Class: Zernio::CreateInboxConversationRequest

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/zernio-sdk/models/create_inbox_conversation_request.rb', line 129

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

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

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

  if attributes.key?(:'skip_dm_check')
    self.skip_dm_check = attributes[:'skip_dm_check']
  else
    self.skip_dm_check = false
  end

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

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

  if attributes.key?(:'link_preview')
    self.link_preview = attributes[:'link_preview']
  else
    self.link_preview = true
  end

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The social account ID to send from



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

def 
  @account_id
end

#category ⇒ Object

WhatsApp only (Meta Direct Send). Combined with message and without templateName, starts the conversation with a business-initiated UTILITY message and no pre-approved template; Meta matches or auto-creates a template asynchronously. The WhatsApp Business Account must be eligible for Direct Send, otherwise the send fails with an error telling you to use an approved message template instead. Cannot be combined with templateName (templates are already categorized at creation). Utility messages only; marketing content is not allowed under this category. Accepted on the JSON body only, not on multipart requests.



37
38
39
 
# File 'lib/zernio-sdk/models/create_inbox_conversation_request.rb', line 37

def category
  @category
end

#header_media ⇒ Object

Returns the value of attribute header_media.



51
52
53
 
# File 'lib/zernio-sdk/models/create_inbox_conversation_request.rb', line 51

def header_media
  @header_media
end

#link_preview ⇒ Object

WhatsApp only. Set false to send the Direct Send (category: 'utility') text message without a link-preview thumbnail for the first URL in the text. Defaults to true, which is how every WhatsApp text has been sent to date. Does not apply to template sends. Accepted on the JSON body only, not on multipart requests.



40
41
42
 
# File 'lib/zernio-sdk/models/create_inbox_conversation_request.rb', line 40

def link_preview
  @link_preview
end

#message ⇒ Object

Text content of the message. At least one of message, attachment, or (for WhatsApp) templateName is required. Required when category is set (a Direct Send utility message is a text message).



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

def message
  @message
end

#participant_id ⇒ Object

Recipient identifier. For X this is the numeric user ID; for WhatsApp and SMS, the recipient phone number in international format (digits, country code included); for Slack, the workspace member id (e.g. U01ABCDEF). Provide either this or participantUsername.



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

def participant_id
  @participant_id
end

#participant_username ⇒ Object

Recipient handle/username — an X or Bluesky handle (with or without @) or a Reddit username (with or without u/). Resolved via lookup. Provide either this or participantId.



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

def participant_username
  @participant_username
end

#skip_dm_check ⇒ Object

X/Twitter only. Skip the receives_your_dm eligibility check before sending. Use if you have already verified the recipient accepts DMs.



31
32
33
 
# File 'lib/zernio-sdk/models/create_inbox_conversation_request.rb', line 31

def skip_dm_check
  @skip_dm_check
end

#template_button_params ⇒ Object

WhatsApp only. Values for template buttons that carry one at send time, each addressed by the button's position in the approved template. This is the only way to send a copy-code button's payload (a Pix payment code, a coupon) or a flow token, because templateParams is a flat array of text variables and covers dynamic URL buttons only. Supplying a button here overrides whatever templateParams would have derived for that same index, so the send never carries one button twice; repeating an index within this array is rejected with 400. Each index must name a button of the matching kind on the approved template, which is also checked before the send and returns 400 (INVALID_TEMPLATE_BUTTON_PARAM) rather than a Meta rejection.



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

def template_button_params
  @template_button_params
end

#template_language ⇒ Object

WhatsApp only. Template language code (e.g. en_US).



43
44
45
 
# File 'lib/zernio-sdk/models/create_inbox_conversation_request.rb', line 43

def template_language
  @template_language
end

#template_name ⇒ Object

WhatsApp only. Name of the approved template to start the conversation with. Required for WhatsApp unless category is used instead (Direct Send). Cannot be combined with category.



34
35
36
 
# File 'lib/zernio-sdk/models/create_inbox_conversation_request.rb', line 34

def template_name
  @template_name
end

#template_params ⇒ Object

WhatsApp only. Template variable values as one flat array, in the order the variables appear across the whole template: text-header variables first, then body variables, then one value per dynamic URL button (in button order). Works with positional placeholders ({1}, {2}, ...) and with named placeholders ({name}, {company} - how Meta Business Manager creates templates), where values fill the named slots in order of appearance. Example - a body with {1}, {2} plus a URL button https://example.com/{1} takes three values: [body1, body2, buttonSuffix]. Media headers (image, video, document) are filled automatically from the approved template and take no value here (use headerMedia to override the header asset per send). Buttons that are not dynamic-URL buttons (copy-code, flow) take no value here either; use templateButtonParams.



46
47
48
 
# File 'lib/zernio-sdk/models/create_inbox_conversation_request.rb', line 46

def template_params
  @template_params
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



94
95
96
 
# File 'lib/zernio-sdk/models/create_inbox_conversation_request.rb', line 94

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



99
100
101
 
# File 'lib/zernio-sdk/models/create_inbox_conversation_request.rb', line 99

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/zernio-sdk/models/create_inbox_conversation_request.rb', line 76

def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'participant_id' => :'participantId',
    :'participant_username' => :'participantUsername',
    :'message' => :'message',
    :'skip_dm_check' => :'skipDmCheck',
    :'template_name' => :'templateName',
    :'category' => :'category',
    :'link_preview' => :'linkPreview',
    :'template_language' => :'templateLanguage',
    :'template_params' => :'templateParams',
    :'template_button_params' => :'templateButtonParams',
    :'header_media' => :'headerMedia'
  }
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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/zernio-sdk/models/create_inbox_conversation_request.rb', line 297

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/zernio-sdk/models/create_inbox_conversation_request.rb', line 104

def self.openapi_types
  {
    :'account_id' => :'String',
    :'participant_id' => :'String',
    :'participant_username' => :'String',
    :'message' => :'String',
    :'skip_dm_check' => :'Boolean',
    :'template_name' => :'String',
    :'category' => :'String',
    :'link_preview' => :'Boolean',
    :'template_language' => :'String',
    :'template_params' => :'Array<String>',
    :'template_button_params' => :'Array<CreateInboxConversationRequestTemplateButtonParamsInner>',
    :'header_media' => :'CreateInboxConversationRequestHeaderMedia'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/zernio-sdk/models/create_inbox_conversation_request.rb', line 265

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      participant_id == o.participant_id &&
      participant_username == o.participant_username &&
      message == o.message &&
      skip_dm_check == o.skip_dm_check &&
      template_name == o.template_name &&
      category == o.category &&
      link_preview == o.link_preview &&
      template_language == o.template_language &&
      template_params == o.template_params &&
      template_button_params == o.template_button_params &&
      header_media == o.header_media
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


284
285
286
 
# File 'lib/zernio-sdk/models/create_inbox_conversation_request.rb', line 284

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



290
291
292
 
# File 'lib/zernio-sdk/models/create_inbox_conversation_request.rb', line 290

def hash
  [, participant_id, participant_username, message, skip_dm_check, template_name, category, link_preview, template_language, template_params, template_button_params, header_media].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



204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/zernio-sdk/models/create_inbox_conversation_request.rb', line 204

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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/zernio-sdk/models/create_inbox_conversation_request.rb', line 319

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



220
221
222
223
224
225
226
227
 
# File 'lib/zernio-sdk/models/create_inbox_conversation_request.rb', line 220

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @account_id.nil?
  category_validator = EnumAttributeValidator.new('String', ["utility"])
  return false unless category_validator.valid?(@category)
  return false if !@template_button_params.nil? && @template_button_params.length > 10
  true
end