synapse_pay_rest 3.2.9 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e1254529baa7987ffaf86abeeffaff7b0219331
-  data.tar.gz: be4f9b1df87137bf78189aae8062986e0825baf9
+  metadata.gz: 503d134992f78bafbfe89fd3ebbe6430fe35ca87
+  data.tar.gz: a23d139910156322ff423ed7dc01d0e2d23d5f81
 SHA512:
-  metadata.gz: 23a3ed5f4a1ca4073df50437910bef26c88a3f819c576c3bd74fdae61ca09d8edc4986fa5dc4486a3ca3ab4e68e3e6e7851e3aa87c661abfe9cd688f1cbc903c
-  data.tar.gz: 6c2bba6907cb3ec22ad8e877a241d766de06200825e9428ea6f066a2ff5998d5745a56b3e901c4f080ab6a1528cdf8690b19697b33bed34b9111ae81508bc47b
+  metadata.gz: 2a55b51ce0018030f2dc71a238751132ec436a99365ae6e68a0362f8c2787fcf4f12142534bdf921c339a377e03986e7f003afa08cb740bba9619e20157006a1
+  data.tar.gz: 00642c06e8e320fd101b7db256c3833949b3b293ca25bddd42386e722083fa35ebeecb33bd0b6e1d8d3293b3f80f7720004becb51f8a4470412cff3e5570abe7

data/lib/synapse_pay_rest.rb

@@ -5,9 +5,11 @@ require 'synapse_pay_rest/http_client'
 # base API classes
 require 'synapse_pay_rest/api/users'
 require 'synapse_pay_rest/api/nodes'
+require 'synapse_pay_rest/api/subnets'
 require 'synapse_pay_rest/api/transactions'
 require 'synapse_pay_rest/api/subscriptions'
 require 'synapse_pay_rest/api/institutions'
+require 'synapse_pay_rest/api/client'
 
 # general library classes
 require 'synapse_pay_rest/error'
@@ -37,6 +39,8 @@ require 'synapse_pay_rest/models/node/subaccount_us_node.rb'
 # ach
 require 'synapse_pay_rest/models/node/ach_us_node.rb'
 require 'synapse_pay_rest/models/node/unverified_node.rb'
+#check
+require 'synapse_pay_rest/models/node/check_us_node.rb'
 # eft
 require 'synapse_pay_rest/models/node/eft_ind_node.rb'
 require 'synapse_pay_rest/models/node/eft_np_node.rb'
@@ -50,12 +54,20 @@ require 'synapse_pay_rest/models/node/triumph_subaccount_us_node.rb'
 require 'synapse_pay_rest/models/node/subaccount_us_node.rb'
 require 'synapse_pay_rest/models/node/deposit_us_node.rb'
 
+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'
+
 # iou
 require 'synapse_pay_rest/models/node/iou_node.rb'
 
 # BaseNode factory
 require 'synapse_pay_rest/models/node/node'
 
+# subnet-related classes
+require 'synapse_pay_rest/models/subnet/subnet'
+
 # transaction-related classes
 require 'synapse_pay_rest/models/transaction/transaction'
 
@@ -65,6 +77,10 @@ require 'synapse_pay_rest/models/subscription/subscription'
 # institution-related classes
 require 'synapse_pay_rest/models/institution/institution'
 
+require 'synapse_pay_rest/models/client/issue_public_key'
+
+
+
 # Namespace for all SynapsePayRest classes and modules
 module SynapsePayRest
   # Modifies the default method to print a warning when deprecated constants

data/lib/synapse_pay_rest/api/client.rb

@@ -0,0 +1,30 @@
+module SynapsePayRest
+  # Wrapper class for /client endpoint
+  class ClientEndpoint
+
+    # @!attribute [rw] client
+    #   @return [SynapsePayRest::HTTPClient]
+    attr_accessor :client
+
+    # @param client [SynapsePayRest::HTTPClient]
+    def initialize(client)
+      @client = client
+    end
+    
+    # Sends a GET request to /client endpoint to issue public key, 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 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")
+      path = '/client?issue_public_key=YES'
+      path += "&scope=#{scope}"
+      client.get(path)
+    end
+    
+  end
+end

data/lib/synapse_pay_rest/api/subnets.rb

