increase 0.3.2 → 1.0.0

data/lib/increase/models/check_transfer_approve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CheckTransfers#approve
+    class CheckTransferApproveParams < 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/check_transfer_cancel_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CheckTransfers#cancel
+    class CheckTransferCancelParams < 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/check_transfer_create_params.rb

@@ -0,0 +1,324 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CheckTransfers#create
+    class CheckTransferCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   The identifier for the account that will send the transfer.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute amount
+      #   The transfer amount in USD cents.
+      #
+      #   @return [Integer]
+      required :amount, Integer
+
+      # @!attribute fulfillment_method
+      #   Whether Increase will print and mail the check or if you will do it yourself.
+      #
+      #   @return [Symbol, Increase::Models::CheckTransferCreateParams::FulfillmentMethod]
+      required :fulfillment_method, enum: -> { Increase::CheckTransferCreateParams::FulfillmentMethod }
+
+      # @!attribute source_account_number_id
+      #   The identifier of the Account Number from which to send the transfer and print
+      #   on the check.
+      #
+      #   @return [String]
+      required :source_account_number_id, String
+
+      # @!attribute check_number
+      #   The check number Increase should use for the check. This should not contain
+      #   leading zeroes and must be unique across the `source_account_number`. If this is
+      #   omitted, Increase will generate a check number for you.
+      #
+      #   @return [String, nil]
+      optional :check_number, String
+
+      # @!attribute physical_check
+      #   Details relating to the physical check that Increase will print and mail. This
+      #   is required if `fulfillment_method` is equal to `physical_check`. It must not be
+      #   included if any other `fulfillment_method` is provided.
+      #
+      #   @return [Increase::Models::CheckTransferCreateParams::PhysicalCheck, nil]
+      optional :physical_check, -> { Increase::CheckTransferCreateParams::PhysicalCheck }
+
+      # @!attribute require_approval
+      #   Whether the transfer requires explicit approval via the dashboard or API.
+      #
+      #   @return [Boolean, nil]
+      optional :require_approval, Increase::Internal::Type::Boolean
+
+      # @!attribute third_party
+      #   Details relating to the custom fulfillment you will perform. This is required if
+      #   `fulfillment_method` is equal to `third_party`. It must not be included if any
+      #   other `fulfillment_method` is provided.
+      #
+      #   @return [Increase::Models::CheckTransferCreateParams::ThirdParty, nil]
+      optional :third_party, -> { Increase::CheckTransferCreateParams::ThirdParty }
+
+      # @!method initialize(account_id:, amount:, fulfillment_method:, source_account_number_id:, check_number: nil, physical_check: nil, require_approval: nil, third_party: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::CheckTransferCreateParams} for more details.
+      #
+      #   @param account_id [String] The identifier for the account that will send the transfer.
+      #
+      #   @param amount [Integer] The transfer amount in USD cents.
+      #
+      #   @param fulfillment_method [Symbol, Increase::Models::CheckTransferCreateParams::FulfillmentMethod] Whether Increase will print and mail the check or if you will do it yourself.
+      #
+      #   @param source_account_number_id [String] The identifier of the Account Number from which to send the transfer and print o
+      #
+      #   @param check_number [String] The check number Increase should use for the check. This should not contain lead
+      #
+      #   @param physical_check [Increase::Models::CheckTransferCreateParams::PhysicalCheck] Details relating to the physical check that Increase will print and mail. This i
+      #
+      #   @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
+      #
+      #   @param third_party [Increase::Models::CheckTransferCreateParams::ThirdParty] Details relating to the custom fulfillment you will perform. This is required if
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      # Whether Increase will print and mail the check or if you will do it yourself.
+      module FulfillmentMethod
+        extend Increase::Internal::Type::Enum
+
+        # Increase will print and mail a physical check.
+        PHYSICAL_CHECK = :physical_check
+
+        # Increase will not print a check; you are responsible for printing and mailing a check with the provided account number, routing number, check number, and amount.
+        THIRD_PARTY = :third_party
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class PhysicalCheck < Increase::Internal::Type::BaseModel
+        # @!attribute mailing_address
+        #   Details for where Increase will mail the check.
+        #
+        #   @return [Increase::Models::CheckTransferCreateParams::PhysicalCheck::MailingAddress]
+        required :mailing_address, -> { Increase::CheckTransferCreateParams::PhysicalCheck::MailingAddress }
+
+        # @!attribute memo
+        #   The descriptor that will be printed on the memo field on the check.
+        #
+        #   @return [String]
+        required :memo, String
+
+        # @!attribute recipient_name
+        #   The name that will be printed on the check in the 'To:' field.
+        #
+        #   @return [String]
+        required :recipient_name, String
+
+        # @!attribute attachment_file_id
+        #   The ID of a File to be attached to the check. This must have
+        #   `purpose: check_attachment`. For details on pricing and restrictions, see
+        #   https://increase.com/documentation/originating-checks#printing-checks .
+        #
+        #   @return [String, nil]
+        optional :attachment_file_id, String
+
+        # @!attribute note
+        #   The descriptor that will be printed on the letter included with the check.
+        #
+        #   @return [String, nil]
+        optional :note, String
+
+        # @!attribute return_address
+        #   The return address to be printed on the check. If omitted this will default to
+        #   an Increase-owned address that will mark checks as delivery failed and shred
+        #   them.
+        #
+        #   @return [Increase::Models::CheckTransferCreateParams::PhysicalCheck::ReturnAddress, nil]
+        optional :return_address, -> { Increase::CheckTransferCreateParams::PhysicalCheck::ReturnAddress }
+
+        # @!attribute shipping_method
+        #   How to ship the check. For details on pricing, timing, and restrictions, see
+        #   https://increase.com/documentation/originating-checks#printing-checks .
+        #
+        #   @return [Symbol, Increase::Models::CheckTransferCreateParams::PhysicalCheck::ShippingMethod, nil]
+        optional :shipping_method,
+                 enum: -> {
+                   Increase::CheckTransferCreateParams::PhysicalCheck::ShippingMethod
+                 }
+
+        # @!attribute signature_text
+        #   The text that will appear as the signature on the check in cursive font. If not
+        #   provided, the check will be printed with 'No signature required'.
+        #
+        #   @return [String, nil]
+        optional :signature_text, String
+
+        # @!method initialize(mailing_address:, memo:, recipient_name:, attachment_file_id: nil, note: nil, return_address: nil, shipping_method: nil, signature_text: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::CheckTransferCreateParams::PhysicalCheck} for more details.
+        #
+        #   Details relating to the physical check that Increase will print and mail. This
+        #   is required if `fulfillment_method` is equal to `physical_check`. It must not be
+        #   included if any other `fulfillment_method` is provided.
+        #
+        #   @param mailing_address [Increase::Models::CheckTransferCreateParams::PhysicalCheck::MailingAddress] Details for where Increase will mail the check.
+        #
+        #   @param memo [String] The descriptor that will be printed on the memo field on the check.
+        #
+        #   @param recipient_name [String] The name that will be printed on the check in the 'To:' field.
+        #
+        #   @param attachment_file_id [String] The ID of a File to be attached to the check. This must have `purpose: check_att
+        #
+        #   @param note [String] The descriptor that will be printed on the letter included with the check.
+        #
+        #   @param return_address [Increase::Models::CheckTransferCreateParams::PhysicalCheck::ReturnAddress] The return address to be printed on the check. If omitted this will default to a
+        #
+        #   @param shipping_method [Symbol, Increase::Models::CheckTransferCreateParams::PhysicalCheck::ShippingMethod] How to ship the check. For details on pricing, timing, and restrictions, see htt
+        #
+        #   @param signature_text [String] The text that will appear as the signature on the check in cursive font. If not
+
+        # @see Increase::Models::CheckTransferCreateParams::PhysicalCheck#mailing_address
+        class MailingAddress < Increase::Internal::Type::BaseModel
+          # @!attribute city
+          #   The city component of the check's destination address.
+          #
+          #   @return [String]
+          required :city, String
+
+          # @!attribute line1
+          #   The first line of the address component of the check's destination address.
+          #
+          #   @return [String]
+          required :line1, String
+
+          # @!attribute postal_code
+          #   The postal code component of the check's destination address.
+          #
+          #   @return [String]
+          required :postal_code, String
+
+          # @!attribute state
+          #   The US state component of the check's destination address.
+          #
+          #   @return [String]
+          required :state, String
+
+          # @!attribute line2
+          #   The second line of the address component of the check's destination address.
+          #
+          #   @return [String, nil]
+          optional :line2, String
+
+          # @!method initialize(city:, line1:, postal_code:, state:, line2: nil)
+          #   Details for where Increase will mail the check.
+          #
+          #   @param city [String] The city component of the check's destination address.
+          #
+          #   @param line1 [String] The first line of the address component of the check's destination address.
+          #
+          #   @param postal_code [String] The postal code component of the check's destination address.
+          #
+          #   @param state [String] The US state component of the check's destination address.
+          #
+          #   @param line2 [String] The second line of the address component of the check's destination address.
+        end
+
+        # @see Increase::Models::CheckTransferCreateParams::PhysicalCheck#return_address
+        class ReturnAddress < Increase::Internal::Type::BaseModel
+          # @!attribute city
+          #   The city of the return address.
+          #
+          #   @return [String]
+          required :city, String
+
+          # @!attribute line1
+          #   The first line of the return address.
+          #
+          #   @return [String]
+          required :line1, String
+
+          # @!attribute name
+          #   The name of the return address.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute postal_code
+          #   The postal code of the return address.
+          #
+          #   @return [String]
+          required :postal_code, String
+
+          # @!attribute state
+          #   The US state of the return address.
+          #
+          #   @return [String]
+          required :state, String
+
+          # @!attribute line2
+          #   The second line of the return address.
+          #
+          #   @return [String, nil]
+          optional :line2, String
+
+          # @!method initialize(city:, line1:, name:, postal_code:, state:, line2: nil)
+          #   The return address to be printed on the check. If omitted this will default to
+          #   an Increase-owned address that will mark checks as delivery failed and shred
+          #   them.
+          #
+          #   @param city [String] The city of the return address.
+          #
+          #   @param line1 [String] The first line of the return address.
+          #
+          #   @param name [String] The name of the return address.
+          #
+          #   @param postal_code [String] The postal code of the return address.
+          #
+          #   @param state [String] The US state of the return address.
+          #
+          #   @param line2 [String] The second line of the return address.
+        end
+
+        # How to ship the check. For details on pricing, timing, and restrictions, see
+        # https://increase.com/documentation/originating-checks#printing-checks .
+        #
+        # @see Increase::Models::CheckTransferCreateParams::PhysicalCheck#shipping_method
+        module ShippingMethod
+          extend Increase::Internal::Type::Enum
+
+          # USPS First Class
+          USPS_FIRST_CLASS = :usps_first_class
+
+          # FedEx Overnight
+          FEDEX_OVERNIGHT = :fedex_overnight
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class ThirdParty < Increase::Internal::Type::BaseModel
+        # @!attribute recipient_name
+        #   The pay-to name you will print on the check. If provided, this is used for
+        #   [Positive Pay](/documentation/positive-pay). If this is omitted, Increase will
+        #   be unable to validate the payee name when the check is deposited.
+        #
+        #   @return [String, nil]
+        optional :recipient_name, String
+
+        # @!method initialize(recipient_name: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::CheckTransferCreateParams::ThirdParty} for more details.
+        #
+        #   Details relating to the custom fulfillment you will perform. This is required if
+        #   `fulfillment_method` is equal to `third_party`. It must not be included if any
+        #   other `fulfillment_method` is provided.
+        #
+        #   @param recipient_name [String] The pay-to name you will print on the check. If provided, this is used for [Posi
+      end
+    end
+  end
+end

