sydecar 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f7ca50a53331e4ebe73abe784b0282097ad56ab1cf9d087bda31919e6670790
+  data.tar.gz: edeabcf4a7687a5bb3b46d030ff54ee8e880e3a40baed30b141124125a4446a8
+SHA512:
+  metadata.gz: 3ebacf1d4a5f69410fae37d013077ef4097d36805fee933266a2070e7e83733bed0922b61b8fd45c2b30fee02b48e94ac6690cb94e131ba4a9f28e1d5eb672a3
+  data.tar.gz: 93faa23340da67d1c6af908a166e0a2fc3786231bae43e08747b19365da8518741eb853f44d07f2ff34e13f52f536e3a6be258b4d19b3bc63c712622fd283904

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+sydecar

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-05-16
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sydecar.gemspec
+gemspec
+gem "rake", "~> 13.0"
+
+group :development do
+end

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    sydecar (0.1.6)
+      faraday (~> 2.7)
+      faraday-multipart (~> 1.0)
+      json (~> 2.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
+    awesome_print (1.9.2)
+    byebug (11.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (3.0.2)
+    hashdiff (1.0.1)
+    json (2.6.3)
+    multipart-post (2.3.0)
+    public_suffix (5.0.1)
+    rake (13.0.6)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    ruby2_keywords (0.0.5)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  awesome_print (~> 1.9)
+  byebug (~> 11.1)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  sydecar!
+  webmock (~> 3.18)
+
+BUNDLED WITH
+   2.4.13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 1lyan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,99 @@
+# Sydecar
+
+This is a ruby gem for Sydecar API https://api-docs.sydecar.io/
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add sydecar
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install sydecar
+
+### Supported endpoints:
+1. Person: create, find, update, find_all, kyc
+2. Entity: create, find, update, find_all
+3. Profile: find, activate_spv, deactivate_spv, find_all, accreditation_qualification_opts
+4. Bank Account: create, find, update, find_all, delete
+5. Vendor: create, find, update, find_all
+6. Expense: create, find, update, find_all, delete, pay, cancel
+7. SPV: create, find, update, find_all, initiate_close, disburse_close, counter_sign_close, request_approval, request_bank_account, disbursements, adjust_disbursements, adjust_fund_deal_investments
+8. Subscription: create, funding_countries_list, find, update, delete, create_agreement_preview, create_virtual_bank_account, set_balance, sign, amend, send_ach_with_plaid, refund_ach_with_plaid, refund, find_all
+9. Document: find, delete, preview, sign, required_fields, sign_arbitrary, find_all, download, upload
+
+### Example usage:
+1. Create a Person: 
+```
+body = {...} # put your data here
+person = Sydecar::Person.create(body: body, idempotency_key: 'unique')
+```
+2. Create an Entity: 
+```
+entity_body = {...} # put your data here
+entity = Sydecar::Entity.create(body: entity_body)
+```
+3. Create an Entity Profile:
+```
+entity_profile_body = {...} # put your data here
+entity_profile_body['person_id'] = person.body['id'] 
+profile = Sydecar::Profile::Entity.create(body: entity_profile_body)
+```
+4. Create Bank Account:
+```
+bank_account_body['profile_ids'] = [profile.body['id']]
+bank = Sydecar::BankAccount.create(body: bank_account_body, idempotency_key: 'unique')
+```
+5. Create SPV:
+```
+spv_body = {...}
+spv_body['spv_lead_profile_id'] = profile.body['id']
+spv = Sydecar::Spv.create(body: spv_body, idempotency_key: 'unique')
+```
+6. Create a Vendor:
+```
+vendor_body = {...}
+vendor = Sydecar::Vendor(body: vendor_body)
+```
+7. Create Expense:
+```
+expense_body = {...}
+expense_body['spv_id'] = spv.body['id']
+expense_body['vendor_id'] = vendor.body['id']
+expense = Sydecar::Expense.create(body: expense_body)
+```
+8. Create a Subscription:
+```
+sub_body = {...}
+sub_body['spv_id'] = spv.body['id']
+sub_body['subscriptions'][0]['profile_id'] = profile.body['id']
+subscription = Sydecar::Subscription.create(body: sub_body, idempotency_key: 'unique')
+```
+9. Upload a Document:
+```
+doc_boby = {
+  type: 'DRAFT_INVESTMENT',
+  name: 'file_name', # Faraday expects here just name without extension
+  profile_id: profile.body['id'], # it's possible to set only 1 id from the following list
+  spv_id: spv.body['id'],
+  subscription_id: subscription.body['id'],
+  expense_id: expense.body['id']
+}
+
+doc = Sydecar::Document.upload(body: doc_body, idempotency_key: 'unique')
+```
+
+## Development
+
+After checking out the repo, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Play-Money/sydecar.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/sydecar/bank_account.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sydecar
+  class BankAccount
+    URL = '/v1/bank_accounts'
+    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, include: 'spvs' })
+      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
+    end
+  end
+end

