Class: Line::Bot::V2::MessagingApi::CouponMessage

Inherits:
Message
  • Object
show all
Defined in:
lib/line/bot/v2/messaging_api/model/coupon_message.rb

Overview

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(quick_reply: nil, sender: nil, coupon_id:, delivery_tag: nil, **dynamic_attributes) ⇒ CouponMessage

Returns a new instance of CouponMessage.

Parameters:

  • quick_reply (QuickReply, Hash[Symbol, untyped], nil) (defaults to: nil)
  • sender (Sender, Hash[Symbol, untyped], nil) (defaults to: nil)
  • coupon_id (String) —

    Unique identifier of the coupon.

  • delivery_tag (String, nil) (defaults to: nil) —

    Delivery route tag information. It can be used for analysis in LINE OA Manager.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/line/bot/v2/messaging_api/model/coupon_message.rb', line 38

def initialize(
  quick_reply: nil,
  sender: nil,
  coupon_id:,
  delivery_tag: nil,
  **dynamic_attributes
)
  @type = "coupon"
  
  @quick_reply = quick_reply.is_a?(Line::Bot::V2::MessagingApi::QuickReply) || quick_reply.nil? ? quick_reply : Line::Bot::V2::MessagingApi::QuickReply.create(**quick_reply) # steep:ignore
  @sender = sender.is_a?(Line::Bot::V2::MessagingApi::Sender) || sender.nil? ? sender : Line::Bot::V2::MessagingApi::Sender.create(**sender) # steep:ignore
  @coupon_id = coupon_id
  @delivery_tag = delivery_tag

  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

#coupon_id ⇒ String

Returns Unique identifier of the coupon.

Returns:

  • (String) —

    Unique identifier of the coupon.



29
30
31
 
# File 'lib/line/bot/v2/messaging_api/model/coupon_message.rb', line 29

def coupon_id
  @coupon_id
end

#delivery_tag ⇒ String?

Returns Delivery route tag information. It can be used for analysis in LINE OA Manager.

Returns:

  • (String, nil) —

    Delivery route tag information. It can be used for analysis in LINE OA Manager.



32
33
34
 
# File 'lib/line/bot/v2/messaging_api/model/coupon_message.rb', line 32

def delivery_tag
  @delivery_tag
end

#quick_reply ⇒ QuickReply?

Returns:



23
24
25
 
# File 'lib/line/bot/v2/messaging_api/model/coupon_message.rb', line 23

def quick_reply
  @quick_reply
end

#sender ⇒ Sender?

Returns:



26
27
28
 
# File 'lib/line/bot/v2/messaging_api/model/coupon_message.rb', line 26

def sender
  @sender
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



20
21
22
 
# File 'lib/line/bot/v2/messaging_api/model/coupon_message.rb', line 20

def type
  @type
end

Class Method Details

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

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



68
69
70
71
 
# File 'lib/line/bot/v2/messaging_api/model/coupon_message.rb', line 68

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



75
76
77
78
79
80
81
 
# File 'lib/line/bot/v2/messaging_api/model/coupon_message.rb', line 75

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



84
85
86
 
# File 'lib/line/bot/v2/messaging_api/model/coupon_message.rb', line 84

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