increase 1.167.0 → 1.169.0

data/lib/increase/models/document.rb

@@ -1,160 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::Documents#create
-    class Document < Increase::Internal::Type::BaseModel
-      # @!attribute id
-      #   The Document identifier.
-      #
-      #   @return [String]
-      required :id, String
-
-      # @!attribute account_verification_letter
-      #   Properties of an account verification letter document.
-      #
-      #   @return [Increase::Models::Document::AccountVerificationLetter, nil]
-      required :account_verification_letter, -> { Increase::Document::AccountVerificationLetter }, nil?: true
-
-      # @!attribute category
-      #   The type of document.
-      #
-      #   @return [Symbol, Increase::Models::Document::Category]
-      required :category, enum: -> { Increase::Document::Category }
-
-      # @!attribute created_at
-      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
-      #   Document was created.
-      #
-      #   @return [Time]
-      required :created_at, Time
-
-      # @!attribute entity_id
-      #   The identifier of the Entity the document was generated for.
-      #
-      #   @return [String, nil]
-      required :entity_id, String, nil?: true
-
-      # @!attribute file_id
-      #   The identifier of the File containing the Document's contents.
-      #
-      #   @return [String]
-      required :file_id, String
-
-      # @!attribute funding_instructions
-      #   Properties of a funding instructions document.
-      #
-      #   @return [Increase::Models::Document::FundingInstructions, nil]
-      required :funding_instructions, -> { Increase::Document::FundingInstructions }, 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 type
-      #   A constant representing the object's type. For this resource it will always be
-      #   `document`.
-      #
-      #   @return [Symbol, Increase::Models::Document::Type]
-      required :type, enum: -> { Increase::Document::Type }
-
-      # @!method initialize(id:, account_verification_letter:, category:, created_at:, entity_id:, file_id:, funding_instructions:, idempotency_key:, type:)
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::Document} for more details.
-      #
-      #   Increase generates certain documents / forms automatically for your application;
-      #   they can be listed here.
-      #
-      #   @param id [String] The Document identifier.
-      #
-      #   @param account_verification_letter [Increase::Models::Document::AccountVerificationLetter, nil] Properties of an account verification letter document.
-      #
-      #   @param category [Symbol, Increase::Models::Document::Category] The type of document.
-      #
-      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Documen
-      #
-      #   @param entity_id [String, nil] The identifier of the Entity the document was generated for.
-      #
-      #   @param file_id [String] The identifier of the File containing the Document's contents.
-      #
-      #   @param funding_instructions [Increase::Models::Document::FundingInstructions, nil] Properties of a funding instructions document.
-      #
-      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
-      #
-      #   @param type [Symbol, Increase::Models::Document::Type] A constant representing the object's type. For this resource it will always be `
-
-      # @see Increase::Models::Document#account_verification_letter
-      class AccountVerificationLetter < Increase::Internal::Type::BaseModel
-        # @!attribute account_number_id
-        #   The identifier of the Account Number the document was generated for.
-        #
-        #   @return [String]
-        required :account_number_id, String
-
-        # @!method initialize(account_number_id:)
-        #   Properties of an account verification letter document.
-        #
-        #   @param account_number_id [String] The identifier of the Account Number the document was generated for.
-      end
-
-      # The type of document.
-      #
-      # @see Increase::Models::Document#category
-      module Category
-        extend Increase::Internal::Type::Enum
-
-        # Internal Revenue Service Form 1099-INT.
-        FORM_1099_INT = :form_1099_int
-
-        # Internal Revenue Service Form 1099-MISC.
-        FORM_1099_MISC = :form_1099_misc
-
-        # A document submitted in response to a proof of authorization request for an ACH transfer.
-        PROOF_OF_AUTHORIZATION = :proof_of_authorization
-
-        # Company information, such a policies or procedures, typically submitted during our due diligence process.
-        COMPANY_INFORMATION = :company_information
-
-        # An account verification letter.
-        ACCOUNT_VERIFICATION_LETTER = :account_verification_letter
-
-        # Funding instructions.
-        FUNDING_INSTRUCTIONS = :funding_instructions
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # @see Increase::Models::Document#funding_instructions
-      class FundingInstructions < Increase::Internal::Type::BaseModel
-        # @!attribute account_number_id
-        #   The identifier of the Account Number the document was generated for.
-        #
-        #   @return [String]
-        required :account_number_id, String
-
-        # @!method initialize(account_number_id:)
-        #   Properties of a funding instructions document.
-        #
-        #   @param account_number_id [String] The identifier of the Account Number the document was generated for.
-      end
-
-      # A constant representing the object's type. For this resource it will always be
-      # `document`.
-      #
-      # @see Increase::Models::Document#type
-      module Type
-        extend Increase::Internal::Type::Enum
-
-        DOCUMENT = :document
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/increase/models/document_create_params.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::Documents#create
-    class DocumentCreateParams < Increase::Internal::Type::BaseModel
-      extend Increase::Internal::Type::RequestParameters::Converter
-      include Increase::Internal::Type::RequestParameters
-
-      # @!attribute category
-      #   The type of document to create.
-      #
-      #   @return [Symbol, Increase::Models::DocumentCreateParams::Category]
-      required :category, enum: -> { Increase::DocumentCreateParams::Category }
-
-      # @!attribute account_verification_letter
-      #   An account verification letter. Required if and only if `category` is
-      #   `account_verification_letter`.
-      #
-      #   @return [Increase::Models::DocumentCreateParams::AccountVerificationLetter, nil]
-      optional :account_verification_letter, -> { Increase::DocumentCreateParams::AccountVerificationLetter }
-
-      # @!attribute funding_instructions
-      #   Funding instructions. Required if and only if `category` is
-      #   `funding_instructions`.
-      #
-      #   @return [Increase::Models::DocumentCreateParams::FundingInstructions, nil]
-      optional :funding_instructions, -> { Increase::DocumentCreateParams::FundingInstructions }
-
-      # @!method initialize(category:, account_verification_letter: nil, funding_instructions: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::DocumentCreateParams} for more details.
-      #
-      #   @param category [Symbol, Increase::Models::DocumentCreateParams::Category] The type of document to create.
-      #
-      #   @param account_verification_letter [Increase::Models::DocumentCreateParams::AccountVerificationLetter] An account verification letter. Required if and only if `category` is `account_v
-      #
-      #   @param funding_instructions [Increase::Models::DocumentCreateParams::FundingInstructions] Funding instructions. Required if and only if `category` is `funding_instruction
-      #
-      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
-
-      # The type of document to create.
-      module Category
-        extend Increase::Internal::Type::Enum
-
-        # An account verification letter.
-        ACCOUNT_VERIFICATION_LETTER = :account_verification_letter
-
-        # Funding instructions.
-        FUNDING_INSTRUCTIONS = :funding_instructions
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      class AccountVerificationLetter < Increase::Internal::Type::BaseModel
-        # @!attribute account_number_id
-        #   The Account Number the bank letter should be generated for.
-        #
-        #   @return [String]
-        required :account_number_id, String
-
-        # @!attribute balance_date
-        #   If provided, the letter will include the Account's balance as of the date.
-        #
-        #   @return [Date, nil]
-        optional :balance_date, Date
-
-        # @!method initialize(account_number_id:, balance_date: nil)
-        #   An account verification letter. Required if and only if `category` is
-        #   `account_verification_letter`.
-        #
-        #   @param account_number_id [String] The Account Number the bank letter should be generated for.
-        #
-        #   @param balance_date [Date] If provided, the letter will include the Account's balance as of the date.
-      end
-
-      class FundingInstructions < Increase::Internal::Type::BaseModel
-        # @!attribute account_number_id
-        #   The Account Number the funding instructions should be generated for.
-        #
-        #   @return [String]
-        required :account_number_id, String
-
-        # @!method initialize(account_number_id:)
-        #   Funding instructions. Required if and only if `category` is
-        #   `funding_instructions`.
-        #
-        #   @param account_number_id [String] The Account Number the funding instructions should be generated for.
-      end
-    end
-  end
-end

