Class: Api::MerchantWebhookMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/jamm/api/models/v1_merchant_webhook_message.rb

Overview

MerchantWebhookMessage is a generic message wrapper representing an event for a specific merchant.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MerchantWebhookMessage

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 82

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `Api::MerchantWebhookMessage` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `Api::MerchantWebhookMessage`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.id = attributes[:id] if attributes.key?(:id)

  self.signature = attributes[:signature] if attributes.key?(:signature)

  self.event_type = if attributes.key?(:event_type)
                      attributes[:event_type]
                    else
                      'EVENT_TYPE_UNSPECIFIED'
                    end

  self.content = attributes[:content] if attributes.key?(:content)

  return unless attributes.key?(:created_at)

  self.created_at = attributes[:created_at]
end

Instance Attribute Details

#content ⇒ Object

Returns the value of attribute content.



25
26
27
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 25

def content
  @content
end

#created_at ⇒ Object

Returns the value of attribute created_at.



25
26
27
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 25

def created_at
  @created_at
end

#event_type ⇒ Object

Returns the value of attribute event_type.



25
26
27
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 25

def event_type
  @event_type
end

#id ⇒ Object

Unique identifier for the webhook. It represents the message uniqueness, therefore it won’t change when retried. Use this value to avoid processing the same message multiple times.



20
21
22
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 20

def id
  @id
end

#signature ⇒ Object

Signature of the message.



23
24
25
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 23

def signature
  @signature
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 174

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Api.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



60
61
62
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 60

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



49
50
51
52
53
54
55
56
57
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 49

def self.attribute_map
  {
    :id => :id,
    :signature => :signature,
    :event_type => :eventType,
    :content => :content,
    :created_at => :createdAt
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 151

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash[key.to_s] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      transformed_hash[key.to_s] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) } if attributes[attribute_map[key]].is_a?(Array)
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash[key.to_s] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



76
77
78
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 76

def self.openapi_nullable
  Set.new([])
end

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 65

def self.openapi_types
  {
    :id => :String,
    :signature => :String,
    :event_type => :EventType,
    :content => :ProtobufAny,
    :created_at => :Time
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



125
126
127
128
129
130
131
132
133
134
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 125

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    signature == other.signature &&
    event_type == other.event_type &&
    content == other.content &&
    created_at == other.created_at
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 245

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


138
139
140
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 138

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



144
145
146
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 144

def hash
  [id, signature, event_type, content, created_at].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



111
112
113
114
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 111

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  []
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



221
222
223
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 221

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 227

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



215
216
217
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 215

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



118
119
120
121
 
# File 'lib/jamm/api/models/v1_merchant_webhook_message.rb', line 118

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end