increase 0.3.2 → 1.0.0

data/lib/increase/models/intrafi_exclusion.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::IntrafiExclusions#create
+    class IntrafiExclusion < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The identifier of this exclusion request.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute bank_name
+      #   The name of the excluded institution.
+      #
+      #   @return [String]
+      required :bank_name, String
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #   the exclusion was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute entity_id
+      #   The entity for which this institution is excluded.
+      #
+      #   @return [String]
+      required :entity_id, String
+
+      # @!attribute excluded_at
+      #   When this was exclusion was confirmed by IntraFi.
+      #
+      #   @return [Time, nil]
+      required :excluded_at, Time, nil?: true
+
+      # @!attribute fdic_certificate_number
+      #   The Federal Deposit Insurance Corporation's certificate number for the
+      #   institution.
+      #
+      #   @return [String, nil]
+      required :fdic_certificate_number, 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 status
+      #   The status of the exclusion request.
+      #
+      #   @return [Symbol, Increase::Models::IntrafiExclusion::Status]
+      required :status, enum: -> { Increase::IntrafiExclusion::Status }
+
+      # @!attribute submitted_at
+      #   When this was exclusion was submitted to IntraFi by Increase.
+      #
+      #   @return [Time, nil]
+      required :submitted_at, Time, nil?: true
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `intrafi_exclusion`.
+      #
+      #   @return [Symbol, Increase::Models::IntrafiExclusion::Type]
+      required :type, enum: -> { Increase::IntrafiExclusion::Type }
+
+      # @!method initialize(id:, bank_name:, created_at:, entity_id:, excluded_at:, fdic_certificate_number:, idempotency_key:, status:, submitted_at:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::IntrafiExclusion} for more details.
+      #
+      #   Certain institutions may be excluded per Entity when sweeping funds into the
+      #   IntraFi network. This is useful when an Entity already has deposits at a
+      #   particular bank, and does not want to sweep additional funds to it. It may take
+      #   5 business days for an exclusion to be processed.
+      #
+      #   @param id [String] The identifier of this exclusion request.
+      #
+      #   @param bank_name [String] The name of the excluded institution.
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+      #
+      #   @param entity_id [String] The entity for which this institution is excluded.
+      #
+      #   @param excluded_at [Time, nil] When this was exclusion was confirmed by IntraFi.
+      #
+      #   @param fdic_certificate_number [String, nil] The Federal Deposit Insurance Corporation's certificate number for the instituti
+      #
+      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
+      #
+      #   @param status [Symbol, Increase::Models::IntrafiExclusion::Status] The status of the exclusion request.
+      #
+      #   @param submitted_at [Time, nil] When this was exclusion was submitted to IntraFi by Increase.
+      #
+      #   @param type [Symbol, Increase::Models::IntrafiExclusion::Type] A constant representing the object's type. For this resource it will always be `
+
+      # The status of the exclusion request.
+      #
+      # @see Increase::Models::IntrafiExclusion#status
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # The exclusion is being added to the IntraFi network.
+        PENDING = :pending
+
+        # The exclusion has been added to the IntraFi network.
+        COMPLETED = :completed
+
+        # The exclusion has been removed from the IntraFi network.
+        ARCHIVED = :archived
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `intrafi_exclusion`.
+      #
+      # @see Increase::Models::IntrafiExclusion#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        INTRAFI_EXCLUSION = :intrafi_exclusion
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/intrafi_exclusion_archive_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::IntrafiExclusions#archive
+    class IntrafiExclusionArchiveParams < 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/intrafi_exclusion_create_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::IntrafiExclusions#create
+    class IntrafiExclusionCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute bank_name
+      #   The name of the financial institution to be excluded.
+      #
+      #   @return [String]
+      required :bank_name, String
+
+      # @!attribute entity_id
+      #   The identifier of the Entity whose deposits will be excluded.
+      #
+      #   @return [String]
+      required :entity_id, String
+
+      # @!method initialize(bank_name:, entity_id:, request_options: {})
+      #   @param bank_name [String] The name of the financial institution to be excluded.
+      #
+      #   @param entity_id [String] The identifier of the Entity whose deposits will be excluded.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/intrafi_exclusion_list_params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::IntrafiExclusions#list
+    class IntrafiExclusionListParams < 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 entity_id
+      #   Filter IntraFi Exclusions for those belonging to the specified Entity.
+      #
+      #   @return [String, nil]
+      optional :entity_id, 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
+
+      # @!method initialize(cursor: nil, entity_id: nil, idempotency_key: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::IntrafiExclusionListParams} for more details.
+      #
+      #   @param cursor [String] Return the page of entries after this one.
+      #
+      #   @param entity_id [String] Filter IntraFi Exclusions for those belonging to the specified Entity.
+      #
+      #   @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 request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/intrafi_exclusion_retrieve_params.rb

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

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Lockboxes#create
+    class Lockbox < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The Lockbox identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_id
+      #   The identifier for the Account checks sent to this lockbox will be deposited
+      #   into.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute address
+      #   The mailing address for the Lockbox.
+      #
+      #   @return [Increase::Models::Lockbox::Address]
+      required :address, -> { Increase::Lockbox::Address }
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
+      #   was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute description
+      #   The description you choose for the Lockbox.
+      #
+      #   @return [String, nil]
+      required :description, 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 recipient_name
+      #   The recipient name you choose for the Lockbox.
+      #
+      #   @return [String, nil]
+      required :recipient_name, String, nil?: true
+
+      # @!attribute status
+      #   This indicates if mail can be sent to this address.
+      #
+      #   @return [Symbol, Increase::Models::Lockbox::Status]
+      required :status, enum: -> { Increase::Lockbox::Status }
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `lockbox`.
+      #
+      #   @return [Symbol, Increase::Models::Lockbox::Type]
+      required :type, enum: -> { Increase::Lockbox::Type }
+
+      # @!method initialize(id:, account_id:, address:, created_at:, description:, idempotency_key:, recipient_name:, status:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::Lockbox} for more details.
+      #
+      #   Lockboxes are physical locations that can receive mail containing paper checks.
+      #   Increase will automatically create a Check Deposit for checks received this way.
+      #
+      #   @param id [String] The Lockbox identifier.
+      #
+      #   @param account_id [String] The identifier for the Account checks sent to this lockbox will be deposited int
+      #
+      #   @param address [Increase::Models::Lockbox::Address] The mailing address for the Lockbox.
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
+      #
+      #   @param description [String, nil] The description you choose for the Lockbox.
+      #
+      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
+      #
+      #   @param recipient_name [String, nil] The recipient name you choose for the Lockbox.
+      #
+      #   @param status [Symbol, Increase::Models::Lockbox::Status] This indicates if mail can be sent to this address.
+      #
+      #   @param type [Symbol, Increase::Models::Lockbox::Type] A constant representing the object's type. For this resource it will always be `
+
+      # @see Increase::Models::Lockbox#address
+      class Address < Increase::Internal::Type::BaseModel
+        # @!attribute city
+        #   The city of the address.
+        #
+        #   @return [String]
+        required :city, String
+
+        # @!attribute line1
+        #   The first line of the address.
+        #
+        #   @return [String]
+        required :line1, String
+
+        # @!attribute line2
+        #   The second line of the address.
+        #
+        #   @return [String]
+        required :line2, String
+
+        # @!attribute postal_code
+        #   The postal code of the address.
+        #
+        #   @return [String]
+        required :postal_code, String
+
+        # @!attribute recipient
+        #   The recipient line of the address. This will include the recipient name you
+        #   provide when creating the address, as well as an ATTN suffix to help route the
+        #   mail to your lockbox. Mail senders must include this ATTN line to receive mail
+        #   at this Lockbox.
+        #
+        #   @return [String, nil]
+        required :recipient, String, nil?: true
+
+        # @!attribute state
+        #   The two-letter United States Postal Service (USPS) abbreviation for the state of
+        #   the address.
+        #
+        #   @return [String]
+        required :state, String
+
+        # @!method initialize(city:, line1:, line2:, postal_code:, recipient:, state:)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::Lockbox::Address} for more details.
+        #
+        #   The mailing address for the Lockbox.
+        #
+        #   @param city [String] The city of the address.
+        #
+        #   @param line1 [String] The first line of the address.
+        #
+        #   @param line2 [String] The second line of the address.
+        #
+        #   @param postal_code [String] The postal code of the address.
+        #
+        #   @param recipient [String, nil] The recipient line of the address. This will include the recipient name you prov
+        #
+        #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
+      end
+
+      # This indicates if mail can be sent to this address.
+      #
+      # @see Increase::Models::Lockbox#status
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # This Lockbox is active. Checks mailed to it will be deposited automatically.
+        ACTIVE = :active
+
+        # This Lockbox is inactive. Checks mailed to it will not be deposited.
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `lockbox`.
+      #
+      # @see Increase::Models::Lockbox#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        LOCKBOX = :lockbox
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/lockbox_create_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Lockboxes#create
+    class LockboxCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   The Account checks sent to this Lockbox should be deposited into.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute description
+      #   The description you choose for the Lockbox, for display purposes.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute recipient_name
+      #   The name of the recipient that will receive mail at this location.
+      #
+      #   @return [String, nil]
+      optional :recipient_name, String
+
+      # @!method initialize(account_id:, description: nil, recipient_name: nil, request_options: {})
+      #   @param account_id [String] The Account checks sent to this Lockbox should be deposited into.
+      #
+      #   @param description [String] The description you choose for the Lockbox, for display purposes.
+      #
+      #   @param recipient_name [String] The name of the recipient that will receive mail at this location.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/lockbox_list_params.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Lockboxes#list
+    class LockboxListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   Filter Lockboxes to those associated with the provided Account.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Increase::Models::LockboxListParams::CreatedAt, nil]
+      optional :created_at, -> { Increase::LockboxListParams::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
+
+      # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::LockboxListParams} for more details.
+      #
+      #   @param account_id [String] Filter Lockboxes to those associated with the provided Account.
+      #
+      #   @param created_at [Increase::Models::LockboxListParams::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 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::LockboxListParams::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
+    end
+  end
+end

data/lib/increase/models/lockbox_retrieve_params.rb

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Lockboxes#update
+    class LockboxUpdateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute description
+      #   The description you choose for the Lockbox.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute recipient_name
+      #   The recipient name you choose for the Lockbox.
+      #
+      #   @return [String, nil]
+      optional :recipient_name, String
+
+      # @!attribute status
+      #   This indicates if checks can be sent to the Lockbox.
+      #
+      #   @return [Symbol, Increase::Models::LockboxUpdateParams::Status, nil]
+      optional :status, enum: -> { Increase::LockboxUpdateParams::Status }
+
+      # @!method initialize(description: nil, recipient_name: nil, status: nil, request_options: {})
+      #   @param description [String] The description you choose for the Lockbox.
+      #
+      #   @param recipient_name [String] The recipient name you choose for the Lockbox.
+      #
+      #   @param status [Symbol, Increase::Models::LockboxUpdateParams::Status] This indicates if checks can be sent to the Lockbox.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      # This indicates if checks can be sent to the Lockbox.
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # This Lockbox is active. Checks mailed to it will be deposited automatically.
+        ACTIVE = :active
+
+        # This Lockbox is inactive. Checks mailed to it will not be deposited.
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end