Class: Zernio::PurchaseWhatsAppPhoneNumberRequest

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
110
111
112
 
# File 'lib/zernio-sdk/models/purchase_whats_app_phone_number_request.rb', line 73

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



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

def allow_multiple
  @allow_multiple
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/whatsapp/phone-numbers/countries.



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

def country
  @country
end

#phone_number ⇒ Object

One exact number to buy, in E.164, taken from GET /v1/phone-numbers/available. Fails with 409 code PHONE_NUMBER_UNAVAILABLE when it is no longer available.



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

def phone_number
  @phone_number
end

#profile_id ⇒ Object

Profile to associate the number with



19
20
21
 
# File 'lib/zernio-sdk/models/purchase_whats_app_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 } instead of provisioning a second number. Generate a fresh key for each genuinely new purchase.



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

def purchase_intent_id
  @purchase_intent_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



45
46
47
 
# File 'lib/zernio-sdk/models/purchase_whats_app_phone_number_request.rb', line 45

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



50
51
52
 
# File 'lib/zernio-sdk/models/purchase_whats_app_phone_number_request.rb', line 50

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'profile_id' => :'profileId',
    :'country' => :'country',
    :'phone_number' => :'phoneNumber',
    :'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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/zernio-sdk/models/purchase_whats_app_phone_number_request.rb', line 211

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'profile_id' => :'String',
    :'country' => :'String',
    :'phone_number' => :'String',
    :'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



186
187
188
189
190
191
192
193
194
 
# File 'lib/zernio-sdk/models/purchase_whats_app_phone_number_request.rb', line 186

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      profile_id == o.profile_id &&
      country == o.country &&
      phone_number == o.phone_number &&
      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


198
199
200
 
# File 'lib/zernio-sdk/models/purchase_whats_app_phone_number_request.rb', line 198

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



204
205
206
 
# File 'lib/zernio-sdk/models/purchase_whats_app_phone_number_request.rb', line 204

def hash
  [profile_id, country, phone_number, 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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/zernio-sdk/models/purchase_whats_app_phone_number_request.rb', line 116

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(/^\+[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



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/zernio-sdk/models/purchase_whats_app_phone_number_request.rb', line 233

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



137
138
139
140
141
142
143
 
# File 'lib/zernio-sdk/models/purchase_whats_app_phone_number_request.rb', line 137

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @profile_id.nil?
  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