late-sdk 0.0.1095 → 0.0.1096

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f749a031e24a96075926fd0c097e29deaa2c6b87770caa880ce0f93600a8965
-  data.tar.gz: '095893c298190b4c7fc31a6cddce0ccf9a43ffa8bdac64d392f74834c386de98'
+  metadata.gz: d7cbc8da0b6b06fa5eee5c82f319625a54accd0fa303082cc670a8bf00357e10
+  data.tar.gz: 5f1cfc284d4d988f7d670319f621d8e53fd986318d4a198495fa2a1c51a83e12
 SHA512:
-  metadata.gz: 2cd949a11afaf95f2d6627f5757ca9c2cf2b0601098d9d2936f3cda44d0a551172f31e46a2dc32676af6e98ae1ac1a07f55029bf22c239aa5625a6c819a640a9
-  data.tar.gz: b6d983d193ef0d41e12a2adee019e9980604c69b042955ee11f27aa286ab579ff79469772902b1718149e25d1f103515fca19df914965c9984faa4cae5466f71
+  metadata.gz: c425ae21a295921dddd40f4f81f3adfba661c52ff662b35747fa1eacc46a767761f870288b1934673def80205e7a58c578b3cc5d1ff526f400f943f673231ea4
+  data.tar.gz: d23f98c5e1374c65dd9f5a5acebb6c220619173b9c06b051be158a83eb114962d7de6dca225d67df46b129a2fdec985ba869e050076f1665ef8c86098ce17600

data/README.md

