packageruby 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b1047d7820c59941d1102b4b6461c1f7bae707d699cae98597876c2a27004af
+  data.tar.gz: ac94b9ff8c591b12822e806e9c8f11771d1e8275a29d50ecc795fa91de243ade
+SHA512:
+  metadata.gz: 511607c4195fe86734ac3cfaa469f679225e18a08471fe7fb351464d0404a0bae6b2853093bcb5948168fc79e17fd1c9d935c6acf3f32eae0ea2e5794ccd5151
+  data.tar.gz: e47519920fe7c60e1933d50514bd79aad7cab551ab031ea1aba815eb903d17f31720cdca4f4cb5c81a16e8310d07cfb644f7278ee756e250e5fb14b1b06d4aca

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2024 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,95 @@
+
+# Getting Started with Form3 Public API
+
+## Install the Package
+
+Install the gem from the command line:
+
+```ruby
+gem install packageruby -v 1.1.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'packageruby', '1.1.1'
+```
+
+For additional gem details, see the [RubyGems page for the packageruby gem](https://rubygems.org/gems/packageruby/versions/1.1.1).
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| `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: 60** |
+| `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. |
+| `basic_credentials` | [`BasicCredentials`](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/$a/https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/basic-authentication.md) | The credential object for Basic Authentication |
+| `o_auth_2_credentials` | [`OAuth2Credentials`](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/$a/https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+
+The API client can be initialized as follows:
+
+```ruby
+client = Form3PublicApi::Client.new(
+  basic_credentials: BasicCredentials.new(
+    username: 'Username',
+    password: 'Password'
+  ),
+  o_auth2_credentials: OAuth2Credentials.new(
+    o_auth_client_id: 'OAuthClientId',
+    o_auth_client_secret: 'OAuthClientSecret'
+  )
+)
+```
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`Basic (Basic Authentication)`](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/$a/https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/basic-authentication.md)
+* [`OAuth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/$a/https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/oauth-2-client-credentials-grant.md)
+
+## List of APIs
+
+* [Scheme File API](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/scheme-file-api.md)
+* [Transaction File API](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/transaction-file-api.md)
+* [Metrics API](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/metrics-api.md)
+* [Name Verification API](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/name-verification-api.md)
+* [O Auth Authorization](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/o-auth-authorization.md)
+* [Audit](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/audit.md)
+* [Reports](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/reports.md)
+* [Scheme Messages](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/scheme-messages.md)
+* [Subscriptions](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/subscriptions.md)
+* [Oauth 2](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/oauth-2.md)
+* [Accounts](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/accounts.md)
+* [Account Identification](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/account-identification.md)
+* [Branches](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/branches.md)
+* [Branch Identification](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/branch-identification.md)
+* [Payments](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/payments.md)
+* [Organisations](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/organisations.md)
+* [Platformsecurityapi](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/platformsecurityapi.md)
+* [Roles](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/roles.md)
+* [ACE](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/ace.md)
+* [Users](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/users.md)
+* [Claims](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/claims.md)
+* [Direct Debits](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/direct-debits.md)
+* [Mandates](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/mandates.md)
+* [Query Api](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/query-api.md)
+* [Account Validation](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/controllers/account-validation.md)
+
+## Classes Documentation
+
+* [Utility Classes](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/utility-classes.md)
+* [HttpResponse](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/ZahraN444/formzeepackage-1-ruby-sdk/tree/1.1.1/doc/http-request.md)
+

data/lib/form3_public_api/api_helper.rb

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

data/lib/form3_public_api/client.rb

@@ -0,0 +1,209 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  #  form3_public_api client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    # Returns the configured authentication OAuth2 instance.
+    def o_auth2
+      @auth_managers['OAuth2']
+    end
+
+    # Access to audit controller.
+    # @return [AuditController] Returns the controller instance.
+    def audit
+      @audit ||= AuditController.new @global_configuration
+    end
+
+    # Access to scheme_file_api controller.
+    # @return [SchemeFileAPIController] Returns the controller instance.
+    def scheme_file_api
+      @scheme_file_api ||= SchemeFileAPIController.new @global_configuration
+    end
+
+    # Access to transaction_file_api controller.
+    # @return [TransactionFileAPIController] Returns the controller instance.
+    def transaction_file_api
+      @transaction_file_api ||= TransactionFileAPIController.new @global_configuration
+    end
+
+    # Access to metrics_api controller.
+    # @return [MetricsAPIController] Returns the controller instance.
+    def metrics_api
+      @metrics_api ||= MetricsAPIController.new @global_configuration
+    end
+
+    # Access to reports controller.
+    # @return [ReportsController] Returns the controller instance.
+    def reports
+      @reports ||= ReportsController.new @global_configuration
+    end
+
+    # Access to scheme_messages controller.
+    # @return [SchemeMessagesController] Returns the controller instance.
+    def scheme_messages
+      @scheme_messages ||= SchemeMessagesController.new @global_configuration
+    end
+
+    # Access to subscriptions controller.
+    # @return [SubscriptionsController] Returns the controller instance.
+    def subscriptions
+      @subscriptions ||= SubscriptionsController.new @global_configuration
+    end
+
+    # Access to oauth2 controller.
+    # @return [Oauth2Controller] Returns the controller instance.
+    def oauth2
+      @oauth2 ||= Oauth2Controller.new @global_configuration
+    end
+
+    # Access to accounts controller.
+    # @return [AccountsController] Returns the controller instance.
+    def accounts
+      @accounts ||= AccountsController.new @global_configuration
+    end
+
+    # Access to account_identification controller.
+    # @return [AccountIdentificationController] Returns the controller instance.
+    def account_identification
+      @account_identification ||= AccountIdentificationController.new @global_configuration
+    end
+
+    # Access to branches controller.
+    # @return [BranchesController] Returns the controller instance.
+    def branches
+      @branches ||= BranchesController.new @global_configuration
+    end
+
+    # Access to branch_identification controller.
+    # @return [BranchIdentificationController] Returns the controller instance.
+    def branch_identification
+      @branch_identification ||= BranchIdentificationController.new @global_configuration
+    end
+
+    # Access to name_verification_api controller.
+    # @return [NameVerificationAPIController] Returns the controller instance.
+    def name_verification_api
+      @name_verification_api ||= NameVerificationAPIController.new @global_configuration
+    end
+
+    # Access to payments controller.
+    # @return [PaymentsController] Returns the controller instance.
+    def payments
+      @payments ||= PaymentsController.new @global_configuration
+    end
+
+    # Access to organisations controller.
+    # @return [OrganisationsController] Returns the controller instance.
+    def organisations
+      @organisations ||= OrganisationsController.new @global_configuration
+    end
+
+    # Access to platformsecurityapi controller.
+    # @return [PlatformsecurityapiController] Returns the controller instance.
+    def platformsecurityapi
+      @platformsecurityapi ||= PlatformsecurityapiController.new @global_configuration
+    end
+
+    # Access to roles controller.
+    # @return [RolesController] Returns the controller instance.
+    def roles
+      @roles ||= RolesController.new @global_configuration
+    end
+
+    # Access to ace controller.
+    # @return [ACEController] Returns the controller instance.
+    def ace
+      @ace ||= ACEController.new @global_configuration
+    end
+
+    # Access to users controller.
+    # @return [UsersController] Returns the controller instance.
+    def users
+      @users ||= UsersController.new @global_configuration
+    end
+
+    # Access to claims controller.
+    # @return [ClaimsController] Returns the controller instance.
+    def claims
+      @claims ||= ClaimsController.new @global_configuration
+    end
+
+    # Access to direct_debits controller.
+    # @return [DirectDebitsController] Returns the controller instance.
+    def direct_debits
+      @direct_debits ||= DirectDebitsController.new @global_configuration
+    end
+
+    # Access to mandates controller.
+    # @return [MandatesController] Returns the controller instance.
+    def mandates
+      @mandates ||= MandatesController.new @global_configuration
+    end
+
+    # Access to query_api controller.
+    # @return [QueryApiController] Returns the controller instance.
+    def query_api
+      @query_api ||= QueryApiController.new @global_configuration
+    end
+
+    # Access to account_validation controller.
+    # @return [AccountValidationController] Returns the controller instance.
+    def account_validation
+      @account_validation ||= AccountValidationController.new @global_configuration
+    end
+
+    # Access to o_auth_authorization controller.
+    # @return [OAuthAuthorizationController] Returns the controller instance.
+    def o_auth_authorization
+      @o_auth_authorization ||= OAuthAuthorizationController.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil,
+      environment: Environment::PRODUCTION, basic_credentials: nil,
+      o_auth2_credentials: nil, config: nil
+    )
+      @config = if config.nil?
+                  Configuration.new(connection: connection, adapter: adapter,
+                                    timeout: timeout, max_retries: max_retries,
+                                    retry_interval: retry_interval,
+                                    backoff_factor: backoff_factor,
+                                    retry_statuses: retry_statuses,
+                                    retry_methods: retry_methods,
+                                    http_callback: http_callback,
+                                    environment: environment,
+                                    basic_credentials: basic_credentials,
+                                    o_auth2_credentials: o_auth2_credentials)
+                else
+                  config
+                end
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseController::GLOBAL_ERRORS)
+                                                 .user_agent(BaseController.user_agent)
+
+      initialize_auth_managers(@global_configuration)
+      @global_configuration = @global_configuration.auth_managers(@auth_managers)
+    end
+
+    # Initializes the auth managers hash used for authenticating API calls.
+    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
+    def initialize_auth_managers(global_config)
+      @auth_managers = {}
+      http_client_config = global_config.client_configuration
+      %w[Basic OAuth2].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['Basic'] = Basic.new(http_client_config.basic_credentials)
+      @auth_managers['OAuth2'] = OAuth2.new(http_client_config.o_auth2_credentials, global_config)
+    end
+  end
+end

data/lib/form3_public_api/configuration.rb

@@ -0,0 +1,103 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # An enum for SDK environments.
+  class Environment
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze
+    ].freeze
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze
+    ].freeze
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    # The attribute readers for properties.
+    attr_reader :environment, :basic_credentials, :o_auth2_credentials
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil,
+      environment: Environment::PRODUCTION, basic_credentials: nil,
+      o_auth2_credentials: nil
+    )
+
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The object holding Basic Authentication credentials
+      @basic_credentials = basic_credentials
+
+      # The object holding OAuth 2 Client Credentials Grant credentials
+      @o_auth2_credentials = o_auth2_credentials
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   environment: nil, basic_credentials: nil,
+                   o_auth2_credentials: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      environment ||= self.environment
+      basic_credentials ||= self.basic_credentials
+      o_auth2_credentials ||= self.o_auth2_credentials
+
+      Configuration.new(connection: connection, adapter: adapter,
+                        timeout: timeout, max_retries: max_retries,
+                        retry_interval: retry_interval,
+                        backoff_factor: backoff_factor,
+                        retry_statuses: retry_statuses,
+                        retry_methods: retry_methods,
+                        http_callback: http_callback, environment: environment,
+                        basic_credentials: basic_credentials,
+                        o_auth2_credentials: o_auth2_credentials)
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://api.form3.tech/v1'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      ENVIRONMENTS[environment][server].clone
+    end
+  end
+end

data/lib/form3_public_api/controllers/account_identification_controller.rb

@@ -0,0 +1,156 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # AccountIdentificationController
+  class AccountIdentificationController < BaseController
+    # List Account Identifications by Account
+    # @param [UUID | String] account_id Required parameter: Account Id to which
+    # this identification relates to
+    # @param [String] page_number Optional parameter: Which page to select
+    # @param [Integer] page_size Optional parameter: Number of items to select
+    # @param [Array[UUID | String]] filter_organisation_id Optional parameter:
+    # Filter by organisation id
+    # @param [Array[String]] filter_secondary_identification Optional parameter:
+    # Filter to only include account identifications with specified
+    # secondary_identification
+    # @return [AccountIdentificationListResponse] response from the API call
+    def list_account_identifications_by_account(account_id,
+                                                page_number: nil,
+                                                page_size: nil,
+                                                filter_organisation_id: nil,
+                                                filter_secondary_identification: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/organisation/accounts/{account_id}/identifications',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(account_id, key: 'account_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(page_number, key: 'page[number]'))
+                   .query_param(new_parameter(page_size, key: 'page[size]'))
+                   .query_param(new_parameter(filter_organisation_id, key: 'filter[organisation_id]'))
+                   .query_param(new_parameter(filter_secondary_identification, key: 'filter[secondary_identification]'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(AccountIdentificationListResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Create an identification for an existing Account
+    # @param [UUID | String] account_id Required parameter: Account Id to which
+    # this identification relates to
+    # @param [AccountIdentificationRequest]
+    # account_identification_creation_request Optional parameter: Example:
+    # @return [AccountIdentificationResponse] response from the API call
+    def create_an_identification_for_an_existing_account(account_id,
+                                                         account_identification_creation_request: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/organisation/accounts/{account_id}/identifications',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(account_id, key: 'account_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
+                   .body_param(new_parameter(account_identification_creation_request))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(AccountIdentificationResponse.method(:from_hash))
+                   .local_error('409',
+                                'Account Identification creation error, constraint violation of'\
+                                 ' secondary identification',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Delete account identification
+    # @param [UUID | String] account_id Required parameter: Account Id
+    # @param [UUID | String] identification_id Required parameter: Account
+    # Identification Id
+    # @param [Integer] version Required parameter: Version
+    # @return [void] response from the API call
+    def delete_account_identification(account_id,
+                                      identification_id,
+                                      version)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/organisation/accounts/{account_id}/identifications/{identification_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(account_id, key: 'account_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(identification_id, key: 'identification_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(version, key: 'version'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .is_response_void(true)
+                   .local_error('404',
+                                'Account Identification not found',
+                                APIException))
+        .execute
+    end
+
+    # Get an account identification by id
+    # @param [UUID | String] account_id Required parameter: Account Id
+    # @param [UUID | String] identification_id Required parameter: Account
+    # Identification Id
+    # @return [AccountIdentificationResponse] response from the API call
+    def get_an_account_identification_by_id(account_id,
+                                            identification_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/organisation/accounts/{account_id}/identifications/{identification_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(account_id, key: 'account_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(identification_id, key: 'identification_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(AccountIdentificationResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Amend Account Identification
+    # @param [UUID | String] account_id Required parameter: Account Id
+    # @param [UUID | String] identification_id Required parameter: Account
+    # Identification Id; Must match id in the payload
+    # @param [AccountIdentificationRequest] account_identification_amend_request
+    # Optional parameter: Example:
+    # @return [AccountIdentificationResponse] response from the API call
+    def amend_account_identification(account_id,
+                                     identification_id,
+                                     account_identification_amend_request: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/organisation/accounts/{account_id}/identifications/{identification_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(account_id, key: 'account_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(identification_id, key: 'identification_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
+                   .body_param(new_parameter(account_identification_amend_request))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(AccountIdentificationResponse.method(:from_hash))
+                   .local_error('409',
+                                'Account Identification update error, constraint violation of'\
+                                 ' secondary identification',
+                                ApiErrorException))
+        .execute
+    end
+  end
+end

data/lib/form3_public_api/controllers/account_validation_controller.rb

@@ -0,0 +1,58 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # AccountValidationController
+  class AccountValidationController < BaseController
+    # Fetch sort code details
+    # @param [String] sortcode Required parameter: Sort code
+    # @return [SortCodeDetailsResponse] response from the API call
+    def fetch_sort_code_details(sortcode)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/validations/gbdsc/sortcodes/{sortcode}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(sortcode, key: 'sortcode')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(SortCodeDetailsResponse.method(:from_hash))
+                   .local_error('400',
+                                'Validation failed',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Validate sortcode and account number details
+    # @param [String] sortcode Required parameter: Sort code
+    # @param [String] accountnumber Required parameter: Account number
+    # @return [AccountNumberDetailsResponse] response from the API call
+    def validate_sortcode_and_account_number_details(sortcode,
+                                                     accountnumber)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/validations/gbdsc/sortcodes/{sortcode}/accountnumbers/{accountnumber}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(sortcode, key: 'sortcode')
+                                    .should_encode(true))
+                   .template_param(new_parameter(accountnumber, key: 'accountnumber')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(AccountNumberDetailsResponse.method(:from_hash))
+                   .local_error('400',
+                                'Validation error',
+                                ApiErrorException)
+                   .local_error('404',
+                                'Validation failed',
+                                ApiErrorException))
+        .execute
+    end
+  end
+end