apimatic-ak-sdk 0.0.1

data/lib/akoya/controllers/tokens_controller.rb

@@ -0,0 +1,122 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # TokensController
+  class TokensController < BaseController
+    # The token endpoint is used to **obtain** tokens during authorization or to
+    # **refresh** tokens without having to go through authorization again. In
+    # each successful token response, you will receive a new `id_token` and a
+    # new `refresh_token`.
+    # > ⚠️ Please note!
+    # >
+    # > Use the correct schema (detailed below) for the type of token request
+    # you're making. The initial token request and the refresh token requests
+    # require different security schemas and parameters.
+    # ## Obtain tokens
+    # To obtain the initial set of tokens or to reauthorize, you will need the
+    # following:
+    # - `grant_type` must be set to `authorization_code`.
+    # - `redirect_uri` must be the same as your app's registered `redirect_uri`.
+    # - `code` is the authorization code from the end-user's authentication
+    # flow. See: [Get authorization
+    # code](https://docs.akoya.com/reference/get-authorization-code).
+    # - **Security**: Include Basic Auth in the header of the call. Select
+    # "Basic Auth" in Try it and use your `client_id` and `client_secret` as
+    # username & password.
+    # ## Refresh tokens
+    # Refresh token expiration times are set by the provider.
+    # - `grant_type` must be set to `refresh_token`.
+    # - `refresh_token` must be set to the refresh token received in the most
+    # recent, previous obtain or refresh token call for your end-user.
+    # - **Security**: Include your `client_id` and `client_secret` **in the body
+    # of the request**. Remove any information from "Basic Auth" (username and
+    # password) in Try it.
+    # ## Responses
+    # Token requests return a new set of tokens. If refreshing or reauthorizing
+    # tokens, they will replace the tokens from your previous, successful obtain
+    # or refresh token call.
+    # The `id_token` (JWT) is a short-lived token. It's used as the **bearer
+    # token** for data calls. To ensure data calls are secure, the `id_token`
+    # must be renewed regularly. To retrieve a new `id_token`, use the refresh
+    # token request. [Read more about
+    # tokens](https://docs.akoya.com/docs/token-flow).
+    # @param [String] grant_type Required parameter: Set to `authorization_code`
+    # to indicate an authorization code will be returned
+    # @param [String] redirect_uri Required parameter: URI where user will be
+    # redirected after end-users authorization is complete. It must be the same
+    # as the URI called in the authorization request
+    # @param [String] code Required parameter: Authorization code from
+    # end-user's authentication.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_token(grant_type,
+                  redirect_uri,
+                  code)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/token',
+                                     Server::DEFAULT1)
+                   .form_param(new_parameter(grant_type, key: 'grant_type')
+                                .is_required(true))
+                   .form_param(new_parameter(redirect_uri, key: 'redirect_uri')
+                                .is_required(true))
+                   .form_param(new_parameter(code, key: 'code')
+                                .is_required(true))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TokenExampleResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    # This request revokes tokens granted on behalf of the end-user.
+    # - **Security**: Include your `client_id` and `client_secret` **in the body
+    # of the request**. Remove any information from "Basic Auth" (username and
+    # password) in Try it.
+    # @param [String] client_id Required parameter: Client ID
+    # @param [String] client_secret Required parameter: Client secret
+    # @param [String] token Required parameter: Refresh token
+    # @param [String] token_type_hint Required parameter: Accepts
+    # `refresh_token`
+    # @param [String] akoya_id Optional parameter: Deprecated. Do not use. Trace
+    # ID for troubleshooting. Required until deprecated October 1, 2021. Akoya
+    # will automatically generate an ID and return it in the response header
+    # `x-akoya-interaction-id`
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def revoke_token(client_id,
+                     client_secret,
+                     token,
+                     token_type_hint,
+                     akoya_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/revoke',
+                                     Server::DEFAULT1)
+                   .form_param(new_parameter(client_id, key: 'client_id')
+                                .is_required(true))
+                   .form_param(new_parameter(client_secret, key: 'client_secret')
+                                .is_required(true))
+                   .form_param(new_parameter(token, key: 'token')
+                                .is_required(true))
+                   .form_param(new_parameter(token_type_hint, key: 'token_type_hint')
+                                .is_required(true))
+                   .header_param(new_parameter(akoya_id, key: 'akoyaId'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/akoya/controllers/transactions_controller.rb

@@ -0,0 +1,108 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # TransactionsController
+  class TransactionsController < BaseController
+    # The transactions API allows you to retrieve transaction history of
+    # consumer-permissioned accounts.
+    # > 🛑
+    # >
+    # > The *id_token* should be used as the bearer token with this call.
+    # For more information on how to paginate transaction results, please see:
+    # [Pagination](https://docs.akoya.com/v2/docs/pagination)
+    # Use the `mode` query param to receive FDX-aligned, standardized data
+    # values (Beta). For example:
+    # `https://sandbox-products.ddp.akoya.com/transactions/v2/mikomo?mode=standa
+    # rd`
+    # `mode` is available in both sandbox and production.
+    # `mode` is supported by a subset of providers. Log into the [Data Recipient
+    # Hub](https://recipient.ddp.akoya.com/login) and click
+    # [here](https://recipient.ddp.akoya.com/support/article/kA0Uw00000015GzKAI)
+    # to view a list of all providers supporting the `mode` parameter.
+    # @param [String] version Required parameter: Akoya major version number. Do
+    # not use minor version numbers. For instance, use v2 and not v2.2
+    # @param [String] provider_id Required parameter: Id of provider
+    # @param [String] account_id Required parameter: Account Identifier
+    # @param [DateTime] start_time Optional parameter: ISO 8601 date format in
+    # UTC time zone. If blank, the default value (current date - 15 calendar
+    # days) is used. If a value is specified, endTime is required.
+    # @param [DateTime] end_time Optional parameter: ISO 8601 date format in UTC
+    # time zone. If blank, the default value (current date) is used. If a value
+    # is specified, startTime is required.
+    # @param [String] offset Optional parameter: The number of items to skip
+    # before the first in the response. The default is 0.
+    # @param [Integer] limit Optional parameter: The maximum number of items to
+    # be returned in the response. The default is 50.
+    # @param [XAkoyaInteractionType] x_akoya_interaction_type Optional
+    # parameter: Optional but recommended header to include with each data
+    # request.  Allowed values are `user` or `batch`.  `user` indicates a
+    # request is prompted by an end-user action. `batch` indicates the request
+    # is part of a batch process.
+    # @param [Mode] mode Optional parameter: BETA. Default is raw. Use standard
+    # for FDX-aligned, standardized data values.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_transactions(version,
+                         provider_id,
+                         account_id,
+                         start_time: nil,
+                         end_time: nil,
+                         offset: '0',
+                         limit: 50,
+                         x_akoya_interaction_type: nil,
+                         mode: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/transactions/{version}/{providerId}/{accountId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(version, key: 'version')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(provider_id, key: 'providerId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(account_id, key: 'accountId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(start_time, key: 'startTime'))
+                   .query_param(new_parameter(end_time, key: 'endTime'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter(x_akoya_interaction_type, key: 'x-akoya-interaction-type'))
+                   .query_param(new_parameter(mode, key: 'mode'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TransactionsEntity.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorEntityException)
+                    .local_error('401',
+                                 '602 - Customer not authorized',
+                                 ErrorEntityException)
+                    .local_error('404',
+                                 '701 - Account not found',
+                                 ErrorEntityException)
+                    .local_error('406',
+                                 '1203 - Content Type not Supported',
+                                 ErrorEntityException)
+                    .local_error('429',
+                                 '1207 - Too many requests',
+                                 ErrorEntityException)
+                    .local_error('500',
+                                 '500 - Internal server error',
+                                 ErrorEntityException)
+                    .local_error('501',
+                                 '1106 - Version not supported or not implemented',
+                                 ErrorEntityException)
+                    .local_error('503',
+                                 '503 - System is down for maintenance',
+                                 ErrorEntityException))
+        .execute
+    end
+  end
+end

data/lib/akoya/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # 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/akoya/exceptions/error_entity_exception.rb

@@ -0,0 +1,54 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # 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.
+  class ErrorEntityException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Long term persistent identifier which can be used to trace error condition
+    # back to log information
+    # @return [Integer]
+    attr_accessor :code
+
+    # End user displayable information which might help the customer diagnose an
+    # error
+    # @return [String]
+    attr_accessor :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
+    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}>"
+    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}>"
+    end
+  end
+end

data/lib/akoya/exceptions/error_response_exception.rb

@@ -0,0 +1,53 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # Error response class.
+  class ErrorResponseException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_description
+
+    # 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
+
+      @error = hash.key?('error') ? hash['error'] : SKIP
+      @error_description =
+        hash.key?('error_description') ? hash['error_description'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, error_description: #{@error_description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, error_description:"\
+      " #{@error_description.inspect}>"
+    end
+  end
+end

data/lib/akoya/http/api_response.rb

@@ -0,0 +1,19 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # Http response received.
+  class ApiResponse < CoreLibrary::ApiResponse
+    # The constructor
+    # @param [HttpResponse] http_response The original, raw response from the api.
+    # @param [Object] data The data field specified for the response.
+    # @param [Array<String>] errors Any errors returned by the server.
+    def initialize(http_response,
+                   data: nil,
+                   errors: nil)
+      super
+    end
+  end
+end

data/lib/akoya/http/auth/basic_auth.rb

@@ -0,0 +1,62 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # Utility class for basic authorization.
+  class BasicAuth < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'BasicAuth: username or password is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(basic_auth_credentials)
+      auth_params = {}
+      unless basic_auth_credentials.nil? ||
+             basic_auth_credentials.username.nil? ||
+             basic_auth_credentials.password.nil?
+        auth_params['Authorization'] =
+          "Basic #{AuthHelper.get_base64_encoded_value(basic_auth_credentials.username,
+                                                       basic_auth_credentials.password)}"
+      end
+
+      super auth_params
+    end
+  end
+
+  # Data class for BasicAuthCredentials.
+  class BasicAuthCredentials
+    attr_reader :username, :password
+
+    def initialize(username:, password:)
+      raise ArgumentError, 'username cannot be nil' if username.nil?
+      raise ArgumentError, 'password cannot be nil' if password.nil?
+
+      @username = username
+      @password = password
+    end
+
+    def self.from_env
+      username = ENV['BASIC_AUTH_USERNAME']
+      password = ENV['BASIC_AUTH_PASSWORD']
+      all_nil = [
+        username,
+        password
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(username: username, password: password)
+    end
+
+    def clone_with(username: nil, password: nil)
+      username ||= self.username
+      password ||= self.password
+
+      BasicAuthCredentials.new(username: username, password: password)
+    end
+  end
+end

data/lib/akoya/http/auth/bearer_auth.rb

@@ -0,0 +1,53 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # Utility class for OAuth 2 authorization and token management.
+  class BearerAuth < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'BearerAuth: access_token is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(bearer_auth_credentials)
+      auth_params = {}
+      @_access_token = bearer_auth_credentials.access_token unless
+        bearer_auth_credentials.nil? || bearer_auth_credentials.access_token.nil?
+      auth_params[:Authorization] = "Bearer #{@_access_token}" unless @_access_token.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for BearerAuthCredentials.
+  class BearerAuthCredentials
+    attr_reader :access_token
+
+    def initialize(access_token:)
+      raise ArgumentError, 'access_token cannot be nil' if access_token.nil?
+
+      @access_token = access_token
+    end
+
+    def self.from_env
+      access_token = ENV['BEARER_AUTH_ACCESS_TOKEN']
+      all_nil = [
+        access_token
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(access_token: access_token)
+    end
+
+    def clone_with(access_token: nil)
+      access_token ||= self.access_token
+
+      BearerAuthCredentials.new(access_token: access_token)
+    end
+  end
+end

data/lib/akoya/http/http_call_back.rb

@@ -0,0 +1,10 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/akoya/http/http_method_enum.rb

@@ -0,0 +1,10 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/akoya/http/http_request.rb

@@ -0,0 +1,10 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/akoya/http/http_response.rb

@@ -0,0 +1,10 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end

data/lib/akoya/http/proxy_settings.rb

@@ -0,0 +1,22 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  ##
+  # ProxySettings encapsulates HTTP proxy configuration for Faraday,
+  # including optional basic authentication.
+  #
+  class ProxySettings < CoreLibrary::ProxySettings
+    def self.from_env
+      address = ENV['PROXY_ADDRESS']
+      port = ENV['PROXY_PORT']
+      username = ENV['PROXY_USERNAME']
+      password = ENV['PROXY_PASSWORD']
+      return nil if address.nil? || address.strip.empty?
+
+      new(address: address, port: port, username: username, password: password)
+    end
+  end
+end