packageruby 1.1.1

data/lib/form3_public_api/controllers/subscriptions_controller.rb

@@ -0,0 +1,150 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # SubscriptionsController
+  class SubscriptionsController < BaseController
+    # List all subscriptions
+    # @param [String] page_number Optional parameter: Which page to select
+    # @param [Integer] page_size Optional parameter: Number of items to select
+    # @param [Array[String]] filter_event_type Optional parameter: Filter by
+    # event type
+    # @param [Array[String]] filter_record_type Optional parameter: Filter by
+    # record type
+    # @param [Array[UUID | String]] filter_organisation_id Optional parameter:
+    # Filter by organisation id
+    # @param [TrueClass | FalseClass] filter_deactivated Optional parameter:
+    # Filter by deactivated
+    # @param [String] filter_callback_transport Optional parameter: Filter by
+    # callback_transport
+    # @param [String] filter_callback_uri_search_term Optional parameter: Filter
+    # on callback_uri containing a search term
+    # @param [TrueClass | FalseClass] filter_notification_filter Optional
+    # parameter: Filter by existence of notification filters
+    # @return [SubscriptionDetailsListResponse] response from the API call
+    def list_subscriptions(page_number: nil,
+                           page_size: nil,
+                           filter_event_type: nil,
+                           filter_record_type: nil,
+                           filter_organisation_id: nil,
+                           filter_deactivated: nil,
+                           filter_callback_transport: nil,
+                           filter_callback_uri_search_term: nil,
+                           filter_notification_filter: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/notification/subscriptions',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(page_number, key: 'page[number]'))
+                   .query_param(new_parameter(page_size, key: 'page[size]'))
+                   .query_param(new_parameter(filter_event_type, key: 'filter[event_type]'))
+                   .query_param(new_parameter(filter_record_type, key: 'filter[record_type]'))
+                   .query_param(new_parameter(filter_organisation_id, key: 'filter[organisation_id]'))
+                   .query_param(new_parameter(filter_deactivated, key: 'filter[deactivated]'))
+                   .query_param(new_parameter(filter_callback_transport, key: 'filter[callback_transport]'))
+                   .query_param(new_parameter(filter_callback_uri_search_term, key: 'filter[callback_uri_search_term]'))
+                   .query_param(new_parameter(filter_notification_filter, key: 'filter[notification_filter]'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(SubscriptionDetailsListResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Create subscription
+    # @param [SubscriptionCreation] subscription_creation_request Required
+    # parameter: Example:
+    # @return [SubscriptionCreationResponse] response from the API call
+    def create_subscription(subscription_creation_request)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/notification/subscriptions',
+                                     Server::DEFAULT)
+                   .body_param(new_parameter(subscription_creation_request))
+                   .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
+                   .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(SubscriptionCreationResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Deletes a subscription
+    # @param [UUID | String] id Required parameter: Subscription Id
+    # @param [Integer] version Required parameter: Version
+    # @return [void] response from the API call
+    def delete_subscription(id,
+                            version)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/notification/subscriptions/{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 subscription
+    # @param [UUID | String] id Required parameter: Subscription Id
+    # @return [SubscriptionDetailsResponse] response from the API call
+    def fetch_subscription(id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/notification/subscriptions/{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(SubscriptionDetailsResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Update subscription details
+    # @param [UUID | String] id Required parameter: Subscription Id
+    # @param [SubscriptionAmendment] subscription_update_request Optional
+    # parameter: Example:
+    # @return [SubscriptionDetailsResponse] response from the API call
+    def patch_subscription(id,
+                           subscription_update_request: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/notification/subscriptions/{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(subscription_update_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(SubscriptionDetailsResponse.method(:from_hash))
+                   .local_error('400',
+                                'Bad Request',
+                                ApiErrorException)
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException)
+                   .local_error('409',
+                                'Conflict',
+                                ApiErrorException)
+                   .local_error('500',
+                                'Internal Error',
+                                ApiErrorException))
+        .execute
+    end
+  end
+end

data/lib/form3_public_api/controllers/transaction_file_api_controller.rb

@@ -0,0 +1,374 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # TransactionFileAPIController
+  class TransactionFileAPIController < BaseController
+    # List transaction files
+    # @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:
+    # Find all File resources with a given organisation ID
+    # @param [String] filter_payment_scheme Optional parameter: Find File
+    # resources by a certain scheme
+    # @param [String] filter_file_format Optional parameter: Find File resources
+    # by the format of the file
+    # @param [Date] filter_created_on_from Optional parameter: Find all File
+    # resources created from this date, in format YYYY-MM-DD
+    # @param [Date] filter_created_on_to Optional parameter: Find all File
+    # resources created up to this date, in format YYYY-MM-DD
+    # @param [String] filter_submission_status Optional parameter: Find all File
+    # resources with a certain submission status
+    # @param [DateTime] filter_submission_submission_date_from Optional
+    # parameter: Find all File resources submitted from and including this
+    # date/time
+    # @param [DateTime] filter_submission_submission_date_to Optional parameter:
+    # Find all File resources submitted up to and included this date/time
+    # @param [String] filter_submission_scheme_references_file_identifier
+    # Optional parameter: Find File resources the id of the submission to to the
+    # scheme
+    # @param [String] filter_submission_scheme_references_file_number Optional
+    # parameter: Find File resources by the id of the file sent to the scheme
+    # @param [String] filter_submission_scheme_references_clearing_id Optional
+    # parameter: Find File resources by the Service User Number (SUN) of the
+    # payment originator
+    # @param [String] filter_admission_status Optional parameter: Find all File
+    # resources with a certain admission status
+    # @param [DateTime] filter_admission_admission_date_from Optional parameter:
+    # Find all File resources admitted from and including this date/time
+    # @param [DateTime] filter_admission_admission_date_to Optional parameter:
+    # Find all File resources admitted up to and included this date/time
+    # @return [ListTransactionFilesResponse] response from the API call
+    def list_transaction_files(page_number: nil,
+                               page_size: 100,
+                               filter_organisation_id: nil,
+                               filter_payment_scheme: nil,
+                               filter_file_format: nil,
+                               filter_created_on_from: nil,
+                               filter_created_on_to: nil,
+                               filter_submission_status: nil,
+                               filter_submission_submission_date_from: nil,
+                               filter_submission_submission_date_to: nil,
+                               filter_submission_scheme_references_file_identifier: nil,
+                               filter_submission_scheme_references_file_number: nil,
+                               filter_submission_scheme_references_clearing_id: nil,
+                               filter_admission_status: nil,
+                               filter_admission_admission_date_from: nil,
+                               filter_admission_admission_date_to: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/files/transactions',
+                                     Server::DEFAULT)
+                   .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_payment_scheme, key: 'filter[payment_scheme]'))
+                   .query_param(new_parameter(filter_file_format, key: 'filter[file_format]'))
+                   .query_param(new_parameter(filter_created_on_from, key: 'filter[created_on_from]'))
+                   .query_param(new_parameter(filter_created_on_to, key: 'filter[created_on_to]'))
+                   .query_param(new_parameter(filter_submission_status, key: 'filter[submission.status]'))
+                   .query_param(new_parameter(filter_submission_submission_date_from, key: 'filter[submission.submission_date_from]'))
+                   .query_param(new_parameter(filter_submission_submission_date_to, key: 'filter[submission.submission_date_to]'))
+                   .query_param(new_parameter(filter_submission_scheme_references_file_identifier, key: 'filter[submission.scheme_references.file_identifier]'))
+                   .query_param(new_parameter(filter_submission_scheme_references_file_number, key: 'filter[submission.scheme_references.file_number]'))
+                   .query_param(new_parameter(filter_submission_scheme_references_clearing_id, key: 'filter[submission.scheme_references.clearing_id]'))
+                   .query_param(new_parameter(filter_admission_status, key: 'filter[admission.status]'))
+                   .query_param(new_parameter(filter_admission_admission_date_from, key: 'filter[admission.admission_date_from]'))
+                   .query_param(new_parameter(filter_admission_admission_date_to, key: 'filter[admission.admission_date_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(ListTransactionFilesResponse.method(:from_hash))
+                   .local_error('400',
+                                'Reports bad request',
+                                ApiErrorException)
+                   .local_error('401',
+                                'Unauthorized',
+                                ApiErrorException)
+                   .local_error('403',
+                                'Forbidden',
+                                ApiErrorException)
+                   .local_error('500',
+                                'Internal Server Error',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Creates a Transaction File
+    # @param [TransactionFileCreation] transaction_file_creation_request
+    # Optional parameter: Example:
+    # @return [TransactionFileResponse] response from the API call
+    def create_transaction_file(transaction_file_creation_request: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/files/transactions',
+                                     Server::DEFAULT)
+                   .body_param(new_parameter(transaction_file_creation_request))
+                   .header_param(new_parameter('application/json; charset=utf-8', key: 'content-type'))
+                   .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(TransactionFileResponse.method(:from_hash))
+                   .local_error('400',
+                                'Bad Request',
+                                ApiErrorException)
+                   .local_error('401',
+                                'Unauthorized',
+                                ApiErrorException)
+                   .local_error('403',
+                                'Forbidden',
+                                ApiErrorException)
+                   .local_error('409',
+                                'Conflict',
+                                ApiErrorException)
+                   .local_error('500',
+                                'Internal Server Error',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Fetch transaction file
+    # @param [UUID | String] transaction_file_id Required parameter: Transaction
+    # File Id
+    # @param [String] accept Optional parameter: Acceptable Formats, possible
+    # values are "application/vnd.api+json", "application/x-ndjson" and
+    # "application/x.form3.standard18"
+    # @return [TransactionFileResponse] response from the API call
+    def get_transaction_file(transaction_file_id,
+                             accept: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/files/transactions/{transaction_file_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transaction_file_id, key: 'transaction_file_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter(accept, key: 'Accept'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(TransactionFileResponse.method(:from_hash))
+                   .local_error('401',
+                                'Unauthorized',
+                                ApiErrorException)
+                   .local_error('403',
+                                'Forbidden',
+                                ApiErrorException)
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException)
+                   .local_error('500',
+                                'Internal Server Error',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Put Transaction file chunk
+    # @param [UUID | String] transaction_file_id Required parameter: Transaction
+    # File Id
+    # @param [String] x_form3_upload_part Required parameter: Which part of the
+    # file we are uploading
+    # @param [File | UploadIO] payload Required parameter: Example:
+    # @return [TransactionFileResponse] response from the API call
+    def upload_transaction_file(transaction_file_id,
+                                x_form3_upload_part,
+                                payload)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/files/transactions/{transaction_file_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transaction_file_id, key: 'transaction_file_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_form3_upload_part, key: 'X-Form3-Upload-Part'))
+                   .multipart_param(new_parameter(payload, key: 'payload')
+                                     .default_content_type('application/octet-stream'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(TransactionFileResponse.method(:from_hash))
+                   .local_error('400',
+                                'Bad Request',
+                                ApiErrorException)
+                   .local_error('401',
+                                'Unauthorized',
+                                ApiErrorException)
+                   .local_error('403',
+                                'Forbidden',
+                                ApiErrorException)
+                   .local_error('404',
+                                'Transaction File Not Found',
+                                ApiErrorException)
+                   .local_error('409',
+                                'Transaction File Conflict',
+                                ApiErrorException)
+                   .local_error('500',
+                                'Internal Server Error',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Creates a Transaction File Admission
+    # @param [UUID | String] transaction_file_id Required parameter: Transaction
+    # File Id
+    # @param [TransactionFileAdmissionCreation]
+    # transaction_file_admission_creation_request Optional parameter: Example:
+    # @return [TransactionFileAdmissionResponse] response from the API call
+    def create_transaction_file_admission(transaction_file_id,
+                                          transaction_file_admission_creation_request: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/files/transactions/{transaction_file_id}/admissions',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transaction_file_id, key: 'transaction_file_id')
+                                    .should_encode(true))
+                   .body_param(new_parameter(transaction_file_admission_creation_request))
+                   .header_param(new_parameter('application/json; charset=utf-8', key: 'content-type'))
+                   .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(TransactionFileAdmissionResponse.method(:from_hash))
+                   .local_error('400',
+                                'Bad Request',
+                                ApiErrorException)
+                   .local_error('401',
+                                'Unauthorized',
+                                ApiErrorException)
+                   .local_error('403',
+                                'Forbidden',
+                                ApiErrorException)
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException)
+                   .local_error('409',
+                                'Transaction File Admission Conflict',
+                                ApiErrorException)
+                   .local_error('500',
+                                'Internal Server Error',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Fetch transaction file admission
+    # @param [UUID | String] transaction_file_id Required parameter: Transaction
+    # File Id
+    # @param [UUID | String] transaction_file_admission_id Required parameter:
+    # Transaction File Admission Id
+    # @return [TransactionFileAdmissionResponse] response from the API call
+    def get_transaction_file_admission(transaction_file_id,
+                                       transaction_file_admission_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/files/transactions/{transaction_file_id}/admissions/{transaction_file_admission_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transaction_file_id, key: 'transaction_file_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(transaction_file_admission_id, key: 'transaction_file_admission_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(TransactionFileAdmissionResponse.method(:from_hash))
+                   .local_error('401',
+                                'Unauthorized',
+                                ApiErrorException)
+                   .local_error('403',
+                                'Forbidden',
+                                ApiErrorException)
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException)
+                   .local_error('500',
+                                'Internal Server Error',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Creates a Transaction File Submission
+    # @param [UUID | String] transaction_file_id Required parameter: Transaction
+    # File Id
+    # @param [TransactionFileSubmissionCreation]
+    # transaction_file_submission_creation_request Optional parameter:
+    # Example:
+    # @return [TransactionFileSubmissionResponse] response from the API call
+    def create_transaction_file_submission(transaction_file_id,
+                                           transaction_file_submission_creation_request: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/files/transactions/{transaction_file_id}/submissions',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transaction_file_id, key: 'transaction_file_id')
+                                    .should_encode(true))
+                   .body_param(new_parameter(transaction_file_submission_creation_request))
+                   .header_param(new_parameter('application/json; charset=utf-8', key: 'content-type'))
+                   .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(TransactionFileSubmissionResponse.method(:from_hash))
+                   .local_error('400',
+                                'Bad Request',
+                                ApiErrorException)
+                   .local_error('401',
+                                'Unauthorized',
+                                ApiErrorException)
+                   .local_error('403',
+                                'Forbidden',
+                                ApiErrorException)
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException)
+                   .local_error('409',
+                                'Transaction File Submission Conflict',
+                                ApiErrorException)
+                   .local_error('500',
+                                'Internal Server Error',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Fetch transaction file submission
+    # @param [UUID | String] transaction_file_id Required parameter: Transaction
+    # File Id
+    # @param [UUID | String] transaction_file_submission_id Required parameter:
+    # Transaction File Submission Id
+    # @return [TransactionFileSubmissionResponse] response from the API call
+    def get_transaction_file_submission(transaction_file_id,
+                                        transaction_file_submission_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/files/transactions/{transaction_file_id}/submissions/{transaction_file_submission_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transaction_file_id, key: 'transaction_file_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(transaction_file_submission_id, key: 'transaction_file_submission_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(TransactionFileSubmissionResponse.method(:from_hash))
+                   .local_error('401',
+                                'Unauthorized',
+                                ApiErrorException)
+                   .local_error('403',
+                                'Forbidden',
+                                ApiErrorException)
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException)
+                   .local_error('500',
+                                'Internal Server Error',
+                                ApiErrorException))
+        .execute
+    end
+  end
+end