Class: Line::Bot::V2::Webhook::PnpDeliveryCompletionEvent

Inherits:
Event
  • Object
show all
Defined in:
lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb

Overview

When a request is made to the LINE notification messages API and delivery of the LINE notification message to the user is completed, a dedicated webhook event (delivery completion event) is sent from the LINE Platform to the webhook URL of the bot server.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source: nil, timestamp:, mode:, webhook_event_id:, delivery_context:, delivery:, **dynamic_attributes) ⇒ PnpDeliveryCompletionEvent

Returns a new instance of PnpDeliveryCompletionEvent.

Parameters:

  • source (Source, Hash[Symbol, untyped], nil) (defaults to: nil)
  • timestamp (Integer) —

    Time of the event in milliseconds.

  • mode (String) —

    (‘active’|‘standby’)

  • webhook_event_id (String) —

    Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format.

  • delivery_context (DeliveryContext, Hash[Symbol, untyped])
  • delivery (PnpDelivery, Hash[Symbol, untyped]) 


46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb', line 46

def initialize(
  source: nil,
  timestamp:,
  mode:,
  webhook_event_id:,
  delivery_context:,
  delivery:,
  **dynamic_attributes
)
  @type = "delivery"
  
  @source = source.is_a?(Line::Bot::V2::Webhook::Source) || source.nil? ? source : Line::Bot::V2::Webhook::Source.create(**source) # steep:ignore
  @timestamp = timestamp
  @mode = mode
  @webhook_event_id = webhook_event_id
  @delivery_context = delivery_context.is_a?(Line::Bot::V2::Webhook::DeliveryContext) ? delivery_context : Line::Bot::V2::Webhook::DeliveryContext.create(**delivery_context) # steep:ignore
  @delivery = delivery.is_a?(Line::Bot::V2::Webhook::PnpDelivery) ? delivery : Line::Bot::V2::Webhook::PnpDelivery.create(**delivery) # steep:ignore

  dynamic_attributes.each do |key, value|
    self.class.attr_accessor key

    if value.is_a?(Hash)
      struct_klass = Struct.new(*value.keys.map(&:to_sym))
      struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
      instance_variable_set("@#{key}", struct_klass.new(*struct_values))
    else
      instance_variable_set("@#{key}", value)
    end
  end
end

Instance Attribute Details

#delivery ⇒ PnpDelivery

Returns:



38
39
40
 
# File 'lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb', line 38

def delivery
  @delivery
end

#delivery_context ⇒ DeliveryContext

Returns:



35
36
37
 
# File 'lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb', line 35

def delivery_context
  @delivery_context
end

#mode ⇒ String

Returns (‘active’|‘standby’).

Returns:

  • (String) —

    (‘active’|‘standby’)



29
30
31
 
# File 'lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb', line 29

def mode
  @mode
end

#source ⇒ Source?

Returns:



23
24
25
 
# File 'lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb', line 23

def source
  @source
end

#timestamp ⇒ Integer

Returns Time of the event in milliseconds.

Returns:

  • (Integer) —

    Time of the event in milliseconds.



26
27
28
 
# File 'lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb', line 26

def timestamp
  @timestamp
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



20
21
22
 
# File 'lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb', line 20

def type
  @type
end

#webhook_event_id ⇒ String

Returns Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format.

Returns:

  • (String) —

    Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format.



32
33
34
 
# File 'lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb', line 32

def webhook_event_id
  @webhook_event_id
end

Class Method Details

.create(args) ⇒ Line::Bot::V2::Webhook::PnpDeliveryCompletionEvent

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



80
81
82
83
 
# File 'lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb', line 80

def self.create(args) # steep:ignore
  symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
  return new(**symbolized_args) # steep:ignore
end

Instance Method Details

#==(other) ⇒ Boolean

Returns true if the objects are equal, false otherwise.

Parameters:

  • other (Object) —

    Object to compare

Returns:

  • (Boolean) —

    true if the objects are equal, false otherwise



87
88
89
90
91
92
93
 
# File 'lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb', line 87

def ==(other)
  return false unless self.class == other.class

  instance_variables.all? do |var|
      instance_variable_get(var) == other.instance_variable_get(var)
  end
end

#hash ⇒ Integer

Returns Hash code of the object.

Returns:

  • (Integer) —

    Hash code of the object



96
97
98
 
# File 'lib/line/bot/v2/webhook/model/pnp_delivery_completion_event.rb', line 96

def hash
  [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
end