late-sdk 0.0.561 → 0.0.562

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17ac91116594e8f9f73b90cad7362fd627cf357b604b6f218a43181c2267c954
-  data.tar.gz: 6ce272bbe5578fe33da52599162b1c3c0c6456d403fc719d3685e27003a02028
+  metadata.gz: 9237073662107b02c4d1da51955963400ecd21cd0d4a4d416a6f8ef613db6b1b
+  data.tar.gz: cf0a7f2ac53f0f70e9c0d4d53be04a457d48cd8e78753742ff9ddfbc5451ceab
 SHA512:
-  metadata.gz: b6808329cd872d87c101fff77704ab5c44cc59f32d06897c150b4e1132e62622fa6e7305a3e07b188ce60ac4bce8247e2edb0f309b7e98a892214eaff1eb819b
-  data.tar.gz: 646b27deacd31fd466383f0475a143bc673324cb22bdeaba58bcbc21a65198d49626363cce610e4dee65c5d5abd21629770dfd61a34d741e681871a2e902ff5d
+  metadata.gz: 16e6de5ddd7a37f5ddfcb79d335262c996743fdf1d8d8265952a1ac78d9fff25328414b9c6c9149f2170b6acf06686bcc2a153bb2dfbdc12ef480ad90dd3a8ee
+  data.tar.gz: 54c325cd8559561db299fb311578bc41fd330a5a5f32c7dee9f4f6012c4c4f29caef07db08192f0952d900a3f7848808a6c63eab9bebcdcd204cf4cb509500e2

data/README.md

