late-sdk 0.0.569 → 0.0.570

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af548c7e84d5e28558c9bb866589f466987ba64c06476f8f472cf4d36e99eb7e
-  data.tar.gz: f66c0904d7cfafa0c38460b5b724e97d23643b09ba9f394f26cb2fc5f857bebb
+  metadata.gz: c6662697b65680201c5406dc215197a7698d35f9eb962faaf4b131add23906cb
+  data.tar.gz: 53a2f69256a9bd88806d40e70be0aaa70bb415d5fccb72fa99c9ca9f8f6c0aa8
 SHA512:
-  metadata.gz: d2ab78049256ae5e7536f0d074f754a7d297a4057bf3bdbb43d48714c60fe6d2b97712b6495764c173e92a1ca38d5ae23aeb34ceba57877d022c3c1bf1e485e8
-  data.tar.gz: 0ff504fcfef7f895fea9b98faf8417f33950f508aceeb1d77ae1859300201928584e916b578ac3b56e22268fa1053146051942db849978f9de3262c485803cfd
+  metadata.gz: a794eb29b649101ab9b233ca322079b4141b15d7440222181ff56ff2f99a3320d6785abb4160d22770b9a5af7433a6e52f6f65a377d58c4299834fa1c7ec5322
+  data.tar.gz: e6ec84fb9678b5043b3edca764f0b1a3d4a140a84d127da39ea20591833a734bcc27ae57fb5094565c689e1d27cdd9bf1df1f8f79644e5cebe9e266fc5710614

data/README.md

@@ -695,6 +695,7 @@ Class | Method | HTTP request | Description
  - [Zernio::CancelBroadcast200Response](docs/CancelBroadcast200Response.md)
  - [Zernio::CancelPhoneNumberPortIn200Response](docs/CancelPhoneNumberPortIn200Response.md)
  - [Zernio::CheckPhoneNumberAvailability200Response](docs/CheckPhoneNumberAvailability200Response.md)
+ - [Zernio::CheckPhoneNumberAvailability200ResponseAreaOptionsInner](docs/CheckPhoneNumberAvailability200ResponseAreaOptionsInner.md)
  - [Zernio::CheckPhoneNumberPortability200Response](docs/CheckPhoneNumberPortability200Response.md)
  - [Zernio::CheckPhoneNumberPortability200ResponseResultsInner](docs/CheckPhoneNumberPortability200ResponseResultsInner.md)
  - [Zernio::CheckPhoneNumberPortabilityRequest](docs/CheckPhoneNumberPortabilityRequest.md)

data/docs/CheckPhoneNumberAvailability200Response.md

@@ -9,6 +9,7 @@
 | **available** | **Boolean** | Whether deliverable voice inventory exists right now. | [optional] |
 | **address_constraint** | **String** |  | [optional] |
 | **areas** | **Array<String>** | For `geo` only — the area(s) the registered address must be in. | [optional] |
+| **area_options** | [**Array<CheckPhoneNumberAvailability200ResponseAreaOptionsInner>**](CheckPhoneNumberAvailability200ResponseAreaOptionsInner.md) | Live inventory grouped by area code, largest stock first. Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area.  | [optional] |
 
 ## Example
 
@@ -20,7 +21,8 @@ instance = Zernio::CheckPhoneNumberAvailability200Response.new(
   number_type: null,
   available: null,
   address_constraint: null,
-  areas: null
+  areas: null,
+  area_options: null
 )
 ```
 

data/docs/CheckPhoneNumberAvailability200ResponseAreaOptionsInner.md

@@ -0,0 +1,22 @@
+# Zernio::CheckPhoneNumberAvailability200ResponseAreaOptionsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ndc** | **String** | Area code (national destination code), e.g. \"11\". | [optional] |
+| **name** | **String** | Human-readable area name, e.g. \"Sao Paulo\". | [optional] |
+| **count** | **Integer** | Deliverable numbers seen in this area on the latest inventory page. | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::CheckPhoneNumberAvailability200ResponseAreaOptionsInner.new(
+  ndc: null,
+  name: null,
+  count: null
+)
+```
+

data/docs/CreatePhoneNumberKycLinkRequest.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **profile_id** | **String** |  |  |
 | **country** | **String** | ISO 3166-1 alpha-2 country code (must be a regulated/KYC country). |  |
+| **area_code** | **String** | Area code (NDC) the eventual number must be in. Hard constraint carried by the link; the end customer filling the form makes no area choice. Options come from GET /v1/phone-numbers/availability (areaOptions). | [optional] |
 | **branding** | [**CreatePhoneNumberKycLinkRequestBranding**](CreatePhoneNumberKycLinkRequestBranding.md) |  | [optional] |
 | **redirect_url** | **String** | Where to send the end customer's browser after a successful submit. On completion Zernio appends `kyc=submitted` and `country=<ISO-2>` as query params. When omitted, the hosted page shows a built-in confirmation screen instead.  | [optional] |
 
@@ -17,6 +18,7 @@ require 'zernio-sdk'
 instance = Zernio::CreatePhoneNumberKycLinkRequest.new(
   profile_id: null,
   country: null,
+  area_code: null,
   branding: null,
   redirect_url: null
 )

data/docs/PhoneNumbersApi.md

@@ -122,7 +122,8 @@ end
 api_instance = Zernio::PhoneNumbersApi.new
 country = 'country_example' # String | ISO-2 country code.
 opts = {
-  number_type: 'local' # String | Check a specific offered type (stock and address constraints are per type). Omitted = the country's default type.
+  number_type: 'local', # String | Check a specific offered type (stock and address constraints are per type). Omitted = the country's default type.
+  sms: true # Boolean | Pass true when the buyer wants SMS: availability, areas, and areaOptions then describe the SMS-capable pool (an SMS purchase orders from it), not the wider voice-only pool.
 }
 
 begin
@@ -158,6 +159,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **country** | **String** | ISO-2 country code. |  |
 | **number_type** | **String** | Check a specific offered type (stock and address constraints are per type). Omitted = the country's default type. | [optional] |
