sdksio-apimatic-sdk 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e966b2e7ee1e910f8cd4284061fab491ad2aa59067b1df31478fb0851dd8547
-  data.tar.gz: be7e3593f690762eb8d4d60bfa096272bc8f7a0f05aa95e72075a791ab439d20
+  metadata.gz: 8129eb3385df7f8066e51031ece95d07e22a0d2afb1aa2dfaa1b112283e998df
+  data.tar.gz: 0c34e9abaf8f7a0bc49fab7eba8670ab8d471fd5f9270d3a418de221e81470a8
 SHA512:
-  metadata.gz: 896ecf8dd9458bdc288dd46819afb3dcc841e8f52007b9cda8d2f02f0d877b14149f2e33e81acf29118f236d1bd3b23340ff2aea2d93e1603c6ed4fc4604bfd2
-  data.tar.gz: 98090b131858ba9c8b87cd813abf2f3363dfb1a26c655d662ed92719127e1ff7c5473fff8951481058850361718a40125715b8a0b752213a7a46890ea705c323
+  metadata.gz: cb16204712f10ff483a1bea2f45f4d1ddab16d123eb18172ff5074e3833ba8c4aac2af9bf15300813976a43ee779227adb422d189c0ff4459ec63cb980bbb350
+  data.tar.gz: a356db56d011becdb19e688525b1972aa1453644b648a1ecf6ee79110d8ddb30210c45eb2642616b420b98c119b152b068b586e0d92a6bb7ab3884866d6e247c

data/LICENSE

@@ -3,7 +3,7 @@ License:
 The MIT License (MIT)
 http://opensource.org/licenses/MIT
 
