zernio-sdk 0.0.555 → 0.0.557

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

@@ -0,0 +1,157 @@
+=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 ReplyToPhoneNumberReviewer200Response < ApiModelBase
+    attr_accessor :posted
+
+    # Number of attachments uploaded.
+    attr_accessor :attachments
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'posted' => :'posted',
+        :'attachments' => :'attachments'
+      }
+    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
+      {
+        :'posted' => :'Boolean',
+        :'attachments' => :'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::ReplyToPhoneNumberReviewer200Response` 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::ReplyToPhoneNumberReviewer200Response`. 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?(:'posted')
+        self.posted = attributes[:'posted']
+      end
+
+      if attributes.key?(:'attachments')
+        self.attachments = attributes[:'attachments']
+      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 &&
+          posted == o.posted &&
+          attachments == o.attachments
+    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
+      [posted, attachments].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/reply_to_phone_number_reviewer_request.rb

@@ -0,0 +1,198 @@
+=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 ReplyToPhoneNumberReviewerRequest < ApiModelBase
+    # The reply message to the reviewer.
+    attr_accessor :text
+
+    # Files (PDF/JPG/PNG/WEBP, max 10 MB each) whose links are added to the reply.
+    attr_accessor :attachments
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'text' => :'text',
+        :'attachments' => :'attachments'
+      }
+    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
+      {
+        :'text' => :'String',
+        :'attachments' => :'Array<ReplyToPhoneNumberReviewerRequestAttachmentsInner>'
+      }
+    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::ReplyToPhoneNumberReviewerRequest` 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::ReplyToPhoneNumberReviewerRequest`. 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?(:'text')
+        self.text = attributes[:'text']
+      end
+
+      if attributes.key?(:'attachments')
+        if (value = attributes[:'attachments']).is_a?(Array)
+          self.attachments = value
+        end
+      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
+      if !@text.nil? && @text.to_s.length > 2000
+        invalid_properties.push('invalid value for "text", the character length must be smaller than or equal to 2000.')
+      end
+
+      if !@attachments.nil? && @attachments.length > 5
+        invalid_properties.push('invalid value for "attachments", number of items must be less than or equal to 5.')
+      end
+
+      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'
+      return false if !@text.nil? && @text.to_s.length > 2000
+      return false if !@attachments.nil? && @attachments.length > 5
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] text Value to be assigned
+    def text=(text)
+      if text.nil?
+        fail ArgumentError, 'text cannot be nil'
+      end
+
+      if text.to_s.length > 2000
+        fail ArgumentError, 'invalid value for "text", the character length must be smaller than or equal to 2000.'
+      end
+
+      @text = text
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] attachments Value to be assigned
+    def attachments=(attachments)
+      if attachments.nil?
+        fail ArgumentError, 'attachments cannot be nil'
+      end
+
+      if attachments.length > 5
+        fail ArgumentError, 'invalid value for "attachments", number of items must be less than or equal to 5.'
+      end
+
+      @attachments = attachments
+    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 &&
+          text == o.text &&
+          attachments == o.attachments
+    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
+      [text, attachments].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/reply_to_phone_number_reviewer_request_attachments_inner.rb

@@ -0,0 +1,191 @@
+=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 ReplyToPhoneNumberReviewerRequestAttachmentsInner < ApiModelBase
+    attr_accessor :filename
+
+    # Base64-encoded file bytes.
+    attr_accessor :base64
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'filename' => :'filename',
+        :'base64' => :'base64'
+      }
+    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
+      {
+        :'filename' => :'String',
+        :'base64' => :'String'
+      }
+    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::ReplyToPhoneNumberReviewerRequestAttachmentsInner` 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::ReplyToPhoneNumberReviewerRequestAttachmentsInner`. 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?(:'filename')
+        self.filename = attributes[:'filename']
+      else
+        self.filename = nil
+      end
+
+      if attributes.key?(:'base64')
+        self.base64 = attributes[:'base64']
+      else
+        self.base64 = nil
+      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
+      if @filename.nil?
+        invalid_properties.push('invalid value for "filename", filename cannot be nil.')
+      end
+
+      if @base64.nil?
+        invalid_properties.push('invalid value for "base64", base64 cannot be nil.')
+      end
+
+      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'
+      return false if @filename.nil?
+      return false if @base64.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] filename Value to be assigned
+    def filename=(filename)
+      if filename.nil?
+        fail ArgumentError, 'filename cannot be nil'
+      end
+
+      @filename = filename
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] base64 Value to be assigned
+    def base64=(base64)
+      if base64.nil?
+        fail ArgumentError, 'base64 cannot be nil'
+      end
+
+      @base64 = base64
+    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 &&
+          filename == o.filename &&
+          base64 == o.base64
+    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
+      [filename, base64].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/version.rb

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