+| **sms** | **Boolean** | Pass true when the buyer wants SMS: availability, areas, and areaOptions then describe the SMS-capable pool (an SMS purchase orders from it), not the wider voice-only pool. | [optional] |
 
 ### Return type
 

data/docs/PurchasePhoneNumberRequest.md

@@ -7,6 +7,7 @@
 | **profile_id** | **String** | Profile to associate the number with |  |
 | **country** | **String** | 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.  | [optional][default to 'US'] |
 | **number_type** | **String** | 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.  | [optional] |
+| **area_code** | **String** | 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).  | [optional] |
 | **connect_whatsapp** | **Boolean** | 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.  | [optional][default to true] |
 | **wants_sms** | **Boolean** | 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).  | [optional][default to false] |
 | **wants_whatsapp** | **Boolean** | 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.  | [optional][default to false] |
@@ -22,6 +23,7 @@ instance = Zernio::PurchasePhoneNumberRequest.new(
   profile_id: null,
   country: null,
   number_type: null,
+  area_code: null,
   connect_whatsapp: null,
   wants_sms: null,
   wants_whatsapp: null,

data/docs/SubmitPhoneNumberKycRequest.md

@@ -11,6 +11,7 @@
 | **reuse** | **Boolean** | Reuse a prior approved verification for this country (skips document/field collection; places the order immediately). | [optional] |
 | **reuse_option_id** | **String** | Which reusable verification to use (GET reusable.options[].id). The unambiguous selection key. Omitted = the approved default. No match = 409. | [optional] |
 | **reuse_from** | **String** | Legacy fallback for `reuseOptionId`: the source phone number (GET reusable.options[].fromPhoneNumber). Ambiguous when a number labels two verifications — prefer `reuseOptionId`. Omitted = the approved default. No match = 409. | [optional] |
+| **area_code** | **String** | Area code (NDC) the number must be in. Hard constraint: an empty area pool fails with 409 code AREA_CODE_UNAVAILABLE instead of ordering from another area. Omit for any area. Options come from GET /v1/phone-numbers/availability (areaOptions); the purchase 202 kycUrl echoes the areaCode picked at purchase time so it can be passed here. | [optional] |
 | **end_user_first_name** | **String** | End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement. | [optional] |
 | **end_user_last_name** | **String** | End user's legal last name. Same condition as endUserFirstName. | [optional] |
 | **values** | **Hash<String, String>** | requirementId → textual value | [optional] |
@@ -30,6 +31,7 @@ instance = Zernio::SubmitPhoneNumberKycRequest.new(
   reuse: null,
   reuse_option_id: null,
   reuse_from: null,
+  area_code: null,
   end_user_first_name: null,
   end_user_last_name: null,
   values: null,

data/docs/SubmitWhatsAppNumberKycRequest.md

@@ -11,6 +11,7 @@
 | **reuse** | **Boolean** | Reuse a prior approved verification for this country (skips document/field collection; places the order immediately). | [optional] |
 | **reuse_option_id** | **String** | Which reusable verification to use (GET reusable.options[].id). The unambiguous selection key. Omitted = the approved default. No match = 409. | [optional] |
 | **reuse_from** | **String** | Legacy fallback for `reuseOptionId`: the source phone number (GET reusable.options[].fromPhoneNumber). Ambiguous when a number labels two verifications — prefer `reuseOptionId`. Omitted = the approved default. No match = 409. | [optional] |
+| **area_code** | **String** | Area code (NDC) the number must be in. Hard constraint: an empty area pool fails with 409 code AREA_CODE_UNAVAILABLE instead of ordering from another area. Omit for any area. Options come from GET /v1/phone-numbers/availability (areaOptions); the purchase 202 kycUrl echoes the areaCode picked at purchase time so it can be passed here. | [optional] |
 | **end_user_first_name** | **String** | End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement. | [optional] |
 | **end_user_last_name** | **String** | End user's legal last name. Same condition as endUserFirstName. | [optional] |
 | **values** | **Hash<String, String>** | requirementId → textual value | [optional] |
@@ -30,6 +31,7 @@ instance = Zernio::SubmitWhatsAppNumberKycRequest.new(
   reuse: null,
   reuse_option_id: null,
   reuse_from: null,
+  area_code: null,
   end_user_first_name: null,
   end_user_last_name: null,
   values: null,

data/docs/WhatsAppPhoneNumbersApi.md

@@ -43,7 +43,8 @@ end
 api_instance = Zernio::WhatsAppPhoneNumbersApi.new
 country = 'country_example' # String | ISO-2 country code.
 opts = {
-  number_type: 'local' # String | Check a specific offered type (stock and address constraints are per type). Omitted = the country's default type.
+  number_type: 'local', # String | Check a specific offered type (stock and address constraints are per type). Omitted = the country's default type.
+  sms: true # Boolean | Pass true when the buyer wants SMS: availability, areas, and areaOptions then describe the SMS-capable pool (an SMS purchase orders from it), not the wider voice-only pool.
 }
 
 begin
@@ -79,6 +80,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **country** | **String** | ISO-2 country code. |  |
 | **number_type** | **String** | Check a specific offered type (stock and address constraints are per type). Omitted = the country's default type. | [optional] |
+| **sms** | **Boolean** | Pass true when the buyer wants SMS: availability, areas, and areaOptions then describe the SMS-capable pool (an SMS purchase orders from it), not the wider voice-only pool. | [optional] |
 
 ### Return type
 

data/lib/zernio-sdk/api/phone_numbers_api.rb

@@ -87,6 +87,7 @@ module Zernio
     # @param country [String] ISO-2 country code.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :number_type Check a specific offered type (stock and address constraints are per type). Omitted = the country's default type.
+    # @option opts [Boolean] :sms Pass true when the buyer wants SMS: availability, areas, and areaOptions then describe the SMS-capable pool (an SMS purchase orders from it), not the wider voice-only pool.
     # @return [CheckPhoneNumberAvailability200Response]
     def check_phone_number_availability(country, opts = {})
       data, _status_code, _headers = check_phone_number_availability_with_http_info(country, opts)
@@ -98,6 +99,7 @@ module Zernio
     # @param country [String] ISO-2 country code.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :number_type Check a specific offered type (stock and address constraints are per type). Omitted = the country's default type.
+    # @option opts [Boolean] :sms Pass true when the buyer wants SMS: availability, areas, and areaOptions then describe the SMS-capable pool (an SMS purchase orders from it), not the wider voice-only pool.
     # @return [Array<(CheckPhoneNumberAvailability200Response, Integer, Hash)>] CheckPhoneNumberAvailability200Response data, response status code and response headers
     def check_phone_number_availability_with_http_info(country, opts = {})
       if @api_client.config.debugging
@@ -118,6 +120,7 @@ module Zernio
       query_params = opts[:query_params] || {}
       query_params[:'country'] = country
       query_params[:'numberType'] = opts[:'number_type'] if !opts[:'number_type'].nil?
+      query_params[:'sms'] = opts[:'sms'] if !opts[:'sms'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/zernio-sdk/api/whats_app_phone_numbers_api.rb

@@ -24,6 +24,7 @@ module Zernio
     # @param country [String] ISO-2 country code.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :number_type Check a specific offered type (stock and address constraints are per type). Omitted = the country's default type.
+    # @option opts [Boolean] :sms Pass true when the buyer wants SMS: availability, areas, and areaOptions then describe the SMS-capable pool (an SMS purchase orders from it), not the wider voice-only pool.
     # @return [CheckPhoneNumberAvailability200Response]
     def check_whats_app_number_availability(country, opts = {})
       data, _status_code, _headers = check_whats_app_number_availability_with_http_info(country, opts)
@@ -35,6 +36,7 @@ module Zernio
     # @param country [String] ISO-2 country code.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :number_type Check a specific offered type (stock and address constraints are per type). Omitted = the country's default type.
+    # @option opts [Boolean] :sms Pass true when the buyer wants SMS: availability, areas, and areaOptions then describe the SMS-capable pool (an SMS purchase orders from it), not the wider voice-only pool.
     # @return [Array<(CheckPhoneNumberAvailability200Response, Integer, Hash)>] CheckPhoneNumberAvailability200Response data, response status code and response headers
     def check_whats_app_number_availability_with_http_info(country, opts = {})
       if @api_client.config.debugging
@@ -55,6 +57,7 @@ module Zernio
       query_params = opts[:query_params] || {}
       query_params[:'country'] = country
       query_params[:'numberType'] = opts[:'number_type'] if !opts[:'number_type'].nil?
+      query_params[:'sms'] = opts[:'sms'] if !opts[:'sms'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/zernio-sdk/models/check_phone_number_availability200_response.rb

@@ -27,6 +27,9 @@ module Zernio
     # For `geo` only — the area(s) the registered address must be in.
     attr_accessor :areas
 
+    # Live inventory grouped by area code, largest stock first. Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area. 
+    attr_accessor :area_options
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -56,7 +59,8 @@ module Zernio
         :'number_type' => :'numberType',
         :'available' => :'available',
         :'address_constraint' => :'addressConstraint',
-        :'areas' => :'areas'
+        :'areas' => :'areas',
+        :'area_options' => :'areaOptions'
       }
     end
 
@@ -77,7 +81,8 @@ module Zernio
         :'number_type' => :'String',
         :'available' => :'Boolean',
         :'address_constraint' => :'String',
-        :'areas' => :'Array<String>'
+        :'areas' => :'Array<String>',
+        :'area_options' => :'Array<CheckPhoneNumberAvailability200ResponseAreaOptionsInner>'
       }
     end
 
@@ -124,6 +129,12 @@ module Zernio
           self.areas = value
         end
       end
+
+      if attributes.key?(:'area_options')
+        if (value = attributes[:'area_options']).is_a?(Array)
+          self.area_options = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -162,7 +173,8 @@ module Zernio
           number_type == o.number_type &&
           available == o.available &&
           address_constraint == o.address_constraint &&
-          areas == o.areas
+          areas == o.areas &&
+          area_options == o.area_options
     end
 
     # @see the `==` method
@@ -174,7 +186,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [country, number_type, available, address_constraint, areas].hash
+      [country, number_type, available, address_constraint, areas, area_options].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/models/check_phone_number_availability200_response_area_options_inner.rb

@@ -0,0 +1,168 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api 
+
+The version of the OpenAPI document: 1.0.4
+Contact: support@zernio.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zernio
+  class CheckPhoneNumberAvailability200ResponseAreaOptionsInner < ApiModelBase
+    # Area code (national destination code), e.g. \"11\".
+    attr_accessor :ndc
+
+    # Human-readable area name, e.g. \"Sao Paulo\".
+    attr_accessor :name
+
+    # Deliverable numbers seen in this area on the latest inventory page.
+    attr_accessor :count
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ndc' => :'ndc',
+        :'name' => :'name',
+        :'count' => :'count'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'ndc' => :'String',
+        :'name' => :'String',
+        :'count' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::CheckPhoneNumberAvailability200ResponseAreaOptionsInner` 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::CheckPhoneNumberAvailability200ResponseAreaOptionsInner`. 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?(:'ndc')
+        self.ndc = attributes[:'ndc']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'count')
+        self.count = attributes[:'count']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          ndc == o.ndc &&
+          name == o.name &&
+          count == o.count
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [ndc, name, count].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+  end
+
+end

data/lib/zernio-sdk/models/create_phone_number_kyc_link_request.rb

@@ -20,6 +20,9 @@ module Zernio
     # ISO 3166-1 alpha-2 country code (must be a regulated/KYC country).
     attr_accessor :country
 
+    # Area code (NDC) the eventual number must be in. Hard constraint carried by the link; the end customer filling the form makes no area choice. Options come from GET /v1/phone-numbers/availability (areaOptions).
+    attr_accessor :area_code
+
     attr_accessor :branding
 
     # Where to send the end customer's browser after a successful submit. On completion Zernio appends `kyc=submitted` and `country=<ISO-2>` as query params. When omitted, the hosted page shows a built-in confirmation screen instead. 
@@ -30,6 +33,7 @@ module Zernio
       {
         :'profile_id' => :'profileId',
         :'country' => :'country',
+        :'area_code' => :'areaCode',
         :'branding' => :'branding',
         :'redirect_url' => :'redirect_url'
       }
@@ -50,6 +54,7 @@ module Zernio
       {
         :'profile_id' => :'String',
         :'country' => :'String',
+        :'area_code' => :'String',
         :'branding' => :'CreatePhoneNumberKycLinkRequestBranding',
         :'redirect_url' => :'String'
       }
@@ -89,6 +94,10 @@ module Zernio
         self.country = nil
       end
 
+      if attributes.key?(:'area_code')
+        self.area_code = attributes[:'area_code']
+      end
+
       if attributes.key?(:'branding')
         self.branding = attributes[:'branding']
       end
@@ -119,6 +128,11 @@ module Zernio
         invalid_properties.push('invalid value for "country", the character length must be greater than or equal to 2.')
       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
+
       invalid_properties
     end
 
@@ -130,6 +144,7 @@ module Zernio
       return false if @country.nil?
       return false if @country.to_s.length > 2
       return false if @country.to_s.length < 2
+      return false if !@area_code.nil? && @area_code !~ Regexp.new(/^\d{1,4}$/)
       true
     end
 
@@ -161,6 +176,21 @@ module Zernio
       @country = country
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] area_code Value to be assigned
+    def area_code=(area_code)
+      if area_code.nil?
+        fail ArgumentError, 'area_code cannot be nil'
+      end
+
+      pattern = Regexp.new(/^\d{1,4}$/)
+      if area_code !~ pattern
+        fail ArgumentError, "invalid value for \"area_code\", must conform to the pattern #{pattern}."
+      end
+
+      @area_code = area_code
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -168,6 +198,7 @@ module Zernio
       self.class == o.class &&
           profile_id == o.profile_id &&
           country == o.country &&
+          area_code == o.area_code &&
           branding == o.branding &&
           redirect_url == o.redirect_url
     end
@@ -181,7 +212,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [profile_id, country, branding, redirect_url].hash
+      [profile_id, country, area_code, branding, redirect_url].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/models/purchase_phone_number409_response.rb

@@ -110,7 +110,7 @@ module Zernio
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      code_validator = EnumAttributeValidator.new('String', ["PURCHASE_VELOCITY"])
+      code_validator = EnumAttributeValidator.new('String', ["PURCHASE_VELOCITY", "AREA_CODE_UNAVAILABLE"])
       return false unless code_validator.valid?(@code)
       true
     end
@@ -118,7 +118,7 @@ module Zernio
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] code Object to be assigned
     def code=(code)
