data-and-reporting-sdk 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 031356f55355649745088ded676766dd0c8f982f6e4d740a8979f326191f977d
-  data.tar.gz: e2ed061fda9bc950ea7add678935bad2114cd314a37e9475274632499567b231
+  metadata.gz: '029daa034be160955c29be965509aadc2b080bfb587f24225b26b144b774b258'
+  data.tar.gz: 1c7f87bb1def847aba87695075112c83f91414b7998d1d55f313c61af7fc28b4
 SHA512:
-  metadata.gz: 6011a74f2cfcb42eef0b02ef087a2b1665d3d1d18eb48e9bfb236ad41909e07b02c199a1ad8a15d9ad9061227b5f8b5ba23d08888531c31533b19c55ded48d31
-  data.tar.gz: bce0d017e652d317d75a1a19e50dc48f8278761166f63df102745bb48448881e73d179d0fbb5268f256e3fb653383259f430ca2936399ea439433b03403ccfa0
+  metadata.gz: a3ab34fbd35187ac36a8442076cb6cf9cd0afc01a0b870074e0d4308c650996ed4f36d810ef84b883bb23d80c176d0ce6a9112dce5cda7af2a5104f0ed49242d
+  data.tar.gz: e6ada66e602acf2b3edaf55ea8b6c248bf9354cb58c215daab2297962b3435aa8db98e799d50b4681893d27b3af2027faaeb65d0c2627f064522a9758ddc330e

data/README.md

@@ -3,10 +3,33 @@
 
 ## Introduction
 
