plaid 10.1.0 → 14.0.0.beta.1

data/lib/plaid/products/liabilities.rb

@@ -1,39 +0,0 @@
-module Plaid
-  # Public: Class used to call the Liabilities product.
-  class Liabilities < BaseProduct
-    # Public: Get liabilities information.
-    #
-    # Does a POST /liabilities/get call which fetches liabilities associated
-    # with an access_token's item.
-    #
-    # access_token - access_token of an item to fetch liabilities for.
-    # account_ids  - Specific account ids to fetch liabilities for
-    #                (optional).
-    #
-    # Returns the LiabilitiesResponse object with liabilities data.
-    def get(access_token, account_ids: nil)
-      post_with_auth 'liabilities/get',
-                     LiabilitiesResponse,
-                     build_payload(access_token,
-                                   account_ids: account_ids)
-    end
-  end
-
-  # Public: Response wrapper for /liabilities/get.
-  class LiabilitiesResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: The list of accounts: Array of Plaid::Models::Account.
-    property :accounts, coerce: Array[Models::Account]
-
-    ##
-    # :attr_reader:
-    # Public: The liabilities: Plaid::Models::Liabilities.
-    property :liabilities, coerce: Models::Liabilities
-
-    ##
-    # :attr_reader:
-    # Public: The item: Plaid::Models::Item.
-    property :item, coerce: Models::Item
-  end
-end

data/lib/plaid/products/payment_initiation.rb

@@ -1,218 +0,0 @@
-module Plaid
-  # Public: Class used to call the Payment product.
-  class PaymentInitiation < BaseProduct
-    # Public: Create a recipient.
-    #
-    # name    - Recipient name.
-    # iban    - Recipient IBAN.
-    # address - Recipient address.
-    # bacs    - Recipient BACS (hash with "account" and "sort_code" keys)
-    #
-    # Returns a PaymentRecipientCreateResponse object.
-    def create_recipient(name, iban, address, bacs)
-      post_with_auth 'payment_initiation/recipient/create',
-                     PaymentRecipientCreateResponse,
-                     name: name,
-                     iban: iban,
-                     bacs: bacs,
-                     address: address
-    end
-
-    # Public: Retrieve a recipient.
-    #
-    # recipient_id - The recipient ID from the `create_recipient` response.
-    #
-    # Returns a PaymentRecipientGetResponse object.
-    def get_recipient(recipient_id)
-      post_with_auth 'payment_initiation/recipient/get',
-                     PaymentRecipientGetResponse,
-                     recipient_id: recipient_id
-    end
-
-    # Public: List all recipients.
-    #
-    # Returns a PaymentRecipientListResponse object.
-    def list_recipients
-      post_with_auth 'payment_initiation/recipient/list',
-                     PaymentRecipientListResponse,
-                     {}
-    end
-
-    # Public: Create a payment.
-    #
-    # recipient_id - Recipient ID that the payment will be initiated for.
-    # reference    - Payment reference.
-    # amount       - Payment amount.
-    #
-    # Returns a PaymentCreateResponse object.
-    def create_payment(recipient_id, reference, amount)
-      post_with_auth 'payment_initiation/payment/create',
-                     PaymentCreateResponse,
-                     recipient_id: recipient_id,
-                     reference: reference,
-                     amount: amount
-    end
-
-    # Public: Create a payment token.
-    #
-    # payment_id - Payment ID that the token will be created for.
-    #
-    # Returns a PaymentTokenCreateResponse object.
-    def create_payment_token(payment_id)
-      post_with_auth 'payment_initiation/payment/token/create',
-                     PaymentTokenCreateResponse,
-                     payment_id: payment_id
-    end
-
-    # Public: Retrieve a payment.
-    #
-    # payment_id - The payment ID from the `create_payment` response.
-    #
-    # Returns a PaymentGetResponse object.
-    def get_payment(payment_id)
-      post_with_auth 'payment_initiation/payment/get',
-                     PaymentGetResponse,
-                     payment_id: payment_id
-    end
-
-    # Public: List all payments.
-    #
-    # options - Object to specify optional parameters 'count' and 'cursor'.
-    #           e.g {count: 10, cursor: '2019-12-06T22:35:49Z'} returns 10
-    #           payments initiated before 2019-12-06T22:35:49Z.
-    #
-    # Returns a PaymentListResponse object.
-    def list_payments(options)
-      post_with_auth 'payment_initiation/payment/list',
-                     PaymentListResponse,
-                     options
-    end
-  end
-
-  # Public: The response wrapper for /payment_initiation/recipient/create.
-  class PaymentRecipientCreateResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: The recipient ID.
-    property :recipient_id
-  end
-
-  # Public: The response wrapper for /payment_initiation/recipient/get.
-  class PaymentRecipientGetResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: The recipient ID.
-    property :recipient_id
-
-    ##
-    # :attr_reader:
-    # Public: The recipient name.
-    property :name
-
-    ##
-    # :attr_reader:
-    # Public: The recipient IBAN.
-    property :iban
-
-    ##
-    # :attr_reader:
-    # Public: The recipient IBAN.
-    property :bacs, coerce: Models::PaymentRecipientBACS
-
-    ##
-    # :attr_reader:
-    # Public: The recipient address.
-    property :address, coerce: Models::PaymentRecipientAddress
-  end
-
-  # Public: The response wrapper for /payment_initiation/recipient/list.
-  class PaymentRecipientListResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: The list of recipients.
-    property :recipients, coerce: Array[Models::PaymentRecipient]
-  end
-
-  # Public: The response wrapper for /payment_initiation/payment/create.
-  class PaymentCreateResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: The payment ID.
-    property :payment_id
-
-    ##
-    # :attr_reader:
-    # Public: The payment status.
-    property :status
-  end
-
-  # Public: The response wrapper for /payment_initiation/payment/token/create.
-  class PaymentTokenCreateResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: The payment token.
-    property :payment_token
-
-    ##
-    # :attr_reader:
-    # Public: The payment token's expiration time.
-    property :payment_token_expiration_time
-  end
-
-  # Public: The response wrapper for /payment_initiation/payment/get.
-  class PaymentGetResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: The payment ID.
-    property :payment_id
-
-    ##
-    # :attr_reader:
-    # Public: The payment token.
-    property :payment_token
-
-    ##
-    # :attr_reader:
-    # Public: The payment reference.
-    property :reference
-
-    ##
-    # :attr_reader:
-    # Public: The payment amount.
-    property :amount, coerce: Models::PaymentAmount
-
-    ##
-    # :attr_reader:
-    # Public: The payment's status.
-    property :status
-
-    ##
-    # :attr_reader:
-    # Public: The last status update time for payment.
-    property :last_status_update
-
-    ##
-    # :attr_reader:
-    # Public: The payment token's expiration time.
-    property :payment_token_expiration_time
-
-    ##
-    # :attr_reader:
-    # Public: The recipient ID for payment.
-    property :recipient_id
-  end
-
-  # Public: The response wrapper for /payment_initiation/payment/list.
-  class PaymentListResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: The list of payments.
-    property :payments, coerce: Array[Models::Payment]
-
-    ##
-    # :attr_reader:
-    # Public: The cursor (its a timestamp) to use in the next
-    # /payment_initiation/payment/list call for retrieving more older payments.
-    property :next_cursor
-  end
-end