@@ -375,6 +375,7 @@ Class | Method | HTTP request | Description
 *Zernio::PhoneNumbersApi* | [**release_phone_number**](docs/PhoneNumbersApi.md#release_phone_number) | **DELETE** /v1/phone-numbers/{id} | Release phone number
 *Zernio::PhoneNumbersApi* | [**remediate_phone_number**](docs/PhoneNumbersApi.md#remediate_phone_number) | **POST** /v1/phone-numbers/{id}/remediate | Resubmit a declined number
 *Zernio::PhoneNumbersApi* | [**reply_to_phone_number_reviewer**](docs/PhoneNumbersApi.md#reply_to_phone_number_reviewer) | **POST** /v1/phone-numbers/{id}/remediate/reply | Reply to the regulatory reviewer
+*Zernio::PhoneNumbersApi* | [**respond_to_phone_number_reviewer**](docs/PhoneNumbersApi.md#respond_to_phone_number_reviewer) | **POST** /v1/phone-numbers/{id}/remediate/respond | Respond to the regulatory reviewer (message + corrections)
 *Zernio::PhoneNumbersApi* | [**review_phone_number_kyc_packet**](docs/PhoneNumbersApi.md#review_phone_number_kyc_packet) | **POST** /v1/phone-numbers/kyc/review-packet | Pre-review a KYC packet
 *Zernio::PhoneNumbersApi* | [**search_available_phone_numbers**](docs/PhoneNumbersApi.md#search_available_phone_numbers) | **GET** /v1/phone-numbers/available | Search available numbers
 *Zernio::PhoneNumbersApi* | [**submit_phone_number_kyc**](docs/PhoneNumbersApi.md#submit_phone_number_kyc) | **POST** /v1/phone-numbers/kyc | Submit KYC
@@ -1601,6 +1602,9 @@ Class | Method | HTTP request | Description
  - [Zernio::ResendSmsRegistrationOtp200Response](docs/ResendSmsRegistrationOtp200Response.md)
  - [Zernio::ReserveRfPrediction201Response](docs/ReserveRfPrediction201Response.md)
  - [Zernio::ReserveRfPredictionRequest](docs/ReserveRfPredictionRequest.md)
+ - [Zernio::RespondToPhoneNumberReviewer200Response](docs/RespondToPhoneNumberReviewer200Response.md)
+ - [Zernio::RespondToPhoneNumberReviewerRequest](docs/RespondToPhoneNumberReviewerRequest.md)
+ - [Zernio::RespondToPhoneNumberReviewerRequestDocumentsInner](docs/RespondToPhoneNumberReviewerRequestDocumentsInner.md)
  - [Zernio::RestoreWorkflowVersion200Response](docs/RestoreWorkflowVersion200Response.md)
  - [Zernio::RestoreWorkflowVersion200ResponseWorkflow](docs/RestoreWorkflowVersion200ResponseWorkflow.md)
  - [Zernio::RetweetPost200Response](docs/RetweetPost200Response.md)

data/docs/PhoneNumbersApi.md

@@ -21,6 +21,7 @@ All URIs are relative to *https://zernio.com/api*
 | [**release_phone_number**](PhoneNumbersApi.md#release_phone_number) | **DELETE** /v1/phone-numbers/{id} | Release phone number |
 | [**remediate_phone_number**](PhoneNumbersApi.md#remediate_phone_number) | **POST** /v1/phone-numbers/{id}/remediate | Resubmit a declined number |
 | [**reply_to_phone_number_reviewer**](PhoneNumbersApi.md#reply_to_phone_number_reviewer) | **POST** /v1/phone-numbers/{id}/remediate/reply | Reply to the regulatory reviewer |
+| [**respond_to_phone_number_reviewer**](PhoneNumbersApi.md#respond_to_phone_number_reviewer) | **POST** /v1/phone-numbers/{id}/remediate/respond | Respond to the regulatory reviewer (message + corrections) |
 | [**review_phone_number_kyc_packet**](PhoneNumbersApi.md#review_phone_number_kyc_packet) | **POST** /v1/phone-numbers/kyc/review-packet | Pre-review a KYC packet |
 | [**search_available_phone_numbers**](PhoneNumbersApi.md#search_available_phone_numbers) | **GET** /v1/phone-numbers/available | Search available numbers |
 | [**submit_phone_number_kyc**](PhoneNumbersApi.md#submit_phone_number_kyc) | **POST** /v1/phone-numbers/kyc | Submit KYC |
@@ -1217,6 +1218,77 @@ end
 - **Accept**: application/json
 
 
+## respond_to_phone_number_reviewer
+
+> <RespondToPhoneNumberReviewer200Response> respond_to_phone_number_reviewer(id, respond_to_phone_number_reviewer_request)
+
+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). 
+
+### 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
+id = 'id_example' # String | 
+respond_to_phone_number_reviewer_request = Zernio::RespondToPhoneNumberReviewerRequest.new # RespondToPhoneNumberReviewerRequest | 
+
+begin
+  # Respond to the regulatory reviewer (message + corrections)
+  result = api_instance.respond_to_phone_number_reviewer(id, respond_to_phone_number_reviewer_request)
+  p result
+rescue Zernio::ApiError => e
+  puts "Error when calling PhoneNumbersApi->respond_to_phone_number_reviewer: #{e}"
+end
+```
+
+#### Using the respond_to_phone_number_reviewer_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RespondToPhoneNumberReviewer200Response>, Integer, Hash)> respond_to_phone_number_reviewer_with_http_info(id, respond_to_phone_number_reviewer_request)
+
+```ruby
+begin
+  # Respond to the regulatory reviewer (message + corrections)
+  data, status_code, headers = api_instance.respond_to_phone_number_reviewer_with_http_info(id, respond_to_phone_number_reviewer_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RespondToPhoneNumberReviewer200Response>
+rescue Zernio::ApiError => e
+  puts "Error when calling PhoneNumbersApi->respond_to_phone_number_reviewer_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **respond_to_phone_number_reviewer_request** | [**RespondToPhoneNumberReviewerRequest**](RespondToPhoneNumberReviewerRequest.md) |  |  |
+
+### Return type
+
+[**RespondToPhoneNumberReviewer200Response**](RespondToPhoneNumberReviewer200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## review_phone_number_kyc_packet
 
 > <ReviewPhoneNumberKycPacket200Response> review_phone_number_kyc_packet(review_phone_number_kyc_packet_request)

data/docs/RespondToPhoneNumberReviewer200Response.md

@@ -0,0 +1,24 @@
+# Zernio::RespondToPhoneNumberReviewer200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | `resubmitted` when corrections were submitted, `replied` when it was message-only. | [optional] |
+| **posted** | **Boolean** | Whether a message/attachments were posted to the reviewer. | [optional] |
+| **phone_number** | [**RemediatePhoneNumber200ResponsePhoneNumber**](RemediatePhoneNumber200ResponsePhoneNumber.md) |  | [optional] |
+| **siblings_resubmitted** | **Integer** | Other numbers on the same registration the correction fanned out to. | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::RespondToPhoneNumberReviewer200Response.new(
+  status: null,
+  posted: null,
+  phone_number: null,
+  siblings_resubmitted: null
+)
+```
+

data/docs/RespondToPhoneNumberReviewerRequest.md

@@ -0,0 +1,26 @@
+# Zernio::RespondToPhoneNumberReviewerRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Your message to the reviewer. | [optional] |
+| **documents** | [**Array<RespondToPhoneNumberReviewerRequestDocumentsInner>**](RespondToPhoneNumberReviewerRequestDocumentsInner.md) | Corrected requirement documents, each keyed to its requirement. | [optional] |
+| **address** | **Object** | A corrected address record, keyed to its requirement. | [optional] |
+| **entity_type** | **String** |  | [optional] |
+| **attachments** | [**Array<ReplyToPhoneNumberReviewerRequestAttachmentsInner>**](ReplyToPhoneNumberReviewerRequestAttachmentsInner.md) | Loose files (PDF/JPG/PNG/WEBP, max 10 MB each) whose links are added to your message. | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::RespondToPhoneNumberReviewerRequest.new(
+  message: null,
+  documents: null,
+  address: null,
+  entity_type: null,
+  attachments: null
+)
+```
+

data/docs/RespondToPhoneNumberReviewerRequestDocumentsInner.md

@@ -0,0 +1,24 @@
+# Zernio::RespondToPhoneNumberReviewerRequestDocumentsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **requirement_id** | **String** |  |  |
+| **filename** | **String** |  | [optional] |
+| **base64** | **String** | Base64-encoded file bytes (or supply documentId instead). | [optional] |
+| **document_id** | **String** | Id of a document already uploaded out-of-band. | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::RespondToPhoneNumberReviewerRequestDocumentsInner.new(
+  requirement_id: null,
+  filename: null,
+  base64: null,
+  document_id: null
+)
+```
+

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

@@ -1156,6 +1156,80 @@ module Zernio
       return data, status_code, headers
     end
 
+    # 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 [String] 
+    # @param respond_to_phone_number_reviewer_request [RespondToPhoneNumberReviewerRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [RespondToPhoneNumberReviewer200Response]
+    def respond_to_phone_number_reviewer(id, respond_to_phone_number_reviewer_request, opts = {})
+      data, _status_code, _headers = respond_to_phone_number_reviewer_with_http_info(id, respond_to_phone_number_reviewer_request, opts)
+      data
+    end
+
+    # 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 [String] 
+    # @param respond_to_phone_number_reviewer_request [RespondToPhoneNumberReviewerRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RespondToPhoneNumberReviewer200Response, Integer, Hash)>] RespondToPhoneNumberReviewer200Response data, response status code and response headers
+    def respond_to_phone_number_reviewer_with_http_info(id, respond_to_phone_number_reviewer_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.respond_to_phone_number_reviewer ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling PhoneNumbersApi.respond_to_phone_number_reviewer"
+      end
+      # verify the required parameter 'respond_to_phone_number_reviewer_request' is set
+      if @api_client.config.client_side_validation && respond_to_phone_number_reviewer_request.nil?
+        fail ArgumentError, "Missing the required parameter 'respond_to_phone_number_reviewer_request' when calling PhoneNumbersApi.respond_to_phone_number_reviewer"
+      end
+      # resource path
+      local_var_path = '/v1/phone-numbers/{id}/remediate/respond'.sub('{' + 'id' + '}', CGI.escape(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']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(respond_to_phone_number_reviewer_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'RespondToPhoneNumberReviewer200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PhoneNumbersApi.respond_to_phone_number_reviewer",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PhoneNumbersApi#respond_to_phone_number_reviewer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 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. 
     # @param review_phone_number_kyc_packet_request [ReviewPhoneNumberKycPacketRequest] 

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

@@ -0,0 +1,211 @@
+=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 RespondToPhoneNumberReviewer200Response < ApiModelBase
+    # `resubmitted` when corrections were submitted, `replied` when it was message-only.
+    attr_accessor :status
+
+    # Whether a message/attachments were posted to the reviewer.
+    attr_accessor :posted
+
+    attr_accessor :phone_number
+
+    # Other numbers on the same registration the correction fanned out to.
+    attr_accessor :siblings_resubmitted
+
+    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
+      {
+        :'status' => :'status',
+        :'posted' => :'posted',
+        :'phone_number' => :'phoneNumber',
+        :'siblings_resubmitted' => :'siblingsResubmitted'
+      }
+    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
+      {
+        :'status' => :'String',
+        :'posted' => :'Boolean',
+        :'phone_number' => :'RemediatePhoneNumber200ResponsePhoneNumber',
+        :'siblings_resubmitted' => :'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::RespondToPhoneNumberReviewer200Response` 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::RespondToPhoneNumberReviewer200Response`. 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?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'posted')
+        self.posted = attributes[:'posted']
+      end
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+
+      if attributes.key?(:'siblings_resubmitted')
+        self.siblings_resubmitted = attributes[:'siblings_resubmitted']
+      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'
+      status_validator = EnumAttributeValidator.new('String', ["resubmitted", "replied"])
+      return false unless status_validator.valid?(@status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["resubmitted", "replied"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    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 &&
+          status == o.status &&
+          posted == o.posted &&
+          phone_number == o.phone_number &&
+          siblings_resubmitted == o.siblings_resubmitted
+    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
+      [status, posted, phone_number, siblings_resubmitted].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