Class: Zernio::SendInboxMessage200ResponseData

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/send_inbox_message200_response_data.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 = {}) ⇒ SendInboxMessage200ResponseData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
104
105
106
107
108
109
 
# File 'lib/zernio-sdk/models/send_inbox_message200_response_data.rb', line 72

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

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

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

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

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

Instance Attribute Details

#attachments ⇒ Object

Echo of the sent attachment with its resolved public URL, when one is available (Facebook, Instagram, Telegram, WhatsApp).



25
26
27
 
# File 'lib/zernio-sdk/models/send_inbox_message200_response_data.rb', line 25

def attachments
  @attachments
end

#conversation_id ⇒ Object

Zernio conversation id, echoed so the thread can be read back or replied to. It equals the id the list-conversations endpoint returns for Telegram, WhatsApp, SMS and Slack; for Facebook, Instagram, Bluesky and Reddit that endpoint returns the platform thread id instead, so do not correlate the two by equality. For X (Twitter), when the request addressed the conversation by its Twitter dm_conversation_id, that platform id is echoed back instead. Omitted when the send succeeded but the conversation could not be resolved to a stored record.



22
23
24
 
# File 'lib/zernio-sdk/models/send_inbox_message200_response_data.rb', line 22

def conversation_id
  @conversation_id
end

#message_id ⇒ Object

Platform id of the sent message (not returned for Reddit). For WhatsApp this is the raw Meta wamid, the same id delivered as message.platformMessageId on webhooks and delivery-status updates, and the value to pass as replyTo to quote-reply.



19
20
21
 
# File 'lib/zernio-sdk/models/send_inbox_message200_response_data.rb', line 19

def message_id
  @message_id
end

#message_ids ⇒ Object

Facebook/Instagram only. Present when an attachment and text were both requested: Meta has no single body shape for both, so the send is two Meta messages under the hood. First element === messageId (the attachment); second is the follow-up text.



28
29
30
 
# File 'lib/zernio-sdk/models/send_inbox_message200_response_data.rb', line 28

def message_ids
  @message_ids
end

#partial_failure ⇒ Object

Returns the value of attribute partial_failure.



30
31
32
 
# File 'lib/zernio-sdk/models/send_inbox_message200_response_data.rb', line 30

def partial_failure
  @partial_failure
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



44
45
46
 
# File 'lib/zernio-sdk/models/send_inbox_message200_response_data.rb', line 44

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



49
50
51
 
# File 'lib/zernio-sdk/models/send_inbox_message200_response_data.rb', line 49

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/zernio-sdk/models/send_inbox_message200_response_data.rb', line 33

def self.attribute_map
  {
    :'message_id' => :'messageId',
    :'conversation_id' => :'conversationId',
    :'attachments' => :'attachments',
    :'message_ids' => :'messageIds',
    :'partial_failure' => :'partialFailure'
  }
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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/zernio-sdk/models/send_inbox_message200_response_data.rb', line 153

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



65
66
67
68
 
# File 'lib/zernio-sdk/models/send_inbox_message200_response_data.rb', line 65

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

.openapi_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
 
# File 'lib/zernio-sdk/models/send_inbox_message200_response_data.rb', line 54

def self.openapi_types
  {
    :'message_id' => :'String',
    :'conversation_id' => :'String',
    :'attachments' => :'Array<SendInboxMessage200ResponseDataAttachmentsInner>',
    :'message_ids' => :'Array<String>',
    :'partial_failure' => :'SendInboxMessage200ResponseDataPartialFailure'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



128
129
130
131
132
133
134
135
136
 
# File 'lib/zernio-sdk/models/send_inbox_message200_response_data.rb', line 128

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      message_id == o.message_id &&
      conversation_id == o.conversation_id &&
      attachments == o.attachments &&
      message_ids == o.message_ids &&
      partial_failure == o.partial_failure
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


140
141
142
 
# File 'lib/zernio-sdk/models/send_inbox_message200_response_data.rb', line 140

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



146
147
148
 
# File 'lib/zernio-sdk/models/send_inbox_message200_response_data.rb', line 146

def hash
  [message_id, conversation_id, attachments, message_ids, partial_failure].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



113
114
115
116
117
 
# File 'lib/zernio-sdk/models/send_inbox_message200_response_data.rb', line 113

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/zernio-sdk/models/send_inbox_message200_response_data.rb', line 175

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



121
122
123
124
 
# File 'lib/zernio-sdk/models/send_inbox_message200_response_data.rb', line 121

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