increase 0.3.2 → 1.0.0

data/lib/increase/models/external_account.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::ExternalAccounts#create
+    class ExternalAccount < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The External Account's identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_holder
+      #   The type of entity that owns the External Account.
+      #
+      #   @return [Symbol, Increase::Models::ExternalAccount::AccountHolder]
+      required :account_holder, enum: -> { Increase::ExternalAccount::AccountHolder }
+
+      # @!attribute account_number
+      #   The destination account number.
+      #
+      #   @return [String]
+      required :account_number, String
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #   the External Account was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute description
+      #   The External Account's description for display purposes.
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute funding
+      #   The type of the account to which the transfer will be sent.
+      #
+      #   @return [Symbol, Increase::Models::ExternalAccount::Funding]
+      required :funding, enum: -> { Increase::ExternalAccount::Funding }
+
+      # @!attribute idempotency_key
+      #   The idempotency key you chose for this object. This value is unique across
+      #   Increase and is used to ensure that a request is only processed once. Learn more
+      #   about [idempotency](https://increase.com/documentation/idempotency-keys).
+      #
+      #   @return [String, nil]
+      required :idempotency_key, String, nil?: true
+
+      # @!attribute routing_number
+      #   The American Bankers' Association (ABA) Routing Transit Number (RTN).
+      #
+      #   @return [String]
+      required :routing_number, String
+
+      # @!attribute status
+      #   The External Account's status.
+      #
+      #   @return [Symbol, Increase::Models::ExternalAccount::Status]
+      required :status, enum: -> { Increase::ExternalAccount::Status }
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `external_account`.
+      #
+      #   @return [Symbol, Increase::Models::ExternalAccount::Type]
+      required :type, enum: -> { Increase::ExternalAccount::Type }
+
+      # @!method initialize(id:, account_holder:, account_number:, created_at:, description:, funding:, idempotency_key:, routing_number:, status:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::ExternalAccount} for more details.
+      #
+      #   External Accounts represent accounts at financial institutions other than
+      #   Increase. You can use this API to store their details for reuse.
+      #
+      #   @param id [String] The External Account's identifier.
+      #
+      #   @param account_holder [Symbol, Increase::Models::ExternalAccount::AccountHolder] The type of entity that owns the External Account.
+      #
+      #   @param account_number [String] The destination account number.
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+      #
+      #   @param description [String] The External Account's description for display purposes.
+      #
+      #   @param funding [Symbol, Increase::Models::ExternalAccount::Funding] The type of the account to which the transfer will be sent.
+      #
+      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
+      #
+      #   @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN).
+      #
+      #   @param status [Symbol, Increase::Models::ExternalAccount::Status] The External Account's status.
+      #
+      #   @param type [Symbol, Increase::Models::ExternalAccount::Type] A constant representing the object's type. For this resource it will always be `
+
+      # The type of entity that owns the External Account.
+      #
+      # @see Increase::Models::ExternalAccount#account_holder
+      module AccountHolder
+        extend Increase::Internal::Type::Enum
+
+        # The External Account is owned by a business.
+        BUSINESS = :business
+
+        # The External Account is owned by an individual.
+        INDIVIDUAL = :individual
+
+        # It's unknown what kind of entity owns the External Account.
+        UNKNOWN = :unknown
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The type of the account to which the transfer will be sent.
+      #
+      # @see Increase::Models::ExternalAccount#funding
+      module Funding
+        extend Increase::Internal::Type::Enum
+
+        # A checking account.
+        CHECKING = :checking
+
+        # A savings account.
+        SAVINGS = :savings
+
+        # A different type of account.
+        OTHER = :other
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The External Account's status.
+      #
+      # @see Increase::Models::ExternalAccount#status
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # The External Account is active.
+        ACTIVE = :active
+
+        # The External Account is archived and won't appear in the dashboard.
+        ARCHIVED = :archived
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `external_account`.
+      #
+      # @see Increase::Models::ExternalAccount#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        EXTERNAL_ACCOUNT = :external_account
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/external_account_create_params.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::ExternalAccounts#create
+    class ExternalAccountCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_number
+      #   The account number for the destination account.
+      #
+      #   @return [String]
+      required :account_number, String
+
+      # @!attribute description
+      #   The name you choose for the Account.
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute routing_number
+      #   The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
+      #   destination account.
+      #
+      #   @return [String]
+      required :routing_number, String
+
+      # @!attribute account_holder
+      #   The type of entity that owns the External Account.
+      #
+      #   @return [Symbol, Increase::Models::ExternalAccountCreateParams::AccountHolder, nil]
+      optional :account_holder, enum: -> { Increase::ExternalAccountCreateParams::AccountHolder }
+
+      # @!attribute funding
+      #   The type of the destination account. Defaults to `checking`.
+      #
+      #   @return [Symbol, Increase::Models::ExternalAccountCreateParams::Funding, nil]
+      optional :funding, enum: -> { Increase::ExternalAccountCreateParams::Funding }
+
+      # @!method initialize(account_number:, description:, routing_number:, account_holder: nil, funding: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::ExternalAccountCreateParams} for more details.
+      #
+      #   @param account_number [String] The account number for the destination account.
+      #
+      #   @param description [String] The name you choose for the Account.
+      #
+      #   @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des
+      #
+      #   @param account_holder [Symbol, Increase::Models::ExternalAccountCreateParams::AccountHolder] The type of entity that owns the External Account.
+      #
+      #   @param funding [Symbol, Increase::Models::ExternalAccountCreateParams::Funding] The type of the destination account. Defaults to `checking`.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      # The type of entity that owns the External Account.
+      module AccountHolder
+        extend Increase::Internal::Type::Enum
+
+        # The External Account is owned by a business.
+        BUSINESS = :business
+
+        # The External Account is owned by an individual.
+        INDIVIDUAL = :individual
+
+        # It's unknown what kind of entity owns the External Account.
+        UNKNOWN = :unknown
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The type of the destination account. Defaults to `checking`.
+      module Funding
+        extend Increase::Internal::Type::Enum
+
+        # A checking account.
+        CHECKING = :checking
+
+        # A savings account.
+        SAVINGS = :savings
+
+        # A different type of account.
+        OTHER = :other
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/external_account_list_params.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::ExternalAccounts#list
+    class ExternalAccountListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   Return the page of entries after this one.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute idempotency_key
+      #   Filter records to the one with the specified `idempotency_key` you chose for
+      #   that object. This value is unique across Increase and is used to ensure that a
+      #   request is only processed once. Learn more about
+      #   [idempotency](https://increase.com/documentation/idempotency-keys).
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute limit
+      #   Limit the size of the list that is returned. The default (and maximum) is 100
+      #   objects.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute routing_number
+      #   Filter External Accounts to those with the specified Routing Number.
+      #
+      #   @return [String, nil]
+      optional :routing_number, String
+
+      # @!attribute status
+      #
+      #   @return [Increase::Models::ExternalAccountListParams::Status, nil]
+      optional :status, -> { Increase::ExternalAccountListParams::Status }
+
+      # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, routing_number: nil, status: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::ExternalAccountListParams} for more details.
+      #
+      #   @param cursor [String] Return the page of entries after this one.
+      #
+      #   @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      #
+      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      #   @param routing_number [String] Filter External Accounts to those with the specified Routing Number.
+      #
+      #   @param status [Increase::Models::ExternalAccountListParams::Status]
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class Status < Increase::Internal::Type::BaseModel
+        # @!attribute in_
+        #   Filter External Accounts for those with the specified status or statuses. For
+        #   GET requests, this should be encoded as a comma-delimited string, such as
+        #   `?in=one,two,three`.
+        #
+        #   @return [Array<Symbol, Increase::Models::ExternalAccountListParams::Status::In>, nil]
+        optional :in_,
+                 -> {
+                   Increase::Internal::Type::ArrayOf[enum: Increase::ExternalAccountListParams::Status::In]
+                 },
+                 api_name: :in
+
+        # @!method initialize(in_: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::ExternalAccountListParams::Status} for more details.
+        #
+        #   @param in_ [Array<Symbol, Increase::Models::ExternalAccountListParams::Status::In>] Filter External Accounts for those with the specified status or statuses. For GE
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          # The External Account is active.
+          ACTIVE = :active
+
+          # The External Account is archived and won't appear in the dashboard.
+          ARCHIVED = :archived
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/increase/models/external_account_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::ExternalAccounts#retrieve
+    class ExternalAccountRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/external_account_update_params.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::ExternalAccounts#update
+    class ExternalAccountUpdateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_holder
+      #   The type of entity that owns the External Account.
+      #
+      #   @return [Symbol, Increase::Models::ExternalAccountUpdateParams::AccountHolder, nil]
+      optional :account_holder, enum: -> { Increase::ExternalAccountUpdateParams::AccountHolder }
+
+      # @!attribute description
+      #   The description you choose to give the external account.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute funding
+      #   The funding type of the External Account.
+      #
+      #   @return [Symbol, Increase::Models::ExternalAccountUpdateParams::Funding, nil]
+      optional :funding, enum: -> { Increase::ExternalAccountUpdateParams::Funding }
+
+      # @!attribute status
+      #   The status of the External Account.
+      #
+      #   @return [Symbol, Increase::Models::ExternalAccountUpdateParams::Status, nil]
+      optional :status, enum: -> { Increase::ExternalAccountUpdateParams::Status }
+
+      # @!method initialize(account_holder: nil, description: nil, funding: nil, status: nil, request_options: {})
+      #   @param account_holder [Symbol, Increase::Models::ExternalAccountUpdateParams::AccountHolder] The type of entity that owns the External Account.
+      #
+      #   @param description [String] The description you choose to give the external account.
+      #
+      #   @param funding [Symbol, Increase::Models::ExternalAccountUpdateParams::Funding] The funding type of the External Account.
+      #
+      #   @param status [Symbol, Increase::Models::ExternalAccountUpdateParams::Status] The status of the External Account.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      # The type of entity that owns the External Account.
+      module AccountHolder
+        extend Increase::Internal::Type::Enum
+
+        # The External Account is owned by a business.
+        BUSINESS = :business
+
+        # The External Account is owned by an individual.
+        INDIVIDUAL = :individual
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The funding type of the External Account.
+      module Funding
+        extend Increase::Internal::Type::Enum
+
+        # A checking account.
+        CHECKING = :checking
+
+        # A savings account.
+        SAVINGS = :savings
+
+        # A different type of account.
+        OTHER = :other
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The status of the External Account.
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # The External Account is active.
+        ACTIVE = :active
+
+        # The External Account is archived and won't appear in the dashboard.
+        ARCHIVED = :archived
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/file.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Files#create
+    class File < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The File's identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The time the File was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute description
+      #   A description of the File.
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute direction
+      #   Whether the File was generated by Increase or by you and sent to Increase.
+      #
+      #   @return [Symbol, Increase::Models::File::Direction]
+      required :direction, enum: -> { Increase::File::Direction }
+
+      # @!attribute filename
+      #   The filename that was provided upon upload or generated by Increase.
+      #
+      #   @return [String, nil]
+      required :filename, String, nil?: true
+
+      # @!attribute idempotency_key
+      #   The idempotency key you chose for this object. This value is unique across
+      #   Increase and is used to ensure that a request is only processed once. Learn more
+      #   about [idempotency](https://increase.com/documentation/idempotency-keys).
+      #
+      #   @return [String, nil]
+      required :idempotency_key, String, nil?: true
+
+      # @!attribute mime_type
+      #   The MIME type of the file.
+      #
+      #   @return [String]
+      required :mime_type, String
+
+      # @!attribute purpose
+      #   What the File will be used for. We may add additional possible values for this
+      #   enum over time; your application should be able to handle such additions
+      #   gracefully.
+      #
+      #   @return [Symbol, Increase::Models::File::Purpose]
+      required :purpose, enum: -> { Increase::File::Purpose }
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `file`.
+      #
+      #   @return [Symbol, Increase::Models::File::Type]
+      required :type, enum: -> { Increase::File::Type }
+
+      # @!method initialize(id:, created_at:, description:, direction:, filename:, idempotency_key:, mime_type:, purpose:, type:)
+      #   Some parameter documentations has been truncated, see {Increase::Models::File}
+      #   for more details.
+      #
+      #   Files are objects that represent a file hosted on Increase's servers. The file
+      #   may have been uploaded by you (for example, when uploading a check image) or it
+      #   may have been created by Increase (for example, an autogenerated statement PDF).
+      #   If you need to download a File, create a File Link.
+      #
+      #   @param id [String] The File's identifier.
+      #
+      #   @param created_at [Time] The time the File was created.
+      #
+      #   @param description [String, nil] A description of the File.
+      #
+      #   @param direction [Symbol, Increase::Models::File::Direction] Whether the File was generated by Increase or by you and sent to Increase.
+      #
+      #   @param filename [String, nil] The filename that was provided upon upload or generated by Increase.
+      #
+      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
+      #
+      #   @param mime_type [String] The MIME type of the file.
+      #
+      #   @param purpose [Symbol, Increase::Models::File::Purpose] What the File will be used for. We may add additional possible values for this e
+      #
+      #   @param type [Symbol, Increase::Models::File::Type] A constant representing the object's type. For this resource it will always be `
+
+      # Whether the File was generated by Increase or by you and sent to Increase.
+      #
+      # @see Increase::Models::File#direction
+      module Direction
+        extend Increase::Internal::Type::Enum
+
+        # This File was sent by you to Increase.
+        TO_INCREASE = :to_increase
+
+        # This File was generated by Increase.
+        FROM_INCREASE = :from_increase
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # What the File will be used for. We may add additional possible values for this
+      # enum over time; your application should be able to handle such additions
+      # gracefully.
+      #
+      # @see Increase::Models::File#purpose
+      module Purpose
+        extend Increase::Internal::Type::Enum
+
+        # An image of the front of a check, used for check deposits.
+        CHECK_IMAGE_FRONT = :check_image_front
+
+        # An image of the back of a check, used for check deposits.
+        CHECK_IMAGE_BACK = :check_image_back
+
+        # An image of the front of a deposited check after processing by Increase and submission to the Federal Reserve.
+        PROCESSED_CHECK_IMAGE_FRONT = :processed_check_image_front
+
+        # An image of the back of a deposited check after processing by Increase and submission to the Federal Reserve.
+        PROCESSED_CHECK_IMAGE_BACK = :processed_check_image_back
+
+        # An image of a check that was mailed to a recipient.
+        MAILED_CHECK_IMAGE = :mailed_check_image
+
+        # A document to be printed on an additional page and mailed with a check that you've requested Increase print.
+        CHECK_ATTACHMENT = :check_attachment
+
+        # A scanned mail item sent to Increase.
+        INBOUND_MAIL_ITEM = :inbound_mail_item
+
+        # IRS Form 1099-INT.
+        FORM_1099_INT = :form_1099_int
+
+        # IRS Form 1099-MISC.
+        FORM_1099_MISC = :form_1099_misc
+
+        # IRS Form SS-4.
+        FORM_SS_4 = :form_ss_4
+
+        # An image of a government-issued ID.
+        IDENTITY_DOCUMENT = :identity_document
+
+        # A statement generated by Increase.
+        INCREASE_STATEMENT = :increase_statement
+
+        # A file purpose not covered by any of the other cases.
+        OTHER = :other
+
+        # A legal document forming a trust.
+        TRUST_FORMATION_DOCUMENT = :trust_formation_document
+
+        # A card image to be rendered inside digital wallet apps. This must be a 1536x969 pixel PNG.
+        DIGITAL_WALLET_ARTWORK = :digital_wallet_artwork
+
+        # An icon for you app to be rendered inside digital wallet apps. This must be a 100x100 pixel PNG.
+        DIGITAL_WALLET_APP_ICON = :digital_wallet_app_icon
+
+        # A card image to be printed on the front of a physical card. This must be a 2100x1340 pixel PNG with no other color but black.
+        PHYSICAL_CARD_FRONT = :physical_card_front
+
+        # The image to be printed on the back of a physical card.
+        PHYSICAL_CARD_BACK = :physical_card_back
+
+        # An image representing the entirety of the carrier used for a physical card. This must be a 2550x3300 pixel PNG with no other color but black.
+        PHYSICAL_CARD_CARRIER = :physical_card_carrier
+
+        # A document requested by Increase.
+        DOCUMENT_REQUEST = :document_request
+
+        # A supplemental document associated an an Entity.
+        ENTITY_SUPPLEMENTAL_DOCUMENT = :entity_supplemental_document
+
+        # The results of an Export you requested via the dashboard or API.
+        EXPORT = :export
+
+        # An attachment to an Unusual Activity Report.
+        UNUSUAL_ACTIVITY_REPORT_ATTACHMENT = :unusual_activity_report_attachment
+
+        # A document granting another entity access to the funds into your account.
+        DEPOSIT_ACCOUNT_CONTROL_AGREEMENT = :deposit_account_control_agreement
+
+        # A file containing additional evidence for a Proof of Authorization Request Submission.
+        PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION = :proof_of_authorization_request_submission
+
+        # An account verification letter.
+        ACCOUNT_VERIFICATION_LETTER = :account_verification_letter
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `file`.
+      #
+      # @see Increase::Models::File#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        FILE = :file
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end