data/lib/plaid/products/processor.rb

@@ -1,190 +0,0 @@
-module Plaid
-  # Public: Class used to call the Stripe sub-product.
-  class Stripe < BaseProduct
-    # Public: Class used to call the BankAccountToken sub-product.
-    class BankAccountToken < BaseProduct
-      # Public: Creates a Stripe bank account token from an access_token.
-      #
-      # Does a POST /processor/stripe/bank_account_token/create call which can
-      # be used to generate a Stripe bank account token for a given account
-      # ID.
-      #
-      # access_token - access_token to create a public token for
-      # account_id - ID of the account to create a bank account token for
-      #
-      # Returns CreateResponse object containing a Stripe bank account token.
-      def create(access_token, account_id)
-        post_with_auth 'processor/stripe/bank_account_token/create',
-                       CreateResponse,
-                       access_token: access_token, account_id: account_id
-      end
-
-      # Public: A response for /processor/stripe/bank_account_token/create.
-      class CreateResponse < Models::BaseResponse
-        ##
-        # :attr_reader:
-        # Public: The String stripe token.
-        property :stripe_bank_account_token
-      end
-    end
-
-    ##
-    # :attr_reader:
-    # Public: The Plaid::Stripe::BankAccountToken product accessor.
-    subproduct :bank_account_token, BankAccountToken
-  end
-
-  # Public: A response for /processor/.../processor_token/create.
-  class ProcessorTokenResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: The String processor token.
-    property :processor_token
-  end
-
-  # Public: Class used to call the Dwolla sub-product.
-  class Dwolla < BaseProduct
-    # Public: Class used to call the dwolla.processor_token subproduct
-    class ProcessorToken < BaseProduct
-      # Public: Creates a Dwolla processor token from an access_token.
-      #
-      # Does a POST /processor/dwolla/processor_token/create call which can be
-      # used to generate a Dwolla processor token for a given account ID.
-      #
-      # access_token - access_token to create a public token for.
-      # account_id - ID of the account to create a processor token for.
-      #
-      # Returns a ProcessorTokenResponse object containing a Dwolla processor
-      # token.
-      def create(access_token, account_id)
-        post_with_auth 'processor/dwolla/processor_token/create',
-                       ProcessorTokenResponse,
-                       access_token: access_token,
-                       account_id: account_id
-      end
-    end
-
-    ##
-    # :attr_reader:
-    # Public: The Plaid::Dwolla::ProcessorToken product accessor.
-    subproduct :processor_token, ProcessorToken
-  end
-
-  # Public: Class used to call the Apex sub-product.
-  class Apex < BaseProduct
-    # Public: Class used to call the apex.processor_token subproduct
-    class ProcessorToken < BaseProduct
-      # Public: Creates an Apex processor token from an access_token.
-      #
-      # Does a POST /processor/apex/processor_token/create call which can be
-      # used to generate an Apex processor token for a given account ID.
-      #
-      # access_token - access_token to create a public token for.
-      # account_id - ID of the account to create a processor token for.
-      #
-      # Returns a ProcessorTokenResponse object containing an Apex processor
-      # token.
-      def create(access_token, account_id)
-        post_with_auth 'processor/apex/processor_token/create',
-                       ProcessorTokenResponse,
-                       access_token: access_token,
-                       account_id: account_id
-      end
-    end
-
-    ##
-    # :attr_reader:
-    # Public: The Plaid::ApexProcessorToken product accessor.
-    subproduct :processor_token, ProcessorToken
-  end
-
-  # Public: Class used to call the Ocrolus sub-product.
-  class Ocrolus < BaseProduct
-    # Public: Class used to call the ocrolus.processor_token subproduct
-    class ProcessorToken < BaseProduct
-      # Public: Creates a Ocrolus processor token from an access_token.
-      #
-      # Does a POST /processor/ocrolus/processor_token/create call which can be
-      # used to generate a Ocrolus processor token for a given account ID.
-      #
-      # access_token - access_token to create a public token for.
-      # account_id - ID of the account to create a processor token for.
-      #
-      # Returns a ProcessorTokenResponse object containing a Ocrolus processor
-      # token.
-      def create(access_token, account_id)
-        post_with_auth 'processor/ocrolus/processor_token/create',
-                       ProcessorTokenResponse,
-                       access_token: access_token,
-                       account_id: account_id
-      end
-    end
-
-    ##
-    # :attr_reader:
-    # Public: The Plaid::Ocrolus::ProcessorToken product accessor.
-    subproduct :processor_token, ProcessorToken
-  end
-
-  # Public: Class used to call the generic ProcessorToken sub-product.
-  class ProcessorToken < BaseProduct
-    # Public: Creates a processor token from an access_token.
-    #
-    # Does a POST /processor/token/create call which can be used to
-    # generate any non-stripe processor token for a given account ID.
-    # If the processor is Stripe, the stripe endpoint will be called
-    # instead.
-    #
-    # access_token - access_token to create a public token for.
-    # account_id - ID of the account to create a processor token for.
-    # processor - name of the processor to create a token for.
-    #
-    # Returns a ProcessorTokenResponse object containing a processor token.
-    def create(access_token, account_id, processor)
-      endpoint = 'processor/token/create'
-      options = {
-        access_token: access_token,
-        account_id: account_id,
-        processor: processor
-      }
-
-      if processor == 'stripe'
-        endpoint = '/processor/stripe/bank_account_token/create'
-        options.delete(:processor)
-      elsif processor == 'apex'
-        endpoint = '/processor/apex/processor_token/create'
-        options.delete(:processor)
-      end
-
-      post_with_auth endpoint, ProcessorTokenResponse, **options
-    end
-  end
-
-  # Public: Class used to call the Processor product.
-  class Processor < BaseProduct
-    ##
-    # :attr_reader:
-    # Public: The Plaid::Stripe product accessor.
-    subproduct :stripe
-
-    ##
-    # :attr_reader:
-    # Public: The Plaid::Dwolla product accessor.
-    subproduct :dwolla
-
-    ##
-    # :attr_reader:
-    # Public: The Plaid::Apex product accessor.
-    subproduct :apex
-
-    ##
-    # :attr_reader:
-    # Public: The Plaid::Ocrolus product accessor.
-    subproduct :ocrolus
-
-    ##
-    # :attr_reader:
-    # Public: The Plaid::ProcessorToken product accessor.
-    subproduct :processor_token
-  end
-end

