univapay-apimatic-sdk 0.0.4 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dff7e69f1e12f970292c1194aa2e9772e79a1077531bdcd3cdc7da549b2b38f
-  data.tar.gz: 778166110fb85b9b967297875e69461fa8f81fc1f5f26caeb7b0ade2c47db3a0
+  metadata.gz: 97529d8f8516665fb6a61e57c9a4c111f9a747f4749eb8cdeb44f0fce9e9deaa
+  data.tar.gz: 496c8f3fcd998dc8f85a3634e236dda0209df90f305c1d015e8f5ccba07d7fd8
 SHA512:
-  metadata.gz: 33b2e5b8e832a065d59ed38db76c157b38731fd51a2d1811a93968c3dc5ed0f515ef17ea993b6d2c06cade89cf4d4be64bdd8f840289024dfbb2258d10670457
-  data.tar.gz: fe7b183e072126bdca270349426bb99e1215074b95940d249c2dc04b7d9147d971ccb7ad49b5cf1605e246f38d9b2ceb511cd6c41ec146160153a5c6a0d4503f
+  metadata.gz: ef62984e293d47c5a96901ce6b4e76d841d1af9d0a027c726e7b3ab350e3ec3ee1187ba28bf877d6ad91b827b52b24180b1ccf5b57d664972f9d5ecf65d6b52e
+  data.tar.gz: 865118534879f0cf56e4c5ff22384d36668fedbb764b76e8eabf29ddc8c9232bc179a189863049ac9a96f31fba7a0269a487bc1310a7185514ef8654825d12ab

data/README.md

@@ -36,16 +36,16 @@ We will assume that all requests are going to originate from a backend server th
 Install the gem from the command line:
 
 ```bash
-gem install univapay-apimatic-sdk -v 0.0.4
+gem install univapay-apimatic-sdk -v 1.0.2
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'univapay-apimatic-sdk', '0.0.4'
+gem 'univapay-apimatic-sdk', '1.0.2'
 ```
 
