synapse_pay_rest 3.2.2 → 3.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0238b5f86667781ee63382a874434f1257061643'
-  data.tar.gz: ee3bedd0c2a1442b65c5c4eecae46ff04e742786
+  metadata.gz: a7b9318467c17d58d84b25ee16da62c521d831a3
+  data.tar.gz: e12ddb18f8d2cbeeea1793aa0c0994b1c7181241
 SHA512:
-  metadata.gz: eac79fe951c026a702fb481975744c26a92f1ca9c808b846e3bc4101159dce69959999dd6cfa76e7920f998c0204fd044907e0647a7a80e260804c05a783f332
-  data.tar.gz: 6b6f88845e3a60e9f76ff268a30bcf4e473ca6b5601b7c9e59253305e75b64f68f3767dafec43d74b87200d368fa510abc3caa0bb613b0ebdc82755b5451f7f6
+  metadata.gz: 29b7c4622218262bfe57afb889746f44a59f3f0a1827918de70832dcad42d7c4e1c5985e992b17241b8127854f5b0d1873854ab4508f75b8fe0e731eb8c891d4
+  data.tar.gz: f16edcbc0d7681811068e9a9ed2f8efcdba30e7d749f718fd53246e7a614042bf66c64288806405dc52a74b203d4ac222564cfb543518f3add979c3e4b6b1839

data/.gitignore

@@ -41,5 +41,5 @@ Gemfile.lock
 
 ## ENV variables and other secrets
 .env
-test.txt
 *.yml
+test.rb

data/lib/synapse_pay_rest/api/subscriptions.rb

@@ -0,0 +1,87 @@
+module SynapsePayRest
+  # Wrapper class for /subscriptions endpoints
+  # 
+  # @todo Implement idempotency keys
+  class Subscriptions
+
+    # 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 POST request to /subscriptions endpoint to create a new subscription.
+    # Returns the response.
+    # 
+    # @param url [String]
+    # @param scope [Array]
+    # @see https://docs.synapsepay.com/docs/create-subscription payload structure
+    # 
+    # @raise [SynapsePayRest::Error] may return subclasses of error based on 
+    # HTTP response from API
+    # 
+    # @return [Hash] API response
+    def create(payload:)
+      path = subscription_path
+      client.post(path, payload)
+    end
+
+    # Sends a GET request to /subscriptions endpoint. Queries a specific subscription_id
+    # if subs_id supplied, else queries all subscriptions. Returns the response.
+    # 
+    # @param subscription_id [String,void] (optional) id of a subscription 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
+    # 
+    # @todo Probably should use CGI or RestClient's param builder instead of
+    # rolling our own, probably error-prone and untested version
+    # https://github.com/rest-client/rest-client#usage-raw-url
+    def get(subscription_id: nil, **options)
+      path = subscription_path(subscription_id: subscription_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 PATCH request to /subscriptions endpoint, updating the current subscription
+    # and returns the response.
+    # 
+    # @param payload [Hash]
+    # @see https://docs.synapsepay.com/docs/update-subscription payload structure for
+    #   updating subscription
+    # 
+    # @raise [SynapsePayRest::Error] may return subclasses of error based on 
+    # HTTP response from API
+    # 
+    # @return [Hash] API response
+    def update(subscription_id:, payload:)
+      path = subscription_path(subscription_id: subscription_id)
+      client.patch(path, payload)
+    end
+    
+    private
+
+    def subscription_path(subscription_id: nil)
+      path = "/subscriptions"
+      path += "/#{subscription_id}" if subscription_id
+      path
+    end
+
+  end
+end

data/lib/synapse_pay_rest/client.rb

@@ -11,7 +11,9 @@ module SynapsePayRest
     #   @return [SynapsePayRest::Nodes]
     # @!attribute [rw] transactions
     #   @return [SynapsePayRest::Transactions]
-    attr_accessor :http_client, :users, :nodes, :transactions
+    # @!attribute [rw] subscriptions
+    #   @return [SynapsePayRest::Subscriptions]
+    attr_accessor :http_client, :users, :nodes, :transactions, :subscriptions
 
     # Alias for #transactions (legacy name)
     alias_method :trans, :transactions
@@ -39,9 +41,10 @@ module SynapsePayRest
                                      fingerprint: fingerprint,
                                      ip_address: ip_address,
                                      **options)
