sydecar 0.1.6

data/lib/sydecar/expense.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Sydecar
+  class Expense
+    URL = '/v1/expenses'
+    CREATE_URL = "#{URL}/create"
+
+    class << self
+      def create(body:)
+        Connection.instance.post(CREATE_URL, body)
+      end
+
+      # @param [UUID] id
+      def find(id:)
+        Connection.instance.get("#{URL}/#{id}", { reveal_pii: true })
+      end
+
+      # @param [UUID] id
+      # @param [Hash] body
+      def update(id:, body:)
+        Connection.instance.patch("#{URL}/#{id}", body)
+      end
+
+      # @param [Hash] params argument expects to have the following keys
+      # [String] sort: asc / desc
+      # [Integer] limit
+      # [Integer] offset
+      # [String] start_date (format: yyyy-mm-dd)
+      # [String] end_date (format: yyyy-mm-dd)
+      # @param [Hash] body: expects to have "ids" key
+      def find_all(params: {}, body: {})
+        query = '?'
+        query += URI.encode_www_form(params)
+        Connection.instance.post("#{URL}#{query}", body)
+      end
+
+      # @param [UUID] id
+      def delete(id:)
+        Connection.instance.delete("#{URL}/#{id}")
+      end
+
+      def pay_url(id:)
+        "/v1/expenses/#{id}/pay"
+      end
+
+      def pay(id:)
+        url = pay_url(id: id)
+        Connection.instance.post(url)
+      end
+
+      def cancel_url(id:)
+        "/v1/expenses/#{id}/cancel"
+      end
+
+      def cancel(id:)
+        url = cancel_url(id: id)
+        Connection.instance.post(url)
+      end
+    end
+  end
+end

data/lib/sydecar/file_connection.rb

@@ -0,0 +1,26 @@
+module Sydecar
+  class FileConnection < BaseConnection
+    class << self
+      def headers
+        common_headers.merge(
+          'Content-Type' => 'multipart/form-data',
+          'Accept' => '*/*'
+        )
+      end
+
+      def instance
+        super
+        return @@instance if @@instance
+
+        @@instance = create_instance(headers, base_url, env, format_of_request: :multipart)
+      end
+    end
+
+    private
+
+    @@instance = nil
+
+    def initialize
+    end
+  end
+end

data/lib/sydecar/person.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Sydecar
+  class Person
+    URL = '/v1/persons'
+    CREATE_URL = "#{URL}/create"
+    class << self
+      # @param [Hash] body
+      def create(body:, idempotency_key:)
+        Connection.instance.post(CREATE_URL, body, { 'idempotency-key': idempotency_key })
+      end
+
+      # @param [UUID] id
+      def find(id:)
+        Connection.instance.get("#{URL}/#{id}", { reveal_pii: true })
+      end
+
+      # @param [UUID] id
+      # @param [Hash] body
+      def update(id:, body:)
+        Connection.instance.patch("#{URL}/#{id}", body)
+      end
+
+      # @param [Hash] params argument expects to have the following keys:
+      # [String] sort: asc / desc
+      # [Integer] limit
+      # [Integer] offset
+      # [String] start_date (format: yyyy-mm-dd)
+      # [String] end_date (format: yyyy-mm-dd)
+      # @param [Hash] body: expects to have "ids" key
+      def find_all(params: {}, body: {})
+        query = '?'
+        query += URI.encode_www_form(params)
+        Connection.instance.post("#{URL}#{query}", body)
+      end
+
+      # @param [UUID] id
+      def kyc(id:)
+        Connection.instance.post("#{URL}/#{id}/kyc")
+      end
+
+      # TODO: implement "Upload documents for KYC" endpoint
+    end
+  end
+end

data/lib/sydecar/plaid.rb

