Class: SunshineConversationsClient::Action

Inherits:
Object
  • Object
show all
Defined in:
lib/sunshine-conversations-client/models/action.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Action

Initializes the object

Parameters:

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

    Model attributes in the form of hash



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
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
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 138

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

The amount being charged. It needs to be specified in cents and is an integer (9.99$ -> 999).



21
22
23
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 21

def amount
  @amount
end

#currency ⇒ Object

An ISO 4217 standard currency code in lowercase. Used for actions of type buy.



24
25
26
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 24

def currency
  @currency
end

#default ⇒ Object

Boolean value indicating whether the action is the default action for a message item in Facebook Messenger.



33
34
35
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 33

def default
  @default
end

#extra_channel_options ⇒ Object

Returns the value of attribute extra_channel_options.



35
36
37
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 35

def extra_channel_options
  @extra_channel_options
end

#fallback ⇒ Object

The fallback uri for channels that don’t support webviews. Used for actions of type webview.



47
48
49
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 47

def fallback
  @fallback
end

#icon_url ⇒ Object

An icon to render next to the reply option.



41
42
43
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 41

def icon_url
  @icon_url
end

#metadata ⇒ Object

Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size.



27
28
29
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 27

def metadata
  @metadata
end

#open_on_receive ⇒ Object

Boolean value indicating if the webview should open automatically. Only one action per message can be set to true. Currently only supported on the Web Messenger.



50
51
52
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 50

def open_on_receive
  @open_on_receive
end

#payload ⇒ Object

A string payload to help you identify the action context. Used when posting the reply. You can also use metadata for more complex needs.



38
39
40
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 38

def payload
  @payload
end

#size ⇒ Object

The size to display a webview. Used for actions of type webview.



44
45
46
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 44

def size
  @size
end

#text ⇒ Object

The button text.



18
19
20
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 18

def text
  @text
end

#type ⇒ Object

The type of action.



15
16
17
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 15

def type
  @type
end

#uri ⇒ Object

The webview URI. This is the URI that will open in the webview when clicking the button.



30
31
32
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 30

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 75

def self.attribute_map
  {
    :'type' => :'type',
    :'text' => :'text',
    :'amount' => :'amount',
    :'currency' => :'currency',
    :'metadata' => :'metadata',
    :'uri' => :'uri',
    :'default' => :'default',
    :'extra_channel_options' => :'extraChannelOptions',
    :'payload' => :'payload',
    :'icon_url' => :'iconUrl',
    :'size' => :'size',
    :'fallback' => :'fallback',
    :'open_on_receive' => :'openOnReceive'
  }
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



310
311
312
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 310

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



132
133
134
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 132

def self.openapi_discriminator_name
  :'type'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



113
114
115
116
117
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 113

def self.openapi_nullable
  Set.new([
    :'metadata',
  ])
end

.openapi_one_of ⇒ Object

List of class defined in oneOf (OpenAPI v3)



120
121
122
123
124
125
126
127
128
129
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 120

def self.openapi_one_of
  [
  :'Buy',
  :'Link',
  :'LocationRequest',
  :'Postback',
  :'Reply',
  :'Webview'
  ]
end

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 94

def self.openapi_types
  {
    :'type' => :'String',
    :'text' => :'String',
    :'amount' => :'Integer',
    :'currency' => :'String',
    :'metadata' => :'Object',
    :'uri' => :'String',
    :'default' => :'Boolean',
    :'extra_channel_options' => :'ExtraChannelOptions',
    :'payload' => :'String',
    :'icon_url' => :'String',
    :'size' => :'String',
    :'fallback' => :'String',
    :'open_on_receive' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 277

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      text == o.text &&
      amount == o.amount &&
      currency == o.currency &&
      metadata == o.metadata &&
      uri == o.uri &&
      default == o.default &&
      extra_channel_options == o.extra_channel_options &&
      payload == o.payload &&
      icon_url == o.icon_url &&
      size == o.size &&
      fallback == o.fallback &&
      open_on_receive == o.open_on_receive
end

#_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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 338

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    SunshineConversationsClient.const_get(type).build_from_hash(value)
  end
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



407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 407

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

#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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 317

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


297
298
299
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 297

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



303
304
305
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 303

def hash
  [type, text, amount, currency, metadata, uri, default, extra_channel_options, payload, icon_url, size, fallback, open_on_receive].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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 206

def list_invalid_properties
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



383
384
385
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 383

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



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 389

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



377
378
379
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 377

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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/sunshine-conversations-client/models/action.rb', line 237

def valid?
  return false if @type.nil?
  return false if @text.nil?
  return false if @amount.nil?
  return false if @uri.nil?
  return false if @payload.nil?
  size_validator = EnumAttributeValidator.new('String', ["compact", "tall", "full"])
  return false unless size_validator.valid?(@size)
  return false if @fallback.nil?
  _one_of_found = false
  self.class.openapi_one_of.each do |_class|
    _one_of = SunshineConversationsClient.const_get(_class).build_from_hash(self.to_hash)
    if _one_of.valid?
      if _one_of_found
        return false
      else
        _one_of_found = true
      end
    end
  end

  if !_one_of_found
    return false
  end

  true
end