-For additional gem details, see the [RubyGems page for the univapay-apimatic-sdk gem](https://rubygems.org/gems/univapay-apimatic-sdk/versions/0.0.4).
+For additional gem details, see the [RubyGems page for the univapay-apimatic-sdk gem](https://rubygems.org/gems/univapay-apimatic-sdk/versions/1.0.2).
 
 ## IRB Console Usage
 
@@ -92,14 +92,15 @@ rake
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| base_url | `String` | Base URL for the API<br>*Default*: `'https://api.univapay.com'` |
-| environment | [`Environment`](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION`** |
+| base_url | `String` | Base URL for the API<br>*Default*: `'https://api.gyro-n.money'` |
+| direct_debit_base_url | `String` | Base URL for the Direct Debit API<br>*Default*: `'https://staging-direct-debit.gopay-services.com'` |
+| environment | [`Environment`](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/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: 30** |
@@ -109,9 +110,9 @@ 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/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
-| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/logging-configuration.md) | The SDK logging configuration for API calls |
-| bearer_auth_credentials | [`BearerAuthCredentials`](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
+| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| bearer_auth_credentials | [`BearerAuthCredentials`](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
 
 The API client can be initialized as follows:
 
@@ -126,7 +127,8 @@ client = Client.new(
     access_token: 'AccessToken'
   ),
   environment: Environment::PRODUCTION,
-  base_url: 'https://api.univapay.com',
+  base_url: 'https://api.gyro-n.money',
+  direct_debit_base_url: 'https://staging-direct-debit.gopay-services.com',
   logging_configuration: LoggingConfiguration.new(
     log_level: Logger::INFO,
     request_logging_config: RequestLoggingConfiguration.new(
@@ -149,7 +151,7 @@ include UnivapayClientSdk
 client = Client.from_env
 ```
 
-See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/environment-based-client-initialization.md) section for details.
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/environment-based-client-initialization.md) section for details.
 
 ## Environments
 
@@ -159,66 +161,57 @@ The SDK can be configured to use a different environment for making API calls. A
 
 | Name | Description |
 |  --- | --- |
-| PRODUCTION | **Default** Production Server |
+| PRODUCTION | **Default** Staging Server |
 
 ## Authorization
 
 This API uses the following authentication schemes.
 
-* [`JWT_TOKEN (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/auth/oauth-2-bearer-token.md)
+* [`JWT_TOKEN (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/auth/oauth-2-bearer-token.md)
 
 ## List of APIs
 
-* [Transaction Tokens](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/controllers/transaction-tokens.md)
-* [Charges](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/controllers/charges.md)
-* [Refunds](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/controllers/refunds.md)
-* [Subscriptions](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/controllers/subscriptions.md)
-* [Cancels](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/controllers/cancels.md)
-* [Merchants](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/controllers/merchants.md)
-* [Stores](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/controllers/stores.md)
-* [Webhooks](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/controllers/webhooks.md)
+* [Transaction Tokens](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/transaction-tokens.md)
+* [Direct Debit](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/direct-debit.md)
+* [Transaction History](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/transaction-history.md)
+* [Charges](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/charges.md)
+* [Refunds](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/refunds.md)
+* [Subscriptions](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/subscriptions.md)
+* [Cancels](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/cancels.md)
+* [Merchants](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/merchants.md)
+* [Stores](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/stores.md)
+* [Webhooks](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/webhooks.md)
+* [Checkout](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/checkout.md)
 
 ## Webhooks
 
-* [Charge Updated](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/events/webhooks/charge-updated-handler.md)
-* [Charge Finished](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/events/webhooks/charge-finished-handler.md)
-* [Token Created](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/events/webhooks/token-created-handler.md)
-* [Token Updated](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/events/webhooks/token-updated-handler.md)
-* [Token Three Ds Updated](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/events/webhooks/token-three-ds-updated-handler.md)
-* [Token Cvv Auth Updated](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/events/webhooks/token-cvv-auth-updated-handler.md)
-* [Token Cvv Auth Check Updated](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/events/webhooks/token-cvv-auth-check-updated-handler.md)
-* [Token Replaced](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/events/webhooks/token-replaced-handler.md)
-* [Recurring Token Deleted](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/events/webhooks/recurring-token-deleted-handler.md)
-* [Refund](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/events/webhooks/refund-handler.md)
-* [Cancel](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/events/webhooks/cancel-handler.md)
-* [Subscription Created](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/events/webhooks/subscription-created-handler.md)
-* [Subscription Payment](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/events/webhooks/subscription-payment-handler.md)
-* [Subscription Completed](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/events/webhooks/subscription-completed-handler.md)
-* [Subscription Failure](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/events/webhooks/subscription-failure-handler.md)
-* [Subscription Canceled](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/events/webhooks/subscription-canceled-handler.md)
-* [Subscription Suspended](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/events/webhooks/subscription-suspended-handler.md)
-* [Bank-Transfer](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/events/webhooks/bank-transfer-handler.md)
-* [Customs](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/events/webhooks/customs-handler.md)
+* [Charge](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/events/webhooks/charge-handler.md)
+* [Token](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/events/webhooks/token-handler.md)
+* [Refund](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/events/webhooks/refund-handler.md)
+* [Cancel](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/events/webhooks/cancel-handler.md)
+* [Subscription](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/events/webhooks/subscription-handler.md)
+* [Bank-Transfer](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/events/webhooks/bank-transfer-handler.md)
+* [Customs](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/events/webhooks/customs-handler.md)
 
 ## SDK Infrastructure
 
 ### Configuration
 
-* [ProxySettings](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/proxy-settings.md)
-* [Environment-Based Client Initialization](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/environment-based-client-initialization.md)
-* [AbstractLogger](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/abstract-logger.md)
-* [LoggingConfiguration](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/logging-configuration.md)
-* [RequestLoggingConfiguration](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/request-logging-configuration.md)
-* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/response-logging-configuration.md)
+* [ProxySettings](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/response-logging-configuration.md)
 
 ### HTTP
 
-* [HttpResponse](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/http-response.md)
-* [HttpRequest](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/http-request.md)
+* [HttpResponse](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/http-request.md)
 
 ### Utilities
 
-* [ApiResponse](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/api-response.md)
-* [ApiHelper](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/api-helper.md)
-* [DateTimeHelper](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/0.0.4/doc/date-time-helper.md)
+* [ApiResponse](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/univapay-apimatic-ruby-sdk/tree/1.0.2/doc/date-time-helper.md)
 

data/lib/univapay_client_sdk/apis/base_api.rb

@@ -10,7 +10,7 @@ module UnivapayClientSdk
     attr_accessor :config, :http_call_back
 
     def self.user_agent
-      'Ruby-SDK/0.0.4 (OS: {os-info}, Engine: {engine}/{engine-version})'
+      'Ruby-SDK/1.0.2 (OS: {os-info}, Engine: {engine}/{engine-version})'
     end
 
     def self.user_agent_parameters

data/lib/univapay_client_sdk/apis/charges_api.rb

@@ -427,21 +427,25 @@ module UnivapayClientSdk
 
     # Captures a previously authorized charge (where `capture` was set to false
     # during creation).  The capture amount must be less than or equal to the
-    # authorized amount, and the currency must match.
+    # authorized amount, and the currency must match. The request body — and
+    # both of its fields — is optional: if omitted entirely, the full
+    # outstanding authorized amount (in the originally requested currency) is
+    # captured.
     # @param [UUID | String] store_id Required parameter: The unique identifier
     # of the store.
     # @param [UUID | String] id Required parameter: The unique identifier of the
     # resource.
-    # @param [ChargeCaptureRequest] body Required parameter: Request payload for
-    # capturing an authorized charge.
     # @param [String] idempotency_key Optional parameter: An optional
     # idempotency key to prevent double charges and duplicate operations. We
     # recommend a randomly generated UUID (v4).
+    # @param [ChargeCaptureRequest] body Optional parameter: Optional request
+    # payload for capturing an authorized charge. Omit entirely to capture the
+    # full outstanding authorized amount.
     # @return [ApiResponse] Complete http response with raw body and status code.
     def capture_charge(store_id,
                        id,
-                       body,
-                       idempotency_key: nil)
+                       idempotency_key: nil,
+                       body: nil)
       @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/stores/{storeId}/charges/{id}/capture',
