snaptrade 3.0.25 → 3.0.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20172866c5d0a5daa8062a75e53758ad384dfe93f0abf666618ae1549166b62f
-  data.tar.gz: 359614f032575b7c6c9c9d74b871b73ea1d94990b50d28964403dcac368a4377
+  metadata.gz: e6d90e855f96cbd008caa69f70d3080bed33318902839e5cc89897ae74bf3fe1
+  data.tar.gz: c4fcc81059b739ad7b7fc3693541cf055f0e50a5e642b58bc8536c23ea198cd4
 SHA512:
-  metadata.gz: 16f48f27245d49b46ed2065835614606d4bff5969b70657bc8f9fe861a5910d546c1fcc8076708524cda889ccf75e6df7654c8d1bbe27b78952d4ad662eab57e
-  data.tar.gz: '0399ce4c03065daceda99088740abd89a51175e6ff2e9e8c750dcb28586d4b9886e371d8f4af70d52eac3b9906a1b11e4d2ae1e07631a42ad095226f62289120'
+  metadata.gz: 2a7d3d5d00874bdd136950039c86f10b9cafdd8816093ffe40eabdde50e25b3d846c0b8b01931057e4fc1a7352401b69addb917b93a9fc9eb1dd1de2184bba92
+  data.tar.gz: e0490b47de01ce9730a5f8db15ff11f0dac2ca9ace18c27ca356df48aa2a96b4b72507dc42e2bb8a0dc7e872bca4a7f6456b2615c5a91ce87f6f73299fdad36a

data/README.md

@@ -63,7 +63,7 @@ backoff with jitter rather than from the headers.
 See https://docs.snaptrade.com/docs/ratelimiting.
 
 