-      @users        = Users.new @http_client
-      @nodes        = Nodes.new @http_client
-      @transactions = Transactions.new @http_client
+      @users         = Users.new @http_client
+      @nodes         = Nodes.new @http_client
+      @transactions  = Transactions.new @http_client
+      @subscriptions = Subscriptions.new @http_client
     end
   end
 end

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

@@ -33,15 +33,14 @@ module SynapsePayRest
         end
       end
 
-      # Creates an ACH-US node via access token, belonging to user supplied.
+      # Creates an Unverified Node Class node via access token, belonging to this user
       # 
       # @param user [SynapsePayRest::User] the user to whom the node belongs 
       # @param access_token [String] user's access token 
       # 
       # @raise [SynapsePayRest::Error]
       # 
-      # @return [Array<SynapsePayRest::AchUsNode>] may contain multiple nodes (checking and/or savings)
-      
+      # @return [<SynapsePayRest::UnverifiedNode>]
       def create_via_bank_login_mfa(user:, access_token:)
         raise ArgumentError, 'user must be a User object' unless user.is_a?(User)
         raise ArgumentError, 'access_token must be a String' unless access_token.is_a?(String)

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

@@ -88,10 +88,12 @@ module SynapsePayRest
           account_class:   response['info']['class'],
           account_number:  response['info']['account_num'],
           routing_number:  response['info']['routing_num'],
-          account_id:      response['info']['account_id'],
           address:         response['info']['address'],
           swift:           response['info']['swift'],
-          ifsc:            response['info']['ifsc']
+          ifsc:            response['info']['ifsc'],
+          user_info:       nil,
+          transactions:    nil,
+          timeline:        nil
         }
 
         if response['info']['correspondent_info']
@@ -121,6 +123,21 @@ module SynapsePayRest
           args[:gateway_restricted] = extra['gateway_restricted']
         end
 
+        if response['extra']['other']['info']
+          user_info = response['extra']['other']['info']
+          args[:user_info] = user_info
+        end
+
+        if response['extra']['other']['transactions']
+          transactions = response['extra']['transactions']
+          args[:transactions] = transactions
+        end
+
+        if response['timeline']
+          timeline = response['timeline']
+          args[:timeline] = timeline
+        end
+
         self.new(**args)
       end
 

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

@@ -30,7 +30,7 @@ module SynapsePayRest
       # @raise [SynapsePayRest::Error] if HTTP error
       # 
       # @return [SynapsePayRest::BaseNode] subclass depends on node type
-      def find(user:, id:, full_dehydrate:)
+      def find(user:, id:, full_dehydrate: 'no')
         raise ArgumentError, 'user must be a User object' unless user.is_a?(User)
         raise ArgumentError, 'id must be a String' unless id.is_a?(String)
 

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

