RubyGems - fortis-apimatic-sdk - Versions diffs - 1.0.2 → 1.0.3 - Mend

fortis-apimatic-sdk 1.0.2 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (810) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d3b3ce7b5de74f27b4506dea12d4533f10255f5262c726efb0776ecba67e206
-  data.tar.gz: 437e8776f8a9b6d9bc9ce48f95475d7733e1059ea1ccc003e1c8ba77344944d7
+  metadata.gz: c8bbb92c7c0b1f9818e03f0ae21cdff9c7e7cb05fb4d063f57a33ddb21f06fec
+  data.tar.gz: 4ce30cc03118b9b53e8f0f67c713bcc2e848e5286b32d1b00b0ffe7ee0815f16
 SHA512:
-  metadata.gz: d0b0994aaa3e5a9c8b0a394b02dc71095f81e84861c5fe34ba359cde156edb2fc6d184fcf8948be318c146e0c59a78264f61333cc54e98fb711872da7ba77789
-  data.tar.gz: fe2538fbb01b2788c2ba15317d4f9af3ffde969106eae3310a882909da9614fc32e64a2daf9e7f47ce7c4e986e5b34c299b60c5bc22e4539f450da6ad70b6ea2
+  metadata.gz: ed897102ecc36351d1bb3127b11992fdb3915d8432c19c8a9974cfa805807e6d5b51efc88e2c220c7b98885b0a020c14282c7a407c639e7c7da2b649f13e01f1
+  data.tar.gz: 67e228b645ef8d1865e7b702ad1c6e7255c7fb2450eaf42b63d45c5a622fd88a48112f3b6b96235f6cae7201e4e54ce59031b5fa5d24726cbfe56c9d552d8294

data/README.md CHANGED Viewed

@@ -6,16 +6,16 @@
 Install the gem from the command line:
 ```bash
-gem install fortis-apimatic-sdk -v 1.0.2
+gem install fortis-apimatic-sdk -v 1.0.3
 ```
 Or add the gem to your Gemfile and run `bundle`:
 ```ruby
-gem 'fortis-apimatic-sdk', '1.0.2'
+gem 'fortis-apimatic-sdk', '1.0.3'
 ```
