univapay-client-sdk 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60bb87fb05403484609586399d911107d01d8375c21bde02a4a815c97e129fcc
-  data.tar.gz: 720da5f2d2dcd82ae63787f450ff9eb9b194fd316249ff7b8c9a64033b887e51
+  metadata.gz: 351a468b95fbc6680edd54b2a81ae7fd7ae67110cfd6ccc1461534816a8cd701
+  data.tar.gz: 952a7897e0a5a0b401837cefd9080850e33d1b622e652b57b24505fb25bea2e5
 SHA512:
-  metadata.gz: bdb9e959c262b21e07263734d985a1e7dc5824de8faee747106571d769e79aa6b72dfcabd14af976f36d1f6d90d4ecd93410e82e7ce1e0838f7c40456ac89f21
-  data.tar.gz: 184f32bc88f3c96fce994276cf357f70eb876a4793b278b3d5618c19c8164e390e3b54aba03da08a8592ca4de5cfa257bfc9cca448eca6fa9c22f27834a12f4f
+  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.2
+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.2'
+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.2).
+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
 
@@ -173,6 +173,7 @@ This API uses the following authentication schemes.
 
 * [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)
@@ -180,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.2 (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

data/lib/univapay_client_sdk/apis/stores_api.rb

@@ -122,5 +122,68 @@ module UnivapayClientSdk
                                           APIException))
         .execute
     end
+
+    # Derives a deterministic, store-scoped UUID from a local customer
+    # identifier supplied by the merchant. Calling this endpoint again with the
+    # same `customer_id` for the same store always returns the same UUID — the
+    # operation has no side effects (nothing is persisted), so it is safe to
+    # call repeatedly and does not require an `Idempotency-Key`. App Token
+    # Secret is required.
+    # @param [UUID | String] store_id Required parameter: The unique identifier
+    # of the store.
+    # @param [CreateCustomerIdRequest] body Required parameter: Request payload
+    # for deriving a customer ID.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_customer_id(store_id,
+                           body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/stores/{storeId}/create_customer_id',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(store_id, key: 'storeId')
+                                    .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('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('JWT_TOKEN')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CreateCustomerIdResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error_template('400',
+                                          'HTTP 400 Bad Request: {$response.body#/code}',
+                                          ApiErrorException)
+                    .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('404',
+                                          'HTTP 404 Not Found: {$response.body#/code}',
+                                          ApiErrorException)
+                    .local_error_template('429',
+                                          'HTTP 429 Rate Limited: {$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

data/lib/univapay_client_sdk/apis/subscriptions_api.rb

@@ -63,6 +63,11 @@ module UnivapayClientSdk
     end
 
     # Lists all subscriptions across all stores.
+    # @param [String] search Optional parameter: Search by metadata values.
+    # @param [SubscriptionStatus] status Optional parameter: Filter
+    # subscriptions by current status.
+    # @param [ChargeMode] mode Optional parameter: Filter subscriptions by
+    # processing mode.
     # @param [Integer] limit Optional parameter: Maximum number of resources to
     # return in one page.
     # @param [UUID | String] cursor Optional parameter: Cursor pointing to the
@@ -70,13 +75,19 @@ module UnivapayClientSdk
     # @param [CursorDirectionQuery] cursor_direction Optional parameter:
     # Pagination direction relative to the supplied cursor.
     # @return [ApiResponse] Complete http response with raw body and status code.
-    def list_all_subscriptions(limit: 10,
+    def list_all_subscriptions(search: nil,
+                               status: nil,
+                               mode: nil,
+                               limit: 10,
                                cursor: nil,
                                cursor_direction: CursorDirectionQuery::DESC)
       @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/subscriptions',
                                      Server::DEFAULT)
+                   .query_param(new_parameter(search, key: 'search'))
+                   .query_param(new_parameter(status, key: 'status'))
+                   .query_param(new_parameter(mode, key: 'mode'))
                    .query_param(new_parameter(limit, key: 'limit'))
                    .query_param(new_parameter(cursor, key: 'cursor'))
                    .query_param(new_parameter(cursor_direction, key: 'cursor_direction'))
@@ -119,6 +130,66 @@ module UnivapayClientSdk
         .execute
     end
 
+    # Simulates the payment schedule that a subscription would follow, without
+    # creating a live subscription or a transaction token. Returns a bare array
+    # of the scheduled payments that would result from the given amount,
+    # currency, period (or cyclical period), and plan settings.
+    # @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 [SubscriptionSimulationRequest] body Optional parameter:
+    # Subscription Plan Simulation request
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def simulate_subscription_plan(idempotency_key: nil,
+                                   body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/subscriptions/simulate_plan',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .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')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SubscriptionSimulationPayment.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error_template('400',
+                                          'HTTP 400 Bad Request: {$response.body#/code}',
+                                          ApiErrorException)
+                    .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('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
+
     # Lists all subscriptions for a specific store.
     # @param [UUID | String] store_id Required parameter: The unique identifier
     # of the store.
@@ -193,6 +264,73 @@ module UnivapayClientSdk
         .execute
     end
 
+    # Simulates the payment schedule that a subscription would follow for a
+    # specific store, without creating a live subscription or a transaction
+    # token. Returns a bare array of the scheduled payments that would result
+    # from the given amount, currency, period (or cyclical period), and plan
+    # settings.
+    # @param [UUID | String] store_id Required parameter: The unique identifier
+    # of the store.
+    # @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 [SubscriptionSimulationRequest] body Optional parameter:
+    # Subscription Plan Simulation request
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def simulate_store_subscription_plan(store_id,
+                                         idempotency_key: nil,
+                                         body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/stores/{storeId}/subscriptions/simulate_plan',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(store_id, key: 'storeId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .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')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SubscriptionSimulationPayment.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error_template('400',
+                                          'HTTP 400 Bad Request: {$response.body#/code}',
+                                          ApiErrorException)
+                    .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('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
+
     # Retrieves the details of an existing subscription.  Supports internal
     # polling to wait for status changes.
     # @param [UUID | String] store_id Required parameter: The unique identifier