snaptrade 2.0.42 → 2.0.43

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef0e42437344c3de95a109e8b65a5297915515a37230c0aa443eaeace9213dab
-  data.tar.gz: 0d6217ba0036003029c403384e8355b2785a485e98443b6bc07513b47f482d9c
+  metadata.gz: 23a2e3fed05b3c17d3f7ab8dac5541766ba2a112c6d1f14ac5e4f0f9b2ed5c29
+  data.tar.gz: 609e612c05e085c990ef3bfe195d62eb9849111a409c85e0b8c58f50760c9947
 SHA512:
-  metadata.gz: ff422a9c92ce394d98e1d0de8aeaee6f73e07864d8e369551be867ebd1af291aac78ac5461969e605f8b21045c269f485b1233b6b787426258991c8a6a2ea68d
-  data.tar.gz: f1a5b614e521789000a54df2252ca23191043f60ee9ee5a3a748e53683ba34a70ca555588b4d2f15de83785ec6a294389c7986b1416a4547cc1b01e32fd60642
+  metadata.gz: 7badc683104a2fe4bc32db98ae561c2865433d4fc861d3c0b73420f850757a4cecdb5fb4be78f7efdbe1bcea1839437e9c05e3f9446eeef6d9dde879ed5ab7af
+  data.tar.gz: 3277c3fc4f7367d6f55c699dbd27bc7abfc0b71ff67a4af619eee0ffbef9801d5805c04af1aa252d8cda41f89199b5ca7bd257eab0ed18d3ec3df5be081db038

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.42)
+    snaptrade (2.0.43)
       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.42-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.42)
