Class: SunshineConversationsClient::Link

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

Overview

A link action will open the provided URI when tapped.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Link

Initializes the object

Parameters:

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

    Model attributes in the form of hash



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'lib/sunshine-conversations-client/models/link.rb', line 65

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::Link` 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::Link`. 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']
  else
    self.type = 'link'
  end

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

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

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

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

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

Instance Attribute Details

#defaultObject

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



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

def default
  @default
end

#extra_channel_optionsObject

Returns the value of attribute extra_channel_options.



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

def extra_channel_options
  @extra_channel_options
end

#metadataObject

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.



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

def 
  @metadata
end

#textObject

The button text.



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

def text
  @text
end

#typeObject

The type of action.



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

def type
  @type
end

#uriObject

The action URI. This is the link that will be used in the clients when clicking the button.



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

def uri
  @uri
end

Class Method Details

.attribute_mapObject

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



33
34
35
36
37
38
39
40
41
42
# File 'lib/sunshine-conversations-client/models/link.rb', line 33

def self.attribute_map
  {
    :'type' => :'type',
    :'uri' => :'uri',
    :'text' => :'text',
    :'default' => :'default',
    :'metadata' => :'metadata',
    :'extra_channel_options' => :'extraChannelOptions'
  }
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



161
162
163
# File 'lib/sunshine-conversations-client/models/link.rb', line 161

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

.openapi_nullableObject

List of attributes with nullable: true



57
58
59
60
61
# File 'lib/sunshine-conversations-client/models/link.rb', line 57

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

.openapi_typesObject

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
# File 'lib/sunshine-conversations-client/models/link.rb', line 45

def self.openapi_types
  {
    :'type' => :'String',
    :'uri' => :'String',
    :'text' => :'String',
    :'default' => :'Boolean',
    :'metadata' => :'Object',
    :'extra_channel_options' => :'ExtraChannelOptions'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



135
136
137
138
139
140
141
142
143
144
# File 'lib/sunshine-conversations-client/models/link.rb', line 135

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      uri == o.uri &&
      text == o.text &&
      default == o.default &&
       == o. &&
      extra_channel_options == o.extra_channel_options
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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# File 'lib/sunshine-conversations-client/models/link.rb', line 189

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



258
259
260
261
262
263
264
265
266
267
268
269
270
# File 'lib/sunshine-conversations-client/models/link.rb', line 258

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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
# File 'lib/sunshine-conversations-client/models/link.rb', line 168

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


148
149
150
# File 'lib/sunshine-conversations-client/models/link.rb', line 148

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



154
155
156
# File 'lib/sunshine-conversations-client/models/link.rb', line 154

def hash
  [type, uri, text, default, , extra_channel_options].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/sunshine-conversations-client/models/link.rb', line 107

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



234
235
236
# File 'lib/sunshine-conversations-client/models/link.rb', line 234

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



240
241
242
243
244
245
246
247
248
249
250
251
252
# File 'lib/sunshine-conversations-client/models/link.rb', line 240

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



228
229
230
# File 'lib/sunshine-conversations-client/models/link.rb', line 228

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



126
127
128
129
130
131
# File 'lib/sunshine-conversations-client/models/link.rb', line 126

def valid?
  return false if @type.nil?
  return false if @uri.nil?
  return false if @text.nil?
  true
end