zernio-sdk 0.0.554 → 0.0.556

data/openapi.yaml

@@ -28469,7 +28469,7 @@ paths:
                         localTo: { type: [string, "null"], description: ISO country the value must be local to }
                   reusable:
                     type: [object, "null"]
-                    description: Present when this account already has an approved verification for the country that can be reused (skip the form). `fromPhoneNumber`/`details` mirror the newest option; `options` lists ALL approved verifications (agencies hold one per end client) — pass the chosen option's `fromPhoneNumber` as `reuseFrom` on POST.
+                    description: 'Present when this account already has a reusable verification for the country (skip the form). `fromPhoneNumber`/`details` mirror the first option; `options` lists ALL reusable verifications (agencies hold one per end client), approved-first. Pass the chosen option''s `id` as `reuseOptionId` on POST. Each option''s `instant` says whether it activates in minutes (group-approved) or still queues for carrier review (1-3 days).'
                     properties:
                       available: { type: boolean }
                       fromPhoneNumber: { type: string }
@@ -28487,7 +28487,9 @@ paths:
                         items:
                           type: object
                           properties:
-                            fromPhoneNumber: { type: string }
+                            id: { type: string, description: 'Opaque option id — pass as `reuseOptionId` on POST. Stable selection key (a phone number is not unique across verifications).' }
+                            fromPhoneNumber: { type: string, description: Display only — the number this verification was submitted for. Not a selection key. }
+                            instant: { type: boolean, description: 'true = group-approved, a new order activates in minutes; false = documents are reused but the order still queues for carrier review (1-3 days).' }
                             details:
                               type: array
                               items:
@@ -28495,6 +28497,7 @@ paths:
                                 properties:
                                   label: { type: string }
                                   value: { type: string }
+                                  documentId: { type: string, description: 'Present on document rows — the Telnyx document id. GET /v1/whatsapp/phone-numbers/kyc/document/{documentId} streams it (auth-scoped, inline PDF).' }
         '400': { description: Country not available }
         '401': { $ref: '#/components/responses/Unauthorized' }
     post:
@@ -28534,7 +28537,8 @@ paths:
                 submissionId: { type: string, description: Idempotency token for this submission attempt. A retry/double-submit with the same token returns the same number; omit and each call creates a new number. }
                 quantity: { type: integer, minimum: 1, maximum: 5, default: 1, description: 'Provision several same-country numbers from one submission (1-5). The single verification covers all of them; each number is billed only when it activates. Numbers that fail to order are skipped (best-effort).' }
                 reuse: { type: boolean, description: Reuse a prior approved verification for this country (skips document/field collection; places the order immediately). }
-                reuseFrom: { type: string, description: 'Which approved verification to reuse when several exist: the phone number it was originally approved for (GET reusable.options[].fromPhoneNumber). Omitted = newest. No match = 409.' }
+                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.' }
                 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:
@@ -28599,6 +28603,34 @@ paths:
         '409': { description: reuse requested but no prior approved verification exists for this country }
         '401': { $ref: '#/components/responses/Unauthorized' }
 
+  /v1/phone-numbers/kyc/document/{documentId}:
+    get:
+      operationId: viewPhoneNumberKycDocument
+      tags: [Phone Numbers]
+      summary: View a KYC document on file
+      description: |
+        Stream a document backing a reusable verification (the `documentId`
+        values from GET /v1/phone-numbers/kyc `reusable.options[].details[]`), so
+        the account holder can see what's on file before reusing it. Returned
+        inline as `application/pdf` (uploads are normalized to PDF). Auth-scoped:
+        a document is viewable only when its id is referenced by one of the
+        caller's own numbers — otherwise `404`.
+      parameters:
+        - name: documentId
+          in: path
+          required: true
+          schema: { type: string }
+          description: The Telnyx document id (from `reusable.options[].details[].documentId`).
+      responses:
+        '200':
+          description: The document, streamed inline.
+          content:
+            application/pdf:
+              schema: { type: string, format: binary }
+        '400': { $ref: '#/components/responses/BadRequest' }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '404': { description: No such document for this account. }
+
   /v1/phone-numbers/kyc/upload-document:
     post:
       operationId: uploadPhoneNumberKycDocument
@@ -29274,7 +29306,7 @@ paths:
                         audience: { type: [string, "null"], enum: [business, individual, null], description: 'When set, the requirement applies ONLY to this end-user type — provide it for that type and OMIT it for the other (e.g. Brazil: "Cartão CNPJ" is business-only, "CPF" and "ID/Passport Copy" are personal-only). Submitting both sets makes the regulator ask whether the number is for personal or business use and stalls the review. Pass `entityType` on POST so the server drops the inapplicable set.' }
                   reusable:
                     type: [object, "null"]
