increase 1.363.0 → 1.364.0

data/sig/increase/models/checkbook.rbs

@@ -0,0 +1,272 @@
+module Increase
+  module Models
+    type checkbook =
+      {
+        id: String,
+        account_number_id: String,
+        created_at: Time,
+        idempotency_key: String?,
+        mailing_address: Increase::Checkbook::MailingAddress,
+        payer: ::Array[Increase::Checkbook::Payer],
+        return_address: Increase::Checkbook::ReturnAddress,
+        status: Increase::Models::Checkbook::status,
+        style: Increase::Models::Checkbook::style,
+        tracking_updates: ::Array[Increase::Checkbook::TrackingUpdate],
+        type: Increase::Models::Checkbook::type_
+      }
+
+    class Checkbook < Increase::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor account_number_id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor idempotency_key: String?
+
+      attr_accessor mailing_address: Increase::Checkbook::MailingAddress
+
+      attr_accessor payer: ::Array[Increase::Checkbook::Payer]
+
+      attr_accessor return_address: Increase::Checkbook::ReturnAddress
+
+      attr_accessor status: Increase::Models::Checkbook::status
+
+      attr_accessor style: Increase::Models::Checkbook::style
+
+      attr_accessor tracking_updates: ::Array[Increase::Checkbook::TrackingUpdate]
+
+      attr_accessor type: Increase::Models::Checkbook::type_
+
+      def initialize: (
+        id: String,
+        account_number_id: String,
+        created_at: Time,
+        idempotency_key: String?,
+        mailing_address: Increase::Checkbook::MailingAddress,
+        payer: ::Array[Increase::Checkbook::Payer],
+        return_address: Increase::Checkbook::ReturnAddress,
+        status: Increase::Models::Checkbook::status,
+        style: Increase::Models::Checkbook::style,
+        tracking_updates: ::Array[Increase::Checkbook::TrackingUpdate],
+        type: Increase::Models::Checkbook::type_
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        account_number_id: String,
+        created_at: Time,
+        idempotency_key: String?,
+        mailing_address: Increase::Checkbook::MailingAddress,
+        payer: ::Array[Increase::Checkbook::Payer],
+        return_address: Increase::Checkbook::ReturnAddress,
+        status: Increase::Models::Checkbook::status,
+        style: Increase::Models::Checkbook::style,
+        tracking_updates: ::Array[Increase::Checkbook::TrackingUpdate],
+        type: Increase::Models::Checkbook::type_
+      }
+
+      type mailing_address =
+        {
+          city: String,
+          :line1 => String,
+          :line2 => String?,
+          name: String,
+          postal_code: String,
+          state: String
+        }
+
+      class MailingAddress < Increase::Internal::Type::BaseModel
+        attr_accessor city: String
+
+        attr_accessor line1: String
+
+        attr_accessor line2: String?
+
+        attr_accessor name: String
+
+        attr_accessor postal_code: String
+
+        attr_accessor state: String
+
+        def initialize: (
+          city: String,
+          line1: String,
+          line2: String?,
+          name: String,
+          postal_code: String,
+          state: String
+        ) -> void
+
+        def to_hash: -> {
+          city: String,
+          :line1 => String,
+          :line2 => String?,
+          name: String,
+          postal_code: String,
+          state: String
+        }
+      end
+
+      type payer = { contents: String }
+
+      class Payer < Increase::Internal::Type::BaseModel
+        attr_accessor contents: String
+
+        def initialize: (contents: String) -> void
+
+        def to_hash: -> { contents: String }
+      end
+
+      type return_address =
+        {
+          city: String,
+          :line1 => String,
+          :line2 => String?,
+          name: String,
+          postal_code: String,
+          state: String
+        }
+
+      class ReturnAddress < Increase::Internal::Type::BaseModel
+        attr_accessor city: String
+
+        attr_accessor line1: String
+
+        attr_accessor line2: String?
+
+        attr_accessor name: String
+
+        attr_accessor postal_code: String
+
+        attr_accessor state: String
+
+        def initialize: (
+          city: String,
+          line1: String,
+          line2: String?,
+          name: String,
+          postal_code: String,
+          state: String
+        ) -> void
+
+        def to_hash: -> {
+          city: String,
+          :line1 => String,
+          :line2 => String?,
+          name: String,
+          postal_code: String,
+          state: String
+        }
+      end
+
+      type status = :pending_submission | :pending_mailing | :mailed | :stopped
+
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # The Checkbook is pending submission to the printer.
+        PENDING_SUBMISSION: :pending_submission
+
+        # The Checkbook has been submitted to the printer and is pending mailing.
+        PENDING_MAILING: :pending_mailing
+
+        # The Checkbook has been mailed.
+        MAILED: :mailed
+
+        # The Checkbook has been stopped and its checks can no longer be deposited.
+        STOPPED: :stopped
+
+        def self?.values: -> ::Array[Increase::Models::Checkbook::status]
+      end
+
+      type style = :three_ring_binder | :folder
+
+      module Style
+        extend Increase::Internal::Type::Enum
+
+        # A half-inch three-ring binder holding 75 pages of checks with 3 checks per page.
+        THREE_RING_BINDER: :three_ring_binder
+
+        # A folder holding 15 pages of checks with 3 checks per page.
+        FOLDER: :folder
+
+        def self?.values: -> ::Array[Increase::Models::Checkbook::style]
+      end
+
+      type tracking_update =
+        {
+          category: Increase::Models::Checkbook::TrackingUpdate::category,
+          country: String,
+          created_at: Time,
+          postal_code: String
+        }
+
+      class TrackingUpdate < Increase::Internal::Type::BaseModel
+        attr_accessor category: Increase::Models::Checkbook::TrackingUpdate::category
+
+        attr_accessor country: String
+
+        attr_accessor created_at: Time
+
+        attr_accessor postal_code: String
+
+        def initialize: (
+          category: Increase::Models::Checkbook::TrackingUpdate::category,
+          country: String,
+          created_at: Time,
+          postal_code: String
+        ) -> void
+
+        def to_hash: -> {
+          category: Increase::Models::Checkbook::TrackingUpdate::category,
+          country: String,
+          created_at: Time,
+          postal_code: String
+        }
+
+        type category =
+          :in_transit
+          | :processed_for_delivery
+          | :delivered
+          | :delivery_issue
+          | :returning_to_sender
+          | :returned_to_sender
+
+        module Category
+          extend Increase::Internal::Type::Enum
+
+          # The checkbook is in transit.
+          IN_TRANSIT: :in_transit
+
+          # The checkbook has been processed for delivery.
+          PROCESSED_FOR_DELIVERY: :processed_for_delivery
+
+          # The checkbook has been delivered. Note that some couriers track delivery status based on driver location data rather than an explicit scan. While uncommon, a single checkbook may have more than one delivered event.
+          DELIVERED: :delivered
+
+          # There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the checkbook will be rerouted to the return address.
+          DELIVERY_ISSUE: :delivery_issue
+
+          # The checkbook has been rerouted to the return address.
+          RETURNING_TO_SENDER: :returning_to_sender
+
+          # The checkbook has been delivered to the return address.
+          RETURNED_TO_SENDER: :returned_to_sender
+
+          def self?.values: -> ::Array[Increase::Models::Checkbook::TrackingUpdate::category]
+        end
+      end
+
+      type type_ = :checkbook
+
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        CHECKBOOK: :checkbook
+
+        def self?.values: -> ::Array[Increase::Models::Checkbook::type_]
+      end
+    end
+  end
+end

