Class: Zernio::PurchasePhoneNumberRequest

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
187
188
189
190
191
192
193
194
 
# File 'lib/zernio-sdk/models/purchase_phone_number_request.rb', line 125

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

  if attributes.key?(:'country')
    self.country = attributes[:'country']
  else
    self.country = 'US'
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#allow_multiple ⇒ Object

Any second purchase within 10 minutes of a previous one is rejected with 409 code PURCHASE_VELOCITY as duplicate protection. Pass true to confirm the additional purchase is intentional (e.g. bulk provisioning).



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

def allow_multiple
  @allow_multiple
end

#area_code ⇒ Object

Area code (national destination code, e.g. 11 for Sao Paulo) the number must be in. Hard constraint: when the area has no deliverable inventory the purchase fails with 409 code AREA_CODE_UNAVAILABLE instead of assigning a number from another area, and later replacements stay in this area too. Omit for any area. Get live options from GET /v1/phone-numbers/availability (areaOptions).



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

def area_code
  @area_code
end

#claim_id ⇒ Object

Keyless calls only: a claimId from a keyless GET /v1/phone-numbers/available. The 401 then carries a claimUrl for that exact number. Ignored when an API key is sent.



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

def claim_id
  @claim_id
end

#connect_whatsapp ⇒ Object

A phone number is the unit; WhatsApp is one optional feature. Pass false to buy a STANDALONE number (Calls/SMS only): provisioning skips the Meta pre-verify/OTP steps and the number activates immediately. Omitted defaults to the WhatsApp provisioning path. WhatsApp can be connected to a standalone number later from the connect flow.



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

def connect_whatsapp
  @connect_whatsapp
end

#country ⇒ Object

ISO 3166-1 alpha-2 country for the number (default US). International numbers require usage-based billing. Tier 3/4 countries return 202 { status: "kyc_required", kycUrl }. The customer must complete KYC at that URL before the number is ordered. See GET /v1/phone-numbers/countries.



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

def country
  @country
end

#number_type ⇒ Object

Which of the country's offered number types to order (see types[] on GET /v1/phone-numbers/countries). Omitted = the country's default type, which is always the WhatsApp-safe choice. Capabilities, price, and KYC requirements are per (country, type): toll_free can never connect WhatsApp (400 when combined with connectWhatsapp:true), and wantsSms:true requires an SMS-capable type.



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

def number_type
  @number_type
end

#phone_number ⇒ Object

