packageruby 1.1.1

data/lib/form3_public_api/controllers/accounts_controller.rb

@@ -0,0 +1,169 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # AccountsController
+  class AccountsController < BaseController
+    # List accounts
+    # @param [String] page_number Optional parameter: Which page to select
+    # @param [String] page_before Optional parameter: Cursor value for getting
+    # previous page
+    # @param [String] page_after Optional parameter: Cursor value for getting
+    # next page
+    # @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_bank_id_code Optional parameter: Filter by
+    # type of bank id e.g. "GBDSC"
+    # @param [Array[String]] filter_bank_id Optional parameter: Filter by bank
+    # id e.g. sort code or bic
+    # @param [Array[String]] filter_account_number Optional parameter: Filter by
+    # account number
+    # @param [Array[String]] filter_country Optional parameter: Filter by
+    # country e.g. FR,GB
+    # @param [Array[String]] filter_customer_id Optional parameter: Filter by
+    # customer_id
+    # @param [Array[String]] filter_iban Optional parameter: Filter by IBAN
+    # @return [AccountDetailsListResponse] response from the API call
+    def list_accounts(page_number: nil,
+                      page_before: nil,
+                      page_after: nil,
+                      page_size: nil,
+                      filter_organisation_id: nil,
+                      filter_bank_id_code: nil,
+                      filter_bank_id: nil,
+                      filter_account_number: nil,
+                      filter_country: nil,
+                      filter_customer_id: nil,
+                      filter_iban: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/organisation/accounts',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(page_number, key: 'page[number]'))
+                   .query_param(new_parameter(page_before, key: 'page[before]'))
+                   .query_param(new_parameter(page_after, key: 'page[after]'))
+                   .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_bank_id_code, key: 'filter[bank_id_code]'))
+                   .query_param(new_parameter(filter_bank_id, key: 'filter[bank_id]'))
+                   .query_param(new_parameter(filter_account_number, key: 'filter[account_number]'))
+                   .query_param(new_parameter(filter_country, key: 'filter[country]'))
+                   .query_param(new_parameter(filter_customer_id, key: 'filter[customer_id]'))
+                   .query_param(new_parameter(filter_iban, key: 'filter[iban]'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(AccountDetailsListResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Create account
+    # @param [AccountCreation] account_creation_request Optional parameter:
+    # Example:
+    # @return [AccountCreationResponse] response from the API call
+    def create_account(account_creation_request: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/organisation/accounts',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
+                   .body_param(new_parameter(account_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(AccountCreationResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Delete account
+    # @param [UUID | String] id Required parameter: Account Id
+    # @param [Integer] version Required parameter: Version
+    # @return [void] response from the API call
+    def delete_account(id,
+                       version)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/organisation/accounts/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(version, key: 'version'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .is_response_void(true))
+        .execute
+    end
+
+    # Fetch account
+    # @param [UUID | String] id Required parameter: Account Id
+    # @return [AccountDetailsResponse] response from the API call
+    def fetch_account(id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/organisation/accounts/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .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(AccountDetailsResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Amend account
+    # @param [UUID | String] id Required parameter: Account Id
+    # @param [AccountAmendment] account_amend_request Optional parameter:
+    # Example:
+    # @return [AccountDetailsResponse] response from the API call
+    def amend_account(id,
+                      account_amend_request: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/organisation/accounts/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
+                   .body_param(new_parameter(account_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(AccountDetailsResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Fetch account events
+    # @param [UUID | String] id Required parameter: Account Id
+    # @param [String] page_number Optional parameter: Which page to select
+    # @param [Integer] page_size Optional parameter: Number of items to select
+    # @return [AccountEventListResponse] response from the API call
+    def fetch_account_events(id,
+                             page_number: nil,
+                             page_size: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/organisation/accounts/{id}/events',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(page_number, key: 'page[number]'))
+                   .query_param(new_parameter(page_size, key: 'page[size]'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(AccountEventListResponse.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/form3_public_api/controllers/ace_controller.rb

@@ -0,0 +1,113 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # ACEController
+  class ACEController < BaseController
+    # List all Access Controls for role
+    # @param [UUID | String] role_id Required parameter: Role Id
+    # @return [AceDetailsListResponse] response from the API call
+    def list_all_access_controls_for_role(role_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/security/roles/{role_id}/aces',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(role_id, key: 'role_id')
+                                    .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(AceDetailsListResponse.method(:from_hash))
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Create Access Control Entry
+    # @param [UUID | String] role_id Required parameter: Role Id
+    # @param [AceCreation] ace_creation_request Optional parameter: Example:
+    # @return [AceCreationResponse] response from the API call
+    def create_access_control_entry(role_id,
+                                    ace_creation_request: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/security/roles/{role_id}/aces',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(role_id, key: 'role_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
+                   .body_param(new_parameter(ace_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(AceCreationResponse.method(:from_hash))
+                   .local_error('400',
+                                'Bad request',
+                                ApiErrorException)
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException)
+                   .local_error('409',
+                                'Conflict',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Delete Access Control Entry
+    # @param [UUID | String] role_id Required parameter: Role Id
+    # @param [UUID | String] ace_id Required parameter: Ace Id
+    # @return [void] response from the API call
+    def delete_access_control_entry(role_id,
+                                    ace_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/security/roles/{role_id}/aces/{ace_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(role_id, key: 'role_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(ace_id, key: 'ace_id')
+                                    .should_encode(true))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .is_response_void(true)
+                   .local_error('400',
+                                'Bad request',
+                                ApiErrorException)
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Fetch Access Control Entry
+    # @param [UUID | String] role_id Required parameter: Role Id
+    # @param [UUID | String] ace_id Required parameter: Ace Id
+    # @return [AceDetailsResponse] response from the API call
+    def fetch_access_control_entry(role_id,
+                                   ace_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/security/roles/{role_id}/aces/{ace_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(role_id, key: 'role_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(ace_id, key: 'ace_id')
+                                    .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(AceDetailsResponse.method(:from_hash))
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException))
+        .execute
+    end
+  end
+end

data/lib/form3_public_api/controllers/audit_controller.rb

@@ -0,0 +1,70 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # AuditController
+  class AuditController < BaseController
+    # List audit entries for this record type
+    # @param [String] record_type Required parameter: Record Type
+    # @param [Integer] page_number Optional parameter: Which page to select
+    # @param [Integer] page_size Optional parameter: Number of items to select
+    # @param [String] page_after Optional parameter: Cursor for next page (this
+    # is a base64-encoded UUID continuation token returned from the application
+    # and should not be manually generated)
+    # @param [Array[UUID | String]] filter_organisation_id Optional parameter:
+    # Filter by organisation id
+    # @param [DateTime] filter_action_time_from Optional parameter: Example:
+    # @param [DateTime] filter_action_time_to Optional parameter: Example:
+    # @return [AuditEntryListResponse] response from the API call
+    def list_audit_entries_for_this_record_type(record_type,
+                                                page_number: nil,
+                                                page_size: nil,
+                                                page_after: nil,
+                                                filter_organisation_id: nil,
+                                                filter_action_time_from: nil,
+                                                filter_action_time_to: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/audit/entries/{record_type}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(record_type, key: 'record_type')
+                                    .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(page_after, key: 'page[after]'))
+                   .query_param(new_parameter(filter_organisation_id, key: 'filter[organisation_id]'))
+                   .query_param(new_parameter(filter_action_time_from, key: 'filter[action_time_from]'))
+                   .query_param(new_parameter(filter_action_time_to, key: 'filter[action_time_to]'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(AuditEntryListResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Fetch audit entry list for this record type/id
+    # @param [String] record_type Required parameter: Record Type
+    # @param [UUID | String] id Required parameter: Record Id
+    # @return [AuditEntryListResponse] response from the API call
+    def fetch_audit_entry_list_for_this_record_type_id(record_type,
+                                                       id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/audit/entries/{record_type}/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(record_type, key: 'record_type')
+                                    .should_encode(true))
+                   .template_param(new_parameter(id, key: 'id')
+                                    .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(AuditEntryListResponse.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/form3_public_api/controllers/base_controller.rb

@@ -0,0 +1,66 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # BaseController.
+  class BaseController
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'APIMATIC 3.0'
+    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 builder for the Api Call instance.
+    # @return [ApiCall] The instance of ApiCall.
+    def new_api_call_builder
+      @api_call.new_builder
+    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/form3_public_api/controllers/branch_identification_controller.rb

@@ -0,0 +1,156 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # BranchIdentificationController
+  class BranchIdentificationController < BaseController
+    # List Branch Identifications by Branch
+    # @param [UUID | String] branch_id Required parameter: Branch 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 branch identifications with specified
+    # secondary_identification
+    # @return [BranchIdentificationListResponse] response from the API call
+    def list_branch_identifications_by_branch(branch_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/branches/{branch_id}/identifications',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(branch_id, key: 'branch_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(BranchIdentificationListResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Create an identification for an existing Branch
+    # @param [UUID | String] branch_id Required parameter: Branch Id to which
+    # this identification relates to
+    # @param [BranchIdentificationRequest]
+    # branch_identification_creation_request Optional parameter: Example:
+    # @return [BranchIdentificationResponse] response from the API call
+    def create_an_identification_for_an_existing_branch(branch_id,
+                                                        branch_identification_creation_request: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/organisation/branches/{branch_id}/identifications',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(branch_id, key: 'branch_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
+                   .body_param(new_parameter(branch_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(BranchIdentificationResponse.method(:from_hash))
+                   .local_error('409',
+                                'Branch Identification creation error, constraint violation of'\
+                                 ' secondary identification',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Delete branch identification
+    # @param [UUID | String] branch_id Required parameter: Branch Id
+    # @param [UUID | String] identification_id Required parameter: Branch
+    # Identification Id
+    # @param [Integer] version Required parameter: Version
+    # @return [void] response from the API call
+    def delete_branch_identification(branch_id,
+                                     identification_id,
+                                     version)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/organisation/branches/{branch_id}/identifications/{identification_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(branch_id, key: 'branch_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',
+                                'Branch Identification not found',
+                                APIException))
+        .execute
+    end
+
+    # Get a branch identification by id
+    # @param [UUID | String] branch_id Required parameter: Branch Id
+    # @param [UUID | String] identification_id Required parameter: Branch
+    # Identification Id
+    # @return [BranchIdentificationResponse] response from the API call
+    def get_a_branch_identification_by_id(branch_id,
+                                          identification_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/organisation/branches/{branch_id}/identifications/{identification_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(branch_id, key: 'branch_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(BranchIdentificationResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Amend Branch Identification
+    # @param [UUID | String] branch_id Required parameter: Branch Id
+    # @param [UUID | String] identification_id Required parameter: Branch
+    # Identification Id; Must match id in the payload
+    # @param [BranchIdentificationRequest] branch_identification_amend_request
+    # Optional parameter: Example:
+    # @return [BranchIdentificationResponse] response from the API call
+    def amend_branch_identification(branch_id,
+                                    identification_id,
+                                    branch_identification_amend_request: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/organisation/branches/{branch_id}/identifications/{identification_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(branch_id, key: 'branch_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(branch_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(BranchIdentificationResponse.method(:from_hash))
+                   .local_error('409',
+                                'Branch Identification update error, constraint violation of'\
+                                 ' secondary identification',
+                                ApiErrorException))
+        .execute
+    end
+  end
+end