-      validator = EnumAttributeValidator.new('String', ["PURCHASE_VELOCITY"])
+      validator = EnumAttributeValidator.new('String', ["PURCHASE_VELOCITY", "AREA_CODE_UNAVAILABLE"])
       unless validator.valid?(code)
         fail ArgumentError, "invalid value for \"code\", must be one of #{validator.allowable_values}."
       end

data/lib/zernio-sdk/models/purchase_phone_number_request.rb

@@ -24,6 +24,9 @@ module Zernio
     # 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. 
     attr_accessor :number_type
 
+    # 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). 
+    attr_accessor :area_code
+
     # 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. 
     attr_accessor :connect_whatsapp
 
@@ -67,6 +70,7 @@ module Zernio
         :'profile_id' => :'profileId',
         :'country' => :'country',
         :'number_type' => :'numberType',
+        :'area_code' => :'areaCode',
         :'connect_whatsapp' => :'connectWhatsapp',
         :'wants_sms' => :'wantsSms',
         :'wants_whatsapp' => :'wantsWhatsapp',
@@ -91,6 +95,7 @@ module Zernio
         :'profile_id' => :'String',
         :'country' => :'String',
         :'number_type' => :'String',
+        :'area_code' => :'String',
         :'connect_whatsapp' => :'Boolean',
         :'wants_sms' => :'Boolean',
         :'wants_whatsapp' => :'Boolean',