@@ -0,0 +1,164 @@
+module Sydecar
+  class Plaid
+    CREATE_LINK_TOKEN_URL = 'v1/plaid/create_link_token'
+    PLAID_INSTITUTIONS_URL = 'v1/plaid/plaid_institutions'
+    CREATE_PLAID_BANK_ACCOUNT_URL = 'v1/plaid/create_plaid_bank_account'
+    class << self
+      def reset_plaid_login_url(bank_account_id:)
+        "v1/plaid/#{bank_account_id}/reset_plaid_login"
+      end
+      def create_bank_account_url
+        '/v1/plaid/link_plaid_bank_account'
+      end
+
+      # body argument expects to have the following keys:
+      # [String] profile_id: required
+      # [String] public_token: required
+      # [Hash] metadata: PlaidLinkOnSuccessMetadata =>
+      # {
+      #   [Hash or nil] institution: required
+      #   [Array of objects (PlaidAccount)] accounts: required
+      #   [String] link_session_id: required
+      # }
+      # See more for details: https://api-docs.sydecar.io/api/#tag/Plaid/operation/setPlaidAccessToken
+      def create_bank_account(body:)
+        url = create_bank_account_url
+        Connection.instance.post(url, body)
+      end
+
+      # This method creates a bank account using the specified body parameters.
+      # @param [Hash] body
+      #   - The request body [Hash] with the following keys:
+      #   - 'profile_id': [String] (required)
+      #   - 'bank_account_id': [String] (optional)
+      #     See more details: https://api-docs.sydecar.io/api/#tag/Plaid/operation/createPlaidLinkToken
+      #
+      # @return [Hash] - application/json -
+      #   { link_token: [String], expiration: [String], request_id: [String] }
+      #
+      #     RESPONSES: > '201'
+      def create_link_token(body:)
+        Connection.instance.post(CREATE_LINK_TOKEN_URL, body)
+      end
+
+      # This method Fetch a list of all available Plaid institutions.
+      # @param [Hash] body
+      #   QUERY PARAMETERS:
+      #   - 'limit': [Number] (<= 500) (optional)
+      #   - 'offset': [Number] (optional)
+      #     See more details: https://api-docs.sydecar.io/api/#tag/Plaid/operation/setPlaidAccessToken
+      # @example
+      # Responses sample:
+      #   {
+      #   "data": [
+      #     {
+      #       "institution_id": "string",
+      #       "name": "string",
+      #       "products": [
+      #         "assets"
+      #       ],
+      #       "country_codes": [
+      #         "US"
+      #       ],
+      #       "url": "string",
+      #       "primary_color": "string",
+      #       "logo": "string",
+      #       "routing_numbers": [
+      #         "string"
+      #       ],
+      #       "oauth": true,
+      #       "status": {},
+      #       "payment_initiation_metadata": {},
+      #       "auth_metadata": {}
+      #     }
+      #   ],
+      #   "pagination": {
+      #     "limit": 0,
+      #     "offset": 0,
+      #     "total": 0
+      #   }
+      # }
+      # @return See example data [Hash] Responses : > '200'
+      def fetch_plaid_institutions(query: {})
+        Connection.instance.get(PLAID_INSTITUTIONS_URL, query)
+      end
+
+      # Create a Plaid account without using Plaid link (Sandbox only)
+      # @param [Hash] body
+      #   - "institution_id": "string", (required)
+      #   - "profile_id": "string"      (required)
+      #     This method create a Plaid account without using Plaid link (Sandbox only). This route is meant to quickly setup a plaid account for testing.
+      #     See https://api-docs.sydecar.io/api/#tag/Plaid/operation/createPlaidPublicToken
+      # @Example
+      # Response sample (application/json) :
+      #   {
+      #   "id": "string",
+      #   "created_at": "2019-08-24T14:15:22Z",
+      #   "updated_at": "2019-08-24T14:15:22Z",
+      #   "bank_name": "string",
+      #   "account_name": "string",
+      #   "type": "STANDARD",
+      #   "account_type": "CHECKING",
+      #   "is_us_based": true,
+      #   "account_number": "string",
+      #   "routing_number": "string",
+      #   "street_1": "123 Maple Street",
+      #   "street_2": "Unit 2",
+      #   "city": "Maple Town",
+      #   "state": "CA",
+      #   "zip_code": "94033",
+      #   "country_code": "US",
+      #   "for_further_credit": "string",
+      #   "profile_ids": [
+      #     "string"
+      #   ],
+      #   "plaid_consent_expiration_time": "2022-10-12T07:30:50.52Z",
+      #   "plaid_account_number_mask": "1111",
+      #   "plaid_institution_id": "string"
+      # }
+      #
+      # @return See example data [Hash] Responses : > '201'
+      def create_plaid_account(body:)
+        Connection.instance.post(CREATE_PLAID_BANK_ACCOUNT_URL, body)
+      end
+
+      # This method reset a Plaid account's login (Sandbox only)
+      # @param
+      #   - 'bank_account_id': [String] (required)
+      #     Resets the Plaid account's login information forcing the user to reauthenticate. As part of the reset, the 'plaid_consent_expiration_time' attribute is set to yesterday's date. When plaid link is called in update mode the 'plaid_consent_expiration_time' gets set back to the item's value. This route is only available in sandbox.
+      #     See https://api-docs.sydecar.io/api/#tag/Plaid/operation/resetPlaidLogin
+      # @Example
+      # Response sample (application/json) :
+      #   {
+      #   "id": "string",
+      #   "created_at": "2019-08-24T14:15:22Z",
+      #   "updated_at": "2019-08-24T14:15:22Z",
+      #   "bank_name": "string",
+      #   "account_name": "string",
+      #   "type": "STANDARD",
+      #   "account_type": "CHECKING",
+      #   "is_us_based": true,
+      #   "account_number": "string",
+      #   "routing_number": "string",
+      #   "street_1": "123 Maple Street",
+      #   "street_2": "Unit 2",
+      #   "city": "Maple Town",
+      #   "state": "CA",
+      #   "zip_code": "94033",
+      #   "country_code": "US",
+      #   "for_further_credit": "string",
+      #   "profile_ids": [
+      #     "string"
+      #   ],
+      #   "plaid_consent_expiration_time": "2022-10-12T07:30:50.52Z",
+      #   "plaid_account_number_mask": "1111",
+      #   "plaid_institution_id": "string"
+      # }
+      #
+      # @return See example data [Hash] Responses : > '200'
+      def reset_plaid_login(bank_account_id:)
+        Connection.instance.post(reset_plaid_login_url(bank_account_id: bank_account_id), body:{})
+      end
+    end
+  end
+end