data/lib/sydecar/base_connection.rb

@@ -0,0 +1,36 @@
+module Sydecar
+  class BaseConnection
+    class << self
+      attr_accessor :token, :base_url, :env
+
+      def common_headers
+        {
+          'Authorization' => "Bearer #{token}",
+          'User-Agent' => 'Faraday',
+          'Connection' => 'keep-alive',
+          'Accept' => 'application/json',
+        }
+      end
+
+      def instance
+        unless token
+          raise TokenNotSetError
+        end
+
+        unless base_url
+          raise BaseUrlNotSetError
+        end
+      end
+
+      protected
+
+      def create_instance(headers, base_url, env, format_of_request: :json)
+        Faraday.new(url: base_url, headers: headers) do |f|
+          f.request format_of_request
+          f.response :json
+          f.response :logger if %w[development].include?(env)
+        end
+      end
+    end
+  end
+end

data/lib/sydecar/capital_call.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+module Sydecar
+  class CapitalCall
+
+    CAPITAL_CALL_EVENTS_URL = 'v1/capital_call_events'
+    class << self
+      # Fetch all capital call events for an SPV
+      # @param
+      #   Query parameters [Hash]
+      #   - 'sort' [String] (Enum: 'asc', 'desc')
+      #   - 'limit' [Number] (<=100)
+      #   - 'offset' [Number]
+      #   - 'start_date' [String]
+      #   - 'end_date' [String]
+      #   - 'include' [String] (Value: 'capital_calls')
+      #   REQUEST BODY SCHEMA: application/json
+      #   - 'ids' [Array of string]
+      # @example
+      # RESPONSE DATA (Sample):
+      #   {
+      #   "data": [
+      #     {
+      #       "id": "string",
+      #       "created_at": "2019-08-24T14:15:22Z",
+      #       "updated_at": "2019-08-24T14:15:22Z",
+      #       "spv_id": "string",
+      #       "memo": "string",
+      #       "percentage": 0,
+      #       "capital_calls": [
+      #         {
+      #           "id": "string",
+      #           "created_at": "2019-08-24T14:15:22Z",
+      #           "updated_at": "2019-08-24T14:15:22Z",
+      #           "amount": 0,
+      #           "amount_funded": 0,
+      #           "due_date": "2019-08-24T14:15:22Z",
+      #           "stage": "CREATED",
+      #           "subscription_id": "string",
+      #           "capital_call_event_id": "string"
+      #         }
+      #       ]
+      #     }
+      #   ],
+      #   "pagination": {
+      #     "limit": 0,
+      #     "offset": 0,
+      #     "total": 0
+      #   }
+      # }
+      # @return See example RESPONSES: > '200'
+      #
+      # See on the https://api-docs.sydecar.io/api/#tag/Capital-Call-Management/operation/getAllCapitalCallEvents
+       def fetch_capital_calls_for_spv(params: {}, body: {})
+     	  query = '?'
+     	  query += URI.encode_www_form(params)
+     	  Connection.instance.post("#{CAPITAL_CALL_EVENTS_URL}#{query}", body)
+       end
+      # This method create an SPV capital call event
+      # @param
+      #   HEADER PARAMETERS:
+      #   - idempotency-key [String]
+      #   REQUEST BODY SCHEMA: application/json
+      #   - {
+      #   "capital_call_events": [ (required)
+      #     {
+      #       "percentage": 100,   (required 0..100)
+      #       "memo": "string"
+      #     }
+      #   ],
+      #   "spv_id": "string"       (required)
+      # }
+      #     - Create one or more capital call events. A valid SPV id is needed.
+      # @example
+      #   RESPONSE SAMPLE
+      #   {
+      #   "data": [
+      #     {
+      #       "id": "string",
+      #       "created_at": "2019-08-24T14:15:22Z",
+      #       "updated_at": "2019-08-24T14:15:22Z",
+      #       "spv_id": "string",
+      #       "memo": "string",
+      #       "percentage": 0,
+      #       "capital_calls": [
+      #         {
+      #           "id": "string",
+      #           "created_at": "2019-08-24T14:15:22Z",
+      #           "updated_at": "2019-08-24T14:15:22Z",
+      #           "amount": 0,
+      #           "amount_funded": 0,
+      #           "due_date": "2019-08-24T14:15:22Z",
+      #           "stage": "CREATED",
+      #           "subscription_id": "string",
+      #           "capital_call_event_id": "string"
+      #         }
+      #       ]
+      #     }
+      #   ]
+      # }
+      # More detail see on the
+      # https://api-docs.sydecar.io/api/#tag/Capital-Call-Management/operation/createOneOrMoreCapitalCallEvents
+      # @return [Hash] Responses: > '201'
+      def create_spv_capital_call(body:, idempotency_key:)
+    	  Connection.instance.post("#{CAPITAL_CALL_EVENTS_URL}/create", body, { 'idempotency-key': idempotency_key })
+      end
+      # Fetch an SPV capital call event by id
+      # @param
+      #   PATH PARAMETERS
+      #   - 'capital_call_event_id' [String] (required)
+      #   QUERY PARAMETERS
+      #   - 'include' [String] (Value: "capital_calls")
+      # @EXAMPLE
+      #   Response samples:
+      #   {
+      #   "id": "string",
+      #   "created_at": "2019-08-24T14:15:22Z",
+      #   "updated_at": "2019-08-24T14:15:22Z",
+      #   "spv_id": "string",
+      #   "memo": "string",
+      #   "percentage": 0,
+      #   "capital_calls": [
+      #     {
+      #       "id": "string",
+      #       "created_at": "2019-08-24T14:15:22Z",
+      #       "updated_at": "2019-08-24T14:15:22Z",
+      #       "amount": 0,
+      #       "amount_funded": 0,
+      #       "due_date": "2019-08-24T14:15:22Z",
+      #       "stage": "CREATED",
+      #       "subscription_id": "string",
+      #       "capital_call_event_id": "string"
+      #     }
+      #   ]
+      # }
+      # @return [Hash] see example
+      #   Response: > '200'
+      def fetch_spv_capital_call(capital_call_event_id:, query: {})
+    	  query = "?#{URI.encode_www_form(query)}"
+    	  Connection.instance.get("#{CAPITAL_CALL_EVENTS_URL}/#{capital_call_event_id}#{query}")
+      end
+      # Update an SPV capital call event
+      # @param
+      #   PATH PARAMETERS
+      #   - 'capital_call_event_id' [String] (required)
+      #   REQUEST BODY SCHEMA: application/json
+      #   - 'percentage' [Number] [ 0 .. 100 ]
+      #   - 'memo'       [String]
+      #
+      # Update an SPV capital call event. You can only update a capital call event before subscription captial calls
+      # have been made (e.g. if the capital call event has been created and the spv has no subscriptions created yet).
+      #
+      # @EXAMPLE
+      #   Response samples:
+      #   {
+      #   "id": "string",
+      #   "created_at": "2019-08-24T14:15:22Z",
+      #   "updated_at": "2019-08-24T14:15:22Z",
+      #   "spv_id": "string",
+      #   "memo": "string",
+      #   "percentage": 0
+      #   }
+      # More detail see on the
+      # https://api-docs.sydecar.io/api/#tag/Capital-Call-Management/operation/updateCapitalCallEvent
+      # @return [Hash] see example
+      #   Response: > '200'
+      def update_spv_capital_call(capital_call_event_id:, body: {})
+    	  Connection.instance.patch("#{CAPITAL_CALL_EVENTS_URL}/#{capital_call_event_id}", body)
+      end
+      # Delete an SPV capital call event by id
+      # @param
+      #   PATH PARAMETERS
+      #   - 'capital_call_event_id' [String] (required)
+      #
+      # Delete an SPV capital call event. You can only delete a capital call event before subscription captial calls
+      # have been made (e.g. if the capital call event has been created but no subscriptions have been created for the spv so far).
+      #
+      # @EXAMPLE
+      #   Response samples:
+      #   {
+      #   "id": "string",
+      #   "created_at": "2019-08-24T14:15:22Z",
+      #   "updated_at": "2019-08-24T14:15:22Z",
+      #   "spv_id": "string",
+      #   "memo": "string",
+      #   "percentage": 0
+      # }
+      # More detail see on the
+      # https://api-docs.sydecar.io/api/#tag/Capital-Call-Management/operation/removeCapitalCallEvent
+      # @return [Hash] see example
+      #   Response: > '200'
+      def delete_spv_capital_call(capital_call_event_id:)
+    	  Connection.instance.delete("#{CAPITAL_CALL_EVENTS_URL}/#{capital_call_event_id}")
+      end
+      # Get the capital call needed for a disbursement
+      # @param
+      #   QUERY PARAMETERS
+      #   - 'use_spv_allocation' [boolean] (optional)
+      #   REQUEST BODY SCHEMA: application/json
+      #   - 'spv_id' [String]            (required)
+      #   - 'disbursement' [Number >=0 ] (required)
+      #
+      # Returns the capital call percentage needed for sufficient funds for a given disbursement. Uses reserved
+      # subscription amounts, unless 'use_spv_allocation' is passed as 'true'.
+      #
+      # @EXAMPLE
+      #   Response samples:
+      #   {
+      #   "data": {
+      #     "capital_call_percentage": 0
+      #   }
+      # }
+      # More detail see on the
+      # https://api-docs.sydecar.io/api/#tag/Capital-Call-Management/operation/getCapitalCallNeededForDisbursement
+      # @return [Hash] see example
+      #   Response: > '200'
+      def get_capital_call_for_disbursement(body:, query: {})
+    	  query = "?#{URI.encode_www_form(query)}"
+    	  Connection.instance.post("#{CAPITAL_CALL_EVENTS_URL}/capital_call_needed_for_disbursement#{query}", body)
+      end
+    end
+  end
+end

