wesley-key-sdk 3.0.6 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 969125a654f4f4b436b2b0f8938e5813e7723824407660979a163c8ee8a495a8
-  data.tar.gz: 30a7af398a95a4dd0a2cce80c6229272aed00a339396b12f79677bba79028cfb
+  metadata.gz: 32b2ba67ccdc0313bfb0c355ad9fa99a6413618ab32324bd9d6f91d062b02831
+  data.tar.gz: '09fb581ec96561ada24b807c5775d75436f750d5c4f56f9a053c8d4fa938aaa6'
 SHA512:
-  metadata.gz: 1d7466129939c3b9ab0e6b381767772343c89a934ede9c82a0982e262b01b806c5a7dd29e18128ec8008168c761240fefff784ac2ce31003c2a575183637e388
-  data.tar.gz: b8ee58033a7ae49494aaf6e1ba3aa082572774a42420ce44dcbcee8909cb16c6312e51a2e559361e9321eb2a7a480dd06d59af4a71aada27ad1ceaa764d49f24
+  metadata.gz: 8960c201fa1e7c00d4fd8f2f0928fcac566a4fd88ba94f41c22acf70eb8539c2b0e5608852b37ff3353dda04e740d549c59c0bb984b192d80a5eccc7a3e914b3
+  data.tar.gz: c048447b48bbecf1651992854ff495daa05526f2ac4a5039c18f607cb2d4e1f19d834f56b782c4a767c96fb647c277df2b42df41b6d645b7b91657a5990f8b3b

data/README.md

