data-and-reporting-sdk 1.2.0 → 2.0.0

data/lib/shell_data_reporting_ap_is/exceptions/api_exception.rb

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

@@ -1,7 +1,7 @@
 # shell_data_reporting_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellDataReportingApIs
   # ErrorObject class.
@@ -25,8 +25,8 @@ module ShellDataReportingApIs
     attr_accessor :errors
 
     # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
+    # @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)
@@ -34,9 +34,11 @@ module ShellDataReportingApIs
     end
 
     # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the
+    # @param [Hash] hash The deserialized response sent by the server in the
     # response body.
     def unbox(hash)
+      return nil unless 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
@@ -50,5 +52,18 @@ module ShellDataReportingApIs
 
       @errors = SKIP unless hash.key?('Errors')
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} request_id: #{@request_id}, status: #{@status}, errors: #{@errors}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} request_id: #{@request_id.inspect}, status: #{@status.inspect}, errors:"\
+      " #{@errors.inspect}>"
+    end
   end
 end

data/lib/shell_data_reporting_ap_is/exceptions/o_auth_provider_exception.rb

@@ -1,7 +1,7 @@
 # shell_data_reporting_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellDataReportingApIs
   # OAuth 2 Authorization endpoint exception.
@@ -27,8 +27,8 @@ module ShellDataReportingApIs
     attr_accessor :error_uri
 
     # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
+    # @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)
@@ -36,13 +36,29 @@ module ShellDataReportingApIs
     end
 
     # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the
+    # @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'] : nil
       @error_description =
         hash.key?('error_description') ? hash['error_description'] : SKIP
       @error_uri = hash.key?('error_uri') ? hash['error_uri'] : 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}, error_uri:"\
+      " #{@error_uri}>"
+    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},"\
+      " error_uri: #{@error_uri.inspect}>"
+    end
   end
 end

data/lib/shell_data_reporting_ap_is/http/auth/{bearer_token.rb → o_auth2.rb}

@@ -1,32 +1,32 @@
 # shell_data_reporting_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellDataReportingApIs
   # Utility class for OAuth 2 authorization and token management.
-  class BearerToken < CoreLibrary::HeaderAuth
+  class OAuth2 < 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.'
+      'ClientCredentialsAuth: OAuthToken is undefined or expired.'
     end
 
     # Initialization constructor.
-    def initialize(bearer_token_credentials, config)
-      @_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_clock_skew = bearer_token_credentials.o_auth_clock_skew unless
-        bearer_token_credentials.nil? || bearer_token_credentials.o_auth_clock_skew.nil?
-      @_o_auth_token_provider = bearer_token_credentials.o_auth_token_provider unless
-        bearer_token_credentials.nil? || bearer_token_credentials.o_auth_token_provider.nil?
-      @_o_auth_on_token_update = bearer_token_credentials.o_auth_on_token_update unless
-        bearer_token_credentials.nil? || bearer_token_credentials.o_auth_on_token_update.nil?
+    def initialize(client_credentials_auth_credentials, config)
+      @_o_auth_client_id = client_credentials_auth_credentials.o_auth_client_id unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_client_id.nil?
+      @_o_auth_client_secret = client_credentials_auth_credentials.o_auth_client_secret unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_client_secret.nil?
+      @_o_auth_token = client_credentials_auth_credentials.o_auth_token unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_token.nil?
+      @_o_auth_clock_skew = client_credentials_auth_credentials.o_auth_clock_skew unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_clock_skew.nil?
+      @_o_auth_token_provider = client_credentials_auth_credentials.o_auth_token_provider unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_token_provider.nil?
+      @_o_auth_on_token_update = client_credentials_auth_credentials.o_auth_on_token_update unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_on_token_update.nil?
       @_o_auth_api = OAuthAuthorizationController.new(config)
       super({})
     end
@@ -48,7 +48,7 @@ module ShellDataReportingApIs
     # @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(
+      token = @_o_auth_api.request_token(
         build_basic_auth_header,
         _field_parameters: additional_params
       )
@@ -92,15 +92,15 @@ module ShellDataReportingApIs
     end
   end
 
-  # Data class for BearerTokenCredentials.
-  class BearerTokenCredentials
+  # Data class for ClientCredentialsAuthCredentials.
+  class ClientCredentialsAuthCredentials
     attr_reader :o_auth_client_id, :o_auth_client_secret, :o_auth_token,
                 :o_auth_token_provider, :o_auth_on_token_update,
                 :o_auth_clock_skew
 
     def initialize(o_auth_client_id:, o_auth_client_secret:, o_auth_token: nil,
                    o_auth_token_provider: nil, o_auth_on_token_update: nil,
-                   o_auth_clock_skew: nil)
+                   o_auth_clock_skew: 0)
       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?
 
@@ -122,12 +122,13 @@ module ShellDataReportingApIs
       o_auth_on_token_update ||= self.o_auth_on_token_update
       o_auth_clock_skew ||= self.o_auth_clock_skew
 