data/lib/zernio-sdk.rb

@@ -612,6 +612,7 @@ require 'zernio-sdk/models/get_phone_number_kyc_form200_response_fields_inner'
 require 'zernio-sdk/models/get_phone_number_kyc_form200_response_reusable'
 require 'zernio-sdk/models/get_phone_number_kyc_form200_response_reusable_details_inner'
 require 'zernio-sdk/models/get_phone_number_kyc_form200_response_reusable_options_inner'
+require 'zernio-sdk/models/get_phone_number_kyc_form200_response_reusable_options_inner_details_inner'
 require 'zernio-sdk/models/get_phone_number_port_in_order_requirements200_response'
 require 'zernio-sdk/models/get_phone_number_port_in_order_requirements200_response_requirements_inner'
 require 'zernio-sdk/models/get_phone_number_port_in_requirements200_response'
@@ -1022,6 +1023,9 @@ require 'zernio-sdk/models/reply_to_inbox_review200_response'
 require 'zernio-sdk/models/reply_to_inbox_review_request'
 require 'zernio-sdk/models/reply_to_mention200_response'
 require 'zernio-sdk/models/reply_to_mention_request'
+require 'zernio-sdk/models/reply_to_phone_number_reviewer200_response'
+require 'zernio-sdk/models/reply_to_phone_number_reviewer_request'
+require 'zernio-sdk/models/reply_to_phone_number_reviewer_request_attachments_inner'
 require 'zernio-sdk/models/request_sms_sender_id_limit_increase200_response'
 require 'zernio-sdk/models/request_sms_sender_id_limit_increase_request'
 require 'zernio-sdk/models/resend_sms_registration_otp200_response'

data/openapi.yaml

@@ -28497,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:
@@ -28602,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
@@ -29235,6 +29264,58 @@ paths:
         '401': { $ref: '#/components/responses/Unauthorized' }
         '404': { description: Number not found }
 
+  /v1/phone-numbers/{id}/remediate/reply:
+    post:
+      operationId: replyToPhoneNumberReviewer
+      tags: [Phone Numbers]
+      summary: Reply to the regulatory reviewer
+      description: |
+        Post a free-text reply (with optional file attachments) to the reviewer
+        on a number awaiting remediation — for asks the structured form can't
+        express (e.g. "is this personal or business?"). Attachments are stored by
+        us and their links are added to the reviewer's comment thread (the
+        carrier's number order takes no loose files). A reply to a comment-style
+        ask moves the number back to "in review"; a reply on a formal decline is
+        supplementary and you must still resubmit the fix. Requires text or at
+        least one attachment.
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema: { type: string }
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                text: { type: string, maxLength: 2000, description: The reply message to the reviewer. }
+                attachments:
+                  type: array
+                  maxItems: 5
+                  description: 'Files (PDF/JPG/PNG/WEBP, max 10 MB each) whose links are added to the reply.'
+                  items:
+                    type: object
+                    required: [filename, base64]
+                    properties:
+                      filename: { type: string }
+                      base64: { type: string, description: Base64-encoded file bytes. }
+      responses:
+        '200':
+          description: Reply posted.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  posted: { type: boolean }
+                  attachments: { type: integer, description: Number of attachments uploaded. }
+        '400': { $ref: '#/components/responses/BadRequest' }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '404': { description: Number not found }
+        '502': { description: Couldn't deliver the reply to the reviewer; retry. }
+
   /v1/whatsapp/phone-numbers/kyc:
     get:
       operationId: getWhatsAppNumberKycForm
@@ -29305,6 +29386,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: