sydecar 0.1.6

data/lib/sydecar/subscription.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module Sydecar
+  class Subscription
+    URL = '/v1/subscriptions'
+    CREATE_URL = "#{URL}/create"
+    FUNDING_COUNTRIES_URL = '/v1/subscriptions/funding_countries'
+
+    class << self
+      # @param [Hash] body
+      # @param [UUID] idempotency_key
+      def create(body:, idempotency_key:)
+        Connection.instance.post(CREATE_URL, body, { 'idempotency-key': idempotency_key })
+      end
+
+      def funding_countries_list
+        Connection.instance.get(FUNDING_COUNTRIES_URL)
+      end
+
+      # @param [UUID] id
+      def find(id:)
+        Connection.instance.get("#{URL}/#{id}", { reveal_bank_info: true, include: 'ach_transfers' })
+      end
+
+      # @param [UUID] id
+      # @param [Hash] body
+      def update(id:, body:)
+        Connection.instance.patch("#{URL}/#{id}", body)
+      end
+
+      # @param [UUID] id
+      def delete(id:)
+        Connection.instance.delete("#{URL}/#{id}")
+      end
+
+      # @param [UUID] id
+      def create_agreement_preview_url(id:)
+        "/v1/subscriptions/#{id}/subscription_agreement/preview?streamable_file=true"
+      end
+
+      # @param [UUID] id
+      def create_agreement_preview(id:)
+        url = create_agreement_preview_url(id: id)
+        Connection.instance.post(url)
+      end
+
+      # @param [UUID] id
+      def create_virtual_bank_account_url(id:)
+        "/v1/subscriptions/#{id}/create_account"
+      end
+
+      # @param [UUID] id
+      # @param [Hash] body
+      def create_virtual_bank_account(id:, body:)
+        url = create_virtual_bank_account_url(id: id)
+        Connection.instance.post(url, body)
+      end
+
+      # @param [UUID] id
+      def set_balance_url(id:)
+        "/v1/subscriptions/#{id}/fund"
+      end
+
+      # @param [UUID] id
+      # @param [Hash] body
+      def set_balance(id:, body:)
+        url = set_balance_url(id: id)
+        Connection.instance.post(url, body)
+      end
+
+      # @param [UUID] id
+      def sign_url(id:)
+        "/v1/subscriptions/#{id}/sign"
+      end
+
+      # @param [UUID] id
+      # @param [Hash] body
+      def sign(id:, body:)
+        url = sign_url(id: id)
+        Connection.instance.post(url, body)
+      end
+
+      def amend_url(id:)
+        "/v1/subscriptions/#{id}/amend"
+      end
+
+      # @param [UUID] id
+      # @param [Hash] body
+      def amend(id:, body:)
+        url = amend_url(id: id)
+        Connection.instance.post(url, body)
+      end
+
+      # @param [UUID] id
+      def send_ach_with_plaid_url(id:)
+        "/v1/subscriptions/#{id}/send_ach_with_plaid"
+      end
+
+      # @param [UUID] id
+      # @param [Hash] body
+      # @param [UUID] idempotency_key
+      def send_ach_with_plaid(id:, body:, idempotency_key:)
+        url = send_ach_with_plaid_url(id: id)
+        Connection.instance.post(url, body, { 'idempotency-key': idempotency_key })
+      end
+
+      # @param [UUID] id
+      def refund_ach_with_plaid_url(id:)
+        "/v1/subscriptions/#{id}/refund_ach_with_plaid"
+      end
+
+      # @param [UUID] id
+      # @param [Hash] body
+      # @param [UUID] idempotency_key
+      def refund_ach_with_plaid(id:, body:, idempotency_key:)
+        url = refund_ach_with_plaid_url(id: id)
+        Connection.instance.post(url, body, { 'idempotency-key': idempotency_key })
+      end
+
+      # @param [UUID] id
+      def refund_url(id:)
+        "/v1/subscriptions/#{id}/refund"
+      end
+
+      # @param [UUID] id
+      # @param [Hash] body
+      # @param [UUID] idempotency_key
+      def refund(id:, body:, idempotency_key:)
+        url = refund_url(id: id)
+        Connection.instance.post(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)
+      # [Boolean] reveal_bank_info
+      # [String] include (example: {include: 'ach_transfers'})
+      # @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 url(id)
+        "#{URL}/#{id}/finalize"
+      end
+
+      # @param
+      # 'id' [String] id of subscriber
+      # @param
+      # body  [Hash] argument expects to have the following keys:
+      # document_signer: { "name": [String],  "title": [String] }
+      #   "name"  The name of the signer.
+      #   "title"  The title of the signer as relates to the entity it represents.
+      #
+      # Finalize a subscription to be ready to create a bank account.
+      def finalize(id:, body:)
+        url = url id
+        Connection.instance.post(url, body)
+      end
+    end
+  end
+end

