snaptrade 2.0.185 → 2.0.187

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6e6686611e26579a7f5b299263c6f9473fc12564d388730380a0b14f992d01e
-  data.tar.gz: 72ccb9a03f1230f0de97978d4d09c549ee38c45b120990ecb3df75ed6874da93
+  metadata.gz: eb4521beb152b33455ba85fb0f22b57d4cb4f1112831c888c4aa47ca01347092
+  data.tar.gz: cabb03509707ea085af558908cdaf7f322feff23b2c96d771e2c4c06cbc0cfed
 SHA512:
-  metadata.gz: cd9ec841ef44d08d5e4d2315937a3cd13dd99c49a7da6ee2a470e6151f684c20d78c47f21e79083f270c3e8b95ce17a9d076b97074a8055780f9085b195681ea
-  data.tar.gz: a8fb0e2f6ef2feb2369036a668643fcc0c11a208bbd604649e2687ced70a4a3db0e67f92f4ed5412246f46fa08dd95ca01fa52406a3bc8fe5f4ac7b8859b9d7f
+  metadata.gz: 6ca1520d727cffeb91dbcdbcd6fe3cdb6839dc45cceb06202750280dcd841c0822eac4049a835e99ecee9be2c3b80ed691ac087f7b211b71f8ab32fb6a2e32b0
+  data.tar.gz: 3f201b7383cc1b2b1929e0a5a2f8dec2941098de7de44c2e435178400c5e1c5a25545869920b84ac85dd433bbda854bbbe9eb576a81b83f23741bd4d647c93cc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.185)
+    snaptrade (2.0.187)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 

data/README.md

@@ -6,7 +6,7 @@
 
 Connect brokerage accounts to your app for live positions and trading
 
