dotissue-sdk 1.2.36

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c9768ebb15a174547c396b436aba9eef5f38c6ce5ec8c892d3c355b8c7dab7e
+  data.tar.gz: 393b11b804349f59a6957bcb2d7e725cb8a3e8e28e53eda983fb74502a98abdd
+SHA512:
+  metadata.gz: 24c81359879d367d4317de806e2c435fe90b730a7ab25ba375013cafbaf18e2d0a35699e24c6e99762a53a7bc39ad74bda37b91d172dc24d7643e9576592dd39
+  data.tar.gz: d21b9e134ee29f7666d01ecb96da946988e23f7d586abefa0bce1b8721b02e4a6d207967e84d40c2972844f44a62ea521bc9f7ec2200141bb521b96e7d9d8000

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,83 @@
+
+# Getting Started with Untitled API
+
+## Install the Package
+
+Install the gem from the command line:
+
+```ruby
+gem install dotissue-sdk -v 1.2.36
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'dotissue-sdk', '1.2.36'
+```
+
+For additional gem details, see the [RubyGems page for the dotissue-sdk gem](https://rubygems.org/gems/dotissue-sdk/versions/1.2.36).
+
+## 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/syed-subtain/dotissue-ruby-sdk/tree/1.2.36/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| `default_host` | `String` | *Default*: `'www.example.com'` |
+| `environment` | `Environment` | 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. |
+| `custom_header_authentication_credentials` | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/syed-subtain/dotissue-ruby-sdk/tree/1.2.36/doc/$a/https://www.github.com/syed-subtain/dotissue-ruby-sdk/tree/1.2.36/custom-header-signature.md) | The credential object for Custom Header Signature |
+
+The API client can be initialized as follows:
+
+```ruby
+client = UntitledApi::Client.new(
+  custom_header_authentication_credentials: CustomHeaderAuthenticationCredentials.new(
+    authorization: 'Authorization'
+  ),
+  environment: Environment::PRODUCTION,
+  default_host: 'www.example.com'
+)
+```
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`tokenAuth (Custom Header Signature)`](https://www.github.com/syed-subtain/dotissue-ruby-sdk/tree/1.2.36/doc/$a/https://www.github.com/syed-subtain/dotissue-ruby-sdk/tree/1.2.36/custom-header-signature.md)
+
+## List of APIs
+
+* [About](https://www.github.com/syed-subtain/dotissue-ruby-sdk/tree/1.2.36/doc/controllers/about.md)
+* [Api](https://www.github.com/syed-subtain/dotissue-ruby-sdk/tree/1.2.36/doc/controllers/api.md)
+* [Internal](https://www.github.com/syed-subtain/dotissue-ruby-sdk/tree/1.2.36/doc/controllers/internal.md)
+* [Manuf](https://www.github.com/syed-subtain/dotissue-ruby-sdk/tree/1.2.36/doc/controllers/manuf.md)
+* [Portal](https://www.github.com/syed-subtain/dotissue-ruby-sdk/tree/1.2.36/doc/controllers/portal.md)
+* [Search](https://www.github.com/syed-subtain/dotissue-ruby-sdk/tree/1.2.36/doc/controllers/search.md)
+* [Tardis](https://www.github.com/syed-subtain/dotissue-ruby-sdk/tree/1.2.36/doc/controllers/tardis.md)
+* [Tdb](https://www.github.com/syed-subtain/dotissue-ruby-sdk/tree/1.2.36/doc/controllers/tdb.md)
+
+## Classes Documentation
+
+* [Utility Classes](https://www.github.com/syed-subtain/dotissue-ruby-sdk/tree/1.2.36/doc/utility-classes.md)
+* [HttpResponse](https://www.github.com/syed-subtain/dotissue-ruby-sdk/tree/1.2.36/doc/http-response.md)
+* [HttpRequest](https://www.github.com/syed-subtain/dotissue-ruby-sdk/tree/1.2.36/doc/http-request.md)
+

data/lib/untitled_api/api_helper.rb

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

data/lib/untitled_api/client.rb

@@ -0,0 +1,104 @@
+# untitled_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module UntitledApi
+  #  untitled_api client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    # Access to about controller.
+    # @return [AboutController] Returns the controller instance.
+    def about
+      @about ||= AboutController.new @global_configuration
+    end
+
+    # Access to api controller.
+    # @return [ApiController] Returns the controller instance.
+    def api
+      @api ||= ApiController.new @global_configuration
+    end
+
+    # Access to internal controller.
+    # @return [InternalController] Returns the controller instance.
+    def internal
+      @internal ||= InternalController.new @global_configuration
+    end
+
+    # Access to manuf controller.
+    # @return [ManufController] Returns the controller instance.
+    def manuf
+      @manuf ||= ManufController.new @global_configuration
+    end
+
+    # Access to portal controller.
+    # @return [PortalController] Returns the controller instance.
+    def portal
+      @portal ||= PortalController.new @global_configuration
+    end
+
+    # Access to search controller.
+    # @return [SearchController] Returns the controller instance.
+    def search
+      @search ||= SearchController.new @global_configuration
+    end
+
+    # Access to tardis controller.
+    # @return [TardisController] Returns the controller instance.
+    def tardis
+      @tardis ||= TardisController.new @global_configuration
+    end
+
+    # Access to tdb controller.
+    # @return [TdbController] Returns the controller instance.
+    def tdb
+      @tdb ||= TdbController.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],
+      retry_methods: %i[get put], http_callback: nil,
+      environment: Environment::PRODUCTION, default_host: 'www.example.com',
+      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, default_host: default_host,
+                    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[tokenAuth].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['tokenAuth'] = CustomHeaderAuthentication.new(
+        http_client_config.custom_header_authentication_credentials
+      )
+    end
+  end
+end

data/lib/untitled_api/configuration.rb

@@ -0,0 +1,135 @@
+# untitled_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module UntitledApi
+  # 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, :default_host,
+                :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],
+      retry_methods: %i[get put], http_callback: nil,
+      environment: Environment::PRODUCTION, default_host: 'www.example.com',
+      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)
+
+      # defaultHost value
+      @default_host = default_host
+
+      # Token-based authentication with required prefix "Token"
+      @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, default_host: 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
+      default_host ||= self.default_host
+      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, default_host: default_host,
+        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://{defaultHost}'
+      }
+    }.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)
+      parameters = {
+        'defaultHost' => { 'value' => default_host, 'encode' => false }
+      }
+      APIHelper.append_url_with_template_parameters(
+        ENVIRONMENTS[environment][server], parameters
+      )
+    end
+  end
+end

data/lib/untitled_api/controllers/about_controller.rb

@@ -0,0 +1,24 @@
+# untitled_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module UntitledApi
+  # AboutController
+  class AboutController < BaseController
+    # TODO: type endpoint description here
+    # @return [AboutResponse1] response from the API call
+    def about_retrieve
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/about',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('tokenAuth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(AboutResponse1.method(:from_hash)))
+        .execute
+    end
+  end
+end