Class: Late::SendInboxMessageRequest

Inherits:
ApiModelBase show all
Defined in:
lib/late-sdk/models/send_inbox_message_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ SendInboxMessageRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 123

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Social account ID



19
20
21
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 19

def 
  @account_id
end

#attachment_type ⇒ Object

Type of attachment. Defaults to file if not specified.



28
29
30
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 28

def attachment_type
  @attachment_type
end

#attachment_url ⇒ Object

URL of the attachment to send (image, video, audio, or file). The URL must be publicly accessible. For binary file uploads, use multipart/form-data instead.



25
26
27
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 25

def attachment_url
  @attachment_url
end

#buttons ⇒ Object

Action buttons. Mutually exclusive with quickReplies. Max 3 items.



34
35
36
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 34

def buttons
  @buttons
end

#message ⇒ Object

Message text



22
23
24
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 22

def message
  @message
end

#message_tag ⇒ Object

Facebook message tag for messaging outside 24h window. Requires messagingType MESSAGE_TAG. Instagram only supports HUMAN_AGENT.



44
45
46
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 44

def message_tag
  @message_tag
end

#messaging_type ⇒ Object

Facebook messaging type. Required when using messageTag.



41
42
43
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 41

def messaging_type
  @messaging_type
end

#quick_replies ⇒ Object

Quick reply buttons. Mutually exclusive with buttons. Max 13 items.



31
32
33
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 31

def quick_replies
  @quick_replies
end

#reply_markup ⇒ Object

Returns the value of attribute reply_markup.



38
39
40
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 38

def reply_markup
  @reply_markup
end

#reply_to ⇒ Object

Platform message ID to reply to (Telegram only).



47
48
49
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 47

def reply_to
  @reply_to
end

#template ⇒ Object

Returns the value of attribute template.



36
37
38
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 36

def template
  @template
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



89
90
91
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 89

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



94
95
96
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 94

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 72

def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'message' => :'message',
    :'attachment_url' => :'attachmentUrl',
    :'attachment_type' => :'attachmentType',
    :'quick_replies' => :'quickReplies',
    :'buttons' => :'buttons',
    :'template' => :'template',
    :'reply_markup' => :'replyMarkup',
    :'messaging_type' => :'messagingType',
    :'message_tag' => :'messageTag',
    :'reply_to' => :'replyTo'
  }
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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 325

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



116
117
118
119
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 116

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

.openapi_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 99

def self.openapi_types
  {
    :'account_id' => :'String',
    :'message' => :'String',
    :'attachment_url' => :'String',
    :'attachment_type' => :'String',
    :'quick_replies' => :'Array<SendInboxMessageRequestQuickRepliesInner>',
    :'buttons' => :'Array<SendInboxMessageRequestButtonsInner>',
    :'template' => :'SendInboxMessageRequestTemplate',
    :'reply_markup' => :'SendInboxMessageRequestReplyMarkup',
    :'messaging_type' => :'String',
    :'message_tag' => :'String',
    :'reply_to' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 294

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      message == o.message &&
      attachment_url == o.attachment_url &&
      attachment_type == o.attachment_type &&
      quick_replies == o.quick_replies &&
      buttons == o.buttons &&
      template == o.template &&
      reply_markup == o.reply_markup &&
      messaging_type == o.messaging_type &&
      message_tag == o.message_tag &&
      reply_to == o.reply_to
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


312
313
314
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 312

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



318
319
320
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 318

def hash
  [, message, attachment_url, attachment_type, quick_replies, buttons, template, reply_markup, messaging_type, message_tag, reply_to].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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 190

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

  if !@quick_replies.nil? && @quick_replies.length > 13
    invalid_properties.push('invalid value for "quick_replies", number of items must be less than or equal to 13.')
  end

  if !@buttons.nil? && @buttons.length > 3
    invalid_properties.push('invalid value for "buttons", number of items must be less than or equal to 3.')
  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



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 347

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



210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/late-sdk/models/send_inbox_message_request.rb', line 210

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @account_id.nil?
  attachment_type_validator = EnumAttributeValidator.new('String', ["image", "video", "audio", "file"])
  return false unless attachment_type_validator.valid?(@attachment_type)
  return false if !@quick_replies.nil? && @quick_replies.length > 13
  return false if !@buttons.nil? && @buttons.length > 3
  messaging_type_validator = EnumAttributeValidator.new('String', ["RESPONSE", "UPDATE", "MESSAGE_TAG"])
  return false unless messaging_type_validator.valid?(@messaging_type)
  message_tag_validator = EnumAttributeValidator.new('String', ["CONFIRMED_EVENT_UPDATE", "POST_PURCHASE_UPDATE", "ACCOUNT_UPDATE", "HUMAN_AGENT"])
  return false unless message_tag_validator.valid?(@message_tag)
  true
end