data/sig/increase/models/checkbook_check.rbs

@@ -0,0 +1,76 @@
+module Increase
+  module Models
+    type checkbook_check =
+      {
+        id: String,
+        check_number: Integer,
+        checkbook_id: String,
+        created_at: Time,
+        status: Increase::Models::CheckbookCheck::status,
+        type: Increase::Models::CheckbookCheck::type_
+      }
+
+    class CheckbookCheck < Increase::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor check_number: Integer
+
+      attr_accessor checkbook_id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor status: Increase::Models::CheckbookCheck::status
+
+      attr_accessor type: Increase::Models::CheckbookCheck::type_
+
+      def initialize: (
+        id: String,
+        check_number: Integer,
+        checkbook_id: String,
+        created_at: Time,
+        status: Increase::Models::CheckbookCheck::status,
+        type: Increase::Models::CheckbookCheck::type_
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        check_number: Integer,
+        checkbook_id: String,
+        created_at: Time,
+        status: Increase::Models::CheckbookCheck::status,
+        type: Increase::Models::CheckbookCheck::type_
+      }
+
+      type status =
+        :pending_deposit | :deposited | :stopped | :requires_attention
+
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # The check has not yet been deposited.
+        PENDING_DEPOSIT: :pending_deposit
+
+        # The check has been deposited.
+        DEPOSITED: :deposited
+
+        # The check has been stopped and can no longer be deposited.
+        STOPPED: :stopped
+
+        # The check requires attention from an Increase operator.
+        REQUIRES_ATTENTION: :requires_attention
+
+        def self?.values: -> ::Array[Increase::Models::CheckbookCheck::status]
+      end
+
+      type type_ = :checkbook_check
+
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        CHECKBOOK_CHECK: :checkbook_check
+
+        def self?.values: -> ::Array[Increase::Models::CheckbookCheck::type_]
+      end
+    end
+  end
+end

