late-sdk 0.0.561 → 0.0.563

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

@@ -0,0 +1,264 @@
+=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 RespondToPhoneNumberReviewerRequest < ApiModelBase
+    # Your message to the reviewer.
+    attr_accessor :message
+
+    # Corrected requirement documents, each keyed to its requirement.
+    attr_accessor :documents
+
+    # A corrected address record, keyed to its requirement.
+    attr_accessor :address
+
+    attr_accessor :entity_type
+
+    # Loose files (PDF/JPG/PNG/WEBP, max 10 MB each) whose links are added to your message.
+    attr_accessor :attachments
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'message' => :'message',
+        :'documents' => :'documents',
+        :'address' => :'address',
+        :'entity_type' => :'entityType',
+        :'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
+      {
+        :'message' => :'String',
+        :'documents' => :'Array<RespondToPhoneNumberReviewerRequestDocumentsInner>',
+        :'address' => :'Object',
+        :'entity_type' => :'String',
+        :'attachments' => :'Array<ReplyToPhoneNumberReviewerRequestAttachmentsInner>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'entity_type',
+      ])
+    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::RespondToPhoneNumberReviewerRequest` 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::RespondToPhoneNumberReviewerRequest`. 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?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'documents')
+        if (value = attributes[:'documents']).is_a?(Array)
+          self.documents = value
+        end
+      end
+
+      if attributes.key?(:'address')
+        self.address = attributes[:'address']
+      end
+
+      if attributes.key?(:'entity_type')
+        self.entity_type = attributes[:'entity_type']
+      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 !@message.nil? && @message.to_s.length > 2000
+        invalid_properties.push('invalid value for "message", 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 !@message.nil? && @message.to_s.length > 2000
+      entity_type_validator = EnumAttributeValidator.new('String', ["individual", "business"])
+      return false unless entity_type_validator.valid?(@entity_type)
+      return false if !@attachments.nil? && @attachments.length > 5
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] message Value to be assigned
+    def message=(message)
+      if message.nil?
+        fail ArgumentError, 'message cannot be nil'
+      end
+
+      if message.to_s.length > 2000
+        fail ArgumentError, 'invalid value for "message", the character length must be smaller than or equal to 2000.'
+      end
+
+      @message = message
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] entity_type Object to be assigned
+    def entity_type=(entity_type)
+      validator = EnumAttributeValidator.new('String', ["individual", "business"])
+      unless validator.valid?(entity_type)
+        fail ArgumentError, "invalid value for \"entity_type\", must be one of #{validator.allowable_values}."
+      end
+      @entity_type = entity_type
+    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 &&
+          message == o.message &&
+          documents == o.documents &&
+          address == o.address &&
+          entity_type == o.entity_type &&
+          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
+      [message, documents, address, entity_type, 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/respond_to_phone_number_reviewer_request_documents_inner.rb

@@ -0,0 +1,193 @@
+=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 RespondToPhoneNumberReviewerRequestDocumentsInner < ApiModelBase
+    attr_accessor :requirement_id
+
+    attr_accessor :filename
+
+    # Base64-encoded file bytes (or supply documentId instead).
+    attr_accessor :base64
+
+    # Id of a document already uploaded out-of-band.
+    attr_accessor :document_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'requirement_id' => :'requirementId',
+        :'filename' => :'filename',
+        :'base64' => :'base64',
+        :'document_id' => :'documentId'
+      }
+    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
+      {
+        :'requirement_id' => :'String',
+        :'filename' => :'String',
+        :'base64' => :'String',
+        :'document_id' => :'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::RespondToPhoneNumberReviewerRequestDocumentsInner` 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::RespondToPhoneNumberReviewerRequestDocumentsInner`. 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?(:'requirement_id')
+        self.requirement_id = attributes[:'requirement_id']
+      else
+        self.requirement_id = nil
+      end
+
+      if attributes.key?(:'filename')
+        self.filename = attributes[:'filename']
+      end
+
+      if attributes.key?(:'base64')
+        self.base64 = attributes[:'base64']
+      end
+
+      if attributes.key?(:'document_id')
+        self.document_id = attributes[:'document_id']
+      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 @requirement_id.nil?
+        invalid_properties.push('invalid value for "requirement_id", requirement_id 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 @requirement_id.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] requirement_id Value to be assigned
+    def requirement_id=(requirement_id)
+      if requirement_id.nil?
+        fail ArgumentError, 'requirement_id cannot be nil'
+      end
+
+      @requirement_id = requirement_id
+    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 &&
+          requirement_id == o.requirement_id &&
+          filename == o.filename &&
+          base64 == o.base64 &&
+          document_id == o.document_id
+    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
+      [requirement_id, filename, base64, document_id].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.561'
+  VERSION = '0.0.563'
 end

data/lib/zernio-sdk.rb

@@ -1031,6 +1031,9 @@ require 'zernio-sdk/models/request_sms_sender_id_limit_increase_request'
 require 'zernio-sdk/models/resend_sms_registration_otp200_response'
 require 'zernio-sdk/models/reserve_rf_prediction201_response'
 require 'zernio-sdk/models/reserve_rf_prediction_request'
+require 'zernio-sdk/models/respond_to_phone_number_reviewer200_response'
+require 'zernio-sdk/models/respond_to_phone_number_reviewer_request'
+require 'zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner'
 require 'zernio-sdk/models/restore_workflow_version200_response'
 require 'zernio-sdk/models/restore_workflow_version200_response_workflow'
 require 'zernio-sdk/models/retweet_post200_response'

data/openapi.yaml

@@ -29363,6 +29363,83 @@ paths:
         '404': { description: Number not found }
         '502': { description: Couldn't deliver the reply to the reviewer; retry. }
 
+  /v1/phone-numbers/{id}/remediate/respond:
+    post:
+      operationId: respondToPhoneNumberReviewer
+      tags: [Phone Numbers]
+      summary: Respond to the regulatory reviewer (message + corrections)
+      description: |
+        Send a single response to the reviewer on a number awaiting remediation:
+        a free-text message and/or corrected requirement documents, in one call.
+        If corrections are present they are PATCHed onto the requirement group and
+        re-submitted (the number goes back to "in review"); if a message or file
+        attachments are present they are posted to the reviewer's comment thread.
+        When both are present, your message is the thread comment and the resubmit
+        drives the state change. At least one of message, corrections, or
+        attachments is required. `documents` correct requirement slots; `attachments`
+        are loose files (their links are added to your message).
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema: { type: string }
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                message: { type: string, maxLength: 2000, description: Your message to the reviewer. }
+                documents:
+                  type: array
+                  description: 'Corrected requirement documents, each keyed to its requirement.'
+                  items:
+                    type: object
+                    required: [requirementId]
+                    properties:
+                      requirementId: { type: string }
+                      filename: { type: string }
+                      base64: { type: string, description: Base64-encoded file bytes (or supply documentId instead). }
+                      documentId: { type: string, description: Id of a document already uploaded out-of-band. }
+                address:
+                  type: object
+                  description: A corrected address record, keyed to its requirement.
+                entityType:
+                  type: [string, 'null']
+                  enum: [individual, business, null]
+                attachments:
+                  type: array
+                  maxItems: 5
+                  description: 'Loose files (PDF/JPG/PNG/WEBP, max 10 MB each) whose links are added to your message.'
+                  items:
+                    type: object
+                    required: [filename, base64]
+                    properties:
+                      filename: { type: string }
+                      base64: { type: string, description: Base64-encoded file bytes. }
+      responses:
+        '200':
+          description: Response sent.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status: { type: string, enum: [resubmitted, replied], description: '`resubmitted` when corrections were submitted, `replied` when it was message-only.' }
+                  posted: { type: boolean, description: Whether a message/attachments were posted to the reviewer. }
+                  phoneNumber:
+                    type: object
+                    properties:
+                      id: { type: string }
+                      status: { type: string }
+                  siblingsResubmitted: { type: integer, description: Other numbers on the same registration the correction fanned out to. }
+        '400': { $ref: '#/components/responses/BadRequest' }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '404': { description: Number not found }
+        '409': { description: Number's registration is held under our own carrier registration; nothing for you to correct. }
+        '502': { description: Couldn't deliver your response to the reviewer; retry. }
+
   /v1/whatsapp/phone-numbers/kyc:
     get:
       operationId: getWhatsAppNumberKycForm
@@ -30428,6 +30505,7 @@ paths:
                         properties:
                           after: { type: string }
                           before: { type: string }
+        '400': { $ref: '#/components/responses/BadRequest' }
         '401': { $ref: '#/components/responses/Unauthorized' }
     post:
       operationId: createWhatsAppGroupChat
@@ -30468,6 +30546,7 @@ paths:
                     properties:
                       groupId: { type: string }
                       inviteLink: { type: string }
+        '400': { $ref: '#/components/responses/BadRequest' }
         '401': { $ref: '#/components/responses/Unauthorized' }
 
   /v1/whatsapp/wa-groups/{groupId}:
@@ -30511,6 +30590,7 @@ paths:
                       participantCount: { type: integer }
                       createdAt: { type: integer, description: UNIX timestamp }
                       isSuspended: { type: boolean }
+        '400': { $ref: '#/components/responses/BadRequest' }
         '401': { $ref: '#/components/responses/Unauthorized' }
         '404': { $ref: '#/components/responses/NotFound' }
     post:
@@ -30546,6 +30626,7 @@ paths:
                 properties:
                   success: { type: boolean }
                   message: { type: string }
+        '400': { $ref: '#/components/responses/BadRequest' }
         '401': { $ref: '#/components/responses/Unauthorized' }
         '404': { $ref: '#/components/responses/NotFound' }
     delete:
@@ -30571,6 +30652,7 @@ paths:
                 properties:
                   success: { type: boolean }
                   message: { type: string }
+        '400': { $ref: '#/components/responses/BadRequest' }
         '401': { $ref: '#/components/responses/Unauthorized' }
         '404': { $ref: '#/components/responses/NotFound' }
 
@@ -30611,6 +30693,7 @@ paths:
                 properties:
                   success: { type: boolean }
                   message: { type: string }
+        '400': { $ref: '#/components/responses/BadRequest' }
         '401': { $ref: '#/components/responses/Unauthorized' }
     delete:
       operationId: removeWhatsAppGroupParticipants
@@ -30647,6 +30730,7 @@ paths:
                 properties:
                   success: { type: boolean }
                   message: { type: string }
+        '400': { $ref: '#/components/responses/BadRequest' }
         '401': { $ref: '#/components/responses/Unauthorized' }
 
   /v1/whatsapp/wa-groups/{groupId}/invite-link:
@@ -30673,6 +30757,7 @@ paths:
                 properties:
                   success: { type: boolean }
                   inviteLink: { type: string }
+        '400': { $ref: '#/components/responses/BadRequest' }
         '401': { $ref: '#/components/responses/Unauthorized' }
 
   /v1/whatsapp/wa-groups/{groupId}/join-requests:
@@ -30705,6 +30790,7 @@ paths:
                       properties:
                         user: { type: string, description: Phone number }
                         timestamp: { type: integer, description: UNIX timestamp of request }
+        '400': { $ref: '#/components/responses/BadRequest' }
         '401': { $ref: '#/components/responses/Unauthorized' }
     post:
       operationId: approveWhatsAppGroupJoinRequests
@@ -30741,6 +30827,7 @@ paths:
                 properties:
                   success: { type: boolean }
                   message: { type: string }
+        '400': { $ref: '#/components/responses/BadRequest' }
         '401': { $ref: '#/components/responses/Unauthorized' }
     delete:
       operationId: rejectWhatsAppGroupJoinRequests
@@ -30777,6 +30864,7 @@ paths:
                 properties:
                   success: { type: boolean }
                   message: { type: string }
+        '400': { $ref: '#/components/responses/BadRequest' }
         '401': { $ref: '#/components/responses/Unauthorized' }
 
   # ─── WhatsApp Flows ───────────────────────────────────────────────

data/spec/api/phone_numbers_api_spec.rb

@@ -240,6 +240,19 @@ describe 'PhoneNumbersApi' do
     end
   end
 
+  # unit tests for respond_to_phone_number_reviewer
+  # Respond to the regulatory reviewer (message + corrections)
+  # Send a single response to the reviewer on a number awaiting remediation: a free-text message and/or corrected requirement documents, in one call. If corrections are present they are PATCHed onto the requirement group and re-submitted (the number goes back to \"in review\"); if a message or file attachments are present they are posted to the reviewer's comment thread. When both are present, your message is the thread comment and the resubmit drives the state change. At least one of message, corrections, or attachments is required. `documents` correct requirement slots; `attachments` are loose files (their links are added to your message). 
+  # @param id 
+  # @param respond_to_phone_number_reviewer_request 
+  # @param [Hash] opts the optional parameters
+  # @return [RespondToPhoneNumberReviewer200Response]
+  describe 'respond_to_phone_number_reviewer test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for review_phone_number_kyc_packet
   # Pre-review a KYC packet
   # Advisory dry-run of a regulated-KYC packet before submitting: reviews the exact documents the regulator will see (referenced by the ids from POST /v1/phone-numbers/kyc/upload-document) against the declared values and address, and returns plain-language advisories for likely decline reasons (wrong document type, mismatched address, one-sided ID scans). Non-blocking: advisories are warnings, submitting anyway is always allowed, and any review failure degrades to an empty list.