-      BearerTokenCredentials.new(o_auth_client_id: o_auth_client_id,
-                                 o_auth_client_secret: o_auth_client_secret,
-                                 o_auth_token: o_auth_token,
-                                 o_auth_token_provider: o_auth_token_provider,
-                                 o_auth_on_token_update: o_auth_on_token_update,
-                                 o_auth_clock_skew: o_auth_clock_skew)
+      ClientCredentialsAuthCredentials.new(
+        o_auth_client_id: o_auth_client_id,
+        o_auth_client_secret: o_auth_client_secret, o_auth_token: o_auth_token,
+        o_auth_token_provider: o_auth_token_provider,
+        o_auth_on_token_update: o_auth_on_token_update,
+        o_auth_clock_skew: o_auth_clock_skew
+      )
     end
   end
 end

data/lib/shell_data_reporting_ap_is/http/http_call_back.rb

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

data/lib/shell_data_reporting_ap_is/http/http_method_enum.rb

@@ -1,7 +1,7 @@
 # shell_data_reporting_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellDataReportingApIs
   # HTTP Methods Enumeration.

data/lib/shell_data_reporting_ap_is/http/http_request.rb

@@ -1,7 +1,7 @@
 # shell_data_reporting_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellDataReportingApIs
   # Represents a single Http Request.

data/lib/shell_data_reporting_ap_is/http/http_response.rb

@@ -1,7 +1,7 @@
 # shell_data_reporting_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellDataReportingApIs
   # Http response received.

data/lib/shell_data_reporting_ap_is/http/proxy_settings.rb

@@ -0,0 +1,13 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ShellDataReportingApIs
+  ##
+  # ProxySettings encapsulates HTTP proxy configuration for Faraday,
+  # including optional basic authentication.
+  #
+  class ProxySettings < CoreLibrary::ProxySettings
+  end
+end

data/lib/shell_data_reporting_ap_is/models/account_access.rb

@@ -1,7 +1,7 @@
 # shell_data_reporting_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellDataReportingApIs
   # AccountAccess Model.
@@ -119,5 +119,22 @@ module ShellDataReportingApIs
                         account_number,
                         account_name)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} colco_id: #{@colco_id}, colco_code: #{@colco_code}, payer_id: #{@payer_id},"\
+      " payer_number: #{@payer_number}, payer_name: #{@payer_name}, account_id: #{@account_id},"\
+      " account_number: #{@account_number}, account_name: #{@account_name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} colco_id: #{@colco_id.inspect}, colco_code: #{@colco_code.inspect},"\
+      " payer_id: #{@payer_id.inspect}, payer_number: #{@payer_number.inspect}, payer_name:"\
+      " #{@payer_name.inspect}, account_id: #{@account_id.inspect}, account_number:"\
+      " #{@account_number.inspect}, account_name: #{@account_name.inspect}>"
+    end
   end
 end

data/lib/shell_data_reporting_ap_is/models/account_req.rb

@@ -0,0 +1,84 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ShellDataReportingApIs
+  # AccountReq Model.
+  class AccountReq < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [AccountRequest]
+    attr_accessor :filters
+
+    # Page Number (as shown to the users)
+    # @return [Integer]
+    attr_accessor :page
+
+    # Page Size – Number of records to show on a page.
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['filters'] = 'Filters'
+      @_hash['page'] = 'Page'
+      @_hash['page_size'] = 'PageSize'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        filters
+        page
+        page_size
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        page
+        page_size
+      ]
+    end
+
+    def initialize(filters = SKIP, page = 1, page_size = 50)
+      @filters = filters unless filters == SKIP
+      @page = page unless page == SKIP
+      @page_size = page_size unless page_size == 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.
+      filters = AccountRequest.from_hash(hash['Filters']) if hash['Filters']
+      page = hash['Page'] ||= 1
+      page_size = hash['PageSize'] ||= 50
+
+      # Create object from extracted values.
+      AccountReq.new(filters,
+                     page,
+                     page_size)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} filters: #{@filters}, page: #{@page}, page_size: #{@page_size}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} filters: #{@filters.inspect}, page: #{@page.inspect}, page_size:"\
+      " #{@page_size.inspect}>"
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/account_request.rb

@@ -1,7 +1,7 @@
 # shell_data_reporting_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellDataReportingApIs
   # AccountRequest Model.
@@ -75,7 +75,7 @@ module ShellDataReportingApIs
     # @return [TrueClass | FalseClass]
     attr_accessor :invoice_points_only
 
-    # Collecting Company Id (in GFN) of the selected payer. 
+    # Collecting Company Id  of the selected payer. 
     # Optional if ColCoCode or ColCoCountryCode  is passed else Mandatory.
     # @return [Integer]
     attr_accessor :col_co_id
@@ -239,5 +239,31 @@ module ShellDataReportingApIs
                          account_name,
                          status_list)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, include_card_summary: #{@include_card_summary},"\