@@ -0,0 +1,87 @@
+module SynapsePayRest
+  # Wrapper class for /subnets endpoints
+  # 
+  class Subnets
+
+    # Valid optional args for #get
+    # @todo Refactor to HTTPClient
+    VALID_QUERY_PARAMS = [:page, :per_page].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 /subnets endpoint. Queries a specific subnet_id
+    # if subnet_id supplied, else queries all transactions. Returns the response.
+    # 
+    # @param user_id [String]
+    # @param node_id [String] id of node
+    # @param subnet_id [String,void] (optional) id of a subnet to look up
+    # @param page [String,Integer] (optional) response will default to 1
+    # @param per_page [String,Integer] (optional) response will default to 20
+    # 
+    # @raise [SynapsePayRest::Error] may return subclasses of error based on 
+    # HTTP response from API
+    # 
+    # @return [Hash] API response
+    # 
+    def get(user_id:, node_id:, subnet_id: nil, **options)
+      path = create_subnet_path(user_id: user_id, node_id: node_id, subnet_id: subnet_id)
+
+      params = VALID_QUERY_PARAMS.map do |p|
+        options[p] ? "#{p}=#{options[p]}" : nil
+      end.compact
+
+      path += '?' + params.join('&') if params.any?
+      client.get(path)
+    end
+
+    # Sends a POST request to /subents endpoint to create a new subnet.
+    # Returns the response.
+    # 
+    # @param user_id [String] user_id associated with the subnet
+    # @param node_id [String] node the subnet belongs to
+    # @param payload [Hash]
+    # @see https://docs.synapsepay.com/docs/create-subnet payload structure
+    # 
+    # @raise [SynapsePayRest::Error] may return subclasses of error based on 
+    # HTTP response from API
+    # 
+    # @return [Hash] API response
+    def create(user_id:, node_id:, payload:)
+      path = create_subnet_path(user_id: user_id, node_id: node_id)
+      client.post(path, payload)
+    end
+
+    # Sends a PATCH request to /subnets endpoint to update a subnet. 
+    # Returns the response.
+    # 
+    # @param user_id [String] id of user associated with the subnet
+    # @param node_id [String] id of node the subnet belongs to
+    # @param subnet_id [String] id of subnet
+    # @param payload [Hash]
+    # @see https://docs.synapsepay.com/docs/subnet-1 payload structure
+    # 
+    # @raise [SynapsePayRest::Error] may return subclasses of error based on 
+    # HTTP response from API
+    # 
+    # @return [Hash] API response
+    def update(user_id:, node_id:, subnet_id:, payload:)
+      path = create_subnet_path(user_id: user_id, node_id: node_id, subnet_id: subnet_id)
+      client.patch(path, payload)
+    end
+
+    private
+
+    def create_subnet_path(user_id:, node_id:, subnet_id: nil)
+      path = "/users/#{user_id}/nodes/#{node_id}/subnets"
+      path += "/#{subnet_id}" if subnet_id
+      path
+    end
+  end
+end

data/lib/synapse_pay_rest/client.rb

@@ -13,7 +13,8 @@ module SynapsePayRest
     #   @return [SynapsePayRest::Transactions]
     # @!attribute [rw] subscriptions
     #   @return [SynapsePayRest::Subscriptions]
-    attr_accessor :http_client, :users, :nodes, :transactions, :subscriptions, :institutions
+    attr_accessor :http_client, :users, :nodes, :subnets, :transactions, :subscriptions, :institutions,
+                  :client_endpoint
 
     # Alias for #transactions (legacy name)
     alias_method :trans, :transactions
@@ -32,7 +33,7 @@ module SynapsePayRest
       base_url = if development_mode
                    'https://uat-api.synapsefi.com/v3.1'
                  else
-                   'https://synapsepay.com/api/3'
+                   'https://api.synapsefi.com/v3.1'
                  end
 
       @http_client  = HTTPClient.new(base_url: base_url,
@@ -41,11 +42,19 @@ module SynapsePayRest
                                      fingerprint: fingerprint,
                                      ip_address: ip_address,
                                      **options)
-      @users         = Users.new @http_client
-      @nodes         = Nodes.new @http_client
-      @transactions  = Transactions.new @http_client
-      @subscriptions = Subscriptions.new @http_client
-      @institutions  = Institutions.new @http_client
+      @users            = Users.new @http_client
+      @nodes            = Nodes.new @http_client
+      @subnets          = Subnets.new @http_client
+      @transactions     = Transactions.new @http_client
+      @subscriptions    = Subscriptions.new @http_client
+      @institutions     = Institutions.new @http_client
+      @client_endpoint  = ClientEndpoint.new @http_client
+    end
+
+  
+
+    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
   end
 end

data/lib/synapse_pay_rest/models/client/issue_public_key.rb