data/lib/increase/models/document_list_params.rb

@@ -1,152 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::Documents#list
-    class DocumentListParams < Increase::Internal::Type::BaseModel
-      extend Increase::Internal::Type::RequestParameters::Converter
-      include Increase::Internal::Type::RequestParameters
-
-      # @!attribute category
-      #
-      #   @return [Increase::Models::DocumentListParams::Category, nil]
-      optional :category, -> { Increase::DocumentListParams::Category }
-
-      # @!attribute created_at
-      #
-      #   @return [Increase::Models::DocumentListParams::CreatedAt, nil]
-      optional :created_at, -> { Increase::DocumentListParams::CreatedAt }
-
-      # @!attribute cursor
-      #   Return the page of entries after this one.
-      #
-      #   @return [String, nil]
-      optional :cursor, String
-
-      # @!attribute entity_id
-      #   Filter Documents to ones 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(category: nil, created_at: nil, cursor: nil, entity_id: nil, idempotency_key: nil, limit: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::DocumentListParams} for more details.
-      #
-      #   @param category [Increase::Models::DocumentListParams::Category]
-      #
-      #   @param created_at [Increase::Models::DocumentListParams::CreatedAt]
-      #
-      #   @param cursor [String] Return the page of entries after this one.
-      #
-      #   @param entity_id [String] Filter Documents to ones 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}]
-
-      class Category < Increase::Internal::Type::BaseModel
-        # @!attribute in_
-        #   Filter Documents for those with the specified category or categories. For GET
-        #   requests, this should be encoded as a comma-delimited string, such as
-        #   `?in=one,two,three`.
-        #
-        #   @return [Array<Symbol, Increase::Models::DocumentListParams::Category::In>, nil]
-        optional :in_,
-                 -> { Increase::Internal::Type::ArrayOf[enum: Increase::DocumentListParams::Category::In] },
-                 api_name: :in
-
-        # @!method initialize(in_: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::DocumentListParams::Category} for more details.
-        #
-        #   @param in_ [Array<Symbol, Increase::Models::DocumentListParams::Category::In>] Filter Documents for those with the specified category or categories. For GET re
-
-        module In
-          extend Increase::Internal::Type::Enum
-
-          # Internal Revenue Service Form 1099-INT.
-          FORM_1099_INT = :form_1099_int
-
-          # Internal Revenue Service Form 1099-MISC.
-          FORM_1099_MISC = :form_1099_misc
-
-          # A document submitted in response to a proof of authorization request for an ACH transfer.
-          PROOF_OF_AUTHORIZATION = :proof_of_authorization
-
-          # Company information, such a policies or procedures, typically submitted during our due diligence process.
-          COMPANY_INFORMATION = :company_information
-
-          # An account verification letter.
-          ACCOUNT_VERIFICATION_LETTER = :account_verification_letter
-
-          # Funding instructions.
-          FUNDING_INSTRUCTIONS = :funding_instructions
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
-      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::DocumentListParams::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/document_retrieve_params.rb

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

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    module Simulations
-      # @see Increase::Resources::Simulations::Documents#create
-      class DocumentCreateParams < Increase::Internal::Type::BaseModel
-        extend Increase::Internal::Type::RequestParameters::Converter
-        include Increase::Internal::Type::RequestParameters
-
-        # @!attribute account_id
-        #   The identifier of the Account the tax document is for.
-        #
-        #   @return [String]
-        required :account_id, String
-
-        # @!method initialize(account_id:, request_options: {})
-        #   @param account_id [String] The identifier of the Account the tax document is for.
-        #
-        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
-      end
-    end
-  end
-end