data/lib/sydecar/vendor.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Sydecar
+  class Vendor
+    URL = '/v1/vendors'
+    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

data/lib/sydecar/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Sydecar
+  VERSION = '0.1.6'
+end

data/lib/sydecar/webhook_calls.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+module Sydecar
+  class WebhookCalls
+    URL = '/v1/configure/webhooks'
+    class << self
+      # The method create a webhook callback URL
+      # @param
+      #   HEADER PARAMETERS:
+      #     - idempotency-key [String] - Idempotency key header for sensitive operations
+      #   REQUEST BODY SCHEMA: application/json
+      #     - url [String]       - The callback url associated the the webhook (required)
+      #     - label [String]     - A label to easily identify your web hook (required)
+      #     - token [String]     - For security reasons every webhook is associated with a token.  (required)
+      #                             This token will be used to sign the incoming payloads.
+      #     - disabled [boolean] - Enable / disable your web hook. (required)
+      #
+      # @note
+      #   Set a webhook callback URL. You can provide any URL for Sydecar webhook callbacks to land.
+      #   All webhook callbacks for the specified environment will be directed to the URL you provide.
+      #   For maximum security, make sure to use https endpoints. In addition, webhook calls will be signed with a token.
+      #
+      # @example
+      #   Response samples:
+      #   {
+      #   "id": "string",
+      #   "created_at": "2019-08-24T14:15:22Z",
+      #   "updated_at": "2019-08-24T14:15:22Z",
+      #   "url": "string",
+      #   "label": "string",
+      #   "token": "string",
+      #   "disabled": true
+      # }
+      # @return [Hash] - Responses: > '201'
+      #
+      # See on the https://api-docs.sydecar.io/api/#tag/Configuration/operation/createWebhook
+      def create(body:, idempotency_key:)
+      	Connection.instance.post("#{URL}/create", body, { 'idempotency-key': idempotency_key })
+      end
+
+      # This method fetch all webhooks
+      # Retrieve all webhooks created to date (filtered). Pagination is available.
+      # @param
+      #   Query parameters [Hash]
+      #   - 'sort' [String] (Enum: 'asc', 'desc')
+      #   - 'limit' [Number] (<=100)
+      #   - 'offset' [Number]
+      #   - 'start_date' [String]
+      #   - 'end_date' [String]
+      # @example
+      # RESPONSE DATA (Sample):
+      #   {
+      #   "data": [
+      #     {
+      #       "id": "string",
+      #       "created_at": "2019-08-24T14:15:22Z",
+      #       "updated_at": "2019-08-24T14:15:22Z",
+      #       "url": "string",
+      #       "label": "string",
+      #       "token": "string",
+      #       "disabled": true
+      #     }
+      #   ],
+      #   "pagination": {
+      #     "limit": 0,
+      #     "offset": 0,
+      #     "total": 0
+      #   }
+      # }
+      # @return See example RESPONSES: > '200'
+      #
+      # See on the https://api-docs.sydecar.io/api/#tag/Configuration/operation/getAllWebhooks
+      def find_all(query: {})
+        query = "?#{URI.encode_www_form(query)}"
+        Connection.instance.post("#{URL}#{query}")
+      end
+
+      # This method Fetch webhook information by id
+      # Fetch webhook information by id. This does not include the associate webhook events.
+      # @param
+      #   PATH PARAMETERS
+      #   - webhook_id [String] (required)
+      # Response samples
+      #   {
+      #   "id": "string",
+      #   "created_at": "2019-08-24T14:15:22Z",
+      #   "updated_at": "2019-08-24T14:15:22Z",
+      #   "url": "string",
+      #   "label": "string",
+      #   "token": "string",
+      #   "disabled": true
+      # }
+      # return [Hash] Responses: > '200'
+      #
+      # See on the https://api-docs.sydecar.io/api/#tag/Configuration/operation/getWebhook
+      def find(id:)
+        Connection.instance.get("#{URL}/#{id}")
+      end
+
+      # This method Update a webhook
+      # Update a webhook. You can update the label, url and/or token.
+      # @param
+      #   PATH PARAMETERS
+      #   - webhook_id [String] (required)
+      #   REQUEST BODY SCHEMA: application/json
+      #     - url [String]       - The callback url associated the the webhook (required)
+      #     - label [String]     - A label to easily identify your web hook    (required)
+      #     - token [String]     - For security reasons every webhook is associated with a token.  (required)
+      #                             This token will be used to sign the incoming payloads.
+      #     - disabled [boolean] - Enable / disable your web hook. (required)
+      # @example
+      #   Response samples:
+      #   {
+      #   "id": "string",
+      #   "created_at": "2019-08-24T14:15:22Z",
+      #   "updated_at": "2019-08-24T14:15:22Z",
+      #   "url": "string",
+      #   "label": "string",
+      #   "token": "string",
+      #   "disabled": true
+      # }
+      # @return [Hash] - Responses: > '200'
+      #
+      # See on the https://api-docs.sydecar.io/api/#tag/Configuration/operation/updateWebhook
+      def update(id:, body:)
+        Connection.instance.patch("#{URL}/#{id}", body)
+      end
+
+      # This method Fetch latest webhook events
+      # Fetch the latest events for a webhook.
+      # @param
+      #   PATH PARAMETERS
+      #   - webhook_id [String] (required)
+      #   Query parameters [Hash]
+      #   - 'sort' [String] (Enum: 'asc', 'desc')
+      #   - 'limit' [Number] (<=100)
+      #   - 'offset' [Number]
+      #   - 'start_date' [String]
+      #   - 'end_date' [String]
+      # @example
+      # RESPONSE DATA (Sample):
+      # {
+      #   "data": [
+      #     {
+      #       "id": "string",
+      #       "created_at": "2019-08-24T14:15:22Z",
+      #       "updated_at": "2019-08-24T14:15:22Z",
+      #       "type": "plaid.account.item.expiring",
+      #       "details": {
+      #         "property1": "string",
+      #         "property2": "string"
+      #       }
+      #     }
+      #   ],
+      #   "pagination": {
+      #     "limit": 0,
+      #     "offset": 0,
+      #     "total": 0
+      #   }
+      # }
+      # @return See example RESPONSES: > '200'
+      #
+      # See on the https://api-docs.sydecar.io/api/#tag/Configuration/operation/getAllWebhookEvents
+      def find_latest_events(id:, query: {})
+        query = URI.encode_www_form(query)
+        Connection.instance.post("#{URL}/#{id}/events?#{query}")
+      end
+
+      # This method Resend webhook event
+      # Resend a webhook event which was previously published.
+      # @param
+      #   PATH PARAMETERS
+      #   - event_id [String] (required)
+      # @example
+      #   Response samples
+      #   {
+      #   "id": "string",
+      #   "created_at": "2019-08-24T14:15:22Z",
+      #   "updated_at": "2019-08-24T14:15:22Z",
+      #   "type": "plaid.account.item.expiring",
+      #   "details": {
+      #     "property1": "string",
+      #     "property2": "string"
+      #   }
+      # }
+      # @return [Hash] Responses > '200'
+      #
+      # See on the https://api-docs.sydecar.io/api/#tag/Configuration/operation/replayWebhookEvent
+      def resend_event(event_id:)
+        Connection.instance.post("#{URL}/event/#{event_id}")
+      end
+    end
+  end
+end