@@ -0,0 +1,47 @@
+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 PublicKey 
+    attr_reader :client, :client_obj_id, :expires_at, :expires_in, :public_key, :scope
+
+    class << self
+      # Creates a client public key from a response hash.
+      # @note Shouldn't need to call this directly.
+      def from_response(response)
+        args = {
+          client:                    response['client'],
+          client_obj_id:             response['public_key_obj']['client_obj_id'],
+          expires_at:                response['public_key_obj']['expires_at'],
+          expires_in:                response['public_key_obj']['expires_in'],
+          public_key:                response['public_key_obj']['public_key'],
+          scope:                     response['public_key_obj']['scope']
+        }
+        self.new(args)
+      end
+
+      #Issues public key for client.
+      # @param client [SynapsePayRest::Client]
+      # @param scope [String]
+      # 
+      # @raise [SynapsePayRest::Error]
+      # 
+      # @return [SynapsePayRest::PublicKey] new instance corresponding to same API record
+      def issue(client:, scope: "OAUTH|POST,USERS|POST,USERS|GET,USER|GET,USER|PATCH,SUBSCRIPTIONS|GET,SUBSCRIPTIONS|POST,SUBSCRIPTION|GET,SUBSCRIPTION|PATCH,CLIENT|REPORTS,CLIENT|CONTROLS")
+        raise ArgumentError, 'client must be a SynapsePayRest::Client' unless client.is_a?(Client)
+        raise ArgumentError, 'scope must be a String' unless scope.is_a?(String)
+
+        response = client.client_endpoint.issue_public_key(scope: scope)
+        from_response(response)
+      end
+    end
+
+    # @note Do not call directly. Use PublicKey.issue or 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/ach_us_node.rb

@@ -126,6 +126,7 @@ module SynapsePayRest
       response = user.client.nodes.resend_micro(user_id: user.id, node_id: id)
       self.class.from_response(user, response)
     end
+    
 
     private
 
@@ -133,5 +134,6 @@ module SynapsePayRest
     def verify_microdeposits_payload(amount1:, amount2:)
       {'micro' => [amount1, amount2]}
     end
+
   end
 end

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

@@ -20,7 +20,10 @@ module SynapsePayRest
                 :correspondent_routing_number, :correspondent_bank_name,
                 :correspondent_address, :correspondent_swift, :account_id, :balance,
                 :ifsc, :swift, :bank_long_name, :type, :gateway_restricted,
-                :email_match, :name_match, :phonenumber_match
+                :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
 
     class << self
       # Creates a new node in the API associated to the provided user and
@@ -91,6 +94,10 @@ module SynapsePayRest
           address:              response['info']['address'],
           swift:                response['info']['swift'],
           ifsc:                 response['info']['ifsc'],
+          payee_name:           response['info']['payee_name'],
+          document_id:          response['info']['document_id'],
+          network:              response['info']['network'],
+          card_type:            response['info']['type'],
           user_info:            nil,
           transactions:         nil,
           timeline:             nil,
@@ -144,6 +151,15 @@ module SynapsePayRest
           args[:timeline] = timeline
         end
 
+        if response['info']['payee_address']
+          payee_address = response['info']['payee_address']
+          args[:address_street]        = payee_address['address_street']
+          args[:address_city]          = payee_address['address_city']
+          args[:address_subdivision]   = payee_address['address_subdivision']
+          args[:address_country_code]  = payee_address['address_country_code']
+          args[:address_postal_code]   = payee_address['address_postal_code']
+        end
+
         self.new(**args)
       end
 
@@ -159,7 +175,7 @@ module SynapsePayRest
         }
 
         info_fields = [
-          :swift, :name_on_account, :bank_name, :address, :ifsc,:nickname,
+          :swift, :name_on_account, :bank_name, :address, :ifsc, :nickname,
           :bank_name
         ]
         info_fields.each do |field|
@@ -200,6 +216,18 @@ module SynapsePayRest
         if options[:password]
           payload['info']['bank_pw'] = options[:password]
         end
+        if options[:payee_name]
+          payload['info']['payee_name'] = options[:payee_name]
+        end
+        if options[:card_number]
+          payload['info']['card_number'] = options[:card_number]
+        end
+        if options[:exp_date]
+          payload['info']['exp_date'] = options[:exp_date]
+        end
+        if options[:document_id]
+          payload['info']['document_id'] = options[:document_id]
+        end
 
         balance_fields = [:currency]
         balance_fields.each do |field|
@@ -209,7 +237,7 @@ module SynapsePayRest
           end
         end
 
