fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/controllers/payments_controller.rb

@@ -0,0 +1,336 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # PaymentsController
+  class PaymentsController < BaseController
+    # Search for payments
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction, as defined by [FAPI 2.0 Implementation
+    # Advice, 2.2.1
+    # x-fapi-interaction-id](https://openid.bitbucket.io/fapi/fapi-2_0-implement
+    # ation_advice.html#name-x-fapi-interaction-id)
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [String] fdx_api_data_provider_id Optional parameter: ID for the
+    # financial institution responding to the request
+    # @param [Array[String]] fdx_api_data_recipient_id Optional parameter: ID(s)
+    # for the data recipient(s) on whose behalf the request is being made
+    # @param [String] updated_since Optional parameter: Return items that have
+    # been created or updated since the nextUpdateId
+    # @param [String] offset Optional parameter: Opaque cursor used by the
+    # provider to send the next set of records. Deprecated in favor of
+    # PageKeyQuery, will be removed with a future major release
+    # @param [String] page_key Optional parameter: Opaque cursor used by the
+    # provider to send the next set of records. Pagination can be implemented
+    # per provider's preference
+    # @param [Integer] limit Optional parameter: Number of elements that the
+    # consumer wishes to receive. Providers should implement reasonable
+    # default/maximum/minimum values based on their internal architecture and
+    # update their documentation accordingly
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_for_payments(x_fapi_interaction_id,
+                            fdx_api_actor_type: nil,
+                            fdx_api_data_provider_id: nil,
+                            fdx_api_data_recipient_id: nil,
+                            updated_since: nil,
+                            offset: nil,
+                            page_key: nil,
+                            limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/payments',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .header_param(new_parameter(fdx_api_data_provider_id, key: 'FDX-API-Data-Provider-Id'))
+                   .header_param(new_parameter(fdx_api_data_recipient_id, key: 'FDX-API-Data-Recipient-Id'))
+                   .query_param(new_parameter(updated_since, key: 'updatedSince'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(page_key, key: 'pageKey'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PaymentsEntity.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 'Data not found for request parameters',
+                                 ErrorException)
+                    .local_error('500',
+                                 'Catch-all exception where request was not processed due to an'\
+                                  ' internal outage/issue. Consider other more specific errors'\
+                                  ' before using this error',
+                                 ErrorException)
+                    .local_error('501',
+                                 'Error when FdxVersion in Header is not one of those'\
+                                  ' implemented at backend',
+                                 ErrorException)
+                    .local_error('503',
+                                 'System is down for maintenance',
+                                 ErrorException))
+        .execute
+    end
+
+    # Schedule a payment
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction, as defined by [FAPI 2.0 Implementation
+    # Advice, 2.2.1
+    # x-fapi-interaction-id](https://openid.bitbucket.io/fapi/fapi-2_0-implement
+    # ation_advice.html#name-x-fapi-interaction-id)
+    # @param [String] idempotency_key Required parameter: Used to de-duplicate
+    # requests
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [String] fdx_api_data_provider_id Optional parameter: ID for the
+    # financial institution responding to the request
+    # @param [Array[String]] fdx_api_data_recipient_id Optional parameter: ID(s)
+    # for the data recipient(s) on whose behalf the request is being made
+    # @param [PaymentForUpdateEntity1] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def schedule_payment(x_fapi_interaction_id,
+                         idempotency_key,
+                         fdx_api_actor_type: nil,
+                         fdx_api_data_provider_id: nil,
+                         fdx_api_data_recipient_id: nil,
+                         body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/payments',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .header_param(new_parameter(idempotency_key, key: 'idempotency-key')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .header_param(new_parameter(fdx_api_data_provider_id, key: 'FDX-API-Data-Provider-Id'))
+                   .header_param(new_parameter(fdx_api_data_recipient_id, key: 'FDX-API-Data-Recipient-Id'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PaymentEntity.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Request is invalid',
+                                 ErrorException)
+                    .local_error('404',
+                                 'Requested payment is invalid',
+                                 ErrorException)
+                    .local_error('409',
+                                 'Duplicate Request',
+                                 PaymentEntityErrorException)
+                    .local_error('422',
+                                 'Account type not supported',
+                                 ErrorException)
+                    .local_error('500',
+                                 'Catch-all exception where request was not processed due to an'\
+                                  ' internal outage/issue. Consider other more specific errors'\
+                                  ' before using this error',
+                                 ErrorException)
+                    .local_error('501',
+                                 'Error when FdxVersion in Header is not one of those'\
+                                  ' implemented at backend',
+                                 ErrorException)
+                    .local_error('503',
+                                 'System is down for maintenance',
+                                 ErrorException))
+        .execute
+    end
+
+    # Get a payment
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction, as defined by [FAPI 2.0 Implementation
+    # Advice, 2.2.1
+    # x-fapi-interaction-id](https://openid.bitbucket.io/fapi/fapi-2_0-implement
+    # ation_advice.html#name-x-fapi-interaction-id)
+    # @param [String] payment_id Required parameter: Payment Identifier.
+    # Uniquely identifies a payment
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [String] fdx_api_data_provider_id Optional parameter: ID for the
+    # financial institution responding to the request
+    # @param [Array[String]] fdx_api_data_recipient_id Optional parameter: ID(s)
+    # for the data recipient(s) on whose behalf the request is being made
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_payment(x_fapi_interaction_id,
+                    payment_id,
+                    fdx_api_actor_type: nil,
+                    fdx_api_data_provider_id: nil,
+                    fdx_api_data_recipient_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/payments/{paymentId}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(payment_id, key: 'paymentId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .header_param(new_parameter(fdx_api_data_provider_id, key: 'FDX-API-Data-Provider-Id'))
+                   .header_param(new_parameter(fdx_api_data_recipient_id, key: 'FDX-API-Data-Recipient-Id'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PaymentEntity.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 'A payment with provided ID was not found',
+                                 ErrorException)
+                    .local_error('500',
+                                 'Catch-all exception where request was not processed due to an'\
+                                  ' internal outage/issue. Consider other more specific errors'\
+                                  ' before using this error',
+                                 ErrorException)
+                    .local_error('501',
+                                 'Error when FdxVersion in Header is not one of those'\
+                                  ' implemented at backend',
+                                 ErrorException)
+                    .local_error('503',
+                                 'System is down for maintenance',
+                                 ErrorException))
+        .execute
+    end
+
+    # Update a payment
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction, as defined by [FAPI 2.0 Implementation
+    # Advice, 2.2.1
+    # x-fapi-interaction-id](https://openid.bitbucket.io/fapi/fapi-2_0-implement
+    # ation_advice.html#name-x-fapi-interaction-id)
+    # @param [String] payment_id Required parameter: Payment Identifier.
+    # Uniquely identifies a payment
+    # @param [String] idempotency_key Required parameter: Used to de-duplicate
+    # requests
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [String] fdx_api_data_provider_id Optional parameter: ID for the
+    # financial institution responding to the request
+    # @param [Array[String]] fdx_api_data_recipient_id Optional parameter: ID(s)
+    # for the data recipient(s) on whose behalf the request is being made
+    # @param [PaymentForUpdateEntity2] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_payment(x_fapi_interaction_id,
+                       payment_id,
+                       idempotency_key,
+                       fdx_api_actor_type: nil,
+                       fdx_api_data_provider_id: nil,
+                       fdx_api_data_recipient_id: nil,
+                       body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/payments/{paymentId}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(payment_id, key: 'paymentId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(idempotency_key, key: 'idempotency-key')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .header_param(new_parameter(fdx_api_data_provider_id, key: 'FDX-API-Data-Provider-Id'))
+                   .header_param(new_parameter(fdx_api_data_recipient_id, key: 'FDX-API-Data-Recipient-Id'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PaymentEntity.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Request is invalid',
+                                 ErrorException)
+                    .local_error('404',
+                                 'Requested payment change is invalid',
+                                 ErrorException)
+                    .local_error('409',
+                                 'Duplicate Request',
+                                 PaymentEntityErrorException)
+                    .local_error('422',
+                                 'Account type not supported',
+                                 ErrorException)
+                    .local_error('500',
+                                 'Catch-all exception where request was not processed due to an'\
+                                  ' internal outage/issue. Consider other more specific errors'\
+                                  ' before using this error',
+                                 ErrorException)
+                    .local_error('501',
+                                 'Error when FdxVersion in Header is not one of those'\
+                                  ' implemented at backend',
+                                 ErrorException)
+                    .local_error('503',
+                                 'System is down for maintenance',
+                                 ErrorException))
+        .execute
+    end
+
+    # Cancel a payment
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction, as defined by [FAPI 2.0 Implementation
+    # Advice, 2.2.1
+    # x-fapi-interaction-id](https://openid.bitbucket.io/fapi/fapi-2_0-implement
+    # ation_advice.html#name-x-fapi-interaction-id)
+    # @param [String] payment_id Required parameter: Payment Identifier.
+    # Uniquely identifies a payment
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [String] fdx_api_data_provider_id Optional parameter: ID for the
+    # financial institution responding to the request
+    # @param [Array[String]] fdx_api_data_recipient_id Optional parameter: ID(s)
+    # for the data recipient(s) on whose behalf the request is being made
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def cancel_payment(x_fapi_interaction_id,
+                       payment_id,
+                       fdx_api_actor_type: nil,
+                       fdx_api_data_provider_id: nil,
+                       fdx_api_data_recipient_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/payments/{paymentId}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(payment_id, key: 'paymentId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .header_param(new_parameter(fdx_api_data_provider_id, key: 'FDX-API-Data-Provider-Id'))
+                   .header_param(new_parameter(fdx_api_data_recipient_id, key: 'FDX-API-Data-Recipient-Id'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PaymentEntity.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Payment cannot be modified or cancelled at this time. Likely'\
+                                  ' due to the state that it is in',
+                                 ErrorException)
+                    .local_error('404',
+                                 'A payment with provided ID was not found',
+                                 ErrorException)
+                    .local_error('500',
+                                 'Catch-all exception where request was not processed due to an'\
+                                  ' internal outage/issue. Consider other more specific errors'\
+                                  ' before using this error',
+                                 ErrorException)
+                    .local_error('501',
+                                 'Error when FdxVersion in Header is not one of those'\
+                                  ' implemented at backend',
+                                 ErrorException)
+                    .local_error('503',
+                                 'System is down for maintenance',
+                                 ErrorException))
+        .execute
+    end
+  end
+end

data/lib/fdx_v660_api/controllers/payroll_information_controller.rb

@@ -0,0 +1,145 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # PayrollInformationController
+  class PayrollInformationController < BaseController
+    # Search for the employee's latest payroll report
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction, as defined by [FAPI 2.0 Implementation
+    # Advice, 2.2.1
+    # x-fapi-interaction-id](https://openid.bitbucket.io/fapi/fapi-2_0-implement
+    # ation_advice.html#name-x-fapi-interaction-id)
+    # @param [PayrollReportType] report_type Required parameter: Whether to
+    # retrieve Verification of Employment ("VOE") or Verification of Income and
+    # Employment ("VOIE") reports
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [String] fdx_api_client_public_key Optional parameter: Public key
+    # for data provider to encrypt sensitive response data
+    # @param [String] fdx_api_data_provider_id Optional parameter: ID for the
+    # financial institution responding to the request
+    # @param [Array[String]] fdx_api_data_recipient_id Optional parameter: ID(s)
+    # for the data recipient(s) on whose behalf the request is being made
+    # @param [ResultType] result_type Optional parameter: Flag to indicate if
+    # you want a lightweight array of metadata (AccountDescriptor or Tax or
+    # Operations) or full item details (Account or a Tax subclass or
+    # Availability details). If set to 'lightweight', should only return the
+    # fields associated with the metadata entity. This field is not required,
+    # defaults to lightweight
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_payroll_reports(x_fapi_interaction_id,
+                            report_type,
+                            fdx_api_actor_type: nil,
+                            fdx_api_client_public_key: nil,
+                            fdx_api_data_provider_id: nil,
+                            fdx_api_data_recipient_id: nil,
+                            result_type: ResultType::LIGHTWEIGHT)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/payroll/reports',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .query_param(new_parameter(report_type, key: 'reportType')
+                                 .is_required(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .header_param(new_parameter(fdx_api_client_public_key, key: 'FDX-API-Client-Public-Key'))
+                   .header_param(new_parameter(fdx_api_data_provider_id, key: 'FDX-API-Data-Provider-Id'))
+                   .header_param(new_parameter(fdx_api_data_recipient_id, key: 'FDX-API-Data-Recipient-Id'))
+                   .query_param(new_parameter(result_type, key: 'resultType'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PayrollReportListEntity1.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Input sent by client does not satisfy API specification',
+                                 ErrorException)
+                    .local_error('401',
+                                 'Request lacks valid authentication credentials for the target'\
+                                  ' resource',
+                                 ErrorException)
+                    .local_error('404',
+                                 'Data not found for request parameters',
+                                 ErrorException)
+                    .local_error('500',
+                                 'Catch-all exception where request was not processed due to an'\
+                                  ' internal outage/issue. Consider other more specific errors'\
+                                  ' before using this error',
+                                 ErrorException)
+                    .local_error('501',
+                                 'Error when FdxVersion in Header is not one of those'\
+                                  ' implemented at backend',
+                                 ErrorException)
+                    .local_error('503',
+                                 'System is down for maintenance',
+                                 ErrorException))
+        .execute
+    end
+
+    # Retrieve the employee's specified payroll report
+    # @param [String] report_id Required parameter: Specific reportId to
+    # retrieve
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction, as defined by [FAPI 2.0 Implementation
+    # Advice, 2.2.1
+    # x-fapi-interaction-id](https://openid.bitbucket.io/fapi/fapi-2_0-implement
+    # ation_advice.html#name-x-fapi-interaction-id)
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [String] fdx_api_client_public_key Optional parameter: Public key
+    # for data provider to encrypt sensitive response data
+    # @param [String] fdx_api_data_provider_id Optional parameter: ID for the
+    # financial institution responding to the request
+    # @param [Array[String]] fdx_api_data_recipient_id Optional parameter: ID(s)
+    # for the data recipient(s) on whose behalf the request is being made
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_payroll_report(report_id,
+                           x_fapi_interaction_id,
+                           fdx_api_actor_type: nil,
+                           fdx_api_client_public_key: nil,
+                           fdx_api_data_provider_id: nil,
+                           fdx_api_data_recipient_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/payroll/reports/{reportId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(report_id, key: 'reportId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .header_param(new_parameter(fdx_api_client_public_key, key: 'FDX-API-Client-Public-Key'))
+                   .header_param(new_parameter(fdx_api_data_provider_id, key: 'FDX-API-Data-Provider-Id'))
+                   .header_param(new_parameter(fdx_api_data_recipient_id, key: 'FDX-API-Data-Recipient-Id'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PayrollReportEntity1.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Required input data not sent',
+                                 ErrorException)
+                    .local_error('404',
+                                 'Payroll Report with provided ID was not found',
+                                 ErrorException)
+                    .local_error('500',
+                                 'Catch-all exception where request was not processed due to an'\
+                                  ' internal outage/issue. Consider other more specific errors'\
+                                  ' before using this error',
+                                 ErrorException)
+                    .local_error('501',
+                                 'Error when FdxVersion in Header is not one of those'\
+                                  ' implemented at backend',
+                                 ErrorException)
+                    .local_error('503',
+                                 'System is down for maintenance',
+                                 ErrorException))
+        .execute
+    end
+  end
+end