petstore-pets 1.0.0

data/lib/swagger_petstore_open_api30/controllers/store_controller.rb

@@ -0,0 +1,107 @@
+# swagger_petstore_open_api30
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SwaggerPetstoreOpenApi30
+  # StoreController
+  class StoreController < BaseController
+    # Place a new order in the store
+    # @param [Integer] id Optional parameter: Example:
+    # @param [Integer] pet_id Optional parameter: Example:
+    # @param [Integer] quantity Optional parameter: Example:
+    # @param [DateTime] ship_date Optional parameter: Example:
+    # @param [OrderStatusEnum] order_status Optional parameter: Order Status
+    # @param [TrueClass | FalseClass] complete Optional parameter: Example:
+    # @return [Order] response from the API call.
+    def place_order(id: nil,
+                    pet_id: nil,
+                    quantity: nil,
+                    ship_date: nil,
+                    order_status: OrderStatusEnum::APPROVED,
+                    complete: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/store/order',
+                                     Server::DEFAULT)
+                   .form_param(new_parameter(id, key: 'id'))
+                   .form_param(new_parameter(pet_id, key: 'petId'))
+                   .form_param(new_parameter(quantity, key: 'quantity'))
+                   .form_param(new_parameter(ship_date, key: 'shipDate'))
+                   .form_param(new_parameter(order_status, key: 'orderStatus'))
+                   .form_param(new_parameter(complete, key: 'complete'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Order.method(:from_hash))
+                    .local_error('405',
+                                 'Invalid input',
+                                 APIException))
+        .execute
+    end
+
+    # For valid response try integer IDs with value <= 5 or > 10. Other values
+    # will generate exceptions.
+    # @param [Integer] order_id Required parameter: ID of order that needs to be
+    # fetched
+    # @return [Order] response from the API call.
+    def get_order_by_id(order_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/store/order/{orderId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(order_id, key: 'orderId')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Order.method(:from_hash))
+                    .local_error('400',
+                                 'Invalid ID supplied',
+                                 APIException)
+                    .local_error('404',
+                                 'Order not found',
+                                 APIException))
+        .execute
+    end
+
+    # For valid response try integer IDs with value < 1000. Anything above 1000
+    # or nonintegers will generate API errors
+    # @param [Integer] order_id Required parameter: ID of the order that needs
+    # to be deleted
+    # @return [void] response from the API call.
+    def delete_order(order_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/store/order/{orderId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(order_id, key: 'orderId')
+                                    .should_encode(true)))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .local_error('400',
+                                 'Invalid ID supplied',
+                                 APIException)
+                    .local_error('404',
+                                 'Order not found',
+                                 APIException))
+        .execute
+    end
+
+    # Returns a map of status codes to quantities
+    # @return [Hash[String, Integer]] response from the API call.
+    def get_inventory
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/store/inventory',
+                                     Server::DEFAULT)
+                   .auth(Single.new('api_key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:deserialize_primitive_types))
+                    .deserialize_into(proc do |response| response.to_i end)
+                    .is_primitive_response(true))
+        .execute
+    end
+  end
+end

data/lib/swagger_petstore_open_api30/controllers/user_controller.rb

@@ -0,0 +1,189 @@
+# swagger_petstore_open_api30
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SwaggerPetstoreOpenApi30
+  # UserController
+  class UserController < BaseController
+    # Creates list of users with given input array
+    # @param [Array[User]] body Optional parameter: Example:
+    # @return [User] response from the API call.
+    def create_users_with_list_input(body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/user/createWithList',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(User.method(:from_hash))
+                    .local_error('default',
+                                 'successful operation',
+                                 APIException))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] username Optional parameter: The user name for login
+    # @param [String] password Optional parameter: The password for login in
+    # clear text
+    # @return [String] response from the API call.
+    def login_user(username: nil,
+                   password: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/user/login',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(username, key: 'username'))
+                   .query_param(new_parameter(password, key: 'password')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:deserialize_primitive_types))
+                    .deserialize_into(proc do |response| response.to_s end)
+                    .is_primitive_response(true)
+                    .local_error('400',
+                                 'Invalid username/password supplied',
+                                 APIException))
+        .execute
+    end
+
+    # This can only be done by the logged in user.
+    # @param [String] name Required parameter: name that need to be deleted
+    # @param [Integer] id Optional parameter: Example:
+    # @param [String] username Optional parameter: Example:
+    # @param [String] first_name Optional parameter: Example:
+    # @param [String] last_name Optional parameter: Example:
+    # @param [String] email Optional parameter: Example:
+    # @param [String] password Optional parameter: Example:
+    # @param [String] phone Optional parameter: Example:
+    # @param [Integer] user_status Optional parameter: User Status
+    # @return [void] response from the API call.
+    def update_user(name,
+                    id: nil,
+                    username: nil,
+                    first_name: nil,
+                    last_name: nil,
+                    email: nil,
+                    password: nil,
+                    phone: nil,
+                    user_status: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/user/{name}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(name, key: 'name')
+                                    .should_encode(true))
+                   .form_param(new_parameter(id, key: 'id'))
+                   .form_param(new_parameter(username, key: 'username'))
+                   .form_param(new_parameter(first_name, key: 'firstName'))
+                   .form_param(new_parameter(last_name, key: 'lastName'))
+                   .form_param(new_parameter(email, key: 'email'))
+                   .form_param(new_parameter(password, key: 'password'))
+                   .form_param(new_parameter(phone, key: 'phone'))
+                   .form_param(new_parameter(user_status, key: 'userStatus'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # This can only be done by the logged in user.
+    # @param [String] name Required parameter: The name that needs to be
+    # deleted
+    # @return [void] response from the API call.
+    def delete_user(name)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/user/{name}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(name, key: 'name')
+                                    .should_encode(true)))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .local_error('400',
+                                 'Invalid username supplied',
+                                 APIException)
+                    .local_error('404',
+                                 'User not found',
+                                 APIException))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] name Required parameter: The name that needs to be
+    # fetched. Use user1 for testing.
+    # @return [User] response from the API call.
+    def get_user_by_name(name)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/user/{name}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(name, key: 'name')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(User.method(:from_hash))
+                    .local_error('400',
+                                 'Invalid username supplied',
+                                 APIException)
+                    .local_error('404',
+                                 'User not found',
+                                 APIException))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @return [void] response from the API call.
+    def logout_user
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/user/logout',
+                                     Server::DEFAULT))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # This can only be done by the logged in user.
+    # @param [Integer] id Optional parameter: Example:
+    # @param [String] username Optional parameter: Example:
+    # @param [String] first_name Optional parameter: Example:
+    # @param [String] last_name Optional parameter: Example:
+    # @param [String] email Optional parameter: Example:
+    # @param [String] password Optional parameter: Example:
+    # @param [String] phone Optional parameter: Example:
+    # @param [Integer] user_status Optional parameter: User Status
+    # @return [User] response from the API call.
+    def create_user(id: nil,
+                    username: nil,
+                    first_name: nil,
+                    last_name: nil,
+                    email: nil,
+                    password: nil,
+                    phone: nil,
+                    user_status: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/user',
+                                     Server::DEFAULT)
+                   .form_param(new_parameter(id, key: 'id'))
+                   .form_param(new_parameter(username, key: 'username'))
+                   .form_param(new_parameter(first_name, key: 'firstName'))
+                   .form_param(new_parameter(last_name, key: 'lastName'))
+                   .form_param(new_parameter(email, key: 'email'))
+                   .form_param(new_parameter(password, key: 'password'))
+                   .form_param(new_parameter(phone, key: 'phone'))
+                   .form_param(new_parameter(user_status, key: 'userStatus'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(User.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/swagger_petstore_open_api30/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# swagger_petstore_open_api30
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SwaggerPetstoreOpenApi30
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code}, reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/swagger_petstore_open_api30/http/auth/custom_header_authentication.rb

@@ -0,0 +1,42 @@
+# swagger_petstore_open_api30
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SwaggerPetstoreOpenApi30
+  # Utility class for custom header authorization.
+  class CustomHeaderAuthentication < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'CustomHeaderAuthentication: api_key is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(custom_header_authentication_credentials)
+      auth_params = {}
+      auth_params['api_key'] = custom_header_authentication_credentials.api_key unless
+        custom_header_authentication_credentials.nil? || custom_header_authentication_credentials.api_key.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for CustomHeaderAuthenticationCredentials.
+  # Data class for CustomHeaderAuthenticationCredentials.
+  class CustomHeaderAuthenticationCredentials
+    attr_reader :api_key
+
+    def initialize(api_key:)
+      raise ArgumentError, 'api_key cannot be nil' if api_key.nil?
+
+      @api_key = api_key
+    end
+
+    def clone_with(api_key: nil)
+      api_key ||= self.api_key
+
+      CustomHeaderAuthenticationCredentials.new(api_key: api_key)
+    end
+  end
+end

data/lib/swagger_petstore_open_api30/http/http_call_back.rb

@@ -0,0 +1,10 @@
+# swagger_petstore_open_api30
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SwaggerPetstoreOpenApi30
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/swagger_petstore_open_api30/http/http_method_enum.rb

@@ -0,0 +1,10 @@
+# swagger_petstore_open_api30
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SwaggerPetstoreOpenApi30
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/swagger_petstore_open_api30/http/http_request.rb

@@ -0,0 +1,10 @@
+# swagger_petstore_open_api30
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SwaggerPetstoreOpenApi30
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/swagger_petstore_open_api30/http/http_response.rb

@@ -0,0 +1,10 @@
+# swagger_petstore_open_api30
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SwaggerPetstoreOpenApi30
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end

data/lib/swagger_petstore_open_api30/models/address.rb

@@ -0,0 +1,90 @@
+# swagger_petstore_open_api30
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SwaggerPetstoreOpenApi30
+  # Address Model.
+  class Address < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :street
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :city
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :state
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :zip
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['street'] = 'street'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['zip'] = 'zip'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        street
+        city
+        state
+        zip
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(street = SKIP, city = SKIP, state = SKIP, zip = SKIP)
+      @street = street unless street == SKIP
+      @city = city unless city == SKIP
+      @state = state unless state == SKIP
+      @zip = zip unless zip == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      street = hash.key?('street') ? hash['street'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      zip = hash.key?('zip') ? hash['zip'] : SKIP
+
+      # Create object from extracted values.
+      Address.new(street,
+                  city,
+                  state,
+                  zip)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} street: #{@street}, city: #{@city}, state: #{@state}, zip: #{@zip}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} street: #{@street.inspect}, city: #{@city.inspect}, state:"\
+      " #{@state.inspect}, zip: #{@zip.inspect}>"
+    end
+  end
+end

data/lib/swagger_petstore_open_api30/models/base_model.rb

@@ -0,0 +1,110 @@
+# swagger_petstore_open_api30
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SwaggerPetstoreOpenApi30
+  # Base model.
+  # rubocop:disable all
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
+          end
+
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
+            else
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+  # rubocop:enable all
+end

data/lib/swagger_petstore_open_api30/models/category.rb

@@ -0,0 +1,71 @@
+# swagger_petstore_open_api30
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SwaggerPetstoreOpenApi30
+  # Category Model.
+  class Category < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, name = SKIP)
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+
+      # Create object from extracted values.
+      Category.new(id,
+                   name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, name: #{@name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, name: #{@name.inspect}>"
+    end
+  end
+end