-        extra_fields = [:supp_id, :gateway_restricted]
+        extra_fields = [:supp_id, :gateway_restricted, :other]
         extra_fields.each do |field|
           if options[field]
             payload['extra'] ||= {}
@@ -217,6 +245,15 @@ module SynapsePayRest
           end
         end
 
+        payee_address_fields = [:address_street, :address_city, :address_subdivision, 
+          :address_country_code, :address_postal_code]
+        payee_address_fields.each do |field|
+          if options[field]
+            payload['info']['payee_address'] ||= {}
+            payload['info']['payee_address'][field.to_s] = options[field] if options[field]
+          end
+        end
+
         payload
       end
     end
@@ -278,6 +315,44 @@ module SynapsePayRest
       Transaction.find(node: self, id: id)
     end
 
+    # Creates a subnet belonging to this node and returns it as a Subnet
+    # instance.
+    # 
+    #
+    # @raise [SynapsePayRest::Error] if HTTP error or invalid argument format
+    # 
+    # @return [SynapsePayRest::Subnet]
+    def create_subnet(**options)
+      Subnet.create(node: self, **options)
+    end
+
+    # Queries the API for all subnets belonging to this node and returns
+    # them as Subnet instances.
+    # 
+    # @param page [String,Integer] (optional) response will default to 1
+    # @param per_page [String,Integer] (optional) response will default to 20
+    # 
+    # @raise [SynapsePayRest::Error]
+    # 
+    # @return [Array<SynapsePayRest::Subnet>]
+    def subnets(**options)
+      Subnet.all(node: self, **options)
+    end
+
+    # Queries the API for a subnet belonging to this node by subnet id
+    # and returns a Subnet instance if found.
+    # 
+    # @param id [String] id of the subnet to find
+    # 
+    # @raise [SynapsePayRest::Error] if not found or other HTTP error
+    # 
+    # @return [SynapsePayRest::Subnet]
+    def find_subnet(id:)
+      raise ArgumentError, 'id must be a String' unless id.is_a?(String)
+
+      Subnet.find(node: self, id: id)
+    end
+
     # Deactivates the node. 
     # 
     # @raise [SynapsePayRest::Error]

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

@@ -0,0 +1,25 @@
+module SynapsePayRest
+  # This node allows you to send a check to any individual or entity in the US.
+  #Currently in sandbox only.
+  class CheckUsNode < BaseNode
+    class << self
+      private
+
+      def payload_for_create(nickname:, payee_name:, address_street:, address_city:,
+        address_subdivision:, address_country_code:, address_postal_code:, **options)
+        args = {
+          type: 'CHECK-US',
+          nickname: nickname,
+          payee_name: payee_name,
+          address_street: address_street,
+          address_city: address_city,
+          address_subdivision: address_subdivision,
+          address_country_code: address_country_code,
+          address_postal_code: address_postal_code
+        }.merge(options)
+        super(args)
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,16 @@
+module SynapsePayRest
+  # 
+  class ClearingUsNode < BaseNode
+    class << self
+      private
+
+      def payload_for_create(nickname:, **options)
+        args = {
+          type: 'CLEARING-US',
+          nickname: nickname
+        }.merge(options)
+        super(args)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module SynapsePayRest
+  # 
+  class IbDepositUsNode < BaseNode
+    class << self
+      private
+
+      def payload_for_create(nickname:, **options)
+        args = {
+          type: 'IB-DEPOSIT-US',
+          nickname: nickname
+        }.merge(options)
+        super(args)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module SynapsePayRest
+  # 
+  class IbSubaccountUsNode < BaseNode
+    class << self
+      private
+
+      def payload_for_create(nickname:, **options)
+        args = {
+          type: 'IB-SUBACCOUNT-US',
+          nickname: nickname
+        }.merge(options)
+        super(args)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module SynapsePayRest
+
+  class InterchangeUsNode < BaseNode
+    class << self
+      private
+
+      def payload_for_create(nickname:, card_number:, exp_date:, document_id:, **options)
+        args = {
+          type: 'INTERCHANGE-US',
+          nickname: nickname,
+          card_number: card_number,
+          exp_date: exp_date,
+          document_id: document_id
+        }.merge(options)
+        super(args)
+      end
+    end
+  end
+end

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

@@ -18,7 +18,12 @@ module SynapsePayRest
       'TRIUMPH-SUBACCOUNT-US'  => TriumphSubaccountUsNode,
       'SUBACCOUNT-US'          => SubaccountUsNode,
       'WIRE-INT'               => WireIntNode,