@@ -580,6 +580,7 @@ Class | Method | HTTP request | Description
 *Zernio::PhoneNumbersApi* | [**create_phone_number_stock_watch**](docs/PhoneNumbersApi.md#create_phone_number_stock_watch) | **POST** /v1/phone-numbers/stock-watches | Watch an out-of-stock country
 *Zernio::PhoneNumbersApi* | [**delete_phone_number_stock_watch**](docs/PhoneNumbersApi.md#delete_phone_number_stock_watch) | **DELETE** /v1/phone-numbers/stock-watches/{id} | Stop watching a country
 *Zernio::PhoneNumbersApi* | [**get_phone_number**](docs/PhoneNumbersApi.md#get_phone_number) | **GET** /v1/phone-numbers/{id} | Get phone number
+*Zernio::PhoneNumbersApi* | [**get_phone_number_claim**](docs/PhoneNumbersApi.md#get_phone_number_claim) | **GET** /v1/phone-numbers/claims/{claimId} | Resolve a number claim
 *Zernio::PhoneNumbersApi* | [**get_phone_number_kyc_form**](docs/PhoneNumbersApi.md#get_phone_number_kyc_form) | **GET** /v1/phone-numbers/kyc | Get KYC form spec
 *Zernio::PhoneNumbersApi* | [**get_phone_number_port_in_order_requirements**](docs/PhoneNumbersApi.md#get_phone_number_port_in_order_requirements) | **GET** /v1/phone-numbers/port-in/{id}/requirements | A port-in order's pending requirements
 *Zernio::PhoneNumbersApi* | [**get_phone_number_port_in_requirements**](docs/PhoneNumbersApi.md#get_phone_number_port_in_requirements) | **GET** /v1/phone-numbers/port-in/requirements | Country porting requirements
@@ -1698,6 +1699,9 @@ Class | Method | HTTP request | Description
  - [Zernio::GetPendingOAuthData200ResponseOrganizationsInner](docs/GetPendingOAuthData200ResponseOrganizationsInner.md)
  - [Zernio::GetPhoneNumber200Response](docs/GetPhoneNumber200Response.md)
  - [Zernio::GetPhoneNumber200ResponsePhoneNumber](docs/GetPhoneNumber200ResponsePhoneNumber.md)
+ - [Zernio::GetPhoneNumberClaim200Response](docs/GetPhoneNumberClaim200Response.md)
+ - [Zernio::GetPhoneNumberClaim200ResponseArea](docs/GetPhoneNumberClaim200ResponseArea.md)
+ - [Zernio::GetPhoneNumberClaim200ResponseCountry](docs/GetPhoneNumberClaim200ResponseCountry.md)
  - [Zernio::GetPhoneNumberKycForm200Response](docs/GetPhoneNumberKycForm200Response.md)
  - [Zernio::GetPhoneNumberKycForm200ResponseFieldsInner](docs/GetPhoneNumberKycForm200ResponseFieldsInner.md)
  - [Zernio::GetPhoneNumberKycForm200ResponseReusable](docs/GetPhoneNumberKycForm200ResponseReusable.md)
@@ -2283,6 +2287,8 @@ Class | Method | HTTP request | Description
  - [Zernio::PurchasePhoneNumber200ResponseOneOf1PhoneNumber](docs/PurchasePhoneNumber200ResponseOneOf1PhoneNumber.md)
  - [Zernio::PurchasePhoneNumber200ResponseOneOf2](docs/PurchasePhoneNumber200ResponseOneOf2.md)
  - [Zernio::PurchasePhoneNumber202Response](docs/PurchasePhoneNumber202Response.md)
+ - [Zernio::PurchasePhoneNumber401Response](docs/PurchasePhoneNumber401Response.md)
+ - [Zernio::PurchasePhoneNumber401ResponseDetails](docs/PurchasePhoneNumber401ResponseDetails.md)
  - [Zernio::PurchasePhoneNumber409Response](docs/PurchasePhoneNumber409Response.md)
  - [Zernio::PurchasePhoneNumber503Response](docs/PurchasePhoneNumber503Response.md)
  - [Zernio::PurchasePhoneNumberRequest](docs/PurchasePhoneNumberRequest.md)

data/docs/GetPhoneNumberClaim200Response.md

@@ -0,0 +1,24 @@
+# Zernio::GetPhoneNumberClaim200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **country** | [**GetPhoneNumberClaim200ResponseCountry**](GetPhoneNumberClaim200ResponseCountry.md) |  | [optional] |
+| **type** | **Object** | The claimed number type, in the shape of `types[]` on GET /v1/phone-numbers/countries. | [optional] |
+| **area** | [**GetPhoneNumberClaim200ResponseArea**](GetPhoneNumberClaim200ResponseArea.md) |  | [optional] |
+| **phone_number** | **String** | E.164, or null for an any-number claim. | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::GetPhoneNumberClaim200Response.new(
+  country: null,
+  type: null,
+  area: null,
+  phone_number: null
+)
+```
+

data/docs/GetPhoneNumberClaim200ResponseArea.md

@@ -0,0 +1,22 @@
+# Zernio::GetPhoneNumberClaim200ResponseArea
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ndc** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **count** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::GetPhoneNumberClaim200ResponseArea.new(
+  ndc: null,
+  name: null,
+  count: null
+)
+```
+

data/docs/GetPhoneNumberClaim200ResponseCountry.md

@@ -0,0 +1,24 @@
+# Zernio::GetPhoneNumberClaim200ResponseCountry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  | [optional] |
+| **needs_kyc** | **Boolean** |  | [optional] |
+| **monthly_cents** | **Integer** |  | [optional] |
+| **types** | **Array<Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::GetPhoneNumberClaim200ResponseCountry.new(
+  code: null,
+  needs_kyc: null,
+  monthly_cents: null,
+  types: null
+)
+```
+

data/docs/PhoneNumbersApi.md

@@ -12,6 +12,7 @@ All URIs are relative to *https://zernio.com/api*
 | [**create_phone_number_stock_watch**](PhoneNumbersApi.md#create_phone_number_stock_watch) | **POST** /v1/phone-numbers/stock-watches | Watch an out-of-stock country |
 | [**delete_phone_number_stock_watch**](PhoneNumbersApi.md#delete_phone_number_stock_watch) | **DELETE** /v1/phone-numbers/stock-watches/{id} | Stop watching a country |
 | [**get_phone_number**](PhoneNumbersApi.md#get_phone_number) | **GET** /v1/phone-numbers/{id} | Get phone number |
+| [**get_phone_number_claim**](PhoneNumbersApi.md#get_phone_number_claim) | **GET** /v1/phone-numbers/claims/{claimId} | Resolve a number claim |
 | [**get_phone_number_kyc_form**](PhoneNumbersApi.md#get_phone_number_kyc_form) | **GET** /v1/phone-numbers/kyc | Get KYC form spec |
 | [**get_phone_number_port_in_order_requirements**](PhoneNumbersApi.md#get_phone_number_port_in_order_requirements) | **GET** /v1/phone-numbers/port-in/{id}/requirements | A port-in order's pending requirements |
 | [**get_phone_number_port_in_requirements**](PhoneNumbersApi.md#get_phone_number_port_in_requirements) | **GET** /v1/phone-numbers/port-in/requirements | Country porting requirements |
@@ -109,7 +110,7 @@ end
 
 Check country availability
 
-Pre-purchase check, so you can warn BEFORE a customer invests in KYC (regulated review is async, 1-3 days). Tells you whether we have deliverable inventory, and what address the customer needs:   - `addressConstraint: geo`  → the registered address MUST be in one of     the returned `areas` (the only place we have stock). A different-area     address passes pre-approval but the number can never be assigned.   - `addressConstraint: country` → any in-country address works.   - `addressConstraint: none` → field-only / instant country, no address. Call this before starting the KYC form for regulated countries. 
+Pre-purchase check, so you can warn BEFORE a customer invests in KYC (regulated review is async, 1-3 days). Tells you whether we have deliverable inventory, and what address the customer needs:   - `addressConstraint: geo`  → the registered address MUST be in one of     the returned `areas` (the only place we have stock). A different-area     address passes pre-approval but the number can never be assigned.   - `addressConstraint: country` → any in-country address works.   - `addressConstraint: none` → field-only / instant country, no address. Call this before starting the KYC form for regulated countries.  Without an API key it answers from cache only and returns just `country`, `numberType` and `areaOptions`, for building an area picker before signup. 
 
 ### Examples
 
@@ -590,6 +591,75 @@ end
 - **Accept**: application/json
 
 
+## get_phone_number_claim
+
+> <GetPhoneNumberClaim200Response> get_phone_number_claim(claim_id)
+
+Resolve a number claim
+
+Resolves a `claimId` from a keyless search or purchase into the selection it carries (country, number type, area and exact number) priced at today's rate. The dashboard calls it when a person lands from a `claimUrl`. The number is not held, so buying it can still fail with 409 PHONE_NUMBER_UNAVAILABLE. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zernio-sdk'
+# setup authorization
+Zernio.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Zernio::PhoneNumbersApi.new
+claim_id = 'claim_id_example' # String | 
+
+begin
+  # Resolve a number claim
+  result = api_instance.get_phone_number_claim(claim_id)
+  p result
+rescue Zernio::ApiError => e
+  puts "Error when calling PhoneNumbersApi->get_phone_number_claim: #{e}"
+end
+```
+
+#### Using the get_phone_number_claim_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetPhoneNumberClaim200Response>, Integer, Hash)> get_phone_number_claim_with_http_info(claim_id)
+
+```ruby
+begin
+  # Resolve a number claim
+  data, status_code, headers = api_instance.get_phone_number_claim_with_http_info(claim_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetPhoneNumberClaim200Response>
+rescue Zernio::ApiError => e
+  puts "Error when calling PhoneNumbersApi->get_phone_number_claim_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **claim_id** | **String** |  |  |
+
+### Return type
+
+[**GetPhoneNumberClaim200Response**](GetPhoneNumberClaim200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_phone_number_kyc_form
 
 > <GetPhoneNumberKycForm200Response> get_phone_number_kyc_form(country, opts)
@@ -880,18 +950,13 @@ end
 
 List offerable number countries
 
-The phone number countries available to purchase, each with its flat monthly price (cents), regulatory tier, whether it needs end-user KYC (Tier 3/4), and per-feature availability (PSTN calls, WhatsApp, SMS, and WhatsApp Business Calling outbound). Drives the country picker. Tier-4 countries appear only when enabled. 
+The phone number countries available to purchase, each with its flat monthly price (cents), regulatory tier, whether it needs end-user KYC (Tier 3/4), and per-feature availability (PSTN calls, WhatsApp, SMS, and WhatsApp Business Calling outbound). Drives the country picker. Tier-4 countries appear only when enabled. No API key needed: the catalog is public so you can browse it before you have an account. 
 
 ### Examples
 
 ```ruby
 require 'time'
 require 'zernio-sdk'
-# setup authorization
-Zernio.configure do |config|
-  # Configure Bearer authorization (JWT): bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
 
 api_instance = Zernio::PhoneNumbersApi.new
 
@@ -932,7 +997,7 @@ This endpoint does not need any parameter.
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+No authorization required
 
 ### HTTP request headers
 
@@ -1569,7 +1634,7 @@ end
 
 Search available numbers
 
-Search the provider's inventory for numbers available to purchase in a country (default US). Optional filters narrow the results. The country must be offerable (see GET /v1/phone-numbers/countries). Voice capability is always required; pass `sms=true` to only see numbers that can also text (SMS support is per-number, not per-country). Numbers a purchase would refuse are left out, and any result's `phoneNumber` can be bought exactly by passing it to POST /v1/phone-numbers/purchase. 
+Search the provider's inventory for numbers available to purchase in a country (default US). Optional filters narrow the results. The country must be offerable (see GET /v1/phone-numbers/countries). Voice capability is always required; pass `sms=true` to only see numbers that can also text (SMS support is per-number, not per-country). Numbers a purchase would refuse are left out, and any result's `phoneNumber` can be bought exactly by passing it to POST /v1/phone-numbers/purchase.  Works without an API key. Keyless calls get up to 12 results with the middle digits masked (`maskedNumber`), each with a `claimId` and a `claimUrl`: a signup link that lands a person on the dashboard's confirm step with that number picked, so an agent can search for a user and hand them one link. Keyless calls are rate limited per IP and results are cached for a few minutes. With an API key you get full numbers and no claim fields. 
 
 ### Examples
 
@@ -1584,7 +1649,7 @@ end
 
 api_instance = Zernio::PhoneNumbersApi.new
 opts = {
-  country: 'country_example', # String | 
+  country: 'country_example', # String | ISO code, or `auto` on the keyless shape to search the caller's own country (from their IP) near their city, falling back to US.
   number_type: 'local', # String | Number type; defaults to the country's WhatsApp-safe type (the same name as on purchase, availability and kyc)
   area_code: 'area_code_example', # String | Area code or national dialing code the number must start with, e.g. 415 or 91
   type: 'type_example', # String | Alias of numberType, kept for existing callers
@@ -1592,7 +1657,8 @@ opts = {
   locality: 'locality_example', # String | City
   contains: 'contains_example', # String | Pattern to match within the number
   sms: true, # Boolean | true narrows the pool to SMS-capable numbers. Each result still carries its full `features` list for per-number capability badging.
-  limit: 56 # Integer | 
+  limit: 56, # Integer | 
+  masked: true # Boolean | true returns the keyless shape (masked numbers with claimId and claimUrl) even when you send an API key, e.g. to hand a user a signup link for a number.
 }
 
 begin
@@ -1626,7 +1692,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **country** | **String** |  | [optional][default to &#39;US&#39;] |
+| **country** | **String** | ISO code, or &#x60;auto&#x60; on the keyless shape to search the caller&#39;s own country (from their IP) near their city, falling back to US. | [optional][default to &#39;US&#39;] |
 | **number_type** | **String** | Number type; defaults to the country&#39;s WhatsApp-safe type (the same name as on purchase, availability and kyc) | [optional] |
 | **area_code** | **String** | Area code or national dialing code the number must start with, e.g. 415 or 91 | [optional] |
 | **type** | **String** | Alias of numberType, kept for existing callers | [optional] |
@@ -1635,6 +1701,7 @@ end
 | **contains** | **String** | Pattern to match within the number | [optional] |
 | **sms** | **Boolean** | true narrows the pool to SMS-capable numbers. Each result still carries its full &#x60;features&#x60; list for per-number capability badging. | [optional] |
 | **limit** | **Integer** |  | [optional][default to 20] |
+| **masked** | **Boolean** | true returns the keyless shape (masked numbers with claimId and claimUrl) even when you send an API key, e.g. to hand a user a signup link for a number. | [optional] |
 
 ### Return type
 

data/docs/PurchasePhoneNumber401Response.md

@@ -0,0 +1,22 @@
+# Zernio::PurchasePhoneNumber401Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** |  | [optional] |
+| **code** | **String** |  | [optional] |
+| **details** | [**PurchasePhoneNumber401ResponseDetails**](PurchasePhoneNumber401ResponseDetails.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::PurchasePhoneNumber401Response.new(
+  error: null,
+  code: null,
+  details: null
+)
+```
+

data/docs/PurchasePhoneNumber401ResponseDetails.md

@@ -0,0 +1,20 @@
+# Zernio::PurchasePhoneNumber401ResponseDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **claim_id** | **String** |  | [optional] |
+| **claim_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::PurchasePhoneNumber401ResponseDetails.new(
+  claim_id: null,
+  claim_url: null
+)
+```
+

data/docs/PurchasePhoneNumberRequest.md

@@ -8,6 +8,7 @@
 | **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] |
+| **claim_id** | **String** | 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.  | [optional] |
 | **phone_number** | **String** | 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.  | [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] |
@@ -25,6 +26,7 @@ instance = Zernio::PurchasePhoneNumberRequest.new(
   country: null,
   number_type: null,
   area_code: null,
+  claim_id: null,
   phone_number: null,
   connect_whatsapp: null,
   wants_sms: null,

data/docs/SearchAvailablePhoneNumbers200Response.md

@@ -8,6 +8,10 @@
 | **number_type** | **String** |  | [optional] |
 | **require_sms** | **Boolean** | Echo of the `sms` filter applied to this search. | [optional] |
 | **numbers** | [**Array<SearchAvailablePhoneNumbers200ResponseNumbersInner>**](SearchAvailablePhoneNumbers200ResponseNumbersInner.md) |  | [optional] |
+| **masked** | **Boolean** | true on keyless calls. | [optional] |
+| **near** | **String** | With `country=auto`: the caller's city the results were narrowed to, or null when there was no stock there. | [optional] |
+| **claim_id** | **String** | Keyless calls only: a claim for any number matching this search's country, type and area. | [optional] |
+| **claim_url** | **String** | Keyless calls only: signup link for any number matching this search. | [optional] |
 
 ## Example
 
@@ -18,7 +22,11 @@ instance = Zernio::SearchAvailablePhoneNumbers200Response.new(
   country: null,
   number_type: null,
   require_sms: null,
-  numbers: null
+  numbers: null,
+  masked: null,
+  near: null,
+  claim_id: null,
+  claim_url: null
 )
 ```
 

data/docs/SearchAvailablePhoneNumbers200ResponseNumbersInner.md

@@ -8,6 +8,10 @@
 | **features** | **Array<String>** | Provider capability list for this number (e.g. voice, sms, mms). | [optional] |
 | **locality** | **String** | Town or rate center the number belongs to, as the carrier names it (e.g. WACO). | [optional] |
 | **best_effort** | **Boolean** | true when the carrier added this number because too few matched your filters, so it may be outside the requested prefix or locality. | [optional] |
+| **masked_number** | **String** | Keyless calls only, in place of `phoneNumber`: the number with its middle digits masked, e.g. +44 20 •••• 0123. | [optional] |
+| **number_type** | **String** | Keyless calls only. Without a `numberType` filter a keyless search mixes every type the country sells, so each result names its own. | [optional] |
+| **claim_id** | **String** | Keyless calls only. Opaque, expires after 7 days. Pass it as `claimId` on a keyless POST /v1/phone-numbers/purchase. | [optional] |
+| **claim_url** | **String** | Keyless calls only. Signup link that opens the dashboard's confirm step for this number. The number is not held: if it is gone by then, the buyer picks another in the same area. | [optional] |
 
 ## Example
 
@@ -18,7 +22,11 @@ instance = Zernio::SearchAvailablePhoneNumbers200ResponseNumbersInner.new(
   phone_number: null,
   features: null,
   locality: null,
-  best_effort: null
+  best_effort: null,
+  masked_number: null,
+  number_type: null,
+  claim_id: null,
+  claim_url: null
 )
 ```
 

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

@@ -83,7 +83,7 @@ module Zernio
     end
 
     # Check country availability
-    # Pre-purchase check, so you can warn BEFORE a customer invests in KYC (regulated review is async, 1-3 days). Tells you whether we have deliverable inventory, and what address the customer needs:   - `addressConstraint: geo`  → the registered address MUST be in one of     the returned `areas` (the only place we have stock). A different-area     address passes pre-approval but the number can never be assigned.   - `addressConstraint: country` → any in-country address works.   - `addressConstraint: none` → field-only / instant country, no address. Call this before starting the KYC form for regulated countries. 
+    # Pre-purchase check, so you can warn BEFORE a customer invests in KYC (regulated review is async, 1-3 days). Tells you whether we have deliverable inventory, and what address the customer needs:   - `addressConstraint: geo`  → the registered address MUST be in one of     the returned `areas` (the only place we have stock). A different-area     address passes pre-approval but the number can never be assigned.   - `addressConstraint: country` → any in-country address works.   - `addressConstraint: none` → field-only / instant country, no address. Call this before starting the KYC form for regulated countries.  Without an API key it answers from cache only and returns just `country`, `numberType` and `areaOptions`, for building an area picker before signup. 
     # @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.
@@ -95,7 +95,7 @@ module Zernio
     end
 
     # Check country availability
-    # Pre-purchase check, so you can warn BEFORE a customer invests in KYC (regulated review is async, 1-3 days). Tells you whether we have deliverable inventory, and what address the customer needs:   - `addressConstraint: geo`  → the registered address MUST be in one of     the returned `areas` (the only place we have stock). A different-area     address passes pre-approval but the number can never be assigned.   - `addressConstraint: country` → any in-country address works.   - `addressConstraint: none` → field-only / instant country, no address. Call this before starting the KYC form for regulated countries. 
+    # Pre-purchase check, so you can warn BEFORE a customer invests in KYC (regulated review is async, 1-3 days). Tells you whether we have deliverable inventory, and what address the customer needs:   - `addressConstraint: geo`  → the registered address MUST be in one of     the returned `areas` (the only place we have stock). A different-area     address passes pre-approval but the number can never be assigned.   - `addressConstraint: country` → any in-country address works.   - `addressConstraint: none` → field-only / instant country, no address. Call this before starting the KYC form for regulated countries.  Without an API key it answers from cache only and returns just `country`, `numberType` and `areaOptions`, for building an area picker before signup. 
     # @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.
@@ -552,6 +552,69 @@ module Zernio
       return data, status_code, headers
     end
 
+    # Resolve a number claim
+    # Resolves a `claimId` from a keyless search or purchase into the selection it carries (country, number type, area and exact number) priced at today's rate. The dashboard calls it when a person lands from a `claimUrl`. The number is not held, so buying it can still fail with 409 PHONE_NUMBER_UNAVAILABLE. 
+    # @param claim_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetPhoneNumberClaim200Response]
+    def get_phone_number_claim(claim_id, opts = {})
+      data, _status_code, _headers = get_phone_number_claim_with_http_info(claim_id, opts)
+      data
+    end
+
+    # Resolve a number claim
+    # Resolves a `claimId` from a keyless search or purchase into the selection it carries (country, number type, area and exact number) priced at today's rate. The dashboard calls it when a person lands from a `claimUrl`. The number is not held, so buying it can still fail with 409 PHONE_NUMBER_UNAVAILABLE. 
+    # @param claim_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetPhoneNumberClaim200Response, Integer, Hash)>] GetPhoneNumberClaim200Response data, response status code and response headers
+    def get_phone_number_claim_with_http_info(claim_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.get_phone_number_claim ...'
+      end
+      # verify the required parameter 'claim_id' is set
+      if @api_client.config.client_side_validation && claim_id.nil?
+        fail ArgumentError, "Missing the required parameter 'claim_id' when calling PhoneNumbersApi.get_phone_number_claim"
+      end
+      # resource path
+      local_var_path = '/v1/phone-numbers/claims/{claimId}'.sub('{' + 'claimId' + '}', CGI.escape(claim_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetPhoneNumberClaim200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PhoneNumbersApi.get_phone_number_claim",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PhoneNumbersApi#get_phone_number_claim\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get KYC form spec
     # For a Tier 3/4 country, the fields the end customer must provide (Telnyx regulatory requirements) before a number can be ordered: text, date, address, or file (document) per requirement. 
     # @param country [String] 
@@ -829,7 +892,7 @@ module Zernio
     end
 
     # List offerable number countries
-    # The phone number countries available to purchase, each with its flat monthly price (cents), regulatory tier, whether it needs end-user KYC (Tier 3/4), and per-feature availability (PSTN calls, WhatsApp, SMS, and WhatsApp Business Calling outbound). Drives the country picker. Tier-4 countries appear only when enabled. 
+    # The phone number countries available to purchase, each with its flat monthly price (cents), regulatory tier, whether it needs end-user KYC (Tier 3/4), and per-feature availability (PSTN calls, WhatsApp, SMS, and WhatsApp Business Calling outbound). Drives the country picker. Tier-4 countries appear only when enabled. No API key needed: the catalog is public so you can browse it before you have an account. 
     # @param [Hash] opts the optional parameters
     # @return [ListPhoneNumberCountries200Response]
     def list_phone_number_countries(opts = {})
@@ -838,7 +901,7 @@ module Zernio
     end
 
     # List offerable number countries
-    # The phone number countries available to purchase, each with its flat monthly price (cents), regulatory tier, whether it needs end-user KYC (Tier 3/4), and per-feature availability (PSTN calls, WhatsApp, SMS, and WhatsApp Business Calling outbound). Drives the country picker. Tier-4 countries appear only when enabled. 
+    # The phone number countries available to purchase, each with its flat monthly price (cents), regulatory tier, whether it needs end-user KYC (Tier 3/4), and per-feature availability (PSTN calls, WhatsApp, SMS, and WhatsApp Business Calling outbound). Drives the country picker. Tier-4 countries appear only when enabled. No API key needed: the catalog is public so you can browse it before you have an account. 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ListPhoneNumberCountries200Response, Integer, Hash)>] ListPhoneNumberCountries200Response data, response status code and response headers
     def list_phone_number_countries_with_http_info(opts = {})
@@ -866,7 +929,7 @@ module Zernio
       return_type = opts[:debug_return_type] || 'ListPhoneNumberCountries200Response'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
         :operation => :"PhoneNumbersApi.list_phone_number_countries",
@@ -1486,9 +1549,9 @@ module Zernio
     end
 
     # Search available numbers
-    # Search the provider's inventory for numbers available to purchase in a country (default US). Optional filters narrow the results. The country must be offerable (see GET /v1/phone-numbers/countries). Voice capability is always required; pass `sms=true` to only see numbers that can also text (SMS support is per-number, not per-country). Numbers a purchase would refuse are left out, and any result's `phoneNumber` can be bought exactly by passing it to POST /v1/phone-numbers/purchase. 
+    # Search the provider's inventory for numbers available to purchase in a country (default US). Optional filters narrow the results. The country must be offerable (see GET /v1/phone-numbers/countries). Voice capability is always required; pass `sms=true` to only see numbers that can also text (SMS support is per-number, not per-country). Numbers a purchase would refuse are left out, and any result's `phoneNumber` can be bought exactly by passing it to POST /v1/phone-numbers/purchase.  Works without an API key. Keyless calls get up to 12 results with the middle digits masked (`maskedNumber`), each with a `claimId` and a `claimUrl`: a signup link that lands a person on the dashboard's confirm step with that number picked, so an agent can search for a user and hand them one link. Keyless calls are rate limited per IP and results are cached for a few minutes. With an API key you get full numbers and no claim fields. 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :country  (default to 'US')
+    # @option opts [String] :country ISO code, or &#x60;auto&#x60; on the keyless shape to search the caller&#39;s own country (from their IP) near their city, falling back to US. (default to 'US')
     # @option opts [String] :number_type Number type; defaults to the country&#39;s WhatsApp-safe type (the same name as on purchase, availability and kyc)
     # @option opts [String] :area_code Area code or national dialing code the number must start with, e.g. 415 or 91
     # @option opts [String] :type Alias of numberType, kept for existing callers
@@ -1497,6 +1560,7 @@ module Zernio
     # @option opts [String] :contains Pattern to match within the number
     # @option opts [Boolean] :sms true narrows the pool to SMS-capable numbers. Each result still carries its full &#x60;features&#x60; list for per-number capability badging.
     # @option opts [Integer] :limit  (default to 20)
+    # @option opts [Boolean] :masked true returns the keyless shape (masked numbers with claimId and claimUrl) even when you send an API key, e.g. to hand a user a signup link for a number.
     # @return [SearchAvailablePhoneNumbers200Response]
     def search_available_phone_numbers(opts = {})
       data, _status_code, _headers = search_available_phone_numbers_with_http_info(opts)
@@ -1504,9 +1568,9 @@ module Zernio
     end
 
     # Search available numbers
-    # Search the provider&#39;s inventory for numbers available to purchase in a country (default US). Optional filters narrow the results. The country must be offerable (see GET /v1/phone-numbers/countries). Voice capability is always required; pass &#x60;sms&#x3D;true&#x60; to only see numbers that can also text (SMS support is per-number, not per-country). Numbers a purchase would refuse are left out, and any result&#39;s &#x60;phoneNumber&#x60; can be bought exactly by passing it to POST /v1/phone-numbers/purchase. 
+    # Search the provider&#39;s inventory for numbers available to purchase in a country (default US). Optional filters narrow the results. The country must be offerable (see GET /v1/phone-numbers/countries). Voice capability is always required; pass &#x60;sms&#x3D;true&#x60; to only see numbers that can also text (SMS support is per-number, not per-country). Numbers a purchase would refuse are left out, and any result&#39;s &#x60;phoneNumber&#x60; can be bought exactly by passing it to POST /v1/phone-numbers/purchase.  Works without an API key. Keyless calls get up to 12 results with the middle digits masked (&#x60;maskedNumber&#x60;), each with a &#x60;claimId&#x60; and a &#x60;claimUrl&#x60;: a signup link that lands a person on the dashboard&#39;s confirm step with that number picked, so an agent can search for a user and hand them one link. Keyless calls are rate limited per IP and results are cached for a few minutes. With an API key you get full numbers and no claim fields. 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :country  (default to 'US')
+    # @option opts [String] :country ISO code, or &#x60;auto&#x60; on the keyless shape to search the caller&#39;s own country (from their IP) near their city, falling back to US. (default to 'US')
     # @option opts [String] :number_type Number type; defaults to the country&#39;s WhatsApp-safe type (the same name as on purchase, availability and kyc)
     # @option opts [String] :area_code Area code or national dialing code the number must start with, e.g. 415 or 91
     # @option opts [String] :type Alias of numberType, kept for existing callers
@@ -1515,6 +1579,7 @@ module Zernio
     # @option opts [String] :contains Pattern to match within the number
     # @option opts [Boolean] :sms true narrows the pool to SMS-capable numbers. Each result still carries its full &#x60;features&#x60; list for per-number capability badging.
     # @option opts [Integer] :limit  (default to 20)
+    # @option opts [Boolean] :masked true returns the keyless shape (masked numbers with claimId and claimUrl) even when you send an API key, e.g. to hand a user a signup link for a number.
     # @return [Array<(SearchAvailablePhoneNumbers200Response, Integer, Hash)>] SearchAvailablePhoneNumbers200Response data, response status code and response headers
     def search_available_phone_numbers_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -1542,6 +1607,7 @@ module Zernio
       query_params[:'contains'] = opts[:'contains'] if !opts[:'contains'].nil?
       query_params[:'sms'] = opts[:'sms'] if !opts[:'sms'].nil?
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'masked'] = opts[:'masked'] if !opts[:'masked'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}