data/lib/sydecar/connection.rb

@@ -0,0 +1,23 @@
+module Sydecar
+  class Connection < BaseConnection
+    class << self
+      def headers
+        common_headers.merge('Content-Type' => 'application/json')
+      end
+
+      def instance
+        super
+        return @@instance if @@instance
+
+        @@instance = create_instance(headers, base_url, env, format_of_request: :json)
+      end
+    end
+
+    private
+
+    @@instance = nil
+
+    def initialize
+    end
+  end
+end

data/lib/sydecar/constants.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+module Sydecar
+end

data/lib/sydecar/document.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Sydecar
+  class Document
+    URL = '/v1/documents'
+    UPLOAD_URL = "#{URL}/upload"
+    SIGN_ARBITRARY_URL = '/v1/documents/click-sign?streamable_file=true'
+    class << self
+      # @param [UUID] id
+      def find(id:)
+        Connection.instance.get("#{URL}/#{id}")
+      end
+      # @param [UUID] id
+      def delete(id:)
+        Connection.instance.delete("#{URL}/#{id}")
+      end
+
+      # @param [UUID] id
+      def preview_url(id:)
+        "/v1/documents/#{id}/preview?streamable_file=false"
+      end
+
+      # @param [UUID] id
+      # @param [Hash] body
+      def preview(id:, body:)
+        url = preview_url(id: id)
+        Connection.instance.post(url, body)
+      end
+
+      # @param [UUID] id
+      def sign_url(id:)
+        "/v1/documents/#{id}/click-sign?streamable_file=false"
+      end
+
+      # @param [UUID] id
+      # @param [Hash] body
+      def sign(id:, body:)
+        url = sign_url(id: id)
+        Connection.instance.post(url, body)
+      end
+
+      # @param [UUID] id
+      def required_fields_url(id:)
+        "/v1/documents/#{id}/fields"
+      end
+
+      # @param [UUID] id
+      def required_fields(id:)
+        url = required_fields_url(id: id)
+        Connection.instance.get(url)
+      end
+
+      def sign_arbitrary(body:, idempotency_key:)
+        Connection.instance.post(SIGN_ARBITRARY_URL, body, { 'idempotency-key': idempotency_key })
+      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
+
+      def download_url(id:)
+        "/v1/documents/#{id}/get_download_url"
+      end
+
+      def download(id:)
+        url = download_url(id: id)
+        Connection.instance.get(url)
+      end
+
+      def upload(body:, idempotency_key:)
+        FileConnection.instance.post(UPLOAD_URL, body, { 'idempotency-key': idempotency_key })
+      end
+    end
+  end
+end

data/lib/sydecar/entity.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Sydecar
+  class Entity
+    URL = '/v1/entities'
+    CREATE_URL = "#{URL}/create"
+    class << self
+      # @param [Hash] body
+      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
+    end
+  end
+end