@@ -0,0 +1,138 @@
+module SynapsePayRest
+  # Represents a subscription record and holds methods for creating subscription instances
+  # from API calls. This is built on top of the SynapsePayRest::Subscription class and
+  # 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 Subscription
+    attr_reader :id, :is_active, :scope, :url
+
+    class << self
+      # Creates a new subscription in the API and returns a Subscription instance from the
+      # response data.
+      # 
+      # @param client [SynapsePayRest::Client]
+      # @param scope [Array<String>]
+      # @param url [String]
+      # 
+      # @raise [SynapsePayRest::Error] if HTTP error or invalid argument format
+      # 
+      # @return [SynapsePayRest::Subscription]
+      def create(client:, url:, scope:, **options)
+        raise ArgumentError, 'client must be a SynapsePayRest::Client' unless client.is_a?(Client)
+        raise ArgumentError, 'url must be a String' unless url.is_a? String
+        raise ArgumentError, 'scope must be an Array' unless scope.is_a? Array
+        
+        payload = payload_for_create(url: url, scope: scope, **options)
+        response = client.subscriptions.create(payload: payload)
+        from_response(response)
+      end
+
+      # Queries the API for a subscription by id and returns a Subscription instances if found.
+      # 
+      # @param client [SynapsePayRest::Client]
+      # @param id [String] id of the subscription to find
+      # 
+      # @raise [SynapsePayRest::Error] if user not found or invalid client credentials
+      # 
+      # @return [SynapsePayRest::Subscription]
+      def find(client:, id:)
+        raise ArgumentError, 'client must be a SynapsePayRest::Client' unless client.is_a?(Client)
+        raise ArgumentError, 'id must be a String' unless id.is_a?(String)
+
+        response = client.subscriptions.get(subscription_id: id)
+        from_response(response)
+      end
+
+      # Queries the API for all subscriptions and returns them as Subscription instances.
+      # 
+      # @param client [SynapsePayRest::Client]
+      # @param page [String,Integer] (optional) response will default to 1
+      # @param per_page [String,Integer] (optional) response will default to 20
+      # 
+      # @raise [SynapsePayRest::Error] if HTTP error or invalid argument format
+      # 
+      # @return [Array<SynapsePayRest::Subscription>]
+      def all(client:, page: nil, per_page: 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
+        response = client.subscriptions.get(page: page, per_page: per_page)
+        multiple_from_response(response['subscriptions'])
+      end
+
+      # Updates the given key value pairs.
+      # 
+      # @param is_active [boolean]
+      # @param url [String]
+      # @param scope [Array<String>]
+      #
+      # @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)
+        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)
+        from_response(response)
+      end
+
+      # Creates a Subscription from a response hash.
+      # 
+      # @note Shouldn't need to call this directly.
+      def from_response(response)
+        args = {
+          id:            response['_id'],
+          is_active:     response['is_active'],
+          scope:         response['scope'],
+          url:           response['url']
+        }
+        self.new(args)
+      end
+
+      # Calls from_response on each member of a response collection.
+      def multiple_from_response(response)
+        return [] if response.empty?
+        response.map { |subscription_data| from_response(subscription_data)}
+      end
+
+      private
+
+      # Converts #create args into API payload structure.
+      def payload_for_create(**options)
+        payload = {}
+        # must have one of these
+        payload['url']       = options[:url] if options[:url]
+        payload['scope']     = options[:scope] if options[:scope]
+        payload
+      end
+
+      # Converts #update args into API payload structure.
+      def payload_for_update(**options)
+        payload = {}
+        # must have one of these
+        payload['is_active'] = options[:is_active] if options[:is_active]
+        payload['url']       = options[:url] if options[:url]
+        payload['scope']     = options[:scope] if options[:scope]
+        payload
+      end
+
+    end
+
+    # @note Do not call directly. Use Subscription.create or other class method
+    #   to instantiate via API action.
+    def initialize(**options)
+      options.each { |key, value| instance_variable_set("@#{key}", value) }
+    end
+
+    # Checks if two Subscription 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/user/base_document.rb

@@ -10,10 +10,11 @@ module SynapsePayRest
                   :entity_scope, :birth_day, :birth_month, :birth_year,
                   :address_street, :address_city, :address_subdivision,
                   :address_postal_code, :address_country_code, 
-                  :physical_documents, :social_documents, :virtual_documents
+                  :physical_documents, :social_documents, :virtual_documents, 
+                  :alias, :day, :month, :year, :screening_results
     attr_reader :id, :permission_scope
 
-    class << self
+    class << self 
       # Creates a new base document in the API belonging to the provided user and
       # returns a base document instance from the response data.
       # 
@@ -66,28 +67,27 @@ module SynapsePayRest
           raise ArgumentError, 'virtual_documents be empty or contain VirtualDocument(s)'
         end
 
-        base_document = BaseDocument.new(
-          user: user, 
-          email: email, 
-          phone_number: phone_number,
-          ip: ip, 
-          name: name, 
-          aka: aka, 
-          entity_type: entity_type,
-          entity_scope: entity_scope, 
-          birth_day: birth_day, 
-          birth_month: birth_month, 
-          birth_year: birth_year, 
-          address_street: address_street, 
-          address_city: address_city,
-          address_subdivision: address_subdivision, 
-          address_postal_code:  address_postal_code,
-          address_country_code: address_country_code, 
-          physical_documents: physical_documents,
-          social_documents: social_documents, 
-          virtual_documents: virtual_documents
-        )
-
+        base_document = BaseDocument.new({
+          "user"=>user,
+          "email"=>email,
+          "phone_number"=>phone_number,
+          "ip"=>ip,
+          "name"=>name,
+          "aka"=>aka,
+          "entity_type"=>entity_type,
+          "entity_scope"=>entity_scope,
+          "birth_day"=>birth_day,
+          "birth_month"=>birth_month,
+          "birth_year"=>birth_year,
+          "address_street"=>address_street,
+          "address_city"=>address_city,
+          "address_subdivision"=>address_subdivision,
+          "address_postal_code"=>address_postal_code,
+          "address_country_code"=>address_country_code,
+          "physical_documents"=>physical_documents,
+          "social_documents"=>social_documents,
+          "virtual_documents"=>virtual_documents
+        })
         base_document.submit
       end
 