-      'WIRE-US'                => WireUsNode
+      'WIRE-US'                => WireUsNode,
+      'CHECK-US'               => CheckUsNode,
+      'CLEARING-US'            => ClearingUsNode,
+      'IB-DEPOSIT-US'          => IbDepositUsNode,
+      'IB-SUBACCOUNT-US'       => IbSubaccountUsNode,
+      'INTERCHANGE-US'         => InterchangeUsNode
     }.freeze
 
     class << self

data/lib/synapse_pay_rest/models/subnet/subnet.rb

@@ -0,0 +1,161 @@
+module SynapsePayRest
+  # Represents a subnet record and holds methods for constructing subnet instances
+  # from API calls. This is built on top of the SynapsePayRest::Subnets class and
+  # is intended to make it easier to use the API without knowing payload formats
+  # or knowledge of REST.
+  # 
+  class Subnet
+    # @!attribute [rw] node
+    attr_reader :id, :account_num, :allowed, :client_id, :client_name, :nickname, :node, :routing_num_ach, 
+                :routing_num_wire
+                
+
+    class << self
+      # Creates a new subnet in the API belonging to the provided node and
+      # returns a subnet instance from the response data.
+      # 
+      # @param nickname [String] any nicknames
+      # @param node [SynapsePayRest::BaseNode] node to which the Subnet belongs
+      # @see https://docs.synapsepay.com/docs/subnets
+      #
+      # @raise [SynapsePayRest::Error] if HTTP error or invalid argument format
+      # 
+      # @return [SynapsePayRest::Subnet]
+      # 
+      def create(node:, nickname:, **options)
+        raise ArgumentError, 'cannot create a transaction with an UnverifiedNode' if node.is_a?(UnverifiedNode)
+        raise ArgumentError, 'node must be a type of BaseNode object' unless node.is_a?(BaseNode)
+        [nickname].each do |arg|
+          if options[arg] && !options[arg].is_a?(String)
+            raise ArgumentError, "#{arg} must be a String"
+          end
+        end
+
+        payload = payload_for_create(node: node, nickname: nickname, **options)
+        response = node.user.client.subnets.create(
+          user_id: node.user.id,
+          node_id: node.id,
+          payload: payload,
+        )
+        from_response(node, response)
+      end
+
+      # Queries the API for a subnet belonging to the supplied node by subnet id
+      # and returns a Subnet n instance if found.
+      # 
+      # @param node [SynapsePayRest::BaseNode] node to which the subnet belongs
+      # @param id [String] id of the subnet to find
+      # 
+      # @raise [SynapsePayRest::Error] if not found or other HTTP error
+      # 
+      # @return [SynapsePayRest::Subnet]
+      def find(node:, id:)
+        raise ArgumentError, 'node must be a type of BaseNode object' unless node.is_a?(BaseNode)
+        raise ArgumentError, 'id must be a String' unless id.is_a?(String)
+
+        response = node.user.client.subnets.get(
+          user_id: node.user.id,
+          node_id: node.id,
+          subnet_id: id
+        )
+        from_response(node, response)
+      end
+
+      # Queries the API for all subnets belonging to the supplied node and returns
+      # them as Subnet instances.
+      # 
+      # @param node [SynapsePayRest::BaseNode] node to which the subnet belongs
+      # @param page [String,Integer] (optional) response will default to 1
+      # @param per_page [String,Integer] (optional) response will default to 20
+      # 
+      # @raise [SynapsePayRest::Error]
+      # 
+      # @return [Array<SynapsePayRest::Subnet>]
+      def all(node:, page: nil, per_page: nil)
+        raise ArgumentError, 'node must be a type of BaseNode object' unless node.is_a?(BaseNode)
+        [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
+
+        response = node.user.client.subnets.get(
+          user_id: node.user.id,
+          node_id: node.id,
+          page: page,
+          per_page: per_page
+        )
+        multiple_from_response(node, response['subnets'])
+      end
+
+      # Creates a Subnet from a response hash.
+      # 
+      # @note Shouldn't need to call this directly.
+      # 
+      def from_response(node, response)
+        args = {
+          node:               node,
+          id:                 response['_id'],
+          account_num:        response['account_num'],
+          allowed:            response['allowed'],
+          client_id:          response['client']['id'],
+          client_name:        response['client']['name'],
+          nickname:           response['nickname'],
+          node_id:            response['node_id'],
+          routing_num_ach:    response['routing_num']['ach'],
+          routing_num_wire:   response['routing_num']['wire'],
+          user_id:            response['user_id']
+        }
+        self.new(args)
+      end
+
+      private
+
+      def payload_for_create(node:, nickname:, **options)
+        payload = {
+          'nickname' => nickname
+        }
+      end
+
+      def multiple_from_response(node, response)
+        return [] if response.empty?
+        response.map { |subnets_data| from_response(node, subnets_data) }
+      end
+    end
+
+    # @note Do not call directly. Use Subnet.create or other class
+    #   method to instantiate via API action.
+    def initialize(**options)
+      options.each { |key, value| instance_variable_set("@#{key}", value) }
+    end
+
+    # Changes Subnet's allowed permission from 'CREDIT' to 'LOCKED'.
+    # 
+    # @param comment [String]
+    # 
+    # @raise [SynapsePayRest::Error]
+    # 
+    # @return [Array<SynapsePayRest::Subnet>] (self)
+    def lock
+      payload = {'allowed' => 'LOCKED'}
+      response = node.user.client.subnets.update(
+        user_id: node.user.id,
+        node_id: node.id,
+        subnet_id: id,
+        payload: payload
+      )
+      if response['subnets']
+        # api v3.1
+        self.class.from_response(node, response['subnets'])
+      else
+        # api v3.1.1
+        self.class.from_response(node, response)
+      end
+    end
+
+    # Checks if two Subnet instances have same id (different instances of same record).
+    def ==(other)
+      other.instance_of?(self.class) && !id.nil? && id == other.id
+    end
+  end
+end

data/lib/synapse_pay_rest/models/subscription/subscription.rb

@@ -74,11 +74,11 @@ module SynapsePayRest
       # @raise [SynapsePayRest::Error] if HTTP error or invalid argument format
       # 
       # @return [SynapsePayRest::Subscription] new instance corresponding to same API record
-      def update(client:, is_active:, url:, scope:, **options)
+      def update(client:, id:, **options)
         raise ArgumentError, 'client must be a SynapsePayRest::Client' unless client.is_a?(Client)
         
-        payload = payload_for_update(is_active: is_active, url: url, scope: scope, **options)
-        response = client.subscriptions.update(payload: payload)
+        payload = payload_for_update(options)
+        response = client.subscriptions.update(subscription_id: id, payload: payload)
         from_response(response)
       end
 

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

@@ -3,5 +3,41 @@ module SynapsePayRest
   #
   # @see https://docs.synapsepay.com/docs/user-resources#section-social-document-types
   #   social document types
-  class SocialDocument < Document; end
+  class SocialDocument < Document
+
+    # Verifies the pin sent via the user's social doc either EMAIL_2FA or PHONE_NUMBER_2FA
+    # status is SUBMITTED|MFA_PENDING before verified
+    # 
+    # @param mfa_answer [String]
+    # @param value [String]
+    # 
+    # @raise [SynapsePayRest::Error] if wrong guess or HTTP error
+    # 
+    # @return [SynapsePayRest::SocialDocument]
+    def verify_2fa(mfa_answer:, value:)
+      user = base_document.user
+      payload = verify_social_doc_2fa_payload(mfa_answer: mfa_answer, type: type, value: value)
+      response = user.client.users.update(user_id: user.id, payload: payload)
+      user = User.from_response(user.client, response)
+      social_doc = base_document.social_documents.find { |doc| doc.type == type }
+    end
+
+    private
+
+    # Converts the data to hash format for request JSON.
+    def verify_social_doc_2fa_payload(mfa_answer:, type:, value:)
+      {
+        'documents' => [{
+          'id' => base_document.id,
+          'social_docs' => [{
+            'id' => id,
+            'document_value' => value,
+            'document_type' => type,
+            'mfa_answer' => mfa_answer
+          }]
+        }]
+      }
+    end
+
+  end
 end

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

@@ -591,7 +591,7 @@ module SynapsePayRest
     # 
     # @return [SynapsePayRest::SynapseUsNode]
     def create_deposit_us_node(**options)
-      SynapseUsNode.create(user: self, **options)
+      DepositUsNode.create(user: self, **options)
     end
 
     # Creates a SUBACCOUNT-US node.
@@ -664,6 +664,79 @@ module SynapsePayRest
       WireUsNode.create(user: self, **options)
     end
 
+    # Creates a CHECK-US node.
+    # 
+    # @param nickname [String] nickname for the node
+    # @param bank_name [String]
+    # @param account_number [String]
+    # @param routing_number [String]
+    # @param name_on_account [String]
+    # @param address [String]
+    # @param correspondent_routing_number [String] (optional)
+    # @param correspondent_bank_name [String] (optional)
+    # @param correspondent_address [String] (optional)
+    # @param supp_id [String] (optional)
+    # @param gateway_restricted [Boolean] (optional)
+    # 
+    # @raise [SynapsePayRest::Error]
+    # 
+    # @return [SynapsePayRest::CheckUsNode]
+    def create_check_us_node(**options)
+      CheckUsNode.create(user: self, **options)
+    end
+
+    # Creates a CLEARING-US node.
+    # 
+    # @param nickname [String] nickname for the node
+    # @param supp_id [String] (optional)
+    # @param gateway_restricted [Boolean] (optional)
+    # 
+    # @raise [SynapsePayRest::Error]
+    # 
+    # @return [SynapsePayRest::ClearingUsNode]
+    def create_clearing_us_node(**options)
+      ClearingUsNode.create(user: self, **options)
+    end
+
+    # Creates a IB-DEPOSIT-US node.
+    # 
+    # @param nickname [String] nickname for the node
+    # @param supp_id [String] (optional)
+    # @param gateway_restricted [Boolean] (optional)
+    # 
+    # @raise [SynapsePayRest::Error]
+    # 
+    # @return [SynapsePayRest::IbDepositUsNode]
+    def create_ib_deposit_us_node(**options)
+      IbDepositUsNode.create(user: self, **options)
+    end
+
+    # Creates a IB-SUBACCOUNT-US node.
+    # 
+    # @param nickname [String] nickname for the node
+    # @param supp_id [String] (optional)
+    # @param gateway_restricted [Boolean] (optional)
+    # 
+    # @raise [SynapsePayRest::Error]
+    # 
+    # @return [SynapsePayRest::IbSubaccountUsNode]
+    def create_ib_subaccount_us_node(**options)
+      IbSubaccountUsNode.create(user: self, **options)
+    end
+
+    # Creates a INTERCHANGE-US node.
+    # 
+    # @param nickname [String] nickname for the node
+    # @param supp_id [String] (optional)
+    # @param gateway_restricted [Boolean] (optional)
+    # 
+    # @raise [SynapsePayRest::Error]
+    # 
+    # @return [SynapsePayRest::InterchangeUsNode]
+    def create_interchange_us_node(**options)
+      InterchangeUsNode.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.2.9'.freeze
+  VERSION = '3.3.1'.freeze
 end

data/samples.md

@@ -443,6 +443,25 @@ base_doc = base_doc.add_virtual_documents(virtual_doc)
 # => #<SynapsePayRest::BaseDocument>
 ```
 
+#### Add and verify email and phone number 2fa
+
+```ruby
+social_doc = SynapsePayRest::SocialDocument.create(
+  type:  'EMAIL_2FA',
+  value: '1111111111'
+)
+
+# reassign base_doc to the output because it returns a new instance
+base_doc = base_doc.add_social_documents(social_doc)
+# => #<SynapsePayRest::BaseDocument>
+
+# find the social doc with the same doc type
+social_doc_email = base_doc.social_documents.find { |doc| doc.type == 'EMAIL_2FA' }
+
+#verify the mfa_answer sent
+social_doc_email.verify_2fa(mfa_answer: '123456' , value: '1111111111')
+```
+
 ## Node Methods
 
 #### All Nodes for a User
@@ -1074,6 +1093,38 @@ node = node.verify_microdeposits(amount1: 0.1, amount2: 0.1)
 # => #<SynapsePayRest::AchUsNode>
 ```
 
+#### Create CHECK-US Node
+
+```ruby
+check_info = {
+  type:                   'CHECK-US',
+  nickname:               'test check-us',
+  payee_name:             'Test McTest',
+  address_street:         '1 Market St',
+  address_city:           'San Francisco',
+  address_subdivision:    'CA',
+  address_country_code:   'US',
+  address_postal_code:    '94105'
+}
+
+node = user.create_check_us_node(check_info)
+# => #<SynapsePayRest::CheckUsNode>
+```
+
+#### Create INTERCHANGE-US Node
+
+```ruby
+node_info = {
+  nickname:               'my debit card',
+  card_number:            [string of encrypted card number],
+  exp_date:               [string of encrypted exp date (YYYYMM)],
+  document_id:            [string of base doc id],
+}
+
+node = user.create_interchange_us_node(node_info)
+# => #<SynapsePayRest::InterchangeUsNode>
+```
+
 #### Deactivate a Node
 
 This deactivates the node. It does not automatically cancel any transactions already underway.
@@ -1164,3 +1215,86 @@ transaction = transaction.add_comment('this is my favorite transaction')
 transaction = transaction.cancel
 # => #<SynapsePayRest::Transaction>
 ```
+
+## Subnet Methods
+
+#### All Subnets from a Node
+
+##### a) Node#subnets
+
+```ruby
+subnets = node.subnets(page: 1, per_page: 15)
+# => [#<SynapsePayRest::Subnet>, #<SynapsePayRest::Subnet>, ...]
+```
+
+##### b) Subnet#all
+
+```ruby
+subnets = SynapsePayRest::Subnet.all(node: node, page: 1, per_page: 15)
+# => [#<SynapsePayRest::Subnet>, #<SynapsePayRest::Subnet>, ...]
+```
+
+#### Find a Node's Subnet by ID
+
+##### a) Node#find_subnet
+
+```ruby
+subnet= node.find_subnet(id: '167e11516')
+# => #<SynapsePayRest::Subnet>
+```
+
+##### b) Subnet#find
+
+```ruby
+subnet = SynapsePayRest::Subnet.find(node: node, id: '57fab7d186c2733525dd7eac')
+# => #<SynapsePayRest::Subnet>
+```
+
+#### Create a Subnet
+
+##### a) Node#create_subnet
+
+```ruby
+subnet_settings = {
+  "nickname":"Test AC/RT"
+}
+
+subnet = node.create_subnet(subnet_settings)
+# => #<SynapsePayRest::Subnet>
+```
+
+##### b) Subnet#create
+
+```ruby
+subnet_settings = {
+  "nickname":"Test AC/RT"
+}
+
+subnet = SynapsePayRest::Subnet.create(subnet_settings)
+# => #<SynapsePayRest::Subnet>
+```
+
+#### To lock a Subnet
+
+```ruby
+subnet = subnet.lock
+# => #<SynapsePayRest::Subnet>
+```
+
+## Issue Public Key Method
+
+#### Issue Public Key From Client
+
+##### a) Client#issue_public_key
+
+```ruby
+public_key = client.issue_public_key(scope: ‘CLIENT|CONTROLS’)
+# => #<SynapsePayRest::Public_key>
+```
+
+##### b) Subnet#all
+
+```ruby
+public_key = SynapsePayRest::PublicKey.issue(client: client, scope: ‘CLIENT|CONTROLS')
+# => #<SynapsePayRest::Public_key>
+```

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synapse_pay_rest
 version: !ruby/object:Gem::Version
-  version: 3.2.9
+  version: 3.3.1
 platform: ruby
 authors:
 - Steven Broderick
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-19 00:00:00.000000000 Z
+date: 2018-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -151,20 +151,28 @@ files:
 - Rakefile
 - bin/console
 - lib/synapse_pay_rest.rb
+- lib/synapse_pay_rest/api/client.rb
 - lib/synapse_pay_rest/api/institutions.rb
 - lib/synapse_pay_rest/api/nodes.rb
+- lib/synapse_pay_rest/api/subnets.rb
 - lib/synapse_pay_rest/api/subscriptions.rb
 - lib/synapse_pay_rest/api/transactions.rb
 - lib/synapse_pay_rest/api/users.rb
 - lib/synapse_pay_rest/client.rb
 - lib/synapse_pay_rest/error.rb
 - lib/synapse_pay_rest/http_client.rb
+- lib/synapse_pay_rest/models/client/issue_public_key.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/check_us_node.rb
+- lib/synapse_pay_rest/models/node/clearing_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
+- lib/synapse_pay_rest/models/node/ib_deposit_us_node.rb
+- lib/synapse_pay_rest/models/node/ib_subaccount_us_node.rb
+- lib/synapse_pay_rest/models/node/interchange_us_node.rb
 - lib/synapse_pay_rest/models/node/iou_node.rb
 - lib/synapse_pay_rest/models/node/node.rb
 - lib/synapse_pay_rest/models/node/reserve_us_node.rb
@@ -176,6 +184,7 @@ files:
 - lib/synapse_pay_rest/models/node/unverified_node.rb
 - lib/synapse_pay_rest/models/node/wire_int_node.rb
 - lib/synapse_pay_rest/models/node/wire_us_node.rb
+- lib/synapse_pay_rest/models/subnet/subnet.rb
 - lib/synapse_pay_rest/models/subscription/subscription.rb
 - lib/synapse_pay_rest/models/transaction/transaction.rb
 - lib/synapse_pay_rest/models/user/base_document.rb
@@ -208,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: SynapsePay v3 Rest Native API Library