data-and-reporting-sdk 1.0.0

data/lib/shell_data_reporting_ap_is/exceptions/api_exception.rb

@@ -0,0 +1,10 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+  end
+end

data/lib/shell_data_reporting_ap_is/exceptions/default_error_exception.rb

@@ -0,0 +1,32 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # Error response
+  class DefaultErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error object
+    # @return [DefaultErrorFault]
+    attr_accessor :fault
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] 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] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @fault = DefaultErrorFault.from_hash(hash['fault']) if hash['fault']
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/exceptions/error_object_exception.rb

@@ -0,0 +1,54 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # ErrorObject class.
+  class ErrorObjectException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique request identifier passed from end user. This identifier helps in
+    # tracing a transaction
+    # @return [String]
+    attr_accessor :request_id
+
+    # Indicates overall status of the request. Allowed values: SUCCES, FAILED,
+    # PARTIAL_SUCCESS
+    # @return [String]
+    attr_accessor :status
+
+    # Indicates overall status of the request. Allowed values: SUCCES, FAILED,
+    # PARTIAL_SUCCESS
+    # @return [Array[ErrorDetails]]
+    attr_accessor :errors
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] 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] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
+      @status = hash.key?('Status') ? hash['Status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      @errors = nil
+      unless hash['Errors'].nil?
+        @errors = []
+        hash['Errors'].each do |structure|
+          @errors << (ErrorDetails.from_hash(structure) if structure)
+        end
+      end
+
+      @errors = SKIP unless hash.key?('Errors')
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/exceptions/error_user_access_error1_exception.rb

@@ -0,0 +1,32 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # ErrorUserAccess_Error1 class.
+  class ErrorUserAccessError1Exception < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ErrorUserAccessError]
+    attr_accessor :error
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] 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] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @error = ErrorUserAccessError.from_hash(hash['Error']) if hash['Error']
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/exceptions/o_auth_provider_exception.rb

@@ -0,0 +1,48 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # OAuth 2 Authorization endpoint exception.
+  class OAuthProviderException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Gets or sets error code.
+    # @return [OAuthProviderErrorEnum]
+    attr_accessor :error
+
+    # Gets or sets human-readable text providing additional information on
+    # error.
+    # Used to assist the client developer in understanding the error that
+    # occurred.
+    # @return [String]
+    attr_accessor :error_description
+
+    # Gets or sets a URI identifying a human-readable web page with information
+    # about the error, used to provide the client developer with additional
+    # information about the error.
+    # @return [String]
+    attr_accessor :error_uri
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] 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] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @error = hash.key?('error') ? hash['error'] : nil
+      @error_description =
+        hash.key?('error_description') ? hash['error_description'] : SKIP
+      @error_uri = hash.key?('error_uri') ? hash['error_uri'] : SKIP
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # 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 clone_with(username: nil, password: nil)
+      username ||= self.username
+      password ||= self.password
+
+      BasicAuthCredentials.new(username: username, password: password)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/http/auth/bearer_token.rb