+[![npm](https://img.shields.io/badge/gem-v2.0.43-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.43)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -70,7 +70,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.42'
+gem 'snaptrade', '~> 2.0.43'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1089,7 +1089,7 @@ A currency pair based on currency code for example, {CAD-USD}
 
 ### `snaptrade.reference_data.get_partner_info`<a id="snaptradereference_dataget_partner_info"></a>
 
-Returns useful data related to the specified ClientID, including allowed brokerages and data access.
+Returns configurations for your SnapTrade Client ID, including allowed brokerages and data access.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1113,7 +1113,7 @@ p result
 
 ### `snaptrade.reference_data.get_security_types`<a id="snaptradereference_dataget_security_types"></a>
 
-List security types available on SnapTrade.
+Return all available security types supported by SnapTrade.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 

data/lib/snaptrade/api/reference_data_api.rb

@@ -102,9 +102,9 @@ module SnapTrade
     end
 
 
-    # Get metadata related to Snaptrade partner
+    # Get Client Info
     #
-    # Returns useful data related to the specified ClientID, including allowed brokerages and data access.
+    # Returns configurations for your SnapTrade Client ID, including allowed brokerages and data access.
     #
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_partner_info(extra: {})
@@ -112,17 +112,17 @@ module SnapTrade
       data
     end
 
-    # Get metadata related to Snaptrade partner
+    # Get Client Info
     #
-    # Returns useful data related to the specified ClientID, including allowed brokerages and data access.
+    # Returns configurations for your SnapTrade Client ID, including allowed brokerages and data access.
     #
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_partner_info_with_http_info(extra: {})
       get_partner_info_with_http_info_impl(extra)
     end
 
-    # Get metadata related to Snaptrade partner
-    # Returns useful data related to the specified ClientID, including allowed brokerages and data access.
+    # Get Client Info
+    # Returns configurations for your SnapTrade Client ID, including allowed brokerages and data access.
     # @param [Hash] opts the optional parameters
     # @return [PartnerData]
     private def get_partner_info_impl(opts = {})
@@ -130,8 +130,8 @@ module SnapTrade
       data
     end
 
-    # Get metadata related to Snaptrade partner
-    # Returns useful data related to the specified ClientID, including allowed brokerages and data access.
+    # Get Client Info
+    # Returns configurations for your SnapTrade Client ID, including allowed brokerages and data access.
     # @param [Hash] opts the optional parameters
     # @return [Array<(PartnerData, Integer, Hash)>] PartnerData data, response status code and response headers
     private def get_partner_info_with_http_info_impl(opts = {})
@@ -179,9 +179,9 @@ module SnapTrade
     end
 
 
-    # List of all security types
+    # List security types
     #
-    # List security types available on SnapTrade.
+    # Return all available security types supported by SnapTrade.
     #
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_security_types(extra: {})
@@ -189,17 +189,17 @@ module SnapTrade
       data
     end
 
-    # List of all security types
+    # List security types
     #
-    # List security types available on SnapTrade.
+    # Return all available security types supported by SnapTrade.
     #
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_security_types_with_http_info(extra: {})
       get_security_types_with_http_info_impl(extra)
     end
 
-    # List of all security types
-    # List security types available on SnapTrade.
+    # List security types
+    # Return all available security types supported by SnapTrade.
     # @param [Hash] opts the optional parameters
     # @return [Array<SecurityType>]
     private def get_security_types_impl(opts = {})
@@ -207,8 +207,8 @@ module SnapTrade
       data
     end
 
-    # List of all security types
-    # List security types available on SnapTrade.
+    # List security types
+    # Return all available security types supported by SnapTrade.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<SecurityType>, Integer, Hash)>] Array<SecurityType> data, response status code and response headers
     private def get_security_types_with_http_info_impl(opts = {})

data/lib/snaptrade/models/partner_data.rb

@@ -11,59 +11,59 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # SnapTrade Partner metadata
+  # Configurations for your SnapTrade Client ID, including allowed brokerages and data access.
   class PartnerData
-    # URI to redirect user back to after user is done adding brokerage connections
-    attr_accessor :redirect_uri
-
-    # Brokerages that can be accessed by partners
-    attr_accessor :allowed_brokerages
+    # A short, unique identifier for your company or product.
+    attr_accessor :slug
 
-    # Name of Snaptrade Partner
+    # Your company or product name.
     attr_accessor :name
 
-    # Slug of Snaptrade Partner
-    attr_accessor :slug
-
-    # URL to partner's logo
+    # URL to your company or product logo.
     attr_accessor :logo_url
 
-    # Shows if pin is required by users to access connection page
-    attr_accessor :pin_required
+    # Brokerages that can be accessed by your Client ID.
+    attr_accessor :allowed_brokerages
 
-    # Shows if users of Snaptrade partners can access trade endpoints
+    # Whether trading is enabled for your SnapTrade Client ID.
     attr_accessor :can_access_trades
 
-    # Shows if Snaptrade partners can get user holdings data
+    # Whether holdings data is enabled for your SnapTrade Client ID.
     attr_accessor :can_access_holdings
 
-    # Shows if Snaptrade partners can get users account history data
+    # Whether account historical transactions is enabled for your SnapTrade Client ID.
     attr_accessor :can_access_account_history
 
-    # Shows if Snaptrade partners can get users holdings data
+    # Whether reference data is enabled for your SnapTrade Client ID.
     attr_accessor :can_access_reference_data
 
-    # Shows if users Snaptrade partners can access portfolio group management features
+    # Whether portfolio management is enabled for your SnapTrade Client ID.
     attr_accessor :can_access_portfolio_management
 
-    # Shows if Snaptrade partners can get users account order history
+    # Whether recent order history is enabled for your SnapTrade Client ID.
     attr_accessor :can_access_orders
 
+    # URI to redirect user back to after user is done adding brokerage connections.
+    attr_accessor :redirect_uri
+
+    # Shows if pin is required by users to access connection page. This field has been deprecated.
+    attr_accessor :pin_required
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'redirect_uri' => :'redirect_uri',
-        :'allowed_brokerages' => :'allowed_brokerages',
-        :'name' => :'name',
         :'slug' => :'slug',
+        :'name' => :'name',
         :'logo_url' => :'logo_url',
-        :'pin_required' => :'pin_required',
+        :'allowed_brokerages' => :'allowed_brokerages',
         :'can_access_trades' => :'can_access_trades',
         :'can_access_holdings' => :'can_access_holdings',
         :'can_access_account_history' => :'can_access_account_history',
         :'can_access_reference_data' => :'can_access_reference_data',
         :'can_access_portfolio_management' => :'can_access_portfolio_management',
-        :'can_access_orders' => :'can_access_orders'
+        :'can_access_orders' => :'can_access_orders',
+        :'redirect_uri' => :'redirect_uri',
+        :'pin_required' => :'pin_required'
       }
     end
 
@@ -75,18 +75,18 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'redirect_uri' => :'String',
-        :'allowed_brokerages' => :'Array<Brokerage>',
-        :'name' => :'String',
         :'slug' => :'String',
+        :'name' => :'String',
         :'logo_url' => :'String',
-        :'pin_required' => :'Boolean',
+        :'allowed_brokerages' => :'Array<Brokerage>',
         :'can_access_trades' => :'Boolean',
         :'can_access_holdings' => :'Boolean',
         :'can_access_account_history' => :'Boolean',
         :'can_access_reference_data' => :'Boolean',
         :'can_access_portfolio_management' => :'Boolean',
-        :'can_access_orders' => :'Boolean'
+        :'can_access_orders' => :'Boolean',
+        :'redirect_uri' => :'String',
+        :'pin_required' => :'Boolean'
       }
     end
 