-[![npm](https://img.shields.io/badge/gem-v2.0.185-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.185)
+[![npm](https://img.shields.io/badge/gem-v2.0.187-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.187)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -46,6 +46,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.connections.return_rates`](#snaptradeconnectionsreturn_rates)
   * [`snaptrade.connections.session_events`](#snaptradeconnectionssession_events)
   * [`snaptrade.experimental_endpoints.get_account_balance_history`](#snaptradeexperimental_endpointsget_account_balance_history)
+  * [`snaptrade.experimental_endpoints.get_all_account_positions`](#snaptradeexperimental_endpointsget_all_account_positions)
   * [`snaptrade.experimental_endpoints.get_user_account_order_detail_v2`](#snaptradeexperimental_endpointsget_user_account_order_detail_v2)
   * [`snaptrade.experimental_endpoints.get_user_account_orders_v2`](#snaptradeexperimental_endpointsget_user_account_orders_v2)
   * [`snaptrade.experimental_endpoints.get_user_account_recent_orders_v2`](#snaptradeexperimental_endpointsget_user_account_recent_orders_v2)
@@ -89,7 +90,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.185'
+gem 'snaptrade', '~> 2.0.187'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1218,6 +1219,55 @@ p result
 ---
 
 
+### `snaptrade.experimental_endpoints.get_all_account_positions`<a id="snaptradeexperimental_endpointsget_all_account_positions"></a>
+
+Returns a paginated list of all positions in the specified account.
+
+The `results` list can contain multiple instrument types in the same response page, including stocks, ETFs, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
+
+Stock positions may also include `cash_equivalent`, and may include `tax_lots` when tax lot data is enabled for the account.
+
+If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = snaptrade.experimental_endpoints.get_all_account_positions(
+  user_id: "snaptrade-user-123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
+  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
+  page: 1,
+  page_size: 100,
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### user_id: `String`<a id="user_id-string"></a>
+##### user_secret: `String`<a id="user_secret-string"></a>
+##### account_id: `String`<a id="account_id-string"></a>
+##### page: `Integer`<a id="page-integer"></a>
+The page number to return. Defaults to 1.
+
+##### page_size: `Integer`<a id="page_size-integer"></a>
+The number of positions to return per page. Defaults to 100 with a maximum of
+1000.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[AllAccountPositionsResponse](./lib/snaptrade/models/all_account_positions_response.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/positions/all` `GET`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `snaptrade.experimental_endpoints.get_user_account_order_detail_v2`<a id="snaptradeexperimental_endpointsget_user_account_order_detail_v2"></a>
 
 Returns the detail of a single order using the brokerage order ID provided as a path parameter.

data/lib/snaptrade/api/experimental_endpoints_api.rb

@@ -120,6 +120,147 @@ module SnapTrade
     end
 
 
+    # List all account positions
+    #
+    # Returns a paginated list of all positions in the specified account.
+    # 
+    # The `results` list can contain multiple instrument types in the same response page, including stocks, ETFs, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
+    # 
+    # Stock positions may also include `cash_equivalent`, and may include `tax_lots` when tax lot data is enabled for the account.
+    # 
+    # If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
+    #
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param account_id [String] 
+    # @param page [Integer] The page number to return. Defaults to 1.
+    # @param page_size [Integer] The number of positions to return per page. Defaults to 100 with a maximum of 1000.
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def get_all_account_positions(user_id:, user_secret:, account_id:, page: SENTINEL, page_size: SENTINEL, extra: {})
+      extra[:page] = page if page != SENTINEL
+      extra[:page_size] = page_size if page_size != SENTINEL
+      data, _status_code, _headers = get_all_account_positions_with_http_info_impl(user_id, user_secret, account_id, extra)
+      data
+    end
+
+    # List all account positions
+    #
+    # Returns a paginated list of all positions in the specified account.
+    # 
+    # The `results` list can contain multiple instrument types in the same response page, including stocks, ETFs, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
+    # 
+    # Stock positions may also include `cash_equivalent`, and may include `tax_lots` when tax lot data is enabled for the account.
+    # 
+    # If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
+    #
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param account_id [String] 
+    # @param page [Integer] The page number to return. Defaults to 1.
+    # @param page_size [Integer] The number of positions to return per page. Defaults to 100 with a maximum of 1000.
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def get_all_account_positions_with_http_info(user_id:, user_secret:, account_id:, page: SENTINEL, page_size: SENTINEL, extra: {})
+      extra[:page] = page if page != SENTINEL
+      extra[:page_size] = page_size if page_size != SENTINEL
+      get_all_account_positions_with_http_info_impl(user_id, user_secret, account_id, extra)
+    end
+
+    # List all account positions
+    # Returns a paginated list of all positions in the specified account.  The `results` list can contain multiple instrument types in the same response page, including stocks, ETFs, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.  Stock positions may also include `cash_equivalent`, and may include `tax_lots` when tax lot data is enabled for the account.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param account_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page The page number to return. Defaults to 1.
+    # @option opts [Integer] :page_size The number of positions to return per page. Defaults to 100 with a maximum of 1000.
+    # @return [AllAccountPositionsResponse]
+    private def get_all_account_positions_impl(user_id, user_secret, account_id, opts = {})
+      data, _status_code, _headers = get_all_account_positions_with_http_info(user_id, user_secret, account_id, opts)
+      data
+    end
+
+    # List all account positions
+    # Returns a paginated list of all positions in the specified account.  The `results` list can contain multiple instrument types in the same response page, including stocks, ETFs, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.  Stock positions may also include `cash_equivalent`, and may include `tax_lots` when tax lot data is enabled for the account.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param account_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page The page number to return. Defaults to 1.
+    # @option opts [Integer] :page_size The number of positions to return per page. Defaults to 100 with a maximum of 1000.
+    # @return [Array<(AllAccountPositionsResponse, Integer, Hash)>] AllAccountPositionsResponse data, response status code and response headers
+    private def get_all_account_positions_with_http_info_impl(user_id, user_secret, account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ExperimentalEndpointsApi.get_all_account_positions ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling ExperimentalEndpointsApi.get_all_account_positions"
+      end
+      # verify the required parameter 'user_secret' is set
+      if @api_client.config.client_side_validation && user_secret.nil?
+        fail ArgumentError, "Missing the required parameter 'user_secret' when calling ExperimentalEndpointsApi.get_all_account_positions"
+      end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling ExperimentalEndpointsApi.get_all_account_positions"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ExperimentalEndpointsApi.get_all_account_positions, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ExperimentalEndpointsApi.get_all_account_positions, must be smaller than or equal to 1000.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ExperimentalEndpointsApi.get_all_account_positions, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/accounts/{accountId}/positions/all'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'userId'] = user_id
+      query_params[:'userSecret'] = user_secret
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+
+      # 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] || 'AllAccountPositionsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
+
+      new_options = opts.merge(
+        :operation => :"ExperimentalEndpointsApi.get_all_account_positions",
+        :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: ExperimentalEndpointsApi#get_all_account_positions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers, response
+    end
+
+
     # Get account order detail (V2)
     #
     # Returns the detail of a single order using the brokerage order ID provided as a path parameter.

data/lib/snaptrade/models/account_order_record.rb

@@ -16,6 +16,12 @@ module SnapTrade
     # Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
     attr_accessor :brokerage_order_id
 
+    # The brokerage-assigned identifier that links all orders within a complex order (OCO, OTO, OTOCO) together. Null for non-complex orders or when the brokerage does not return a group identifier. 
+    attr_accessor :brokerage_group_order_id
+
+    # The role of this order within a complex order group (OCO, OTO, OTOCO). Null for non-complex orders. 
+    attr_accessor :order_role
+
     # Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. Possible values include:   - NONE   - PENDING   - ACCEPTED   - FAILED   - REJECTED   - CANCELED   - PARTIAL_CANCELED   - CANCEL_PENDING   - EXECUTED   - PARTIAL   - REPLACE_PENDING   - REPLACED   - EXPIRED   - QUEUED   - TRIGGERED   - ACTIVATED 
     attr_accessor :status
 
@@ -80,6 +86,8 @@ module SnapTrade
     def self.attribute_map
       {
         :'brokerage_order_id' => :'brokerage_order_id',
+        :'brokerage_group_order_id' => :'brokerage_group_order_id',
+        :'order_role' => :'order_role',
         :'status' => :'status',
         :'universal_symbol' => :'universal_symbol',
         :'option_symbol' => :'option_symbol',
@@ -114,6 +122,8 @@ module SnapTrade
     def self.openapi_types
       {
         :'brokerage_order_id' => :'String',
+        :'brokerage_group_order_id' => :'String',
+        :'order_role' => :'OrderRole',
         :'status' => :'AccountOrderRecordStatus',
         :'universal_symbol' => :'AccountOrderRecordUniversalSymbol',
         :'option_symbol' => :'AccountOrderRecordOptionSymbol',
@@ -142,6 +152,8 @@ module SnapTrade
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'brokerage_group_order_id',
+        :'order_role',
         :'total_quantity',
         :'open_quantity',
         :'canceled_quantity',
@@ -177,6 +189,14 @@ module SnapTrade
         self.brokerage_order_id = attributes[:'brokerage_order_id']
       end
 
+      if attributes.key?(:'brokerage_group_order_id')
+        self.brokerage_group_order_id = attributes[:'brokerage_group_order_id']
+      end
+
+      if attributes.key?(:'order_role')
+        self.order_role = attributes[:'order_role']
+      end
+
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
@@ -285,6 +305,8 @@ module SnapTrade
       return true if self.equal?(o)
       self.class == o.class &&
           brokerage_order_id == o.brokerage_order_id &&
+          brokerage_group_order_id == o.brokerage_group_order_id &&
+          order_role == o.order_role &&
           status == o.status &&
           universal_symbol == o.universal_symbol &&
           option_symbol == o.option_symbol &&
@@ -318,7 +340,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [brokerage_order_id, status, universal_symbol, option_symbol, quote_universal_symbol, quote_currency, action, total_quantity, open_quantity, canceled_quantity, filled_quantity, execution_price, limit_price, stop_price, trailing_stop, order_type, time_in_force, time_placed, time_updated, time_executed, expiry_date, symbol, child_brokerage_order_ids].hash
+      [brokerage_order_id, brokerage_group_order_id, order_role, status, universal_symbol, option_symbol, quote_universal_symbol, quote_currency, action, total_quantity, open_quantity, canceled_quantity, filled_quantity, execution_price, limit_price, stop_price, trailing_stop, order_type, time_in_force, time_placed, time_updated, time_executed, expiry_date, symbol, child_brokerage_order_ids].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/account_order_record_option_symbol.rb

@@ -56,7 +56,7 @@ module SnapTrade
       {
         :'id' => :'String',
         :'ticker' => :'String',
-        :'option_type' => :'OptionType',
+        :'option_type' => :'OptionsSymbolOptionType',
         :'strike_price' => :'Float',
         :'expiration_date' => :'Date',
         :'is_mini_option' => :'Boolean',

data/lib/snaptrade/models/account_order_record_quote_universal_symbol.rb

@@ -71,7 +71,7 @@ module SnapTrade
         :'exchange' => :'SymbolExchange',
         :'type' => :'SecurityType',
         :'figi_code' => :'String',
-        :'figi_instrument' => :'SymbolFigiInstrument',
+        :'figi_instrument' => :'StockInstrumentFigiInstrument',
         :'currencies' => :'Array<Currency>'
       }
     end

data/lib/snaptrade/models/account_order_record_universal_symbol.rb

@@ -71,7 +71,7 @@ module SnapTrade
         :'exchange' => :'SymbolExchange',
         :'type' => :'SecurityType',
         :'figi_code' => :'String',
-        :'figi_instrument' => :'SymbolFigiInstrument',
+        :'figi_instrument' => :'StockInstrumentFigiInstrument',
         :'currencies' => :'Array<Currency>'
       }
     end

data/lib/snaptrade/models/account_order_record_v2.rb

@@ -16,6 +16,12 @@ module SnapTrade
     # Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
     attr_accessor :brokerage_order_id
 
+    # The brokerage-assigned identifier that links all orders within a complex order (OCO, OTO, OTOCO) together. Null for non-complex orders or when the brokerage does not return a group identifier. 
+    attr_accessor :brokerage_group_order_id
+
+    # The role of this order within a complex order group (OCO, OTO, OTOCO). Null for non-complex orders. 
+    attr_accessor :order_role
+
     # Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. Possible values include:   - NONE   - PENDING   - ACCEPTED   - FAILED   - REJECTED   - CANCELED   - PARTIAL_CANCELED   - CANCEL_PENDING   - EXECUTED   - PARTIAL   - REPLACE_PENDING   - REPLACED   - EXPIRED   - QUEUED   - TRIGGERED   - ACTIVATED 
     attr_accessor :status
 
@@ -48,10 +54,34 @@ module SnapTrade
     # List of legs that make up the order.
     attr_accessor :legs
 
+    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
       {
         :'brokerage_order_id' => :'brokerage_order_id',
+        :'brokerage_group_order_id' => :'brokerage_group_order_id',
+        :'order_role' => :'order_role',
         :'status' => :'status',
         :'order_type' => :'order_type',
         :'time_in_force' => :'time_in_force',
@@ -75,6 +105,8 @@ module SnapTrade
     def self.openapi_types
       {
         :'brokerage_order_id' => :'String',
+        :'brokerage_group_order_id' => :'String',
+        :'order_role' => :'String',
         :'status' => :'AccountOrderRecordStatus',
         :'order_type' => :'String',
         :'time_in_force' => :'String',
@@ -92,6 +124,8 @@ module SnapTrade
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'brokerage_group_order_id',
+        :'order_role',
         :'order_type',
         :'time_executed',
         :'execution_price',
@@ -120,6 +154,14 @@ module SnapTrade
         self.brokerage_order_id = attributes[:'brokerage_order_id']
       end
 
+      if attributes.key?(:'brokerage_group_order_id')
+        self.brokerage_group_order_id = attributes[:'brokerage_group_order_id']
+      end
+
+      if attributes.key?(:'order_role')
+        self.order_role = attributes[:'order_role']
+      end
+
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
@@ -177,15 +219,29 @@ module SnapTrade
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      order_role_validator = EnumAttributeValidator.new('String', ["TRIGGER", "CONDITIONAL", "PEER"])
+      return false unless order_role_validator.valid?(@order_role)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] order_role Object to be assigned
+    def order_role=(order_role)
+      validator = EnumAttributeValidator.new('String', ["TRIGGER", "CONDITIONAL", "PEER"])
+      unless validator.valid?(order_role)
+        fail ArgumentError, "invalid value for \"order_role\", must be one of #{validator.allowable_values}."
+      end
+      @order_role = order_role
+    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 &&
           brokerage_order_id == o.brokerage_order_id &&
+          brokerage_group_order_id == o.brokerage_group_order_id &&
+          order_role == o.order_role &&
           status == o.status &&
           order_type == o.order_type &&
           time_in_force == o.time_in_force &&
@@ -208,7 +264,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [brokerage_order_id, status, order_type, time_in_force, time_placed, time_executed, quote_currency, execution_price, limit_price, stop_price, trailing_stop, legs].hash
+      [brokerage_order_id, brokerage_group_order_id, order_role, status, order_type, time_in_force, time_placed, time_executed, quote_currency, execution_price, limit_price, stop_price, trailing_stop, legs].hash
     end
 
     # Builds the object from hash