@@ -113,15 +113,42 @@ module SynapsePayRest
           end
 
           args = {
-            user:               user,
-            id:                 base_document_data['id'],
-            name:               base_document_data['name'],
-            permission_scope:   base_document_data['permission_scope'],
-            physical_documents: physical_docs,
-            social_documents:   social_docs,
-            virtual_documents:  virtual_docs
+            "user"=>user,
+            "id"=>base_document_data['id'],
+            "name"=>base_document_data['name'],
+            "permission_scope"=>base_document_data['permission_scope'],
+            "address_city"=>nil,
+            "address_country_code"=>nil,
+            "address_postal_code"=>nil,
+            "address_street"=>nil,
+            "address_subdivision"=>nil,
+            "alias"=>nil,
+            "day"=>nil,
+            "email"=>nil,
+            "entity_scope"=>nil,
+            "entity_type"=>nil,
+            "ip"=>nil,
+            "month"=>nil,
+            "phone_number"=>nil,
+            "year"=>nil,
+            "screening_results"=>nil,
+            "physical_documents"=>physical_docs,
+            "social_documents"=>social_docs,
+            "virtual_documents"=>virtual_docs
           }
 
+          other_keys = base_document_data.keys
+
+          ["physical_docs", "social_docs", "virtual_docs"].each do |item|
+            other_keys.delete_at(other_keys.index(item))
+          end
+
+          for key in other_keys do
+            if base_document_data.has_key?(key)
+              args[key] = base_document_data[key]
+            end
+          end
+
           base_doc = self.new(args)
           [physical_docs, social_docs, virtual_docs].flatten.each do |doc|
             doc.base_document = base_doc
@@ -133,28 +160,29 @@ module SynapsePayRest
     end
 
     # @note It should not be necessary to call this method directly.
-    def initialize(**args)
-      @id                   = args[:id]
-      @permission_scope     = args[:permission_scope]
-      @user                 = args[:user]
-      @email                = args[:email]
-      @phone_number         = args[:phone_number]
-      @ip                   = args[:ip]
-      @name                 = args[:name]
-      @aka                  = args[:aka]
-      @entity_type          = args[:entity_type]
-      @entity_scope         = args[:entity_scope]
-      @birth_day            = args[:birth_day]
-      @birth_month          = args[:birth_month]
-      @birth_year           = args[:birth_year]
-      @address_street       = args[:address_street]
-      @address_city         = args[:address_city]
-      @address_subdivision  = args[:address_subdivision]
-      @address_postal_code  = args[:address_postal_code]
-      @address_country_code = args[:address_country_code]
-      @physical_documents   = args[:physical_documents]
-      @social_documents     = args[:social_documents]
-      @virtual_documents    = args[:virtual_documents]
+    def initialize(args)
+      @id                   = args["id"]
+      @permission_scope     = args["permission_scope"]
+      @user                 = args["user"]
+      @email                = args["email"]
+      @phone_number         = args["phone_number"]
+      @ip                   = args["ip"]
+      @name                 = args["name"]
+      @aka                  = args["aka"]
+      @entity_type          = args["entity_type"]
+      @entity_scope         = args["entity_scope"]
+      @birth_day            = args["birth_day"]
+      @birth_month          = args["birth_month"]
+      @birth_year           = args["birth_year"]
+      @address_street       = args["address_street"]
+      @address_city         = args["address_city"]
+      @address_subdivision  = args["address_subdivision"]
+      @address_postal_code  = args["address_postal_code"]
+      @address_country_code = args["address_country_code"]
+      @screening_results    = args["screening_results"]
+      @physical_documents   = args["physical_documents"]
+      @social_documents     = args["social_documents"]
+      @virtual_documents    = args["virtual_documents"]
     end
 
     # Submits the base document to the API.

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

