synapse_pay_rest 3.3.1 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 503d134992f78bafbfe89fd3ebbe6430fe35ca87
-  data.tar.gz: a23d139910156322ff423ed7dc01d0e2d23d5f81
+  metadata.gz: 2d39843aa3c581493f96b2cd055bccf32cec1ebe
+  data.tar.gz: 4ae3a0cd80c4282eeaf9db0715e9e7296a689c8e
 SHA512:
-  metadata.gz: 2a55b51ce0018030f2dc71a238751132ec436a99365ae6e68a0362f8c2787fcf4f12142534bdf921c339a377e03986e7f003afa08cb740bba9619e20157006a1
-  data.tar.gz: 00642c06e8e320fd101b7db256c3833949b3b293ca25bddd42386e722083fa35ebeecb33bd0b6e1d8d3293b3f80f7720004becb51f8a4470412cff3e5570abe7
+  metadata.gz: edb542dea9180a45b5a11e86e26a7e86eeea9d0369170bbdc629598a40a5304a759db8d1b38541fc73c86627c315869fcd9d374acfa23fb259b71afd5fab17ad
+  data.tar.gz: 764b6483c776ca8164277751fd013b864a36eebf25425a7faebaf58c3ab365f32eeaa323e0a0cc9ea61266926547d4e69bf69cb1d54fb3f6c7b48a91860c37d2

data/README.md