@@ -453,9 +457,8 @@ module UnivapayClientSdk
                                     .is_required(true)
                                     .should_encode(true))
                    .header_param(new_parameter('application/json', key: 'Content-Type'))
-                   .body_param(new_parameter(body)
-                                .is_required(true))
                    .header_param(new_parameter(idempotency_key, key: 'Idempotency-Key'))
+                   .body_param(new_parameter(body))
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .body_serializer(proc do |param| param.to_json unless param.nil? end)
                    .auth(Single.new('JWT_TOKEN')))
@@ -623,7 +626,13 @@ module UnivapayClientSdk
         .execute
     end
 
-    # Retrieves bank transfer ledger entries associated with a charge.
+    # Retrieves bank transfer ledger entries associated with a charge. This is
+    # an optional reconciliation endpoint — not part of the required
+    # create-charge-and-poll flow.
+    # **⚠️ Requires a merchant-level application token**, unlike the rest of the
+    # bank transfer flow. A store application token (`Bearer {secret}.{jwt}`
+    # scoped to a `store_id`) is not sufficient here, even though the path is
+    # store-scoped.
     # @param [UUID | String] store_id Required parameter: The unique identifier
     # of the store.
     # @param [UUID | String] id Required parameter: The unique identifier of the

data/lib/univapay_client_sdk/apis/checkout_api.rb

@@ -0,0 +1,58 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # CheckoutApi
+  class CheckoutApi < BaseApi
+    # Returns the merchant's checkout configuration: enabled payment methods and
+    # their limits, installment/subscription plan settings, convenience-store
+    # and bank-transfer settings, widget theme, and per-brand feature support.
+    # Resolved entirely from the bearer credential — takes no parameters.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_checkout_info
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/checkout_info',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('JWT_TOKEN')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CheckoutInfo.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error_template('401',
+                                          'HTTP 401 Unauthorized: {$response.body#/code}',
+                                          ApiErrorException)
+                    .local_error_template('403',
+                                          'HTTP 403 Forbidden: {$response.body#/code}',
+                                          ApiErrorException)
+                    .local_error_template('429',
+                                          'HTTP 429 Rate Limited: {$response.body#/code}',
+                                          APIException)
+                    .local_error_template('400',
+                                          'HTTP 400 Bad Request: {$response.body#/code}',
+                                          APIException)
+                    .local_error_template('404',
+                                          'HTTP 404 Not Found: {$response.body#/code}',
+                                          APIException)
+                    .local_error_template('409',
+                                          'HTTP 409 Conflict: {$response.body#/code}',
+                                          APIException)
+                    .local_error_template('500',
+                                          'HTTP 500 Server Error: {$response.body#/code}',
+                                          APIException)
+                    .local_error_template('503',
+                                          'HTTP 503 Unavailable: {$response.body#/code}',
+                                          APIException)
+                    .local_error_template('504',
+                                          'HTTP 504 Timeout: {$response.body#/code}',
+                                          APIException)
+                    .local_error_template('default',
+                                          'HTTP {$statusCode}: {$response.body#/code}',
+                                          APIException))
+        .execute
+    end
+  end
+end