@@ -137,6 +142,10 @@ module Zernio
         self.number_type = attributes[:'number_type']
       end
 
+      if attributes.key?(:'area_code')
+        self.area_code = attributes[:'area_code']
+      end
+
       if attributes.key?(:'connect_whatsapp')
         self.connect_whatsapp = attributes[:'connect_whatsapp']
       else
@@ -175,6 +184,11 @@ module Zernio
         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
+
       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
@@ -189,6 +203,7 @@ module Zernio
       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 !@purchase_intent_id.nil? && @purchase_intent_id.to_s.length > 100
       true
     end
@@ -213,6 +228,21 @@ module Zernio
       @number_type = number_type
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] area_code Value to be assigned
+    def area_code=(area_code)
+      if area_code.nil?
+        fail ArgumentError, 'area_code cannot be nil'
+      end
+
+      pattern = Regexp.new(/^\d{1,4}$/)
+      if area_code !~ pattern
+        fail ArgumentError, "invalid value for \"area_code\", must conform to the pattern #{pattern}."
+      end
+
+      @area_code = area_code
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] purchase_intent_id Value to be assigned
     def purchase_intent_id=(purchase_intent_id)
@@ -235,6 +265,7 @@ module Zernio
           profile_id == o.profile_id &&
           country == o.country &&
           number_type == o.number_type &&
+          area_code == o.area_code &&
           connect_whatsapp == o.connect_whatsapp &&
           wants_sms == o.wants_sms &&
           wants_whatsapp == o.wants_whatsapp &&
@@ -251,7 +282,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [profile_id, country, number_type, connect_whatsapp, wants_sms, wants_whatsapp, purchase_intent_id, allow_multiple].hash
+      [profile_id, country, number_type, area_code, connect_whatsapp, wants_sms, wants_whatsapp, purchase_intent_id, allow_multiple].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/models/submit_phone_number_kyc_request.rb

@@ -34,6 +34,9 @@ module Zernio
     # Legacy fallback for `reuseOptionId`: the source phone number (GET reusable.options[].fromPhoneNumber). Ambiguous when a number labels two verifications — prefer `reuseOptionId`. Omitted = the approved default. No match = 409.
     attr_accessor :reuse_from
 