+      " payer_id: #{@payer_id}, payer_number: #{@payer_number}, page_size: #{@page_size},"\
+      " request_id: #{@request_id}, col_co_code: #{@col_co_code}, col_co_country_code:"\
+      " #{@col_co_country_code}, current_page: #{@current_page}, invoice_points_only:"\
+      " #{@invoice_points_only}, col_co_id: #{@col_co_id}, return_tolls_customer_id:"\
+      " #{@return_tolls_customer_id}, accounts: #{@accounts}, account_name: #{@account_name},"\
+      " status_list: #{@status_list}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status.inspect}, include_card_summary:"\
+      " #{@include_card_summary.inspect}, payer_id: #{@payer_id.inspect}, payer_number:"\
+      " #{@payer_number.inspect}, page_size: #{@page_size.inspect}, request_id:"\
+      " #{@request_id.inspect}, col_co_code: #{@col_co_code.inspect}, col_co_country_code:"\
+      " #{@col_co_country_code.inspect}, current_page: #{@current_page.inspect},"\
+      " invoice_points_only: #{@invoice_points_only.inspect}, col_co_id: #{@col_co_id.inspect},"\
+      " return_tolls_customer_id: #{@return_tolls_customer_id.inspect}, accounts:"\
+      " #{@accounts.inspect}, account_name: #{@account_name.inspect}, status_list:"\
+      " #{@status_list.inspect}>"
+    end
   end
 end

data/lib/shell_data_reporting_ap_is/models/account_res.rb

@@ -0,0 +1,158 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ShellDataReportingApIs
+  # AccountRes Model.
+  class AccountRes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the request. This will be played back in the
+    # response from the request.
+    # @return [String]
+    attr_accessor :request_id
+
+    # Status of the request
+    # @return [String]
+    attr_accessor :status
+
+    # Status of the request
+    # @return [Array[AccountResponseAccountsItems]]
+    attr_accessor :data
+
+    # Current Page
+    # @return [Integer]
+    attr_accessor :page
+
+    # Total row count matched for the given input criteria
+    # @return [Integer]
+    attr_accessor :total_records
+
+    # Calculated page count based on page size from the incoming API request and
+    # total number of rows matched for the given input criteria. Return 1 if the
+    # page size is -1 as all records are returned.
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # Page Size – Number of records to show on current page.
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # A list of Warning entity. 
+    # This entity will hold the details of the scheduled System Outages of any
+    # dependent applications of this service.
+    # Note: If there is no scheduled outage information available, in the
+    # configuration in AMS, for this service, this parameter won’t be present in
+    # output.
+    # @return [Array[Warning]]
+    attr_accessor :warnings
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'RequestId'
+      @_hash['status'] = 'Status'
+      @_hash['data'] = 'Data'
+      @_hash['page'] = 'Page'
+      @_hash['total_records'] = 'TotalRecords'
+      @_hash['total_pages'] = 'TotalPages'
+      @_hash['page_size'] = 'PageSize'
+      @_hash['warnings'] = 'Warnings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+        data
+        page
+        total_records
+        total_pages
+        page_size
+        warnings
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP, status = SKIP, data = SKIP, page = SKIP,
+                   total_records = SKIP, total_pages = SKIP, page_size = SKIP,
+                   warnings = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == SKIP
+      @data = data unless data == SKIP
+      @page = page unless page == SKIP
+      @total_records = total_records unless total_records == SKIP
+      @total_pages = total_pages unless total_pages == SKIP
+      @page_size = page_size unless page_size == SKIP
+      @warnings = warnings unless warnings == 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.
+      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
+      data = nil
+      unless hash['Data'].nil?
+        data = []
+        hash['Data'].each do |structure|
+          data << (AccountResponseAccountsItems.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+      page = hash.key?('Page') ? hash['Page'] : SKIP
+      total_records = hash.key?('TotalRecords') ? hash['TotalRecords'] : SKIP
+      total_pages = hash.key?('TotalPages') ? hash['TotalPages'] : SKIP
+      page_size = hash.key?('PageSize') ? hash['PageSize'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      warnings = nil
+      unless hash['Warnings'].nil?
+        warnings = []
+        hash['Warnings'].each do |structure|
+          warnings << (Warning.from_hash(structure) if structure)
+        end
+      end
+
+      warnings = SKIP unless hash.key?('Warnings')
+
+      # Create object from extracted values.
+      AccountRes.new(request_id,
+                     status,
+                     data,
+                     page,
+                     total_records,
+                     total_pages,
+                     page_size,
+                     warnings)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} request_id: #{@request_id}, status: #{@status}, data: #{@data}, page:"\
+      " #{@page}, total_records: #{@total_records}, total_pages: #{@total_pages}, page_size:"\
+      " #{@page_size}, warnings: #{@warnings}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} request_id: #{@request_id.inspect}, status: #{@status.inspect}, data:"\
+      " #{@data.inspect}, page: #{@page.inspect}, total_records: #{@total_records.inspect},"\
+      " total_pages: #{@total_pages.inspect}, page_size: #{@page_size.inspect}, warnings:"\
+      " #{@warnings.inspect}>"
+    end
+  end
+end