-[![npm](https://img.shields.io/badge/gem-v3.0.25-blue)](https://rubygems.org/gems/snaptrade/versions/3.0.25)
+[![npm](https://img.shields.io/badge/gem-v3.0.26-blue)](https://rubygems.org/gems/snaptrade/versions/3.0.26)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -116,6 +116,7 @@ See https://docs.snaptrade.com/docs/ratelimiting.
   * [`snaptrade.reference_data.list_all_brokerage_authorization_type`](#snaptradereference_datalist_all_brokerage_authorization_type)
   * [`snaptrade.reference_data.list_all_brokerage_instruments`](#snaptradereference_datalist_all_brokerage_instruments)
   * [`snaptrade.reference_data.list_all_brokerages`](#snaptradereference_datalist_all_brokerages)
+  * [`snaptrade.reference_data.list_institutions`](#snaptradereference_datalist_institutions)
   * [`snaptrade.reference_data.symbol_search_user_account`](#snaptradereference_datasymbol_search_user_account)
   * [`snaptrade.trading.cancel_order`](#snaptradetradingcancel_order)
   * [`snaptrade.trading.get_cryptocurrency_pair_quote`](#snaptradetradingget_cryptocurrency_pair_quote)
@@ -139,7 +140,7 @@ See https://docs.snaptrade.com/docs/ratelimiting.
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 3.0.25'
+gem 'snaptrade', '~> 3.0.26'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -563,7 +564,7 @@ false to retrieve non executed orders as well
 
 ### `snaptrade.account_information.get_user_account_return_rates`<a id="snaptradeaccount_informationget_user_account_return_rates"></a>
 
-Returns a list of rate of return percents for a given account.
+DEPRECATED. Returns a list of rate of return percents for a given account.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -1219,7 +1220,7 @@ p result
 
 ### `snaptrade.connections.return_rates`<a id="snaptradeconnectionsreturn_rates"></a>
 
-Returns a list of rate of return percents for a given connection.
+DEPRECATED. Returns a list of rate of return percents for a given connection.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -1724,6 +1725,33 @@ p result
 ---
 
 
+### `snaptrade.reference_data.list_institutions`<a id="snaptradereference_datalist_institutions"></a>
+
+Returns the public catalog of institutions SnapTrade supports and what each one supports. The response is the same for every caller and needs no authentication. To list the brokerages a specific Client ID can connect to right now, use `GET /brokerages` instead.
+
+A `null` field means the information is not documented yet, never that the institution lacks it. New fields and new enum values may be added over time, so ignore any you don't recognize.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = snaptrade.reference_data.list_institutions
+p result
+```
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[Institution](./lib/snaptrade/models/institution.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/institutions` `GET`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `snaptrade.reference_data.symbol_search_user_account`<a id="snaptradereference_datasymbol_search_user_account"></a>
 
 Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.

data/lib/snaptrade/api/account_information_api.rb

@@ -1030,7 +1030,7 @@ module SnapTrade
 
     # List account rate of returns
     #
-    # Returns a list of rate of return percents for a given account.
+    # DEPRECATED. Returns a list of rate of return percents for a given account.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -1045,7 +1045,7 @@ module SnapTrade
 
     # List account rate of returns
     #
-    # Returns a list of rate of return percents for a given account.
+    # DEPRECATED. Returns a list of rate of return percents for a given account.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -1058,7 +1058,7 @@ module SnapTrade
     end
 
     # List account rate of returns
-    # Returns a list of rate of return percents for a given account. 
+    # DEPRECATED. Returns a list of rate of return percents for a given account. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
@@ -1071,7 +1071,7 @@ module SnapTrade
     end
 
     # List account rate of returns
-    # Returns a list of rate of return percents for a given account. 
+    # DEPRECATED. Returns a list of rate of return percents for a given account. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 

data/lib/snaptrade/api/connections_api.rb

@@ -782,7 +782,7 @@ module SnapTrade
 
     # List connection rate of returns
     #
-    # Returns a list of rate of return percents for a given connection.
+    # DEPRECATED. Returns a list of rate of return percents for a given connection.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -797,7 +797,7 @@ module SnapTrade
 
     # List connection rate of returns
     #
-    # Returns a list of rate of return percents for a given connection.
+    # DEPRECATED. Returns a list of rate of return percents for a given connection.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -810,7 +810,7 @@ module SnapTrade
     end
 
     # List connection rate of returns
-    # Returns a list of rate of return percents for a given connection. 
+    # DEPRECATED. Returns a list of rate of return percents for a given connection. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param authorization_id [String] 
@@ -823,7 +823,7 @@ module SnapTrade
     end
 
     # List connection rate of returns
-    # Returns a list of rate of return percents for a given connection. 
+    # DEPRECATED. Returns a list of rate of return percents for a given connection. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param authorization_id [String] 

data/lib/snaptrade/api/reference_data_api.rb

@@ -596,6 +596,87 @@ module SnapTrade
     end
 
 
+    # List institutions
+    #
+    # Returns the public catalog of institutions SnapTrade supports and what each one supports. The response is the same for every caller and needs no authentication. To list the brokerages a specific Client ID can connect to right now, use `GET /brokerages` instead.
+    # 
+    # A `null` field means the information is not documented yet, never that the institution lacks it. New fields and new enum values may be added over time, so ignore any you don't recognize.
+    #
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def list_institutions(extra: {})
+      data, _status_code, _headers = list_institutions_with_http_info_impl(extra)
+      data
+    end
+
+    # List institutions
+    #
+    # Returns the public catalog of institutions SnapTrade supports and what each one supports. The response is the same for every caller and needs no authentication. To list the brokerages a specific Client ID can connect to right now, use `GET /brokerages` instead.
+    # 
+    # A `null` field means the information is not documented yet, never that the institution lacks it. New fields and new enum values may be added over time, so ignore any you don't recognize.
+    #
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def list_institutions_with_http_info(extra: {})
+      list_institutions_with_http_info_impl(extra)
+    end
+
+    # List institutions
+    # Returns the public catalog of institutions SnapTrade supports and what each one supports. The response is the same for every caller and needs no authentication. To list the brokerages a specific Client ID can connect to right now, use `GET /brokerages` instead.  A `null` field means the information is not documented yet, never that the institution lacks it. New fields and new enum values may be added over time, so ignore any you don't recognize. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Institution>]
+    private def list_institutions_impl(opts = {})
+      data, _status_code, _headers = list_institutions_with_http_info(opts)
+      data
+    end
+
+    # List institutions
+    # Returns the public catalog of institutions SnapTrade supports and what each one supports. The response is the same for every caller and needs no authentication. To list the brokerages a specific Client ID can connect to right now, use &#x60;GET /brokerages&#x60; instead.  A &#x60;null&#x60; field means the information is not documented yet, never that the institution lacks it. New fields and new enum values may be added over time, so ignore any you don&#39;t recognize. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Institution>, Integer, Hash)>] Array<Institution> data, response status code and response headers
+    private def list_institutions_with_http_info_impl(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ReferenceDataApi.list_institutions ...'
+      end
+      # resource path
+      local_var_path = '/institutions'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<Institution>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ReferenceDataApi.list_institutions",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ReferenceDataApi#list_institutions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers, response
+    end
+
+
     # Search account symbols
     #
     # Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.

data/lib/snaptrade/models/brokerage_authorization_data_freshness_mode.rb

@@ -35,7 +35,7 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'institution' => :'Institution',
+        :'institution' => :'BrokerageAuthorizationInstitution',
         :'snaptrade' => :'Snaptrade'
       }
     end

data/lib/snaptrade/models/brokerage_authorization_institution.rb

@@ -0,0 +1,37 @@
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading.  ## Rate limiting  Two limits apply to requests signed with your `clientId`. The stricter one wins, and exceeding either returns `429 Too Many Requests`.  - **Customer-level** — 250 requests/minute by default, scoped to your   `clientId` and applied across all endpoints. Reported in   `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`. - **Account-level** — 10 requests/minute per account, scoped to   (`clientId`, `accountId`). All covered operations for one account draw on   the same bucket — reading balances and reading positions share it — and   enforcement does not depend on the HTTP method, so updating an account   consumes the same bucket as reading it. Only enforced for Personal users,   and only for integrations it has been rolled out to — it is not yet in   force for every Personal integration. It also does not apply on every   operation that documents a 429 below. Where it applies it is reported in   `X-RateLimit-Account-Limit`, `X-RateLimit-Account-Remaining` and   `X-RateLimit-Account-Reset`. Do not read the absence of those headers as   proof the limit is off — some configurations omit the rate limit headers   while still enforcing the limit, so header absence tells you nothing   about your allowance.  On a 429, `X-RateLimit-Remaining: 0` means you hit the customer-level limit and `X-RateLimit-Account-Remaining: 0` means the account-level one. Wait for the corresponding `*-Reset` value (seconds) before retrying, or fall back to exponential backoff with jitter.  Not every 429 is explained by those headers. A separate per-authenticated-user limit, reported in no `X-RateLimit-*` header, covers OAuth-authenticated requests and signed requests in configurations where the customer-level limit is not in effect — on the operations that use the default throttles. A few operations override those and are governed by the customer-level limit alone. The two do not stack: a signed request governed by the customer-level limit above is not additionally subject to the per-user one. If a 429 arrives with no header at zero — or with no `X-RateLimit-*` headers at all — honour `Retry-After` and back off. Treat the remaining counts as a hint, not a guarantee that the next request will succeed.  Because the customer-level limit applies everywhere, any signed request can return 429.  **OAuth-authenticated requests are an exception.** They are not subject to the customer-level limit and do not receive `X-RateLimit-Limit`, `X-RateLimit-Remaining` or `X-RateLimit-Reset` — do not wait on those headers or design around a customer-level allowance on this path. The account-level limit still applies to them on the account-data endpoints above, reported in the `X-RateLimit-Account-*` headers. On operations using the default throttles the per-user limit above applies to them as well, so an OAuth request can be rejected while the account headers still show capacity; on the few operations that override those throttles, OAuth callers have no per-user ceiling at all. Drive retries from `Retry-After` and exponential backoff with jitter rather than from the headers.  See https://docs.snaptrade.com/docs/ratelimiting. 
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+=end
+
+require 'date'
+require 'time'
+
+module SnapTrade
+  class BrokerageAuthorizationInstitution
+    REALTIME = "realtime".freeze
+    DELAYED = "delayed".freeze
+
+    def self.all_vars
+      @all_vars ||= [REALTIME, DELAYED].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if BrokerageAuthorizationInstitution.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #BrokerageAuthorizationInstitution"
+    end
+  end
+end

data/lib/snaptrade/models/institution.rb

@@ -11,27 +11,351 @@ require 'date'
 require 'time'
 
 module SnapTrade
+  # An institution in SnapTrade's public catalog and what it supports. A `null` field means the information is not documented yet.
   class Institution
-    REALTIME = "realtime".freeze
-    DELAYED = "delayed".freeze
+    # A short, unique identifier for the institution. It is usually the name in capital letters and will never change. It matches the `slug` of the same brokerage in `GET /brokerages`.
+    attr_accessor :slug
 
-    def self.all_vars
-      @all_vars ||= [REALTIME, DELAYED].freeze
+    # Full name of the institution.
+    attr_accessor :name
+
+    # A display-friendly name of the institution.
+    attr_accessor :display_name
+
+    # A brief description of the institution.
+    attr_accessor :description
+
+    # URL of the institution's website.
+    attr_accessor :website
+
+    # URL of the institution's rectangular logo.
+    attr_accessor :logo_url
+
+    # URL of the institution's square logo.
+    attr_accessor :square_logo_url
+
+    # How mature the integration is. - `GENERALLY_AVAILABLE`: fully supported and validated for production use. - `BETA`: production-ready, with ongoing validation and improvements. 
+    attr_accessor :release_stage
+
+    # Regions where end users can connect to this institution. - `US`: United States - `CA`: Canada - `EUROPE`: Europe, including the United Kingdom - `AU`: Australia - `IN`: India 
+    attr_accessor :regions
+
+    attr_accessor :connection
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'slug' => :'slug',
+        :'name' => :'name',
+        :'display_name' => :'display_name',
+        :'description' => :'description',
+        :'website' => :'website',
+        :'logo_url' => :'logo_url',
+        :'square_logo_url' => :'square_logo_url',
+        :'release_stage' => :'release_stage',
+        :'regions' => :'regions',
+        :'connection' => :'connection'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
     end
 
-    # Builds the enum from string
-    # @param [String] The enum value in the form of the string
-    # @return [String] The enum value
-    def self.build_from_hash(value)
-      new.build_from_hash(value)
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'slug' => :'String',
+        :'name' => :'String',
+        :'display_name' => :'String',
+        :'description' => :'String',
+        :'website' => :'String',
+        :'logo_url' => :'String',
+        :'square_logo_url' => :'String',
+        :'release_stage' => :'ReleaseStage',
+        :'regions' => :'Array<String>',
+        :'connection' => :'InstitutionConnection'
+      }
     end
 
-    # Builds the enum from string
-    # @param [String] The enum value in the form of the string
-    # @return [String] The enum value
-    def build_from_hash(value)
-      return value if Institution.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #Institution"
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'description',
+        :'website',
+        :'square_logo_url',
+        :'regions',
+        :'connection'
+      ])
     end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::Institution` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::Institution`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'slug')
+        self.slug = attributes[:'slug']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'website')
+        self.website = attributes[:'website']
+      end
+
+      if attributes.key?(:'logo_url')
+        self.logo_url = attributes[:'logo_url']
+      end
+
+      if attributes.key?(:'square_logo_url')
+        self.square_logo_url = attributes[:'square_logo_url']
+      end
+
+      if attributes.key?(:'release_stage')
+        self.release_stage = attributes[:'release_stage']
+      end
+
+      if attributes.key?(:'regions')
+        if (value = attributes[:'regions']).is_a?(Array)
+          self.regions = value
+        end
+      end
+
+      if attributes.key?(:'connection')
+        self.connection = attributes[:'connection']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @slug.nil?
+        invalid_properties.push('invalid value for "slug", slug cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @display_name.nil?
+        invalid_properties.push('invalid value for "display_name", display_name cannot be nil.')
+      end
+
+      if @logo_url.nil?
+        invalid_properties.push('invalid value for "logo_url", logo_url cannot be nil.')
+      end
+
+      if @release_stage.nil?
+        invalid_properties.push('invalid value for "release_stage", release_stage cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @slug.nil?
+      return false if @name.nil?
+      return false if @display_name.nil?
+      return false if @logo_url.nil?
+      return false if @release_stage.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          slug == o.slug &&
+          name == o.name &&
+          display_name == o.display_name &&
+          description == o.description &&
+          website == o.website &&
+          logo_url == o.logo_url &&
+          square_logo_url == o.square_logo_url &&
+          release_stage == o.release_stage &&
+          regions == o.regions &&
+          connection == o.connection
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [slug, name, display_name, description, website, logo_url, square_logo_url, release_stage, regions, connection].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = SnapTrade.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
   end
+
 end