@@ -0,0 +1,89 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # Utility class for OAuth 2 authorization and token management.
+  class BearerToken < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'BearerToken: OAuthToken is undefined or expired.'
+    end
+
+    # Initialization constructor.
+    def initialize(bearer_token_credentials, config)
+      auth_params = {}
+      @_o_auth_client_id = bearer_token_credentials.o_auth_client_id unless
+        bearer_token_credentials.nil? || bearer_token_credentials.o_auth_client_id.nil?
+      @_o_auth_client_secret = bearer_token_credentials.o_auth_client_secret unless
+        bearer_token_credentials.nil? || bearer_token_credentials.o_auth_client_secret.nil?
+      @_o_auth_token = bearer_token_credentials.o_auth_token unless
+        bearer_token_credentials.nil? || bearer_token_credentials.o_auth_token.nil?
+      @_o_auth_api = OAuthAuthorizationController.new(config)
+      auth_params['Authorization'] = "Bearer #{@_o_auth_token.access_token}" unless @_o_auth_token.nil?
+
+      super auth_params
+    end
+
+    # Validates the oAuth token.
+    # @return [Boolean] true if the token is present and not expired.
+    def valid
+      !@_o_auth_token.nil? && !token_expired?(@_o_auth_token)
+    end
+
+    # Builds the basic auth header for endpoints in the OAuth Authorization Controller.
+    # @return [String] The value of the Authentication header.
+    def build_basic_auth_header
+      "Basic #{AuthHelper.get_base64_encoded_value(@_o_auth_client_id, @_o_auth_client_secret)}"
+    end
+
+    # Fetches the token.
+    # @param [Hash] additional_params Any additional form parameters.
+    # @return [OAuthToken] The oAuth token instance.
+    def fetch_token(additional_params: nil)
+      token = @_o_auth_api.request_token_bearer_token(
+        build_basic_auth_header,
+        _field_parameters: additional_params
+      )
+      if token.respond_to?('expires_in') && !token.expires_in.nil?
+        token.expiry = AuthHelper.get_token_expiry(token.expires_in, Time.now.utc.to_i)
+      end
+      token
+    end
+
+    # Checks if OAuth token has expired.
+    # @param [OAuthToken] token The oAuth token instance.
+    # @return [Boolean] true if the token's expiry exist and also the token is expired, false otherwise.
+    def token_expired?(token)
+      token.respond_to?('expiry') && AuthHelper.token_expired?(token.expiry)
+    end
+  end
+
+  # Data class for BearerTokenCredentials.
+  class BearerTokenCredentials
+    attr_reader :o_auth_client_id, :o_auth_client_secret, :o_auth_token
+
+    def initialize(o_auth_client_id:, o_auth_client_secret:, o_auth_token: nil)
+      raise ArgumentError, 'o_auth_client_id cannot be nil' if o_auth_client_id.nil?
+      raise ArgumentError, 'o_auth_client_secret cannot be nil' if o_auth_client_secret.nil?
+
+      @o_auth_client_id = o_auth_client_id
+      @o_auth_client_secret = o_auth_client_secret
+      @o_auth_token = o_auth_token
+    end
+
+    def clone_with(o_auth_client_id: nil, o_auth_client_secret: nil,
+                   o_auth_token: nil)
+      o_auth_client_id ||= self.o_auth_client_id
+      o_auth_client_secret ||= self.o_auth_client_secret
+      o_auth_token ||= self.o_auth_token
+
+      BearerTokenCredentials.new(o_auth_client_id: o_auth_client_id,
+                                 o_auth_client_secret: o_auth_client_secret,
+                                 o_auth_token: o_auth_token)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/http/http_call_back.rb

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

data/lib/shell_data_reporting_ap_is/http/http_method_enum.rb

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

data/lib/shell_data_reporting_ap_is/http/http_request.rb

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

data/lib/shell_data_reporting_ap_is/http/http_response.rb

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

data/lib/shell_data_reporting_ap_is/models/account_access.rb

@@ -0,0 +1,128 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # AccountAccess Model.
+  class AccountAccess < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Collecting company id.
+    # @return [Integer]
+    attr_accessor :colco_id
+
+    # Collecting company code.
+    # @return [Integer]
+    attr_accessor :colco_code
+
+    # Payer Id to which the user has access
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Payer Number to which the user has access
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Name of the Payer to which the user has access
+    # @return [String]
+    attr_accessor :payer_name
+
+    # Account Id to which the user has access
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Number to which the user has access
+    # @return [String]
+    attr_accessor :account_number
+
+    # Name of the Account to which the user has access
+    # @return [String]
+    attr_accessor :account_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['colco_id'] = 'ColcoId'
+      @_hash['colco_code'] = 'ColcoCode'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['payer_name'] = 'PayerName'
+      @_hash['account_id'] = 'AccountId'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['account_name'] = 'AccountName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        colco_id
+        colco_code
+        payer_id
+        payer_number
+        payer_name
+        account_id
+        account_number
+        account_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        colco_id
+        colco_code
+        payer_id
+        payer_number
+        payer_name
+        account_id
+        account_name
+      ]
+    end
+
+    def initialize(colco_id = SKIP,
+                   colco_code = SKIP,
+                   payer_id = SKIP,
+                   payer_number = SKIP,
+                   payer_name = SKIP,
+                   account_id = SKIP,
+                   account_number = SKIP,
+                   account_name = SKIP)
+      @colco_id = colco_id unless colco_id == SKIP
+      @colco_code = colco_code unless colco_code == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @payer_number = payer_number unless payer_number == SKIP
+      @payer_name = payer_name unless payer_name == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @account_name = account_name unless account_name == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      colco_id = hash.key?('ColcoId') ? hash['ColcoId'] : SKIP
+      colco_code = hash.key?('ColcoCode') ? hash['ColcoCode'] : SKIP
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      payer_name = hash.key?('PayerName') ? hash['PayerName'] : SKIP
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      account_name = hash.key?('AccountName') ? hash['AccountName'] : SKIP
+
+      # Create object from extracted values.
+      AccountAccess.new(colco_id,
+                        colco_code,
+                        payer_id,
+                        payer_number,
+                        payer_name,
+                        account_id,
+                        account_number,
+                        account_name)
+    end
+  end
+end