One exact number to buy, in E.164, taken from GET /v1/phone-numbers/available. Hard constraint: when it is no longer available (bought by someone else, or WhatsApp's buy-time check rejects it) the purchase fails with 409 code PHONE_NUMBER_UNAVAILABLE instead of assigning another number; search again and pick another. Only for countries and types that activate instantly: a regulated one (202 kyc_required) returns 400 when phoneNumber is set.



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

def phone_number
  @phone_number
end

#profile_id ⇒ Object

Preferred profile for the number. One number = one profile, so when the requested profile already holds a number the API assigns the next free profile instead (or creates one) and returns the actual assignment in profileId on the response.



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

def profile_id
  @profile_id
end

#purchase_intent_id ⇒ Object

Optional idempotency key. Send the same value when retrying a purchase: if a number was already bought under this key, the API returns { status: "already_purchased", numberId, phoneNumber, profileId } instead of provisioning a second number. Generate a fresh key for each genuinely new purchase.



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

def purchase_intent_id
  @purchase_intent_id
end

#wants_sms ⇒ Object

SMS capability is per-number, not per-country. Pass true to provision from the SMS-capable inventory pool so the number can actually text (see also GET /v1/phone-numbers/available with sms=true, and smsAvailable on GET /v1/phone-numbers/countries).



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

def wants_sms
  @wants_sms
end

#wants_whatsapp ⇒ Object

Declare WhatsApp intent on a STANDALONE purchase (connectWhatsapp:false). The number still activates and bills immediately, but if WhatsApp's buy-time check rejects the assigned number, it is automatically swapped for a WhatsApp-eligible one during the purchase instead of being delivered with WhatsApp unavailable. Ignored on the WhatsApp provisioning path (connectWhatsapp omitted or true), which always delivers a WhatsApp-verified number.



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

def wants_whatsapp
  @wants_whatsapp
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



91
92
93
 
# File 'lib/zernio-sdk/models/purchase_phone_number_request.rb', line 91

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



96
97
98
 
# File 'lib/zernio-sdk/models/purchase_phone_number_request.rb', line 96

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/zernio-sdk/models/purchase_phone_number_request.rb', line 74

def self.attribute_map
  {
    :'profile_id' => :'profileId',
    :'country' => :'country',
    :'number_type' => :'numberType',
    :'area_code' => :'areaCode',
    :'claim_id' => :'claimId',
    :'phone_number' => :'phoneNumber',
    :'connect_whatsapp' => :'connectWhatsapp',
    :'wants_sms' => :'wantsSms',
    :'wants_whatsapp' => :'wantsWhatsapp',
    :'purchase_intent_id' => :'purchaseIntentId',
    :'allow_multiple' => :'allowMultiple'
  }
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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/zernio-sdk/models/purchase_phone_number_request.rb', line 332

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



118
119
120
121
 
# File 'lib/zernio-sdk/models/purchase_phone_number_request.rb', line 118

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

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/zernio-sdk/models/purchase_phone_number_request.rb', line 101

def self.openapi_types
  {
    :'profile_id' => :'String',
    :'country' => :'String',
    :'number_type' => :'String',
    :'area_code' => :'String',
    :'claim_id' => :'String',
    :'phone_number' => :'String',
    :'connect_whatsapp' => :'Boolean',
    :'wants_sms' => :'Boolean',
    :'wants_whatsapp' => :'Boolean',
    :'purchase_intent_id' => :'String',
    :'allow_multiple' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      profile_id == o.profile_id &&
      country == o.country &&
      number_type == o.number_type &&
      area_code == o.area_code &&
      claim_id == o.claim_id &&
      phone_number == o.phone_number &&
      connect_whatsapp == o.connect_whatsapp &&
      wants_sms == o.wants_sms &&
      wants_whatsapp == o.wants_whatsapp &&
      purchase_intent_id == o.purchase_intent_id &&
      allow_multiple == o.allow_multiple
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


319
320
321
 
# File 'lib/zernio-sdk/models/purchase_phone_number_request.rb', line 319

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



325
326
327
 
# File 'lib/zernio-sdk/models/purchase_phone_number_request.rb', line 325

def hash
  [profile_id, country, number_type, area_code, claim_id, phone_number, connect_whatsapp, wants_sms, wants_whatsapp, purchase_intent_id, allow_multiple].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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/zernio-sdk/models/purchase_phone_number_request.rb', line 198

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

  pattern = Regexp.new(/^\d{1,4}$/)
  if !@area_code.nil? && @area_code !~ pattern
    invalid_properties.push("invalid value for \"area_code\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^\+[1-9]\d{6,14}$/)
  if !@phone_number.nil? && @phone_number !~ pattern
    invalid_properties.push("invalid value for \"phone_number\", must conform to the pattern #{pattern}.")
  end

  if !@purchase_intent_id.nil? && @purchase_intent_id.to_s.length > 100
    invalid_properties.push('invalid value for "purchase_intent_id", the character length must be smaller than or equal to 100.')
  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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/zernio-sdk/models/purchase_phone_number_request.rb', line 354

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



224
225
226
227
228
229
230
231
232
233
 
# File 'lib/zernio-sdk/models/purchase_phone_number_request.rb', line 224

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @profile_id.nil?
  number_type_validator = EnumAttributeValidator.new('String', ["local", "mobile", "national", "toll_free"])
  return false unless number_type_validator.valid?(@number_type)
  return false if !@area_code.nil? && @area_code !~ Regexp.new(/^\d{1,4}$/)
  return false if !@phone_number.nil? && @phone_number !~ Regexp.new(/^\+[1-9]\d{6,14}$/)
  return false if !@purchase_intent_id.nil? && @purchase_intent_id.to_s.length > 100
  true
end