fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/controllers/money_movement_controller.rb

@@ -0,0 +1,347 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # MoneyMovementController
+  class MoneyMovementController < BaseController
+    # ...
+    # @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] account_id Required parameter: Account Identifier
+    # @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_account_asset_transfer_networks(x_fapi_interaction_id,
+                                            account_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,
+                                     '/accounts/{accountId}/asset-transfer-networks',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(account_id, key: 'accountId')
+                                    .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_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(AssetTransferNetworkList1.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Get payment networks supported by the account
+    # @param [String] account_id Required parameter: Account Identifier
+    # @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
+    # @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 [Integer] page_key Optional parameter: Pagination for
+    # `/accounts/{accountId}/payment-network` is deprecated in v6.5
+    # @param [Integer] limit Optional parameter: Pagination for
+    # `/accounts/{accountId}/payment-network` is deprecated in v6.5
+    # @param [BankIdType] bank_id_type Optional parameter: Type of Bank ID or
+    # the Routing Number, if an international Bank Identifier Code (`BIC`) is
+    # needed for international payments. If omitted response should default to
+    # the appropriate domestic bank IDs of either `US_ABA_NUMBER` or
+    # `CA_ROUTING_NUMBER` depending upon institution
+    # @param [Array[PaymentNetworkType]] payment_network_types Optional
+    # parameter: Comma separated list of payment network types being requested,
+    # if the account supports them, such as `US_ACH`, `US_CHECK`, `US_RTP`,
+    # `US_RTP_RFP`, etc.
+    # @param [Array[PaymentNetworkIdentifierType]] identifier_types Optional
+    # parameter: Comma separated list of `identifier` types being requested,
+    # such as if a specific type is required for the requested
+    # `paymentNetworkTypes`. One or both of `ACCOUNT_NUMBER`,
+    # `TOKENIZED_ACCOUNT_NUMBER`
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_account_payment_networks(account_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,
+                                     offset: nil,
+                                     page_key: nil,
+                                     limit: nil,
+                                     bank_id_type: nil,
+                                     payment_network_types: nil,
+                                     identifier_types: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/accounts/{accountId}/payment-networks',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(account_id, key: 'accountId')
+                                    .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'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(page_key, key: 'pageKey'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(bank_id_type, key: 'bankIdType'))
+                   .query_param(new_parameter(payment_network_types, key: 'paymentNetworkTypes'))
+                   .query_param(new_parameter(identifier_types, key: 'identifierTypes'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountPaymentNetworks1.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 'Account with id not found',
+                                 ErrorException)
+                    .local_error('422',
+                                 'Unprocessable Entity',
+                                 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 the payment network(s) on this account for the `bankId` and account
+    # `identifier` pair identified by the paymentNetworkId
+    # @param [String] account_id Required parameter: Account Identifier
+    # @param [String] payment_network_id Required parameter: Payment network
+    # identifier for a bankId and account identifier pair, possibly used across
+    # multiple payment network types
+    # @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_account_payment_network(account_id,
+                                    payment_network_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,
+                                     '/accounts/{accountId}/payment-networks/{paymentNetworkId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(account_id, key: 'accountId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(payment_network_id, key: 'paymentNetworkId')
+                                    .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(AccountPaymentNetworks1.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
+
+    # Revoke the payment network pair of `bankId` and account `identifier`
+    # identified by the paymentNetworkId across all its multiple payment network
+    # types. For example, a `TOKENIZED_ACCOUNT_NUMBER` thought to be compromised
+    # will be revoked across both US_ACH and US_RTP (assuming it was issued
+    # across both)
+    # @param [String] account_id Required parameter: Account Identifier
+    # @param [String] payment_network_id Required parameter: Payment network
+    # identifier for a bankId and account identifier pair, possibly used across
+    # multiple payment network types
+    # @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 [RevocationRequestEntity] body Required parameter: Reason and
+    # initiator of payment network identifier revocation request
+    # @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 revoke_payment_network_id(account_id,
+                                  payment_network_id,
+                                  x_fapi_interaction_id,
+                                  body,
+                                  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::PUT,
+                                     '/accounts/{accountId}/payment-networks/{paymentNetworkId}/revocation',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(account_id, key: 'accountId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(payment_network_id, key: 'paymentNetworkId')
+                                    .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('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .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'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .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('403',
+                                 'Forbidden, server understands the request but refuses to'\
+                                  ' authorize it',
+                                 ErrorException)
+                    .local_error('404',
+                                 'Account with id not found',
+                                 ErrorException)
+                    .local_error('409',
+                                 'Conflict with current state of target resource',
+                                 ErrorException))
+        .execute
+    end
+
+    # Retrieve revocation records of a payment network identifier pair of
+    # `bankId` and account `identifier`, possibly used across multiple payment
+    # network types
+    # @param [String] account_id Required parameter: Account Identifier
+    # @param [String] payment_network_id Required parameter: Payment network
+    # identifier for a bankId and account identifier pair, possibly used across
+    # multiple payment network types
+    # @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_payment_network_lifecycle_events(account_id,
+                                             payment_network_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,
+                                     '/accounts/{accountId}/payment-networks/{paymentNetworkId}/revocation',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(account_id, key: 'accountId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(payment_network_id, key: 'paymentNetworkId')
+                                    .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(PaymentNetworkLifecycleEventsEntity.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Request lacks valid authentication credentials for the target'\
+                                  ' resource',
+                                 ErrorException)
+                    .local_error('404',
+                                 'Account with id not found',
+                                 ErrorException))
+        .execute
+    end
+  end
+end

data/lib/fdx_v660_api/controllers/oauth_authorization_controller.rb

@@ -0,0 +1,122 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # OauthAuthorizationController
+  class OauthAuthorizationController < BaseController
+    # Create a new OAuth 2 token.
+    # @param [String] authorization Required parameter: Authorization header in
+    # Basic auth format
+    # @param [String] code Required parameter: Authorization Code
+    # @param [String] redirect_uri Required parameter: Redirect Uri
+    # @param [Hash] _field_parameters Additional optional form parameters are
+    # supported by this endpoint.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def request_token_oauth_fapi1_advanced(authorization,
+                                           code,
+                                           redirect_uri,
+                                           _field_parameters: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/token',
+                                     Server::AUTH_SERVER)
+                   .form_param(new_parameter('authorization_code', key: 'grant_type'))
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .form_param(new_parameter(code, key: 'code')
+                                .is_required(true))
+                   .form_param(new_parameter(redirect_uri, key: 'redirect_uri')
+                                .is_required(true))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .additional_form_params(_field_parameters))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(OauthToken.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'OAuth 2 provider returned an error.',
+                                 OauthProviderException)
+                    .local_error('401',
+                                 'OAuth 2 provider says client authentication failed.',
+                                 OauthProviderException))
+        .execute
+    end
+
+    # Obtain a new access token using a refresh token
+    # @param [String] authorization Required parameter: Authorization header in
+    # Basic auth format
+    # @param [String] refresh_token Required parameter: Refresh token
+    # @param [String] scope Optional parameter: Requested scopes as a
+    # space-delimited list.
+    # @param [Hash] _field_parameters Additional optional form parameters are
+    # supported by this endpoint.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def refresh_token_oauth_fapi1_advanced(authorization,
+                                           refresh_token,
+                                           scope: nil,
+                                           _field_parameters: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/token',
+                                     Server::AUTH_SERVER)
+                   .form_param(new_parameter('refresh_token', key: 'grant_type'))
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .form_param(new_parameter(refresh_token, key: 'refresh_token')
+                                .is_required(true))
+                   .form_param(new_parameter(scope, key: 'scope'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .additional_form_params(_field_parameters))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(OauthToken.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'OAuth 2 provider returned an error.',
+                                 OauthProviderException)
+                    .local_error('401',
+                                 'OAuth 2 provider says client authentication failed.',
+                                 OauthProviderException))
+        .execute
+    end
+
+    # Create a new OAuth 2 token.
+    # @param [String] authorization Required parameter: Authorization header in
+    # Basic auth format
+    # @param [String] scope Optional parameter: Requested scopes as a
+    # space-delimited list.
+    # @param [Hash] _field_parameters Additional optional form parameters are
+    # supported by this endpoint.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def request_token_oauth_fapi1_baseline(authorization,
+                                           scope: nil,
+                                           _field_parameters: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/token',
+                                     Server::AUTH_SERVER)
+                   .form_param(new_parameter('client_credentials', key: 'grant_type'))
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .form_param(new_parameter(scope, key: 'scope'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .additional_form_params(_field_parameters))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(OauthToken.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'OAuth 2 provider returned an error.',
+                                 OauthProviderException)
+                    .local_error('401',
+                                 'OAuth 2 provider says client authentication failed.',
+                                 OauthProviderException))
+        .execute
+    end
+  end
+end

data/lib/fdx_v660_api/controllers/pay_stub_information_controller.rb

@@ -0,0 +1,182 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # PayStubInformationController
+  class PayStubInformationController < BaseController
+    # Search for and retrieve the employee's latest paystubs
+    # @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
+    # @param [Date] start_date Optional parameter: Start date for use in
+    # retrieval of elements (ISO 8601 format). Provider to define the date
+    # ranges and behaviors they will support. Example of defined behavior:   -
+    # Recipients need to either specify both start date and end date or neither.
+    #     If both start date and end date are not specified; default provided.
+    #   Default range: 7 Days of past data. (Today's date - 6 days both dates
+    # are inclusive)   - Recipient can specify the same start date and end date.
+    #     The returned data will reflect transactions from that date   - If
+    # start date and end date both are specified and if start date is later than
+    # end date,     return 'invalid date range' error code: 703, HTTPS 400 per
+    # the FDX spec   - If start Date and end date both are specified and if
+    # start date is older than what the Data Provider supports,     then the
+    # Data Provider should return 'invalid date range' error code: 703, HTTPS
+    # 400 per the FDX spec.     Example: If today is 5/14/2024 and the DP
+    # supports 24 months, the start date should be 5/14/2022 and newer;     it
+    # should not be 5/13/2022 or older   - If start date is specified but end
+    # date is not specified or vice versa;     Data Provider should return
+    # 'invalid date range' error code: 703, HTTPS 400 per the FDX spec
+    # @param [Date] end_date Optional parameter: End date for use in retrieval
+    # of elements (ISO 8601 format). Provider to define the date ranges and
+    # behaviors they will support. Example of defined behavior:   - Recipients
+    # need to either specify both start date and end date or neither.     If
+    # both start date and end date are not specified; default provided.
+    # Default range: 7 Days of past data. (Today's date - 6 days both dates are
+    # inclusive)   - Recipient can specify the same start date and end date. The
+    # returned data will reflect transactions from that date   - If start date
+    # and end date both are specified and if start date is later than end date,
+    #    return 'invalid date range' error code: 703, HTTPS 400 per the FDX spec
+    #   - If start Date and end date both are specified and if start date is
+    # older than what the Data Provider supports,     then the Data Provider
+    # should return 'invalid date range' error code: 703, HTTPS 400 per the FDX
+    # spec.     Example: If today is 5/14/2024 and the DP supports 24 months,
+    # the start date should be 5/14/2022 and newer;     it should not be
+    # 5/13/2022 or older   - If start date is specified but end date is not
+    # specified or vice versa;     Data Provider should return 'invalid date
+    # range' error code: 703, HTTPS 400 per the FDX spec   - If end date is
+    # today's date, the most recent transactions from the time the request is
+    # received will be returned
+    # @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
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_paystubs(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,
+                     start_date: nil,
+                     end_date: nil,
+                     page_key: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/payroll/paystubs',
+                                     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_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(start_date, key: 'startDate'))
+                   .query_param(new_parameter(end_date, key: 'endDate'))
+                   .query_param(new_parameter(page_key, key: 'pageKey'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PaystubListEntity1.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 paystub as a Base64 PDF file
+    # @param [String] paystub_id Required parameter: The specific paystub ID to
+    # retrieve. This can be any ID which the data provider creates specific to
+    # the consenting person's paystub, perhaps simply the pay date as a string
+    # optionally followed by a sequence number: "2024-09-30-01". Need only be
+    # unique within the current employee's consent / token, according to data
+    # provider's preference
+    # @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_paystub(paystub_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/paystubs/{paystubId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(paystub_id, key: 'paystubId')
+                                    .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(PaystubEntity2.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Required input data not sent',
+                                 ErrorException)
+                    .local_error('404',
+                                 'Pay Stub 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