-                    description: Present when this account already has an approved verification for the country that can be reused (skip the form). `fromPhoneNumber`/`details` mirror the newest option; `options` lists ALL approved verifications (agencies hold one per end client) — pass the chosen option's `fromPhoneNumber` as `reuseFrom` on POST.
+                    description: 'Present when this account already has a reusable verification for the country (skip the form). `fromPhoneNumber`/`details` mirror the first option; `options` lists ALL reusable verifications (agencies hold one per end client), approved-first. Pass the chosen option''s `id` as `reuseOptionId` on POST. Each option''s `instant` says whether it activates in minutes (group-approved) or still queues for carrier review (1-3 days).'
                     properties:
                       available: { type: boolean }
                       fromPhoneNumber: { type: string }
@@ -29292,7 +29324,9 @@ paths:
                         items:
                           type: object
                           properties:
-                            fromPhoneNumber: { type: string }
+                            id: { type: string, description: 'Opaque option id — pass as `reuseOptionId` on POST. Stable selection key (a phone number is not unique across verifications).' }
+                            fromPhoneNumber: { type: string, description: Display only — the number this verification was submitted for. Not a selection key. }
+                            instant: { type: boolean, description: 'true = group-approved, a new order activates in minutes; false = documents are reused but the order still queues for carrier review (1-3 days).' }
                             details:
                               type: array
                               items:
@@ -29300,6 +29334,7 @@ paths:
                                 properties:
                                   label: { type: string }
                                   value: { type: string }
+                                  documentId: { type: string, description: 'Present on document rows — the Telnyx document id. GET /v1/whatsapp/phone-numbers/kyc/document/{documentId} streams it (auth-scoped, inline PDF).' }
         '400': { description: Country not available }
         '401': { $ref: '#/components/responses/Unauthorized' }
     post:
@@ -29343,7 +29378,8 @@ paths:
                 submissionId: { type: string, description: Idempotency token for this submission attempt. A retry/double-submit with the same token returns the same number; omit and each call creates a new number. }
                 quantity: { type: integer, minimum: 1, maximum: 5, default: 1, description: 'Provision several same-country numbers from one submission (1-5). The single verification covers all of them; each number is billed only when it activates. Numbers that fail to order are skipped (best-effort).' }
                 reuse: { type: boolean, description: Reuse a prior approved verification for this country (skips document/field collection; places the order immediately). }
-                reuseFrom: { type: string, description: 'Which approved verification to reuse when several exist: the phone number it was originally approved for (GET reusable.options[].fromPhoneNumber). Omitted = newest. No match = 409.' }
+                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.' }
                 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:

data/spec/api/phone_numbers_api_spec.rb

@@ -307,4 +307,16 @@ describe 'PhoneNumbersApi' do
     end
   end
 
+  # unit tests for view_phone_number_kyc_document
+  # View a KYC document on file
+  # Stream a document backing a reusable verification (the `documentId` values from GET /v1/phone-numbers/kyc `reusable.options[].details[]`), so the account holder can see what's on file before reusing it. Returned inline as `application/pdf` (uploads are normalized to PDF). Auth-scoped: a document is viewable only when its id is referenced by one of the caller's own numbers — otherwise `404`. 
+  # @param document_id The Telnyx document id (from `reusable.options[].details[].documentId`).
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'view_phone_number_kyc_document test' 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/get_phone_number_kyc_form200_response_reusable_options_inner_details_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::GetPhoneNumberKycForm200ResponseReusableOptionsInnerDetailsInner
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Zernio::GetPhoneNumberKycForm200ResponseReusableOptionsInnerDetailsInner do
+  #let(:instance) { Zernio::GetPhoneNumberKycForm200ResponseReusableOptionsInnerDetailsInner.new }
+
+  describe 'test an instance of GetPhoneNumberKycForm200ResponseReusableOptionsInnerDetailsInner' do
+    it 'should create an instance of GetPhoneNumberKycForm200ResponseReusableOptionsInnerDetailsInner' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(Zernio::GetPhoneNumberKycForm200ResponseReusableOptionsInnerDetailsInner)
+    end
+  end
+
+  describe 'test attribute "label"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "value"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "document_id"' 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/get_phone_number_kyc_form200_response_reusable_options_inner_spec.rb

@@ -27,12 +27,24 @@ describe Zernio::GetPhoneNumberKycForm200ResponseReusableOptionsInner do
     end
   end
 
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "from_phone_number"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
+  describe 'test attribute "instant"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "details"' 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

@@ -57,6 +57,12 @@ describe Zernio::SubmitPhoneNumberKycRequest do
     end
   end
 
+  describe 'test attribute "reuse_option_id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "reuse_from"' 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

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