data/lib/sydecar/profile/entity.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Sydecar
+  class Profile
+    class Entity
+      URL = '/v1/profiles/entity'
+
+      class << self
+        # @param [Hash] body
+        def create(body:)
+          Connection.instance.post(URL, body)
+        end
+
+        def update(id:, body:)
+          Connection.instance.patch(update_url(id: id), body)
+        end
+
+        def update_url(id:)
+          "/v1/profiles/#{id}/entity"
+        end
+      end
+    end
+  end
+end

data/lib/sydecar/profile/individual.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Sydecar
+  class Profile
+    class Individual
+      URL = '/v1/profiles/individual'
+
+      class << self
+        # @param [Hash] body
+        def create(body:)
+          Connection.instance.post(URL, body)
+        end
+      end
+    end
+  end
+end

data/lib/sydecar/profile.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Sydecar
+  class Profile
+    URL = '/v1/profiles'
+    ACCREDITATION_QUALIFICATION_URL = "#{URL}/accreditation_qualification_options"
+    class << self
+      def find(id:)
+        url = "#{URL}/#{id}"
+        Connection.instance.get(url, { reveal_pii: true, include: 'subscriptions,spvs' })
+      end
+
+      # @param [UUID] id. Warning: this must be PROFILE_ID. Not SPV ID
+      def activate_spv_url(id:)
+        "/v1/profiles/#{id}/activate"
+      end
+
+      # TODO: check with Sydecar why this is called "activate SPV" whereas a PROFILE_ID is passed
+      # @param [UUID] id. Warning: this must be PROFILE_ID. Not SPV ID
+      def activate_spv(id:)
+        Connection.instance.post(activate_spv_url(id: id))
+      end
+
+      # @param [UUID] id. Warning: this must be PROFILE_ID. Not SPV ID
+      def deactivate_spv_url(id:)
+        "/v1/profiles/#{id}/deactivate"
+      end
+
+      # TODO: check with Sydecar why this is called "deactivate SPV" whereas a PROFILE_ID is passed
+      # @param [UUID] id. Warning: this must be PROFILE_ID. Not SPV ID
+      def deactivate_spv(id:)
+        Connection.instance.post(deactivate_spv_url(id: id))
+      end
+
+      # @param [Hash] params argument expects to have the following keys
+      # [String] sort: asc / desc
+      # [Integer] limit
+      # [Integer] offset
+      # [String] start_date (format: yyyy-mm-dd)
+      # [String] end_date (format: yyyy-mm-dd)
+      # @param [Hash] body: expects to have "ids" key
+      def find_all(params: {}, body: {})
+        query = '?'
+        query += URI.encode_www_form(params)
+        Connection.instance.post("#{URL}#{query}", body)
+      end
+
+      # @param [String] sub_type. Enum: "ENTITY", "PERSON"
+      # @param [String] entity_type. Enum: "SOLE_PROPRIETOR"
+      # "SINGLE_MEMBER_LLC"
+      # "LLC"
+      # "PARTNERSHIP"
+      # "C_CORPORATION"
+      # "S_CORPORATION"
+      # "TRUST"
+      # "IRA_OR_TAX_EXEMPT"
+      # "NON_US_CORPORATION"
+      # "PRIVATE_LIMITED_COMPANY"
+      # "PUBLIC_LIMITED_COMPANY"
+      # "TAX_EXEMPT_ENTITY"
+      # "FOREIGN_TRUST"
+      # "OTHER"
+      def accreditation_qualification_opts(sub_type: , entity_type:)
+        body = { sub_type: sub_type, entity_type: entity_type }
+        Connection.instance.post(ACCREDITATION_QUALIFICATION_URL, body)
+      end
+    end
+  end
+end

