card-management-sdk 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7f6cc3446161cd9718881bd3c51e6a0f654286c88174b06097c50b2b91f8a58
-  data.tar.gz: 8debe4b4ca20401b8725d6f3e8b121fd369fd72a52c802a799158bf58e83421b
+  metadata.gz: dad0e8970d49be89c8d49e010eb66702ecae47dca513b850b43da1128135fa97
+  data.tar.gz: ae34c0b7d3ae7ebaa5adf4c5e2d59e1dfe4407c8cec09b5a5fbb2b0b761768e7
 SHA512:
-  metadata.gz: ee3a12824e50f9d27f499148526813b922d1e7b2e10e74c670ed978788a3570ecc490da48703aa966e9cd72e3edca3737a5ee2b02865afa61554fd82e904b9a3
-  data.tar.gz: ae412f28fe47ffefaf60a55ade3f6c0802ed7e69deedaa6ad54277b50feaabc1b642fc629ae7e30ca7601a80c32f68a8304175cc6d1be2fb266abac82fa0bc34
+  metadata.gz: 06a1e8d1f8e704631626d9ea7ab277e66627b40a386d805870a8a076fc16decdcfc1a0cd43257d7935f94c27906d6579561ee9e710b6c0829c49f4d9acc833a7
+  data.tar.gz: 709b223f2690ef31c22eac6ce38db59275c429050893c2e2da13ed6f19711ad4db535b1e5e8b116d9c1fca5c033ad8b4cb5d5eae8bdd56cc7ae1e228ca7cb76b

data/README.md

@@ -3,11 +3,13 @@
 
 ## Introduction
 
-The Shell Card Management API is REST-based and employs OAUTH 2.0,Basic and ApiKey authentication.
-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.
-The internal workings of the platform are not important when interacting with the API. However, it is worth noting that the platform uses a microservice architecture to communicate with various backend systems and some API calls are processed asynchronously.
-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 Management API provides secure and structured access to the Shell Card Platform, enabling integration with Shell’s internal systems for managing card-related resources.
+
+This REST-based API uses the POST method for all operations—including retrieval, creation, update, and deletion of resources. It supports flexible search capabilities through JSON-encoded request bodies and returns JSON-formatted responses. Standard HTTP status codes are used to indicate the outcome of each request.
+
+Authentication is handled via OAuth 2.0 using the Client Credentials flow. Access tokens must be included in the Authorization header of each request.
+
+All resources are managed within the Shell Card Platform, which abstracts the complexity of backend systems. Some operations may be processed asynchronously, and clients should be prepared to handle delayed responses or polling mechanisms where applicable.
 
 Go to the Shell Developer Portal: [https://developer.shell.com](https://developer.shell.com)
 
@@ -16,47 +18,54 @@ Go to the Shell Developer Portal: [https://developer.shell.com](https://develope
 Install the gem from the command line:
 
 ```bash
-gem install card-management-sdk -v 1.4.0
+gem install card-management-sdk -v 2.0.0
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'card-management-sdk', '1.4.0'
+gem 'card-management-sdk', '2.0.0'
 ```
 
-For additional gem details, see the [RubyGems page for the card-management-sdk gem](https://rubygems.org/gems/card-management-sdk/versions/1.4.0).
+For additional gem details, see the [RubyGems page for the card-management-sdk gem](https://rubygems.org/gems/card-management-sdk/versions/2.0.0).
+
+## Test the SDK
+
+To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:
+
+```
+rake
+```
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.4.0/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/card-management-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/card-management-ruby-sdk/tree/1.4.0/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
-| `bearer_token_credentials` | [`BearerTokenCredentials`](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.4.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/card-management-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/card-management-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 = ShellCardManagementApIs::Client.new(
-  basic_auth_credentials: BasicAuthCredentials.new(
-    username: 'Username',
-    password: 'Password'
-  ),
-  bearer_token_credentials: BearerTokenCredentials.new(
+require 'shell_card_management_ap_is'
+include ShellCardManagementApIs
+
+client = Client.new(
+  client_credentials_auth_credentials: ClientCredentialsAuthCredentials.new(
     o_auth_client_id: 'OAuthClientId',
     o_auth_client_secret: 'OAuthClientSecret'
   ),
@@ -79,18 +88,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/card-management-ruby-sdk/tree/1.4.0/doc/auth/basic-authentication.md)
-* [`BearerToken (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.4.0/doc/auth/oauth-2-client-credentials-grant.md)
+* [`BearerToken (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/2.0.0/doc/auth/oauth-2-client-credentials-grant.md)
 
 ## List of APIs
 
-* [Customer](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.4.0/doc/controllers/customer.md)
-* [Restriction](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.4.0/doc/controllers/restriction.md)
-* [Card](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.4.0/doc/controllers/card.md)
+* [Customer](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/2.0.0/doc/controllers/customer.md)
+* [Restriction](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/2.0.0/doc/controllers/restriction.md)
+* [Card](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/2.0.0/doc/controllers/card.md)
 
-## Classes Documentation
+## SDK Infrastructure
 
-* [Utility Classes](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.4.0/doc/utility-classes.md)
-* [HttpResponse](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.4.0/doc/http-response.md)
-* [HttpRequest](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/1.4.0/doc/http-request.md)
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/2.0.0/doc/proxy-settings.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/2.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/2.0.0/doc/http-request.md)
+
+### Utilities
+
+* [ApiHelper](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/2.0.0/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/card-management-ruby-sdk/tree/2.0.0/doc/date-time-helper.md)
 

data/lib/shell_card_management_ap_is/api_helper.rb

@@ -1,7 +1,7 @@
 # shell_card_management_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 ShellCardManagementApIs
   # API utility class

data/lib/shell_card_management_ap_is/client.rb

@@ -1,7 +1,7 @@
 # shell_card_management_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 ShellCardManagementApIs
   #  shell_card_management_ap_is client class.
@@ -42,9 +42,9 @@ module ShellCardManagementApIs
       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 ShellCardManagementApIs
                     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 ShellCardManagementApIs
     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_card_management_ap_is/configuration.rb

@@ -1,7 +1,7 @@
 # shell_card_management_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 ShellCardManagementApIs
   # An enum for SDK environments.
@@ -24,7 +24,7 @@ module ShellCardManagementApIs
   # 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 ShellCardManagementApIs
       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 ShellCardManagementApIs
     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 ShellCardManagementApIs
       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_card_management_ap_is/controllers/base_controller.rb

@@ -1,7 +1,7 @@
 # shell_card_management_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 ShellCardManagementApIs
   # BaseController.
@@ -26,13 +26,7 @@ module ShellCardManagementApIs
       @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.