-Copyright (c) 2014 - 2024 APIMATIC Limited
+Copyright (c) 2014 - 2026 APIMATIC Limited
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,82 +1,170 @@
-
-# Getting Started with Apimatic API
-
-## Introduction
-
-This API gives you programmatic access to APIMatic's Code Generation, Docs Generation and Transformation Engine
-
-## Install the Package
-
-Install the gem from the command line:
-
-```ruby
-gem install sdksio-apimatic-sdk -v 3.0.0
-```
-
-Or add the gem to your Gemfile and run `bundle`:
-
-```ruby
-gem 'sdksio-apimatic-sdk', '3.0.0'
-```
-
-For additional gem details, see the [RubyGems page for the sdksio-apimatic-sdk gem](https://rubygems.org/gems/sdksio-apimatic-sdk/versions/3.0.0).
-
-## 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.](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: 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, 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. |
-| `custom_header_authentication_credentials` | [`CustomHeaderAuthenticationCredentials`](__base_path/$a/custom-header-signature.md) | The credential object for Custom Header Signature |
-
-The API client can be initialized as follows:
-
-```ruby
-client = ApimaticApi::Client.new(
+
+# Getting Started with Apimatic API
+
+## Introduction
+
+This API gives you programmatic access to APIMatic's Code Generation, Docs Generation and Transformation Engine
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install sdksio-apimatic-sdk -v 3.0.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'sdksio-apimatic-sdk', '3.0.1'
+```
+
+For additional gem details, see the [RubyGems page for the sdksio-apimatic-sdk gem](https://rubygems.org/gems/sdksio-apimatic-sdk/versions/3.0.1).
+
+## 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 'apimatic_api'
+include ApimaticApi
+```
+
+### 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/apimatic_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.](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| user_agent | `String` |  |
+| custom_url | `String` | The testing domain for the API<br>*Default*: `'https://localhost:44301/api'` |
+| environment | [`Environment`](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/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** |
+| 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/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| custom_header_authentication_credentials | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'apimatic_api'
+include ApimaticApi
+
+client = Client.new(
+  user_agent: 'user-agent',
   custom_header_authentication_credentials: CustomHeaderAuthenticationCredentials.new(
     authorization: 'Authorization'
+  ),
+  environment: Environment::PRODUCTION,
+  custom_url: 'https://localhost:44301/api',
+  logging_configuration: LoggingConfiguration.new(
+    log_level: Logger::INFO,
+    request_logging_config: RequestLoggingConfiguration.new(
+      log_body: true
+    ),
+    response_logging_config: ResponseLoggingConfiguration.new(
+      log_headers: true
+    )
   )
-)
-```
-
-## Authorization
-
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'apimatic_api'
+include ApimaticApi
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/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** |
+| TESTING | - |
+
+## Authorization
+
 This API uses the following authentication schemes.
 
-* [`Authorization (Custom Header Signature)`](__base_path/$a/custom-header-signature.md)
-
-## List of APIs
-
-* [APIs Management](doc/controllers/apis-management.md)
-* [Code Generation-Imported APIs](doc/controllers/code-generation-imported-apis.md)
-* [Code Generation-External APIs](doc/controllers/code-generation-external-apis.md)
-* [Docs Portal Management](doc/controllers/docs-portal-management.md)
-* [API Validation-Imported APIs](doc/controllers/api-validation-imported-apis.md)
-* [API Validation-External APIs](doc/controllers/api-validation-external-apis.md)
-* [Transformation](doc/controllers/transformation.md)
-
-## Classes Documentation
-
-* [Utility Classes](doc/utility-classes.md)
-* [HttpResponse](doc/http-response.md)
-* [HttpRequest](doc/http-request.md)
-
+* [`Authorization (Custom Header Signature)`](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/auth/custom-header-signature.md)
+
+## List of APIs
+
+* [Code Generation-External APIs](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/controllers/code-generation-external-apis.md)
+* [Docs Portal Management](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/controllers/docs-portal-management.md)
+* [Docs Portal Generation-Async](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/controllers/docs-portal-generation-async.md)
+* [API Validation-External APIs](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/controllers/api-validation-external-apis.md)
+* [API Validation V2-External APIs](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/controllers/api-validation-v2-external-apis.md)
+* [SDK Generation-Async](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/controllers/sdk-generation-async.md)
+* [Transformation](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/controllers/transformation.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/apimatic-ruby-sdk/tree/3.0.1/doc/date-time-helper.md)
+

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# Load the lib folder into Ruby's load path
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+# Require the gem
+require 'apimatic_api'
+
+puts 'ApimaticApi SDK loaded!'
+puts 'You can now create a client with: client = ApimaticApi::Client.new'
+puts 'Or use from_env: client = ApimaticApi::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/apimatic_api/api_helper.rb

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

data/lib/apimatic_api/client.rb

@@ -1,96 +1,108 @@
-# apimatic_api
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module ApimaticApi
-  #  apimatic_api client class.
-  class Client
-    include CoreLibrary
-    attr_reader :config, :auth_managers
-
-    # Access to apis_management controller.
-    # @return [ApisManagementController] Returns the controller instance.
-    def apis_management
-      @apis_management ||= ApisManagementController.new @global_configuration
-    end
-
-    # Access to code_generation_imported_apis controller.
-    # @return [CodeGenerationImportedApisController] Returns the controller instance.
-    def code_generation_imported_apis
-      @code_generation_imported_apis ||= CodeGenerationImportedApisController.new @global_configuration
-    end
-
-    # Access to code_generation_external_apis controller.
-    # @return [CodeGenerationExternalApisController] Returns the controller instance.
-    def code_generation_external_apis
-      @code_generation_external_apis ||= CodeGenerationExternalApisController.new @global_configuration
-    end
-
-    # Access to transformation controller.
-    # @return [TransformationController] Returns the controller instance.
-    def transformation
-      @transformation ||= TransformationController.new @global_configuration
-    end
-
-    # Access to docs_portal_management controller.
-    # @return [DocsPortalManagementController] Returns the controller instance.
-    def docs_portal_management
-      @docs_portal_management ||= DocsPortalManagementController.new @global_configuration
-    end
-
-    # Access to api_validation_imported_apis controller.
-    # @return [APIValidationImportedApisController] Returns the controller instance.
-    def api_validation_imported_apis
-      @api_validation_imported_apis ||= APIValidationImportedApisController.new @global_configuration
-    end
-
-    # Access to api_validation_external_apis controller.
-    # @return [APIValidationExternalApisController] Returns the controller instance.
-    def api_validation_external_apis
-      @api_validation_external_apis ||= APIValidationExternalApisController.new @global_configuration
-    end
-
-    def initialize(
-      connection: nil, adapter: :net_http_persistent, timeout: 60,
-      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,
-      environment: Environment::PRODUCTION, authorization: nil,
-      custom_header_authentication_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,
-                    environment: environment, authorization: authorization,
-                    custom_header_authentication_credentials: custom_header_authentication_credentials
-                  )
-                else
-                  config
-                end
-
-      @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)
-
-      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[Authorization].each { |auth| @auth_managers[auth] = nil }
-      @auth_managers['Authorization'] = CustomHeaderAuthentication.new(
-        http_client_config.custom_header_authentication_credentials
-      )
-    end
-  end
-end
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApimaticApi
+  #  apimatic_api client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    # Access to code_generation_external_apis controller.
+    # @return [CodeGenerationExternalApisController] Returns the controller instance.
+    def code_generation_external_apis
+      @code_generation_external_apis ||= CodeGenerationExternalApisController.new @global_configuration
+    end
+
+    # Access to transformation controller.
+    # @return [TransformationController] Returns the controller instance.
+    def transformation
+      @transformation ||= TransformationController.new @global_configuration
+    end
+
+    # Access to docs_portal_management controller.
+    # @return [DocsPortalManagementController] Returns the controller instance.
+    def docs_portal_management
+      @docs_portal_management ||= DocsPortalManagementController.new @global_configuration
+    end
+
+    # Access to docs_portal_generation_async controller.
+    # @return [DocsPortalGenerationAsyncController] Returns the controller instance.
+    def docs_portal_generation_async
+      @docs_portal_generation_async ||= DocsPortalGenerationAsyncController.new @global_configuration
+    end
+
+    # Access to api_validation_external_apis controller.
+    # @return [ApiValidationExternalApisController] Returns the controller instance.
+    def api_validation_external_apis
+      @api_validation_external_apis ||= ApiValidationExternalApisController.new @global_configuration
+    end
+
+    # Access to api_validation_v2_external_apis controller.
+    # @return [ApiValidationV2ExternalApisController] Returns the controller instance.
+    def api_validation_v2_external_apis
+      @api_validation_v2_external_apis ||= ApiValidationV2ExternalApisController.new @global_configuration
+    end
+
+    # Access to sdk_generation_async controller.
+    # @return [SdkGenerationAsyncController] Returns the controller instance.
+    def sdk_generation_async
+      @sdk_generation_async ||= SdkGenerationAsyncController.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 30,
+      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,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      custom_url: 'https://localhost:44301/api',
+      custom_header_authentication_credentials: nil,
+      user_agent: 'TODO: Replace', 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, custom_url: custom_url,
+                    custom_header_authentication_credentials: custom_header_authentication_credentials,
+                    user_agent: user_agent
+                  )
+                else
+                  config
+                end
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseController::GLOBAL_ERRORS)
+                                                 .global_header('user-agent', @config.user_agent)
+
+      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[Authorization].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['Authorization'] = CustomHeaderAuthentication.new(
+        http_client_config.custom_header_authentication_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