data/lib/sydecar.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+Bundler.require(:default)
+require 'uri'
+
+require_relative "sydecar/version"
+require_relative "sydecar/constants"
+require_relative "sydecar/base_connection"
+require_relative "sydecar/connection"
+require_relative "sydecar/file_connection"
+require_relative "sydecar/person"
+require_relative "sydecar/profile"
+require_relative "sydecar/profile/entity"
+require_relative "sydecar/profile/individual"
+require_relative "sydecar/entity"
+require_relative "sydecar/bank_account"
+require_relative "sydecar/spv"
+require_relative "sydecar/vendor"
+require_relative "sydecar/expense"
+require_relative "sydecar/subscription"
+require_relative "sydecar/document"
+require_relative "sydecar/plaid"
+require_relative "sydecar/webhook_calls"
+require_relative "sydecar/capital_call"
+
+module Sydecar
+  class TokenNotSetError < StandardError; end
+  class BaseUrlNotSetError < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: sydecar
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- 1lyan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Ruby bindings for the Sydecar API.
+email:
+- ilya.nechiporenko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sydecar.rb
+- lib/sydecar/bank_account.rb
+- lib/sydecar/base_connection.rb
+- lib/sydecar/capital_call.rb
+- lib/sydecar/connection.rb
+- lib/sydecar/constants.rb
+- lib/sydecar/document.rb
+- lib/sydecar/entity.rb
+- lib/sydecar/expense.rb
+- lib/sydecar/file_connection.rb
+- lib/sydecar/person.rb
+- lib/sydecar/plaid.rb
+- lib/sydecar/profile.rb
+- lib/sydecar/profile/entity.rb
+- lib/sydecar/profile/individual.rb
+- lib/sydecar/spv.rb
+- lib/sydecar/subscription.rb
+- lib/sydecar/vendor.rb
+- lib/sydecar/version.rb
+- lib/sydecar/webhook_calls.rb
+homepage: https://github.com/Play-Money/sydecar.
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Play-Money/sydecar.
+  source_code_uri: https://github.com/Play-Money/sydecar.
+  changelog_uri: https://github.com/Play-Money/sydecar.
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Ruby bindings for the Sydecar API.
+test_files: []