Class: Line::Bot::V2::MessagingApi::PnpTemplatedMessageRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/line/bot/v2/messaging_api/model/pnp_templated_message_request.rb,
sig/line/bot/v2/messaging_api/model/pnp_templated_message_request.rbs

Overview

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(to:, template_key:, body: nil, custom_aggregation_units: nil, **dynamic_attributes) ⇒ Object

Parameters:



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/line/bot/v2/messaging_api/model/pnp_templated_message_request.rb', line 33

def initialize(
  to:,
  template_key:,
  body: nil,
  custom_aggregation_units: nil,
  **dynamic_attributes
)
  
  @to = to
  @template_key = template_key
  @body = body.is_a?(Line::Bot::V2::MessagingApi::PnpTemplatedMessageBody) || body.nil? ? body : Line::Bot::V2::MessagingApi::PnpTemplatedMessageBody.create(**body)
  @custom_aggregation_units = custom_aggregation_units

  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

#body ⇒ PnpTemplatedMessageBody?

Returns:



24
25
26
 
# File 'lib/line/bot/v2/messaging_api/model/pnp_templated_message_request.rb', line 24

def body
  @body
end

#custom_aggregation_units ⇒ Array[String]?

Returns Name of aggregation unit. Case-sensitive. For more information about assigning a unit name, see https://developers.line.biz/en/docs/messaging-api/unit-based-statistics-aggregation/#assign-names-to-units-when-sending-messages.

Returns:



27
28
29
 
# File 'lib/line/bot/v2/messaging_api/model/pnp_templated_message_request.rb', line 27

def custom_aggregation_units
  @custom_aggregation_units
end

#template_key ⇒ String

Returns Specify the key of the template you want to send. For available keys, see https://developers.line.biz/en/docs/partner-docs/line-notification-messages/template/#templates.

Returns:



21
22
23
 
# File 'lib/line/bot/v2/messaging_api/model/pnp_templated_message_request.rb', line 21

def template_key
  @template_key
end

#to ⇒ String

Returns Message destination. Specify a phone number that has been normalized to E.164 format and hashed with SHA256.

Returns:

  • (String) —

    Message destination. Specify a phone number that has been normalized to E.164 format and hashed with SHA256.



18
19
20
 
# File 'lib/line/bot/v2/messaging_api/model/pnp_templated_message_request.rb', line 18

def to
  @to
end

Class Method Details

.create(args) ⇒ Line::Bot::V2::MessagingApi::PnpTemplatedMessageRequest

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

  • (Hash[Symbol, untyped])

Returns:



62
63
64
65
 
# File 'lib/line/bot/v2/messaging_api/model/pnp_templated_message_request.rb', line 62

def self.create(args)
  symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
  return new(**symbolized_args) # steep:ignore InsufficientKeywordArguments
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



69
70
71
72
73
74
75
 
# File 'lib/line/bot/v2/messaging_api/model/pnp_templated_message_request.rb', line 69

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



78
79
80
 
# File 'lib/line/bot/v2/messaging_api/model/pnp_templated_message_request.rb', line 78

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