demo-vender 1.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb4e260a06a44ab1f1ee5454dfa6ae55bf640008baf82664f22fe9acc9492081
+  data.tar.gz: f6b0068e256901466a1899be3505598905afa38c8ff1f9444e6c3d5a486fa7ea
+SHA512:
+  metadata.gz: 34988fc5c582f9b1871e9f60e084e367f658d27f38f9b0a4ac36d0cc8134af0f286043d636e8a4de045bba485a754676f3dda2ba26662d52743662c1730bdee4
+  data.tar.gz: 985fbaa01bd3aac5073301c38a069578b70a2209b8acd4685b74b08793e38ccc29e3c8e83e2d5d3e57650e74e4b221210b18db68edca137954bcf305fa5064a0

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+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
+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,173 @@
+
+# Getting Started with Swagger Petstore - OpenAPI 3.0
+
+## Introduction
+
+Sample Pet Store Server based on the OpenAPI 3.0 specification.
+
+Find out more about Swagger: [https://swagger.io](https://swagger.io)
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install demo-vender -v 1.5.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'demo-vender', '1.5.0'
+```
+
+For additional gem details, see the [RubyGems page for the demo-vender gem](https://rubygems.org/gems/demo-vender/versions/1.5.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 'swagger_petstore_open_api30'
+include SwaggerPetstoreOpenApi30
+```
+
+### 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/swagger_petstore_open_api30
+```
+
+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 |
+|  --- | --- | --- |
+| environment | [`Environment`](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, 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 |
+| petstore_auth_credentials | [`PetstoreAuthCredentials`](doc/auth/oauth-2-implicit-grant.md) | The credential object for OAuth 2 Implicit Grant |
+| api_key_credentials | [`ApiKeyCredentials`](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 'swagger_petstore_open_api30'
+include SwaggerPetstoreOpenApi30
+
+client = Client.new(
+  petstore_auth_credentials: PetstoreAuthCredentials.new(
+    oauth_client_id: 'OAuthClientId',
+    oauth_redirect_uri: 'OAuthRedirectUri',
+    oauth_scopes: [
+      OauthScopePetstoreAuth::WRITEPETS,
+      OauthScopePetstoreAuth::READPETS
+    ]
+  ),
+  api_key_credentials: ApiKeyCredentials.new(
+    api_key: 'api_key'
+  ),
+  environment: Environment::PRODUCTION,
+  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 'swagger_petstore_open_api30'
+include SwaggerPetstoreOpenApi30
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](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** |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`petstore_auth (OAuth 2 Implicit Grant)`](doc/auth/oauth-2-implicit-grant.md)
+* [`api_key (Custom Header Signature)`](doc/auth/custom-header-signature.md)
+
+## List of APIs
+
+* [Pet](doc/controllers/pet.md)
+* [Store](doc/controllers/store.md)
+* [User](doc/controllers/user.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [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](doc/http-response.md)
+* [HttpRequest](doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](doc/api-response.md)
+* [ApiHelper](doc/api-helper.md)
+* [DateTimeHelper](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 'swagger_petstore_open_api30'
+
+puts 'SwaggerPetstoreOpenApi30 SDK loaded!'
+puts 'You can now create a client with: client = SwaggerPetstoreOpenApi30::Client.new'
+puts 'Or use from_env: client = SwaggerPetstoreOpenApi30::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/swagger_petstore_open_api30/api_helper.rb

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

data/lib/swagger_petstore_open_api30/apis/base_api.rb

@@ -0,0 +1,67 @@
+# swagger_petstore_open_api30
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module SwaggerPetstoreOpenApi30
+  # BaseApi.
+  class BaseApi
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'Ruby-SDK/1.5.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 = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end

data/lib/swagger_petstore_open_api30/apis/pet_api.rb

@@ -0,0 +1,287 @@
+# swagger_petstore_open_api30
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module SwaggerPetstoreOpenApi30
+  # PetApi
+  class PetApi < BaseApi
+    # Update an existing pet by Id.
+    # @param [String] name Required parameter: TODO: type description here
+    # @param [Array[String]] photo_urls Required parameter: TODO: type
+    # description here
+    # @param [Integer] id Optional parameter: TODO: type description here
+    # @param [Category] category Optional parameter: TODO: type description
+    # here
+    # @param [Array[Tag]] tags Optional parameter: TODO: type description here
+    # @param [PetStatus] status Optional parameter: pet status in the store
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_pet(name,
+                   photo_urls,
+                   id: nil,
+                   category: nil,
+                   tags: nil,
+                   status: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/pet',
+                                     Server::DEFAULT)
+                   .form_param(new_parameter(name, key: 'name')
+                                .is_required(true))
+                   .form_param(new_parameter(photo_urls, key: 'photoUrls')
+                                .is_required(true))
+                   .form_param(new_parameter(id, key: 'id'))
+                   .form_param(new_parameter(category, key: 'category'))
+                   .form_param(new_parameter(tags, key: 'tags'))
+                   .form_param(new_parameter(status, key: 'status'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('petstore_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Pet.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid ID supplied',
+                                 APIException)
+                    .local_error('404',
+                                 'Pet not found',
+                                 APIException)
+                    .local_error('422',
+                                 'Validation exception',
+                                 APIException)
+                    .local_error('default',
+                                 'Unexpected error',
+                                 APIException))
+        .execute
+    end
+
+    # Add a new pet to the store.
+    # @param [String] name Required parameter: TODO: type description here
+    # @param [Array[String]] photo_urls Required parameter: TODO: type
+    # description here
+    # @param [Integer] id Optional parameter: TODO: type description here
+    # @param [Category] category Optional parameter: TODO: type description
+    # here
+    # @param [Array[Tag]] tags Optional parameter: TODO: type description here
+    # @param [PetStatus] status Optional parameter: pet status in the store
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def add_pet(name,
+                photo_urls,
+                id: nil,
+                category: nil,
+                tags: nil,
+                status: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/pet',
+                                     Server::DEFAULT)
+                   .form_param(new_parameter(name, key: 'name')
+                                .is_required(true))
+                   .form_param(new_parameter(photo_urls, key: 'photoUrls')
+                                .is_required(true))
+                   .form_param(new_parameter(id, key: 'id'))
+                   .form_param(new_parameter(category, key: 'category'))
+                   .form_param(new_parameter(tags, key: 'tags'))
+                   .form_param(new_parameter(status, key: 'status'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('petstore_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Pet.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid input',
+                                 APIException)
+                    .local_error('422',
+                                 'Validation exception',
+                                 APIException)
+                    .local_error('default',
+                                 'Unexpected error',
+                                 APIException))
+        .execute
+    end
+
+    # Multiple status values can be provided with comma separated strings.
+    # @param [PetStatus] status Optional parameter: Status values that need to
+    # be considered for filter
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def find_pets_by_status(status: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/pet/findByStatus',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(status, key: 'status'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('petstore_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Pet.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('400',
+                                 'Invalid status value',
+                                 APIException)
+                    .local_error('default',
+                                 'Unexpected error',
+                                 APIException))
+        .execute
+    end
+
+    # Multiple tags can be provided with comma separated strings. Use tag1,
+    # tag2, tag3 for testing.
+    # @param [Array[String]] tags Optional parameter: Tags to filter by
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def find_pets_by_tags(tags: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/pet/findByTags',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(tags, key: 'tags'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('petstore_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Pet.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('400',
+                                 'Invalid tag value',
+                                 APIException)
+                    .local_error('default',
+                                 'Unexpected error',
+                                 APIException))
+        .execute
+    end
+
+    # Returns a single pet.
+    # @param [Integer] pet_id Required parameter: ID of pet to return
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_pet_by_id(pet_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/pet/{petId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(pet_id, key: 'petId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('api_key', 'petstore_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Pet.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid ID supplied',
+                                 APIException)
+                    .local_error('404',
+                                 'Pet not found',
+                                 APIException)
+                    .local_error('default',
+                                 'Unexpected error',
+                                 APIException))
+        .execute
+    end
+
+    # Updates a pet resource based on the form data.
+    # @param [Integer] pet_id Required parameter: ID of pet that needs to be
+    # updated
+    # @param [String] name Optional parameter: Name of pet that needs to be
+    # updated
+    # @param [String] status Optional parameter: Status of pet that needs to be
+    # updated
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_pet_with_form(pet_id,
+                             name: nil,
+                             status: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/pet/{petId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(pet_id, key: 'petId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(name, key: 'name'))
+                   .query_param(new_parameter(status, key: 'status'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('petstore_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Pet.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid input',
+                                 APIException)
+                    .local_error('default',
+                                 'Unexpected error',
+                                 APIException))
+        .execute
+    end
+
+    # Delete a pet.
+    # @param [Integer] pet_id Required parameter: Pet id to delete
+    # @param [String] api_key Optional parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_pet(pet_id,
+                   api_key: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/pet/{petId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(pet_id, key: 'petId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(api_key, key: 'api_key'))
+                   .auth(Single.new('petstore_auth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid pet value',
+                                 APIException)
+                    .local_error('default',
+                                 'Unexpected error',
+                                 APIException))
+        .execute
+    end
+
+    # Upload image of the pet.
+    # @param [Integer] pet_id Required parameter: ID of pet to update
+    # @param [String] additional_metadata Optional parameter: Additional
+    # Metadata
+    # @param [File | UploadIO] body Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def upload_file(pet_id,
+                    additional_metadata: nil,
+                    body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/pet/{petId}/uploadImage',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(pet_id, key: 'petId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(additional_metadata, key: 'additionalMetadata'))
+                   .multipart_param(new_parameter(body, key: 'body')
+                                     .default_content_type('application/octet-stream'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('petstore_auth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ApiResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'No file uploaded',
+                                 APIException)
+                    .local_error('404',
+                                 'Pet not found',
+                                 APIException)
+                    .local_error('default',
+                                 'Unexpected error',
+                                 APIException))
+        .execute
+    end
+  end
+end