increase 0.3.3 → 1.0.0

data/lib/increase/models/file_create_params.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Files#create
+    class FileCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute file
+      #   The file contents. This should follow the specifications of
+      #   [RFC 7578](https://datatracker.ietf.org/doc/html/rfc7578) which defines file
+      #   transfers for the multipart/form-data protocol.
+      #
+      #   @return [Pathname, StringIO, IO, String, Increase::FilePart]
+      required :file, Increase::Internal::Type::FileInput
+
+      # @!attribute purpose
+      #   What the File will be used for in Increase's systems.
+      #
+      #   @return [Symbol, Increase::Models::FileCreateParams::Purpose]
+      required :purpose, enum: -> { Increase::FileCreateParams::Purpose }
+
+      # @!attribute description
+      #   The description you choose to give the File.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!method initialize(file:, purpose:, description: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::FileCreateParams} for more details.
+      #
+      #   @param file [Pathname, StringIO, IO, String, Increase::FilePart] The file contents. This should follow the specifications of [RFC 7578](https://d
+      #
+      #   @param purpose [Symbol, Increase::Models::FileCreateParams::Purpose] What the File will be used for in Increase's systems.
+      #
+      #   @param description [String] The description you choose to give the File.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      # What the File will be used for in Increase's systems.
+      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 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
+
+        # IRS Form SS-4.
+        FORM_SS_4 = :form_ss_4
+
+        # An image of a government-issued ID.
+        IDENTITY_DOCUMENT = :identity_document
+
+        # 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
+
+        # 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
+
+        # An attachment to an Unusual Activity Report.
+        UNUSUAL_ACTIVITY_REPORT_ATTACHMENT = :unusual_activity_report_attachment
+
+        # A file containing additional evidence for a Proof of Authorization Request Submission.
+        PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION = :proof_of_authorization_request_submission
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/file_link.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::FileLinks#create
+    class FileLink < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The File Link identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the File
+      #   Link was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute expires_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the File
+      #   Link will expire.
+      #
+      #   @return [Time]
+      required :expires_at, Time
+
+      # @!attribute file_id
+      #   The identifier of the File the File Link points to.
+      #
+      #   @return [String]
+      required :file_id, String
+
+      # @!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 type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `file_link`.
+      #
+      #   @return [Symbol, Increase::Models::FileLink::Type]
+      required :type, enum: -> { Increase::FileLink::Type }
+
+      # @!attribute unauthenticated_url
+      #   A URL where the File can be downloaded. The URL will expire after the
+      #   `expires_at` time. This URL is unauthenticated and can be used to download the
+      #   File without an Increase API key.
+      #
+      #   @return [String]
+      required :unauthenticated_url, String
+
+      # @!method initialize(id:, created_at:, expires_at:, file_id:, idempotency_key:, type:, unauthenticated_url:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::FileLink} for more details.
+      #
+      #   File Links let you generate a URL that can be used to download a File.
+      #
+      #   @param id [String] The File Link identifier.
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the File Li
+      #
+      #   @param expires_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the File Li
+      #
+      #   @param file_id [String] The identifier of the File the File Link points to.
+      #
+      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
+      #
+      #   @param type [Symbol, Increase::Models::FileLink::Type] A constant representing the object's type. For this resource it will always be `
+      #
+      #   @param unauthenticated_url [String] A URL where the File can be downloaded. The URL will expire after the `expires_a
+
+      # A constant representing the object's type. For this resource it will always be
+      # `file_link`.
+      #
+      # @see Increase::Models::FileLink#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        FILE_LINK = :file_link
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/file_link_create_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::FileLinks#create
+    class FileLinkCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute file_id
+      #   The File to create a File Link for.
+      #
+      #   @return [String]
+      required :file_id, String
+
+      # @!attribute expires_at
+      #   The time at which the File Link will expire. The default is 1 hour from the time
+      #   of the request. The maxiumum is 1 day from the time of the request.
+      #
+      #   @return [Time, nil]
+      optional :expires_at, Time
+
+      # @!method initialize(file_id:, expires_at: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::FileLinkCreateParams} for more details.
+      #
+      #   @param file_id [String] The File to create a File Link for.
+      #
+      #   @param expires_at [Time] The time at which the File Link will expire. The default is 1 hour from the time
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/file_list_params.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Files#list
+    class FileListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute created_at
+      #
+      #   @return [Increase::Models::FileListParams::CreatedAt, nil]
+      optional :created_at, -> { Increase::FileListParams::CreatedAt }
+
+      # @!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 purpose
+      #
+      #   @return [Increase::Models::FileListParams::Purpose, nil]
+      optional :purpose, -> { Increase::FileListParams::Purpose }
+
+      # @!method initialize(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, purpose: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::FileListParams} for more details.
+      #
+      #   @param created_at [Increase::Models::FileListParams::CreatedAt]
+      #
+      #   @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 purpose [Increase::Models::FileListParams::Purpose]
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class CreatedAt < Increase::Internal::Type::BaseModel
+        # @!attribute after
+        #   Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #   timestamp.
+        #
+        #   @return [Time, nil]
+        optional :after, Time
+
+        # @!attribute before
+        #   Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #   timestamp.
+        #
+        #   @return [Time, nil]
+        optional :before, Time
+
+        # @!attribute on_or_after
+        #   Return results on or after this
+        #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        #
+        #   @return [Time, nil]
+        optional :on_or_after, Time
+
+        # @!attribute on_or_before
+        #   Return results on or before this
+        #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        #
+        #   @return [Time, nil]
+        optional :on_or_before, Time
+
+        # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::FileListParams::CreatedAt} for more details.
+        #
+        #   @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
+        #
+        #   @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
+        #
+        #   @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
+        #
+        #   @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
+      end
+
+      class Purpose < Increase::Internal::Type::BaseModel
+        # @!attribute in_
+        #   Filter Files for those with the specified purpose or purposes. For GET requests,
+        #   this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
+        #
+        #   @return [Array<Symbol, Increase::Models::FileListParams::Purpose::In>, nil]
+        optional :in_,
+                 -> { Increase::Internal::Type::ArrayOf[enum: Increase::FileListParams::Purpose::In] },
+                 api_name: :in
+
+        # @!method initialize(in_: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::FileListParams::Purpose} for more details.
+        #
+        #   @param in_ [Array<Symbol, Increase::Models::FileListParams::Purpose::In>] Filter Files for those with the specified purpose or purposes. For GET requests,
+
+        module In
+          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
+      end
+    end
+  end
+end