@@ -28,7 +28,7 @@ $ gem install synapse_pay_rest
 
 - [Samples demonstrating common operations](samples.md)
 - [synapse_pay_rest gem docs](http://www.rubydoc.info/github/synapsepay/SynapsePayRest-Ruby)
-- [API docs](http://docs.synapsepay.com/v3.1)
+- [API docs](http://docs.synapsefi.com/v3.1)
 
 ## Contributing
 

data/lib/synapse_pay_rest.rb

@@ -10,6 +10,8 @@ require 'synapse_pay_rest/api/transactions'
 require 'synapse_pay_rest/api/subscriptions'
 require 'synapse_pay_rest/api/institutions'
 require 'synapse_pay_rest/api/client'
+require 'synapse_pay_rest/api/atms'
+require 'synapse_pay_rest/api/crypto_quotes'
 
 # general library classes
 require 'synapse_pay_rest/error'
@@ -58,6 +60,9 @@ require 'synapse_pay_rest/models/node/clearing_us_node.rb'
 require 'synapse_pay_rest/models/node/ib_deposit_us_node.rb'
 require 'synapse_pay_rest/models/node/ib_subaccount_us_node.rb'
 require 'synapse_pay_rest/models/node/interchange_us_node.rb'
+require 'synapse_pay_rest/models/node/card_us_node.rb'
+require 'synapse_pay_rest/models/node/subcard_us_node.rb'
+require 'synapse_pay_rest/models/node/crypto_us_node.rb'
 
 # iou
 require 'synapse_pay_rest/models/node/iou_node.rb'
@@ -79,6 +84,9 @@ require 'synapse_pay_rest/models/institution/institution'
 
 require 'synapse_pay_rest/models/client/issue_public_key'
 
+require 'synapse_pay_rest/models/atm/atm'
+
+require 'synapse_pay_rest/models/crypto_quote/crypto_quote'
 
 
 # Namespace for all SynapsePayRest classes and modules

data/lib/synapse_pay_rest/api/atms.rb

@@ -0,0 +1,35 @@
+module SynapsePayRest
+  # Wrapper class for /client endpoint
+  class Atms
+    VALID_QUERY_PARAMS = [:page, :per_page, :radius, :zip, :lat, :lon].freeze
+
+    # @!attribute [rw] client
+    #   @return [SynapsePayRest::HTTPClient]
+    attr_accessor :client
+
+    # @param client [SynapsePayRest::HTTPClient]
+    def initialize(client)
+      @client = client
+    end
+    
+    # Sends a GET request to /nodes endpoint to locate atms, and returns the
+    # response.
+    # 
+    # @param scope [String]
+    # 
+    # @raise [SynapsePayRest::Error] may return subclasses of error based on 
+    # HTTP response from API
+    # 
+    # @return [Hash] API responsea
+    def locate(**options)
+      params = VALID_QUERY_PARAMS.map do |p|
+        options[p] ? "#{p}=#{options[p]}" : nil
+      end.compact
+
+      path = "/nodes/atms?"
+      path += params.join('&') if params.any?
+      client.get(path)
+    end
+    
+  end
+end

data/lib/synapse_pay_rest/api/crypto_quotes.rb

@@ -0,0 +1,30 @@
+module SynapsePayRest
+  # Wrapper class for /client endpoint
+  class CryptoQuotes
+
+    # @!attribute [rw] client
+    #   @return [SynapsePayRest::HTTPClient]
+    attr_accessor :client
+
+    # @param client [SynapsePayRest::HTTPClient]
+    def initialize(client)
+      @client = client
+    end
+    
+    # Sends a GET request to /crypto-quotes endpoint to get btc exchange rate and returns the
+    # response.
+    # 
+    # @param scope [String]
+    # 
+    # @raise [SynapsePayRest::Error] may return subclasses of error based on 
+    # HTTP response from API
+    # 
+    # @return [Hash] API response
+    def get()
+      path = '/nodes/crypto-quotes'
+      client.get(path)
+    end
+    private
+    
+  end
+end

data/lib/synapse_pay_rest/api/institutions.rb

@@ -1,7 +1,5 @@
 module SynapsePayRest
   # Wrapper class for /institutions endpoints
-  # 
-  # 
   class Institutions
 
     # @!attribute [rw] client
@@ -13,7 +11,7 @@ module SynapsePayRest
       @client = client
     end
 
-    # Sends a GET request to /v3.1/institutions endpoint. Queries a specific subscription_id
+    # Sends a GET request to /v3.1/institutions endpoint. 
     # 
     # 
     # @raise [SynapsePayRest::Error] may return subclasses of error based on 

data/lib/synapse_pay_rest/api/nodes.rb

@@ -94,6 +94,38 @@ module SynapsePayRest
       client.patch(path, {})
     end
 
+    # Sends a PATCH request to /nodes endpoint to reissue debit card-us node, and returns the
+    # response.
+    # 
+    # @param user_id [String]
+    # @param node_id [String]
+    # 
+    # @raise [SynapsePayRest::Error] may return subclasses of error based on 
+    # HTTP response from API
+    # 
+    # @return [Hash] API response
+    def reissue_card(user_id:, node_id:)
+      path = node_path(user_id: user_id, node_id: node_id)
+      path += '?reissue_card=YES'
+      client.patch(path, {})
+    end
+
+    # Sends a PATCH request to /nodes endpoint to reorder debit card-us node, and returns the
+    # response.
+    # 
+    # @param user_id [String]
+    # @param node_id [String]
+    # 
+    # @raise [SynapsePayRest::Error] may return subclasses of error based on 
+    # HTTP response from API
+    # 
+    # @return [Hash] API response
+    def reorder_card(user_id:, node_id:)
+      path = node_path(user_id: user_id, node_id: node_id)
+      path += '?reorder_card=YES'
+      client.patch(path, {})
+    end
+
     # Sends a DELETE request to /node endpoint to remove a node, and returns the response.
     # 
     # @param user_id [String]

data/lib/synapse_pay_rest/client.rb

@@ -14,7 +14,7 @@ module SynapsePayRest
     # @!attribute [rw] subscriptions
     #   @return [SynapsePayRest::Subscriptions]
     attr_accessor :http_client, :users, :nodes, :subnets, :transactions, :subscriptions, :institutions,
-                  :client_endpoint
+                  :client_endpoint, :atms, :crypto_quotes
 
     # Alias for #transactions (legacy name)
     alias_method :trans, :transactions
@@ -49,6 +49,8 @@ module SynapsePayRest
       @subscriptions    = Subscriptions.new @http_client
       @institutions     = Institutions.new @http_client
       @client_endpoint  = ClientEndpoint.new @http_client
+      @atms             = Atms.new @http_client
+      @crypto_quotes    = CryptoQuotes.new @http_client
     end
 
   
@@ -56,5 +58,10 @@ module SynapsePayRest
     def issue_public_key(scope: "OAUTH|POST,USERS|POST,USERS|GET,USER|GET,USER|PATCH,SUBSCRIPTIONS|GET,SUBSCRIPTIONS|POST,SUBSCRIPTION|GET,SUBSCRIPTION|PATCH,CLIENT|REPORTS,CLIENT|CONTROLS")
       PublicKey.issue(client: self, scope: scope)
     end
+
+    def get_crypto_quotes()
+      CryptoQuote.get(client: self)
+    end
+
   end
 end

data/lib/synapse_pay_rest/models/atm/atm.rb

@@ -0,0 +1,81 @@
+module SynapsePayRest
+  # Represents a public key record and holds methods for getting public key instances
+  # from API calls. This is built on top of the SynapsePayRest::Client class and
+  # is intended to make it easier to use the API without knowing payload formats
+  # or knowledge of REST.
+  class Atm 
+    attr_reader :client, :address_city, :address_country, :address_postal_code, :address_state, :address_street,
+    :latitude, :longitude, :id, :isAvailable24Hours, :isDepositAvailable, :isHandicappedAccessible, :isOffPremise,
+    :isSeasonal, :languageType, :locationDescription, :logoName, :name, :distance
+
+    class << self
+      # Creates a client public key from a response hash.
+      # @note Shouldn't need to call this directly.
+      def from_response(client, response)
+        args = {
+          client:                  client,
+          address_city:            response['atmLocation']['address']['city'],
+          address_country:         response['atmLocation']['address']['country'],
+          address_postal_code:     response['atmLocation']['address']['postalCode'],
+          address_state:           response['atmLocation']['address']['state'],
+          address_street:          response['atmLocation']['address']['street'],
+          latitude:                response['atmLocation']['coordinates']['latitude'],
+          longitude:               response['atmLocation']['coordinates']['longitude'],
+          id:                      response['atmLocation']['id'],
+          isAvailable24Hours:      response['atmLocation']['isAvailable24Hours'],
+          isDepositAvailable:      response['atmLocation']['isDepositAvailable'],
+          isHandicappedAccessible: response['atmLocation']['isHandicappedAccessible'],
+          isOffPremise:            response['atmLocation']['isOffPremise'],
+          isSeasonal:              response['atmLocation']['isSeasonal'],
+          languageType:            response['atmLocation']['languageType'],
+          locationDescription:     response['atmLocation']['locationDescription'],
+          logoName:                response['atmLocation']['logoName'],
+          name:                    response['atmLocation']['name'],
+          distance:                response['distance']
+        }
+        self.new(args)
+      end
+
+      # Locate ATMs near zip code
+      # @param client [SynapsePayRest::Client]
+      # @param zip [String]
+      # 
+      # @raise [SynapsePayRest::Error]
+      # 
+      # @return [SynapsePayRest::Atm] new instance corresponding to same API record
+      def locate(client:, zip: nil, page: nil, per_page: nil, radius: nil, lat: nil, lon: nil)
+        raise ArgumentError, 'client must be a SynapsePayRest::Client' unless client.is_a?(Client)
+        [page, per_page].each do |arg|
+          if arg && (!arg.is_a?(Integer) || arg < 1)
+            raise ArgumentError, "#{arg} must be nil or an Integer >= 1"
+          end
+        end
+
+        [zip, radius, lat, lon].each do |arg|
+          if arg && !arg.is_a?(String)
+            raise ArgumentError, "#{arg}must be a String"
+          end
+        end
+
+        response = client.atms.locate(zip: zip, page: page, per_page: per_page, radius: radius, lat: lat, lon: lon)
+        multiple_from_response(client, response['atms'])
+      end
+
+
+      # Calls from_response on each member of a response collection.
+      def multiple_from_response(client, response)
+        return [] if response.empty?
+        response.map { |atm_data| from_response(client.dup, atm_data)}
+      end
+    end
+
+
+    # @note Do not call directly. Use other class method
+    #   to instantiate via API action.
+    def initialize(**options)
+      options.each { |key, value| instance_variable_set("@#{key}", value) }
+    end
+
+
+  end
+end

data/lib/synapse_pay_rest/models/crypto_quote/crypto_quote.rb

@@ -0,0 +1,40 @@
+module SynapsePayRest
+  # Represents a public key record and holds methods for getting crypto quote
+  # from API calls. This is built on top of the SynapsePayRest::Client class and
+  # is intended to make it easier to use the API without knowing payload formats
+  # or knowledge of REST.
+  class CryptoQuote
+    attr_reader :client, :btcusd, :ethusd, :usdbtc, :usdeth
+
+    class << self
+
+      # Creates a crypto quote from a response hash.
+      # 
+      # @note Shouldn't need to call this directly.
+      def from_response(client, response)
+        args = {
+          client:                    client,
+          btcusd:        response['BTCUSD'],
+          ethusd:        response['ETHUSD'],
+          usdbtc:        response['USDBTC'],
+          usdeth:        response['USDETH']
+        }
+        self.new(args)
+      end
+
+      def get(client:)
+        raise ArgumentError, 'client must be a SynapsePayRest::Client' unless client.is_a?(Client)
+        response = client.crypto_quotes.get()
+        self.from_response(client, response)
+      end
+
+    end
+
+    # @note Do not call directly. Use other class method
+    #   to instantiate via API action.
+    def initialize(**options)
+      options.each { |key, value| instance_variable_set("@#{key}", value) }
+    end
+
+  end
+end

data/lib/synapse_pay_rest/models/institution/institution.rb

@@ -4,22 +4,17 @@ module SynapsePayRest
   # is intended to make it easier to use the API without knowing payload formats
   # or knowledge of REST.
   # 
-  # @todo use mixins to remove duplication between Node and BaseNode.
   class Institution
-    attr_reader :id, :is_active, :scope, :url
+    attr_reader :client, :bank_code, :bank_name, :features, :forgotten_password, :is_active, :logo, :tx_history_months
 
     class << self
-      def all(client:)
-        raise ArgumentError, 'client must be a SynapsePayRest::Client' unless client.is_a?(Client)
-        response = client.institutions.get()
-        multiple_from_response(response['banks'])
-      end
 
       # Creates an Institution from a response hash.
       # 
       # @note Shouldn't need to call this directly.
-      def from_response(response)
+      def from_response(client, response)
         args = {
+          client:                       client,
           bank_code:                    response['bank_code'],
           bank_name:                    response['bank_name'],
           features:                     response['features'],
@@ -31,14 +26,25 @@ module SynapsePayRest
         self.new(args)
       end
 
+      def all(client:)
+        raise ArgumentError, 'client must be a SynapsePayRest::Client' unless client.is_a?(Client)
+        response = client.institutions.get()
+        multiple_from_response(client, response['banks'])
+      end
+
       # Calls from_response on each member of a response collection.
-      def multiple_from_response(response)
+      def multiple_from_response(client, response)
         return [] if response.empty?
-        response.map { |institution_data| from_response(institution_data)}
+        response.map { |institution_data| from_response(client.dup, institution_data)}
       end
 
-      private
+    end
 
+    # @note Do not call directly. Use other class method
+    #   to instantiate via API action.
+    def initialize(**options)
+      options.each { |key, value| instance_variable_set("@#{key}", value) }
     end
+
   end
 end

data/lib/synapse_pay_rest/models/node/base_node.rb

@@ -23,7 +23,9 @@ module SynapsePayRest
                 :email_match, :name_match, :phonenumber_match, :address_street,
                 :address_city, :address_subdivision, :address_country_code, 
                 :address_postal_code, :payee_address, :payee_name, :other, :network,
-                :document_id, :card_type
+                :document_id, :interchange_type, :card_hash, :is_international, :allow_foreign_transactions,
+                :atm_withdrawal_limit, :max_pin_attempts, :pos_withdrawal_limit, :security_alerts,
+                :card_type, :access_token, :portfolio_BTC, :portfolio_ETH, :card_style_id
 
     class << self
       # Creates a new node in the API associated to the provided user and
@@ -97,7 +99,10 @@ module SynapsePayRest
           payee_name:           response['info']['payee_name'],
           document_id:          response['info']['document_id'],
           network:              response['info']['network'],
-          card_type:            response['info']['type'],
+          interchange_type:     response['info']['type'],
+          card_type:            response['info']['card_type'],
+          card_hash:            response['info']['card_hash'],
+          is_international:     response['info']['is_international'],
           user_info:            nil,
           transactions:         nil,
           timeline:             nil,
@@ -144,6 +149,9 @@ module SynapsePayRest
 
           transaction_analysis = response['extra']['other']['transaction_analysis']
           args[:transaction_analysis] = transaction_analysis
+
+          access_token = response['extra']['other']['access_token']
+          args[:access_token] = access_token
         end
 
         if response['timeline']
@@ -160,6 +168,21 @@ module SynapsePayRest
           args[:address_postal_code]   = payee_address['address_postal_code']
         end
 
+        if response['info']['preferences']
+          preferences = response['info']['preferences']
+          args[:allow_foreign_transactions]        = preferences['allow_foreign_transactions']
+          args[:atm_withdrawal_limit]              = preferences['atm_withdrawal_limit']
+          args[:max_pin_attempts]                  = preferences['max_pin_attempts']
+          args[:pos_withdrawal_limit]              = preferences['pos_withdrawal_limit']
+          args[:security_alerts]                   = preferences['security_alerts']
+        end
+
+        if response['info']['portfolio']
+          preferences = response['info']['portfolio']
+          args[:portfolio_BTC]        = preferences['BTC']
+          args[:portfolio_ETH]        = preferences['ETH']
+        end
+
         self.new(**args)
       end
 
@@ -228,6 +251,12 @@ module SynapsePayRest
         if options[:document_id]
           payload['info']['document_id'] = options[:document_id]
         end
+        if options[:card_type]
+          payload['info']['card_type'] = options[:card_type]
+        end
+        if options[:card_style_id]
+          payload['card_style_id'] = options[:card_style_id]
+        end
 
         balance_fields = [:currency]
         balance_fields.each do |field|

data/lib/synapse_pay_rest/models/node/card_us_node.rb

@@ -0,0 +1,92 @@
+module SynapsePayRest
+
+  class CardUsNode < BaseNode
+    class << self
+      private
+
+      def payload_for_create(nickname:, document_id:, card_type:, **options)
+        args = {
+          type: 'CARD-US',
+          nickname: nickname,
+          document_id: document_id,
+          card_type: card_type,
+        }.merge(options)
+        super(args)
+      end
+
+    end
+
+      def update_preferences(**options)
+        if options.empty?
+          raise ArgumentError, 'must provide some key-value pairs to update'
+        end
+        payload = payload_for_preferences(options)
+        response = user.client.nodes.patch(user_id: user.id, node_id: id, payload: payload)
+        self.class.from_response(user, response)
+      end
+
+      def update_allowed(allowed:)
+        if allowed.empty?
+          raise ArgumentError, 'must provide some key-value pairs to update'
+        end
+        payload = { 'allowed': allowed }
+        response = user.client.nodes.patch(user_id: user.id, node_id: id, payload: payload)
+        self.class.from_response(user, response)
+      end
+
+      # Reissues Debit Card on a node
+      # Use Reissue if you wish to change the card number associated with the debit card. 
+      # This is meant to be used in instances where the user wishes to change their existing card 
+      # number (due to fraud or any other reason).
+      # 
+      # @raise [SynapsePayRest::Error] if wrong guess or HTTP error
+      # 
+      # @return [SynapsePayRest::CardUsNode]
+      def reissue_card()
+        response = user.client.nodes.reissue_card(user_id: user.id, node_id: id)
+        self.class.from_response(user, response)
+      end
+
+      # Reorders Debit Card on a node
+      # Use Reorder if the user wishes to keep the same card number but want to order a new plastic. 
+      #Can be used in scenarios where the user's card was destroyed.
+      # 
+      # @raise [SynapsePayRest::Error] if wrong guess or HTTP error
+      # 
+      # @return [SynapsePayRest::CardUsNode]
+      def reorder_card()
+        response = user.client.nodes.reorder_card(user_id: user.id, node_id: id)
+        self.class.from_response(user, response)
+      end
+
+      private
+
+      def payload_for_preferences(**options)
+        payload = {
+            'preferences' => {}
+        }
+        if options[:allow_foreign_transactions]
+          payload['preferences']['allow_foreign_transactions'] = options[:allow_foreign_transactions]
+        end
+
+        if options[:atm_withdrawal_limit]
+          payload['preferences']['atm_withdrawal_limit'] = options[:atm_withdrawal_limit]
+        end
+
+        if options[:max_pin_attempts]
+          payload['preferences']['max_pin_attempts'] = options[:max_pin_attempts]
+        end
+        
+        if options[:pos_withdrawal_limit]
+          payload['preferences']['pos_withdrawal_limit'] = options[:pos_withdrawal_limit]
+        end
+
+        if options[:security_alerts]
+          payload['preferences']['security_alerts'] = options[:security_alerts]
+        end
+
+        payload
+      end
+
+  end
+end

data/lib/synapse_pay_rest/models/node/crypto_us_node.rb

@@ -0,0 +1,16 @@
+module SynapsePayRest
+  # A BTC node allowing any user to hold funds in BTC.
+  class CryptoUsNode < BaseNode
+    class << self
+      private
+
+      def payload_for_create(nickname:, **options)
+        args = {
+          type: 'CRYPTO-US',
+          nickname: nickname
+        }.merge(options)
+        super(args)
+      end
+    end
+  end
+end

data/lib/synapse_pay_rest/models/node/node.rb

@@ -23,7 +23,10 @@ module SynapsePayRest
       'CLEARING-US'            => ClearingUsNode,
       'IB-DEPOSIT-US'          => IbDepositUsNode,
       'IB-SUBACCOUNT-US'       => IbSubaccountUsNode,
-      'INTERCHANGE-US'         => InterchangeUsNode
+      'INTERCHANGE-US'         => InterchangeUsNode,
+      'CARD-US'                => CardUsNode,
+      'SUBCARD-US'             => SubcardUsNode,
+      'CRYPTO-US'              => CryptoUsNode
     }.freeze
 
     class << self

data/lib/synapse_pay_rest/models/node/subcard_us_node.rb

@@ -0,0 +1,65 @@
+module SynapsePayRest
+
+  class SubcardUsNode < BaseNode
+    class << self
+      private
+
+      def payload_for_create(nickname:, document_id:, card_type:, **options)
+        args = {
+          type: 'SUBCARD-US',
+          nickname: nickname,
+          document_id: document_id,
+          card_type: card_type,
+        }.merge(options)
+        super(args)
+      end
+    end
+
+      def update_preferences(**options)
+        if options.empty?
+          raise ArgumentError, 'must provide some key-value pairs to update'
+        end
+        payload = payload_for_preferences(options)
+        response = user.client.nodes.patch(user_id: user.id, node_id: id, payload: payload)
+        self.class.from_response(user, response)
+      end
+
+      def update_allowed(allowed:)
+        if allowed.empty?
+          raise ArgumentError, 'must provide some key-value pairs to update'
+        end
+        payload = { 'allowed': allowed }
+        response = user.client.nodes.patch(user_id: user.id, node_id: id, payload: payload)
+        self.class.from_response(user, response)
+      end
+
+      private
+      
+      def payload_for_preferences(**options)
+        payload = {
+            'preferences' => {}
+        }
+        if options[:allow_foreign_transactions]
+          payload['preferences']['allow_foreign_transactions'] = options[:allow_foreign_transactions]
+        end
+
+        if options[:atm_withdrawal_limit]
+          payload['preferences']['atm_withdrawal_limit'] = options[:atm_withdrawal_limit]
+        end
+
+        if options[:max_pin_attempts]
+          payload['preferences']['max_pin_attempts'] = options[:max_pin_attempts]
+        end
+        
+        if options[:pos_withdrawal_limit]
+          payload['preferences']['pos_withdrawal_limit'] = options[:pos_withdrawal_limit]
+        end
+
+        if options[:security_alerts]
+          payload['preferences']['security_alerts'] = options[:security_alerts]
+        end
+
+        payload
+      end
+  end
+end

data/lib/synapse_pay_rest/models/transaction/transaction.rb

@@ -12,7 +12,7 @@ module SynapsePayRest
     attr_reader :node, :id, :amount, :currency, :client_id, :client_name, :created_on,
                 :ip, :latlon, :note, :process_on, :supp_id, :webhook, :fees,
                 :recent_status, :timeline, :from, :to, :to_type, :to_id,
-                :fee_amount, :fee_note, :fee_to_id
+                :fee_amount, :fee_note, :fee_to_id , :asset, :same_day
 
     class << self
       # Creates a new transaction in the API belonging to the provided node and
@@ -130,6 +130,7 @@ module SynapsePayRest
           latlon:        response['extra']['latlon'],
           note:          response['extra']['note'],
           process_on:    response['extra']['process_on'],
+          same_day:      response['extra']['same_day'],
           supp_id:       response['extra']['supp_id'],
           webhook:       response['extra']['webhook'],
           fees:          response['fees'],
@@ -166,6 +167,8 @@ module SynapsePayRest
           }
         }
         # optional payload fields
+        payload['extra']['asset']      = options[:asset] if options[:asset]
+        payload['extra']['same_day']   = options[:same_day] if options[:same_day]
         payload['extra']['supp_id']    = options[:supp_id] if options[:supp_id]
         payload['extra']['note']       = options[:note] if options[:note]
         payload['extra']['process_on'] = options[:process_in] if options[:process_in]

data/lib/synapse_pay_rest/models/user/user.rb

@@ -727,7 +727,7 @@ module SynapsePayRest
     # Creates a INTERCHANGE-US node.
     # 
     # @param nickname [String] nickname for the node
-    # @param supp_id [String] (optional)
+    # @param document_id [String] Document ID of user's base document that the card is associated with
     # @param gateway_restricted [Boolean] (optional)
     # 
     # @raise [SynapsePayRest::Error]
@@ -737,6 +737,45 @@ module SynapsePayRest
       InterchangeUsNode.create(user: self, **options)
     end
 
+    # Creates a CARD-US node.
+    # 
+    # @param nickname [String] nickname for the node
+    # @param document_id [String] Document ID of user's base document that the card is associated with
+    # @param card_type[String] PHYSICAL or VIRTUAL
+    # 
+    # @raise [SynapsePayRest::Error]
+    # 
+    # @return [SynapsePayRest::CardUsNode]
+    def create_card_us_node(**options)
+      CardUsNode.create(user: self, **options)
+    end
+
+    # Creates a SUBCARD-US node.
+    # 
+    # @param nickname [String] nickname for the node
+    # @param document_id [String] Document ID of user's base document that the card is associated with
+    # @param card_type[String] PHYSICAL or VIRTUAL
+    # 
+    # @raise [SynapsePayRest::Error]
+    # 
+    # @return [SynapsePayRest::SubcardUsNode]
+    def create_subcard_us_node(**options)
+      SubcardUsNode.create(user: self, **options)
+    end
+
+    # Creates a BTC-US node.
+    # 
+    # @param nickname [String] nickname for the node
+    # @param supp_id [String] (optional)
+    # @param gateway_restricted [Boolean] (optional)
+    # 
+    # @raise [SynapsePayRest::Error]
+    # 
+    # @return [SynapsePayRest::BtcUsNode]
+    def create_crypto_us_node(**options)
+      CryptoUsNode.create(user: self, **options)
+    end
+
     # Checks if two User instances have same id (different instances of same record).
     def ==(other)
       other.instance_of?(self.class) && !id.nil? && id == other.id

data/lib/synapse_pay_rest/version.rb

@@ -1,4 +1,4 @@
 module SynapsePayRest
   # Gem version
-  VERSION = '3.3.1'.freeze
+  VERSION = '3.4.0'.freeze
 end

data/samples.md

@@ -1125,6 +1125,51 @@ node = user.create_interchange_us_node(node_info)
 # => #<SynapsePayRest::InterchangeUsNode>
 ```
 
+#### Create CARD-US Node
+
+```ruby
+id = base_document.id
+
+node_info = {
+  nickname: 'Debit Card',
+  document_id: id,
+  card_type: 'PHYSICAL',
+  card_style_id: '550' #optional -- only pass this in if there are multiple styles
+}
+
+card_node = user.create_card_us_node(node_info)
+# => #<SynapsePayRest::CardUsNode>
+```
+
+#### Reorder CARD-US Node
+
+```ruby
+node = card_node.reorder_card
+# => #<SynapsePayRest::CardUsNode>
+```
+
+#### Reissue CARD-US Node
+
+```ruby
+node = card_node.reissue_card
+# => #<SynapsePayRest::CardUsNode>
+```
+
+#### Update CARD-US Preferences
+
+```ruby
+card_prefs = {
+    allow_foreign_transactions: true,
+    atm_withdrawal_limit: 6000,
+    max_pin_attempts: 4,
+    pos_withdrawal_limit: 100,
+    security_alerts: false
+}
+
+node = node.update_preferences(card_prefs)
+# => #<SynapsePayRest::CardUsNode>
+```
+
 #### Deactivate a Node
 
 This deactivates the node. It does not automatically cancel any transactions already underway.
@@ -1292,9 +1337,73 @@ public_key = client.issue_public_key(scope: ‘CLIENT|CONTROLS’)
 # => #<SynapsePayRest::Public_key>
 ```
 
-##### b) Subnet#all
+##### b) PublicKey#issue
 
 ```ruby
 public_key = SynapsePayRest::PublicKey.issue(client: client, scope: ‘CLIENT|CONTROLS')
 # => #<SynapsePayRest::Public_key>
 ```
+
+## Crypto Quote Method
+
+#### Get Crypto Quote From Client
+
+##### a) Client#get_crypto_quotes
+
+```ruby
+crypto_quotes = client.get_crypto_quotes
+# => #<SynapsePayRest::CryptoQuote>
+```
+
+##### b) CryptoQuote#get
+
+```ruby
+crypto_quote = SynapsePayRest::CryptoQuote.get(client: client)
+# => #<SynapsePayRest::CryptoQuote>
+```
+
+## Institution Method
+
+#### Get Institutions
+
+##### a) Institutions#all
+
+```ruby
+institutions = SynapsePayRest::Institution.all(client: client)
+# => [#<SynapsePayRest::Institution>, #<SynapsePayRest::Institution>, ...]
+```
+
+## Locate ATM Method
+
+#### Locate nearby ATMs with lat/lon or zipcode
+
+##### a) ATM#locate
+
+```ruby
+atm_info = {
+  client: client,
+  lat: '37.764832',
+  lon: '-122.419304',
+  radius: '5',
+  page: 1,
+  per_page: 10
+   }
+
+atms = SynapsePayRest::Atm.locate(atm_info)
+# => [#<SynapsePayRest::Atm>, #<SynapsePayRest::Atm>, ...]
+```
+
+##### b) ATM#locate
+
+```ruby
+atm_args = {
+  client: client,
+  zip: '95131',
+  radius: '10',
+  page: 1,
+  per_page: 10
+   }
+
+atms = SynapsePayRest::Atm.locate(atm_args)
+# => [#<SynapsePayRest::Atm>, #<SynapsePayRest::Atm>, ...]
+```

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synapse_pay_rest
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.4.0
 platform: ruby
 authors:
 - Steven Broderick
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-12 00:00:00.000000000 Z
+date: 2018-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -151,7 +151,9 @@ files:
 - Rakefile
 - bin/console
 - lib/synapse_pay_rest.rb
+- lib/synapse_pay_rest/api/atms.rb
 - lib/synapse_pay_rest/api/client.rb
+- lib/synapse_pay_rest/api/crypto_quotes.rb
 - lib/synapse_pay_rest/api/institutions.rb
 - lib/synapse_pay_rest/api/nodes.rb
 - lib/synapse_pay_rest/api/subnets.rb
@@ -161,12 +163,16 @@ files:
 - lib/synapse_pay_rest/client.rb
 - lib/synapse_pay_rest/error.rb
 - lib/synapse_pay_rest/http_client.rb
+- lib/synapse_pay_rest/models/atm/atm.rb
 - lib/synapse_pay_rest/models/client/issue_public_key.rb
+- lib/synapse_pay_rest/models/crypto_quote/crypto_quote.rb
 - lib/synapse_pay_rest/models/institution/institution.rb
 - lib/synapse_pay_rest/models/node/ach_us_node.rb
 - lib/synapse_pay_rest/models/node/base_node.rb
+- lib/synapse_pay_rest/models/node/card_us_node.rb
 - lib/synapse_pay_rest/models/node/check_us_node.rb
 - lib/synapse_pay_rest/models/node/clearing_us_node.rb
+- lib/synapse_pay_rest/models/node/crypto_us_node.rb
 - lib/synapse_pay_rest/models/node/deposit_us_node.rb
 - lib/synapse_pay_rest/models/node/eft_ind_node.rb
 - lib/synapse_pay_rest/models/node/eft_np_node.rb
@@ -177,6 +183,7 @@ files:
 - lib/synapse_pay_rest/models/node/node.rb
 - lib/synapse_pay_rest/models/node/reserve_us_node.rb
 - lib/synapse_pay_rest/models/node/subaccount_us_node.rb
+- lib/synapse_pay_rest/models/node/subcard_us_node.rb
 - lib/synapse_pay_rest/models/node/synapse_ind_node.rb
 - lib/synapse_pay_rest/models/node/synapse_np_node.rb
 - lib/synapse_pay_rest/models/node/synapse_us_node.rb