data/lib/increase/models/check_transfer_list_params.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CheckTransfers#list
+    class CheckTransferListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   Filter Check Transfers to those that originated from the specified Account.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Increase::Models::CheckTransferListParams::CreatedAt, nil]
+      optional :created_at, -> { Increase::CheckTransferListParams::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 status
+      #
+      #   @return [Increase::Models::CheckTransferListParams::Status, nil]
+      optional :status, -> { Increase::CheckTransferListParams::Status }
+
+      # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::CheckTransferListParams} for more details.
+      #
+      #   @param account_id [String] Filter Check Transfers to those that originated from the specified Account.
+      #
+      #   @param created_at [Increase::Models::CheckTransferListParams::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 status [Increase::Models::CheckTransferListParams::Status]
+      #
+      #   @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::CheckTransferListParams::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 Status < Increase::Internal::Type::BaseModel
+        # @!attribute in_
+        #   Filter Check Transfers to those that have the specified status. For GET
+        #   requests, this should be encoded as a comma-delimited string, such as
+        #   `?in=one,two,three`.
+        #
+        #   @return [Array<Symbol, Increase::Models::CheckTransferListParams::Status::In>, nil]
+        optional :in_,
+                 -> {
+                   Increase::Internal::Type::ArrayOf[enum: Increase::CheckTransferListParams::Status::In]
+                 },
+                 api_name: :in
+
+        # @!method initialize(in_: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::CheckTransferListParams::Status} for more details.
+        #
+        #   @param in_ [Array<Symbol, Increase::Models::CheckTransferListParams::Status::In>] Filter Check Transfers to those that have the specified status. For GET requests
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          # The transfer is awaiting approval.
+          PENDING_APPROVAL = :pending_approval
+
+          # The transfer has been canceled.
+          CANCELED = :canceled
+
+          # The transfer is pending submission.
+          PENDING_SUBMISSION = :pending_submission
+
+          # The transfer requires attention from an Increase operator.
+          REQUIRES_ATTENTION = :requires_attention
+
+          # The transfer has been rejected.
+          REJECTED = :rejected
+
+          # The check is queued for mailing.
+          PENDING_MAILING = :pending_mailing
+
+          # The check has been mailed.
+          MAILED = :mailed
+
+          # The check has been deposited.
+          DEPOSITED = :deposited
+
+          # A stop-payment was requested for this check.
+          STOPPED = :stopped
+
+          # The transfer has been returned.
+          RETURNED = :returned
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/increase/models/check_transfer_retrieve_params.rb

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CheckTransfers#stop_payment
+    class CheckTransferStopPaymentParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute reason
+      #   The reason why this transfer should be stopped.
+      #
+      #   @return [Symbol, Increase::Models::CheckTransferStopPaymentParams::Reason, nil]
+      optional :reason, enum: -> { Increase::CheckTransferStopPaymentParams::Reason }
+
+      # @!method initialize(reason: nil, request_options: {})
+      #   @param reason [Symbol, Increase::Models::CheckTransferStopPaymentParams::Reason] The reason why this transfer should be stopped.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      # The reason why this transfer should be stopped.
+      module Reason
+        extend Increase::Internal::Type::Enum
+
+        # The check could not be delivered.
+        MAIL_DELIVERY_FAILED = :mail_delivery_failed
+
+        # The check was not authorized.
+        NOT_AUTHORIZED = :not_authorized
+
+        # The check was stopped for another reason.
+        UNKNOWN = :unknown
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end