+    # Area code (NDC) the number must be in. Hard constraint: an empty area pool fails with 409 code AREA_CODE_UNAVAILABLE instead of ordering from another area. Omit for any area. Options come from GET /v1/phone-numbers/availability (areaOptions); the purchase 202 kycUrl echoes the areaCode picked at purchase time so it can be passed here.
+    attr_accessor :area_code
+
     # End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement.
     attr_accessor :end_user_first_name
 
@@ -58,6 +61,7 @@ module Zernio
         :'reuse' => :'reuse',
         :'reuse_option_id' => :'reuseOptionId',
         :'reuse_from' => :'reuseFrom',
+        :'area_code' => :'areaCode',
         :'end_user_first_name' => :'endUserFirstName',
         :'end_user_last_name' => :'endUserLastName',
         :'values' => :'values',
@@ -86,6 +90,7 @@ module Zernio
         :'reuse' => :'Boolean',
         :'reuse_option_id' => :'String',
         :'reuse_from' => :'String',
+        :'area_code' => :'String',
         :'end_user_first_name' => :'String',
         :'end_user_last_name' => :'String',
         :'values' => :'Hash<String, String>',
@@ -150,6 +155,10 @@ module Zernio
         self.reuse_from = attributes[:'reuse_from']
       end
 
+      if attributes.key?(:'area_code')
+        self.area_code = attributes[:'area_code']
+      end
+
       if attributes.key?(:'end_user_first_name')
         self.end_user_first_name = attributes[:'end_user_first_name']
       end
@@ -196,6 +205,11 @@ module Zernio
         invalid_properties.push('invalid value for "quantity", must be greater than or equal to 1.')
       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
+
       invalid_properties
     end
 
@@ -207,6 +221,7 @@ module Zernio
       return false if @country.nil?
       return false if !@quantity.nil? && @quantity > 5
       return false if !@quantity.nil? && @quantity < 1
+      return false if !@area_code.nil? && @area_code !~ Regexp.new(/^\d{1,4}$/)
       true
     end
 
@@ -248,6 +263,21 @@ module Zernio
       @quantity = quantity
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] area_code Value to be assigned
+    def area_code=(area_code)
+      if area_code.nil?
+        fail ArgumentError, 'area_code cannot be nil'
+      end
+
+      pattern = Regexp.new(/^\d{1,4}$/)
+      if area_code !~ pattern
+        fail ArgumentError, "invalid value for \"area_code\", must conform to the pattern #{pattern}."
+      end
+
+      @area_code = area_code
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -260,6 +290,7 @@ module Zernio
           reuse == o.reuse &&
           reuse_option_id == o.reuse_option_id &&
           reuse_from == o.reuse_from &&
+          area_code == o.area_code &&
           end_user_first_name == o.end_user_first_name &&
           end_user_last_name == o.end_user_last_name &&
           values == o.values &&
@@ -276,7 +307,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [profile_id, country, submission_id, quantity, reuse, reuse_option_id, reuse_from, end_user_first_name, end_user_last_name, values, documents, address].hash
+      [profile_id, country, submission_id, quantity, reuse, reuse_option_id, reuse_from, area_code, end_user_first_name, end_user_last_name, values, documents, address].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/models/submit_whats_app_number_kyc_request.rb

@@ -34,6 +34,9 @@ module Zernio
     # Legacy fallback for `reuseOptionId`: the source phone number (GET reusable.options[].fromPhoneNumber). Ambiguous when a number labels two verifications — prefer `reuseOptionId`. Omitted = the approved default. No match = 409.
     attr_accessor :reuse_from
 
+    # Area code (NDC) the number must be in. Hard constraint: an empty area pool fails with 409 code AREA_CODE_UNAVAILABLE instead of ordering from another area. Omit for any area. Options come from GET /v1/phone-numbers/availability (areaOptions); the purchase 202 kycUrl echoes the areaCode picked at purchase time so it can be passed here.
+    attr_accessor :area_code
+
     # End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement.
     attr_accessor :end_user_first_name
 
@@ -58,6 +61,7 @@ module Zernio
         :'reuse' => :'reuse',
         :'reuse_option_id' => :'reuseOptionId',
         :'reuse_from' => :'reuseFrom',
+        :'area_code' => :'areaCode',
         :'end_user_first_name' => :'endUserFirstName',
         :'end_user_last_name' => :'endUserLastName',
         :'values' => :'values',
@@ -86,6 +90,7 @@ module Zernio
         :'reuse' => :'Boolean',
         :'reuse_option_id' => :'String',
         :'reuse_from' => :'String',
+        :'area_code' => :'String',
         :'end_user_first_name' => :'String',
         :'end_user_last_name' => :'String',
         :'values' => :'Hash<String, String>',
@@ -150,6 +155,10 @@ module Zernio
         self.reuse_from = attributes[:'reuse_from']
       end
 
+      if attributes.key?(:'area_code')
+        self.area_code = attributes[:'area_code']
+      end
+
       if attributes.key?(:'end_user_first_name')
         self.end_user_first_name = attributes[:'end_user_first_name']
       end
@@ -196,6 +205,11 @@ module Zernio
         invalid_properties.push('invalid value for "quantity", must be greater than or equal to 1.')
       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
+
       invalid_properties
     end
 
@@ -207,6 +221,7 @@ module Zernio
       return false if @country.nil?
       return false if !@quantity.nil? && @quantity > 5
       return false if !@quantity.nil? && @quantity < 1
+      return false if !@area_code.nil? && @area_code !~ Regexp.new(/^\d{1,4}$/)
       true
     end
 
@@ -248,6 +263,21 @@ module Zernio
       @quantity = quantity
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] area_code Value to be assigned
+    def area_code=(area_code)
+      if area_code.nil?
+        fail ArgumentError, 'area_code cannot be nil'
+      end
+
+      pattern = Regexp.new(/^\d{1,4}$/)
+      if area_code !~ pattern
+        fail ArgumentError, "invalid value for \"area_code\", must conform to the pattern #{pattern}."
+      end
+
+      @area_code = area_code
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -260,6 +290,7 @@ module Zernio
           reuse == o.reuse &&
           reuse_option_id == o.reuse_option_id &&
           reuse_from == o.reuse_from &&
