Class: OneMsgSdk::SendOrderDetailsRequest

Inherits:
ApiModelBase show all
Defined in:
lib/one_msg_sdk/models/send_order_details_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ SendOrderDetailsRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 96

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OneMsgSdk::SendOrderDetailsRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OneMsgSdk::SendOrderDetailsRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'phone')
    self.phone = attributes[:'phone']
  end

  if attributes.key?(:'chat_id')
    self.chat_id = attributes[:'chat_id']
  end

  if attributes.key?(:'template')
    self.template = attributes[:'template']
  else
    self.template = nil
  end

  if attributes.key?(:'namespace')
    self.namespace = attributes[:'namespace']
  else
    self.namespace = nil
  end

  if attributes.key?(:'language')
    self.language = attributes[:'language']
  else
    self.language = nil
  end

  if attributes.key?(:'params')
    if (value = attributes[:'params']).is_a?(Array)
      self.params = value
    end
  end

  if attributes.key?(:'reference_id')
    self.reference_id = attributes[:'reference_id']
  end

  if attributes.key?(:'currency')
    self.currency = attributes[:'currency']
  end

  if attributes.key?(:'payment_settings')
    if (value = attributes[:'payment_settings']).is_a?(Hash)
      self.payment_settings = value
    end
  end

  if attributes.key?(:'order')
    self.order = attributes[:'order']
  else
    self.order = nil
  end
end

Instance Attribute Details

#chat_id ⇒ Object

Recipient chatId (e.g. phone@c.us). Use phone or chatId.



22
23
24
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 22

def chat_id
  @chat_id
end

#currency ⇒ Object

Currency code for India payments



39
40
41
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 39

def currency
  @currency
end

#language ⇒ Object

Returns the value of attribute language.



30
31
32
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 30

def language
  @language
end

#namespace ⇒ Object

Template namespace from the channel / template list



28
29
30
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 28

def namespace
  @namespace
end

#order ⇒ Object

Returns the value of attribute order.



44
45
46
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 44

def order
  @order
end

#params ⇒ Object

Extra template components (HEADER / BODY / etc.). If an order_details button is missing, the API appends one from order / referenceId / currency / paymentSettings.



33
34
35
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 33

def params
  @params
end

#payment_settings ⇒ Object

Optional payment settings (UPI / payment gateway / payment link). Forwarded as payment_settings on the order_details action.



42
43
44
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 42

def payment_settings
  @payment_settings
end

#phone ⇒ Object

Recipient phone (India E.164 digits, no +). Use phone or chatId.



19
20
21
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 19

def phone
  @phone
end

#reference_id ⇒ Object

Unique order / payment reference id (maps to reference_id)



36
37
38
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 36

def reference_id
  @reference_id
end

#template ⇒ Object

Approved Utility template name that includes an ORDER_DETAILS button



25
26
27
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 25

def template
  @template
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



63
64
65
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 63

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



68
69
70
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 68

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 47

def self.attribute_map
  {
    :'phone' => :'phone',
    :'chat_id' => :'chatId',
    :'template' => :'template',
    :'namespace' => :'namespace',
    :'language' => :'language',
    :'params' => :'params',
    :'reference_id' => :'referenceId',
    :'currency' => :'currency',
    :'payment_settings' => :'paymentSettings',
    :'order' => :'order'
  }
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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 270

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}"] = 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
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



89
90
91
92
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 89

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

.openapi_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 73

def self.openapi_types
  {
    :'phone' => :'Integer',
    :'chat_id' => :'String',
    :'template' => :'String',
    :'namespace' => :'String',
    :'language' => :'SendOrderDetailsRequestLanguage',
    :'params' => :'Array<Hash<String, Object>>',
    :'reference_id' => :'String',
    :'currency' => :'String',
    :'payment_settings' => :'Hash<String, Object>',
    :'order' => :'SendOrderDetailsRequestOrder'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 240

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      phone == o.phone &&
      chat_id == o.chat_id &&
      template == o.template &&
      namespace == o.namespace &&
      language == o.language &&
      params == o.params &&
      reference_id == o.reference_id &&
      currency == o.currency &&
      payment_settings == o.payment_settings &&
      order == o.order
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


257
258
259
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 257

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



263
264
265
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 263

def hash
  [phone, chat_id, template, namespace, language, params, reference_id, currency, payment_settings, order].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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 165

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @template.nil?
    invalid_properties.push('invalid value for "template", template cannot be nil.')
  end

  if @namespace.nil?
    invalid_properties.push('invalid value for "namespace", namespace cannot be nil.')
  end

  if @language.nil?
    invalid_properties.push('invalid value for "language", language cannot be nil.')
  end

  if @order.nil?
    invalid_properties.push('invalid value for "order", order cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 292

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



189
190
191
192
193
194
195
196
 
# File 'lib/one_msg_sdk/models/send_order_details_request.rb', line 189

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @template.nil?
  return false if @namespace.nil?
  return false if @language.nil?
  return false if @order.nil?
  true
end