wesley-key-sdk 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +28 -0
  3. data/README.md +126 -0
  4. data/lib/swagger_petstore/api_helper.rb +10 -0
  5. data/lib/swagger_petstore/client.rb +84 -0
  6. data/lib/swagger_petstore/configuration.rb +127 -0
  7. data/lib/swagger_petstore/controllers/base_controller.rb +60 -0
  8. data/lib/swagger_petstore/controllers/pet_controller.rb +206 -0
  9. data/lib/swagger_petstore/controllers/store_controller.rb +94 -0
  10. data/lib/swagger_petstore/controllers/user_controller.rb +165 -0
  11. data/lib/swagger_petstore/exceptions/api_exception.rb +21 -0
  12. data/lib/swagger_petstore/exceptions/o_auth_provider_exception.rb +64 -0
  13. data/lib/swagger_petstore/http/auth/api_key.rb +42 -0
  14. data/lib/swagger_petstore/http/auth/http_basic.rb +50 -0
  15. data/lib/swagger_petstore/http/auth/petstore_auth.rb +98 -0
  16. data/lib/swagger_petstore/http/http_call_back.rb +10 -0
  17. data/lib/swagger_petstore/http/http_method_enum.rb +10 -0
  18. data/lib/swagger_petstore/http/http_request.rb +10 -0
  19. data/lib/swagger_petstore/http/http_response.rb +10 -0
  20. data/lib/swagger_petstore/http/proxy_settings.rb +13 -0
  21. data/lib/swagger_petstore/models/api_response.rb +81 -0
  22. data/lib/swagger_petstore/models/base_model.rb +110 -0
  23. data/lib/swagger_petstore/models/category.rb +71 -0
  24. data/lib/swagger_petstore/models/category2.rb +71 -0
  25. data/lib/swagger_petstore/models/content_type_enum.rb +20 -0
  26. data/lib/swagger_petstore/models/o_auth_provider_error_enum.rb +45 -0
  27. data/lib/swagger_petstore/models/o_auth_scope_petstore_auth_enum.rb +23 -0
  28. data/lib/swagger_petstore/models/o_auth_token.rb +96 -0
  29. data/lib/swagger_petstore/models/order.rb +120 -0
  30. data/lib/swagger_petstore/models/pet.rb +117 -0
  31. data/lib/swagger_petstore/models/pet_request.rb +117 -0
  32. data/lib/swagger_petstore/models/status1_enum.rb +26 -0
  33. data/lib/swagger_petstore/models/status2_enum.rb +26 -0
  34. data/lib/swagger_petstore/models/status_enum.rb +26 -0
  35. data/lib/swagger_petstore/models/store_order_request.rb +120 -0
  36. data/lib/swagger_petstore/models/tag.rb +71 -0
  37. data/lib/swagger_petstore/models/user.rb +132 -0
  38. data/lib/swagger_petstore/models/user_request.rb +132 -0
  39. data/lib/swagger_petstore/utilities/date_time_helper.rb +11 -0
  40. data/lib/swagger_petstore/utilities/file_wrapper.rb +28 -0
  41. data/lib/swagger_petstore.rb +62 -0
  42. data/test/controllers/controller_test_base.rb +37 -0
  43. data/test/controllers/test_store_controller.rb +31 -0
  44. data/test/http_response_catcher.rb +19 -0
  45. metadata +156 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 1b7f68e0d65c4e998b5166bca622f595cb3752cd8109a9cbddafda349e10d87e