+          area_code == o.area_code &&
           end_user_first_name == o.end_user_first_name &&
           end_user_last_name == o.end_user_last_name &&
           values == o.values &&
@@ -276,7 +307,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [profile_id, country, submission_id, quantity, reuse, reuse_option_id, reuse_from, end_user_first_name, end_user_last_name, values, documents, address].hash
+      [profile_id, country, submission_id, quantity, reuse, reuse_option_id, reuse_from, area_code, end_user_first_name, end_user_last_name, values, documents, address].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.19.0
 =end
 
 module Zernio
-  VERSION = '0.0.569'
+  VERSION = '0.0.570'
 end

data/lib/zernio-sdk.rb

@@ -124,6 +124,7 @@ require 'zernio-sdk/models/call_record_transcript_inner'
 require 'zernio-sdk/models/cancel_broadcast200_response'
 require 'zernio-sdk/models/cancel_phone_number_port_in200_response'
 require 'zernio-sdk/models/check_phone_number_availability200_response'
+require 'zernio-sdk/models/check_phone_number_availability200_response_area_options_inner'
 require 'zernio-sdk/models/check_phone_number_portability200_response'
 require 'zernio-sdk/models/check_phone_number_portability200_response_results_inner'
 require 'zernio-sdk/models/check_phone_number_portability_request'

data/openapi.yaml

@@ -27899,6 +27899,17 @@ paths:
                     connect WhatsApp (400 when combined with
                     connectWhatsapp:true), and wantsSms:true requires an
                     SMS-capable type.
+                areaCode:
+                  type: string
+                  pattern: '^\d{1,4}$'
+                  description: >
+                    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).
                 connectWhatsapp:
                   type: boolean
                   default: true
@@ -27990,16 +28001,18 @@ paths:
         '403': { description: A paid plan is required }
         '409':
           description: >
-            Duplicate-purchase protection: another number was purchased for
-            this user within the last 10 minutes. Retry with allowMultiple:
-            true to confirm the additional purchase is intentional.
+            Either duplicate-purchase protection (code PURCHASE_VELOCITY:
+            another number was purchased within the last 10 minutes; retry
+            with allowMultiple: true to confirm), or the requested areaCode
+            has no deliverable inventory right now (code
+            AREA_CODE_UNAVAILABLE: pick another area or omit areaCode).
           content:
             application/json:
               schema:
                 type: object
                 properties:
                   error: { type: string }
-                  code: { type: string, enum: [PURCHASE_VELOCITY] }
+                  code: { type: string, enum: [PURCHASE_VELOCITY, AREA_CODE_UNAVAILABLE] }
         '202':
           description: Country requires end-user KYC before the number can be ordered.
           content:
@@ -28132,6 +28145,7 @@ paths:
       parameters:
         - { name: country, in: query, required: true, schema: { type: string }, description: ISO-2 country code. }
         - { name: numberType, in: query, required: false, schema: { type: string, enum: [local, mobile, national, toll_free] }, description: "Check a specific offered type (stock and address constraints are per type). Omitted = the country's default type." }
+        - { name: sms, in: query, required: false, schema: { type: boolean }, description: 'Pass true when the buyer wants SMS: availability, areas, and areaOptions then describe the SMS-capable pool (an SMS purchase orders from it), not the wider voice-only pool.' }
       responses:
         '200':
           description: Availability + address constraint.
@@ -28148,6 +28162,20 @@ paths:
                     type: array
                     description: For `geo` only — the area(s) the registered address must be in.
                     items: { type: string }
+                  areaOptions:
+                    type: array
+                    description: >
+                      Live inventory grouped by area code, largest stock
+                      first. Empty when out of stock (or the area lookup
+                      failed). Pass a chosen `ndc` as `areaCode` on POST
+                      /v1/phone-numbers/purchase (or on the KYC submit for
+                      regulated countries) to require that area.
+                    items:
+                      type: object
+                      properties:
+                        ndc: { type: string, description: 'Area code (national destination code), e.g. "11".' }
+                        name: { type: string, description: 'Human-readable area name, e.g. "Sao Paulo".' }
+                        count: { type: integer, description: Deliverable numbers seen in this area on the latest inventory page. }
         '400': { description: Country not offerable }
         '401': { $ref: '#/components/responses/Unauthorized' }
 
@@ -28356,16 +28384,18 @@ paths:
         '403': { description: A paid plan is required }
         '409':
           description: >
-            Duplicate-purchase protection: another number was purchased for
-            this user within the last 10 minutes. Retry with allowMultiple:
-            true to confirm the additional purchase is intentional.
+            Either duplicate-purchase protection (code PURCHASE_VELOCITY:
+            another number was purchased within the last 10 minutes; retry
+            with allowMultiple: true to confirm), or the requested areaCode
+            has no deliverable inventory right now (code
+            AREA_CODE_UNAVAILABLE: pick another area or omit areaCode).
           content:
             application/json:
               schema:
                 type: object
                 properties:
                   error: { type: string }
-                  code: { type: string, enum: [PURCHASE_VELOCITY] }
+                  code: { type: string, enum: [PURCHASE_VELOCITY, AREA_CODE_UNAVAILABLE] }
         '202':
           description: Country requires end-user KYC before the number can be ordered.
           content:
@@ -28481,6 +28511,7 @@ paths:
       parameters:
         - { name: country, in: query, required: true, schema: { type: string }, description: ISO-2 country code. }
         - { name: numberType, in: query, required: false, schema: { type: string, enum: [local, mobile, national, toll_free] }, description: "Check a specific offered type (stock and address constraints are per type). Omitted = the country's default type." }
+        - { name: sms, in: query, required: false, schema: { type: boolean }, description: 'Pass true when the buyer wants SMS: availability, areas, and areaOptions then describe the SMS-capable pool (an SMS purchase orders from it), not the wider voice-only pool.' }
       responses:
         '200':
           description: Availability + address constraint.
