Class: Line::Bot::V2::MessagingApi::RichMenuBatchProgressResponse

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

Overview

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(phase:, accepted_time:, completed_time: nil, **dynamic_attributes) ⇒ RichMenuBatchProgressResponse

Returns a new instance of RichMenuBatchProgressResponse.

Parameters:

  • phase (String) —

    (‘ongoing’|‘succeeded’|‘failed’)

  • accepted_time (String) —

    The accepted time in milliseconds of the request of batch control the rich menu. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC

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

    The completed time in milliseconds of rich menu batch control. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/line/bot/v2/messaging_api/model/rich_menu_batch_progress_response.rb', line 29

def initialize(
  phase:,
  accepted_time:,
  completed_time: nil,
  **dynamic_attributes
)
  
  @phase = phase
  @accepted_time = accepted_time
  @completed_time = completed_time

  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

#accepted_time ⇒ String

Returns The accepted time in milliseconds of the request of batch control the rich menu. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC.

Returns:

  • (String) —

    The accepted time in milliseconds of the request of batch control the rich menu. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC



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

def accepted_time
  @accepted_time
end

#completed_time ⇒ String?

Returns The completed time in milliseconds of rich menu batch control. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC.

Returns:

  • (String, nil) —

    The completed time in milliseconds of rich menu batch control. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC



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

def completed_time
  @completed_time
end

#phase ⇒ String

Returns (‘ongoing’|‘succeeded’|‘failed’).

Returns:

  • (String) —

    (‘ongoing’|‘succeeded’|‘failed’)



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

def phase
  @phase
end

Class Method Details

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

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



56
57
58
59
 
# File 'lib/line/bot/v2/messaging_api/model/rich_menu_batch_progress_response.rb', line 56

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



63
64
65
66
67
68
69
 
# File 'lib/line/bot/v2/messaging_api/model/rich_menu_batch_progress_response.rb', line 63

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



72
73
74
 
# File 'lib/line/bot/v2/messaging_api/model/rich_menu_batch_progress_response.rb', line 72

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