data/sig/increase/models/checkbook_check_list_params.rbs

@@ -0,0 +1,56 @@
+module Increase
+  module Models
+    type checkbook_check_list_params =
+      {
+        account_number_id: String,
+        check_number: Integer,
+        checkbook_id: String,
+        cursor: String,
+        limit: Integer
+      }
+      & Increase::Internal::Type::request_parameters
+
+    class CheckbookCheckListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_reader account_number_id: String?
+
+      def account_number_id=: (String) -> String
+
+      attr_reader check_number: Integer?
+
+      def check_number=: (Integer) -> Integer
+
+      attr_reader checkbook_id: String?
+
+      def checkbook_id=: (String) -> String
+
+      attr_reader cursor: String?
+
+      def cursor=: (String) -> String
+
+      attr_reader limit: Integer?
+
+      def limit=: (Integer) -> Integer
+
+      def initialize: (
+        ?account_number_id: String,
+        ?check_number: Integer,
+        ?checkbook_id: String,
+        ?cursor: String,
+        ?limit: Integer,
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        account_number_id: String,
+        check_number: Integer,
+        checkbook_id: String,
+        cursor: String,
+        limit: Integer,
+        request_options: Increase::RequestOptions
+      }
+    end
+  end
+end

data/sig/increase/models/checkbook_check_retrieve_params.rbs

@@ -0,0 +1,24 @@
+module Increase
+  module Models
+    type checkbook_check_retrieve_params =
+      { checkbook_check_id: String }
+      & Increase::Internal::Type::request_parameters
+
+    class CheckbookCheckRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_accessor checkbook_check_id: String
+
+      def initialize: (
+        checkbook_check_id: String,
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        checkbook_check_id: String,
+        request_options: Increase::RequestOptions
+      }
+    end
+  end
+end

data/sig/increase/models/checkbook_check_stop_params.rbs

@@ -0,0 +1,24 @@
+module Increase
+  module Models
+    type checkbook_check_stop_params =
+      { checkbook_check_id: String }
+      & Increase::Internal::Type::request_parameters
+
+    class CheckbookCheckStopParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_accessor checkbook_check_id: String
+
+      def initialize: (
+        checkbook_check_id: String,
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        checkbook_check_id: String,
+        request_options: Increase::RequestOptions
+      }
+    end
+  end
+end

data/sig/increase/models/checkbook_create_params.rbs

@@ -0,0 +1,90 @@
+module Increase
+  module Models
+    type checkbook_create_params =
+      {
+        account_number_id: String,
+        mailing_address: Increase::CheckbookCreateParams::MailingAddress,
+        payer: ::Array[Increase::CheckbookCreateParams::Payer]
+      }
+      & Increase::Internal::Type::request_parameters
+
+    class CheckbookCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_accessor account_number_id: String
+
+      attr_accessor mailing_address: Increase::CheckbookCreateParams::MailingAddress
+
+      attr_accessor payer: ::Array[Increase::CheckbookCreateParams::Payer]
+
+      def initialize: (
+        account_number_id: String,
+        mailing_address: Increase::CheckbookCreateParams::MailingAddress,
+        payer: ::Array[Increase::CheckbookCreateParams::Payer],
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        account_number_id: String,
+        mailing_address: Increase::CheckbookCreateParams::MailingAddress,
+        payer: ::Array[Increase::CheckbookCreateParams::Payer],
+        request_options: Increase::RequestOptions
+      }
+
+      type mailing_address =
+        {
+          city: String,
+          :line1 => String,
+          name: String,
+          postal_code: String,
+          state: String,
+          :line2 => String
+        }
+
+      class MailingAddress < Increase::Internal::Type::BaseModel
+        attr_accessor city: String
+
+        attr_accessor line1: String
+
+        attr_accessor name: String
+
+        attr_accessor postal_code: String
+
+        attr_accessor state: String
+
+        attr_reader line2: String?
+
+        def line2=: (String) -> String
+
+        def initialize: (
+          city: String,
+          line1: String,
+          name: String,
+          postal_code: String,
+          state: String,
+          ?line2: String
+        ) -> void
+
+        def to_hash: -> {
+          city: String,
+          :line1 => String,
+          name: String,
+          postal_code: String,
+          state: String,
+          :line2 => String
+        }
+      end
+
+      type payer = { contents: String }
+
+      class Payer < Increase::Internal::Type::BaseModel
+        attr_accessor contents: String
+
+        def initialize: (contents: String) -> void
+
+        def to_hash: -> { contents: String }
+      end
+    end
+  end
+end