-Data And Reporting product consists of API's which provides details of transaction and invoice informations about shell cards.
-The Shell Card Transaction and Invoice API is REST-based and employs Basic authentication in Version 1 and Oauth authentication in Version 2 end points. The API endpoints accept JSON-encoded request bodies, return JSON-encoded responses and use standard HTTP response codes.
-All resources are located in the Shell Card Platform.  The Shell Card Platform is the overall platform that encompasses all the internal Shell systems used to manage resources.
-All endpoints use the `POST` verb for retrieving, updating, creating and deleting resources in the Shell Card Platform. The endpoints that retrieve resources from the Shell Card Platform allow flexible search parameters in the API request body.
+The Shell Card Transaction and Invoice API is part of the Data and Reporting product suite, designed to provide secure and flexible access to transaction and invoice data related to Shell Cards.
+
+### Authentication
+
+- OAuth 2.0 Authentication.
+
+### Architecture
+
+- RESTful API design.
+- All endpoints use the `POST` HTTP method for all operations including retrieval, creation, update, and deletion of resources.
+- Requests and responses are encoded in JSON format.
+- Standard HTTP status codes are used for response handling.
+
+### Platform
+
+- All resources are managed within the **Shell Card Platform**, which integrates multiple internal Shell systems for resource management.
+
+### Features
+
+- Flexible search parameters supported in the request body for data retrieval.
+- Designed for integration with enterprise systems requiring Shell Card transaction and invoice data.
+
+### Use Cases
+
+- Retrieve detailed transaction history for Shell Cards.
+- Access invoice summaries and line-item details.
+- Integrate Shell Card financial data into internal reporting tools.
 
 Go to the Shell Developer Portal: [https://developer.shell.com](https://developer.shell.com)
 
@@ -15,16 +38,16 @@ Go to the Shell Developer Portal: [https://developer.shell.com](https://develope
 Install the gem from the command line:
 
 ```bash
-gem install data-and-reporting-sdk -v 1.3.0
+gem install data-and-reporting-sdk -v 2.0.0
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'data-and-reporting-sdk', '1.3.0'
+gem 'data-and-reporting-sdk', '2.0.0'
 ```
 
-For additional gem details, see the [RubyGems page for the data-and-reporting-sdk gem](https://rubygems.org/gems/data-and-reporting-sdk/versions/1.3.0).
+For additional gem details, see the [RubyGems page for the data-and-reporting-sdk gem](https://rubygems.org/gems/data-and-reporting-sdk/versions/2.0.0).
 
 ## Test the SDK
 
@@ -36,34 +59,33 @@ rake
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.3.0/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/2.0.0/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| `environment` | `Environment` | The API environment. <br> **Default: `Environment.SIT`** |
-| `connection` | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
-| `adapter` | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
-| `timeout` | `Float` | The value to use for connection timeout. <br> **Default: 60** |
-| `max_retries` | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
-| `retry_interval` | `Float` | Pause in seconds between retries. <br> **Default: 1** |
-| `backoff_factor` | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
-| `retry_statuses` | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
-| `retry_methods` | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
-| `http_callback` | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
-| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.3.0/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
-| `bearer_token_credentials` | [`BearerTokenCredentials`](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.3.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+| environment | `Environment` | The API environment. <br> **Default: `Environment.SIT`** |
+| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| timeout | `Float` | The value to use for connection timeout. <br> **Default: 60** |
+| max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/2.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| client_credentials_auth_credentials | [`ClientCredentialsAuthCredentials`](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/2.0.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
 
 The API client can be initialized as follows:
 
 ```ruby
-client = ShellDataReportingApIs::Client.new(
-  basic_auth_credentials: BasicAuthCredentials.new(
-    username: 'Username',
-    password: 'Password'
-  ),
-  bearer_token_credentials: BearerTokenCredentials.new(
+require 'shell_data_reporting_ap_is'
+include ShellDataReportingApIs
+
+client = Client.new(
+  client_credentials_auth_credentials: ClientCredentialsAuthCredentials.new(
     o_auth_client_id: 'OAuthClientId',
     o_auth_client_secret: 'OAuthClientSecret'
   ),
@@ -86,18 +108,27 @@ The SDK can be configured to use a different environment for making API calls. A
 
 This API uses the following authentication schemes.
 
-* [`BasicAuth (Basic Authentication)`](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.3.0/doc/auth/basic-authentication.md)
-* [`BearerToken (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.3.0/doc/auth/oauth-2-client-credentials-grant.md)
+* [`BearerToken (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/2.0.0/doc/auth/oauth-2-client-credentials-grant.md)
 
 ## List of APIs
 
-* [Customer](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.3.0/doc/controllers/customer.md)
-* [Transaction](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.3.0/doc/controllers/transaction.md)
-* [Invoice](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.3.0/doc/controllers/invoice.md)
+* [Customer](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/2.0.0/doc/controllers/customer.md)
+* [Transaction](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/2.0.0/doc/controllers/transaction.md)
+* [Invoice](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/2.0.0/doc/controllers/invoice.md)
 
-## Classes Documentation
+## SDK Infrastructure
 
-* [Utility Classes](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.3.0/doc/utility-classes.md)
-* [HttpResponse](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.3.0/doc/http-response.md)
-* [HttpRequest](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.3.0/doc/http-request.md)
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/2.0.0/doc/proxy-settings.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/2.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/2.0.0/doc/http-request.md)
+
+### Utilities
+
+* [ApiHelper](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/2.0.0/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/2.0.0/doc/date-time-helper.md)
 

data/lib/shell_data_reporting_ap_is/api_helper.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
   # API utility class

data/lib/shell_data_reporting_ap_is/client.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
   #  shell_data_reporting_ap_is client class.
@@ -42,9 +42,9 @@ module ShellDataReportingApIs
       connection: nil, adapter: :net_http_persistent, timeout: 60,
       max_retries: 0, retry_interval: 1, backoff_factor: 2,
       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
-      retry_methods: %i[get put], http_callback: nil,
-      environment: Environment::SIT, basic_auth_credentials: nil,
-      bearer_token_credentials: nil, config: nil
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      environment: Environment::SIT, client_credentials_auth_credentials: nil,
+      config: nil
     )
       @config = if config.nil?
                   Configuration.new(
@@ -53,9 +53,8 @@ module ShellDataReportingApIs
                     backoff_factor: backoff_factor,
                     retry_statuses: retry_statuses,
                     retry_methods: retry_methods, http_callback: http_callback,
-                    environment: environment,
-                    basic_auth_credentials: basic_auth_credentials,
-                    bearer_token_credentials: bearer_token_credentials
+                    proxy_settings: proxy_settings, environment: environment,
+                    client_credentials_auth_credentials: client_credentials_auth_credentials
                   )
                 else
                   config
@@ -75,10 +74,10 @@ module ShellDataReportingApIs
     def initialize_auth_managers(global_config)
       @auth_managers = {}
       http_client_config = global_config.client_configuration
-      %w[BasicAuth BearerToken].each { |auth| @auth_managers[auth] = nil }
-      @auth_managers['BasicAuth'] = BasicAuth.new(http_client_config.basic_auth_credentials)
-      @auth_managers['BearerToken'] = BearerToken.new(http_client_config.bearer_token_credentials,
-                                                      global_config)
+      %w[BearerToken].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['BearerToken'] = OAuth2.new(
+        http_client_config.client_credentials_auth_credentials, global_config
+      )
     end
   end
 end

data/lib/shell_data_reporting_ap_is/configuration.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
   # An enum for SDK environments.
@@ -24,7 +24,7 @@ module ShellDataReportingApIs
   # are configured in this class.
   class Configuration < CoreLibrary::HttpClientConfiguration
     # The attribute readers for properties.
-    attr_reader :environment, :basic_auth_credentials, :bearer_token_credentials
+    attr_reader :environment, :client_credentials_auth_credentials
 
     class << self
       attr_reader :environments
@@ -34,24 +34,23 @@ module ShellDataReportingApIs
       connection: nil, adapter: :net_http_persistent, timeout: 60,
       max_retries: 0, retry_interval: 1, backoff_factor: 2,
       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
-      retry_methods: %i[get put], http_callback: nil,
-      environment: Environment::SIT, basic_auth_credentials: nil,
-      bearer_token_credentials: nil
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      environment: Environment::SIT, client_credentials_auth_credentials: nil
     )
-
       super connection: connection, adapter: adapter, timeout: timeout,
             max_retries: max_retries, retry_interval: retry_interval,
             backoff_factor: backoff_factor, retry_statuses: retry_statuses,
-            retry_methods: retry_methods, http_callback: http_callback
+            retry_methods: retry_methods, http_callback: http_callback,
+            proxy_settings: proxy_settings
 
       # Current API environment
       @environment = String(environment)
 
-      # The object holding Basic Authentication credentials
-      @basic_auth_credentials = basic_auth_credentials
-
       # The object holding OAuth 2 Client Credentials Grant credentials
-      @bearer_token_credentials = bearer_token_credentials
+      @client_credentials_auth_credentials = client_credentials_auth_credentials
+
+      # Initializing OAuth 2 Client Credentials Grant credentials with the provided auth parameters
+      @client_credentials_auth_credentials = client_credentials_auth_credentials
 
       # The Http Client to use for making requests.
       set_http_client CoreLibrary::FaradayClient.new(self)
@@ -60,8 +59,8 @@ module ShellDataReportingApIs
     def clone_with(connection: nil, adapter: nil, timeout: nil,
                    max_retries: nil, retry_interval: nil, backoff_factor: nil,
                    retry_statuses: nil, retry_methods: nil, http_callback: nil,
-                   environment: nil, basic_auth_credentials: nil,
-                   bearer_token_credentials: nil)
+                   proxy_settings: nil, environment: nil,
+                   client_credentials_auth_credentials: nil)
       connection ||= self.connection
       adapter ||= self.adapter
       timeout ||= self.timeout
@@ -71,19 +70,18 @@ module ShellDataReportingApIs
       retry_statuses ||= self.retry_statuses
       retry_methods ||= self.retry_methods
       http_callback ||= self.http_callback
+      proxy_settings ||= self.proxy_settings
       environment ||= self.environment
-      basic_auth_credentials ||= self.basic_auth_credentials
-      bearer_token_credentials ||= self.bearer_token_credentials
+      client_credentials_auth_credentials ||= self.client_credentials_auth_credentials
 
-      Configuration.new(connection: connection, adapter: adapter,
-                        timeout: timeout, max_retries: max_retries,
-                        retry_interval: retry_interval,
-                        backoff_factor: backoff_factor,
-                        retry_statuses: retry_statuses,
-                        retry_methods: retry_methods,
-                        http_callback: http_callback, environment: environment,
-                        basic_auth_credentials: basic_auth_credentials,
-                        bearer_token_credentials: bearer_token_credentials)
+      Configuration.new(
+        connection: connection, adapter: adapter, timeout: timeout,
+        max_retries: max_retries, retry_interval: retry_interval,
+        backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+        retry_methods: retry_methods, http_callback: http_callback,
+        proxy_settings: proxy_settings, environment: environment,
+        client_credentials_auth_credentials: client_credentials_auth_credentials
+      )
     end
 
 

data/lib/shell_data_reporting_ap_is/controllers/base_controller.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
   # BaseController.
@@ -26,13 +26,7 @@ module ShellDataReportingApIs
       @global_configuration = global_configuration
       @config = @global_configuration.client_configuration
       @http_call_back = @config.http_callback
-      @api_call = ApiCall.new(@global_configuration)
-    end
-
-    # Creates a new builder for the Api Call instance.
-    # @return [ApiCall] The instance of ApiCall.
-    def new_api_call_builder
-      @api_call.new_builder
+      @api_call = ApiCall.new(@global_configuration)
     end
 
     # Creates a new instance of the request builder.