4
+ data.tar.gz: 3c6f5657cadf1efb23a2a2f5236da7b41555ddb2bed71e96443857b515c9d412
5
+ SHA512:
6
+ metadata.gz: da0d9f1aa80e9ff43402e330a6c1c4dff22193565eaf04d9266ad637b9cc008fa82244dffbc946508b2701876d1749c94dcc5b92698184f37e895432761af691
7
+ data.tar.gz: d95ea0a4b26234419259772005030bc8beafe989e1d82df03a639bf0065ab6d52fdf70b5d33057458062c9f9da864e1edb032c26fa67298b7453fee12a15347e
data/LICENSE ADDED
@@ -0,0 +1,28 @@
1
+ License:
2
+ ========
3
+ The MIT License (MIT)
4
+ http://opensource.org/licenses/MIT
5
+
6
+ Copyright (c) 2014 - 2025 APIMATIC Limited
7
+
8
+ Permission is hereby granted, free of charge, to any person obtaining a copy
9
+ of this software and associated documentation files (the "Software"), to deal
10
+ in the Software without restriction, including without limitation the rights
11
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12
+ copies of the Software, and to permit persons to whom the Software is
13
+ furnished to do so, subject to the following conditions:
14
+
15
+ The above copyright notice and this permission notice shall be included in
16
+ all copies or substantial portions of the Software.
17
+
18
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24
+ THE SOFTWARE.
25
+
26
+ Trade Mark:
27
+ ==========
28
+ APIMATIC is a trade mark for APIMATIC Limited
data/README.md ADDED
@@ -0,0 +1,126 @@
1
+
2
+ # Getting Started with Swagger Petstore
3
+
4
+ ## Introduction
5
+
6
+ This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.
7
+
8
+ Find out more about Swagger: [http://swagger.io](http://swagger.io)
9
+
10
+ ## Install the Package
11
+
12
+ Install the gem from the command line:
13
+
14
+ ```bash
15
+ gem install wesley-key-sdk -v 0.1.2
16
+ ```
17
+
18
+ Or add the gem to your Gemfile and run `bundle`:
19
+
20
+ ```ruby
21
+ gem 'wesley-key-sdk', '0.1.2'
22
+ ```
23
+
24
+ For additional gem details, see the [RubyGems page for the wesley-key-sdk gem](https://rubygems.org/gems/wesley-key-sdk/versions/0.1.2).
25
+
26
+ ## Test the SDK
27
+
28
+ To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:
29
+
30
+ ```
31
+ rake
32
+ ```
33
+
34
+ ## Initialize the API Client
35
+
36
+ **_Note:_** Documentation for the client can be found [here.](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.2/doc/client.md)
37
+
38
+ The following parameters are configurable for the API Client:
39
+
40
+ | Parameter | Type | Description |
41
+ | --- | --- | --- |
42
+ | test_header | `String` | This is a test header<br>*Default*: `'TestHeaderDefaultValue'` |
43
+ | environment | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION`** |
44
+ | connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
45
+ | adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
46
+ | timeout | `Float` | The value to use for connection timeout. <br> **Default: 60** |
47
+ | max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
48
+ | retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
49
+ | backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
50
+ | retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
51
+ | retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
52
+ | http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
53
+ | proxy_settings | [`ProxySettings`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.2/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
54
+ | api_key_credentials | [`ApiKeyCredentials`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.2/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
55
+ | http_basic_credentials | [`HttpBasicCredentials`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.2/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
56
+ | petstore_auth_credentials | [`PetstoreAuthCredentials`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.2/doc/auth/oauth-2-implicit-grant.md) | The credential object for OAuth 2 Implicit Grant |
57
+
58
+ The API client can be initialized as follows:
59
+
60
+ ```ruby
61
+ require 'swagger_petstore'
62
+ include SwaggerPetstore
63
+
64
+ client = Client.new(
65
+ test_header: 'TestHeaderDefaultValue',
66
+ api_key_credentials: ApiKeyCredentials.new(
67
+ api_key: 'api_key'
68
+ ),
69
+ http_basic_credentials: HttpBasicCredentials.new(
70
+ username: 'username',
71
+ passwprd: 'passwprd'
72
+ ),
73
+ petstore_auth_credentials: PetstoreAuthCredentials.new(
74
+ o_auth_client_id: 'OAuthClientId',
75
+ o_auth_redirect_uri: 'OAuthRedirectUri',
76
+ o_auth_scopes: [
77
+ OAuthScopePetstoreAuthEnum::READPETS,
78
+ OAuthScopePetstoreAuthEnum::WRITEPETS
79
+ ]
80
+ ),
81
+ environment: Environment::PRODUCTION
82
+ )
83
+ ```
84
+
85
+ ## Environments
86
+
87
+ The SDK can be configured to use a different environment for making API calls. Available environments are:
88
+
89
+ ### Fields
90
+
91
+ | Name | Description |
92
+ | --- | --- |
93
+ | production | **Default** |
94
+ | environment2 | - |
95
+ | environment3 | - |
96
+
97
+ ## Authorization
98
+
99
+ This API uses the following authentication schemes.
100
+
101
+ * [`api_key (Custom Header Signature)`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.2/doc/auth/custom-header-signature.md)
102
+ * [`httpBasic (Basic Authentication)`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.2/doc/auth/basic-authentication.md)
103
+ * [`petstore_auth (OAuth 2 Implicit Grant)`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.2/doc/auth/oauth-2-implicit-grant.md)
104
+
105
+ ## List of APIs
106
+
107
+ * [Pet](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.2/doc/controllers/pet.md)
108
+ * [Store](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.2/doc/controllers/store.md)
109
+ * [User](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.2/doc/controllers/user.md)
110
+
111
+ ## SDK Infrastructure
112
+
113
+ ### Configuration
114
+
115
+ * [ProxySettings](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.2/doc/proxy-settings.md)
116
+
117
+ ### HTTP
118
+
119
+ * [HttpResponse](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.2/doc/http-response.md)
120
+ * [HttpRequest](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.2/doc/http-request.md)
121
+
122
+ ### Utilities
123
+
124
+ * [ApiHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.2/doc/api-helper.md)
125
+ * [DateTimeHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.2/doc/date-time-helper.md)
126
+
@@ -0,0 +1,10 @@
1
+ # swagger_petstore
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0
4
+ # ( https://www.apimatic.io ).
5
+
6
+ module SwaggerPetstore
7
+ # API utility class
8
+ class APIHelper < CoreLibrary::ApiHelper
9
+ end
10
+ end
@@ -0,0 +1,84 @@
1
+ # swagger_petstore
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0
4
+ # ( https://www.apimatic.io ).
5
+
6
+ module SwaggerPetstore
7
+ # swagger_petstore client class.
8
+ class Client
9
+ include CoreLibrary
10
+ attr_reader :config, :auth_managers
11
+
12
+ # Returns the configured authentication petstore_auth instance.
13
+ def petstore_auth
14
+ @auth_managers['petstore_auth']
15
+ end
16
+
17
+ # Access to pet controller.
18
+ # @return [PetController] Returns the controller instance.
19
+ def pet
20
+ @pet ||= PetController.new @global_configuration
21
+ end
22
+
23
+ # Access to store controller.
24
+ # @return [StoreController] Returns the controller instance.
25
+ def store
26
+ @store ||= StoreController.new @global_configuration
27
+ end
28
+
29
+ # Access to user controller.
30
+ # @return [UserController] Returns the controller instance.
31
+ def user
32
+ @user ||= UserController.new @global_configuration
33
+ end
34
+
35
+ def initialize(
36
+ connection: nil, adapter: :net_http_persistent, timeout: 60,
37
+ max_retries: 0, retry_interval: 1, backoff_factor: 2,
38
+ retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
39
+ retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
40
+ environment: Environment::PRODUCTION, api_key_credentials: nil,
41
+ http_basic_credentials: nil, petstore_auth_credentials: nil,
42
+ test_header: 'TestHeaderDefaultValue', config: nil
43
+ )
44
+ @config = if config.nil?
45
+ Configuration.new(
46
+ connection: connection, adapter: adapter, timeout: timeout,
47
+ max_retries: max_retries, retry_interval: retry_interval,
48
+ backoff_factor: backoff_factor,
49
+ retry_statuses: retry_statuses,
50
+ retry_methods: retry_methods, http_callback: http_callback,
51
+ proxy_settings: proxy_settings, environment: environment,
52
+ api_key_credentials: api_key_credentials,
53
+ http_basic_credentials: http_basic_credentials,
54
+ petstore_auth_credentials: petstore_auth_credentials,
55
+ test_header: test_header
56
+ )
57
+ else
58
+ config
59
+ end
60
+
61
+ @global_configuration = GlobalConfiguration.new(client_configuration: @config)
62
+ .base_uri_executor(@config.method(:get_base_uri))
63
+ .global_errors(BaseController::GLOBAL_ERRORS)
64
+ .user_agent(BaseController.user_agent)
65
+ .global_header('TestHeader', @config.test_header)
66
+
67
+ initialize_auth_managers(@global_configuration)
68
+ @global_configuration = @global_configuration.auth_managers(@auth_managers)
69
+ end
70
+
71
+ # Initializes the auth managers hash used for authenticating API calls.
72
+ # @param [GlobalConfiguration] global_config The global configuration of the SDK)
73
+ def initialize_auth_managers(global_config)
74
+ @auth_managers = {}
75
+ http_client_config = global_config.client_configuration
76
+ %w[api_key httpBasic petstore_auth].each { |auth| @auth_managers[auth] = nil }
77
+ @auth_managers['api_key'] = ApiKey.new(http_client_config.api_key_credentials)
78
+ @auth_managers['httpBasic'] = HttpBasic.new(http_client_config.http_basic_credentials)
79
+ @auth_managers['petstore_auth'] = PetstoreAuth.new(
80
+ http_client_config.petstore_auth_credentials, global_config
81
+ )
82
+ end
83
+ end
84
+ end
@@ -0,0 +1,127 @@
1
+ # swagger_petstore
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0
4
+ # ( https://www.apimatic.io ).
5
+
6
+ module SwaggerPetstore
7
+ # An enum for SDK environments.
8
+ class Environment
9
+ ENVIRONMENT = [
10
+ PRODUCTION = 'production'.freeze,
11
+ ENVIRONMENT2 = 'environment2'.freeze,
12
+ ENVIRONMENT3 = 'environment3'.freeze
13
+ ].freeze
14
+ end
15
+
16
+ # An enum for API servers.
17
+ class Server
18
+ SERVER = [
19
+ DEFAULT = 'default'.freeze
20
+ ].freeze
21
+ end
22
+
23
+ # All configuration including auth info and base URI for the API access
24
+ # are configured in this class.
25
+ class Configuration < CoreLibrary::HttpClientConfiguration
26
+ # The attribute readers for properties.
27
+ attr_reader :environment, :api_key_credentials, :http_basic_credentials,
28
+ :petstore_auth_credentials, :test_header
29
+
30
+ class << self
31
+ attr_reader :environments
32
+ end
33
+
34
+ def initialize(
35
+ connection: nil, adapter: :net_http_persistent, timeout: 60,
36
+ max_retries: 0, retry_interval: 1, backoff_factor: 2,
37
+ retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
38
+ retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
39
+ environment: Environment::PRODUCTION, api_key_credentials: nil,
40
+ http_basic_credentials: nil, petstore_auth_credentials: nil,
41
+ test_header: 'TestHeaderDefaultValue'
42
+ )
43
+ super connection: connection, adapter: adapter, timeout: timeout,
44
+ max_retries: max_retries, retry_interval: retry_interval,
45
+ backoff_factor: backoff_factor, retry_statuses: retry_statuses,
46
+ retry_methods: retry_methods, http_callback: http_callback,
47
+ proxy_settings: proxy_settings
48
+
49
+ # Current API environment
50
+ @environment = String(environment)
51
+
52
+ # The object holding Custom Header Signature credentials
53
+ @api_key_credentials = api_key_credentials
54
+
55
+ # The object holding Basic Authentication credentials
56
+ @http_basic_credentials = http_basic_credentials
57
+
58
+ # The object holding OAuth 2 Implicit Grant credentials
59
+ @petstore_auth_credentials = petstore_auth_credentials
60
+
61
+ # This is a test header
62
+ @test_header = test_header
63
+
64
+ # The Http Client to use for making requests.
65
+ set_http_client CoreLibrary::FaradayClient.new(self)
66
+ end
67
+
68
+ def clone_with(connection: nil, adapter: nil, timeout: nil,
69
+ max_retries: nil, retry_interval: nil, backoff_factor: nil,
70
+ retry_statuses: nil, retry_methods: nil, http_callback: nil,
71
+ proxy_settings: nil, environment: nil,
72
+ api_key_credentials: nil, http_basic_credentials: nil,
73
+ petstore_auth_credentials: nil, test_header: nil)
74
+ connection ||= self.connection
75
+ adapter ||= self.adapter
76
+ timeout ||= self.timeout
77
+ max_retries ||= self.max_retries
78
+ retry_interval ||= self.retry_interval
79
+ backoff_factor ||= self.backoff_factor
80
+ retry_statuses ||= self.retry_statuses
81
+ retry_methods ||= self.retry_methods
82
+ http_callback ||= self.http_callback
83
+ proxy_settings ||= self.proxy_settings
84
+ environment ||= self.environment
85
+ api_key_credentials ||= self.api_key_credentials
86
+ http_basic_credentials ||= self.http_basic_credentials
87
+ petstore_auth_credentials ||= self.petstore_auth_credentials
88
+ test_header ||= self.test_header
89
+
90
+ Configuration.new(connection: connection, adapter: adapter,
91
+ timeout: timeout, max_retries: max_retries,
92
+ retry_interval: retry_interval,
93
+ backoff_factor: backoff_factor,
94
+ retry_statuses: retry_statuses,
95
+ retry_methods: retry_methods,
96
+ http_callback: http_callback,
97
+ proxy_settings: proxy_settings,
98
+ environment: environment,
99
+ api_key_credentials: api_key_credentials,
100
+ http_basic_credentials: http_basic_credentials,
101
+ petstore_auth_credentials: petstore_auth_credentials,
102
+ test_header: test_header)
103
+ end
104
+
105
+
106
+ # All the environments the SDK can run in.
107
+ ENVIRONMENTS = {
108
+ Environment::PRODUCTION => {
109
+ Server::DEFAULT => 'https://petstore.swagger.io/v2'
110
+ },
111
+ Environment::ENVIRONMENT2 => {
112
+ Server::DEFAULT => 'http://petstore.swagger.io/v2'
113
+ },
114
+ Environment::ENVIRONMENT3 => {
115
+ Server::DEFAULT => 'https://petstore.swagger.io/oauth'
116
+ }
117
+ }.freeze
118
+
119
+ # Generates the appropriate base URI for the environment and the server.
120
+ # @param [Configuration::Server] server The server enum for which the base URI is
121
+ # required.
122
+ # @return [String] The base URI.
123
+ def get_base_uri(server = Server::DEFAULT)
124
+ ENVIRONMENTS[environment][server].clone
125
+ end
126
+ end
127
+ end
@@ -0,0 +1,60 @@
1
+ # swagger_petstore
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0
4
+ # ( https://www.apimatic.io ).
5
+
6
+ module SwaggerPetstore
7
+ # BaseController.
8
+ class BaseController
9
+ include CoreLibrary
10
+ attr_accessor :config, :http_call_back
11
+
12
+ def self.user_agent
13
+ 'APIMATIC 3.0'
14
+ end
15
+
16
+
17
+ GLOBAL_ERRORS = {
18
+ 'default' => ErrorCase.new
19
+ .error_message('HTTP response not OK.')
20
+ .exception_type(APIException)
21
+ }.freeze
22
+
23
+ # Initialization constructor.
24
+ # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
25
+ def initialize(global_configuration)
26
+ @global_configuration = global_configuration
27
+ @config = @global_configuration.client_configuration
28
+ @http_call_back = @config.http_callback
29
+ @api_call = ApiCall.new(@global_configuration)
30
+ end
31
+
32
+ # Creates a new instance of the request builder.
33
+ # @param [String] http_method The HTTP method to use in the request.
34
+ # @param [String] path The endpoint path to use in the request.
35
+ # @param [String] server The server to extract the base uri for the request.
36
+ # @return [RequestBuilder] The instance of RequestBuilder.
37
+ def new_request_builder(http_method, path, server)
38
+ RequestBuilder.new
39
+ .http_method(http_method)
40
+ .path(path)
41
+ .server(server)
42
+ end
43
+
44
+ # Creates a new instance of the response handler.
45
+ # @return [ResponseHandler] The instance of ResponseHandler.
46
+ def new_response_handler
47
+ ResponseHandler.new
48
+ end
49
+
50
+ # Creates a new instance of the parameter.
51
+ # @param [String|optional] key The key of the parameter.
52
+ # @param [Object] value The value of the parameter.
53
+ # @return [Parameter] The instance of Parameter.
54
+ def new_parameter(value, key: nil)
55
+ Parameter.new
56
+ .key(key)
57
+ .value(value)
58
+ end
59
+ end
60
+ end
@@ -0,0 +1,206 @@
1
+ # swagger_petstore
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0
4
+ # ( https://www.apimatic.io ).
5
+
6
+ module SwaggerPetstore
7
+ # PetController
8
+ class PetController < BaseController
9
+ # Returns a single pet
10
+ # @param [Integer] pet_id Required parameter: ID of pet to return
11
+ # @return [Pet] Response from the API call.
12
+ def get_pet_by_id(pet_id)
13
+ @api_call
14
+ .request(new_request_builder(HttpMethodEnum::GET,
15
+ '/pet/{petId}',
16
+ Server::DEFAULT)
17
+ .template_param(new_parameter(pet_id, key: 'petId')
18
+ .should_encode(true))
19
+ .header_param(new_parameter('application/json', key: 'accept'))
20
+ .auth(Single.new('api_key')))
21
+ .response(new_response_handler
22
+ .deserializer(APIHelper.method(:custom_type_deserializer))
23
+ .deserialize_into(Pet.method(:from_hash))
24
+ .local_error('400',
25
+ 'Invalid ID supplied',
26
+ APIException)
27
+ .local_error('404',
28
+ 'Pet not found',
29
+ APIException))
30
+ .execute
31
+ end
32
+
33
+ # Updates a pet in the store with form data
34
+ # @param [Integer] pet_id Required parameter: ID of pet that needs to be
35
+ # updated
36
+ # @param [ContentTypeEnum] content_type Required parameter: Example:
37
+ # @param [String] name Optional parameter: Updated name of the pet
38
+ # @param [String] status Optional parameter: Updated status of the pet
39
+ # @return [void] Response from the API call.
40
+ def update_pet_with_form(pet_id,
41
+ content_type,
42
+ name: nil,
43
+ status: nil)
44
+ @api_call
45
+ .request(new_request_builder(HttpMethodEnum::POST,
46
+ '/pet/{petId}',
47
+ Server::DEFAULT)
48
+ .template_param(new_parameter(pet_id, key: 'petId')
49
+ .should_encode(true))
50
+ .form_param(new_parameter(name, key: 'name'))
51
+ .form_param(new_parameter(status, key: 'status'))
52
+ .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
53
+ .auth(Single.new('petstore_auth')))
54
+ .response(new_response_handler
55
+ .is_response_void(true)
56
+ .local_error('405',
57
+ 'Invalid input',
58
+ APIException))
59
+ .execute
60
+ end
61
+
62
+ # Deletes a pet
63
+ # @param [Integer] pet_id Required parameter: Pet id to delete
64
+ # @param [String] api_key Optional parameter: Example:
65
+ # @return [void] Response from the API call.
66
+ def delete_pet(pet_id,
67
+ api_key: nil)
68
+ @api_call
69
+ .request(new_request_builder(HttpMethodEnum::DELETE,
70
+ '/pet/{petId}',
71
+ Server::DEFAULT)
72
+ .template_param(new_parameter(pet_id, key: 'petId')
73
+ .should_encode(true))
74
+ .header_param(new_parameter(api_key, key: 'api_key'))
75
+ .auth(Single.new('petstore_auth')))
76
+ .response(new_response_handler
77
+ .is_response_void(true)
78
+ .local_error('400',
79
+ 'Invalid ID supplied',
80
+ APIException)
81
+ .local_error('404',
82
+ 'Pet not found',
83
+ APIException))
84
+ .execute
85
+ end
86
+
87
+ # Add a new pet to the store
88
+ # @param [PetRequest] body Required parameter: Pet object that needs to be
89
+ # added to the store
90
+ # @return [void] Response from the API call.
91
+ def add_pet(body)
92
+ @api_call
93
+ .request(new_request_builder(HttpMethodEnum::POST,
94
+ '/pet',
95
+ Server::DEFAULT)
96
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
97
+ .body_param(new_parameter(body))
98
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
99
+ .auth(Single.new('petstore_auth')))
100
+ .response(new_response_handler
101
+ .is_response_void(true)
102
+ .local_error('405',
103
+ 'Invalid input',
104
+ APIException))
105
+ .execute
106
+ end
107
+
108
+ # Update an existing pet
109
+ # @param [PetRequest] body Required parameter: Pet object that needs to be
110
+ # added to the store
111
+ # @return [void] Response from the API call.
112
+ def update_pet(body)
113
+ @api_call
114
+ .request(new_request_builder(HttpMethodEnum::PUT,
115
+ '/pet',
116
+ Server::DEFAULT)
117
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
118
+ .body_param(new_parameter(body))
119
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
120
+ .auth(Single.new('petstore_auth')))
121
+ .response(new_response_handler
122
+ .is_response_void(true)
123
+ .local_error('400',
124
+ 'Invalid ID supplied',
125
+ APIException)
126
+ .local_error('404',
127
+ 'Pet not found',
128
+ APIException)
129
+ .local_error('405',
130
+ 'Validation exception',
131
+ APIException))
132
+ .execute
133
+ end
134
+
135
+ # Multiple status values can be provided with comma separated strings
136
+ # @param [Array[Status2Enum]] status Required parameter: Status values that
137
+ # need to be considered for filter
138
+ # @return [Array[Pet]] Response from the API call.
139
+ def find_pets_by_status(status)
140
+ @api_call
141
+ .request(new_request_builder(HttpMethodEnum::GET,
142
+ '/pet/findByStatus',
143
+ Server::DEFAULT)
144
+ .query_param(new_parameter(status, key: 'status'))
145
+ .header_param(new_parameter('application/json', key: 'accept'))
146
+ .auth(Single.new('petstore_auth')))
147
+ .response(new_response_handler
148
+ .deserializer(APIHelper.method(:custom_type_deserializer))
149
+ .deserialize_into(Pet.method(:from_hash))
150
+ .is_response_array(true)
151
+ .local_error('400',
152
+ 'Invalid status value',
153
+ APIException))
154
+ .execute
155
+ end
156
+
157
+ # uploads an image
158
+ # @param [Integer] pet_id Required parameter: ID of pet to update
159
+ # @param [String] additional_metadata Optional parameter: Additional data to
160
+ # pass to server
161
+ # @param [File | UploadIO] file Optional parameter: file to upload
162
+ # @return [ApiResponse] Response from the API call.
163
+ def upload_file(pet_id,
164
+ additional_metadata: nil,
165
+ file: nil)
166
+ @api_call
167
+ .request(new_request_builder(HttpMethodEnum::POST,
168
+ '/pet/{petId}/uploadImage',
169
+ Server::DEFAULT)
170
+ .template_param(new_parameter(pet_id, key: 'petId')
171
+ .should_encode(true))
172
+ .form_param(new_parameter(additional_metadata, key: 'additionalMetadata'))
173
+ .multipart_param(new_parameter(file, key: 'file')
174
+ .default_content_type('application/octet-stream'))
175
+ .header_param(new_parameter('application/json', key: 'accept'))
176
+ .auth(Single.new('petstore_auth')))
177
+ .response(new_response_handler
178
+ .deserializer(APIHelper.method(:custom_type_deserializer))
179
+ .deserialize_into(ApiResponse.method(:from_hash)))
180
+ .execute
181
+ end
182
+
183
+ # Multiple tags can be provided with comma separated strings. Use tag1,
184
+ # tag2, tag3 for testing.
185
+ # @param [Array[String]] tags Required parameter: Tags to filter by
186
+ # @return [Array[Pet]] Response from the API call.
187
+ def find_pets_by_tags(tags)
188
+ warn 'Endpoint find_pets_by_tags in PetController is deprecated'
189
+ @api_call
190
+ .request(new_request_builder(HttpMethodEnum::GET,
191
+ '/pet/findByTags',
192
+ Server::DEFAULT)
193
+ .query_param(new_parameter(tags, key: 'tags'))
194
+ .header_param(new_parameter('application/json', key: 'accept'))
195
+ .auth(Single.new('petstore_auth')))
196
+ .response(new_response_handler
197
+ .deserializer(APIHelper.method(:custom_type_deserializer))
198
+ .deserialize_into(Pet.method(:from_hash))
199
+ .is_response_array(true)
200
+ .local_error('400',
201
+ 'Invalid tag value',
202
+ APIException))
203
+ .execute
204
+ end
205
+ end
206
+ end