-For additional gem details, see the [RubyGems page for the fortis-apimatic-sdk gem](https://rubygems.org/gems/fortis-apimatic-sdk/versions/1.0.2).
+For additional gem details, see the [RubyGems page for the fortis-apimatic-sdk gem](https://rubygems.org/gems/fortis-apimatic-sdk/versions/1.0.3).
 ## IRB Console Usage
@@ -52,23 +52,15 @@ ruby bin/console
 **_Note:_** This automatically loads the SDK from lib/
-## 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/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/client.md)
 The following parameters are configurable for the API Client:
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| environment | [`Environment`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/README.md#environments) | The API environment. <br> **Default: `Environment.SANDBOX`** |
+| environment | [`Environment`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION`** |
 | 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** |
@@ -78,11 +70,12 @@ 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. |
-| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
-| user_id_credentials | [`UserIdCredentials`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
-| user_api_key_credentials | [`UserApiKeyCredentials`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/auth/custom-header-signature-1.md) | The credential object for Custom Header Signature |
-| developer_id_credentials | [`DeveloperIdCredentials`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/auth/custom-header-signature-2.md) | The credential object for Custom Header Signature |
-| access_token_credentials | [`AccessTokenCredentials`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/auth/custom-header-signature-3.md) | The credential object for Custom Header Signature |
+| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| user_id_credentials | [`UserIdCredentials`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
+| user_api_key_credentials | [`UserApiKeyCredentials`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/auth/custom-header-signature-1.md) | The credential object for Custom Header Signature |
+| developer_id_credentials | [`DeveloperIdCredentials`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/auth/custom-header-signature-2.md) | The credential object for Custom Header Signature |
+| access_token_credentials | [`AccessTokenCredentials`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/auth/custom-header-signature-3.md) | The credential object for Custom Header Signature |
 The API client can be initialized as follows:
@@ -105,7 +98,16 @@ client = Client.new(
   access_token_credentials: AccessTokenCredentials.new(
     access_token: 'access-token'
   ),
-  environment: Environment::SANDBOX
+  environment: Environment::PRODUCTION,
+  logging_configuration: LoggingConfiguration.new(
+    log_level: Logger::INFO,
+    request_logging_config: RequestLoggingConfiguration.new(
+      log_body: true
+    ),
+    response_logging_config: ResponseLoggingConfiguration.new(
+      log_headers: true
+    )
+  )
 )
 ```
@@ -119,7 +121,7 @@ include FortisApi
 client = Client.from_env
 ```
-See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/environment-based-client-initialization.md) section for details.
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/environment-based-client-initialization.md) section for details.
 ## Environments
@@ -129,69 +131,74 @@ The SDK can be configured to use a different environment for making API calls. A
 | Name | Description |
 |  --- | --- |
-| SANDBOX | **Default** |
-| PRODUCTION | - |
+| PRODUCTION | **Default** |
+| ENVIRONMENT2 | - |
 ## Authorization
 This API uses the following authentication schemes.
-* [`user-id (Custom Header Signature)`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/auth/custom-header-signature.md)
-* [`user-api-key (Custom Header Signature)`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/auth/custom-header-signature-1.md)
-* [`developer-id (Custom Header Signature)`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/auth/custom-header-signature-2.md)
-* [`access-token (Custom Header Signature)`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/auth/custom-header-signature-3.md)
+* [`user-id (Custom Header Signature)`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/auth/custom-header-signature.md)
+* [`user-api-key (Custom Header Signature)`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/auth/custom-header-signature-1.md)
+* [`developer-id (Custom Header Signature)`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/auth/custom-header-signature-2.md)
+* [`access-token (Custom Header Signature)`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/auth/custom-header-signature-3.md)
 ## List of APIs
-* [Async Processing](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/async-processing.md)
-* [Declined Recurring Transactions](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/declined-recurring-transactions.md)
-* [Device Terms](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/device-terms.md)
-* [Full Boarding](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/full-boarding.md)
-* [3 DS Authentication](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/3-ds-authentication.md)
-* [3 DS Transactions](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/3-ds-transactions.md)
-* [Merchant Deposits](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/merchant-deposits.md)
-* [On Boarding](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/on-boarding.md)
-* [Payment Card Reader Token](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/payment-card-reader-token.md)
-* [Quick Invoices](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/quick-invoices.md)
-* [Transaction ACH Retries](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/transaction-ach-retries.md)
-* [Transactions-ACH](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/transactions-ach.md)
-* [Transactions-Cash](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/transactions-cash.md)
-* [Transactions-Credit Card](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/transactions-credit-card.md)
-* [Transactions-EBT Card](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/transactions-ebt-card.md)
-* [Transactions-Read](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/transactions-read.md)
-* [Level 3 Data](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/level-3-data.md)
-* [Transactions-Updates](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/transactions-updates.md)
-* [User Verifications](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/user-verifications.md)
-* [Apple Pay Validate Merchant](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/apple-pay-validate-merchant.md)
-* [Merchant Details](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/merchant-details.md)
-* [Batches](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/batches.md)
-* [Contacts](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/contacts.md)
-* [Elements](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/elements.md)
-* [Locations](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/locations.md)
-* [Paylinks](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/paylinks.md)
-* [Recurring](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/recurring.md)
-* [Signatures](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/signatures.md)
-* [Tags](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/tags.md)
-* [Terminals](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/terminals.md)
-* [Tickets](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/tickets.md)
-* [Tokens](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/tokens.md)
-* [Users](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/users.md)
-* [Webhooks](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/webhooks.md)
+* [Async Processing](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/async-processing.md)
+* [Declined Recurring Transactions](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/declined-recurring-transactions.md)
+* [Device Terms](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/device-terms.md)
+* [Full Boarding](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/full-boarding.md)
+* [3 DS Authentication](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/3-ds-authentication.md)
+* [3 DS Transactions](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/3-ds-transactions.md)
+* [Merchant Deposits](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/merchant-deposits.md)
+* [On Boarding](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/on-boarding.md)
+* [Payment Card Reader Token](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/payment-card-reader-token.md)
+* [Quick Invoices](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/quick-invoices.md)
+* [Transaction ACH Retries](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/transaction-ach-retries.md)
+* [Transactions-ACH](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/transactions-ach.md)
+* [Transactions-Cash](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/transactions-cash.md)
+* [Transactions-Credit Card](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/transactions-credit-card.md)
+* [Transactions-EBT Card](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/transactions-ebt-card.md)
+* [Transactions-Read](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/transactions-read.md)
+* [Level 3 Data](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/level-3-data.md)
+* [Transactions-Updates](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/transactions-updates.md)
+* [User Verifications](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/user-verifications.md)
+* [Apple Pay Validate Merchant](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/apple-pay-validate-merchant.md)
+* [Merchant Details](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/merchant-details.md)
+* [Batches](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/batches.md)
+* [Contacts](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/contacts.md)
+* [Elements](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/elements.md)
+* [Locations](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/locations.md)
+* [Paylinks](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/paylinks.md)
+* [Recurring](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/recurring.md)
+* [Signatures](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/signatures.md)
+* [Tags](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/tags.md)
+* [Terminals](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/terminals.md)
+* [Tickets](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/tickets.md)
+* [Tokens](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/tokens.md)
+* [Users](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/users.md)
+* [Webhooks](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/controllers/webhooks.md)
 ## SDK Infrastructure
 ### Configuration
-* [ProxySettings](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/proxy-settings.md)
-* [Environment-Based Client Initialization](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/environment-based-client-initialization.md)
+* [ProxySettings](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/response-logging-configuration.md)
 ### HTTP
-* [HttpResponse](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/http-response.md)
-* [HttpRequest](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/http-request.md)
+* [HttpResponse](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/http-request.md)
 ### Utilities
-* [ApiHelper](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/api-helper.md)
-* [DateTimeHelper](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/date-time-helper.md)
+* [ApiResponse](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.3/doc/date-time-helper.md)

data/lib/fortis_api/client.rb CHANGED Viewed

@@ -62,15 +62,15 @@ module FortisApi
     end
     # Access to m3_ds_authentication controller.
-    # @return [M3DSAuthenticationController] Returns the controller instance.
+    # @return [M3DsAuthenticationController] Returns the controller instance.
     def m3_ds_authentication
-      @m3_ds_authentication ||= M3DSAuthenticationController.new @global_configuration
+      @m3_ds_authentication ||= M3DsAuthenticationController.new @global_configuration
     end
     # Access to m3_ds_transactions controller.
-    # @return [M3DSTransactionsController] Returns the controller instance.
+    # @return [M3DsTransactionsController] Returns the controller instance.
     def m3_ds_transactions
-      @m3_ds_transactions ||= M3DSTransactionsController.new @global_configuration
+      @m3_ds_transactions ||= M3DsTransactionsController.new @global_configuration
     end
     # Access to merchant_deposits controller.
@@ -140,15 +140,15 @@ module FortisApi
     end
     # Access to transaction_ach_retries controller.
-    # @return [TransactionACHRetriesController] Returns the controller instance.
+    # @return [TransactionAchRetriesController] Returns the controller instance.
     def transaction_ach_retries
-      @transaction_ach_retries ||= TransactionACHRetriesController.new @global_configuration
+      @transaction_ach_retries ||= TransactionAchRetriesController.new @global_configuration
     end
     # Access to transactions_ach controller.
-    # @return [TransactionsACHController] Returns the controller instance.
+    # @return [TransactionsAchController] Returns the controller instance.
     def transactions_ach
-      @transactions_ach ||= TransactionsACHController.new @global_configuration
+      @transactions_ach ||= TransactionsAchController.new @global_configuration
     end
     # Access to transactions_cash controller.
@@ -164,9 +164,9 @@ module FortisApi
     end
     # Access to transactions_ebt_card controller.
-    # @return [TransactionsEBTCardController] Returns the controller instance.
+    # @return [TransactionsEbtCardController] Returns the controller instance.
     def transactions_ebt_card
-      @transactions_ebt_card ||= TransactionsEBTCardController.new @global_configuration
+      @transactions_ebt_card ||= TransactionsEbtCardController.new @global_configuration
     end
     # Access to transactions_read controller.
@@ -222,9 +222,9 @@ module FortisApi
       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, proxy_settings: nil,
-      environment: Environment::SANDBOX, user_id_credentials: nil,
-      user_api_key_credentials: nil, developer_id_credentials: nil,
-      access_token_credentials: nil, config: nil
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      user_id_credentials: nil, user_api_key_credentials: nil,
+      developer_id_credentials: nil, access_token_credentials: nil, config: nil
     )
       @config = if config.nil?
                   Configuration.new(
@@ -233,7 +233,9 @@ module FortisApi
                     backoff_factor: backoff_factor,
                     retry_statuses: retry_statuses,
                     retry_methods: retry_methods, http_callback: http_callback,
-                    proxy_settings: proxy_settings, environment: environment,
+                    proxy_settings: proxy_settings,
+                    logging_configuration: logging_configuration,
+                    environment: environment,
                     user_id_credentials: user_id_credentials,
                     user_api_key_credentials: user_api_key_credentials,
                     developer_id_credentials: developer_id_credentials,
@@ -242,11 +244,13 @@ module FortisApi
                 else
                   config
                 end
+      user_agent_params = BaseController.user_agent_parameters
       @global_configuration = GlobalConfiguration.new(client_configuration: @config)
                                                  .base_uri_executor(@config.method(:get_base_uri))
                                                  .global_errors(BaseController::GLOBAL_ERRORS)
-                                                 .user_agent(BaseController.user_agent)
+                                                 .user_agent(BaseController.user_agent,
+                                                             agent_parameters: user_agent_params)
       initialize_auth_managers(@global_configuration)
       @global_configuration = @global_configuration.auth_managers(@auth_managers)

data/lib/fortis_api/configuration.rb CHANGED Viewed

@@ -7,18 +7,18 @@ module FortisApi
   # An enum for SDK environments.
   class Environment
     ENVIRONMENT = [
-      SANDBOX = 'sandbox'.freeze,
-      PRODUCTION = 'production'.freeze
+      PRODUCTION = 'production'.freeze,
+      ENVIRONMENT2 = 'environment2'.freeze
     ].freeze
     # Converts a string or symbol into a valid Environment constant.
-    def self.from_value(value, default_value = SANDBOX)
+    def self.from_value(value, default_value = PRODUCTION)
       return default_value if value.nil?
       str = value.to_s.strip.downcase
       case str
-      when 'sandbox' then SANDBOX
       when 'production' then PRODUCTION
+      when 'environment2' then ENVIRONMENT2
       else
         warn "[Environment] Unknown environment '#{value}', falling back to #{default_value} "
@@ -57,15 +57,16 @@ module FortisApi
       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, proxy_settings: nil,
-      environment: Environment::SANDBOX, user_id_credentials: nil,
-      user_api_key_credentials: nil, developer_id_credentials: nil,
-      access_token_credentials: nil
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      user_id_credentials: nil, user_api_key_credentials: nil,
+      developer_id_credentials: nil, access_token_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,
-            proxy_settings: proxy_settings
+            proxy_settings: proxy_settings,
+            logging_configuration: logging_configuration
       # Current API environment
       @environment = String(environment)
@@ -89,9 +90,10 @@ module FortisApi
     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,
-                   proxy_settings: nil, environment: nil,
-                   user_id_credentials: nil, user_api_key_credentials: nil,
-                   developer_id_credentials: nil, access_token_credentials: nil)
+                   proxy_settings: nil, logging_configuration: nil,
+                   environment: nil, user_id_credentials: nil,
+                   user_api_key_credentials: nil, developer_id_credentials: nil,
+                   access_token_credentials: nil)
       connection ||= self.connection
       adapter ||= self.adapter
       timeout ||= self.timeout
@@ -102,6 +104,7 @@ module FortisApi
       retry_methods ||= self.retry_methods
       http_callback ||= self.http_callback
       proxy_settings ||= self.proxy_settings
+      logging_configuration ||= self.logging_configuration
       environment ||= self.environment
       user_id_credentials ||= self.user_id_credentials
       user_api_key_credentials ||= self.user_api_key_credentials
@@ -116,6 +119,7 @@ module FortisApi
                         retry_methods: retry_methods,
                         http_callback: http_callback,
                         proxy_settings: proxy_settings,
+                        logging_configuration: logging_configuration,
                         environment: environment,
                         user_id_credentials: user_id_credentials,
                         user_api_key_credentials: user_api_key_credentials,
@@ -126,10 +130,10 @@ module FortisApi
     # All the environments the SDK can run in.
     ENVIRONMENTS = {
-      Environment::SANDBOX => {
+      Environment::PRODUCTION => {
         Server::DEFAULT => 'https://api.sandbox.fortis.tech'
       },
-      Environment::PRODUCTION => {
+      Environment::ENVIRONMENT2 => {
         Server::DEFAULT => 'https://api.fortis.tech'
       }
     }.freeze
@@ -145,7 +149,7 @@ module FortisApi
     # Builds a Configuration instance using environment variables.
     def self.build_default_config_from_env
       # === Core environment ===
-      environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'sandbox'))
+      environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'production'))
       timeout = (ENV['TIMEOUT'] || 60).to_f
       max_retries = (ENV['MAX_RETRIES'] || 0).to_i
       retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
@@ -172,6 +176,8 @@ module FortisApi
       # === Proxy settings ===
       proxy_settings = ProxySettings.from_env
+      # === Logging Configuration ===
+      logging_configuration = LoggingConfiguration.from_env if LoggingConfiguration.any_logging_configured?
       Configuration.new(
         environment: environment,
@@ -185,7 +191,8 @@ module FortisApi
         user_api_key_credentials: user_api_key_credentials,
         developer_id_credentials: developer_id_credentials,
         access_token_credentials: access_token_credentials,
-        proxy_settings: proxy_settings
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration
       )
     end
   end

data/lib/fortis_api/controllers/apple_pay_validate_merchant_controller.rb CHANGED Viewed

@@ -9,23 +9,25 @@ module FortisApi
     # Apple Pay Validate Merchant
     # @param [V1WalletProviderApplePayValidateMerchantRequest] body Required
     # parameter: TODO: type description here
-    # @return [ResponseApplePayValidateMerchant] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def apple_pay_validate_merchant(body)
       @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/v1/wallet-provider/apple-pay-validate-merchant',
                                      Server::DEFAULT)
                    .header_param(new_parameter('application/json', key: 'Content-Type'))
-                   .body_param(new_parameter(body))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .body_serializer(proc do |param| param.to_json unless param.nil? end)
                    .auth(And.new('user-id', 'user-api-key', 'developer-id')))
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(ResponseApplePayValidateMerchant.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('401',
                                  'Unauthorized',
-                                 Response401tokenException)
+                                 Response401TokenException)
                     .local_error('412',
                                  'Precondition Failed',
                                  Response412Exception))

data/lib/fortis_api/controllers/async_processing_controller.rb CHANGED Viewed

@@ -10,22 +10,24 @@ module FortisApi
     # @param [UUID | String] status_code Required parameter: A [UUID
     # v4](https://datatracker.ietf.org/doc/html/rfc4122) that's unique for the
     # Async Request
-    # @return [ResponseAsyncStatus] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def status_check(status_code)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/v1/async/status/{status_code}',
                                      Server::DEFAULT)
                    .template_param(new_parameter(status_code, key: 'status_code')
+                                    .is_required(true)
                                     .should_encode(true))
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(And.new('user-id', 'user-api-key', 'developer-id')))
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(ResponseAsyncStatus.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('401',
                                  'Unauthorized',
-                                 Response401tokenException))
+                                 Response401TokenException))
         .execute
     end
   end

data/lib/fortis_api/controllers/base_controller.rb CHANGED Viewed

@@ -10,9 +10,14 @@ module FortisApi
     attr_accessor :config, :http_call_back
     def self.user_agent
-      'APIMATIC 3.0'
+      'Ruby SDK, Version: 1.0.3, on OS {os-info}'
     end
+    def self.user_agent_parameters
+      {
+        '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
+      }
+    end
     GLOBAL_ERRORS = {
       'default' => ErrorCase.new

data/lib/fortis_api/controllers/batches_controller.rb CHANGED Viewed

@@ -7,7 +7,7 @@ module FortisApi
   # BatchesController
   class BatchesController < BaseController
     # Show a list of all batches per location_id or per product_transcaction_id.
-    # @param [Page] page Optional parameter: Use this field to specify paginate
+    # @param [Page1] page Optional parameter: Use this field to specify paginate
     # your results, by using page size and number. You can use one of the
     # following methods: >/endpoint?page={ "number": 1, "size": 50 } >
     # >/endpoint?page[number]=1&page[size]=50 >
@@ -32,23 +32,23 @@ module FortisApi
     # "created_ts", "operator": "<=", value: "1695061891" }] >
     # >/endpoint?filter_by=[{ "key": "last_name", "operator": "IN", "value":
     # "Williams,Brown,Allman" }] >
-    # @param [Array[ExpandEnum]] expand Optional parameter: Most endpoints in
-    # the API have a way to retrieve extra data related to the current record
-    # being retrieved. For example, if the API request is for the accountvaults
+    # @param [Array[Expand]] expand Optional parameter: Most endpoints in the
+    # API have a way to retrieve extra data related to the current record being
+    # retrieved. For example, if the API request is for the accountvaults
     # endpoint, and the end user also needs to know which contact the token
     # belongs to, this data can be returned in the accountvaults endpoint
     # request.
-    # @param [Format1Enum] format Optional parameter: Reporting format, valid
+    # @param [Format1] format Optional parameter: Reporting format, valid
     # values: csv, tsv
     # @param [String] typeahead Optional parameter: You can use any `field_name`
     # from this endpoint results to order the list using the value provided as
     # filter for the same `field_name`. It will be ordered using the following
     # rules: 1) Exact match, 2) Starts with, 3) Contains. >/endpoint?filter={
     # "field_name": "Value" }&_typeahead=field_name >
-    # @param [Array[Field27Enum]] fields Optional parameter: You can use any
+    # @param [Array[Field27]] fields Optional parameter: You can use any
     # `field_name` from this endpoint results to filter the list of fields
     # returned on the response.
-    # @return [ResponseBatchsCollection] Response from the API call.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def list_all_batches(page: nil,
                          order: nil,
                          filter_by: nil,
@@ -72,31 +72,34 @@ module FortisApi
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(ResponseBatchsCollection.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('401',
                                  'Unauthorized',
-                                 Response401tokenException))
+                                 Response401TokenException))
         .execute
     end
     #  Manually close a credit card batch. Used primarily with hospitality and
     # tips.
     # @param [String] batch_id Required parameter: Batch ID
-    # @return [ResponseTransactionProcessing] Response from the API call.
-    def settle_a_batch(batch_id)
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def settlea_batch(batch_id)
       @api_call
         .request(new_request_builder(HttpMethodEnum::PUT,
                                      '/v1/batches/{batch_id}/settle',
                                      Server::DEFAULT)
                    .template_param(new_parameter(batch_id, key: 'batch_id')
+                                    .is_required(true)
                                     .should_encode(true))
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(And.new('user-id', 'user-api-key', 'developer-id')))
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(ResponseTransactionProcessing.method(:from_hash))
+                    .is_api_response(true)
                     .local_error('401',
                                  'Unauthorized',
-                                 Response401tokenException))
+                                 Response401TokenException))
         .execute
     end
   end