@@ -8,7 +8,7 @@ module SynapsePayRest
     #   @return [SynapsePayRest::BaseDocument] the base document to which the document belongs
     # @!attribute [rw] status
     #   @return [String] https://docs.synapsepay.com/docs/user-resources#section-document-status
-    attr_accessor :base_document, :status, :id, :type, :value, :last_updated
+    attr_accessor :base_document, :status, :id, :type, :value, :last_updated, :document_value, :meta
 
     class << self
       # Creates a document instance but does not submit it to the API. Use
@@ -35,12 +35,23 @@ module SynapsePayRest
 
       # @note Do not call this method. It is used by child classes only.
       def from_response(data)
-        self.new(
-          type:         data['document_type'],
-          id:           data['id'],
-          status:       data['status'],
-          last_updated: data['last_updated']
+        doc = self.new(
+          type:           data['document_type'],
+          id:             data['id'],
+          status:         data['status'],
+          last_updated:   data['last_updated'],
+          document_value: nil,
+          meta:           nil
         )
+
+        if data.has_key?('document_value')
+          doc.document_value = data['document_value']
+        end
+
+        if data.has_key?('meta')
+          doc.meta = data['meta']
+        end
+        doc
       end
     end
 
@@ -53,6 +64,8 @@ module SynapsePayRest
       # only exist for fetched data
       @status       = options[:status]
       @last_updated = options[:last_updated]
+      @document_value = options[:document_value]
+      @meta = options[:meta]
     end
 
     # Checks if two Document instances have same id (different instances of same record).

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

@@ -13,7 +13,7 @@ module SynapsePayRest
     #   @return [String] https://docs.synapsepay.com/docs/user-resources#section-user-permissions
     attr_reader :client, :id, :logins, :phone_numbers, :legal_names, :note, 
                 :supp_id, :is_business, :cip_tag, :permission
-    attr_accessor :refresh_token, :base_documents
+    attr_accessor :refresh_token, :base_documents, :oauth_key, :expires_in, :flag, :ips
 
     class << self
       # Creates a new user in the API and returns a User instance from the
@@ -69,11 +69,12 @@ module SynapsePayRest
       # @raise [SynapsePayRest::Error] if user not found or invalid client credentials
       # 
       # @return [SynapsePayRest::User]
-      def find(client:, id:, full_dehydrate:)
+      def find(client:, id:, full_dehydrate:'no')
         raise ArgumentError, 'client must be a SynapsePayRest::Client' unless client.is_a?(Client)
         raise ArgumentError, 'id must be a String' unless id.is_a?(String)
 
         response = client.users.get(user_id: id, full_dehydrate: full_dehydrate)
+        
         from_response(client, response)
       end
 
@@ -157,9 +158,21 @@ module SynapsePayRest
           note:              response['extra']['note'],
           supp_id:           response['extra']['supp_id'],
           is_business:       response['extra']['is_business'],
-          cip_tag:           response['extra']['cip_tag']
+          cip_tag:           response['extra']['cip_tag'],
+          flag:              nil,
+          ips:               nil,
+          oauth_key:         nil,
+          expires_in:        nil
         )
 
+        if response.has_key?('flag')
+          user.flag = response['flag']
+        end
+
+        if response.has_key?('ips')
+          user.ips = response['ips']
+        end
+
         unless response['documents'].empty?
           base_documents = BaseDocument.from_response(user, response)
           user.base_documents = base_documents
@@ -186,9 +199,11 @@ module SynapsePayRest
     # 
     # @raise [SynapsePayRest::Error]
     # 
-    # @return [SynapsePayRest::User] (self)
+    # @return [SynapsePayRest::User] (new instance with updated tokens)
     def authenticate
-      client.users.refresh(user_id: id, payload: payload_for_refresh)
+      response        = client.users.refresh(user_id: id, payload: payload_for_refresh)
+      self.oauth_key  = response['oauth_key']
+      self.expires_in = response['expires_in']
       self
     end
 
@@ -303,6 +318,19 @@ module SynapsePayRest
       update(phone_number: phone_number)
     end
 
+    # Add a legal_name to the user.
+    # 
+    # @param legal_name [String]
+    # 
+    # @raise [SynapsePayRest::Error]
+    # 
+    # @return [SynapsePayRest::User] new instance corresponding to same API record
+    def add_legal_name(legal_name)
+      raise ArgumentError, 'legal_name must be a String' unless legal_name.is_a? String
+
+      update(legal_name: legal_name)
+    end
+
     # Removes a phone_number from the user.
     # 
     # @param phone_number [String]
