sdksio-apimatic-sdk 3.0.0

checksums.yaml

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

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2024 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,82 @@
+
+# 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(
+  custom_header_authentication_credentials: CustomHeaderAuthenticationCredentials.new(
+    authorization: 'Authorization'
+  )
+)
+```
+
+## 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)
+

data/lib/apimatic_api/api_helper.rb

@@ -0,0 +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

data/lib/apimatic_api/client.rb

@@ -0,0 +1,96 @@
+# 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

data/lib/apimatic_api/configuration.rb

@@ -0,0 +1,125 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # An enum for SDK environments.
+  class Environment
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze
+    ].freeze
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze
+    ].freeze
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    def authorization
+      @custom_header_authentication_credentials.authorization
+    end
+
+    # The attribute readers for properties.
+    attr_reader :environment, :custom_header_authentication_credentials
+
+    class << self
+      attr_reader :environments
+    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
+    )
+
+      super 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
+
+      # Current API environment
+      @environment = String(environment)
+
+      # Auth Header. Provide your Auth key in the format `X-Auth-Key {auth-key}`.
+      @authorization = authorization
+
+      # Initializing Custom Header Signature credentials with the provided auth parameters
+      @custom_header_authentication_credentials = create_auth_credentials_object(
+        authorization, custom_header_authentication_credentials
+      )
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   environment: nil, authorization: nil,
+                   custom_header_authentication_credentials: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      environment ||= self.environment
+      custom_header_authentication_credentials = create_auth_credentials_object(
+        authorization,
+        custom_header_authentication_credentials || self.custom_header_authentication_credentials
+      )
+
+      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,
+        custom_header_authentication_credentials: custom_header_authentication_credentials
+      )
+    end
+
+    def create_auth_credentials_object(authorization,
+                                       custom_header_authentication_credentials)
+      return custom_header_authentication_credentials if authorization.nil?
+
+      warn('The \'authorization\' params are deprecated. Use \'custom_header_a'\
+           'uthentication_credentials\' param instead.')
+
+      unless custom_header_authentication_credentials.nil?
+        return custom_header_authentication_credentials.clone_with(
+          authorization: authorization
+        )
+      end
+
+      CustomHeaderAuthenticationCredentials.new(authorization: authorization)
+    end
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://api.apimatic.io'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      ENVIRONMENTS[environment][server].clone
+    end
+  end
+end

data/lib/apimatic_api/controllers/api_validation_external_apis_controller.rb

@@ -0,0 +1,84 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # APIValidationExternalApisController
+  class APIValidationExternalApisController < BaseController
+    # Validate an API by uploading the API specification file.
+    # You can also specify [API
+    # Metadata](https://docs.apimatic.io/manage-apis/apimatic-metadata) while
+    # validating the API using this endpoint. When specifying Metadata, the
+    # uploaded file will be a zip file containing the API specification file and
+    # the `APIMATIC-META` json file.
+    # @param [File | UploadIO] file Required parameter: The API specification
+    # file.<br>The type of the specification file should be any of the
+    # [supported
+    # formats](https://docs.apimatic.io/api-transformer/overview-transformer#sup
+    # ported-input-formats).
+    # @return [ApiValidationSummary] response from the API call
+    def validate_api_via_file(file)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/validation/validate-via-file',
+                                     Server::DEFAULT)
+                   .multipart_param(new_parameter(file, key: 'file')
+                                     .default_content_type('application/octet-stream'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ApiValidationSummary.method(:from_hash))
+                   .local_error('400',
+                                'Bad Request',
+                                APIException)
+                   .local_error('401',
+                                'Unauthenticated',
+                                APIException)
+                   .local_error('403',
+                                'Forbidden',
+                                APIException)
+                   .local_error('500',
+                                'Internal Server Error',
+                                APIException))
+        .execute
+    end
+
+    # Validate an API by providing the URL of the API specification file.
+    # You can also specify [API
+    # Metadata](https://docs.apimatic.io/manage-apis/apimatic-metadata) while
+    # validating the API using this endpoint. When specifying Metadata, the URL
+    # provided will be that of a zip file containing the API specification file
+    # and the `APIMATIC-META` json file.
+    # @param [String] description_url Required parameter: The URL for the API
+    # specification file.<br><br>**Note:** This URL should be publicly
+    # accessible.
+    # @return [ApiValidationSummary] response from the API call
+    def validate_api_via_url(description_url)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/validation/validate-via-url',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(description_url, key: 'descriptionUrl'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ApiValidationSummary.method(:from_hash))
+                   .local_error('400',
+                                'Bad Request',
+                                APIException)
+                   .local_error('401',
+                                'Unauthenticated',
+                                APIException)
+                   .local_error('403',
+                                'Forbidden',
+                                APIException)
+                   .local_error('500',
+                                'Internal Server Error',
+                                APIException))
+        .execute
+    end
+  end
+end

data/lib/apimatic_api/controllers/api_validation_imported_apis_controller.rb

@@ -0,0 +1,74 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # APIValidationImportedApisController
+  class APIValidationImportedApisController < BaseController
+    # Validate an API using the [APIMatic
+    # Validator](https://docs.apimatic.io/generate-sdks/overview-sdks#step-2-api
+    # -validation).
+    # @param [String] api_entity_id Required parameter: The ID of the API Entity
+    # to perform validation for.
+    # @return [ApiValidationSummary] response from the API call
+    def validate_api(api_entity_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api-entities/{api_entity_id}/api-validation-summary',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(api_entity_id, key: 'api_entity_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ApiValidationSummary.method(:from_hash))
+                   .local_error('400',
+                                'Bad Request',
+                                APIException)
+                   .local_error('403',
+                                'Forbidden',
+                                APIException)
+                   .local_error('404',
+                                'API not found',
+                                APIException)
+                   .local_error('500',
+                                'Internal Server Error',
+                                APIException))
+        .execute
+    end
+
+    # Validate an API for documentation generation. This process validates the
+    # API for missing examples or missing descriptions.
+    # @param [String] api_entity_id Required parameter: The ID of the API Entity
+    # to perform validation for.
+    # @return [DocsValidationSummary] response from the API call
+    def validate_api_for_docs(api_entity_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api-entities/{api_entity_id}/docs-validation-summary',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(api_entity_id, key: 'api_entity_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(DocsValidationSummary.method(:from_hash))
+                   .local_error('400',
+                                'Bad Request',
+                                APIException)
+                   .local_error('403',
+                                'Forbidden',
+                                APIException)
+                   .local_error('404',
+                                'API not found',
+                                APIException)
+                   .local_error('500',
+                                'Internal Server Error',
+                                APIException))
+        .execute
+    end
+  end
+end