data/sig/increase/models/checkbook_list_params.rbs

@@ -0,0 +1,97 @@
+module Increase
+  module Models
+    type checkbook_list_params =
+      {
+        account_number_id: String,
+        cursor: String,
+        idempotency_key: String,
+        limit: Integer,
+        status: Increase::CheckbookListParams::Status
+      }
+      & Increase::Internal::Type::request_parameters
+
+    class CheckbookListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_reader account_number_id: String?
+
+      def account_number_id=: (String) -> String
+
+      attr_reader cursor: String?
+
+      def cursor=: (String) -> String
+
+      attr_reader idempotency_key: String?
+
+      def idempotency_key=: (String) -> String
+
+      attr_reader limit: Integer?
+
+      def limit=: (Integer) -> Integer
+
+      attr_reader status: Increase::CheckbookListParams::Status?
+
+      def status=: (
+        Increase::CheckbookListParams::Status
+      ) -> Increase::CheckbookListParams::Status
+
+      def initialize: (
+        ?account_number_id: String,
+        ?cursor: String,
+        ?idempotency_key: String,
+        ?limit: Integer,
+        ?status: Increase::CheckbookListParams::Status,
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        account_number_id: String,
+        cursor: String,
+        idempotency_key: String,
+        limit: Integer,
+        status: Increase::CheckbookListParams::Status,
+        request_options: Increase::RequestOptions
+      }
+
+      type status =
+        { in_: ::Array[Increase::Models::CheckbookListParams::Status::in_] }
+
+      class Status < Increase::Internal::Type::BaseModel
+        attr_reader in_: ::Array[Increase::Models::CheckbookListParams::Status::in_]?
+
+        def in_=: (
+          ::Array[Increase::Models::CheckbookListParams::Status::in_]
+        ) -> ::Array[Increase::Models::CheckbookListParams::Status::in_]
+
+        def initialize: (
+          ?in_: ::Array[Increase::Models::CheckbookListParams::Status::in_]
+        ) -> void
+
+        def to_hash: -> {
+          in_: ::Array[Increase::Models::CheckbookListParams::Status::in_]
+        }
+
+        type in_ = :pending_submission | :pending_mailing | :mailed | :stopped
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          # The Checkbook is pending submission to the printer.
+          PENDING_SUBMISSION: :pending_submission
+
+          # The Checkbook has been submitted to the printer and is pending mailing.
+          PENDING_MAILING: :pending_mailing
+
+          # The Checkbook has been mailed.
+          MAILED: :mailed
+
+          # The Checkbook has been stopped and its checks can no longer be deposited.
+          STOPPED: :stopped
+
+          def self?.values: -> ::Array[Increase::Models::CheckbookListParams::Status::in_]
+        end
+      end
+    end
+  end
+end

data/sig/increase/models/checkbook_retrieve_params.rbs

@@ -0,0 +1,23 @@
+module Increase
+  module Models
+    type checkbook_retrieve_params =
+      { checkbook_id: String } & Increase::Internal::Type::request_parameters
+
+    class CheckbookRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_accessor checkbook_id: String
+
+      def initialize: (
+        checkbook_id: String,
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        checkbook_id: String,
+        request_options: Increase::RequestOptions
+      }
+    end
+  end
+end

data/sig/increase/models/checkbook_stop_params.rbs

@@ -0,0 +1,23 @@
+module Increase
+  module Models
+    type checkbook_stop_params =
+      { checkbook_id: String } & Increase::Internal::Type::request_parameters
+
+    class CheckbookStopParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_accessor checkbook_id: String
+
+      def initialize: (
+        checkbook_id: String,
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        checkbook_id: String,
+        request_options: Increase::RequestOptions
+      }
+    end
+  end
+end