univapay-client-sdk 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1342c0449b6ee293db45dd5b397e5bc1ea581b98f57e4dd8b7f3790a05d191da
-  data.tar.gz: ca0a24c38e04b189c162e280f2ec33be5f808bdd3c15cfa11a375d490be422cc
+  metadata.gz: 351a468b95fbc6680edd54b2a81ae7fd7ae67110cfd6ccc1461534816a8cd701
+  data.tar.gz: 952a7897e0a5a0b401837cefd9080850e33d1b622e652b57b24505fb25bea2e5
 SHA512:
-  metadata.gz: 1cc3a5d944d5c0e40e84b1ae3edc4ca6aee4d8123de4d325f23e1a99295aa093caa06a71057e1784313e8028a0b959d1c89a9ded07b895446fd09b5d78910111
-  data.tar.gz: 4446484ea04820ceee34cf5d50f758bf54a320c00ffc75cff2a90d4c1959209fc9d795d8aefd15de4d5f49e894aebfb07a521adb23273b05da10ef3d5680517f
+  metadata.gz: 9d2557bf0488aad54a3c6f75b58ae884162fe5643c820923f8d98bbac421ad60385b063ccab45080dd69aa9e14c803d2b46a97997dc200c10d9cf9e870cc246f
+  data.tar.gz: 1e984113af71cfa604ce77fbd89d5d3ab1878b963594f0a681270b6da1dad1fca6b1db12faf33261704e89e5f5118e2349ad3bd36fb25e0495426f0648ff50dc

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-client-sdk -v 1.0.1
+gem install univapay-client-sdk -v 1.1.0
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'univapay-client-sdk', '1.0.1'
+gem 'univapay-client-sdk', '1.1.0'
 ```
 
-For additional gem details, see the [RubyGems page for the univapay-client-sdk gem](https://rubygems.org/gems/univapay-client-sdk/versions/1.0.1).
+For additional gem details, see the [RubyGems page for the univapay-client-sdk gem](https://rubygems.org/gems/univapay-client-sdk/versions/1.1.0).
 
 ## IRB Console Usage
 
@@ -99,6 +99,7 @@ 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'` |
+| direct_debit_base_url | `String` | Base URL for the Direct Debit API<br>*Default*: `'https://direct-debit.gopay-services.com'` |
 | environment | [`Environment`](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 |
@@ -127,6 +128,7 @@ client = Client.new(
   ),
   environment: Environment::PRODUCTION,
   base_url: 'https://api.univapay.com',
+  direct_debit_base_url: 'https://direct-debit.gopay-services.com',
   logging_configuration: LoggingConfiguration.new(
     log_level: Logger::INFO,
     request_logging_config: RequestLoggingConfiguration.new(
@@ -170,6 +172,8 @@ This API uses the following authentication schemes.
 ## List of APIs
 
 * [Transaction Tokens](doc/controllers/transaction-tokens.md)
+* [Direct Debit](doc/controllers/direct-debit.md)
+* [Transaction History](doc/controllers/transaction-history.md)
 * [Charges](doc/controllers/charges.md)
 * [Refunds](doc/controllers/refunds.md)
 * [Subscriptions](doc/controllers/subscriptions.md)
@@ -177,6 +181,7 @@ This API uses the following authentication schemes.
 * [Merchants](doc/controllers/merchants.md)
 * [Stores](doc/controllers/stores.md)
 * [Webhooks](doc/controllers/webhooks.md)
+* [Checkout](doc/controllers/checkout.md)
 
 ## Webhooks
 

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/1.0.1 (OS: {os-info}, Engine: {engine}/{engine-version})'
+      'Ruby-SDK/1.1.0 (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')))

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