fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/controllers/payment_initiation_parties_controller.rb

@@ -0,0 +1,439 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # PaymentInitiationPartiesController
+  class PaymentInitiationPartiesController < BaseController
+    # Create a payment initiation party associated with a customer profile
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction
+    # @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 [PaymentInitiationPartyEntity] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_payment_initiation_party(x_fapi_interaction_id,
+                                        idempotency_key,
+                                        fdx_api_actor_type: nil,
+                                        body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/payment-initiation-parties',
+                                     Server::MONEYMOVEMENT)
+                   .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'))
+                   .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)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PaymentInitiationPartyCreateResponseEntity.method(:from_hash))
+                    .is_api_response(true)
+                    .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 payment initiation parties associated with a customer profile
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [String] offset Optional parameter: Opaque cursor used by the
+    # provider to send the next set of records
+    # @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 list_payment_initiation_parties(x_fapi_interaction_id,
+                                        fdx_api_actor_type: nil,
+                                        offset: nil,
+                                        limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/payment-initiation-parties',
+                                     Server::MONEYMOVEMENT)
+                   .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'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PaymentInitiationPartiesEntity.method(:from_hash))
+                    .is_api_response(true)
+                    .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 payment initiation party details by ID
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction
+    # @param [String] payment_initiation_party_id Required parameter: This is an
+    # unique identifier of a payment initiation party
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_payment_initiation_party(x_fapi_interaction_id,
+                                     payment_initiation_party_id,
+                                     fdx_api_actor_type: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/payment-initiation-parties/{paymentInitiationPartyId}',
+                                     Server::MONEYMOVEMENT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(payment_initiation_party_id, key: 'paymentInitiationPartyId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PaymentInitiationPartyEntity.method(:from_hash))
+                    .is_api_response(true)
+                    .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 the payment initiation party associated with a customer profile
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction
+    # @param [String] payment_initiation_party_id Required parameter: This is an
+    # unique identifier of a payment initiation party
+    # @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 [PaymentInitiationPartyEntity] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_payment_initiation_party(x_fapi_interaction_id,
+                                        payment_initiation_party_id,
+                                        idempotency_key,
+                                        fdx_api_actor_type: nil,
+                                        body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/payment-initiation-parties/{paymentInitiationPartyId}',
+                                     Server::MONEYMOVEMENT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(payment_initiation_party_id, key: 'paymentInitiationPartyId')
+                                    .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'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .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
+
+    # Remove the payment initiation party associated with a customer profile
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction
+    # @param [String] payment_initiation_party_id Required parameter: This is an
+    # unique identifier of a payment initiation party
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_payment_initiation_party(x_fapi_interaction_id,
+                                        payment_initiation_party_id,
+                                        fdx_api_actor_type: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/payment-initiation-parties/{paymentInitiationPartyId}',
+                                     Server::MONEYMOVEMENT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(payment_initiation_party_id, key: 'paymentInitiationPartyId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .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
+
+    # Registration of a payment initiation party to a payment method
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction
+    # @param [String] payment_initiation_party_id Required parameter: This is an
+    # unique identifier of a payment initiation party
+    # @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 [PaymentInitiationPartyToPaymentMethodEntity] body Optional
+    # parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_payment_method(x_fapi_interaction_id,
+                              payment_initiation_party_id,
+                              idempotency_key,
+                              fdx_api_actor_type: nil,
+                              body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/payment-initiation-parties/{paymentInitiationPartyId}/payment-methods',
+                                     Server::MONEYMOVEMENT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(payment_initiation_party_id, key: 'paymentInitiationPartyId')
+                                    .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'))
+                   .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)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PaymentInitiationPartyMethodCreateResponseEntity.method(:from_hash))
+                    .is_api_response(true)
+                    .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 details of a payment method registered with a payment
+    # initiation party
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction
+    # @param [String] payment_initiation_party_id Required parameter: This is an
+    # unique identifier of a payment initiation party
+    # @param [String] payment_method_registration_id Required parameter:
+    # Registration identifier between a payment initiation party and a payment
+    # method
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_payment_method_registration(x_fapi_interaction_id,
+                                        payment_initiation_party_id,
+                                        payment_method_registration_id,
+                                        fdx_api_actor_type: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/payment-initiation-parties/{paymentInitiationPartyId}/payment-methods/{paymentMethodRegistrationId}',
+                                     Server::MONEYMOVEMENT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(payment_initiation_party_id, key: 'paymentInitiationPartyId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(payment_method_registration_id, key: 'paymentMethodRegistrationId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PaymentInitiationPartyToPaymentMethodEntity.method(:from_hash))
+                    .is_api_response(true)
+                    .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
+
+    # Remove the registered payment method from a payment initiation party
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction
+    # @param [String] payment_initiation_party_id Required parameter: This is an
+    # unique identifier of a payment initiation party
+    # @param [String] payment_method_registration_id Required parameter:
+    # Registration identifier between a payment initiation party and a payment
+    # method
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_payment_method_registration(x_fapi_interaction_id,
+                                           payment_initiation_party_id,
+                                           payment_method_registration_id,
+                                           fdx_api_actor_type: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/payment-initiation-parties/{paymentInitiationPartyId}/payment-methods/{paymentMethodRegistrationId}',
+                                     Server::MONEYMOVEMENT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(payment_initiation_party_id, key: 'paymentInitiationPartyId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(payment_method_registration_id, key: 'paymentMethodRegistrationId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .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 the payment method registration associated with payment initiation
+    # party
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction
+    # @param [String] payment_initiation_party_id Required parameter: This is an
+    # unique identifier of a payment initiation party
+    # @param [String] payment_method_registration_id Required parameter:
+    # Registration identifier between a payment initiation party and a payment
+    # method
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [PaymentInitiationPartyToPaymentMethodEntity] body Optional
+    # parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_payment_method_registration(x_fapi_interaction_id,
+                                           payment_initiation_party_id,
+                                           payment_method_registration_id,
+                                           fdx_api_actor_type: nil,
+                                           body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/payment-initiation-parties/{paymentInitiationPartyId}/payment-methods/{paymentMethodRegistrationId}',
+                                     Server::MONEYMOVEMENT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(payment_initiation_party_id, key: 'paymentInitiationPartyId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(payment_method_registration_id, key: 'paymentMethodRegistrationId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .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