data-and-reporting-sdk 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b2e3ac6fdcee464dda4b015df821bd82659abbfac4adccd37a85e0c5da9d99a
-  data.tar.gz: ac9d67d4238e3837cce64b4b40eafc7a255ebc3544a62ea30c09ed4e777e57e0
+  metadata.gz: d03ff99147838113626eae4d7d2e2cc1cbee9fb169d4b36926d3a45cbd933ce0
+  data.tar.gz: e8d1943099145c20eb647fd2a5911c4a963095a0f095a1c73d6f0ae2baa10da9
 SHA512:
-  metadata.gz: 833fef79a392f620cd7fd9912c529ec0b943978aca14e34da469acccc5f119ad19132ed5adc45ce46df3470477de1d020a80f0dacfbf5f263fc56d6b168caeac
-  data.tar.gz: eb08d34e5e367da1d11abb93a37b4fa9c96507031bc3fe3b1d2569d14142fe53eccb566fd9e47425bf822437d6996bd797980001fd1764acb8a25228074982d5
+  metadata.gz: 609b1c17dbdd02c4ece7489c8e7759aa86799f2fb37ac8a3164ebc32c51e1f332a045dd77048ef7fedf8030542a512148bf9abb36e92c82195818132d4a9524a
+  data.tar.gz: 9dd7941a481edb65ac177b0308b5cf0f429ca4cdd0401777953e336e10aedd773ac7c6c06d6f29d600f80325debd7c6f753c1798828da3f948b04ec8bb15f176

data/README.md

@@ -14,17 +14,17 @@ Go to the Shell Developer Portal: [https://developer.shell.com](https://develope
 
 Install the gem from the command line:
 
-```ruby
-gem install data-and-reporting-sdk -v 1.0.0
+```bash
+gem install data-and-reporting-sdk -v 1.2.0
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'data-and-reporting-sdk', '1.0.0'
+gem 'data-and-reporting-sdk', '1.2.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.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.2.0).
 
 ## Test the SDK
 
@@ -36,7 +36,7 @@ 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.0.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/1.2.0/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
@@ -52,8 +52,8 @@ The following parameters are configurable for the API Client:
 | `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.0.0/doc/$a/https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.0.0/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.0.0/doc/$a/https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.0.0/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.2.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.2.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:
 
@@ -86,19 +86,18 @@ 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.0.0/doc/$a/https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.0.0/basic-authentication.md)
-* [`BearerToken (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.0.0/oauth-2-client-credentials-grant.md)
+* [`BasicAuth (Basic Authentication)`](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.2.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.2.0/doc/auth/oauth-2-client-credentials-grant.md)
 
 ## List of APIs
 
-* [O Auth Authorization](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.0.0/doc/controllers/o-auth-authorization.md)
-* [Customer](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.0.0/doc/controllers/customer.md)
-* [Transaction](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.0.0/doc/controllers/transaction.md)
-* [Invoice](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.0.0/doc/controllers/invoice.md)
+* [Customer](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.2.0/doc/controllers/customer.md)
+* [Transaction](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.2.0/doc/controllers/transaction.md)
+* [Invoice](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.2.0/doc/controllers/invoice.md)
 
 ## Classes Documentation
 
-* [Utility Classes](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.0.0/doc/utility-classes.md)
-* [HttpResponse](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.0.0/doc/http-response.md)
-* [HttpRequest](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.0.0/doc/http-request.md)
+* [Utility Classes](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.2.0/doc/utility-classes.md)
+* [HttpResponse](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.2.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/data-and-reporting-ruby-sdk/tree/1.2.0/doc/http-request.md)
 

data/lib/shell_data_reporting_ap_is/controllers/base_controller.rb

@@ -30,15 +30,15 @@ module ShellDataReportingApIs
     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
-    end
-
-    # Creates a new instance of the request builder.
-    # @param [String] http_method The HTTP method to use in the request.
-    # @param [String] path The endpoint path to use in the request.
-    # @param [String] server The server to extract the base uri for the request.
+    # @return [ApiCall] The instance of ApiCall.
+    def new_api_call_builder
+      @api_call.new_builder
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
     # @return [RequestBuilder] The instance of RequestBuilder.
     def new_request_builder(http_method, path, server)
       RequestBuilder.new