@@ -1,144 +1,168 @@
-
-# Getting Started with Cypress Test API
-
-## Introduction
-
-This is a sample API to demonstrate an OpenAPI spec with multiple endpoints and a custom model.
-
-## Install the Package
-
-Install the gem from the command line:
-
-```bash
-gem install wesley-key-sdk -v 3.0.6
-```
-
-Or add the gem to your Gemfile and run `bundle`:
-
-```ruby
-gem 'wesley-key-sdk', '3.0.6'
-```
-
-For additional gem details, see the [RubyGems page for the wesley-key-sdk gem](https://rubygems.org/gems/wesley-key-sdk/versions/3.0.6).
-
-## IRB Console Usage
-
-You can explore the SDK interactively using IRB in two ways
-
-### 1. Use IRB with Installed Gem
-
-Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
-
-```bash
-irb
-```
-
-Now you can load the SDK in the IRB
-
-```ruby
-require 'cypress_test_api'
-include CypressTestApi
-```
-
-### 2. Use IRB within SDK
-
-Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
-
-```
-cd path/to/cypress_test_api
-```
-
-Now you can start the preconfigured irb console by running the following command
-
-```bash
-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/ZahraN444/wesley-key-ruby-sdk/tree/3.0.6/doc/client.md)
-
-The following parameters are configurable for the API Client:
-
-| Parameter | Type | Description |
-|  --- | --- | --- |
-| default_host | `String` | *Default*: `'www.example.com'` |
-| environment | [`Environment`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.6/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** |
-| 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/ZahraN444/wesley-key-ruby-sdk/tree/3.0.6/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
-
-The API client can be initialized as follows:
-
-### Code-Based Client Initialization
-
-```ruby
-require 'cypress_test_api'
-include CypressTestApi
+
+# Getting Started with Webhooks and Callbacks API
+
+## Introduction
+
+A comprehensive API demonstrating webhooks and callbacks patterns.
+
+### Webhooks
+
+Webhooks allow your application to receive real-time notifications when certain events occur.
+
+### Callbacks
+
+Callbacks are used for asynchronous operations where the API will call back to your provided URL when the operation completes.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install wesley-key-sdk -v 4.0.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'wesley-key-sdk', '4.0.0'
+```
+
+For additional gem details, see the [RubyGems page for the wesley-key-sdk gem](https://rubygems.org/gems/wesley-key-sdk/versions/4.0.0).
+
+## IRB Console Usage
+
+You can explore the SDK interactively using IRB in two ways
+
+### 1. Use IRB with Installed Gem
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
+
+```bash
+irb
+```
+
+Now you can load the SDK in the IRB
+
+```ruby
+require 'webhooks_and_callbacks_api'
+include WebhooksAndCallbacksApi
+```
+
+### 2. Use IRB within SDK
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
+
+```
+cd path/to/webhooks_and_callbacks_api
+```
+
+Now you can start the preconfigured irb console by running the following command
+
+```bash
+ruby bin/console
+```
+
+**_Note:_** This automatically loads the SDK from lib/
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| 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: 50** |
+| 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, 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 get put]** |
+| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| proxy_settings | [`ProxySettings`](doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| api_key_credentials | [`ApiKeyCredentials`](doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
+| bearer_auth_credentials | [`BearerAuthCredentials`](doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'webhooks_and_callbacks_api'
+include WebhooksAndCallbacksApi
 
 client = Client.new(
-  environment: Environment::PRODUCTION,
-  default_host: 'www.example.com'
-)
-```
-
-### Environment-Based Client Initialization
-
-```ruby
-require 'cypress_test_api'
-include CypressTestApi
+  api_key_credentials: ApiKeyCredentials.new(
+    x_api_key: 'X-API-Key'
+  ),
+  bearer_auth_credentials: BearerAuthCredentials.new(
+    access_token: 'AccessToken'
+  ),
+  logging_configuration: LoggingConfiguration.new(
+    log_level: Logger::INFO,
+    request_logging_config: RequestLoggingConfiguration.new(
+      log_body: true
+    ),
+    response_logging_config: ResponseLoggingConfiguration.new(
+      log_headers: true
+    )
+  )
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'webhooks_and_callbacks_api'
+include WebhooksAndCallbacksApi
 
 # Create client from environment
-client = Client.from_env
-```
-
-See the [`Environment-Based Client Initialization`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.6/doc/environment-based-client-initialization.md) section for details.
-
-## Environments
-
-The SDK can be configured to use a different environment for making API calls. Available environments are:
-
-### Fields
-
-| Name | Description |
-|  --- | --- |
-| PRODUCTION | **Default** |
-
-## List of APIs
-
-* [API](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.6/doc/controllers/api.md)
-
-## SDK Infrastructure
-
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](doc/environment-based-client-initialization.md) section for details.
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`ApiKey (Custom Header Signature)`](doc/auth/custom-header-signature.md)
+* [`BearerAuth (OAuth 2 Bearer token)`](doc/auth/oauth-2-bearer-token.md)
+
+## List of APIs
+
+* [Orders](doc/controllers/orders.md)
+
+## Webhooks
+
+* [Webhooks](doc/events/webhooks/webhooks-handler.md)
+* [Webhooks A](doc/events/webhooks/webhooks-a-handler.md)
+* [Webhooks B](doc/events/webhooks/webhooks-b-handler.md)
+* [Webhooks C](doc/events/webhooks/webhooks-c-handler.md)
+* [Webhooks No Verification](doc/events/webhooks/webhooks-no-verification-handler.md)
+
+## SDK Infrastructure
+
 ### Configuration
 
-* [ProxySettings](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.6/doc/proxy-settings.md)
-* [Environment-Based Client Initialization](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.6/doc/environment-based-client-initialization.md)
+* [ProxySettings](doc/proxy-settings.md)
+* [Environment-Based Client Initialization](doc/environment-based-client-initialization.md)
+* [AbstractLogger](doc/abstract-logger.md)
+* [LoggingConfiguration](doc/logging-configuration.md)
+* [RequestLoggingConfiguration](doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](doc/response-logging-configuration.md)
 
 ### HTTP
 
-* [HttpResponse](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.6/doc/http-response.md)
-* [HttpRequest](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.6/doc/http-request.md)
+* [HttpResponse](doc/http-response.md)
+* [HttpRequest](doc/http-request.md)
 
 ### Utilities
 
-* [ApiHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.6/doc/api-helper.md)
-* [DateTimeHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.6/doc/date-time-helper.md)
-
+* [ApiResponse](doc/api-response.md)
+* [ApiHelper](doc/api-helper.md)
+* [DateTimeHelper](doc/date-time-helper.md)
+

data/bin/console

@@ -4,11 +4,11 @@
 $LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
 
 # Require the gem
-require 'cypress_test_api'
+require 'webhooks_and_callbacks_api'
 