data/lib/increase/resources/documents.rb

@@ -1,99 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Resources
-    class Documents
-      # Some parameter documentations has been truncated, see
-      # {Increase::Models::DocumentCreateParams} for more details.
-      #
-      # Create a Document
-      #
-      # @overload create(category:, account_verification_letter: nil, funding_instructions: nil, request_options: {})
-      #
-      # @param category [Symbol, Increase::Models::DocumentCreateParams::Category] The type of document to create.
-      #
-      # @param account_verification_letter [Increase::Models::DocumentCreateParams::AccountVerificationLetter] An account verification letter. Required if and only if `category` is `account_v
-      #
-      # @param funding_instructions [Increase::Models::DocumentCreateParams::FundingInstructions] Funding instructions. Required if and only if `category` is `funding_instruction
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Models::Document]
-      #
-      # @see Increase::Models::DocumentCreateParams
-      def create(params)
-        parsed, options = Increase::DocumentCreateParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "documents",
-          body: parsed,
-          model: Increase::Document,
-          options: options
-        )
-      end
-
-      # Retrieve a Document
-      #
-      # @overload retrieve(document_id, request_options: {})
-      #
-      # @param document_id [String] The identifier of the Document to retrieve.
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Models::Document]
-      #
-      # @see Increase::Models::DocumentRetrieveParams
-      def retrieve(document_id, params = {})
-        @client.request(
-          method: :get,
-          path: ["documents/%1$s", document_id],
-          model: Increase::Document,
-          options: params[:request_options]
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {Increase::Models::DocumentListParams} for more details.
-      #
-      # List Documents
-      #
-      # @overload list(category: nil, created_at: nil, cursor: nil, entity_id: nil, idempotency_key: nil, limit: nil, request_options: {})
-      #
-      # @param category [Increase::Models::DocumentListParams::Category]
-      #
-      # @param created_at [Increase::Models::DocumentListParams::CreatedAt]
-      #
-      # @param cursor [String] Return the page of entries after this one.
-      #
-      # @param entity_id [String] Filter Documents to ones 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}, nil]
-      #
-      # @return [Increase::Internal::Page<Increase::Models::Document>]
-      #
-      # @see Increase::Models::DocumentListParams
-      def list(params = {})
-        parsed, options = Increase::DocumentListParams.dump_request(params)
-        @client.request(
-          method: :get,
-          path: "documents",
-          query: parsed,
-          page: Increase::Internal::Page,
-          model: Increase::Document,
-          options: options
-        )
-      end
-
-      # @api private
-      #
-      # @param client [Increase::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/lib/increase/resources/simulations/documents.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Resources
-    class Simulations
-      class Documents
-        # Simulates an tax document being created for an account.
-        #
-        # @overload create(account_id:, request_options: {})
-        #
-        # @param account_id [String] The identifier of the Account the tax document is for.
-        #
-        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [Increase::Models::Document]
-        #
-        # @see Increase::Models::Simulations::DocumentCreateParams
-        def create(params)
-          parsed, options = Increase::Simulations::DocumentCreateParams.dump_request(params)
-          @client.request(
-            method: :post,
-            path: "simulations/documents",
-            body: parsed,
-            model: Increase::Document,
-            options: options
-          )
-        end
-
-        # @api private
-        #
-        # @param client [Increase::Client]
-        def initialize(client:)
-          @client = client
-        end
-      end
-    end
-  end
-end