data/lib/sydecar/spv.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module Sydecar
+  class Spv
+    URL = '/v1/spvs'
+    CREATE_URL = "#{URL}/create"
+    class << self
+      # @param [Hash] body
+      def create(body:, idempotency_key:)
+        Connection.instance.post(CREATE_URL, body, { 'idempotency-key': idempotency_key })
+      end
+
+      # @param [UUID] id
+      # @param [Boolean] bank_accounts
+      # @param [Boolean] capital_call_events
+      # @param [Boolean] dates
+      # @param [Boolean] docset
+      # @param [Boolean] documents
+      # @param [Boolean] expenses
+      # @param [Boolean] profile
+      # @param [Boolean] subscriptions
+      def find(
+        id:,
+        bank_accounts: false,
+        capital_call_events: false,
+        dates: false,
+        docset: false,
+        documents: false,
+        expenses: false,
+        profile: false,
+        subscriptions: false
+      )
+        query = compile_find_params(
+          bank_accounts: bank_accounts,
+          capital_call_events: capital_call_events,
+          dates: dates,
+          docset: docset,
+          documents: documents,
+          expenses: expenses,
+          profile: profile,
+          subscriptions: subscriptions
+        )
+
+        Connection.instance.get("#{URL}/#{id}", query)
+      end
+
+      # @param [UUID] id
+      # @param [Hash] body
+      def update(id:, body:)
+        Connection.instance.patch("#{URL}/#{id}", body)
+      end
+
+      # @param [Hash] params argument expects to have the following keys
+      # [String] sort: asc / desc
+      # [Integer] limit
+      # [Integer] offset
+      # [String] start_date (format: yyyy-mm-dd)
+      # [String] end_date (format: yyyy-mm-dd)
+      # @param [Hash] body: expects to have "ids" key
+      def find_all(params: {}, body: {})
+        query = '?'
+        query += URI.encode_www_form(params)
+        Connection.instance.post("#{URL}#{query}", body)
+      end
+
+      # @param [UUID] id
+      def initiate_close_url(id:)
+        "/v1/spvs/#{id}/close/initiate"
+      end
+
+      # @param [UUID] id
+      # @param [UUID] idempotency_key
+      def initiate_close(id:, idempotency_key:)
+        url = initiate_close_url(id: id)
+        Connection.instance.post(url, nil, { 'idempotency-key': idempotency_key })
+      end
+
+      def disburse_close_url(id:)
+        "/v1/spvs/#{id}/close/disburse"
+      end
+
+      def disburse_close(id:, idempotency_key:)
+        url = disburse_close_url(id: id)
+        Connection.instance.post(url, nil, { 'idempotency-key': idempotency_key })
+      end
+
+      def counter_sign_close_url(id:)
+        "/v1/spvs/#{id}/close/counter_sign"
+      end
+
+      def counter_sign_close(id:, idempotency_key:)
+        url = counter_sign_close_url(id: id)
+        Connection.instance.post(url, nil, { 'idempotency-key': idempotency_key })
+      end
+
+      def request_approval_url(id:)
+        "/v1/spvs/#{id}/request_approval"
+      end
+
+      def request_approval(id:, body:)
+        url = request_approval_url(id: id)
+        Connection.instance.post(url, body)
+      end
+
+      def request_bank_account_url(id:)
+        "/v1/spvs/#{:id}/request_bank_account"
+      end
+
+      def request_bank_account(id:, idempotency_key:)
+        url = request_bank_account_url(id: id)
+        Connection.instance.post(url, nil, { 'idempotency-key': idempotency_key })
+      end
+
+      def disbursements_url(id:)
+        "/v1/spvs/#{id}/disbursements"
+      end
+
+      def disbursements(id:)
+        url = disbursements_url(id: id)
+        Connection.instance.get(url)
+      end
+
+      def adjust_disbursements_url(id:)
+        "/v1/spvs/#{id}/adjust_disbursements"
+      end
+
+      def adjust_disbursements(id:, body:)
+        url = adjust_disbursements_url(id: id)
+        Connection.instance.post(url, body)
+      end
+
+      def adjust_fund_deal_investments_url(id:)
+        "/v1/spvs/#{id}/adjust_fund_deal_investments"
+      end
+
+      def adjust_fund_deal_investments(id:)
+        url = adjust_fund_deal_investments_url(id: id)
+        Connection.instance.post(url)
+      end
+
+      private
+      def compile_find_params(
+        bank_accounts: false,
+        capital_call_events: false,
+        dates: false,
+        docset: false,
+        documents: false,
+        expenses: false,
+        profile: false,
+        subscriptions: false
+      )
+        include_queries = []
+        include_queries << 'bank_accounts' if bank_accounts
+        include_queries << 'capital_call_events' if capital_call_events
+        include_queries << 'dates' if dates
+        include_queries << 'docset' if docset
+        include_queries << 'documents' if documents
+        include_queries << 'expenses' if expenses
+        include_queries << 'profile' if profile
+        include_queries << 'subscriptions' if subscriptions
+
+        return {} if include_queries.size.zero?
+
+        { include: include_queries.join(',') }
+      end
+    end
+  end
+end