fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/controllers/reward_program_categories_controller.rb

@@ -0,0 +1,64 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # RewardProgramCategoriesController
+  class RewardProgramCategoriesController < BaseController
+    # Get reward categories
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction
+    # @param [String] reward_program_id Required parameter: Reward Program
+    # Identifier
+    # @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 get_reward_program_categories(x_fapi_interaction_id,
+                                      reward_program_id,
+                                      fdx_api_actor_type: nil,
+                                      offset: nil,
+                                      limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reward-programs/{rewardProgramId}/categories',
+                                     Server::CORE)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(reward_program_id, key: 'rewardProgramId')
+                                    .is_required(true)
+                                    .should_encode(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(RewardCategoriesEntity.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 'Request is invalid',
+                                 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_api/controllers/reward_program_information_controller.rb

@@ -0,0 +1,88 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # RewardProgramInformationController
+  class RewardProgramInformationController < BaseController
+    # Query all reward programs
+    # @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 search_reward_programs(x_fapi_interaction_id,
+                               fdx_api_actor_type: nil,
+                               offset: nil,
+                               limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reward-programs',
+                                     Server::CORE)
+                   .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(RewardProgramsEntity.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Get a specific reward program
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction
+    # @param [String] reward_program_id Required parameter: Reward Program
+    # Identifier
+    # @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_reward_program(x_fapi_interaction_id,
+                           reward_program_id,
+                           fdx_api_actor_type: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reward-programs/{rewardProgramId}',
+                                     Server::CORE)
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .template_param(new_parameter(reward_program_id, key: 'rewardProgramId')
+                                    .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(RewardProgramEntity.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 'Reward program Id 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_api/controllers/submit_tax_forms_controller.rb

@@ -0,0 +1,106 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # SubmitTaxFormsController
+  class SubmitTaxFormsController < BaseController
+    # Submit the data for a specific tax document
+    # @param [String] authorization Required parameter: The [Authorization HTTP
+    # request
+    # header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authoriz
+    # ation) provides credentials to allow access to a protected resources
+    # @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 [TaxStatement1] body Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_tax_form(authorization,
+                        x_fapi_interaction_id,
+                        fdx_api_actor_type: nil,
+                        body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/tax-forms',
+                                     Server::USTAX)
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(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'))
+                   .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(TaxStatement2.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Tax Form type is 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
+
+    # Update tax document. Allows you to upload and replace binaries or json
+    # document
+    # @param [String] tax_form_id Required parameter: The unique ID for this tax
+    # form or tax statement
+    # @param [String] authorization Required parameter: The [Authorization HTTP
+    # request
+    # header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authoriz
+    # ation) provides credentials to allow access to a protected resources
+    # @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 [TaxStatement6] body Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_tax_form(tax_form_id,
+                        authorization,
+                        x_fapi_interaction_id,
+                        fdx_api_actor_type: nil,
+                        body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/tax-forms/{taxFormId}',
+                                     Server::USTAX)
+                   .template_param(new_parameter(tax_form_id, key: 'taxFormId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(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'))
+                   .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('415',
+                                 'Server does not support the content type uploaded',
+                                 ErrorException))
+        .execute
+    end
+  end
+end

data/lib/fdx_api/controllers/tax_forms_controller.rb

@@ -0,0 +1,190 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # TaxFormsController
+  class TaxFormsController < BaseController
+    # Get the full lists of tax document data and tax form images available for
+    # a specific year for the current authorized customer
+    # @param [String] authorization Required parameter: The [Authorization HTTP
+    # request
+    # header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authoriz
+    # ation) provides credentials to allow access to a protected resources
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction
+    # @param [String] accept Required parameter: Use the [Accept HTTP request
+    # header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept)
+    # to indicate one or more content types to request for the search result
+    # response. Use `application/json` to request data, `application/pdf`,
+    # `application/zip` or `image/*` MIME-types to request images. In
+    # comma-separated array format using values typically from
+    # './fdxapi.components.yaml#/components/schemas/ContentTypes' enumeration.
+    # Use in combination with TaxDataTypeQuery parameter to request
+    # `application/json` responses in 'JSON' or 'BASE64_PDF' format for tax form
+    # data
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [String] account_id Optional parameter: Account Identifier for use
+    # in searching or authorization. Optional
+    # @param [Integer] tax_year Optional parameter: Tax year in which to search
+    # for tax forms. Optional
+    # @param [Array[TypeFormType]] tax_forms Optional parameter: One or more tax
+    # form type enums for the specific documents being requested. Comma
+    # separated
+    # @param [TypeDataType] tax_data_type Optional parameter: Use taxDataType to
+    # request `application/json` tax form data response in 'JSON' or
+    # 'BASE64_PDF' format. Omit if either format is acceptable. Used in
+    # combination with AcceptHeader requesting `application/json` response
+    # @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 search_for_tax_forms(authorization,
+                             x_fapi_interaction_id,
+                             accept,
+                             fdx_api_actor_type: nil,
+                             account_id: nil,
+                             tax_year: nil,
+                             tax_forms: nil,
+                             tax_data_type: nil,
+                             result_type: ResultType::LIGHTWEIGHT)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/tax-forms',
+                                     Server::USTAX)
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .header_param(new_parameter(accept, key: 'Accept')
+                                  .is_required(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .query_param(new_parameter(account_id, key: 'accountId'))
+                   .query_param(new_parameter(tax_year, key: 'taxYear'))
+                   .query_param(new_parameter(tax_forms, key: 'taxForms'))
+                   .query_param(new_parameter(tax_data_type, key: 'taxDataType'))
+                   .query_param(new_parameter(result_type, key: 'resultType'))
+                   .auth(Or.new('TaxBasicAuth', 'bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TaxStatementList.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Request is invalid or parameter values are not supported',
+                                 ErrorException)
+                    .local_error('404',
+                                 'Tax Form not Found',
+                                 ErrorException)
+                    .local_error('406',
+                                 'Content Type not Supported',
+                                 ErrorException)
+                    .local_error('409',
+                                 'Tax forms are not currently available for this account or this'\
+                                  ' year',
+                                 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 form image or TaxStatement as json for a single tax document for
+    # the customer. Use [HTTP Accept
+    # request-header](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html)
+    # to specify desired content types. See `AcceptHeader` definition for
+    # typical values
+    # @param [String] tax_form_id Required parameter: The unique ID for this tax
+    # form or tax statement
+    # @param [String] authorization Required parameter: The [Authorization HTTP
+    # request
+    # header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authoriz
+    # ation) provides credentials to allow access to a protected resources
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction
+    # @param [String] accept Required parameter: Use the [Accept HTTP request
+    # header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept)
+    # to indicate one or more content types to request for the search result
+    # response. Use `application/json` to request data, `application/pdf`,
+    # `application/zip` or `image/*` MIME-types to request images. In
+    # comma-separated array format using values typically from
+    # './fdxapi.components.yaml#/components/schemas/ContentTypes' enumeration.
+    # Use in combination with TaxDataTypeQuery parameter to request
+    # `application/json` responses in 'JSON' or 'BASE64_PDF' format for tax form
+    # data
+    # @param [FdxApiActorType] fdx_api_actor_type Optional parameter: Identifies
+    # whether the customer is present (USER) or it is a BATCH operation
+    # @param [TypeDataType] tax_data_type Optional parameter: Use taxDataType to
+    # request `application/json` tax form data response in 'JSON' or
+    # 'BASE64_PDF' format. Omit if either format is acceptable. Used in
+    # combination with AcceptHeader requesting `application/json` response
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_tax_form(tax_form_id,
+                     authorization,
+                     x_fapi_interaction_id,
+                     accept,
+                     fdx_api_actor_type: nil,
+                     tax_data_type: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/tax-forms/{taxFormId}',
+                                     Server::USTAX)
+                   .template_param(new_parameter(tax_form_id, key: 'taxFormId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id')
+                                  .is_required(true))
+                   .header_param(new_parameter(accept, key: 'Accept')
+                                  .is_required(true))
+                   .header_param(new_parameter(fdx_api_actor_type, key: 'FDX-API-Actor-Type'))
+                   .query_param(new_parameter(tax_data_type, key: 'taxDataType'))
+                   .auth(Or.new('TaxBasicAuth', 'bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TaxStatement4.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Account ID is required for searching or validating'\
+                                  ' authorization',
+                                 ErrorException)
+                    .local_error('404',
+                                 'Tax Form for provided Tax Form ID was not found',
+                                 ErrorException)
+                    .local_error('406',
+                                 'Content Type not Supported',
+                                 ErrorException)
+                    .local_error('409',
+                                 'Tax forms are not currently available for this account or this'\
+                                  ' year',
+                                 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_api/controllers/user_consent_controller.rb

@@ -0,0 +1,125 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # UserConsentController
+  class UserConsentController < BaseController
+    # Get a Consent Grant
+    # @param [String] consent_id Required parameter: Consent Identifier
+    # @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
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_consent_grant(consent_id,
+                          x_fapi_interaction_id,
+                          fdx_api_actor_type: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/consents/{consentId}',
+                                     Server::CONSENT)
+                   .template_param(new_parameter(consent_id, key: 'consentId')
+                                    .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('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ConsentGrantEntity.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Request lacks valid authentication credentials for the target'\
+                                  ' resource',
+                                 ErrorException)
+                    .local_error('404',
+                                 'Data not found for request parameters',
+                                 ErrorException))
+        .execute
+    end
+
+    # Revoke a Consent Grant
+    # @param [String] consent_id Required parameter: Consent Identifier
+    # @param [UUID | String] x_fapi_interaction_id Required parameter: Unique
+    # identifier for this interaction
+    # @param [ConsentRevocationRequestEntity] body Required parameter: Reason
+    # and initiator of revocation
+    # @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 revoke_consent_grant(consent_id,
+                             x_fapi_interaction_id,
+                             body,
+                             fdx_api_actor_type: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/consents/{consentId}/revocation',
+                                     Server::CONSENT)
+                   .template_param(new_parameter(consent_id, key: 'consentId')
+                                    .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'))
+                   .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('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',
+                                 'Data not found for request parameters',
+                                 ErrorException)
+                    .local_error('409',
+                                 'Conflict with current state of target resource',
+                                 ErrorException))
+        .execute
+    end
+
+    # Retrieve Consent Revocation record
+    # @param [String] consent_id Required parameter: Consent Identifier
+    # @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
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_consent_revocation(consent_id,
+                               x_fapi_interaction_id,
+                               fdx_api_actor_type: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/consents/{consentId}/revocation',
+                                     Server::CONSENT)
+                   .template_param(new_parameter(consent_id, key: 'consentId')
+                                    .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('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ConsentRevocationListEntity.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/fdx_api/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code}, reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/fdx_api/exceptions/error_exception.rb

@@ -0,0 +1,65 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # An error entity which can be used at the API level for error responses or at
+  # the account level to indicate a problem specific to a particular account.
+  # See the error codes and descriptions defined in the latest FDX API
+  # Specification document, section 6.2 Errors
+  class ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error code defined by FDX API Specification or Data Provider indicating
+    # the error situation which has occurred
+    # @return [String]
+    attr_accessor :code
+
+    # End user displayable information which might help the customer diagnose an
+    # error
+    # @return [String]
+    attr_accessor :message
+
+    # Message used to debug the root cause of the error. Contents should not be
+    # used in consumer's business logic. Can change at any time and should only
+    # be used for consumer to communicate with the data provider about an issue.
+    # Provider can include an error GUID in message for their use.
+    # @return [String]
+    attr_accessor :debug_message
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @code = hash.key?('code') ? hash['code'] : SKIP
+      @message = hash.key?('message') ? hash['message'] : SKIP
+      @debug_message = hash.key?('debugMessage') ? hash['debugMessage'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}, message: #{@message}, debug_message: #{@debug_message}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code.inspect}, message: #{@message.inspect}, debug_message:"\
+      " #{@debug_message.inspect}>"
+    end
+  end
+end