@@ -28497,6 +28528,20 @@ paths:
                     type: array
                     description: For `geo` only — the area(s) the registered address must be in.
                     items: { type: string }
+                  areaOptions:
+                    type: array
+                    description: >
+                      Live inventory grouped by area code, largest stock
+                      first. Empty when out of stock (or the area lookup
+                      failed). Pass a chosen `ndc` as `areaCode` on POST
+                      /v1/phone-numbers/purchase (or on the KYC submit for
+                      regulated countries) to require that area.
+                    items:
+                      type: object
+                      properties:
+                        ndc: { type: string, description: 'Area code (national destination code), e.g. "11".' }
+                        name: { type: string, description: 'Human-readable area name, e.g. "Sao Paulo".' }
+                        count: { type: integer, description: Deliverable numbers seen in this area on the latest inventory page. }
         '400': { description: Country not offerable }
         '401': { $ref: '#/components/responses/Unauthorized' }
 
@@ -28607,6 +28652,7 @@ paths:
                 reuse: { type: boolean, description: Reuse a prior approved verification for this country (skips document/field collection; places the order immediately). }
                 reuseOptionId: { type: string, description: 'Which reusable verification to use (GET reusable.options[].id). The unambiguous selection key. Omitted = the approved default. No match = 409.' }
                 reuseFrom: { type: string, description: 'Legacy fallback for `reuseOptionId`: the source phone number (GET reusable.options[].fromPhoneNumber). Ambiguous when a number labels two verifications — prefer `reuseOptionId`. Omitted = the approved default. No match = 409.' }