-puts 'CypressTestApi SDK loaded!'
-puts 'You can now create a client with: client = CypressTestApi::Client.new'
-puts 'Or use from_env: client = CypressTestApi::Client.from_env'
+puts 'WebhooksAndCallbacksApi SDK loaded!'
+puts 'You can now create a client with: client = WebhooksAndCallbacksApi::Client.new'
+puts 'Or use from_env: client = WebhooksAndCallbacksApi::Client.from_env'
 
 # Start an interactive IRB session
 require 'irb'

data/lib/webhooks_and_callbacks_api/api_helper.rb

@@ -0,0 +1,10 @@
+# webhooks_and_callbacks_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module WebhooksAndCallbacksApi
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end

data/lib/{cypress_test_api/controllers/base_controller.rb → webhooks_and_callbacks_api/apis/base_api.rb}

@@ -1,23 +1,30 @@
-# cypress_test_api
+# webhooks_and_callbacks_api
 #
-# This file was automatically generated by APIMATIC v3.0
-# ( https://www.apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
-module CypressTestApi
-  # BaseController.
-  class BaseController
+module WebhooksAndCallbacksApi
+  # BaseApi.
+  class BaseApi
     include CoreLibrary
     attr_accessor :config, :http_call_back
 
-    def self.user_agent
-      'APIMATIC 3.0'
+    def self.user_agent
+      'Ruby-SDK/4.0.0 (OS: {os-info}, Engine: {engine}/{engine-version})'
     end
 
+    def self.user_agent_parameters
+      {
+        '{engine}' => { 'value' => RUBY_ENGINE, 'encode' => false },
+        '{engine-version}' => { 'value' => RUBY_ENGINE_VERSION, 'encode' => false },
+        '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
+      }
+    end
 
-    GLOBAL_ERRORS = {
+    GLOBAL_ERRORS = {
       'default' => ErrorCase.new
                             .error_message('HTTP response not OK.')
-                            .exception_type(APIException)
+                            .exception_type(APIException)
     }.freeze
 
     # Initialization constructor.

data/lib/webhooks_and_callbacks_api/apis/orders_api.rb

@@ -0,0 +1,34 @@
+# webhooks_and_callbacks_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module WebhooksAndCallbacksApi
+  # OrdersApi
+  class OrdersApi < BaseApi
+    # Creates a new order and triggers callbacks for payment processing
+    # @param [CreateOrderRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_order(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/orders',
+                                     Server::DEFAULT)
+                   .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(Or.new('ApiKey', 'BearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Order.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request',
+                                 ErrorException))
+        .execute
+    end
+  end
+end

data/lib/webhooks_and_callbacks_api/client.rb

@@ -0,0 +1,76 @@
+# webhooks_and_callbacks_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module WebhooksAndCallbacksApi
+  #  webhooks_and_callbacks_api client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
+    # Access to orders controller.
+    # @return [OrdersApi] Returns the controller instance.
+    def orders
+      @orders ||= OrdersApi.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 50,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put get put], http_callback: nil,
+      proxy_settings: nil, logging_configuration: nil,
+      environment: Environment::PRODUCTION, api_key_credentials: nil,
+      bearer_auth_credentials: nil, config: nil
+    )
+      @config = if config.nil?
+                  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,
+                    logging_configuration: logging_configuration,
+                    environment: environment,
+                    api_key_credentials: api_key_credentials,
+                    bearer_auth_credentials: bearer_auth_credentials
+                  )
+                else
+                  config
+                end
+      user_agent_params = BaseApi.user_agent_parameters
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseApi::GLOBAL_ERRORS)
+                                                 .user_agent(BaseApi.user_agent,
+                                                             agent_parameters: user_agent_params)
+
+      initialize_auth_managers(@global_configuration)
+      @global_configuration = @global_configuration.auth_managers(@auth_managers)
+    end
+
+    # Initializes the auth managers hash used for authenticating API calls.
+    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
+    def initialize_auth_managers(global_config)
+      @auth_managers = {}
+      http_client_config = global_config.client_configuration
+      %w[ApiKey BearerAuth].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['ApiKey'] = ApiKey.new(http_client_config.api_key_credentials)
+      @auth_managers['BearerAuth'] = BearerAuth.new(http_client_config.bearer_auth_credentials)
+    end
+
+    # Creates a client directly from environment variables.
+    def self.from_env(**overrides)
+      default_config = Configuration.build_default_config_from_env
+      new_config = default_config.clone_with(**overrides)
+      new(config: new_config)
+    end
+  end
+end