sc-apimatic-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab6a432c6e20b00e6c5ebcacc6bae222bec22a9d6d0c3a9c434f71858ab41b45
+  data.tar.gz: eaa14e3e014d31fe9236d45188b506d5248cf83160b0ee656b31efd03e71fa0f
+SHA512:
+  metadata.gz: 763b18143158f91cc7db22d22b82bc66da69f8a55052bb9e1525064100dd3eb5977159bf242a7e2504af1cbba1a2e7338cd74224e1c43f18c8d180c3c917ddf8
+  data.tar.gz: c78c208a22b14255badadd2dc3d54ba47366365a8c977dad66bee1445ecfcc6db16a8ccbb6ef269a199e35773079f90521fcfb59afa79ba93fe54df9de125417

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2026 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,166 @@
+
+# Getting Started with Socure RiskOS™ API
+
+## Introduction
+
+*RiskOS™ documentation site is Socure confidential and proprietary information, and is only intended for viewing by authorized persons.*
+
+The Socure RiskOS™ APIs provide a unified API framework for risk evaluation. They use predictable, resource-oriented URLs, accept JSON-formatted request bodies, return JSON-formatted responses, and follow standard HTTP methods, status codes, and authentication practices.
+
+You can test RiskOS™ APIs in the **Sandbox environment**, which allows you to simulate requests without impacting live data. The request endpoint determines whether the request is directed to the Sandbox or Production (live) environment.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install sc-apimatic-sdk -v 0.0.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'sc-apimatic-sdk', '0.0.1'
+```
+
+For additional gem details, see the [RubyGems page for the sc-apimatic-sdk gem](https://rubygems.org/gems/sc-apimatic-sdk/versions/0.0.1).
+
+## IRB Console Usage
+
+You can explore the SDK interactively using IRB in two ways
+
+### 1. Use IRB with Installed Gem
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
+
+```bash
+irb
+```
+
+Now you can load the SDK in the IRB
+
+```ruby
+require 'socure_risk_os_api'
+include SocureRiskOsApi
+```
+
+### 2. Use IRB within SDK
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
+
+```
+cd path/to/socure_risk_os_api
+```
+
+Now you can start the preconfigured irb console by running the following command
+
+```bash
+ruby bin/console
+```
+
+**_Note:_** This automatically loads the SDK from lib/
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| environment | [`Environment`](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION`** |
+| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| timeout | `Float` | The value to use for connection timeout. <br> **Default: 30** |
+| max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| bearer_auth_credentials | [`BearerAuthCredentials`](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'socure_risk_os_api'
+include SocureRiskOsApi
+
+client = Client.new(
+  bearer_auth_credentials: BearerAuthCredentials.new(
+    access_token: 'AccessToken'
+  ),
+  environment: Environment::PRODUCTION,
+  logging_configuration: LoggingConfiguration.new(
+    log_level: Logger::INFO,
+    request_logging_config: RequestLoggingConfiguration.new(
+      log_body: true
+    ),
+    response_logging_config: ResponseLoggingConfiguration.new(
+      log_headers: true
+    )
+  )
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'socure_risk_os_api'
+include SocureRiskOsApi
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md) section for details.
+
+## Environments
+
+The SDK can be configured to use a different environment for making API calls. Available environments are:
+
+### Fields
+
+| Name | Description |
+|  --- | --- |
+| PRODUCTION | **Default** Production server (versioned) |
+| ENVIRONMENT2 | Sandbox server (for testing and development, versioned) |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`BearerAuth (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md)
+
+## List of APIs
+
+* [Reason Codes](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/reason-codes.md)
+* [Evaluation](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/evaluation.md)
+* [Feedback](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/feedback.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/sc-apimatic-ruby-sdk/tree/0.0.1/doc/date-time-helper.md)
+

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# Load the lib folder into Ruby's load path
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+# Require the gem
+require 'socure_risk_os_api'
+
+puts 'SocureRiskOsApi SDK loaded!'
+puts 'You can now create a client with: client = SocureRiskOsApi::Client.new'
+puts 'Or use from_env: client = SocureRiskOsApi::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/socure_risk_os_api/api_helper.rb

@@ -0,0 +1,10 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end

data/lib/socure_risk_os_api/apis/base_api.rb

@@ -0,0 +1,67 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # BaseApi.
+  class BaseApi
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'Ruby-SDK/0.0.1 (OS: {os-info}, Engine: {engine}/{engine-version})'
+    end
+
+    def self.user_agent_parameters
+      {
+        '{engine}' => { 'value' => RUBY_ENGINE, 'encode' => false },
+        '{engine-version}' => { 'value' => RUBY_ENGINE_VERSION, 'encode' => false },
+        '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
+      }
+    end
+
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end

data/lib/socure_risk_os_api/apis/evaluation_api.rb

@@ -0,0 +1,318 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # EvaluationApi
+  class EvaluationApi < BaseApi
+    # Submit a new evaluation in RiskOS™. Select the evaluation type below to
+    # view the corresponding request schema.
+    # @param [ConsumerOnboarding | AdvancedPrefill | GenericPassthrough |
+    # TrustAndSafety | BankAccountVerification | BusinessOnboarding |
+    # LoginAndAuthentication | WorkforceVerification | PaymentScreening |
+    # AgeAssurance] body Required parameter: TODO: type description here
+    # @param [String] x_api_version Optional parameter: This header is optional.
+    # If omitted, requests use the current default version, `2025-01-01.orion`.
+    # Set this header to pin your integration to a specific API version.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def post_evaluation(body,
+                        x_api_version: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/evaluation',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true)
+                                .validator(proc do |value|
+                                  UnionTypeLookUp.get(:PostEvaluationBody)
+                                                 .validate(value)
+                                end))
+                   .header_param(new_parameter(x_api_version, key: 'X-API-Version'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(APIHelper.method(:json_serialize))
+                   .auth(Single.new('BearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(EvalResponseWithOutSocureData.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request – The request was invalid or cannot be otherwise'\
+                                  ' served.',
+                                 ErrorException)
+                    .local_error('401',
+                                 'Unauthorized – No valid API key provided.',
+                                 ErrorException)
+                    .local_error('403',
+                                 'Forbidden – IP address was rejected.',
+                                 ErrorException)
+                    .local_error('404',
+                                 'Not Found – The requested resource does not exist.',
+                                 ErrorException)
+                    .local_error('413',
+                                 'Payload Too Large – The `customer_metadata` object exceeds the'\
+                                  ' maximum allowed size.',
+                                 ErrorException)
+                    .local_error('429',
+                                 'Too Many Requests – The rate limit for this API has been'\
+                                  ' exceeded.',
+                                 ErrorException)
+                    .local_error('500',
+                                 'Internal Server Error – An unexpected condition occurred on'\
+                                  ' the server.',
+                                 ErrorException))
+        .execute
+    end
+
+    # Enable or disable daily watchlist monitoring for an existing evaluation.
+    # Monitored entities are checked automatically for additions, modifications,
+    # or removals across specified lists.
+    # @param [ApiEvaluationMonitoringRequest] body Required parameter: TODO:
+    # type description here
+    # @param [String] x_api_version Optional parameter: This header is optional.
+    # If omitted, requests use the current default version, `2025-01-01.orion`.
+    # Set this header to pin your integration to a specific API version.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def watchlist_monitoring(body,
+                             x_api_version: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/evaluation/monitoring',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter(x_api_version, key: 'X-API-Version'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('BearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ApiEvaluationMonitoringResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request - The request was unacceptable.',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized - An invalid API key was provided.',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden - The client does not have permission to access this'\
+                                  ' resource.',
+                                 APIException)
+                    .local_error('404',
+                                 'Not Found - The requested resource does not exist.',
+                                 APIException)
+                    .local_error('500',
+                                 'Internal Server Error – Unexpected server issue.',
+                                 APIException))
+        .execute
+    end
+
+    # Update risk data or metadata for a paused evaluation identified by
+    # `eval_id`. Partial updates are supported — omitted fields remain
+    # unchanged. Completed evaluations are immutable.
+    # @param [UUID | String] eval_id Required parameter: The system-generated
+    # unique ID for the evaluation. Capture this value from the initial `POST`
+    # `/api/evaluation` response.
+    # @param [ConsumerOnboardingPatch | TrustAndSafety | BankAccountVerification
+    # | BusinessOnboarding | LoginAndAuthentication] body Required parameter:
+    # TODO: type description here
+    # @param [String] x_api_version Optional parameter: This header is optional.
+    # If omitted, requests use the current default version, `2025-01-01.orion`.
+    # Set this header to pin your integration to a specific API version.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def patch_evaluation(eval_id,
+                         body,
+                         x_api_version: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/api/evaluation/{eval_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(eval_id, key: 'eval_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true)
+                                .validator(proc do |value|
+                                  UnionTypeLookUp.get(:EvaluationPatchRequest)
+                                                 .validate(value)
+                                end))
+                   .header_param(new_parameter(x_api_version, key: 'X-API-Version'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(APIHelper.method(:json_serialize))
+                   .auth(Single.new('BearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(EvalResponseWithOutSocureData.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request - The request was unacceptable.',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized - An invalid API key was provided.',
+                                 APIException)
+                    .local_error('404',
+                                 'Not Found - The requested resource does not exist.',
+                                 APIException)
+                    .local_error('413',
+                                 'Payload Too Large - The `customer_metadata` object exceeds the'\
+                                  ' maximum allowed size.',
+                                 APIException)
+                    .local_error('500',
+                                 '500 Internal Server Error – Unexpected server issue.',
+                                 APIException))
+        .execute
+    end
+
+    # Retrieves evaluation data for a workflow by providing the unique
+    # `eval_id`.
+    # @param [UUID | String] eval_id Required parameter: The system-generated
+    # unique ID for the evaluation. Capture this value from the initial `POST`
+    # `/api/evaluation` response.
+    # @param [String] x_api_version Optional parameter: This header is optional.
+    # If omitted, requests use the current default version, `2025-01-01.orion`.
+    # Set this header to pin your integration to a specific API version.
+    # @param [TrueClass | FalseClass] include_input Optional parameter: Set to
+    # `true` to include the original input data and any transformed data in the
+    # response under the `input` field.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_evaluation(eval_id,
+                       x_api_version: nil,
+                       include_input: false)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/evaluation/{eval_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(eval_id, key: 'eval_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_api_version, key: 'X-API-Version'))
+                   .query_param(new_parameter(include_input, key: 'include_input'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(EvalResponseWithOutSocureData.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request - The request was unacceptable.',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized - An invalid API key was provided.',
+                                 APIException)
+                    .local_error('404',
+                                 'Not Found - The requested resource does not exist.',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests - The rate limit for this API has been'\
+                                  ' exceeded.',
+                                 APIException)
+                    .local_error('500',
+                                 'Internal Server Error – An unexpected condition occurred on'\
+                                  ' the server.',
+                                 APIException))
+        .execute
+    end
+
+    # Retrieve a ZIP archive of documents associated with an evaluation,
+    # including user-uploaded identity documents and reviewer-added case
+    # attachments.
+    # @param [UUID | String] eval_id Required parameter: The system-generated
+    # unique ID for the evaluation. Capture this value from the initial `POST`
+    # `/api/evaluation` response.
+    # @param [String] x_api_version Optional parameter: This header is optional.
+    # If omitted, requests use the current default version, `2025-01-01.orion`.
+    # Set this header to pin your integration to a specific API version.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def download_evaluation_documents(eval_id,
+                                      x_api_version: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/evaluation/{eval_id}/documents',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(eval_id, key: 'eval_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_api_version, key: 'X-API-Version'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:dynamic_deserializer))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request - The request was unacceptable.',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized - An invalid API key was provided.',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden - The client does not have permission to access this'\
+                                  ' resource.',
+                                 APIException)
+                    .local_error('404',
+                                 'Not Found - The requested resource does not exist.',
+                                 APIException)
+                    .local_error('500',
+                                 'Internal Server Error – An unexpected condition occurred on'\
+                                  ' the server.',
+                                 APIException))
+        .execute
+    end
+
+    # Updates evaluation metadata, including `decision`, `status`, and
+    # `sub_status`, and optionally adds notes or a base64-encoded attachment.
+    # @param [UUID | String] eval_id Required parameter: The system-generated
+    # unique ID for the evaluation. Capture this value from the initial `POST`
+    # `/api/evaluation` response.
+    # @param [UpdateDecision | UpdateStatus] body Required parameter: TODO: type
+    # description here
+    # @param [String] x_api_version Optional parameter: This header is optional.
+    # If omitted, requests use the current default version, `2025-01-01.orion`.
+    # Set this header to pin your integration to a specific API version.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_evaluation_state(eval_id,
+                                body,
+                                x_api_version: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/api/evaluation/{eval_id}/state',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(eval_id, key: 'eval_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true)
+                                .validator(proc do |value|
+                                  UnionTypeLookUp.get(:UpdateEvaluationStateBody)
+                                                 .validate(value)
+                                end))
+                   .header_param(new_parameter(x_api_version, key: 'X-API-Version'))
+                   .body_serializer(APIHelper.method(:json_serialize))
+                   .auth(Single.new('BearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request - The request was unacceptable.',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized - An invalid API key was provided.',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden - IP Address was rejected.',
+                                 APIException)
+                    .local_error('404',
+                                 'Not Found - The requested resource does not exist.',
+                                 APIException)
+                    .local_error('500',
+                                 'Internal Server Error – An unexpected condition occurred on'\
+                                  ' the server.',
+                                 APIException))
+        .execute
+    end
+  end
+end