+                areaCode: { type: string, pattern: '^\d{1,4}$', description: 'Area code (NDC) the number must be in. Hard constraint: an empty area pool fails with 409 code AREA_CODE_UNAVAILABLE instead of ordering from another area. Omit for any area. Options come from GET /v1/phone-numbers/availability (areaOptions); the purchase 202 kycUrl echoes the areaCode picked at purchase time so it can be passed here.' }
                 endUserFirstName: { type: string, description: End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement. }
                 endUserLastName: { type: string, description: End user's legal last name. Same condition as endUserFirstName. }
                 values:
@@ -28668,7 +28714,7 @@ paths:
                         phoneNumber: { type: string }
                         country: { type: string }
         '400': { description: "Validation error (e.g. address not in-country, file too large)" }
-        '409': { description: reuse requested but no prior approved verification exists for this country }
+        '409': { description: 'Either reuse was requested but no prior approved verification exists for this country, or the requested areaCode has no deliverable inventory right now (code: area_code_unavailable; pick another area and resubmit).' }
         '401': { $ref: '#/components/responses/Unauthorized' }
 
   /v1/phone-numbers/kyc/document/{documentId}:
@@ -28831,6 +28877,7 @@ paths:
               properties:
                 profileId: { type: string }
                 country: { type: string, minLength: 2, maxLength: 2, description: ISO 3166-1 alpha-2 country code (must be a regulated/KYC country). }
+                areaCode: { type: string, pattern: '^\d{1,4}$', description: 'Area code (NDC) the eventual number must be in. Hard constraint carried by the link; the end customer filling the form makes no area choice. Options come from GET /v1/phone-numbers/availability (areaOptions).' }
                 branding:
                   type: object
                   description: Optional white-label of the hosted page the end customer sees.
@@ -29577,6 +29624,7 @@ paths:
                 reuse: { type: boolean, description: Reuse a prior approved verification for this country (skips document/field collection; places the order immediately). }
                 reuseOptionId: { type: string, description: 'Which reusable verification to use (GET reusable.options[].id). The unambiguous selection key. Omitted = the approved default. No match = 409.' }
                 reuseFrom: { type: string, description: 'Legacy fallback for `reuseOptionId`: the source phone number (GET reusable.options[].fromPhoneNumber). Ambiguous when a number labels two verifications — prefer `reuseOptionId`. Omitted = the approved default. No match = 409.' }
+                areaCode: { type: string, pattern: '^\d{1,4}$', description: 'Area code (NDC) the number must be in. Hard constraint: an empty area pool fails with 409 code AREA_CODE_UNAVAILABLE instead of ordering from another area. Omit for any area. Options come from GET /v1/phone-numbers/availability (areaOptions); the purchase 202 kycUrl echoes the areaCode picked at purchase time so it can be passed here.' }
                 endUserFirstName: { type: string, description: End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement. }
                 endUserLastName: { type: string, description: End user's legal last name. Same condition as endUserFirstName. }
                 values:
@@ -29638,7 +29686,7 @@ paths:
                         phoneNumber: { type: string }
                         country: { type: string }
         '400': { description: "Validation error (e.g. address not in-country, file too large)" }
-        '409': { description: reuse requested but no prior approved verification exists for this country }
+        '409': { description: 'Either reuse was requested but no prior approved verification exists for this country, or the requested areaCode has no deliverable inventory right now (code: area_code_unavailable; pick another area and resubmit).' }
         '401': { $ref: '#/components/responses/Unauthorized' }
 
   /v1/whatsapp/phone-numbers/kyc/upload-document:
@@ -29785,6 +29833,7 @@ paths:
               properties:
                 profileId: { type: string }
                 country: { type: string, minLength: 2, maxLength: 2, description: ISO 3166-1 alpha-2 country code (must be a regulated/KYC country). }
+                areaCode: { type: string, pattern: '^\d{1,4}$', description: 'Area code (NDC) the eventual number must be in. Hard constraint carried by the link; the end customer filling the form makes no area choice. Options come from GET /v1/phone-numbers/availability (areaOptions).' }
                 branding:
                   type: object
                   description: Optional white-label of the hosted page the end customer sees.

data/spec/api/phone_numbers_api_spec.rb

@@ -50,6 +50,7 @@ describe 'PhoneNumbersApi' do
   # @param country ISO-2 country code.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :number_type Check a specific offered type (stock and address constraints are per type). Omitted = the country's default type.
+  # @option opts [Boolean] :sms Pass true when the buyer wants SMS: availability, areas, and areaOptions then describe the SMS-capable pool (an SMS purchase orders from it), not the wider voice-only pool.
   # @return [CheckPhoneNumberAvailability200Response]
   describe 'check_phone_number_availability test' do
     it 'should work' do

data/spec/api/whats_app_phone_numbers_api_spec.rb

@@ -38,6 +38,7 @@ describe 'WhatsAppPhoneNumbersApi' do
   # @param country ISO-2 country code.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :number_type Check a specific offered type (stock and address constraints are per type). Omitted = the country's default type.
+  # @option opts [Boolean] :sms Pass true when the buyer wants SMS: availability, areas, and areaOptions then describe the SMS-capable pool (an SMS purchase orders from it), not the wider voice-only pool.
   # @return [CheckPhoneNumberAvailability200Response]
   describe 'check_whats_app_number_availability test' do
     it 'should work' do

data/spec/models/check_phone_number_availability200_response_area_options_inner_spec.rb

@@ -0,0 +1,48 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api 
+
+The version of the OpenAPI document: 1.0.4
+Contact: support@zernio.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Zernio::CheckPhoneNumberAvailability200ResponseAreaOptionsInner
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Zernio::CheckPhoneNumberAvailability200ResponseAreaOptionsInner do
+  #let(:instance) { Zernio::CheckPhoneNumberAvailability200ResponseAreaOptionsInner.new }
+
+  describe 'test an instance of CheckPhoneNumberAvailability200ResponseAreaOptionsInner' do
+    it 'should create an instance of CheckPhoneNumberAvailability200ResponseAreaOptionsInner' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(Zernio::CheckPhoneNumberAvailability200ResponseAreaOptionsInner)
+    end
+  end
+
+  describe 'test attribute "ndc"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "name"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "count"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/check_phone_number_availability200_response_spec.rb

@@ -61,4 +61,10 @@ describe Zernio::CheckPhoneNumberAvailability200Response do
     end
   end
 
+  describe 'test attribute "area_options"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end

data/spec/models/create_phone_number_kyc_link_request_spec.rb

@@ -39,6 +39,12 @@ describe Zernio::CreatePhoneNumberKycLinkRequest do
     end
   end
 
+  describe 'test attribute "area_code"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "branding"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/models/purchase_phone_number409_response_spec.rb

@@ -36,7 +36,7 @@ describe Zernio::PurchasePhoneNumber409Response do
   describe 'test attribute "code"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["PURCHASE_VELOCITY"])
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["PURCHASE_VELOCITY", "AREA_CODE_UNAVAILABLE"])
       # validator.allowable_values.each do |value|
       #   expect { instance.code = value }.not_to raise_error
       # end

data/spec/models/purchase_phone_number_request_spec.rb

@@ -49,6 +49,12 @@ describe Zernio::PurchasePhoneNumberRequest do
     end
   end
 
+  describe 'test attribute "area_code"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "connect_whatsapp"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/models/submit_phone_number_kyc_request_spec.rb

@@ -69,6 +69,12 @@ describe Zernio::SubmitPhoneNumberKycRequest do
     end
   end
 
+  describe 'test attribute "area_code"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "end_user_first_name"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/models/submit_whats_app_number_kyc_request_spec.rb

@@ -69,6 +69,12 @@ describe Zernio::SubmitWhatsAppNumberKycRequest do
     end
   end
 
+  describe 'test attribute "area_code"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "end_user_first_name"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: late-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.569
+  version: 0.0.570
 platform: ruby
 authors:
 - OpenAPI-Generator
@@ -182,6 +182,7 @@ files:
 - docs/CancelBroadcast200Response.md
 - docs/CancelPhoneNumberPortIn200Response.md
 - docs/CheckPhoneNumberAvailability200Response.md
+- docs/CheckPhoneNumberAvailability200ResponseAreaOptionsInner.md
 - docs/CheckPhoneNumberPortability200Response.md
 - docs/CheckPhoneNumberPortability200ResponseResultsInner.md
 - docs/CheckPhoneNumberPortabilityRequest.md
@@ -1800,6 +1801,7 @@ files:
 - lib/zernio-sdk/models/cancel_broadcast200_response.rb
 - lib/zernio-sdk/models/cancel_phone_number_port_in200_response.rb
 - lib/zernio-sdk/models/check_phone_number_availability200_response.rb
+- lib/zernio-sdk/models/check_phone_number_availability200_response_area_options_inner.rb
 - lib/zernio-sdk/models/check_phone_number_portability200_response.rb
 - lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb
 - lib/zernio-sdk/models/check_phone_number_portability_request.rb
@@ -3361,6 +3363,7 @@ files:
 - spec/models/call_record_transcript_inner_spec.rb
 - spec/models/cancel_broadcast200_response_spec.rb
 - spec/models/cancel_phone_number_port_in200_response_spec.rb
+- spec/models/check_phone_number_availability200_response_area_options_inner_spec.rb
 - spec/models/check_phone_number_availability200_response_spec.rb
 - spec/models/check_phone_number_portability200_response_results_inner_spec.rb
 - spec/models/check_phone_number_portability200_response_spec.rb
@@ -4754,7 +4757,7 @@ files:
 - spec/models/you_tube_video_retention_response_retention_curve_inner_spec.rb
 - spec/models/you_tube_video_retention_response_spec.rb
 - spec/spec_helper.rb
-- zernio-sdk-0.0.569.gem
+- zernio-sdk-0.0.570.gem
 - zernio-sdk.gemspec
 homepage: https://openapi-generator.tech
 licenses:
@@ -5165,6 +5168,7 @@ test_files:
 - spec/models/webhook_payload_review_new_spec.rb
 - spec/models/get_inbox_top_accounts200_response_accounts_inner_spec.rb
 - spec/models/boost_post_request_tracking_spec.rb
+- spec/models/check_phone_number_availability200_response_area_options_inner_spec.rb
 - spec/models/request_sms_sender_id_limit_increase_request_spec.rb
 - spec/models/get_whats_app_number_remediation200_response_spec.rb
 - spec/models/get_ad_comments200_response_meta_spec.rb