Class: Line::Bot::V2::MessagingApi::NumberOfMessagesResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(status:, success: nil, **dynamic_attributes) ⇒ NumberOfMessagesResponse

Returns a new instance of NumberOfMessagesResponse.

Parameters:

  • status (String) —

    (‘ready’|‘unready’|‘unavailable_for_privacy’|‘out_of_service’) Aggregation process status. One of: ‘ready`: The number of messages can be obtained. `unready`: We haven’t finished calculating the number of sent messages for the specified in date. For example, this property is returned when the delivery date or a future date is specified. Calculation usually takes about a day. ‘unavailable_for_privacy`: The total number of messages on the specified day is less than 20. `out_of_service`: The specified date is earlier than the date on which we first started calculating sent messages (March 31, 2018).

  • success (Integer, nil) (defaults to: nil) —

    The number of messages delivered using the phone number on the date specified in ‘date`. The response has this property only when the value of `status` is `ready`.



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/line/bot/v2/messaging_api/model/number_of_messages_response.rb', line 24

def initialize(
  status:,
  success: nil,
  **dynamic_attributes
)
  
  @status = status
  @success = success

  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

#status ⇒ String

Returns (‘ready’|‘unready’|‘unavailable_for_privacy’|‘out_of_service’) Aggregation process status. One of: ‘ready`: The number of messages can be obtained. `unready`: We haven’t finished calculating the number of sent messages for the specified in date. For example, this property is returned when the delivery date or a future date is specified. Calculation usually takes about a day. ‘unavailable_for_privacy`: The total number of messages on the specified day is less than 20. `out_of_service`: The specified date is earlier than the date on which we first started calculating sent messages (March 31, 2018).

Returns:

  • (String) —

    (‘ready’|‘unready’|‘unavailable_for_privacy’|‘out_of_service’) Aggregation process status. One of: ‘ready`: The number of messages can be obtained. `unready`: We haven’t finished calculating the number of sent messages for the specified in date. For example, this property is returned when the delivery date or a future date is specified. Calculation usually takes about a day. ‘unavailable_for_privacy`: The total number of messages on the specified day is less than 20. `out_of_service`: The specified date is earlier than the date on which we first started calculating sent messages (March 31, 2018).



17
18
19
 
# File 'lib/line/bot/v2/messaging_api/model/number_of_messages_response.rb', line 17

def status
  @status
end

#success ⇒ Integer?

Returns The number of messages delivered using the phone number on the date specified in ‘date`. The response has this property only when the value of `status` is `ready`.

Returns:

  • (Integer, nil) —

    The number of messages delivered using the phone number on the date specified in ‘date`. The response has this property only when the value of `status` is `ready`.



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

def success
  @success
end

Class Method Details

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

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



49
50
51
52
 
# File 'lib/line/bot/v2/messaging_api/model/number_of_messages_response.rb', line 49

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



56
57
58
59
60
61
62
 
# File 'lib/line/bot/v2/messaging_api/model/number_of_messages_response.rb', line 56

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



65
66
67
 
# File 'lib/line/bot/v2/messaging_api/model/number_of_messages_response.rb', line 65

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