@@ -111,30 +111,22 @@ module SnapTrade
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'redirect_uri')
-        self.redirect_uri = attributes[:'redirect_uri']
-      end
-
-      if attributes.key?(:'allowed_brokerages')
-        if (value = attributes[:'allowed_brokerages']).is_a?(Array)
-          self.allowed_brokerages = value
-        end
+      if attributes.key?(:'slug')
+        self.slug = attributes[:'slug']
       end
 
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
 
-      if attributes.key?(:'slug')
-        self.slug = attributes[:'slug']
-      end
-
       if attributes.key?(:'logo_url')
         self.logo_url = attributes[:'logo_url']
       end
 
-      if attributes.key?(:'pin_required')
-        self.pin_required = attributes[:'pin_required']
+      if attributes.key?(:'allowed_brokerages')
+        if (value = attributes[:'allowed_brokerages']).is_a?(Array)
+          self.allowed_brokerages = value
+        end
       end
 
       if attributes.key?(:'can_access_trades')
@@ -160,6 +152,14 @@ module SnapTrade
       if attributes.key?(:'can_access_orders')
         self.can_access_orders = attributes[:'can_access_orders']
       end
+
+      if attributes.key?(:'redirect_uri')
+        self.redirect_uri = attributes[:'redirect_uri']
+      end
+
+      if attributes.key?(:'pin_required')
+        self.pin_required = attributes[:'pin_required']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -180,18 +180,18 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          redirect_uri == o.redirect_uri &&
-          allowed_brokerages == o.allowed_brokerages &&
-          name == o.name &&
           slug == o.slug &&
+          name == o.name &&
           logo_url == o.logo_url &&
-          pin_required == o.pin_required &&
+          allowed_brokerages == o.allowed_brokerages &&
           can_access_trades == o.can_access_trades &&
           can_access_holdings == o.can_access_holdings &&
           can_access_account_history == o.can_access_account_history &&
           can_access_reference_data == o.can_access_reference_data &&
           can_access_portfolio_management == o.can_access_portfolio_management &&
-          can_access_orders == o.can_access_orders
+          can_access_orders == o.can_access_orders &&
+          redirect_uri == o.redirect_uri &&
+          pin_required == o.pin_required
     end
 
     # @see the `==` method
@@ -203,7 +203,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [redirect_uri, allowed_brokerages, name, slug, logo_url, pin_required, can_access_trades, can_access_holdings, can_access_account_history, can_access_reference_data, can_access_portfolio_management, can_access_orders].hash
+      [slug, name, logo_url, allowed_brokerages, can_access_trades, can_access_holdings, can_access_account_history, can_access_reference_data, can_access_portfolio_management, can_access_orders, redirect_uri, pin_required].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/version.rb

@@ -8,5 +8,5 @@ Contact: api@snaptrade.com
 =end
 
 module SnapTrade
-  VERSION = '2.0.42'
+  VERSION = '2.0.43'
 end

data/spec/api/reference_data_api_spec.rb

@@ -40,8 +40,8 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for get_partner_info
-  # Get metadata related to Snaptrade partner
-  # Returns useful data related to the specified ClientID, including allowed brokerages and data access.
+  # Get Client Info
+  # Returns configurations for your SnapTrade Client ID, including allowed brokerages and data access.
   # @param [Hash] opts the optional parameters
   # @return [PartnerData]
   describe 'get_partner_info test' do
@@ -51,8 +51,8 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for get_security_types
-  # List of all security types
-  # List security types available on SnapTrade.
+  # List security types
+  # Return all available security types supported by SnapTrade.
   # @param [Hash] opts the optional parameters
   # @return [Array<SecurityType>]
   describe 'get_security_types test' do

data/spec/models/partner_data_spec.rb

@@ -20,73 +20,73 @@ describe SnapTrade::PartnerData do
       expect(instance).to be_instance_of(SnapTrade::PartnerData)
     end
   end
-  describe 'test attribute "redirect_uri"' do
+  describe 'test attribute "slug"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "allowed_brokerages"' do
+  describe 'test attribute "name"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "name"' do
+  describe 'test attribute "logo_url"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "slug"' do
+  describe 'test attribute "allowed_brokerages"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "logo_url"' do
+  describe 'test attribute "can_access_trades"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "pin_required"' do
+  describe 'test attribute "can_access_holdings"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "can_access_trades"' do
+  describe 'test attribute "can_access_account_history"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "can_access_holdings"' do
+  describe 'test attribute "can_access_reference_data"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "can_access_account_history"' do
+  describe 'test attribute "can_access_portfolio_management"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "can_access_reference_data"' do
+  describe 'test attribute "can_access_orders"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "can_access_portfolio_management"' do
+  describe 'test attribute "redirect_uri"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "can_access_orders"' do
+  describe 'test attribute "pin_required"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.42
+  version: 2.0.43
 platform: ruby
 authors:
 - SnapTrade