data/lib/increase/models/file_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Files#retrieve
+    class FileRetrieveParams < 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/group.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Groups#retrieve
+    class Group < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The Group identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute ach_debit_status
+      #   If the Group is allowed to create ACH debits.
+      #
+      #   @return [Symbol, Increase::Models::Group::ACHDebitStatus]
+      required :ach_debit_status, enum: -> { Increase::Group::ACHDebitStatus }
+
+      # @!attribute activation_status
+      #   If the Group is activated or not.
+      #
+      #   @return [Symbol, Increase::Models::Group::ActivationStatus]
+      required :activation_status, enum: -> { Increase::Group::ActivationStatus }
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Group
+      #   was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `group`.
+      #
+      #   @return [Symbol, Increase::Models::Group::Type]
+      required :type, enum: -> { Increase::Group::Type }
+
+      # @!method initialize(id:, ach_debit_status:, activation_status:, created_at:, type:)
+      #   Some parameter documentations has been truncated, see {Increase::Models::Group}
+      #   for more details.
+      #
+      #   Groups represent organizations using Increase. You can retrieve information
+      #   about your own organization via the API. More commonly, OAuth platforms can
+      #   retrieve information about the organizations that have granted them access.
+      #   Learn more about OAuth [here](https://increase.com/documentation/oauth).
+      #
+      #   @param id [String] The Group identifier.
+      #
+      #   @param ach_debit_status [Symbol, Increase::Models::Group::ACHDebitStatus] If the Group is allowed to create ACH debits.
+      #
+      #   @param activation_status [Symbol, Increase::Models::Group::ActivationStatus] If the Group is activated or not.
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Group w
+      #
+      #   @param type [Symbol, Increase::Models::Group::Type] A constant representing the object's type. For this resource it will always be `
+
+      # If the Group is allowed to create ACH debits.
+      #
+      # @see Increase::Models::Group#ach_debit_status
+      module ACHDebitStatus
+        extend Increase::Internal::Type::Enum
+
+        # The Group cannot make ACH debits.
+        DISABLED = :disabled
+
+        # The Group can make ACH debits.
+        ENABLED = :enabled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # If the Group is activated or not.
+      #
+      # @see Increase::Models::Group#activation_status
+      module ActivationStatus
+        extend Increase::Internal::Type::Enum
+
+        # The Group is not activated.
+        UNACTIVATED = :unactivated
+
+        # The Group is activated.
+        ACTIVATED = :activated
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `group`.
+      #
+      # @see Increase::Models::Group#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        GROUP = :group
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/group_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Groups#retrieve
+    class GroupRetrieveParams < 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