Class: Line::Bot::V2::MessagingApi::TestWebhookEndpointResponse

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

Overview

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(success: nil, timestamp:, status_code:, reason:, detail:, **dynamic_attributes) ⇒ TestWebhookEndpointResponse

Returns a new instance of TestWebhookEndpointResponse.

Parameters:

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

    Result of the communication from the LINE platform to the webhook URL.

  • timestamp (String) —

    Time of the event in milliseconds. Even in the case of a redelivered webhook, it represents the time the event occurred, not the time it was redelivered.

  • status_code (Integer) —

    The HTTP status code. If the webhook response isn’t received, the status code is set to zero or a negative number.

  • reason (String) —

    Reason for the response.

  • detail (String) —

    Details of the response.



37
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/test_webhook_endpoint_response.rb', line 37

def initialize(
  success: nil,
  timestamp:,
  status_code:,
  reason:,
  detail:,
  **dynamic_attributes
)
  
  @success = success
  @timestamp = timestamp
  @status_code = status_code
  @reason = reason
  @detail = detail

  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

#detail ⇒ String

Returns Details of the response.

Returns:

  • (String) —

    Details of the response.



30
31
32
 
# File 'lib/line/bot/v2/messaging_api/model/test_webhook_endpoint_response.rb', line 30

def detail
  @detail
end

#reason ⇒ String

Returns Reason for the response.

Returns:

  • (String) —

    Reason for the response.



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

def reason
  @reason
end

#status_code ⇒ Integer

Returns The HTTP status code. If the webhook response isn’t received, the status code is set to zero or a negative number.

Returns:

  • (Integer) —

    The HTTP status code. If the webhook response isn’t received, the status code is set to zero or a negative number.



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

def status_code
  @status_code
end

#success ⇒ Boolean?

Returns Result of the communication from the LINE platform to the webhook URL.

Returns:

  • (Boolean, nil) —

    Result of the communication from the LINE platform to the webhook URL.



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

def success
  @success
end

#timestamp ⇒ String

Returns Time of the event in milliseconds. Even in the case of a redelivered webhook, it represents the time the event occurred, not the time it was redelivered.

Returns:

  • (String) —

    Time of the event in milliseconds. Even in the case of a redelivered webhook, it represents the time the event occurred, not the time it was redelivered.



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

def timestamp
  @timestamp
end

Class Method Details

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

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/test_webhook_endpoint_response.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/test_webhook_endpoint_response.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/test_webhook_endpoint_response.rb', line 84

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