data/lib/plaid/products/sandbox.rb

@@ -1,148 +0,0 @@
-module Plaid
-  # Public: Class used to call the SandboxItem sub-product.
-  class SandboxItem < BaseProduct
-    # Public: Resets sandbox item login.
-    #
-    # Does a POST /sandbox/item/reset_login call.
-    #
-    # access_token - access_token which item to reset login for.
-    #
-    # Returns a ResetLoginResponse object.
-    def reset_login(access_token)
-      post_with_auth 'sandbox/item/reset_login',
-                     ResetLoginResponse,
-                     access_token: access_token
-    end
-
-    # Public: Response for /sandbox/item/reset_login.
-    class ResetLoginResponse < Models::BaseResponse
-      ##
-      # :attr_reader:
-      # Public: The Boolean reset success flag.
-      property :reset_login
-    end
-
-    # Public: Fires a webhook for a sandbox item
-    #
-    # Does a POST /sandbox/item/fire_webhook call.
-    #
-    # access_token - access_token of the item to fire a webhook for.
-    # webhook_code - webhook_code to fire.
-    #
-    # Returns a FireWebhookResponse object.
-    def fire_webhook(access_token, webhook_code)
-      post_with_auth 'sandbox/item/fire_webhook',
-                     FireWebhookResponse,
-                     access_token: access_token,
-                     webhook_code: webhook_code
-    end
-
-    # Public: Response for /sandbox/item/fire_webhook.
-    class FireWebhookResponse < Models::BaseResponse
-      ##
-      # :attr_reader:
-      # Public: The Boolean webhook fired success flag.
-      property :webhook_fired
-    end
-
-    # Public: Sets the verification status for an item
-    # created via automated microdeposits
-    #
-    # Does a POST /sandbox/item/set_verification_status call.
-    #
-    # access_token - access_token of the item
-    # account_id - id of the account to verify
-    # verification_status - status to set
-    #
-    # Returns a Models::BaseResponse object.
-    def set_verification_status(access_token, account_id, verification_status)
-      post_with_auth '/sandbox/item/set_verification_status',
-                     Models::BaseResponse,
-                     access_token: access_token,
-                     account_id: account_id,
-                     verification_status: verification_status
-    end
-  end
-
-  # Public: Class used to call the SandboxPublicToken sub-product
-  class SandboxPublicToken < BaseProduct
-    # Public: Creates a public token for sandbox testing.
-    #
-    # Does a POST /sandbox/public_token/create call which can be used
-    # to generate a public_token given an institution and list of
-    # products.
-    #
-    # institution_id    - Specific institution id to generate token for.
-    # initial_products  - Products for which generated token is valid for.
-    # webhook           - webhook to associate with the item (optional).
-    # override_username - Specific test credential username to use
-    # override_password - Specific test credential password to use
-    # options           - Additional options to merge into API request.
-    #
-    # Returns a SandboxCreateResponse object with a public token and item id.
-    def create(institution_id:,
-               initial_products:,
-               transactions_start_date: nil,
-               transactions_end_date: nil,
-               webhook: nil,
-               override_username: nil,
-               override_password: nil,
-               options: nil)
-
-      options_payload = {}
-      options_payload[:webhook] = webhook unless webhook.nil?
-      txn_options = transaction_options transactions_start_date,
-                                        transactions_end_date
-      options_payload[:transactions] = txn_options if txn_options != {}
-      unless override_username.nil?
-        options_payload[:override_username] = override_username
-      end
-      unless override_password.nil?
-        options_payload[:override_password] = override_password
-      end
-      options_payload = options_payload.merge(options) unless options.nil?
-
-      post_with_public_key 'sandbox/public_token/create',
-                           SandboxCreateResponse,
-                           institution_id: institution_id,
-                           initial_products: initial_products,
-                           options: options_payload
-    end
-
-    private def transaction_options(start_date, end_date)
-      {}.tap do |options|
-        options[:start_date] = Plaid.convert_to_date_string(start_date) \
-          if start_date
-
-        options[:end_date] = Plaid.convert_to_date_string(end_date) \
-          if end_date
-      end
-    end
-
-    # Public: Response for /sandbox/public_token/create.
-    class SandboxCreateResponse < Models::BaseResponse
-      ##
-      # :attr_reader:
-      # Public: The String token.
-      property :public_token
-
-      ##
-      # :attr_reader:
-      # Public: The String item ID.
-      property :item_id
-    end
-  end
-
-  # Public: Class used to call the Sandbox product.
-  class Sandbox < BaseProduct
-    ##
-    # :attr_reader:
-    # Public: The Plaid::SandboxItem product accessor.
-    subproduct :sandbox_item
-
-    ##
-    # :attr_reader:
-    # Public: The Plaid::SandboxPublicToken product accessor.
-    subproduct :sandbox_public_token
-  end
-end