Class: Zernio::EnableWhatsAppCallingLegacyRequest

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
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
 
# File 'lib/zernio-sdk/models/enable_whats_app_calling_legacy_request.rb', line 106

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

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

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

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

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

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

  if attributes.key?(:'forward_caller_id')
    self.forward_caller_id = attributes[:'forward_caller_id']
  else
    self.forward_caller_id = 'business'
  end
end

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



18
19
20
 
# File 'lib/zernio-sdk/models/enable_whats_app_calling_legacy_request.rb', line 18

def 
  @account_id
end

#call_icon_countries ⇒ Object

Returns the value of attribute call_icon_countries.



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

def call_icon_countries
  @call_icon_countries
end

#forward_caller_id ⇒ Object

Caller ID presented to the forward destination. caller = the WhatsApp user's number (sip: destinations only; ignored on tel: forwards). Fixes AI-agent trunks that reject seeing the business number call itself.



36
37
38
 
# File 'lib/zernio-sdk/models/enable_whats_app_calling_legacy_request.rb', line 36

def forward_caller_id
  @forward_caller_id
end

#forward_to ⇒ Object

tel:+E164 / sip:... / wss://... destination



21
22
23
 
# File 'lib/zernio-sdk/models/enable_whats_app_calling_legacy_request.rb', line 21

def forward_to
  @forward_to
end

#max_call_duration_seconds ⇒ Object

Hard cap (seconds) on a forwarded call; the carrier hangs up both legs when it fires. Safety valve against dead-air billing when a destination hangs up but the signal is lost.



33
34
35
 
# File 'lib/zernio-sdk/models/enable_whats_app_calling_legacy_request.rb', line 33

def max_call_duration_seconds
  @max_call_duration_seconds
end

#recording_enabled ⇒ Object

Returns the value of attribute recording_enabled.



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

def recording_enabled
  @recording_enabled
end

#sip_auth_password ⇒ Object

Stored encrypted, never returned by any endpoint.



26
27
28
 
# File 'lib/zernio-sdk/models/enable_whats_app_calling_legacy_request.rb', line 26

def sip_auth_password
  @sip_auth_password
end

#sip_auth_username ⇒ Object

Returns the value of attribute sip_auth_username.



23
24
25
 
# File 'lib/zernio-sdk/models/enable_whats_app_calling_legacy_request.rb', line 23

def sip_auth_username
  @sip_auth_username
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



75
76
77
 
# File 'lib/zernio-sdk/models/enable_whats_app_calling_legacy_request.rb', line 75

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/zernio-sdk/models/enable_whats_app_calling_legacy_request.rb', line 80

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/zernio-sdk/models/enable_whats_app_calling_legacy_request.rb', line 61

def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'forward_to' => :'forwardTo',
    :'sip_auth_username' => :'sipAuthUsername',
    :'sip_auth_password' => :'sipAuthPassword',
    :'recording_enabled' => :'recordingEnabled',
    :'call_icon_countries' => :'callIconCountries',
    :'max_call_duration_seconds' => :'maxCallDurationSeconds',
    :'forward_caller_id' => :'forwardCallerId'
  }
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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/zernio-sdk/models/enable_whats_app_calling_legacy_request.rb', line 278

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/zernio-sdk/models/enable_whats_app_calling_legacy_request.rb', line 85

def self.openapi_types
  {
    :'account_id' => :'String',
    :'forward_to' => :'String',
    :'sip_auth_username' => :'String',
    :'sip_auth_password' => :'String',
    :'recording_enabled' => :'Boolean',
    :'call_icon_countries' => :'Array<String>',
    :'max_call_duration_seconds' => :'Integer',
    :'forward_caller_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/zernio-sdk/models/enable_whats_app_calling_legacy_request.rb', line 250

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      forward_to == o.forward_to &&
      sip_auth_username == o.sip_auth_username &&
      sip_auth_password == o.sip_auth_password &&
      recording_enabled == o.recording_enabled &&
      call_icon_countries == o.call_icon_countries &&
      max_call_duration_seconds == o.max_call_duration_seconds &&
      forward_caller_id == o.forward_caller_id
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


265
266
267
 
# File 'lib/zernio-sdk/models/enable_whats_app_calling_legacy_request.rb', line 265

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



271
272
273
 
# File 'lib/zernio-sdk/models/enable_whats_app_calling_legacy_request.rb', line 271

def hash
  [, forward_to, sip_auth_username, sip_auth_password, recording_enabled, call_icon_countries, max_call_duration_seconds, forward_caller_id].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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/zernio-sdk/models/enable_whats_app_calling_legacy_request.rb', line 165

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 @forward_to.nil?
    invalid_properties.push('invalid value for "forward_to", forward_to cannot be nil.')
  end

  if !@max_call_duration_seconds.nil? && @max_call_duration_seconds > 14400
    invalid_properties.push('invalid value for "max_call_duration_seconds", must be smaller than or equal to 14400.')
  end

  if !@max_call_duration_seconds.nil? && @max_call_duration_seconds < 30
    invalid_properties.push('invalid value for "max_call_duration_seconds", must be greater than or equal to 30.')
  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



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/zernio-sdk/models/enable_whats_app_calling_legacy_request.rb', line 300

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



189
190
191
192
193
194
195
196
197
198
 
# File 'lib/zernio-sdk/models/enable_whats_app_calling_legacy_request.rb', line 189

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @account_id.nil?
  return false if @forward_to.nil?
  return false if !@max_call_duration_seconds.nil? && @max_call_duration_seconds > 14400
  return false if !@max_call_duration_seconds.nil? && @max_call_duration_seconds < 30
  forward_caller_id_validator = EnumAttributeValidator.new('String', ["business", "caller"])
  return false unless forward_caller_id_validator.valid?(@forward_caller_id)
  true
end