@@ -441,6 +469,18 @@ module SynapsePayRest
       AchUsNode.create_via_bank_login(user: self, **options)
     end
 
+    # Creates an Unverified Node Class node via access token, belonging to this user
+    # 
+    # @param access_token [String] 
+    # @see https://synapsepay.com/api/v3/institutions/show valid bank_name options
+    # 
+    # @raise [SynapsePayRest::Error]
+    # 
+    # @return [<SynapsePayRest::UnverifiedNode>] 
+    def create_ach_us_nodes_via_bank_login_mfa(**options)
+      AchUsNode.create_via_bank_login_mfa(user: self, **options)
+    end
+
     # Creates an EFT-IND node.
     # 
     # @param nickname [String] nickname for the node

data/lib/synapse_pay_rest/version.rb

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

data/lib/synapse_pay_rest.rb

@@ -6,6 +6,7 @@ require 'synapse_pay_rest/http_client'
 require 'synapse_pay_rest/api/users'
 require 'synapse_pay_rest/api/nodes'
 require 'synapse_pay_rest/api/transactions'
+require 'synapse_pay_rest/api/subscriptions'
 
 # general library classes
 require 'synapse_pay_rest/error'
@@ -52,6 +53,9 @@ require 'synapse_pay_rest/models/node/node'
 # transaction-related classes
 require 'synapse_pay_rest/models/transaction/transaction'
 
+# subscription-related classes
+require 'synapse_pay_rest/models/subscription/subscription'
+
 # Namespace for all SynapsePayRest classes and modules
 module SynapsePayRest
   # Modifies the default method to print a warning when deprecated constants

data/samples.md

@@ -44,9 +44,7 @@ args = {
   # (optional) uses API default of 20 unless specified, larger values take longer
   per_page: 50,
   # (optional) filters by name/email match
-  query:    nil,
-  # (optional) returns all KYC on user
-  full_dehydrate: yes
+  query:    nil
 }
 
 users = SynapsePayRest::User.all(args)
@@ -56,8 +54,11 @@ users = SynapsePayRest::User.all(args)
 #### Find a User by User ID
 
 ```ruby
-user = SynapsePayRest::User.find(client: client, id: '57e97ab786c2737f4ccd4dc1', full_dehydrate: 'no')
+user = SynapsePayRest::User.find(client: client, id: '57e97ab786c2737f4ccd4dc1')
 # => #<SynapsePayRest::User>
+
+# full_dehydrate: 'yes' optional, see docs for response example (https://docs.synapsepay.com/docs/get-user)
+user = SynapsePayRest::User.find(client: client, id: '57e97ab786c2737f4ccd4dc1', full_dehydrate: 'yes')
 ```
 
 #### Search for a User by Name/Email
@@ -311,9 +312,12 @@ node = user.find_node(id: '1a3efa1231as2f')
 ##### b) Node#find
 
 ```ruby
-# full_dehydrate: 'yes' (optional) returns all trans data on node
-node = SynapsePayRest::Node.find(user: user, id: '1a3efa1231as2f', full_dehydrate: 'no')
+node = SynapsePayRest::Node.find(user: user, id: '1a3efa1231as2f')
 # => #<SynapsePayRest::EftNpNode>
+
+# full_dehydrate: 'yes' (optional) returns all trans data on node
+node = SynapsePayRest::Node.find(user: user, id: '1a3efa1231as2f', full_dehydrate: 'yes')
+
 ```
 
 #### Create ACH-US Node(s) via Bank Login

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synapse_pay_rest
 version: !ruby/object:Gem::Version
-  version: 3.2.2
+  version: 3.2.3
 platform: ruby
 authors:
 - Steven Broderick
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-24 00:00:00.000000000 Z
+date: 2017-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -152,6 +152,7 @@ files:
 - bin/console
 - lib/synapse_pay_rest.rb
 - lib/synapse_pay_rest/api/nodes.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
@@ -171,6 +172,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/subscription/subscription.rb
 - lib/synapse_pay_rest/models/transaction/transaction.rb
 - lib/synapse_pay_rest/models/user/base_document.rb
 - lib/synapse_pay_rest/models/user/document.rb