From 7d7ab72a46faa7274855639846a130f2a9e0ad41 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 22 Apr 2025 17:16:42 +0000 Subject: [PATCH 01/16] feat(api): api update --- .stats.yml | 8 +- lib/increase.rb | 9 - lib/increase/client.rb | 9 - lib/increase/models/event.rb | 6 - lib/increase/models/event_list_params.rb | 6 - lib/increase/models/event_subscription.rb | 6 - .../event_subscription_create_params.rb | 6 - .../models/proof_of_authorization_request.rb | 80 ------- ...of_of_authorization_request_list_params.rb | 71 ------ ...f_authorization_request_retrieve_params.rb | 14 -- ...oof_of_authorization_request_submission.rb | 197 --------------- ...zation_request_submission_create_params.rb | 98 -------- ...rization_request_submission_list_params.rb | 46 ---- ...tion_request_submission_retrieve_params.rb | 14 -- ...of_of_authorization_request_submissions.rb | 94 -------- .../proof_of_authorization_requests.rb | 57 ----- rbi/lib/increase/client.rbi | 6 - rbi/lib/increase/models/event.rbi | 14 -- rbi/lib/increase/models/event_list_params.rbi | 14 -- .../increase/models/event_subscription.rbi | 14 -- .../event_subscription_create_params.rbi | 14 -- .../models/proof_of_authorization_request.rbi | 88 ------- ...f_of_authorization_request_list_params.rbi | 102 -------- ..._authorization_request_retrieve_params.rbi | 19 -- ...of_of_authorization_request_submission.rbi | 224 ------------------ ...ation_request_submission_create_params.rbi | 122 ---------- ...ization_request_submission_list_params.rbi | 75 ------ ...ion_request_submission_retrieve_params.rbi | 19 -- ...f_of_authorization_request_submissions.rbi | 96 -------- .../proof_of_authorization_requests.rbi | 43 ---- sig/increase/client.rbs | 4 - sig/increase/models/event.rbs | 8 - sig/increase/models/event_list_params.rbs | 8 - sig/increase/models/event_subscription.rbs | 8 - .../event_subscription_create_params.rbs | 8 - .../models/proof_of_authorization_request.rbs | 58 ----- ...f_of_authorization_request_list_params.rbs | 69 ------ ..._authorization_request_retrieve_params.rbs | 15 -- ...of_of_authorization_request_submission.rbs | 130 ---------- ...ation_request_submission_create_params.rbs | 73 ------ ...ization_request_submission_list_params.rbs | 43 ---- ...ion_request_submission_retrieve_params.rbs | 15 -- ...f_of_authorization_request_submissions.rbs | 36 --- .../proof_of_authorization_requests.rbs | 19 -- ..._authorization_request_submissions_test.rb | 119 ---------- .../proof_of_authorization_requests_test.rb | 50 ---- 46 files changed, 4 insertions(+), 2230 deletions(-) delete mode 100644 lib/increase/models/proof_of_authorization_request.rb delete mode 100644 lib/increase/models/proof_of_authorization_request_list_params.rb delete mode 100644 lib/increase/models/proof_of_authorization_request_retrieve_params.rb delete mode 100644 lib/increase/models/proof_of_authorization_request_submission.rb delete mode 100644 lib/increase/models/proof_of_authorization_request_submission_create_params.rb delete mode 100644 lib/increase/models/proof_of_authorization_request_submission_list_params.rb delete mode 100644 lib/increase/models/proof_of_authorization_request_submission_retrieve_params.rb delete mode 100644 lib/increase/resources/proof_of_authorization_request_submissions.rb delete mode 100644 lib/increase/resources/proof_of_authorization_requests.rb delete mode 100644 rbi/lib/increase/models/proof_of_authorization_request.rbi delete mode 100644 rbi/lib/increase/models/proof_of_authorization_request_list_params.rbi delete mode 100644 rbi/lib/increase/models/proof_of_authorization_request_retrieve_params.rbi delete mode 100644 rbi/lib/increase/models/proof_of_authorization_request_submission.rbi delete mode 100644 rbi/lib/increase/models/proof_of_authorization_request_submission_create_params.rbi delete mode 100644 rbi/lib/increase/models/proof_of_authorization_request_submission_list_params.rbi delete mode 100644 rbi/lib/increase/models/proof_of_authorization_request_submission_retrieve_params.rbi delete mode 100644 rbi/lib/increase/resources/proof_of_authorization_request_submissions.rbi delete mode 100644 rbi/lib/increase/resources/proof_of_authorization_requests.rbi delete mode 100644 sig/increase/models/proof_of_authorization_request.rbs delete mode 100644 sig/increase/models/proof_of_authorization_request_list_params.rbs delete mode 100644 sig/increase/models/proof_of_authorization_request_retrieve_params.rbs delete mode 100644 sig/increase/models/proof_of_authorization_request_submission.rbs delete mode 100644 sig/increase/models/proof_of_authorization_request_submission_create_params.rbs delete mode 100644 sig/increase/models/proof_of_authorization_request_submission_list_params.rbs delete mode 100644 sig/increase/models/proof_of_authorization_request_submission_retrieve_params.rbs delete mode 100644 sig/increase/resources/proof_of_authorization_request_submissions.rbs delete mode 100644 sig/increase/resources/proof_of_authorization_requests.rbs delete mode 100644 test/increase/resources/proof_of_authorization_request_submissions_test.rb delete mode 100644 test/increase/resources/proof_of_authorization_requests_test.rb diff --git a/.stats.yml b/.stats.yml index b6d277351..3ebab9869 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 199 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-77c909117116f16f4bd7d5596257445e57c54d288d6534fe5b11ee37126c4c34.yml -openapi_spec_hash: 29e929217173626e3edec897a5b6c5e7 -config_hash: 20a463ecd33bd32b7b9bc6f4990907ac +configured_endpoints: 194 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-7eefcf9e79e89a7e4a2a064d93c40f83d3efe93ea91c0e9ba7112e491fb69e8f.yml +openapi_spec_hash: 3e3ee435a96bbb79dfe7c28d4bdab846 +config_hash: 6ae27f935d24d38237894dd4fd6bd749 diff --git a/lib/increase.rb b/lib/increase.rb index 35adf59fc..de8559a30 100644 --- a/lib/increase.rb +++ b/lib/increase.rb @@ -236,13 +236,6 @@ require_relative "increase/models/program" require_relative "increase/models/program_list_params" require_relative "increase/models/program_retrieve_params" -require_relative "increase/models/proof_of_authorization_request" -require_relative "increase/models/proof_of_authorization_request_list_params" -require_relative "increase/models/proof_of_authorization_request_retrieve_params" -require_relative "increase/models/proof_of_authorization_request_submission" -require_relative "increase/models/proof_of_authorization_request_submission_create_params" -require_relative "increase/models/proof_of_authorization_request_submission_list_params" -require_relative "increase/models/proof_of_authorization_request_submission_retrieve_params" require_relative "increase/models/real_time_decision" require_relative "increase/models/real_time_decision_action_params" require_relative "increase/models/real_time_decision_retrieve_params" @@ -348,8 +341,6 @@ require_relative "increase/resources/physical_card_profiles" require_relative "increase/resources/physical_cards" require_relative "increase/resources/programs" -require_relative "increase/resources/proof_of_authorization_requests" -require_relative "increase/resources/proof_of_authorization_request_submissions" require_relative "increase/resources/real_time_decisions" require_relative "increase/resources/real_time_payments_transfers" require_relative "increase/resources/routing_numbers" diff --git a/lib/increase/client.rb b/lib/increase/client.rb index eedf21ef9..de8b588da 100644 --- a/lib/increase/client.rb +++ b/lib/increase/client.rb @@ -122,12 +122,6 @@ class Client < Increase::Internal::Transport::BaseClient # @return [Increase::Resources::Programs] attr_reader :programs - # @return [Increase::Resources::ProofOfAuthorizationRequests] - attr_reader :proof_of_authorization_requests - - # @return [Increase::Resources::ProofOfAuthorizationRequestSubmissions] - attr_reader :proof_of_authorization_request_submissions - # @return [Increase::Resources::AccountStatements] attr_reader :account_statements @@ -281,9 +275,6 @@ def initialize( @entities = Increase::Resources::Entities.new(client: self) @supplemental_documents = Increase::Resources::SupplementalDocuments.new(client: self) @programs = Increase::Resources::Programs.new(client: self) - @proof_of_authorization_requests = Increase::Resources::ProofOfAuthorizationRequests.new(client: self) - @proof_of_authorization_request_submissions = - Increase::Resources::ProofOfAuthorizationRequestSubmissions.new(client: self) @account_statements = Increase::Resources::AccountStatements.new(client: self) @files = Increase::Resources::Files.new(client: self) @file_links = Increase::Resources::FileLinks.new(client: self) diff --git a/lib/increase/models/event.rb b/lib/increase/models/event.rb index 99e2e7e1d..00c1b6c65 100644 --- a/lib/increase/models/event.rb +++ b/lib/increase/models/event.rb @@ -278,12 +278,6 @@ module Category # Occurs whenever a Proof of Authorization Request is updated. PROOF_OF_AUTHORIZATION_REQUEST_UPDATED = :"proof_of_authorization_request.updated" - # Occurs whenever a Proof of Authorization Request Submission is created. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_CREATED = :"proof_of_authorization_request_submission.created" - - # Occurs whenever a Proof of Authorization Request Submission is updated. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_UPDATED = :"proof_of_authorization_request_submission.updated" - # Occurs whenever a Real-Time Decision is created in response to a card authorization. REAL_TIME_DECISION_CARD_AUTHORIZATION_REQUESTED = :"real_time_decision.card_authorization_requested" diff --git a/lib/increase/models/event_list_params.rb b/lib/increase/models/event_list_params.rb index 3a8f47e37..c44294357 100644 --- a/lib/increase/models/event_list_params.rb +++ b/lib/increase/models/event_list_params.rb @@ -277,12 +277,6 @@ module In # Occurs whenever a Proof of Authorization Request is updated. PROOF_OF_AUTHORIZATION_REQUEST_UPDATED = :"proof_of_authorization_request.updated" - # Occurs whenever a Proof of Authorization Request Submission is created. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_CREATED = :"proof_of_authorization_request_submission.created" - - # Occurs whenever a Proof of Authorization Request Submission is updated. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_UPDATED = :"proof_of_authorization_request_submission.updated" - # Occurs whenever a Real-Time Decision is created in response to a card authorization. REAL_TIME_DECISION_CARD_AUTHORIZATION_REQUESTED = :"real_time_decision.card_authorization_requested" diff --git a/lib/increase/models/event_subscription.rb b/lib/increase/models/event_subscription.rb index 882bb0d53..a6e3fc0a5 100644 --- a/lib/increase/models/event_subscription.rb +++ b/lib/increase/models/event_subscription.rb @@ -299,12 +299,6 @@ module SelectedEventCategory # Occurs whenever a Proof of Authorization Request is updated. PROOF_OF_AUTHORIZATION_REQUEST_UPDATED = :"proof_of_authorization_request.updated" - # Occurs whenever a Proof of Authorization Request Submission is created. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_CREATED = :"proof_of_authorization_request_submission.created" - - # Occurs whenever a Proof of Authorization Request Submission is updated. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_UPDATED = :"proof_of_authorization_request_submission.updated" - # Occurs whenever a Real-Time Decision is created in response to a card authorization. REAL_TIME_DECISION_CARD_AUTHORIZATION_REQUESTED = :"real_time_decision.card_authorization_requested" diff --git a/lib/increase/models/event_subscription_create_params.rb b/lib/increase/models/event_subscription_create_params.rb index 617082935..7c53fce6f 100644 --- a/lib/increase/models/event_subscription_create_params.rb +++ b/lib/increase/models/event_subscription_create_params.rb @@ -263,12 +263,6 @@ module SelectedEventCategory # Occurs whenever a Proof of Authorization Request is updated. PROOF_OF_AUTHORIZATION_REQUEST_UPDATED = :"proof_of_authorization_request.updated" - # Occurs whenever a Proof of Authorization Request Submission is created. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_CREATED = :"proof_of_authorization_request_submission.created" - - # Occurs whenever a Proof of Authorization Request Submission is updated. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_UPDATED = :"proof_of_authorization_request_submission.updated" - # Occurs whenever a Real-Time Decision is created in response to a card authorization. REAL_TIME_DECISION_CARD_AUTHORIZATION_REQUESTED = :"real_time_decision.card_authorization_requested" diff --git a/lib/increase/models/proof_of_authorization_request.rb b/lib/increase/models/proof_of_authorization_request.rb deleted file mode 100644 index c806ecca0..000000000 --- a/lib/increase/models/proof_of_authorization_request.rb +++ /dev/null @@ -1,80 +0,0 @@ -# frozen_string_literal: true - -module Increase - module Models - # @see Increase::Resources::ProofOfAuthorizationRequests#retrieve - class ProofOfAuthorizationRequest < Increase::Internal::Type::BaseModel - # @!attribute id - # The Proof of Authorization Request identifier. - # - # @return [String] - required :id, String - - # @!attribute ach_transfers - # The ACH Transfers associated with the request. - # - # @return [Array] - required :ach_transfers, - -> { Increase::Internal::Type::ArrayOf[Increase::Models::ProofOfAuthorizationRequest::ACHTransfer] } - - # @!attribute created_at - # The time the Proof of Authorization Request was created. - # - # @return [Time] - required :created_at, Time - - # @!attribute due_on - # The time the Proof of Authorization Request is due. - # - # @return [Time] - required :due_on, Time - - # @!attribute type - # A constant representing the object's type. For this resource it will always be - # `proof_of_authorization_request`. - # - # @return [Symbol, Increase::Models::ProofOfAuthorizationRequest::Type] - required :type, enum: -> { Increase::Models::ProofOfAuthorizationRequest::Type } - - # @!attribute updated_at - # The time the Proof of Authorization Request was last updated. - # - # @return [Time] - required :updated_at, Time - - # @!method initialize(id:, ach_transfers:, created_at:, due_on:, type:, updated_at:) - # A request for proof of authorization for one or more ACH debit transfers. - # - # @param id [String] - # @param ach_transfers [Array] - # @param created_at [Time] - # @param due_on [Time] - # @param type [Symbol, Increase::Models::ProofOfAuthorizationRequest::Type] - # @param updated_at [Time] - - class ACHTransfer < Increase::Internal::Type::BaseModel - # @!attribute id - # The ACH Transfer identifier. - # - # @return [String] - required :id, String - - # @!method initialize(id:) - # @param id [String] - end - - # A constant representing the object's type. For this resource it will always be - # `proof_of_authorization_request`. - # - # @see Increase::Models::ProofOfAuthorizationRequest#type - module Type - extend Increase::Internal::Type::Enum - - PROOF_OF_AUTHORIZATION_REQUEST = :proof_of_authorization_request - - # @!method self.values - # @return [Array] - end - end - end -end diff --git a/lib/increase/models/proof_of_authorization_request_list_params.rb b/lib/increase/models/proof_of_authorization_request_list_params.rb deleted file mode 100644 index 285b5e0e0..000000000 --- a/lib/increase/models/proof_of_authorization_request_list_params.rb +++ /dev/null @@ -1,71 +0,0 @@ -# frozen_string_literal: true - -module Increase - module Models - # @see Increase::Resources::ProofOfAuthorizationRequests#list - class ProofOfAuthorizationRequestListParams < Increase::Internal::Type::BaseModel - extend Increase::Internal::Type::RequestParameters::Converter - include Increase::Internal::Type::RequestParameters - - # @!attribute created_at - # - # @return [Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt, nil] - optional :created_at, -> { Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt } - - # @!attribute cursor - # Return the page of entries after this one. - # - # @return [String, nil] - optional :cursor, 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(created_at: nil, cursor: nil, limit: nil, request_options: {}) - # @param created_at [Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] - # @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) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] - end - end - end -end diff --git a/lib/increase/models/proof_of_authorization_request_retrieve_params.rb b/lib/increase/models/proof_of_authorization_request_retrieve_params.rb deleted file mode 100644 index 429ff879b..000000000 --- a/lib/increase/models/proof_of_authorization_request_retrieve_params.rb +++ /dev/null @@ -1,14 +0,0 @@ -# frozen_string_literal: true - -module Increase - module Models - # @see Increase::Resources::ProofOfAuthorizationRequests#retrieve - class ProofOfAuthorizationRequestRetrieveParams < 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 diff --git a/lib/increase/models/proof_of_authorization_request_submission.rb b/lib/increase/models/proof_of_authorization_request_submission.rb deleted file mode 100644 index 23f88f743..000000000 --- a/lib/increase/models/proof_of_authorization_request_submission.rb +++ /dev/null @@ -1,197 +0,0 @@ -# frozen_string_literal: true - -module Increase - module Models - # @see Increase::Resources::ProofOfAuthorizationRequestSubmissions#create - class ProofOfAuthorizationRequestSubmission < Increase::Internal::Type::BaseModel - # @!attribute id - # The Proof of Authorization Request Submission identifier. - # - # @return [String] - required :id, String - - # @!attribute additional_evidence_files - # Files containing additional evidence. - # - # @return [Array] - required :additional_evidence_files, - -> { Increase::Internal::Type::ArrayOf[Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile] } - - # @!attribute authorization_terms - # Terms of authorization. - # - # @return [String] - required :authorization_terms, String - - # @!attribute authorized_at - # Time of authorization. - # - # @return [Time] - required :authorized_at, Time - - # @!attribute authorizer_company - # Company of the authorizer. - # - # @return [String, nil] - required :authorizer_company, String, nil?: true - - # @!attribute authorizer_email - # Email of the authorizer. - # - # @return [String, nil] - required :authorizer_email, String, nil?: true - - # @!attribute authorizer_ip_address - # IP address of the authorizer. - # - # @return [String, nil] - required :authorizer_ip_address, String, nil?: true - - # @!attribute authorizer_name - # Name of the authorizer. - # - # @return [String, nil] - required :authorizer_name, String, nil?: true - - # @!attribute created_at - # The time the Proof of Authorization Request Submission was created. - # - # @return [Time] - required :created_at, Time - - # @!attribute customer_has_been_offboarded - # Whether the customer has been offboarded. - # - # @return [Boolean, nil] - required :customer_has_been_offboarded, Increase::Internal::Type::Boolean, 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 proof_of_authorization_request_id - # ID of the proof of authorization request. - # - # @return [String] - required :proof_of_authorization_request_id, String - - # @!attribute status - # Status of the proof of authorization request submission. - # - # @return [Symbol, Increase::Models::ProofOfAuthorizationRequestSubmission::Status] - required :status, enum: -> { Increase::Models::ProofOfAuthorizationRequestSubmission::Status } - - # @!attribute type - # A constant representing the object's type. For this resource it will always be - # `proof_of_authorization_request_submission`. - # - # @return [Symbol, Increase::Models::ProofOfAuthorizationRequestSubmission::Type] - required :type, enum: -> { Increase::Models::ProofOfAuthorizationRequestSubmission::Type } - - # @!attribute updated_at - # The time the Proof of Authorization Request Submission was last updated. - # - # @return [Time] - required :updated_at, Time - - # @!attribute validated_account_ownership_via_credential - # Whether account ownership was validated via credential (for instance, Plaid). - # - # @return [Boolean, nil] - required :validated_account_ownership_via_credential, Increase::Internal::Type::Boolean, nil?: true - - # @!attribute validated_account_ownership_with_account_statement - # Whether account ownership was validated with an account statement. - # - # @return [Boolean, nil] - required :validated_account_ownership_with_account_statement, - Increase::Internal::Type::Boolean, - nil?: true - - # @!attribute validated_account_ownership_with_microdeposit - # Whether account ownership was validated with microdeposit. - # - # @return [Boolean, nil] - required :validated_account_ownership_with_microdeposit, Increase::Internal::Type::Boolean, nil?: true - - # @!method initialize(id:, additional_evidence_files:, authorization_terms:, authorized_at:, authorizer_company:, authorizer_email:, authorizer_ip_address:, authorizer_name:, created_at:, customer_has_been_offboarded:, idempotency_key:, proof_of_authorization_request_id:, status:, type:, updated_at:, validated_account_ownership_via_credential:, validated_account_ownership_with_account_statement:, validated_account_ownership_with_microdeposit:) - # Information submitted in response to a proof of authorization request. Per - # Nacha's guidance on proof of authorization, the originator must ensure that the - # authorization complies with applicable legal requirements, is readily - # identifiable as an authorization, and has clear and readily understandable - # terms. - # - # @param id [String] - # @param additional_evidence_files [Array] - # @param authorization_terms [String] - # @param authorized_at [Time] - # @param authorizer_company [String, nil] - # @param authorizer_email [String, nil] - # @param authorizer_ip_address [String, nil] - # @param authorizer_name [String, nil] - # @param created_at [Time] - # @param customer_has_been_offboarded [Boolean, nil] - # @param idempotency_key [String, nil] - # @param proof_of_authorization_request_id [String] - # @param status [Symbol, Increase::Models::ProofOfAuthorizationRequestSubmission::Status] - # @param type [Symbol, Increase::Models::ProofOfAuthorizationRequestSubmission::Type] - # @param updated_at [Time] - # @param validated_account_ownership_via_credential [Boolean, nil] - # @param validated_account_ownership_with_account_statement [Boolean, nil] - # @param validated_account_ownership_with_microdeposit [Boolean, nil] - - class AdditionalEvidenceFile < Increase::Internal::Type::BaseModel - # @!attribute file_id - # The File identifier. - # - # @return [String] - required :file_id, String - - # @!method initialize(file_id:) - # @param file_id [String] - end - - # Status of the proof of authorization request submission. - # - # @see Increase::Models::ProofOfAuthorizationRequestSubmission#status - module Status - extend Increase::Internal::Type::Enum - - # The proof of authorization request submission is pending review. - PENDING_REVIEW = :pending_review - - # The proof of authorization request submission was rejected. - REJECTED = :rejected - - # The proof of authorization request submission was canceled and replaced with another. - CANCELED = :canceled - - # The proof of authorization request submission is pending sending. - PENDING_SENDING = :pending_sending - - # The proof of authorization request submission was sent. - SENT = :sent - - # @!method self.values - # @return [Array] - end - - # A constant representing the object's type. For this resource it will always be - # `proof_of_authorization_request_submission`. - # - # @see Increase::Models::ProofOfAuthorizationRequestSubmission#type - module Type - extend Increase::Internal::Type::Enum - - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION = :proof_of_authorization_request_submission - - # @!method self.values - # @return [Array] - end - end - end -end diff --git a/lib/increase/models/proof_of_authorization_request_submission_create_params.rb b/lib/increase/models/proof_of_authorization_request_submission_create_params.rb deleted file mode 100644 index 3237a074d..000000000 --- a/lib/increase/models/proof_of_authorization_request_submission_create_params.rb +++ /dev/null @@ -1,98 +0,0 @@ -# frozen_string_literal: true - -module Increase - module Models - # @see Increase::Resources::ProofOfAuthorizationRequestSubmissions#create - class ProofOfAuthorizationRequestSubmissionCreateParams < Increase::Internal::Type::BaseModel - extend Increase::Internal::Type::RequestParameters::Converter - include Increase::Internal::Type::RequestParameters - - # @!attribute authorization_terms - # Terms of authorization. - # - # @return [String] - required :authorization_terms, String - - # @!attribute authorized_at - # Time of authorization. - # - # @return [Time] - required :authorized_at, Time - - # @!attribute authorizer_email - # Email of the authorizer. - # - # @return [String] - required :authorizer_email, String - - # @!attribute authorizer_name - # Name of the authorizer. - # - # @return [String] - required :authorizer_name, String - - # @!attribute customer_has_been_offboarded - # Whether the customer has been offboarded or suspended. - # - # @return [Boolean] - required :customer_has_been_offboarded, Increase::Internal::Type::Boolean - - # @!attribute proof_of_authorization_request_id - # ID of the proof of authorization request. - # - # @return [String] - required :proof_of_authorization_request_id, String - - # @!attribute validated_account_ownership_via_credential - # Whether the account ownership was validated via credential (e.g. Plaid). - # - # @return [Boolean] - required :validated_account_ownership_via_credential, Increase::Internal::Type::Boolean - - # @!attribute validated_account_ownership_with_account_statement - # Whether the account ownership was validated with an account statement. - # - # @return [Boolean] - required :validated_account_ownership_with_account_statement, Increase::Internal::Type::Boolean - - # @!attribute validated_account_ownership_with_microdeposit - # Whether the account ownership was validated with a microdeposit. - # - # @return [Boolean] - required :validated_account_ownership_with_microdeposit, Increase::Internal::Type::Boolean - - # @!attribute additional_evidence_file_id - # File containing additional evidence. - # - # @return [String, nil] - optional :additional_evidence_file_id, String - - # @!attribute authorizer_company - # Company of the authorizer. - # - # @return [String, nil] - optional :authorizer_company, String - - # @!attribute authorizer_ip_address - # IP address of the authorizer. - # - # @return [String, nil] - optional :authorizer_ip_address, String - - # @!method initialize(authorization_terms:, authorized_at:, authorizer_email:, authorizer_name:, customer_has_been_offboarded:, proof_of_authorization_request_id:, validated_account_ownership_via_credential:, validated_account_ownership_with_account_statement:, validated_account_ownership_with_microdeposit:, additional_evidence_file_id: nil, authorizer_company: nil, authorizer_ip_address: nil, request_options: {}) - # @param authorization_terms [String] - # @param authorized_at [Time] - # @param authorizer_email [String] - # @param authorizer_name [String] - # @param customer_has_been_offboarded [Boolean] - # @param proof_of_authorization_request_id [String] - # @param validated_account_ownership_via_credential [Boolean] - # @param validated_account_ownership_with_account_statement [Boolean] - # @param validated_account_ownership_with_microdeposit [Boolean] - # @param additional_evidence_file_id [String] - # @param authorizer_company [String] - # @param authorizer_ip_address [String] - # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - end - end -end diff --git a/lib/increase/models/proof_of_authorization_request_submission_list_params.rb b/lib/increase/models/proof_of_authorization_request_submission_list_params.rb deleted file mode 100644 index 04fff3394..000000000 --- a/lib/increase/models/proof_of_authorization_request_submission_list_params.rb +++ /dev/null @@ -1,46 +0,0 @@ -# frozen_string_literal: true - -module Increase - module Models - # @see Increase::Resources::ProofOfAuthorizationRequestSubmissions#list - class ProofOfAuthorizationRequestSubmissionListParams < 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 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 proof_of_authorization_request_id - # ID of the proof of authorization request. - # - # @return [String, nil] - optional :proof_of_authorization_request_id, String - - # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, proof_of_authorization_request_id: nil, request_options: {}) - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] - # @param proof_of_authorization_request_id [String] - # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - end - end -end diff --git a/lib/increase/models/proof_of_authorization_request_submission_retrieve_params.rb b/lib/increase/models/proof_of_authorization_request_submission_retrieve_params.rb deleted file mode 100644 index 6219b0cf0..000000000 --- a/lib/increase/models/proof_of_authorization_request_submission_retrieve_params.rb +++ /dev/null @@ -1,14 +0,0 @@ -# frozen_string_literal: true - -module Increase - module Models - # @see Increase::Resources::ProofOfAuthorizationRequestSubmissions#retrieve - class ProofOfAuthorizationRequestSubmissionRetrieveParams < 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 diff --git a/lib/increase/resources/proof_of_authorization_request_submissions.rb b/lib/increase/resources/proof_of_authorization_request_submissions.rb deleted file mode 100644 index 1a4e81bc8..000000000 --- a/lib/increase/resources/proof_of_authorization_request_submissions.rb +++ /dev/null @@ -1,94 +0,0 @@ -# frozen_string_literal: true - -module Increase - module Resources - class ProofOfAuthorizationRequestSubmissions - # Submit Proof of Authorization - # - # @overload create(authorization_terms:, authorized_at:, authorizer_email:, authorizer_name:, customer_has_been_offboarded:, proof_of_authorization_request_id:, validated_account_ownership_via_credential:, validated_account_ownership_with_account_statement:, validated_account_ownership_with_microdeposit:, additional_evidence_file_id: nil, authorizer_company: nil, authorizer_ip_address: nil, request_options: {}) - # - # @param authorization_terms [String] - # @param authorized_at [Time] - # @param authorizer_email [String] - # @param authorizer_name [String] - # @param customer_has_been_offboarded [Boolean] - # @param proof_of_authorization_request_id [String] - # @param validated_account_ownership_via_credential [Boolean] - # @param validated_account_ownership_with_account_statement [Boolean] - # @param validated_account_ownership_with_microdeposit [Boolean] - # @param additional_evidence_file_id [String] - # @param authorizer_company [String] - # @param authorizer_ip_address [String] - # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Increase::Models::ProofOfAuthorizationRequestSubmission] - # - # @see Increase::Models::ProofOfAuthorizationRequestSubmissionCreateParams - def create(params) - parsed, options = - Increase::Models::ProofOfAuthorizationRequestSubmissionCreateParams.dump_request(params) - @client.request( - method: :post, - path: "proof_of_authorization_request_submissions", - body: parsed, - model: Increase::Models::ProofOfAuthorizationRequestSubmission, - options: options - ) - end - - # Retrieve a Proof of Authorization Request Submission - # - # @overload retrieve(proof_of_authorization_request_submission_id, request_options: {}) - # - # @param proof_of_authorization_request_submission_id [String] - # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Increase::Models::ProofOfAuthorizationRequestSubmission] - # - # @see Increase::Models::ProofOfAuthorizationRequestSubmissionRetrieveParams - def retrieve(proof_of_authorization_request_submission_id, params = {}) - @client.request( - method: :get, - path: [ - "proof_of_authorization_request_submissions/%1$s", - proof_of_authorization_request_submission_id - ], - model: Increase::Models::ProofOfAuthorizationRequestSubmission, - options: params[:request_options] - ) - end - - # List Proof of Authorization Request Submissions - # - # @overload list(cursor: nil, idempotency_key: nil, limit: nil, proof_of_authorization_request_id: nil, request_options: {}) - # - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] - # @param proof_of_authorization_request_id [String] - # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Increase::Internal::Page] - # - # @see Increase::Models::ProofOfAuthorizationRequestSubmissionListParams - def list(params = {}) - parsed, options = Increase::Models::ProofOfAuthorizationRequestSubmissionListParams.dump_request(params) - @client.request( - method: :get, - path: "proof_of_authorization_request_submissions", - query: parsed, - page: Increase::Internal::Page, - model: Increase::Models::ProofOfAuthorizationRequestSubmission, - options: options - ) - end - - # @api private - # - # @param client [Increase::Client] - def initialize(client:) - @client = client - end - end - end -end diff --git a/lib/increase/resources/proof_of_authorization_requests.rb b/lib/increase/resources/proof_of_authorization_requests.rb deleted file mode 100644 index 2755f8fc7..000000000 --- a/lib/increase/resources/proof_of_authorization_requests.rb +++ /dev/null @@ -1,57 +0,0 @@ -# frozen_string_literal: true - -module Increase - module Resources - class ProofOfAuthorizationRequests - # Retrieve a Proof of Authorization Request - # - # @overload retrieve(proof_of_authorization_request_id, request_options: {}) - # - # @param proof_of_authorization_request_id [String] - # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Increase::Models::ProofOfAuthorizationRequest] - # - # @see Increase::Models::ProofOfAuthorizationRequestRetrieveParams - def retrieve(proof_of_authorization_request_id, params = {}) - @client.request( - method: :get, - path: ["proof_of_authorization_requests/%1$s", proof_of_authorization_request_id], - model: Increase::Models::ProofOfAuthorizationRequest, - options: params[:request_options] - ) - end - - # List Proof of Authorization Requests - # - # @overload list(created_at: nil, cursor: nil, limit: nil, request_options: {}) - # - # @param created_at [Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] - # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Increase::Internal::Page] - # - # @see Increase::Models::ProofOfAuthorizationRequestListParams - def list(params = {}) - parsed, options = Increase::Models::ProofOfAuthorizationRequestListParams.dump_request(params) - @client.request( - method: :get, - path: "proof_of_authorization_requests", - query: parsed, - page: Increase::Internal::Page, - model: Increase::Models::ProofOfAuthorizationRequest, - options: options - ) - end - - # @api private - # - # @param client [Increase::Client] - def initialize(client:) - @client = client - end - end - end -end diff --git a/rbi/lib/increase/client.rbi b/rbi/lib/increase/client.rbi index e0dcdb033..5233225cd 100644 --- a/rbi/lib/increase/client.rbi +++ b/rbi/lib/increase/client.rbi @@ -118,12 +118,6 @@ module Increase sig { returns(Increase::Resources::Programs) } attr_reader :programs - sig { returns(Increase::Resources::ProofOfAuthorizationRequests) } - attr_reader :proof_of_authorization_requests - - sig { returns(Increase::Resources::ProofOfAuthorizationRequestSubmissions) } - attr_reader :proof_of_authorization_request_submissions - sig { returns(Increase::Resources::AccountStatements) } attr_reader :account_statements diff --git a/rbi/lib/increase/models/event.rbi b/rbi/lib/increase/models/event.rbi index 83da7b498..827fc86d6 100644 --- a/rbi/lib/increase/models/event.rbi +++ b/rbi/lib/increase/models/event.rbi @@ -331,20 +331,6 @@ module Increase PROOF_OF_AUTHORIZATION_REQUEST_UPDATED = T.let(:"proof_of_authorization_request.updated", Increase::Models::Event::Category::TaggedSymbol) - # Occurs whenever a Proof of Authorization Request Submission is created. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_CREATED = - T.let( - :"proof_of_authorization_request_submission.created", - Increase::Models::Event::Category::TaggedSymbol - ) - - # Occurs whenever a Proof of Authorization Request Submission is updated. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_UPDATED = - T.let( - :"proof_of_authorization_request_submission.updated", - Increase::Models::Event::Category::TaggedSymbol - ) - # Occurs whenever a Real-Time Decision is created in response to a card authorization. REAL_TIME_DECISION_CARD_AUTHORIZATION_REQUESTED = T.let(:"real_time_decision.card_authorization_requested", Increase::Models::Event::Category::TaggedSymbol) diff --git a/rbi/lib/increase/models/event_list_params.rbi b/rbi/lib/increase/models/event_list_params.rbi index 3d39983b2..fa0b4ec85 100644 --- a/rbi/lib/increase/models/event_list_params.rbi +++ b/rbi/lib/increase/models/event_list_params.rbi @@ -405,20 +405,6 @@ module Increase Increase::Models::EventListParams::Category::In::TaggedSymbol ) - # Occurs whenever a Proof of Authorization Request Submission is created. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_CREATED = - T.let( - :"proof_of_authorization_request_submission.created", - Increase::Models::EventListParams::Category::In::TaggedSymbol - ) - - # Occurs whenever a Proof of Authorization Request Submission is updated. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_UPDATED = - T.let( - :"proof_of_authorization_request_submission.updated", - Increase::Models::EventListParams::Category::In::TaggedSymbol - ) - # Occurs whenever a Real-Time Decision is created in response to a card authorization. REAL_TIME_DECISION_CARD_AUTHORIZATION_REQUESTED = T.let( diff --git a/rbi/lib/increase/models/event_subscription.rbi b/rbi/lib/increase/models/event_subscription.rbi index 526f9cb15..34e4f85f0 100644 --- a/rbi/lib/increase/models/event_subscription.rbi +++ b/rbi/lib/increase/models/event_subscription.rbi @@ -510,20 +510,6 @@ module Increase Increase::Models::EventSubscription::SelectedEventCategory::TaggedSymbol ) - # Occurs whenever a Proof of Authorization Request Submission is created. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_CREATED = - T.let( - :"proof_of_authorization_request_submission.created", - Increase::Models::EventSubscription::SelectedEventCategory::TaggedSymbol - ) - - # Occurs whenever a Proof of Authorization Request Submission is updated. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_UPDATED = - T.let( - :"proof_of_authorization_request_submission.updated", - Increase::Models::EventSubscription::SelectedEventCategory::TaggedSymbol - ) - # Occurs whenever a Real-Time Decision is created in response to a card authorization. REAL_TIME_DECISION_CARD_AUTHORIZATION_REQUESTED = T.let( diff --git a/rbi/lib/increase/models/event_subscription_create_params.rbi b/rbi/lib/increase/models/event_subscription_create_params.rbi index 920fcc9ed..1c464d01c 100644 --- a/rbi/lib/increase/models/event_subscription_create_params.rbi +++ b/rbi/lib/increase/models/event_subscription_create_params.rbi @@ -585,20 +585,6 @@ module Increase Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory::TaggedSymbol ) - # Occurs whenever a Proof of Authorization Request Submission is created. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_CREATED = - T.let( - :"proof_of_authorization_request_submission.created", - Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory::TaggedSymbol - ) - - # Occurs whenever a Proof of Authorization Request Submission is updated. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_UPDATED = - T.let( - :"proof_of_authorization_request_submission.updated", - Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory::TaggedSymbol - ) - # Occurs whenever a Real-Time Decision is created in response to a card authorization. REAL_TIME_DECISION_CARD_AUTHORIZATION_REQUESTED = T.let( diff --git a/rbi/lib/increase/models/proof_of_authorization_request.rbi b/rbi/lib/increase/models/proof_of_authorization_request.rbi deleted file mode 100644 index d5170ee2b..000000000 --- a/rbi/lib/increase/models/proof_of_authorization_request.rbi +++ /dev/null @@ -1,88 +0,0 @@ -# typed: strong - -module Increase - module Models - class ProofOfAuthorizationRequest < Increase::Internal::Type::BaseModel - # The Proof of Authorization Request identifier. - sig { returns(String) } - attr_accessor :id - - # The ACH Transfers associated with the request. - sig { returns(T::Array[Increase::Models::ProofOfAuthorizationRequest::ACHTransfer]) } - attr_accessor :ach_transfers - - # The time the Proof of Authorization Request was created. - sig { returns(Time) } - attr_accessor :created_at - - # The time the Proof of Authorization Request is due. - sig { returns(Time) } - attr_accessor :due_on - - # A constant representing the object's type. For this resource it will always be - # `proof_of_authorization_request`. - sig { returns(Increase::Models::ProofOfAuthorizationRequest::Type::TaggedSymbol) } - attr_accessor :type - - # The time the Proof of Authorization Request was last updated. - sig { returns(Time) } - attr_accessor :updated_at - - # A request for proof of authorization for one or more ACH debit transfers. - sig do - params( - id: String, - ach_transfers: T::Array[T.any(Increase::Models::ProofOfAuthorizationRequest::ACHTransfer, Increase::Internal::AnyHash)], - created_at: Time, - due_on: Time, - type: Increase::Models::ProofOfAuthorizationRequest::Type::OrSymbol, - updated_at: Time - ) - .returns(T.attached_class) - end - def self.new(id:, ach_transfers:, created_at:, due_on:, type:, updated_at:); end - - sig do - override - .returns( - { - id: String, - ach_transfers: T::Array[Increase::Models::ProofOfAuthorizationRequest::ACHTransfer], - created_at: Time, - due_on: Time, - type: Increase::Models::ProofOfAuthorizationRequest::Type::TaggedSymbol, - updated_at: Time - } - ) - end - def to_hash; end - - class ACHTransfer < Increase::Internal::Type::BaseModel - # The ACH Transfer identifier. - sig { returns(String) } - attr_accessor :id - - sig { params(id: String).returns(T.attached_class) } - def self.new(id:); end - - sig { override.returns({id: String}) } - def to_hash; end - end - - # A constant representing the object's type. For this resource it will always be - # `proof_of_authorization_request`. - module Type - extend Increase::Internal::Type::Enum - - TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ProofOfAuthorizationRequest::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - PROOF_OF_AUTHORIZATION_REQUEST = - T.let(:proof_of_authorization_request, Increase::Models::ProofOfAuthorizationRequest::Type::TaggedSymbol) - - sig { override.returns(T::Array[Increase::Models::ProofOfAuthorizationRequest::Type::TaggedSymbol]) } - def self.values; end - end - end - end -end diff --git a/rbi/lib/increase/models/proof_of_authorization_request_list_params.rbi b/rbi/lib/increase/models/proof_of_authorization_request_list_params.rbi deleted file mode 100644 index 179395887..000000000 --- a/rbi/lib/increase/models/proof_of_authorization_request_list_params.rbi +++ /dev/null @@ -1,102 +0,0 @@ -# typed: strong - -module Increase - module Models - class ProofOfAuthorizationRequestListParams < Increase::Internal::Type::BaseModel - extend Increase::Internal::Type::RequestParameters::Converter - include Increase::Internal::Type::RequestParameters - - sig { returns(T.nilable(Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt)) } - attr_reader :created_at - - sig do - params( - created_at: T.any(Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt, Increase::Internal::AnyHash) - ) - .void - end - attr_writer :created_at - - # Return the page of entries after this one. - sig { returns(T.nilable(String)) } - attr_reader :cursor - - sig { params(cursor: String).void } - attr_writer :cursor - - # Limit the size of the list that is returned. The default (and maximum) is 100 - # objects. - sig { returns(T.nilable(Integer)) } - attr_reader :limit - - sig { params(limit: Integer).void } - attr_writer :limit - - sig do - params( - created_at: T.any(Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt, Increase::Internal::AnyHash), - cursor: String, - limit: Integer, - request_options: T.any(Increase::RequestOptions, Increase::Internal::AnyHash) - ) - .returns(T.attached_class) - end - def self.new(created_at: nil, cursor: nil, limit: nil, request_options: {}); end - - sig do - override - .returns( - { - created_at: Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt, - cursor: String, - limit: Integer, - request_options: Increase::RequestOptions - } - ) - end - def to_hash; end - - class CreatedAt < Increase::Internal::Type::BaseModel - # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) - # timestamp. - sig { returns(T.nilable(Time)) } - attr_reader :after - - sig { params(after: Time).void } - attr_writer :after - - # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) - # timestamp. - sig { returns(T.nilable(Time)) } - attr_reader :before - - sig { params(before: Time).void } - attr_writer :before - - # Return results on or after this - # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. - sig { returns(T.nilable(Time)) } - attr_reader :on_or_after - - sig { params(on_or_after: Time).void } - attr_writer :on_or_after - - # Return results on or before this - # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. - sig { returns(T.nilable(Time)) } - attr_reader :on_or_before - - sig { params(on_or_before: Time).void } - attr_writer :on_or_before - - sig do - params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) - end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - - sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } - def to_hash; end - end - end - end -end diff --git a/rbi/lib/increase/models/proof_of_authorization_request_retrieve_params.rbi b/rbi/lib/increase/models/proof_of_authorization_request_retrieve_params.rbi deleted file mode 100644 index 976cc6826..000000000 --- a/rbi/lib/increase/models/proof_of_authorization_request_retrieve_params.rbi +++ /dev/null @@ -1,19 +0,0 @@ -# typed: strong - -module Increase - module Models - class ProofOfAuthorizationRequestRetrieveParams < Increase::Internal::Type::BaseModel - extend Increase::Internal::Type::RequestParameters::Converter - include Increase::Internal::Type::RequestParameters - - sig do - params(request_options: T.any(Increase::RequestOptions, Increase::Internal::AnyHash)) - .returns(T.attached_class) - end - def self.new(request_options: {}); end - - sig { override.returns({request_options: Increase::RequestOptions}) } - def to_hash; end - end - end -end diff --git a/rbi/lib/increase/models/proof_of_authorization_request_submission.rbi b/rbi/lib/increase/models/proof_of_authorization_request_submission.rbi deleted file mode 100644 index 263c5a513..000000000 --- a/rbi/lib/increase/models/proof_of_authorization_request_submission.rbi +++ /dev/null @@ -1,224 +0,0 @@ -# typed: strong - -module Increase - module Models - class ProofOfAuthorizationRequestSubmission < Increase::Internal::Type::BaseModel - # The Proof of Authorization Request Submission identifier. - sig { returns(String) } - attr_accessor :id - - # Files containing additional evidence. - sig { returns(T::Array[Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile]) } - attr_accessor :additional_evidence_files - - # Terms of authorization. - sig { returns(String) } - attr_accessor :authorization_terms - - # Time of authorization. - sig { returns(Time) } - attr_accessor :authorized_at - - # Company of the authorizer. - sig { returns(T.nilable(String)) } - attr_accessor :authorizer_company - - # Email of the authorizer. - sig { returns(T.nilable(String)) } - attr_accessor :authorizer_email - - # IP address of the authorizer. - sig { returns(T.nilable(String)) } - attr_accessor :authorizer_ip_address - - # Name of the authorizer. - sig { returns(T.nilable(String)) } - attr_accessor :authorizer_name - - # The time the Proof of Authorization Request Submission was created. - sig { returns(Time) } - attr_accessor :created_at - - # Whether the customer has been offboarded. - sig { returns(T.nilable(T::Boolean)) } - attr_accessor :customer_has_been_offboarded - - # 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). - sig { returns(T.nilable(String)) } - attr_accessor :idempotency_key - - # ID of the proof of authorization request. - sig { returns(String) } - attr_accessor :proof_of_authorization_request_id - - # Status of the proof of authorization request submission. - sig { returns(Increase::Models::ProofOfAuthorizationRequestSubmission::Status::TaggedSymbol) } - attr_accessor :status - - # A constant representing the object's type. For this resource it will always be - # `proof_of_authorization_request_submission`. - sig { returns(Increase::Models::ProofOfAuthorizationRequestSubmission::Type::TaggedSymbol) } - attr_accessor :type - - # The time the Proof of Authorization Request Submission was last updated. - sig { returns(Time) } - attr_accessor :updated_at - - # Whether account ownership was validated via credential (for instance, Plaid). - sig { returns(T.nilable(T::Boolean)) } - attr_accessor :validated_account_ownership_via_credential - - # Whether account ownership was validated with an account statement. - sig { returns(T.nilable(T::Boolean)) } - attr_accessor :validated_account_ownership_with_account_statement - - # Whether account ownership was validated with microdeposit. - sig { returns(T.nilable(T::Boolean)) } - attr_accessor :validated_account_ownership_with_microdeposit - - # Information submitted in response to a proof of authorization request. Per - # Nacha's guidance on proof of authorization, the originator must ensure that the - # authorization complies with applicable legal requirements, is readily - # identifiable as an authorization, and has clear and readily understandable - # terms. - sig do - params( - id: String, - additional_evidence_files: T::Array[ - T.any( - Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile, - Increase::Internal::AnyHash - ) - ], - authorization_terms: String, - authorized_at: Time, - authorizer_company: T.nilable(String), - authorizer_email: T.nilable(String), - authorizer_ip_address: T.nilable(String), - authorizer_name: T.nilable(String), - created_at: Time, - customer_has_been_offboarded: T.nilable(T::Boolean), - idempotency_key: T.nilable(String), - proof_of_authorization_request_id: String, - status: Increase::Models::ProofOfAuthorizationRequestSubmission::Status::OrSymbol, - type: Increase::Models::ProofOfAuthorizationRequestSubmission::Type::OrSymbol, - updated_at: Time, - validated_account_ownership_via_credential: T.nilable(T::Boolean), - validated_account_ownership_with_account_statement: T.nilable(T::Boolean), - validated_account_ownership_with_microdeposit: T.nilable(T::Boolean) - ) - .returns(T.attached_class) - end - def self.new( - id:, - additional_evidence_files:, - authorization_terms:, - authorized_at:, - authorizer_company:, - authorizer_email:, - authorizer_ip_address:, - authorizer_name:, - created_at:, - customer_has_been_offboarded:, - idempotency_key:, - proof_of_authorization_request_id:, - status:, - type:, - updated_at:, - validated_account_ownership_via_credential:, - validated_account_ownership_with_account_statement:, - validated_account_ownership_with_microdeposit: - ); end - sig do - override - .returns( - { - id: String, - additional_evidence_files: T::Array[Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile], - authorization_terms: String, - authorized_at: Time, - authorizer_company: T.nilable(String), - authorizer_email: T.nilable(String), - authorizer_ip_address: T.nilable(String), - authorizer_name: T.nilable(String), - created_at: Time, - customer_has_been_offboarded: T.nilable(T::Boolean), - idempotency_key: T.nilable(String), - proof_of_authorization_request_id: String, - status: Increase::Models::ProofOfAuthorizationRequestSubmission::Status::TaggedSymbol, - type: Increase::Models::ProofOfAuthorizationRequestSubmission::Type::TaggedSymbol, - updated_at: Time, - validated_account_ownership_via_credential: T.nilable(T::Boolean), - validated_account_ownership_with_account_statement: T.nilable(T::Boolean), - validated_account_ownership_with_microdeposit: T.nilable(T::Boolean) - } - ) - end - def to_hash; end - - class AdditionalEvidenceFile < Increase::Internal::Type::BaseModel - # The File identifier. - sig { returns(String) } - attr_accessor :file_id - - sig { params(file_id: String).returns(T.attached_class) } - def self.new(file_id:); end - - sig { override.returns({file_id: String}) } - def to_hash; end - end - - # Status of the proof of authorization request submission. - module Status - extend Increase::Internal::Type::Enum - - TaggedSymbol = - T.type_alias { T.all(Symbol, Increase::Models::ProofOfAuthorizationRequestSubmission::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - # The proof of authorization request submission is pending review. - PENDING_REVIEW = - T.let(:pending_review, Increase::Models::ProofOfAuthorizationRequestSubmission::Status::TaggedSymbol) - - # The proof of authorization request submission was rejected. - REJECTED = - T.let(:rejected, Increase::Models::ProofOfAuthorizationRequestSubmission::Status::TaggedSymbol) - - # The proof of authorization request submission was canceled and replaced with another. - CANCELED = - T.let(:canceled, Increase::Models::ProofOfAuthorizationRequestSubmission::Status::TaggedSymbol) - - # The proof of authorization request submission is pending sending. - PENDING_SENDING = - T.let(:pending_sending, Increase::Models::ProofOfAuthorizationRequestSubmission::Status::TaggedSymbol) - - # The proof of authorization request submission was sent. - SENT = T.let(:sent, Increase::Models::ProofOfAuthorizationRequestSubmission::Status::TaggedSymbol) - - sig { override.returns(T::Array[Increase::Models::ProofOfAuthorizationRequestSubmission::Status::TaggedSymbol]) } - def self.values; end - end - - # A constant representing the object's type. For this resource it will always be - # `proof_of_authorization_request_submission`. - module Type - extend Increase::Internal::Type::Enum - - TaggedSymbol = - T.type_alias { T.all(Symbol, Increase::Models::ProofOfAuthorizationRequestSubmission::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION = - T.let( - :proof_of_authorization_request_submission, - Increase::Models::ProofOfAuthorizationRequestSubmission::Type::TaggedSymbol - ) - - sig { override.returns(T::Array[Increase::Models::ProofOfAuthorizationRequestSubmission::Type::TaggedSymbol]) } - def self.values; end - end - end - end -end diff --git a/rbi/lib/increase/models/proof_of_authorization_request_submission_create_params.rbi b/rbi/lib/increase/models/proof_of_authorization_request_submission_create_params.rbi deleted file mode 100644 index f0114adf8..000000000 --- a/rbi/lib/increase/models/proof_of_authorization_request_submission_create_params.rbi +++ /dev/null @@ -1,122 +0,0 @@ -# typed: strong - -module Increase - module Models - class ProofOfAuthorizationRequestSubmissionCreateParams < Increase::Internal::Type::BaseModel - extend Increase::Internal::Type::RequestParameters::Converter - include Increase::Internal::Type::RequestParameters - - # Terms of authorization. - sig { returns(String) } - attr_accessor :authorization_terms - - # Time of authorization. - sig { returns(Time) } - attr_accessor :authorized_at - - # Email of the authorizer. - sig { returns(String) } - attr_accessor :authorizer_email - - # Name of the authorizer. - sig { returns(String) } - attr_accessor :authorizer_name - - # Whether the customer has been offboarded or suspended. - sig { returns(T::Boolean) } - attr_accessor :customer_has_been_offboarded - - # ID of the proof of authorization request. - sig { returns(String) } - attr_accessor :proof_of_authorization_request_id - - # Whether the account ownership was validated via credential (e.g. Plaid). - sig { returns(T::Boolean) } - attr_accessor :validated_account_ownership_via_credential - - # Whether the account ownership was validated with an account statement. - sig { returns(T::Boolean) } - attr_accessor :validated_account_ownership_with_account_statement - - # Whether the account ownership was validated with a microdeposit. - sig { returns(T::Boolean) } - attr_accessor :validated_account_ownership_with_microdeposit - - # File containing additional evidence. - sig { returns(T.nilable(String)) } - attr_reader :additional_evidence_file_id - - sig { params(additional_evidence_file_id: String).void } - attr_writer :additional_evidence_file_id - - # Company of the authorizer. - sig { returns(T.nilable(String)) } - attr_reader :authorizer_company - - sig { params(authorizer_company: String).void } - attr_writer :authorizer_company - - # IP address of the authorizer. - sig { returns(T.nilable(String)) } - attr_reader :authorizer_ip_address - - sig { params(authorizer_ip_address: String).void } - attr_writer :authorizer_ip_address - - sig do - params( - authorization_terms: String, - authorized_at: Time, - authorizer_email: String, - authorizer_name: String, - customer_has_been_offboarded: T::Boolean, - proof_of_authorization_request_id: String, - validated_account_ownership_via_credential: T::Boolean, - validated_account_ownership_with_account_statement: T::Boolean, - validated_account_ownership_with_microdeposit: T::Boolean, - additional_evidence_file_id: String, - authorizer_company: String, - authorizer_ip_address: String, - request_options: T.any(Increase::RequestOptions, Increase::Internal::AnyHash) - ) - .returns(T.attached_class) - end - def self.new( - authorization_terms:, - authorized_at:, - authorizer_email:, - authorizer_name:, - customer_has_been_offboarded:, - proof_of_authorization_request_id:, - validated_account_ownership_via_credential:, - validated_account_ownership_with_account_statement:, - validated_account_ownership_with_microdeposit:, - additional_evidence_file_id: nil, - authorizer_company: nil, - authorizer_ip_address: nil, - request_options: {} - ); end - sig do - override - .returns( - { - authorization_terms: String, - authorized_at: Time, - authorizer_email: String, - authorizer_name: String, - customer_has_been_offboarded: T::Boolean, - proof_of_authorization_request_id: String, - validated_account_ownership_via_credential: T::Boolean, - validated_account_ownership_with_account_statement: T::Boolean, - validated_account_ownership_with_microdeposit: T::Boolean, - additional_evidence_file_id: String, - authorizer_company: String, - authorizer_ip_address: String, - request_options: Increase::RequestOptions - } - ) - end - def to_hash; end - end - end -end diff --git a/rbi/lib/increase/models/proof_of_authorization_request_submission_list_params.rbi b/rbi/lib/increase/models/proof_of_authorization_request_submission_list_params.rbi deleted file mode 100644 index 5c6738be5..000000000 --- a/rbi/lib/increase/models/proof_of_authorization_request_submission_list_params.rbi +++ /dev/null @@ -1,75 +0,0 @@ -# typed: strong - -module Increase - module Models - class ProofOfAuthorizationRequestSubmissionListParams < Increase::Internal::Type::BaseModel - extend Increase::Internal::Type::RequestParameters::Converter - include Increase::Internal::Type::RequestParameters - - # Return the page of entries after this one. - sig { returns(T.nilable(String)) } - attr_reader :cursor - - sig { params(cursor: String).void } - attr_writer :cursor - - # 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). - sig { returns(T.nilable(String)) } - attr_reader :idempotency_key - - sig { params(idempotency_key: String).void } - attr_writer :idempotency_key - - # Limit the size of the list that is returned. The default (and maximum) is 100 - # objects. - sig { returns(T.nilable(Integer)) } - attr_reader :limit - - sig { params(limit: Integer).void } - attr_writer :limit - - # ID of the proof of authorization request. - sig { returns(T.nilable(String)) } - attr_reader :proof_of_authorization_request_id - - sig { params(proof_of_authorization_request_id: String).void } - attr_writer :proof_of_authorization_request_id - - sig do - params( - cursor: String, - idempotency_key: String, - limit: Integer, - proof_of_authorization_request_id: String, - request_options: T.any(Increase::RequestOptions, Increase::Internal::AnyHash) - ) - .returns(T.attached_class) - end - def self.new( - cursor: nil, - idempotency_key: nil, - limit: nil, - proof_of_authorization_request_id: nil, - request_options: {} - ) - end - - sig do - override - .returns( - { - cursor: String, - idempotency_key: String, - limit: Integer, - proof_of_authorization_request_id: String, - request_options: Increase::RequestOptions - } - ) - end - def to_hash; end - end - end -end diff --git a/rbi/lib/increase/models/proof_of_authorization_request_submission_retrieve_params.rbi b/rbi/lib/increase/models/proof_of_authorization_request_submission_retrieve_params.rbi deleted file mode 100644 index d1b50a869..000000000 --- a/rbi/lib/increase/models/proof_of_authorization_request_submission_retrieve_params.rbi +++ /dev/null @@ -1,19 +0,0 @@ -# typed: strong - -module Increase - module Models - class ProofOfAuthorizationRequestSubmissionRetrieveParams < Increase::Internal::Type::BaseModel - extend Increase::Internal::Type::RequestParameters::Converter - include Increase::Internal::Type::RequestParameters - - sig do - params(request_options: T.any(Increase::RequestOptions, Increase::Internal::AnyHash)) - .returns(T.attached_class) - end - def self.new(request_options: {}); end - - sig { override.returns({request_options: Increase::RequestOptions}) } - def to_hash; end - end - end -end diff --git a/rbi/lib/increase/resources/proof_of_authorization_request_submissions.rbi b/rbi/lib/increase/resources/proof_of_authorization_request_submissions.rbi deleted file mode 100644 index e4ebf024c..000000000 --- a/rbi/lib/increase/resources/proof_of_authorization_request_submissions.rbi +++ /dev/null @@ -1,96 +0,0 @@ -# typed: strong - -module Increase - module Resources - class ProofOfAuthorizationRequestSubmissions - # Submit Proof of Authorization - sig do - params( - authorization_terms: String, - authorized_at: Time, - authorizer_email: String, - authorizer_name: String, - customer_has_been_offboarded: T::Boolean, - proof_of_authorization_request_id: String, - validated_account_ownership_via_credential: T::Boolean, - validated_account_ownership_with_account_statement: T::Boolean, - validated_account_ownership_with_microdeposit: T::Boolean, - additional_evidence_file_id: String, - authorizer_company: String, - authorizer_ip_address: String, - request_options: T.nilable(T.any(Increase::RequestOptions, Increase::Internal::AnyHash)) - ) - .returns(Increase::Models::ProofOfAuthorizationRequestSubmission) - end - def create( - # Terms of authorization. - authorization_terms:, - # Time of authorization. - authorized_at:, - # Email of the authorizer. - authorizer_email:, - # Name of the authorizer. - authorizer_name:, - # Whether the customer has been offboarded or suspended. - customer_has_been_offboarded:, - # ID of the proof of authorization request. - proof_of_authorization_request_id:, - # Whether the account ownership was validated via credential (e.g. Plaid). - validated_account_ownership_via_credential:, - # Whether the account ownership was validated with an account statement. - validated_account_ownership_with_account_statement:, - # Whether the account ownership was validated with a microdeposit. - validated_account_ownership_with_microdeposit:, - # File containing additional evidence. - additional_evidence_file_id: nil, - # Company of the authorizer. - authorizer_company: nil, - # IP address of the authorizer. - authorizer_ip_address: nil, - request_options: {} - ); end - # Retrieve a Proof of Authorization Request Submission - sig do - params( - proof_of_authorization_request_submission_id: String, - request_options: T.nilable(T.any(Increase::RequestOptions, Increase::Internal::AnyHash)) - ) - .returns(Increase::Models::ProofOfAuthorizationRequestSubmission) - end - def retrieve( - # The identifier of the Proof of Authorization Request Submission. - proof_of_authorization_request_submission_id, - request_options: {} - ); end - # List Proof of Authorization Request Submissions - sig do - params( - cursor: String, - idempotency_key: String, - limit: Integer, - proof_of_authorization_request_id: String, - request_options: T.nilable(T.any(Increase::RequestOptions, Increase::Internal::AnyHash)) - ) - .returns(Increase::Internal::Page[Increase::Models::ProofOfAuthorizationRequestSubmission]) - end - def list( - # Return the page of entries after this one. - cursor: nil, - # 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). - idempotency_key: nil, - # Limit the size of the list that is returned. The default (and maximum) is 100 - # objects. - limit: nil, - # ID of the proof of authorization request. - proof_of_authorization_request_id: nil, - request_options: {} - ); end - # @api private - sig { params(client: Increase::Client).returns(T.attached_class) } - def self.new(client:); end - end - end -end diff --git a/rbi/lib/increase/resources/proof_of_authorization_requests.rbi b/rbi/lib/increase/resources/proof_of_authorization_requests.rbi deleted file mode 100644 index abfdfa30e..000000000 --- a/rbi/lib/increase/resources/proof_of_authorization_requests.rbi +++ /dev/null @@ -1,43 +0,0 @@ -# typed: strong - -module Increase - module Resources - class ProofOfAuthorizationRequests - # Retrieve a Proof of Authorization Request - sig do - params( - proof_of_authorization_request_id: String, - request_options: T.nilable(T.any(Increase::RequestOptions, Increase::Internal::AnyHash)) - ) - .returns(Increase::Models::ProofOfAuthorizationRequest) - end - def retrieve( - # The identifier of the Proof of Authorization Request. - proof_of_authorization_request_id, - request_options: {} - ); end - # List Proof of Authorization Requests - sig do - params( - created_at: T.any(Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt, Increase::Internal::AnyHash), - cursor: String, - limit: Integer, - request_options: T.nilable(T.any(Increase::RequestOptions, Increase::Internal::AnyHash)) - ) - .returns(Increase::Internal::Page[Increase::Models::ProofOfAuthorizationRequest]) - end - def list( - created_at: nil, - # Return the page of entries after this one. - cursor: nil, - # Limit the size of the list that is returned. The default (and maximum) is 100 - # objects. - limit: nil, - request_options: {} - ); end - # @api private - sig { params(client: Increase::Client).returns(T.attached_class) } - def self.new(client:); end - end - end -end diff --git a/sig/increase/client.rbs b/sig/increase/client.rbs index 19cf48add..f4139593f 100644 --- a/sig/increase/client.rbs +++ b/sig/increase/client.rbs @@ -81,10 +81,6 @@ module Increase attr_reader programs: Increase::Resources::Programs - attr_reader proof_of_authorization_requests: Increase::Resources::ProofOfAuthorizationRequests - - attr_reader proof_of_authorization_request_submissions: Increase::Resources::ProofOfAuthorizationRequestSubmissions - attr_reader account_statements: Increase::Resources::AccountStatements attr_reader files: Increase::Resources::Files diff --git a/sig/increase/models/event.rbs b/sig/increase/models/event.rbs index 7b972695d..4656b3d7e 100644 --- a/sig/increase/models/event.rbs +++ b/sig/increase/models/event.rbs @@ -107,8 +107,6 @@ module Increase | :"physical_card_profile.updated" | :"proof_of_authorization_request.created" | :"proof_of_authorization_request.updated" - | :"proof_of_authorization_request_submission.created" - | :"proof_of_authorization_request_submission.updated" | :"real_time_decision.card_authorization_requested" | :"real_time_decision.digital_wallet_token_requested" | :"real_time_decision.digital_wallet_authentication_requested" @@ -343,12 +341,6 @@ module Increase # Occurs whenever a Proof of Authorization Request is updated. PROOF_OF_AUTHORIZATION_REQUEST_UPDATED: :"proof_of_authorization_request.updated" - # Occurs whenever a Proof of Authorization Request Submission is created. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_CREATED: :"proof_of_authorization_request_submission.created" - - # Occurs whenever a Proof of Authorization Request Submission is updated. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_UPDATED: :"proof_of_authorization_request_submission.updated" - # Occurs whenever a Real-Time Decision is created in response to a card authorization. REAL_TIME_DECISION_CARD_AUTHORIZATION_REQUESTED: :"real_time_decision.card_authorization_requested" diff --git a/sig/increase/models/event_list_params.rbs b/sig/increase/models/event_list_params.rbs index dc023a447..237c20bd7 100644 --- a/sig/increase/models/event_list_params.rbs +++ b/sig/increase/models/event_list_params.rbs @@ -138,8 +138,6 @@ module Increase | :"physical_card_profile.updated" | :"proof_of_authorization_request.created" | :"proof_of_authorization_request.updated" - | :"proof_of_authorization_request_submission.created" - | :"proof_of_authorization_request_submission.updated" | :"real_time_decision.card_authorization_requested" | :"real_time_decision.digital_wallet_token_requested" | :"real_time_decision.digital_wallet_authentication_requested" @@ -374,12 +372,6 @@ module Increase # Occurs whenever a Proof of Authorization Request is updated. PROOF_OF_AUTHORIZATION_REQUEST_UPDATED: :"proof_of_authorization_request.updated" - # Occurs whenever a Proof of Authorization Request Submission is created. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_CREATED: :"proof_of_authorization_request_submission.created" - - # Occurs whenever a Proof of Authorization Request Submission is updated. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_UPDATED: :"proof_of_authorization_request_submission.updated" - # Occurs whenever a Real-Time Decision is created in response to a card authorization. REAL_TIME_DECISION_CARD_AUTHORIZATION_REQUESTED: :"real_time_decision.card_authorization_requested" diff --git a/sig/increase/models/event_subscription.rbs b/sig/increase/models/event_subscription.rbs index 20a7680ea..ca540db0e 100644 --- a/sig/increase/models/event_subscription.rbs +++ b/sig/increase/models/event_subscription.rbs @@ -115,8 +115,6 @@ module Increase | :"physical_card_profile.updated" | :"proof_of_authorization_request.created" | :"proof_of_authorization_request.updated" - | :"proof_of_authorization_request_submission.created" - | :"proof_of_authorization_request_submission.updated" | :"real_time_decision.card_authorization_requested" | :"real_time_decision.digital_wallet_token_requested" | :"real_time_decision.digital_wallet_authentication_requested" @@ -351,12 +349,6 @@ module Increase # Occurs whenever a Proof of Authorization Request is updated. PROOF_OF_AUTHORIZATION_REQUEST_UPDATED: :"proof_of_authorization_request.updated" - # Occurs whenever a Proof of Authorization Request Submission is created. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_CREATED: :"proof_of_authorization_request_submission.created" - - # Occurs whenever a Proof of Authorization Request Submission is updated. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_UPDATED: :"proof_of_authorization_request_submission.updated" - # Occurs whenever a Real-Time Decision is created in response to a card authorization. REAL_TIME_DECISION_CARD_AUTHORIZATION_REQUESTED: :"real_time_decision.card_authorization_requested" diff --git a/sig/increase/models/event_subscription_create_params.rbs b/sig/increase/models/event_subscription_create_params.rbs index b6f47930b..8fc3669de 100644 --- a/sig/increase/models/event_subscription_create_params.rbs +++ b/sig/increase/models/event_subscription_create_params.rbs @@ -112,8 +112,6 @@ module Increase | :"physical_card_profile.updated" | :"proof_of_authorization_request.created" | :"proof_of_authorization_request.updated" - | :"proof_of_authorization_request_submission.created" - | :"proof_of_authorization_request_submission.updated" | :"real_time_decision.card_authorization_requested" | :"real_time_decision.digital_wallet_token_requested" | :"real_time_decision.digital_wallet_authentication_requested" @@ -348,12 +346,6 @@ module Increase # Occurs whenever a Proof of Authorization Request is updated. PROOF_OF_AUTHORIZATION_REQUEST_UPDATED: :"proof_of_authorization_request.updated" - # Occurs whenever a Proof of Authorization Request Submission is created. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_CREATED: :"proof_of_authorization_request_submission.created" - - # Occurs whenever a Proof of Authorization Request Submission is updated. - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION_UPDATED: :"proof_of_authorization_request_submission.updated" - # Occurs whenever a Real-Time Decision is created in response to a card authorization. REAL_TIME_DECISION_CARD_AUTHORIZATION_REQUESTED: :"real_time_decision.card_authorization_requested" diff --git a/sig/increase/models/proof_of_authorization_request.rbs b/sig/increase/models/proof_of_authorization_request.rbs deleted file mode 100644 index 2baf8d0fe..000000000 --- a/sig/increase/models/proof_of_authorization_request.rbs +++ /dev/null @@ -1,58 +0,0 @@ -module Increase - module Models - type proof_of_authorization_request = - { - id: String, - ach_transfers: ::Array[Increase::Models::ProofOfAuthorizationRequest::ACHTransfer], - created_at: Time, - due_on: Time, - type: Increase::Models::ProofOfAuthorizationRequest::type_, - updated_at: Time - } - - class ProofOfAuthorizationRequest < Increase::Internal::Type::BaseModel - attr_accessor id: String - - attr_accessor ach_transfers: ::Array[Increase::Models::ProofOfAuthorizationRequest::ACHTransfer] - - attr_accessor created_at: Time - - attr_accessor due_on: Time - - attr_accessor type: Increase::Models::ProofOfAuthorizationRequest::type_ - - attr_accessor updated_at: Time - - def initialize: ( - id: String, - ach_transfers: ::Array[Increase::Models::ProofOfAuthorizationRequest::ACHTransfer], - created_at: Time, - due_on: Time, - type: Increase::Models::ProofOfAuthorizationRequest::type_, - updated_at: Time - ) -> void - - def to_hash: -> Increase::Models::proof_of_authorization_request - - type ach_transfer = { id: String } - - class ACHTransfer < Increase::Internal::Type::BaseModel - attr_accessor id: String - - def initialize: (id: String) -> void - - def to_hash: -> Increase::Models::ProofOfAuthorizationRequest::ach_transfer - end - - type type_ = :proof_of_authorization_request - - module Type - extend Increase::Internal::Type::Enum - - PROOF_OF_AUTHORIZATION_REQUEST: :proof_of_authorization_request - - def self?.values: -> ::Array[Increase::Models::ProofOfAuthorizationRequest::type_] - end - end - end -end diff --git a/sig/increase/models/proof_of_authorization_request_list_params.rbs b/sig/increase/models/proof_of_authorization_request_list_params.rbs deleted file mode 100644 index 8f2fc1f9f..000000000 --- a/sig/increase/models/proof_of_authorization_request_list_params.rbs +++ /dev/null @@ -1,69 +0,0 @@ -module Increase - module Models - type proof_of_authorization_request_list_params = - { - created_at: Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt, - cursor: String, - limit: Integer - } - & Increase::Internal::Type::request_parameters - - class ProofOfAuthorizationRequestListParams < Increase::Internal::Type::BaseModel - extend Increase::Internal::Type::RequestParameters::Converter - include Increase::Internal::Type::RequestParameters - - attr_reader created_at: Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt? - - def created_at=: ( - Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt - ) -> Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt - - attr_reader cursor: String? - - def cursor=: (String) -> String - - attr_reader limit: Integer? - - def limit=: (Integer) -> Integer - - def initialize: ( - ?created_at: Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt, - ?cursor: String, - ?limit: Integer, - ?request_options: Increase::request_opts - ) -> void - - def to_hash: -> Increase::Models::proof_of_authorization_request_list_params - - type created_at = - { after: Time, before: Time, on_or_after: Time, on_or_before: Time } - - class CreatedAt < Increase::Internal::Type::BaseModel - attr_reader after: Time? - - def after=: (Time) -> Time - - attr_reader before: Time? - - def before=: (Time) -> Time - - attr_reader on_or_after: Time? - - def on_or_after=: (Time) -> Time - - attr_reader on_or_before: Time? - - def on_or_before=: (Time) -> Time - - def initialize: ( - ?after: Time, - ?before: Time, - ?on_or_after: Time, - ?on_or_before: Time - ) -> void - - def to_hash: -> Increase::Models::ProofOfAuthorizationRequestListParams::created_at - end - end - end -end diff --git a/sig/increase/models/proof_of_authorization_request_retrieve_params.rbs b/sig/increase/models/proof_of_authorization_request_retrieve_params.rbs deleted file mode 100644 index 764d4e8e9..000000000 --- a/sig/increase/models/proof_of_authorization_request_retrieve_params.rbs +++ /dev/null @@ -1,15 +0,0 @@ -module Increase - module Models - type proof_of_authorization_request_retrieve_params = - { } & Increase::Internal::Type::request_parameters - - class ProofOfAuthorizationRequestRetrieveParams < Increase::Internal::Type::BaseModel - extend Increase::Internal::Type::RequestParameters::Converter - include Increase::Internal::Type::RequestParameters - - def initialize: (?request_options: Increase::request_opts) -> void - - def to_hash: -> Increase::Models::proof_of_authorization_request_retrieve_params - end - end -end diff --git a/sig/increase/models/proof_of_authorization_request_submission.rbs b/sig/increase/models/proof_of_authorization_request_submission.rbs deleted file mode 100644 index 9edb67929..000000000 --- a/sig/increase/models/proof_of_authorization_request_submission.rbs +++ /dev/null @@ -1,130 +0,0 @@ -module Increase - module Models - type proof_of_authorization_request_submission = - { - id: String, - additional_evidence_files: ::Array[Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile], - authorization_terms: String, - authorized_at: Time, - authorizer_company: String?, - authorizer_email: String?, - authorizer_ip_address: String?, - authorizer_name: String?, - created_at: Time, - customer_has_been_offboarded: bool?, - idempotency_key: String?, - proof_of_authorization_request_id: String, - status: Increase::Models::ProofOfAuthorizationRequestSubmission::status, - type: Increase::Models::ProofOfAuthorizationRequestSubmission::type_, - updated_at: Time, - validated_account_ownership_via_credential: bool?, - validated_account_ownership_with_account_statement: bool?, - validated_account_ownership_with_microdeposit: bool? - } - - class ProofOfAuthorizationRequestSubmission < Increase::Internal::Type::BaseModel - attr_accessor id: String - - attr_accessor additional_evidence_files: ::Array[Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile] - - attr_accessor authorization_terms: String - - attr_accessor authorized_at: Time - - attr_accessor authorizer_company: String? - - attr_accessor authorizer_email: String? - - attr_accessor authorizer_ip_address: String? - - attr_accessor authorizer_name: String? - - attr_accessor created_at: Time - - attr_accessor customer_has_been_offboarded: bool? - - attr_accessor idempotency_key: String? - - attr_accessor proof_of_authorization_request_id: String - - attr_accessor status: Increase::Models::ProofOfAuthorizationRequestSubmission::status - - attr_accessor type: Increase::Models::ProofOfAuthorizationRequestSubmission::type_ - - attr_accessor updated_at: Time - - attr_accessor validated_account_ownership_via_credential: bool? - - attr_accessor validated_account_ownership_with_account_statement: bool? - - attr_accessor validated_account_ownership_with_microdeposit: bool? - - def initialize: ( - id: String, - additional_evidence_files: ::Array[Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile], - authorization_terms: String, - authorized_at: Time, - authorizer_company: String?, - authorizer_email: String?, - authorizer_ip_address: String?, - authorizer_name: String?, - created_at: Time, - customer_has_been_offboarded: bool?, - idempotency_key: String?, - proof_of_authorization_request_id: String, - status: Increase::Models::ProofOfAuthorizationRequestSubmission::status, - type: Increase::Models::ProofOfAuthorizationRequestSubmission::type_, - updated_at: Time, - validated_account_ownership_via_credential: bool?, - validated_account_ownership_with_account_statement: bool?, - validated_account_ownership_with_microdeposit: bool? - ) -> void - - def to_hash: -> Increase::Models::proof_of_authorization_request_submission - - type additional_evidence_file = { file_id: String } - - class AdditionalEvidenceFile < Increase::Internal::Type::BaseModel - attr_accessor file_id: String - - def initialize: (file_id: String) -> void - - def to_hash: -> Increase::Models::ProofOfAuthorizationRequestSubmission::additional_evidence_file - end - - type status = - :pending_review | :rejected | :canceled | :pending_sending | :sent - - module Status - extend Increase::Internal::Type::Enum - - # The proof of authorization request submission is pending review. - PENDING_REVIEW: :pending_review - - # The proof of authorization request submission was rejected. - REJECTED: :rejected - - # The proof of authorization request submission was canceled and replaced with another. - CANCELED: :canceled - - # The proof of authorization request submission is pending sending. - PENDING_SENDING: :pending_sending - - # The proof of authorization request submission was sent. - SENT: :sent - - def self?.values: -> ::Array[Increase::Models::ProofOfAuthorizationRequestSubmission::status] - end - - type type_ = :proof_of_authorization_request_submission - - module Type - extend Increase::Internal::Type::Enum - - PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION: :proof_of_authorization_request_submission - - def self?.values: -> ::Array[Increase::Models::ProofOfAuthorizationRequestSubmission::type_] - end - end - end -end diff --git a/sig/increase/models/proof_of_authorization_request_submission_create_params.rbs b/sig/increase/models/proof_of_authorization_request_submission_create_params.rbs deleted file mode 100644 index 5e47089ca..000000000 --- a/sig/increase/models/proof_of_authorization_request_submission_create_params.rbs +++ /dev/null @@ -1,73 +0,0 @@ -module Increase - module Models - type proof_of_authorization_request_submission_create_params = - { - authorization_terms: String, - authorized_at: Time, - authorizer_email: String, - authorizer_name: String, - customer_has_been_offboarded: bool, - proof_of_authorization_request_id: String, - validated_account_ownership_via_credential: bool, - validated_account_ownership_with_account_statement: bool, - validated_account_ownership_with_microdeposit: bool, - additional_evidence_file_id: String, - authorizer_company: String, - authorizer_ip_address: String - } - & Increase::Internal::Type::request_parameters - - class ProofOfAuthorizationRequestSubmissionCreateParams < Increase::Internal::Type::BaseModel - extend Increase::Internal::Type::RequestParameters::Converter - include Increase::Internal::Type::RequestParameters - - attr_accessor authorization_terms: String - - attr_accessor authorized_at: Time - - attr_accessor authorizer_email: String - - attr_accessor authorizer_name: String - - attr_accessor customer_has_been_offboarded: bool - - attr_accessor proof_of_authorization_request_id: String - - attr_accessor validated_account_ownership_via_credential: bool - - attr_accessor validated_account_ownership_with_account_statement: bool - - attr_accessor validated_account_ownership_with_microdeposit: bool - - attr_reader additional_evidence_file_id: String? - - def additional_evidence_file_id=: (String) -> String - - attr_reader authorizer_company: String? - - def authorizer_company=: (String) -> String - - attr_reader authorizer_ip_address: String? - - def authorizer_ip_address=: (String) -> String - - def initialize: ( - authorization_terms: String, - authorized_at: Time, - authorizer_email: String, - authorizer_name: String, - customer_has_been_offboarded: bool, - proof_of_authorization_request_id: String, - validated_account_ownership_via_credential: bool, - validated_account_ownership_with_account_statement: bool, - validated_account_ownership_with_microdeposit: bool, - ?additional_evidence_file_id: String, - ?authorizer_company: String, - ?authorizer_ip_address: String, - ?request_options: Increase::request_opts - ) -> void - - def to_hash: -> Increase::Models::proof_of_authorization_request_submission_create_params - end - end -end diff --git a/sig/increase/models/proof_of_authorization_request_submission_list_params.rbs b/sig/increase/models/proof_of_authorization_request_submission_list_params.rbs deleted file mode 100644 index f8a350b80..000000000 --- a/sig/increase/models/proof_of_authorization_request_submission_list_params.rbs +++ /dev/null @@ -1,43 +0,0 @@ -module Increase - module Models - type proof_of_authorization_request_submission_list_params = - { - cursor: String, - idempotency_key: String, - limit: Integer, - proof_of_authorization_request_id: String - } - & Increase::Internal::Type::request_parameters - - class ProofOfAuthorizationRequestSubmissionListParams < Increase::Internal::Type::BaseModel - extend Increase::Internal::Type::RequestParameters::Converter - include Increase::Internal::Type::RequestParameters - - 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 proof_of_authorization_request_id: String? - - def proof_of_authorization_request_id=: (String) -> String - - def initialize: ( - ?cursor: String, - ?idempotency_key: String, - ?limit: Integer, - ?proof_of_authorization_request_id: String, - ?request_options: Increase::request_opts - ) -> void - - def to_hash: -> Increase::Models::proof_of_authorization_request_submission_list_params - end - end -end diff --git a/sig/increase/models/proof_of_authorization_request_submission_retrieve_params.rbs b/sig/increase/models/proof_of_authorization_request_submission_retrieve_params.rbs deleted file mode 100644 index 85eba862b..000000000 --- a/sig/increase/models/proof_of_authorization_request_submission_retrieve_params.rbs +++ /dev/null @@ -1,15 +0,0 @@ -module Increase - module Models - type proof_of_authorization_request_submission_retrieve_params = - { } & Increase::Internal::Type::request_parameters - - class ProofOfAuthorizationRequestSubmissionRetrieveParams < Increase::Internal::Type::BaseModel - extend Increase::Internal::Type::RequestParameters::Converter - include Increase::Internal::Type::RequestParameters - - def initialize: (?request_options: Increase::request_opts) -> void - - def to_hash: -> Increase::Models::proof_of_authorization_request_submission_retrieve_params - end - end -end diff --git a/sig/increase/resources/proof_of_authorization_request_submissions.rbs b/sig/increase/resources/proof_of_authorization_request_submissions.rbs deleted file mode 100644 index 20a934c31..000000000 --- a/sig/increase/resources/proof_of_authorization_request_submissions.rbs +++ /dev/null @@ -1,36 +0,0 @@ -module Increase - module Resources - class ProofOfAuthorizationRequestSubmissions - def create: ( - authorization_terms: String, - authorized_at: Time, - authorizer_email: String, - authorizer_name: String, - customer_has_been_offboarded: bool, - proof_of_authorization_request_id: String, - validated_account_ownership_via_credential: bool, - validated_account_ownership_with_account_statement: bool, - validated_account_ownership_with_microdeposit: bool, - ?additional_evidence_file_id: String, - ?authorizer_company: String, - ?authorizer_ip_address: String, - ?request_options: Increase::request_opts - ) -> Increase::Models::ProofOfAuthorizationRequestSubmission - - def retrieve: ( - String proof_of_authorization_request_submission_id, - ?request_options: Increase::request_opts - ) -> Increase::Models::ProofOfAuthorizationRequestSubmission - - def list: ( - ?cursor: String, - ?idempotency_key: String, - ?limit: Integer, - ?proof_of_authorization_request_id: String, - ?request_options: Increase::request_opts - ) -> Increase::Internal::Page[Increase::Models::ProofOfAuthorizationRequestSubmission] - - def initialize: (client: Increase::Client) -> void - end - end -end diff --git a/sig/increase/resources/proof_of_authorization_requests.rbs b/sig/increase/resources/proof_of_authorization_requests.rbs deleted file mode 100644 index cbdae93c0..000000000 --- a/sig/increase/resources/proof_of_authorization_requests.rbs +++ /dev/null @@ -1,19 +0,0 @@ -module Increase - module Resources - class ProofOfAuthorizationRequests - def retrieve: ( - String proof_of_authorization_request_id, - ?request_options: Increase::request_opts - ) -> Increase::Models::ProofOfAuthorizationRequest - - def list: ( - ?created_at: Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt, - ?cursor: String, - ?limit: Integer, - ?request_options: Increase::request_opts - ) -> Increase::Internal::Page[Increase::Models::ProofOfAuthorizationRequest] - - def initialize: (client: Increase::Client) -> void - end - end -end diff --git a/test/increase/resources/proof_of_authorization_request_submissions_test.rb b/test/increase/resources/proof_of_authorization_request_submissions_test.rb deleted file mode 100644 index dc395ec31..000000000 --- a/test/increase/resources/proof_of_authorization_request_submissions_test.rb +++ /dev/null @@ -1,119 +0,0 @@ -# frozen_string_literal: true - -require_relative "../test_helper" - -class Increase::Test::Resources::ProofOfAuthorizationRequestSubmissionsTest < Increase::Test::ResourceTest - def test_create_required_params - response = - @increase.proof_of_authorization_request_submissions.create( - authorization_terms: "I agree to the terms of service.", - authorized_at: "2020-01-31T23:59:59Z", - authorizer_email: "user@example.com", - authorizer_name: "Ian Crease", - customer_has_been_offboarded: true, - proof_of_authorization_request_id: "proof_of_authorization_request_iwp8no25h3rjvil6ad3b", - validated_account_ownership_via_credential: true, - validated_account_ownership_with_account_statement: true, - validated_account_ownership_with_microdeposit: true - ) - - assert_pattern do - response => Increase::Models::ProofOfAuthorizationRequestSubmission - end - - assert_pattern do - response => { - id: String, - additional_evidence_files: ^(Increase::Internal::Type::ArrayOf[Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile]), - authorization_terms: String, - authorized_at: Time, - authorizer_company: String | nil, - authorizer_email: String | nil, - authorizer_ip_address: String | nil, - authorizer_name: String | nil, - created_at: Time, - customer_has_been_offboarded: Increase::Internal::Type::Boolean | nil, - idempotency_key: String | nil, - proof_of_authorization_request_id: String, - status: Increase::Models::ProofOfAuthorizationRequestSubmission::Status, - type: Increase::Models::ProofOfAuthorizationRequestSubmission::Type, - updated_at: Time, - validated_account_ownership_via_credential: Increase::Internal::Type::Boolean | nil, - validated_account_ownership_with_account_statement: Increase::Internal::Type::Boolean | nil, - validated_account_ownership_with_microdeposit: Increase::Internal::Type::Boolean | nil - } - end - end - - def test_retrieve - response = - @increase.proof_of_authorization_request_submissions.retrieve( - "proof_of_authorization_request_submission_id" - ) - - assert_pattern do - response => Increase::Models::ProofOfAuthorizationRequestSubmission - end - - assert_pattern do - response => { - id: String, - additional_evidence_files: ^(Increase::Internal::Type::ArrayOf[Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile]), - authorization_terms: String, - authorized_at: Time, - authorizer_company: String | nil, - authorizer_email: String | nil, - authorizer_ip_address: String | nil, - authorizer_name: String | nil, - created_at: Time, - customer_has_been_offboarded: Increase::Internal::Type::Boolean | nil, - idempotency_key: String | nil, - proof_of_authorization_request_id: String, - status: Increase::Models::ProofOfAuthorizationRequestSubmission::Status, - type: Increase::Models::ProofOfAuthorizationRequestSubmission::Type, - updated_at: Time, - validated_account_ownership_via_credential: Increase::Internal::Type::Boolean | nil, - validated_account_ownership_with_account_statement: Increase::Internal::Type::Boolean | nil, - validated_account_ownership_with_microdeposit: Increase::Internal::Type::Boolean | nil - } - end - end - - def test_list - response = @increase.proof_of_authorization_request_submissions.list - - assert_pattern do - response => Increase::Internal::Page - end - - row = response.to_enum.first - return if row.nil? - - assert_pattern do - row => Increase::Models::ProofOfAuthorizationRequestSubmission - end - - assert_pattern do - row => { - id: String, - additional_evidence_files: ^(Increase::Internal::Type::ArrayOf[Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile]), - authorization_terms: String, - authorized_at: Time, - authorizer_company: String | nil, - authorizer_email: String | nil, - authorizer_ip_address: String | nil, - authorizer_name: String | nil, - created_at: Time, - customer_has_been_offboarded: Increase::Internal::Type::Boolean | nil, - idempotency_key: String | nil, - proof_of_authorization_request_id: String, - status: Increase::Models::ProofOfAuthorizationRequestSubmission::Status, - type: Increase::Models::ProofOfAuthorizationRequestSubmission::Type, - updated_at: Time, - validated_account_ownership_via_credential: Increase::Internal::Type::Boolean | nil, - validated_account_ownership_with_account_statement: Increase::Internal::Type::Boolean | nil, - validated_account_ownership_with_microdeposit: Increase::Internal::Type::Boolean | nil - } - end - end -end diff --git a/test/increase/resources/proof_of_authorization_requests_test.rb b/test/increase/resources/proof_of_authorization_requests_test.rb deleted file mode 100644 index 0536e2620..000000000 --- a/test/increase/resources/proof_of_authorization_requests_test.rb +++ /dev/null @@ -1,50 +0,0 @@ -# frozen_string_literal: true - -require_relative "../test_helper" - -class Increase::Test::Resources::ProofOfAuthorizationRequestsTest < Increase::Test::ResourceTest - def test_retrieve - response = @increase.proof_of_authorization_requests.retrieve("proof_of_authorization_request_id") - - assert_pattern do - response => Increase::Models::ProofOfAuthorizationRequest - end - - assert_pattern do - response => { - id: String, - ach_transfers: ^(Increase::Internal::Type::ArrayOf[Increase::Models::ProofOfAuthorizationRequest::ACHTransfer]), - created_at: Time, - due_on: Time, - type: Increase::Models::ProofOfAuthorizationRequest::Type, - updated_at: Time - } - end - end - - def test_list - response = @increase.proof_of_authorization_requests.list - - assert_pattern do - response => Increase::Internal::Page - end - - row = response.to_enum.first - return if row.nil? - - assert_pattern do - row => Increase::Models::ProofOfAuthorizationRequest - end - - assert_pattern do - row => { - id: String, - ach_transfers: ^(Increase::Internal::Type::ArrayOf[Increase::Models::ProofOfAuthorizationRequest::ACHTransfer]), - created_at: Time, - due_on: Time, - type: Increase::Models::ProofOfAuthorizationRequest::Type, - updated_at: Time - } - end - end -end From 79b309d21bf855bdd27c7822cf6735e83d3cb484 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 22 Apr 2025 20:39:18 +0000 Subject: [PATCH 02/16] chore(internal): codegen related update --- .github/workflows/ci.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index b2c0c8f79..4f7276bb2 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -10,6 +10,7 @@ on: jobs: lint: + timeout-minutes: 10 name: lint runs-on: ubuntu-latest steps: @@ -25,6 +26,7 @@ jobs: - name: Run lints run: ./scripts/lint test: + timeout-minutes: 10 name: test runs-on: ubuntu-latest steps: From 81e1f3ac48fe1e256ae0f203b902a1b3e87901f9 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 23 Apr 2025 17:56:59 +0000 Subject: [PATCH 03/16] chore(ci): run on more branches and use depot runners --- .github/workflows/ci.yml | 17 +++++++++-------- .github/workflows/publish-gem.yml | 2 +- .github/workflows/release-doctor.yml | 2 +- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 4f7276bb2..85872a3c4 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,18 +1,19 @@ name: CI on: push: - branches: - - main - pull_request: - branches: - - main - - next + branches-ignore: + - 'generated' + - 'codegen/**' + - 'integrated/**' + - 'stl-preview-head/**' + - 'stl-preview-base/**' jobs: lint: timeout-minutes: 10 name: lint - runs-on: ubuntu-latest + runs-on: depot-ubuntu-24.04 + steps: - uses: actions/checkout@v4 - name: Set up Ruby @@ -28,7 +29,7 @@ jobs: test: timeout-minutes: 10 name: test - runs-on: ubuntu-latest + runs-on: depot-ubuntu-24.04 steps: - uses: actions/checkout@v4 - name: Set up Ruby diff --git a/.github/workflows/publish-gem.yml b/.github/workflows/publish-gem.yml index 9ebe2490c..bc50b4479 100644 --- a/.github/workflows/publish-gem.yml +++ b/.github/workflows/publish-gem.yml @@ -11,7 +11,7 @@ on: jobs: publish: name: publish - runs-on: ubuntu-latest + runs-on: depot-ubuntu-24.04 steps: - uses: actions/checkout@v4 diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml index f2a1d3f64..d8f8d124f 100644 --- a/.github/workflows/release-doctor.yml +++ b/.github/workflows/release-doctor.yml @@ -8,7 +8,7 @@ on: jobs: release_doctor: name: release doctor - runs-on: ubuntu-latest + runs-on: depot-ubuntu-24.04 if: github.repository == 'Increase/increase-ruby' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next') steps: From 0ab95d54a80ef309144a61b51543bfb298f44f22 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 23 Apr 2025 20:00:25 +0000 Subject: [PATCH 04/16] chore(ci): only use depot for staging repos --- .github/workflows/ci.yml | 4 ++-- .github/workflows/publish-gem.yml | 2 +- .github/workflows/release-doctor.yml | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 85872a3c4..433691f13 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -12,7 +12,7 @@ jobs: lint: timeout-minutes: 10 name: lint - runs-on: depot-ubuntu-24.04 + runs-on: ${{ github.repository == 'stainless-sdks/increase-ruby' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} steps: - uses: actions/checkout@v4 @@ -29,7 +29,7 @@ jobs: test: timeout-minutes: 10 name: test - runs-on: depot-ubuntu-24.04 + runs-on: ${{ github.repository == 'stainless-sdks/increase-ruby' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} steps: - uses: actions/checkout@v4 - name: Set up Ruby diff --git a/.github/workflows/publish-gem.yml b/.github/workflows/publish-gem.yml index bc50b4479..9ebe2490c 100644 --- a/.github/workflows/publish-gem.yml +++ b/.github/workflows/publish-gem.yml @@ -11,7 +11,7 @@ on: jobs: publish: name: publish - runs-on: depot-ubuntu-24.04 + runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml index d8f8d124f..f2a1d3f64 100644 --- a/.github/workflows/release-doctor.yml +++ b/.github/workflows/release-doctor.yml @@ -8,7 +8,7 @@ on: jobs: release_doctor: name: release doctor - runs-on: depot-ubuntu-24.04 + runs-on: ubuntu-latest if: github.repository == 'Increase/increase-ruby' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next') steps: From 6ce04be506ecb273342936ed47e4996cd2173fef Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 23 Apr 2025 22:10:02 +0000 Subject: [PATCH 05/16] chore: broadly detect json family of content-type headers --- lib/increase/internal/util.rb | 13 +++++++++---- rbi/lib/increase/internal/util.rbi | 3 +++ sig/increase/internal/util.rbs | 3 +++ test/increase/internal/util_test.rb | 16 ++++++++++++++++ 4 files changed, 31 insertions(+), 4 deletions(-) diff --git a/lib/increase/internal/util.rb b/lib/increase/internal/util.rb index 1e54c71ff..b3e863fab 100644 --- a/lib/increase/internal/util.rb +++ b/lib/increase/internal/util.rb @@ -471,6 +471,11 @@ def writable_enum(&blk) end end + # @type [Regexp] + JSON_CONTENT = %r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)} + # @type [Regexp] + JSONL_CONTENT = %r{^application/(?:x-)?jsonl} + class << self # @api private # @@ -563,9 +568,9 @@ def encode_content(headers, body) body = body.inner if body.is_a?(Increase::Internal::Util::SerializationAdapter) case [content_type, body] - in [%r{^application/(?:vnd\.api\+)?json}, Hash | Array | -> { primitive?(_1) }] + in [Increase::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }] [headers, JSON.fast_generate(body)] - in [%r{^application/(?:x-)?jsonl}, Enumerable] unless body.is_a?(StringIO) || body.is_a?(IO) + in [Increase::Internal::Util::JSONL_CONTENT, Enumerable] unless body.is_a?(StringIO) || body.is_a?(IO) [headers, body.lazy.map { JSON.fast_generate(_1) }] in [%r{^multipart/form-data}, Hash | Pathname | StringIO | IO] boundary, strio = encode_multipart_streaming(body) @@ -611,7 +616,7 @@ def force_charset!(content_type, text:) # @return [Object] def decode_content(headers, stream:, suppress_error: false) case (content_type = headers["content-type"]) - in %r{^application/(?:vnd\.api\+)?json} + in Increase::Internal::Util::JSON_CONTENT json = stream.to_a.join begin JSON.parse(json, symbolize_names: true) @@ -619,7 +624,7 @@ def decode_content(headers, stream:, suppress_error: false) raise e unless suppress_error json end - in %r{^application/(?:x-)?jsonl} + in Increase::Internal::Util::JSONL_CONTENT lines = decode_lines(stream) chain_fused(lines) do |y| lines.each { y << JSON.parse(_1, symbolize_names: true) } diff --git a/rbi/lib/increase/internal/util.rbi b/rbi/lib/increase/internal/util.rbi index 0ce77413d..ad5e1b3df 100644 --- a/rbi/lib/increase/internal/util.rbi +++ b/rbi/lib/increase/internal/util.rbi @@ -192,6 +192,9 @@ module Increase def writable_enum(&blk); end end + JSON_CONTENT = T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp) + JSONL_CONTENT = T.let(%r{^application/(?:x-)?jsonl}, Regexp) + class << self # @api private sig do diff --git a/sig/increase/internal/util.rbs b/sig/increase/internal/util.rbs index 4b13b048b..f9e9d3ed8 100644 --- a/sig/increase/internal/util.rbs +++ b/sig/increase/internal/util.rbs @@ -103,6 +103,9 @@ module Increase (Enumerator::Yielder y) -> void } -> Enumerable[String] + JSON_CONTENT: Regexp + JSONL_CONTENT: Regexp + def self?.write_multipart_chunk: ( Enumerator::Yielder y, boundary: String, diff --git a/test/increase/internal/util_test.rb b/test/increase/internal/util_test.rb index 4a671c043..cb585d2c1 100644 --- a/test/increase/internal/util_test.rb +++ b/test/increase/internal/util_test.rb @@ -157,6 +157,22 @@ def test_joining_queries end end +class Increase::Test::RegexMatchTest < Minitest::Test + def test_json_content + cases = { + "application/json" => true, + "application/jsonl" => false, + "application/vnd.github.v3+json" => true, + "application/vnd.api+json" => true + } + cases.each do |header, _verdict| + assert_pattern do + Increase::Internal::Util::JSON_CONTENT.match?(header) => verdict + end + end + end +end + class Increase::Test::UtilFormDataEncodingTest < Minitest::Test class FakeCGI < CGI def initialize(headers, io) From 995c8baa67995d921ea02054f120e9bdaebe01ad Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 24 Apr 2025 05:15:58 +0000 Subject: [PATCH 06/16] feat: support webmock for testing --- Gemfile | 1 + Gemfile.lock | 13 + Rakefile | 2 +- .../internal/transport/base_client.rb | 2 +- .../transport/pooled_net_requester.rb | 2 +- .../internal/transport/base_client.rbi | 2 +- .../internal/transport/base_client.rbs | 2 +- test/increase/client_test.rb | 330 +++++++++++------- test/increase/test_helper.rb | 9 +- 9 files changed, 226 insertions(+), 137 deletions(-) diff --git a/Gemfile b/Gemfile index e5ec01e90..0d76364b9 100644 --- a/Gemfile +++ b/Gemfile @@ -23,6 +23,7 @@ group :development, :test do gem "minitest-hooks" gem "minitest-proveit" gem "minitest-rg" + gem "webmock" end group :development, :docs do diff --git a/Gemfile.lock b/Gemfile.lock index 51a1e8096..344952aac 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -29,6 +29,8 @@ GEM minitest (>= 5.1) securerandom (>= 0.3) tzinfo (~> 2.0, >= 2.0.5) + addressable (2.8.7) + public_suffix (>= 2.0.2, < 7.0) ast (2.4.3) async (2.23.1) console (~> 1.29) @@ -45,6 +47,9 @@ GEM fiber-annotation fiber-local (~> 1.1) json + crack (1.0.0) + bigdecimal + rexml csv (3.3.3) drb (2.2.1) erubi (1.13.1) @@ -54,6 +59,7 @@ GEM fiber-storage fiber-storage (1.0.0) fileutils (1.7.3) + hashdiff (1.1.2) i18n (1.14.7) concurrent-ruby (~> 1.0) io-event (1.10.0) @@ -82,6 +88,7 @@ GEM racc prettier_print (1.2.1) prism (1.4.0) + public_suffix (6.0.1) racc (1.8.1) rainbow (3.1.1) rake (13.2.1) @@ -96,6 +103,7 @@ GEM logger redcarpet (3.6.1) regexp_parser (2.10.0) + rexml (3.4.1) rubocop (1.75.1) json (~> 2.3) language_server-protocol (~> 3.17.0.2) @@ -165,6 +173,10 @@ GEM unicode-emoji (~> 4.0, >= 4.0.4) unicode-emoji (4.0.4) uri (1.0.3) + webmock (3.25.1) + addressable (>= 2.8.0) + crack (>= 0.3.2) + hashdiff (>= 0.4.0, < 2.0.0) webrick (1.9.1) yard (0.9.37) yard-sorbet (0.9.0) @@ -191,6 +203,7 @@ DEPENDENCIES syntax_tree syntax_tree-rbs! tapioca + webmock webrick yard diff --git a/Rakefile b/Rakefile index 5b270b07a..ca9453d6c 100644 --- a/Rakefile +++ b/Rakefile @@ -31,7 +31,7 @@ multitask(:test) do .map { "require_relative(#{_1.dump});" } .join - ruby(*%w[-w -e], rb, verbose: false) { fail unless _1 } + ruby(*%w[-e], rb, verbose: false) { fail unless _1 } end rubo_find = %w[find ./lib ./test ./rbi -type f -and ( -name *.rb -or -name *.rbi ) -print0] diff --git a/lib/increase/internal/transport/base_client.rb b/lib/increase/internal/transport/base_client.rb index 61ee3b397..ebe5c3941 100644 --- a/lib/increase/internal/transport/base_client.rb +++ b/lib/increase/internal/transport/base_client.rb @@ -153,7 +153,7 @@ def reap_connection!(status, stream:) # @api private # @return [Increase::Internal::Transport::PooledNetRequester] - attr_accessor :requester + attr_reader :requester # @api private # diff --git a/lib/increase/internal/transport/pooled_net_requester.rb b/lib/increase/internal/transport/pooled_net_requester.rb index 7657209dc..bcc31e3b6 100644 --- a/lib/increase/internal/transport/pooled_net_requester.rb +++ b/lib/increase/internal/transport/pooled_net_requester.rb @@ -176,7 +176,7 @@ def execute(request) conn.finish if !eof && conn&.started? closing&.call end - [Integer(response.code), response, (response.body = body)] + [Integer(response.code), response, body] end # @api private diff --git a/rbi/lib/increase/internal/transport/base_client.rbi b/rbi/lib/increase/internal/transport/base_client.rbi index e617789c0..16685f27c 100644 --- a/rbi/lib/increase/internal/transport/base_client.rbi +++ b/rbi/lib/increase/internal/transport/base_client.rbi @@ -90,7 +90,7 @@ module Increase # @api private sig { returns(Increase::Internal::Transport::PooledNetRequester) } - attr_accessor :requester + attr_reader :requester # @api private sig do diff --git a/sig/increase/internal/transport/base_client.rbs b/sig/increase/internal/transport/base_client.rbs index 75d721df7..c190123d1 100644 --- a/sig/increase/internal/transport/base_client.rbs +++ b/sig/increase/internal/transport/base_client.rbs @@ -53,7 +53,7 @@ module Increase ) -> void # @api private - attr_accessor requester: Increase::Internal::Transport::PooledNetRequester + attr_reader requester: Increase::Internal::Transport::PooledNetRequester def initialize: ( base_url: String, diff --git a/test/increase/client_test.rb b/test/increase/client_test.rb index 566c2871e..8cc95edb6 100644 --- a/test/increase/client_test.rb +++ b/test/increase/client_test.rb @@ -3,12 +3,33 @@ require_relative "test_helper" class IncreaseTest < Minitest::Test + include WebMock::API + + class << self + def test_order = :random + + def run_one_method(...) = Minitest::Runnable.run_one_method(...) + end + + def before_all + super + WebMock.enable! + end + def setup + super Thread.current.thread_variable_set(:mock_sleep, []) end def teardown Thread.current.thread_variable_set(:mock_sleep, nil) + WebMock.reset! + super + end + + def after_all + WebMock.disable! + super end def test_raises_on_unknown_environment @@ -25,104 +46,91 @@ def test_raises_on_missing_non_nullable_opts assert_match(/is required/, e.message) end - class MockRequester - # @return [Integer] - attr_reader :response_code - - # @return [Hash{String=>String}] - attr_reader :response_headers - - # @return [Object] - attr_reader :response_data - - # @return [ArrayObject}>] - attr_accessor :attempts - - # @param response_code [Integer] - # @param response_headers [Hash{String=>String}] - # @param response_data [Object] - def initialize(response_code, response_headers, response_data) - @response_code = response_code - @response_headers = response_headers - @response_data = JSON.fast_generate(response_data) - @attempts = [] - end - - # @param req [Hash{Symbol=>Object}] - def execute(req) - # Deep copy the request because it is mutated on each retry. - attempts.push(Marshal.load(Marshal.dump(req))) - headers = {"content-type" => "application/json", **response_headers} - [response_code, headers, response_data.grapheme_clusters] - end - end - def test_client_default_request_default_retry_attempts - increase = Increase::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(500, {}, {"type" => "internal_server_error"}) - increase.requester = requester + stub_request(:post, "http://localhost/accounts").to_return_json( + status: 500, + body: {"type" => "internal_server_error"} + ) + + increase = Increase::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Increase::Errors::InternalServerError) do increase.accounts.create(name: "New Account!") end - assert_equal(3, requester.attempts.length) + assert_requested(:any, /./, times: 3) end def test_client_given_request_default_retry_attempts - increase = Increase::Client.new(base_url: "http://localhost:4010", api_key: "My API Key", max_retries: 3) - requester = MockRequester.new(500, {}, {"type" => "internal_server_error"}) - increase.requester = requester + stub_request(:post, "http://localhost/accounts").to_return_json( + status: 500, + body: {"type" => "internal_server_error"} + ) + + increase = Increase::Client.new(base_url: "http://localhost", api_key: "My API Key", max_retries: 3) assert_raises(Increase::Errors::InternalServerError) do increase.accounts.create(name: "New Account!") end - assert_equal(4, requester.attempts.length) + assert_requested(:any, /./, times: 4) end def test_client_default_request_given_retry_attempts - increase = Increase::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(500, {}, {"type" => "internal_server_error"}) - increase.requester = requester + stub_request(:post, "http://localhost/accounts").to_return_json( + status: 500, + body: {"type" => "internal_server_error"} + ) + + increase = Increase::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Increase::Errors::InternalServerError) do increase.accounts.create(name: "New Account!", request_options: {max_retries: 3}) end - assert_equal(4, requester.attempts.length) + assert_requested(:any, /./, times: 4) end def test_client_given_request_given_retry_attempts - increase = Increase::Client.new(base_url: "http://localhost:4010", api_key: "My API Key", max_retries: 3) - requester = MockRequester.new(500, {}, {"type" => "internal_server_error"}) - increase.requester = requester + stub_request(:post, "http://localhost/accounts").to_return_json( + status: 500, + body: {"type" => "internal_server_error"} + ) + + increase = Increase::Client.new(base_url: "http://localhost", api_key: "My API Key", max_retries: 3) assert_raises(Increase::Errors::InternalServerError) do increase.accounts.create(name: "New Account!", request_options: {max_retries: 4}) end - assert_equal(5, requester.attempts.length) + assert_requested(:any, /./, times: 5) end def test_client_retry_after_seconds - increase = Increase::Client.new(base_url: "http://localhost:4010", api_key: "My API Key", max_retries: 1) - requester = MockRequester.new(500, {"retry-after" => "1.3"}, {"type" => "internal_server_error"}) - increase.requester = requester + stub_request(:post, "http://localhost/accounts").to_return_json( + status: 500, + headers: {"retry-after" => "1.3"}, + body: {"type" => "internal_server_error"} + ) + + increase = Increase::Client.new(base_url: "http://localhost", api_key: "My API Key", max_retries: 1) assert_raises(Increase::Errors::InternalServerError) do increase.accounts.create(name: "New Account!") end - assert_equal(2, requester.attempts.length) + assert_requested(:any, /./, times: 2) assert_equal(1.3, Thread.current.thread_variable_get(:mock_sleep).last) end def test_client_retry_after_date - increase = Increase::Client.new(base_url: "http://localhost:4010", api_key: "My API Key", max_retries: 1) - requester = - MockRequester.new(500, {"retry-after" => (Time.now + 10).httpdate}, {"type" => "internal_server_error"}) - increase.requester = requester + stub_request(:post, "http://localhost/accounts").to_return_json( + status: 500, + headers: {"retry-after" => (Time.now + 10).httpdate}, + body: {"type" => "internal_server_error"} + ) + + increase = Increase::Client.new(base_url: "http://localhost", api_key: "My API Key", max_retries: 1) assert_raises(Increase::Errors::InternalServerError) do Thread.current.thread_variable_set(:time_now, Time.now) @@ -130,43 +138,51 @@ def test_client_retry_after_date Thread.current.thread_variable_set(:time_now, nil) end - assert_equal(2, requester.attempts.length) + assert_requested(:any, /./, times: 2) assert_in_delta(10, Thread.current.thread_variable_get(:mock_sleep).last, 1.0) end def test_client_retry_after_ms - increase = Increase::Client.new(base_url: "http://localhost:4010", api_key: "My API Key", max_retries: 1) - requester = MockRequester.new(500, {"retry-after-ms" => "1300"}, {"type" => "internal_server_error"}) - increase.requester = requester + stub_request(:post, "http://localhost/accounts").to_return_json( + status: 500, + headers: {"retry-after-ms" => "1300"}, + body: {"type" => "internal_server_error"} + ) + + increase = Increase::Client.new(base_url: "http://localhost", api_key: "My API Key", max_retries: 1) assert_raises(Increase::Errors::InternalServerError) do increase.accounts.create(name: "New Account!") end - assert_equal(2, requester.attempts.length) + assert_requested(:any, /./, times: 2) assert_equal(1.3, Thread.current.thread_variable_get(:mock_sleep).last) end def test_retry_count_header - increase = Increase::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(500, {}, {"type" => "internal_server_error"}) - increase.requester = requester + stub_request(:post, "http://localhost/accounts").to_return_json( + status: 500, + body: {"type" => "internal_server_error"} + ) + + increase = Increase::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Increase::Errors::InternalServerError) do increase.accounts.create(name: "New Account!") end - retry_count_headers = requester.attempts.map do - _1.fetch(:headers).fetch("x-stainless-retry-count") + 3.times do + assert_requested(:any, /./, headers: {"x-stainless-retry-count" => _1}) end - - assert_equal(%w[0 1 2], retry_count_headers) end def test_omit_retry_count_header - increase = Increase::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(500, {}, {"type" => "internal_server_error"}) - increase.requester = requester + stub_request(:post, "http://localhost/accounts").to_return_json( + status: 500, + body: {"type" => "internal_server_error"} + ) + + increase = Increase::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Increase::Errors::InternalServerError) do increase.accounts.create( @@ -175,17 +191,18 @@ def test_omit_retry_count_header ) end - retry_count_headers = requester.attempts.map do - _1.fetch(:headers).fetch("x-stainless-retry-count", nil) + assert_requested(:any, /./, times: 3) do + refute_includes(_1.headers.keys.map(&:downcase), "x-stainless-retry-count") end - - assert_equal([nil, nil, nil], retry_count_headers) end def test_overwrite_retry_count_header - increase = Increase::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(500, {}, {"type" => "internal_server_error"}) - increase.requester = requester + stub_request(:post, "http://localhost/accounts").to_return_json( + status: 500, + body: {"type" => "internal_server_error"} + ) + + increase = Increase::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Increase::Errors::InternalServerError) do increase.accounts.create( @@ -194,50 +211,74 @@ def test_overwrite_retry_count_header ) end - retry_count_headers = requester.attempts.map do - _1.fetch(:headers).fetch("x-stainless-retry-count") - end - - assert_equal(%w[42 42 42], retry_count_headers) + assert_requested(:any, /./, headers: {"x-stainless-retry-count" => "42"}, times: 3) end def test_client_redirect_307 - increase = Increase::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(307, {"location" => "/redirected"}, {}) - increase.requester = requester + stub_request(:post, "http://localhost/accounts").to_return_json( + status: 307, + headers: {"location" => "/redirected"}, + body: {} + ) + stub_request(:any, "http://localhost/redirected").to_return( + status: 307, + headers: {"location" => "/redirected"} + ) + + increase = Increase::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Increase::Errors::APIConnectionError) do increase.accounts.create(name: "New Account!", request_options: {extra_headers: {}}) end - assert_equal("/redirected", requester.attempts.last.fetch(:url).path) - assert_equal(requester.attempts.first.fetch(:method), requester.attempts.last.fetch(:method)) - assert_equal(requester.attempts.first.fetch(:body), requester.attempts.last.fetch(:body)) - assert_equal( - requester.attempts.first.fetch(:headers)["content-type"], - requester.attempts.last.fetch(:headers)["content-type"] - ) + recorded, = WebMock::RequestRegistry.instance.requested_signatures.hash.first + + assert_requested(:any, "http://localhost/redirected", times: Increase::Client::MAX_REDIRECTS) do + assert_equal(recorded.method, _1.method) + assert_equal(recorded.body, _1.body) + assert_equal( + recorded.headers.transform_keys(&:downcase).fetch("content-type"), + _1.headers.transform_keys(&:downcase).fetch("content-type") + ) + end end def test_client_redirect_303 - increase = Increase::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(303, {"location" => "/redirected"}, {}) - increase.requester = requester + stub_request(:post, "http://localhost/accounts").to_return_json( + status: 303, + headers: {"location" => "/redirected"}, + body: {} + ) + stub_request(:get, "http://localhost/redirected").to_return( + status: 303, + headers: {"location" => "/redirected"} + ) + + increase = Increase::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Increase::Errors::APIConnectionError) do increase.accounts.create(name: "New Account!", request_options: {extra_headers: {}}) end - assert_equal("/redirected", requester.attempts.last.fetch(:url).path) - assert_equal(:get, requester.attempts.last.fetch(:method)) - assert_nil(requester.attempts.last.fetch(:body)) - assert_nil(requester.attempts.last.fetch(:headers)["content-type"]) + assert_requested(:get, "http://localhost/redirected", times: Increase::Client::MAX_REDIRECTS) do + headers = _1.headers.keys.map(&:downcase) + refute_includes(headers, "content-type") + assert_nil(_1.body) + end end def test_client_redirect_auth_keep_same_origin - increase = Increase::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(307, {"location" => "/redirected"}, {}) - increase.requester = requester + stub_request(:post, "http://localhost/accounts").to_return_json( + status: 307, + headers: {"location" => "/redirected"}, + body: {} + ) + stub_request(:any, "http://localhost/redirected").to_return( + status: 307, + headers: {"location" => "/redirected"} + ) + + increase = Increase::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Increase::Errors::APIConnectionError) do increase.accounts.create( @@ -246,16 +287,28 @@ def test_client_redirect_auth_keep_same_origin ) end - assert_equal( - requester.attempts.first.fetch(:headers)["authorization"], - requester.attempts.last.fetch(:headers)["authorization"] - ) + recorded, = WebMock::RequestRegistry.instance.requested_signatures.hash.first + auth_header = recorded.headers.transform_keys(&:downcase).fetch("authorization") + + assert_equal("Bearer xyz", auth_header) + assert_requested(:any, "http://localhost/redirected", times: Increase::Client::MAX_REDIRECTS) do + auth_header = _1.headers.transform_keys(&:downcase).fetch("authorization") + assert_equal("Bearer xyz", auth_header) + end end def test_client_redirect_auth_strip_cross_origin - increase = Increase::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(307, {"location" => "https://example.com/redirected"}, {}) - increase.requester = requester + stub_request(:post, "http://localhost/accounts").to_return_json( + status: 307, + headers: {"location" => "https://example.com/redirected"}, + body: {} + ) + stub_request(:any, "https://example.com/redirected").to_return( + status: 307, + headers: {"location" => "https://example.com/redirected"} + ) + + increase = Increase::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Increase::Errors::APIConnectionError) do increase.accounts.create( @@ -264,31 +317,41 @@ def test_client_redirect_auth_strip_cross_origin ) end - assert_nil(requester.attempts.last.fetch(:headers)["authorization"]) + assert_requested(:any, "https://example.com/redirected", times: Increase::Client::MAX_REDIRECTS) do + headers = _1.headers.keys.map(&:downcase) + refute_includes(headers, "authorization") + end end def test_client_default_idempotency_key_on_writes - increase = Increase::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(500, {}, {"type" => "internal_server_error"}) - increase.requester = requester + stub_request(:post, "http://localhost/accounts").to_return_json( + status: 500, + body: {"type" => "internal_server_error"} + ) + + increase = Increase::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Increase::Errors::InternalServerError) do increase.accounts.create(name: "New Account!", request_options: {max_retries: 1}) end - idempotency_headers = requester.attempts.map do - _1.fetch(:headers).fetch("idempotency-key") + headers = [] + assert_requested(:any, /./, times: 2) do + header = _1.headers.transform_keys(&:downcase).fetch("idempotency-key") + headers << header + refute_empty(header) end - assert_kind_of(String, idempotency_headers.first) - refute_empty(idempotency_headers.first) - assert_equal(idempotency_headers.first, idempotency_headers.last) + assert_equal(*headers) end def test_request_option_idempotency_key_on_writes - increase = Increase::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(500, {}, {"type" => "internal_server_error"}) - increase.requester = requester + stub_request(:post, "http://localhost/accounts").to_return_json( + status: 500, + body: {"type" => "internal_server_error"} + ) + + increase = Increase::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Increase::Errors::InternalServerError) do increase.accounts.create( @@ -297,19 +360,24 @@ def test_request_option_idempotency_key_on_writes ) end - requester.attempts.each do - assert_equal("user-supplied-key", _1.fetch(:headers).fetch("idempotency-key")) - end + assert_requested( + :any, + /./, + headers: {"idempotency-key" => "user-supplied-key"}, + times: 2 + ) end def test_default_headers - increase = Increase::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(200, {}, {}) - increase.requester = requester + stub_request(:post, "http://localhost/accounts").to_return_json(status: 200, body: {}) + + increase = Increase::Client.new(base_url: "http://localhost", api_key: "My API Key") + increase.accounts.create(name: "New Account!") - headers = requester.attempts.first.fetch(:headers) - refute_empty(headers["accept"]) - refute_empty(headers["content-type"]) + assert_requested(:any, /./) do |req| + headers = req.headers.transform_keys(&:downcase).fetch_values("accept", "content-type") + headers.each { refute_empty(_1) } + end end end diff --git a/test/increase/test_helper.rb b/test/increase/test_helper.rb index 04b5d0e71..0aa6e3144 100644 --- a/test/increase/test_helper.rb +++ b/test/increase/test_helper.rb @@ -15,6 +15,7 @@ require "minitest/hooks/test" require "minitest/proveit" require "minitest/rg" +require "webmock" require_relative "../../lib/increase" require_relative "resource_namespaces" @@ -44,8 +45,10 @@ def self.now = Thread.current.thread_variable_get(:time_now) || _now class Increase::Test::SingletonClient < Increase::Client include Singleton + TEST_API_BASE_URL = ENV.fetch("TEST_API_BASE_URL", "http://localhost:4010") + def initialize - super(base_url: ENV.fetch("TEST_API_BASE_URL", "http://localhost:4010"), api_key: "My API Key") + super(base_url: Increase::Test::SingletonClient::TEST_API_BASE_URL, api_key: "My API Key") end end @@ -72,3 +75,7 @@ def around_all = async? ? Sync { super } : super def around = async? ? Async { super }.wait : super end + +module WebMock + AssertionFailure.error_class = Minitest::Assertion +end From 294b3473dff35162a9f5e64552579261b1babed6 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 24 Apr 2025 07:10:42 +0000 Subject: [PATCH 07/16] chore: show truncated parameter docs in yard --- lib/increase/models/account.rb | 57 +- lib/increase/models/account_balance_params.rb | 3 +- lib/increase/models/account_create_params.rb | 17 +- lib/increase/models/account_list_params.rb | 49 +- lib/increase/models/account_number.rb | 47 +- .../models/account_number_create_params.rb | 28 +- .../models/account_number_list_params.rb | 50 +- .../models/account_number_update_params.rb | 24 +- lib/increase/models/account_statement.rb | 33 +- .../models/account_statement_list_params.rb | 33 +- lib/increase/models/account_transfer.rb | 98 +- .../models/account_transfer_create_params.rb | 19 +- .../models/account_transfer_list_params.rb | 36 +- lib/increase/models/account_update_params.rb | 3 +- lib/increase/models/ach_prenotification.rb | 78 +- .../ach_prenotification_create_params.rb | 45 +- .../models/ach_prenotification_list_params.rb | 33 +- lib/increase/models/ach_transfer.rb | 308 +++- .../models/ach_transfer_create_params.rb | 114 +- .../models/ach_transfer_list_params.rb | 46 +- lib/increase/models/balance_lookup.rb | 17 +- lib/increase/models/bookkeeping_account.rb | 25 +- .../bookkeeping_account_balance_params.rb | 3 +- .../bookkeeping_account_create_params.rb | 12 +- .../models/bookkeeping_account_list_params.rb | 14 +- .../bookkeeping_account_update_params.rb | 3 +- .../models/bookkeeping_balance_lookup.rb | 13 +- lib/increase/models/bookkeeping_entry.rb | 22 +- .../models/bookkeeping_entry_list_params.rb | 13 +- lib/increase/models/bookkeeping_entry_set.rb | 33 +- .../bookkeeping_entry_set_create_params.rb | 22 +- .../bookkeeping_entry_set_list_params.rb | 17 +- lib/increase/models/card.rb | 73 +- lib/increase/models/card_create_params.rb | 47 +- lib/increase/models/card_details.rb | 22 +- lib/increase/models/card_dispute.rb | 95 +- .../models/card_dispute_create_params.rb | 14 +- .../models/card_dispute_list_params.rb | 40 +- lib/increase/models/card_list_params.rb | 43 +- lib/increase/models/card_payment.rb | 1546 ++++++++++++----- .../models/card_payment_list_params.rb | 35 +- .../models/card_purchase_supplement.rb | 128 +- .../card_purchase_supplement_list_params.rb | 34 +- lib/increase/models/card_update_params.rb | 47 +- lib/increase/models/check_deposit.rb | 191 +- .../models/check_deposit_create_params.rb | 19 +- .../models/check_deposit_list_params.rb | 36 +- lib/increase/models/check_transfer.rb | 258 ++- .../models/check_transfer_create_params.rb | 98 +- .../models/check_transfer_list_params.rb | 43 +- .../check_transfer_stop_payment_params.rb | 3 +- lib/increase/models/declined_transaction.rb | 368 ++-- .../declined_transaction_list_params.rb | 42 +- lib/increase/models/digital_card_profile.rb | 55 +- .../digital_card_profile_clone_params.rb | 35 +- .../digital_card_profile_create_params.rb | 35 +- .../digital_card_profile_list_params.rb | 21 +- lib/increase/models/digital_wallet_token.rb | 53 +- .../digital_wallet_token_list_params.rb | 32 +- lib/increase/models/document.rb | 22 +- lib/increase/models/document_list_params.rb | 39 +- lib/increase/models/entity.rb | 414 +++-- .../entity_archive_beneficial_owner_params.rb | 7 +- lib/increase/models/entity_confirm_params.rb | 7 +- .../entity_create_beneficial_owner_params.rb | 124 +- lib/increase/models/entity_create_params.rb | 709 ++++++-- lib/increase/models/entity_list_params.rb | 40 +- .../models/entity_supplemental_document.rb | 20 +- .../models/entity_update_address_params.rb | 25 +- ..._update_beneficial_owner_address_params.rb | 34 +- .../entity_update_industry_code_params.rb | 7 +- lib/increase/models/event.rb | 22 +- lib/increase/models/event_list_params.rb | 39 +- lib/increase/models/event_subscription.rb | 30 +- .../event_subscription_create_params.rb | 18 +- .../models/event_subscription_list_params.rb | 14 +- .../event_subscription_update_params.rb | 3 +- lib/increase/models/export.rb | 31 +- lib/increase/models/export_create_params.rb | 139 +- lib/increase/models/export_list_params.rb | 47 +- lib/increase/models/external_account.rb | 38 +- .../models/external_account_create_params.rb | 19 +- .../models/external_account_list_params.rb | 24 +- .../models/external_account_update_params.rb | 12 +- lib/increase/models/file.rb | 32 +- lib/increase/models/file_create_params.rb | 13 +- lib/increase/models/file_link.rb | 28 +- .../models/file_link_create_params.rb | 10 +- lib/increase/models/file_list_params.rb | 40 +- lib/increase/models/group.rb | 19 +- lib/increase/models/inbound_ach_transfer.rb | 242 ++- ...er_create_notification_of_change_params.rb | 6 +- .../inbound_ach_transfer_decline_params.rb | 7 +- .../inbound_ach_transfer_list_params.rb | 42 +- ...und_ach_transfer_transfer_return_params.rb | 7 +- lib/increase/models/inbound_check_deposit.rb | 92 +- .../inbound_check_deposit_list_params.rb | 36 +- .../inbound_check_deposit_return_params.rb | 3 +- lib/increase/models/inbound_mail_item.rb | 29 +- .../models/inbound_mail_item_list_params.rb | 32 +- .../inbound_real_time_payments_transfer.rb | 66 +- ...real_time_payments_transfer_list_params.rb | 38 +- .../models/inbound_wire_drawdown_request.rb | 79 +- ...bound_wire_drawdown_request_list_params.rb | 10 +- lib/increase/models/inbound_wire_transfer.rb | 81 +- .../inbound_wire_transfer_list_params.rb | 43 +- .../models/intrafi_account_enrollment.rb | 28 +- ...ntrafi_account_enrollment_create_params.rb | 6 +- .../intrafi_account_enrollment_list_params.rb | 24 +- lib/increase/models/intrafi_balance.rb | 47 +- lib/increase/models/intrafi_exclusion.rb | 36 +- .../models/intrafi_exclusion_create_params.rb | 6 +- .../models/intrafi_exclusion_list_params.rb | 17 +- lib/increase/models/lockbox.rb | 55 +- lib/increase/models/lockbox_create_params.rb | 9 +- lib/increase/models/lockbox_list_params.rb | 36 +- lib/increase/models/lockbox_update_params.rb | 9 +- lib/increase/models/oauth_application.rb | 27 +- .../models/oauth_application_list_params.rb | 36 +- lib/increase/models/oauth_connection.rb | 26 +- .../models/oauth_connection_list_params.rb | 21 +- lib/increase/models/oauth_token.rb | 13 +- .../models/oauth_token_create_params.rb | 22 +- lib/increase/models/pending_transaction.rb | 382 ++-- .../models/pending_transaction_list_params.rb | 49 +- lib/increase/models/physical_card.rb | 83 +- .../models/physical_card_create_params.rb | 49 +- .../models/physical_card_list_params.rb | 36 +- lib/increase/models/physical_card_profile.rb | 45 +- .../physical_card_profile_clone_params.rb | 28 +- .../physical_card_profile_create_params.rb | 15 +- .../physical_card_profile_list_params.rb | 21 +- .../models/physical_card_update_params.rb | 3 +- lib/increase/models/program.rb | 33 +- lib/increase/models/program_list_params.rb | 10 +- lib/increase/models/real_time_decision.rb | 299 +++- .../real_time_decision_action_params.rb | 84 +- .../models/real_time_payments_transfer.rb | 154 +- ...al_time_payments_transfer_create_params.rb | 42 +- ...real_time_payments_transfer_list_params.rb | 49 +- .../models/routing_number_list_params.rb | 13 +- .../models/routing_number_list_response.rb | 21 +- .../account_statement_create_params.rb | 3 +- ...er_create_notification_of_change_params.rb | 6 +- .../simulations/ach_transfer_return_params.rb | 7 +- .../card_authorization_create_params.rb | 66 +- .../card_authorization_create_response.rb | 15 +- ..._authorization_expiration_create_params.rb | 3 +- .../simulations/card_dispute_action_params.rb | 6 +- .../card_fuel_confirmation_create_params.rb | 11 +- .../card_increment_create_params.rb | 14 +- .../simulations/card_refund_create_params.rb | 7 +- .../card_reversal_create_params.rb | 10 +- .../card_settlement_create_params.rb | 14 +- ...ital_wallet_token_request_create_params.rb | 3 +- ...al_wallet_token_request_create_response.rb | 15 +- .../simulations/document_create_params.rb | 3 +- .../inbound_ach_transfer_create_params.rb | 39 +- .../inbound_check_deposit_create_params.rb | 9 +- .../inbound_funds_hold_release_response.rb | 38 +- .../inbound_mail_item_create_params.rb | 13 +- ...al_time_payments_transfer_create_params.rb | 27 +- ...und_wire_drawdown_request_create_params.rb | 70 +- .../inbound_wire_transfer_create_params.rb | 70 +- .../interest_payment_create_params.rb | 20 +- .../physical_card_advance_shipment_params.rb | 3 +- .../simulations/program_create_params.rb | 3 +- ..._time_payments_transfer_complete_params.rb | 5 +- .../supplemental_document_create_params.rb | 6 +- .../supplemental_document_list_params.rb | 17 +- lib/increase/models/transaction.rb | 1378 +++++++++++---- .../models/transaction_list_params.rb | 43 +- lib/increase/models/wire_drawdown_request.rb | 78 +- .../wire_drawdown_request_create_params.rb | 46 +- .../wire_drawdown_request_list_params.rb | 21 +- lib/increase/models/wire_transfer.rb | 198 ++- .../models/wire_transfer_create_params.rb | 57 +- .../models/wire_transfer_list_params.rb | 39 +- lib/increase/resources/account_numbers.rb | 58 +- lib/increase/resources/account_statements.rb | 17 +- lib/increase/resources/account_transfers.rb | 46 +- lib/increase/resources/accounts.rb | 60 +- .../resources/ach_prenotifications.rb | 63 +- lib/increase/resources/ach_transfers.rb | 103 +- .../resources/bookkeeping_accounts.rb | 38 +- lib/increase/resources/bookkeeping_entries.rb | 16 +- .../resources/bookkeeping_entry_sets.rb | 33 +- lib/increase/resources/card_disputes.rb | 33 +- lib/increase/resources/card_payments.rb | 20 +- .../resources/card_purchase_supplements.rb | 18 +- lib/increase/resources/cards.rb | 68 +- lib/increase/resources/check_deposits.rb | 40 +- lib/increase/resources/check_transfers.rb | 61 +- .../resources/declined_transactions.rb | 21 +- .../resources/digital_card_profiles.rb | 78 +- .../resources/digital_wallet_tokens.rb | 17 +- lib/increase/resources/documents.rb | 18 +- lib/increase/resources/entities.rb | 129 +- lib/increase/resources/event_subscriptions.rb | 41 +- lib/increase/resources/events.rb | 18 +- lib/increase/resources/exports.rb | 50 +- lib/increase/resources/external_accounts.rb | 55 +- lib/increase/resources/file_links.rb | 10 +- lib/increase/resources/files.rb | 32 +- .../resources/inbound_ach_transfers.rb | 56 +- .../resources/inbound_check_deposits.rb | 30 +- lib/increase/resources/inbound_mail_items.rb | 17 +- .../inbound_real_time_payments_transfers.rb | 22 +- .../inbound_wire_drawdown_requests.rb | 13 +- .../resources/inbound_wire_transfers.rb | 22 +- .../resources/intrafi_account_enrollments.rb | 30 +- lib/increase/resources/intrafi_balances.rb | 3 +- lib/increase/resources/intrafi_exclusions.rb | 33 +- lib/increase/resources/lockboxes.rb | 42 +- lib/increase/resources/oauth_applications.rb | 15 +- lib/increase/resources/oauth_connections.rb | 18 +- lib/increase/resources/oauth_tokens.rb | 22 +- .../resources/pending_transactions.rb | 22 +- .../resources/physical_card_profiles.rb | 58 +- lib/increase/resources/physical_cards.rb | 43 +- lib/increase/resources/programs.rb | 13 +- lib/increase/resources/real_time_decisions.rb | 29 +- .../resources/real_time_payments_transfers.rb | 69 +- lib/increase/resources/routing_numbers.rb | 13 +- .../simulations/account_statements.rb | 3 +- .../simulations/account_transfers.rb | 3 +- .../resources/simulations/ach_transfers.rb | 33 +- .../card_authorization_expirations.rb | 3 +- .../simulations/card_authorizations.rb | 62 +- .../resources/simulations/card_disputes.rb | 9 +- .../simulations/card_fuel_confirmations.rb | 11 +- .../resources/simulations/card_increments.rb | 14 +- .../resources/simulations/card_refunds.rb | 7 +- .../resources/simulations/card_reversals.rb | 10 +- .../resources/simulations/card_settlements.rb | 14 +- .../resources/simulations/check_deposits.rb | 9 +- .../resources/simulations/check_transfers.rb | 3 +- .../digital_wallet_token_requests.rb | 3 +- .../resources/simulations/documents.rb | 3 +- .../simulations/inbound_ach_transfers.rb | 39 +- .../simulations/inbound_check_deposits.rb | 9 +- .../simulations/inbound_funds_holds.rb | 3 +- .../simulations/inbound_mail_items.rb | 13 +- .../inbound_real_time_payments_transfers.rb | 27 +- .../inbound_wire_drawdown_requests.rb | 70 +- .../simulations/inbound_wire_transfers.rb | 70 +- .../simulations/interest_payments.rb | 20 +- .../resources/simulations/physical_cards.rb | 6 +- .../resources/simulations/programs.rb | 3 +- .../real_time_payments_transfers.rb | 6 +- .../resources/simulations/wire_transfers.rb | 6 +- .../resources/supplemental_documents.rb | 23 +- lib/increase/resources/transactions.rb | 22 +- .../resources/wire_drawdown_requests.rb | 64 +- lib/increase/resources/wire_transfers.rb | 87 +- rbi/lib/increase/models/account.rbi | 27 + .../models/account_balance_params.rbi | 7 +- .../increase/models/account_create_params.rbi | 16 +- .../increase/models/account_list_params.rbi | 33 +- rbi/lib/increase/models/account_number.rbi | 29 +- .../models/account_number_create_params.rbi | 29 +- .../models/account_number_list_params.rbi | 38 +- .../models/account_number_update_params.rbi | 27 +- rbi/lib/increase/models/account_statement.rbi | 13 + .../models/account_statement_list_params.rbi | 24 +- rbi/lib/increase/models/account_transfer.rbi | 78 +- .../models/account_transfer_create_params.rbi | 10 +- .../models/account_transfer_list_params.rbi | 28 +- .../increase/models/account_update_params.rbi | 7 +- .../increase/models/ach_prenotification.rbi | 46 +- .../ach_prenotification_create_params.rbi | 16 + .../ach_prenotification_list_params.rbi | 32 +- rbi/lib/increase/models/ach_transfer.rbi | 237 ++- .../models/ach_transfer_create_params.rbi | 87 +- .../models/ach_transfer_list_params.rbi | 32 +- rbi/lib/increase/models/balance_lookup.rbi | 15 +- .../increase/models/bookkeeping_account.rbi | 21 +- .../bookkeeping_account_balance_params.rbi | 7 +- .../bookkeeping_account_create_params.rbi | 13 +- .../bookkeeping_account_list_params.rbi | 15 +- .../bookkeeping_account_update_params.rbi | 7 +- .../models/bookkeeping_balance_lookup.rbi | 12 +- rbi/lib/increase/models/bookkeeping_entry.rbi | 18 +- .../models/bookkeeping_entry_list_params.rbi | 12 +- .../increase/models/bookkeeping_entry_set.rbi | 31 +- .../bookkeeping_entry_set_create_params.rbi | 22 +- .../bookkeeping_entry_set_list_params.rbi | 18 +- rbi/lib/increase/models/card.rbi | 46 +- .../increase/models/card_create_params.rbi | 36 +- rbi/lib/increase/models/card_details.rbi | 13 +- rbi/lib/increase/models/card_dispute.rbi | 66 +- .../models/card_dispute_create_params.rbi | 15 +- .../models/card_dispute_list_params.rbi | 35 +- rbi/lib/increase/models/card_list_params.rbi | 31 +- rbi/lib/increase/models/card_payment.rbi | 839 ++++++++- .../models/card_payment_list_params.rbi | 25 +- .../models/card_purchase_supplement.rbi | 54 +- .../card_purchase_supplement_list_params.rbi | 30 +- .../increase/models/card_update_params.rbi | 34 +- rbi/lib/increase/models/check_deposit.rbi | 114 +- .../models/check_deposit_create_params.rbi | 9 +- .../models/check_deposit_list_params.rbi | 28 +- rbi/lib/increase/models/check_transfer.rbi | 203 ++- .../models/check_transfer_create_params.rbi | 67 +- .../models/check_transfer_list_params.rbi | 32 +- .../check_transfer_stop_payment_params.rbi | 7 +- .../increase/models/declined_transaction.rbi | 200 ++- .../declined_transaction_list_params.rbi | 28 +- .../increase/models/digital_card_profile.rbi | 28 +- .../digital_card_profile_clone_params.rbi | 19 +- .../digital_card_profile_create_params.rbi | 19 +- .../digital_card_profile_list_params.rbi | 24 +- .../increase/models/digital_wallet_token.rbi | 42 +- .../digital_wallet_token_list_params.rbi | 29 +- rbi/lib/increase/models/document.rbi | 18 +- .../increase/models/document_list_params.rbi | 32 +- rbi/lib/increase/models/entity.rbi | 337 +++- ...entity_archive_beneficial_owner_params.rbi | 8 +- .../increase/models/entity_confirm_params.rbi | 8 +- .../entity_create_beneficial_owner_params.rbi | 112 +- .../increase/models/entity_create_params.rbi | 606 ++++++- .../increase/models/entity_list_params.rbi | 35 +- .../models/entity_supplemental_document.rbi | 18 +- .../models/entity_update_address_params.rbi | 23 +- ...update_beneficial_owner_address_params.rbi | 29 +- .../entity_update_industry_code_params.rbi | 10 +- rbi/lib/increase/models/event.rbi | 18 +- rbi/lib/increase/models/event_list_params.rbi | 32 +- .../increase/models/event_subscription.rbi | 17 +- .../event_subscription_create_params.rbi | 11 +- .../models/event_subscription_list_params.rbi | 15 +- .../event_subscription_update_params.rbi | 7 +- rbi/lib/increase/models/export.rbi | 18 +- .../increase/models/export_create_params.rbi | 124 +- .../increase/models/export_list_params.rbi | 39 +- rbi/lib/increase/models/external_account.rbi | 15 + .../models/external_account_create_params.rbi | 10 +- .../models/external_account_list_params.rbi | 20 +- .../models/external_account_update_params.rbi | 13 +- rbi/lib/increase/models/file.rbi | 18 +- .../increase/models/file_create_params.rbi | 13 +- rbi/lib/increase/models/file_link.rbi | 26 +- .../models/file_link_create_params.rbi | 10 +- rbi/lib/increase/models/file_list_params.rbi | 34 +- rbi/lib/increase/models/group.rbi | 16 +- .../increase/models/inbound_ach_transfer.rbi | 145 +- ...r_create_notification_of_change_params.rbi | 9 +- .../inbound_ach_transfer_decline_params.rbi | 9 +- .../inbound_ach_transfer_list_params.rbi | 29 +- ...nd_ach_transfer_transfer_return_params.rbi | 8 +- .../increase/models/inbound_check_deposit.rbi | 56 +- .../inbound_check_deposit_list_params.rbi | 26 +- .../inbound_check_deposit_return_params.rbi | 7 +- rbi/lib/increase/models/inbound_mail_item.rbi | 15 +- .../models/inbound_mail_item_list_params.rbi | 29 +- .../inbound_real_time_payments_transfer.rbi | 37 +- ...eal_time_payments_transfer_list_params.rbi | 27 +- .../models/inbound_wire_drawdown_request.rbi | 31 + ...ound_wire_drawdown_request_list_params.rbi | 10 +- .../increase/models/inbound_wire_transfer.rbi | 30 + .../inbound_wire_transfer_list_params.rbi | 29 +- .../models/intrafi_account_enrollment.rbi | 24 +- ...trafi_account_enrollment_create_params.rbi | 9 +- ...intrafi_account_enrollment_list_params.rbi | 20 +- rbi/lib/increase/models/intrafi_balance.rbi | 44 +- rbi/lib/increase/models/intrafi_exclusion.rbi | 15 + .../intrafi_exclusion_create_params.rbi | 9 +- .../models/intrafi_exclusion_list_params.rbi | 17 +- rbi/lib/increase/models/lockbox.rbi | 38 +- .../increase/models/lockbox_create_params.rbi | 11 +- .../increase/models/lockbox_list_params.rbi | 28 +- .../increase/models/lockbox_update_params.rbi | 11 +- rbi/lib/increase/models/oauth_application.rbi | 22 +- .../models/oauth_application_list_params.rbi | 35 +- rbi/lib/increase/models/oauth_connection.rbi | 21 +- .../models/oauth_connection_list_params.rbi | 22 +- rbi/lib/increase/models/oauth_token.rbi | 12 +- .../models/oauth_token_create_params.rbi | 15 +- .../increase/models/pending_transaction.rbi | 248 ++- .../pending_transaction_list_params.rbi | 37 +- rbi/lib/increase/models/physical_card.rbi | 65 +- .../models/physical_card_create_params.rbi | 51 +- .../models/physical_card_list_params.rbi | 28 +- .../increase/models/physical_card_profile.rbi | 18 + .../physical_card_profile_clone_params.rbi | 16 +- .../physical_card_profile_create_params.rbi | 5 + .../physical_card_profile_list_params.rbi | 24 +- .../models/physical_card_update_params.rbi | 7 +- rbi/lib/increase/models/program.rbi | 14 + .../increase/models/program_list_params.rbi | 10 +- .../increase/models/real_time_decision.rbi | 209 ++- .../real_time_decision_action_params.rbi | 75 +- .../models/real_time_payments_transfer.rbi | 121 +- ...l_time_payments_transfer_create_params.rbi | 18 + ...eal_time_payments_transfer_list_params.rbi | 33 +- .../models/routing_number_list_params.rbi | 12 +- .../models/routing_number_list_response.rbi | 11 +- .../account_statement_create_params.rbi | 7 +- ...r_create_notification_of_change_params.rbi | 9 +- .../ach_transfer_return_params.rbi | 8 +- .../card_authorization_create_params.rbi | 39 +- .../card_authorization_create_response.rbi | 15 +- ...authorization_expiration_create_params.rbi | 7 +- .../card_dispute_action_params.rbi | 9 +- .../card_fuel_confirmation_create_params.rbi | 10 +- .../card_increment_create_params.rbi | 14 +- .../simulations/card_refund_create_params.rbi | 8 +- .../card_reversal_create_params.rbi | 10 +- .../card_settlement_create_params.rbi | 13 +- ...tal_wallet_token_request_create_params.rbi | 7 +- ...l_wallet_token_request_create_response.rbi | 13 +- .../simulations/document_create_params.rbi | 7 +- .../inbound_ach_transfer_create_params.rbi | 14 + .../inbound_check_deposit_create_params.rbi | 11 +- .../inbound_funds_hold_release_response.rbi | 15 + .../inbound_mail_item_create_params.rbi | 12 +- ...l_time_payments_transfer_create_params.rbi | 8 + ...nd_wire_drawdown_request_create_params.rbi | 26 + .../inbound_wire_transfer_create_params.rbi | 32 + .../interest_payment_create_params.rbi | 9 +- .../physical_card_advance_shipment_params.rbi | 7 +- .../simulations/program_create_params.rbi | 7 +- ...time_payments_transfer_complete_params.rbi | 13 +- .../supplemental_document_create_params.rbi | 9 +- .../supplemental_document_list_params.rbi | 17 +- rbi/lib/increase/models/transaction.rbi | 821 ++++++++- .../models/transaction_list_params.rbi | 29 +- .../increase/models/wire_drawdown_request.rbi | 36 +- .../wire_drawdown_request_create_params.rbi | 21 + .../wire_drawdown_request_list_params.rbi | 24 +- rbi/lib/increase/models/wire_transfer.rbi | 120 +- .../models/wire_transfer_create_params.rbi | 22 + .../models/wire_transfer_list_params.rbi | 25 +- 433 files changed, 17458 insertions(+), 4752 deletions(-) diff --git a/lib/increase/models/account.rb b/lib/increase/models/account.rb index ac65714a3..9afcda483 100644 --- a/lib/increase/models/account.rb +++ b/lib/increase/models/account.rb @@ -107,24 +107,51 @@ class Account < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::Account::Type } # @!method initialize(id:, bank:, closed_at:, created_at:, currency:, entity_id:, idempotency_key:, informational_entity_id:, interest_accrued:, interest_accrued_at:, interest_rate:, name:, program_id:, status:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Account} for more details. + # # Accounts are your bank accounts with Increase. They store money, receive # transfers, and send payments. They earn interest and have depository insurance. # - # @param id [String] - # @param bank [Symbol, Increase::Models::Account::Bank] - # @param closed_at [Time, nil] - # @param created_at [Time] - # @param currency [Symbol, Increase::Models::Account::Currency] - # @param entity_id [String, nil] - # @param idempotency_key [String, nil] - # @param informational_entity_id [String, nil] - # @param interest_accrued [String] - # @param interest_accrued_at [Date, nil] - # @param interest_rate [String] - # @param name [String] - # @param program_id [String] - # @param status [Symbol, Increase::Models::Account::Status] - # @param type [Symbol, Increase::Models::Account::Type] + # @param id [String] The Account identifier. + # + # @param bank [Symbol, Increase::Models::Account::Bank] The bank the Account is with. + # + # @param closed_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account + # ... + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account + # ... + # + # @param currency [Symbol, Increase::Models::Account::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account curr + # ... + # + # @param entity_id [String, nil] The identifier for the Entity the Account belongs to. + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param informational_entity_id [String, nil] The identifier of an Entity that, while not owning the Account, is associated wi + # ... + # + # @param interest_accrued [String] The interest accrued but not yet paid, expressed as a string containing a floati + # ... + # + # @param interest_accrued_at [Date, nil] The latest [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which inte + # ... + # + # @param interest_rate [String] The Interest Rate currently being earned on the account, as a string containing + # ... + # + # @param name [String] The name you choose for the Account. + # + # @param program_id [String] The identifier of the Program determining the compliance and commercial terms of + # ... + # + # @param status [Symbol, Increase::Models::Account::Status] The status of the Account. + # + # @param type [Symbol, Increase::Models::Account::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The bank the Account is with. # diff --git a/lib/increase/models/account_balance_params.rb b/lib/increase/models/account_balance_params.rb index 7e4f090e2..b106d4120 100644 --- a/lib/increase/models/account_balance_params.rb +++ b/lib/increase/models/account_balance_params.rb @@ -14,7 +14,8 @@ class AccountBalanceParams < Increase::Internal::Type::BaseModel optional :at_time, Time # @!method initialize(at_time: nil, request_options: {}) - # @param at_time [Time] + # @param at_time [Time] The moment to query the balance at. If not set, returns the current balances. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/account_create_params.rb b/lib/increase/models/account_create_params.rb index e93eb0f31..0461bfbf5 100644 --- a/lib/increase/models/account_create_params.rb +++ b/lib/increase/models/account_create_params.rb @@ -34,10 +34,19 @@ class AccountCreateParams < Increase::Internal::Type::BaseModel optional :program_id, String # @!method initialize(name:, entity_id: nil, informational_entity_id: nil, program_id: nil, request_options: {}) - # @param name [String] - # @param entity_id [String] - # @param informational_entity_id [String] - # @param program_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountCreateParams} for more details. + # + # @param name [String] The name you choose for the Account. + # + # @param entity_id [String] The identifier for the Entity that will own the Account. + # + # @param informational_entity_id [String] The identifier of an Entity that, while not owning the Account, is associated wi + # ... + # + # @param program_id [String] The identifier for the Program that this Account falls under. Required if you op + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/account_list_params.rb b/lib/increase/models/account_list_params.rb index bdafaaace..61e2bf381 100644 --- a/lib/increase/models/account_list_params.rb +++ b/lib/increase/models/account_list_params.rb @@ -58,14 +58,27 @@ class AccountListParams < Increase::Internal::Type::BaseModel optional :status, -> { Increase::Models::AccountListParams::Status } # @!method initialize(created_at: nil, cursor: nil, entity_id: nil, idempotency_key: nil, informational_entity_id: nil, limit: nil, program_id: nil, status: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountListParams} for more details. + # # @param created_at [Increase::Models::AccountListParams::CreatedAt] - # @param cursor [String] - # @param entity_id [String] - # @param idempotency_key [String] - # @param informational_entity_id [String] - # @param limit [Integer] - # @param program_id [String] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param entity_id [String] Filter Accounts 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 informational_entity_id [String] Filter Accounts for those belonging to the specified Entity as informational. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # + # @param program_id [String] Filter Accounts for those in a specific Program. + # # @param status [Increase::Models::AccountListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel @@ -98,10 +111,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountListParams::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 @@ -115,7 +138,11 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountListParams::Status} for more details. + # + # @param in_ [Array] Filter Accounts for those with the specified status. For GET requests, this shou + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/account_number.rb b/lib/increase/models/account_number.rb index 50f2748cd..5d7c7efce 100644 --- a/lib/increase/models/account_number.rb +++ b/lib/increase/models/account_number.rb @@ -76,23 +76,40 @@ class AccountNumber < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::AccountNumber::Type } # @!method initialize(id:, account_id:, account_number:, created_at:, idempotency_key:, inbound_ach:, inbound_checks:, name:, routing_number:, status:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountNumber} for more details. + # # Each account can have multiple account and routing numbers. We recommend that # you use a set per vendor. This is similar to how you use different passwords for # different websites. Account numbers can also be used to seamlessly reconcile # inbound payments. Generating a unique account number per vendor ensures you # always know the originator of an incoming payment. # - # @param id [String] - # @param account_id [String] - # @param account_number [String] - # @param created_at [Time] - # @param idempotency_key [String, nil] - # @param inbound_ach [Increase::Models::AccountNumber::InboundACH] - # @param inbound_checks [Increase::Models::AccountNumber::InboundChecks] - # @param name [String] - # @param routing_number [String] - # @param status [Symbol, Increase::Models::AccountNumber::Status] - # @param type [Symbol, Increase::Models::AccountNumber::Type] + # @param id [String] The Account Number identifier. + # + # @param account_id [String] The identifier for the account this Account Number belongs to. + # + # @param account_number [String] The account number. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account + # ... + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param inbound_ach [Increase::Models::AccountNumber::InboundACH] Properties related to how this Account Number handles inbound ACH transfers. + # + # @param inbound_checks [Increase::Models::AccountNumber::InboundChecks] Properties related to how this Account Number should handle inbound check withdr + # ... + # + # @param name [String] The name you choose for the Account Number. + # + # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN). + # + # @param status [Symbol, Increase::Models::AccountNumber::Status] This indicates if payments can be made to the Account Number. + # + # @param type [Symbol, Increase::Models::AccountNumber::Type] A constant representing the object's type. For this resource it will always be ` + # ... # @see Increase::Models::AccountNumber#inbound_ach class InboundACH < Increase::Internal::Type::BaseModel @@ -104,9 +121,13 @@ class InboundACH < Increase::Internal::Type::BaseModel required :debit_status, enum: -> { Increase::Models::AccountNumber::InboundACH::DebitStatus } # @!method initialize(debit_status:) + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountNumber::InboundACH} for more details. + # # Properties related to how this Account Number handles inbound ACH transfers. # - # @param debit_status [Symbol, Increase::Models::AccountNumber::InboundACH::DebitStatus] + # @param debit_status [Symbol, Increase::Models::AccountNumber::InboundACH::DebitStatus] Whether ACH debits are allowed against this Account Number. Note that they will + # ... # Whether ACH debits are allowed against this Account Number. Note that they will # still be declined if this is `allowed` if the Account Number is not active. @@ -138,7 +159,7 @@ class InboundChecks < Increase::Internal::Type::BaseModel # Properties related to how this Account Number should handle inbound check # withdrawals. # - # @param status [Symbol, Increase::Models::AccountNumber::InboundChecks::Status] + # @param status [Symbol, Increase::Models::AccountNumber::InboundChecks::Status] How Increase should process checks with this account number printed on them. # How Increase should process checks with this account number printed on them. # diff --git a/lib/increase/models/account_number_create_params.rb b/lib/increase/models/account_number_create_params.rb index 913f4855c..3c2dffb58 100644 --- a/lib/increase/models/account_number_create_params.rb +++ b/lib/increase/models/account_number_create_params.rb @@ -33,10 +33,18 @@ class AccountNumberCreateParams < Increase::Internal::Type::BaseModel optional :inbound_checks, -> { Increase::Models::AccountNumberCreateParams::InboundChecks } # @!method initialize(account_id:, name:, inbound_ach: nil, inbound_checks: nil, request_options: {}) - # @param account_id [String] - # @param name [String] - # @param inbound_ach [Increase::Models::AccountNumberCreateParams::InboundACH] - # @param inbound_checks [Increase::Models::AccountNumberCreateParams::InboundChecks] + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountNumberCreateParams} for more details. + # + # @param account_id [String] The Account the Account Number should belong to. + # + # @param name [String] The name you choose for the Account Number. + # + # @param inbound_ach [Increase::Models::AccountNumberCreateParams::InboundACH] Options related to how this Account Number should handle inbound ACH transfers. + # + # @param inbound_checks [Increase::Models::AccountNumberCreateParams::InboundChecks] Options related to how this Account Number should handle inbound check withdrawa + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class InboundACH < Increase::Internal::Type::BaseModel @@ -49,9 +57,13 @@ class InboundACH < Increase::Internal::Type::BaseModel required :debit_status, enum: -> { Increase::Models::AccountNumberCreateParams::InboundACH::DebitStatus } # @!method initialize(debit_status:) + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountNumberCreateParams::InboundACH} for more details. + # # Options related to how this Account Number should handle inbound ACH transfers. # - # @param debit_status [Symbol, Increase::Models::AccountNumberCreateParams::InboundACH::DebitStatus] + # @param debit_status [Symbol, Increase::Models::AccountNumberCreateParams::InboundACH::DebitStatus] Whether ACH debits are allowed against this Account Number. Note that ACH debits + # ... # Whether ACH debits are allowed against this Account Number. Note that ACH debits # will be declined if this is `allowed` but the Account Number is not active. If @@ -81,10 +93,14 @@ class InboundChecks < Increase::Internal::Type::BaseModel required :status, enum: -> { Increase::Models::AccountNumberCreateParams::InboundChecks::Status } # @!method initialize(status:) + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountNumberCreateParams::InboundChecks} for more details. + # # Options related to how this Account Number should handle inbound check # withdrawals. # - # @param status [Symbol, Increase::Models::AccountNumberCreateParams::InboundChecks::Status] + # @param status [Symbol, Increase::Models::AccountNumberCreateParams::InboundChecks::Status] How Increase should process checks with this account number printed on them. If + # ... # How Increase should process checks with this account number printed on them. If # you do not specify this field, the default is `check_transfers_only`. diff --git a/lib/increase/models/account_number_list_params.rb b/lib/increase/models/account_number_list_params.rb index a10dde1d1..4bbda809d 100644 --- a/lib/increase/models/account_number_list_params.rb +++ b/lib/increase/models/account_number_list_params.rb @@ -51,13 +51,25 @@ class AccountNumberListParams < Increase::Internal::Type::BaseModel optional :status, -> { Increase::Models::AccountNumberListParams::Status } # @!method initialize(account_id: nil, ach_debit_status: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) - # @param account_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountNumberListParams} for more details. + # + # @param account_id [String] Filter Account Numbers to those belonging to the specified Account. + # # @param ach_debit_status [Increase::Models::AccountNumberListParams::ACHDebitStatus] + # # @param created_at [Increase::Models::AccountNumberListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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::AccountNumberListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class ACHDebitStatus < Increase::Internal::Type::BaseModel @@ -71,7 +83,11 @@ class ACHDebitStatus < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountNumberListParams::ACHDebitStatus} for more details. + # + # @param in_ [Array] The ACH Debit status to retrieve Account Numbers for. For GET requests, this sho + # ... module In extend Increase::Internal::Type::Enum @@ -117,10 +133,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountNumberListParams::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 @@ -134,7 +160,11 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountNumberListParams::Status} for more details. + # + # @param in_ [Array] The status to retrieve Account Numbers for. For GET requests, this should be enc + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/account_number_update_params.rb b/lib/increase/models/account_number_update_params.rb index 517ca4fce..9733a78b8 100644 --- a/lib/increase/models/account_number_update_params.rb +++ b/lib/increase/models/account_number_update_params.rb @@ -33,10 +33,18 @@ class AccountNumberUpdateParams < Increase::Internal::Type::BaseModel optional :status, enum: -> { Increase::Models::AccountNumberUpdateParams::Status } # @!method initialize(inbound_ach: nil, inbound_checks: nil, name: nil, status: nil, request_options: {}) - # @param inbound_ach [Increase::Models::AccountNumberUpdateParams::InboundACH] - # @param inbound_checks [Increase::Models::AccountNumberUpdateParams::InboundChecks] - # @param name [String] - # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::Status] + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountNumberUpdateParams} for more details. + # + # @param inbound_ach [Increase::Models::AccountNumberUpdateParams::InboundACH] Options related to how this Account Number handles inbound ACH transfers. + # + # @param inbound_checks [Increase::Models::AccountNumberUpdateParams::InboundChecks] Options related to how this Account Number should handle inbound check withdrawa + # ... + # + # @param name [String] The name you choose for the Account Number. + # + # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::Status] This indicates if transfers can be made to the Account Number. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class InboundACH < Increase::Internal::Type::BaseModel @@ -48,9 +56,13 @@ class InboundACH < Increase::Internal::Type::BaseModel optional :debit_status, enum: -> { Increase::Models::AccountNumberUpdateParams::InboundACH::DebitStatus } # @!method initialize(debit_status: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountNumberUpdateParams::InboundACH} for more details. + # # Options related to how this Account Number handles inbound ACH transfers. # - # @param debit_status [Symbol, Increase::Models::AccountNumberUpdateParams::InboundACH::DebitStatus] + # @param debit_status [Symbol, Increase::Models::AccountNumberUpdateParams::InboundACH::DebitStatus] Whether ACH debits are allowed against this Account Number. Note that ACH debits + # ... # Whether ACH debits are allowed against this Account Number. Note that ACH debits # will be declined if this is `allowed` but the Account Number is not active. @@ -81,7 +93,7 @@ class InboundChecks < Increase::Internal::Type::BaseModel # Options related to how this Account Number should handle inbound check # withdrawals. # - # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::InboundChecks::Status] + # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::InboundChecks::Status] How Increase should process checks with this account number printed on them. # How Increase should process checks with this account number printed on them. # diff --git a/lib/increase/models/account_statement.rb b/lib/increase/models/account_statement.rb index b59a91283..1ece24c78 100644 --- a/lib/increase/models/account_statement.rb +++ b/lib/increase/models/account_statement.rb @@ -63,19 +63,34 @@ class AccountStatement < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::AccountStatement::Type } # @!method initialize(id:, account_id:, created_at:, ending_balance:, file_id:, starting_balance:, statement_period_end:, statement_period_start:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountStatement} for more details. + # # Account Statements are generated monthly for every active Account. You can # access the statement's data via the API or retrieve a PDF with its details via # its associated File. # - # @param id [String] - # @param account_id [String] - # @param created_at [Time] - # @param ending_balance [Integer] - # @param file_id [String] - # @param starting_balance [Integer] - # @param statement_period_end [Time] - # @param statement_period_start [Time] - # @param type [Symbol, Increase::Models::AccountStatement::Type] + # @param id [String] The Account Statement identifier. + # + # @param account_id [String] The identifier for the Account this Account Statement belongs to. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account + # ... + # + # @param ending_balance [Integer] The Account's balance at the start of its statement period. + # + # @param file_id [String] The identifier of the File containing a PDF of the statement. + # + # @param starting_balance [Integer] The Account's balance at the start of its statement period. + # + # @param statement_period_end [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end + # ... + # + # @param statement_period_start [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the sta + # ... + # + # @param type [Symbol, Increase::Models::AccountStatement::Type] A constant representing the object's type. For this resource it will always be ` + # ... # A constant representing the object's type. For this resource it will always be # `account_statement`. diff --git a/lib/increase/models/account_statement_list_params.rb b/lib/increase/models/account_statement_list_params.rb index 4a6f45bed..fc7c7abd8 100644 --- a/lib/increase/models/account_statement_list_params.rb +++ b/lib/increase/models/account_statement_list_params.rb @@ -33,10 +33,18 @@ class AccountStatementListParams < Increase::Internal::Type::BaseModel -> { Increase::Models::AccountStatementListParams::StatementPeriodStart } # @!method initialize(account_id: nil, cursor: nil, limit: nil, statement_period_start: nil, request_options: {}) - # @param account_id [String] - # @param cursor [String] - # @param limit [Integer] + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountStatementListParams} for more details. + # + # @param account_id [String] Filter Account Statements to those belonging to the specified Account. + # + # @param cursor [String] Return the page of entries after this one. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # # @param statement_period_start [Increase::Models::AccountStatementListParams::StatementPeriodStart] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class StatementPeriodStart < Increase::Internal::Type::BaseModel @@ -69,10 +77,21 @@ class StatementPeriodStart < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountStatementListParams::StatementPeriodStart} 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 diff --git a/lib/increase/models/account_transfer.rb b/lib/increase/models/account_transfer.rb index 706c02e0c..183c3a1ee 100644 --- a/lib/increase/models/account_transfer.rb +++ b/lib/increase/models/account_transfer.rb @@ -118,25 +118,52 @@ class AccountTransfer < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::AccountTransfer::Type } # @!method initialize(id:, account_id:, amount:, approval:, cancellation:, created_at:, created_by:, currency:, description:, destination_account_id:, destination_transaction_id:, idempotency_key:, network:, pending_transaction_id:, status:, transaction_id:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountTransfer} for more details. + # # Account transfers move funds between your own accounts at Increase. # - # @param id [String] - # @param account_id [String] - # @param amount [Integer] - # @param approval [Increase::Models::AccountTransfer::Approval, nil] - # @param cancellation [Increase::Models::AccountTransfer::Cancellation, nil] - # @param created_at [Time] - # @param created_by [Increase::Models::AccountTransfer::CreatedBy, nil] - # @param currency [Symbol, Increase::Models::AccountTransfer::Currency] - # @param description [String] - # @param destination_account_id [String] - # @param destination_transaction_id [String, nil] - # @param idempotency_key [String, nil] - # @param network [Symbol, Increase::Models::AccountTransfer::Network] - # @param pending_transaction_id [String, nil] - # @param status [Symbol, Increase::Models::AccountTransfer::Status] - # @param transaction_id [String, nil] - # @param type [Symbol, Increase::Models::AccountTransfer::Type] + # @param id [String] The account transfer's identifier. + # + # @param account_id [String] The Account to which the transfer belongs. + # + # @param amount [Integer] The transfer amount in the minor unit of the destination account currency. For d + # ... + # + # @param approval [Increase::Models::AccountTransfer::Approval, nil] If your account requires approvals for transfers and the transfer was approved, + # ... + # + # @param cancellation [Increase::Models::AccountTransfer::Cancellation, nil] If your account requires approvals for transfers and the transfer was not approv + # ... + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param created_by [Increase::Models::AccountTransfer::CreatedBy, nil] What object created the transfer, either via the API or the dashboard. + # + # @param currency [Symbol, Increase::Models::AccountTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination + # ... + # + # @param description [String] The description that will show on the transactions. + # + # @param destination_account_id [String] The destination account's identifier. + # + # @param destination_transaction_id [String, nil] The ID for the transaction receiving the transfer. + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param network [Symbol, Increase::Models::AccountTransfer::Network] The transfer's network. + # + # @param pending_transaction_id [String, nil] The ID for the pending transaction representing the transfer. A pending transact + # ... + # + # @param status [Symbol, Increase::Models::AccountTransfer::Status] The lifecycle status of the transfer. + # + # @param transaction_id [String, nil] The ID for the transaction funding the transfer. + # + # @param type [Symbol, Increase::Models::AccountTransfer::Type] A constant representing the object's type. For this resource it will always be ` + # ... # @see Increase::Models::AccountTransfer#approval class Approval < Increase::Internal::Type::BaseModel @@ -155,11 +182,17 @@ class Approval < Increase::Internal::Type::BaseModel required :approved_by, String, nil?: true # @!method initialize(approved_at:, approved_by:) + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountTransfer::Approval} for more details. + # # If your account requires approvals for transfers and the transfer was approved, # this will contain details of the approval. # - # @param approved_at [Time] - # @param approved_by [String, nil] + # @param approved_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param approved_by [String, nil] If the Transfer was approved by a user in the dashboard, the email address of th + # ... end # @see Increase::Models::AccountTransfer#cancellation @@ -179,11 +212,17 @@ class Cancellation < Increase::Internal::Type::BaseModel required :canceled_by, String, nil?: true # @!method initialize(canceled_at:, canceled_by:) + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountTransfer::Cancellation} for more details. + # # If your account requires approvals for transfers and the transfer was not # approved, this will contain details of the cancellation. # - # @param canceled_at [Time] - # @param canceled_by [String, nil] + # @param canceled_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param canceled_by [String, nil] If the Transfer was canceled by a user in the dashboard, the email address of th + # ... end # @see Increase::Models::AccountTransfer#created_by @@ -217,10 +256,13 @@ class CreatedBy < Increase::Internal::Type::BaseModel # @!method initialize(api_key:, category:, oauth_application:, user:) # What object created the transfer, either via the API or the dashboard. # - # @param api_key [Increase::Models::AccountTransfer::CreatedBy::APIKey, nil] - # @param category [Symbol, Increase::Models::AccountTransfer::CreatedBy::Category] - # @param oauth_application [Increase::Models::AccountTransfer::CreatedBy::OAuthApplication, nil] - # @param user [Increase::Models::AccountTransfer::CreatedBy::User, nil] + # @param api_key [Increase::Models::AccountTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer. + # + # @param category [Symbol, Increase::Models::AccountTransfer::CreatedBy::Category] The type of object that created this transfer. + # + # @param oauth_application [Increase::Models::AccountTransfer::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer. + # + # @param user [Increase::Models::AccountTransfer::CreatedBy::User, nil] If present, details about the User that created the transfer. # @see Increase::Models::AccountTransfer::CreatedBy#api_key class APIKey < Increase::Internal::Type::BaseModel @@ -233,7 +275,7 @@ class APIKey < Increase::Internal::Type::BaseModel # @!method initialize(description:) # If present, details about the API key that created the transfer. # - # @param description [String, nil] + # @param description [String, nil] The description set for the API key when it was created. end # The type of object that created this transfer. @@ -266,7 +308,7 @@ class OAuthApplication < Increase::Internal::Type::BaseModel # @!method initialize(name:) # If present, details about the OAuth Application that created the transfer. # - # @param name [String] + # @param name [String] The name of the OAuth Application. end # @see Increase::Models::AccountTransfer::CreatedBy#user @@ -280,7 +322,7 @@ class User < Increase::Internal::Type::BaseModel # @!method initialize(email:) # If present, details about the User that created the transfer. # - # @param email [String] + # @param email [String] The email address of the User. end end diff --git a/lib/increase/models/account_transfer_create_params.rb b/lib/increase/models/account_transfer_create_params.rb index acbddeaac..a51c431ad 100644 --- a/lib/increase/models/account_transfer_create_params.rb +++ b/lib/increase/models/account_transfer_create_params.rb @@ -39,11 +39,20 @@ class AccountTransferCreateParams < Increase::Internal::Type::BaseModel optional :require_approval, Increase::Internal::Type::Boolean # @!method initialize(account_id:, amount:, description:, destination_account_id:, require_approval: nil, request_options: {}) - # @param account_id [String] - # @param amount [Integer] - # @param description [String] - # @param destination_account_id [String] - # @param require_approval [Boolean] + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountTransferCreateParams} for more details. + # + # @param account_id [String] The identifier for the account that will send the transfer. + # + # @param amount [Integer] The transfer amount in the minor unit of the account currency. For dollars, for + # ... + # + # @param description [String] The description you choose to give the transfer. + # + # @param destination_account_id [String] The identifier for the account that will receive the transfer. + # + # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/account_transfer_list_params.rb b/lib/increase/models/account_transfer_list_params.rb index 483f1e9bf..317b733ad 100644 --- a/lib/increase/models/account_transfer_list_params.rb +++ b/lib/increase/models/account_transfer_list_params.rb @@ -41,11 +41,21 @@ class AccountTransferListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) - # @param account_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountTransferListParams} for more details. + # + # @param account_id [String] Filter Account Transfers to those that originated from the specified Account. + # # @param created_at [Increase::Models::AccountTransferListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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 @@ -78,10 +88,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountTransferListParams::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 diff --git a/lib/increase/models/account_update_params.rb b/lib/increase/models/account_update_params.rb index 4560bd0aa..344104bcf 100644 --- a/lib/increase/models/account_update_params.rb +++ b/lib/increase/models/account_update_params.rb @@ -14,7 +14,8 @@ class AccountUpdateParams < Increase::Internal::Type::BaseModel optional :name, String # @!method initialize(name: nil, request_options: {}) - # @param name [String] + # @param name [String] The new name of the Account. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/ach_prenotification.rb b/lib/increase/models/ach_prenotification.rb index efdd74b21..1cb31cd4a 100644 --- a/lib/increase/models/ach_prenotification.rb +++ b/lib/increase/models/ach_prenotification.rb @@ -111,25 +111,48 @@ class ACHPrenotification < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::ACHPrenotification::Type } # @!method initialize(id:, account_number:, addendum:, company_descriptive_date:, company_discretionary_data:, company_entry_description:, company_name:, created_at:, credit_debit_indicator:, effective_date:, idempotency_key:, notifications_of_change:, prenotification_return:, routing_number:, status:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHPrenotification} for more details. + # # ACH Prenotifications are one way you can verify account and routing numbers by # Automated Clearing House (ACH). # - # @param id [String] - # @param account_number [String] - # @param addendum [String, nil] - # @param company_descriptive_date [String, nil] - # @param company_discretionary_data [String, nil] - # @param company_entry_description [String, nil] - # @param company_name [String, nil] - # @param created_at [Time] - # @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotification::CreditDebitIndicator, nil] - # @param effective_date [Time, nil] - # @param idempotency_key [String, nil] - # @param notifications_of_change [Array] - # @param prenotification_return [Increase::Models::ACHPrenotification::PrenotificationReturn, nil] - # @param routing_number [String] - # @param status [Symbol, Increase::Models::ACHPrenotification::Status] - # @param type [Symbol, Increase::Models::ACHPrenotification::Type] + # @param id [String] The ACH Prenotification's identifier. + # + # @param account_number [String] The destination account number. + # + # @param addendum [String, nil] Additional information for the recipient. + # + # @param company_descriptive_date [String, nil] The description of the date of the notification. + # + # @param company_discretionary_data [String, nil] Optional data associated with the notification. + # + # @param company_entry_description [String, nil] The description of the notification. + # + # @param company_name [String, nil] The name by which you know the company. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotification::CreditDebitIndicator, nil] If the notification is for a future credit or debit. + # + # @param effective_date [Time, nil] The effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + # ... + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param notifications_of_change [Array] If the receiving bank notifies that future transfers should use different detail + # ... + # + # @param prenotification_return [Increase::Models::ACHPrenotification::PrenotificationReturn, nil] If your prenotification is returned, this will contain details of the return. + # + # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN). + # + # @param status [Symbol, Increase::Models::ACHPrenotification::Status] The lifecycle status of the ACH Prenotification. + # + # @param type [Symbol, Increase::Models::ACHPrenotification::Type] A constant representing the object's type. For this resource it will always be ` + # ... # If the notification is for a future credit or debit. # @@ -174,9 +197,17 @@ class NotificationsOfChange < Increase::Internal::Type::BaseModel required :created_at, Time # @!method initialize(change_code:, corrected_data:, created_at:) - # @param change_code [Symbol, Increase::Models::ACHPrenotification::NotificationsOfChange::ChangeCode] - # @param corrected_data [String] - # @param created_at [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHPrenotification::NotificationsOfChange} for more details. + # + # @param change_code [Symbol, Increase::Models::ACHPrenotification::NotificationsOfChange::ChangeCode] The required type of change that is being signaled by the receiving financial in + # ... + # + # @param corrected_data [String] The corrected data that should be used in future ACHs to this account. This may + # ... + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... # The required type of change that is being signaled by the receiving financial # institution. @@ -270,10 +301,15 @@ class PrenotificationReturn < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::ACHPrenotification::PrenotificationReturn::ReturnReasonCode } # @!method initialize(created_at:, return_reason_code:) + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHPrenotification::PrenotificationReturn} for more details. + # # If your prenotification is returned, this will contain details of the return. # - # @param created_at [Time] - # @param return_reason_code [Symbol, Increase::Models::ACHPrenotification::PrenotificationReturn::ReturnReasonCode] + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param return_reason_code [Symbol, Increase::Models::ACHPrenotification::PrenotificationReturn::ReturnReasonCode] Why the Prenotification was returned. # Why the Prenotification was returned. # diff --git a/lib/increase/models/ach_prenotification_create_params.rb b/lib/increase/models/ach_prenotification_create_params.rb index e1b0f47a0..33b68dbd4 100644 --- a/lib/increase/models/ach_prenotification_create_params.rb +++ b/lib/increase/models/ach_prenotification_create_params.rb @@ -91,19 +91,38 @@ class ACHPrenotificationCreateParams < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode } # @!method initialize(account_id:, account_number:, routing_number:, addendum: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, credit_debit_indicator: nil, effective_date: nil, individual_id: nil, individual_name: nil, standard_entry_class_code: nil, request_options: {}) - # @param account_id [String] - # @param account_number [String] - # @param routing_number [String] - # @param addendum [String] - # @param company_descriptive_date [String] - # @param company_discretionary_data [String] - # @param company_entry_description [String] - # @param company_name [String] - # @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator] - # @param effective_date [Date] - # @param individual_id [String] - # @param individual_name [String] - # @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode] + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHPrenotificationCreateParams} for more details. + # + # @param account_id [String] The Increase identifier for the account that will send the transfer. + # + # @param account_number [String] The account number for the destination account. + # + # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des + # ... + # + # @param addendum [String] Additional information that will be sent to the recipient. + # + # @param company_descriptive_date [String] The description of the date of the transfer. + # + # @param company_discretionary_data [String] The data you choose to associate with the transfer. + # + # @param company_entry_description [String] The description of the transfer you wish to be shown to the recipient. + # + # @param company_name [String] The name by which the recipient knows you. + # + # @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator] Whether the Prenotification is for a future debit or credit. + # + # @param effective_date [Date] The transfer effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601 + # ... + # + # @param individual_id [String] Your identifier for the transfer recipient. + # + # @param individual_name [String] The name of the transfer recipient. This value is information and not verified b + # ... + # + # @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode] The Standard Entry Class (SEC) code to use for the ACH Prenotification. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # Whether the Prenotification is for a future debit or credit. diff --git a/lib/increase/models/ach_prenotification_list_params.rb b/lib/increase/models/ach_prenotification_list_params.rb index 4cb2a0ea2..bab0a3ad4 100644 --- a/lib/increase/models/ach_prenotification_list_params.rb +++ b/lib/increase/models/ach_prenotification_list_params.rb @@ -35,10 +35,19 @@ class ACHPrenotificationListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHPrenotificationListParams} for more details. + # # @param created_at [Increase::Models::ACHPrenotificationListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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 @@ -71,10 +80,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHPrenotificationListParams::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 diff --git a/lib/increase/models/ach_transfer.rb b/lib/increase/models/ach_transfer.rb index 8f14b1b27..621f38b88 100644 --- a/lib/increase/models/ach_transfer.rb +++ b/lib/increase/models/ach_transfer.rb @@ -248,45 +248,99 @@ class ACHTransfer < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::ACHTransfer::Type } # @!method initialize(id:, account_id:, account_number:, acknowledgement:, addenda:, amount:, approval:, cancellation:, company_descriptive_date:, company_discretionary_data:, company_entry_description:, company_id:, company_name:, created_at:, created_by:, currency:, destination_account_holder:, external_account_id:, funding:, idempotency_key:, inbound_funds_hold:, individual_id:, individual_name:, network:, notifications_of_change:, pending_transaction_id:, preferred_effective_date:, return_:, routing_number:, settlement:, standard_entry_class_code:, statement_descriptor:, status:, submission:, transaction_id:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransfer} for more details. + # # ACH transfers move funds between your Increase account and any other account # accessible by the Automated Clearing House (ACH). # - # @param id [String] - # @param account_id [String] - # @param account_number [String] - # @param acknowledgement [Increase::Models::ACHTransfer::Acknowledgement, nil] - # @param addenda [Increase::Models::ACHTransfer::Addenda, nil] - # @param amount [Integer] - # @param approval [Increase::Models::ACHTransfer::Approval, nil] - # @param cancellation [Increase::Models::ACHTransfer::Cancellation, nil] - # @param company_descriptive_date [String, nil] - # @param company_discretionary_data [String, nil] - # @param company_entry_description [String, nil] - # @param company_id [String] - # @param company_name [String, nil] - # @param created_at [Time] - # @param created_by [Increase::Models::ACHTransfer::CreatedBy, nil] - # @param currency [Symbol, Increase::Models::ACHTransfer::Currency] - # @param destination_account_holder [Symbol, Increase::Models::ACHTransfer::DestinationAccountHolder] - # @param external_account_id [String, nil] - # @param funding [Symbol, Increase::Models::ACHTransfer::Funding] - # @param idempotency_key [String, nil] - # @param inbound_funds_hold [Increase::Models::ACHTransfer::InboundFundsHold, nil] - # @param individual_id [String, nil] - # @param individual_name [String, nil] - # @param network [Symbol, Increase::Models::ACHTransfer::Network] - # @param notifications_of_change [Array] - # @param pending_transaction_id [String, nil] - # @param preferred_effective_date [Increase::Models::ACHTransfer::PreferredEffectiveDate] - # @param return_ [Increase::Models::ACHTransfer::Return, nil] - # @param routing_number [String] - # @param settlement [Increase::Models::ACHTransfer::Settlement, nil] - # @param standard_entry_class_code [Symbol, Increase::Models::ACHTransfer::StandardEntryClassCode] - # @param statement_descriptor [String] - # @param status [Symbol, Increase::Models::ACHTransfer::Status] - # @param submission [Increase::Models::ACHTransfer::Submission, nil] - # @param transaction_id [String, nil] - # @param type [Symbol, Increase::Models::ACHTransfer::Type] + # @param id [String] The ACH transfer's identifier. + # + # @param account_id [String] The Account to which the transfer belongs. + # + # @param account_number [String] The destination account number. + # + # @param acknowledgement [Increase::Models::ACHTransfer::Acknowledgement, nil] After the transfer is acknowledged by FedACH, this will contain supplemental det + # ... + # + # @param addenda [Increase::Models::ACHTransfer::Addenda, nil] Additional information that will be sent to the recipient. + # + # @param amount [Integer] The transfer amount in USD cents. A positive amount indicates a credit transfer + # ... + # + # @param approval [Increase::Models::ACHTransfer::Approval, nil] If your account requires approvals for transfers and the transfer was approved, + # ... + # + # @param cancellation [Increase::Models::ACHTransfer::Cancellation, nil] If your account requires approvals for transfers and the transfer was not approv + # ... + # + # @param company_descriptive_date [String, nil] The description of the date of the transfer. + # + # @param company_discretionary_data [String, nil] The data you chose to associate with the transfer. + # + # @param company_entry_description [String, nil] The description of the transfer you set to be shown to the recipient. + # + # @param company_id [String] The company ID associated with the transfer. + # + # @param company_name [String, nil] The name by which the recipient knows you. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param created_by [Increase::Models::ACHTransfer::CreatedBy, nil] What object created the transfer, either via the API or the dashboard. + # + # @param currency [Symbol, Increase::Models::ACHTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's c + # ... + # + # @param destination_account_holder [Symbol, Increase::Models::ACHTransfer::DestinationAccountHolder] The type of entity that owns the account to which the ACH Transfer is being sent + # ... + # + # @param external_account_id [String, nil] The identifier of the External Account the transfer was made to, if any. + # + # @param funding [Symbol, Increase::Models::ACHTransfer::Funding] The type of the account to which the transfer will be sent. + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param inbound_funds_hold [Increase::Models::ACHTransfer::InboundFundsHold, nil] Increase will sometimes hold the funds for ACH debit transfers. If funds are hel + # ... + # + # @param individual_id [String, nil] Your identifier for the transfer recipient. + # + # @param individual_name [String, nil] The name of the transfer recipient. This value is information and not verified b + # ... + # + # @param network [Symbol, Increase::Models::ACHTransfer::Network] The transfer's network. + # + # @param notifications_of_change [Array] If the receiving bank accepts the transfer but notifies that future transfers sh + # ... + # + # @param pending_transaction_id [String, nil] The ID for the pending transaction representing the transfer. A pending transact + # ... + # + # @param preferred_effective_date [Increase::Models::ACHTransfer::PreferredEffectiveDate] Configuration for how the effective date of the transfer will be set. This deter + # ... + # + # @param return_ [Increase::Models::ACHTransfer::Return, nil] If your transfer is returned, this will contain details of the return. + # + # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN). + # + # @param settlement [Increase::Models::ACHTransfer::Settlement, nil] A subhash containing information about when and how the transfer settled at the + # ... + # + # @param standard_entry_class_code [Symbol, Increase::Models::ACHTransfer::StandardEntryClassCode] The Standard Entry Class (SEC) code to use for the transfer. + # + # @param statement_descriptor [String] The descriptor that will show on the recipient's bank statement. + # + # @param status [Symbol, Increase::Models::ACHTransfer::Status] The lifecycle status of the transfer. + # + # @param submission [Increase::Models::ACHTransfer::Submission, nil] After the transfer is submitted to FedACH, this will contain supplemental detail + # ... + # + # @param transaction_id [String, nil] The ID for the transaction funding the transfer. + # + # @param type [Symbol, Increase::Models::ACHTransfer::Type] A constant representing the object's type. For this resource it will always be ` + # ... # @see Increase::Models::ACHTransfer#acknowledgement class Acknowledgement < Increase::Internal::Type::BaseModel @@ -298,11 +352,15 @@ class Acknowledgement < Increase::Internal::Type::BaseModel required :acknowledged_at, String # @!method initialize(acknowledged_at:) + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransfer::Acknowledgement} for more details. + # # After the transfer is acknowledged by FedACH, this will contain supplemental # details. The Federal Reserve sends an acknowledgement message for each file that # Increase submits. # - # @param acknowledged_at [String] + # @param acknowledged_at [String] When the Federal Reserve acknowledged the submitted file containing this transfe + # ... end # @see Increase::Models::ACHTransfer#addenda @@ -330,11 +388,18 @@ class Addenda < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(category:, freeform:, payment_order_remittance_advice:) + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransfer::Addenda} for more details. + # # Additional information that will be sent to the recipient. # - # @param category [Symbol, Increase::Models::ACHTransfer::Addenda::Category] - # @param freeform [Increase::Models::ACHTransfer::Addenda::Freeform, nil] - # @param payment_order_remittance_advice [Increase::Models::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice, nil] + # @param category [Symbol, Increase::Models::ACHTransfer::Addenda::Category] The type of the resource. We may add additional possible values for this enum ov + # ... + # + # @param freeform [Increase::Models::ACHTransfer::Addenda::Freeform, nil] Unstructured `payment_related_information` passed through with the transfer. + # + # @param payment_order_remittance_advice [Increase::Models::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice, nil] Structured ASC X12 820 remittance advice records. Please reach out to [support@i + # ... # The type of the resource. We may add additional possible values for this enum # over time; your application should be able to handle such additions gracefully. @@ -368,7 +433,7 @@ class Freeform < Increase::Internal::Type::BaseModel # @!method initialize(entries:) # Unstructured `payment_related_information` passed through with the transfer. # - # @param entries [Array] + # @param entries [Array] Each entry represents an addendum sent with the transfer. class Entry < Increase::Internal::Type::BaseModel # @!attribute payment_related_information @@ -378,7 +443,7 @@ class Entry < Increase::Internal::Type::BaseModel required :payment_related_information, String # @!method initialize(payment_related_information:) - # @param payment_related_information [String] + # @param payment_related_information [String] The payment related information passed in the addendum. end end @@ -395,7 +460,7 @@ class PaymentOrderRemittanceAdvice < Increase::Internal::Type::BaseModel # Structured ASC X12 820 remittance advice records. Please reach out to # [support@increase.com](mailto:support@increase.com) for more information. # - # @param invoices [Array] + # @param invoices [Array] ASC X12 RMR records for this specific transfer. class Invoice < Increase::Internal::Type::BaseModel # @!attribute invoice_number @@ -412,8 +477,14 @@ class Invoice < Increase::Internal::Type::BaseModel required :paid_amount, Integer # @!method initialize(invoice_number:, paid_amount:) - # @param invoice_number [String] - # @param paid_amount [Integer] + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice::Invoice} + # for more details. + # + # @param invoice_number [String] The invoice number for this reference, determined in advance with the receiver. + # + # @param paid_amount [Integer] The amount that was paid for this invoice in the minor unit of its currency. For + # ... end end end @@ -435,11 +506,17 @@ class Approval < Increase::Internal::Type::BaseModel required :approved_by, String, nil?: true # @!method initialize(approved_at:, approved_by:) + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransfer::Approval} for more details. + # # If your account requires approvals for transfers and the transfer was approved, # this will contain details of the approval. # - # @param approved_at [Time] - # @param approved_by [String, nil] + # @param approved_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param approved_by [String, nil] If the Transfer was approved by a user in the dashboard, the email address of th + # ... end # @see Increase::Models::ACHTransfer#cancellation @@ -459,11 +536,17 @@ class Cancellation < Increase::Internal::Type::BaseModel required :canceled_by, String, nil?: true # @!method initialize(canceled_at:, canceled_by:) + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransfer::Cancellation} for more details. + # # If your account requires approvals for transfers and the transfer was not # approved, this will contain details of the cancellation. # - # @param canceled_at [Time] - # @param canceled_by [String, nil] + # @param canceled_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param canceled_by [String, nil] If the Transfer was canceled by a user in the dashboard, the email address of th + # ... end # @see Increase::Models::ACHTransfer#created_by @@ -495,10 +578,13 @@ class CreatedBy < Increase::Internal::Type::BaseModel # @!method initialize(api_key:, category:, oauth_application:, user:) # What object created the transfer, either via the API or the dashboard. # - # @param api_key [Increase::Models::ACHTransfer::CreatedBy::APIKey, nil] - # @param category [Symbol, Increase::Models::ACHTransfer::CreatedBy::Category] - # @param oauth_application [Increase::Models::ACHTransfer::CreatedBy::OAuthApplication, nil] - # @param user [Increase::Models::ACHTransfer::CreatedBy::User, nil] + # @param api_key [Increase::Models::ACHTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer. + # + # @param category [Symbol, Increase::Models::ACHTransfer::CreatedBy::Category] The type of object that created this transfer. + # + # @param oauth_application [Increase::Models::ACHTransfer::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer. + # + # @param user [Increase::Models::ACHTransfer::CreatedBy::User, nil] If present, details about the User that created the transfer. # @see Increase::Models::ACHTransfer::CreatedBy#api_key class APIKey < Increase::Internal::Type::BaseModel @@ -511,7 +597,7 @@ class APIKey < Increase::Internal::Type::BaseModel # @!method initialize(description:) # If present, details about the API key that created the transfer. # - # @param description [String, nil] + # @param description [String, nil] The description set for the API key when it was created. end # The type of object that created this transfer. @@ -544,7 +630,7 @@ class OAuthApplication < Increase::Internal::Type::BaseModel # @!method initialize(name:) # If present, details about the OAuth Application that created the transfer. # - # @param name [String] + # @param name [String] The name of the OAuth Application. end # @see Increase::Models::ACHTransfer::CreatedBy#user @@ -558,7 +644,7 @@ class User < Increase::Internal::Type::BaseModel # @!method initialize(email:) # If present, details about the User that created the transfer. # - # @param email [String] + # @param email [String] The email address of the User. end end @@ -695,19 +781,36 @@ class InboundFundsHold < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::ACHTransfer::InboundFundsHold::Type } # @!method initialize(id:, amount:, automatically_releases_at:, created_at:, currency:, held_transaction_id:, pending_transaction_id:, released_at:, status:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransfer::InboundFundsHold} for more details. + # # Increase will sometimes hold the funds for ACH debit transfers. If funds are # held, this sub-object will contain details of the hold. # - # @param id [String] - # @param amount [Integer] - # @param automatically_releases_at [Time] - # @param created_at [Time] - # @param currency [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Currency] - # @param held_transaction_id [String, nil] - # @param pending_transaction_id [String, nil] - # @param released_at [Time, nil] - # @param status [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Status] - # @param type [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Type] + # @param id [String] The Inbound Funds Hold identifier. + # + # @param amount [Integer] The held amount in the minor unit of the account's currency. For dollars, for ex + # ... + # + # @param automatically_releases_at [Time] When the hold will be released automatically. Certain conditions may cause it to + # ... + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold wa + # ... + # + # @param currency [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's curre + # ... + # + # @param held_transaction_id [String, nil] The ID of the Transaction for which funds were held. + # + # @param pending_transaction_id [String, nil] The ID of the Pending Transaction representing the held funds. + # + # @param released_at [Time, nil] When the hold was released (if it has been released). + # + # @param status [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Status] The status of the hold. + # + # @param type [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's # currency. @@ -806,9 +909,17 @@ class NotificationsOfChange < Increase::Internal::Type::BaseModel required :created_at, Time # @!method initialize(change_code:, corrected_data:, created_at:) - # @param change_code [Symbol, Increase::Models::ACHTransfer::NotificationsOfChange::ChangeCode] - # @param corrected_data [String] - # @param created_at [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransfer::NotificationsOfChange} for more details. + # + # @param change_code [Symbol, Increase::Models::ACHTransfer::NotificationsOfChange::ChangeCode] The required type of change that is being signaled by the receiving financial in + # ... + # + # @param corrected_data [String] The corrected data that should be used in future ACHs to this account. This may + # ... + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... # The required type of change that is being signaled by the receiving financial # institution. @@ -903,13 +1014,18 @@ class PreferredEffectiveDate < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(date:, settlement_schedule:) + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransfer::PreferredEffectiveDate} for more details. + # # Configuration for how the effective date of the transfer will be set. This # determines same-day vs future-dated settlement timing. If not set, defaults to a # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes # must be set. # - # @param date [Date, nil] - # @param settlement_schedule [Symbol, Increase::Models::ACHTransfer::PreferredEffectiveDate::SettlementSchedule, nil] + # @param date [Date, nil] A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to + # ... + # + # @param settlement_schedule [Symbol, Increase::Models::ACHTransfer::PreferredEffectiveDate::SettlementSchedule, nil] A schedule by which Increase will choose an effective date for the transfer. # A schedule by which Increase will choose an effective date for the transfer. # @@ -975,14 +1091,25 @@ class Return < Increase::Internal::Type::BaseModel required :transfer_id, String # @!method initialize(created_at:, raw_return_reason_code:, return_reason_code:, trace_number:, transaction_id:, transfer_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransfer::Return} for more details. + # # If your transfer is returned, this will contain details of the return. # - # @param created_at [Time] - # @param raw_return_reason_code [String] - # @param return_reason_code [Symbol, Increase::Models::ACHTransfer::Return::ReturnReasonCode] - # @param trace_number [String] - # @param transaction_id [String] - # @param transfer_id [String] + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param raw_return_reason_code [String] The three character ACH return code, in the range R01 to R85. + # + # @param return_reason_code [Symbol, Increase::Models::ACHTransfer::Return::ReturnReasonCode] Why the ACH Transfer was returned. This reason code is sent by the receiving ban + # ... + # + # @param trace_number [String] A 15 digit number that was generated by the bank that initiated the return. The + # ... + # + # @param transaction_id [String] The identifier of the Transaction associated with this return. + # + # @param transfer_id [String] The identifier of the ACH Transfer associated with this return. # Why the ACH Transfer was returned. This reason code is sent by the receiving # bank back to Increase. @@ -1219,10 +1346,14 @@ class Settlement < Increase::Internal::Type::BaseModel required :settled_at, Time # @!method initialize(settled_at:) + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransfer::Settlement} for more details. + # # A subhash containing information about when and how the transfer settled at the # Federal Reserve. # - # @param settled_at [Time] + # @param settled_at [Time] When the funds for this transfer have settled at the destination bank at the Fed + # ... end # The Standard Entry Class (SEC) code to use for the transfer. @@ -1330,17 +1461,28 @@ class Submission < Increase::Internal::Type::BaseModel required :trace_number, String # @!method initialize(effective_date:, expected_funds_settlement_at:, expected_settlement_schedule:, submitted_at:, trace_number:) + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransfer::Submission} for more details. + # # After the transfer is submitted to FedACH, this will contain supplemental # details. Increase batches transfers and submits a file to the Federal Reserve # roughly every 30 minutes. The Federal Reserve processes ACH transfers during # weekdays according to their # [posted schedule](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html). # - # @param effective_date [Date] - # @param expected_funds_settlement_at [Time] - # @param expected_settlement_schedule [Symbol, Increase::Models::ACHTransfer::Submission::ExpectedSettlementSchedule] - # @param submitted_at [Time] - # @param trace_number [String] + # @param effective_date [Date] The ACH transfer's effective date as sent to the Federal Reserve. If a specific + # ... + # + # @param expected_funds_settlement_at [Time] When the transfer is expected to settle in the recipient's account. Credits may + # ... + # + # @param expected_settlement_schedule [Symbol, Increase::Models::ACHTransfer::Submission::ExpectedSettlementSchedule] The settlement schedule the transfer is expected to follow. This expectation tak + # ... + # + # @param submitted_at [Time] When the ACH transfer was sent to FedACH. + # + # @param trace_number [String] A 15 digit number recorded in the Nacha file and transmitted to the receiving ba + # ... # The settlement schedule the transfer is expected to follow. This expectation # takes into account the `effective_date`, `submitted_at`, and the amount of the diff --git a/lib/increase/models/ach_transfer_create_params.rb b/lib/increase/models/ach_transfer_create_params.rb index 6a7517b16..7eda470f9 100644 --- a/lib/increase/models/ach_transfer_create_params.rb +++ b/lib/increase/models/ach_transfer_create_params.rb @@ -144,25 +144,59 @@ class ACHTransferCreateParams < Increase::Internal::Type::BaseModel optional :transaction_timing, enum: -> { Increase::Models::ACHTransferCreateParams::TransactionTiming } # @!method initialize(account_id:, amount:, statement_descriptor:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, individual_name: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, transaction_timing: nil, request_options: {}) - # @param account_id [String] - # @param amount [Integer] - # @param statement_descriptor [String] - # @param account_number [String] - # @param addenda [Increase::Models::ACHTransferCreateParams::Addenda] - # @param company_descriptive_date [String] - # @param company_discretionary_data [String] - # @param company_entry_description [String] - # @param company_name [String] - # @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder] - # @param external_account_id [String] - # @param funding [Symbol, Increase::Models::ACHTransferCreateParams::Funding] - # @param individual_id [String] - # @param individual_name [String] - # @param preferred_effective_date [Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate] - # @param require_approval [Boolean] - # @param routing_number [String] - # @param standard_entry_class_code [Symbol, Increase::Models::ACHTransferCreateParams::StandardEntryClassCode] - # @param transaction_timing [Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming] + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransferCreateParams} for more details. + # + # @param account_id [String] The Increase identifier for the account that will send the transfer. + # + # @param amount [Integer] The transfer amount in USD cents. A positive amount originates a credit transfer + # ... + # + # @param statement_descriptor [String] A description you choose to give the transfer. This will be saved with the trans + # ... + # + # @param account_number [String] The account number for the destination account. + # + # @param addenda [Increase::Models::ACHTransferCreateParams::Addenda] Additional information that will be sent to the recipient. This is included in t + # ... + # + # @param company_descriptive_date [String] The description of the date of the transfer, usually in the format `YYMMDD`. Thi + # ... + # + # @param company_discretionary_data [String] The data you choose to associate with the transfer. This is included in the tran + # ... + # + # @param company_entry_description [String] A description of the transfer. This is included in the transfer data sent to the + # ... + # + # @param company_name [String] The name by which the recipient knows you. This is included in the transfer data + # ... + # + # @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder] The type of entity that owns the account to which the ACH Transfer is being sent + # ... + # + # @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr + # ... + # + # @param funding [Symbol, Increase::Models::ACHTransferCreateParams::Funding] The type of the account to which the transfer will be sent. + # + # @param individual_id [String] Your identifier for the transfer recipient. + # + # @param individual_name [String] The name of the transfer recipient. This value is informational and not verified + # ... + # + # @param preferred_effective_date [Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate] Configuration for how the effective date of the transfer will be set. This deter + # ... + # + # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API. + # + # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des + # ... + # + # @param standard_entry_class_code [Symbol, Increase::Models::ACHTransferCreateParams::StandardEntryClassCode] The Standard Entry Class (SEC) code to use for the transfer. + # + # @param transaction_timing [Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming] The timing of the transaction. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Addenda < Increase::Internal::Type::BaseModel @@ -187,12 +221,18 @@ class Addenda < Increase::Internal::Type::BaseModel -> { Increase::Models::ACHTransferCreateParams::Addenda::PaymentOrderRemittanceAdvice } # @!method initialize(category:, freeform: nil, payment_order_remittance_advice: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransferCreateParams::Addenda} for more details. + # # Additional information that will be sent to the recipient. This is included in # the transfer data sent to the receiving bank. # - # @param category [Symbol, Increase::Models::ACHTransferCreateParams::Addenda::Category] - # @param freeform [Increase::Models::ACHTransferCreateParams::Addenda::Freeform] - # @param payment_order_remittance_advice [Increase::Models::ACHTransferCreateParams::Addenda::PaymentOrderRemittanceAdvice] + # @param category [Symbol, Increase::Models::ACHTransferCreateParams::Addenda::Category] The type of addenda to pass with the transfer. + # + # @param freeform [Increase::Models::ACHTransferCreateParams::Addenda::Freeform] Unstructured `payment_related_information` passed through with the transfer. + # + # @param payment_order_remittance_advice [Increase::Models::ACHTransferCreateParams::Addenda::PaymentOrderRemittanceAdvice] Structured ASC X12 820 remittance advice records. Please reach out to [support@i + # ... # The type of addenda to pass with the transfer. # @@ -222,9 +262,13 @@ class Freeform < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[Increase::Models::ACHTransferCreateParams::Addenda::Freeform::Entry] } # @!method initialize(entries:) + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransferCreateParams::Addenda::Freeform} for more details. + # # Unstructured `payment_related_information` passed through with the transfer. # - # @param entries [Array] + # @param entries [Array] Each entry represents an addendum sent with the transfer. Please reach out to [s + # ... class Entry < Increase::Internal::Type::BaseModel # @!attribute payment_related_information @@ -234,7 +278,7 @@ class Entry < Increase::Internal::Type::BaseModel required :payment_related_information, String # @!method initialize(payment_related_information:) - # @param payment_related_information [String] + # @param payment_related_information [String] The payment related information passed in the addendum. end end @@ -251,7 +295,7 @@ class PaymentOrderRemittanceAdvice < Increase::Internal::Type::BaseModel # Structured ASC X12 820 remittance advice records. Please reach out to # [support@increase.com](mailto:support@increase.com) for more information. # - # @param invoices [Array] + # @param invoices [Array] ASC X12 RMR records for this specific transfer. class Invoice < Increase::Internal::Type::BaseModel # @!attribute invoice_number @@ -268,8 +312,14 @@ class Invoice < Increase::Internal::Type::BaseModel required :paid_amount, Integer # @!method initialize(invoice_number:, paid_amount:) - # @param invoice_number [String] - # @param paid_amount [Integer] + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransferCreateParams::Addenda::PaymentOrderRemittanceAdvice::Invoice} + # for more details. + # + # @param invoice_number [String] The invoice number for this reference, determined in advance with the receiver. + # + # @param paid_amount [Integer] The amount that was paid for this invoice in the minor unit of its currency. For + # ... end end end @@ -322,13 +372,19 @@ class PreferredEffectiveDate < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate::SettlementSchedule } # @!method initialize(date: nil, settlement_schedule: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate} for more + # details. + # # Configuration for how the effective date of the transfer will be set. This # determines same-day vs future-dated settlement timing. If not set, defaults to a # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes # must be set. # - # @param date [Date] - # @param settlement_schedule [Symbol, Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate::SettlementSchedule] + # @param date [Date] A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to + # ... + # + # @param settlement_schedule [Symbol, Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate::SettlementSchedule] A schedule by which Increase will choose an effective date for the transfer. # A schedule by which Increase will choose an effective date for the transfer. # diff --git a/lib/increase/models/ach_transfer_list_params.rb b/lib/increase/models/ach_transfer_list_params.rb index f9015dfe4..12b57147b 100644 --- a/lib/increase/models/ach_transfer_list_params.rb +++ b/lib/increase/models/ach_transfer_list_params.rb @@ -52,13 +52,25 @@ class ACHTransferListParams < Increase::Internal::Type::BaseModel optional :status, -> { Increase::Models::ACHTransferListParams::Status } # @!method initialize(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) - # @param account_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransferListParams} for more details. + # + # @param account_id [String] Filter ACH Transfers to those that originated from the specified Account. + # # @param created_at [Increase::Models::ACHTransferListParams::CreatedAt] - # @param cursor [String] - # @param external_account_id [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param external_account_id [String] Filter ACH Transfers to those made to the specified External Account. + # + # @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::ACHTransferListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel @@ -91,10 +103,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransferListParams::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 @@ -108,7 +130,11 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransferListParams::Status} for more details. + # + # @param in_ [Array] Return results whose value is in the provided list. For GET requests, this shoul + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/balance_lookup.rb b/lib/increase/models/balance_lookup.rb index 8e7e0559f..c67404a10 100644 --- a/lib/increase/models/balance_lookup.rb +++ b/lib/increase/models/balance_lookup.rb @@ -32,13 +32,22 @@ class BalanceLookup < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::BalanceLookup::Type } # @!method initialize(account_id:, available_balance:, current_balance:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::BalanceLookup} for more details. + # # Represents a request to lookup the balance of an Account at a given point in # time. # - # @param account_id [String] - # @param available_balance [Integer] - # @param current_balance [Integer] - # @param type [Symbol, Increase::Models::BalanceLookup::Type] + # @param account_id [String] The identifier for the account for which the balance was queried. + # + # @param available_balance [Integer] The Account's available balance, representing the current balance less any open + # ... + # + # @param current_balance [Integer] The Account's current balance, representing the sum of all posted Transactions o + # ... + # + # @param type [Symbol, Increase::Models::BalanceLookup::Type] A constant representing the object's type. For this resource it will always be ` + # ... # A constant representing the object's type. For this resource it will always be # `balance_lookup`. diff --git a/lib/increase/models/bookkeeping_account.rb b/lib/increase/models/bookkeeping_account.rb index 5e6358431..57e22be4c 100644 --- a/lib/increase/models/bookkeeping_account.rb +++ b/lib/increase/models/bookkeeping_account.rb @@ -52,17 +52,28 @@ class BookkeepingAccount < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::BookkeepingAccount::Type } # @!method initialize(id:, account_id:, compliance_category:, entity_id:, idempotency_key:, name:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::BookkeepingAccount} for more details. + # # Accounts are T-accounts. They can store accounting entries. Your compliance # setup might require annotating money movements using this API. Learn more in our # [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping). # - # @param id [String] - # @param account_id [String, nil] - # @param compliance_category [Symbol, Increase::Models::BookkeepingAccount::ComplianceCategory, nil] - # @param entity_id [String, nil] - # @param idempotency_key [String, nil] - # @param name [String] - # @param type [Symbol, Increase::Models::BookkeepingAccount::Type] + # @param id [String] The account identifier. + # + # @param account_id [String, nil] The API Account associated with this bookkeeping account. + # + # @param compliance_category [Symbol, Increase::Models::BookkeepingAccount::ComplianceCategory, nil] The compliance category of the account. + # + # @param entity_id [String, nil] The Entity associated with this bookkeeping account. + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param name [String] The name you choose for the account. + # + # @param type [Symbol, Increase::Models::BookkeepingAccount::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The compliance category of the account. # diff --git a/lib/increase/models/bookkeeping_account_balance_params.rb b/lib/increase/models/bookkeeping_account_balance_params.rb index bfd3ff65d..2d5ca3b26 100644 --- a/lib/increase/models/bookkeeping_account_balance_params.rb +++ b/lib/increase/models/bookkeeping_account_balance_params.rb @@ -14,7 +14,8 @@ class BookkeepingAccountBalanceParams < Increase::Internal::Type::BaseModel optional :at_time, Time # @!method initialize(at_time: nil, request_options: {}) - # @param at_time [Time] + # @param at_time [Time] The moment to query the balance at. If not set, returns the current balances. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/bookkeeping_account_create_params.rb b/lib/increase/models/bookkeeping_account_create_params.rb index e81050273..db357c3c0 100644 --- a/lib/increase/models/bookkeeping_account_create_params.rb +++ b/lib/increase/models/bookkeeping_account_create_params.rb @@ -33,10 +33,14 @@ class BookkeepingAccountCreateParams < Increase::Internal::Type::BaseModel optional :entity_id, String # @!method initialize(name:, account_id: nil, compliance_category: nil, entity_id: nil, request_options: {}) - # @param name [String] - # @param account_id [String] - # @param compliance_category [Symbol, Increase::Models::BookkeepingAccountCreateParams::ComplianceCategory] - # @param entity_id [String] + # @param name [String] The name you choose for the account. + # + # @param account_id [String] The entity, if `compliance_category` is `commingled_cash`. + # + # @param compliance_category [Symbol, Increase::Models::BookkeepingAccountCreateParams::ComplianceCategory] The account compliance category. + # + # @param entity_id [String] The entity, if `compliance_category` is `customer_balance`. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The account compliance category. diff --git a/lib/increase/models/bookkeeping_account_list_params.rb b/lib/increase/models/bookkeeping_account_list_params.rb index 6ca67aa18..aff0e1793 100644 --- a/lib/increase/models/bookkeeping_account_list_params.rb +++ b/lib/increase/models/bookkeeping_account_list_params.rb @@ -30,9 +30,17 @@ class BookkeepingAccountListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # Some parameter documentations has been truncated, see + # {Increase::Models::BookkeepingAccountListParams} for more details. + # + # @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}] end end diff --git a/lib/increase/models/bookkeeping_account_update_params.rb b/lib/increase/models/bookkeeping_account_update_params.rb index 68ba33baa..81a05c8b2 100644 --- a/lib/increase/models/bookkeeping_account_update_params.rb +++ b/lib/increase/models/bookkeeping_account_update_params.rb @@ -14,7 +14,8 @@ class BookkeepingAccountUpdateParams < Increase::Internal::Type::BaseModel required :name, String # @!method initialize(name:, request_options: {}) - # @param name [String] + # @param name [String] The name you choose for the account. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/bookkeeping_balance_lookup.rb b/lib/increase/models/bookkeeping_balance_lookup.rb index 8018eff14..0bd1236d3 100644 --- a/lib/increase/models/bookkeeping_balance_lookup.rb +++ b/lib/increase/models/bookkeeping_balance_lookup.rb @@ -25,12 +25,19 @@ class BookkeepingBalanceLookup < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::BookkeepingBalanceLookup::Type } # @!method initialize(balance:, bookkeeping_account_id:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::BookkeepingBalanceLookup} for more details. + # # Represents a request to lookup the balance of an Bookkeeping Account at a given # point in time. # - # @param balance [Integer] - # @param bookkeeping_account_id [String] - # @param type [Symbol, Increase::Models::BookkeepingBalanceLookup::Type] + # @param balance [Integer] The Bookkeeping Account's current balance, representing the sum of all Bookkeepi + # ... + # + # @param bookkeeping_account_id [String] The identifier for the account for which the balance was queried. + # + # @param type [Symbol, Increase::Models::BookkeepingBalanceLookup::Type] A constant representing the object's type. For this resource it will always be ` + # ... # A constant representing the object's type. For this resource it will always be # `bookkeeping_balance_lookup`. diff --git a/lib/increase/models/bookkeeping_entry.rb b/lib/increase/models/bookkeeping_entry.rb index e12c77e6d..01e244cc4 100644 --- a/lib/increase/models/bookkeeping_entry.rb +++ b/lib/increase/models/bookkeeping_entry.rb @@ -43,16 +43,26 @@ class BookkeepingEntry < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::BookkeepingEntry::Type } # @!method initialize(id:, account_id:, amount:, created_at:, entry_set_id:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::BookkeepingEntry} for more details. + # # Entries are T-account entries recording debits and credits. Your compliance # setup might require annotating money movements using this API. Learn more in our # [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping). # - # @param id [String] - # @param account_id [String] - # @param amount [Integer] - # @param created_at [Time] - # @param entry_set_id [String] - # @param type [Symbol, Increase::Models::BookkeepingEntry::Type] + # @param id [String] The entry identifier. + # + # @param account_id [String] The identifier for the Account the Entry belongs to. + # + # @param amount [Integer] The Entry amount in the minor unit of its currency. For dollars, for example, th + # ... + # + # @param created_at [Time] When the entry set was created. + # + # @param entry_set_id [String] The identifier for the Account the Entry belongs to. + # + # @param type [Symbol, Increase::Models::BookkeepingEntry::Type] A constant representing the object's type. For this resource it will always be ` + # ... # A constant representing the object's type. For this resource it will always be # `bookkeeping_entry`. diff --git a/lib/increase/models/bookkeeping_entry_list_params.rb b/lib/increase/models/bookkeeping_entry_list_params.rb index 47aa09fd3..02ffa9eac 100644 --- a/lib/increase/models/bookkeeping_entry_list_params.rb +++ b/lib/increase/models/bookkeeping_entry_list_params.rb @@ -27,9 +27,16 @@ class BookkeepingEntryListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(account_id: nil, cursor: nil, limit: nil, request_options: {}) - # @param account_id [String] - # @param cursor [String] - # @param limit [Integer] + # Some parameter documentations has been truncated, see + # {Increase::Models::BookkeepingEntryListParams} for more details. + # + # @param account_id [String] The identifier for the Bookkeeping Account to filter by. + # + # @param cursor [String] Return the page of entries after this one. + # + # @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 diff --git a/lib/increase/models/bookkeeping_entry_set.rb b/lib/increase/models/bookkeeping_entry_set.rb index fecc59992..517c96d09 100644 --- a/lib/increase/models/bookkeeping_entry_set.rb +++ b/lib/increase/models/bookkeeping_entry_set.rb @@ -50,18 +50,29 @@ class BookkeepingEntrySet < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::BookkeepingEntrySet::Type } # @!method initialize(id:, created_at:, date:, entries:, idempotency_key:, transaction_id:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::BookkeepingEntrySet} for more details. + # # Entry Sets are accounting entries that are transactionally applied. Your # compliance setup might require annotating money movements using this API. Learn # more in our # [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping). # - # @param id [String] - # @param created_at [Time] - # @param date [Time] - # @param entries [Array] - # @param idempotency_key [String, nil] - # @param transaction_id [String, nil] - # @param type [Symbol, Increase::Models::BookkeepingEntrySet::Type] + # @param id [String] The entry set identifier. + # + # @param created_at [Time] When the entry set was created. + # + # @param date [Time] The timestamp of the entry set. + # + # @param entries [Array] The entries. + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param transaction_id [String, nil] The transaction identifier, if any. + # + # @param type [Symbol, Increase::Models::BookkeepingEntrySet::Type] A constant representing the object's type. For this resource it will always be ` + # ... class Entry < Increase::Internal::Type::BaseModel # @!attribute id @@ -83,9 +94,11 @@ class Entry < Increase::Internal::Type::BaseModel required :amount, Integer # @!method initialize(id:, account_id:, amount:) - # @param id [String] - # @param account_id [String] - # @param amount [Integer] + # @param id [String] The entry identifier. + # + # @param account_id [String] The bookkeeping account impacted by the entry. + # + # @param amount [Integer] The amount of the entry in minor units. end # A constant representing the object's type. For this resource it will always be diff --git a/lib/increase/models/bookkeeping_entry_set_create_params.rb b/lib/increase/models/bookkeeping_entry_set_create_params.rb index c2a1ff1ad..8d9758382 100644 --- a/lib/increase/models/bookkeeping_entry_set_create_params.rb +++ b/lib/increase/models/bookkeeping_entry_set_create_params.rb @@ -28,9 +28,16 @@ class BookkeepingEntrySetCreateParams < Increase::Internal::Type::BaseModel optional :transaction_id, String # @!method initialize(entries:, date: nil, transaction_id: nil, request_options: {}) - # @param entries [Array] - # @param date [Time] - # @param transaction_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::BookkeepingEntrySetCreateParams} for more details. + # + # @param entries [Array] The bookkeeping entries. + # + # @param date [Time] The date of the transaction. Optional if `transaction_id` is provided, in which + # ... + # + # @param transaction_id [String] The identifier of the Transaction related to this entry set, if any. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Entry < Increase::Internal::Type::BaseModel @@ -49,8 +56,13 @@ class Entry < Increase::Internal::Type::BaseModel required :amount, Integer # @!method initialize(account_id:, amount:) - # @param account_id [String] - # @param amount [Integer] + # Some parameter documentations has been truncated, see + # {Increase::Models::BookkeepingEntrySetCreateParams::Entry} for more details. + # + # @param account_id [String] The identifier for the Bookkeeping Account impacted by this entry. + # + # @param amount [Integer] The entry amount in the minor unit of the account currency. For dollars, for exa + # ... end end end diff --git a/lib/increase/models/bookkeeping_entry_set_list_params.rb b/lib/increase/models/bookkeeping_entry_set_list_params.rb index e38da0ca9..4205c345d 100644 --- a/lib/increase/models/bookkeeping_entry_set_list_params.rb +++ b/lib/increase/models/bookkeeping_entry_set_list_params.rb @@ -36,10 +36,19 @@ class BookkeepingEntrySetListParams < Increase::Internal::Type::BaseModel optional :transaction_id, String # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, transaction_id: nil, request_options: {}) - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] - # @param transaction_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::BookkeepingEntrySetListParams} for more details. + # + # @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 transaction_id [String] Filter to the Bookkeeping Entry Set that maps to this Transaction. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/card.rb b/lib/increase/models/card.rb index 04c1cf296..824603fe0 100644 --- a/lib/increase/models/card.rb +++ b/lib/increase/models/card.rb @@ -89,24 +89,43 @@ class Card < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::Card::Type } # @!method initialize(id:, account_id:, billing_address:, created_at:, description:, digital_wallet:, entity_id:, expiration_month:, expiration_year:, idempotency_key:, last4:, status:, type:) + # Some parameter documentations has been truncated, see {Increase::Models::Card} + # for more details. + # # Cards are commercial credit cards. They'll immediately work for online purchases # after you create them. All cards maintain a credit limit of 100% of the # Account’s available balance at the time of transaction. Funds are deducted from # the Account upon transaction settlement. # - # @param id [String] - # @param account_id [String] - # @param billing_address [Increase::Models::Card::BillingAddress] - # @param created_at [Time] - # @param description [String, nil] - # @param digital_wallet [Increase::Models::Card::DigitalWallet, nil] - # @param entity_id [String, nil] - # @param expiration_month [Integer] - # @param expiration_year [Integer] - # @param idempotency_key [String, nil] - # @param last4 [String] - # @param status [Symbol, Increase::Models::Card::Status] - # @param type [Symbol, Increase::Models::Card::Type] + # @param id [String] The card identifier. + # + # @param account_id [String] The identifier for the account this card belongs to. + # + # @param billing_address [Increase::Models::Card::BillingAddress] The Card's billing address. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param description [String, nil] The card's description for display purposes. + # + # @param digital_wallet [Increase::Models::Card::DigitalWallet, nil] The contact information used in the two-factor steps for digital wallet card cre + # ... + # + # @param entity_id [String, nil] The identifier for the entity associated with this card. + # + # @param expiration_month [Integer] The month the card expires in M format (e.g., August is 8). + # + # @param expiration_year [Integer] The year the card expires in YYYY format (e.g., 2025). + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param last4 [String] The last 4 digits of the Card's Primary Account Number. + # + # @param status [Symbol, Increase::Models::Card::Status] This indicates if payments can be made with the card. + # + # @param type [Symbol, Increase::Models::Card::Type] A constant representing the object's type. For this resource it will always be ` + # ... # @see Increase::Models::Card#billing_address class BillingAddress < Increase::Internal::Type::BaseModel @@ -143,11 +162,15 @@ class BillingAddress < Increase::Internal::Type::BaseModel # @!method initialize(city:, line1:, line2:, postal_code:, state:) # The Card's billing address. # - # @param city [String, nil] - # @param line1 [String, nil] - # @param line2 [String, nil] - # @param postal_code [String, nil] - # @param state [String, nil] + # @param city [String, nil] The city of the billing address. + # + # @param line1 [String, nil] The first line of the billing address. + # + # @param line2 [String, nil] The second line of the billing address. + # + # @param postal_code [String, nil] The postal code of the billing address. + # + # @param state [String, nil] The US state of the billing address. end # @see Increase::Models::Card#digital_wallet @@ -174,13 +197,21 @@ class DigitalWallet < Increase::Internal::Type::BaseModel required :phone, String, nil?: true # @!method initialize(digital_card_profile_id:, email:, phone:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Card::DigitalWallet} for more details. + # # The contact information used in the two-factor steps for digital wallet card # creation. At least one field must be present to complete the digital wallet # steps. # - # @param digital_card_profile_id [String, nil] - # @param email [String, nil] - # @param phone [String, nil] + # @param digital_card_profile_id [String, nil] The digital card profile assigned to this digital card. Card profiles may also b + # ... + # + # @param email [String, nil] An email address that can be used to verify the cardholder via one-time passcode + # ... + # + # @param phone [String, nil] A phone number that can be used to verify the cardholder via one-time passcode o + # ... end # This indicates if payments can be made with the card. diff --git a/lib/increase/models/card_create_params.rb b/lib/increase/models/card_create_params.rb index 6d4974dda..ac183a421 100644 --- a/lib/increase/models/card_create_params.rb +++ b/lib/increase/models/card_create_params.rb @@ -43,11 +43,21 @@ class CardCreateParams < Increase::Internal::Type::BaseModel optional :entity_id, String # @!method initialize(account_id:, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, request_options: {}) - # @param account_id [String] - # @param billing_address [Increase::Models::CardCreateParams::BillingAddress] - # @param description [String] - # @param digital_wallet [Increase::Models::CardCreateParams::DigitalWallet] - # @param entity_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::CardCreateParams} for more details. + # + # @param account_id [String] The Account the card should belong to. + # + # @param billing_address [Increase::Models::CardCreateParams::BillingAddress] The card's billing address. + # + # @param description [String] The description you choose to give the card. + # + # @param digital_wallet [Increase::Models::CardCreateParams::DigitalWallet] The contact information used in the two-factor steps for digital wallet card cre + # ... + # + # @param entity_id [String] The Entity the card belongs to. You only need to supply this in rare situations + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class BillingAddress < Increase::Internal::Type::BaseModel @@ -84,11 +94,15 @@ class BillingAddress < Increase::Internal::Type::BaseModel # @!method initialize(city:, line1:, postal_code:, state:, line2: nil) # The card's billing address. # - # @param city [String] - # @param line1 [String] - # @param postal_code [String] - # @param state [String] - # @param line2 [String] + # @param city [String] The city of the billing address. + # + # @param line1 [String] The first line of the billing address. + # + # @param postal_code [String] The postal code of the billing address. + # + # @param state [String] The US state of the billing address. + # + # @param line2 [String] The second line of the billing address. end class DigitalWallet < Increase::Internal::Type::BaseModel @@ -113,15 +127,22 @@ class DigitalWallet < Increase::Internal::Type::BaseModel optional :phone, String # @!method initialize(digital_card_profile_id: nil, email: nil, phone: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardCreateParams::DigitalWallet} for more details. + # # The contact information used in the two-factor steps for digital wallet card # creation. To add the card to a digital wallet, you may supply an email or phone # number with this request. Otherwise, subscribe and then action a Real Time # Decision with the category `digital_wallet_token_requested` or # `digital_wallet_authentication_requested`. # - # @param digital_card_profile_id [String] - # @param email [String] - # @param phone [String] + # @param digital_card_profile_id [String] The digital card profile assigned to this digital card. + # + # @param email [String] An email address that can be used to contact and verify the cardholder via one-t + # ... + # + # @param phone [String] A phone number that can be used to contact and verify the cardholder via one-tim + # ... end end end diff --git a/lib/increase/models/card_details.rb b/lib/increase/models/card_details.rb index bd85fbc2f..479972f8d 100644 --- a/lib/increase/models/card_details.rb +++ b/lib/increase/models/card_details.rb @@ -44,14 +44,24 @@ class CardDetails < Increase::Internal::Type::BaseModel required :verification_code, String # @!method initialize(card_id:, expiration_month:, expiration_year:, primary_account_number:, type:, verification_code:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardDetails} for more details. + # # An object containing the sensitive details (card number, cvc, etc) for a Card. # - # @param card_id [String] - # @param expiration_month [Integer] - # @param expiration_year [Integer] - # @param primary_account_number [String] - # @param type [Symbol, Increase::Models::CardDetails::Type] - # @param verification_code [String] + # @param card_id [String] The identifier for the Card for which sensitive details have been returned. + # + # @param expiration_month [Integer] The month the card expires in M format (e.g., August is 8). + # + # @param expiration_year [Integer] The year the card expires in YYYY format (e.g., 2025). + # + # @param primary_account_number [String] The card number. + # + # @param type [Symbol, Increase::Models::CardDetails::Type] A constant representing the object's type. For this resource it will always be ` + # ... + # + # @param verification_code [String] The three-digit verification code for the card. It's also known as the Card Veri + # ... # A constant representing the object's type. For this resource it will always be # `card_details`. diff --git a/lib/increase/models/card_dispute.rb b/lib/increase/models/card_dispute.rb index 9c0dcca5d..2dc32f209 100644 --- a/lib/increase/models/card_dispute.rb +++ b/lib/increase/models/card_dispute.rb @@ -85,21 +85,42 @@ class CardDispute < Increase::Internal::Type::BaseModel required :win, -> { Increase::Models::CardDispute::Win }, nil?: true # @!method initialize(id:, acceptance:, amount:, created_at:, disputed_transaction_id:, explanation:, idempotency_key:, loss:, rejection:, status:, type:, win:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardDispute} for more details. + # # If unauthorized activity occurs on a card, you can create a Card Dispute and # we'll return the funds if appropriate. # - # @param id [String] - # @param acceptance [Increase::Models::CardDispute::Acceptance, nil] - # @param amount [Integer, nil] - # @param created_at [Time] - # @param disputed_transaction_id [String] - # @param explanation [String] - # @param idempotency_key [String, nil] - # @param loss [Increase::Models::CardDispute::Loss, nil] - # @param rejection [Increase::Models::CardDispute::Rejection, nil] - # @param status [Symbol, Increase::Models::CardDispute::Status] - # @param type [Symbol, Increase::Models::CardDispute::Type] - # @param win [Increase::Models::CardDispute::Win, nil] + # @param id [String] The Card Dispute identifier. + # + # @param acceptance [Increase::Models::CardDispute::Acceptance, nil] If the Card Dispute's status is `accepted`, this will contain details of the suc + # ... + # + # @param amount [Integer, nil] The amount of the dispute, if provided, or the transaction amount otherwise. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param disputed_transaction_id [String] The identifier of the Transaction that was disputed. + # + # @param explanation [String] Why you disputed the Transaction in question. + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param loss [Increase::Models::CardDispute::Loss, nil] If the Card Dispute's status is `lost`, this will contain details of the lost di + # ... + # + # @param rejection [Increase::Models::CardDispute::Rejection, nil] If the Card Dispute's status is `rejected`, this will contain details of the uns + # ... + # + # @param status [Symbol, Increase::Models::CardDispute::Status] The results of the Dispute investigation. + # + # @param type [Symbol, Increase::Models::CardDispute::Type] A constant representing the object's type. For this resource it will always be ` + # ... + # + # @param win [Increase::Models::CardDispute::Win, nil] If the Card Dispute's status is `won`, this will contain details of the won disp + # ... # @see Increase::Models::CardDispute#acceptance class Acceptance < Increase::Internal::Type::BaseModel @@ -124,12 +145,19 @@ class Acceptance < Increase::Internal::Type::BaseModel required :transaction_id, String # @!method initialize(accepted_at:, card_dispute_id:, transaction_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardDispute::Acceptance} for more details. + # # If the Card Dispute's status is `accepted`, this will contain details of the # successful dispute. # - # @param accepted_at [Time] - # @param card_dispute_id [String] - # @param transaction_id [String] + # @param accepted_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param card_dispute_id [String] The identifier of the Card Dispute that was accepted. + # + # @param transaction_id [String] The identifier of the Transaction that was created to return the disputed funds + # ... end # @see Increase::Models::CardDispute#loss @@ -161,13 +189,21 @@ class Loss < Increase::Internal::Type::BaseModel required :transaction_id, String # @!method initialize(card_dispute_id:, explanation:, lost_at:, transaction_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardDispute::Loss} for more details. + # # If the Card Dispute's status is `lost`, this will contain details of the lost # dispute. # - # @param card_dispute_id [String] - # @param explanation [String] - # @param lost_at [Time] - # @param transaction_id [String] + # @param card_dispute_id [String] The identifier of the Card Dispute that was lost. + # + # @param explanation [String] Why the Card Dispute was lost. + # + # @param lost_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param transaction_id [String] The identifier of the Transaction that was created to debit the disputed funds f + # ... end # @see Increase::Models::CardDispute#rejection @@ -192,12 +228,18 @@ class Rejection < Increase::Internal::Type::BaseModel required :rejected_at, Time # @!method initialize(card_dispute_id:, explanation:, rejected_at:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardDispute::Rejection} for more details. + # # If the Card Dispute's status is `rejected`, this will contain details of the # unsuccessful dispute. # - # @param card_dispute_id [String] - # @param explanation [String] - # @param rejected_at [Time] + # @param card_dispute_id [String] The identifier of the Card Dispute that was rejected. + # + # @param explanation [String] Why the Card Dispute was rejected. + # + # @param rejected_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... end # The results of the Dispute investigation. @@ -257,11 +299,16 @@ class Win < Increase::Internal::Type::BaseModel required :won_at, Time # @!method initialize(card_dispute_id:, won_at:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardDispute::Win} for more details. + # # If the Card Dispute's status is `won`, this will contain details of the won # dispute. # - # @param card_dispute_id [String] - # @param won_at [Time] + # @param card_dispute_id [String] The identifier of the Card Dispute that was won. + # + # @param won_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... end end end diff --git a/lib/increase/models/card_dispute_create_params.rb b/lib/increase/models/card_dispute_create_params.rb index 451fcb514..2f9dd61d0 100644 --- a/lib/increase/models/card_dispute_create_params.rb +++ b/lib/increase/models/card_dispute_create_params.rb @@ -30,9 +30,17 @@ class CardDisputeCreateParams < Increase::Internal::Type::BaseModel optional :amount, Integer # @!method initialize(disputed_transaction_id:, explanation:, amount: nil, request_options: {}) - # @param disputed_transaction_id [String] - # @param explanation [String] - # @param amount [Integer] + # Some parameter documentations has been truncated, see + # {Increase::Models::CardDisputeCreateParams} for more details. + # + # @param disputed_transaction_id [String] The Transaction you wish to dispute. This Transaction must have a `source_type` + # ... + # + # @param explanation [String] Why you are disputing this Transaction. + # + # @param amount [Integer] The monetary amount of the part of the transaction that is being disputed. This + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/card_dispute_list_params.rb b/lib/increase/models/card_dispute_list_params.rb index 441ae8e4e..78386a6a4 100644 --- a/lib/increase/models/card_dispute_list_params.rb +++ b/lib/increase/models/card_dispute_list_params.rb @@ -40,11 +40,21 @@ class CardDisputeListParams < Increase::Internal::Type::BaseModel optional :status, -> { Increase::Models::CardDisputeListParams::Status } # @!method initialize(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardDisputeListParams} for more details. + # # @param created_at [Increase::Models::CardDisputeListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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::CardDisputeListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel @@ -77,10 +87,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::CardDisputeListParams::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 @@ -95,7 +115,11 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::CardDisputeListParams::Status} for more details. + # + # @param in_ [Array] Filter Card Disputes for those with the specified status or statuses. For GET re + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/card_list_params.rb b/lib/increase/models/card_list_params.rb index ea0db4a6e..e164186cf 100644 --- a/lib/increase/models/card_list_params.rb +++ b/lib/increase/models/card_list_params.rb @@ -46,12 +46,23 @@ class CardListParams < Increase::Internal::Type::BaseModel optional :status, -> { Increase::Models::CardListParams::Status } # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) - # @param account_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::CardListParams} for more details. + # + # @param account_id [String] Filter Cards to ones belonging to the specified Account. + # # @param created_at [Increase::Models::CardListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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::CardListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel @@ -84,10 +95,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::CardListParams::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 @@ -101,7 +122,11 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::CardListParams::Status} for more details. + # + # @param in_ [Array] Filter Cards by status. For GET requests, this should be encoded as a comma-deli + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/card_payment.rb b/lib/increase/models/card_payment.rb index 16b092439..9e9e01efd 100644 --- a/lib/increase/models/card_payment.rb +++ b/lib/increase/models/card_payment.rb @@ -61,18 +61,31 @@ class CardPayment < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::CardPayment::Type } # @!method initialize(id:, account_id:, card_id:, created_at:, digital_wallet_token_id:, elements:, physical_card_id:, state:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment} for more details. + # # Card Payments group together interactions related to a single card payment, such # as an authorization and its corresponding settlement. # - # @param id [String] - # @param account_id [String] - # @param card_id [String] - # @param created_at [Time] - # @param digital_wallet_token_id [String, nil] - # @param elements [Array] - # @param physical_card_id [String, nil] - # @param state [Increase::Models::CardPayment::State] - # @param type [Symbol, Increase::Models::CardPayment::Type] + # @param id [String] The Card Payment identifier. + # + # @param account_id [String] The identifier for the Account the Transaction belongs to. + # + # @param card_id [String] The Card identifier for this payment. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card Pa + # ... + # + # @param digital_wallet_token_id [String, nil] The Digital Wallet Token identifier for this payment. + # + # @param elements [Array] The interactions related to this card payment. + # + # @param physical_card_id [String, nil] The Physical Card identifier for this payment. + # + # @param state [Increase::Models::CardPayment::State] The summarized state of this card payment. + # + # @param type [Symbol, Increase::Models::CardPayment::Type] A constant representing the object's type. For this resource it will always be ` + # ... class Element < Increase::Internal::Type::BaseModel # @!attribute card_authentication @@ -190,19 +203,47 @@ class Element < Increase::Internal::Type::BaseModel required :other, Increase::Internal::Type::Unknown, nil?: true # @!method initialize(card_authentication:, card_authorization:, card_authorization_expiration:, card_decline:, card_fuel_confirmation:, card_increment:, card_refund:, card_reversal:, card_settlement:, card_validation:, category:, created_at:, other:) - # @param card_authentication [Increase::Models::CardPayment::Element::CardAuthentication, nil] - # @param card_authorization [Increase::Models::CardPayment::Element::CardAuthorization, nil] - # @param card_authorization_expiration [Increase::Models::CardPayment::Element::CardAuthorizationExpiration, nil] - # @param card_decline [Increase::Models::CardPayment::Element::CardDecline, nil] - # @param card_fuel_confirmation [Increase::Models::CardPayment::Element::CardFuelConfirmation, nil] - # @param card_increment [Increase::Models::CardPayment::Element::CardIncrement, nil] - # @param card_refund [Increase::Models::CardPayment::Element::CardRefund, nil] - # @param card_reversal [Increase::Models::CardPayment::Element::CardReversal, nil] - # @param card_settlement [Increase::Models::CardPayment::Element::CardSettlement, nil] - # @param card_validation [Increase::Models::CardPayment::Element::CardValidation, nil] - # @param category [Symbol, Increase::Models::CardPayment::Element::Category] - # @param created_at [Time] - # @param other [Object, nil] + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element} for more details. + # + # @param card_authentication [Increase::Models::CardPayment::Element::CardAuthentication, nil] A Card Authentication object. This field will be present in the JSON response if + # ... + # + # @param card_authorization [Increase::Models::CardPayment::Element::CardAuthorization, nil] A Card Authorization object. This field will be present in the JSON response if + # ... + # + # @param card_authorization_expiration [Increase::Models::CardPayment::Element::CardAuthorizationExpiration, nil] A Card Authorization Expiration object. This field will be present in the JSON r + # ... + # + # @param card_decline [Increase::Models::CardPayment::Element::CardDecline, nil] A Card Decline object. This field will be present in the JSON response if and on + # ... + # + # @param card_fuel_confirmation [Increase::Models::CardPayment::Element::CardFuelConfirmation, nil] A Card Fuel Confirmation object. This field will be present in the JSON response + # ... + # + # @param card_increment [Increase::Models::CardPayment::Element::CardIncrement, nil] A Card Increment object. This field will be present in the JSON response if and + # ... + # + # @param card_refund [Increase::Models::CardPayment::Element::CardRefund, nil] A Card Refund object. This field will be present in the JSON response if and onl + # ... + # + # @param card_reversal [Increase::Models::CardPayment::Element::CardReversal, nil] A Card Reversal object. This field will be present in the JSON response if and o + # ... + # + # @param card_settlement [Increase::Models::CardPayment::Element::CardSettlement, nil] A Card Settlement object. This field will be present in the JSON response if and + # ... + # + # @param card_validation [Increase::Models::CardPayment::Element::CardValidation, nil] A Card Validation object. This field will be present in the JSON response if and + # ... + # + # @param category [Symbol, Increase::Models::CardPayment::Element::Category] The type of the resource. We may add additional possible values for this enum ov + # ... + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param other [Object, nil] If the category of this Transaction source is equal to `other`, this field will + # ... # @see Increase::Models::CardPayment::Element#card_authentication class CardAuthentication < Increase::Internal::Type::BaseModel @@ -323,27 +364,52 @@ class CardAuthentication < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::CardPayment::Element::CardAuthentication::Type } # @!method initialize(id:, card_id:, card_payment_id:, category:, challenge:, created_at:, deny_reason:, device_channel:, merchant_acceptor_id:, merchant_category_code:, merchant_country:, merchant_name:, purchase_amount:, purchase_currency:, real_time_decision_id:, status:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardAuthentication} for more details. + # # A Card Authentication object. This field will be present in the JSON response if # and only if `category` is equal to `card_authentication`. Card Authentications # are attempts to authenticate a transaction or a card with 3DS. # - # @param id [String] - # @param card_id [String] - # @param card_payment_id [String] - # @param category [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Category, nil] - # @param challenge [Increase::Models::CardPayment::Element::CardAuthentication::Challenge, nil] - # @param created_at [Time] - # @param deny_reason [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::DenyReason, nil] - # @param device_channel [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::DeviceChannel, nil] - # @param merchant_acceptor_id [String] - # @param merchant_category_code [String] - # @param merchant_country [String] - # @param merchant_name [String] - # @param purchase_amount [Integer, nil] - # @param purchase_currency [String, nil] - # @param real_time_decision_id [String, nil] - # @param status [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Status] - # @param type [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Type] + # @param id [String] The Card Authentication identifier. + # + # @param card_id [String] The identifier of the Card. + # + # @param card_payment_id [String] The ID of the Card Payment this transaction belongs to. + # + # @param category [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Category, nil] The category of the card authentication attempt. + # + # @param challenge [Increase::Models::CardPayment::Element::CardAuthentication::Challenge, nil] Details about the challenge, if one was requested. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card Au + # ... + # + # @param deny_reason [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::DenyReason, nil] The reason why this authentication attempt was denied, if it was. + # + # @param device_channel [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::DeviceChannel, nil] The device channel of the card authentication attempt. + # + # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i + # ... + # + # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car + # ... + # + # @param merchant_country [String] The country the merchant resides in. + # + # @param merchant_name [String] The name of the merchant. + # + # @param purchase_amount [Integer, nil] The purchase amount in minor units. + # + # @param purchase_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the authenticati + # ... + # + # @param real_time_decision_id [String, nil] The identifier of the Real-Time Decision sent to approve or decline this authent + # ... + # + # @param status [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Status] The status of the card authentication. + # + # @param type [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The category of the card authentication attempt. # @@ -398,13 +464,23 @@ class Challenge < Increase::Internal::Type::BaseModel required :verification_value, String, nil?: true # @!method initialize(attempts:, created_at:, one_time_code:, verification_method:, verification_value:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardAuthentication::Challenge} for more + # details. + # # Details about the challenge, if one was requested. # - # @param attempts [Array] - # @param created_at [Time] - # @param one_time_code [String] - # @param verification_method [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Challenge::VerificationMethod] - # @param verification_value [String, nil] + # @param attempts [Array] Details about the challenge verification attempts, if any happened. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card Au + # ... + # + # @param one_time_code [String] The one-time code used for the Card Authentication Challenge. + # + # @param verification_method [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Challenge::VerificationMethod] The method used to verify the Card Authentication Challenge. + # + # @param verification_value [String, nil] E.g., the email address or phone number used for the Card Authentication Challen + # ... class Attempt < Increase::Internal::Type::BaseModel # @!attribute created_at @@ -422,8 +498,14 @@ class Attempt < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::CardPayment::Element::CardAuthentication::Challenge::Attempt::Outcome } # @!method initialize(created_at:, outcome:) - # @param created_at [Time] - # @param outcome [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Challenge::Attempt::Outcome] + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardAuthentication::Challenge::Attempt} + # for more details. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time of the Card Authenti + # ... + # + # @param outcome [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Challenge::Attempt::Outcome] The outcome of the Card Authentication Challenge Attempt. # The outcome of the Card Authentication Challenge Attempt. # @@ -744,38 +826,83 @@ class CardAuthorization < Increase::Internal::Type::BaseModel required :verification, -> { Increase::Models::CardPayment::Element::CardAuthorization::Verification } # @!method initialize(id:, actioner:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, expires_at:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, pending_transaction_id:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, terminal_id:, type:, verification:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardAuthorization} for more details. + # # A Card Authorization object. This field will be present in the JSON response if # and only if `category` is equal to `card_authorization`. Card Authorizations are # temporary holds placed on a customers funds with the intent to later clear a # transaction. # - # @param id [String] - # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Actioner] - # @param amount [Integer] - # @param card_payment_id [String] - # @param currency [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Currency] - # @param digital_wallet_token_id [String, nil] - # @param direction [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Direction] - # @param expires_at [Time] - # @param merchant_acceptor_id [String] - # @param merchant_category_code [String] - # @param merchant_city [String, nil] - # @param merchant_country [String] - # @param merchant_descriptor [String] - # @param merchant_postal_code [String, nil] - # @param merchant_state [String, nil] - # @param network_details [Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails] - # @param network_identifiers [Increase::Models::CardPayment::Element::CardAuthorization::NetworkIdentifiers] - # @param network_risk_score [Integer, nil] - # @param pending_transaction_id [String, nil] - # @param physical_card_id [String, nil] - # @param presentment_amount [Integer] - # @param presentment_currency [String] - # @param processing_category [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::ProcessingCategory] - # @param real_time_decision_id [String, nil] - # @param terminal_id [String, nil] - # @param type [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Type] - # @param verification [Increase::Models::CardPayment::Element::CardAuthorization::Verification] + # @param id [String] The Card Authorization identifier. + # + # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Actioner] Whether this authorization was approved by Increase, the card network through st + # ... + # + # @param amount [Integer] The pending amount in the minor unit of the transaction's currency. For dollars, + # ... + # + # @param card_payment_id [String] The ID of the Card Payment this transaction belongs to. + # + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param digital_wallet_token_id [String, nil] If the authorization was made via a Digital Wallet Token (such as an Apple Pay p + # ... + # + # @param direction [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Direction] The direction describes the direction the funds will move, either from the cardh + # ... + # + # @param expires_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization w + # ... + # + # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i + # ... + # + # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car + # ... + # + # @param merchant_city [String, nil] The city the merchant resides in. + # + # @param merchant_country [String] The country the merchant resides in. + # + # @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with. + # + # @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is either a 5-digit or 9-digit + # ... + # + # @param merchant_state [String, nil] The state the merchant resides in. + # + # @param network_details [Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails] Fields specific to the `network`. + # + # @param network_identifiers [Increase::Models::CardPayment::Element::CardAuthorization::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction. + # + # @param network_risk_score [Integer, nil] The risk score generated by the card network. For Visa this is the Visa Advanced + # ... + # + # @param pending_transaction_id [String, nil] The identifier of the Pending Transaction associated with this Transaction. + # + # @param physical_card_id [String, nil] If the authorization was made in-person with a physical card, the Physical Card + # ... + # + # @param presentment_amount [Integer] The pending amount in the minor unit of the transaction's presentment currency. + # + # @param presentment_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param processing_category [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::ProcessingCategory] The processing category describes the intent behind the authorization, such as w + # ... + # + # @param real_time_decision_id [String, nil] The identifier of the Real-Time Decision sent to approve or decline this transac + # ... + # + # @param terminal_id [String, nil] The terminal identifier (commonly abbreviated as TID) of the terminal the card i + # ... + # + # @param type [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Type] A constant representing the object's type. For this resource it will always be ` + # ... + # + # @param verification [Increase::Models::CardPayment::Element::CardAuthorization::Verification] Fields related to verification of cardholder-provided values. # Whether this authorization was approved by Increase, the card network through # stand-in processing, or the user through a real-time decision. @@ -863,8 +990,9 @@ class NetworkDetails < Increase::Internal::Type::BaseModel # @!method initialize(category:, visa:) # Fields specific to the `network`. # - # @param category [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Category] - # @param visa [Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa, nil] + # @param category [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Category] The payment network used to process this card authorization. + # + # @param visa [Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa, nil] Fields specific to the `visa` network. # The payment network used to process this card authorization. # @@ -910,11 +1038,20 @@ class Visa < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa} + # for more details. + # # Fields specific to the `visa` network. # - # @param electronic_commerce_indicator [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] - # @param point_of_service_entry_mode [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode, nil] - # @param stand_in_processing_reason [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason, nil] + # @param electronic_commerce_indicator [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] For electronic commerce transactions, this identifies the level of security used + # ... + # + # @param point_of_service_entry_mode [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode, nil] The method used to enter the cardholder's primary account number and card expira + # ... + # + # @param stand_in_processing_reason [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason, nil] Only present when `actioner: network`. Describes why a card authorization was ap + # ... # For electronic commerce transactions, this identifies the level of security used # in obtaining the customer's payment credential. For mail or telephone order @@ -1055,11 +1192,20 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel required :transaction_id, String, nil?: true # @!method initialize(retrieval_reference_number:, trace_number:, transaction_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardAuthorization::NetworkIdentifiers} + # for more details. + # # Network-specific identifiers for a specific request or transaction. # - # @param retrieval_reference_number [String, nil] - # @param trace_number [String, nil] - # @param transaction_id [String, nil] + # @param retrieval_reference_number [String, nil] A life-cycle identifier used across e.g., an authorization and a reversal. Expec + # ... + # + # @param trace_number [String, nil] A counter used to verify an individual authorization. Expected to be unique per + # ... + # + # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro + # ... end # The processing category describes the intent behind the authorization, such as @@ -1123,10 +1269,17 @@ class Verification < Increase::Internal::Type::BaseModel -> { Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress } # @!method initialize(card_verification_code:, cardholder_address:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardAuthorization::Verification} for + # more details. + # # Fields related to verification of cardholder-provided values. # - # @param card_verification_code [Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode] - # @param cardholder_address [Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress] + # @param card_verification_code [Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode] Fields related to verification of the Card Verification Code, a 3-digit code on + # ... + # + # @param cardholder_address [Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress] Cardholder address provided in the authorization request and the address on file + # ... # @see Increase::Models::CardPayment::Element::CardAuthorization::Verification#card_verification_code class CardVerificationCode < Increase::Internal::Type::BaseModel @@ -1141,7 +1294,7 @@ class CardVerificationCode < Increase::Internal::Type::BaseModel # Fields related to verification of the Card Verification Code, a 3-digit code on # the back of the card. # - # @param result [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result] + # @param result [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result] The result of verifying the Card Verification Code. # The result of verifying the Card Verification Code. # @@ -1198,14 +1351,23 @@ class CardholderAddress < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result } # @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress} + # for more details. + # # Cardholder address provided in the authorization request and the address on file # we verified it against. # - # @param actual_line1 [String, nil] - # @param actual_postal_code [String, nil] - # @param provided_line1 [String, nil] - # @param provided_postal_code [String, nil] - # @param result [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result] + # @param actual_line1 [String, nil] Line 1 of the address on file for the cardholder. + # + # @param actual_postal_code [String, nil] The postal code of the address on file for the cardholder. + # + # @param provided_line1 [String, nil] The cardholder address line 1 provided for verification in the authorization req + # ... + # + # @param provided_postal_code [String, nil] The postal code provided for verification in the authorization request. + # + # @param result [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result] The address verification result returned to the card network. # The address verification result returned to the card network. # @@ -1282,17 +1444,29 @@ class CardAuthorizationExpiration < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Type } # @!method initialize(id:, card_authorization_id:, currency:, expired_amount:, network:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardAuthorizationExpiration} for more + # details. + # # A Card Authorization Expiration object. This field will be present in the JSON # response if and only if `category` is equal to `card_authorization_expiration`. # Card Authorization Expirations are cancellations of authorizations that were # never settled by the acquirer. # - # @param id [String] - # @param card_authorization_id [String] - # @param currency [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Currency] - # @param expired_amount [Integer] - # @param network [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Network] - # @param type [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Type] + # @param id [String] The Card Authorization Expiration identifier. + # + # @param card_authorization_id [String] The identifier for the Card Authorization this reverses. + # + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's c + # ... + # + # @param expired_amount [Integer] The amount of this authorization expiration in the minor unit of the transaction + # ... + # + # @param network [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Network] The card network used to process this card authorization. + # + # @param type [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's # currency. @@ -1534,36 +1708,81 @@ class CardDecline < Increase::Internal::Type::BaseModel required :verification, -> { Increase::Models::CardPayment::Element::CardDecline::Verification } # @!method initialize(id:, actioner:, amount:, card_payment_id:, currency:, declined_transaction_id:, digital_wallet_token_id:, direction:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, real_time_decision_reason:, reason:, terminal_id:, verification:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardDecline} for more details. + # # A Card Decline object. This field will be present in the JSON response if and # only if `category` is equal to `card_decline`. # - # @param id [String] - # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardDecline::Actioner] - # @param amount [Integer] - # @param card_payment_id [String] - # @param currency [Symbol, Increase::Models::CardPayment::Element::CardDecline::Currency] - # @param declined_transaction_id [String] - # @param digital_wallet_token_id [String, nil] - # @param direction [Symbol, Increase::Models::CardPayment::Element::CardDecline::Direction] - # @param merchant_acceptor_id [String] - # @param merchant_category_code [String] - # @param merchant_city [String, nil] - # @param merchant_country [String] - # @param merchant_descriptor [String] - # @param merchant_postal_code [String, nil] - # @param merchant_state [String, nil] - # @param network_details [Increase::Models::CardPayment::Element::CardDecline::NetworkDetails] - # @param network_identifiers [Increase::Models::CardPayment::Element::CardDecline::NetworkIdentifiers] - # @param network_risk_score [Integer, nil] - # @param physical_card_id [String, nil] - # @param presentment_amount [Integer] - # @param presentment_currency [String] - # @param processing_category [Symbol, Increase::Models::CardPayment::Element::CardDecline::ProcessingCategory] - # @param real_time_decision_id [String, nil] - # @param real_time_decision_reason [Symbol, Increase::Models::CardPayment::Element::CardDecline::RealTimeDecisionReason, nil] - # @param reason [Symbol, Increase::Models::CardPayment::Element::CardDecline::Reason] - # @param terminal_id [String, nil] - # @param verification [Increase::Models::CardPayment::Element::CardDecline::Verification] + # @param id [String] The Card Decline identifier. + # + # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardDecline::Actioner] Whether this authorization was approved by Increase, the card network through st + # ... + # + # @param amount [Integer] The declined amount in the minor unit of the destination account currency. For d + # ... + # + # @param card_payment_id [String] The ID of the Card Payment this transaction belongs to. + # + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardDecline::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination + # ... + # + # @param declined_transaction_id [String] The identifier of the declined transaction created for this Card Decline. + # + # @param digital_wallet_token_id [String, nil] If the authorization was made via a Digital Wallet Token (such as an Apple Pay p + # ... + # + # @param direction [Symbol, Increase::Models::CardPayment::Element::CardDecline::Direction] The direction describes the direction the funds will move, either from the cardh + # ... + # + # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i + # ... + # + # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car + # ... + # + # @param merchant_city [String, nil] The city the merchant resides in. + # + # @param merchant_country [String] The country the merchant resides in. + # + # @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with. + # + # @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is either a 5-digit or 9-digit + # ... + # + # @param merchant_state [String, nil] The state the merchant resides in. + # + # @param network_details [Increase::Models::CardPayment::Element::CardDecline::NetworkDetails] Fields specific to the `network`. + # + # @param network_identifiers [Increase::Models::CardPayment::Element::CardDecline::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction. + # + # @param network_risk_score [Integer, nil] The risk score generated by the card network. For Visa this is the Visa Advanced + # ... + # + # @param physical_card_id [String, nil] If the authorization was made in-person with a physical card, the Physical Card + # ... + # + # @param presentment_amount [Integer] The declined amount in the minor unit of the transaction's presentment currency. + # ... + # + # @param presentment_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param processing_category [Symbol, Increase::Models::CardPayment::Element::CardDecline::ProcessingCategory] The processing category describes the intent behind the authorization, such as w + # ... + # + # @param real_time_decision_id [String, nil] The identifier of the Real-Time Decision sent to approve or decline this transac + # ... + # + # @param real_time_decision_reason [Symbol, Increase::Models::CardPayment::Element::CardDecline::RealTimeDecisionReason, nil] This is present if a specific decline reason was given in the real-time decision + # ... + # + # @param reason [Symbol, Increase::Models::CardPayment::Element::CardDecline::Reason] Why the transaction was declined. + # + # @param terminal_id [String, nil] The terminal identifier (commonly abbreviated as TID) of the terminal the card i + # ... + # + # @param verification [Increase::Models::CardPayment::Element::CardDecline::Verification] Fields related to verification of cardholder-provided values. # Whether this authorization was approved by Increase, the card network through # stand-in processing, or the user through a real-time decision. @@ -1651,8 +1870,9 @@ class NetworkDetails < Increase::Internal::Type::BaseModel # @!method initialize(category:, visa:) # Fields specific to the `network`. # - # @param category [Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Category] - # @param visa [Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa, nil] + # @param category [Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Category] The payment network used to process this card authorization. + # + # @param visa [Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa, nil] Fields specific to the `visa` network. # The payment network used to process this card authorization. # @@ -1698,11 +1918,20 @@ class Visa < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa} for + # more details. + # # Fields specific to the `visa` network. # - # @param electronic_commerce_indicator [Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] - # @param point_of_service_entry_mode [Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa::PointOfServiceEntryMode, nil] - # @param stand_in_processing_reason [Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa::StandInProcessingReason, nil] + # @param electronic_commerce_indicator [Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] For electronic commerce transactions, this identifies the level of security used + # ... + # + # @param point_of_service_entry_mode [Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa::PointOfServiceEntryMode, nil] The method used to enter the cardholder's primary account number and card expira + # ... + # + # @param stand_in_processing_reason [Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa::StandInProcessingReason, nil] Only present when `actioner: network`. Describes why a card authorization was ap + # ... # For electronic commerce transactions, this identifies the level of security used # in obtaining the customer's payment credential. For mail or telephone order @@ -1843,11 +2072,20 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel required :transaction_id, String, nil?: true # @!method initialize(retrieval_reference_number:, trace_number:, transaction_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardDecline::NetworkIdentifiers} for + # more details. + # # Network-specific identifiers for a specific request or transaction. # - # @param retrieval_reference_number [String, nil] - # @param trace_number [String, nil] - # @param transaction_id [String, nil] + # @param retrieval_reference_number [String, nil] A life-cycle identifier used across e.g., an authorization and a reversal. Expec + # ... + # + # @param trace_number [String, nil] A counter used to verify an individual authorization. Expected to be unique per + # ... + # + # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro + # ... end # The processing category describes the intent behind the authorization, such as @@ -1991,10 +2229,17 @@ class Verification < Increase::Internal::Type::BaseModel -> { Increase::Models::CardPayment::Element::CardDecline::Verification::CardholderAddress } # @!method initialize(card_verification_code:, cardholder_address:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardDecline::Verification} for more + # details. + # # Fields related to verification of cardholder-provided values. # - # @param card_verification_code [Increase::Models::CardPayment::Element::CardDecline::Verification::CardVerificationCode] - # @param cardholder_address [Increase::Models::CardPayment::Element::CardDecline::Verification::CardholderAddress] + # @param card_verification_code [Increase::Models::CardPayment::Element::CardDecline::Verification::CardVerificationCode] Fields related to verification of the Card Verification Code, a 3-digit code on + # ... + # + # @param cardholder_address [Increase::Models::CardPayment::Element::CardDecline::Verification::CardholderAddress] Cardholder address provided in the authorization request and the address on file + # ... # @see Increase::Models::CardPayment::Element::CardDecline::Verification#card_verification_code class CardVerificationCode < Increase::Internal::Type::BaseModel @@ -2009,7 +2254,7 @@ class CardVerificationCode < Increase::Internal::Type::BaseModel # Fields related to verification of the Card Verification Code, a 3-digit code on # the back of the card. # - # @param result [Symbol, Increase::Models::CardPayment::Element::CardDecline::Verification::CardVerificationCode::Result] + # @param result [Symbol, Increase::Models::CardPayment::Element::CardDecline::Verification::CardVerificationCode::Result] The result of verifying the Card Verification Code. # The result of verifying the Card Verification Code. # @@ -2066,14 +2311,23 @@ class CardholderAddress < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::CardPayment::Element::CardDecline::Verification::CardholderAddress::Result } # @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardDecline::Verification::CardholderAddress} + # for more details. + # # Cardholder address provided in the authorization request and the address on file # we verified it against. # - # @param actual_line1 [String, nil] - # @param actual_postal_code [String, nil] - # @param provided_line1 [String, nil] - # @param provided_postal_code [String, nil] - # @param result [Symbol, Increase::Models::CardPayment::Element::CardDecline::Verification::CardholderAddress::Result] + # @param actual_line1 [String, nil] Line 1 of the address on file for the cardholder. + # + # @param actual_postal_code [String, nil] The postal code of the address on file for the cardholder. + # + # @param provided_line1 [String, nil] The cardholder address line 1 provided for verification in the authorization req + # ... + # + # @param provided_postal_code [String, nil] The postal code provided for verification in the authorization request. + # + # @param result [Symbol, Increase::Models::CardPayment::Element::CardDecline::Verification::CardholderAddress::Result] The address verification result returned to the card network. # The address verification result returned to the card network. # @@ -2162,19 +2416,33 @@ class CardFuelConfirmation < Increase::Internal::Type::BaseModel required :updated_authorization_amount, Integer # @!method initialize(id:, card_authorization_id:, currency:, network:, network_identifiers:, pending_transaction_id:, type:, updated_authorization_amount:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardFuelConfirmation} for more details. + # # A Card Fuel Confirmation object. This field will be present in the JSON response # if and only if `category` is equal to `card_fuel_confirmation`. Card Fuel # Confirmations update the amount of a Card Authorization after a fuel pump # transaction is completed. # - # @param id [String] - # @param card_authorization_id [String] - # @param currency [Symbol, Increase::Models::CardPayment::Element::CardFuelConfirmation::Currency] - # @param network [Symbol, Increase::Models::CardPayment::Element::CardFuelConfirmation::Network] - # @param network_identifiers [Increase::Models::CardPayment::Element::CardFuelConfirmation::NetworkIdentifiers] - # @param pending_transaction_id [String, nil] - # @param type [Symbol, Increase::Models::CardPayment::Element::CardFuelConfirmation::Type] - # @param updated_authorization_amount [Integer] + # @param id [String] The Card Fuel Confirmation identifier. + # + # @param card_authorization_id [String] The identifier for the Card Authorization this updates. + # + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardFuelConfirmation::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's + # ... + # + # @param network [Symbol, Increase::Models::CardPayment::Element::CardFuelConfirmation::Network] The card network used to process this card authorization. + # + # @param network_identifiers [Increase::Models::CardPayment::Element::CardFuelConfirmation::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction. + # + # @param pending_transaction_id [String, nil] The identifier of the Pending Transaction associated with this Card Fuel Confirm + # ... + # + # @param type [Symbol, Increase::Models::CardPayment::Element::CardFuelConfirmation::Type] A constant representing the object's type. For this resource it will always be ` + # ... + # + # @param updated_authorization_amount [Integer] The updated authorization amount after this fuel confirmation, in the minor unit + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's # currency. @@ -2243,11 +2511,20 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel required :transaction_id, String, nil?: true # @!method initialize(retrieval_reference_number:, trace_number:, transaction_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardFuelConfirmation::NetworkIdentifiers} + # for more details. + # # Network-specific identifiers for a specific request or transaction. # - # @param retrieval_reference_number [String, nil] - # @param trace_number [String, nil] - # @param transaction_id [String, nil] + # @param retrieval_reference_number [String, nil] A life-cycle identifier used across e.g., an authorization and a reversal. Expec + # ... + # + # @param trace_number [String, nil] A counter used to verify an individual authorization. Expected to be unique per + # ... + # + # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro + # ... end # A constant representing the object's type. For this resource it will always be @@ -2347,22 +2624,43 @@ class CardIncrement < Increase::Internal::Type::BaseModel required :updated_authorization_amount, Integer # @!method initialize(id:, actioner:, amount:, card_authorization_id:, currency:, network:, network_identifiers:, network_risk_score:, pending_transaction_id:, real_time_decision_id:, type:, updated_authorization_amount:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardIncrement} for more details. + # # A Card Increment object. This field will be present in the JSON response if and # only if `category` is equal to `card_increment`. Card Increments increase the # pending amount of an authorized transaction. # - # @param id [String] - # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Actioner] - # @param amount [Integer] - # @param card_authorization_id [String] - # @param currency [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Currency] - # @param network [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Network] - # @param network_identifiers [Increase::Models::CardPayment::Element::CardIncrement::NetworkIdentifiers] - # @param network_risk_score [Integer, nil] - # @param pending_transaction_id [String, nil] - # @param real_time_decision_id [String, nil] - # @param type [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Type] - # @param updated_authorization_amount [Integer] + # @param id [String] The Card Increment identifier. + # + # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Actioner] Whether this authorization was approved by Increase, the card network through st + # ... + # + # @param amount [Integer] The amount of this increment in the minor unit of the transaction's currency. Fo + # ... + # + # @param card_authorization_id [String] The identifier for the Card Authorization this increments. + # + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's + # ... + # + # @param network [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Network] The card network used to process this card authorization. + # + # @param network_identifiers [Increase::Models::CardPayment::Element::CardIncrement::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction. + # + # @param network_risk_score [Integer, nil] The risk score generated by the card network. For Visa this is the Visa Advanced + # ... + # + # @param pending_transaction_id [String, nil] The identifier of the Pending Transaction associated with this Card Increment. + # + # @param real_time_decision_id [String, nil] The identifier of the Real-Time Decision sent to approve or decline this increme + # ... + # + # @param type [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Type] A constant representing the object's type. For this resource it will always be ` + # ... + # + # @param updated_authorization_amount [Integer] The updated authorization amount after this increment, in the minor unit of the + # ... # Whether this authorization was approved by Increase, the card network through # stand-in processing, or the user through a real-time decision. @@ -2451,11 +2749,20 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel required :transaction_id, String, nil?: true # @!method initialize(retrieval_reference_number:, trace_number:, transaction_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardIncrement::NetworkIdentifiers} for + # more details. + # # Network-specific identifiers for a specific request or transaction. # - # @param retrieval_reference_number [String, nil] - # @param trace_number [String, nil] - # @param transaction_id [String, nil] + # @param retrieval_reference_number [String, nil] A life-cycle identifier used across e.g., an authorization and a reversal. Expec + # ... + # + # @param trace_number [String, nil] A counter used to verify an individual authorization. Expected to be unique per + # ... + # + # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro + # ... end # A constant representing the object's type. For this resource it will always be @@ -2599,31 +2906,59 @@ class CardRefund < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::CardPayment::Element::CardRefund::Type } # @!method initialize(id:, amount:, card_payment_id:, cashback:, currency:, interchange:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_name:, merchant_postal_code:, merchant_state:, network_identifiers:, presentment_amount:, presentment_currency:, purchase_details:, transaction_id:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardRefund} for more details. + # # A Card Refund object. This field will be present in the JSON response if and # only if `category` is equal to `card_refund`. Card Refunds move money back to # the cardholder. While they are usually connected to a Card Settlement an # acquirer can also refund money directly to a card without relation to a # transaction. # - # @param id [String] - # @param amount [Integer] - # @param card_payment_id [String] - # @param cashback [Increase::Models::CardPayment::Element::CardRefund::Cashback, nil] - # @param currency [Symbol, Increase::Models::CardPayment::Element::CardRefund::Currency] - # @param interchange [Increase::Models::CardPayment::Element::CardRefund::Interchange, nil] - # @param merchant_acceptor_id [String] - # @param merchant_category_code [String] - # @param merchant_city [String] - # @param merchant_country [String] - # @param merchant_name [String] - # @param merchant_postal_code [String, nil] - # @param merchant_state [String, nil] - # @param network_identifiers [Increase::Models::CardPayment::Element::CardRefund::NetworkIdentifiers] - # @param presentment_amount [Integer] - # @param presentment_currency [String] - # @param purchase_details [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails, nil] - # @param transaction_id [String] - # @param type [Symbol, Increase::Models::CardPayment::Element::CardRefund::Type] + # @param id [String] The Card Refund identifier. + # + # @param amount [Integer] The amount in the minor unit of the transaction's settlement currency. For dolla + # ... + # + # @param card_payment_id [String] The ID of the Card Payment this transaction belongs to. + # + # @param cashback [Increase::Models::CardPayment::Element::CardRefund::Cashback, nil] Cashback debited for this transaction, if eligible. Cashback is paid out in aggr + # ... + # + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardRefund::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param interchange [Increase::Models::CardPayment::Element::CardRefund::Interchange, nil] Interchange assessed as a part of this transaciton. + # + # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i + # ... + # + # @param merchant_category_code [String] The 4-digit MCC describing the merchant's business. + # + # @param merchant_city [String] The city the merchant resides in. + # + # @param merchant_country [String] The country the merchant resides in. + # + # @param merchant_name [String] The name of the merchant. + # + # @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is always a 5-digit ZIP code. + # + # @param merchant_state [String, nil] The state the merchant resides in. + # + # @param network_identifiers [Increase::Models::CardPayment::Element::CardRefund::NetworkIdentifiers] Network-specific identifiers for this refund. + # + # @param presentment_amount [Integer] The amount in the minor unit of the transaction's presentment currency. + # + # @param presentment_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param purchase_details [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails, nil] Additional details about the card purchase, such as tax and industry-specific fi + # ... + # + # @param transaction_id [String] The identifier of the Transaction associated with this Transaction. + # + # @param type [Symbol, Increase::Models::CardPayment::Element::CardRefund::Type] A constant representing the object's type. For this resource it will always be ` + # ... # @see Increase::Models::CardPayment::Element::CardRefund#cashback class Cashback < Increase::Internal::Type::BaseModel @@ -2642,11 +2977,16 @@ class Cashback < Increase::Internal::Type::BaseModel required :currency, enum: -> { Increase::Models::CardPayment::Element::CardRefund::Cashback::Currency } # @!method initialize(amount:, currency:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardRefund::Cashback} for more details. + # # Cashback debited for this transaction, if eligible. Cashback is paid out in # aggregate, monthly. # - # @param amount [String] - # @param currency [Symbol, Increase::Models::CardPayment::Element::CardRefund::Cashback::Currency] + # @param amount [String] The cashback amount given as a string containing a decimal number. The amount is + # ... + # + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardRefund::Cashback::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. # @@ -2731,11 +3071,19 @@ class Interchange < Increase::Internal::Type::BaseModel required :currency, enum: -> { Increase::Models::CardPayment::Element::CardRefund::Interchange::Currency } # @!method initialize(amount:, code:, currency:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardRefund::Interchange} for more + # details. + # # Interchange assessed as a part of this transaciton. # - # @param amount [String] - # @param code [String, nil] - # @param currency [Symbol, Increase::Models::CardPayment::Element::CardRefund::Interchange::Currency] + # @param amount [String] The interchange amount given as a string containing a decimal number in major un + # ... + # + # @param code [String, nil] The card network specific interchange code. + # + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardRefund::Interchange::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange # reimbursement. @@ -2790,11 +3138,19 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel required :transaction_id, String, nil?: true # @!method initialize(acquirer_business_id:, acquirer_reference_number:, transaction_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardRefund::NetworkIdentifiers} for + # more details. + # # Network-specific identifiers for this refund. # - # @param acquirer_business_id [String] - # @param acquirer_reference_number [String] - # @param transaction_id [String, nil] + # @param acquirer_business_id [String] A network assigned business ID that identifies the acquirer that processed this + # ... + # + # @param acquirer_reference_number [String] A globally unique identifier for this settlement. + # + # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro + # ... end # @see Increase::Models::CardPayment::Element::CardRefund#purchase_details @@ -2870,19 +3226,34 @@ class PurchaseDetails < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(car_rental:, customer_reference_identifier:, local_tax_amount:, local_tax_currency:, lodging:, national_tax_amount:, national_tax_currency:, purchase_identifier:, purchase_identifier_format:, travel:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails} for more + # details. + # # Additional details about the card purchase, such as tax and industry-specific # fields. # - # @param car_rental [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::CarRental, nil] - # @param customer_reference_identifier [String, nil] - # @param local_tax_amount [Integer, nil] - # @param local_tax_currency [String, nil] - # @param lodging [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Lodging, nil] - # @param national_tax_amount [Integer, nil] - # @param national_tax_currency [String, nil] - # @param purchase_identifier [String, nil] - # @param purchase_identifier_format [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::PurchaseIdentifierFormat, nil] - # @param travel [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel, nil] + # @param car_rental [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::CarRental, nil] Fields specific to car rentals. + # + # @param customer_reference_identifier [String, nil] An identifier from the merchant for the customer or consumer. + # + # @param local_tax_amount [Integer, nil] The state or provincial tax amount in minor units. + # + # @param local_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax as + # ... + # + # @param lodging [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Lodging, nil] Fields specific to lodging. + # + # @param national_tax_amount [Integer, nil] The national tax amount in minor units. + # + # @param national_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax as + # ... + # + # @param purchase_identifier [String, nil] An identifier from the merchant for the purchase to the issuer and cardholder. + # + # @param purchase_identifier_format [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::PurchaseIdentifierFormat, nil] The format of the purchase identifier. + # + # @param travel [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel, nil] Fields specific to travel. # @see Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails#car_rental class CarRental < Increase::Internal::Type::BaseModel @@ -2995,24 +3366,51 @@ class CarRental < Increase::Internal::Type::BaseModel required :weekly_rental_rate_currency, String, nil?: true # @!method initialize(car_class_code:, checkout_date:, daily_rental_rate_amount:, daily_rental_rate_currency:, days_rented:, extra_charges:, fuel_charges_amount:, fuel_charges_currency:, insurance_charges_amount:, insurance_charges_currency:, no_show_indicator:, one_way_drop_off_charges_amount:, one_way_drop_off_charges_currency:, renter_name:, weekly_rental_rate_amount:, weekly_rental_rate_currency:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::CarRental} + # for more details. + # # Fields specific to car rentals. # - # @param car_class_code [String, nil] - # @param checkout_date [Date, nil] - # @param daily_rental_rate_amount [Integer, nil] - # @param daily_rental_rate_currency [String, nil] - # @param days_rented [Integer, nil] - # @param extra_charges [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::CarRental::ExtraCharges, nil] - # @param fuel_charges_amount [Integer, nil] - # @param fuel_charges_currency [String, nil] - # @param insurance_charges_amount [Integer, nil] - # @param insurance_charges_currency [String, nil] - # @param no_show_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::CarRental::NoShowIndicator, nil] - # @param one_way_drop_off_charges_amount [Integer, nil] - # @param one_way_drop_off_charges_currency [String, nil] - # @param renter_name [String, nil] - # @param weekly_rental_rate_amount [Integer, nil] - # @param weekly_rental_rate_currency [String, nil] + # @param car_class_code [String, nil] Code indicating the vehicle's class. + # + # @param checkout_date [Date, nil] Date the customer picked up the car or, in the case of a no-show or pre-pay tran + # ... + # + # @param daily_rental_rate_amount [Integer, nil] Daily rate being charged for the vehicle. + # + # @param daily_rental_rate_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental + # ... + # + # @param days_rented [Integer, nil] Number of days the vehicle was rented. + # + # @param extra_charges [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::CarRental::ExtraCharges, nil] Additional charges (gas, late fee, etc.) being billed. + # + # @param fuel_charges_amount [Integer, nil] Fuel charges for the vehicle. + # + # @param fuel_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges + # ... + # + # @param insurance_charges_amount [Integer, nil] Any insurance being charged for the vehicle. + # + # @param insurance_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance ch + # ... + # + # @param no_show_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::CarRental::NoShowIndicator, nil] An indicator that the cardholder is being billed for a reserved vehicle that was + # ... + # + # @param one_way_drop_off_charges_amount [Integer, nil] Charges for returning the vehicle at a different location than where it was pick + # ... + # + # @param one_way_drop_off_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way drop + # ... + # + # @param renter_name [String, nil] Name of the person renting the vehicle. + # + # @param weekly_rental_rate_amount [Integer, nil] Weekly rate being charged for the vehicle. + # + # @param weekly_rental_rate_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly renta + # ... # Additional charges (gas, late fee, etc.) being billed. # @@ -3170,24 +3568,50 @@ class Lodging < Increase::Internal::Type::BaseModel required :total_tax_currency, String, nil?: true # @!method initialize(check_in_date:, daily_room_rate_amount:, daily_room_rate_currency:, extra_charges:, folio_cash_advances_amount:, folio_cash_advances_currency:, food_beverage_charges_amount:, food_beverage_charges_currency:, no_show_indicator:, prepaid_expenses_amount:, prepaid_expenses_currency:, room_nights:, total_room_tax_amount:, total_room_tax_currency:, total_tax_amount:, total_tax_currency:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Lodging} + # for more details. + # # Fields specific to lodging. # - # @param check_in_date [Date, nil] - # @param daily_room_rate_amount [Integer, nil] - # @param daily_room_rate_currency [String, nil] - # @param extra_charges [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Lodging::ExtraCharges, nil] - # @param folio_cash_advances_amount [Integer, nil] - # @param folio_cash_advances_currency [String, nil] - # @param food_beverage_charges_amount [Integer, nil] - # @param food_beverage_charges_currency [String, nil] - # @param no_show_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Lodging::NoShowIndicator, nil] - # @param prepaid_expenses_amount [Integer, nil] - # @param prepaid_expenses_currency [String, nil] - # @param room_nights [Integer, nil] - # @param total_room_tax_amount [Integer, nil] - # @param total_room_tax_currency [String, nil] - # @param total_tax_amount [Integer, nil] - # @param total_tax_currency [String, nil] + # @param check_in_date [Date, nil] Date the customer checked in. + # + # @param daily_room_rate_amount [Integer, nil] Daily rate being charged for the room. + # + # @param daily_room_rate_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room r + # ... + # + # @param extra_charges [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Lodging::ExtraCharges, nil] Additional charges (phone, late check-out, etc.) being billed. + # + # @param folio_cash_advances_amount [Integer, nil] Folio cash advances for the room. + # + # @param folio_cash_advances_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash a + # ... + # + # @param food_beverage_charges_amount [Integer, nil] Food and beverage charges for the room. + # + # @param food_beverage_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and bev + # ... + # + # @param no_show_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Lodging::NoShowIndicator, nil] Indicator that the cardholder is being billed for a reserved room that was not a + # ... + # + # @param prepaid_expenses_amount [Integer, nil] Prepaid expenses being charged for the room. + # + # @param prepaid_expenses_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid expe + # ... + # + # @param room_nights [Integer, nil] Number of nights the room was rented. + # + # @param total_room_tax_amount [Integer, nil] Total room tax being charged. + # + # @param total_room_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room t + # ... + # + # @param total_tax_amount [Integer, nil] Total tax being charged for the room. + # + # @param total_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax as + # ... # Additional charges (phone, late check-out, etc.) being billed. # @@ -3350,18 +3774,29 @@ class Travel < Increase::Internal::Type::BaseModel # @!method initialize(ancillary:, computerized_reservation_system:, credit_reason_indicator:, departure_date:, origination_city_airport_code:, passenger_name:, restricted_ticket_indicator:, ticket_change_indicator:, ticket_number:, travel_agency_code:, travel_agency_name:, trip_legs:) # Fields specific to travel. # - # @param ancillary [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::Ancillary, nil] - # @param computerized_reservation_system [String, nil] - # @param credit_reason_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::CreditReasonIndicator, nil] - # @param departure_date [Date, nil] - # @param origination_city_airport_code [String, nil] - # @param passenger_name [String, nil] - # @param restricted_ticket_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::RestrictedTicketIndicator, nil] - # @param ticket_change_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::TicketChangeIndicator, nil] - # @param ticket_number [String, nil] - # @param travel_agency_code [String, nil] - # @param travel_agency_name [String, nil] - # @param trip_legs [Array, nil] + # @param ancillary [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::Ancillary, nil] Ancillary purchases in addition to the airfare. + # + # @param computerized_reservation_system [String, nil] Indicates the computerized reservation system used to book the ticket. + # + # @param credit_reason_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::CreditReasonIndicator, nil] Indicates the reason for a credit to the cardholder. + # + # @param departure_date [Date, nil] Date of departure. + # + # @param origination_city_airport_code [String, nil] Code for the originating city or airport. + # + # @param passenger_name [String, nil] Name of the passenger. + # + # @param restricted_ticket_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::RestrictedTicketIndicator, nil] Indicates whether this ticket is non-refundable. + # + # @param ticket_change_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::TicketChangeIndicator, nil] Indicates why a ticket was changed. + # + # @param ticket_number [String, nil] Ticket number. + # + # @param travel_agency_code [String, nil] Code for the travel agency if the ticket was issued by a travel agency. + # + # @param travel_agency_name [String, nil] Name of the travel agency if the ticket was issued by a travel agency. + # + # @param trip_legs [Array, nil] Fields specific to each leg of the journey. # @see Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel#ancillary class Ancillary < Increase::Internal::Type::BaseModel @@ -3401,13 +3836,22 @@ class Ancillary < Increase::Internal::Type::BaseModel required :ticket_document_number, String, nil?: true # @!method initialize(connected_ticket_document_number:, credit_reason_indicator:, passenger_name_or_description:, services:, ticket_document_number:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::Ancillary} + # for more details. + # # Ancillary purchases in addition to the airfare. # - # @param connected_ticket_document_number [String, nil] - # @param credit_reason_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil] - # @param passenger_name_or_description [String, nil] - # @param services [Array] - # @param ticket_document_number [String, nil] + # @param connected_ticket_document_number [String, nil] If this purchase has a connection or relationship to another purchase, such as a + # ... + # + # @param credit_reason_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil] Indicates the reason for a credit to the cardholder. + # + # @param passenger_name_or_description [String, nil] Name of the passenger or description of the ancillary purchase. + # + # @param services [Array] Additional travel charges, such as baggage fees. + # + # @param ticket_document_number [String, nil] Ticket document number. # Indicates the reason for a credit to the cardholder. # @@ -3449,8 +3893,9 @@ class Service < Increase::Internal::Type::BaseModel required :sub_category, String, nil?: true # @!method initialize(category:, sub_category:) - # @param category [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::Ancillary::Service::Category, nil] - # @param sub_category [String, nil] + # @param category [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::Ancillary::Service::Category, nil] Category of the ancillary service. + # + # @param sub_category [String, nil] Sub-category of the ancillary service, free-form. # Category of the ancillary service. # @@ -3641,12 +4086,17 @@ class TripLeg < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(carrier_code:, destination_city_airport_code:, fare_basis_code:, flight_number:, service_class:, stop_over_code:) - # @param carrier_code [String, nil] - # @param destination_city_airport_code [String, nil] - # @param fare_basis_code [String, nil] - # @param flight_number [String, nil] - # @param service_class [String, nil] - # @param stop_over_code [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::TripLeg::StopOverCode, nil] + # @param carrier_code [String, nil] Carrier code (e.g., United Airlines, Jet Blue, etc.). + # + # @param destination_city_airport_code [String, nil] Code for the destination city or airport. + # + # @param fare_basis_code [String, nil] Fare basis code. + # + # @param flight_number [String, nil] Flight number. + # + # @param service_class [String, nil] Service class (e.g., first class, business class, etc.). + # + # @param stop_over_code [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::TripLeg::StopOverCode, nil] Indicates whether a stopover is allowed on this ticket. # Indicates whether a stopover is allowed on this ticket. # @@ -3806,28 +4256,56 @@ class CardReversal < Increase::Internal::Type::BaseModel required :updated_authorization_amount, Integer # @!method initialize(id:, card_authorization_id:, currency:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network:, network_identifiers:, pending_transaction_id:, reversal_amount:, reversal_reason:, terminal_id:, type:, updated_authorization_amount:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardReversal} for more details. + # # A Card Reversal object. This field will be present in the JSON response if and # only if `category` is equal to `card_reversal`. Card Reversals cancel parts of # or the entirety of an existing Card Authorization. # - # @param id [String] - # @param card_authorization_id [String] - # @param currency [Symbol, Increase::Models::CardPayment::Element::CardReversal::Currency] - # @param merchant_acceptor_id [String] - # @param merchant_category_code [String] - # @param merchant_city [String, nil] - # @param merchant_country [String, nil] - # @param merchant_descriptor [String] - # @param merchant_postal_code [String, nil] - # @param merchant_state [String, nil] - # @param network [Symbol, Increase::Models::CardPayment::Element::CardReversal::Network] - # @param network_identifiers [Increase::Models::CardPayment::Element::CardReversal::NetworkIdentifiers] - # @param pending_transaction_id [String, nil] - # @param reversal_amount [Integer] - # @param reversal_reason [Symbol, Increase::Models::CardPayment::Element::CardReversal::ReversalReason, nil] - # @param terminal_id [String, nil] - # @param type [Symbol, Increase::Models::CardPayment::Element::CardReversal::Type] - # @param updated_authorization_amount [Integer] + # @param id [String] The Card Reversal identifier. + # + # @param card_authorization_id [String] The identifier for the Card Authorization this reverses. + # + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardReversal::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's c + # ... + # + # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i + # ... + # + # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car + # ... + # + # @param merchant_city [String, nil] The city the merchant resides in. + # + # @param merchant_country [String, nil] The country the merchant resides in. + # + # @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with. + # + # @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is either a 5-digit or 9-digit + # ... + # + # @param merchant_state [String, nil] The state the merchant resides in. + # + # @param network [Symbol, Increase::Models::CardPayment::Element::CardReversal::Network] The card network used to process this card authorization. + # + # @param network_identifiers [Increase::Models::CardPayment::Element::CardReversal::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction. + # + # @param pending_transaction_id [String, nil] The identifier of the Pending Transaction associated with this Card Reversal. + # + # @param reversal_amount [Integer] The amount of this reversal in the minor unit of the transaction's currency. For + # ... + # + # @param reversal_reason [Symbol, Increase::Models::CardPayment::Element::CardReversal::ReversalReason, nil] Why this reversal was initiated. + # + # @param terminal_id [String, nil] The terminal identifier (commonly abbreviated as TID) of the terminal the card i + # ... + # + # @param type [Symbol, Increase::Models::CardPayment::Element::CardReversal::Type] A constant representing the object's type. For this resource it will always be ` + # ... + # + # @param updated_authorization_amount [Integer] The amount left pending on the Card Authorization in the minor unit of the trans + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's # currency. @@ -3896,11 +4374,20 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel required :transaction_id, String, nil?: true # @!method initialize(retrieval_reference_number:, trace_number:, transaction_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardReversal::NetworkIdentifiers} for + # more details. + # # Network-specific identifiers for a specific request or transaction. # - # @param retrieval_reference_number [String, nil] - # @param trace_number [String, nil] - # @param transaction_id [String, nil] + # @param retrieval_reference_number [String, nil] A life-cycle identifier used across e.g., an authorization and a reversal. Expec + # ... + # + # @param trace_number [String, nil] A counter used to verify an individual authorization. Expected to be unique per + # ... + # + # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro + # ... end # Why this reversal was initiated. @@ -4081,33 +4568,64 @@ class CardSettlement < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::CardPayment::Element::CardSettlement::Type } # @!method initialize(id:, amount:, card_authorization:, card_payment_id:, cashback:, currency:, interchange:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_name:, merchant_postal_code:, merchant_state:, network_identifiers:, pending_transaction_id:, presentment_amount:, presentment_currency:, purchase_details:, transaction_id:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardSettlement} for more details. + # # A Card Settlement object. This field will be present in the JSON response if and # only if `category` is equal to `card_settlement`. Card Settlements are card # transactions that have cleared and settled. While a settlement is usually # preceded by an authorization, an acquirer can also directly clear a transaction # without first authorizing it. # - # @param id [String] - # @param amount [Integer] - # @param card_authorization [String, nil] - # @param card_payment_id [String] - # @param cashback [Increase::Models::CardPayment::Element::CardSettlement::Cashback, nil] - # @param currency [Symbol, Increase::Models::CardPayment::Element::CardSettlement::Currency] - # @param interchange [Increase::Models::CardPayment::Element::CardSettlement::Interchange, nil] - # @param merchant_acceptor_id [String] - # @param merchant_category_code [String] - # @param merchant_city [String] - # @param merchant_country [String] - # @param merchant_name [String] - # @param merchant_postal_code [String, nil] - # @param merchant_state [String, nil] - # @param network_identifiers [Increase::Models::CardPayment::Element::CardSettlement::NetworkIdentifiers] - # @param pending_transaction_id [String, nil] - # @param presentment_amount [Integer] - # @param presentment_currency [String] - # @param purchase_details [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails, nil] - # @param transaction_id [String] - # @param type [Symbol, Increase::Models::CardPayment::Element::CardSettlement::Type] + # @param id [String] The Card Settlement identifier. + # + # @param amount [Integer] The amount in the minor unit of the transaction's settlement currency. For dolla + # ... + # + # @param card_authorization [String, nil] The Card Authorization that was created prior to this Card Settlement, if one ex + # ... + # + # @param card_payment_id [String] The ID of the Card Payment this transaction belongs to. + # + # @param cashback [Increase::Models::CardPayment::Element::CardSettlement::Cashback, nil] Cashback earned on this transaction, if eligible. Cashback is paid out in aggreg + # ... + # + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardSettlement::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param interchange [Increase::Models::CardPayment::Element::CardSettlement::Interchange, nil] Interchange assessed as a part of this transaction. + # + # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i + # ... + # + # @param merchant_category_code [String] The 4-digit MCC describing the merchant's business. + # + # @param merchant_city [String] The city the merchant resides in. + # + # @param merchant_country [String] The country the merchant resides in. + # + # @param merchant_name [String] The name of the merchant. + # + # @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is always a 5-digit ZIP code. + # + # @param merchant_state [String, nil] The state the merchant resides in. + # + # @param network_identifiers [Increase::Models::CardPayment::Element::CardSettlement::NetworkIdentifiers] Network-specific identifiers for this refund. + # + # @param pending_transaction_id [String, nil] The identifier of the Pending Transaction associated with this Transaction. + # + # @param presentment_amount [Integer] The amount in the minor unit of the transaction's presentment currency. + # + # @param presentment_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param purchase_details [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails, nil] Additional details about the card purchase, such as tax and industry-specific fi + # ... + # + # @param transaction_id [String] The identifier of the Transaction associated with this Transaction. + # + # @param type [Symbol, Increase::Models::CardPayment::Element::CardSettlement::Type] A constant representing the object's type. For this resource it will always be ` + # ... # @see Increase::Models::CardPayment::Element::CardSettlement#cashback class Cashback < Increase::Internal::Type::BaseModel @@ -4127,11 +4645,17 @@ class Cashback < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::CardPayment::Element::CardSettlement::Cashback::Currency } # @!method initialize(amount:, currency:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardSettlement::Cashback} for more + # details. + # # Cashback earned on this transaction, if eligible. Cashback is paid out in # aggregate, monthly. # - # @param amount [String] - # @param currency [Symbol, Increase::Models::CardPayment::Element::CardSettlement::Cashback::Currency] + # @param amount [String] The cashback amount given as a string containing a decimal number. The amount is + # ... + # + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardSettlement::Cashback::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. # @@ -4217,11 +4741,19 @@ class Interchange < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::CardPayment::Element::CardSettlement::Interchange::Currency } # @!method initialize(amount:, code:, currency:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardSettlement::Interchange} for more + # details. + # # Interchange assessed as a part of this transaction. # - # @param amount [String] - # @param code [String, nil] - # @param currency [Symbol, Increase::Models::CardPayment::Element::CardSettlement::Interchange::Currency] + # @param amount [String] The interchange amount given as a string containing a decimal number in major un + # ... + # + # @param code [String, nil] The card network specific interchange code. + # + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardSettlement::Interchange::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange # reimbursement. @@ -4276,11 +4808,19 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel required :transaction_id, String, nil?: true # @!method initialize(acquirer_business_id:, acquirer_reference_number:, transaction_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardSettlement::NetworkIdentifiers} for + # more details. + # # Network-specific identifiers for this refund. # - # @param acquirer_business_id [String] - # @param acquirer_reference_number [String] - # @param transaction_id [String, nil] + # @param acquirer_business_id [String] A network assigned business ID that identifies the acquirer that processed this + # ... + # + # @param acquirer_reference_number [String] A globally unique identifier for this settlement. + # + # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro + # ... end # @see Increase::Models::CardPayment::Element::CardSettlement#purchase_details @@ -4356,19 +4896,34 @@ class PurchaseDetails < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(car_rental:, customer_reference_identifier:, local_tax_amount:, local_tax_currency:, lodging:, national_tax_amount:, national_tax_currency:, purchase_identifier:, purchase_identifier_format:, travel:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails} for + # more details. + # # Additional details about the card purchase, such as tax and industry-specific # fields. # - # @param car_rental [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::CarRental, nil] - # @param customer_reference_identifier [String, nil] - # @param local_tax_amount [Integer, nil] - # @param local_tax_currency [String, nil] - # @param lodging [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Lodging, nil] - # @param national_tax_amount [Integer, nil] - # @param national_tax_currency [String, nil] - # @param purchase_identifier [String, nil] - # @param purchase_identifier_format [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::PurchaseIdentifierFormat, nil] - # @param travel [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel, nil] + # @param car_rental [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::CarRental, nil] Fields specific to car rentals. + # + # @param customer_reference_identifier [String, nil] An identifier from the merchant for the customer or consumer. + # + # @param local_tax_amount [Integer, nil] The state or provincial tax amount in minor units. + # + # @param local_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax as + # ... + # + # @param lodging [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Lodging, nil] Fields specific to lodging. + # + # @param national_tax_amount [Integer, nil] The national tax amount in minor units. + # + # @param national_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax as + # ... + # + # @param purchase_identifier [String, nil] An identifier from the merchant for the purchase to the issuer and cardholder. + # + # @param purchase_identifier_format [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::PurchaseIdentifierFormat, nil] The format of the purchase identifier. + # + # @param travel [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel, nil] Fields specific to travel. # @see Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails#car_rental class CarRental < Increase::Internal::Type::BaseModel @@ -4481,24 +5036,51 @@ class CarRental < Increase::Internal::Type::BaseModel required :weekly_rental_rate_currency, String, nil?: true # @!method initialize(car_class_code:, checkout_date:, daily_rental_rate_amount:, daily_rental_rate_currency:, days_rented:, extra_charges:, fuel_charges_amount:, fuel_charges_currency:, insurance_charges_amount:, insurance_charges_currency:, no_show_indicator:, one_way_drop_off_charges_amount:, one_way_drop_off_charges_currency:, renter_name:, weekly_rental_rate_amount:, weekly_rental_rate_currency:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::CarRental} + # for more details. + # # Fields specific to car rentals. # - # @param car_class_code [String, nil] - # @param checkout_date [Date, nil] - # @param daily_rental_rate_amount [Integer, nil] - # @param daily_rental_rate_currency [String, nil] - # @param days_rented [Integer, nil] - # @param extra_charges [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::CarRental::ExtraCharges, nil] - # @param fuel_charges_amount [Integer, nil] - # @param fuel_charges_currency [String, nil] - # @param insurance_charges_amount [Integer, nil] - # @param insurance_charges_currency [String, nil] - # @param no_show_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::CarRental::NoShowIndicator, nil] - # @param one_way_drop_off_charges_amount [Integer, nil] - # @param one_way_drop_off_charges_currency [String, nil] - # @param renter_name [String, nil] - # @param weekly_rental_rate_amount [Integer, nil] - # @param weekly_rental_rate_currency [String, nil] + # @param car_class_code [String, nil] Code indicating the vehicle's class. + # + # @param checkout_date [Date, nil] Date the customer picked up the car or, in the case of a no-show or pre-pay tran + # ... + # + # @param daily_rental_rate_amount [Integer, nil] Daily rate being charged for the vehicle. + # + # @param daily_rental_rate_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental + # ... + # + # @param days_rented [Integer, nil] Number of days the vehicle was rented. + # + # @param extra_charges [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::CarRental::ExtraCharges, nil] Additional charges (gas, late fee, etc.) being billed. + # + # @param fuel_charges_amount [Integer, nil] Fuel charges for the vehicle. + # + # @param fuel_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges + # ... + # + # @param insurance_charges_amount [Integer, nil] Any insurance being charged for the vehicle. + # + # @param insurance_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance ch + # ... + # + # @param no_show_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::CarRental::NoShowIndicator, nil] An indicator that the cardholder is being billed for a reserved vehicle that was + # ... + # + # @param one_way_drop_off_charges_amount [Integer, nil] Charges for returning the vehicle at a different location than where it was pick + # ... + # + # @param one_way_drop_off_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way drop + # ... + # + # @param renter_name [String, nil] Name of the person renting the vehicle. + # + # @param weekly_rental_rate_amount [Integer, nil] Weekly rate being charged for the vehicle. + # + # @param weekly_rental_rate_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly renta + # ... # Additional charges (gas, late fee, etc.) being billed. # @@ -4656,24 +5238,50 @@ class Lodging < Increase::Internal::Type::BaseModel required :total_tax_currency, String, nil?: true # @!method initialize(check_in_date:, daily_room_rate_amount:, daily_room_rate_currency:, extra_charges:, folio_cash_advances_amount:, folio_cash_advances_currency:, food_beverage_charges_amount:, food_beverage_charges_currency:, no_show_indicator:, prepaid_expenses_amount:, prepaid_expenses_currency:, room_nights:, total_room_tax_amount:, total_room_tax_currency:, total_tax_amount:, total_tax_currency:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Lodging} + # for more details. + # # Fields specific to lodging. # - # @param check_in_date [Date, nil] - # @param daily_room_rate_amount [Integer, nil] - # @param daily_room_rate_currency [String, nil] - # @param extra_charges [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Lodging::ExtraCharges, nil] - # @param folio_cash_advances_amount [Integer, nil] - # @param folio_cash_advances_currency [String, nil] - # @param food_beverage_charges_amount [Integer, nil] - # @param food_beverage_charges_currency [String, nil] - # @param no_show_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Lodging::NoShowIndicator, nil] - # @param prepaid_expenses_amount [Integer, nil] - # @param prepaid_expenses_currency [String, nil] - # @param room_nights [Integer, nil] - # @param total_room_tax_amount [Integer, nil] - # @param total_room_tax_currency [String, nil] - # @param total_tax_amount [Integer, nil] - # @param total_tax_currency [String, nil] + # @param check_in_date [Date, nil] Date the customer checked in. + # + # @param daily_room_rate_amount [Integer, nil] Daily rate being charged for the room. + # + # @param daily_room_rate_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room r + # ... + # + # @param extra_charges [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Lodging::ExtraCharges, nil] Additional charges (phone, late check-out, etc.) being billed. + # + # @param folio_cash_advances_amount [Integer, nil] Folio cash advances for the room. + # + # @param folio_cash_advances_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash a + # ... + # + # @param food_beverage_charges_amount [Integer, nil] Food and beverage charges for the room. + # + # @param food_beverage_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and bev + # ... + # + # @param no_show_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Lodging::NoShowIndicator, nil] Indicator that the cardholder is being billed for a reserved room that was not a + # ... + # + # @param prepaid_expenses_amount [Integer, nil] Prepaid expenses being charged for the room. + # + # @param prepaid_expenses_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid expe + # ... + # + # @param room_nights [Integer, nil] Number of nights the room was rented. + # + # @param total_room_tax_amount [Integer, nil] Total room tax being charged. + # + # @param total_room_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room t + # ... + # + # @param total_tax_amount [Integer, nil] Total tax being charged for the room. + # + # @param total_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax as + # ... # Additional charges (phone, late check-out, etc.) being billed. # @@ -4836,18 +5444,29 @@ class Travel < Increase::Internal::Type::BaseModel # @!method initialize(ancillary:, computerized_reservation_system:, credit_reason_indicator:, departure_date:, origination_city_airport_code:, passenger_name:, restricted_ticket_indicator:, ticket_change_indicator:, ticket_number:, travel_agency_code:, travel_agency_name:, trip_legs:) # Fields specific to travel. # - # @param ancillary [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::Ancillary, nil] - # @param computerized_reservation_system [String, nil] - # @param credit_reason_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::CreditReasonIndicator, nil] - # @param departure_date [Date, nil] - # @param origination_city_airport_code [String, nil] - # @param passenger_name [String, nil] - # @param restricted_ticket_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::RestrictedTicketIndicator, nil] - # @param ticket_change_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::TicketChangeIndicator, nil] - # @param ticket_number [String, nil] - # @param travel_agency_code [String, nil] - # @param travel_agency_name [String, nil] - # @param trip_legs [Array, nil] + # @param ancillary [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::Ancillary, nil] Ancillary purchases in addition to the airfare. + # + # @param computerized_reservation_system [String, nil] Indicates the computerized reservation system used to book the ticket. + # + # @param credit_reason_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::CreditReasonIndicator, nil] Indicates the reason for a credit to the cardholder. + # + # @param departure_date [Date, nil] Date of departure. + # + # @param origination_city_airport_code [String, nil] Code for the originating city or airport. + # + # @param passenger_name [String, nil] Name of the passenger. + # + # @param restricted_ticket_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::RestrictedTicketIndicator, nil] Indicates whether this ticket is non-refundable. + # + # @param ticket_change_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::TicketChangeIndicator, nil] Indicates why a ticket was changed. + # + # @param ticket_number [String, nil] Ticket number. + # + # @param travel_agency_code [String, nil] Code for the travel agency if the ticket was issued by a travel agency. + # + # @param travel_agency_name [String, nil] Name of the travel agency if the ticket was issued by a travel agency. + # + # @param trip_legs [Array, nil] Fields specific to each leg of the journey. # @see Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel#ancillary class Ancillary < Increase::Internal::Type::BaseModel @@ -4887,13 +5506,22 @@ class Ancillary < Increase::Internal::Type::BaseModel required :ticket_document_number, String, nil?: true # @!method initialize(connected_ticket_document_number:, credit_reason_indicator:, passenger_name_or_description:, services:, ticket_document_number:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::Ancillary} + # for more details. + # # Ancillary purchases in addition to the airfare. # - # @param connected_ticket_document_number [String, nil] - # @param credit_reason_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil] - # @param passenger_name_or_description [String, nil] - # @param services [Array] - # @param ticket_document_number [String, nil] + # @param connected_ticket_document_number [String, nil] If this purchase has a connection or relationship to another purchase, such as a + # ... + # + # @param credit_reason_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil] Indicates the reason for a credit to the cardholder. + # + # @param passenger_name_or_description [String, nil] Name of the passenger or description of the ancillary purchase. + # + # @param services [Array] Additional travel charges, such as baggage fees. + # + # @param ticket_document_number [String, nil] Ticket document number. # Indicates the reason for a credit to the cardholder. # @@ -4935,8 +5563,9 @@ class Service < Increase::Internal::Type::BaseModel required :sub_category, String, nil?: true # @!method initialize(category:, sub_category:) - # @param category [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::Ancillary::Service::Category, nil] - # @param sub_category [String, nil] + # @param category [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::Ancillary::Service::Category, nil] Category of the ancillary service. + # + # @param sub_category [String, nil] Sub-category of the ancillary service, free-form. # Category of the ancillary service. # @@ -5127,12 +5756,17 @@ class TripLeg < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(carrier_code:, destination_city_airport_code:, fare_basis_code:, flight_number:, service_class:, stop_over_code:) - # @param carrier_code [String, nil] - # @param destination_city_airport_code [String, nil] - # @param fare_basis_code [String, nil] - # @param flight_number [String, nil] - # @param service_class [String, nil] - # @param stop_over_code [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::TripLeg::StopOverCode, nil] + # @param carrier_code [String, nil] Carrier code (e.g., United Airlines, Jet Blue, etc.). + # + # @param destination_city_airport_code [String, nil] Code for the destination city or airport. + # + # @param fare_basis_code [String, nil] Fare basis code. + # + # @param flight_number [String, nil] Flight number. + # + # @param service_class [String, nil] Service class (e.g., first class, business class, etc.). + # + # @param stop_over_code [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::TripLeg::StopOverCode, nil] Indicates whether a stopover is allowed on this ticket. # Indicates whether a stopover is allowed on this ticket. # @@ -5305,31 +5939,64 @@ class CardValidation < Increase::Internal::Type::BaseModel required :verification, -> { Increase::Models::CardPayment::Element::CardValidation::Verification } # @!method initialize(id:, actioner:, card_payment_id:, currency:, digital_wallet_token_id:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, physical_card_id:, real_time_decision_id:, terminal_id:, type:, verification:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardValidation} for more details. + # # A Card Validation object. This field will be present in the JSON response if and # only if `category` is equal to `card_validation`. Card Validations are requests # from a merchant to verify that a card number and optionally its address and/or # Card Verification Value are valid. # - # @param id [String] - # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardValidation::Actioner] - # @param card_payment_id [String] - # @param currency [Symbol, Increase::Models::CardPayment::Element::CardValidation::Currency] - # @param digital_wallet_token_id [String, nil] - # @param merchant_acceptor_id [String] - # @param merchant_category_code [String] - # @param merchant_city [String, nil] - # @param merchant_country [String] - # @param merchant_descriptor [String] - # @param merchant_postal_code [String, nil] - # @param merchant_state [String, nil] - # @param network_details [Increase::Models::CardPayment::Element::CardValidation::NetworkDetails] - # @param network_identifiers [Increase::Models::CardPayment::Element::CardValidation::NetworkIdentifiers] - # @param network_risk_score [Integer, nil] - # @param physical_card_id [String, nil] - # @param real_time_decision_id [String, nil] - # @param terminal_id [String, nil] - # @param type [Symbol, Increase::Models::CardPayment::Element::CardValidation::Type] - # @param verification [Increase::Models::CardPayment::Element::CardValidation::Verification] + # @param id [String] The Card Validation identifier. + # + # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardValidation::Actioner] Whether this authorization was approved by Increase, the card network through st + # ... + # + # @param card_payment_id [String] The ID of the Card Payment this transaction belongs to. + # + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardValidation::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param digital_wallet_token_id [String, nil] If the authorization was made via a Digital Wallet Token (such as an Apple Pay p + # ... + # + # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i + # ... + # + # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car + # ... + # + # @param merchant_city [String, nil] The city the merchant resides in. + # + # @param merchant_country [String] The country the merchant resides in. + # + # @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with. + # + # @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is either a 5-digit or 9-digit + # ... + # + # @param merchant_state [String, nil] The state the merchant resides in. + # + # @param network_details [Increase::Models::CardPayment::Element::CardValidation::NetworkDetails] Fields specific to the `network`. + # + # @param network_identifiers [Increase::Models::CardPayment::Element::CardValidation::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction. + # + # @param network_risk_score [Integer, nil] The risk score generated by the card network. For Visa this is the Visa Advanced + # ... + # + # @param physical_card_id [String, nil] If the authorization was made in-person with a physical card, the Physical Card + # ... + # + # @param real_time_decision_id [String, nil] The identifier of the Real-Time Decision sent to approve or decline this transac + # ... + # + # @param terminal_id [String, nil] The terminal identifier (commonly abbreviated as TID) of the terminal the card i + # ... + # + # @param type [Symbol, Increase::Models::CardPayment::Element::CardValidation::Type] A constant representing the object's type. For this resource it will always be ` + # ... + # + # @param verification [Increase::Models::CardPayment::Element::CardValidation::Verification] Fields related to verification of cardholder-provided values. # Whether this authorization was approved by Increase, the card network through # stand-in processing, or the user through a real-time decision. @@ -5400,8 +6067,9 @@ class NetworkDetails < Increase::Internal::Type::BaseModel # @!method initialize(category:, visa:) # Fields specific to the `network`. # - # @param category [Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Category] - # @param visa [Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa, nil] + # @param category [Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Category] The payment network used to process this card authorization. + # + # @param visa [Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa, nil] Fields specific to the `visa` network. # The payment network used to process this card authorization. # @@ -5447,11 +6115,20 @@ class Visa < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa} + # for more details. + # # Fields specific to the `visa` network. # - # @param electronic_commerce_indicator [Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] - # @param point_of_service_entry_mode [Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa::PointOfServiceEntryMode, nil] - # @param stand_in_processing_reason [Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa::StandInProcessingReason, nil] + # @param electronic_commerce_indicator [Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] For electronic commerce transactions, this identifies the level of security used + # ... + # + # @param point_of_service_entry_mode [Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa::PointOfServiceEntryMode, nil] The method used to enter the cardholder's primary account number and card expira + # ... + # + # @param stand_in_processing_reason [Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa::StandInProcessingReason, nil] Only present when `actioner: network`. Describes why a card authorization was ap + # ... # For electronic commerce transactions, this identifies the level of security used # in obtaining the customer's payment credential. For mail or telephone order @@ -5592,11 +6269,20 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel required :transaction_id, String, nil?: true # @!method initialize(retrieval_reference_number:, trace_number:, transaction_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardValidation::NetworkIdentifiers} for + # more details. + # # Network-specific identifiers for a specific request or transaction. # - # @param retrieval_reference_number [String, nil] - # @param trace_number [String, nil] - # @param transaction_id [String, nil] + # @param retrieval_reference_number [String, nil] A life-cycle identifier used across e.g., an authorization and a reversal. Expec + # ... + # + # @param trace_number [String, nil] A counter used to verify an individual authorization. Expected to be unique per + # ... + # + # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro + # ... end # A constant representing the object's type. For this resource it will always be @@ -5631,10 +6317,17 @@ class Verification < Increase::Internal::Type::BaseModel -> { Increase::Models::CardPayment::Element::CardValidation::Verification::CardholderAddress } # @!method initialize(card_verification_code:, cardholder_address:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardValidation::Verification} for more + # details. + # # Fields related to verification of cardholder-provided values. # - # @param card_verification_code [Increase::Models::CardPayment::Element::CardValidation::Verification::CardVerificationCode] - # @param cardholder_address [Increase::Models::CardPayment::Element::CardValidation::Verification::CardholderAddress] + # @param card_verification_code [Increase::Models::CardPayment::Element::CardValidation::Verification::CardVerificationCode] Fields related to verification of the Card Verification Code, a 3-digit code on + # ... + # + # @param cardholder_address [Increase::Models::CardPayment::Element::CardValidation::Verification::CardholderAddress] Cardholder address provided in the authorization request and the address on file + # ... # @see Increase::Models::CardPayment::Element::CardValidation::Verification#card_verification_code class CardVerificationCode < Increase::Internal::Type::BaseModel @@ -5649,7 +6342,7 @@ class CardVerificationCode < Increase::Internal::Type::BaseModel # Fields related to verification of the Card Verification Code, a 3-digit code on # the back of the card. # - # @param result [Symbol, Increase::Models::CardPayment::Element::CardValidation::Verification::CardVerificationCode::Result] + # @param result [Symbol, Increase::Models::CardPayment::Element::CardValidation::Verification::CardVerificationCode::Result] The result of verifying the Card Verification Code. # The result of verifying the Card Verification Code. # @@ -5706,14 +6399,23 @@ class CardholderAddress < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::CardPayment::Element::CardValidation::Verification::CardholderAddress::Result } # @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::Element::CardValidation::Verification::CardholderAddress} + # for more details. + # # Cardholder address provided in the authorization request and the address on file # we verified it against. # - # @param actual_line1 [String, nil] - # @param actual_postal_code [String, nil] - # @param provided_line1 [String, nil] - # @param provided_postal_code [String, nil] - # @param result [Symbol, Increase::Models::CardPayment::Element::CardValidation::Verification::CardholderAddress::Result] + # @param actual_line1 [String, nil] Line 1 of the address on file for the cardholder. + # + # @param actual_postal_code [String, nil] The postal code of the address on file for the cardholder. + # + # @param provided_line1 [String, nil] The cardholder address line 1 provided for verification in the authorization req + # ... + # + # @param provided_postal_code [String, nil] The postal code provided for verification in the authorization request. + # + # @param result [Symbol, Increase::Models::CardPayment::Element::CardValidation::Verification::CardholderAddress::Result] The address verification result returned to the card network. # The address verification result returned to the card network. # @@ -5829,13 +6531,25 @@ class State < Increase::Internal::Type::BaseModel required :settled_amount, Integer # @!method initialize(authorized_amount:, fuel_confirmed_amount:, incremented_amount:, reversed_amount:, settled_amount:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPayment::State} for more details. + # # The summarized state of this card payment. # - # @param authorized_amount [Integer] - # @param fuel_confirmed_amount [Integer] - # @param incremented_amount [Integer] - # @param reversed_amount [Integer] - # @param settled_amount [Integer] + # @param authorized_amount [Integer] The total authorized amount in the minor unit of the transaction's currency. For + # ... + # + # @param fuel_confirmed_amount [Integer] The total amount from fuel confirmations in the minor unit of the transaction's + # ... + # + # @param incremented_amount [Integer] The total incrementally updated authorized amount in the minor unit of the trans + # ... + # + # @param reversed_amount [Integer] The total reversed amount in the minor unit of the transaction's currency. For d + # ... + # + # @param settled_amount [Integer] The total settled or refunded amount in the minor unit of the transaction's curr + # ... end # A constant representing the object's type. For this resource it will always be diff --git a/lib/increase/models/card_payment_list_params.rb b/lib/increase/models/card_payment_list_params.rb index 1b41453b8..f98778776 100644 --- a/lib/increase/models/card_payment_list_params.rb +++ b/lib/increase/models/card_payment_list_params.rb @@ -38,11 +38,20 @@ class CardPaymentListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(account_id: nil, card_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) - # @param account_id [String] - # @param card_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPaymentListParams} for more details. + # + # @param account_id [String] Filter Card Payments to ones belonging to the specified Account. + # + # @param card_id [String] Filter Card Payments to ones belonging to the specified Card. + # # @param created_at [Increase::Models::CardPaymentListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @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 @@ -75,10 +84,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPaymentListParams::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 diff --git a/lib/increase/models/card_purchase_supplement.rb b/lib/increase/models/card_purchase_supplement.rb index 4c1f23c3c..8c9df3b3c 100644 --- a/lib/increase/models/card_purchase_supplement.rb +++ b/lib/increase/models/card_purchase_supplement.rb @@ -44,15 +44,24 @@ class CardPurchaseSupplement < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::CardPurchaseSupplement::Type } # @!method initialize(id:, card_payment_id:, invoice:, line_items:, transaction_id:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPurchaseSupplement} for more details. + # # Additional information about a card purchase (e.g., settlement or refund), such # as level 3 line item data. # - # @param id [String] - # @param card_payment_id [String, nil] - # @param invoice [Increase::Models::CardPurchaseSupplement::Invoice, nil] - # @param line_items [Array, nil] - # @param transaction_id [String] - # @param type [Symbol, Increase::Models::CardPurchaseSupplement::Type] + # @param id [String] The Card Purchase Supplement identifier. + # + # @param card_payment_id [String, nil] The ID of the Card Payment this transaction belongs to. + # + # @param invoice [Increase::Models::CardPurchaseSupplement::Invoice, nil] Invoice-level information about the payment. + # + # @param line_items [Array, nil] Line item information, such as individual products purchased. + # + # @param transaction_id [String] The ID of the transaction. + # + # @param type [Symbol, Increase::Models::CardPurchaseSupplement::Type] A constant representing the object's type. For this resource it will always be ` + # ... # @see Increase::Models::CardPurchaseSupplement#invoice class Invoice < Increase::Internal::Type::BaseModel @@ -159,24 +168,44 @@ class Invoice < Increase::Internal::Type::BaseModel required :unique_value_added_tax_invoice_reference, String, nil?: true # @!method initialize(discount_amount:, discount_currency:, discount_treatment_code:, duty_tax_amount:, duty_tax_currency:, order_date:, shipping_amount:, shipping_currency:, shipping_destination_country_code:, shipping_destination_postal_code:, shipping_source_postal_code:, shipping_tax_amount:, shipping_tax_currency:, shipping_tax_rate:, tax_treatments:, unique_value_added_tax_invoice_reference:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPurchaseSupplement::Invoice} for more details. + # # Invoice-level information about the payment. # - # @param discount_amount [Integer, nil] - # @param discount_currency [String, nil] - # @param discount_treatment_code [Symbol, Increase::Models::CardPurchaseSupplement::Invoice::DiscountTreatmentCode, nil] - # @param duty_tax_amount [Integer, nil] - # @param duty_tax_currency [String, nil] - # @param order_date [Date, nil] - # @param shipping_amount [Integer, nil] - # @param shipping_currency [String, nil] - # @param shipping_destination_country_code [String, nil] - # @param shipping_destination_postal_code [String, nil] - # @param shipping_source_postal_code [String, nil] - # @param shipping_tax_amount [Integer, nil] - # @param shipping_tax_currency [String, nil] - # @param shipping_tax_rate [String, nil] - # @param tax_treatments [Symbol, Increase::Models::CardPurchaseSupplement::Invoice::TaxTreatments, nil] - # @param unique_value_added_tax_invoice_reference [String, nil] + # @param discount_amount [Integer, nil] Discount given to cardholder. + # + # @param discount_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the discount. + # + # @param discount_treatment_code [Symbol, Increase::Models::CardPurchaseSupplement::Invoice::DiscountTreatmentCode, nil] Indicates how the merchant applied the discount. + # + # @param duty_tax_amount [Integer, nil] Amount of duty taxes. + # + # @param duty_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the duty tax. + # + # @param order_date [Date, nil] Date the order was taken. + # + # @param shipping_amount [Integer, nil] The shipping cost. + # + # @param shipping_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the shipping cos + # ... + # + # @param shipping_destination_country_code [String, nil] Country code of the shipping destination. + # + # @param shipping_destination_postal_code [String, nil] Postal code of the shipping destination. + # + # @param shipping_source_postal_code [String, nil] Postal code of the location being shipped from. + # + # @param shipping_tax_amount [Integer, nil] Taxes paid for freight and shipping. + # + # @param shipping_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the shipping tax + # ... + # + # @param shipping_tax_rate [String, nil] Tax rate for freight and shipping. + # + # @param tax_treatments [Symbol, Increase::Models::CardPurchaseSupplement::Invoice::TaxTreatments, nil] Indicates how the merchant applied taxes. + # + # @param unique_value_added_tax_invoice_reference [String, nil] Value added tax invoice reference number. # Indicates how the merchant applied the discount. # @@ -333,23 +362,44 @@ class LineItem < Increase::Internal::Type::BaseModel required :unit_of_measure_code, String, nil?: true # @!method initialize(id:, detail_indicator:, discount_amount:, discount_currency:, discount_treatment_code:, item_commodity_code:, item_descriptor:, item_quantity:, product_code:, sales_tax_amount:, sales_tax_currency:, sales_tax_rate:, total_amount:, total_amount_currency:, unit_cost:, unit_cost_currency:, unit_of_measure_code:) - # @param id [String] - # @param detail_indicator [Symbol, Increase::Models::CardPurchaseSupplement::LineItem::DetailIndicator, nil] - # @param discount_amount [Integer, nil] - # @param discount_currency [String, nil] - # @param discount_treatment_code [Symbol, Increase::Models::CardPurchaseSupplement::LineItem::DiscountTreatmentCode, nil] - # @param item_commodity_code [String, nil] - # @param item_descriptor [String, nil] - # @param item_quantity [String, nil] - # @param product_code [String, nil] - # @param sales_tax_amount [Integer, nil] - # @param sales_tax_currency [String, nil] - # @param sales_tax_rate [String, nil] - # @param total_amount [Integer, nil] - # @param total_amount_currency [String, nil] - # @param unit_cost [String, nil] - # @param unit_cost_currency [String, nil] - # @param unit_of_measure_code [String, nil] + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPurchaseSupplement::LineItem} for more details. + # + # @param id [String] The Card Purchase Supplement Line Item identifier. + # + # @param detail_indicator [Symbol, Increase::Models::CardPurchaseSupplement::LineItem::DetailIndicator, nil] Indicates the type of line item. + # + # @param discount_amount [Integer, nil] Discount amount for this specific line item. + # + # @param discount_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the discount. + # + # @param discount_treatment_code [Symbol, Increase::Models::CardPurchaseSupplement::LineItem::DiscountTreatmentCode, nil] Indicates how the merchant applied the discount for this specific line item. + # + # @param item_commodity_code [String, nil] Code used to categorize the purchase item. + # + # @param item_descriptor [String, nil] Description of the purchase item. + # + # @param item_quantity [String, nil] The number of units of the product being purchased. + # + # @param product_code [String, nil] Code used to categorize the product being purchased. + # + # @param sales_tax_amount [Integer, nil] Sales tax amount for this line item. + # + # @param sales_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the sales tax as + # ... + # + # @param sales_tax_rate [String, nil] Sales tax rate for this line item. + # + # @param total_amount [Integer, nil] Total amount of all line items. + # + # @param total_amount_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total amount + # ... + # + # @param unit_cost [String, nil] Cost of line item per unit of measure, in major units. + # + # @param unit_cost_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the unit cost. + # + # @param unit_of_measure_code [String, nil] Code indicating unit of measure (gallons, etc.). # Indicates the type of line item. # diff --git a/lib/increase/models/card_purchase_supplement_list_params.rb b/lib/increase/models/card_purchase_supplement_list_params.rb index 51dd3e2f0..c504725ed 100644 --- a/lib/increase/models/card_purchase_supplement_list_params.rb +++ b/lib/increase/models/card_purchase_supplement_list_params.rb @@ -33,10 +33,19 @@ class CardPurchaseSupplementListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(card_payment_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) - # @param card_payment_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPurchaseSupplementListParams} for more details. + # + # @param card_payment_id [String] Filter Card Purchase Supplements to ones belonging to the specified Card Payment + # ... + # # @param created_at [Increase::Models::CardPurchaseSupplementListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @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 @@ -69,10 +78,21 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPurchaseSupplementListParams::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 diff --git a/lib/increase/models/card_update_params.rb b/lib/increase/models/card_update_params.rb index 23bdffb96..9df8ed737 100644 --- a/lib/increase/models/card_update_params.rb +++ b/lib/increase/models/card_update_params.rb @@ -41,11 +41,21 @@ class CardUpdateParams < Increase::Internal::Type::BaseModel optional :status, enum: -> { Increase::Models::CardUpdateParams::Status } # @!method initialize(billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, status: nil, request_options: {}) - # @param billing_address [Increase::Models::CardUpdateParams::BillingAddress] - # @param description [String] - # @param digital_wallet [Increase::Models::CardUpdateParams::DigitalWallet] - # @param entity_id [String] - # @param status [Symbol, Increase::Models::CardUpdateParams::Status] + # Some parameter documentations has been truncated, see + # {Increase::Models::CardUpdateParams} for more details. + # + # @param billing_address [Increase::Models::CardUpdateParams::BillingAddress] The card's updated billing address. + # + # @param description [String] The description you choose to give the card. + # + # @param digital_wallet [Increase::Models::CardUpdateParams::DigitalWallet] The contact information used in the two-factor steps for digital wallet card cre + # ... + # + # @param entity_id [String] The Entity the card belongs to. You only need to supply this in rare situations + # ... + # + # @param status [Symbol, Increase::Models::CardUpdateParams::Status] The status to update the Card with. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class BillingAddress < Increase::Internal::Type::BaseModel @@ -82,11 +92,15 @@ class BillingAddress < Increase::Internal::Type::BaseModel # @!method initialize(city:, line1:, postal_code:, state:, line2: nil) # The card's updated billing address. # - # @param city [String] - # @param line1 [String] - # @param postal_code [String] - # @param state [String] - # @param line2 [String] + # @param city [String] The city of the billing address. + # + # @param line1 [String] The first line of the billing address. + # + # @param postal_code [String] The postal code of the billing address. + # + # @param state [String] The US state of the billing address. + # + # @param line2 [String] The second line of the billing address. end class DigitalWallet < Increase::Internal::Type::BaseModel @@ -111,13 +125,20 @@ class DigitalWallet < Increase::Internal::Type::BaseModel optional :phone, String # @!method initialize(digital_card_profile_id: nil, email: nil, phone: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::CardUpdateParams::DigitalWallet} for more details. + # # The contact information used in the two-factor steps for digital wallet card # creation. At least one field must be present to complete the digital wallet # steps. # - # @param digital_card_profile_id [String] - # @param email [String] - # @param phone [String] + # @param digital_card_profile_id [String] The digital card profile assigned to this digital card. + # + # @param email [String] An email address that can be used to verify the cardholder via one-time passcode + # ... + # + # @param phone [String] A phone number that can be used to verify the cardholder via one-time passcode o + # ... end # The status to update the Card with. diff --git a/lib/increase/models/check_deposit.rb b/lib/increase/models/check_deposit.rb index 96d19c2d7..e58e089f9 100644 --- a/lib/increase/models/check_deposit.rb +++ b/lib/increase/models/check_deposit.rb @@ -124,26 +124,56 @@ class CheckDeposit < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::CheckDeposit::Type } # @!method initialize(id:, account_id:, amount:, back_image_file_id:, created_at:, deposit_acceptance:, deposit_rejection:, deposit_return:, deposit_submission:, description:, front_image_file_id:, idempotency_key:, inbound_funds_hold:, inbound_mail_item_id:, lockbox_id:, status:, transaction_id:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckDeposit} for more details. + # # Check Deposits allow you to deposit images of paper checks into your account. # - # @param id [String] - # @param account_id [String] - # @param amount [Integer] - # @param back_image_file_id [String, nil] - # @param created_at [Time] - # @param deposit_acceptance [Increase::Models::CheckDeposit::DepositAcceptance, nil] - # @param deposit_rejection [Increase::Models::CheckDeposit::DepositRejection, nil] - # @param deposit_return [Increase::Models::CheckDeposit::DepositReturn, nil] - # @param deposit_submission [Increase::Models::CheckDeposit::DepositSubmission, nil] - # @param description [String, nil] - # @param front_image_file_id [String] - # @param idempotency_key [String, nil] - # @param inbound_funds_hold [Increase::Models::CheckDeposit::InboundFundsHold, nil] - # @param inbound_mail_item_id [String, nil] - # @param lockbox_id [String, nil] - # @param status [Symbol, Increase::Models::CheckDeposit::Status] - # @param transaction_id [String, nil] - # @param type [Symbol, Increase::Models::CheckDeposit::Type] + # @param id [String] The deposit's identifier. + # + # @param account_id [String] The Account the check was deposited into. + # + # @param amount [Integer] The deposited amount in USD cents. + # + # @param back_image_file_id [String, nil] The ID for the File containing the image of the back of the check. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param deposit_acceptance [Increase::Models::CheckDeposit::DepositAcceptance, nil] If your deposit is successfully parsed and accepted by Increase, this will conta + # ... + # + # @param deposit_rejection [Increase::Models::CheckDeposit::DepositRejection, nil] If your deposit is rejected by Increase, this will contain details as to why it + # ... + # + # @param deposit_return [Increase::Models::CheckDeposit::DepositReturn, nil] If your deposit is returned, this will contain details as to why it was returned + # ... + # + # @param deposit_submission [Increase::Models::CheckDeposit::DepositSubmission, nil] After the check is parsed, it is submitted to the Check21 network for processing + # ... + # + # @param description [String, nil] The description of the Check Deposit, for display purposes only. + # + # @param front_image_file_id [String] The ID for the File containing the image of the front of the check. + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param inbound_funds_hold [Increase::Models::CheckDeposit::InboundFundsHold, nil] Increase will sometimes hold the funds for Check Deposits. If funds are held, th + # ... + # + # @param inbound_mail_item_id [String, nil] If the Check Deposit was the result of an Inbound Mail Item, this will contain t + # ... + # + # @param lockbox_id [String, nil] If the Check Deposit was the result of an Inbound Mail Item, this will contain t + # ... + # + # @param status [Symbol, Increase::Models::CheckDeposit::Status] The status of the Check Deposit. + # + # @param transaction_id [String, nil] The ID for the Transaction created by the deposit. + # + # @param type [Symbol, Increase::Models::CheckDeposit::Type] A constant representing the object's type. For this resource it will always be ` + # ... # @see Increase::Models::CheckDeposit#deposit_acceptance class DepositAcceptance < Increase::Internal::Type::BaseModel @@ -194,16 +224,29 @@ class DepositAcceptance < Increase::Internal::Type::BaseModel required :serial_number, String, nil?: true # @!method initialize(account_number:, amount:, auxiliary_on_us:, check_deposit_id:, currency:, routing_number:, serial_number:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckDeposit::DepositAcceptance} for more details. + # # If your deposit is successfully parsed and accepted by Increase, this will # contain details of the parsed check. # - # @param account_number [String] - # @param amount [Integer] - # @param auxiliary_on_us [String, nil] - # @param check_deposit_id [String] - # @param currency [Symbol, Increase::Models::CheckDeposit::DepositAcceptance::Currency] - # @param routing_number [String] - # @param serial_number [String, nil] + # @param account_number [String] The account number printed on the check. + # + # @param amount [Integer] The amount to be deposited in the minor unit of the transaction's currency. For + # ... + # + # @param auxiliary_on_us [String, nil] An additional line of metadata printed on the check. This typically includes the + # ... + # + # @param check_deposit_id [String] The ID of the Check Deposit that was accepted. + # + # @param currency [Symbol, Increase::Models::CheckDeposit::DepositAcceptance::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param routing_number [String] The routing number printed on the check. + # + # @param serial_number [String, nil] The check serial number, if present, for consumer checks. For business checks, t + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the # transaction's currency. @@ -277,15 +320,26 @@ class DepositRejection < Increase::Internal::Type::BaseModel required :rejected_at, Time # @!method initialize(amount:, check_deposit_id:, currency:, declined_transaction_id:, reason:, rejected_at:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckDeposit::DepositRejection} for more details. + # # If your deposit is rejected by Increase, this will contain details as to why it # was rejected. # - # @param amount [Integer] - # @param check_deposit_id [String] - # @param currency [Symbol, Increase::Models::CheckDeposit::DepositRejection::Currency] - # @param declined_transaction_id [String] - # @param reason [Symbol, Increase::Models::CheckDeposit::DepositRejection::Reason] - # @param rejected_at [Time] + # @param amount [Integer] The rejected amount in the minor unit of check's currency. For dollars, for exam + # ... + # + # @param check_deposit_id [String] The identifier of the Check Deposit that was rejected. + # + # @param currency [Symbol, Increase::Models::CheckDeposit::DepositRejection::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's curr + # ... + # + # @param declined_transaction_id [String] The identifier of the associated declined transaction. + # + # @param reason [Symbol, Increase::Models::CheckDeposit::DepositRejection::Reason] Why the check deposit was rejected. + # + # @param rejected_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's # currency. @@ -403,15 +457,27 @@ class DepositReturn < Increase::Internal::Type::BaseModel required :transaction_id, String # @!method initialize(amount:, check_deposit_id:, currency:, return_reason:, returned_at:, transaction_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckDeposit::DepositReturn} for more details. + # # If your deposit is returned, this will contain details as to why it was # returned. # - # @param amount [Integer] - # @param check_deposit_id [String] - # @param currency [Symbol, Increase::Models::CheckDeposit::DepositReturn::Currency] - # @param return_reason [Symbol, Increase::Models::CheckDeposit::DepositReturn::ReturnReason] - # @param returned_at [Time] - # @param transaction_id [String] + # @param amount [Integer] The returned amount in USD cents. + # + # @param check_deposit_id [String] The identifier of the Check Deposit that was returned. + # + # @param currency [Symbol, Increase::Models::CheckDeposit::DepositReturn::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param return_reason [Symbol, Increase::Models::CheckDeposit::DepositReturn::ReturnReason] Why this check was returned by the bank holding the account it was drawn against + # ... + # + # @param returned_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param transaction_id [String] The identifier of the transaction that reversed the original check deposit trans + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the # transaction's currency. @@ -557,12 +623,20 @@ class DepositSubmission < Increase::Internal::Type::BaseModel required :submitted_at, Time # @!method initialize(back_file_id:, front_file_id:, submitted_at:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckDeposit::DepositSubmission} for more details. + # # After the check is parsed, it is submitted to the Check21 network for # processing. This will contain details of the submission. # - # @param back_file_id [String] - # @param front_file_id [String] - # @param submitted_at [Time] + # @param back_file_id [String] The ID for the File containing the check back image that was submitted to the Ch + # ... + # + # @param front_file_id [String] The ID for the File containing the check front image that was submitted to the C + # ... + # + # @param submitted_at [Time] When the check deposit was submitted to the Check21 network for processing. Duri + # ... end # @see Increase::Models::CheckDeposit#inbound_funds_hold @@ -633,19 +707,36 @@ class InboundFundsHold < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::CheckDeposit::InboundFundsHold::Type } # @!method initialize(id:, amount:, automatically_releases_at:, created_at:, currency:, held_transaction_id:, pending_transaction_id:, released_at:, status:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckDeposit::InboundFundsHold} for more details. + # # Increase will sometimes hold the funds for Check Deposits. If funds are held, # this sub-object will contain details of the hold. # - # @param id [String] - # @param amount [Integer] - # @param automatically_releases_at [Time] - # @param created_at [Time] - # @param currency [Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Currency] - # @param held_transaction_id [String, nil] - # @param pending_transaction_id [String, nil] - # @param released_at [Time, nil] - # @param status [Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Status] - # @param type [Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Type] + # @param id [String] The Inbound Funds Hold identifier. + # + # @param amount [Integer] The held amount in the minor unit of the account's currency. For dollars, for ex + # ... + # + # @param automatically_releases_at [Time] When the hold will be released automatically. Certain conditions may cause it to + # ... + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold wa + # ... + # + # @param currency [Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's curre + # ... + # + # @param held_transaction_id [String, nil] The ID of the Transaction for which funds were held. + # + # @param pending_transaction_id [String, nil] The ID of the Pending Transaction representing the held funds. + # + # @param released_at [Time, nil] When the hold was released (if it has been released). + # + # @param status [Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Status] The status of the hold. + # + # @param type [Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's # currency. diff --git a/lib/increase/models/check_deposit_create_params.rb b/lib/increase/models/check_deposit_create_params.rb index ccdc25fa4..b329fedfd 100644 --- a/lib/increase/models/check_deposit_create_params.rb +++ b/lib/increase/models/check_deposit_create_params.rb @@ -38,11 +38,20 @@ class CheckDepositCreateParams < Increase::Internal::Type::BaseModel optional :description, String # @!method initialize(account_id:, amount:, back_image_file_id:, front_image_file_id:, description: nil, request_options: {}) - # @param account_id [String] - # @param amount [Integer] - # @param back_image_file_id [String] - # @param front_image_file_id [String] - # @param description [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckDepositCreateParams} for more details. + # + # @param account_id [String] The identifier for the Account to deposit the check in. + # + # @param amount [Integer] The deposit amount in USD cents. + # + # @param back_image_file_id [String] The File containing the check's back image. + # + # @param front_image_file_id [String] The File containing the check's front image. + # + # @param description [String] The description you choose to give the Check Deposit, for display purposes only. + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/check_deposit_list_params.rb b/lib/increase/models/check_deposit_list_params.rb index f13122ade..757da489e 100644 --- a/lib/increase/models/check_deposit_list_params.rb +++ b/lib/increase/models/check_deposit_list_params.rb @@ -41,11 +41,21 @@ class CheckDepositListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) - # @param account_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckDepositListParams} for more details. + # + # @param account_id [String] Filter Check Deposits to those belonging to the specified Account. + # # @param created_at [Increase::Models::CheckDepositListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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 @@ -78,10 +88,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckDepositListParams::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 diff --git a/lib/increase/models/check_transfer.rb b/lib/increase/models/check_transfer.rb index 5658885c5..d030028a8 100644 --- a/lib/increase/models/check_transfer.rb +++ b/lib/increase/models/check_transfer.rb @@ -159,32 +159,70 @@ class CheckTransfer < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::CheckTransfer::Type } # @!method initialize(id:, account_id:, account_number:, amount:, approval:, approved_inbound_check_deposit_id:, cancellation:, check_number:, created_at:, created_by:, currency:, fulfillment_method:, idempotency_key:, mailing:, pending_transaction_id:, physical_check:, routing_number:, source_account_number_id:, status:, stop_payment_request:, submission:, third_party:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckTransfer} for more details. + # # Check Transfers move funds from your Increase account by mailing a physical # check. # - # @param id [String] - # @param account_id [String] - # @param account_number [String] - # @param amount [Integer] - # @param approval [Increase::Models::CheckTransfer::Approval, nil] - # @param approved_inbound_check_deposit_id [String, nil] - # @param cancellation [Increase::Models::CheckTransfer::Cancellation, nil] - # @param check_number [String] - # @param created_at [Time] - # @param created_by [Increase::Models::CheckTransfer::CreatedBy, nil] - # @param currency [Symbol, Increase::Models::CheckTransfer::Currency] - # @param fulfillment_method [Symbol, Increase::Models::CheckTransfer::FulfillmentMethod] - # @param idempotency_key [String, nil] - # @param mailing [Increase::Models::CheckTransfer::Mailing, nil] - # @param pending_transaction_id [String, nil] - # @param physical_check [Increase::Models::CheckTransfer::PhysicalCheck, nil] - # @param routing_number [String] - # @param source_account_number_id [String, nil] - # @param status [Symbol, Increase::Models::CheckTransfer::Status] - # @param stop_payment_request [Increase::Models::CheckTransfer::StopPaymentRequest, nil] - # @param submission [Increase::Models::CheckTransfer::Submission, nil] - # @param third_party [Increase::Models::CheckTransfer::ThirdParty, nil] - # @param type [Symbol, Increase::Models::CheckTransfer::Type] + # @param id [String] The Check transfer's identifier. + # + # @param account_id [String] The identifier of the Account from which funds will be transferred. + # + # @param account_number [String] The account number printed on the check. + # + # @param amount [Integer] The transfer amount in USD cents. + # + # @param approval [Increase::Models::CheckTransfer::Approval, nil] If your account requires approvals for transfers and the transfer was approved, + # ... + # + # @param approved_inbound_check_deposit_id [String, nil] If the Check Transfer was successfully deposited, this will contain the identifi + # ... + # + # @param cancellation [Increase::Models::CheckTransfer::Cancellation, nil] If your account requires approvals for transfers and the transfer was not approv + # ... + # + # @param check_number [String] The check number printed on the check. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param created_by [Increase::Models::CheckTransfer::CreatedBy, nil] What object created the transfer, either via the API or the dashboard. + # + # @param currency [Symbol, Increase::Models::CheckTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's curr + # ... + # + # @param fulfillment_method [Symbol, Increase::Models::CheckTransfer::FulfillmentMethod] Whether Increase will print and mail the check or if you will do it yourself. + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param mailing [Increase::Models::CheckTransfer::Mailing, nil] If the check has been mailed by Increase, this will contain details of the shipm + # ... + # + # @param pending_transaction_id [String, nil] The ID for the pending transaction representing the transfer. A pending transact + # ... + # + # @param physical_check [Increase::Models::CheckTransfer::PhysicalCheck, nil] Details relating to the physical check that Increase will print and mail. Will b + # ... + # + # @param routing_number [String] The routing number printed on the check. + # + # @param source_account_number_id [String, nil] The identifier of the Account Number from which to send the transfer and print o + # ... + # + # @param status [Symbol, Increase::Models::CheckTransfer::Status] The lifecycle status of the transfer. + # + # @param stop_payment_request [Increase::Models::CheckTransfer::StopPaymentRequest, nil] After a stop-payment is requested on the check, this will contain supplemental d + # ... + # + # @param submission [Increase::Models::CheckTransfer::Submission, nil] After the transfer is submitted, this will contain supplemental details. + # + # @param third_party [Increase::Models::CheckTransfer::ThirdParty, nil] Details relating to the custom fulfillment you will perform. Will be present if + # ... + # + # @param type [Symbol, Increase::Models::CheckTransfer::Type] A constant representing the object's type. For this resource it will always be ` + # ... # @see Increase::Models::CheckTransfer#approval class Approval < Increase::Internal::Type::BaseModel @@ -203,11 +241,17 @@ class Approval < Increase::Internal::Type::BaseModel required :approved_by, String, nil?: true # @!method initialize(approved_at:, approved_by:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckTransfer::Approval} for more details. + # # If your account requires approvals for transfers and the transfer was approved, # this will contain details of the approval. # - # @param approved_at [Time] - # @param approved_by [String, nil] + # @param approved_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param approved_by [String, nil] If the Transfer was approved by a user in the dashboard, the email address of th + # ... end # @see Increase::Models::CheckTransfer#cancellation @@ -227,11 +271,17 @@ class Cancellation < Increase::Internal::Type::BaseModel required :canceled_by, String, nil?: true # @!method initialize(canceled_at:, canceled_by:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckTransfer::Cancellation} for more details. + # # If your account requires approvals for transfers and the transfer was not # approved, this will contain details of the cancellation. # - # @param canceled_at [Time] - # @param canceled_by [String, nil] + # @param canceled_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param canceled_by [String, nil] If the Transfer was canceled by a user in the dashboard, the email address of th + # ... end # @see Increase::Models::CheckTransfer#created_by @@ -265,10 +315,13 @@ class CreatedBy < Increase::Internal::Type::BaseModel # @!method initialize(api_key:, category:, oauth_application:, user:) # What object created the transfer, either via the API or the dashboard. # - # @param api_key [Increase::Models::CheckTransfer::CreatedBy::APIKey, nil] - # @param category [Symbol, Increase::Models::CheckTransfer::CreatedBy::Category] - # @param oauth_application [Increase::Models::CheckTransfer::CreatedBy::OAuthApplication, nil] - # @param user [Increase::Models::CheckTransfer::CreatedBy::User, nil] + # @param api_key [Increase::Models::CheckTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer. + # + # @param category [Symbol, Increase::Models::CheckTransfer::CreatedBy::Category] The type of object that created this transfer. + # + # @param oauth_application [Increase::Models::CheckTransfer::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer. + # + # @param user [Increase::Models::CheckTransfer::CreatedBy::User, nil] If present, details about the User that created the transfer. # @see Increase::Models::CheckTransfer::CreatedBy#api_key class APIKey < Increase::Internal::Type::BaseModel @@ -281,7 +334,7 @@ class APIKey < Increase::Internal::Type::BaseModel # @!method initialize(description:) # If present, details about the API key that created the transfer. # - # @param description [String, nil] + # @param description [String, nil] The description set for the API key when it was created. end # The type of object that created this transfer. @@ -314,7 +367,7 @@ class OAuthApplication < Increase::Internal::Type::BaseModel # @!method initialize(name:) # If present, details about the OAuth Application that created the transfer. # - # @param name [String] + # @param name [String] The name of the OAuth Application. end # @see Increase::Models::CheckTransfer::CreatedBy#user @@ -328,7 +381,7 @@ class User < Increase::Internal::Type::BaseModel # @!method initialize(email:) # If present, details about the User that created the transfer. # - # @param email [String] + # @param email [String] The email address of the User. end end @@ -400,12 +453,19 @@ class Mailing < Increase::Internal::Type::BaseModel required :tracking_number, String, nil?: true # @!method initialize(image_id:, mailed_at:, tracking_number:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckTransfer::Mailing} for more details. + # # If the check has been mailed by Increase, this will contain details of the # shipment. # - # @param image_id [String, nil] - # @param mailed_at [Time] - # @param tracking_number [String, nil] + # @param image_id [String, nil] The ID of the file corresponding to an image of the check that was mailed, if av + # ... + # + # @param mailed_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param tracking_number [String, nil] The tracking number of the shipment, if available for the shipping method. end # @see Increase::Models::CheckTransfer#physical_check @@ -469,18 +529,30 @@ class PhysicalCheck < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate] } # @!method initialize(attachment_file_id:, mailing_address:, memo:, note:, recipient_name:, return_address:, shipping_method:, signature_text:, tracking_updates:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckTransfer::PhysicalCheck} for more details. + # # Details relating to the physical check that Increase will print and mail. Will # be present if and only if `fulfillment_method` is equal to `physical_check`. # - # @param attachment_file_id [String, nil] - # @param mailing_address [Increase::Models::CheckTransfer::PhysicalCheck::MailingAddress] - # @param memo [String, nil] - # @param note [String, nil] - # @param recipient_name [String] - # @param return_address [Increase::Models::CheckTransfer::PhysicalCheck::ReturnAddress, nil] - # @param shipping_method [Symbol, Increase::Models::CheckTransfer::PhysicalCheck::ShippingMethod, nil] - # @param signature_text [String, nil] - # @param tracking_updates [Array] + # @param attachment_file_id [String, nil] The ID of the file for the check attachment. + # + # @param mailing_address [Increase::Models::CheckTransfer::PhysicalCheck::MailingAddress] Details for where Increase will mail the check. + # + # @param memo [String, nil] The descriptor that will be printed on the memo field on the check. + # + # @param note [String, nil] The descriptor that will be printed on the letter included with the check. + # + # @param recipient_name [String] The name that will be printed on the check. + # + # @param return_address [Increase::Models::CheckTransfer::PhysicalCheck::ReturnAddress, nil] The return address to be printed on the check. + # + # @param shipping_method [Symbol, Increase::Models::CheckTransfer::PhysicalCheck::ShippingMethod, nil] The shipping method for the check. + # + # @param signature_text [String, nil] The text that will appear as the signature on the check in cursive font. If blan + # ... + # + # @param tracking_updates [Array] Tracking updates relating to the physical check's delivery. # @see Increase::Models::CheckTransfer::PhysicalCheck#mailing_address class MailingAddress < Increase::Internal::Type::BaseModel @@ -523,12 +595,17 @@ class MailingAddress < Increase::Internal::Type::BaseModel # @!method initialize(city:, line1:, line2:, name:, postal_code:, state:) # Details for where Increase will mail the check. # - # @param city [String, nil] - # @param line1 [String, nil] - # @param line2 [String, nil] - # @param name [String, nil] - # @param postal_code [String, nil] - # @param state [String, nil] + # @param city [String, nil] The city of the check's destination. + # + # @param line1 [String, nil] The street address of the check's destination. + # + # @param line2 [String, nil] The second line of the address of the check's destination. + # + # @param name [String, nil] The name component of the check's mailing address. + # + # @param postal_code [String, nil] The postal code of the check's destination. + # + # @param state [String, nil] The state of the check's destination. end # @see Increase::Models::CheckTransfer::PhysicalCheck#return_address @@ -572,12 +649,17 @@ class ReturnAddress < Increase::Internal::Type::BaseModel # @!method initialize(city:, line1:, line2:, name:, postal_code:, state:) # The return address to be printed on the check. # - # @param city [String, nil] - # @param line1 [String, nil] - # @param line2 [String, nil] - # @param name [String, nil] - # @param postal_code [String, nil] - # @param state [String, nil] + # @param city [String, nil] The city of the check's destination. + # + # @param line1 [String, nil] The street address of the check's destination. + # + # @param line2 [String, nil] The second line of the address of the check's destination. + # + # @param name [String, nil] The name component of the check's return address. + # + # @param postal_code [String, nil] The postal code of the check's destination. + # + # @param state [String, nil] The state of the check's destination. end # The shipping method for the check. @@ -617,9 +699,16 @@ class TrackingUpdate < Increase::Internal::Type::BaseModel required :postal_code, String # @!method initialize(category:, created_at:, postal_code:) - # @param category [Symbol, Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate::Category] - # @param created_at [Time] - # @param postal_code [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate} for more + # details. + # + # @param category [Symbol, Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate::Category] The type of tracking event. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param postal_code [String] The postal code where the event took place. # The type of tracking event. # @@ -713,13 +802,20 @@ class StopPaymentRequest < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::CheckTransfer::StopPaymentRequest::Type } # @!method initialize(reason:, requested_at:, transfer_id:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckTransfer::StopPaymentRequest} for more details. + # # After a stop-payment is requested on the check, this will contain supplemental # details. # - # @param reason [Symbol, Increase::Models::CheckTransfer::StopPaymentRequest::Reason] - # @param requested_at [Time] - # @param transfer_id [String] - # @param type [Symbol, Increase::Models::CheckTransfer::StopPaymentRequest::Type] + # @param reason [Symbol, Increase::Models::CheckTransfer::StopPaymentRequest::Reason] The reason why this transfer was stopped. + # + # @param requested_at [Time] The time the stop-payment was requested. + # + # @param transfer_id [String] The ID of the check transfer that was stopped. + # + # @param type [Symbol, Increase::Models::CheckTransfer::StopPaymentRequest::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The reason why this transfer was stopped. # @@ -783,11 +879,18 @@ class Submission < Increase::Internal::Type::BaseModel required :submitted_at, Time # @!method initialize(address_correction_action:, submitted_address:, submitted_at:) + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckTransfer::Submission} for more details. + # # After the transfer is submitted, this will contain supplemental details. # - # @param address_correction_action [Symbol, Increase::Models::CheckTransfer::Submission::AddressCorrectionAction] - # @param submitted_address [Increase::Models::CheckTransfer::Submission::SubmittedAddress] - # @param submitted_at [Time] + # @param address_correction_action [Symbol, Increase::Models::CheckTransfer::Submission::AddressCorrectionAction] Per USPS requirements, Increase will standardize the address to USPS standards a + # ... + # + # @param submitted_address [Increase::Models::CheckTransfer::Submission::SubmittedAddress] The address we submitted to the printer. This is what is physically printed on t + # ... + # + # @param submitted_at [Time] When this check transfer was submitted to our check printer. # Per USPS requirements, Increase will standardize the address to USPS standards # and check it against the USPS National Change of Address (NCOA) database before @@ -856,12 +959,17 @@ class SubmittedAddress < Increase::Internal::Type::BaseModel # The address we submitted to the printer. This is what is physically printed on # the check. # - # @param city [String] - # @param line1 [String] - # @param line2 [String, nil] - # @param recipient_name [String] - # @param state [String] - # @param zip [String] + # @param city [String] The submitted address city. + # + # @param line1 [String] The submitted address line 1. + # + # @param line2 [String, nil] The submitted address line 2. + # + # @param recipient_name [String] The submitted recipient name. + # + # @param state [String] The submitted address state. + # + # @param zip [String] The submitted address zip. end end @@ -877,7 +985,7 @@ class ThirdParty < Increase::Internal::Type::BaseModel # Details relating to the custom fulfillment you will perform. Will be present if # and only if `fulfillment_method` is equal to `third_party`. # - # @param recipient_name [String, nil] + # @param recipient_name [String, nil] The name that you will print on the check. end # A constant representing the object's type. For this resource it will always be diff --git a/lib/increase/models/check_transfer_create_params.rb b/lib/increase/models/check_transfer_create_params.rb index d724b8ad8..aab2eaf13 100644 --- a/lib/increase/models/check_transfer_create_params.rb +++ b/lib/increase/models/check_transfer_create_params.rb @@ -55,13 +55,26 @@ class CheckTransferCreateParams < Increase::Internal::Type::BaseModel optional :third_party, -> { Increase::Models::CheckTransferCreateParams::ThirdParty } # @!method initialize(account_id:, amount:, fulfillment_method:, source_account_number_id:, physical_check: nil, require_approval: nil, third_party: nil, request_options: {}) - # @param account_id [String] - # @param amount [Integer] - # @param fulfillment_method [Symbol, Increase::Models::CheckTransferCreateParams::FulfillmentMethod] - # @param source_account_number_id [String] - # @param physical_check [Increase::Models::CheckTransferCreateParams::PhysicalCheck] - # @param require_approval [Boolean] - # @param third_party [Increase::Models::CheckTransferCreateParams::ThirdParty] + # 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 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. @@ -144,19 +157,35 @@ class PhysicalCheck < Increase::Internal::Type::BaseModel optional :signature_text, String # @!method initialize(mailing_address:, memo:, recipient_name:, attachment_file_id: nil, check_number: 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] - # @param memo [String] - # @param recipient_name [String] - # @param attachment_file_id [String] - # @param check_number [String] - # @param note [String] - # @param return_address [Increase::Models::CheckTransferCreateParams::PhysicalCheck::ReturnAddress] - # @param shipping_method [Symbol, Increase::Models::CheckTransferCreateParams::PhysicalCheck::ShippingMethod] - # @param signature_text [String] + # @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 check_number [String] The check number Increase should print on the check. This should not contain lea + # ... + # + # @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 @@ -193,11 +222,15 @@ class MailingAddress < Increase::Internal::Type::BaseModel # @!method initialize(city:, line1:, postal_code:, state:, line2: nil) # Details for where Increase will mail the check. # - # @param city [String] - # @param line1 [String] - # @param postal_code [String] - # @param state [String] - # @param line2 [String] + # @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 @@ -243,12 +276,17 @@ class ReturnAddress < Increase::Internal::Type::BaseModel # an Increase-owned address that will mark checks as delivery failed and shred # them. # - # @param city [String] - # @param line1 [String] - # @param name [String] - # @param postal_code [String] - # @param state [String] - # @param line2 [String] + # @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 @@ -279,11 +317,15 @@ class ThirdParty < Increase::Internal::Type::BaseModel 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] + # @param recipient_name [String] The pay-to name you will print on the check. If provided, this is used for [Posi + # ... end end end diff --git a/lib/increase/models/check_transfer_list_params.rb b/lib/increase/models/check_transfer_list_params.rb index cb4248bcc..c8e140488 100644 --- a/lib/increase/models/check_transfer_list_params.rb +++ b/lib/increase/models/check_transfer_list_params.rb @@ -46,12 +46,23 @@ class CheckTransferListParams < Increase::Internal::Type::BaseModel optional :status, -> { Increase::Models::CheckTransferListParams::Status } # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) - # @param account_id [String] + # 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] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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 @@ -84,10 +95,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # 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 @@ -102,7 +123,11 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckTransferListParams::Status} for more details. + # + # @param in_ [Array] Filter Check Transfers to those that have the specified status. For GET requests + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/check_transfer_stop_payment_params.rb b/lib/increase/models/check_transfer_stop_payment_params.rb index 0fab9d42a..c95d9fe28 100644 --- a/lib/increase/models/check_transfer_stop_payment_params.rb +++ b/lib/increase/models/check_transfer_stop_payment_params.rb @@ -14,7 +14,8 @@ class CheckTransferStopPaymentParams < Increase::Internal::Type::BaseModel optional :reason, enum: -> { Increase::Models::CheckTransferStopPaymentParams::Reason } # @!method initialize(reason: nil, request_options: {}) - # @param reason [Symbol, Increase::Models::CheckTransferStopPaymentParams::Reason] + # @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. diff --git a/lib/increase/models/declined_transaction.rb b/lib/increase/models/declined_transaction.rb index 8ce0f278f..4126ef218 100644 --- a/lib/increase/models/declined_transaction.rb +++ b/lib/increase/models/declined_transaction.rb @@ -75,20 +75,38 @@ class DeclinedTransaction < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::DeclinedTransaction::Type } # @!method initialize(id:, account_id:, amount:, created_at:, currency:, description:, route_id:, route_type:, source:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::DeclinedTransaction} for more details. + # # Declined Transactions are refused additions and removals of money from your bank # account. For example, Declined Transactions are caused when your Account has an # insufficient balance or your Limits are triggered. # - # @param id [String] - # @param account_id [String] - # @param amount [Integer] - # @param created_at [Time] - # @param currency [Symbol, Increase::Models::DeclinedTransaction::Currency] - # @param description [String] - # @param route_id [String, nil] - # @param route_type [Symbol, Increase::Models::DeclinedTransaction::RouteType, nil] - # @param source [Increase::Models::DeclinedTransaction::Source] - # @param type [Symbol, Increase::Models::DeclinedTransaction::Type] + # @param id [String] The Declined Transaction identifier. + # + # @param account_id [String] The identifier for the Account the Declined Transaction belongs to. + # + # @param amount [Integer] The Declined Transaction amount in the minor unit of its currency. For dollars, + # ... + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transac + # ... + # + # @param currency [Symbol, Increase::Models::DeclinedTransaction::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined Tra + # ... + # + # @param description [String] This is the description the vendor provides. + # + # @param route_id [String, nil] The identifier for the route this Declined Transaction came through. Routes are + # ... + # + # @param route_type [Symbol, Increase::Models::DeclinedTransaction::RouteType, nil] The type of the route this Declined Transaction came through. + # + # @param source [Increase::Models::DeclinedTransaction::Source] This is an object giving more details on the network-level event that caused the + # ... + # + # @param type [Symbol, Increase::Models::DeclinedTransaction::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined # Transaction's currency. This will match the currency on the Declined @@ -203,20 +221,38 @@ class Source < Increase::Internal::Type::BaseModel required :wire_decline, -> { Increase::Models::DeclinedTransaction::Source::WireDecline }, nil?: true # @!method initialize(ach_decline:, card_decline:, category:, check_decline:, check_deposit_rejection:, inbound_real_time_payments_transfer_decline:, other:, wire_decline:) + # Some parameter documentations has been truncated, see + # {Increase::Models::DeclinedTransaction::Source} for more details. + # # This is an object giving more details on the network-level event that caused the # Declined Transaction. For example, for a card transaction this lists the # merchant's industry and location. Note that for backwards compatibility reasons, # additional undocumented keys may appear in this object. These should be treated # as deprecated and will be removed in the future. # - # @param ach_decline [Increase::Models::DeclinedTransaction::Source::ACHDecline, nil] - # @param card_decline [Increase::Models::DeclinedTransaction::Source::CardDecline, nil] - # @param category [Symbol, Increase::Models::DeclinedTransaction::Source::Category] - # @param check_decline [Increase::Models::DeclinedTransaction::Source::CheckDecline, nil] - # @param check_deposit_rejection [Increase::Models::DeclinedTransaction::Source::CheckDepositRejection, nil] - # @param inbound_real_time_payments_transfer_decline [Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline, nil] - # @param other [Object, nil] - # @param wire_decline [Increase::Models::DeclinedTransaction::Source::WireDecline, nil] + # @param ach_decline [Increase::Models::DeclinedTransaction::Source::ACHDecline, nil] An ACH Decline object. This field will be present in the JSON response if and on + # ... + # + # @param card_decline [Increase::Models::DeclinedTransaction::Source::CardDecline, nil] A Card Decline object. This field will be present in the JSON response if and on + # ... + # + # @param category [Symbol, Increase::Models::DeclinedTransaction::Source::Category] The type of the resource. We may add additional possible values for this enum ov + # ... + # + # @param check_decline [Increase::Models::DeclinedTransaction::Source::CheckDecline, nil] A Check Decline object. This field will be present in the JSON response if and o + # ... + # + # @param check_deposit_rejection [Increase::Models::DeclinedTransaction::Source::CheckDepositRejection, nil] A Check Deposit Rejection object. This field will be present in the JSON respons + # ... + # + # @param inbound_real_time_payments_transfer_decline [Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline, nil] An Inbound Real-Time Payments Transfer Decline object. This field will be presen + # ... + # + # @param other [Object, nil] If the category of this Transaction source is equal to `other`, this field will + # ... + # + # @param wire_decline [Increase::Models::DeclinedTransaction::Source::WireDecline, nil] A Wire Decline object. This field will be present in the JSON response if and on + # ... # @see Increase::Models::DeclinedTransaction::Source#ach_decline class ACHDecline < Increase::Internal::Type::BaseModel @@ -294,21 +330,36 @@ class ACHDecline < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::DeclinedTransaction::Source::ACHDecline::Type } # @!method initialize(id:, amount:, inbound_ach_transfer_id:, originator_company_descriptive_date:, originator_company_discretionary_data:, originator_company_id:, originator_company_name:, reason:, receiver_id_number:, receiver_name:, trace_number:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::DeclinedTransaction::Source::ACHDecline} for more details. + # # An ACH Decline object. This field will be present in the JSON response if and # only if `category` is equal to `ach_decline`. # - # @param id [String] - # @param amount [Integer] - # @param inbound_ach_transfer_id [String] - # @param originator_company_descriptive_date [String, nil] - # @param originator_company_discretionary_data [String, nil] - # @param originator_company_id [String] - # @param originator_company_name [String] - # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::ACHDecline::Reason] - # @param receiver_id_number [String, nil] - # @param receiver_name [String, nil] - # @param trace_number [String] - # @param type [Symbol, Increase::Models::DeclinedTransaction::Source::ACHDecline::Type] + # @param id [String] The ACH Decline's identifier. + # + # @param amount [Integer] The declined amount in USD cents. + # + # @param inbound_ach_transfer_id [String] The identifier of the Inbound ACH Transfer object associated with this decline. + # + # @param originator_company_descriptive_date [String, nil] The descriptive date of the transfer. + # + # @param originator_company_discretionary_data [String, nil] The additional information included with the transfer. + # + # @param originator_company_id [String] The identifier of the company that initiated the transfer. + # + # @param originator_company_name [String] The name of the company that initiated the transfer. + # + # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::ACHDecline::Reason] Why the ACH transfer was declined. + # + # @param receiver_id_number [String, nil] The id of the receiver of the transfer. + # + # @param receiver_name [String, nil] The name of the receiver of the transfer. + # + # @param trace_number [String] The trace number of the transfer. + # + # @param type [Symbol, Increase::Models::DeclinedTransaction::Source::ACHDecline::Type] A constant representing the object's type. For this resource it will always be ` + # ... # Why the ACH transfer was declined. # @@ -572,36 +623,81 @@ class CardDecline < Increase::Internal::Type::BaseModel required :verification, -> { Increase::Models::DeclinedTransaction::Source::CardDecline::Verification } # @!method initialize(id:, actioner:, amount:, card_payment_id:, currency:, declined_transaction_id:, digital_wallet_token_id:, direction:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, real_time_decision_reason:, reason:, terminal_id:, verification:) + # Some parameter documentations has been truncated, see + # {Increase::Models::DeclinedTransaction::Source::CardDecline} for more details. + # # A Card Decline object. This field will be present in the JSON response if and # only if `category` is equal to `card_decline`. # - # @param id [String] - # @param actioner [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Actioner] - # @param amount [Integer] - # @param card_payment_id [String] - # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Currency] - # @param declined_transaction_id [String] - # @param digital_wallet_token_id [String, nil] - # @param direction [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Direction] - # @param merchant_acceptor_id [String] - # @param merchant_category_code [String] - # @param merchant_city [String, nil] - # @param merchant_country [String] - # @param merchant_descriptor [String] - # @param merchant_postal_code [String, nil] - # @param merchant_state [String, nil] - # @param network_details [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails] - # @param network_identifiers [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkIdentifiers] - # @param network_risk_score [Integer, nil] - # @param physical_card_id [String, nil] - # @param presentment_amount [Integer] - # @param presentment_currency [String] - # @param processing_category [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::ProcessingCategory] - # @param real_time_decision_id [String, nil] - # @param real_time_decision_reason [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::RealTimeDecisionReason, nil] - # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Reason] - # @param terminal_id [String, nil] - # @param verification [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification] + # @param id [String] The Card Decline identifier. + # + # @param actioner [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Actioner] Whether this authorization was approved by Increase, the card network through st + # ... + # + # @param amount [Integer] The declined amount in the minor unit of the destination account currency. For d + # ... + # + # @param card_payment_id [String] The ID of the Card Payment this transaction belongs to. + # + # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination + # ... + # + # @param declined_transaction_id [String] The identifier of the declined transaction created for this Card Decline. + # + # @param digital_wallet_token_id [String, nil] If the authorization was made via a Digital Wallet Token (such as an Apple Pay p + # ... + # + # @param direction [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Direction] The direction describes the direction the funds will move, either from the cardh + # ... + # + # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i + # ... + # + # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car + # ... + # + # @param merchant_city [String, nil] The city the merchant resides in. + # + # @param merchant_country [String] The country the merchant resides in. + # + # @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with. + # + # @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is either a 5-digit or 9-digit + # ... + # + # @param merchant_state [String, nil] The state the merchant resides in. + # + # @param network_details [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails] Fields specific to the `network`. + # + # @param network_identifiers [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction. + # + # @param network_risk_score [Integer, nil] The risk score generated by the card network. For Visa this is the Visa Advanced + # ... + # + # @param physical_card_id [String, nil] If the authorization was made in-person with a physical card, the Physical Card + # ... + # + # @param presentment_amount [Integer] The declined amount in the minor unit of the transaction's presentment currency. + # ... + # + # @param presentment_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param processing_category [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::ProcessingCategory] The processing category describes the intent behind the authorization, such as w + # ... + # + # @param real_time_decision_id [String, nil] The identifier of the Real-Time Decision sent to approve or decline this transac + # ... + # + # @param real_time_decision_reason [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::RealTimeDecisionReason, nil] This is present if a specific decline reason was given in the real-time decision + # ... + # + # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Reason] Why the transaction was declined. + # + # @param terminal_id [String, nil] The terminal identifier (commonly abbreviated as TID) of the terminal the card i + # ... + # + # @param verification [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification] Fields related to verification of cardholder-provided values. # Whether this authorization was approved by Increase, the card network through # stand-in processing, or the user through a real-time decision. @@ -689,8 +785,9 @@ class NetworkDetails < Increase::Internal::Type::BaseModel # @!method initialize(category:, visa:) # Fields specific to the `network`. # - # @param category [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Category] - # @param visa [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa, nil] + # @param category [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Category] The payment network used to process this card authorization. + # + # @param visa [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa, nil] Fields specific to the `visa` network. # The payment network used to process this card authorization. # @@ -736,11 +833,20 @@ class Visa < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:) + # Some parameter documentations has been truncated, see + # {Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa} + # for more details. + # # Fields specific to the `visa` network. # - # @param electronic_commerce_indicator [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] - # @param point_of_service_entry_mode [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::PointOfServiceEntryMode, nil] - # @param stand_in_processing_reason [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::StandInProcessingReason, nil] + # @param electronic_commerce_indicator [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] For electronic commerce transactions, this identifies the level of security used + # ... + # + # @param point_of_service_entry_mode [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::PointOfServiceEntryMode, nil] The method used to enter the cardholder's primary account number and card expira + # ... + # + # @param stand_in_processing_reason [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::StandInProcessingReason, nil] Only present when `actioner: network`. Describes why a card authorization was ap + # ... # For electronic commerce transactions, this identifies the level of security used # in obtaining the customer's payment credential. For mail or telephone order @@ -881,11 +987,20 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel required :transaction_id, String, nil?: true # @!method initialize(retrieval_reference_number:, trace_number:, transaction_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkIdentifiers} + # for more details. + # # Network-specific identifiers for a specific request or transaction. # - # @param retrieval_reference_number [String, nil] - # @param trace_number [String, nil] - # @param transaction_id [String, nil] + # @param retrieval_reference_number [String, nil] A life-cycle identifier used across e.g., an authorization and a reversal. Expec + # ... + # + # @param trace_number [String, nil] A counter used to verify an individual authorization. Expected to be unique per + # ... + # + # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro + # ... end # The processing category describes the intent behind the authorization, such as @@ -1029,10 +1144,17 @@ class Verification < Increase::Internal::Type::BaseModel -> { Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress } # @!method initialize(card_verification_code:, cardholder_address:) + # Some parameter documentations has been truncated, see + # {Increase::Models::DeclinedTransaction::Source::CardDecline::Verification} for + # more details. + # # Fields related to verification of cardholder-provided values. # - # @param card_verification_code [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardVerificationCode] - # @param cardholder_address [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress] + # @param card_verification_code [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardVerificationCode] Fields related to verification of the Card Verification Code, a 3-digit code on + # ... + # + # @param cardholder_address [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress] Cardholder address provided in the authorization request and the address on file + # ... # @see Increase::Models::DeclinedTransaction::Source::CardDecline::Verification#card_verification_code class CardVerificationCode < Increase::Internal::Type::BaseModel @@ -1047,7 +1169,7 @@ class CardVerificationCode < Increase::Internal::Type::BaseModel # Fields related to verification of the Card Verification Code, a 3-digit code on # the back of the card. # - # @param result [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardVerificationCode::Result] + # @param result [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardVerificationCode::Result] The result of verifying the Card Verification Code. # The result of verifying the Card Verification Code. # @@ -1104,14 +1226,23 @@ class CardholderAddress < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress::Result } # @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:) + # Some parameter documentations has been truncated, see + # {Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress} + # for more details. + # # Cardholder address provided in the authorization request and the address on file # we verified it against. # - # @param actual_line1 [String, nil] - # @param actual_postal_code [String, nil] - # @param provided_line1 [String, nil] - # @param provided_postal_code [String, nil] - # @param result [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress::Result] + # @param actual_line1 [String, nil] Line 1 of the address on file for the cardholder. + # + # @param actual_postal_code [String, nil] The postal code of the address on file for the cardholder. + # + # @param provided_line1 [String, nil] The cardholder address line 1 provided for verification in the authorization req + # ... + # + # @param provided_postal_code [String, nil] The postal code provided for verification in the authorization request. + # + # @param result [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress::Result] The address verification result returned to the card network. # The address verification result returned to the card network. # @@ -1225,16 +1356,29 @@ class CheckDecline < Increase::Internal::Type::BaseModel required :reason, enum: -> { Increase::Models::DeclinedTransaction::Source::CheckDecline::Reason } # @!method initialize(amount:, auxiliary_on_us:, back_image_file_id:, check_transfer_id:, front_image_file_id:, inbound_check_deposit_id:, reason:) + # Some parameter documentations has been truncated, see + # {Increase::Models::DeclinedTransaction::Source::CheckDecline} for more details. + # # A Check Decline object. This field will be present in the JSON response if and # only if `category` is equal to `check_decline`. # - # @param amount [Integer] - # @param auxiliary_on_us [String, nil] - # @param back_image_file_id [String, nil] - # @param check_transfer_id [String, nil] - # @param front_image_file_id [String, nil] - # @param inbound_check_deposit_id [String, nil] - # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDecline::Reason] + # @param amount [Integer] The declined amount in USD cents. + # + # @param auxiliary_on_us [String, nil] A computer-readable number printed on the MICR line of business checks, usually + # ... + # + # @param back_image_file_id [String, nil] The identifier of the API File object containing an image of the back of the dec + # ... + # + # @param check_transfer_id [String, nil] The identifier of the Check Transfer object associated with this decline. + # + # @param front_image_file_id [String, nil] The identifier of the API File object containing an image of the front of the de + # ... + # + # @param inbound_check_deposit_id [String, nil] The identifier of the Inbound Check Deposit object associated with this decline. + # ... + # + # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDecline::Reason] Why the check was declined. # Why the check was declined. # @@ -1342,15 +1486,27 @@ class CheckDepositRejection < Increase::Internal::Type::BaseModel required :rejected_at, Time # @!method initialize(amount:, check_deposit_id:, currency:, declined_transaction_id:, reason:, rejected_at:) + # Some parameter documentations has been truncated, see + # {Increase::Models::DeclinedTransaction::Source::CheckDepositRejection} for more + # details. + # # A Check Deposit Rejection object. This field will be present in the JSON # response if and only if `category` is equal to `check_deposit_rejection`. # - # @param amount [Integer] - # @param check_deposit_id [String] - # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDepositRejection::Currency] - # @param declined_transaction_id [String] - # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDepositRejection::Reason] - # @param rejected_at [Time] + # @param amount [Integer] The rejected amount in the minor unit of check's currency. For dollars, for exam + # ... + # + # @param check_deposit_id [String] The identifier of the Check Deposit that was rejected. + # + # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDepositRejection::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's curr + # ... + # + # @param declined_transaction_id [String] The identifier of the associated declined transaction. + # + # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDepositRejection::Reason] Why the check deposit was rejected. + # + # @param rejected_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's # currency. @@ -1493,20 +1649,35 @@ class InboundRealTimePaymentsTransferDecline < Increase::Internal::Type::BaseMod required :transfer_id, String # @!method initialize(amount:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, reason:, remittance_information:, transaction_identification:, transfer_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline} + # for more details. + # # An Inbound Real-Time Payments Transfer Decline object. This field will be # present in the JSON response if and only if `category` is equal to # `inbound_real_time_payments_transfer_decline`. # - # @param amount [Integer] - # @param creditor_name [String] - # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline::Currency] - # @param debtor_account_number [String] - # @param debtor_name [String] - # @param debtor_routing_number [String] - # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline::Reason] - # @param remittance_information [String, nil] - # @param transaction_identification [String] - # @param transfer_id [String] + # @param amount [Integer] The declined amount in the minor unit of the destination account currency. For d + # ... + # + # @param creditor_name [String] The name the sender of the transfer specified as the recipient of the transfer. + # + # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined tran + # ... + # + # @param debtor_account_number [String] The account number of the account that sent the transfer. + # + # @param debtor_name [String] The name provided by the sender of the transfer. + # + # @param debtor_routing_number [String] The routing number of the account that sent the transfer. + # + # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline::Reason] Why the transfer was declined. + # + # @param remittance_information [String, nil] Additional information included with the transfer. + # + # @param transaction_identification [String] The Real-Time Payments network identification of the declined transfer. + # + # @param transfer_id [String] The identifier of the Real-Time Payments Transfer that led to this Transaction. # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined # transfer's currency. This will always be "USD" for a Real-Time Payments @@ -1585,8 +1756,9 @@ class WireDecline < Increase::Internal::Type::BaseModel # A Wire Decline object. This field will be present in the JSON response if and # only if `category` is equal to `wire_decline`. # - # @param inbound_wire_transfer_id [String] - # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::WireDecline::Reason] + # @param inbound_wire_transfer_id [String] The identifier of the Inbound Wire Transfer that was declined. + # + # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::WireDecline::Reason] Why the wire transfer was declined. # Why the wire transfer was declined. # diff --git a/lib/increase/models/declined_transaction_list_params.rb b/lib/increase/models/declined_transaction_list_params.rb index 989ca54f8..8425fc4c8 100644 --- a/lib/increase/models/declined_transaction_list_params.rb +++ b/lib/increase/models/declined_transaction_list_params.rb @@ -43,12 +43,22 @@ class DeclinedTransactionListParams < Increase::Internal::Type::BaseModel optional :route_id, String # @!method initialize(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, request_options: {}) - # @param account_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::DeclinedTransactionListParams} for more details. + # + # @param account_id [String] Filter Declined Transactions to ones belonging to the specified Account. + # # @param category [Increase::Models::DeclinedTransactionListParams::Category] + # # @param created_at [Increase::Models::DeclinedTransactionListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] - # @param route_id [String] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # + # @param route_id [String] Filter Declined Transactions to those belonging to the specified route. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Category < Increase::Internal::Type::BaseModel @@ -62,7 +72,11 @@ class Category < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::DeclinedTransactionListParams::Category} for more details. + # + # @param in_ [Array] Return results whose value is in the provided list. For GET requests, this shoul + # ... module In extend Increase::Internal::Type::Enum @@ -123,10 +137,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::DeclinedTransactionListParams::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 diff --git a/lib/increase/models/digital_card_profile.rb b/lib/increase/models/digital_card_profile.rb index 223ebca5b..c441f74fd 100644 --- a/lib/increase/models/digital_card_profile.rb +++ b/lib/increase/models/digital_card_profile.rb @@ -93,24 +93,43 @@ class DigitalCardProfile < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::DigitalCardProfile::Type } # @!method initialize(id:, app_icon_file_id:, background_image_file_id:, card_description:, contact_email:, contact_phone:, contact_website:, created_at:, description:, idempotency_key:, issuer_name:, status:, text_color:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::DigitalCardProfile} for more details. + # # This contains artwork and metadata relating to a Card's appearance in digital # wallet apps like Apple Pay and Google Pay. For more information, see our guide # on [digital card artwork](https://increase.com/documentation/card-art). # - # @param id [String] - # @param app_icon_file_id [String] - # @param background_image_file_id [String] - # @param card_description [String] - # @param contact_email [String, nil] - # @param contact_phone [String, nil] - # @param contact_website [String, nil] - # @param created_at [Time] - # @param description [String] - # @param idempotency_key [String, nil] - # @param issuer_name [String] - # @param status [Symbol, Increase::Models::DigitalCardProfile::Status] - # @param text_color [Increase::Models::DigitalCardProfile::TextColor] - # @param type [Symbol, Increase::Models::DigitalCardProfile::Type] + # @param id [String] The Card Profile identifier. + # + # @param app_icon_file_id [String] The identifier of the File containing the card's icon image. + # + # @param background_image_file_id [String] The identifier of the File containing the card's front image. + # + # @param card_description [String] A user-facing description for the card itself. + # + # @param contact_email [String, nil] An email address the user can contact to receive support for their card. + # + # @param contact_phone [String, nil] A phone number the user can contact to receive support for their card. + # + # @param contact_website [String, nil] A website the user can visit to view and receive support for their card. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param description [String] A description you can use to identify the Card Profile. + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param issuer_name [String] A user-facing description for whoever is issuing the card. + # + # @param status [Symbol, Increase::Models::DigitalCardProfile::Status] The status of the Card Profile. + # + # @param text_color [Increase::Models::DigitalCardProfile::TextColor] The Card's text color, specified as an RGB triple. + # + # @param type [Symbol, Increase::Models::DigitalCardProfile::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The status of the Card Profile. # @@ -157,9 +176,11 @@ class TextColor < Increase::Internal::Type::BaseModel # @!method initialize(blue:, green:, red:) # The Card's text color, specified as an RGB triple. # - # @param blue [Integer] - # @param green [Integer] - # @param red [Integer] + # @param blue [Integer] The value of the blue channel in the RGB color. + # + # @param green [Integer] The value of the green channel in the RGB color. + # + # @param red [Integer] The value of the red channel in the RGB color. end # A constant representing the object's type. For this resource it will always be diff --git a/lib/increase/models/digital_card_profile_clone_params.rb b/lib/increase/models/digital_card_profile_clone_params.rb index 364c1924a..2299e421e 100644 --- a/lib/increase/models/digital_card_profile_clone_params.rb +++ b/lib/increase/models/digital_card_profile_clone_params.rb @@ -62,15 +62,24 @@ class DigitalCardProfileCloneParams < Increase::Internal::Type::BaseModel optional :text_color, -> { Increase::Models::DigitalCardProfileCloneParams::TextColor } # @!method initialize(app_icon_file_id: nil, background_image_file_id: nil, card_description: nil, contact_email: nil, contact_phone: nil, contact_website: nil, description: nil, issuer_name: nil, text_color: nil, request_options: {}) - # @param app_icon_file_id [String] - # @param background_image_file_id [String] - # @param card_description [String] - # @param contact_email [String] - # @param contact_phone [String] - # @param contact_website [String] - # @param description [String] - # @param issuer_name [String] - # @param text_color [Increase::Models::DigitalCardProfileCloneParams::TextColor] + # @param app_icon_file_id [String] The identifier of the File containing the card's icon image. + # + # @param background_image_file_id [String] The identifier of the File containing the card's front image. + # + # @param card_description [String] A user-facing description for the card itself. + # + # @param contact_email [String] An email address the user can contact to receive support for their card. + # + # @param contact_phone [String] A phone number the user can contact to receive support for their card. + # + # @param contact_website [String] A website the user can visit to view and receive support for their card. + # + # @param description [String] A description you can use to identify the Card Profile. + # + # @param issuer_name [String] A user-facing description for whoever is issuing the card. + # + # @param text_color [Increase::Models::DigitalCardProfileCloneParams::TextColor] The Card's text color, specified as an RGB triple. The default is white. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class TextColor < Increase::Internal::Type::BaseModel @@ -95,9 +104,11 @@ class TextColor < Increase::Internal::Type::BaseModel # @!method initialize(blue:, green:, red:) # The Card's text color, specified as an RGB triple. The default is white. # - # @param blue [Integer] - # @param green [Integer] - # @param red [Integer] + # @param blue [Integer] The value of the blue channel in the RGB color. + # + # @param green [Integer] The value of the green channel in the RGB color. + # + # @param red [Integer] The value of the red channel in the RGB color. end end end diff --git a/lib/increase/models/digital_card_profile_create_params.rb b/lib/increase/models/digital_card_profile_create_params.rb index 0d09ede28..6e37048d0 100644 --- a/lib/increase/models/digital_card_profile_create_params.rb +++ b/lib/increase/models/digital_card_profile_create_params.rb @@ -62,15 +62,24 @@ class DigitalCardProfileCreateParams < Increase::Internal::Type::BaseModel optional :text_color, -> { Increase::Models::DigitalCardProfileCreateParams::TextColor } # @!method initialize(app_icon_file_id:, background_image_file_id:, card_description:, description:, issuer_name:, contact_email: nil, contact_phone: nil, contact_website: nil, text_color: nil, request_options: {}) - # @param app_icon_file_id [String] - # @param background_image_file_id [String] - # @param card_description [String] - # @param description [String] - # @param issuer_name [String] - # @param contact_email [String] - # @param contact_phone [String] - # @param contact_website [String] - # @param text_color [Increase::Models::DigitalCardProfileCreateParams::TextColor] + # @param app_icon_file_id [String] The identifier of the File containing the card's icon image. + # + # @param background_image_file_id [String] The identifier of the File containing the card's front image. + # + # @param card_description [String] A user-facing description for the card itself. + # + # @param description [String] A description you can use to identify the Card Profile. + # + # @param issuer_name [String] A user-facing description for whoever is issuing the card. + # + # @param contact_email [String] An email address the user can contact to receive support for their card. + # + # @param contact_phone [String] A phone number the user can contact to receive support for their card. + # + # @param contact_website [String] A website the user can visit to view and receive support for their card. + # + # @param text_color [Increase::Models::DigitalCardProfileCreateParams::TextColor] The Card's text color, specified as an RGB triple. The default is white. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class TextColor < Increase::Internal::Type::BaseModel @@ -95,9 +104,11 @@ class TextColor < Increase::Internal::Type::BaseModel # @!method initialize(blue:, green:, red:) # The Card's text color, specified as an RGB triple. The default is white. # - # @param blue [Integer] - # @param green [Integer] - # @param red [Integer] + # @param blue [Integer] The value of the blue channel in the RGB color. + # + # @param green [Integer] The value of the green channel in the RGB color. + # + # @param red [Integer] The value of the red channel in the RGB color. end end end diff --git a/lib/increase/models/digital_card_profile_list_params.rb b/lib/increase/models/digital_card_profile_list_params.rb index c20e660b0..c2aa1e575 100644 --- a/lib/increase/models/digital_card_profile_list_params.rb +++ b/lib/increase/models/digital_card_profile_list_params.rb @@ -35,10 +35,19 @@ class DigitalCardProfileListParams < Increase::Internal::Type::BaseModel optional :status, -> { Increase::Models::DigitalCardProfileListParams::Status } # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # Some parameter documentations has been truncated, see + # {Increase::Models::DigitalCardProfileListParams} for more details. + # + # @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::DigitalCardProfileListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Status < Increase::Internal::Type::BaseModel @@ -53,7 +62,11 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::DigitalCardProfileListParams::Status} for more details. + # + # @param in_ [Array] Filter Digital Card Profiles for those with the specified digital wallet status + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/digital_wallet_token.rb b/lib/increase/models/digital_wallet_token.rb index 3d5aaea6f..e55b9c139 100644 --- a/lib/increase/models/digital_wallet_token.rb +++ b/lib/increase/models/digital_wallet_token.rb @@ -61,19 +61,32 @@ class DigitalWalletToken < Increase::Internal::Type::BaseModel required :updates, -> { Increase::Internal::Type::ArrayOf[Increase::Models::DigitalWalletToken::Update] } # @!method initialize(id:, card_id:, cardholder:, created_at:, device:, status:, token_requestor:, type:, updates:) + # Some parameter documentations has been truncated, see + # {Increase::Models::DigitalWalletToken} for more details. + # # A Digital Wallet Token is created when a user adds a Card to their Apple Pay or # Google Pay app. The Digital Wallet Token can be used for purchases just like a # Card. # - # @param id [String] - # @param card_id [String] - # @param cardholder [Increase::Models::DigitalWalletToken::Cardholder] - # @param created_at [Time] - # @param device [Increase::Models::DigitalWalletToken::Device] - # @param status [Symbol, Increase::Models::DigitalWalletToken::Status] - # @param token_requestor [Symbol, Increase::Models::DigitalWalletToken::TokenRequestor] - # @param type [Symbol, Increase::Models::DigitalWalletToken::Type] - # @param updates [Array] + # @param id [String] The Digital Wallet Token identifier. + # + # @param card_id [String] The identifier for the Card this Digital Wallet Token belongs to. + # + # @param cardholder [Increase::Models::DigitalWalletToken::Cardholder] The cardholder information given when the Digital Wallet Token was created. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param device [Increase::Models::DigitalWalletToken::Device] The device that was used to create the Digital Wallet Token. + # + # @param status [Symbol, Increase::Models::DigitalWalletToken::Status] This indicates if payments can be made with the Digital Wallet Token. + # + # @param token_requestor [Symbol, Increase::Models::DigitalWalletToken::TokenRequestor] The digital wallet app being used. + # + # @param type [Symbol, Increase::Models::DigitalWalletToken::Type] A constant representing the object's type. For this resource it will always be ` + # ... + # + # @param updates [Array] Updates to the Digital Wallet Token. # @see Increase::Models::DigitalWalletToken#cardholder class Cardholder < Increase::Internal::Type::BaseModel @@ -86,7 +99,7 @@ class Cardholder < Increase::Internal::Type::BaseModel # @!method initialize(name:) # The cardholder information given when the Digital Wallet Token was created. # - # @param name [String, nil] + # @param name [String, nil] Name of the cardholder, for example "John Smith". end # @see Increase::Models::DigitalWalletToken#device @@ -118,10 +131,13 @@ class Device < Increase::Internal::Type::BaseModel # @!method initialize(device_type:, identifier:, ip_address:, name:) # The device that was used to create the Digital Wallet Token. # - # @param device_type [Symbol, Increase::Models::DigitalWalletToken::Device::DeviceType, nil] - # @param identifier [String, nil] - # @param ip_address [String, nil] - # @param name [String, nil] + # @param device_type [Symbol, Increase::Models::DigitalWalletToken::Device::DeviceType, nil] Device type. + # + # @param identifier [String, nil] ID assigned to the device by the digital wallet provider. + # + # @param ip_address [String, nil] IP address of the device. + # + # @param name [String, nil] Name of the device, for example "My Work Phone". # Device type. # @@ -233,8 +249,13 @@ class Update < Increase::Internal::Type::BaseModel required :timestamp, Time # @!method initialize(status:, timestamp:) - # @param status [Symbol, Increase::Models::DigitalWalletToken::Update::Status] - # @param timestamp [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::DigitalWalletToken::Update} for more details. + # + # @param status [Symbol, Increase::Models::DigitalWalletToken::Update::Status] The status the update changed this Digital Wallet Token to. + # + # @param timestamp [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... # The status the update changed this Digital Wallet Token to. # diff --git a/lib/increase/models/digital_wallet_token_list_params.rb b/lib/increase/models/digital_wallet_token_list_params.rb index 3b54867d7..7fa58ce9f 100644 --- a/lib/increase/models/digital_wallet_token_list_params.rb +++ b/lib/increase/models/digital_wallet_token_list_params.rb @@ -32,10 +32,18 @@ class DigitalWalletTokenListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(card_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) - # @param card_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::DigitalWalletTokenListParams} for more details. + # + # @param card_id [String] Filter Digital Wallet Tokens to ones belonging to the specified Card. + # # @param created_at [Increase::Models::DigitalWalletTokenListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @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 @@ -68,10 +76,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::DigitalWalletTokenListParams::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 diff --git a/lib/increase/models/document.rb b/lib/increase/models/document.rb index f9144be04..fea48b6e1 100644 --- a/lib/increase/models/document.rb +++ b/lib/increase/models/document.rb @@ -43,15 +43,25 @@ class Document < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::Document::Type } # @!method initialize(id:, category:, created_at:, entity_id:, file_id:, 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] - # @param category [Symbol, Increase::Models::Document::Category] - # @param created_at [Time] - # @param entity_id [String, nil] - # @param file_id [String] - # @param type [Symbol, Increase::Models::Document::Type] + # @param id [String] The Document identifier. + # + # @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 type [Symbol, Increase::Models::Document::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The type of document. # diff --git a/lib/increase/models/document_list_params.rb b/lib/increase/models/document_list_params.rb index 380da924b..de7e8848f 100644 --- a/lib/increase/models/document_list_params.rb +++ b/lib/increase/models/document_list_params.rb @@ -37,11 +37,20 @@ class DocumentListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(category: nil, created_at: nil, cursor: nil, entity_id: 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] - # @param entity_id [String] - # @param limit [Integer] + # + # @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 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 @@ -56,7 +65,11 @@ class Category < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::DocumentListParams::Category} for more details. + # + # @param in_ [Array] Filter Documents for those with the specified category or categories. For GET re + # ... module In extend Increase::Internal::Type::Enum @@ -108,10 +121,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # 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 diff --git a/lib/increase/models/entity.rb b/lib/increase/models/entity.rb index 19a4e5e59..9cbb32815 100644 --- a/lib/increase/models/entity.rb +++ b/lib/increase/models/entity.rb @@ -107,24 +107,52 @@ class Entity < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::Entity::Type } # @!method initialize(id:, corporation:, created_at:, description:, details_confirmed_at:, government_authority:, idempotency_key:, joint:, natural_person:, status:, structure:, supplemental_documents:, third_party_verification:, trust:, type:) + # Some parameter documentations has been truncated, see {Increase::Models::Entity} + # for more details. + # # Entities are the legal entities that own accounts. They can be people, # corporations, partnerships, government authorities, or trusts. # - # @param id [String] - # @param corporation [Increase::Models::Entity::Corporation, nil] - # @param created_at [Time] - # @param description [String, nil] - # @param details_confirmed_at [Time, nil] - # @param government_authority [Increase::Models::Entity::GovernmentAuthority, nil] - # @param idempotency_key [String, nil] - # @param joint [Increase::Models::Entity::Joint, nil] - # @param natural_person [Increase::Models::Entity::NaturalPerson, nil] - # @param status [Symbol, Increase::Models::Entity::Status] - # @param structure [Symbol, Increase::Models::Entity::Structure] - # @param supplemental_documents [Array] - # @param third_party_verification [Increase::Models::Entity::ThirdPartyVerification, nil] - # @param trust [Increase::Models::Entity::Trust, nil] - # @param type [Symbol, Increase::Models::Entity::Type] + # @param id [String] The entity's identifier. + # + # @param corporation [Increase::Models::Entity::Corporation, nil] Details of the corporation entity. Will be present if `structure` is equal to `c + # ... + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity + # ... + # + # @param description [String, nil] The entity's description for display purposes. + # + # @param details_confirmed_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity' + # ... + # + # @param government_authority [Increase::Models::Entity::GovernmentAuthority, nil] Details of the government authority entity. Will be present if `structure` is eq + # ... + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param joint [Increase::Models::Entity::Joint, nil] Details of the joint entity. Will be present if `structure` is equal to `joint`. + # ... + # + # @param natural_person [Increase::Models::Entity::NaturalPerson, nil] Details of the natural person entity. Will be present if `structure` is equal to + # ... + # + # @param status [Symbol, Increase::Models::Entity::Status] The status of the entity. + # + # @param structure [Symbol, Increase::Models::Entity::Structure] The entity's legal structure. + # + # @param supplemental_documents [Array] Additional documentation associated with the entity. This is limited to the firs + # ... + # + # @param third_party_verification [Increase::Models::Entity::ThirdPartyVerification, nil] A reference to data stored in a third-party verification service. Your integrati + # ... + # + # @param trust [Increase::Models::Entity::Trust, nil] Details of the trust entity. Will be present if `structure` is equal to `trust`. + # ... + # + # @param type [Symbol, Increase::Models::Entity::Type] A constant representing the object's type. For this resource it will always be ` + # ... # @see Increase::Models::Entity#corporation class Corporation < Increase::Internal::Type::BaseModel @@ -175,16 +203,28 @@ class Corporation < Increase::Internal::Type::BaseModel required :website, String, nil?: true # @!method initialize(address:, beneficial_owners:, incorporation_state:, industry_code:, name:, tax_identifier:, website:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Entity::Corporation} for more details. + # # Details of the corporation entity. Will be present if `structure` is equal to # `corporation`. # - # @param address [Increase::Models::Entity::Corporation::Address] - # @param beneficial_owners [Array] - # @param incorporation_state [String, nil] - # @param industry_code [String, nil] - # @param name [String] - # @param tax_identifier [String, nil] - # @param website [String, nil] + # @param address [Increase::Models::Entity::Corporation::Address] The corporation's address. + # + # @param beneficial_owners [Array] The identifying details of anyone controlling or owning 25% or more of the corpo + # ... + # + # @param incorporation_state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the corporat + # ... + # + # @param industry_code [String, nil] The numeric North American Industry Classification System (NAICS) code submitted + # ... + # + # @param name [String] The legal name of the corporation. + # + # @param tax_identifier [String, nil] The Employer Identification Number (EIN) for the corporation. + # + # @param website [String, nil] The website of the corporation. # @see Increase::Models::Entity::Corporation#address class Address < Increase::Internal::Type::BaseModel @@ -220,13 +260,21 @@ class Address < Increase::Internal::Type::BaseModel required :zip, String # @!method initialize(city:, line1:, line2:, state:, zip:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Entity::Corporation::Address} for more details. + # # The corporation's address. # - # @param city [String] - # @param line1 [String] - # @param line2 [String, nil] - # @param state [String] - # @param zip [String] + # @param city [String] The city of the address. + # + # @param line1 [String] The first line of the address. + # + # @param line2 [String, nil] The second line of the address. + # + # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of + # ... + # + # @param zip [String] The ZIP code of the address. end class BeneficialOwner < Increase::Internal::Type::BaseModel @@ -255,10 +303,13 @@ class BeneficialOwner < Increase::Internal::Type::BaseModel required :prong, enum: -> { Increase::Models::Entity::Corporation::BeneficialOwner::Prong } # @!method initialize(beneficial_owner_id:, company_title:, individual:, prong:) - # @param beneficial_owner_id [String] - # @param company_title [String, nil] - # @param individual [Increase::Models::Entity::Corporation::BeneficialOwner::Individual] - # @param prong [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Prong] + # @param beneficial_owner_id [String] The identifier of this beneficial owner. + # + # @param company_title [String, nil] This person's role or title within the entity. + # + # @param individual [Increase::Models::Entity::Corporation::BeneficialOwner::Individual] Personal details for the beneficial owner. + # + # @param prong [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Prong] Why this person is considered a beneficial owner of the entity. # @see Increase::Models::Entity::Corporation::BeneficialOwner#individual class Individual < Increase::Internal::Type::BaseModel @@ -290,10 +341,13 @@ class Individual < Increase::Internal::Type::BaseModel # @!method initialize(address:, date_of_birth:, identification:, name:) # Personal details for the beneficial owner. # - # @param address [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address] - # @param date_of_birth [Date] - # @param identification [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification] - # @param name [String] + # @param address [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address] The person's address. + # + # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format. + # + # @param identification [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification] A means of verifying the person's identity. + # + # @param name [String] The person's legal name. # @see Increase::Models::Entity::Corporation::BeneficialOwner::Individual#address class Address < Increase::Internal::Type::BaseModel @@ -335,14 +389,24 @@ class Address < Increase::Internal::Type::BaseModel required :zip, String, nil?: true # @!method initialize(city:, country:, line1:, line2:, state:, zip:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address} + # for more details. + # # The person's address. # - # @param city [String, nil] - # @param country [String] - # @param line1 [String] - # @param line2 [String, nil] - # @param state [String, nil] - # @param zip [String, nil] + # @param city [String, nil] The city, district, town, or village of the address. + # + # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address. + # + # @param line1 [String] The first line of the address. + # + # @param line2 [String, nil] The second line of the address. + # + # @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state + # ... + # + # @param zip [String, nil] The ZIP or postal code of the address. end # @see Increase::Models::Entity::Corporation::BeneficialOwner::Individual#identification @@ -363,10 +427,16 @@ class Identification < Increase::Internal::Type::BaseModel required :number_last4, String # @!method initialize(method_:, number_last4:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification} + # for more details. + # # A means of verifying the person's identity. # - # @param method_ [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification::Method] - # @param number_last4 [String] + # @param method_ [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification::Method] A method that can be used to verify the individual's identity. + # + # @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in + # ... # A method that can be used to verify the individual's identity. # @@ -456,12 +526,17 @@ class GovernmentAuthority < Increase::Internal::Type::BaseModel # Details of the government authority entity. Will be present if `structure` is # equal to `government_authority`. # - # @param address [Increase::Models::Entity::GovernmentAuthority::Address] - # @param authorized_persons [Array] - # @param category [Symbol, Increase::Models::Entity::GovernmentAuthority::Category] - # @param name [String] - # @param tax_identifier [String, nil] - # @param website [String, nil] + # @param address [Increase::Models::Entity::GovernmentAuthority::Address] The government authority's address. + # + # @param authorized_persons [Array] The identifying details of authorized persons of the government authority. + # + # @param category [Symbol, Increase::Models::Entity::GovernmentAuthority::Category] The category of the government authority. + # + # @param name [String] The government authority's name. + # + # @param tax_identifier [String, nil] The Employer Identification Number (EIN) of the government authority. + # + # @param website [String, nil] The government authority's website. # @see Increase::Models::Entity::GovernmentAuthority#address class Address < Increase::Internal::Type::BaseModel @@ -497,13 +572,21 @@ class Address < Increase::Internal::Type::BaseModel required :zip, String # @!method initialize(city:, line1:, line2:, state:, zip:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Entity::GovernmentAuthority::Address} for more details. + # # The government authority's address. # - # @param city [String] - # @param line1 [String] - # @param line2 [String, nil] - # @param state [String] - # @param zip [String] + # @param city [String] The city of the address. + # + # @param line1 [String] The first line of the address. + # + # @param line2 [String, nil] The second line of the address. + # + # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of + # ... + # + # @param zip [String] The ZIP code of the address. end class AuthorizedPerson < Increase::Internal::Type::BaseModel @@ -520,8 +603,9 @@ class AuthorizedPerson < Increase::Internal::Type::BaseModel required :name, String # @!method initialize(authorized_person_id:, name:) - # @param authorized_person_id [String] - # @param name [String] + # @param authorized_person_id [String] The identifier of this authorized person. + # + # @param name [String] The person's legal name. end # The category of the government authority. @@ -556,8 +640,9 @@ class Joint < Increase::Internal::Type::BaseModel # @!method initialize(individuals:, name:) # Details of the joint entity. Will be present if `structure` is equal to `joint`. # - # @param individuals [Array] - # @param name [String] + # @param individuals [Array] The two individuals that share control of the entity. + # + # @param name [String] The entity's name. class Individual < Increase::Internal::Type::BaseModel # @!attribute address @@ -585,10 +670,13 @@ class Individual < Increase::Internal::Type::BaseModel required :name, String # @!method initialize(address:, date_of_birth:, identification:, name:) - # @param address [Increase::Models::Entity::Joint::Individual::Address] - # @param date_of_birth [Date] - # @param identification [Increase::Models::Entity::Joint::Individual::Identification] - # @param name [String] + # @param address [Increase::Models::Entity::Joint::Individual::Address] The person's address. + # + # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format. + # + # @param identification [Increase::Models::Entity::Joint::Individual::Identification] A means of verifying the person's identity. + # + # @param name [String] The person's legal name. # @see Increase::Models::Entity::Joint::Individual#address class Address < Increase::Internal::Type::BaseModel @@ -624,13 +712,21 @@ class Address < Increase::Internal::Type::BaseModel required :zip, String # @!method initialize(city:, line1:, line2:, state:, zip:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Entity::Joint::Individual::Address} for more details. + # # The person's address. # - # @param city [String] - # @param line1 [String] - # @param line2 [String, nil] - # @param state [String] - # @param zip [String] + # @param city [String] The city of the address. + # + # @param line1 [String] The first line of the address. + # + # @param line2 [String, nil] The second line of the address. + # + # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of + # ... + # + # @param zip [String] The ZIP code of the address. end # @see Increase::Models::Entity::Joint::Individual#identification @@ -651,10 +747,15 @@ class Identification < Increase::Internal::Type::BaseModel required :number_last4, String # @!method initialize(method_:, number_last4:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Entity::Joint::Individual::Identification} for more details. + # # A means of verifying the person's identity. # - # @param method_ [Symbol, Increase::Models::Entity::Joint::Individual::Identification::Method] - # @param number_last4 [String] + # @param method_ [Symbol, Increase::Models::Entity::Joint::Individual::Identification::Method] A method that can be used to verify the individual's identity. + # + # @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in + # ... # A method that can be used to verify the individual's identity. # @@ -714,10 +815,13 @@ class NaturalPerson < Increase::Internal::Type::BaseModel # Details of the natural person entity. Will be present if `structure` is equal to # `natural_person`. # - # @param address [Increase::Models::Entity::NaturalPerson::Address] - # @param date_of_birth [Date] - # @param identification [Increase::Models::Entity::NaturalPerson::Identification] - # @param name [String] + # @param address [Increase::Models::Entity::NaturalPerson::Address] The person's address. + # + # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format. + # + # @param identification [Increase::Models::Entity::NaturalPerson::Identification] A means of verifying the person's identity. + # + # @param name [String] The person's legal name. # @see Increase::Models::Entity::NaturalPerson#address class Address < Increase::Internal::Type::BaseModel @@ -753,13 +857,21 @@ class Address < Increase::Internal::Type::BaseModel required :zip, String # @!method initialize(city:, line1:, line2:, state:, zip:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Entity::NaturalPerson::Address} for more details. + # # The person's address. # - # @param city [String] - # @param line1 [String] - # @param line2 [String, nil] - # @param state [String] - # @param zip [String] + # @param city [String] The city of the address. + # + # @param line1 [String] The first line of the address. + # + # @param line2 [String, nil] The second line of the address. + # + # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of + # ... + # + # @param zip [String] The ZIP code of the address. end # @see Increase::Models::Entity::NaturalPerson#identification @@ -780,10 +892,15 @@ class Identification < Increase::Internal::Type::BaseModel required :number_last4, String # @!method initialize(method_:, number_last4:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Entity::NaturalPerson::Identification} for more details. + # # A means of verifying the person's identity. # - # @param method_ [Symbol, Increase::Models::Entity::NaturalPerson::Identification::Method] - # @param number_last4 [String] + # @param method_ [Symbol, Increase::Models::Entity::NaturalPerson::Identification::Method] A method that can be used to verify the individual's identity. + # + # @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in + # ... # A method that can be used to verify the individual's identity. # @@ -874,8 +991,9 @@ class ThirdPartyVerification < Increase::Internal::Type::BaseModel # A reference to data stored in a third-party verification service. Your # integration may or may not use this field. # - # @param reference [String] - # @param vendor [Symbol, Increase::Models::Entity::ThirdPartyVerification::Vendor] + # @param reference [String] The reference identifier for the third party verification. + # + # @param vendor [Symbol, Increase::Models::Entity::ThirdPartyVerification::Vendor] The vendor that was used to perform the verification. # The vendor that was used to perform the verification. # @@ -946,16 +1064,27 @@ class Trust < Increase::Internal::Type::BaseModel required :trustees, -> { Increase::Internal::Type::ArrayOf[Increase::Models::Entity::Trust::Trustee] } # @!method initialize(address:, category:, formation_document_file_id:, formation_state:, grantor:, name:, tax_identifier:, trustees:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Entity::Trust} for more details. + # # Details of the trust entity. Will be present if `structure` is equal to `trust`. # - # @param address [Increase::Models::Entity::Trust::Address] - # @param category [Symbol, Increase::Models::Entity::Trust::Category] - # @param formation_document_file_id [String, nil] - # @param formation_state [String, nil] - # @param grantor [Increase::Models::Entity::Trust::Grantor, nil] - # @param name [String] - # @param tax_identifier [String, nil] - # @param trustees [Array] + # @param address [Increase::Models::Entity::Trust::Address] The trust's address. + # + # @param category [Symbol, Increase::Models::Entity::Trust::Category] Whether the trust is `revocable` or `irrevocable`. + # + # @param formation_document_file_id [String, nil] The ID for the File containing the formation document of the trust. + # + # @param formation_state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the state in + # ... + # + # @param grantor [Increase::Models::Entity::Trust::Grantor, nil] The grantor of the trust. Will be present if the `category` is `revocable`. + # + # @param name [String] The trust's name. + # + # @param tax_identifier [String, nil] The Employer Identification Number (EIN) of the trust itself. + # + # @param trustees [Array] The trustees of the trust. # @see Increase::Models::Entity::Trust#address class Address < Increase::Internal::Type::BaseModel @@ -991,13 +1120,21 @@ class Address < Increase::Internal::Type::BaseModel required :zip, String # @!method initialize(city:, line1:, line2:, state:, zip:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Entity::Trust::Address} for more details. + # # The trust's address. # - # @param city [String] - # @param line1 [String] - # @param line2 [String, nil] - # @param state [String] - # @param zip [String] + # @param city [String] The city of the address. + # + # @param line1 [String] The first line of the address. + # + # @param line2 [String, nil] The second line of the address. + # + # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of + # ... + # + # @param zip [String] The ZIP code of the address. end # Whether the trust is `revocable` or `irrevocable`. @@ -1045,10 +1182,13 @@ class Grantor < Increase::Internal::Type::BaseModel # @!method initialize(address:, date_of_birth:, identification:, name:) # The grantor of the trust. Will be present if the `category` is `revocable`. # - # @param address [Increase::Models::Entity::Trust::Grantor::Address] - # @param date_of_birth [Date] - # @param identification [Increase::Models::Entity::Trust::Grantor::Identification] - # @param name [String] + # @param address [Increase::Models::Entity::Trust::Grantor::Address] The person's address. + # + # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format. + # + # @param identification [Increase::Models::Entity::Trust::Grantor::Identification] A means of verifying the person's identity. + # + # @param name [String] The person's legal name. # @see Increase::Models::Entity::Trust::Grantor#address class Address < Increase::Internal::Type::BaseModel @@ -1084,13 +1224,21 @@ class Address < Increase::Internal::Type::BaseModel required :zip, String # @!method initialize(city:, line1:, line2:, state:, zip:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Entity::Trust::Grantor::Address} for more details. + # # The person's address. # - # @param city [String] - # @param line1 [String] - # @param line2 [String, nil] - # @param state [String] - # @param zip [String] + # @param city [String] The city of the address. + # + # @param line1 [String] The first line of the address. + # + # @param line2 [String, nil] The second line of the address. + # + # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of + # ... + # + # @param zip [String] The ZIP code of the address. end # @see Increase::Models::Entity::Trust::Grantor#identification @@ -1111,10 +1259,15 @@ class Identification < Increase::Internal::Type::BaseModel required :number_last4, String # @!method initialize(method_:, number_last4:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Entity::Trust::Grantor::Identification} for more details. + # # A means of verifying the person's identity. # - # @param method_ [Symbol, Increase::Models::Entity::Trust::Grantor::Identification::Method] - # @param number_last4 [String] + # @param method_ [Symbol, Increase::Models::Entity::Trust::Grantor::Identification::Method] A method that can be used to verify the individual's identity. + # + # @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in + # ... # A method that can be used to verify the individual's identity. # @@ -1158,8 +1311,13 @@ class Trustee < Increase::Internal::Type::BaseModel required :structure, enum: -> { Increase::Models::Entity::Trust::Trustee::Structure } # @!method initialize(individual:, structure:) - # @param individual [Increase::Models::Entity::Trust::Trustee::Individual, nil] - # @param structure [Symbol, Increase::Models::Entity::Trust::Trustee::Structure] + # Some parameter documentations has been truncated, see + # {Increase::Models::Entity::Trust::Trustee} for more details. + # + # @param individual [Increase::Models::Entity::Trust::Trustee::Individual, nil] The individual trustee of the trust. Will be present if the trustee's `structure + # ... + # + # @param structure [Symbol, Increase::Models::Entity::Trust::Trustee::Structure] The structure of the trustee. Will always be equal to `individual`. # @see Increase::Models::Entity::Trust::Trustee#individual class Individual < Increase::Internal::Type::BaseModel @@ -1191,10 +1349,13 @@ class Individual < Increase::Internal::Type::BaseModel # The individual trustee of the trust. Will be present if the trustee's # `structure` is equal to `individual`. # - # @param address [Increase::Models::Entity::Trust::Trustee::Individual::Address] - # @param date_of_birth [Date] - # @param identification [Increase::Models::Entity::Trust::Trustee::Individual::Identification] - # @param name [String] + # @param address [Increase::Models::Entity::Trust::Trustee::Individual::Address] The person's address. + # + # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format. + # + # @param identification [Increase::Models::Entity::Trust::Trustee::Individual::Identification] A means of verifying the person's identity. + # + # @param name [String] The person's legal name. # @see Increase::Models::Entity::Trust::Trustee::Individual#address class Address < Increase::Internal::Type::BaseModel @@ -1230,13 +1391,22 @@ class Address < Increase::Internal::Type::BaseModel required :zip, String # @!method initialize(city:, line1:, line2:, state:, zip:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Entity::Trust::Trustee::Individual::Address} for more + # details. + # # The person's address. # - # @param city [String] - # @param line1 [String] - # @param line2 [String, nil] - # @param state [String] - # @param zip [String] + # @param city [String] The city of the address. + # + # @param line1 [String] The first line of the address. + # + # @param line2 [String, nil] The second line of the address. + # + # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of + # ... + # + # @param zip [String] The ZIP code of the address. end # @see Increase::Models::Entity::Trust::Trustee::Individual#identification @@ -1257,10 +1427,16 @@ class Identification < Increase::Internal::Type::BaseModel required :number_last4, String # @!method initialize(method_:, number_last4:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Entity::Trust::Trustee::Individual::Identification} for more + # details. + # # A means of verifying the person's identity. # - # @param method_ [Symbol, Increase::Models::Entity::Trust::Trustee::Individual::Identification::Method] - # @param number_last4 [String] + # @param method_ [Symbol, Increase::Models::Entity::Trust::Trustee::Individual::Identification::Method] A method that can be used to verify the individual's identity. + # + # @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in + # ... # A method that can be used to verify the individual's identity. # diff --git a/lib/increase/models/entity_archive_beneficial_owner_params.rb b/lib/increase/models/entity_archive_beneficial_owner_params.rb index 56673ce37..46feaa7d6 100644 --- a/lib/increase/models/entity_archive_beneficial_owner_params.rb +++ b/lib/increase/models/entity_archive_beneficial_owner_params.rb @@ -15,7 +15,12 @@ class EntityArchiveBeneficialOwnerParams < Increase::Internal::Type::BaseModel required :beneficial_owner_id, String # @!method initialize(beneficial_owner_id:, request_options: {}) - # @param beneficial_owner_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityArchiveBeneficialOwnerParams} for more details. + # + # @param beneficial_owner_id [String] The identifying details of anyone controlling or owning 25% or more of the corpo + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/entity_confirm_params.rb b/lib/increase/models/entity_confirm_params.rb index cf2afb604..192277f58 100644 --- a/lib/increase/models/entity_confirm_params.rb +++ b/lib/increase/models/entity_confirm_params.rb @@ -15,7 +15,12 @@ class EntityConfirmParams < Increase::Internal::Type::BaseModel optional :confirmed_at, Time # @!method initialize(confirmed_at: nil, request_options: {}) - # @param confirmed_at [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityConfirmParams} for more details. + # + # @param confirmed_at [Time] When your user confirmed the Entity's details. If not provided, the current time + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/entity_create_beneficial_owner_params.rb b/lib/increase/models/entity_create_beneficial_owner_params.rb index 5f21ee5ab..079754748 100644 --- a/lib/increase/models/entity_create_beneficial_owner_params.rb +++ b/lib/increase/models/entity_create_beneficial_owner_params.rb @@ -15,7 +15,12 @@ class EntityCreateBeneficialOwnerParams < Increase::Internal::Type::BaseModel required :beneficial_owner, -> { Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner } # @!method initialize(beneficial_owner:, request_options: {}) - # @param beneficial_owner [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner] + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateBeneficialOwnerParams} for more details. + # + # @param beneficial_owner [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner] The identifying details of anyone controlling or owning 25% or more of the corpo + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class BeneficialOwner < Increase::Internal::Type::BaseModel @@ -42,12 +47,19 @@ class BeneficialOwner < Increase::Internal::Type::BaseModel optional :company_title, String # @!method initialize(individual:, prongs:, company_title: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner} for more + # details. + # # The identifying details of anyone controlling or owning 25% or more of the # corporation. # - # @param individual [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual] - # @param prongs [Array] - # @param company_title [String] + # @param individual [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual] Personal details for the beneficial owner. + # + # @param prongs [Array] Why this person is considered a beneficial owner of the entity. At least one opt + # ... + # + # @param company_title [String] This person's role or title within the entity. # @see Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner#individual class Individual < Increase::Internal::Type::BaseModel @@ -88,13 +100,23 @@ class Individual < Increase::Internal::Type::BaseModel optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual} + # for more details. + # # Personal details for the beneficial owner. # - # @param address [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Address] - # @param date_of_birth [Date] - # @param identification [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification] - # @param name [String] - # @param confirmed_no_us_tax_id [Boolean] + # @param address [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM + # ... + # + # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format. + # + # @param identification [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification] A means of verifying the person's identity. + # + # @param name [String] The person's legal name. + # + # @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic + # ... # @see Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual#address class Address < Increase::Internal::Type::BaseModel @@ -137,15 +159,26 @@ class Address < Increase::Internal::Type::BaseModel optional :zip, String # @!method initialize(country:, line1:, city: nil, line2: nil, state: nil, zip: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Address} + # for more details. + # # The individual's physical address. Mail receiving locations like PO Boxes and # PMB's are disallowed. # - # @param country [String] - # @param line1 [String] - # @param city [String] - # @param line2 [String] - # @param state [String] - # @param zip [String] + # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address. + # + # @param line1 [String] The first line of the address. This is usually the street number and street. + # + # @param city [String] The city, district, town, or village of the address. Required in certain countri + # ... + # + # @param line2 [String] The second line of the address. This might be the floor or room number. + # + # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the US state + # ... + # + # @param zip [String] The ZIP or postal code of the address. Required in certain countries. end # @see Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual#identification @@ -190,13 +223,25 @@ class Identification < Increase::Internal::Type::BaseModel -> { Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Passport } # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification} + # for more details. + # # A means of verifying the person's identity. # - # @param method_ [Symbol, Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Method] - # @param number [String] - # @param drivers_license [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::DriversLicense] - # @param other [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Other] - # @param passport [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Passport] + # @param method_ [Symbol, Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Method] A method that can be used to verify the individual's identity. + # + # @param number [String] An identification number that can be used to verify the individual's identity, s + # ... + # + # @param drivers_license [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::DriversLicense] Information about the United States driver's license used for identification. Re + # ... + # + # @param other [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Other] Information about the identification document provided. Required if `method` is + # ... + # + # @param passport [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Passport] Information about the passport used for identification. Required if `method` is + # ... # A method that can be used to verify the individual's identity. # @@ -253,10 +298,13 @@ class DriversLicense < Increase::Internal::Type::BaseModel # Information about the United States driver's license used for identification. # Required if `method` is equal to `drivers_license`. # - # @param expiration_date [Date] - # @param file_id [String] - # @param state [String] - # @param back_file_id [String] + # @param expiration_date [Date] The driver's license's expiration date in YYYY-MM-DD format. + # + # @param file_id [String] The identifier of the File containing the front of the driver's license. + # + # @param state [String] The state that issued the provided driver's license. + # + # @param back_file_id [String] The identifier of the File containing the back of the driver's license. end # @see Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification#other @@ -294,14 +342,24 @@ class Other < Increase::Internal::Type::BaseModel optional :expiration_date, Date # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Other} + # for more details. + # # Information about the identification document provided. Required if `method` is # equal to `other`. # - # @param country [String] - # @param description [String] - # @param file_id [String] - # @param back_file_id [String] - # @param expiration_date [Date] + # @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum + # ... + # + # @param description [String] A description of the document submitted. + # + # @param file_id [String] The identifier of the File containing the front of the document. + # + # @param back_file_id [String] The identifier of the File containing the back of the document. Not every docume + # ... + # + # @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format. end # @see Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification#passport @@ -328,9 +386,11 @@ class Passport < Increase::Internal::Type::BaseModel # Information about the passport used for identification. Required if `method` is # equal to `passport`. # - # @param country [String] - # @param expiration_date [Date] - # @param file_id [String] + # @param country [String] The country that issued the passport. + # + # @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format. + # + # @param file_id [String] The identifier of the File containing the passport. end end end diff --git a/lib/increase/models/entity_create_params.rb b/lib/increase/models/entity_create_params.rb index 281167439..5dafd3ee0 100644 --- a/lib/increase/models/entity_create_params.rb +++ b/lib/increase/models/entity_create_params.rb @@ -71,15 +71,33 @@ class EntityCreateParams < Increase::Internal::Type::BaseModel optional :trust, -> { Increase::Models::EntityCreateParams::Trust } # @!method initialize(structure:, corporation: nil, description: nil, government_authority: nil, joint: nil, natural_person: nil, supplemental_documents: nil, third_party_verification: nil, trust: nil, request_options: {}) - # @param structure [Symbol, Increase::Models::EntityCreateParams::Structure] - # @param corporation [Increase::Models::EntityCreateParams::Corporation] - # @param description [String] - # @param government_authority [Increase::Models::EntityCreateParams::GovernmentAuthority] - # @param joint [Increase::Models::EntityCreateParams::Joint] - # @param natural_person [Increase::Models::EntityCreateParams::NaturalPerson] - # @param supplemental_documents [Array] - # @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] - # @param trust [Increase::Models::EntityCreateParams::Trust] + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams} for more details. + # + # @param structure [Symbol, Increase::Models::EntityCreateParams::Structure] The type of Entity to create. + # + # @param corporation [Increase::Models::EntityCreateParams::Corporation] Details of the corporation entity to create. Required if `structure` is equal to + # ... + # + # @param description [String] The description you choose to give the entity. + # + # @param government_authority [Increase::Models::EntityCreateParams::GovernmentAuthority] Details of the Government Authority entity to create. Required if `structure` is + # ... + # + # @param joint [Increase::Models::EntityCreateParams::Joint] Details of the joint entity to create. Required if `structure` is equal to `join + # ... + # + # @param natural_person [Increase::Models::EntityCreateParams::NaturalPerson] Details of the natural person entity to create. Required if `structure` is equal + # ... + # + # @param supplemental_documents [Array] Additional documentation associated with the entity. + # + # @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] A reference to data stored in a third-party verification service. Your integrati + # ... + # + # @param trust [Increase::Models::EntityCreateParams::Trust] Details of the trust entity to create. Required if `structure` is equal to `trus + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The type of Entity to create. @@ -166,17 +184,32 @@ class Corporation < Increase::Internal::Type::BaseModel optional :website, String # @!method initialize(address:, beneficial_owners:, name:, tax_identifier:, beneficial_ownership_exemption_reason: nil, incorporation_state: nil, industry_code: nil, website: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Corporation} for more details. + # # Details of the corporation entity to create. Required if `structure` is equal to # `corporation`. # - # @param address [Increase::Models::EntityCreateParams::Corporation::Address] - # @param beneficial_owners [Array] - # @param name [String] - # @param tax_identifier [String] - # @param beneficial_ownership_exemption_reason [Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason] - # @param incorporation_state [String] - # @param industry_code [String] - # @param website [String] + # @param address [Increase::Models::EntityCreateParams::Corporation::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's + # ... + # + # @param beneficial_owners [Array] The identifying details of each person who owns 25% or more of the business and + # ... + # + # @param name [String] The legal name of the corporation. + # + # @param tax_identifier [String] The Employer Identification Number (EIN) for the corporation. + # + # @param beneficial_ownership_exemption_reason [Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason] If the entity is exempt from the requirement to submit beneficial owners, provid + # ... + # + # @param incorporation_state [String] The two-letter United States Postal Service (USPS) abbreviation for the corporat + # ... + # + # @param industry_code [String] The North American Industry Classification System (NAICS) code for the corporati + # ... + # + # @param website [String] The website of the corporation. # @see Increase::Models::EntityCreateParams::Corporation#address class Address < Increase::Internal::Type::BaseModel @@ -212,14 +245,22 @@ class Address < Increase::Internal::Type::BaseModel optional :line2, String # @!method initialize(city:, line1:, state:, zip:, line2: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Corporation::Address} for more details. + # # The entity's physical address. Mail receiving locations like PO Boxes and PMB's # are disallowed. # - # @param city [String] - # @param line1 [String] - # @param state [String] - # @param zip [String] - # @param line2 [String] + # @param city [String] The city of the address. + # + # @param line1 [String] The first line of the address. This is usually the street number and street. + # + # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of + # ... + # + # @param zip [String] The ZIP code of the address. + # + # @param line2 [String] The second line of the address. This might be the floor or room number. end class BeneficialOwner < Increase::Internal::Type::BaseModel @@ -246,9 +287,16 @@ class BeneficialOwner < Increase::Internal::Type::BaseModel optional :company_title, String # @!method initialize(individual:, prongs:, company_title: nil) - # @param individual [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual] - # @param prongs [Array] - # @param company_title [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Corporation::BeneficialOwner} for more + # details. + # + # @param individual [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual] Personal details for the beneficial owner. + # + # @param prongs [Array] Why this person is considered a beneficial owner of the entity. At least one opt + # ... + # + # @param company_title [String] This person's role or title within the entity. # @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner#individual class Individual < Increase::Internal::Type::BaseModel @@ -289,13 +337,23 @@ class Individual < Increase::Internal::Type::BaseModel optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual} + # for more details. + # # Personal details for the beneficial owner. # - # @param address [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address] - # @param date_of_birth [Date] - # @param identification [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification] - # @param name [String] - # @param confirmed_no_us_tax_id [Boolean] + # @param address [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM + # ... + # + # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format. + # + # @param identification [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification] A means of verifying the person's identity. + # + # @param name [String] The person's legal name. + # + # @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic + # ... # @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual#address class Address < Increase::Internal::Type::BaseModel @@ -338,15 +396,26 @@ class Address < Increase::Internal::Type::BaseModel optional :zip, String # @!method initialize(country:, line1:, city: nil, line2: nil, state: nil, zip: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address} + # for more details. + # # The individual's physical address. Mail receiving locations like PO Boxes and # PMB's are disallowed. # - # @param country [String] - # @param line1 [String] - # @param city [String] - # @param line2 [String] - # @param state [String] - # @param zip [String] + # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address. + # + # @param line1 [String] The first line of the address. This is usually the street number and street. + # + # @param city [String] The city, district, town, or village of the address. Required in certain countri + # ... + # + # @param line2 [String] The second line of the address. This might be the floor or room number. + # + # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the US state + # ... + # + # @param zip [String] The ZIP or postal code of the address. Required in certain countries. end # @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual#identification @@ -391,13 +460,25 @@ class Identification < Increase::Internal::Type::BaseModel -> { Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport } # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification} + # for more details. + # # A means of verifying the person's identity. # - # @param method_ [Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method] - # @param number [String] - # @param drivers_license [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::DriversLicense] - # @param other [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other] - # @param passport [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport] + # @param method_ [Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method] A method that can be used to verify the individual's identity. + # + # @param number [String] An identification number that can be used to verify the individual's identity, s + # ... + # + # @param drivers_license [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::DriversLicense] Information about the United States driver's license used for identification. Re + # ... + # + # @param other [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other] Information about the identification document provided. Required if `method` is + # ... + # + # @param passport [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport] Information about the passport used for identification. Required if `method` is + # ... # A method that can be used to verify the individual's identity. # @@ -454,10 +535,13 @@ class DriversLicense < Increase::Internal::Type::BaseModel # Information about the United States driver's license used for identification. # Required if `method` is equal to `drivers_license`. # - # @param expiration_date [Date] - # @param file_id [String] - # @param state [String] - # @param back_file_id [String] + # @param expiration_date [Date] The driver's license's expiration date in YYYY-MM-DD format. + # + # @param file_id [String] The identifier of the File containing the front of the driver's license. + # + # @param state [String] The state that issued the provided driver's license. + # + # @param back_file_id [String] The identifier of the File containing the back of the driver's license. end # @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification#other @@ -495,14 +579,24 @@ class Other < Increase::Internal::Type::BaseModel optional :expiration_date, Date # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other} + # for more details. + # # Information about the identification document provided. Required if `method` is # equal to `other`. # - # @param country [String] - # @param description [String] - # @param file_id [String] - # @param back_file_id [String] - # @param expiration_date [Date] + # @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum + # ... + # + # @param description [String] A description of the document submitted. + # + # @param file_id [String] The identifier of the File containing the front of the document. + # + # @param back_file_id [String] The identifier of the File containing the back of the document. Not every docume + # ... + # + # @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format. end # @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification#passport @@ -529,9 +623,11 @@ class Passport < Increase::Internal::Type::BaseModel # Information about the passport used for identification. Required if `method` is # equal to `passport`. # - # @param country [String] - # @param expiration_date [Date] - # @param file_id [String] + # @param country [String] The country that issued the passport. + # + # @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format. + # + # @param file_id [String] The identifier of the File containing the passport. end end end @@ -612,15 +708,24 @@ class GovernmentAuthority < Increase::Internal::Type::BaseModel optional :website, String # @!method initialize(address:, authorized_persons:, category:, name:, tax_identifier:, website: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::GovernmentAuthority} for more details. + # # Details of the Government Authority entity to create. Required if `structure` is # equal to `Government Authority`. # - # @param address [Increase::Models::EntityCreateParams::GovernmentAuthority::Address] - # @param authorized_persons [Array] - # @param category [Symbol, Increase::Models::EntityCreateParams::GovernmentAuthority::Category] - # @param name [String] - # @param tax_identifier [String] - # @param website [String] + # @param address [Increase::Models::EntityCreateParams::GovernmentAuthority::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's + # ... + # + # @param authorized_persons [Array] The identifying details of authorized officials acting on the entity's behalf. + # + # @param category [Symbol, Increase::Models::EntityCreateParams::GovernmentAuthority::Category] The category of the government authority. + # + # @param name [String] The legal name of the government authority. + # + # @param tax_identifier [String] The Employer Identification Number (EIN) for the government authority. + # + # @param website [String] The website of the government authority. # @see Increase::Models::EntityCreateParams::GovernmentAuthority#address class Address < Increase::Internal::Type::BaseModel @@ -656,14 +761,23 @@ class Address < Increase::Internal::Type::BaseModel optional :line2, String # @!method initialize(city:, line1:, state:, zip:, line2: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::GovernmentAuthority::Address} for more + # details. + # # The entity's physical address. Mail receiving locations like PO Boxes and PMB's # are disallowed. # - # @param city [String] - # @param line1 [String] - # @param state [String] - # @param zip [String] - # @param line2 [String] + # @param city [String] The city of the address. + # + # @param line1 [String] The first line of the address. This is usually the street number and street. + # + # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of + # ... + # + # @param zip [String] The ZIP code of the address. + # + # @param line2 [String] The second line of the address. This might be the floor or room number. end class AuthorizedPerson < Increase::Internal::Type::BaseModel @@ -674,7 +788,7 @@ class AuthorizedPerson < Increase::Internal::Type::BaseModel required :name, String # @!method initialize(name:) - # @param name [String] + # @param name [String] The person's legal name. end # The category of the government authority. @@ -709,8 +823,9 @@ class Joint < Increase::Internal::Type::BaseModel # Details of the joint entity to create. Required if `structure` is equal to # `joint`. # - # @param individuals [Array] - # @param name [String] + # @param individuals [Array] The two individuals that share control of the entity. + # + # @param name [String] The name of the joint entity. class Individual < Increase::Internal::Type::BaseModel # @!attribute address @@ -748,11 +863,20 @@ class Individual < Increase::Internal::Type::BaseModel optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil) - # @param address [Increase::Models::EntityCreateParams::Joint::Individual::Address] - # @param date_of_birth [Date] - # @param identification [Increase::Models::EntityCreateParams::Joint::Individual::Identification] - # @param name [String] - # @param confirmed_no_us_tax_id [Boolean] + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Joint::Individual} for more details. + # + # @param address [Increase::Models::EntityCreateParams::Joint::Individual::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM + # ... + # + # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format. + # + # @param identification [Increase::Models::EntityCreateParams::Joint::Individual::Identification] A means of verifying the person's identity. + # + # @param name [String] The person's legal name. + # + # @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic + # ... # @see Increase::Models::EntityCreateParams::Joint::Individual#address class Address < Increase::Internal::Type::BaseModel @@ -788,14 +912,23 @@ class Address < Increase::Internal::Type::BaseModel optional :line2, String # @!method initialize(city:, line1:, state:, zip:, line2: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Joint::Individual::Address} for more + # details. + # # The individual's physical address. Mail receiving locations like PO Boxes and # PMB's are disallowed. # - # @param city [String] - # @param line1 [String] - # @param state [String] - # @param zip [String] - # @param line2 [String] + # @param city [String] The city of the address. + # + # @param line1 [String] The first line of the address. This is usually the street number and street. + # + # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of + # ... + # + # @param zip [String] The ZIP code of the address. + # + # @param line2 [String] The second line of the address. This might be the floor or room number. end # @see Increase::Models::EntityCreateParams::Joint::Individual#identification @@ -839,13 +972,25 @@ class Identification < Increase::Internal::Type::BaseModel -> { Increase::Models::EntityCreateParams::Joint::Individual::Identification::Passport } # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Joint::Individual::Identification} for + # more details. + # # A means of verifying the person's identity. # - # @param method_ [Symbol, Increase::Models::EntityCreateParams::Joint::Individual::Identification::Method] - # @param number [String] - # @param drivers_license [Increase::Models::EntityCreateParams::Joint::Individual::Identification::DriversLicense] - # @param other [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Other] - # @param passport [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Passport] + # @param method_ [Symbol, Increase::Models::EntityCreateParams::Joint::Individual::Identification::Method] A method that can be used to verify the individual's identity. + # + # @param number [String] An identification number that can be used to verify the individual's identity, s + # ... + # + # @param drivers_license [Increase::Models::EntityCreateParams::Joint::Individual::Identification::DriversLicense] Information about the United States driver's license used for identification. Re + # ... + # + # @param other [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Other] Information about the identification document provided. Required if `method` is + # ... + # + # @param passport [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Passport] Information about the passport used for identification. Required if `method` is + # ... # A method that can be used to verify the individual's identity. # @@ -902,10 +1047,13 @@ class DriversLicense < Increase::Internal::Type::BaseModel # Information about the United States driver's license used for identification. # Required if `method` is equal to `drivers_license`. # - # @param expiration_date [Date] - # @param file_id [String] - # @param state [String] - # @param back_file_id [String] + # @param expiration_date [Date] The driver's license's expiration date in YYYY-MM-DD format. + # + # @param file_id [String] The identifier of the File containing the front of the driver's license. + # + # @param state [String] The state that issued the provided driver's license. + # + # @param back_file_id [String] The identifier of the File containing the back of the driver's license. end # @see Increase::Models::EntityCreateParams::Joint::Individual::Identification#other @@ -943,14 +1091,24 @@ class Other < Increase::Internal::Type::BaseModel optional :expiration_date, Date # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Joint::Individual::Identification::Other} + # for more details. + # # Information about the identification document provided. Required if `method` is # equal to `other`. # - # @param country [String] - # @param description [String] - # @param file_id [String] - # @param back_file_id [String] - # @param expiration_date [Date] + # @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum + # ... + # + # @param description [String] A description of the document submitted. + # + # @param file_id [String] The identifier of the File containing the front of the document. + # + # @param back_file_id [String] The identifier of the File containing the back of the document. Not every docume + # ... + # + # @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format. end # @see Increase::Models::EntityCreateParams::Joint::Individual::Identification#passport @@ -977,9 +1135,11 @@ class Passport < Increase::Internal::Type::BaseModel # Information about the passport used for identification. Required if `method` is # equal to `passport`. # - # @param country [String] - # @param expiration_date [Date] - # @param file_id [String] + # @param country [String] The country that issued the passport. + # + # @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format. + # + # @param file_id [String] The identifier of the File containing the passport. end end end @@ -1021,16 +1181,25 @@ class NaturalPerson < Increase::Internal::Type::BaseModel optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::NaturalPerson} for more details. + # # Details of the natural person entity to create. Required if `structure` is equal # to `natural_person`. Natural people entities should be submitted with # `social_security_number` or `individual_taxpayer_identification_number` # identification methods. # - # @param address [Increase::Models::EntityCreateParams::NaturalPerson::Address] - # @param date_of_birth [Date] - # @param identification [Increase::Models::EntityCreateParams::NaturalPerson::Identification] - # @param name [String] - # @param confirmed_no_us_tax_id [Boolean] + # @param address [Increase::Models::EntityCreateParams::NaturalPerson::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM + # ... + # + # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format. + # + # @param identification [Increase::Models::EntityCreateParams::NaturalPerson::Identification] A means of verifying the person's identity. + # + # @param name [String] The person's legal name. + # + # @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic + # ... # @see Increase::Models::EntityCreateParams::NaturalPerson#address class Address < Increase::Internal::Type::BaseModel @@ -1066,14 +1235,22 @@ class Address < Increase::Internal::Type::BaseModel optional :line2, String # @!method initialize(city:, line1:, state:, zip:, line2: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::NaturalPerson::Address} for more details. + # # The individual's physical address. Mail receiving locations like PO Boxes and # PMB's are disallowed. # - # @param city [String] - # @param line1 [String] - # @param state [String] - # @param zip [String] - # @param line2 [String] + # @param city [String] The city of the address. + # + # @param line1 [String] The first line of the address. This is usually the street number and street. + # + # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of + # ... + # + # @param zip [String] The ZIP code of the address. + # + # @param line2 [String] The second line of the address. This might be the floor or room number. end # @see Increase::Models::EntityCreateParams::NaturalPerson#identification @@ -1116,13 +1293,25 @@ class Identification < Increase::Internal::Type::BaseModel optional :passport, -> { Increase::Models::EntityCreateParams::NaturalPerson::Identification::Passport } # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::NaturalPerson::Identification} for more + # details. + # # A means of verifying the person's identity. # - # @param method_ [Symbol, Increase::Models::EntityCreateParams::NaturalPerson::Identification::Method] - # @param number [String] - # @param drivers_license [Increase::Models::EntityCreateParams::NaturalPerson::Identification::DriversLicense] - # @param other [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Other] - # @param passport [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Passport] + # @param method_ [Symbol, Increase::Models::EntityCreateParams::NaturalPerson::Identification::Method] A method that can be used to verify the individual's identity. + # + # @param number [String] An identification number that can be used to verify the individual's identity, s + # ... + # + # @param drivers_license [Increase::Models::EntityCreateParams::NaturalPerson::Identification::DriversLicense] Information about the United States driver's license used for identification. Re + # ... + # + # @param other [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Other] Information about the identification document provided. Required if `method` is + # ... + # + # @param passport [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Passport] Information about the passport used for identification. Required if `method` is + # ... # A method that can be used to verify the individual's identity. # @@ -1179,10 +1368,13 @@ class DriversLicense < Increase::Internal::Type::BaseModel # Information about the United States driver's license used for identification. # Required if `method` is equal to `drivers_license`. # - # @param expiration_date [Date] - # @param file_id [String] - # @param state [String] - # @param back_file_id [String] + # @param expiration_date [Date] The driver's license's expiration date in YYYY-MM-DD format. + # + # @param file_id [String] The identifier of the File containing the front of the driver's license. + # + # @param state [String] The state that issued the provided driver's license. + # + # @param back_file_id [String] The identifier of the File containing the back of the driver's license. end # @see Increase::Models::EntityCreateParams::NaturalPerson::Identification#other @@ -1220,14 +1412,24 @@ class Other < Increase::Internal::Type::BaseModel optional :expiration_date, Date # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::NaturalPerson::Identification::Other} for + # more details. + # # Information about the identification document provided. Required if `method` is # equal to `other`. # - # @param country [String] - # @param description [String] - # @param file_id [String] - # @param back_file_id [String] - # @param expiration_date [Date] + # @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum + # ... + # + # @param description [String] A description of the document submitted. + # + # @param file_id [String] The identifier of the File containing the front of the document. + # + # @param back_file_id [String] The identifier of the File containing the back of the document. Not every docume + # ... + # + # @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format. end # @see Increase::Models::EntityCreateParams::NaturalPerson::Identification#passport @@ -1254,9 +1456,11 @@ class Passport < Increase::Internal::Type::BaseModel # Information about the passport used for identification. Required if `method` is # equal to `passport`. # - # @param country [String] - # @param expiration_date [Date] - # @param file_id [String] + # @param country [String] The country that issued the passport. + # + # @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format. + # + # @param file_id [String] The identifier of the File containing the passport. end end end @@ -1269,7 +1473,7 @@ class SupplementalDocument < Increase::Internal::Type::BaseModel required :file_id, String # @!method initialize(file_id:) - # @param file_id [String] + # @param file_id [String] The identifier of the File containing the document. end class ThirdPartyVerification < Increase::Internal::Type::BaseModel @@ -1289,8 +1493,9 @@ class ThirdPartyVerification < Increase::Internal::Type::BaseModel # A reference to data stored in a third-party verification service. Your # integration may or may not use this field. # - # @param reference [String] - # @param vendor [Symbol, Increase::Models::EntityCreateParams::ThirdPartyVerification::Vendor] + # @param reference [String] The reference identifier for the third party verification. + # + # @param vendor [Symbol, Increase::Models::EntityCreateParams::ThirdPartyVerification::Vendor] The vendor that was used to perform the verification. # The vendor that was used to perform the verification. # @@ -1365,17 +1570,31 @@ class Trust < Increase::Internal::Type::BaseModel optional :tax_identifier, String # @!method initialize(address:, category:, name:, trustees:, formation_document_file_id: nil, formation_state: nil, grantor: nil, tax_identifier: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Trust} for more details. + # # Details of the trust entity to create. Required if `structure` is equal to # `trust`. # - # @param address [Increase::Models::EntityCreateParams::Trust::Address] - # @param category [Symbol, Increase::Models::EntityCreateParams::Trust::Category] - # @param name [String] - # @param trustees [Array] - # @param formation_document_file_id [String] - # @param formation_state [String] - # @param grantor [Increase::Models::EntityCreateParams::Trust::Grantor] - # @param tax_identifier [String] + # @param address [Increase::Models::EntityCreateParams::Trust::Address] The trust's physical address. Mail receiving locations like PO Boxes and PMB's a + # ... + # + # @param category [Symbol, Increase::Models::EntityCreateParams::Trust::Category] Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require th + # ... + # + # @param name [String] The legal name of the trust. + # + # @param trustees [Array] The trustees of the trust. + # + # @param formation_document_file_id [String] The identifier of the File containing the formation document of the trust. + # + # @param formation_state [String] The two-letter United States Postal Service (USPS) abbreviation for the state in + # ... + # + # @param grantor [Increase::Models::EntityCreateParams::Trust::Grantor] The grantor of the trust. Required if `category` is equal to `revocable`. + # + # @param tax_identifier [String] The Employer Identification Number (EIN) for the trust. Required if `category` i + # ... # @see Increase::Models::EntityCreateParams::Trust#address class Address < Increase::Internal::Type::BaseModel @@ -1411,14 +1630,22 @@ class Address < Increase::Internal::Type::BaseModel optional :line2, String # @!method initialize(city:, line1:, state:, zip:, line2: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Trust::Address} for more details. + # # The trust's physical address. Mail receiving locations like PO Boxes and PMB's # are disallowed. # - # @param city [String] - # @param line1 [String] - # @param state [String] - # @param zip [String] - # @param line2 [String] + # @param city [String] The city of the address. + # + # @param line1 [String] The first line of the address. This is usually the street number and street. + # + # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of + # ... + # + # @param zip [String] The ZIP code of the address. + # + # @param line2 [String] The second line of the address. This might be the floor or room number. end # Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require @@ -1454,8 +1681,13 @@ class Trustee < Increase::Internal::Type::BaseModel optional :individual, -> { Increase::Models::EntityCreateParams::Trust::Trustee::Individual } # @!method initialize(structure:, individual: nil) - # @param structure [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Structure] - # @param individual [Increase::Models::EntityCreateParams::Trust::Trustee::Individual] + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Trust::Trustee} for more details. + # + # @param structure [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Structure] The structure of the trustee. + # + # @param individual [Increase::Models::EntityCreateParams::Trust::Trustee::Individual] Details of the individual trustee. Required when the trustee `structure` is equa + # ... # The structure of the trustee. # @@ -1508,14 +1740,24 @@ class Individual < Increase::Internal::Type::BaseModel optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Trust::Trustee::Individual} for more + # details. + # # Details of the individual trustee. Required when the trustee `structure` is # equal to `individual`. # - # @param address [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Address] - # @param date_of_birth [Date] - # @param identification [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification] - # @param name [String] - # @param confirmed_no_us_tax_id [Boolean] + # @param address [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM + # ... + # + # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format. + # + # @param identification [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification] A means of verifying the person's identity. + # + # @param name [String] The person's legal name. + # + # @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic + # ... # @see Increase::Models::EntityCreateParams::Trust::Trustee::Individual#address class Address < Increase::Internal::Type::BaseModel @@ -1551,14 +1793,23 @@ class Address < Increase::Internal::Type::BaseModel optional :line2, String # @!method initialize(city:, line1:, state:, zip:, line2: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Address} for + # more details. + # # The individual's physical address. Mail receiving locations like PO Boxes and # PMB's are disallowed. # - # @param city [String] - # @param line1 [String] - # @param state [String] - # @param zip [String] - # @param line2 [String] + # @param city [String] The city of the address. + # + # @param line1 [String] The first line of the address. This is usually the street number and street. + # + # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of + # ... + # + # @param zip [String] The ZIP code of the address. + # + # @param line2 [String] The second line of the address. This might be the floor or room number. end # @see Increase::Models::EntityCreateParams::Trust::Trustee::Individual#identification @@ -1603,13 +1854,25 @@ class Identification < Increase::Internal::Type::BaseModel -> { Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport } # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification} + # for more details. + # # A means of verifying the person's identity. # - # @param method_ [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Method] - # @param number [String] - # @param drivers_license [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense] - # @param other [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Other] - # @param passport [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport] + # @param method_ [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Method] A method that can be used to verify the individual's identity. + # + # @param number [String] An identification number that can be used to verify the individual's identity, s + # ... + # + # @param drivers_license [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense] Information about the United States driver's license used for identification. Re + # ... + # + # @param other [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Other] Information about the identification document provided. Required if `method` is + # ... + # + # @param passport [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport] Information about the passport used for identification. Required if `method` is + # ... # A method that can be used to verify the individual's identity. # @@ -1666,10 +1929,13 @@ class DriversLicense < Increase::Internal::Type::BaseModel # Information about the United States driver's license used for identification. # Required if `method` is equal to `drivers_license`. # - # @param expiration_date [Date] - # @param file_id [String] - # @param state [String] - # @param back_file_id [String] + # @param expiration_date [Date] The driver's license's expiration date in YYYY-MM-DD format. + # + # @param file_id [String] The identifier of the File containing the front of the driver's license. + # + # @param state [String] The state that issued the provided driver's license. + # + # @param back_file_id [String] The identifier of the File containing the back of the driver's license. end # @see Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification#other @@ -1707,14 +1973,24 @@ class Other < Increase::Internal::Type::BaseModel optional :expiration_date, Date # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Other} + # for more details. + # # Information about the identification document provided. Required if `method` is # equal to `other`. # - # @param country [String] - # @param description [String] - # @param file_id [String] - # @param back_file_id [String] - # @param expiration_date [Date] + # @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum + # ... + # + # @param description [String] A description of the document submitted. + # + # @param file_id [String] The identifier of the File containing the front of the document. + # + # @param back_file_id [String] The identifier of the File containing the back of the document. Not every docume + # ... + # + # @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format. end # @see Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification#passport @@ -1741,9 +2017,11 @@ class Passport < Increase::Internal::Type::BaseModel # Information about the passport used for identification. Required if `method` is # equal to `passport`. # - # @param country [String] - # @param expiration_date [Date] - # @param file_id [String] + # @param country [String] The country that issued the passport. + # + # @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format. + # + # @param file_id [String] The identifier of the File containing the passport. end end end @@ -1786,13 +2064,22 @@ class Grantor < Increase::Internal::Type::BaseModel optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Trust::Grantor} for more details. + # # The grantor of the trust. Required if `category` is equal to `revocable`. # - # @param address [Increase::Models::EntityCreateParams::Trust::Grantor::Address] - # @param date_of_birth [Date] - # @param identification [Increase::Models::EntityCreateParams::Trust::Grantor::Identification] - # @param name [String] - # @param confirmed_no_us_tax_id [Boolean] + # @param address [Increase::Models::EntityCreateParams::Trust::Grantor::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM + # ... + # + # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format. + # + # @param identification [Increase::Models::EntityCreateParams::Trust::Grantor::Identification] A means of verifying the person's identity. + # + # @param name [String] The person's legal name. + # + # @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic + # ... # @see Increase::Models::EntityCreateParams::Trust::Grantor#address class Address < Increase::Internal::Type::BaseModel @@ -1828,14 +2115,23 @@ class Address < Increase::Internal::Type::BaseModel optional :line2, String # @!method initialize(city:, line1:, state:, zip:, line2: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Trust::Grantor::Address} for more + # details. + # # The individual's physical address. Mail receiving locations like PO Boxes and # PMB's are disallowed. # - # @param city [String] - # @param line1 [String] - # @param state [String] - # @param zip [String] - # @param line2 [String] + # @param city [String] The city of the address. + # + # @param line1 [String] The first line of the address. This is usually the street number and street. + # + # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of + # ... + # + # @param zip [String] The ZIP code of the address. + # + # @param line2 [String] The second line of the address. This might be the floor or room number. end # @see Increase::Models::EntityCreateParams::Trust::Grantor#identification @@ -1878,13 +2174,25 @@ class Identification < Increase::Internal::Type::BaseModel optional :passport, -> { Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Passport } # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Trust::Grantor::Identification} for more + # details. + # # A means of verifying the person's identity. # - # @param method_ [Symbol, Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Method] - # @param number [String] - # @param drivers_license [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::DriversLicense] - # @param other [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Other] - # @param passport [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Passport] + # @param method_ [Symbol, Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Method] A method that can be used to verify the individual's identity. + # + # @param number [String] An identification number that can be used to verify the individual's identity, s + # ... + # + # @param drivers_license [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::DriversLicense] Information about the United States driver's license used for identification. Re + # ... + # + # @param other [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Other] Information about the identification document provided. Required if `method` is + # ... + # + # @param passport [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Passport] Information about the passport used for identification. Required if `method` is + # ... # A method that can be used to verify the individual's identity. # @@ -1941,10 +2249,13 @@ class DriversLicense < Increase::Internal::Type::BaseModel # Information about the United States driver's license used for identification. # Required if `method` is equal to `drivers_license`. # - # @param expiration_date [Date] - # @param file_id [String] - # @param state [String] - # @param back_file_id [String] + # @param expiration_date [Date] The driver's license's expiration date in YYYY-MM-DD format. + # + # @param file_id [String] The identifier of the File containing the front of the driver's license. + # + # @param state [String] The state that issued the provided driver's license. + # + # @param back_file_id [String] The identifier of the File containing the back of the driver's license. end # @see Increase::Models::EntityCreateParams::Trust::Grantor::Identification#other @@ -1982,14 +2293,24 @@ class Other < Increase::Internal::Type::BaseModel optional :expiration_date, Date # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Other} + # for more details. + # # Information about the identification document provided. Required if `method` is # equal to `other`. # - # @param country [String] - # @param description [String] - # @param file_id [String] - # @param back_file_id [String] - # @param expiration_date [Date] + # @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum + # ... + # + # @param description [String] A description of the document submitted. + # + # @param file_id [String] The identifier of the File containing the front of the document. + # + # @param back_file_id [String] The identifier of the File containing the back of the document. Not every docume + # ... + # + # @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format. end # @see Increase::Models::EntityCreateParams::Trust::Grantor::Identification#passport @@ -2016,9 +2337,11 @@ class Passport < Increase::Internal::Type::BaseModel # Information about the passport used for identification. Required if `method` is # equal to `passport`. # - # @param country [String] - # @param expiration_date [Date] - # @param file_id [String] + # @param country [String] The country that issued the passport. + # + # @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format. + # + # @param file_id [String] The identifier of the File containing the passport. end end end diff --git a/lib/increase/models/entity_list_params.rb b/lib/increase/models/entity_list_params.rb index 71ee9480b..16320766f 100644 --- a/lib/increase/models/entity_list_params.rb +++ b/lib/increase/models/entity_list_params.rb @@ -40,11 +40,21 @@ class EntityListParams < Increase::Internal::Type::BaseModel optional :status, -> { Increase::Models::EntityListParams::Status } # @!method initialize(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityListParams} for more details. + # # @param created_at [Increase::Models::EntityListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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::EntityListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel @@ -77,10 +87,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityListParams::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 @@ -95,7 +115,11 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityListParams::Status} for more details. + # + # @param in_ [Array] Filter Entities for those with the specified status or statuses. For GET request + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/entity_supplemental_document.rb b/lib/increase/models/entity_supplemental_document.rb index 4e9e6b177..d8c0c1e4c 100644 --- a/lib/increase/models/entity_supplemental_document.rb +++ b/lib/increase/models/entity_supplemental_document.rb @@ -39,14 +39,24 @@ class EntitySupplementalDocument < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::EntitySupplementalDocument::Type } # @!method initialize(created_at:, entity_id:, file_id:, idempotency_key:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntitySupplementalDocument} for more details. + # # Supplemental Documents are uploaded files connected to an Entity during # onboarding. # - # @param created_at [Time] - # @param entity_id [String] - # @param file_id [String] - # @param idempotency_key [String, nil] - # @param type [Symbol, Increase::Models::EntitySupplementalDocument::Type] + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Supplem + # ... + # + # @param entity_id [String] The Entity the supplemental document is attached to. + # + # @param file_id [String] The File containing the 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::EntitySupplementalDocument::Type] A constant representing the object's type. For this resource it will always be ` + # ... # A constant representing the object's type. For this resource it will always be # `entity_supplemental_document`. diff --git a/lib/increase/models/entity_update_address_params.rb b/lib/increase/models/entity_update_address_params.rb index da9553eea..c4042947a 100644 --- a/lib/increase/models/entity_update_address_params.rb +++ b/lib/increase/models/entity_update_address_params.rb @@ -15,7 +15,12 @@ class EntityUpdateAddressParams < Increase::Internal::Type::BaseModel required :address, -> { Increase::Models::EntityUpdateAddressParams::Address } # @!method initialize(address:, request_options: {}) - # @param address [Increase::Models::EntityUpdateAddressParams::Address] + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityUpdateAddressParams} for more details. + # + # @param address [Increase::Models::EntityUpdateAddressParams::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Address < Increase::Internal::Type::BaseModel @@ -51,14 +56,22 @@ class Address < Increase::Internal::Type::BaseModel optional :line2, String # @!method initialize(city:, line1:, state:, zip:, line2: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityUpdateAddressParams::Address} for more details. + # # The entity's physical address. Mail receiving locations like PO Boxes and PMB's # are disallowed. # - # @param city [String] - # @param line1 [String] - # @param state [String] - # @param zip [String] - # @param line2 [String] + # @param city [String] The city of the address. + # + # @param line1 [String] The first line of the address. This is usually the street number and street. + # + # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of + # ... + # + # @param zip [String] The ZIP code of the address. + # + # @param line2 [String] The second line of the address. This might be the floor or room number. end end end diff --git a/lib/increase/models/entity_update_beneficial_owner_address_params.rb b/lib/increase/models/entity_update_beneficial_owner_address_params.rb index 8409500f3..6a316388c 100644 --- a/lib/increase/models/entity_update_beneficial_owner_address_params.rb +++ b/lib/increase/models/entity_update_beneficial_owner_address_params.rb @@ -22,8 +22,15 @@ class EntityUpdateBeneficialOwnerAddressParams < Increase::Internal::Type::BaseM required :beneficial_owner_id, String # @!method initialize(address:, beneficial_owner_id:, request_options: {}) - # @param address [Increase::Models::EntityUpdateBeneficialOwnerAddressParams::Address] - # @param beneficial_owner_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityUpdateBeneficialOwnerAddressParams} for more details. + # + # @param address [Increase::Models::EntityUpdateBeneficialOwnerAddressParams::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM + # ... + # + # @param beneficial_owner_id [String] The identifying details of anyone controlling or owning 25% or more of the corpo + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Address < Increase::Internal::Type::BaseModel @@ -66,15 +73,26 @@ class Address < Increase::Internal::Type::BaseModel optional :zip, String # @!method initialize(country:, line1:, city: nil, line2: nil, state: nil, zip: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityUpdateBeneficialOwnerAddressParams::Address} for more + # details. + # # The individual's physical address. Mail receiving locations like PO Boxes and # PMB's are disallowed. # - # @param country [String] - # @param line1 [String] - # @param city [String] - # @param line2 [String] - # @param state [String] - # @param zip [String] + # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address. + # + # @param line1 [String] The first line of the address. This is usually the street number and street. + # + # @param city [String] The city, district, town, or village of the address. Required in certain countri + # ... + # + # @param line2 [String] The second line of the address. This might be the floor or room number. + # + # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the US state + # ... + # + # @param zip [String] The ZIP or postal code of the address. Required in certain countries. end end end diff --git a/lib/increase/models/entity_update_industry_code_params.rb b/lib/increase/models/entity_update_industry_code_params.rb index dc00f7b26..d03f6bc0b 100644 --- a/lib/increase/models/entity_update_industry_code_params.rb +++ b/lib/increase/models/entity_update_industry_code_params.rb @@ -17,7 +17,12 @@ class EntityUpdateIndustryCodeParams < Increase::Internal::Type::BaseModel required :industry_code, String # @!method initialize(industry_code:, request_options: {}) - # @param industry_code [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityUpdateIndustryCodeParams} for more details. + # + # @param industry_code [String] The North American Industry Classification System (NAICS) code for the corporati + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/event.rb b/lib/increase/models/event.rb index 00c1b6c65..35d0ed96a 100644 --- a/lib/increase/models/event.rb +++ b/lib/increase/models/event.rb @@ -43,17 +43,27 @@ class Event < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::Event::Type } # @!method initialize(id:, associated_object_id:, associated_object_type:, category:, created_at:, type:) + # Some parameter documentations has been truncated, see {Increase::Models::Event} + # for more details. + # # Events are records of things that happened to objects at Increase. Events are # accessible via the List Events endpoint and can be delivered to your application # via webhooks. For more information, see our # [webhooks guide](https://increase.com/documentation/webhooks). # - # @param id [String] - # @param associated_object_id [String] - # @param associated_object_type [String] - # @param category [Symbol, Increase::Models::Event::Category] - # @param created_at [Time] - # @param type [Symbol, Increase::Models::Event::Type] + # @param id [String] The Event identifier. + # + # @param associated_object_id [String] The identifier of the object that generated this Event. + # + # @param associated_object_type [String] The type of the object that generated this Event. + # + # @param category [Symbol, Increase::Models::Event::Category] The category of the Event. We may add additional possible values for this enum o + # ... + # + # @param created_at [Time] The time the Event was created. + # + # @param type [Symbol, Increase::Models::Event::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The category of the Event. We may add additional possible values for this enum # over time; your application should be able to handle such additions gracefully. diff --git a/lib/increase/models/event_list_params.rb b/lib/increase/models/event_list_params.rb index c44294357..51f4f1010 100644 --- a/lib/increase/models/event_list_params.rb +++ b/lib/increase/models/event_list_params.rb @@ -37,11 +37,20 @@ class EventListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(associated_object_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) - # @param associated_object_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::EventListParams} for more details. + # + # @param associated_object_id [String] Filter Events to those belonging to the object with the provided identifier. + # # @param category [Increase::Models::EventListParams::Category] + # # @param created_at [Increase::Models::EventListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @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 @@ -56,7 +65,11 @@ class Category < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::EventListParams::Category} for more details. + # + # @param in_ [Array] Filter Events for those with the specified category or categories. For GET reque + # ... module In extend Increase::Internal::Type::Enum @@ -356,10 +369,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::EventListParams::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 diff --git a/lib/increase/models/event_subscription.rb b/lib/increase/models/event_subscription.rb index a6e3fc0a5..ebca0c2e8 100644 --- a/lib/increase/models/event_subscription.rb +++ b/lib/increase/models/event_subscription.rb @@ -60,6 +60,9 @@ class EventSubscription < Increase::Internal::Type::BaseModel required :url, String # @!method initialize(id:, created_at:, idempotency_key:, oauth_connection_id:, selected_event_category:, status:, type:, url:) + # Some parameter documentations has been truncated, see + # {Increase::Models::EventSubscription} for more details. + # # Webhooks are event notifications we send to you by HTTPS POST requests. Event # Subscriptions are how you configure your application to listen for them. You can # create an Event Subscription through your @@ -67,14 +70,25 @@ class EventSubscription < Increase::Internal::Type::BaseModel # API. For more information, see our # [webhooks guide](https://increase.com/documentation/webhooks). # - # @param id [String] - # @param created_at [Time] - # @param idempotency_key [String, nil] - # @param oauth_connection_id [String, nil] - # @param selected_event_category [Symbol, Increase::Models::EventSubscription::SelectedEventCategory, nil] - # @param status [Symbol, Increase::Models::EventSubscription::Status] - # @param type [Symbol, Increase::Models::EventSubscription::Type] - # @param url [String] + # @param id [String] The event subscription identifier. + # + # @param created_at [Time] The time the event subscription was created. + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param oauth_connection_id [String, nil] If specified, this subscription will only receive webhooks for Events associated + # ... + # + # @param selected_event_category [Symbol, Increase::Models::EventSubscription::SelectedEventCategory, nil] If specified, this subscription will only receive webhooks for Events with the s + # ... + # + # @param status [Symbol, Increase::Models::EventSubscription::Status] This indicates if we'll send notifications to this subscription. + # + # @param type [Symbol, Increase::Models::EventSubscription::Type] A constant representing the object's type. For this resource it will always be ` + # ... + # + # @param url [String] The webhook url where we'll send notifications. # If specified, this subscription will only receive webhooks for Events with the # specified `category`. diff --git a/lib/increase/models/event_subscription_create_params.rb b/lib/increase/models/event_subscription_create_params.rb index 7c53fce6f..f656d851e 100644 --- a/lib/increase/models/event_subscription_create_params.rb +++ b/lib/increase/models/event_subscription_create_params.rb @@ -36,10 +36,20 @@ class EventSubscriptionCreateParams < Increase::Internal::Type::BaseModel optional :shared_secret, String # @!method initialize(url:, oauth_connection_id: nil, selected_event_category: nil, shared_secret: nil, request_options: {}) - # @param url [String] - # @param oauth_connection_id [String] - # @param selected_event_category [Symbol, Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory] - # @param shared_secret [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::EventSubscriptionCreateParams} for more details. + # + # @param url [String] The URL you'd like us to send webhooks to. + # + # @param oauth_connection_id [String] If specified, this subscription will only receive webhooks for Events associated + # ... + # + # @param selected_event_category [Symbol, Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory] If specified, this subscription will only receive webhooks for Events with the s + # ... + # + # @param shared_secret [String] The key that will be used to sign webhooks. If no value is passed, a random stri + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # If specified, this subscription will only receive webhooks for Events with the diff --git a/lib/increase/models/event_subscription_list_params.rb b/lib/increase/models/event_subscription_list_params.rb index 9b39377bb..30924019e 100644 --- a/lib/increase/models/event_subscription_list_params.rb +++ b/lib/increase/models/event_subscription_list_params.rb @@ -30,9 +30,17 @@ class EventSubscriptionListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # Some parameter documentations has been truncated, see + # {Increase::Models::EventSubscriptionListParams} for more details. + # + # @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}] end end diff --git a/lib/increase/models/event_subscription_update_params.rb b/lib/increase/models/event_subscription_update_params.rb index ed91c7459..9da745af2 100644 --- a/lib/increase/models/event_subscription_update_params.rb +++ b/lib/increase/models/event_subscription_update_params.rb @@ -14,7 +14,8 @@ class EventSubscriptionUpdateParams < Increase::Internal::Type::BaseModel optional :status, enum: -> { Increase::Models::EventSubscriptionUpdateParams::Status } # @!method initialize(status: nil, request_options: {}) - # @param status [Symbol, Increase::Models::EventSubscriptionUpdateParams::Status] + # @param status [Symbol, Increase::Models::EventSubscriptionUpdateParams::Status] The status to update the Event Subscription with. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The status to update the Event Subscription with. diff --git a/lib/increase/models/export.rb b/lib/increase/models/export.rb index 9f26789e4..44bce4092 100644 --- a/lib/increase/models/export.rb +++ b/lib/increase/models/export.rb @@ -59,20 +59,35 @@ class Export < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::Export::Type } # @!method initialize(id:, category:, created_at:, file_download_url:, file_id:, idempotency_key:, status:, type:) + # Some parameter documentations has been truncated, see {Increase::Models::Export} + # for more details. + # # Exports are batch summaries of your Increase data. You can make them from the # API or dashboard. Since they can take a while, they are generated # asynchronously. We send a webhook when they are ready. For more information, # please read our # [Exports documentation](https://increase.com/documentation/exports). # - # @param id [String] - # @param category [Symbol, Increase::Models::Export::Category] - # @param created_at [Time] - # @param file_download_url [String, nil] - # @param file_id [String, nil] - # @param idempotency_key [String, nil] - # @param status [Symbol, Increase::Models::Export::Status] - # @param type [Symbol, Increase::Models::Export::Type] + # @param id [String] The Export identifier. + # + # @param category [Symbol, Increase::Models::Export::Category] The category of the Export. We may add additional possible values for this enum + # ... + # + # @param created_at [Time] The time the Export was created. + # + # @param file_download_url [String, nil] A URL at which the Export's file can be downloaded. This will be present when th + # ... + # + # @param file_id [String, nil] The File containing the contents of the Export. This will be present when the Ex + # ... + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param status [Symbol, Increase::Models::Export::Status] The status of the Export. + # + # @param type [Symbol, Increase::Models::Export::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The category of the Export. We may add additional possible values for this enum # over time; your application should be able to handle that gracefully. diff --git a/lib/increase/models/export_create_params.rb b/lib/increase/models/export_create_params.rb index 6c7246c9d..3392e907e 100644 --- a/lib/increase/models/export_create_params.rb +++ b/lib/increase/models/export_create_params.rb @@ -55,13 +55,29 @@ class ExportCreateParams < Increase::Internal::Type::BaseModel optional :vendor_csv, Increase::Internal::Type::Unknown # @!method initialize(category:, account_statement_ofx: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, entity_csv: nil, transaction_csv: nil, vendor_csv: nil, request_options: {}) - # @param category [Symbol, Increase::Models::ExportCreateParams::Category] - # @param account_statement_ofx [Increase::Models::ExportCreateParams::AccountStatementOfx] - # @param balance_csv [Increase::Models::ExportCreateParams::BalanceCsv] - # @param bookkeeping_account_balance_csv [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv] - # @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv] - # @param transaction_csv [Increase::Models::ExportCreateParams::TransactionCsv] - # @param vendor_csv [Object] + # Some parameter documentations has been truncated, see + # {Increase::Models::ExportCreateParams} for more details. + # + # @param category [Symbol, Increase::Models::ExportCreateParams::Category] The type of Export to create. + # + # @param account_statement_ofx [Increase::Models::ExportCreateParams::AccountStatementOfx] Options for the created export. Required if `category` is equal to `account_stat + # ... + # + # @param balance_csv [Increase::Models::ExportCreateParams::BalanceCsv] Options for the created export. Required if `category` is equal to `balance_csv` + # ... + # + # @param bookkeeping_account_balance_csv [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv] Options for the created export. Required if `category` is equal to + # `bookkeeping\_ ... + # + # @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv] Options for the created export. Required if `category` is equal to `entity_csv`. + # ... + # + # @param transaction_csv [Increase::Models::ExportCreateParams::TransactionCsv] Options for the created export. Required if `category` is equal to + # `transaction\_ ... + # + # @param vendor_csv [Object] Options for the created export. Required if `category` is equal to `vendor_csv`. + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The type of Export to create. @@ -107,8 +123,9 @@ class AccountStatementOfx < Increase::Internal::Type::BaseModel # Options for the created export. Required if `category` is equal to # `account_statement_ofx`. # - # @param account_id [String] - # @param created_at [Increase::Models::ExportCreateParams::AccountStatementOfx::CreatedAt] + # @param account_id [String] The Account to create a statement for. + # + # @param created_at [Increase::Models::ExportCreateParams::AccountStatementOfx::CreatedAt] Filter results by time range on the `created_at` attribute. # @see Increase::Models::ExportCreateParams::AccountStatementOfx#created_at class CreatedAt < Increase::Internal::Type::BaseModel @@ -141,12 +158,23 @@ class CreatedAt < Increase::Internal::Type::BaseModel 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::ExportCreateParams::AccountStatementOfx::CreatedAt} for more + # details. + # # Filter results by time range on the `created_at` attribute. # - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # @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 @@ -173,9 +201,11 @@ class BalanceCsv < Increase::Internal::Type::BaseModel # Options for the created export. Required if `category` is equal to # `balance_csv`. # - # @param account_id [String] - # @param created_at [Increase::Models::ExportCreateParams::BalanceCsv::CreatedAt] - # @param program_id [String] + # @param account_id [String] Filter exported Transactions to the specified Account. + # + # @param created_at [Increase::Models::ExportCreateParams::BalanceCsv::CreatedAt] Filter results by time range on the `created_at` attribute. + # + # @param program_id [String] Filter exported Transactions to the specified Program. # @see Increase::Models::ExportCreateParams::BalanceCsv#created_at class CreatedAt < Increase::Internal::Type::BaseModel @@ -208,12 +238,22 @@ class CreatedAt < Increase::Internal::Type::BaseModel 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::ExportCreateParams::BalanceCsv::CreatedAt} for more details. + # # Filter results by time range on the `created_at` attribute. # - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # @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 @@ -234,8 +274,9 @@ class BookkeepingAccountBalanceCsv < Increase::Internal::Type::BaseModel # Options for the created export. Required if `category` is equal to # `bookkeeping_account_balance_csv`. # - # @param bookkeeping_account_id [String] - # @param created_at [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv::CreatedAt] + # @param bookkeeping_account_id [String] Filter exported Transactions to the specified Bookkeeping Account. + # + # @param created_at [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv::CreatedAt] Filter results by time range on the `created_at` attribute. # @see Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv#created_at class CreatedAt < Increase::Internal::Type::BaseModel @@ -268,12 +309,23 @@ class CreatedAt < Increase::Internal::Type::BaseModel 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::ExportCreateParams::BookkeepingAccountBalanceCsv::CreatedAt} + # for more details. + # # Filter results by time range on the `created_at` attribute. # - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # @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 @@ -287,7 +339,7 @@ class EntityCsv < Increase::Internal::Type::BaseModel # @!method initialize(status: nil) # Options for the created export. Required if `category` is equal to `entity_csv`. # - # @param status [Increase::Models::ExportCreateParams::EntityCsv::Status] + # @param status [Increase::Models::ExportCreateParams::EntityCsv::Status] Entity statuses to filter by. # @see Increase::Models::ExportCreateParams::EntityCsv#status class Status < Increase::Internal::Type::BaseModel @@ -301,9 +353,13 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_:) + # Some parameter documentations has been truncated, see + # {Increase::Models::ExportCreateParams::EntityCsv::Status} for more details. + # # Entity statuses to filter by. # - # @param in_ [Array] + # @param in_ [Array] Entity statuses to filter by. For GET requests, this should be encoded as a comm + # ... module In extend Increase::Internal::Type::Enum @@ -346,9 +402,11 @@ class TransactionCsv < Increase::Internal::Type::BaseModel # Options for the created export. Required if `category` is equal to # `transaction_csv`. # - # @param account_id [String] - # @param created_at [Increase::Models::ExportCreateParams::TransactionCsv::CreatedAt] - # @param program_id [String] + # @param account_id [String] Filter exported Transactions to the specified Account. + # + # @param created_at [Increase::Models::ExportCreateParams::TransactionCsv::CreatedAt] Filter results by time range on the `created_at` attribute. + # + # @param program_id [String] Filter exported Transactions to the specified Program. # @see Increase::Models::ExportCreateParams::TransactionCsv#created_at class CreatedAt < Increase::Internal::Type::BaseModel @@ -381,12 +439,23 @@ class CreatedAt < Increase::Internal::Type::BaseModel 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::ExportCreateParams::TransactionCsv::CreatedAt} for more + # details. + # # Filter results by time range on the `created_at` attribute. # - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # @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 diff --git a/lib/increase/models/export_list_params.rb b/lib/increase/models/export_list_params.rb index 9e0c7e40f..e27256882 100644 --- a/lib/increase/models/export_list_params.rb +++ b/lib/increase/models/export_list_params.rb @@ -45,12 +45,23 @@ class ExportListParams < Increase::Internal::Type::BaseModel optional :status, -> { Increase::Models::ExportListParams::Status } # @!method initialize(category: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Increase::Models::ExportListParams} for more details. + # # @param category [Increase::Models::ExportListParams::Category] + # # @param created_at [Increase::Models::ExportListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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::ExportListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Category < Increase::Internal::Type::BaseModel @@ -65,7 +76,11 @@ class Category < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::ExportListParams::Category} for more details. + # + # @param in_ [Array] Filter Exports for those with the specified category or categories. For GET requ + # ... module In extend Increase::Internal::Type::Enum @@ -126,10 +141,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::ExportListParams::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 @@ -144,7 +169,11 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::ExportListParams::Status} for more details. + # + # @param in_ [Array] Filter Exports for those with the specified status or statuses. For GET requests + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/external_account.rb b/lib/increase/models/external_account.rb index ca8968651..6f037032a 100644 --- a/lib/increase/models/external_account.rb +++ b/lib/increase/models/external_account.rb @@ -75,20 +75,36 @@ class ExternalAccount < Increase::Internal::Type::BaseModel required :verification_status, enum: -> { Increase::Models::ExternalAccount::VerificationStatus } # @!method initialize(id:, account_holder:, account_number:, created_at:, description:, funding:, idempotency_key:, routing_number:, status:, type:, verification_status:) + # Some parameter documentations has been truncated, see + # {Increase::Models::ExternalAccount} for more details. + # # External Accounts represent accounts at financial institutions other than # Increase. You can use this API to store their details for reuse. # - # @param id [String] - # @param account_holder [Symbol, Increase::Models::ExternalAccount::AccountHolder] - # @param account_number [String] - # @param created_at [Time] - # @param description [String] - # @param funding [Symbol, Increase::Models::ExternalAccount::Funding] - # @param idempotency_key [String, nil] - # @param routing_number [String] - # @param status [Symbol, Increase::Models::ExternalAccount::Status] - # @param type [Symbol, Increase::Models::ExternalAccount::Type] - # @param verification_status [Symbol, Increase::Models::ExternalAccount::VerificationStatus] + # @param id [String] The External Account's identifier. + # + # @param account_holder [Symbol, Increase::Models::ExternalAccount::AccountHolder] The type of entity that owns the External Account. + # + # @param account_number [String] The destination account number. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param description [String] The External Account's description for display purposes. + # + # @param funding [Symbol, Increase::Models::ExternalAccount::Funding] The type of the account to which the transfer will be sent. + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN). + # + # @param status [Symbol, Increase::Models::ExternalAccount::Status] The External Account's status. + # + # @param type [Symbol, Increase::Models::ExternalAccount::Type] A constant representing the object's type. For this resource it will always be ` + # ... + # + # @param verification_status [Symbol, Increase::Models::ExternalAccount::VerificationStatus] If you have verified ownership of the External Account. # The type of entity that owns the External Account. # diff --git a/lib/increase/models/external_account_create_params.rb b/lib/increase/models/external_account_create_params.rb index ea1dbb026..e79e06d07 100644 --- a/lib/increase/models/external_account_create_params.rb +++ b/lib/increase/models/external_account_create_params.rb @@ -39,11 +39,20 @@ class ExternalAccountCreateParams < Increase::Internal::Type::BaseModel optional :funding, enum: -> { Increase::Models::ExternalAccountCreateParams::Funding } # @!method initialize(account_number:, description:, routing_number:, account_holder: nil, funding: nil, request_options: {}) - # @param account_number [String] - # @param description [String] - # @param routing_number [String] - # @param account_holder [Symbol, Increase::Models::ExternalAccountCreateParams::AccountHolder] - # @param funding [Symbol, Increase::Models::ExternalAccountCreateParams::Funding] + # Some parameter documentations has been truncated, see + # {Increase::Models::ExternalAccountCreateParams} for more details. + # + # @param account_number [String] The account number for the destination account. + # + # @param description [String] The name you choose for the Account. + # + # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des + # ... + # + # @param account_holder [Symbol, Increase::Models::ExternalAccountCreateParams::AccountHolder] The type of entity that owns the External Account. + # + # @param funding [Symbol, Increase::Models::ExternalAccountCreateParams::Funding] The type of the destination account. Defaults to `checking`. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The type of entity that owns the External Account. diff --git a/lib/increase/models/external_account_list_params.rb b/lib/increase/models/external_account_list_params.rb index 145317405..8bb2e6553 100644 --- a/lib/increase/models/external_account_list_params.rb +++ b/lib/increase/models/external_account_list_params.rb @@ -41,11 +41,21 @@ class ExternalAccountListParams < Increase::Internal::Type::BaseModel optional :status, -> { Increase::Models::ExternalAccountListParams::Status } # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, routing_number: nil, status: nil, request_options: {}) - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] - # @param routing_number [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::ExternalAccountListParams} for more details. + # + # @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 routing_number [String] Filter External Accounts to those with the specified Routing Number. + # # @param status [Increase::Models::ExternalAccountListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Status < Increase::Internal::Type::BaseModel @@ -60,7 +70,11 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::ExternalAccountListParams::Status} for more details. + # + # @param in_ [Array] Filter External Accounts for those with the specified status or statuses. For GE + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/external_account_update_params.rb b/lib/increase/models/external_account_update_params.rb index 1b7f161a8..92db43365 100644 --- a/lib/increase/models/external_account_update_params.rb +++ b/lib/increase/models/external_account_update_params.rb @@ -32,10 +32,14 @@ class ExternalAccountUpdateParams < Increase::Internal::Type::BaseModel optional :status, enum: -> { Increase::Models::ExternalAccountUpdateParams::Status } # @!method initialize(account_holder: nil, description: nil, funding: nil, status: nil, request_options: {}) - # @param account_holder [Symbol, Increase::Models::ExternalAccountUpdateParams::AccountHolder] - # @param description [String] - # @param funding [Symbol, Increase::Models::ExternalAccountUpdateParams::Funding] - # @param status [Symbol, Increase::Models::ExternalAccountUpdateParams::Status] + # @param account_holder [Symbol, Increase::Models::ExternalAccountUpdateParams::AccountHolder] The type of entity that owns the External Account. + # + # @param description [String] The description you choose to give the external account. + # + # @param funding [Symbol, Increase::Models::ExternalAccountUpdateParams::Funding] The funding type of the External Account. + # + # @param status [Symbol, Increase::Models::ExternalAccountUpdateParams::Status] The status of the External Account. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The type of entity that owns the External Account. diff --git a/lib/increase/models/file.rb b/lib/increase/models/file.rb index aa866809a..8603ddfb4 100644 --- a/lib/increase/models/file.rb +++ b/lib/increase/models/file.rb @@ -64,20 +64,34 @@ class File < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::File::Type } # @!method initialize(id:, created_at:, description:, direction:, filename:, idempotency_key:, mime_type:, purpose:, type:) + # Some parameter documentations has been truncated, see {Increase::Models::File} + # for more details. + # # Files are objects that represent a file hosted on Increase's servers. The file # may have been uploaded by you (for example, when uploading a check image) or it # may have been created by Increase (for example, an autogenerated statement PDF). # If you need to download a File, create a File Link. # - # @param id [String] - # @param created_at [Time] - # @param description [String, nil] - # @param direction [Symbol, Increase::Models::File::Direction] - # @param filename [String, nil] - # @param idempotency_key [String, nil] - # @param mime_type [String] - # @param purpose [Symbol, Increase::Models::File::Purpose] - # @param type [Symbol, Increase::Models::File::Type] + # @param id [String] The File's identifier. + # + # @param created_at [Time] The time the File was created. + # + # @param description [String, nil] A description of the File. + # + # @param direction [Symbol, Increase::Models::File::Direction] Whether the File was generated by Increase or by you and sent to Increase. + # + # @param filename [String, nil] The filename that was provided upon upload or generated by Increase. + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param mime_type [String] The MIME type of the file. + # + # @param purpose [Symbol, Increase::Models::File::Purpose] What the File will be used for. We may add additional possible values for this e + # ... + # + # @param type [Symbol, Increase::Models::File::Type] A constant representing the object's type. For this resource it will always be ` + # ... # Whether the File was generated by Increase or by you and sent to Increase. # diff --git a/lib/increase/models/file_create_params.rb b/lib/increase/models/file_create_params.rb index 758eab6f7..4f80030a8 100644 --- a/lib/increase/models/file_create_params.rb +++ b/lib/increase/models/file_create_params.rb @@ -28,9 +28,16 @@ class FileCreateParams < Increase::Internal::Type::BaseModel optional :description, String # @!method initialize(file:, purpose:, description: nil, request_options: {}) - # @param file [Pathname, StringIO] - # @param purpose [Symbol, Increase::Models::FileCreateParams::Purpose] - # @param description [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::FileCreateParams} for more details. + # + # @param file [Pathname, StringIO] The file contents. This should follow the specifications of [RFC 7578](https://d + # ... + # + # @param purpose [Symbol, Increase::Models::FileCreateParams::Purpose] What the File will be used for in Increase's systems. + # + # @param description [String] The description you choose to give the File. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # What the File will be used for in Increase's systems. diff --git a/lib/increase/models/file_link.rb b/lib/increase/models/file_link.rb index b6861130a..a12e99cc1 100644 --- a/lib/increase/models/file_link.rb +++ b/lib/increase/models/file_link.rb @@ -54,15 +54,29 @@ class FileLink < Increase::Internal::Type::BaseModel required :unauthenticated_url, String # @!method initialize(id:, created_at:, expires_at:, file_id:, idempotency_key:, type:, unauthenticated_url:) + # Some parameter documentations has been truncated, see + # {Increase::Models::FileLink} for more details. + # # File Links let you generate a URL that can be used to download a File. # - # @param id [String] - # @param created_at [Time] - # @param expires_at [Time] - # @param file_id [String] - # @param idempotency_key [String, nil] - # @param type [Symbol, Increase::Models::FileLink::Type] - # @param unauthenticated_url [String] + # @param id [String] The File Link identifier. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the File Li + # ... + # + # @param expires_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the File Li + # ... + # + # @param file_id [String] The identifier of the File the File Link points to. + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param type [Symbol, Increase::Models::FileLink::Type] A constant representing the object's type. For this resource it will always be ` + # ... + # + # @param unauthenticated_url [String] A URL where the File can be downloaded. The URL will expire after the `expires_a + # ... # A constant representing the object's type. For this resource it will always be # `file_link`. diff --git a/lib/increase/models/file_link_create_params.rb b/lib/increase/models/file_link_create_params.rb index 4abffa610..c6f6b401c 100644 --- a/lib/increase/models/file_link_create_params.rb +++ b/lib/increase/models/file_link_create_params.rb @@ -21,8 +21,14 @@ class FileLinkCreateParams < Increase::Internal::Type::BaseModel optional :expires_at, Time # @!method initialize(file_id:, expires_at: nil, request_options: {}) - # @param file_id [String] - # @param expires_at [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::FileLinkCreateParams} for more details. + # + # @param file_id [String] The File to create a File Link for. + # + # @param expires_at [Time] The time at which the File Link will expire. The default is 1 hour from the time + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/file_list_params.rb b/lib/increase/models/file_list_params.rb index f336492a2..9c41bd8d6 100644 --- a/lib/increase/models/file_list_params.rb +++ b/lib/increase/models/file_list_params.rb @@ -40,11 +40,21 @@ class FileListParams < Increase::Internal::Type::BaseModel optional :purpose, -> { Increase::Models::FileListParams::Purpose } # @!method initialize(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, purpose: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Increase::Models::FileListParams} for more details. + # # @param created_at [Increase::Models::FileListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha + # ... + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # # @param purpose [Increase::Models::FileListParams::Purpose] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel @@ -77,10 +87,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::FileListParams::CreatedAt} for more details. + # + # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim + # ... + # + # @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti + # ... + # + # @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860 + # ... + # + # @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86 + # ... end class Purpose < Increase::Internal::Type::BaseModel @@ -94,7 +114,11 @@ class Purpose < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::FileListParams::Purpose} for more details. + # + # @param in_ [Array] Filter Files for those with the specified purpose or purposes. For GET requests, + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/group.rb b/lib/increase/models/group.rb index c7f66b1c9..ba7d67f6b 100644 --- a/lib/increase/models/group.rb +++ b/lib/increase/models/group.rb @@ -37,16 +37,25 @@ class Group < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::Group::Type } # @!method initialize(id:, ach_debit_status:, activation_status:, created_at:, type:) + # Some parameter documentations has been truncated, see {Increase::Models::Group} + # for more details. + # # Groups represent organizations using Increase. You can retrieve information # about your own organization via the API. More commonly, OAuth platforms can # retrieve information about the organizations that have granted them access. # Learn more about OAuth [here](https://increase.com/documentation/oauth). # - # @param id [String] - # @param ach_debit_status [Symbol, Increase::Models::Group::ACHDebitStatus] - # @param activation_status [Symbol, Increase::Models::Group::ActivationStatus] - # @param created_at [Time] - # @param type [Symbol, Increase::Models::Group::Type] + # @param id [String] The Group identifier. + # + # @param ach_debit_status [Symbol, Increase::Models::Group::ACHDebitStatus] If the Group is allowed to create ACH debits. + # + # @param activation_status [Symbol, Increase::Models::Group::ActivationStatus] If the Group is activated or not. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Group w + # ... + # + # @param type [Symbol, Increase::Models::Group::Type] A constant representing the object's type. For this resource it will always be ` + # ... # If the Group is allowed to create ACH debits. # diff --git a/lib/increase/models/inbound_ach_transfer.rb b/lib/increase/models/inbound_ach_transfer.rb index d37ffdf92..014407a5b 100644 --- a/lib/increase/models/inbound_ach_transfer.rb +++ b/lib/increase/models/inbound_ach_transfer.rb @@ -182,36 +182,72 @@ class InboundACHTransfer < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::InboundACHTransfer::Type } # @!method initialize(id:, acceptance:, account_id:, account_number_id:, addenda:, amount:, automatically_resolves_at:, created_at:, decline:, direction:, effective_date:, expected_settlement_schedule:, international_addenda:, notification_of_change:, originator_company_descriptive_date:, originator_company_discretionary_data:, originator_company_entry_description:, originator_company_id:, originator_company_name:, originator_routing_number:, receiver_id_number:, receiver_name:, standard_entry_class_code:, status:, trace_number:, transfer_return:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundACHTransfer} for more details. + # # An Inbound ACH Transfer is an ACH transfer initiated outside of Increase to your # account. # - # @param id [String] - # @param acceptance [Increase::Models::InboundACHTransfer::Acceptance, nil] - # @param account_id [String] - # @param account_number_id [String] - # @param addenda [Increase::Models::InboundACHTransfer::Addenda, nil] - # @param amount [Integer] - # @param automatically_resolves_at [Time] - # @param created_at [Time] - # @param decline [Increase::Models::InboundACHTransfer::Decline, nil] - # @param direction [Symbol, Increase::Models::InboundACHTransfer::Direction] - # @param effective_date [Date] - # @param expected_settlement_schedule [Symbol, Increase::Models::InboundACHTransfer::ExpectedSettlementSchedule] - # @param international_addenda [Increase::Models::InboundACHTransfer::InternationalAddenda, nil] - # @param notification_of_change [Increase::Models::InboundACHTransfer::NotificationOfChange, nil] - # @param originator_company_descriptive_date [String, nil] - # @param originator_company_discretionary_data [String, nil] - # @param originator_company_entry_description [String] - # @param originator_company_id [String] - # @param originator_company_name [String] - # @param originator_routing_number [String] - # @param receiver_id_number [String, nil] - # @param receiver_name [String, nil] - # @param standard_entry_class_code [Symbol, Increase::Models::InboundACHTransfer::StandardEntryClassCode] - # @param status [Symbol, Increase::Models::InboundACHTransfer::Status] - # @param trace_number [String] - # @param transfer_return [Increase::Models::InboundACHTransfer::TransferReturn, nil] - # @param type [Symbol, Increase::Models::InboundACHTransfer::Type] + # @param id [String] The inbound ACH transfer's identifier. + # + # @param acceptance [Increase::Models::InboundACHTransfer::Acceptance, nil] If your transfer is accepted, this will contain details of the acceptance. + # + # @param account_id [String] The Account to which the transfer belongs. + # + # @param account_number_id [String] The identifier of the Account Number to which this transfer was sent. + # + # @param addenda [Increase::Models::InboundACHTransfer::Addenda, nil] Additional information sent from the originator. + # + # @param amount [Integer] The transfer amount in USD cents. + # + # @param automatically_resolves_at [Time] The time at which the transfer will be automatically resolved. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param decline [Increase::Models::InboundACHTransfer::Decline, nil] If your transfer is declined, this will contain details of the decline. + # + # @param direction [Symbol, Increase::Models::InboundACHTransfer::Direction] The direction of the transfer. + # + # @param effective_date [Date] The effective date of the transfer. This is sent by the sending bank and is a fa + # ... + # + # @param expected_settlement_schedule [Symbol, Increase::Models::InboundACHTransfer::ExpectedSettlementSchedule] The settlement schedule the transfer is expected to follow. + # + # @param international_addenda [Increase::Models::InboundACHTransfer::InternationalAddenda, nil] If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will co + # ... + # + # @param notification_of_change [Increase::Models::InboundACHTransfer::NotificationOfChange, nil] If you initiate a notification of change in response to the transfer, this will + # ... + # + # @param originator_company_descriptive_date [String, nil] The descriptive date of the transfer. + # + # @param originator_company_discretionary_data [String, nil] The additional information included with the transfer. + # + # @param originator_company_entry_description [String] The description of the transfer. + # + # @param originator_company_id [String] The id of the company that initiated the transfer. + # + # @param originator_company_name [String] The name of the company that initiated the transfer. + # + # @param originator_routing_number [String] The American Banking Association (ABA) routing number of the bank originating th + # ... + # + # @param receiver_id_number [String, nil] The id of the receiver of the transfer. + # + # @param receiver_name [String, nil] The name of the receiver of the transfer. + # + # @param standard_entry_class_code [Symbol, Increase::Models::InboundACHTransfer::StandardEntryClassCode] The Standard Entry Class (SEC) code of the transfer. + # + # @param status [Symbol, Increase::Models::InboundACHTransfer::Status] The status of the transfer. + # + # @param trace_number [String] A 15 digit number set by the sending bank and transmitted to the receiving bank. + # ... + # + # @param transfer_return [Increase::Models::InboundACHTransfer::TransferReturn, nil] If your transfer is returned, this will contain details of the return. + # + # @param type [Symbol, Increase::Models::InboundACHTransfer::Type] A constant representing the object's type. For this resource it will always be ` + # ... # @see Increase::Models::InboundACHTransfer#acceptance class Acceptance < Increase::Internal::Type::BaseModel @@ -230,8 +266,9 @@ class Acceptance < Increase::Internal::Type::BaseModel # @!method initialize(accepted_at:, transaction_id:) # If your transfer is accepted, this will contain details of the acceptance. # - # @param accepted_at [Time] - # @param transaction_id [String] + # @param accepted_at [Time] The time at which the transfer was accepted. + # + # @param transaction_id [String] The id of the transaction for the accepted transfer. end # @see Increase::Models::InboundACHTransfer#addenda @@ -251,8 +288,9 @@ class Addenda < Increase::Internal::Type::BaseModel # @!method initialize(category:, freeform:) # Additional information sent from the originator. # - # @param category [Symbol, Increase::Models::InboundACHTransfer::Addenda::Category] - # @param freeform [Increase::Models::InboundACHTransfer::Addenda::Freeform, nil] + # @param category [Symbol, Increase::Models::InboundACHTransfer::Addenda::Category] The type of addendum. + # + # @param freeform [Increase::Models::InboundACHTransfer::Addenda::Freeform, nil] Unstructured `payment_related_information` passed through by the originator. # The type of addendum. # @@ -279,7 +317,7 @@ class Freeform < Increase::Internal::Type::BaseModel # @!method initialize(entries:) # Unstructured `payment_related_information` passed through by the originator. # - # @param entries [Array] + # @param entries [Array] Each entry represents an addendum received from the originator. class Entry < Increase::Internal::Type::BaseModel # @!attribute payment_related_information @@ -289,7 +327,7 @@ class Entry < Increase::Internal::Type::BaseModel required :payment_related_information, String # @!method initialize(payment_related_information:) - # @param payment_related_information [String] + # @param payment_related_information [String] The payment related information passed in the addendum. end end end @@ -317,9 +355,11 @@ class Decline < Increase::Internal::Type::BaseModel # @!method initialize(declined_at:, declined_transaction_id:, reason:) # If your transfer is declined, this will contain details of the decline. # - # @param declined_at [Time] - # @param declined_transaction_id [String] - # @param reason [Symbol, Increase::Models::InboundACHTransfer::Decline::Reason] + # @param declined_at [Time] The time at which the transfer was declined. + # + # @param declined_transaction_id [String] The id of the transaction for the declined transfer. + # + # @param reason [Symbol, Increase::Models::InboundACHTransfer::Decline::Reason] The reason for the transfer decline. # The reason for the transfer decline. # @@ -643,42 +683,93 @@ class InternationalAddenda < Increase::Internal::Type::BaseModel required :receiving_depository_financial_institution_name, String # @!method initialize(destination_country_code:, destination_currency_code:, foreign_exchange_indicator:, foreign_exchange_reference:, foreign_exchange_reference_indicator:, foreign_payment_amount:, foreign_trace_number:, international_transaction_type_code:, originating_currency_code:, originating_depository_financial_institution_branch_country:, originating_depository_financial_institution_id:, originating_depository_financial_institution_id_qualifier:, originating_depository_financial_institution_name:, originator_city:, originator_country:, originator_identification:, originator_name:, originator_postal_code:, originator_state_or_province:, originator_street_address:, payment_related_information:, payment_related_information2:, receiver_city:, receiver_country:, receiver_identification_number:, receiver_postal_code:, receiver_state_or_province:, receiver_street_address:, receiving_company_or_individual_name:, receiving_depository_financial_institution_country:, receiving_depository_financial_institution_id:, receiving_depository_financial_institution_id_qualifier:, receiving_depository_financial_institution_name:) + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundACHTransfer::InternationalAddenda} for more details. + # # If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will # contain fields pertaining to the International ACH Transaction. # - # @param destination_country_code [String] - # @param destination_currency_code [String] - # @param foreign_exchange_indicator [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeIndicator] - # @param foreign_exchange_reference [String, nil] - # @param foreign_exchange_reference_indicator [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeReferenceIndicator] - # @param foreign_payment_amount [Integer] - # @param foreign_trace_number [String, nil] - # @param international_transaction_type_code [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::InternationalTransactionTypeCode] - # @param originating_currency_code [String] - # @param originating_depository_financial_institution_branch_country [String] - # @param originating_depository_financial_institution_id [String] - # @param originating_depository_financial_institution_id_qualifier [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::OriginatingDepositoryFinancialInstitutionIDQualifier] - # @param originating_depository_financial_institution_name [String] - # @param originator_city [String] - # @param originator_country [String] - # @param originator_identification [String] - # @param originator_name [String] - # @param originator_postal_code [String, nil] - # @param originator_state_or_province [String, nil] - # @param originator_street_address [String] - # @param payment_related_information [String, nil] - # @param payment_related_information2 [String, nil] - # @param receiver_city [String] - # @param receiver_country [String] - # @param receiver_identification_number [String, nil] - # @param receiver_postal_code [String, nil] - # @param receiver_state_or_province [String, nil] - # @param receiver_street_address [String] - # @param receiving_company_or_individual_name [String] - # @param receiving_depository_financial_institution_country [String] - # @param receiving_depository_financial_institution_id [String] - # @param receiving_depository_financial_institution_id_qualifier [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ReceivingDepositoryFinancialInstitutionIDQualifier] - # @param receiving_depository_financial_institution_name [String] + # @param destination_country_code [String] The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 countr + # ... + # + # @param destination_currency_code [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the des + # ... + # + # @param foreign_exchange_indicator [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeIndicator] A description of how the foreign exchange rate was calculated. + # + # @param foreign_exchange_reference [String, nil] Depending on the `foreign_exchange_reference_indicator`, an exchange rate or a r + # ... + # + # @param foreign_exchange_reference_indicator [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeReferenceIndicator] An instruction of how to interpret the `foreign_exchange_reference` field for th + # ... + # + # @param foreign_payment_amount [Integer] The amount in the minor unit of the foreign payment currency. For dollars, for e + # ... + # + # @param foreign_trace_number [String, nil] A reference number in the foreign banking infrastructure. + # + # @param international_transaction_type_code [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::InternationalTransactionTypeCode] The type of transfer. Set by the originator. + # + # @param originating_currency_code [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the ori + # ... + # + # @param originating_depository_financial_institution_branch_country [String] The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 countr + # ... + # + # @param originating_depository_financial_institution_id [String] An identifier for the originating bank. One of an International Bank Account Num + # ... + # + # @param originating_depository_financial_institution_id_qualifier [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::OriginatingDepositoryFinancialInstitutionIDQualifier] An instruction of how to interpret the `originating_depository_financial_institu + # ... + # + # @param originating_depository_financial_institution_name [String] The name of the originating bank. Sometimes this will refer to an American bank + # ... + # + # @param originator_city [String] A portion of the originator address. This may be incomplete. + # + # @param originator_country [String] A portion of the originator address. The [ISO 3166](https://en.wikipedia.org/wik + # ... + # + # @param originator_identification [String] An identifier for the originating company. This is generally stable across multi + # ... + # + # @param originator_name [String] Either the name of the originator or an intermediary money transmitter. + # + # @param originator_postal_code [String, nil] A portion of the originator address. This may be incomplete. + # + # @param originator_state_or_province [String, nil] A portion of the originator address. This may be incomplete. + # + # @param originator_street_address [String] A portion of the originator address. This may be incomplete. + # + # @param payment_related_information [String, nil] A description field set by the originator. + # + # @param payment_related_information2 [String, nil] A description field set by the originator. + # + # @param receiver_city [String] A portion of the receiver address. This may be incomplete. + # + # @param receiver_country [String] A portion of the receiver address. The [ISO 3166](https://en.wikipedia.org/wiki/ + # ... + # + # @param receiver_identification_number [String, nil] An identification number the originator uses for the receiver. + # + # @param receiver_postal_code [String, nil] A portion of the receiver address. This may be incomplete. + # + # @param receiver_state_or_province [String, nil] A portion of the receiver address. This may be incomplete. + # + # @param receiver_street_address [String] A portion of the receiver address. This may be incomplete. + # + # @param receiving_company_or_individual_name [String] The name of the receiver of the transfer. This is not verified by Increase. + # + # @param receiving_depository_financial_institution_country [String] The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 countr + # ... + # + # @param receiving_depository_financial_institution_id [String] An identifier for the receiving bank. One of an International Bank Account Numbe + # ... + # + # @param receiving_depository_financial_institution_id_qualifier [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ReceivingDepositoryFinancialInstitutionIDQualifier] An instruction of how to interpret the `receiving_depository_financial_instituti + # ... + # + # @param receiving_depository_financial_institution_name [String] The name of the receiving bank, as set by the sending financial institution. # A description of how the foreign exchange rate was calculated. # @@ -848,8 +939,9 @@ class NotificationOfChange < Increase::Internal::Type::BaseModel # If you initiate a notification of change in response to the transfer, this will # contain its details. # - # @param updated_account_number [String, nil] - # @param updated_routing_number [String, nil] + # @param updated_account_number [String, nil] The new account number provided in the notification of change. + # + # @param updated_routing_number [String, nil] The new account number provided in the notification of change. end # The Standard Entry Class (SEC) code of the transfer. @@ -955,9 +1047,11 @@ class TransferReturn < Increase::Internal::Type::BaseModel # @!method initialize(reason:, returned_at:, transaction_id:) # If your transfer is returned, this will contain details of the return. # - # @param reason [Symbol, Increase::Models::InboundACHTransfer::TransferReturn::Reason] - # @param returned_at [Time] - # @param transaction_id [String] + # @param reason [Symbol, Increase::Models::InboundACHTransfer::TransferReturn::Reason] The reason for the transfer return. + # + # @param returned_at [Time] The time at which the transfer was returned. + # + # @param transaction_id [String] The id of the transaction for the returned transfer. # The reason for the transfer return. # diff --git a/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb b/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb index b21b48cf6..0aa7c3521 100644 --- a/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb +++ b/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb @@ -20,8 +20,10 @@ class InboundACHTransferCreateNotificationOfChangeParams < Increase::Internal::T optional :updated_routing_number, String # @!method initialize(updated_account_number: nil, updated_routing_number: nil, request_options: {}) - # @param updated_account_number [String] - # @param updated_routing_number [String] + # @param updated_account_number [String] The updated account number to send in the notification of change. + # + # @param updated_routing_number [String] The updated routing number to send in the notification of change. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/inbound_ach_transfer_decline_params.rb b/lib/increase/models/inbound_ach_transfer_decline_params.rb index d26079e16..5ae463492 100644 --- a/lib/increase/models/inbound_ach_transfer_decline_params.rb +++ b/lib/increase/models/inbound_ach_transfer_decline_params.rb @@ -16,7 +16,12 @@ class InboundACHTransferDeclineParams < Increase::Internal::Type::BaseModel optional :reason, enum: -> { Increase::Models::InboundACHTransferDeclineParams::Reason } # @!method initialize(reason: nil, request_options: {}) - # @param reason [Symbol, Increase::Models::InboundACHTransferDeclineParams::Reason] + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundACHTransferDeclineParams} for more details. + # + # @param reason [Symbol, Increase::Models::InboundACHTransferDeclineParams::Reason] The reason why this transfer will be returned. If this parameter is unset, the r + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The reason why this transfer will be returned. If this parameter is unset, the diff --git a/lib/increase/models/inbound_ach_transfer_list_params.rb b/lib/increase/models/inbound_ach_transfer_list_params.rb index 5d623655f..4b5e05939 100644 --- a/lib/increase/models/inbound_ach_transfer_list_params.rb +++ b/lib/increase/models/inbound_ach_transfer_list_params.rb @@ -43,12 +43,22 @@ class InboundACHTransferListParams < Increase::Internal::Type::BaseModel optional :status, -> { Increase::Models::InboundACHTransferListParams::Status } # @!method initialize(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, status: nil, request_options: {}) - # @param account_id [String] - # @param account_number_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundACHTransferListParams} for more details. + # + # @param account_id [String] Filter Inbound ACH Transfers to ones belonging to the specified Account. + # + # @param account_number_id [String] Filter Inbound ACH Transfers to ones belonging to the specified Account Number. + # # @param created_at [Increase::Models::InboundACHTransferListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # # @param status [Increase::Models::InboundACHTransferListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel @@ -81,10 +91,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundACHTransferListParams::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 @@ -99,7 +119,11 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundACHTransferListParams::Status} for more details. + # + # @param in_ [Array] Filter Inbound ACH Transfers to those with the specified status. For GET request + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb b/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb index 440397bd3..7fce67245 100644 --- a/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb +++ b/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb @@ -15,7 +15,12 @@ class InboundACHTransferTransferReturnParams < Increase::Internal::Type::BaseMod required :reason, enum: -> { Increase::Models::InboundACHTransferTransferReturnParams::Reason } # @!method initialize(reason:, request_options: {}) - # @param reason [Symbol, Increase::Models::InboundACHTransferTransferReturnParams::Reason] + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundACHTransferTransferReturnParams} for more details. + # + # @param reason [Symbol, Increase::Models::InboundACHTransferTransferReturnParams::Reason] The reason why this transfer will be returned. The most usual return codes are ` + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The reason why this transfer will be returned. The most usual return codes are diff --git a/lib/increase/models/inbound_check_deposit.rb b/lib/increase/models/inbound_check_deposit.rb index 7e83ca698..786b2d0f6 100644 --- a/lib/increase/models/inbound_check_deposit.rb +++ b/lib/increase/models/inbound_check_deposit.rb @@ -140,29 +140,62 @@ class InboundCheckDeposit < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::InboundCheckDeposit::Type } # @!method initialize(id:, accepted_at:, account_id:, account_number_id:, adjustments:, amount:, back_image_file_id:, bank_of_first_deposit_routing_number:, check_number:, check_transfer_id:, created_at:, currency:, declined_at:, declined_transaction_id:, deposit_return:, front_image_file_id:, payee_name_analysis:, status:, transaction_id:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundCheckDeposit} for more details. + # # Inbound Check Deposits are records of third-parties attempting to deposit checks # against your account. # - # @param id [String] - # @param accepted_at [Time, nil] - # @param account_id [String] - # @param account_number_id [String, nil] - # @param adjustments [Array] - # @param amount [Integer] - # @param back_image_file_id [String, nil] - # @param bank_of_first_deposit_routing_number [String, nil] - # @param check_number [String, nil] - # @param check_transfer_id [String, nil] - # @param created_at [Time] - # @param currency [Symbol, Increase::Models::InboundCheckDeposit::Currency] - # @param declined_at [Time, nil] - # @param declined_transaction_id [String, nil] - # @param deposit_return [Increase::Models::InboundCheckDeposit::DepositReturn, nil] - # @param front_image_file_id [String, nil] - # @param payee_name_analysis [Symbol, Increase::Models::InboundCheckDeposit::PayeeNameAnalysis] - # @param status [Symbol, Increase::Models::InboundCheckDeposit::Status] - # @param transaction_id [String, nil] - # @param type [Symbol, Increase::Models::InboundCheckDeposit::Type] + # @param id [String] The deposit's identifier. + # + # @param accepted_at [Time, nil] If the Inbound Check Deposit was accepted, the [ISO 8601](https://en.wikipedia.o + # ... + # + # @param account_id [String] The Account the check is being deposited against. + # + # @param account_number_id [String, nil] The Account Number the check is being deposited against. + # + # @param adjustments [Array] If the deposit or the return was adjusted by the sending institution, this will + # ... + # + # @param amount [Integer] The deposited amount in USD cents. + # + # @param back_image_file_id [String, nil] The ID for the File containing the image of the back of the check. + # + # @param bank_of_first_deposit_routing_number [String, nil] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the ban + # ... + # + # @param check_number [String, nil] The check number printed on the check being deposited. + # + # @param check_transfer_id [String, nil] If this deposit is for an existing Check Transfer, the identifier of that Check + # ... + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param currency [Symbol, Increase::Models::InboundCheckDeposit::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit. + # + # @param declined_at [Time, nil] If the Inbound Check Deposit was declined, the [ISO 8601](https://en.wikipedia.o + # ... + # + # @param declined_transaction_id [String, nil] If the deposit attempt has been rejected, the identifier of the Declined Transac + # ... + # + # @param deposit_return [Increase::Models::InboundCheckDeposit::DepositReturn, nil] If you requested a return of this deposit, this will contain details of the retu + # ... + # + # @param front_image_file_id [String, nil] The ID for the File containing the image of the front of the check. + # + # @param payee_name_analysis [Symbol, Increase::Models::InboundCheckDeposit::PayeeNameAnalysis] Whether the details on the check match the recipient name of the check transfer. + # ... + # + # @param status [Symbol, Increase::Models::InboundCheckDeposit::Status] The status of the Inbound Check Deposit. + # + # @param transaction_id [String, nil] If the deposit attempt has been accepted, the identifier of the Transaction obje + # ... + # + # @param type [Symbol, Increase::Models::InboundCheckDeposit::Type] A constant representing the object's type. For this resource it will always be ` + # ... class Adjustment < Increase::Internal::Type::BaseModel # @!attribute adjusted_at @@ -190,10 +223,13 @@ class Adjustment < Increase::Internal::Type::BaseModel required :transaction_id, String # @!method initialize(adjusted_at:, amount:, reason:, transaction_id:) - # @param adjusted_at [Time] - # @param amount [Integer] - # @param reason [Symbol, Increase::Models::InboundCheckDeposit::Adjustment::Reason] - # @param transaction_id [String] + # @param adjusted_at [Time] The time at which the return adjustment was received. + # + # @param amount [Integer] The amount of the adjustment. + # + # @param reason [Symbol, Increase::Models::InboundCheckDeposit::Adjustment::Reason] The reason for the adjustment. + # + # @param transaction_id [String] The id of the transaction for the adjustment. # The reason for the adjustment. # @@ -270,9 +306,11 @@ class DepositReturn < Increase::Internal::Type::BaseModel # If you requested a return of this deposit, this will contain details of the # return. # - # @param reason [Symbol, Increase::Models::InboundCheckDeposit::DepositReturn::Reason] - # @param returned_at [Time] - # @param transaction_id [String] + # @param reason [Symbol, Increase::Models::InboundCheckDeposit::DepositReturn::Reason] The reason the deposit was returned. + # + # @param returned_at [Time] The time at which the deposit was returned. + # + # @param transaction_id [String] The id of the transaction for the returned deposit. # The reason the deposit was returned. # diff --git a/lib/increase/models/inbound_check_deposit_list_params.rb b/lib/increase/models/inbound_check_deposit_list_params.rb index 737a68d23..9a66ec84e 100644 --- a/lib/increase/models/inbound_check_deposit_list_params.rb +++ b/lib/increase/models/inbound_check_deposit_list_params.rb @@ -39,11 +39,21 @@ class InboundCheckDepositListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(account_id: nil, check_transfer_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) - # @param account_id [String] - # @param check_transfer_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundCheckDepositListParams} for more details. + # + # @param account_id [String] Filter Inbound Check Deposits to those belonging to the specified Account. + # + # @param check_transfer_id [String] Filter Inbound Check Deposits to those belonging to the specified Check Transfer + # ... + # # @param created_at [Increase::Models::InboundCheckDepositListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @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 @@ -76,10 +86,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundCheckDepositListParams::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 diff --git a/lib/increase/models/inbound_check_deposit_return_params.rb b/lib/increase/models/inbound_check_deposit_return_params.rb index 524870b0b..45079a43c 100644 --- a/lib/increase/models/inbound_check_deposit_return_params.rb +++ b/lib/increase/models/inbound_check_deposit_return_params.rb @@ -14,7 +14,8 @@ class InboundCheckDepositReturnParams < Increase::Internal::Type::BaseModel required :reason, enum: -> { Increase::Models::InboundCheckDepositReturnParams::Reason } # @!method initialize(reason:, request_options: {}) - # @param reason [Symbol, Increase::Models::InboundCheckDepositReturnParams::Reason] + # @param reason [Symbol, Increase::Models::InboundCheckDepositReturnParams::Reason] The reason to return the Inbound Check Deposit. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The reason to return the Inbound Check Deposit. diff --git a/lib/increase/models/inbound_mail_item.rb b/lib/increase/models/inbound_mail_item.rb index 14b08fcc5..b644386e0 100644 --- a/lib/increase/models/inbound_mail_item.rb +++ b/lib/increase/models/inbound_mail_item.rb @@ -56,16 +56,29 @@ class InboundMailItem < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::InboundMailItem::Type } # @!method initialize(id:, created_at:, file_id:, lockbox_id:, recipient_name:, rejection_reason:, status:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundMailItem} for more details. + # # Inbound Mail Items represent pieces of physical mail delivered to a Lockbox. # - # @param id [String] - # @param created_at [Time] - # @param file_id [String] - # @param lockbox_id [String, nil] - # @param recipient_name [String, nil] - # @param rejection_reason [Symbol, Increase::Models::InboundMailItem::RejectionReason, nil] - # @param status [Symbol, Increase::Models::InboundMailItem::Status] - # @param type [Symbol, Increase::Models::InboundMailItem::Type] + # @param id [String] The Inbound Mail Item identifier. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Inbound + # ... + # + # @param file_id [String] The identifier for the File containing the scanned contents of the mail item. + # + # @param lockbox_id [String, nil] The identifier for the Lockbox that received this mail item. For mail items that + # ... + # + # @param recipient_name [String, nil] The recipient name as written on the mail item. + # + # @param rejection_reason [Symbol, Increase::Models::InboundMailItem::RejectionReason, nil] If the mail item has been rejected, why it was rejected. + # + # @param status [Symbol, Increase::Models::InboundMailItem::Status] If the mail item has been processed. + # + # @param type [Symbol, Increase::Models::InboundMailItem::Type] A constant representing the object's type. For this resource it will always be ` + # ... # If the mail item has been rejected, why it was rejected. # diff --git a/lib/increase/models/inbound_mail_item_list_params.rb b/lib/increase/models/inbound_mail_item_list_params.rb index badf23785..ca221519c 100644 --- a/lib/increase/models/inbound_mail_item_list_params.rb +++ b/lib/increase/models/inbound_mail_item_list_params.rb @@ -32,10 +32,18 @@ class InboundMailItemListParams < Increase::Internal::Type::BaseModel optional :lockbox_id, String # @!method initialize(created_at: nil, cursor: nil, limit: nil, lockbox_id: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundMailItemListParams} for more details. + # # @param created_at [Increase::Models::InboundMailItemListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] - # @param lockbox_id [String] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # + # @param lockbox_id [String] Filter Inbound Mail Items to ones sent to the provided Lockbox. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel @@ -68,10 +76,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundMailItemListParams::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 diff --git a/lib/increase/models/inbound_real_time_payments_transfer.rb b/lib/increase/models/inbound_real_time_payments_transfer.rb index c9fd01277..c84e1d1ec 100755 --- a/lib/increase/models/inbound_real_time_payments_transfer.rb +++ b/lib/increase/models/inbound_real_time_payments_transfer.rb @@ -104,25 +104,46 @@ class InboundRealTimePaymentsTransfer < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::InboundRealTimePaymentsTransfer::Type } # @!method initialize(id:, account_id:, account_number_id:, amount:, confirmation:, created_at:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, decline:, remittance_information:, status:, transaction_identification:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundRealTimePaymentsTransfer} for more details. + # # An Inbound Real-Time Payments Transfer is a Real-Time Payments transfer # initiated outside of Increase to your account. # - # @param id [String] - # @param account_id [String] - # @param account_number_id [String] - # @param amount [Integer] - # @param confirmation [Increase::Models::InboundRealTimePaymentsTransfer::Confirmation, nil] - # @param created_at [Time] - # @param creditor_name [String] - # @param currency [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Currency] - # @param debtor_account_number [String] - # @param debtor_name [String] - # @param debtor_routing_number [String] - # @param decline [Increase::Models::InboundRealTimePaymentsTransfer::Decline, nil] - # @param remittance_information [String, nil] - # @param status [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Status] - # @param transaction_identification [String] - # @param type [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Type] + # @param id [String] The inbound Real-Time Payments transfer's identifier. + # + # @param account_id [String] The Account to which the transfer was sent. + # + # @param account_number_id [String] The identifier of the Account Number to which this transfer was sent. + # + # @param amount [Integer] The amount in USD cents. + # + # @param confirmation [Increase::Models::InboundRealTimePaymentsTransfer::Confirmation, nil] If your transfer is confirmed, this will contain details of the confirmation. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param creditor_name [String] The name the sender of the transfer specified as the recipient of the transfer. + # + # @param currency [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's cu + # ... + # + # @param debtor_account_number [String] The account number of the account that sent the transfer. + # + # @param debtor_name [String] The name provided by the sender of the transfer. + # + # @param debtor_routing_number [String] The routing number of the account that sent the transfer. + # + # @param decline [Increase::Models::InboundRealTimePaymentsTransfer::Decline, nil] If your transfer is declined, this will contain details of the decline. + # + # @param remittance_information [String, nil] Additional information included with the transfer. + # + # @param status [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Status] The lifecycle status of the transfer. + # + # @param transaction_identification [String] The Real-Time Payments network identification of the transfer. + # + # @param type [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Type] A constant representing the object's type. For this resource it will always be ` + # ... # @see Increase::Models::InboundRealTimePaymentsTransfer#confirmation class Confirmation < Increase::Internal::Type::BaseModel @@ -141,8 +162,9 @@ class Confirmation < Increase::Internal::Type::BaseModel # @!method initialize(confirmed_at:, transaction_id:) # If your transfer is confirmed, this will contain details of the confirmation. # - # @param confirmed_at [Time] - # @param transaction_id [String] + # @param confirmed_at [Time] The time at which the transfer was confirmed. + # + # @param transaction_id [String] The id of the transaction for the confirmed transfer. end # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's @@ -197,9 +219,11 @@ class Decline < Increase::Internal::Type::BaseModel # @!method initialize(declined_at:, declined_transaction_id:, reason:) # If your transfer is declined, this will contain details of the decline. # - # @param declined_at [Time] - # @param declined_transaction_id [String] - # @param reason [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Decline::Reason] + # @param declined_at [Time] The time at which the transfer was declined. + # + # @param declined_transaction_id [String] The id of the transaction for the declined transfer. + # + # @param reason [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Decline::Reason] The reason for the transfer decline. # The reason for the transfer decline. # diff --git a/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb b/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb index 8de9120a7..8766c9823 100644 --- a/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb +++ b/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb @@ -40,11 +40,22 @@ class InboundRealTimePaymentsTransferListParams < Increase::Internal::Type::Base optional :limit, Integer # @!method initialize(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) - # @param account_id [String] - # @param account_number_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundRealTimePaymentsTransferListParams} for more details. + # + # @param account_id [String] Filter Inbound Real-Time Payments Transfers to those belonging to the specified + # ... + # + # @param account_number_id [String] Filter Inbound Real-Time Payments Transfers to ones belonging to the specified A + # ... + # # @param created_at [Increase::Models::InboundRealTimePaymentsTransferListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @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 @@ -77,10 +88,21 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundRealTimePaymentsTransferListParams::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 diff --git a/lib/increase/models/inbound_wire_drawdown_request.rb b/lib/increase/models/inbound_wire_drawdown_request.rb index 7c7917f97..57369a856 100644 --- a/lib/increase/models/inbound_wire_drawdown_request.rb +++ b/lib/increase/models/inbound_wire_drawdown_request.rb @@ -151,33 +151,66 @@ class InboundWireDrawdownRequest < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::InboundWireDrawdownRequest::Type } # @!method initialize(id:, amount:, beneficiary_account_number:, beneficiary_address_line1:, beneficiary_address_line2:, beneficiary_address_line3:, beneficiary_name:, beneficiary_routing_number:, created_at:, currency:, message_to_recipient:, originator_account_number:, originator_address_line1:, originator_address_line2:, originator_address_line3:, originator_name:, originator_routing_number:, originator_to_beneficiary_information_line1:, originator_to_beneficiary_information_line2:, originator_to_beneficiary_information_line3:, originator_to_beneficiary_information_line4:, recipient_account_number_id:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundWireDrawdownRequest} for more details. + # # Inbound wire drawdown requests are requests from someone else to send them a # wire. This feature is in beta; reach out to # [support@increase.com](mailto:support@increase.com) to learn more. # - # @param id [String] - # @param amount [Integer] - # @param beneficiary_account_number [String] - # @param beneficiary_address_line1 [String, nil] - # @param beneficiary_address_line2 [String, nil] - # @param beneficiary_address_line3 [String, nil] - # @param beneficiary_name [String, nil] - # @param beneficiary_routing_number [String] - # @param created_at [Time] - # @param currency [String] - # @param message_to_recipient [String, nil] - # @param originator_account_number [String, nil] - # @param originator_address_line1 [String, nil] - # @param originator_address_line2 [String, nil] - # @param originator_address_line3 [String, nil] - # @param originator_name [String, nil] - # @param originator_routing_number [String] - # @param originator_to_beneficiary_information_line1 [String, nil] - # @param originator_to_beneficiary_information_line2 [String, nil] - # @param originator_to_beneficiary_information_line3 [String, nil] - # @param originator_to_beneficiary_information_line4 [String, nil] - # @param recipient_account_number_id [String] - # @param type [Symbol, Increase::Models::InboundWireDrawdownRequest::Type] + # @param id [String] The Wire drawdown request identifier. + # + # @param amount [Integer] The amount being requested in cents. + # + # @param beneficiary_account_number [String] The drawdown request's beneficiary's account number. + # + # @param beneficiary_address_line1 [String, nil] Line 1 of the drawdown request's beneficiary's address. + # + # @param beneficiary_address_line2 [String, nil] Line 2 of the drawdown request's beneficiary's address. + # + # @param beneficiary_address_line3 [String, nil] Line 3 of the drawdown request's beneficiary's address. + # + # @param beneficiary_name [String, nil] The drawdown request's beneficiary's name. + # + # @param beneficiary_routing_number [String] The drawdown request's beneficiary's routing number. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being + # ... + # + # @param message_to_recipient [String, nil] A message from the drawdown request's originator. + # + # @param originator_account_number [String, nil] The drawdown request's originator's account number. + # + # @param originator_address_line1 [String, nil] Line 1 of the drawdown request's originator's address. + # + # @param originator_address_line2 [String, nil] Line 2 of the drawdown request's originator's address. + # + # @param originator_address_line3 [String, nil] Line 3 of the drawdown request's originator's address. + # + # @param originator_name [String, nil] The drawdown request's originator's name. + # + # @param originator_routing_number [String] The drawdown request's originator's routing number. + # + # @param originator_to_beneficiary_information_line1 [String, nil] Line 1 of the information conveyed from the originator of the message to the ben + # ... + # + # @param originator_to_beneficiary_information_line2 [String, nil] Line 2 of the information conveyed from the originator of the message to the ben + # ... + # + # @param originator_to_beneficiary_information_line3 [String, nil] Line 3 of the information conveyed from the originator of the message to the ben + # ... + # + # @param originator_to_beneficiary_information_line4 [String, nil] Line 4 of the information conveyed from the originator of the message to the ben + # ... + # + # @param recipient_account_number_id [String] The Account Number from which the recipient of this request is being requested t + # ... + # + # @param type [Symbol, Increase::Models::InboundWireDrawdownRequest::Type] A constant representing the object's type. For this resource it will always be ` + # ... # A constant representing the object's type. For this resource it will always be # `inbound_wire_drawdown_request`. diff --git a/lib/increase/models/inbound_wire_drawdown_request_list_params.rb b/lib/increase/models/inbound_wire_drawdown_request_list_params.rb index bb0d1c8cc..de21241de 100644 --- a/lib/increase/models/inbound_wire_drawdown_request_list_params.rb +++ b/lib/increase/models/inbound_wire_drawdown_request_list_params.rb @@ -21,8 +21,14 @@ class InboundWireDrawdownRequestListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(cursor: nil, limit: nil, request_options: {}) - # @param cursor [String] - # @param limit [Integer] + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundWireDrawdownRequestListParams} for more details. + # + # @param cursor [String] Return the page of entries after this one. + # + # @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 diff --git a/lib/increase/models/inbound_wire_transfer.rb b/lib/increase/models/inbound_wire_transfer.rb index 62188a7aa..583b1e0bc 100644 --- a/lib/increase/models/inbound_wire_transfer.rb +++ b/lib/increase/models/inbound_wire_transfer.rb @@ -160,34 +160,65 @@ class InboundWireTransfer < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::InboundWireTransfer::Type } # @!method initialize(id:, account_id:, account_number_id:, amount:, beneficiary_address_line1:, beneficiary_address_line2:, beneficiary_address_line3:, beneficiary_name:, beneficiary_reference:, created_at:, description:, input_message_accountability_data:, originator_address_line1:, originator_address_line2:, originator_address_line3:, originator_name:, originator_routing_number:, originator_to_beneficiary_information:, originator_to_beneficiary_information_line1:, originator_to_beneficiary_information_line2:, originator_to_beneficiary_information_line3:, originator_to_beneficiary_information_line4:, sender_reference:, status:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundWireTransfer} for more details. + # # An Inbound Wire Transfer is a wire transfer initiated outside of Increase to # your account. # - # @param id [String] - # @param account_id [String] - # @param account_number_id [String] - # @param amount [Integer] - # @param beneficiary_address_line1 [String, nil] - # @param beneficiary_address_line2 [String, nil] - # @param beneficiary_address_line3 [String, nil] - # @param beneficiary_name [String, nil] - # @param beneficiary_reference [String, nil] - # @param created_at [Time] - # @param description [String] - # @param input_message_accountability_data [String, nil] - # @param originator_address_line1 [String, nil] - # @param originator_address_line2 [String, nil] - # @param originator_address_line3 [String, nil] - # @param originator_name [String, nil] - # @param originator_routing_number [String, nil] - # @param originator_to_beneficiary_information [String, nil] - # @param originator_to_beneficiary_information_line1 [String, nil] - # @param originator_to_beneficiary_information_line2 [String, nil] - # @param originator_to_beneficiary_information_line3 [String, nil] - # @param originator_to_beneficiary_information_line4 [String, nil] - # @param sender_reference [String, nil] - # @param status [Symbol, Increase::Models::InboundWireTransfer::Status] - # @param type [Symbol, Increase::Models::InboundWireTransfer::Type] + # @param id [String] The inbound wire transfer's identifier. + # + # @param account_id [String] The Account to which the transfer belongs. + # + # @param account_number_id [String] The identifier of the Account Number to which this transfer was sent. + # + # @param amount [Integer] The amount in USD cents. + # + # @param beneficiary_address_line1 [String, nil] A free-form address field set by the sender. + # + # @param beneficiary_address_line2 [String, nil] A free-form address field set by the sender. + # + # @param beneficiary_address_line3 [String, nil] A free-form address field set by the sender. + # + # @param beneficiary_name [String, nil] A name set by the sender. + # + # @param beneficiary_reference [String, nil] A free-form reference string set by the sender, to help identify the transfer. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param description [String] An Increase-constructed description of the transfer. + # + # @param input_message_accountability_data [String, nil] A unique identifier available to the originating and receiving banks, commonly a + # ... + # + # @param originator_address_line1 [String, nil] The address of the wire originator, set by the sending bank. + # + # @param originator_address_line2 [String, nil] The address of the wire originator, set by the sending bank. + # + # @param originator_address_line3 [String, nil] The address of the wire originator, set by the sending bank. + # + # @param originator_name [String, nil] The originator of the wire, set by the sending bank. + # + # @param originator_routing_number [String, nil] The American Banking Association (ABA) routing number of the bank originating th + # ... + # + # @param originator_to_beneficiary_information [String, nil] An Increase-created concatenation of the Originator-to-Beneficiary lines. + # + # @param originator_to_beneficiary_information_line1 [String, nil] A free-form message set by the wire originator. + # + # @param originator_to_beneficiary_information_line2 [String, nil] A free-form message set by the wire originator. + # + # @param originator_to_beneficiary_information_line3 [String, nil] A free-form message set by the wire originator. + # + # @param originator_to_beneficiary_information_line4 [String, nil] A free-form message set by the wire originator. + # + # @param sender_reference [String, nil] The sending bank's reference number for the wire transfer. + # + # @param status [Symbol, Increase::Models::InboundWireTransfer::Status] The status of the transfer. + # + # @param type [Symbol, Increase::Models::InboundWireTransfer::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The status of the transfer. # diff --git a/lib/increase/models/inbound_wire_transfer_list_params.rb b/lib/increase/models/inbound_wire_transfer_list_params.rb index 02a9b1397..99b773c62 100644 --- a/lib/increase/models/inbound_wire_transfer_list_params.rb +++ b/lib/increase/models/inbound_wire_transfer_list_params.rb @@ -43,12 +43,23 @@ class InboundWireTransferListParams < Increase::Internal::Type::BaseModel optional :status, -> { Increase::Models::InboundWireTransferListParams::Status } # @!method initialize(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, status: nil, request_options: {}) - # @param account_id [String] - # @param account_number_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundWireTransferListParams} for more details. + # + # @param account_id [String] Filter Inbound Wire Transfers to ones belonging to the specified Account. + # + # @param account_number_id [String] Filter Inbound Wire Transfers to ones belonging to the specified Account Number. + # ... + # # @param created_at [Increase::Models::InboundWireTransferListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # # @param status [Increase::Models::InboundWireTransferListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel @@ -81,10 +92,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundWireTransferListParams::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 @@ -99,7 +120,11 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundWireTransferListParams::Status} for more details. + # + # @param in_ [Array] Filter Inbound Wire Transfers to those with the specified status. For GET reques + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/intrafi_account_enrollment.rb b/lib/increase/models/intrafi_account_enrollment.rb index ff7dac814..d999b8609 100644 --- a/lib/increase/models/intrafi_account_enrollment.rb +++ b/lib/increase/models/intrafi_account_enrollment.rb @@ -53,6 +53,9 @@ class IntrafiAccountEnrollment < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::IntrafiAccountEnrollment::Type } # @!method initialize(id:, account_id:, created_at:, idempotency_key:, intrafi_id:, status:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::IntrafiAccountEnrollment} for more details. + # # IntraFi is a # [network of financial institutions](https://www.intrafi.com/network-banks) that # allows Increase users to sweep funds to multiple banks, in addition to @@ -61,13 +64,24 @@ class IntrafiAccountEnrollment < Increase::Internal::Type::BaseModel # Account Enrollment object represents the status of an account in the network. # Sweeping an account to IntraFi doesn't affect funds availability. # - # @param id [String] - # @param account_id [String] - # @param created_at [Time] - # @param idempotency_key [String, nil] - # @param intrafi_id [String] - # @param status [Symbol, Increase::Models::IntrafiAccountEnrollment::Status] - # @param type [Symbol, Increase::Models::IntrafiAccountEnrollment::Type] + # @param id [String] The identifier of this enrollment at IntraFi. + # + # @param account_id [String] The identifier of the Increase Account being swept into the network. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param intrafi_id [String] The identifier of the account in IntraFi's system. This identifier will be print + # ... + # + # @param status [Symbol, Increase::Models::IntrafiAccountEnrollment::Status] The status of the account in the network. An account takes about one business da + # ... + # + # @param type [Symbol, Increase::Models::IntrafiAccountEnrollment::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The status of the account in the network. An account takes about one business # day to go from `pending_enrolling` to `enrolled`. diff --git a/lib/increase/models/intrafi_account_enrollment_create_params.rb b/lib/increase/models/intrafi_account_enrollment_create_params.rb index 51b4843c1..0624477fe 100644 --- a/lib/increase/models/intrafi_account_enrollment_create_params.rb +++ b/lib/increase/models/intrafi_account_enrollment_create_params.rb @@ -20,8 +20,10 @@ class IntrafiAccountEnrollmentCreateParams < Increase::Internal::Type::BaseModel required :email_address, String # @!method initialize(account_id:, email_address:, request_options: {}) - # @param account_id [String] - # @param email_address [String] + # @param account_id [String] The identifier for the account to be added to IntraFi. + # + # @param email_address [String] The contact email for the account owner, to be shared with IntraFi. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/intrafi_account_enrollment_list_params.rb b/lib/increase/models/intrafi_account_enrollment_list_params.rb index 138c5b1ab..7655d1c71 100644 --- a/lib/increase/models/intrafi_account_enrollment_list_params.rb +++ b/lib/increase/models/intrafi_account_enrollment_list_params.rb @@ -41,11 +41,21 @@ class IntrafiAccountEnrollmentListParams < Increase::Internal::Type::BaseModel optional :status, -> { Increase::Models::IntrafiAccountEnrollmentListParams::Status } # @!method initialize(account_id: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) - # @param account_id [String] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # Some parameter documentations has been truncated, see + # {Increase::Models::IntrafiAccountEnrollmentListParams} for more details. + # + # @param account_id [String] Filter IntraFi Account Enrollments to the one belonging to an account. + # + # @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::IntrafiAccountEnrollmentListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Status < Increase::Internal::Type::BaseModel @@ -60,7 +70,11 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::IntrafiAccountEnrollmentListParams::Status} for more details. + # + # @param in_ [Array] Filter IntraFi Account Enrollments for those with the specified status or status + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/intrafi_balance.rb b/lib/increase/models/intrafi_balance.rb index 63f57ab75..c41758d7d 100644 --- a/lib/increase/models/intrafi_balance.rb +++ b/lib/increase/models/intrafi_balance.rb @@ -45,16 +45,28 @@ class IntrafiBalance < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::IntrafiBalance::Type } # @!method initialize(id:, balances:, currency:, effective_date:, total_balance:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::IntrafiBalance} for more details. + # # When using IntraFi, each account's balance over the standard FDIC insurance # amount are swept to various other institutions. Funds are rebalanced across # banks as needed once per business day. # - # @param id [String] - # @param balances [Array] - # @param currency [Symbol, Increase::Models::IntrafiBalance::Currency] - # @param effective_date [Date] - # @param total_balance [Integer] - # @param type [Symbol, Increase::Models::IntrafiBalance::Type] + # @param id [String] The identifier of this balance. + # + # @param balances [Array] Each entry represents a balance held at a different bank. IntraFi separates the + # ... + # + # @param currency [Symbol, Increase::Models::IntrafiBalance::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the account curr + # ... + # + # @param effective_date [Date] The date this balance reflects. + # + # @param total_balance [Integer] The total balance, in minor units of `currency`. Increase reports this balance t + # ... + # + # @param type [Symbol, Increase::Models::IntrafiBalance::Type] A constant representing the object's type. For this resource it will always be ` + # ... class Balance < Increase::Internal::Type::BaseModel # @!attribute id @@ -90,11 +102,19 @@ class Balance < Increase::Internal::Type::BaseModel required :fdic_certificate_number, String # @!method initialize(id:, balance:, bank:, bank_location:, fdic_certificate_number:) - # @param id [String] - # @param balance [Integer] - # @param bank [String] - # @param bank_location [Increase::Models::IntrafiBalance::Balance::BankLocation, nil] - # @param fdic_certificate_number [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::IntrafiBalance::Balance} for more details. + # + # @param id [String] The identifier of this balance. + # + # @param balance [Integer] The balance, in minor units of `currency`, held with this bank. + # + # @param bank [String] The name of the bank holding these funds. + # + # @param bank_location [Increase::Models::IntrafiBalance::Balance::BankLocation, nil] The primary location of the bank. + # + # @param fdic_certificate_number [String] The Federal Deposit Insurance Corporation (FDIC) certificate number of the bank. + # ... # @see Increase::Models::IntrafiBalance::Balance#bank_location class BankLocation < Increase::Internal::Type::BaseModel @@ -113,8 +133,9 @@ class BankLocation < Increase::Internal::Type::BaseModel # @!method initialize(city:, state:) # The primary location of the bank. # - # @param city [String] - # @param state [String] + # @param city [String] The bank's city. + # + # @param state [String] The bank's state. end end diff --git a/lib/increase/models/intrafi_exclusion.rb b/lib/increase/models/intrafi_exclusion.rb index dc899728b..8c88de691 100644 --- a/lib/increase/models/intrafi_exclusion.rb +++ b/lib/increase/models/intrafi_exclusion.rb @@ -70,21 +70,37 @@ class IntrafiExclusion < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::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] - # @param bank_name [String] - # @param created_at [Time] - # @param entity_id [String] - # @param excluded_at [Time, nil] - # @param fdic_certificate_number [String, nil] - # @param idempotency_key [String, nil] - # @param status [Symbol, Increase::Models::IntrafiExclusion::Status] - # @param submitted_at [Time, nil] - # @param type [Symbol, Increase::Models::IntrafiExclusion::Type] + # @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. # diff --git a/lib/increase/models/intrafi_exclusion_create_params.rb b/lib/increase/models/intrafi_exclusion_create_params.rb index 7f8c7183e..3e3a23ef7 100644 --- a/lib/increase/models/intrafi_exclusion_create_params.rb +++ b/lib/increase/models/intrafi_exclusion_create_params.rb @@ -20,8 +20,10 @@ class IntrafiExclusionCreateParams < Increase::Internal::Type::BaseModel required :entity_id, String # @!method initialize(bank_name:, entity_id:, request_options: {}) - # @param bank_name [String] - # @param entity_id [String] + # @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 diff --git a/lib/increase/models/intrafi_exclusion_list_params.rb b/lib/increase/models/intrafi_exclusion_list_params.rb index d823c9736..e36317127 100644 --- a/lib/increase/models/intrafi_exclusion_list_params.rb +++ b/lib/increase/models/intrafi_exclusion_list_params.rb @@ -36,10 +36,19 @@ class IntrafiExclusionListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(cursor: nil, entity_id: nil, idempotency_key: nil, limit: nil, request_options: {}) - # @param cursor [String] - # @param entity_id [String] - # @param idempotency_key [String] - # @param limit [Integer] + # 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 diff --git a/lib/increase/models/lockbox.rb b/lib/increase/models/lockbox.rb index 85fe1e38b..2930f03c0 100644 --- a/lib/increase/models/lockbox.rb +++ b/lib/increase/models/lockbox.rb @@ -64,18 +64,33 @@ class Lockbox < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::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] - # @param account_id [String] - # @param address [Increase::Models::Lockbox::Address] - # @param created_at [Time] - # @param description [String, nil] - # @param idempotency_key [String, nil] - # @param recipient_name [String, nil] - # @param status [Symbol, Increase::Models::Lockbox::Status] - # @param type [Symbol, Increase::Models::Lockbox::Type] + # @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 @@ -120,14 +135,24 @@ class Address < Increase::Internal::Type::BaseModel 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] - # @param line1 [String] - # @param line2 [String] - # @param postal_code [String] - # @param recipient [String, nil] - # @param state [String] + # @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. diff --git a/lib/increase/models/lockbox_create_params.rb b/lib/increase/models/lockbox_create_params.rb index 70fa558ad..fcbfc1962 100644 --- a/lib/increase/models/lockbox_create_params.rb +++ b/lib/increase/models/lockbox_create_params.rb @@ -26,9 +26,12 @@ class LockboxCreateParams < Increase::Internal::Type::BaseModel optional :recipient_name, String # @!method initialize(account_id:, description: nil, recipient_name: nil, request_options: {}) - # @param account_id [String] - # @param description [String] - # @param recipient_name [String] + # @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 diff --git a/lib/increase/models/lockbox_list_params.rb b/lib/increase/models/lockbox_list_params.rb index 08e10245b..af743c36f 100644 --- a/lib/increase/models/lockbox_list_params.rb +++ b/lib/increase/models/lockbox_list_params.rb @@ -41,11 +41,21 @@ class LockboxListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) - # @param account_id [String] + # 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] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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 @@ -78,10 +88,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # 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 diff --git a/lib/increase/models/lockbox_update_params.rb b/lib/increase/models/lockbox_update_params.rb index 45536c9fa..12d69ad8c 100644 --- a/lib/increase/models/lockbox_update_params.rb +++ b/lib/increase/models/lockbox_update_params.rb @@ -26,9 +26,12 @@ class LockboxUpdateParams < Increase::Internal::Type::BaseModel optional :status, enum: -> { Increase::Models::LockboxUpdateParams::Status } # @!method initialize(description: nil, recipient_name: nil, status: nil, request_options: {}) - # @param description [String] - # @param recipient_name [String] - # @param status [Symbol, Increase::Models::LockboxUpdateParams::Status] + # @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. diff --git a/lib/increase/models/oauth_application.rb b/lib/increase/models/oauth_application.rb index 46f2dc1e5..e93731341 100644 --- a/lib/increase/models/oauth_application.rb +++ b/lib/increase/models/oauth_application.rb @@ -51,18 +51,31 @@ class OAuthApplication < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::OAuthApplication::Type } # @!method initialize(id:, client_id:, created_at:, deleted_at:, name:, status:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::OAuthApplication} for more details. + # # An OAuth Application lets you build an application for others to use with their # Increase data. You can create an OAuth Application via the Dashboard and read # information about it with the API. Learn more about OAuth # [here](https://increase.com/documentation/oauth). # - # @param id [String] - # @param client_id [String] - # @param created_at [Time] - # @param deleted_at [Time, nil] - # @param name [String, nil] - # @param status [Symbol, Increase::Models::OAuthApplication::Status] - # @param type [Symbol, Increase::Models::OAuthApplication::Type] + # @param id [String] The OAuth Application's identifier. + # + # @param client_id [String] The OAuth Application's client_id. Use this to authenticate with the OAuth Appli + # ... + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth + # ... + # + # @param deleted_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth + # ... + # + # @param name [String, nil] The name you chose for this OAuth Application. + # + # @param status [Symbol, Increase::Models::OAuthApplication::Status] Whether the application is active. + # + # @param type [Symbol, Increase::Models::OAuthApplication::Type] A constant representing the object's type. For this resource it will always be ` + # ... # Whether the application is active. # diff --git a/lib/increase/models/oauth_application_list_params.rb b/lib/increase/models/oauth_application_list_params.rb index 619a32a18..042166fb9 100644 --- a/lib/increase/models/oauth_application_list_params.rb +++ b/lib/increase/models/oauth_application_list_params.rb @@ -31,10 +31,18 @@ class OAuthApplicationListParams < Increase::Internal::Type::BaseModel optional :status, -> { Increase::Models::OAuthApplicationListParams::Status } # @!method initialize(created_at: nil, cursor: nil, limit: nil, status: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Increase::Models::OAuthApplicationListParams} for more details. + # # @param created_at [Increase::Models::OAuthApplicationListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # # @param status [Increase::Models::OAuthApplicationListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel @@ -67,10 +75,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::OAuthApplicationListParams::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 @@ -84,7 +102,11 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::OAuthApplicationListParams::Status} for more details. + # + # @param in_ [Array] Return results whose value is in the provided list. For GET requests, this shoul + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/oauth_connection.rb b/lib/increase/models/oauth_connection.rb index fb2a6ac68..7a59be164 100644 --- a/lib/increase/models/oauth_connection.rb +++ b/lib/increase/models/oauth_connection.rb @@ -50,17 +50,29 @@ class OAuthConnection < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::OAuthConnection::Type } # @!method initialize(id:, created_at:, deleted_at:, group_id:, oauth_application_id:, status:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::OAuthConnection} for more details. + # # When a user authorizes your OAuth application, an OAuth Connection object is # created. Learn more about OAuth # [here](https://increase.com/documentation/oauth). # - # @param id [String] - # @param created_at [Time] - # @param deleted_at [Time, nil] - # @param group_id [String] - # @param oauth_application_id [String] - # @param status [Symbol, Increase::Models::OAuthConnection::Status] - # @param type [Symbol, Increase::Models::OAuthConnection::Type] + # @param id [String] The OAuth Connection's identifier. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth + # ... + # + # @param deleted_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth + # ... + # + # @param group_id [String] The identifier of the Group that has authorized your OAuth application. + # + # @param oauth_application_id [String] The identifier of the OAuth application this connection is for. + # + # @param status [Symbol, Increase::Models::OAuthConnection::Status] Whether the connection is active. + # + # @param type [Symbol, Increase::Models::OAuthConnection::Type] A constant representing the object's type. For this resource it will always be ` + # ... # Whether the connection is active. # diff --git a/lib/increase/models/oauth_connection_list_params.rb b/lib/increase/models/oauth_connection_list_params.rb index e2c74b80d..177ba652e 100644 --- a/lib/increase/models/oauth_connection_list_params.rb +++ b/lib/increase/models/oauth_connection_list_params.rb @@ -33,10 +33,19 @@ class OAuthConnectionListParams < Increase::Internal::Type::BaseModel optional :status, -> { Increase::Models::OAuthConnectionListParams::Status } # @!method initialize(cursor: nil, limit: nil, oauth_application_id: nil, status: nil, request_options: {}) - # @param cursor [String] - # @param limit [Integer] - # @param oauth_application_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::OAuthConnectionListParams} for more details. + # + # @param cursor [String] Return the page of entries after this one. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # + # @param oauth_application_id [String] Filter results to only include OAuth Connections for a specific OAuth Applicatio + # ... + # # @param status [Increase::Models::OAuthConnectionListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Status < Increase::Internal::Type::BaseModel @@ -51,7 +60,11 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::OAuthConnectionListParams::Status} for more details. + # + # @param in_ [Array] Filter to OAuth Connections by their status. By default, return only the `active + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/oauth_token.rb b/lib/increase/models/oauth_token.rb index 46582d2ef..978d15b87 100644 --- a/lib/increase/models/oauth_token.rb +++ b/lib/increase/models/oauth_token.rb @@ -25,13 +25,20 @@ class OAuthToken < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::OAuthToken::Type } # @!method initialize(access_token:, token_type:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::OAuthToken} for more details. + # # A token that is returned to your application when a user completes the OAuth # flow and may be used to authenticate requests. Learn more about OAuth # [here](/documentation/oauth). # - # @param access_token [String] - # @param token_type [Symbol, Increase::Models::OAuthToken::TokenType] - # @param type [Symbol, Increase::Models::OAuthToken::Type] + # @param access_token [String] You may use this token in place of an API key to make OAuth requests on a user's + # ... + # + # @param token_type [Symbol, Increase::Models::OAuthToken::TokenType] The type of OAuth token. + # + # @param type [Symbol, Increase::Models::OAuthToken::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The type of OAuth token. # diff --git a/lib/increase/models/oauth_token_create_params.rb b/lib/increase/models/oauth_token_create_params.rb index 69c22ae7d..1f7437390 100644 --- a/lib/increase/models/oauth_token_create_params.rb +++ b/lib/increase/models/oauth_token_create_params.rb @@ -44,11 +44,23 @@ class OAuthTokenCreateParams < Increase::Internal::Type::BaseModel optional :production_token, String # @!method initialize(grant_type:, client_id: nil, client_secret: nil, code: nil, production_token: nil, request_options: {}) - # @param grant_type [Symbol, Increase::Models::OAuthTokenCreateParams::GrantType] - # @param client_id [String] - # @param client_secret [String] - # @param code [String] - # @param production_token [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::OAuthTokenCreateParams} for more details. + # + # @param grant_type [Symbol, Increase::Models::OAuthTokenCreateParams::GrantType] The credential you request in exchange for the code. In Production, this is alwa + # ... + # + # @param client_id [String] The public identifier for your application. + # + # @param client_secret [String] The secret that confirms you own the application. This is redundent given that t + # ... + # + # @param code [String] The authorization code generated by the user and given to you as a query paramet + # ... + # + # @param production_token [String] The production token you want to exchange for a sandbox token. This is only avai + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The credential you request in exchange for the code. In Production, this is diff --git a/lib/increase/models/pending_transaction.rb b/lib/increase/models/pending_transaction.rb index 6b624c518..a4c508299 100644 --- a/lib/increase/models/pending_transaction.rb +++ b/lib/increase/models/pending_transaction.rb @@ -89,21 +89,44 @@ class PendingTransaction < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::PendingTransaction::Type } # @!method initialize(id:, account_id:, amount:, completed_at:, created_at:, currency:, description:, route_id:, route_type:, source:, status:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::PendingTransaction} for more details. + # # Pending Transactions are potential future additions and removals of money from # your bank account. # - # @param id [String] - # @param account_id [String] - # @param amount [Integer] - # @param completed_at [Time, nil] - # @param created_at [Time] - # @param currency [Symbol, Increase::Models::PendingTransaction::Currency] - # @param description [String] - # @param route_id [String, nil] - # @param route_type [Symbol, Increase::Models::PendingTransaction::RouteType, nil] - # @param source [Increase::Models::PendingTransaction::Source] - # @param status [Symbol, Increase::Models::PendingTransaction::Status] - # @param type [Symbol, Increase::Models::PendingTransaction::Type] + # @param id [String] The Pending Transaction identifier. + # + # @param account_id [String] The identifier for the account this Pending Transaction belongs to. + # + # @param amount [Integer] The Pending Transaction amount in the minor unit of its currency. For dollars, f + # ... + # + # @param completed_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending + # ... + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending + # ... + # + # @param currency [Symbol, Increase::Models::PendingTransaction::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending Tran + # ... + # + # @param description [String] For a Pending Transaction related to a transfer, this is the description you pro + # ... + # + # @param route_id [String, nil] The identifier for the route this Pending Transaction came through. Routes are t + # ... + # + # @param route_type [Symbol, Increase::Models::PendingTransaction::RouteType, nil] The type of the route this Pending Transaction came through. + # + # @param source [Increase::Models::PendingTransaction::Source] This is an object giving more details on the network-level event that caused the + # ... + # + # @param status [Symbol, Increase::Models::PendingTransaction::Status] Whether the Pending Transaction has been confirmed and has an associated Transac + # ... + # + # @param type [Symbol, Increase::Models::PendingTransaction::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending # Transaction's currency. This will match the currency on the Pending @@ -259,21 +282,45 @@ class Source < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(account_transfer_instruction:, ach_transfer_instruction:, card_authorization:, category:, check_deposit_instruction:, check_transfer_instruction:, inbound_funds_hold:, inbound_wire_transfer_reversal:, other:, real_time_payments_transfer_instruction:, wire_transfer_instruction:) + # Some parameter documentations has been truncated, see + # {Increase::Models::PendingTransaction::Source} for more details. + # # This is an object giving more details on the network-level event that caused the # Pending Transaction. For example, for a card transaction this lists the # merchant's industry and location. # - # @param account_transfer_instruction [Increase::Models::PendingTransaction::Source::AccountTransferInstruction, nil] - # @param ach_transfer_instruction [Increase::Models::PendingTransaction::Source::ACHTransferInstruction, nil] - # @param card_authorization [Increase::Models::PendingTransaction::Source::CardAuthorization, nil] - # @param category [Symbol, Increase::Models::PendingTransaction::Source::Category] - # @param check_deposit_instruction [Increase::Models::PendingTransaction::Source::CheckDepositInstruction, nil] - # @param check_transfer_instruction [Increase::Models::PendingTransaction::Source::CheckTransferInstruction, nil] - # @param inbound_funds_hold [Increase::Models::PendingTransaction::Source::InboundFundsHold, nil] - # @param inbound_wire_transfer_reversal [Increase::Models::PendingTransaction::Source::InboundWireTransferReversal, nil] - # @param other [Object, nil] - # @param real_time_payments_transfer_instruction [Increase::Models::PendingTransaction::Source::RealTimePaymentsTransferInstruction, nil] - # @param wire_transfer_instruction [Increase::Models::PendingTransaction::Source::WireTransferInstruction, nil] + # @param account_transfer_instruction [Increase::Models::PendingTransaction::Source::AccountTransferInstruction, nil] An Account Transfer Instruction object. This field will be present in the JSON r + # ... + # + # @param ach_transfer_instruction [Increase::Models::PendingTransaction::Source::ACHTransferInstruction, nil] An ACH Transfer Instruction object. This field will be present in the JSON respo + # ... + # + # @param card_authorization [Increase::Models::PendingTransaction::Source::CardAuthorization, nil] A Card Authorization object. This field will be present in the JSON response if + # ... + # + # @param category [Symbol, Increase::Models::PendingTransaction::Source::Category] The type of the resource. We may add additional possible values for this enum ov + # ... + # + # @param check_deposit_instruction [Increase::Models::PendingTransaction::Source::CheckDepositInstruction, nil] A Check Deposit Instruction object. This field will be present in the JSON respo + # ... + # + # @param check_transfer_instruction [Increase::Models::PendingTransaction::Source::CheckTransferInstruction, nil] A Check Transfer Instruction object. This field will be present in the JSON resp + # ... + # + # @param inbound_funds_hold [Increase::Models::PendingTransaction::Source::InboundFundsHold, nil] An Inbound Funds Hold object. This field will be present in the JSON response if + # ... + # + # @param inbound_wire_transfer_reversal [Increase::Models::PendingTransaction::Source::InboundWireTransferReversal, nil] An Inbound Wire Transfer Reversal object. This field will be present in the JSON + # ... + # + # @param other [Object, nil] If the category of this Transaction source is equal to `other`, this field will + # ... + # + # @param real_time_payments_transfer_instruction [Increase::Models::PendingTransaction::Source::RealTimePaymentsTransferInstruction, nil] A Real-Time Payments Transfer Instruction object. This field will be present in + # ... + # + # @param wire_transfer_instruction [Increase::Models::PendingTransaction::Source::WireTransferInstruction, nil] A Wire Transfer Instruction object. This field will be present in the JSON respo + # ... # @see Increase::Models::PendingTransaction::Source#account_transfer_instruction class AccountTransferInstruction < Increase::Internal::Type::BaseModel @@ -299,12 +346,20 @@ class AccountTransferInstruction < Increase::Internal::Type::BaseModel required :transfer_id, String # @!method initialize(amount:, currency:, transfer_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::PendingTransaction::Source::AccountTransferInstruction} for + # more details. + # # An Account Transfer Instruction object. This field will be present in the JSON # response if and only if `category` is equal to `account_transfer_instruction`. # - # @param amount [Integer] - # @param currency [Symbol, Increase::Models::PendingTransaction::Source::AccountTransferInstruction::Currency] - # @param transfer_id [String] + # @param amount [Integer] The pending amount in the minor unit of the transaction's currency. For dollars, + # ... + # + # @param currency [Symbol, Increase::Models::PendingTransaction::Source::AccountTransferInstruction::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination + # ... + # + # @param transfer_id [String] The identifier of the Account Transfer that led to this Pending Transaction. # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination # account currency. @@ -354,8 +409,9 @@ class ACHTransferInstruction < Increase::Internal::Type::BaseModel # An ACH Transfer Instruction object. This field will be present in the JSON # response if and only if `category` is equal to `ach_transfer_instruction`. # - # @param amount [Integer] - # @param transfer_id [String] + # @param amount [Integer] The pending amount in USD cents. + # + # @param transfer_id [String] The identifier of the ACH Transfer that led to this Pending Transaction. end # @see Increase::Models::PendingTransaction::Source#card_authorization @@ -544,38 +600,84 @@ class CardAuthorization < Increase::Internal::Type::BaseModel -> { Increase::Models::PendingTransaction::Source::CardAuthorization::Verification } # @!method initialize(id:, actioner:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, expires_at:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, pending_transaction_id:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, terminal_id:, type:, verification:) + # Some parameter documentations has been truncated, see + # {Increase::Models::PendingTransaction::Source::CardAuthorization} for more + # details. + # # A Card Authorization object. This field will be present in the JSON response if # and only if `category` is equal to `card_authorization`. Card Authorizations are # temporary holds placed on a customers funds with the intent to later clear a # transaction. # - # @param id [String] - # @param actioner [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Actioner] - # @param amount [Integer] - # @param card_payment_id [String] - # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Currency] - # @param digital_wallet_token_id [String, nil] - # @param direction [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Direction] - # @param expires_at [Time] - # @param merchant_acceptor_id [String] - # @param merchant_category_code [String] - # @param merchant_city [String, nil] - # @param merchant_country [String] - # @param merchant_descriptor [String] - # @param merchant_postal_code [String, nil] - # @param merchant_state [String, nil] - # @param network_details [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails] - # @param network_identifiers [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkIdentifiers] - # @param network_risk_score [Integer, nil] - # @param pending_transaction_id [String, nil] - # @param physical_card_id [String, nil] - # @param presentment_amount [Integer] - # @param presentment_currency [String] - # @param processing_category [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::ProcessingCategory] - # @param real_time_decision_id [String, nil] - # @param terminal_id [String, nil] - # @param type [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Type] - # @param verification [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification] + # @param id [String] The Card Authorization identifier. + # + # @param actioner [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Actioner] Whether this authorization was approved by Increase, the card network through st + # ... + # + # @param amount [Integer] The pending amount in the minor unit of the transaction's currency. For dollars, + # ... + # + # @param card_payment_id [String] The ID of the Card Payment this transaction belongs to. + # + # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param digital_wallet_token_id [String, nil] If the authorization was made via a Digital Wallet Token (such as an Apple Pay p + # ... + # + # @param direction [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Direction] The direction describes the direction the funds will move, either from the cardh + # ... + # + # @param expires_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization w + # ... + # + # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i + # ... + # + # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car + # ... + # + # @param merchant_city [String, nil] The city the merchant resides in. + # + # @param merchant_country [String] The country the merchant resides in. + # + # @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with. + # + # @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is either a 5-digit or 9-digit + # ... + # + # @param merchant_state [String, nil] The state the merchant resides in. + # + # @param network_details [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails] Fields specific to the `network`. + # + # @param network_identifiers [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction. + # + # @param network_risk_score [Integer, nil] The risk score generated by the card network. For Visa this is the Visa Advanced + # ... + # + # @param pending_transaction_id [String, nil] The identifier of the Pending Transaction associated with this Transaction. + # + # @param physical_card_id [String, nil] If the authorization was made in-person with a physical card, the Physical Card + # ... + # + # @param presentment_amount [Integer] The pending amount in the minor unit of the transaction's presentment currency. + # + # @param presentment_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param processing_category [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::ProcessingCategory] The processing category describes the intent behind the authorization, such as w + # ... + # + # @param real_time_decision_id [String, nil] The identifier of the Real-Time Decision sent to approve or decline this transac + # ... + # + # @param terminal_id [String, nil] The terminal identifier (commonly abbreviated as TID) of the terminal the card i + # ... + # + # @param type [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Type] A constant representing the object's type. For this resource it will always be ` + # ... + # + # @param verification [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification] Fields related to verification of cardholder-provided values. # Whether this authorization was approved by Increase, the card network through # stand-in processing, or the user through a real-time decision. @@ -663,8 +765,9 @@ class NetworkDetails < Increase::Internal::Type::BaseModel # @!method initialize(category:, visa:) # Fields specific to the `network`. # - # @param category [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Category] - # @param visa [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa, nil] + # @param category [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Category] The payment network used to process this card authorization. + # + # @param visa [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa, nil] Fields specific to the `visa` network. # The payment network used to process this card authorization. # @@ -710,11 +813,20 @@ class Visa < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:) + # Some parameter documentations has been truncated, see + # {Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa} + # for more details. + # # Fields specific to the `visa` network. # - # @param electronic_commerce_indicator [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] - # @param point_of_service_entry_mode [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode, nil] - # @param stand_in_processing_reason [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason, nil] + # @param electronic_commerce_indicator [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] For electronic commerce transactions, this identifies the level of security used + # ... + # + # @param point_of_service_entry_mode [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode, nil] The method used to enter the cardholder's primary account number and card expira + # ... + # + # @param stand_in_processing_reason [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason, nil] Only present when `actioner: network`. Describes why a card authorization was ap + # ... # For electronic commerce transactions, this identifies the level of security used # in obtaining the customer's payment credential. For mail or telephone order @@ -855,11 +967,20 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel required :transaction_id, String, nil?: true # @!method initialize(retrieval_reference_number:, trace_number:, transaction_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkIdentifiers} + # for more details. + # # Network-specific identifiers for a specific request or transaction. # - # @param retrieval_reference_number [String, nil] - # @param trace_number [String, nil] - # @param transaction_id [String, nil] + # @param retrieval_reference_number [String, nil] A life-cycle identifier used across e.g., an authorization and a reversal. Expec + # ... + # + # @param trace_number [String, nil] A counter used to verify an individual authorization. Expected to be unique per + # ... + # + # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro + # ... end # The processing category describes the intent behind the authorization, such as @@ -923,10 +1044,17 @@ class Verification < Increase::Internal::Type::BaseModel -> { Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress } # @!method initialize(card_verification_code:, cardholder_address:) + # Some parameter documentations has been truncated, see + # {Increase::Models::PendingTransaction::Source::CardAuthorization::Verification} + # for more details. + # # Fields related to verification of cardholder-provided values. # - # @param card_verification_code [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardVerificationCode] - # @param cardholder_address [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress] + # @param card_verification_code [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardVerificationCode] Fields related to verification of the Card Verification Code, a 3-digit code on + # ... + # + # @param cardholder_address [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress] Cardholder address provided in the authorization request and the address on file + # ... # @see Increase::Models::PendingTransaction::Source::CardAuthorization::Verification#card_verification_code class CardVerificationCode < Increase::Internal::Type::BaseModel @@ -941,7 +1069,7 @@ class CardVerificationCode < Increase::Internal::Type::BaseModel # Fields related to verification of the Card Verification Code, a 3-digit code on # the back of the card. # - # @param result [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardVerificationCode::Result] + # @param result [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardVerificationCode::Result] The result of verifying the Card Verification Code. # The result of verifying the Card Verification Code. # @@ -998,14 +1126,23 @@ class CardholderAddress < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress::Result } # @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:) + # Some parameter documentations has been truncated, see + # {Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress} + # for more details. + # # Cardholder address provided in the authorization request and the address on file # we verified it against. # - # @param actual_line1 [String, nil] - # @param actual_postal_code [String, nil] - # @param provided_line1 [String, nil] - # @param provided_postal_code [String, nil] - # @param result [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress::Result] + # @param actual_line1 [String, nil] Line 1 of the address on file for the cardholder. + # + # @param actual_postal_code [String, nil] The postal code of the address on file for the cardholder. + # + # @param provided_line1 [String, nil] The cardholder address line 1 provided for verification in the authorization req + # ... + # + # @param provided_postal_code [String, nil] The postal code provided for verification in the authorization request. + # + # @param result [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress::Result] The address verification result returned to the card network. # The address verification result returned to the card network. # @@ -1116,14 +1253,25 @@ class CheckDepositInstruction < Increase::Internal::Type::BaseModel required :front_image_file_id, String # @!method initialize(amount:, back_image_file_id:, check_deposit_id:, currency:, front_image_file_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::PendingTransaction::Source::CheckDepositInstruction} for more + # details. + # # A Check Deposit Instruction object. This field will be present in the JSON # response if and only if `category` is equal to `check_deposit_instruction`. # - # @param amount [Integer] - # @param back_image_file_id [String, nil] - # @param check_deposit_id [String, nil] - # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CheckDepositInstruction::Currency] - # @param front_image_file_id [String] + # @param amount [Integer] The pending amount in USD cents. + # + # @param back_image_file_id [String, nil] The identifier of the File containing the image of the back of the check that wa + # ... + # + # @param check_deposit_id [String, nil] The identifier of the Check Deposit. + # + # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CheckDepositInstruction::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param front_image_file_id [String] The identifier of the File containing the image of the front of the check that w + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the # transaction's currency. @@ -1178,12 +1326,19 @@ class CheckTransferInstruction < Increase::Internal::Type::BaseModel required :transfer_id, String # @!method initialize(amount:, currency:, transfer_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::PendingTransaction::Source::CheckTransferInstruction} for + # more details. + # # A Check Transfer Instruction object. This field will be present in the JSON # response if and only if `category` is equal to `check_transfer_instruction`. # - # @param amount [Integer] - # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CheckTransferInstruction::Currency] - # @param transfer_id [String] + # @param amount [Integer] The transfer amount in USD cents. + # + # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CheckTransferInstruction::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's curr + # ... + # + # @param transfer_id [String] The identifier of the Check Transfer that led to this Pending Transaction. # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's # currency. @@ -1283,21 +1438,39 @@ class InboundFundsHold < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::PendingTransaction::Source::InboundFundsHold::Type } # @!method initialize(id:, amount:, automatically_releases_at:, created_at:, currency:, held_transaction_id:, pending_transaction_id:, released_at:, status:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::PendingTransaction::Source::InboundFundsHold} for more + # details. + # # An Inbound Funds Hold object. This field will be present in the JSON response if # and only if `category` is equal to `inbound_funds_hold`. We hold funds for # certain transaction types to account for return windows where funds might still # be clawed back by the sending institution. # - # @param id [String] - # @param amount [Integer] - # @param automatically_releases_at [Time] - # @param created_at [Time] - # @param currency [Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Currency] - # @param held_transaction_id [String, nil] - # @param pending_transaction_id [String, nil] - # @param released_at [Time, nil] - # @param status [Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Status] - # @param type [Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Type] + # @param id [String] The Inbound Funds Hold identifier. + # + # @param amount [Integer] The held amount in the minor unit of the account's currency. For dollars, for ex + # ... + # + # @param automatically_releases_at [Time] When the hold will be released automatically. Certain conditions may cause it to + # ... + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold wa + # ... + # + # @param currency [Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's curre + # ... + # + # @param held_transaction_id [String, nil] The ID of the Transaction for which funds were held. + # + # @param pending_transaction_id [String, nil] The ID of the Pending Transaction representing the held funds. + # + # @param released_at [Time, nil] When the hold was released (if it has been released). + # + # @param status [Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Status] The status of the hold. + # + # @param type [Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's # currency. @@ -1372,7 +1545,7 @@ class InboundWireTransferReversal < Increase::Internal::Type::BaseModel # An Inbound Wire Transfer Reversal is created when Increase has received a wire # and the User requests that it be reversed. # - # @param inbound_wire_transfer_id [String] + # @param inbound_wire_transfer_id [String] The ID of the Inbound Wire Transfer that is being reversed. end # @see Increase::Models::PendingTransaction::Source#real_time_payments_transfer_instruction @@ -1391,12 +1564,18 @@ class RealTimePaymentsTransferInstruction < Increase::Internal::Type::BaseModel required :transfer_id, String # @!method initialize(amount:, transfer_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::PendingTransaction::Source::RealTimePaymentsTransferInstruction} + # for more details. + # # A Real-Time Payments Transfer Instruction object. This field will be present in # the JSON response if and only if `category` is equal to # `real_time_payments_transfer_instruction`. # - # @param amount [Integer] - # @param transfer_id [String] + # @param amount [Integer] The transfer amount in USD cents. + # + # @param transfer_id [String] The identifier of the Real-Time Payments Transfer that led to this Pending Trans + # ... end # @see Increase::Models::PendingTransaction::Source#wire_transfer_instruction @@ -1433,14 +1612,23 @@ class WireTransferInstruction < Increase::Internal::Type::BaseModel required :transfer_id, String # @!method initialize(account_number:, amount:, message_to_recipient:, routing_number:, transfer_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::PendingTransaction::Source::WireTransferInstruction} for more + # details. + # # A Wire Transfer Instruction object. This field will be present in the JSON # response if and only if `category` is equal to `wire_transfer_instruction`. # - # @param account_number [String] - # @param amount [Integer] - # @param message_to_recipient [String] - # @param routing_number [String] - # @param transfer_id [String] + # @param account_number [String] The account number for the destination account. + # + # @param amount [Integer] The transfer amount in USD cents. + # + # @param message_to_recipient [String] The message that will show on the recipient's bank statement. + # + # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des + # ... + # + # @param transfer_id [String] The identifier of the Wire Transfer that led to this Pending Transaction. end end diff --git a/lib/increase/models/pending_transaction_list_params.rb b/lib/increase/models/pending_transaction_list_params.rb index d1b150c84..9fd992671 100644 --- a/lib/increase/models/pending_transaction_list_params.rb +++ b/lib/increase/models/pending_transaction_list_params.rb @@ -48,13 +48,24 @@ class PendingTransactionListParams < Increase::Internal::Type::BaseModel optional :status, -> { Increase::Models::PendingTransactionListParams::Status } # @!method initialize(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, status: nil, request_options: {}) - # @param account_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::PendingTransactionListParams} for more details. + # + # @param account_id [String] Filter pending transactions to those belonging to the specified Account. + # # @param category [Increase::Models::PendingTransactionListParams::Category] + # # @param created_at [Increase::Models::PendingTransactionListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] - # @param route_id [String] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # + # @param route_id [String] Filter pending transactions to those belonging to the specified Route. + # # @param status [Increase::Models::PendingTransactionListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Category < Increase::Internal::Type::BaseModel @@ -68,7 +79,11 @@ class Category < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::PendingTransactionListParams::Category} for more details. + # + # @param in_ [Array] Return results whose value is in the provided list. For GET requests, this shoul + # ... module In extend Increase::Internal::Type::Enum @@ -138,10 +153,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::PendingTransactionListParams::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 @@ -157,7 +182,11 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::PendingTransactionListParams::Status} for more details. + # + # @param in_ [Array] Filter Pending Transactions for those with the specified status. By default only + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/physical_card.rb b/lib/increase/models/physical_card.rb index d16447fb7..4fe51958d 100644 --- a/lib/increase/models/physical_card.rb +++ b/lib/increase/models/physical_card.rb @@ -63,21 +63,35 @@ class PhysicalCard < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::PhysicalCard::Type } # @!method initialize(id:, card_id:, cardholder:, created_at:, idempotency_key:, physical_card_profile_id:, shipment:, status:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::PhysicalCard} for more details. + # # Custom physical Visa cards that are shipped to your customers. The artwork is # configurable by a connected [Card Profile](/documentation/api#card-profiles). # The same Card can be used for multiple Physical Cards. Printing cards incurs a # fee. Please contact [support@increase.com](mailto:support@increase.com) for # pricing! # - # @param id [String] - # @param card_id [String] - # @param cardholder [Increase::Models::PhysicalCard::Cardholder] - # @param created_at [Time] - # @param idempotency_key [String, nil] - # @param physical_card_profile_id [String, nil] - # @param shipment [Increase::Models::PhysicalCard::Shipment] - # @param status [Symbol, Increase::Models::PhysicalCard::Status] - # @param type [Symbol, Increase::Models::PhysicalCard::Type] + # @param id [String] The physical card identifier. + # + # @param card_id [String] The identifier for the Card this Physical Card represents. + # + # @param cardholder [Increase::Models::PhysicalCard::Cardholder] Details about the cardholder, as it appears on the printed card. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param physical_card_profile_id [String, nil] The Physical Card Profile used for this Physical Card. + # + # @param shipment [Increase::Models::PhysicalCard::Shipment] The details used to ship this physical card. + # + # @param status [Symbol, Increase::Models::PhysicalCard::Status] The status of the Physical Card. + # + # @param type [Symbol, Increase::Models::PhysicalCard::Type] A constant representing the object's type. For this resource it will always be ` + # ... # @see Increase::Models::PhysicalCard#cardholder class Cardholder < Increase::Internal::Type::BaseModel @@ -96,8 +110,9 @@ class Cardholder < Increase::Internal::Type::BaseModel # @!method initialize(first_name:, last_name:) # Details about the cardholder, as it appears on the printed card. # - # @param first_name [String] - # @param last_name [String] + # @param first_name [String] The cardholder's first name. + # + # @param last_name [String] The cardholder's last name. end # @see Increase::Models::PhysicalCard#shipment @@ -129,10 +144,13 @@ class Shipment < Increase::Internal::Type::BaseModel # @!method initialize(address:, method_:, status:, tracking:) # The details used to ship this physical card. # - # @param address [Increase::Models::PhysicalCard::Shipment::Address] - # @param method_ [Symbol, Increase::Models::PhysicalCard::Shipment::Method] - # @param status [Symbol, Increase::Models::PhysicalCard::Shipment::Status] - # @param tracking [Increase::Models::PhysicalCard::Shipment::Tracking, nil] + # @param address [Increase::Models::PhysicalCard::Shipment::Address] The location to where the card's packing label is addressed. + # + # @param method_ [Symbol, Increase::Models::PhysicalCard::Shipment::Method] The shipping method. + # + # @param status [Symbol, Increase::Models::PhysicalCard::Shipment::Status] The status of this shipment. + # + # @param tracking [Increase::Models::PhysicalCard::Shipment::Tracking, nil] Tracking details for the shipment. # @see Increase::Models::PhysicalCard::Shipment#address class Address < Increase::Internal::Type::BaseModel @@ -181,13 +199,19 @@ class Address < Increase::Internal::Type::BaseModel # @!method initialize(city:, line1:, line2:, line3:, name:, postal_code:, state:) # The location to where the card's packing label is addressed. # - # @param city [String] - # @param line1 [String] - # @param line2 [String, nil] - # @param line3 [String, nil] - # @param name [String] - # @param postal_code [String] - # @param state [String] + # @param city [String] The city of the shipping address. + # + # @param line1 [String] The first line of the shipping address. + # + # @param line2 [String, nil] The second line of the shipping address. + # + # @param line3 [String, nil] The third line of the shipping address. + # + # @param name [String] The name of the recipient. + # + # @param postal_code [String] The postal code of the shipping address. + # + # @param state [String] The US state of the shipping address. end # The shipping method. @@ -269,12 +293,19 @@ class Tracking < Increase::Internal::Type::BaseModel required :shipped_at, Time # @!method initialize(number:, return_number:, return_reason:, shipped_at:) + # Some parameter documentations has been truncated, see + # {Increase::Models::PhysicalCard::Shipment::Tracking} for more details. + # # Tracking details for the shipment. # - # @param number [String] - # @param return_number [String, nil] - # @param return_reason [String, nil] - # @param shipped_at [Time] + # @param number [String] The tracking number. + # + # @param return_number [String, nil] For returned shipments, the tracking number of the return shipment. + # + # @param return_reason [String, nil] For returned shipments, this describes why the package was returned. + # + # @param shipped_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... end end diff --git a/lib/increase/models/physical_card_create_params.rb b/lib/increase/models/physical_card_create_params.rb index 2bf63fde6..f74d66fb0 100644 --- a/lib/increase/models/physical_card_create_params.rb +++ b/lib/increase/models/physical_card_create_params.rb @@ -33,10 +33,18 @@ class PhysicalCardCreateParams < Increase::Internal::Type::BaseModel optional :physical_card_profile_id, String # @!method initialize(card_id:, cardholder:, shipment:, physical_card_profile_id: nil, request_options: {}) - # @param card_id [String] - # @param cardholder [Increase::Models::PhysicalCardCreateParams::Cardholder] - # @param shipment [Increase::Models::PhysicalCardCreateParams::Shipment] - # @param physical_card_profile_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::PhysicalCardCreateParams} for more details. + # + # @param card_id [String] The underlying card representing this physical card. + # + # @param cardholder [Increase::Models::PhysicalCardCreateParams::Cardholder] Details about the cardholder, as it will appear on the physical card. + # + # @param shipment [Increase::Models::PhysicalCardCreateParams::Shipment] The details used to ship this physical card. + # + # @param physical_card_profile_id [String] The physical card profile to use for this physical card. The latest default phys + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Cardholder < Increase::Internal::Type::BaseModel @@ -55,8 +63,9 @@ class Cardholder < Increase::Internal::Type::BaseModel # @!method initialize(first_name:, last_name:) # Details about the cardholder, as it will appear on the physical card. # - # @param first_name [String] - # @param last_name [String] + # @param first_name [String] The cardholder's first name. + # + # @param last_name [String] The cardholder's last name. end class Shipment < Increase::Internal::Type::BaseModel @@ -77,8 +86,9 @@ class Shipment < Increase::Internal::Type::BaseModel # @!method initialize(address:, method_:) # The details used to ship this physical card. # - # @param address [Increase::Models::PhysicalCardCreateParams::Shipment::Address] - # @param method_ [Symbol, Increase::Models::PhysicalCardCreateParams::Shipment::Method] + # @param address [Increase::Models::PhysicalCardCreateParams::Shipment::Address] The address to where the card should be shipped. + # + # @param method_ [Symbol, Increase::Models::PhysicalCardCreateParams::Shipment::Method] The shipping method to use. # @see Increase::Models::PhysicalCardCreateParams::Shipment#address class Address < Increase::Internal::Type::BaseModel @@ -133,14 +143,21 @@ class Address < Increase::Internal::Type::BaseModel # @!method initialize(city:, line1:, name:, postal_code:, state:, line2: nil, line3: nil, phone_number: nil) # The address to where the card should be shipped. # - # @param city [String] - # @param line1 [String] - # @param name [String] - # @param postal_code [String] - # @param state [String] - # @param line2 [String] - # @param line3 [String] - # @param phone_number [String] + # @param city [String] The city of the shipping address. + # + # @param line1 [String] The first line of the shipping address. + # + # @param name [String] The name of the recipient. + # + # @param postal_code [String] The postal code of the shipping address. + # + # @param state [String] The US state of the shipping address. + # + # @param line2 [String] The second line of the shipping address. + # + # @param line3 [String] The third line of the shipping address. + # + # @param phone_number [String] The phone number of the recipient. end # The shipping method to use. diff --git a/lib/increase/models/physical_card_list_params.rb b/lib/increase/models/physical_card_list_params.rb index 3ead222f9..0144856ae 100644 --- a/lib/increase/models/physical_card_list_params.rb +++ b/lib/increase/models/physical_card_list_params.rb @@ -41,11 +41,21 @@ class PhysicalCardListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(card_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) - # @param card_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::PhysicalCardListParams} for more details. + # + # @param card_id [String] Filter Physical Cards to ones belonging to the specified Card. + # # @param created_at [Increase::Models::PhysicalCardListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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 @@ -78,10 +88,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::PhysicalCardListParams::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 diff --git a/lib/increase/models/physical_card_profile.rb b/lib/increase/models/physical_card_profile.rb index a853959bc..28c801915 100644 --- a/lib/increase/models/physical_card_profile.rb +++ b/lib/increase/models/physical_card_profile.rb @@ -88,23 +88,42 @@ class PhysicalCardProfile < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::PhysicalCardProfile::Type } # @!method initialize(id:, back_image_file_id:, carrier_image_file_id:, contact_phone:, created_at:, creator:, description:, front_image_file_id:, idempotency_key:, is_default:, program_id:, status:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::PhysicalCardProfile} for more details. + # # This contains artwork and metadata relating to a Physical Card's appearance. For # more information, see our guide on # [physical card artwork](https://increase.com/documentation/card-art-physical-cards). # - # @param id [String] - # @param back_image_file_id [String, nil] - # @param carrier_image_file_id [String, nil] - # @param contact_phone [String, nil] - # @param created_at [Time] - # @param creator [Symbol, Increase::Models::PhysicalCardProfile::Creator] - # @param description [String] - # @param front_image_file_id [String, nil] - # @param idempotency_key [String, nil] - # @param is_default [Boolean] - # @param program_id [String] - # @param status [Symbol, Increase::Models::PhysicalCardProfile::Status] - # @param type [Symbol, Increase::Models::PhysicalCardProfile::Type] + # @param id [String] The Card Profile identifier. + # + # @param back_image_file_id [String, nil] The identifier of the File containing the physical card's back image. + # + # @param carrier_image_file_id [String, nil] The identifier of the File containing the physical card's carrier image. + # + # @param contact_phone [String, nil] A phone number the user can contact to receive support for their card. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param creator [Symbol, Increase::Models::PhysicalCardProfile::Creator] The creator of this Physical Card Profile. + # + # @param description [String] A description you can use to identify the Physical Card Profile. + # + # @param front_image_file_id [String, nil] The identifier of the File containing the physical card's front image. + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param is_default [Boolean] Whether this Physical Card Profile is the default for all cards in its Increase + # ... + # + # @param program_id [String] The identifier for the Program this Physical Card Profile belongs to. + # + # @param status [Symbol, Increase::Models::PhysicalCardProfile::Status] The status of the Physical Card Profile. + # + # @param type [Symbol, Increase::Models::PhysicalCardProfile::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The creator of this Physical Card Profile. # diff --git a/lib/increase/models/physical_card_profile_clone_params.rb b/lib/increase/models/physical_card_profile_clone_params.rb index 28193c6d8..4c0a2d7ba 100644 --- a/lib/increase/models/physical_card_profile_clone_params.rb +++ b/lib/increase/models/physical_card_profile_clone_params.rb @@ -39,11 +39,20 @@ class PhysicalCardProfileCloneParams < Increase::Internal::Type::BaseModel optional :front_text, -> { Increase::Models::PhysicalCardProfileCloneParams::FrontText } # @!method initialize(carrier_image_file_id: nil, contact_phone: nil, description: nil, front_image_file_id: nil, front_text: nil, request_options: {}) - # @param carrier_image_file_id [String] - # @param contact_phone [String] - # @param description [String] - # @param front_image_file_id [String] - # @param front_text [Increase::Models::PhysicalCardProfileCloneParams::FrontText] + # Some parameter documentations has been truncated, see + # {Increase::Models::PhysicalCardProfileCloneParams} for more details. + # + # @param carrier_image_file_id [String] The identifier of the File containing the physical card's carrier image. + # + # @param contact_phone [String] A phone number the user can contact to receive support for their card. + # + # @param description [String] A description you can use to identify the Card Profile. + # + # @param front_image_file_id [String] The identifier of the File containing the physical card's front image. + # + # @param front_text [Increase::Models::PhysicalCardProfileCloneParams::FrontText] Text printed on the front of the card. Reach out to [support@increase.com](mailt + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class FrontText < Increase::Internal::Type::BaseModel @@ -62,11 +71,16 @@ class FrontText < Increase::Internal::Type::BaseModel optional :line2, String # @!method initialize(line1:, line2: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::PhysicalCardProfileCloneParams::FrontText} for more details. + # # Text printed on the front of the card. Reach out to # [support@increase.com](mailto:support@increase.com) for more information. # - # @param line1 [String] - # @param line2 [String] + # @param line1 [String] The first line of text on the front of the card. + # + # @param line2 [String] The second line of text on the front of the card. Providing a second line moves + # ... end end end diff --git a/lib/increase/models/physical_card_profile_create_params.rb b/lib/increase/models/physical_card_profile_create_params.rb index 9e158409f..c59f22f7a 100644 --- a/lib/increase/models/physical_card_profile_create_params.rb +++ b/lib/increase/models/physical_card_profile_create_params.rb @@ -38,11 +38,16 @@ class PhysicalCardProfileCreateParams < Increase::Internal::Type::BaseModel required :program_id, String # @!method initialize(carrier_image_file_id:, contact_phone:, description:, front_image_file_id:, program_id:, request_options: {}) - # @param carrier_image_file_id [String] - # @param contact_phone [String] - # @param description [String] - # @param front_image_file_id [String] - # @param program_id [String] + # @param carrier_image_file_id [String] The identifier of the File containing the physical card's carrier image. + # + # @param contact_phone [String] A phone number the user can contact to receive support for their card. + # + # @param description [String] A description you can use to identify the Card Profile. + # + # @param front_image_file_id [String] The identifier of the File containing the physical card's front image. + # + # @param program_id [String] The identifier for the Program that this Physical Card Profile falls under. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/physical_card_profile_list_params.rb b/lib/increase/models/physical_card_profile_list_params.rb index 17b522f09..88b36dc1c 100644 --- a/lib/increase/models/physical_card_profile_list_params.rb +++ b/lib/increase/models/physical_card_profile_list_params.rb @@ -35,10 +35,19 @@ class PhysicalCardProfileListParams < Increase::Internal::Type::BaseModel optional :status, -> { Increase::Models::PhysicalCardProfileListParams::Status } # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # Some parameter documentations has been truncated, see + # {Increase::Models::PhysicalCardProfileListParams} for more details. + # + # @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::PhysicalCardProfileListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Status < Increase::Internal::Type::BaseModel @@ -53,7 +62,11 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::PhysicalCardProfileListParams::Status} for more details. + # + # @param in_ [Array] Filter Physical Card Profiles for those with the specified statuses. For GET req + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/physical_card_update_params.rb b/lib/increase/models/physical_card_update_params.rb index 47b9ed7f2..2eec28856 100644 --- a/lib/increase/models/physical_card_update_params.rb +++ b/lib/increase/models/physical_card_update_params.rb @@ -14,7 +14,8 @@ class PhysicalCardUpdateParams < Increase::Internal::Type::BaseModel required :status, enum: -> { Increase::Models::PhysicalCardUpdateParams::Status } # @!method initialize(status:, request_options: {}) - # @param status [Symbol, Increase::Models::PhysicalCardUpdateParams::Status] + # @param status [Symbol, Increase::Models::PhysicalCardUpdateParams::Status] The status to update the Physical Card to. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The status to update the Physical Card to. diff --git a/lib/increase/models/program.rb b/lib/increase/models/program.rb index bcb43fc7e..688d5d801 100644 --- a/lib/increase/models/program.rb +++ b/lib/increase/models/program.rb @@ -64,20 +64,35 @@ class Program < Increase::Internal::Type::BaseModel required :updated_at, Time # @!method initialize(id:, bank:, billing_account_id:, created_at:, default_digital_card_profile_id:, interest_rate:, name:, type:, updated_at:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Program} for more details. + # # Programs determine the compliance and commercial terms of Accounts. By default, # you have a Commercial Banking program for managing your own funds. If you are # lending or managing funds on behalf of your customers, or otherwise engaged in # regulated activity, we will work together to create additional Programs for you. # - # @param id [String] - # @param bank [Symbol, Increase::Models::Program::Bank] - # @param billing_account_id [String, nil] - # @param created_at [Time] - # @param default_digital_card_profile_id [String, nil] - # @param interest_rate [String] - # @param name [String] - # @param type [Symbol, Increase::Models::Program::Type] - # @param updated_at [Time] + # @param id [String] The Program identifier. + # + # @param bank [Symbol, Increase::Models::Program::Bank] The Bank the Program is with. + # + # @param billing_account_id [String, nil] The Program billing account. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program + # ... + # + # @param default_digital_card_profile_id [String, nil] The default configuration for digital cards attached to this Program. + # + # @param interest_rate [String] The Interest Rate currently being earned on the accounts in this program, as a s + # ... + # + # @param name [String] The name of the Program. + # + # @param type [Symbol, Increase::Models::Program::Type] A constant representing the object's type. For this resource it will always be ` + # ... + # + # @param updated_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program + # ... # The Bank the Program is with. # diff --git a/lib/increase/models/program_list_params.rb b/lib/increase/models/program_list_params.rb index d2605151c..a9ce7aa5c 100644 --- a/lib/increase/models/program_list_params.rb +++ b/lib/increase/models/program_list_params.rb @@ -21,8 +21,14 @@ class ProgramListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(cursor: nil, limit: nil, request_options: {}) - # @param cursor [String] - # @param limit [Integer] + # Some parameter documentations has been truncated, see + # {Increase::Models::ProgramListParams} for more details. + # + # @param cursor [String] Return the page of entries after this one. + # + # @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 diff --git a/lib/increase/models/real_time_decision.rb b/lib/increase/models/real_time_decision.rb index c34cb8935..b520800c5 100644 --- a/lib/increase/models/real_time_decision.rb +++ b/lib/increase/models/real_time_decision.rb @@ -78,22 +78,38 @@ class RealTimeDecision < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::RealTimeDecision::Type } # @!method initialize(id:, card_authentication:, card_authentication_challenge:, card_authorization:, category:, created_at:, digital_wallet_authentication:, digital_wallet_token:, status:, timeout_at:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecision} for more details. + # # Real Time Decisions are created when your application needs to take action in # real-time to some event such as a card authorization. For more information, see # our # [Real-Time Decisions guide](https://increase.com/documentation/real-time-decisions). # - # @param id [String] - # @param card_authentication [Increase::Models::RealTimeDecision::CardAuthentication, nil] - # @param card_authentication_challenge [Increase::Models::RealTimeDecision::CardAuthenticationChallenge, nil] - # @param card_authorization [Increase::Models::RealTimeDecision::CardAuthorization, nil] - # @param category [Symbol, Increase::Models::RealTimeDecision::Category] - # @param created_at [Time] - # @param digital_wallet_authentication [Increase::Models::RealTimeDecision::DigitalWalletAuthentication, nil] - # @param digital_wallet_token [Increase::Models::RealTimeDecision::DigitalWalletToken, nil] - # @param status [Symbol, Increase::Models::RealTimeDecision::Status] - # @param timeout_at [Time] - # @param type [Symbol, Increase::Models::RealTimeDecision::Type] + # @param id [String] The Real-Time Decision identifier. + # + # @param card_authentication [Increase::Models::RealTimeDecision::CardAuthentication, nil] Fields related to a 3DS authentication attempt. + # + # @param card_authentication_challenge [Increase::Models::RealTimeDecision::CardAuthenticationChallenge, nil] Fields related to a 3DS authentication attempt. + # + # @param card_authorization [Increase::Models::RealTimeDecision::CardAuthorization, nil] Fields related to a card authorization. + # + # @param category [Symbol, Increase::Models::RealTimeDecision::Category] The category of the Real-Time Decision. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param digital_wallet_authentication [Increase::Models::RealTimeDecision::DigitalWalletAuthentication, nil] Fields related to a digital wallet authentication attempt. + # + # @param digital_wallet_token [Increase::Models::RealTimeDecision::DigitalWalletToken, nil] Fields related to a digital wallet token provisioning attempt. + # + # @param status [Symbol, Increase::Models::RealTimeDecision::Status] The status of the Real-Time Decision. + # + # @param timeout_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which yo + # ... + # + # @param type [Symbol, Increase::Models::RealTimeDecision::Type] A constant representing the object's type. For this resource it will always be ` + # ... # @see Increase::Models::RealTimeDecision#card_authentication class CardAuthentication < Increase::Internal::Type::BaseModel @@ -125,12 +141,19 @@ class CardAuthentication < Increase::Internal::Type::BaseModel required :upcoming_card_payment_id, String # @!method initialize(account_id:, card_id:, decision:, upcoming_card_payment_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecision::CardAuthentication} for more details. + # # Fields related to a 3DS authentication attempt. # - # @param account_id [String] - # @param card_id [String] - # @param decision [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::Decision, nil] - # @param upcoming_card_payment_id [String] + # @param account_id [String] The identifier of the Account the card belongs to. + # + # @param card_id [String] The identifier of the Card that is being tokenized. + # + # @param decision [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::Decision, nil] Whether or not the authentication attempt was approved. + # + # @param upcoming_card_payment_id [String] The identifier of the Card Payment this authentication attempt will belong to. A + # ... # Whether or not the authentication attempt was approved. # @@ -188,13 +211,22 @@ class CardAuthenticationChallenge < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(account_id:, card_id:, card_payment_id:, one_time_code:, result:) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecision::CardAuthenticationChallenge} for more + # details. + # # Fields related to a 3DS authentication attempt. # - # @param account_id [String] - # @param card_id [String] - # @param card_payment_id [String] - # @param one_time_code [String] - # @param result [Symbol, Increase::Models::RealTimeDecision::CardAuthenticationChallenge::Result, nil] + # @param account_id [String] The identifier of the Account the card belongs to. + # + # @param card_id [String] The identifier of the Card that is being tokenized. + # + # @param card_payment_id [String] The identifier of the Card Payment this authentication challenge attempt belongs + # ... + # + # @param one_time_code [String] The one-time code delivered to the cardholder. + # + # @param result [Symbol, Increase::Models::RealTimeDecision::CardAuthenticationChallenge::Result, nil] Whether or not the challenge was delivered to the cardholder. # Whether or not the challenge was delivered to the cardholder. # @@ -385,33 +417,74 @@ class CardAuthorization < Increase::Internal::Type::BaseModel required :verification, -> { Increase::Models::RealTimeDecision::CardAuthorization::Verification } # @!method initialize(account_id:, card_id:, decision:, digital_wallet_token_id:, direction:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, request_details:, settlement_amount:, settlement_currency:, terminal_id:, upcoming_card_payment_id:, verification:) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecision::CardAuthorization} for more details. + # # Fields related to a card authorization. # - # @param account_id [String] - # @param card_id [String] - # @param decision [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Decision, nil] - # @param digital_wallet_token_id [String, nil] - # @param direction [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Direction] - # @param merchant_acceptor_id [String] - # @param merchant_category_code [String] - # @param merchant_city [String, nil] - # @param merchant_country [String] - # @param merchant_descriptor [String] - # @param merchant_postal_code [String, nil] - # @param merchant_state [String, nil] - # @param network_details [Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails] - # @param network_identifiers [Increase::Models::RealTimeDecision::CardAuthorization::NetworkIdentifiers] - # @param network_risk_score [Integer, nil] - # @param physical_card_id [String, nil] - # @param presentment_amount [Integer] - # @param presentment_currency [String] - # @param processing_category [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::ProcessingCategory] - # @param request_details [Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails] - # @param settlement_amount [Integer] - # @param settlement_currency [String] - # @param terminal_id [String, nil] - # @param upcoming_card_payment_id [String] - # @param verification [Increase::Models::RealTimeDecision::CardAuthorization::Verification] + # @param account_id [String] The identifier of the Account the authorization will debit. + # + # @param card_id [String] The identifier of the Card that is being authorized. + # + # @param decision [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Decision, nil] Whether or not the authorization was approved. + # + # @param digital_wallet_token_id [String, nil] If the authorization was made via a Digital Wallet Token (such as an Apple Pay p + # ... + # + # @param direction [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Direction] The direction describes the direction the funds will move, either from the cardh + # ... + # + # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i + # ... + # + # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car + # ... + # + # @param merchant_city [String, nil] The city the merchant resides in. + # + # @param merchant_country [String] The country the merchant resides in. + # + # @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with. + # + # @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is either a 5-digit or 9-digit + # ... + # + # @param merchant_state [String, nil] The state the merchant resides in. + # + # @param network_details [Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails] Fields specific to the `network`. + # + # @param network_identifiers [Increase::Models::RealTimeDecision::CardAuthorization::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction. + # + # @param network_risk_score [Integer, nil] The risk score generated by the card network. For Visa this is the Visa Advanced + # ... + # + # @param physical_card_id [String, nil] If the authorization was made in-person with a physical card, the Physical Card + # ... + # + # @param presentment_amount [Integer] The amount of the attempted authorization in the currency the card user sees at + # ... + # + # @param presentment_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the + # ... + # + # @param processing_category [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::ProcessingCategory] The processing category describes the intent behind the authorization, such as w + # ... + # + # @param request_details [Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails] Fields specific to the type of request, such as an incremental authorization. + # + # @param settlement_amount [Integer] The amount of the attempted authorization in the currency it will be settled in. + # ... + # + # @param settlement_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the + # ... + # + # @param terminal_id [String, nil] The terminal identifier (commonly abbreviated as TID) of the terminal the card i + # ... + # + # @param upcoming_card_payment_id [String] The identifier of the Card Payment this authorization will belong to. Available + # ... + # + # @param verification [Increase::Models::RealTimeDecision::CardAuthorization::Verification] Fields related to verification of cardholder-provided values. # Whether or not the authorization was approved. # @@ -466,8 +539,9 @@ class NetworkDetails < Increase::Internal::Type::BaseModel # @!method initialize(category:, visa:) # Fields specific to the `network`. # - # @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Category] - # @param visa [Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa, nil] + # @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Category] The payment network used to process this card authorization. + # + # @param visa [Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa, nil] Fields specific to the `visa` network. # The payment network used to process this card authorization. # @@ -513,11 +587,20 @@ class Visa < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa} + # for more details. + # # Fields specific to the `visa` network. # - # @param electronic_commerce_indicator [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] - # @param point_of_service_entry_mode [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode, nil] - # @param stand_in_processing_reason [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason, nil] + # @param electronic_commerce_indicator [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] For electronic commerce transactions, this identifies the level of security used + # ... + # + # @param point_of_service_entry_mode [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode, nil] The method used to enter the cardholder's primary account number and card expira + # ... + # + # @param stand_in_processing_reason [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason, nil] Only present when `actioner: network`. Describes why a card authorization was ap + # ... # For electronic commerce transactions, this identifies the level of security used # in obtaining the customer's payment credential. For mail or telephone order @@ -658,11 +741,20 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel required :transaction_id, String, nil?: true # @!method initialize(retrieval_reference_number:, trace_number:, transaction_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecision::CardAuthorization::NetworkIdentifiers} for + # more details. + # # Network-specific identifiers for a specific request or transaction. # - # @param retrieval_reference_number [String, nil] - # @param trace_number [String, nil] - # @param transaction_id [String, nil] + # @param retrieval_reference_number [String, nil] A life-cycle identifier used across e.g., an authorization and a reversal. Expec + # ... + # + # @param trace_number [String, nil] A counter used to verify an individual authorization. Expected to be unique per + # ... + # + # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro + # ... end # The processing category describes the intent behind the authorization, such as @@ -719,11 +811,18 @@ class RequestDetails < Increase::Internal::Type::BaseModel required :initial_authorization, Increase::Internal::Type::Unknown, nil?: true # @!method initialize(category:, incremental_authorization:, initial_authorization:) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails} for more + # details. + # # Fields specific to the type of request, such as an incremental authorization. # - # @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails::Category] - # @param incremental_authorization [Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails::IncrementalAuthorization, nil] - # @param initial_authorization [Object, nil] + # @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails::Category] The type of this request (e.g., an initial authorization or an incremental autho + # ... + # + # @param incremental_authorization [Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails::IncrementalAuthorization, nil] Fields specific to the category `incremental_authorization`. + # + # @param initial_authorization [Object, nil] Fields specific to the category `initial_authorization`. # The type of this request (e.g., an initial authorization or an incremental # authorization). @@ -758,10 +857,16 @@ class IncrementalAuthorization < Increase::Internal::Type::BaseModel required :original_card_authorization_id, String # @!method initialize(card_payment_id:, original_card_authorization_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails::IncrementalAuthorization} + # for more details. + # # Fields specific to the category `incremental_authorization`. # - # @param card_payment_id [String] - # @param original_card_authorization_id [String] + # @param card_payment_id [String] The card payment for this authorization and increment. + # + # @param original_card_authorization_id [String] The identifier of the card authorization this request is attempting to increment + # ... end end @@ -784,10 +889,17 @@ class Verification < Increase::Internal::Type::BaseModel -> { Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress } # @!method initialize(card_verification_code:, cardholder_address:) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecision::CardAuthorization::Verification} for more + # details. + # # Fields related to verification of cardholder-provided values. # - # @param card_verification_code [Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardVerificationCode] - # @param cardholder_address [Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress] + # @param card_verification_code [Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardVerificationCode] Fields related to verification of the Card Verification Code, a 3-digit code on + # ... + # + # @param cardholder_address [Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress] Cardholder address provided in the authorization request and the address on file + # ... # @see Increase::Models::RealTimeDecision::CardAuthorization::Verification#card_verification_code class CardVerificationCode < Increase::Internal::Type::BaseModel @@ -802,7 +914,7 @@ class CardVerificationCode < Increase::Internal::Type::BaseModel # Fields related to verification of the Card Verification Code, a 3-digit code on # the back of the card. # - # @param result [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardVerificationCode::Result] + # @param result [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardVerificationCode::Result] The result of verifying the Card Verification Code. # The result of verifying the Card Verification Code. # @@ -859,14 +971,23 @@ class CardholderAddress < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress::Result } # @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress} + # for more details. + # # Cardholder address provided in the authorization request and the address on file # we verified it against. # - # @param actual_line1 [String, nil] - # @param actual_postal_code [String, nil] - # @param provided_line1 [String, nil] - # @param provided_postal_code [String, nil] - # @param result [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress::Result] + # @param actual_line1 [String, nil] Line 1 of the address on file for the cardholder. + # + # @param actual_postal_code [String, nil] The postal code of the address on file for the cardholder. + # + # @param provided_line1 [String, nil] The cardholder address line 1 provided for verification in the authorization req + # ... + # + # @param provided_postal_code [String, nil] The postal code provided for verification in the authorization request. + # + # @param result [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress::Result] The address verification result returned to the card network. # The address verification result returned to the card network. # @@ -973,15 +1094,26 @@ class DigitalWalletAuthentication < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(card_id:, channel:, digital_wallet:, email:, one_time_passcode:, phone:, result:) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecision::DigitalWalletAuthentication} for more + # details. + # # Fields related to a digital wallet authentication attempt. # - # @param card_id [String] - # @param channel [Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::Channel] - # @param digital_wallet [Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::DigitalWallet] - # @param email [String, nil] - # @param one_time_passcode [String] - # @param phone [String, nil] - # @param result [Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::Result, nil] + # @param card_id [String] The identifier of the Card that is being tokenized. + # + # @param channel [Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::Channel] The channel to send the card user their one-time passcode. + # + # @param digital_wallet [Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::DigitalWallet] The digital wallet app being used. + # + # @param email [String, nil] The email to send the one-time passcode to if `channel` is equal to `email`. + # + # @param one_time_passcode [String] The one-time passcode to send the card user. + # + # @param phone [String, nil] The phone number to send the one-time passcode to if `channel` is equal to `sms` + # ... + # + # @param result [Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::Result, nil] Whether your application successfully delivered the one-time passcode. # The channel to send the card user their one-time passcode. # @@ -1077,13 +1209,22 @@ class DigitalWalletToken < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::RealTimeDecision::DigitalWalletToken::DigitalWallet } # @!method initialize(card_id:, card_profile_id:, decision:, device:, digital_wallet:) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecision::DigitalWalletToken} for more details. + # # Fields related to a digital wallet token provisioning attempt. # - # @param card_id [String] - # @param card_profile_id [String, nil] - # @param decision [Symbol, Increase::Models::RealTimeDecision::DigitalWalletToken::Decision, nil] - # @param device [Increase::Models::RealTimeDecision::DigitalWalletToken::Device] - # @param digital_wallet [Symbol, Increase::Models::RealTimeDecision::DigitalWalletToken::DigitalWallet] + # @param card_id [String] The identifier of the Card that is being tokenized. + # + # @param card_profile_id [String, nil] The identifier of the Card Profile that was set via the real time decision. This + # ... + # + # @param decision [Symbol, Increase::Models::RealTimeDecision::DigitalWalletToken::Decision, nil] Whether or not the provisioning request was approved. This will be null until th + # ... + # + # @param device [Increase::Models::RealTimeDecision::DigitalWalletToken::Device] Device that is being used to provision the digital wallet token. + # + # @param digital_wallet [Symbol, Increase::Models::RealTimeDecision::DigitalWalletToken::DigitalWallet] The digital wallet app being used. # Whether or not the provisioning request was approved. This will be null until # the real time decision is responded to. @@ -1113,7 +1254,7 @@ class Device < Increase::Internal::Type::BaseModel # @!method initialize(identifier:) # Device that is being used to provision the digital wallet token. # - # @param identifier [String, nil] + # @param identifier [String, nil] ID assigned to the device by the digital wallet provider. end # The digital wallet app being used. diff --git a/lib/increase/models/real_time_decision_action_params.rb b/lib/increase/models/real_time_decision_action_params.rb index 4880a75e6..9cfa06c54 100644 --- a/lib/increase/models/real_time_decision_action_params.rb +++ b/lib/increase/models/real_time_decision_action_params.rb @@ -45,11 +45,24 @@ class RealTimeDecisionActionParams < Increase::Internal::Type::BaseModel optional :digital_wallet_token, -> { Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken } # @!method initialize(card_authentication: nil, card_authentication_challenge: nil, card_authorization: nil, digital_wallet_authentication: nil, digital_wallet_token: nil, request_options: {}) - # @param card_authentication [Increase::Models::RealTimeDecisionActionParams::CardAuthentication] - # @param card_authentication_challenge [Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge] - # @param card_authorization [Increase::Models::RealTimeDecisionActionParams::CardAuthorization] - # @param digital_wallet_authentication [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication] - # @param digital_wallet_token [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken] + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecisionActionParams} for more details. + # + # @param card_authentication [Increase::Models::RealTimeDecisionActionParams::CardAuthentication] If the Real-Time Decision relates to a 3DS card authentication attempt, this obj + # ... + # + # @param card_authentication_challenge [Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge] If the Real-Time Decision relates to 3DS card authentication challenge delivery, + # ... + # + # @param card_authorization [Increase::Models::RealTimeDecisionActionParams::CardAuthorization] If the Real-Time Decision relates to a card authorization attempt, this object c + # ... + # + # @param digital_wallet_authentication [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication] If the Real-Time Decision relates to a digital wallet authentication attempt, th + # ... + # + # @param digital_wallet_token [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken] If the Real-Time Decision relates to a digital wallet token provisioning attempt + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CardAuthentication < Increase::Internal::Type::BaseModel @@ -64,7 +77,7 @@ class CardAuthentication < Increase::Internal::Type::BaseModel # If the Real-Time Decision relates to a 3DS card authentication attempt, this # object contains your response to the authentication. # - # @param decision [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthentication::Decision] + # @param decision [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthentication::Decision] Whether the card authentication attempt should be approved or declined. # Whether the card authentication attempt should be approved or declined. # @@ -96,10 +109,15 @@ class CardAuthenticationChallenge < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge::Result } # @!method initialize(result:) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge} + # for more details. + # # If the Real-Time Decision relates to 3DS card authentication challenge delivery, # this object contains your response. # - # @param result [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge::Result] + # @param result [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge::Result] Whether the card authentication challenge was successfully delivered to the card + # ... # Whether the card authentication challenge was successfully delivered to the # cardholder. @@ -136,11 +154,17 @@ class CardAuthorization < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::RealTimeDecisionActionParams::CardAuthorization::DeclineReason } # @!method initialize(decision:, decline_reason: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecisionActionParams::CardAuthorization} for more + # details. + # # If the Real-Time Decision relates to a card authorization attempt, this object # contains your response to the authorization. # - # @param decision [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Decision] - # @param decline_reason [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::DeclineReason] + # @param decision [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Decision] Whether the card authorization should be approved or declined. + # + # @param decline_reason [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::DeclineReason] The reason the card authorization was declined. This translates to a specific de + # ... # Whether the card authorization should be approved or declined. # @@ -206,7 +230,8 @@ class DigitalWalletAuthentication < Increase::Internal::Type::BaseModel # If the Real-Time Decision relates to a digital wallet authentication attempt, # this object contains your response to the authentication. # - # @param result [Symbol, Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication::Result] + # @param result [Symbol, Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication::Result] Whether your application was able to deliver the one-time passcode. + # # @param success [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication::Success] # Whether your application was able to deliver the one-time passcode. @@ -241,8 +266,14 @@ class Success < Increase::Internal::Type::BaseModel optional :phone, String # @!method initialize(email: nil, phone: nil) - # @param email [String] - # @param phone [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication::Success} + # for more details. + # + # @param email [String] The email address that was used to verify the cardholder via one-time passcode. + # + # @param phone [String] The phone number that was used to verify the cardholder via one-time passcode ov + # ... end end @@ -262,11 +293,18 @@ class DigitalWalletToken < Increase::Internal::Type::BaseModel optional :decline, -> { Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Decline } # @!method initialize(approval: nil, decline: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken} for more + # details. + # # If the Real-Time Decision relates to a digital wallet token provisioning # attempt, this object contains your response to the attempt. # - # @param approval [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Approval] - # @param decline [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Decline] + # @param approval [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Approval] If your application approves the provisioning attempt, this contains metadata ab + # ... + # + # @param decline [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Decline] If your application declines the provisioning attempt, this contains details abo + # ... # @see Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken#approval class Approval < Increase::Internal::Type::BaseModel @@ -285,11 +323,18 @@ class Approval < Increase::Internal::Type::BaseModel optional :phone, String # @!method initialize(email: nil, phone: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Approval} + # for more details. + # # If your application approves the provisioning attempt, this contains metadata # about the digital wallet token that will be generated. # - # @param email [String] - # @param phone [String] + # @param email [String] An email address that can be used to verify the cardholder via one-time passcode + # ... + # + # @param phone [String] A phone number that can be used to verify the cardholder via one-time passcode o + # ... end # @see Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken#decline @@ -302,10 +347,15 @@ class Decline < Increase::Internal::Type::BaseModel optional :reason, String # @!method initialize(reason: nil) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Decline} + # for more details. + # # If your application declines the provisioning attempt, this contains details # about the decline. # - # @param reason [String] + # @param reason [String] Why the tokenization attempt was declined. This is for logging purposes only and + # ... end end end diff --git a/lib/increase/models/real_time_payments_transfer.rb b/lib/increase/models/real_time_payments_transfer.rb index 8b05c59a8..77818fbb5 100644 --- a/lib/increase/models/real_time_payments_transfer.rb +++ b/lib/increase/models/real_time_payments_transfer.rb @@ -173,34 +173,76 @@ class RealTimePaymentsTransfer < Increase::Internal::Type::BaseModel required :ultimate_debtor_name, String, nil?: true # @!method initialize(id:, account_id:, acknowledgement:, amount:, approval:, cancellation:, created_at:, created_by:, creditor_name:, currency:, debtor_name:, destination_account_number:, destination_routing_number:, external_account_id:, idempotency_key:, pending_transaction_id:, rejection:, remittance_information:, source_account_number_id:, status:, submission:, transaction_id:, type:, ultimate_creditor_name:, ultimate_debtor_name:) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimePaymentsTransfer} for more details. + # # Real-Time Payments transfers move funds, within seconds, between your Increase # account and any other account on the Real-Time Payments network. # - # @param id [String] - # @param account_id [String] - # @param acknowledgement [Increase::Models::RealTimePaymentsTransfer::Acknowledgement, nil] - # @param amount [Integer] - # @param approval [Increase::Models::RealTimePaymentsTransfer::Approval, nil] - # @param cancellation [Increase::Models::RealTimePaymentsTransfer::Cancellation, nil] - # @param created_at [Time] - # @param created_by [Increase::Models::RealTimePaymentsTransfer::CreatedBy, nil] - # @param creditor_name [String] - # @param currency [Symbol, Increase::Models::RealTimePaymentsTransfer::Currency] - # @param debtor_name [String, nil] - # @param destination_account_number [String] - # @param destination_routing_number [String] - # @param external_account_id [String, nil] - # @param idempotency_key [String, nil] - # @param pending_transaction_id [String, nil] - # @param rejection [Increase::Models::RealTimePaymentsTransfer::Rejection, nil] - # @param remittance_information [String] - # @param source_account_number_id [String] - # @param status [Symbol, Increase::Models::RealTimePaymentsTransfer::Status] - # @param submission [Increase::Models::RealTimePaymentsTransfer::Submission, nil] - # @param transaction_id [String, nil] - # @param type [Symbol, Increase::Models::RealTimePaymentsTransfer::Type] - # @param ultimate_creditor_name [String, nil] - # @param ultimate_debtor_name [String, nil] + # @param id [String] The Real-Time Payments Transfer's identifier. + # + # @param account_id [String] The Account from which the transfer was sent. + # + # @param acknowledgement [Increase::Models::RealTimePaymentsTransfer::Acknowledgement, nil] If the transfer is acknowledged by the recipient bank, this will contain supplem + # ... + # + # @param amount [Integer] The transfer amount in USD cents. + # + # @param approval [Increase::Models::RealTimePaymentsTransfer::Approval, nil] If your account requires approvals for transfers and the transfer was approved, + # ... + # + # @param cancellation [Increase::Models::RealTimePaymentsTransfer::Cancellation, nil] If your account requires approvals for transfers and the transfer was not approv + # ... + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param created_by [Increase::Models::RealTimePaymentsTransfer::CreatedBy, nil] What object created the transfer, either via the API or the dashboard. + # + # @param creditor_name [String] The name of the transfer's recipient. This is set by the sender when creating th + # ... + # + # @param currency [Symbol, Increase::Models::RealTimePaymentsTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's c + # ... + # + # @param debtor_name [String, nil] The name of the transfer's sender. If not provided, defaults to the name of the + # ... + # + # @param destination_account_number [String] The destination account number. + # + # @param destination_routing_number [String] The destination American Bankers' Association (ABA) Routing Transit Number (RTN) + # ... + # + # @param external_account_id [String, nil] The identifier of the External Account the transfer was made to, if any. + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param pending_transaction_id [String, nil] The ID for the pending transaction representing the transfer. A pending transact + # ... + # + # @param rejection [Increase::Models::RealTimePaymentsTransfer::Rejection, nil] If the transfer is rejected by Real-Time Payments or the destination financial i + # ... + # + # @param remittance_information [String] Unstructured information that will show on the recipient's bank statement. + # + # @param source_account_number_id [String] The Account Number the recipient will see as having sent the transfer. + # + # @param status [Symbol, Increase::Models::RealTimePaymentsTransfer::Status] The lifecycle status of the transfer. + # + # @param submission [Increase::Models::RealTimePaymentsTransfer::Submission, nil] After the transfer is submitted to Real-Time Payments, this will contain supplem + # ... + # + # @param transaction_id [String, nil] The Transaction funding the transfer once it is complete. + # + # @param type [Symbol, Increase::Models::RealTimePaymentsTransfer::Type] A constant representing the object's type. For this resource it will always be ` + # ... + # + # @param ultimate_creditor_name [String, nil] The name of the ultimate recipient of the transfer. Set this if the creditor is + # ... + # + # @param ultimate_debtor_name [String, nil] The name of the ultimate sender of the transfer. Set this if the funds are being + # ... # @see Increase::Models::RealTimePaymentsTransfer#acknowledgement class Acknowledgement < Increase::Internal::Type::BaseModel @@ -214,7 +256,7 @@ class Acknowledgement < Increase::Internal::Type::BaseModel # If the transfer is acknowledged by the recipient bank, this will contain # supplemental details. # - # @param acknowledged_at [Time] + # @param acknowledged_at [Time] When the transfer was acknowledged. end # @see Increase::Models::RealTimePaymentsTransfer#approval @@ -234,11 +276,17 @@ class Approval < Increase::Internal::Type::BaseModel required :approved_by, String, nil?: true # @!method initialize(approved_at:, approved_by:) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimePaymentsTransfer::Approval} for more details. + # # If your account requires approvals for transfers and the transfer was approved, # this will contain details of the approval. # - # @param approved_at [Time] - # @param approved_by [String, nil] + # @param approved_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param approved_by [String, nil] If the Transfer was approved by a user in the dashboard, the email address of th + # ... end # @see Increase::Models::RealTimePaymentsTransfer#cancellation @@ -258,11 +306,17 @@ class Cancellation < Increase::Internal::Type::BaseModel required :canceled_by, String, nil?: true # @!method initialize(canceled_at:, canceled_by:) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimePaymentsTransfer::Cancellation} for more details. + # # If your account requires approvals for transfers and the transfer was not # approved, this will contain details of the cancellation. # - # @param canceled_at [Time] - # @param canceled_by [String, nil] + # @param canceled_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param canceled_by [String, nil] If the Transfer was canceled by a user in the dashboard, the email address of th + # ... end # @see Increase::Models::RealTimePaymentsTransfer#created_by @@ -296,10 +350,13 @@ class CreatedBy < Increase::Internal::Type::BaseModel # @!method initialize(api_key:, category:, oauth_application:, user:) # What object created the transfer, either via the API or the dashboard. # - # @param api_key [Increase::Models::RealTimePaymentsTransfer::CreatedBy::APIKey, nil] - # @param category [Symbol, Increase::Models::RealTimePaymentsTransfer::CreatedBy::Category] - # @param oauth_application [Increase::Models::RealTimePaymentsTransfer::CreatedBy::OAuthApplication, nil] - # @param user [Increase::Models::RealTimePaymentsTransfer::CreatedBy::User, nil] + # @param api_key [Increase::Models::RealTimePaymentsTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer. + # + # @param category [Symbol, Increase::Models::RealTimePaymentsTransfer::CreatedBy::Category] The type of object that created this transfer. + # + # @param oauth_application [Increase::Models::RealTimePaymentsTransfer::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer. + # + # @param user [Increase::Models::RealTimePaymentsTransfer::CreatedBy::User, nil] If present, details about the User that created the transfer. # @see Increase::Models::RealTimePaymentsTransfer::CreatedBy#api_key class APIKey < Increase::Internal::Type::BaseModel @@ -312,7 +369,7 @@ class APIKey < Increase::Internal::Type::BaseModel # @!method initialize(description:) # If present, details about the API key that created the transfer. # - # @param description [String, nil] + # @param description [String, nil] The description set for the API key when it was created. end # The type of object that created this transfer. @@ -345,7 +402,7 @@ class OAuthApplication < Increase::Internal::Type::BaseModel # @!method initialize(name:) # If present, details about the OAuth Application that created the transfer. # - # @param name [String] + # @param name [String] The name of the OAuth Application. end # @see Increase::Models::RealTimePaymentsTransfer::CreatedBy#user @@ -359,7 +416,7 @@ class User < Increase::Internal::Type::BaseModel # @!method initialize(email:) # If present, details about the User that created the transfer. # - # @param email [String] + # @param email [String] The email address of the User. end end @@ -417,12 +474,20 @@ class Rejection < Increase::Internal::Type::BaseModel required :rejected_at, Time, nil?: true # @!method initialize(reject_reason_additional_information:, reject_reason_code:, rejected_at:) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimePaymentsTransfer::Rejection} for more details. + # # If the transfer is rejected by Real-Time Payments or the destination financial # institution, this will contain supplemental details. # - # @param reject_reason_additional_information [String, nil] - # @param reject_reason_code [Symbol, Increase::Models::RealTimePaymentsTransfer::Rejection::RejectReasonCode] - # @param rejected_at [Time, nil] + # @param reject_reason_additional_information [String, nil] Additional information about the rejection provided by the recipient bank when t + # ... + # + # @param reject_reason_code [Symbol, Increase::Models::RealTimePaymentsTransfer::Rejection::RejectReasonCode] The reason the transfer was rejected as provided by the recipient bank or the Re + # ... + # + # @param rejected_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... # The reason the transfer was rejected as provided by the recipient bank or the # Real-Time Payments network. @@ -549,11 +614,16 @@ class Submission < Increase::Internal::Type::BaseModel required :transaction_identification, String # @!method initialize(submitted_at:, transaction_identification:) + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimePaymentsTransfer::Submission} for more details. + # # After the transfer is submitted to Real-Time Payments, this will contain # supplemental details. # - # @param submitted_at [Time, nil] - # @param transaction_identification [String] + # @param submitted_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param transaction_identification [String] The Real-Time Payments network identification of the transfer. end # A constant representing the object's type. For this resource it will always be diff --git a/lib/increase/models/real_time_payments_transfer_create_params.rb b/lib/increase/models/real_time_payments_transfer_create_params.rb index ec2d91a4a..bf2218e29 100644 --- a/lib/increase/models/real_time_payments_transfer_create_params.rb +++ b/lib/increase/models/real_time_payments_transfer_create_params.rb @@ -81,17 +81,37 @@ class RealTimePaymentsTransferCreateParams < Increase::Internal::Type::BaseModel optional :ultimate_debtor_name, String # @!method initialize(amount:, creditor_name:, remittance_information:, source_account_number_id:, debtor_name: nil, destination_account_number: nil, destination_routing_number: nil, external_account_id: nil, require_approval: nil, ultimate_creditor_name: nil, ultimate_debtor_name: nil, request_options: {}) - # @param amount [Integer] - # @param creditor_name [String] - # @param remittance_information [String] - # @param source_account_number_id [String] - # @param debtor_name [String] - # @param destination_account_number [String] - # @param destination_routing_number [String] - # @param external_account_id [String] - # @param require_approval [Boolean] - # @param ultimate_creditor_name [String] - # @param ultimate_debtor_name [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimePaymentsTransferCreateParams} for more details. + # + # @param amount [Integer] The transfer amount in USD cents. For Real-Time Payments transfers, must be posi + # ... + # + # @param creditor_name [String] The name of the transfer's recipient. + # + # @param remittance_information [String] Unstructured information that will show on the recipient's bank statement. + # + # @param source_account_number_id [String] The identifier of the Account Number from which to send the transfer. + # + # @param debtor_name [String] The name of the transfer's sender. If not provided, defaults to the name of the + # ... + # + # @param destination_account_number [String] The destination account number. + # + # @param destination_routing_number [String] The destination American Bankers' Association (ABA) Routing Transit Number (RTN) + # ... + # + # @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr + # ... + # + # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API. + # + # @param ultimate_creditor_name [String] The name of the ultimate recipient of the transfer. Set this if the creditor is + # ... + # + # @param ultimate_debtor_name [String] The name of the ultimate sender of the transfer. Set this if the funds are being + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/real_time_payments_transfer_list_params.rb b/lib/increase/models/real_time_payments_transfer_list_params.rb index e960de76e..98828d11f 100644 --- a/lib/increase/models/real_time_payments_transfer_list_params.rb +++ b/lib/increase/models/real_time_payments_transfer_list_params.rb @@ -53,13 +53,27 @@ class RealTimePaymentsTransferListParams < Increase::Internal::Type::BaseModel optional :status, -> { Increase::Models::RealTimePaymentsTransferListParams::Status } # @!method initialize(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) - # @param account_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimePaymentsTransferListParams} for more details. + # + # @param account_id [String] Filter Real-Time Payments Transfers to those belonging to the specified Account. + # ... + # # @param created_at [Increase::Models::RealTimePaymentsTransferListParams::CreatedAt] - # @param cursor [String] - # @param external_account_id [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param external_account_id [String] Filter Real-Time Payments Transfers to those made to the specified External Acco + # ... + # + # @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::RealTimePaymentsTransferListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel @@ -92,10 +106,21 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimePaymentsTransferListParams::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 @@ -109,7 +134,11 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimePaymentsTransferListParams::Status} for more details. + # + # @param in_ [Array] Return results whose value is in the provided list. For GET requests, this shoul + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/routing_number_list_params.rb b/lib/increase/models/routing_number_list_params.rb index ff4221e67..e10dfabac 100644 --- a/lib/increase/models/routing_number_list_params.rb +++ b/lib/increase/models/routing_number_list_params.rb @@ -27,9 +27,16 @@ class RoutingNumberListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(routing_number:, cursor: nil, limit: nil, request_options: {}) - # @param routing_number [String] - # @param cursor [String] - # @param limit [Integer] + # Some parameter documentations has been truncated, see + # {Increase::Models::RoutingNumberListParams} for more details. + # + # @param routing_number [String] Filter financial institutions by routing number. + # + # @param cursor [String] Return the page of entries after this one. + # + # @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 diff --git a/lib/increase/models/routing_number_list_response.rb b/lib/increase/models/routing_number_list_response.rb index 6b996f421..65eb0c9d2 100644 --- a/lib/increase/models/routing_number_list_response.rb +++ b/lib/increase/models/routing_number_list_response.rb @@ -43,14 +43,23 @@ class RoutingNumberListResponse < Increase::Internal::Type::BaseModel required :wire_transfers, enum: -> { Increase::Models::RoutingNumberListResponse::WireTransfers } # @!method initialize(ach_transfers:, name:, real_time_payments_transfers:, routing_number:, type:, wire_transfers:) + # Some parameter documentations has been truncated, see + # {Increase::Models::RoutingNumberListResponse} for more details. + # # Routing numbers are used to identify your bank in a financial transaction. # - # @param ach_transfers [Symbol, Increase::Models::RoutingNumberListResponse::ACHTransfers] - # @param name [String] - # @param real_time_payments_transfers [Symbol, Increase::Models::RoutingNumberListResponse::RealTimePaymentsTransfers] - # @param routing_number [String] - # @param type [Symbol, Increase::Models::RoutingNumberListResponse::Type] - # @param wire_transfers [Symbol, Increase::Models::RoutingNumberListResponse::WireTransfers] + # @param ach_transfers [Symbol, Increase::Models::RoutingNumberListResponse::ACHTransfers] This routing number's support for ACH Transfers. + # + # @param name [String] The name of the financial institution belonging to a routing number. + # + # @param real_time_payments_transfers [Symbol, Increase::Models::RoutingNumberListResponse::RealTimePaymentsTransfers] This routing number's support for Real-Time Payments Transfers. + # + # @param routing_number [String] The nine digit routing number identifier. + # + # @param type [Symbol, Increase::Models::RoutingNumberListResponse::Type] A constant representing the object's type. For this resource it will always be ` + # ... + # + # @param wire_transfers [Symbol, Increase::Models::RoutingNumberListResponse::WireTransfers] This routing number's support for Wire Transfers. # This routing number's support for ACH Transfers. # diff --git a/lib/increase/models/simulations/account_statement_create_params.rb b/lib/increase/models/simulations/account_statement_create_params.rb index 96af7d481..32b313d18 100644 --- a/lib/increase/models/simulations/account_statement_create_params.rb +++ b/lib/increase/models/simulations/account_statement_create_params.rb @@ -15,7 +15,8 @@ class AccountStatementCreateParams < Increase::Internal::Type::BaseModel required :account_id, String # @!method initialize(account_id:, request_options: {}) - # @param account_id [String] + # @param account_id [String] The identifier of the Account the statement is for. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb b/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb index 21a89ac4d..0d83fc6a4 100644 --- a/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb +++ b/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb @@ -22,8 +22,10 @@ class ACHTransferCreateNotificationOfChangeParams < Increase::Internal::Type::Ba required :corrected_data, String # @!method initialize(change_code:, corrected_data:, request_options: {}) - # @param change_code [Symbol, Increase::Models::Simulations::ACHTransferCreateNotificationOfChangeParams::ChangeCode] - # @param corrected_data [String] + # @param change_code [Symbol, Increase::Models::Simulations::ACHTransferCreateNotificationOfChangeParams::ChangeCode] The reason for the notification of change. + # + # @param corrected_data [String] The corrected data for the notification of change (e.g., a new routing number). + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The reason for the notification of change. diff --git a/lib/increase/models/simulations/ach_transfer_return_params.rb b/lib/increase/models/simulations/ach_transfer_return_params.rb index e37339850..5b2b3224c 100644 --- a/lib/increase/models/simulations/ach_transfer_return_params.rb +++ b/lib/increase/models/simulations/ach_transfer_return_params.rb @@ -16,7 +16,12 @@ class ACHTransferReturnParams < Increase::Internal::Type::BaseModel optional :reason, enum: -> { Increase::Models::Simulations::ACHTransferReturnParams::Reason } # @!method initialize(reason: nil, request_options: {}) - # @param reason [Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason] + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::ACHTransferReturnParams} for more details. + # + # @param reason [Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason] The reason why the Federal Reserve or destination bank returned this transfer. D + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The reason why the Federal Reserve or destination bank returned this transfer. diff --git a/lib/increase/models/simulations/card_authorization_create_params.rb b/lib/increase/models/simulations/card_authorization_create_params.rb index 97d38045e..a39776468 100644 --- a/lib/increase/models/simulations/card_authorization_create_params.rb +++ b/lib/increase/models/simulations/card_authorization_create_params.rb @@ -123,23 +123,51 @@ class CardAuthorizationCreateParams < Increase::Internal::Type::BaseModel optional :terminal_id, String # @!method initialize(amount:, authenticated_card_payment_id: nil, card_id: nil, decline_reason: nil, digital_wallet_token_id: nil, direction: nil, event_subscription_id: nil, merchant_acceptor_id: nil, merchant_category_code: nil, merchant_city: nil, merchant_country: nil, merchant_descriptor: nil, merchant_state: nil, network_details: nil, network_risk_score: nil, physical_card_id: nil, terminal_id: nil, request_options: {}) - # @param amount [Integer] - # @param authenticated_card_payment_id [String] - # @param card_id [String] - # @param decline_reason [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::DeclineReason] - # @param digital_wallet_token_id [String] - # @param direction [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::Direction] - # @param event_subscription_id [String] - # @param merchant_acceptor_id [String] - # @param merchant_category_code [String] - # @param merchant_city [String] - # @param merchant_country [String] - # @param merchant_descriptor [String] - # @param merchant_state [String] - # @param network_details [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails] - # @param network_risk_score [Integer] - # @param physical_card_id [String] - # @param terminal_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::CardAuthorizationCreateParams} for more details. + # + # @param amount [Integer] The authorization amount in cents. + # + # @param authenticated_card_payment_id [String] The identifier of a Card Payment with a `card_authentication` if you want to sim + # ... + # + # @param card_id [String] The identifier of the Card to be authorized. + # + # @param decline_reason [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::DeclineReason] Forces a card decline with a specific reason. No real time decision will be sent + # ... + # + # @param digital_wallet_token_id [String] The identifier of the Digital Wallet Token to be authorized. + # + # @param direction [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::Direction] The direction describes the direction the funds will move, either from the cardh + # ... + # + # @param event_subscription_id [String] The identifier of the Event Subscription to use. If provided, will override the + # ... + # + # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i + # ... + # + # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car + # ... + # + # @param merchant_city [String] The city the merchant resides in. + # + # @param merchant_country [String] The country the merchant resides in. + # + # @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with. + # + # @param merchant_state [String] The state the merchant resides in. + # + # @param network_details [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails] Fields specific to a given card network. + # + # @param network_risk_score [Integer] The risk score generated by the card network. For Visa this is the Visa Advanced + # ... + # + # @param physical_card_id [String] The identifier of the Physical Card to be authorized. + # + # @param terminal_id [String] The terminal identifier (commonly abbreviated as TID) of the terminal the card i + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # Forces a card decline with a specific reason. No real time decision will be @@ -230,7 +258,7 @@ class NetworkDetails < Increase::Internal::Type::BaseModel # @!method initialize(visa:) # Fields specific to a given card network. # - # @param visa [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa] + # @param visa [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa] Fields specific to the Visa network. # @see Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails#visa class Visa < Increase::Internal::Type::BaseModel @@ -244,7 +272,7 @@ class Visa < Increase::Internal::Type::BaseModel # @!method initialize(stand_in_processing_reason: nil) # Fields specific to the Visa network. # - # @param stand_in_processing_reason [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa::StandInProcessingReason] + # @param stand_in_processing_reason [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa::StandInProcessingReason] The reason code for the stand-in processing. # The reason code for the stand-in processing. # diff --git a/lib/increase/models/simulations/card_authorization_create_response.rb b/lib/increase/models/simulations/card_authorization_create_response.rb index f6cfb0baf..84674504a 100644 --- a/lib/increase/models/simulations/card_authorization_create_response.rb +++ b/lib/increase/models/simulations/card_authorization_create_response.rb @@ -29,11 +29,20 @@ class CardAuthorizationCreateResponse < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::Simulations::CardAuthorizationCreateResponse::Type } # @!method initialize(declined_transaction:, pending_transaction:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::CardAuthorizationCreateResponse} for more + # details. + # # The results of a Card Authorization simulation. # - # @param declined_transaction [Increase::Models::DeclinedTransaction, nil] - # @param pending_transaction [Increase::Models::PendingTransaction, nil] - # @param type [Symbol, Increase::Models::Simulations::CardAuthorizationCreateResponse::Type] + # @param declined_transaction [Increase::Models::DeclinedTransaction, nil] If the authorization attempt fails, this will contain the resulting [Declined Tr + # ... + # + # @param pending_transaction [Increase::Models::PendingTransaction, nil] If the authorization attempt succeeds, this will contain the resulting Pending T + # ... + # + # @param type [Symbol, Increase::Models::Simulations::CardAuthorizationCreateResponse::Type] A constant representing the object's type. For this resource it will always be ` + # ... # A constant representing the object's type. For this resource it will always be # `inbound_card_authorization_simulation_result`. diff --git a/lib/increase/models/simulations/card_authorization_expiration_create_params.rb b/lib/increase/models/simulations/card_authorization_expiration_create_params.rb index 5100d9593..9ca1cb58c 100644 --- a/lib/increase/models/simulations/card_authorization_expiration_create_params.rb +++ b/lib/increase/models/simulations/card_authorization_expiration_create_params.rb @@ -15,7 +15,8 @@ class CardAuthorizationExpirationCreateParams < Increase::Internal::Type::BaseMo required :card_payment_id, String # @!method initialize(card_payment_id:, request_options: {}) - # @param card_payment_id [String] + # @param card_payment_id [String] The identifier of the Card Payment to expire. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/simulations/card_dispute_action_params.rb b/lib/increase/models/simulations/card_dispute_action_params.rb index 8c5b2e7d7..eafbdb6df 100644 --- a/lib/increase/models/simulations/card_dispute_action_params.rb +++ b/lib/increase/models/simulations/card_dispute_action_params.rb @@ -21,8 +21,10 @@ class CardDisputeActionParams < Increase::Internal::Type::BaseModel optional :explanation, String # @!method initialize(status:, explanation: nil, request_options: {}) - # @param status [Symbol, Increase::Models::Simulations::CardDisputeActionParams::Status] - # @param explanation [String] + # @param status [Symbol, Increase::Models::Simulations::CardDisputeActionParams::Status] The status to move the dispute to. + # + # @param explanation [String] Why the dispute was rejected. Not required for accepting disputes. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The status to move the dispute to. diff --git a/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb b/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb index d984c0f97..1d028a0a2 100644 --- a/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb +++ b/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb @@ -22,8 +22,15 @@ class CardFuelConfirmationCreateParams < Increase::Internal::Type::BaseModel required :card_payment_id, String # @!method initialize(amount:, card_payment_id:, request_options: {}) - # @param amount [Integer] - # @param card_payment_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::CardFuelConfirmationCreateParams} for more + # details. + # + # @param amount [Integer] The amount of the fuel_confirmation in minor units in the card authorization's c + # ... + # + # @param card_payment_id [String] The identifier of the Card Payment to create a fuel_confirmation on. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/simulations/card_increment_create_params.rb b/lib/increase/models/simulations/card_increment_create_params.rb index b16edcf70..cca5b0699 100644 --- a/lib/increase/models/simulations/card_increment_create_params.rb +++ b/lib/increase/models/simulations/card_increment_create_params.rb @@ -30,9 +30,17 @@ class CardIncrementCreateParams < Increase::Internal::Type::BaseModel optional :event_subscription_id, String # @!method initialize(amount:, card_payment_id:, event_subscription_id: nil, request_options: {}) - # @param amount [Integer] - # @param card_payment_id [String] - # @param event_subscription_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::CardIncrementCreateParams} for more details. + # + # @param amount [Integer] The amount of the increment in minor units in the card authorization's currency. + # ... + # + # @param card_payment_id [String] The identifier of the Card Payment to create a increment on. + # + # @param event_subscription_id [String] The identifier of the Event Subscription to use. If provided, will override the + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/simulations/card_refund_create_params.rb b/lib/increase/models/simulations/card_refund_create_params.rb index 2cdcf2142..79bbc4e8d 100644 --- a/lib/increase/models/simulations/card_refund_create_params.rb +++ b/lib/increase/models/simulations/card_refund_create_params.rb @@ -16,7 +16,12 @@ class CardRefundCreateParams < Increase::Internal::Type::BaseModel required :transaction_id, String # @!method initialize(transaction_id:, request_options: {}) - # @param transaction_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::CardRefundCreateParams} for more details. + # + # @param transaction_id [String] The identifier for the Transaction to refund. The Transaction's source must have + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/simulations/card_reversal_create_params.rb b/lib/increase/models/simulations/card_reversal_create_params.rb index aa32b9422..b7d37f6a0 100644 --- a/lib/increase/models/simulations/card_reversal_create_params.rb +++ b/lib/increase/models/simulations/card_reversal_create_params.rb @@ -22,8 +22,14 @@ class CardReversalCreateParams < Increase::Internal::Type::BaseModel optional :amount, Integer # @!method initialize(card_payment_id:, amount: nil, request_options: {}) - # @param card_payment_id [String] - # @param amount [Integer] + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::CardReversalCreateParams} for more details. + # + # @param card_payment_id [String] The identifier of the Card Payment to create a reversal on. + # + # @param amount [Integer] The amount of the reversal in minor units in the card authorization's currency. + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/simulations/card_settlement_create_params.rb b/lib/increase/models/simulations/card_settlement_create_params.rb index 1ae193b5a..3f4fd0b46 100644 --- a/lib/increase/models/simulations/card_settlement_create_params.rb +++ b/lib/increase/models/simulations/card_settlement_create_params.rb @@ -29,9 +29,17 @@ class CardSettlementCreateParams < Increase::Internal::Type::BaseModel optional :amount, Integer # @!method initialize(card_id:, pending_transaction_id:, amount: nil, request_options: {}) - # @param card_id [String] - # @param pending_transaction_id [String] - # @param amount [Integer] + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::CardSettlementCreateParams} for more details. + # + # @param card_id [String] The identifier of the Card to create a settlement on. + # + # @param pending_transaction_id [String] The identifier of the Pending Transaction for the Card Authorization you wish to + # ... + # + # @param amount [Integer] The amount to be settled. This defaults to the amount of the Pending Transaction + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/simulations/digital_wallet_token_request_create_params.rb b/lib/increase/models/simulations/digital_wallet_token_request_create_params.rb index f0dd14002..e33a9c1bc 100644 --- a/lib/increase/models/simulations/digital_wallet_token_request_create_params.rb +++ b/lib/increase/models/simulations/digital_wallet_token_request_create_params.rb @@ -15,7 +15,8 @@ class DigitalWalletTokenRequestCreateParams < Increase::Internal::Type::BaseMode required :card_id, String # @!method initialize(card_id:, request_options: {}) - # @param card_id [String] + # @param card_id [String] The identifier of the Card to be authorized. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb b/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb index 63c25dbc0..f01b0c8bf 100644 --- a/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +++ b/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb @@ -29,11 +29,20 @@ class DigitalWalletTokenRequestCreateResponse < Increase::Internal::Type::BaseMo required :type, enum: -> { Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::Type } # @!method initialize(decline_reason:, digital_wallet_token_id:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse} for + # more details. + # # The results of a Digital Wallet Token simulation. # - # @param decline_reason [Symbol, Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::DeclineReason, nil] - # @param digital_wallet_token_id [String, nil] - # @param type [Symbol, Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::Type] + # @param decline_reason [Symbol, Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::DeclineReason, nil] If the simulated tokenization attempt was declined, this field contains details + # ... + # + # @param digital_wallet_token_id [String, nil] If the simulated tokenization attempt was accepted, this field contains the id o + # ... + # + # @param type [Symbol, Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::Type] A constant representing the object's type. For this resource it will always be ` + # ... # If the simulated tokenization attempt was declined, this field contains details # as to why. diff --git a/lib/increase/models/simulations/document_create_params.rb b/lib/increase/models/simulations/document_create_params.rb index 540ab13ca..a72769ae1 100644 --- a/lib/increase/models/simulations/document_create_params.rb +++ b/lib/increase/models/simulations/document_create_params.rb @@ -15,7 +15,8 @@ class DocumentCreateParams < Increase::Internal::Type::BaseModel required :account_id, String # @!method initialize(account_id:, request_options: {}) - # @param account_id [String] + # @param account_id [String] The identifier of the Account the tax document is for. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb b/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb index e4233385b..f5235af3c 100644 --- a/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +++ b/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb @@ -79,17 +79,34 @@ class InboundACHTransferCreateParams < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode } # @!method initialize(account_number_id:, amount:, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_id: nil, company_name: nil, receiver_id_number: nil, receiver_name: nil, resolve_at: nil, standard_entry_class_code: nil, request_options: {}) - # @param account_number_id [String] - # @param amount [Integer] - # @param company_descriptive_date [String] - # @param company_discretionary_data [String] - # @param company_entry_description [String] - # @param company_id [String] - # @param company_name [String] - # @param receiver_id_number [String] - # @param receiver_name [String] - # @param resolve_at [Time] - # @param standard_entry_class_code [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode] + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::InboundACHTransferCreateParams} for more + # details. + # + # @param account_number_id [String] The identifier of the Account Number the inbound ACH Transfer is for. + # + # @param amount [Integer] The transfer amount in cents. A positive amount originates a credit transfer pus + # ... + # + # @param company_descriptive_date [String] The description of the date of the transfer. + # + # @param company_discretionary_data [String] Data associated with the transfer set by the sender. + # + # @param company_entry_description [String] The description of the transfer set by the sender. + # + # @param company_id [String] The sender's company ID. + # + # @param company_name [String] The name of the sender. + # + # @param receiver_id_number [String] The ID of the receiver of the transfer. + # + # @param receiver_name [String] The name of the receiver of the transfer. + # + # @param resolve_at [Time] The time at which the transfer should be resolved. If not provided will resolve + # ... + # + # @param standard_entry_class_code [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode] The standard entry class code for the transfer. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The standard entry class code for the transfer. diff --git a/lib/increase/models/simulations/inbound_check_deposit_create_params.rb b/lib/increase/models/simulations/inbound_check_deposit_create_params.rb index dae81bf2b..b440a316f 100644 --- a/lib/increase/models/simulations/inbound_check_deposit_create_params.rb +++ b/lib/increase/models/simulations/inbound_check_deposit_create_params.rb @@ -27,9 +27,12 @@ class InboundCheckDepositCreateParams < Increase::Internal::Type::BaseModel required :check_number, String # @!method initialize(account_number_id:, amount:, check_number:, request_options: {}) - # @param account_number_id [String] - # @param amount [Integer] - # @param check_number [String] + # @param account_number_id [String] The identifier of the Account Number the Inbound Check Deposit will be against. + # + # @param amount [Integer] The check amount in cents. + # + # @param check_number [String] The check number on the check to be deposited. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/simulations/inbound_funds_hold_release_response.rb b/lib/increase/models/simulations/inbound_funds_hold_release_response.rb index 8c47dc743..a7bc6b793 100644 --- a/lib/increase/models/simulations/inbound_funds_hold_release_response.rb +++ b/lib/increase/models/simulations/inbound_funds_hold_release_response.rb @@ -71,19 +71,37 @@ class InboundFundsHoldReleaseResponse < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Type } # @!method initialize(id:, amount:, automatically_releases_at:, created_at:, currency:, held_transaction_id:, pending_transaction_id:, released_at:, status:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::InboundFundsHoldReleaseResponse} for more + # details. + # # We hold funds for certain transaction types to account for return windows where # funds might still be clawed back by the sending institution. # - # @param id [String] - # @param amount [Integer] - # @param automatically_releases_at [Time] - # @param created_at [Time] - # @param currency [Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Currency] - # @param held_transaction_id [String, nil] - # @param pending_transaction_id [String, nil] - # @param released_at [Time, nil] - # @param status [Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Status] - # @param type [Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Type] + # @param id [String] The Inbound Funds Hold identifier. + # + # @param amount [Integer] The held amount in the minor unit of the account's currency. For dollars, for ex + # ... + # + # @param automatically_releases_at [Time] When the hold will be released automatically. Certain conditions may cause it to + # ... + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold wa + # ... + # + # @param currency [Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's curre + # ... + # + # @param held_transaction_id [String, nil] The ID of the Transaction for which funds were held. + # + # @param pending_transaction_id [String, nil] The ID of the Pending Transaction representing the held funds. + # + # @param released_at [Time, nil] When the hold was released (if it has been released). + # + # @param status [Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Status] The status of the hold. + # + # @param type [Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's # currency. diff --git a/lib/increase/models/simulations/inbound_mail_item_create_params.rb b/lib/increase/models/simulations/inbound_mail_item_create_params.rb index 1a920a9ce..464084f25 100644 --- a/lib/increase/models/simulations/inbound_mail_item_create_params.rb +++ b/lib/increase/models/simulations/inbound_mail_item_create_params.rb @@ -28,9 +28,16 @@ class InboundMailItemCreateParams < Increase::Internal::Type::BaseModel optional :contents_file_id, String # @!method initialize(amount:, lockbox_id:, contents_file_id: nil, request_options: {}) - # @param amount [Integer] - # @param lockbox_id [String] - # @param contents_file_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::InboundMailItemCreateParams} for more details. + # + # @param amount [Integer] The amount of the check to be simulated, in cents. + # + # @param lockbox_id [String] The identifier of the Lockbox to simulate inbound mail to. + # + # @param contents_file_id [String] The file containing the PDF contents. If not present, a default check image file + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb b/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb index 2e93db7dd..f1769cdcd 100644 --- a/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb +++ b/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb @@ -52,13 +52,26 @@ class InboundRealTimePaymentsTransferCreateParams < Increase::Internal::Type::Ba optional :request_for_payment_id, String # @!method initialize(account_number_id:, amount:, debtor_account_number: nil, debtor_name: nil, debtor_routing_number: nil, remittance_information: nil, request_for_payment_id: nil, request_options: {}) - # @param account_number_id [String] - # @param amount [Integer] - # @param debtor_account_number [String] - # @param debtor_name [String] - # @param debtor_routing_number [String] - # @param remittance_information [String] - # @param request_for_payment_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::InboundRealTimePaymentsTransferCreateParams} for + # more details. + # + # @param account_number_id [String] The identifier of the Account Number the inbound Real-Time Payments Transfer is + # ... + # + # @param amount [Integer] The transfer amount in USD cents. Must be positive. + # + # @param debtor_account_number [String] The account number of the account that sent the transfer. + # + # @param debtor_name [String] The name provided by the sender of the transfer. + # + # @param debtor_routing_number [String] The routing number of the account that sent the transfer. + # + # @param remittance_information [String] Additional information included with the transfer. + # + # @param request_for_payment_id [String] The identifier of a pending Request for Payment that this transfer will fulfill. + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb b/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb index 8c10a8548..762b4247a 100644 --- a/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb +++ b/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb @@ -135,26 +135,56 @@ class InboundWireDrawdownRequestCreateParams < Increase::Internal::Type::BaseMod optional :originator_to_beneficiary_information_line4, String # @!method initialize(amount:, beneficiary_account_number:, beneficiary_routing_number:, currency:, message_to_recipient:, originator_account_number:, originator_routing_number:, recipient_account_number_id:, beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, beneficiary_name: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, originator_to_beneficiary_information_line1: nil, originator_to_beneficiary_information_line2: nil, originator_to_beneficiary_information_line3: nil, originator_to_beneficiary_information_line4: nil, request_options: {}) - # @param amount [Integer] - # @param beneficiary_account_number [String] - # @param beneficiary_routing_number [String] - # @param currency [String] - # @param message_to_recipient [String] - # @param originator_account_number [String] - # @param originator_routing_number [String] - # @param recipient_account_number_id [String] - # @param beneficiary_address_line1 [String] - # @param beneficiary_address_line2 [String] - # @param beneficiary_address_line3 [String] - # @param beneficiary_name [String] - # @param originator_address_line1 [String] - # @param originator_address_line2 [String] - # @param originator_address_line3 [String] - # @param originator_name [String] - # @param originator_to_beneficiary_information_line1 [String] - # @param originator_to_beneficiary_information_line2 [String] - # @param originator_to_beneficiary_information_line3 [String] - # @param originator_to_beneficiary_information_line4 [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::InboundWireDrawdownRequestCreateParams} for more + # details. + # + # @param amount [Integer] The amount being requested in cents. + # + # @param beneficiary_account_number [String] The drawdown request's beneficiary's account number. + # + # @param beneficiary_routing_number [String] The drawdown request's beneficiary's routing number. + # + # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being + # ... + # + # @param message_to_recipient [String] A message from the drawdown request's originator. + # + # @param originator_account_number [String] The drawdown request's originator's account number. + # + # @param originator_routing_number [String] The drawdown request's originator's routing number. + # + # @param recipient_account_number_id [String] The Account Number to which the recipient of this request is being requested to + # ... + # + # @param beneficiary_address_line1 [String] Line 1 of the drawdown request's beneficiary's address. + # + # @param beneficiary_address_line2 [String] Line 2 of the drawdown request's beneficiary's address. + # + # @param beneficiary_address_line3 [String] Line 3 of the drawdown request's beneficiary's address. + # + # @param beneficiary_name [String] The drawdown request's beneficiary's name. + # + # @param originator_address_line1 [String] Line 1 of the drawdown request's originator's address. + # + # @param originator_address_line2 [String] Line 2 of the drawdown request's originator's address. + # + # @param originator_address_line3 [String] Line 3 of the drawdown request's originator's address. + # + # @param originator_name [String] The drawdown request's originator's name. + # + # @param originator_to_beneficiary_information_line1 [String] Line 1 of the information conveyed from the originator of the message to the ben + # ... + # + # @param originator_to_beneficiary_information_line2 [String] Line 2 of the information conveyed from the originator of the message to the ben + # ... + # + # @param originator_to_beneficiary_information_line3 [String] Line 3 of the information conveyed from the originator of the message to the ben + # ... + # + # @param originator_to_beneficiary_information_line4 [String] Line 4 of the information conveyed from the originator of the message to the ben + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb b/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb index 48649b919..a6d90d59d 100644 --- a/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb +++ b/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb @@ -126,23 +126,59 @@ class InboundWireTransferCreateParams < Increase::Internal::Type::BaseModel optional :sender_reference, String # @!method initialize(account_number_id:, amount:, beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, beneficiary_name: nil, beneficiary_reference: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, originator_routing_number: nil, originator_to_beneficiary_information_line1: nil, originator_to_beneficiary_information_line2: nil, originator_to_beneficiary_information_line3: nil, originator_to_beneficiary_information_line4: nil, sender_reference: nil, request_options: {}) - # @param account_number_id [String] - # @param amount [Integer] - # @param beneficiary_address_line1 [String] - # @param beneficiary_address_line2 [String] - # @param beneficiary_address_line3 [String] - # @param beneficiary_name [String] - # @param beneficiary_reference [String] - # @param originator_address_line1 [String] - # @param originator_address_line2 [String] - # @param originator_address_line3 [String] - # @param originator_name [String] - # @param originator_routing_number [String] - # @param originator_to_beneficiary_information_line1 [String] - # @param originator_to_beneficiary_information_line2 [String] - # @param originator_to_beneficiary_information_line3 [String] - # @param originator_to_beneficiary_information_line4 [String] - # @param sender_reference [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::InboundWireTransferCreateParams} for more + # details. + # + # @param account_number_id [String] The identifier of the Account Number the inbound Wire Transfer is for. + # + # @param amount [Integer] The transfer amount in cents. Must be positive. + # + # @param beneficiary_address_line1 [String] The sending bank will set beneficiary_address_line1 in production. You can simul + # ... + # + # @param beneficiary_address_line2 [String] The sending bank will set beneficiary_address_line2 in production. You can simul + # ... + # + # @param beneficiary_address_line3 [String] The sending bank will set beneficiary_address_line3 in production. You can simul + # ... + # + # @param beneficiary_name [String] The sending bank will set beneficiary_name in production. You can simulate any v + # ... + # + # @param beneficiary_reference [String] The sending bank will set beneficiary_reference in production. You can simulate + # ... + # + # @param originator_address_line1 [String] The sending bank will set originator_address_line1 in production. You can simula + # ... + # + # @param originator_address_line2 [String] The sending bank will set originator_address_line2 in production. You can simula + # ... + # + # @param originator_address_line3 [String] The sending bank will set originator_address_line3 in production. You can simula + # ... + # + # @param originator_name [String] The sending bank will set originator_name in production. You can simulate any va + # ... + # + # @param originator_routing_number [String] The sending bank will set originator_routing_number in production. You can simul + # ... + # + # @param originator_to_beneficiary_information_line1 [String] The sending bank will set originator_to_beneficiary_information_line1 in product + # ... + # + # @param originator_to_beneficiary_information_line2 [String] The sending bank will set originator_to_beneficiary_information_line2 in product + # ... + # + # @param originator_to_beneficiary_information_line3 [String] The sending bank will set originator_to_beneficiary_information_line3 in product + # ... + # + # @param originator_to_beneficiary_information_line4 [String] The sending bank will set originator_to_beneficiary_information_line4 in product + # ... + # + # @param sender_reference [String] The sending bank will set sender_reference in production. You can simulate any v + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/simulations/interest_payment_create_params.rb b/lib/increase/models/simulations/interest_payment_create_params.rb index 5130e7f2b..8c7326fec 100644 --- a/lib/increase/models/simulations/interest_payment_create_params.rb +++ b/lib/increase/models/simulations/interest_payment_create_params.rb @@ -39,11 +39,21 @@ class InterestPaymentCreateParams < Increase::Internal::Type::BaseModel optional :period_start, Time # @!method initialize(account_id:, amount:, accrued_on_account_id: nil, period_end: nil, period_start: nil, request_options: {}) - # @param account_id [String] - # @param amount [Integer] - # @param accrued_on_account_id [String] - # @param period_end [Time] - # @param period_start [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::InterestPaymentCreateParams} for more details. + # + # @param account_id [String] The identifier of the Account the Interest Payment should be paid to is for. + # + # @param amount [Integer] The interest amount in cents. Must be positive. + # + # @param accrued_on_account_id [String] The identifier of the Account the Interest accrued on. Defaults to `account_id`. + # ... + # + # @param period_end [Time] The end of the interest period. If not provided, defaults to the current time. + # + # @param period_start [Time] The start of the interest period. If not provided, defaults to the current time. + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/simulations/physical_card_advance_shipment_params.rb b/lib/increase/models/simulations/physical_card_advance_shipment_params.rb index a9ae77352..d40ec704c 100644 --- a/lib/increase/models/simulations/physical_card_advance_shipment_params.rb +++ b/lib/increase/models/simulations/physical_card_advance_shipment_params.rb @@ -16,7 +16,8 @@ class PhysicalCardAdvanceShipmentParams < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus } # @!method initialize(shipment_status:, request_options: {}) - # @param shipment_status [Symbol, Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus] + # @param shipment_status [Symbol, Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus] The shipment status to move the Physical Card to. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The shipment status to move the Physical Card to. diff --git a/lib/increase/models/simulations/program_create_params.rb b/lib/increase/models/simulations/program_create_params.rb index 5ab482b36..3bd5e0104 100644 --- a/lib/increase/models/simulations/program_create_params.rb +++ b/lib/increase/models/simulations/program_create_params.rb @@ -15,7 +15,8 @@ class ProgramCreateParams < Increase::Internal::Type::BaseModel required :name, String # @!method initialize(name:, request_options: {}) - # @param name [String] + # @param name [String] The name of the program being added. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb b/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb index ef245103b..1c9d55323 100644 --- a/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb +++ b/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb @@ -16,7 +16,8 @@ class RealTimePaymentsTransferCompleteParams < Increase::Internal::Type::BaseMod -> { Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection } # @!method initialize(rejection: nil, request_options: {}) - # @param rejection [Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection] + # @param rejection [Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection] If set, the simulation will reject the transfer. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Rejection < Increase::Internal::Type::BaseModel @@ -30,7 +31,7 @@ class Rejection < Increase::Internal::Type::BaseModel # @!method initialize(reject_reason_code:) # If set, the simulation will reject the transfer. # - # @param reject_reason_code [Symbol, Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection::RejectReasonCode] + # @param reject_reason_code [Symbol, Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection::RejectReasonCode] The reason code that the simulated rejection will have. # The reason code that the simulated rejection will have. # diff --git a/lib/increase/models/supplemental_document_create_params.rb b/lib/increase/models/supplemental_document_create_params.rb index 0dffdb299..cfd86ebfd 100644 --- a/lib/increase/models/supplemental_document_create_params.rb +++ b/lib/increase/models/supplemental_document_create_params.rb @@ -20,8 +20,10 @@ class SupplementalDocumentCreateParams < Increase::Internal::Type::BaseModel required :file_id, String # @!method initialize(entity_id:, file_id:, request_options: {}) - # @param entity_id [String] - # @param file_id [String] + # @param entity_id [String] The identifier of the Entity to associate with the supplemental document. + # + # @param file_id [String] The identifier of the File containing the document. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/supplemental_document_list_params.rb b/lib/increase/models/supplemental_document_list_params.rb index 46888eec1..9c1145f43 100644 --- a/lib/increase/models/supplemental_document_list_params.rb +++ b/lib/increase/models/supplemental_document_list_params.rb @@ -36,10 +36,19 @@ class SupplementalDocumentListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(entity_id:, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) - # @param entity_id [String] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # Some parameter documentations has been truncated, see + # {Increase::Models::SupplementalDocumentListParams} for more details. + # + # @param entity_id [String] The identifier of the Entity to list supplemental documents for. + # + # @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}] end end diff --git a/lib/increase/models/transaction.rb b/lib/increase/models/transaction.rb index 9752bb319..8798a064c 100644 --- a/lib/increase/models/transaction.rb +++ b/lib/increase/models/transaction.rb @@ -76,19 +76,38 @@ class Transaction < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::Transaction::Type } # @!method initialize(id:, account_id:, amount:, created_at:, currency:, description:, route_id:, route_type:, source:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction} for more details. + # # Transactions are the immutable additions and removals of money from your bank # account. They're the equivalent of line items on your bank statement. # - # @param id [String] - # @param account_id [String] - # @param amount [Integer] - # @param created_at [Time] - # @param currency [Symbol, Increase::Models::Transaction::Currency] - # @param description [String] - # @param route_id [String, nil] - # @param route_type [Symbol, Increase::Models::Transaction::RouteType, nil] - # @param source [Increase::Models::Transaction::Source] - # @param type [Symbol, Increase::Models::Transaction::Type] + # @param id [String] The Transaction identifier. + # + # @param account_id [String] The identifier for the Account the Transaction belongs to. + # + # @param amount [Integer] The Transaction amount in the minor unit of its currency. For dollars, for examp + # ... + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transac + # ... + # + # @param currency [Symbol, Increase::Models::Transaction::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction' + # ... + # + # @param description [String] An informational message describing this transaction. Use the fields in `source` + # ... + # + # @param route_id [String, nil] The identifier for the route this Transaction came through. Routes are things li + # ... + # + # @param route_type [Symbol, Increase::Models::Transaction::RouteType, nil] The type of the route this Transaction came through. + # + # @param source [Increase::Models::Transaction::Source] This is an object giving more details on the network-level event that caused the + # ... + # + # @param type [Symbol, Increase::Models::Transaction::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the # Transaction's currency. This will match the currency on the Transaction's @@ -451,41 +470,103 @@ class Source < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(account_transfer_intention:, ach_transfer_intention:, ach_transfer_rejection:, ach_transfer_return:, card_dispute_acceptance:, card_dispute_loss:, card_refund:, card_revenue_payment:, card_settlement:, cashback_payment:, category:, check_deposit_acceptance:, check_deposit_return:, check_transfer_deposit:, fee_payment:, inbound_ach_transfer:, inbound_ach_transfer_return_intention:, inbound_check_adjustment:, inbound_check_deposit_return_intention:, inbound_real_time_payments_transfer_confirmation:, inbound_real_time_payments_transfer_decline:, inbound_wire_reversal:, inbound_wire_transfer:, inbound_wire_transfer_reversal:, interest_payment:, internal_source:, other:, real_time_payments_transfer_acknowledgement:, sample_funds:, wire_transfer_intention:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source} for more details. + # # This is an object giving more details on the network-level event that caused the # Transaction. Note that for backwards compatibility reasons, additional # undocumented keys may appear in this object. These should be treated as # deprecated and will be removed in the future. # - # @param account_transfer_intention [Increase::Models::Transaction::Source::AccountTransferIntention, nil] - # @param ach_transfer_intention [Increase::Models::Transaction::Source::ACHTransferIntention, nil] - # @param ach_transfer_rejection [Increase::Models::Transaction::Source::ACHTransferRejection, nil] - # @param ach_transfer_return [Increase::Models::Transaction::Source::ACHTransferReturn, nil] - # @param card_dispute_acceptance [Increase::Models::Transaction::Source::CardDisputeAcceptance, nil] - # @param card_dispute_loss [Increase::Models::Transaction::Source::CardDisputeLoss, nil] - # @param card_refund [Increase::Models::Transaction::Source::CardRefund, nil] - # @param card_revenue_payment [Increase::Models::Transaction::Source::CardRevenuePayment, nil] - # @param card_settlement [Increase::Models::Transaction::Source::CardSettlement, nil] - # @param cashback_payment [Increase::Models::Transaction::Source::CashbackPayment, nil] - # @param category [Symbol, Increase::Models::Transaction::Source::Category] - # @param check_deposit_acceptance [Increase::Models::Transaction::Source::CheckDepositAcceptance, nil] - # @param check_deposit_return [Increase::Models::Transaction::Source::CheckDepositReturn, nil] - # @param check_transfer_deposit [Increase::Models::Transaction::Source::CheckTransferDeposit, nil] - # @param fee_payment [Increase::Models::Transaction::Source::FeePayment, nil] - # @param inbound_ach_transfer [Increase::Models::Transaction::Source::InboundACHTransfer, nil] - # @param inbound_ach_transfer_return_intention [Increase::Models::Transaction::Source::InboundACHTransferReturnIntention, nil] - # @param inbound_check_adjustment [Increase::Models::Transaction::Source::InboundCheckAdjustment, nil] - # @param inbound_check_deposit_return_intention [Increase::Models::Transaction::Source::InboundCheckDepositReturnIntention, nil] - # @param inbound_real_time_payments_transfer_confirmation [Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation, nil] - # @param inbound_real_time_payments_transfer_decline [Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline, nil] - # @param inbound_wire_reversal [Increase::Models::Transaction::Source::InboundWireReversal, nil] - # @param inbound_wire_transfer [Increase::Models::Transaction::Source::InboundWireTransfer, nil] - # @param inbound_wire_transfer_reversal [Increase::Models::Transaction::Source::InboundWireTransferReversal, nil] - # @param interest_payment [Increase::Models::Transaction::Source::InterestPayment, nil] - # @param internal_source [Increase::Models::Transaction::Source::InternalSource, nil] - # @param other [Object, nil] - # @param real_time_payments_transfer_acknowledgement [Increase::Models::Transaction::Source::RealTimePaymentsTransferAcknowledgement, nil] - # @param sample_funds [Increase::Models::Transaction::Source::SampleFunds, nil] - # @param wire_transfer_intention [Increase::Models::Transaction::Source::WireTransferIntention, nil] + # @param account_transfer_intention [Increase::Models::Transaction::Source::AccountTransferIntention, nil] An Account Transfer Intention object. This field will be present in the JSON res + # ... + # + # @param ach_transfer_intention [Increase::Models::Transaction::Source::ACHTransferIntention, nil] An ACH Transfer Intention object. This field will be present in the JSON respons + # ... + # + # @param ach_transfer_rejection [Increase::Models::Transaction::Source::ACHTransferRejection, nil] An ACH Transfer Rejection object. This field will be present in the JSON respons + # ... + # + # @param ach_transfer_return [Increase::Models::Transaction::Source::ACHTransferReturn, nil] An ACH Transfer Return object. This field will be present in the JSON response i + # ... + # + # @param card_dispute_acceptance [Increase::Models::Transaction::Source::CardDisputeAcceptance, nil] A Card Dispute Acceptance object. This field will be present in the JSON respons + # ... + # + # @param card_dispute_loss [Increase::Models::Transaction::Source::CardDisputeLoss, nil] A Card Dispute Loss object. This field will be present in the JSON response if a + # ... + # + # @param card_refund [Increase::Models::Transaction::Source::CardRefund, nil] A Card Refund object. This field will be present in the JSON response if and onl + # ... + # + # @param card_revenue_payment [Increase::Models::Transaction::Source::CardRevenuePayment, nil] A Card Revenue Payment object. This field will be present in the JSON response i + # ... + # + # @param card_settlement [Increase::Models::Transaction::Source::CardSettlement, nil] A Card Settlement object. This field will be present in the JSON response if and + # ... + # + # @param cashback_payment [Increase::Models::Transaction::Source::CashbackPayment, nil] A Cashback Payment object. This field will be present in the JSON response if an + # ... + # + # @param category [Symbol, Increase::Models::Transaction::Source::Category] The type of the resource. We may add additional possible values for this enum ov + # ... + # + # @param check_deposit_acceptance [Increase::Models::Transaction::Source::CheckDepositAcceptance, nil] A Check Deposit Acceptance object. This field will be present in the JSON respon + # ... + # + # @param check_deposit_return [Increase::Models::Transaction::Source::CheckDepositReturn, nil] A Check Deposit Return object. This field will be present in the JSON response i + # ... + # + # @param check_transfer_deposit [Increase::Models::Transaction::Source::CheckTransferDeposit, nil] A Check Transfer Deposit object. This field will be present in the JSON response + # ... + # + # @param fee_payment [Increase::Models::Transaction::Source::FeePayment, nil] A Fee Payment object. This field will be present in the JSON response if and onl + # ... + # + # @param inbound_ach_transfer [Increase::Models::Transaction::Source::InboundACHTransfer, nil] An Inbound ACH Transfer Intention object. This field will be present in the JSON + # ... + # + # @param inbound_ach_transfer_return_intention [Increase::Models::Transaction::Source::InboundACHTransferReturnIntention, nil] An Inbound ACH Transfer Return Intention object. This field will be present in t + # ... + # + # @param inbound_check_adjustment [Increase::Models::Transaction::Source::InboundCheckAdjustment, nil] An Inbound Check Adjustment object. This field will be present in the JSON respo + # ... + # + # @param inbound_check_deposit_return_intention [Increase::Models::Transaction::Source::InboundCheckDepositReturnIntention, nil] An Inbound Check Deposit Return Intention object. This field will be present in + # ... + # + # @param inbound_real_time_payments_transfer_confirmation [Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation, nil] An Inbound Real-Time Payments Transfer Confirmation object. This field will be p + # ... + # + # @param inbound_real_time_payments_transfer_decline [Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline, nil] An Inbound Real-Time Payments Transfer Decline object. This field will be presen + # ... + # + # @param inbound_wire_reversal [Increase::Models::Transaction::Source::InboundWireReversal, nil] An Inbound Wire Reversal object. This field will be present in the JSON response + # ... + # + # @param inbound_wire_transfer [Increase::Models::Transaction::Source::InboundWireTransfer, nil] An Inbound Wire Transfer Intention object. This field will be present in the JSO + # ... + # + # @param inbound_wire_transfer_reversal [Increase::Models::Transaction::Source::InboundWireTransferReversal, nil] An Inbound Wire Transfer Reversal Intention object. This field will be present i + # ... + # + # @param interest_payment [Increase::Models::Transaction::Source::InterestPayment, nil] An Interest Payment object. This field will be present in the JSON response if a + # ... + # + # @param internal_source [Increase::Models::Transaction::Source::InternalSource, nil] An Internal Source object. This field will be present in the JSON response if an + # ... + # + # @param other [Object, nil] If the category of this Transaction source is equal to `other`, this field will + # ... + # + # @param real_time_payments_transfer_acknowledgement [Increase::Models::Transaction::Source::RealTimePaymentsTransferAcknowledgement, nil] A Real-Time Payments Transfer Acknowledgement object. This field will be present + # ... + # + # @param sample_funds [Increase::Models::Transaction::Source::SampleFunds, nil] A Sample Funds object. This field will be present in the JSON response if and on + # ... + # + # @param wire_transfer_intention [Increase::Models::Transaction::Source::WireTransferIntention, nil] A Wire Transfer Intention object. This field will be present in the JSON respons + # ... # @see Increase::Models::Transaction::Source#account_transfer_intention class AccountTransferIntention < Increase::Internal::Type::BaseModel @@ -528,17 +609,28 @@ class AccountTransferIntention < Increase::Internal::Type::BaseModel required :transfer_id, String # @!method initialize(amount:, currency:, description:, destination_account_id:, source_account_id:, transfer_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::AccountTransferIntention} for more + # details. + # # An Account Transfer Intention object. This field will be present in the JSON # response if and only if `category` is equal to `account_transfer_intention`. Two # Account Transfer Intentions are created from each Account Transfer. One # decrements the source account, and the other increments the destination account. # - # @param amount [Integer] - # @param currency [Symbol, Increase::Models::Transaction::Source::AccountTransferIntention::Currency] - # @param description [String] - # @param destination_account_id [String] - # @param source_account_id [String] - # @param transfer_id [String] + # @param amount [Integer] The pending amount in the minor unit of the transaction's currency. For dollars, + # ... + # + # @param currency [Symbol, Increase::Models::Transaction::Source::AccountTransferIntention::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination + # ... + # + # @param description [String] The description you chose to give the transfer. + # + # @param destination_account_id [String] The identifier of the Account to where the Account Transfer was sent. + # + # @param source_account_id [String] The identifier of the Account from where the Account Transfer was sent. + # + # @param transfer_id [String] The identifier of the Account Transfer that led to this Pending Transaction. # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination # account currency. @@ -605,16 +697,25 @@ class ACHTransferIntention < Increase::Internal::Type::BaseModel required :transfer_id, String # @!method initialize(account_number:, amount:, routing_number:, statement_descriptor:, transfer_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::ACHTransferIntention} for more details. + # # An ACH Transfer Intention object. This field will be present in the JSON # response if and only if `category` is equal to `ach_transfer_intention`. An ACH # Transfer Intention is created from an ACH Transfer. It reflects the intention to # move money into or out of an Increase account via the ACH network. # - # @param account_number [String] - # @param amount [Integer] - # @param routing_number [String] - # @param statement_descriptor [String] - # @param transfer_id [String] + # @param account_number [String] The account number for the destination account. + # + # @param amount [Integer] The amount in the minor unit of the transaction's currency. For dollars, for exa + # ... + # + # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des + # ... + # + # @param statement_descriptor [String] A description set when the ACH Transfer was created. + # + # @param transfer_id [String] The identifier of the ACH Transfer that led to this Transaction. end # @see Increase::Models::Transaction::Source#ach_transfer_rejection @@ -631,7 +732,7 @@ class ACHTransferRejection < Increase::Internal::Type::BaseModel # Transfer Rejection is created when an ACH Transfer is rejected by Increase. It # offsets the ACH Transfer Intention. These rejections are rare. # - # @param transfer_id [String] + # @param transfer_id [String] The identifier of the ACH Transfer that led to this Transaction. end # @see Increase::Models::Transaction::Source#ach_transfer_return @@ -679,6 +780,9 @@ class ACHTransferReturn < Increase::Internal::Type::BaseModel required :transfer_id, String # @!method initialize(created_at:, raw_return_reason_code:, return_reason_code:, trace_number:, transaction_id:, transfer_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::ACHTransferReturn} for more details. + # # An ACH Transfer Return object. This field will be present in the JSON response # if and only if `category` is equal to `ach_transfer_return`. An ACH Transfer # Return is created when an ACH Transfer is returned by the receiving bank. It @@ -686,12 +790,20 @@ class ACHTransferReturn < Increase::Internal::Type::BaseModel # the first two business days after the transfer is initiated, but can occur much # later. # - # @param created_at [Time] - # @param raw_return_reason_code [String] - # @param return_reason_code [Symbol, Increase::Models::Transaction::Source::ACHTransferReturn::ReturnReasonCode] - # @param trace_number [String] - # @param transaction_id [String] - # @param transfer_id [String] + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param raw_return_reason_code [String] The three character ACH return code, in the range R01 to R85. + # + # @param return_reason_code [Symbol, Increase::Models::Transaction::Source::ACHTransferReturn::ReturnReasonCode] Why the ACH Transfer was returned. This reason code is sent by the receiving ban + # ... + # + # @param trace_number [String] A 15 digit number that was generated by the bank that initiated the return. The + # ... + # + # @param transaction_id [String] The identifier of the Transaction associated with this return. + # + # @param transfer_id [String] The identifier of the ACH Transfer associated with this return. # Why the ACH Transfer was returned. This reason code is sent by the receiving # bank back to Increase. @@ -941,13 +1053,20 @@ class CardDisputeAcceptance < Increase::Internal::Type::BaseModel required :transaction_id, String # @!method initialize(accepted_at:, card_dispute_id:, transaction_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CardDisputeAcceptance} for more details. + # # A Card Dispute Acceptance object. This field will be present in the JSON # response if and only if `category` is equal to `card_dispute_acceptance`. # Contains the details of a successful Card Dispute. # - # @param accepted_at [Time] - # @param card_dispute_id [String] - # @param transaction_id [String] + # @param accepted_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param card_dispute_id [String] The identifier of the Card Dispute that was accepted. + # + # @param transaction_id [String] The identifier of the Transaction that was created to return the disputed funds + # ... end # @see Increase::Models::Transaction::Source#card_dispute_loss @@ -979,14 +1098,22 @@ class CardDisputeLoss < Increase::Internal::Type::BaseModel required :transaction_id, String # @!method initialize(card_dispute_id:, explanation:, lost_at:, transaction_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CardDisputeLoss} for more details. + # # A Card Dispute Loss object. This field will be present in the JSON response if # and only if `category` is equal to `card_dispute_loss`. Contains the details of # a lost Card Dispute. # - # @param card_dispute_id [String] - # @param explanation [String] - # @param lost_at [Time] - # @param transaction_id [String] + # @param card_dispute_id [String] The identifier of the Card Dispute that was lost. + # + # @param explanation [String] Why the Card Dispute was lost. + # + # @param lost_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param transaction_id [String] The identifier of the Transaction that was created to debit the disputed funds f + # ... end # @see Increase::Models::Transaction::Source#card_refund @@ -1116,31 +1243,59 @@ class CardRefund < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::Transaction::Source::CardRefund::Type } # @!method initialize(id:, amount:, card_payment_id:, cashback:, currency:, interchange:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_name:, merchant_postal_code:, merchant_state:, network_identifiers:, presentment_amount:, presentment_currency:, purchase_details:, transaction_id:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CardRefund} for more details. + # # A Card Refund object. This field will be present in the JSON response if and # only if `category` is equal to `card_refund`. Card Refunds move money back to # the cardholder. While they are usually connected to a Card Settlement an # acquirer can also refund money directly to a card without relation to a # transaction. # - # @param id [String] - # @param amount [Integer] - # @param card_payment_id [String] - # @param cashback [Increase::Models::Transaction::Source::CardRefund::Cashback, nil] - # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Currency] - # @param interchange [Increase::Models::Transaction::Source::CardRefund::Interchange, nil] - # @param merchant_acceptor_id [String] - # @param merchant_category_code [String] - # @param merchant_city [String] - # @param merchant_country [String] - # @param merchant_name [String] - # @param merchant_postal_code [String, nil] - # @param merchant_state [String, nil] - # @param network_identifiers [Increase::Models::Transaction::Source::CardRefund::NetworkIdentifiers] - # @param presentment_amount [Integer] - # @param presentment_currency [String] - # @param purchase_details [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails, nil] - # @param transaction_id [String] - # @param type [Symbol, Increase::Models::Transaction::Source::CardRefund::Type] + # @param id [String] The Card Refund identifier. + # + # @param amount [Integer] The amount in the minor unit of the transaction's settlement currency. For dolla + # ... + # + # @param card_payment_id [String] The ID of the Card Payment this transaction belongs to. + # + # @param cashback [Increase::Models::Transaction::Source::CardRefund::Cashback, nil] Cashback debited for this transaction, if eligible. Cashback is paid out in aggr + # ... + # + # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param interchange [Increase::Models::Transaction::Source::CardRefund::Interchange, nil] Interchange assessed as a part of this transaciton. + # + # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i + # ... + # + # @param merchant_category_code [String] The 4-digit MCC describing the merchant's business. + # + # @param merchant_city [String] The city the merchant resides in. + # + # @param merchant_country [String] The country the merchant resides in. + # + # @param merchant_name [String] The name of the merchant. + # + # @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is always a 5-digit ZIP code. + # + # @param merchant_state [String, nil] The state the merchant resides in. + # + # @param network_identifiers [Increase::Models::Transaction::Source::CardRefund::NetworkIdentifiers] Network-specific identifiers for this refund. + # + # @param presentment_amount [Integer] The amount in the minor unit of the transaction's presentment currency. + # + # @param presentment_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param purchase_details [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails, nil] Additional details about the card purchase, such as tax and industry-specific fi + # ... + # + # @param transaction_id [String] The identifier of the Transaction associated with this Transaction. + # + # @param type [Symbol, Increase::Models::Transaction::Source::CardRefund::Type] A constant representing the object's type. For this resource it will always be ` + # ... # @see Increase::Models::Transaction::Source::CardRefund#cashback class Cashback < Increase::Internal::Type::BaseModel @@ -1159,11 +1314,16 @@ class Cashback < Increase::Internal::Type::BaseModel required :currency, enum: -> { Increase::Models::Transaction::Source::CardRefund::Cashback::Currency } # @!method initialize(amount:, currency:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CardRefund::Cashback} for more details. + # # Cashback debited for this transaction, if eligible. Cashback is paid out in # aggregate, monthly. # - # @param amount [String] - # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Cashback::Currency] + # @param amount [String] The cashback amount given as a string containing a decimal number. The amount is + # ... + # + # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Cashback::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. # @@ -1248,11 +1408,19 @@ class Interchange < Increase::Internal::Type::BaseModel required :currency, enum: -> { Increase::Models::Transaction::Source::CardRefund::Interchange::Currency } # @!method initialize(amount:, code:, currency:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CardRefund::Interchange} for more + # details. + # # Interchange assessed as a part of this transaciton. # - # @param amount [String] - # @param code [String, nil] - # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Interchange::Currency] + # @param amount [String] The interchange amount given as a string containing a decimal number in major un + # ... + # + # @param code [String, nil] The card network specific interchange code. + # + # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Interchange::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange # reimbursement. @@ -1307,11 +1475,19 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel required :transaction_id, String, nil?: true # @!method initialize(acquirer_business_id:, acquirer_reference_number:, transaction_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CardRefund::NetworkIdentifiers} for more + # details. + # # Network-specific identifiers for this refund. # - # @param acquirer_business_id [String] - # @param acquirer_reference_number [String] - # @param transaction_id [String, nil] + # @param acquirer_business_id [String] A network assigned business ID that identifies the acquirer that processed this + # ... + # + # @param acquirer_reference_number [String] A globally unique identifier for this settlement. + # + # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro + # ... end # @see Increase::Models::Transaction::Source::CardRefund#purchase_details @@ -1387,19 +1563,34 @@ class PurchaseDetails < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(car_rental:, customer_reference_identifier:, local_tax_amount:, local_tax_currency:, lodging:, national_tax_amount:, national_tax_currency:, purchase_identifier:, purchase_identifier_format:, travel:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CardRefund::PurchaseDetails} for more + # details. + # # Additional details about the card purchase, such as tax and industry-specific # fields. # - # @param car_rental [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental, nil] - # @param customer_reference_identifier [String, nil] - # @param local_tax_amount [Integer, nil] - # @param local_tax_currency [String, nil] - # @param lodging [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging, nil] - # @param national_tax_amount [Integer, nil] - # @param national_tax_currency [String, nil] - # @param purchase_identifier [String, nil] - # @param purchase_identifier_format [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::PurchaseIdentifierFormat, nil] - # @param travel [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel, nil] + # @param car_rental [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental, nil] Fields specific to car rentals. + # + # @param customer_reference_identifier [String, nil] An identifier from the merchant for the customer or consumer. + # + # @param local_tax_amount [Integer, nil] The state or provincial tax amount in minor units. + # + # @param local_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax as + # ... + # + # @param lodging [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging, nil] Fields specific to lodging. + # + # @param national_tax_amount [Integer, nil] The national tax amount in minor units. + # + # @param national_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax as + # ... + # + # @param purchase_identifier [String, nil] An identifier from the merchant for the purchase to the issuer and cardholder. + # + # @param purchase_identifier_format [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::PurchaseIdentifierFormat, nil] The format of the purchase identifier. + # + # @param travel [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel, nil] Fields specific to travel. # @see Increase::Models::Transaction::Source::CardRefund::PurchaseDetails#car_rental class CarRental < Increase::Internal::Type::BaseModel @@ -1512,24 +1703,51 @@ class CarRental < Increase::Internal::Type::BaseModel required :weekly_rental_rate_currency, String, nil?: true # @!method initialize(car_class_code:, checkout_date:, daily_rental_rate_amount:, daily_rental_rate_currency:, days_rented:, extra_charges:, fuel_charges_amount:, fuel_charges_currency:, insurance_charges_amount:, insurance_charges_currency:, no_show_indicator:, one_way_drop_off_charges_amount:, one_way_drop_off_charges_currency:, renter_name:, weekly_rental_rate_amount:, weekly_rental_rate_currency:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental} + # for more details. + # # Fields specific to car rentals. # - # @param car_class_code [String, nil] - # @param checkout_date [Date, nil] - # @param daily_rental_rate_amount [Integer, nil] - # @param daily_rental_rate_currency [String, nil] - # @param days_rented [Integer, nil] - # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::ExtraCharges, nil] - # @param fuel_charges_amount [Integer, nil] - # @param fuel_charges_currency [String, nil] - # @param insurance_charges_amount [Integer, nil] - # @param insurance_charges_currency [String, nil] - # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::NoShowIndicator, nil] - # @param one_way_drop_off_charges_amount [Integer, nil] - # @param one_way_drop_off_charges_currency [String, nil] - # @param renter_name [String, nil] - # @param weekly_rental_rate_amount [Integer, nil] - # @param weekly_rental_rate_currency [String, nil] + # @param car_class_code [String, nil] Code indicating the vehicle's class. + # + # @param checkout_date [Date, nil] Date the customer picked up the car or, in the case of a no-show or pre-pay tran + # ... + # + # @param daily_rental_rate_amount [Integer, nil] Daily rate being charged for the vehicle. + # + # @param daily_rental_rate_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental + # ... + # + # @param days_rented [Integer, nil] Number of days the vehicle was rented. + # + # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::ExtraCharges, nil] Additional charges (gas, late fee, etc.) being billed. + # + # @param fuel_charges_amount [Integer, nil] Fuel charges for the vehicle. + # + # @param fuel_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges + # ... + # + # @param insurance_charges_amount [Integer, nil] Any insurance being charged for the vehicle. + # + # @param insurance_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance ch + # ... + # + # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::NoShowIndicator, nil] An indicator that the cardholder is being billed for a reserved vehicle that was + # ... + # + # @param one_way_drop_off_charges_amount [Integer, nil] Charges for returning the vehicle at a different location than where it was pick + # ... + # + # @param one_way_drop_off_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way drop + # ... + # + # @param renter_name [String, nil] Name of the person renting the vehicle. + # + # @param weekly_rental_rate_amount [Integer, nil] Weekly rate being charged for the vehicle. + # + # @param weekly_rental_rate_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly renta + # ... # Additional charges (gas, late fee, etc.) being billed. # @@ -1687,24 +1905,50 @@ class Lodging < Increase::Internal::Type::BaseModel required :total_tax_currency, String, nil?: true # @!method initialize(check_in_date:, daily_room_rate_amount:, daily_room_rate_currency:, extra_charges:, folio_cash_advances_amount:, folio_cash_advances_currency:, food_beverage_charges_amount:, food_beverage_charges_currency:, no_show_indicator:, prepaid_expenses_amount:, prepaid_expenses_currency:, room_nights:, total_room_tax_amount:, total_room_tax_currency:, total_tax_amount:, total_tax_currency:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging} + # for more details. + # # Fields specific to lodging. # - # @param check_in_date [Date, nil] - # @param daily_room_rate_amount [Integer, nil] - # @param daily_room_rate_currency [String, nil] - # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::ExtraCharges, nil] - # @param folio_cash_advances_amount [Integer, nil] - # @param folio_cash_advances_currency [String, nil] - # @param food_beverage_charges_amount [Integer, nil] - # @param food_beverage_charges_currency [String, nil] - # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::NoShowIndicator, nil] - # @param prepaid_expenses_amount [Integer, nil] - # @param prepaid_expenses_currency [String, nil] - # @param room_nights [Integer, nil] - # @param total_room_tax_amount [Integer, nil] - # @param total_room_tax_currency [String, nil] - # @param total_tax_amount [Integer, nil] - # @param total_tax_currency [String, nil] + # @param check_in_date [Date, nil] Date the customer checked in. + # + # @param daily_room_rate_amount [Integer, nil] Daily rate being charged for the room. + # + # @param daily_room_rate_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room r + # ... + # + # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::ExtraCharges, nil] Additional charges (phone, late check-out, etc.) being billed. + # + # @param folio_cash_advances_amount [Integer, nil] Folio cash advances for the room. + # + # @param folio_cash_advances_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash a + # ... + # + # @param food_beverage_charges_amount [Integer, nil] Food and beverage charges for the room. + # + # @param food_beverage_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and bev + # ... + # + # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::NoShowIndicator, nil] Indicator that the cardholder is being billed for a reserved room that was not a + # ... + # + # @param prepaid_expenses_amount [Integer, nil] Prepaid expenses being charged for the room. + # + # @param prepaid_expenses_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid expe + # ... + # + # @param room_nights [Integer, nil] Number of nights the room was rented. + # + # @param total_room_tax_amount [Integer, nil] Total room tax being charged. + # + # @param total_room_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room t + # ... + # + # @param total_tax_amount [Integer, nil] Total tax being charged for the room. + # + # @param total_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax as + # ... # Additional charges (phone, late check-out, etc.) being billed. # @@ -1867,18 +2111,29 @@ class Travel < Increase::Internal::Type::BaseModel # @!method initialize(ancillary:, computerized_reservation_system:, credit_reason_indicator:, departure_date:, origination_city_airport_code:, passenger_name:, restricted_ticket_indicator:, ticket_change_indicator:, ticket_number:, travel_agency_code:, travel_agency_name:, trip_legs:) # Fields specific to travel. # - # @param ancillary [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary, nil] - # @param computerized_reservation_system [String, nil] - # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::CreditReasonIndicator, nil] - # @param departure_date [Date, nil] - # @param origination_city_airport_code [String, nil] - # @param passenger_name [String, nil] - # @param restricted_ticket_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::RestrictedTicketIndicator, nil] - # @param ticket_change_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TicketChangeIndicator, nil] - # @param ticket_number [String, nil] - # @param travel_agency_code [String, nil] - # @param travel_agency_name [String, nil] - # @param trip_legs [Array, nil] + # @param ancillary [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary, nil] Ancillary purchases in addition to the airfare. + # + # @param computerized_reservation_system [String, nil] Indicates the computerized reservation system used to book the ticket. + # + # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::CreditReasonIndicator, nil] Indicates the reason for a credit to the cardholder. + # + # @param departure_date [Date, nil] Date of departure. + # + # @param origination_city_airport_code [String, nil] Code for the originating city or airport. + # + # @param passenger_name [String, nil] Name of the passenger. + # + # @param restricted_ticket_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::RestrictedTicketIndicator, nil] Indicates whether this ticket is non-refundable. + # + # @param ticket_change_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TicketChangeIndicator, nil] Indicates why a ticket was changed. + # + # @param ticket_number [String, nil] Ticket number. + # + # @param travel_agency_code [String, nil] Code for the travel agency if the ticket was issued by a travel agency. + # + # @param travel_agency_name [String, nil] Name of the travel agency if the ticket was issued by a travel agency. + # + # @param trip_legs [Array, nil] Fields specific to each leg of the journey. # @see Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel#ancillary class Ancillary < Increase::Internal::Type::BaseModel @@ -1918,13 +2173,22 @@ class Ancillary < Increase::Internal::Type::BaseModel required :ticket_document_number, String, nil?: true # @!method initialize(connected_ticket_document_number:, credit_reason_indicator:, passenger_name_or_description:, services:, ticket_document_number:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary} + # for more details. + # # Ancillary purchases in addition to the airfare. # - # @param connected_ticket_document_number [String, nil] - # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil] - # @param passenger_name_or_description [String, nil] - # @param services [Array] - # @param ticket_document_number [String, nil] + # @param connected_ticket_document_number [String, nil] If this purchase has a connection or relationship to another purchase, such as a + # ... + # + # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil] Indicates the reason for a credit to the cardholder. + # + # @param passenger_name_or_description [String, nil] Name of the passenger or description of the ancillary purchase. + # + # @param services [Array] Additional travel charges, such as baggage fees. + # + # @param ticket_document_number [String, nil] Ticket document number. # Indicates the reason for a credit to the cardholder. # @@ -1966,8 +2230,9 @@ class Service < Increase::Internal::Type::BaseModel required :sub_category, String, nil?: true # @!method initialize(category:, sub_category:) - # @param category [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::Service::Category, nil] - # @param sub_category [String, nil] + # @param category [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::Service::Category, nil] Category of the ancillary service. + # + # @param sub_category [String, nil] Sub-category of the ancillary service, free-form. # Category of the ancillary service. # @@ -2158,12 +2423,17 @@ class TripLeg < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(carrier_code:, destination_city_airport_code:, fare_basis_code:, flight_number:, service_class:, stop_over_code:) - # @param carrier_code [String, nil] - # @param destination_city_airport_code [String, nil] - # @param fare_basis_code [String, nil] - # @param flight_number [String, nil] - # @param service_class [String, nil] - # @param stop_over_code [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TripLeg::StopOverCode, nil] + # @param carrier_code [String, nil] Carrier code (e.g., United Airlines, Jet Blue, etc.). + # + # @param destination_city_airport_code [String, nil] Code for the destination city or airport. + # + # @param fare_basis_code [String, nil] Fare basis code. + # + # @param flight_number [String, nil] Flight number. + # + # @param service_class [String, nil] Service class (e.g., first class, business class, etc.). + # + # @param stop_over_code [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TripLeg::StopOverCode, nil] Indicates whether a stopover is allowed on this ticket. # Indicates whether a stopover is allowed on this ticket. # @@ -2236,15 +2506,24 @@ class CardRevenuePayment < Increase::Internal::Type::BaseModel required :transacted_on_account_id, String, nil?: true # @!method initialize(amount:, currency:, period_end:, period_start:, transacted_on_account_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CardRevenuePayment} for more details. + # # A Card Revenue Payment object. This field will be present in the JSON response # if and only if `category` is equal to `card_revenue_payment`. Card Revenue # Payments reflect earnings from fees on card transactions. # - # @param amount [Integer] - # @param currency [Symbol, Increase::Models::Transaction::Source::CardRevenuePayment::Currency] - # @param period_end [Time] - # @param period_start [Time] - # @param transacted_on_account_id [String, nil] + # @param amount [Integer] The amount in the minor unit of the transaction's currency. For dollars, for exa + # ... + # + # @param currency [Symbol, Increase::Models::Transaction::Source::CardRevenuePayment::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction + # ... + # + # @param period_end [Time] The end of the period for which this transaction paid interest. + # + # @param period_start [Time] The start of the period for which this transaction paid interest. + # + # @param transacted_on_account_id [String, nil] The account the card belonged to. # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction # currency. @@ -2418,33 +2697,64 @@ class CardSettlement < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::Transaction::Source::CardSettlement::Type } # @!method initialize(id:, amount:, card_authorization:, card_payment_id:, cashback:, currency:, interchange:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_name:, merchant_postal_code:, merchant_state:, network_identifiers:, pending_transaction_id:, presentment_amount:, presentment_currency:, purchase_details:, transaction_id:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CardSettlement} for more details. + # # A Card Settlement object. This field will be present in the JSON response if and # only if `category` is equal to `card_settlement`. Card Settlements are card # transactions that have cleared and settled. While a settlement is usually # preceded by an authorization, an acquirer can also directly clear a transaction # without first authorizing it. # - # @param id [String] - # @param amount [Integer] - # @param card_authorization [String, nil] - # @param card_payment_id [String] - # @param cashback [Increase::Models::Transaction::Source::CardSettlement::Cashback, nil] - # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Currency] - # @param interchange [Increase::Models::Transaction::Source::CardSettlement::Interchange, nil] - # @param merchant_acceptor_id [String] - # @param merchant_category_code [String] - # @param merchant_city [String] - # @param merchant_country [String] - # @param merchant_name [String] - # @param merchant_postal_code [String, nil] - # @param merchant_state [String, nil] - # @param network_identifiers [Increase::Models::Transaction::Source::CardSettlement::NetworkIdentifiers] - # @param pending_transaction_id [String, nil] - # @param presentment_amount [Integer] - # @param presentment_currency [String] - # @param purchase_details [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails, nil] - # @param transaction_id [String] - # @param type [Symbol, Increase::Models::Transaction::Source::CardSettlement::Type] + # @param id [String] The Card Settlement identifier. + # + # @param amount [Integer] The amount in the minor unit of the transaction's settlement currency. For dolla + # ... + # + # @param card_authorization [String, nil] The Card Authorization that was created prior to this Card Settlement, if one ex + # ... + # + # @param card_payment_id [String] The ID of the Card Payment this transaction belongs to. + # + # @param cashback [Increase::Models::Transaction::Source::CardSettlement::Cashback, nil] Cashback earned on this transaction, if eligible. Cashback is paid out in aggreg + # ... + # + # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param interchange [Increase::Models::Transaction::Source::CardSettlement::Interchange, nil] Interchange assessed as a part of this transaction. + # + # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i + # ... + # + # @param merchant_category_code [String] The 4-digit MCC describing the merchant's business. + # + # @param merchant_city [String] The city the merchant resides in. + # + # @param merchant_country [String] The country the merchant resides in. + # + # @param merchant_name [String] The name of the merchant. + # + # @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is always a 5-digit ZIP code. + # + # @param merchant_state [String, nil] The state the merchant resides in. + # + # @param network_identifiers [Increase::Models::Transaction::Source::CardSettlement::NetworkIdentifiers] Network-specific identifiers for this refund. + # + # @param pending_transaction_id [String, nil] The identifier of the Pending Transaction associated with this Transaction. + # + # @param presentment_amount [Integer] The amount in the minor unit of the transaction's presentment currency. + # + # @param presentment_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param purchase_details [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails, nil] Additional details about the card purchase, such as tax and industry-specific fi + # ... + # + # @param transaction_id [String] The identifier of the Transaction associated with this Transaction. + # + # @param type [Symbol, Increase::Models::Transaction::Source::CardSettlement::Type] A constant representing the object's type. For this resource it will always be ` + # ... # @see Increase::Models::Transaction::Source::CardSettlement#cashback class Cashback < Increase::Internal::Type::BaseModel @@ -2463,11 +2773,17 @@ class Cashback < Increase::Internal::Type::BaseModel required :currency, enum: -> { Increase::Models::Transaction::Source::CardSettlement::Cashback::Currency } # @!method initialize(amount:, currency:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CardSettlement::Cashback} for more + # details. + # # Cashback earned on this transaction, if eligible. Cashback is paid out in # aggregate, monthly. # - # @param amount [String] - # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Cashback::Currency] + # @param amount [String] The cashback amount given as a string containing a decimal number. The amount is + # ... + # + # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Cashback::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. # @@ -2553,11 +2869,19 @@ class Interchange < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::Transaction::Source::CardSettlement::Interchange::Currency } # @!method initialize(amount:, code:, currency:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CardSettlement::Interchange} for more + # details. + # # Interchange assessed as a part of this transaction. # - # @param amount [String] - # @param code [String, nil] - # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Interchange::Currency] + # @param amount [String] The interchange amount given as a string containing a decimal number in major un + # ... + # + # @param code [String, nil] The card network specific interchange code. + # + # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Interchange::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange # reimbursement. @@ -2612,11 +2936,19 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel required :transaction_id, String, nil?: true # @!method initialize(acquirer_business_id:, acquirer_reference_number:, transaction_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CardSettlement::NetworkIdentifiers} for + # more details. + # # Network-specific identifiers for this refund. # - # @param acquirer_business_id [String] - # @param acquirer_reference_number [String] - # @param transaction_id [String, nil] + # @param acquirer_business_id [String] A network assigned business ID that identifies the acquirer that processed this + # ... + # + # @param acquirer_reference_number [String] A globally unique identifier for this settlement. + # + # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro + # ... end # @see Increase::Models::Transaction::Source::CardSettlement#purchase_details @@ -2692,19 +3024,34 @@ class PurchaseDetails < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(car_rental:, customer_reference_identifier:, local_tax_amount:, local_tax_currency:, lodging:, national_tax_amount:, national_tax_currency:, purchase_identifier:, purchase_identifier_format:, travel:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails} for + # more details. + # # Additional details about the card purchase, such as tax and industry-specific # fields. # - # @param car_rental [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental, nil] - # @param customer_reference_identifier [String, nil] - # @param local_tax_amount [Integer, nil] - # @param local_tax_currency [String, nil] - # @param lodging [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging, nil] - # @param national_tax_amount [Integer, nil] - # @param national_tax_currency [String, nil] - # @param purchase_identifier [String, nil] - # @param purchase_identifier_format [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::PurchaseIdentifierFormat, nil] - # @param travel [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel, nil] + # @param car_rental [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental, nil] Fields specific to car rentals. + # + # @param customer_reference_identifier [String, nil] An identifier from the merchant for the customer or consumer. + # + # @param local_tax_amount [Integer, nil] The state or provincial tax amount in minor units. + # + # @param local_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax as + # ... + # + # @param lodging [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging, nil] Fields specific to lodging. + # + # @param national_tax_amount [Integer, nil] The national tax amount in minor units. + # + # @param national_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax as + # ... + # + # @param purchase_identifier [String, nil] An identifier from the merchant for the purchase to the issuer and cardholder. + # + # @param purchase_identifier_format [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::PurchaseIdentifierFormat, nil] The format of the purchase identifier. + # + # @param travel [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel, nil] Fields specific to travel. # @see Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails#car_rental class CarRental < Increase::Internal::Type::BaseModel @@ -2817,24 +3164,51 @@ class CarRental < Increase::Internal::Type::BaseModel required :weekly_rental_rate_currency, String, nil?: true # @!method initialize(car_class_code:, checkout_date:, daily_rental_rate_amount:, daily_rental_rate_currency:, days_rented:, extra_charges:, fuel_charges_amount:, fuel_charges_currency:, insurance_charges_amount:, insurance_charges_currency:, no_show_indicator:, one_way_drop_off_charges_amount:, one_way_drop_off_charges_currency:, renter_name:, weekly_rental_rate_amount:, weekly_rental_rate_currency:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental} + # for more details. + # # Fields specific to car rentals. # - # @param car_class_code [String, nil] - # @param checkout_date [Date, nil] - # @param daily_rental_rate_amount [Integer, nil] - # @param daily_rental_rate_currency [String, nil] - # @param days_rented [Integer, nil] - # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::ExtraCharges, nil] - # @param fuel_charges_amount [Integer, nil] - # @param fuel_charges_currency [String, nil] - # @param insurance_charges_amount [Integer, nil] - # @param insurance_charges_currency [String, nil] - # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::NoShowIndicator, nil] - # @param one_way_drop_off_charges_amount [Integer, nil] - # @param one_way_drop_off_charges_currency [String, nil] - # @param renter_name [String, nil] - # @param weekly_rental_rate_amount [Integer, nil] - # @param weekly_rental_rate_currency [String, nil] + # @param car_class_code [String, nil] Code indicating the vehicle's class. + # + # @param checkout_date [Date, nil] Date the customer picked up the car or, in the case of a no-show or pre-pay tran + # ... + # + # @param daily_rental_rate_amount [Integer, nil] Daily rate being charged for the vehicle. + # + # @param daily_rental_rate_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental + # ... + # + # @param days_rented [Integer, nil] Number of days the vehicle was rented. + # + # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::ExtraCharges, nil] Additional charges (gas, late fee, etc.) being billed. + # + # @param fuel_charges_amount [Integer, nil] Fuel charges for the vehicle. + # + # @param fuel_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges + # ... + # + # @param insurance_charges_amount [Integer, nil] Any insurance being charged for the vehicle. + # + # @param insurance_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance ch + # ... + # + # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::NoShowIndicator, nil] An indicator that the cardholder is being billed for a reserved vehicle that was + # ... + # + # @param one_way_drop_off_charges_amount [Integer, nil] Charges for returning the vehicle at a different location than where it was pick + # ... + # + # @param one_way_drop_off_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way drop + # ... + # + # @param renter_name [String, nil] Name of the person renting the vehicle. + # + # @param weekly_rental_rate_amount [Integer, nil] Weekly rate being charged for the vehicle. + # + # @param weekly_rental_rate_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly renta + # ... # Additional charges (gas, late fee, etc.) being billed. # @@ -2992,24 +3366,50 @@ class Lodging < Increase::Internal::Type::BaseModel required :total_tax_currency, String, nil?: true # @!method initialize(check_in_date:, daily_room_rate_amount:, daily_room_rate_currency:, extra_charges:, folio_cash_advances_amount:, folio_cash_advances_currency:, food_beverage_charges_amount:, food_beverage_charges_currency:, no_show_indicator:, prepaid_expenses_amount:, prepaid_expenses_currency:, room_nights:, total_room_tax_amount:, total_room_tax_currency:, total_tax_amount:, total_tax_currency:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging} + # for more details. + # # Fields specific to lodging. # - # @param check_in_date [Date, nil] - # @param daily_room_rate_amount [Integer, nil] - # @param daily_room_rate_currency [String, nil] - # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::ExtraCharges, nil] - # @param folio_cash_advances_amount [Integer, nil] - # @param folio_cash_advances_currency [String, nil] - # @param food_beverage_charges_amount [Integer, nil] - # @param food_beverage_charges_currency [String, nil] - # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::NoShowIndicator, nil] - # @param prepaid_expenses_amount [Integer, nil] - # @param prepaid_expenses_currency [String, nil] - # @param room_nights [Integer, nil] - # @param total_room_tax_amount [Integer, nil] - # @param total_room_tax_currency [String, nil] - # @param total_tax_amount [Integer, nil] - # @param total_tax_currency [String, nil] + # @param check_in_date [Date, nil] Date the customer checked in. + # + # @param daily_room_rate_amount [Integer, nil] Daily rate being charged for the room. + # + # @param daily_room_rate_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room r + # ... + # + # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::ExtraCharges, nil] Additional charges (phone, late check-out, etc.) being billed. + # + # @param folio_cash_advances_amount [Integer, nil] Folio cash advances for the room. + # + # @param folio_cash_advances_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash a + # ... + # + # @param food_beverage_charges_amount [Integer, nil] Food and beverage charges for the room. + # + # @param food_beverage_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and bev + # ... + # + # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::NoShowIndicator, nil] Indicator that the cardholder is being billed for a reserved room that was not a + # ... + # + # @param prepaid_expenses_amount [Integer, nil] Prepaid expenses being charged for the room. + # + # @param prepaid_expenses_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid expe + # ... + # + # @param room_nights [Integer, nil] Number of nights the room was rented. + # + # @param total_room_tax_amount [Integer, nil] Total room tax being charged. + # + # @param total_room_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room t + # ... + # + # @param total_tax_amount [Integer, nil] Total tax being charged for the room. + # + # @param total_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax as + # ... # Additional charges (phone, late check-out, etc.) being billed. # @@ -3172,18 +3572,29 @@ class Travel < Increase::Internal::Type::BaseModel # @!method initialize(ancillary:, computerized_reservation_system:, credit_reason_indicator:, departure_date:, origination_city_airport_code:, passenger_name:, restricted_ticket_indicator:, ticket_change_indicator:, ticket_number:, travel_agency_code:, travel_agency_name:, trip_legs:) # Fields specific to travel. # - # @param ancillary [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary, nil] - # @param computerized_reservation_system [String, nil] - # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::CreditReasonIndicator, nil] - # @param departure_date [Date, nil] - # @param origination_city_airport_code [String, nil] - # @param passenger_name [String, nil] - # @param restricted_ticket_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::RestrictedTicketIndicator, nil] - # @param ticket_change_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TicketChangeIndicator, nil] - # @param ticket_number [String, nil] - # @param travel_agency_code [String, nil] - # @param travel_agency_name [String, nil] - # @param trip_legs [Array, nil] + # @param ancillary [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary, nil] Ancillary purchases in addition to the airfare. + # + # @param computerized_reservation_system [String, nil] Indicates the computerized reservation system used to book the ticket. + # + # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::CreditReasonIndicator, nil] Indicates the reason for a credit to the cardholder. + # + # @param departure_date [Date, nil] Date of departure. + # + # @param origination_city_airport_code [String, nil] Code for the originating city or airport. + # + # @param passenger_name [String, nil] Name of the passenger. + # + # @param restricted_ticket_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::RestrictedTicketIndicator, nil] Indicates whether this ticket is non-refundable. + # + # @param ticket_change_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TicketChangeIndicator, nil] Indicates why a ticket was changed. + # + # @param ticket_number [String, nil] Ticket number. + # + # @param travel_agency_code [String, nil] Code for the travel agency if the ticket was issued by a travel agency. + # + # @param travel_agency_name [String, nil] Name of the travel agency if the ticket was issued by a travel agency. + # + # @param trip_legs [Array, nil] Fields specific to each leg of the journey. # @see Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel#ancillary class Ancillary < Increase::Internal::Type::BaseModel @@ -3223,13 +3634,22 @@ class Ancillary < Increase::Internal::Type::BaseModel required :ticket_document_number, String, nil?: true # @!method initialize(connected_ticket_document_number:, credit_reason_indicator:, passenger_name_or_description:, services:, ticket_document_number:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary} + # for more details. + # # Ancillary purchases in addition to the airfare. # - # @param connected_ticket_document_number [String, nil] - # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil] - # @param passenger_name_or_description [String, nil] - # @param services [Array] - # @param ticket_document_number [String, nil] + # @param connected_ticket_document_number [String, nil] If this purchase has a connection or relationship to another purchase, such as a + # ... + # + # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil] Indicates the reason for a credit to the cardholder. + # + # @param passenger_name_or_description [String, nil] Name of the passenger or description of the ancillary purchase. + # + # @param services [Array] Additional travel charges, such as baggage fees. + # + # @param ticket_document_number [String, nil] Ticket document number. # Indicates the reason for a credit to the cardholder. # @@ -3271,8 +3691,9 @@ class Service < Increase::Internal::Type::BaseModel required :sub_category, String, nil?: true # @!method initialize(category:, sub_category:) - # @param category [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::Service::Category, nil] - # @param sub_category [String, nil] + # @param category [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::Service::Category, nil] Category of the ancillary service. + # + # @param sub_category [String, nil] Sub-category of the ancillary service, free-form. # Category of the ancillary service. # @@ -3463,12 +3884,17 @@ class TripLeg < Increase::Internal::Type::BaseModel nil?: true # @!method initialize(carrier_code:, destination_city_airport_code:, fare_basis_code:, flight_number:, service_class:, stop_over_code:) - # @param carrier_code [String, nil] - # @param destination_city_airport_code [String, nil] - # @param fare_basis_code [String, nil] - # @param flight_number [String, nil] - # @param service_class [String, nil] - # @param stop_over_code [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TripLeg::StopOverCode, nil] + # @param carrier_code [String, nil] Carrier code (e.g., United Airlines, Jet Blue, etc.). + # + # @param destination_city_airport_code [String, nil] Code for the destination city or airport. + # + # @param fare_basis_code [String, nil] Fare basis code. + # + # @param flight_number [String, nil] Flight number. + # + # @param service_class [String, nil] Service class (e.g., first class, business class, etc.). + # + # @param stop_over_code [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TripLeg::StopOverCode, nil] Indicates whether a stopover is allowed on this ticket. # Indicates whether a stopover is allowed on this ticket. # @@ -3541,16 +3967,25 @@ class CashbackPayment < Increase::Internal::Type::BaseModel required :period_start, Time # @!method initialize(accrued_on_card_id:, amount:, currency:, period_end:, period_start:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CashbackPayment} for more details. + # # A Cashback Payment object. This field will be present in the JSON response if # and only if `category` is equal to `cashback_payment`. A Cashback Payment # represents the cashback paid to a cardholder for a given period. Cashback is # usually paid monthly for the prior month's transactions. # - # @param accrued_on_card_id [String, nil] - # @param amount [Integer] - # @param currency [Symbol, Increase::Models::Transaction::Source::CashbackPayment::Currency] - # @param period_end [Time] - # @param period_start [Time] + # @param accrued_on_card_id [String, nil] The card on which the cashback was accrued. + # + # @param amount [Integer] The amount in the minor unit of the transaction's currency. For dollars, for exa + # ... + # + # @param currency [Symbol, Increase::Models::Transaction::Source::CashbackPayment::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction + # ... + # + # @param period_end [Time] The end of the period for which this transaction paid cashback. + # + # @param period_start [Time] The start of the period for which this transaction paid cashback. # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction # currency. @@ -3729,19 +4164,33 @@ class CheckDepositAcceptance < Increase::Internal::Type::BaseModel required :serial_number, String, nil?: true # @!method initialize(account_number:, amount:, auxiliary_on_us:, check_deposit_id:, currency:, routing_number:, serial_number:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CheckDepositAcceptance} for more + # details. + # # A Check Deposit Acceptance object. This field will be present in the JSON # response if and only if `category` is equal to `check_deposit_acceptance`. A # Check Deposit Acceptance is created when a Check Deposit is processed and its # details confirmed. Check Deposits may be returned by the receiving bank, which # will appear as a Check Deposit Return. # - # @param account_number [String] - # @param amount [Integer] - # @param auxiliary_on_us [String, nil] - # @param check_deposit_id [String] - # @param currency [Symbol, Increase::Models::Transaction::Source::CheckDepositAcceptance::Currency] - # @param routing_number [String] - # @param serial_number [String, nil] + # @param account_number [String] The account number printed on the check. + # + # @param amount [Integer] The amount to be deposited in the minor unit of the transaction's currency. For + # ... + # + # @param auxiliary_on_us [String, nil] An additional line of metadata printed on the check. This typically includes the + # ... + # + # @param check_deposit_id [String] The ID of the Check Deposit that was accepted. + # + # @param currency [Symbol, Increase::Models::Transaction::Source::CheckDepositAcceptance::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param routing_number [String] The routing number printed on the check. + # + # @param serial_number [String, nil] The check serial number, if present, for consumer checks. For business checks, t + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the # transaction's currency. @@ -3817,6 +4266,9 @@ class CheckDepositReturn < Increase::Internal::Type::BaseModel required :transaction_id, String # @!method initialize(amount:, check_deposit_id:, currency:, return_reason:, returned_at:, transaction_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CheckDepositReturn} for more details. + # # A Check Deposit Return object. This field will be present in the JSON response # if and only if `category` is equal to `check_deposit_return`. A Check Deposit # Return is created when a Check Deposit is returned by the bank holding the @@ -3824,12 +4276,21 @@ class CheckDepositReturn < Increase::Internal::Type::BaseModel # reasons, including insufficient funds or a mismatched account number. Usually, # checks are returned within the first 7 days after the deposit is made. # - # @param amount [Integer] - # @param check_deposit_id [String] - # @param currency [Symbol, Increase::Models::Transaction::Source::CheckDepositReturn::Currency] - # @param return_reason [Symbol, Increase::Models::Transaction::Source::CheckDepositReturn::ReturnReason] - # @param returned_at [Time] - # @param transaction_id [String] + # @param amount [Integer] The returned amount in USD cents. + # + # @param check_deposit_id [String] The identifier of the Check Deposit that was returned. + # + # @param currency [Symbol, Increase::Models::Transaction::Source::CheckDepositReturn::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction' + # ... + # + # @param return_reason [Symbol, Increase::Models::Transaction::Source::CheckDepositReturn::ReturnReason] Why this check was returned by the bank holding the account it was drawn against + # ... + # + # @param returned_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param transaction_id [String] The identifier of the transaction that reversed the original check deposit trans + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the # transaction's currency. @@ -4007,19 +4468,34 @@ class CheckTransferDeposit < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::Transaction::Source::CheckTransferDeposit::Type } # @!method initialize(back_image_file_id:, bank_of_first_deposit_routing_number:, deposited_at:, front_image_file_id:, inbound_check_deposit_id:, transaction_id:, transfer_id:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::CheckTransferDeposit} for more details. + # # A Check Transfer Deposit object. This field will be present in the JSON response # if and only if `category` is equal to `check_transfer_deposit`. An Inbound Check # is a check drawn on an Increase account that has been deposited by an external # bank account. These types of checks are not pre-registered. # - # @param back_image_file_id [String, nil] - # @param bank_of_first_deposit_routing_number [String, nil] - # @param deposited_at [Time] - # @param front_image_file_id [String, nil] - # @param inbound_check_deposit_id [String, nil] - # @param transaction_id [String, nil] - # @param transfer_id [String, nil] - # @param type [Symbol, Increase::Models::Transaction::Source::CheckTransferDeposit::Type] + # @param back_image_file_id [String, nil] The identifier of the API File object containing an image of the back of the dep + # ... + # + # @param bank_of_first_deposit_routing_number [String, nil] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the ban + # ... + # + # @param deposited_at [Time] When the check was deposited. + # + # @param front_image_file_id [String, nil] The identifier of the API File object containing an image of the front of the de + # ... + # + # @param inbound_check_deposit_id [String, nil] The identifier of the Inbound Check Deposit object associated with this transact + # ... + # + # @param transaction_id [String, nil] The identifier of the Transaction object created when the check was deposited. + # + # @param transfer_id [String, nil] The identifier of the Check Transfer object that was deposited. + # + # @param type [Symbol, Increase::Models::Transaction::Source::CheckTransferDeposit::Type] A constant representing the object's type. For this resource it will always be ` + # ... # A constant representing the object's type. For this resource it will always be # `check_transfer_deposit`. @@ -4064,14 +4540,22 @@ class FeePayment < Increase::Internal::Type::BaseModel required :program_id, String, nil?: true # @!method initialize(amount:, currency:, fee_period_start:, program_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::FeePayment} for more details. + # # A Fee Payment object. This field will be present in the JSON response if and # only if `category` is equal to `fee_payment`. A Fee Payment represents a payment # made to Increase. # - # @param amount [Integer] - # @param currency [Symbol, Increase::Models::Transaction::Source::FeePayment::Currency] - # @param fee_period_start [Date] - # @param program_id [String, nil] + # @param amount [Integer] The amount in the minor unit of the transaction's currency. For dollars, for exa + # ... + # + # @param currency [Symbol, Increase::Models::Transaction::Source::FeePayment::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction + # ... + # + # @param fee_period_start [Date] The start of this payment's fee period, usually the first day of a month. + # + # @param program_id [String, nil] The Program for which this fee was incurred. # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction # currency. @@ -4178,22 +4662,38 @@ class InboundACHTransfer < Increase::Internal::Type::BaseModel required :transfer_id, String # @!method initialize(addenda:, amount:, originator_company_descriptive_date:, originator_company_discretionary_data:, originator_company_entry_description:, originator_company_id:, originator_company_name:, receiver_id_number:, receiver_name:, trace_number:, transfer_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::InboundACHTransfer} for more details. + # # An Inbound ACH Transfer Intention object. This field will be present in the JSON # response if and only if `category` is equal to `inbound_ach_transfer`. An # Inbound ACH Transfer Intention is created when an ACH transfer is initiated at # another bank and received by Increase. # - # @param addenda [Increase::Models::Transaction::Source::InboundACHTransfer::Addenda, nil] - # @param amount [Integer] - # @param originator_company_descriptive_date [String, nil] - # @param originator_company_discretionary_data [String, nil] - # @param originator_company_entry_description [String] - # @param originator_company_id [String] - # @param originator_company_name [String] - # @param receiver_id_number [String, nil] - # @param receiver_name [String, nil] - # @param trace_number [String] - # @param transfer_id [String] + # @param addenda [Increase::Models::Transaction::Source::InboundACHTransfer::Addenda, nil] Additional information sent from the originator. + # + # @param amount [Integer] The transfer amount in USD cents. + # + # @param originator_company_descriptive_date [String, nil] The description of the date of the transfer, usually in the format `YYMMDD`. + # + # @param originator_company_discretionary_data [String, nil] Data set by the originator. + # + # @param originator_company_entry_description [String] An informational description of the transfer. + # + # @param originator_company_id [String] An identifier for the originating company. This is generally, but not always, a + # ... + # + # @param originator_company_name [String] A name set by the originator to identify themselves. + # + # @param receiver_id_number [String, nil] The originator's identifier for the transfer recipient. + # + # @param receiver_name [String, nil] The name of the transfer recipient. This value is informational and not verified + # ... + # + # @param trace_number [String] A 15 digit number recorded in the Nacha file and available to both the originati + # ... + # + # @param transfer_id [String] The Inbound ACH Transfer's identifier. # @see Increase::Models::Transaction::Source::InboundACHTransfer#addenda class Addenda < Increase::Internal::Type::BaseModel @@ -4215,8 +4715,9 @@ class Addenda < Increase::Internal::Type::BaseModel # @!method initialize(category:, freeform:) # Additional information sent from the originator. # - # @param category [Symbol, Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Category] - # @param freeform [Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Freeform, nil] + # @param category [Symbol, Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Category] The type of addendum. + # + # @param freeform [Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Freeform, nil] Unstructured `payment_related_information` passed through by the originator. # The type of addendum. # @@ -4243,7 +4744,7 @@ class Freeform < Increase::Internal::Type::BaseModel # @!method initialize(entries:) # Unstructured `payment_related_information` passed through by the originator. # - # @param entries [Array] + # @param entries [Array] Each entry represents an addendum received from the originator. class Entry < Increase::Internal::Type::BaseModel # @!attribute payment_related_information @@ -4253,7 +4754,7 @@ class Entry < Increase::Internal::Type::BaseModel required :payment_related_information, String # @!method initialize(payment_related_information:) - # @param payment_related_information [String] + # @param payment_related_information [String] The payment related information passed in the addendum. end end end @@ -4274,7 +4775,7 @@ class InboundACHTransferReturnIntention < Increase::Internal::Type::BaseModel # Intention is created when an ACH transfer is initiated at another bank and # returned by Increase. # - # @param inbound_ach_transfer_id [String] + # @param inbound_ach_transfer_id [String] The ID of the Inbound ACH Transfer that is being returned. end # @see Increase::Models::Transaction::Source#inbound_check_adjustment @@ -4303,9 +4804,11 @@ class InboundCheckAdjustment < Increase::Internal::Type::BaseModel # Inbound Check Adjustment is created when Increase receives an adjustment for a # check or return deposited through Check21. # - # @param adjusted_transaction_id [String] - # @param amount [Integer] - # @param reason [Symbol, Increase::Models::Transaction::Source::InboundCheckAdjustment::Reason] + # @param adjusted_transaction_id [String] The ID of the transaction that was adjusted. + # + # @param amount [Integer] The amount of the check adjustment. + # + # @param reason [Symbol, Increase::Models::Transaction::Source::InboundCheckAdjustment::Reason] The reason for the adjustment. # The reason for the adjustment. # @@ -4351,8 +4854,9 @@ class InboundCheckDepositReturnIntention < Increase::Internal::Type::BaseModel # Intention is created when Increase receives an Inbound Check and the User # requests that it be returned. # - # @param inbound_check_deposit_id [String] - # @param transfer_id [String, nil] + # @param inbound_check_deposit_id [String] The ID of the Inbound Check Deposit that is being returned. + # + # @param transfer_id [String, nil] The identifier of the Check Transfer object that was deposited. end # @see Increase::Models::Transaction::Source#inbound_real_time_payments_transfer_confirmation @@ -4415,21 +4919,35 @@ class InboundRealTimePaymentsTransferConfirmation < Increase::Internal::Type::Ba required :transfer_id, String # @!method initialize(amount:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, remittance_information:, transaction_identification:, transfer_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation} + # for more details. + # # An Inbound Real-Time Payments Transfer Confirmation object. This field will be # present in the JSON response if and only if `category` is equal to # `inbound_real_time_payments_transfer_confirmation`. An Inbound Real-Time # Payments Transfer Confirmation is created when a Real-Time Payments transfer is # initiated at another bank and received by Increase. # - # @param amount [Integer] - # @param creditor_name [String] - # @param currency [Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation::Currency] - # @param debtor_account_number [String] - # @param debtor_name [String] - # @param debtor_routing_number [String] - # @param remittance_information [String, nil] - # @param transaction_identification [String] - # @param transfer_id [String] + # @param amount [Integer] The amount in the minor unit of the transfer's currency. For dollars, for exampl + # ... + # + # @param creditor_name [String] The name the sender of the transfer specified as the recipient of the transfer. + # + # @param currency [Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's cu + # ... + # + # @param debtor_account_number [String] The account number of the account that sent the transfer. + # + # @param debtor_name [String] The name provided by the sender of the transfer. + # + # @param debtor_routing_number [String] The routing number of the account that sent the transfer. + # + # @param remittance_information [String, nil] Additional information included with the transfer. + # + # @param transaction_identification [String] The Real-Time Payments network identification of the transfer. + # + # @param transfer_id [String] The identifier of the Real-Time Payments Transfer that led to this Transaction. # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's # currency. This will always be "USD" for a Real-Time Payments transfer. @@ -4529,20 +5047,35 @@ class InboundRealTimePaymentsTransferDecline < Increase::Internal::Type::BaseMod required :transfer_id, String # @!method initialize(amount:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, reason:, remittance_information:, transaction_identification:, transfer_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline} + # for more details. + # # An Inbound Real-Time Payments Transfer Decline object. This field will be # present in the JSON response if and only if `category` is equal to # `inbound_real_time_payments_transfer_decline`. # - # @param amount [Integer] - # @param creditor_name [String] - # @param currency [Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline::Currency] - # @param debtor_account_number [String] - # @param debtor_name [String] - # @param debtor_routing_number [String] - # @param reason [Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline::Reason] - # @param remittance_information [String, nil] - # @param transaction_identification [String] - # @param transfer_id [String] + # @param amount [Integer] The declined amount in the minor unit of the destination account currency. For d + # ... + # + # @param creditor_name [String] The name the sender of the transfer specified as the recipient of the transfer. + # + # @param currency [Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined tran + # ... + # + # @param debtor_account_number [String] The account number of the account that sent the transfer. + # + # @param debtor_name [String] The name provided by the sender of the transfer. + # + # @param debtor_routing_number [String] The routing number of the account that sent the transfer. + # + # @param reason [Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline::Reason] Why the transfer was declined. + # + # @param remittance_information [String, nil] Additional information included with the transfer. + # + # @param transaction_identification [String] The Real-Time Payments network identification of the declined transfer. + # + # @param transfer_id [String] The identifier of the Real-Time Payments Transfer that led to this Transaction. # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined # transfer's currency. This will always be "USD" for a Real-Time Payments @@ -4713,29 +5246,54 @@ class InboundWireReversal < Increase::Internal::Type::BaseModel required :wire_transfer_id, String # @!method initialize(amount:, created_at:, description:, financial_institution_to_financial_institution_information:, input_cycle_date:, input_message_accountability_data:, input_sequence_number:, input_source:, originator_routing_number:, previous_message_input_cycle_date:, previous_message_input_message_accountability_data:, previous_message_input_sequence_number:, previous_message_input_source:, receiver_financial_institution_information:, sender_reference:, transaction_id:, wire_transfer_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::InboundWireReversal} for more details. + # # An Inbound Wire Reversal object. This field will be present in the JSON response # if and only if `category` is equal to `inbound_wire_reversal`. An Inbound Wire # Reversal represents a reversal of a wire transfer that was initiated via # Increase. The other bank is sending the money back. This most often happens when # the original destination account details were incorrect. # - # @param amount [Integer] - # @param created_at [Time] - # @param description [String] - # @param financial_institution_to_financial_institution_information [String, nil] - # @param input_cycle_date [Date] - # @param input_message_accountability_data [String] - # @param input_sequence_number [String] - # @param input_source [String] - # @param originator_routing_number [String, nil] - # @param previous_message_input_cycle_date [Date] - # @param previous_message_input_message_accountability_data [String] - # @param previous_message_input_sequence_number [String] - # @param previous_message_input_source [String] - # @param receiver_financial_institution_information [String, nil] - # @param sender_reference [String, nil] - # @param transaction_id [String] - # @param wire_transfer_id [String] + # @param amount [Integer] The amount that was reversed in USD cents. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param description [String] The description on the reversal message from Fedwire, set by the reversing bank. + # ... + # + # @param financial_institution_to_financial_institution_information [String, nil] Additional financial institution information included in the wire reversal. + # + # @param input_cycle_date [Date] The Fedwire cycle date for the wire reversal. The "Fedwire day" begins at 9:00 P + # ... + # + # @param input_message_accountability_data [String] The Fedwire transaction identifier. + # + # @param input_sequence_number [String] The Fedwire sequence number. + # + # @param input_source [String] The Fedwire input source identifier. + # + # @param originator_routing_number [String, nil] The American Banking Association (ABA) routing number of the bank originating th + # ... + # + # @param previous_message_input_cycle_date [Date] The Fedwire cycle date for the wire transfer that is being reversed by this mess + # ... + # + # @param previous_message_input_message_accountability_data [String] The Fedwire transaction identifier for the wire transfer that was reversed. + # + # @param previous_message_input_sequence_number [String] The Fedwire sequence number for the wire transfer that was reversed. + # + # @param previous_message_input_source [String] The Fedwire input source identifier for the wire transfer that was reversed. + # + # @param receiver_financial_institution_information [String, nil] Information included in the wire reversal for the receiving financial institutio + # ... + # + # @param sender_reference [String, nil] The sending bank's reference number for the wire reversal. + # + # @param transaction_id [String] The ID for the Transaction associated with the transfer reversal. + # + # @param wire_transfer_id [String] The ID for the Wire Transfer that is being reversed. end # @see Increase::Models::Transaction::Source#inbound_wire_transfer @@ -4858,30 +5416,53 @@ class InboundWireTransfer < Increase::Internal::Type::BaseModel required :transfer_id, String # @!method initialize(amount:, beneficiary_address_line1:, beneficiary_address_line2:, beneficiary_address_line3:, beneficiary_name:, beneficiary_reference:, description:, input_message_accountability_data:, originator_address_line1:, originator_address_line2:, originator_address_line3:, originator_name:, originator_routing_number:, originator_to_beneficiary_information:, originator_to_beneficiary_information_line1:, originator_to_beneficiary_information_line2:, originator_to_beneficiary_information_line3:, originator_to_beneficiary_information_line4:, transfer_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::InboundWireTransfer} for more details. + # # An Inbound Wire Transfer Intention object. This field will be present in the # JSON response if and only if `category` is equal to `inbound_wire_transfer`. An # Inbound Wire Transfer Intention is created when a wire transfer is initiated at # another bank and received by Increase. # - # @param amount [Integer] - # @param beneficiary_address_line1 [String, nil] - # @param beneficiary_address_line2 [String, nil] - # @param beneficiary_address_line3 [String, nil] - # @param beneficiary_name [String, nil] - # @param beneficiary_reference [String, nil] - # @param description [String] - # @param input_message_accountability_data [String, nil] - # @param originator_address_line1 [String, nil] - # @param originator_address_line2 [String, nil] - # @param originator_address_line3 [String, nil] - # @param originator_name [String, nil] - # @param originator_routing_number [String, nil] - # @param originator_to_beneficiary_information [String, nil] - # @param originator_to_beneficiary_information_line1 [String, nil] - # @param originator_to_beneficiary_information_line2 [String, nil] - # @param originator_to_beneficiary_information_line3 [String, nil] - # @param originator_to_beneficiary_information_line4 [String, nil] - # @param transfer_id [String] + # @param amount [Integer] The amount in USD cents. + # + # @param beneficiary_address_line1 [String, nil] A free-form address field set by the sender. + # + # @param beneficiary_address_line2 [String, nil] A free-form address field set by the sender. + # + # @param beneficiary_address_line3 [String, nil] A free-form address field set by the sender. + # + # @param beneficiary_name [String, nil] A name set by the sender. + # + # @param beneficiary_reference [String, nil] A free-form reference string set by the sender, to help identify the transfer. + # + # @param description [String] An Increase-constructed description of the transfer. + # + # @param input_message_accountability_data [String, nil] A unique identifier available to the originating and receiving banks, commonly a + # ... + # + # @param originator_address_line1 [String, nil] The address of the wire originator, set by the sending bank. + # + # @param originator_address_line2 [String, nil] The address of the wire originator, set by the sending bank. + # + # @param originator_address_line3 [String, nil] The address of the wire originator, set by the sending bank. + # + # @param originator_name [String, nil] The originator of the wire, set by the sending bank. + # + # @param originator_routing_number [String, nil] The American Banking Association (ABA) routing number of the bank originating th + # ... + # + # @param originator_to_beneficiary_information [String, nil] An Increase-created concatenation of the Originator-to-Beneficiary lines. + # + # @param originator_to_beneficiary_information_line1 [String, nil] A free-form message set by the wire originator. + # + # @param originator_to_beneficiary_information_line2 [String, nil] A free-form message set by the wire originator. + # + # @param originator_to_beneficiary_information_line3 [String, nil] A free-form message set by the wire originator. + # + # @param originator_to_beneficiary_information_line4 [String, nil] A free-form message set by the wire originator. + # + # @param transfer_id [String] The ID of the Inbound Wire Transfer object that resulted in this Transaction. end # @see Increase::Models::Transaction::Source#inbound_wire_transfer_reversal @@ -4899,7 +5480,7 @@ class InboundWireTransferReversal < Increase::Internal::Type::BaseModel # created when Increase has received a wire and the User requests that it be # reversed. # - # @param inbound_wire_transfer_id [String] + # @param inbound_wire_transfer_id [String] The ID of the Inbound Wire Transfer that is being reversed. end # @see Increase::Models::Transaction::Source#interest_payment @@ -4937,16 +5518,25 @@ class InterestPayment < Increase::Internal::Type::BaseModel required :period_start, Time # @!method initialize(accrued_on_account_id:, amount:, currency:, period_end:, period_start:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::InterestPayment} for more details. + # # An Interest Payment object. This field will be present in the JSON response if # and only if `category` is equal to `interest_payment`. An Interest Payment # represents a payment of interest on an account. Interest is usually paid # monthly. # - # @param accrued_on_account_id [String] - # @param amount [Integer] - # @param currency [Symbol, Increase::Models::Transaction::Source::InterestPayment::Currency] - # @param period_end [Time] - # @param period_start [Time] + # @param accrued_on_account_id [String] The account on which the interest was accrued. + # + # @param amount [Integer] The amount in the minor unit of the transaction's currency. For dollars, for exa + # ... + # + # @param currency [Symbol, Increase::Models::Transaction::Source::InterestPayment::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction + # ... + # + # @param period_end [Time] The end of the period for which this transaction paid interest. + # + # @param period_start [Time] The start of the period for which this transaction paid interest. # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction # currency. @@ -5002,13 +5592,21 @@ class InternalSource < Increase::Internal::Type::BaseModel required :reason, enum: -> { Increase::Models::Transaction::Source::InternalSource::Reason } # @!method initialize(amount:, currency:, reason:) + # Some parameter documentations has been truncated, see + # {Increase::Models::Transaction::Source::InternalSource} for more details. + # # An Internal Source object. This field will be present in the JSON response if # and only if `category` is equal to `internal_source`. A transaction between the # user and Increase. See the `reason` attribute for more information. # - # @param amount [Integer] - # @param currency [Symbol, Increase::Models::Transaction::Source::InternalSource::Currency] - # @param reason [Symbol, Increase::Models::Transaction::Source::InternalSource::Reason] + # @param amount [Integer] The amount in the minor unit of the transaction's currency. For dollars, for exa + # ... + # + # @param currency [Symbol, Increase::Models::Transaction::Source::InternalSource::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction + # ... + # + # @param reason [Symbol, Increase::Models::Transaction::Source::InternalSource::Reason] An Internal Source is a transaction between you and Increase. This describes the + # ... # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction # currency. @@ -5135,11 +5733,15 @@ class RealTimePaymentsTransferAcknowledgement < Increase::Internal::Type::BaseMo # Acknowledgement is created when a Real-Time Payments Transfer sent from Increase # is acknowledged by the receiving bank. # - # @param amount [Integer] - # @param destination_account_number [String] - # @param destination_routing_number [String] - # @param remittance_information [String] - # @param transfer_id [String] + # @param amount [Integer] The transfer amount in USD cents. + # + # @param destination_account_number [String] The destination account number. + # + # @param destination_routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN). + # + # @param remittance_information [String] Unstructured information that will show on the recipient's bank statement. + # + # @param transfer_id [String] The identifier of the Real-Time Payments Transfer that led to this Transaction. end # @see Increase::Models::Transaction::Source#sample_funds @@ -5155,7 +5757,7 @@ class SampleFunds < Increase::Internal::Type::BaseModel # only if `category` is equal to `sample_funds`. Sample funds for testing # purposes. # - # @param originator [String] + # @param originator [String] Where the sample funds came from. end # @see Increase::Models::Transaction::Source#wire_transfer_intention @@ -5195,11 +5797,15 @@ class WireTransferIntention < Increase::Internal::Type::BaseModel # response if and only if `category` is equal to `wire_transfer_intention`. A Wire # Transfer initiated via Increase and sent to a different bank. # - # @param account_number [String] - # @param amount [Integer] - # @param message_to_recipient [String] - # @param routing_number [String] - # @param transfer_id [String] + # @param account_number [String] The destination account number. + # + # @param amount [Integer] The transfer amount in USD cents. + # + # @param message_to_recipient [String] The message that will show on the recipient's bank statement. + # + # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN). + # + # @param transfer_id [String] The identifier of the Wire Transfer that led to this Transaction. end end diff --git a/lib/increase/models/transaction_list_params.rb b/lib/increase/models/transaction_list_params.rb index c2ac029de..e99f2b427 100644 --- a/lib/increase/models/transaction_list_params.rb +++ b/lib/increase/models/transaction_list_params.rb @@ -44,12 +44,23 @@ class TransactionListParams < Increase::Internal::Type::BaseModel optional :route_id, String # @!method initialize(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, request_options: {}) - # @param account_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::TransactionListParams} for more details. + # + # @param account_id [String] Filter Transactions for those belonging to the specified Account. + # # @param category [Increase::Models::TransactionListParams::Category] + # # @param created_at [Increase::Models::TransactionListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] - # @param route_id [String] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # + # @param route_id [String] Filter Transactions for those belonging to the specified route. This could be a + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Category < Increase::Internal::Type::BaseModel @@ -63,7 +74,11 @@ class Category < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::TransactionListParams::Category} for more details. + # + # @param in_ [Array] Return results whose value is in the provided list. For GET requests, this shoul + # ... module In extend Increase::Internal::Type::Enum @@ -190,10 +205,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::TransactionListParams::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 diff --git a/lib/increase/models/wire_drawdown_request.rb b/lib/increase/models/wire_drawdown_request.rb index 042e4db07..d20e93f65 100644 --- a/lib/increase/models/wire_drawdown_request.rb +++ b/lib/increase/models/wire_drawdown_request.rb @@ -139,31 +139,61 @@ class WireDrawdownRequest < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::WireDrawdownRequest::Type } # @!method initialize(id:, account_number_id:, amount:, created_at:, currency:, fulfillment_inbound_wire_transfer_id:, idempotency_key:, message_to_recipient:, originator_address_line1:, originator_address_line2:, originator_address_line3:, originator_name:, recipient_account_number:, recipient_address_line1:, recipient_address_line2:, recipient_address_line3:, recipient_name:, recipient_routing_number:, status:, submission:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::WireDrawdownRequest} for more details. + # # Wire drawdown requests enable you to request that someone else send you a wire. # This feature is in beta; reach out to # [support@increase.com](mailto:support@increase.com) to learn more. # - # @param id [String] - # @param account_number_id [String] - # @param amount [Integer] - # @param created_at [Time] - # @param currency [String] - # @param fulfillment_inbound_wire_transfer_id [String, nil] - # @param idempotency_key [String, nil] - # @param message_to_recipient [String] - # @param originator_address_line1 [String, nil] - # @param originator_address_line2 [String, nil] - # @param originator_address_line3 [String, nil] - # @param originator_name [String, nil] - # @param recipient_account_number [String] - # @param recipient_address_line1 [String, nil] - # @param recipient_address_line2 [String, nil] - # @param recipient_address_line3 [String, nil] - # @param recipient_name [String, nil] - # @param recipient_routing_number [String] - # @param status [Symbol, Increase::Models::WireDrawdownRequest::Status] - # @param submission [Increase::Models::WireDrawdownRequest::Submission, nil] - # @param type [Symbol, Increase::Models::WireDrawdownRequest::Type] + # @param id [String] The Wire drawdown request identifier. + # + # @param account_number_id [String] The Account Number to which the recipient of this request is being requested to + # ... + # + # @param amount [Integer] The amount being requested in cents. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being + # ... + # + # @param fulfillment_inbound_wire_transfer_id [String, nil] If the recipient fulfills the drawdown request by sending funds, then this will + # ... + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param message_to_recipient [String] The message the recipient will see as part of the drawdown request. + # + # @param originator_address_line1 [String, nil] The originator's address line 1. + # + # @param originator_address_line2 [String, nil] The originator's address line 2. + # + # @param originator_address_line3 [String, nil] The originator's address line 3. + # + # @param originator_name [String, nil] The originator's name. + # + # @param recipient_account_number [String] The drawdown request's recipient's account number. + # + # @param recipient_address_line1 [String, nil] Line 1 of the drawdown request's recipient's address. + # + # @param recipient_address_line2 [String, nil] Line 2 of the drawdown request's recipient's address. + # + # @param recipient_address_line3 [String, nil] Line 3 of the drawdown request's recipient's address. + # + # @param recipient_name [String, nil] The drawdown request's recipient's name. + # + # @param recipient_routing_number [String] The drawdown request's recipient's routing number. + # + # @param status [Symbol, Increase::Models::WireDrawdownRequest::Status] The lifecycle status of the drawdown request. + # + # @param submission [Increase::Models::WireDrawdownRequest::Submission, nil] After the drawdown request is submitted to Fedwire, this will contain supplement + # ... + # + # @param type [Symbol, Increase::Models::WireDrawdownRequest::Type] A constant representing the object's type. For this resource it will always be ` + # ... # The lifecycle status of the drawdown request. # @@ -197,10 +227,14 @@ class Submission < Increase::Internal::Type::BaseModel required :input_message_accountability_data, String # @!method initialize(input_message_accountability_data:) + # Some parameter documentations has been truncated, see + # {Increase::Models::WireDrawdownRequest::Submission} for more details. + # # After the drawdown request is submitted to Fedwire, this will contain # supplemental details. # - # @param input_message_accountability_data [String] + # @param input_message_accountability_data [String] The input message accountability data (IMAD) uniquely identifying the submission + # ... end # A constant representing the object's type. For this resource it will always be diff --git a/lib/increase/models/wire_drawdown_request_create_params.rb b/lib/increase/models/wire_drawdown_request_create_params.rb index 1ec4dfb3d..8b04c4b6c 100644 --- a/lib/increase/models/wire_drawdown_request_create_params.rb +++ b/lib/increase/models/wire_drawdown_request_create_params.rb @@ -94,19 +94,39 @@ class WireDrawdownRequestCreateParams < Increase::Internal::Type::BaseModel optional :recipient_address_line3, String # @!method initialize(account_number_id:, amount:, message_to_recipient:, recipient_account_number:, recipient_name:, recipient_routing_number:, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, recipient_address_line1: nil, recipient_address_line2: nil, recipient_address_line3: nil, request_options: {}) - # @param account_number_id [String] - # @param amount [Integer] - # @param message_to_recipient [String] - # @param recipient_account_number [String] - # @param recipient_name [String] - # @param recipient_routing_number [String] - # @param originator_address_line1 [String] - # @param originator_address_line2 [String] - # @param originator_address_line3 [String] - # @param originator_name [String] - # @param recipient_address_line1 [String] - # @param recipient_address_line2 [String] - # @param recipient_address_line3 [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::WireDrawdownRequestCreateParams} for more details. + # + # @param account_number_id [String] The Account Number to which the recipient should send funds. + # + # @param amount [Integer] The amount requested from the recipient, in USD cents. + # + # @param message_to_recipient [String] A message the recipient will see as part of the request. + # + # @param recipient_account_number [String] The drawdown request's recipient's account number. + # + # @param recipient_name [String] The drawdown request's recipient's name. + # + # @param recipient_routing_number [String] The drawdown request's recipient's routing number. + # + # @param originator_address_line1 [String] The drawdown request originator's address line 1. This is only necessary if you' + # ... + # + # @param originator_address_line2 [String] The drawdown request originator's address line 2. This is only necessary if you' + # ... + # + # @param originator_address_line3 [String] The drawdown request originator's address line 3. This is only necessary if you' + # ... + # + # @param originator_name [String] The drawdown request originator's name. This is only necessary if you're request + # ... + # + # @param recipient_address_line1 [String] Line 1 of the drawdown request's recipient's address. + # + # @param recipient_address_line2 [String] Line 2 of the drawdown request's recipient's address. + # + # @param recipient_address_line3 [String] Line 3 of the drawdown request's recipient's address. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/wire_drawdown_request_list_params.rb b/lib/increase/models/wire_drawdown_request_list_params.rb index 037269146..313dda416 100644 --- a/lib/increase/models/wire_drawdown_request_list_params.rb +++ b/lib/increase/models/wire_drawdown_request_list_params.rb @@ -35,10 +35,19 @@ class WireDrawdownRequestListParams < Increase::Internal::Type::BaseModel optional :status, -> { Increase::Models::WireDrawdownRequestListParams::Status } # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # Some parameter documentations has been truncated, see + # {Increase::Models::WireDrawdownRequestListParams} for more details. + # + # @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::WireDrawdownRequestListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Status < Increase::Internal::Type::BaseModel @@ -53,7 +62,11 @@ class Status < Increase::Internal::Type::BaseModel api_name: :in # @!method initialize(in_: nil) - # @param in_ [Array] + # Some parameter documentations has been truncated, see + # {Increase::Models::WireDrawdownRequestListParams::Status} for more details. + # + # @param in_ [Array] Filter Wire Drawdown Requests for those with the specified status. For GET reque + # ... module In extend Increase::Internal::Type::Enum diff --git a/lib/increase/models/wire_transfer.rb b/lib/increase/models/wire_transfer.rb index b09da6850..f95bc2cb5 100644 --- a/lib/increase/models/wire_transfer.rb +++ b/lib/increase/models/wire_transfer.rb @@ -190,38 +190,77 @@ class WireTransfer < Increase::Internal::Type::BaseModel required :type, enum: -> { Increase::Models::WireTransfer::Type } # @!method initialize(id:, account_id:, account_number:, amount:, approval:, beneficiary_address_line1:, beneficiary_address_line2:, beneficiary_address_line3:, beneficiary_name:, cancellation:, created_at:, created_by:, currency:, external_account_id:, idempotency_key:, message_to_recipient:, network:, originator_address_line1:, originator_address_line2:, originator_address_line3:, originator_name:, pending_transaction_id:, reversal:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:) + # Some parameter documentations has been truncated, see + # {Increase::Models::WireTransfer} for more details. + # # Wire transfers move funds between your Increase account and any other account # accessible by Fedwire. # - # @param id [String] - # @param account_id [String] - # @param account_number [String] - # @param amount [Integer] - # @param approval [Increase::Models::WireTransfer::Approval, nil] - # @param beneficiary_address_line1 [String, nil] - # @param beneficiary_address_line2 [String, nil] - # @param beneficiary_address_line3 [String, nil] - # @param beneficiary_name [String, nil] - # @param cancellation [Increase::Models::WireTransfer::Cancellation, nil] - # @param created_at [Time] - # @param created_by [Increase::Models::WireTransfer::CreatedBy, nil] - # @param currency [Symbol, Increase::Models::WireTransfer::Currency] - # @param external_account_id [String, nil] - # @param idempotency_key [String, nil] - # @param message_to_recipient [String, nil] - # @param network [Symbol, Increase::Models::WireTransfer::Network] - # @param originator_address_line1 [String, nil] - # @param originator_address_line2 [String, nil] - # @param originator_address_line3 [String, nil] - # @param originator_name [String, nil] - # @param pending_transaction_id [String, nil] - # @param reversal [Increase::Models::WireTransfer::Reversal, nil] - # @param routing_number [String] - # @param source_account_number_id [String, nil] - # @param status [Symbol, Increase::Models::WireTransfer::Status] - # @param submission [Increase::Models::WireTransfer::Submission, nil] - # @param transaction_id [String, nil] - # @param type [Symbol, Increase::Models::WireTransfer::Type] + # @param id [String] The wire transfer's identifier. + # + # @param account_id [String] The Account to which the transfer belongs. + # + # @param account_number [String] The destination account number. + # + # @param amount [Integer] The transfer amount in USD cents. + # + # @param approval [Increase::Models::WireTransfer::Approval, nil] If your account requires approvals for transfers and the transfer was approved, + # ... + # + # @param beneficiary_address_line1 [String, nil] The beneficiary's address line 1. + # + # @param beneficiary_address_line2 [String, nil] The beneficiary's address line 2. + # + # @param beneficiary_address_line3 [String, nil] The beneficiary's address line 3. + # + # @param beneficiary_name [String, nil] The beneficiary's name. + # + # @param cancellation [Increase::Models::WireTransfer::Cancellation, nil] If your account requires approvals for transfers and the transfer was not approv + # ... + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param created_by [Increase::Models::WireTransfer::CreatedBy, nil] What object created the transfer, either via the API or the dashboard. + # + # @param currency [Symbol, Increase::Models::WireTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's c + # ... + # + # @param external_account_id [String, nil] The identifier of the External Account the transfer was made to, if any. + # + # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre + # ... + # + # @param message_to_recipient [String, nil] The message that will show on the recipient's bank statement. + # + # @param network [Symbol, Increase::Models::WireTransfer::Network] The transfer's network. + # + # @param originator_address_line1 [String, nil] The originator's address line 1. + # + # @param originator_address_line2 [String, nil] The originator's address line 2. + # + # @param originator_address_line3 [String, nil] The originator's address line 3. + # + # @param originator_name [String, nil] The originator's name. + # + # @param pending_transaction_id [String, nil] The ID for the pending transaction representing the transfer. A pending transact + # ... + # + # @param reversal [Increase::Models::WireTransfer::Reversal, nil] If your transfer is reversed, this will contain details of the reversal. + # + # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN). + # + # @param source_account_number_id [String, nil] The Account Number that was passed to the wire's recipient. + # + # @param status [Symbol, Increase::Models::WireTransfer::Status] The lifecycle status of the transfer. + # + # @param submission [Increase::Models::WireTransfer::Submission, nil] After the transfer is submitted to Fedwire, this will contain supplemental detai + # ... + # + # @param transaction_id [String, nil] The ID for the transaction funding the transfer. + # + # @param type [Symbol, Increase::Models::WireTransfer::Type] A constant representing the object's type. For this resource it will always be ` + # ... # @see Increase::Models::WireTransfer#approval class Approval < Increase::Internal::Type::BaseModel @@ -240,11 +279,17 @@ class Approval < Increase::Internal::Type::BaseModel required :approved_by, String, nil?: true # @!method initialize(approved_at:, approved_by:) + # Some parameter documentations has been truncated, see + # {Increase::Models::WireTransfer::Approval} for more details. + # # If your account requires approvals for transfers and the transfer was approved, # this will contain details of the approval. # - # @param approved_at [Time] - # @param approved_by [String, nil] + # @param approved_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param approved_by [String, nil] If the Transfer was approved by a user in the dashboard, the email address of th + # ... end # @see Increase::Models::WireTransfer#cancellation @@ -264,11 +309,17 @@ class Cancellation < Increase::Internal::Type::BaseModel required :canceled_by, String, nil?: true # @!method initialize(canceled_at:, canceled_by:) + # Some parameter documentations has been truncated, see + # {Increase::Models::WireTransfer::Cancellation} for more details. + # # If your account requires approvals for transfers and the transfer was not # approved, this will contain details of the cancellation. # - # @param canceled_at [Time] - # @param canceled_by [String, nil] + # @param canceled_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param canceled_by [String, nil] If the Transfer was canceled by a user in the dashboard, the email address of th + # ... end # @see Increase::Models::WireTransfer#created_by @@ -302,10 +353,13 @@ class CreatedBy < Increase::Internal::Type::BaseModel # @!method initialize(api_key:, category:, oauth_application:, user:) # What object created the transfer, either via the API or the dashboard. # - # @param api_key [Increase::Models::WireTransfer::CreatedBy::APIKey, nil] - # @param category [Symbol, Increase::Models::WireTransfer::CreatedBy::Category] - # @param oauth_application [Increase::Models::WireTransfer::CreatedBy::OAuthApplication, nil] - # @param user [Increase::Models::WireTransfer::CreatedBy::User, nil] + # @param api_key [Increase::Models::WireTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer. + # + # @param category [Symbol, Increase::Models::WireTransfer::CreatedBy::Category] The type of object that created this transfer. + # + # @param oauth_application [Increase::Models::WireTransfer::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer. + # + # @param user [Increase::Models::WireTransfer::CreatedBy::User, nil] If present, details about the User that created the transfer. # @see Increase::Models::WireTransfer::CreatedBy#api_key class APIKey < Increase::Internal::Type::BaseModel @@ -318,7 +372,7 @@ class APIKey < Increase::Internal::Type::BaseModel # @!method initialize(description:) # If present, details about the API key that created the transfer. # - # @param description [String, nil] + # @param description [String, nil] The description set for the API key when it was created. end # The type of object that created this transfer. @@ -351,7 +405,7 @@ class OAuthApplication < Increase::Internal::Type::BaseModel # @!method initialize(name:) # If present, details about the OAuth Application that created the transfer. # - # @param name [String] + # @param name [String] The name of the OAuth Application. end # @see Increase::Models::WireTransfer::CreatedBy#user @@ -365,7 +419,7 @@ class User < Increase::Internal::Type::BaseModel # @!method initialize(email:) # If present, details about the User that created the transfer. # - # @param email [String] + # @param email [String] The email address of the User. end end @@ -520,25 +574,50 @@ class Reversal < Increase::Internal::Type::BaseModel required :wire_transfer_id, String # @!method initialize(amount:, created_at:, description:, financial_institution_to_financial_institution_information:, input_cycle_date:, input_message_accountability_data:, input_sequence_number:, input_source:, originator_routing_number:, previous_message_input_cycle_date:, previous_message_input_message_accountability_data:, previous_message_input_sequence_number:, previous_message_input_source:, receiver_financial_institution_information:, sender_reference:, transaction_id:, wire_transfer_id:) + # Some parameter documentations has been truncated, see + # {Increase::Models::WireTransfer::Reversal} for more details. + # # If your transfer is reversed, this will contain details of the reversal. # - # @param amount [Integer] - # @param created_at [Time] - # @param description [String] - # @param financial_institution_to_financial_institution_information [String, nil] - # @param input_cycle_date [Date] - # @param input_message_accountability_data [String] - # @param input_sequence_number [String] - # @param input_source [String] - # @param originator_routing_number [String, nil] - # @param previous_message_input_cycle_date [Date] - # @param previous_message_input_message_accountability_data [String] - # @param previous_message_input_sequence_number [String] - # @param previous_message_input_source [String] - # @param receiver_financial_institution_information [String, nil] - # @param sender_reference [String, nil] - # @param transaction_id [String] - # @param wire_transfer_id [String] + # @param amount [Integer] The amount that was reversed in USD cents. + # + # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th + # ... + # + # @param description [String] The description on the reversal message from Fedwire, set by the reversing bank. + # ... + # + # @param financial_institution_to_financial_institution_information [String, nil] Additional financial institution information included in the wire reversal. + # + # @param input_cycle_date [Date] The Fedwire cycle date for the wire reversal. The "Fedwire day" begins at 9:00 P + # ... + # + # @param input_message_accountability_data [String] The Fedwire transaction identifier. + # + # @param input_sequence_number [String] The Fedwire sequence number. + # + # @param input_source [String] The Fedwire input source identifier. + # + # @param originator_routing_number [String, nil] The American Banking Association (ABA) routing number of the bank originating th + # ... + # + # @param previous_message_input_cycle_date [Date] The Fedwire cycle date for the wire transfer that is being reversed by this mess + # ... + # + # @param previous_message_input_message_accountability_data [String] The Fedwire transaction identifier for the wire transfer that was reversed. + # + # @param previous_message_input_sequence_number [String] The Fedwire sequence number for the wire transfer that was reversed. + # + # @param previous_message_input_source [String] The Fedwire input source identifier for the wire transfer that was reversed. + # + # @param receiver_financial_institution_information [String, nil] Information included in the wire reversal for the receiving financial institutio + # ... + # + # @param sender_reference [String, nil] The sending bank's reference number for the wire reversal. + # + # @param transaction_id [String] The ID for the Transaction associated with the transfer reversal. + # + # @param wire_transfer_id [String] The ID for the Wire Transfer that is being reversed. end # The lifecycle status of the transfer. @@ -596,8 +675,9 @@ class Submission < Increase::Internal::Type::BaseModel # After the transfer is submitted to Fedwire, this will contain supplemental # details. # - # @param input_message_accountability_data [String] - # @param submitted_at [Time] + # @param input_message_accountability_data [String] The accountability data for the submission. + # + # @param submitted_at [Time] When this wire transfer was submitted to Fedwire. end # A constant representing the object's type. For this resource it will always be diff --git a/lib/increase/models/wire_transfer_create_params.rb b/lib/increase/models/wire_transfer_create_params.rb index a9993109f..05319abfd 100644 --- a/lib/increase/models/wire_transfer_create_params.rb +++ b/lib/increase/models/wire_transfer_create_params.rb @@ -110,22 +110,47 @@ class WireTransferCreateParams < Increase::Internal::Type::BaseModel optional :source_account_number_id, String # @!method initialize(account_id:, amount:, beneficiary_name:, message_to_recipient:, account_number: nil, beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, external_account_id: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, require_approval: nil, routing_number: nil, source_account_number_id: nil, request_options: {}) - # @param account_id [String] - # @param amount [Integer] - # @param beneficiary_name [String] - # @param message_to_recipient [String] - # @param account_number [String] - # @param beneficiary_address_line1 [String] - # @param beneficiary_address_line2 [String] - # @param beneficiary_address_line3 [String] - # @param external_account_id [String] - # @param originator_address_line1 [String] - # @param originator_address_line2 [String] - # @param originator_address_line3 [String] - # @param originator_name [String] - # @param require_approval [Boolean] - # @param routing_number [String] - # @param source_account_number_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::WireTransferCreateParams} 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 beneficiary_name [String] The beneficiary's name. + # + # @param message_to_recipient [String] The message that will show on the recipient's bank statement. + # + # @param account_number [String] The account number for the destination account. + # + # @param beneficiary_address_line1 [String] The beneficiary's address line 1. + # + # @param beneficiary_address_line2 [String] The beneficiary's address line 2. + # + # @param beneficiary_address_line3 [String] The beneficiary's address line 3. + # + # @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr + # ... + # + # @param originator_address_line1 [String] The originator's address line 1. This is only necessary if you're transferring f + # ... + # + # @param originator_address_line2 [String] The originator's address line 2. This is only necessary if you're transferring f + # ... + # + # @param originator_address_line3 [String] The originator's address line 3. This is only necessary if you're transferring f + # ... + # + # @param originator_name [String] The originator's name. This is only necessary if you're transferring from a comm + # ... + # + # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API. + # + # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des + # ... + # + # @param source_account_number_id [String] The ID of an Account Number that will be passed to the wire's recipient + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/increase/models/wire_transfer_list_params.rb b/lib/increase/models/wire_transfer_list_params.rb index 49525cce0..8fe182ef0 100644 --- a/lib/increase/models/wire_transfer_list_params.rb +++ b/lib/increase/models/wire_transfer_list_params.rb @@ -47,12 +47,23 @@ class WireTransferListParams < Increase::Internal::Type::BaseModel optional :limit, Integer # @!method initialize(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, request_options: {}) - # @param account_id [String] + # Some parameter documentations has been truncated, see + # {Increase::Models::WireTransferListParams} for more details. + # + # @param account_id [String] Filter Wire Transfers to those belonging to the specified Account. + # # @param created_at [Increase::Models::WireTransferListParams::CreatedAt] - # @param cursor [String] - # @param external_account_id [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param external_account_id [String] Filter Wire Transfers to those made to the specified External Account. + # + # @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 @@ -85,10 +96,20 @@ class CreatedAt < Increase::Internal::Type::BaseModel optional :on_or_before, Time # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) - # @param after [Time] - # @param before [Time] - # @param on_or_after [Time] - # @param on_or_before [Time] + # Some parameter documentations has been truncated, see + # {Increase::Models::WireTransferListParams::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 diff --git a/lib/increase/resources/account_numbers.rb b/lib/increase/resources/account_numbers.rb index 088feb214..70fa3ba67 100644 --- a/lib/increase/resources/account_numbers.rb +++ b/lib/increase/resources/account_numbers.rb @@ -3,14 +3,22 @@ module Increase module Resources class AccountNumbers + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountNumberCreateParams} for more details. + # # Create an Account Number # # @overload create(account_id:, name:, inbound_ach: nil, inbound_checks: nil, request_options: {}) # - # @param account_id [String] - # @param name [String] - # @param inbound_ach [Increase::Models::AccountNumberCreateParams::InboundACH] - # @param inbound_checks [Increase::Models::AccountNumberCreateParams::InboundChecks] + # @param account_id [String] The Account the Account Number should belong to. + # + # @param name [String] The name you choose for the Account Number. + # + # @param inbound_ach [Increase::Models::AccountNumberCreateParams::InboundACH] Options related to how this Account Number should handle inbound ACH transfers. + # + # @param inbound_checks [Increase::Models::AccountNumberCreateParams::InboundChecks] Options related to how this Account Number should handle inbound check withdrawa + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::AccountNumber] @@ -31,7 +39,8 @@ def create(params) # # @overload retrieve(account_number_id, request_options: {}) # - # @param account_number_id [String] + # @param account_number_id [String] The identifier of the Account Number to retrieve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::AccountNumber] @@ -46,15 +55,24 @@ def retrieve(account_number_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountNumberUpdateParams} for more details. + # # Update an Account Number # # @overload update(account_number_id, inbound_ach: nil, inbound_checks: nil, name: nil, status: nil, request_options: {}) # - # @param account_number_id [String] - # @param inbound_ach [Increase::Models::AccountNumberUpdateParams::InboundACH] - # @param inbound_checks [Increase::Models::AccountNumberUpdateParams::InboundChecks] - # @param name [String] - # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::Status] + # @param account_number_id [String] The identifier of the Account Number. + # + # @param inbound_ach [Increase::Models::AccountNumberUpdateParams::InboundACH] Options related to how this Account Number handles inbound ACH transfers. + # + # @param inbound_checks [Increase::Models::AccountNumberUpdateParams::InboundChecks] Options related to how this Account Number should handle inbound check withdrawa + # ... + # + # @param name [String] The name you choose for the Account Number. + # + # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::Status] This indicates if transfers can be made to the Account Number. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::AccountNumber] @@ -71,17 +89,29 @@ def update(account_number_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountNumberListParams} for more details. + # # List Account Numbers # # @overload list(account_id: nil, ach_debit_status: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) # - # @param account_id [String] + # @param account_id [String] Filter Account Numbers to those belonging to the specified Account. + # # @param ach_debit_status [Increase::Models::AccountNumberListParams::ACHDebitStatus] + # # @param created_at [Increase::Models::AccountNumberListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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::AccountNumberListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/account_statements.rb b/lib/increase/resources/account_statements.rb index 4badaedc8..6f408aa82 100644 --- a/lib/increase/resources/account_statements.rb +++ b/lib/increase/resources/account_statements.rb @@ -7,7 +7,8 @@ class AccountStatements # # @overload retrieve(account_statement_id, request_options: {}) # - # @param account_statement_id [String] + # @param account_statement_id [String] The identifier of the Account Statement to retrieve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::AccountStatement] @@ -22,14 +23,22 @@ def retrieve(account_statement_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountStatementListParams} for more details. + # # List Account Statements # # @overload list(account_id: nil, cursor: nil, limit: nil, statement_period_start: nil, request_options: {}) # - # @param account_id [String] - # @param cursor [String] - # @param limit [Integer] + # @param account_id [String] Filter Account Statements to those belonging to the specified Account. + # + # @param cursor [String] Return the page of entries after this one. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # # @param statement_period_start [Increase::Models::AccountStatementListParams::StatementPeriodStart] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/account_transfers.rb b/lib/increase/resources/account_transfers.rb index e4e466e32..9926f848b 100644 --- a/lib/increase/resources/account_transfers.rb +++ b/lib/increase/resources/account_transfers.rb @@ -3,15 +3,24 @@ module Increase module Resources class AccountTransfers + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountTransferCreateParams} for more details. + # # Create an Account Transfer # # @overload create(account_id:, amount:, description:, destination_account_id:, require_approval: nil, request_options: {}) # - # @param account_id [String] - # @param amount [Integer] - # @param description [String] - # @param destination_account_id [String] - # @param require_approval [Boolean] + # @param account_id [String] The identifier for the account that will send the transfer. + # + # @param amount [Integer] The transfer amount in the minor unit of the account currency. For dollars, for + # ... + # + # @param description [String] The description you choose to give the transfer. + # + # @param destination_account_id [String] The identifier for the account that will receive the transfer. + # + # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::AccountTransfer] @@ -32,7 +41,8 @@ def create(params) # # @overload retrieve(account_transfer_id, request_options: {}) # - # @param account_transfer_id [String] + # @param account_transfer_id [String] The identifier of the Account Transfer. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::AccountTransfer] @@ -47,15 +57,25 @@ def retrieve(account_transfer_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountTransferListParams} for more details. + # # List Account Transfers # # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) # - # @param account_id [String] + # @param account_id [String] Filter Account Transfers to those that originated from the specified Account. + # # @param created_at [Increase::Models::AccountTransferListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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}, nil] # # @return [Increase::Internal::Page] @@ -77,7 +97,8 @@ def list(params = {}) # # @overload approve(account_transfer_id, request_options: {}) # - # @param account_transfer_id [String] + # @param account_transfer_id [String] The identifier of the Account Transfer to approve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::AccountTransfer] @@ -96,7 +117,8 @@ def approve(account_transfer_id, params = {}) # # @overload cancel(account_transfer_id, request_options: {}) # - # @param account_transfer_id [String] + # @param account_transfer_id [String] The identifier of the pending Account Transfer to cancel. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::AccountTransfer] diff --git a/lib/increase/resources/accounts.rb b/lib/increase/resources/accounts.rb index e4fcca736..3bf49f0ba 100644 --- a/lib/increase/resources/accounts.rb +++ b/lib/increase/resources/accounts.rb @@ -3,14 +3,23 @@ module Increase module Resources class Accounts + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountCreateParams} for more details. + # # Create an Account # # @overload create(name:, entity_id: nil, informational_entity_id: nil, program_id: nil, request_options: {}) # - # @param name [String] - # @param entity_id [String] - # @param informational_entity_id [String] - # @param program_id [String] + # @param name [String] The name you choose for the Account. + # + # @param entity_id [String] The identifier for the Entity that will own the Account. + # + # @param informational_entity_id [String] The identifier of an Entity that, while not owning the Account, is associated wi + # ... + # + # @param program_id [String] The identifier for the Program that this Account falls under. Required if you op + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Account] @@ -31,7 +40,8 @@ def create(params) # # @overload retrieve(account_id, request_options: {}) # - # @param account_id [String] + # @param account_id [String] The identifier of the Account to retrieve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Account] @@ -50,8 +60,10 @@ def retrieve(account_id, params = {}) # # @overload update(account_id, name: nil, request_options: {}) # - # @param account_id [String] - # @param name [String] + # @param account_id [String] The identifier of the Account to update. + # + # @param name [String] The new name of the Account. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Account] @@ -68,18 +80,31 @@ def update(account_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::AccountListParams} for more details. + # # List Accounts # # @overload list(created_at: nil, cursor: nil, entity_id: nil, idempotency_key: nil, informational_entity_id: nil, limit: nil, program_id: nil, status: nil, request_options: {}) # # @param created_at [Increase::Models::AccountListParams::CreatedAt] - # @param cursor [String] - # @param entity_id [String] - # @param idempotency_key [String] - # @param informational_entity_id [String] - # @param limit [Integer] - # @param program_id [String] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param entity_id [String] Filter Accounts 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 informational_entity_id [String] Filter Accounts for those belonging to the specified Entity as informational. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # + # @param program_id [String] Filter Accounts for those in a specific Program. + # # @param status [Increase::Models::AccountListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] @@ -102,8 +127,10 @@ def list(params = {}) # # @overload balance(account_id, at_time: nil, request_options: {}) # - # @param account_id [String] - # @param at_time [Time] + # @param account_id [String] The identifier of the Account to retrieve. + # + # @param at_time [Time] The moment to query the balance at. If not set, returns the current balances. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::BalanceLookup] @@ -124,7 +151,8 @@ def balance(account_id, params = {}) # # @overload close(account_id, request_options: {}) # - # @param account_id [String] + # @param account_id [String] The identifier of the Account to close. The account must have a zero balance. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Account] diff --git a/lib/increase/resources/ach_prenotifications.rb b/lib/increase/resources/ach_prenotifications.rb index 7e9c013d8..397ed2ed2 100644 --- a/lib/increase/resources/ach_prenotifications.rb +++ b/lib/increase/resources/ach_prenotifications.rb @@ -3,23 +3,42 @@ module Increase module Resources class ACHPrenotifications + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHPrenotificationCreateParams} for more details. + # # Create an ACH Prenotification # # @overload create(account_id:, account_number:, routing_number:, addendum: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, credit_debit_indicator: nil, effective_date: nil, individual_id: nil, individual_name: nil, standard_entry_class_code: nil, request_options: {}) # - # @param account_id [String] - # @param account_number [String] - # @param routing_number [String] - # @param addendum [String] - # @param company_descriptive_date [String] - # @param company_discretionary_data [String] - # @param company_entry_description [String] - # @param company_name [String] - # @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator] - # @param effective_date [Date] - # @param individual_id [String] - # @param individual_name [String] - # @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode] + # @param account_id [String] The Increase identifier for the account that will send the transfer. + # + # @param account_number [String] The account number for the destination account. + # + # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des + # ... + # + # @param addendum [String] Additional information that will be sent to the recipient. + # + # @param company_descriptive_date [String] The description of the date of the transfer. + # + # @param company_discretionary_data [String] The data you choose to associate with the transfer. + # + # @param company_entry_description [String] The description of the transfer you wish to be shown to the recipient. + # + # @param company_name [String] The name by which the recipient knows you. + # + # @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator] Whether the Prenotification is for a future debit or credit. + # + # @param effective_date [Date] The transfer effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601 + # ... + # + # @param individual_id [String] Your identifier for the transfer recipient. + # + # @param individual_name [String] The name of the transfer recipient. This value is information and not verified b + # ... + # + # @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode] The Standard Entry Class (SEC) code to use for the ACH Prenotification. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::ACHPrenotification] @@ -40,7 +59,8 @@ def create(params) # # @overload retrieve(ach_prenotification_id, request_options: {}) # - # @param ach_prenotification_id [String] + # @param ach_prenotification_id [String] The identifier of the ACH Prenotification to retrieve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::ACHPrenotification] @@ -55,14 +75,23 @@ def retrieve(ach_prenotification_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHPrenotificationListParams} for more details. + # # List ACH Prenotifications # # @overload list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) # # @param created_at [Increase::Models::ACHPrenotificationListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/ach_transfers.rb b/lib/increase/resources/ach_transfers.rb index 89005fdab..c8d1646a9 100644 --- a/lib/increase/resources/ach_transfers.rb +++ b/lib/increase/resources/ach_transfers.rb @@ -3,29 +3,63 @@ module Increase module Resources class ACHTransfers + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransferCreateParams} for more details. + # # Create an ACH Transfer # # @overload create(account_id:, amount:, statement_descriptor:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, individual_name: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, transaction_timing: nil, request_options: {}) # - # @param account_id [String] - # @param amount [Integer] - # @param statement_descriptor [String] - # @param account_number [String] - # @param addenda [Increase::Models::ACHTransferCreateParams::Addenda] - # @param company_descriptive_date [String] - # @param company_discretionary_data [String] - # @param company_entry_description [String] - # @param company_name [String] - # @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder] - # @param external_account_id [String] - # @param funding [Symbol, Increase::Models::ACHTransferCreateParams::Funding] - # @param individual_id [String] - # @param individual_name [String] - # @param preferred_effective_date [Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate] - # @param require_approval [Boolean] - # @param routing_number [String] - # @param standard_entry_class_code [Symbol, Increase::Models::ACHTransferCreateParams::StandardEntryClassCode] - # @param transaction_timing [Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming] + # @param account_id [String] The Increase identifier for the account that will send the transfer. + # + # @param amount [Integer] The transfer amount in USD cents. A positive amount originates a credit transfer + # ... + # + # @param statement_descriptor [String] A description you choose to give the transfer. This will be saved with the trans + # ... + # + # @param account_number [String] The account number for the destination account. + # + # @param addenda [Increase::Models::ACHTransferCreateParams::Addenda] Additional information that will be sent to the recipient. This is included in t + # ... + # + # @param company_descriptive_date [String] The description of the date of the transfer, usually in the format `YYMMDD`. Thi + # ... + # + # @param company_discretionary_data [String] The data you choose to associate with the transfer. This is included in the tran + # ... + # + # @param company_entry_description [String] A description of the transfer. This is included in the transfer data sent to the + # ... + # + # @param company_name [String] The name by which the recipient knows you. This is included in the transfer data + # ... + # + # @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder] The type of entity that owns the account to which the ACH Transfer is being sent + # ... + # + # @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr + # ... + # + # @param funding [Symbol, Increase::Models::ACHTransferCreateParams::Funding] The type of the account to which the transfer will be sent. + # + # @param individual_id [String] Your identifier for the transfer recipient. + # + # @param individual_name [String] The name of the transfer recipient. This value is informational and not verified + # ... + # + # @param preferred_effective_date [Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate] Configuration for how the effective date of the transfer will be set. This deter + # ... + # + # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API. + # + # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des + # ... + # + # @param standard_entry_class_code [Symbol, Increase::Models::ACHTransferCreateParams::StandardEntryClassCode] The Standard Entry Class (SEC) code to use for the transfer. + # + # @param transaction_timing [Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming] The timing of the transaction. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::ACHTransfer] @@ -46,7 +80,8 @@ def create(params) # # @overload retrieve(ach_transfer_id, request_options: {}) # - # @param ach_transfer_id [String] + # @param ach_transfer_id [String] The identifier of the ACH Transfer. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::ACHTransfer] @@ -61,17 +96,29 @@ def retrieve(ach_transfer_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::ACHTransferListParams} for more details. + # # List ACH Transfers # # @overload list(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) # - # @param account_id [String] + # @param account_id [String] Filter ACH Transfers to those that originated from the specified Account. + # # @param created_at [Increase::Models::ACHTransferListParams::CreatedAt] - # @param cursor [String] - # @param external_account_id [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param external_account_id [String] Filter ACH Transfers to those made to the specified External Account. + # + # @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::ACHTransferListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] @@ -93,7 +140,8 @@ def list(params = {}) # # @overload approve(ach_transfer_id, request_options: {}) # - # @param ach_transfer_id [String] + # @param ach_transfer_id [String] The identifier of the ACH Transfer to approve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::ACHTransfer] @@ -112,7 +160,8 @@ def approve(ach_transfer_id, params = {}) # # @overload cancel(ach_transfer_id, request_options: {}) # - # @param ach_transfer_id [String] + # @param ach_transfer_id [String] The identifier of the pending ACH Transfer to cancel. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::ACHTransfer] diff --git a/lib/increase/resources/bookkeeping_accounts.rb b/lib/increase/resources/bookkeeping_accounts.rb index 1b519d3f8..06d9438e6 100644 --- a/lib/increase/resources/bookkeeping_accounts.rb +++ b/lib/increase/resources/bookkeeping_accounts.rb @@ -7,10 +7,14 @@ class BookkeepingAccounts # # @overload create(name:, account_id: nil, compliance_category: nil, entity_id: nil, request_options: {}) # - # @param name [String] - # @param account_id [String] - # @param compliance_category [Symbol, Increase::Models::BookkeepingAccountCreateParams::ComplianceCategory] - # @param entity_id [String] + # @param name [String] The name you choose for the account. + # + # @param account_id [String] The entity, if `compliance_category` is `commingled_cash`. + # + # @param compliance_category [Symbol, Increase::Models::BookkeepingAccountCreateParams::ComplianceCategory] The account compliance category. + # + # @param entity_id [String] The entity, if `compliance_category` is `customer_balance`. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::BookkeepingAccount] @@ -31,8 +35,10 @@ def create(params) # # @overload update(bookkeeping_account_id, name:, request_options: {}) # - # @param bookkeeping_account_id [String] - # @param name [String] + # @param bookkeeping_account_id [String] The bookkeeping account you would like to update. + # + # @param name [String] The name you choose for the account. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::BookkeepingAccount] @@ -49,13 +55,21 @@ def update(bookkeeping_account_id, params) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::BookkeepingAccountListParams} for more details. + # # List Bookkeeping Accounts # # @overload list(cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) # - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # @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}, nil] # # @return [Increase::Internal::Page] @@ -77,8 +91,10 @@ def list(params = {}) # # @overload balance(bookkeeping_account_id, at_time: nil, request_options: {}) # - # @param bookkeeping_account_id [String] - # @param at_time [Time] + # @param bookkeeping_account_id [String] The identifier of the Bookkeeping Account to retrieve. + # + # @param at_time [Time] The moment to query the balance at. If not set, returns the current balances. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::BookkeepingBalanceLookup] diff --git a/lib/increase/resources/bookkeeping_entries.rb b/lib/increase/resources/bookkeeping_entries.rb index 52bb2b684..6775994a0 100644 --- a/lib/increase/resources/bookkeeping_entries.rb +++ b/lib/increase/resources/bookkeeping_entries.rb @@ -7,7 +7,8 @@ class BookkeepingEntries # # @overload retrieve(bookkeeping_entry_id, request_options: {}) # - # @param bookkeeping_entry_id [String] + # @param bookkeeping_entry_id [String] The identifier of the Bookkeeping Entry. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::BookkeepingEntry] @@ -22,13 +23,20 @@ def retrieve(bookkeeping_entry_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::BookkeepingEntryListParams} for more details. + # # List Bookkeeping Entries # # @overload list(account_id: nil, cursor: nil, limit: nil, request_options: {}) # - # @param account_id [String] - # @param cursor [String] - # @param limit [Integer] + # @param account_id [String] The identifier for the Bookkeeping Account to filter by. + # + # @param cursor [String] Return the page of entries after this one. + # + # @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] diff --git a/lib/increase/resources/bookkeeping_entry_sets.rb b/lib/increase/resources/bookkeeping_entry_sets.rb index 096b896f8..823e57ed7 100644 --- a/lib/increase/resources/bookkeeping_entry_sets.rb +++ b/lib/increase/resources/bookkeeping_entry_sets.rb @@ -3,13 +3,20 @@ module Increase module Resources class BookkeepingEntrySets + # Some parameter documentations has been truncated, see + # {Increase::Models::BookkeepingEntrySetCreateParams} for more details. + # # Create a Bookkeeping Entry Set # # @overload create(entries:, date: nil, transaction_id: nil, request_options: {}) # - # @param entries [Array] - # @param date [Time] - # @param transaction_id [String] + # @param entries [Array] The bookkeeping entries. + # + # @param date [Time] The date of the transaction. Optional if `transaction_id` is provided, in which + # ... + # + # @param transaction_id [String] The identifier of the Transaction related to this entry set, if any. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::BookkeepingEntrySet] @@ -30,7 +37,8 @@ def create(params) # # @overload retrieve(bookkeeping_entry_set_id, request_options: {}) # - # @param bookkeeping_entry_set_id [String] + # @param bookkeeping_entry_set_id [String] The identifier of the Bookkeeping Entry Set. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::BookkeepingEntrySet] @@ -45,14 +53,23 @@ def retrieve(bookkeeping_entry_set_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::BookkeepingEntrySetListParams} for more details. + # # List Bookkeeping Entry Sets # # @overload list(cursor: nil, idempotency_key: nil, limit: nil, transaction_id: nil, request_options: {}) # - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] - # @param transaction_id [String] + # @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 transaction_id [String] Filter to the Bookkeeping Entry Set that maps to this Transaction. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/card_disputes.rb b/lib/increase/resources/card_disputes.rb index e78b5145d..6892f0004 100644 --- a/lib/increase/resources/card_disputes.rb +++ b/lib/increase/resources/card_disputes.rb @@ -3,13 +3,21 @@ module Increase module Resources class CardDisputes + # Some parameter documentations has been truncated, see + # {Increase::Models::CardDisputeCreateParams} for more details. + # # Create a Card Dispute # # @overload create(disputed_transaction_id:, explanation:, amount: nil, request_options: {}) # - # @param disputed_transaction_id [String] - # @param explanation [String] - # @param amount [Integer] + # @param disputed_transaction_id [String] The Transaction you wish to dispute. This Transaction must have a `source_type` + # ... + # + # @param explanation [String] Why you are disputing this Transaction. + # + # @param amount [Integer] The monetary amount of the part of the transaction that is being disputed. This + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CardDispute] @@ -30,7 +38,8 @@ def create(params) # # @overload retrieve(card_dispute_id, request_options: {}) # - # @param card_dispute_id [String] + # @param card_dispute_id [String] The identifier of the Card Dispute. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CardDispute] @@ -45,15 +54,25 @@ def retrieve(card_dispute_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::CardDisputeListParams} for more details. + # # List Card Disputes # # @overload list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) # # @param created_at [Increase::Models::CardDisputeListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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::CardDisputeListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/card_payments.rb b/lib/increase/resources/card_payments.rb index d55e1da13..66d509ffa 100644 --- a/lib/increase/resources/card_payments.rb +++ b/lib/increase/resources/card_payments.rb @@ -7,7 +7,8 @@ class CardPayments # # @overload retrieve(card_payment_id, request_options: {}) # - # @param card_payment_id [String] + # @param card_payment_id [String] The identifier of the Card Payment. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CardPayment] @@ -22,15 +23,24 @@ def retrieve(card_payment_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPaymentListParams} for more details. + # # List Card Payments # # @overload list(account_id: nil, card_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) # - # @param account_id [String] - # @param card_id [String] + # @param account_id [String] Filter Card Payments to ones belonging to the specified Account. + # + # @param card_id [String] Filter Card Payments to ones belonging to the specified Card. + # # @param created_at [Increase::Models::CardPaymentListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @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] diff --git a/lib/increase/resources/card_purchase_supplements.rb b/lib/increase/resources/card_purchase_supplements.rb index c4e45e947..b0aec0a98 100644 --- a/lib/increase/resources/card_purchase_supplements.rb +++ b/lib/increase/resources/card_purchase_supplements.rb @@ -7,7 +7,8 @@ class CardPurchaseSupplements # # @overload retrieve(card_purchase_supplement_id, request_options: {}) # - # @param card_purchase_supplement_id [String] + # @param card_purchase_supplement_id [String] The identifier of the Card Purchase Supplement. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CardPurchaseSupplement] @@ -22,14 +23,23 @@ def retrieve(card_purchase_supplement_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::CardPurchaseSupplementListParams} for more details. + # # List Card Purchase Supplements # # @overload list(card_payment_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) # - # @param card_payment_id [String] + # @param card_payment_id [String] Filter Card Purchase Supplements to ones belonging to the specified Card Payment + # ... + # # @param created_at [Increase::Models::CardPurchaseSupplementListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @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] diff --git a/lib/increase/resources/cards.rb b/lib/increase/resources/cards.rb index 44159ef0c..8af1b97a5 100644 --- a/lib/increase/resources/cards.rb +++ b/lib/increase/resources/cards.rb @@ -3,15 +3,25 @@ module Increase module Resources class Cards + # Some parameter documentations has been truncated, see + # {Increase::Models::CardCreateParams} for more details. + # # Create a Card # # @overload create(account_id:, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, request_options: {}) # - # @param account_id [String] - # @param billing_address [Increase::Models::CardCreateParams::BillingAddress] - # @param description [String] - # @param digital_wallet [Increase::Models::CardCreateParams::DigitalWallet] - # @param entity_id [String] + # @param account_id [String] The Account the card should belong to. + # + # @param billing_address [Increase::Models::CardCreateParams::BillingAddress] The card's billing address. + # + # @param description [String] The description you choose to give the card. + # + # @param digital_wallet [Increase::Models::CardCreateParams::DigitalWallet] The contact information used in the two-factor steps for digital wallet card cre + # ... + # + # @param entity_id [String] The Entity the card belongs to. You only need to supply this in rare situations + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Card] @@ -32,7 +42,8 @@ def create(params) # # @overload retrieve(card_id, request_options: {}) # - # @param card_id [String] + # @param card_id [String] The identifier of the Card. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Card] @@ -47,16 +58,27 @@ def retrieve(card_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::CardUpdateParams} for more details. + # # Update a Card # # @overload update(card_id, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, status: nil, request_options: {}) # - # @param card_id [String] - # @param billing_address [Increase::Models::CardUpdateParams::BillingAddress] - # @param description [String] - # @param digital_wallet [Increase::Models::CardUpdateParams::DigitalWallet] - # @param entity_id [String] - # @param status [Symbol, Increase::Models::CardUpdateParams::Status] + # @param card_id [String] The card identifier. + # + # @param billing_address [Increase::Models::CardUpdateParams::BillingAddress] The card's updated billing address. + # + # @param description [String] The description you choose to give the card. + # + # @param digital_wallet [Increase::Models::CardUpdateParams::DigitalWallet] The contact information used in the two-factor steps for digital wallet card cre + # ... + # + # @param entity_id [String] The Entity the card belongs to. You only need to supply this in rare situations + # ... + # + # @param status [Symbol, Increase::Models::CardUpdateParams::Status] The status to update the Card with. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Card] @@ -73,16 +95,27 @@ def update(card_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::CardListParams} for more details. + # # List Cards # # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) # - # @param account_id [String] + # @param account_id [String] Filter Cards to ones belonging to the specified Account. + # # @param created_at [Increase::Models::CardListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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::CardListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] @@ -104,7 +137,8 @@ def list(params = {}) # # @overload details(card_id, request_options: {}) # - # @param card_id [String] + # @param card_id [String] The identifier of the Card to retrieve details for. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CardDetails] diff --git a/lib/increase/resources/check_deposits.rb b/lib/increase/resources/check_deposits.rb index 80baed7ee..862da31d1 100644 --- a/lib/increase/resources/check_deposits.rb +++ b/lib/increase/resources/check_deposits.rb @@ -3,15 +3,24 @@ module Increase module Resources class CheckDeposits + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckDepositCreateParams} for more details. + # # Create a Check Deposit # # @overload create(account_id:, amount:, back_image_file_id:, front_image_file_id:, description: nil, request_options: {}) # - # @param account_id [String] - # @param amount [Integer] - # @param back_image_file_id [String] - # @param front_image_file_id [String] - # @param description [String] + # @param account_id [String] The identifier for the Account to deposit the check in. + # + # @param amount [Integer] The deposit amount in USD cents. + # + # @param back_image_file_id [String] The File containing the check's back image. + # + # @param front_image_file_id [String] The File containing the check's front image. + # + # @param description [String] The description you choose to give the Check Deposit, for display purposes only. + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CheckDeposit] @@ -32,7 +41,8 @@ def create(params) # # @overload retrieve(check_deposit_id, request_options: {}) # - # @param check_deposit_id [String] + # @param check_deposit_id [String] The identifier of the Check Deposit to retrieve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CheckDeposit] @@ -47,15 +57,25 @@ def retrieve(check_deposit_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckDepositListParams} for more details. + # # List Check Deposits # # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) # - # @param account_id [String] + # @param account_id [String] Filter Check Deposits to those belonging to the specified Account. + # # @param created_at [Increase::Models::CheckDepositListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/check_transfers.rb b/lib/increase/resources/check_transfers.rb index 29f93b6dd..c59d45d29 100644 --- a/lib/increase/resources/check_transfers.rb +++ b/lib/increase/resources/check_transfers.rb @@ -3,17 +3,30 @@ module Increase module Resources class CheckTransfers + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckTransferCreateParams} for more details. + # # Create a Check Transfer # # @overload create(account_id:, amount:, fulfillment_method:, source_account_number_id:, physical_check: nil, require_approval: nil, third_party: nil, request_options: {}) # - # @param account_id [String] - # @param amount [Integer] - # @param fulfillment_method [Symbol, Increase::Models::CheckTransferCreateParams::FulfillmentMethod] - # @param source_account_number_id [String] - # @param physical_check [Increase::Models::CheckTransferCreateParams::PhysicalCheck] - # @param require_approval [Boolean] - # @param third_party [Increase::Models::CheckTransferCreateParams::ThirdParty] + # @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 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}, nil] # # @return [Increase::Models::CheckTransfer] @@ -34,7 +47,8 @@ def create(params) # # @overload retrieve(check_transfer_id, request_options: {}) # - # @param check_transfer_id [String] + # @param check_transfer_id [String] The identifier of the Check Transfer. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CheckTransfer] @@ -49,16 +63,27 @@ def retrieve(check_transfer_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::CheckTransferListParams} for more details. + # # List Check Transfers # # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) # - # @param account_id [String] + # @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] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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}, nil] # # @return [Increase::Internal::Page] @@ -80,7 +105,8 @@ def list(params = {}) # # @overload approve(check_transfer_id, request_options: {}) # - # @param check_transfer_id [String] + # @param check_transfer_id [String] The identifier of the Check Transfer to approve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CheckTransfer] @@ -99,7 +125,8 @@ def approve(check_transfer_id, params = {}) # # @overload cancel(check_transfer_id, request_options: {}) # - # @param check_transfer_id [String] + # @param check_transfer_id [String] The identifier of the pending Check Transfer to cancel. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CheckTransfer] @@ -118,8 +145,10 @@ def cancel(check_transfer_id, params = {}) # # @overload stop_payment(check_transfer_id, reason: nil, request_options: {}) # - # @param check_transfer_id [String] - # @param reason [Symbol, Increase::Models::CheckTransferStopPaymentParams::Reason] + # @param check_transfer_id [String] The identifier of the Check Transfer. + # + # @param reason [Symbol, Increase::Models::CheckTransferStopPaymentParams::Reason] The reason why this transfer should be stopped. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CheckTransfer] diff --git a/lib/increase/resources/declined_transactions.rb b/lib/increase/resources/declined_transactions.rb index d5d3a4b65..4baa2e46b 100644 --- a/lib/increase/resources/declined_transactions.rb +++ b/lib/increase/resources/declined_transactions.rb @@ -7,7 +7,8 @@ class DeclinedTransactions # # @overload retrieve(declined_transaction_id, request_options: {}) # - # @param declined_transaction_id [String] + # @param declined_transaction_id [String] The identifier of the Declined Transaction. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::DeclinedTransaction] @@ -22,16 +23,26 @@ def retrieve(declined_transaction_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::DeclinedTransactionListParams} for more details. + # # List Declined Transactions # # @overload list(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, request_options: {}) # - # @param account_id [String] + # @param account_id [String] Filter Declined Transactions to ones belonging to the specified Account. + # # @param category [Increase::Models::DeclinedTransactionListParams::Category] + # # @param created_at [Increase::Models::DeclinedTransactionListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] - # @param route_id [String] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # + # @param route_id [String] Filter Declined Transactions to those belonging to the specified route. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/digital_card_profiles.rb b/lib/increase/resources/digital_card_profiles.rb index abb925e9b..b4e7985a6 100644 --- a/lib/increase/resources/digital_card_profiles.rb +++ b/lib/increase/resources/digital_card_profiles.rb @@ -7,15 +7,24 @@ class DigitalCardProfiles # # @overload create(app_icon_file_id:, background_image_file_id:, card_description:, description:, issuer_name:, contact_email: nil, contact_phone: nil, contact_website: nil, text_color: nil, request_options: {}) # - # @param app_icon_file_id [String] - # @param background_image_file_id [String] - # @param card_description [String] - # @param description [String] - # @param issuer_name [String] - # @param contact_email [String] - # @param contact_phone [String] - # @param contact_website [String] - # @param text_color [Increase::Models::DigitalCardProfileCreateParams::TextColor] + # @param app_icon_file_id [String] The identifier of the File containing the card's icon image. + # + # @param background_image_file_id [String] The identifier of the File containing the card's front image. + # + # @param card_description [String] A user-facing description for the card itself. + # + # @param description [String] A description you can use to identify the Card Profile. + # + # @param issuer_name [String] A user-facing description for whoever is issuing the card. + # + # @param contact_email [String] An email address the user can contact to receive support for their card. + # + # @param contact_phone [String] A phone number the user can contact to receive support for their card. + # + # @param contact_website [String] A website the user can visit to view and receive support for their card. + # + # @param text_color [Increase::Models::DigitalCardProfileCreateParams::TextColor] The Card's text color, specified as an RGB triple. The default is white. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::DigitalCardProfile] @@ -36,7 +45,8 @@ def create(params) # # @overload retrieve(digital_card_profile_id, request_options: {}) # - # @param digital_card_profile_id [String] + # @param digital_card_profile_id [String] The identifier of the Digital Card Profile. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::DigitalCardProfile] @@ -51,14 +61,23 @@ def retrieve(digital_card_profile_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::DigitalCardProfileListParams} for more details. + # # List Card Profiles # # @overload list(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) # - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # @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::DigitalCardProfileListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] @@ -80,7 +99,8 @@ def list(params = {}) # # @overload archive(digital_card_profile_id, request_options: {}) # - # @param digital_card_profile_id [String] + # @param digital_card_profile_id [String] The identifier of the Digital Card Profile to archive. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::DigitalCardProfile] @@ -99,16 +119,26 @@ def archive(digital_card_profile_id, params = {}) # # @overload clone_(digital_card_profile_id, app_icon_file_id: nil, background_image_file_id: nil, card_description: nil, contact_email: nil, contact_phone: nil, contact_website: nil, description: nil, issuer_name: nil, text_color: nil, request_options: {}) # - # @param digital_card_profile_id [String] - # @param app_icon_file_id [String] - # @param background_image_file_id [String] - # @param card_description [String] - # @param contact_email [String] - # @param contact_phone [String] - # @param contact_website [String] - # @param description [String] - # @param issuer_name [String] - # @param text_color [Increase::Models::DigitalCardProfileCloneParams::TextColor] + # @param digital_card_profile_id [String] The identifier of the Digital Card Profile to clone. + # + # @param app_icon_file_id [String] The identifier of the File containing the card's icon image. + # + # @param background_image_file_id [String] The identifier of the File containing the card's front image. + # + # @param card_description [String] A user-facing description for the card itself. + # + # @param contact_email [String] An email address the user can contact to receive support for their card. + # + # @param contact_phone [String] A phone number the user can contact to receive support for their card. + # + # @param contact_website [String] A website the user can visit to view and receive support for their card. + # + # @param description [String] A description you can use to identify the Card Profile. + # + # @param issuer_name [String] A user-facing description for whoever is issuing the card. + # + # @param text_color [Increase::Models::DigitalCardProfileCloneParams::TextColor] The Card's text color, specified as an RGB triple. The default is white. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::DigitalCardProfile] diff --git a/lib/increase/resources/digital_wallet_tokens.rb b/lib/increase/resources/digital_wallet_tokens.rb index 393b944d4..ffb66fba5 100644 --- a/lib/increase/resources/digital_wallet_tokens.rb +++ b/lib/increase/resources/digital_wallet_tokens.rb @@ -7,7 +7,8 @@ class DigitalWalletTokens # # @overload retrieve(digital_wallet_token_id, request_options: {}) # - # @param digital_wallet_token_id [String] + # @param digital_wallet_token_id [String] The identifier of the Digital Wallet Token. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::DigitalWalletToken] @@ -22,14 +23,22 @@ def retrieve(digital_wallet_token_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::DigitalWalletTokenListParams} for more details. + # # List Digital Wallet Tokens # # @overload list(card_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) # - # @param card_id [String] + # @param card_id [String] Filter Digital Wallet Tokens to ones belonging to the specified Card. + # # @param created_at [Increase::Models::DigitalWalletTokenListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @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] diff --git a/lib/increase/resources/documents.rb b/lib/increase/resources/documents.rb index 182bda682..28127c98c 100644 --- a/lib/increase/resources/documents.rb +++ b/lib/increase/resources/documents.rb @@ -7,7 +7,8 @@ class Documents # # @overload retrieve(document_id, request_options: {}) # - # @param document_id [String] + # @param document_id [String] The identifier of the Document to retrieve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Document] @@ -22,15 +23,24 @@ def retrieve(document_id, params = {}) ) 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, limit: nil, request_options: {}) # # @param category [Increase::Models::DocumentListParams::Category] + # # @param created_at [Increase::Models::DocumentListParams::CreatedAt] - # @param cursor [String] - # @param entity_id [String] - # @param limit [Integer] + # + # @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 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] diff --git a/lib/increase/resources/entities.rb b/lib/increase/resources/entities.rb index 01cec4399..de0280f00 100644 --- a/lib/increase/resources/entities.rb +++ b/lib/increase/resources/entities.rb @@ -3,19 +3,37 @@ module Increase module Resources class Entities + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateParams} for more details. + # # Create an Entity # # @overload create(structure:, corporation: nil, description: nil, government_authority: nil, joint: nil, natural_person: nil, supplemental_documents: nil, third_party_verification: nil, trust: nil, request_options: {}) # - # @param structure [Symbol, Increase::Models::EntityCreateParams::Structure] - # @param corporation [Increase::Models::EntityCreateParams::Corporation] - # @param description [String] - # @param government_authority [Increase::Models::EntityCreateParams::GovernmentAuthority] - # @param joint [Increase::Models::EntityCreateParams::Joint] - # @param natural_person [Increase::Models::EntityCreateParams::NaturalPerson] - # @param supplemental_documents [Array] - # @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] - # @param trust [Increase::Models::EntityCreateParams::Trust] + # @param structure [Symbol, Increase::Models::EntityCreateParams::Structure] The type of Entity to create. + # + # @param corporation [Increase::Models::EntityCreateParams::Corporation] Details of the corporation entity to create. Required if `structure` is equal to + # ... + # + # @param description [String] The description you choose to give the entity. + # + # @param government_authority [Increase::Models::EntityCreateParams::GovernmentAuthority] Details of the Government Authority entity to create. Required if `structure` is + # ... + # + # @param joint [Increase::Models::EntityCreateParams::Joint] Details of the joint entity to create. Required if `structure` is equal to `join + # ... + # + # @param natural_person [Increase::Models::EntityCreateParams::NaturalPerson] Details of the natural person entity to create. Required if `structure` is equal + # ... + # + # @param supplemental_documents [Array] Additional documentation associated with the entity. + # + # @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] A reference to data stored in a third-party verification service. Your integrati + # ... + # + # @param trust [Increase::Models::EntityCreateParams::Trust] Details of the trust entity to create. Required if `structure` is equal to `trus + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Entity] @@ -36,7 +54,8 @@ def create(params) # # @overload retrieve(entity_id, request_options: {}) # - # @param entity_id [String] + # @param entity_id [String] The identifier of the Entity to retrieve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Entity] @@ -51,15 +70,25 @@ def retrieve(entity_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityListParams} for more details. + # # List Entities # # @overload list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) # # @param created_at [Increase::Models::EntityListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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::EntityListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] @@ -77,11 +106,16 @@ def list(params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityArchiveParams} for more details. + # # Archive an Entity # # @overload archive(entity_id, request_options: {}) # - # @param entity_id [String] + # @param entity_id [String] The identifier of the Entity to archive. Any accounts associated with an entity + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Entity] @@ -96,12 +130,19 @@ def archive(entity_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityArchiveBeneficialOwnerParams} for more details. + # # Archive a beneficial owner for a corporate Entity # # @overload archive_beneficial_owner(entity_id, beneficial_owner_id:, request_options: {}) # - # @param entity_id [String] - # @param beneficial_owner_id [String] + # @param entity_id [String] The identifier of the Entity associated with the Beneficial Owner that is being + # ... + # + # @param beneficial_owner_id [String] The identifying details of anyone controlling or owning 25% or more of the corpo + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Entity] @@ -118,14 +159,20 @@ def archive_beneficial_owner(entity_id, params) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityConfirmParams} for more details. + # # Depending on your program, you may be required to re-confirm an Entity's details # on a recurring basis. After making any required updates, call this endpoint to # record that your user confirmed their details. # # @overload confirm(entity_id, confirmed_at: nil, request_options: {}) # - # @param entity_id [String] - # @param confirmed_at [Time] + # @param entity_id [String] The identifier of the Entity to confirm the details of. + # + # @param confirmed_at [Time] When your user confirmed the Entity's details. If not provided, the current time + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Entity] @@ -142,12 +189,18 @@ def confirm(entity_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityCreateBeneficialOwnerParams} for more details. + # # Create a beneficial owner for a corporate Entity # # @overload create_beneficial_owner(entity_id, beneficial_owner:, request_options: {}) # - # @param entity_id [String] - # @param beneficial_owner [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner] + # @param entity_id [String] The identifier of the Entity to associate with the new Beneficial Owner. + # + # @param beneficial_owner [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner] The identifying details of anyone controlling or owning 25% or more of the corpo + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Entity] @@ -164,12 +217,18 @@ def create_beneficial_owner(entity_id, params) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityUpdateAddressParams} for more details. + # # Update a Natural Person or Corporation's address # # @overload update_address(entity_id, address:, request_options: {}) # - # @param entity_id [String] - # @param address [Increase::Models::EntityUpdateAddressParams::Address] + # @param entity_id [String] The identifier of the Entity whose address is being updated. + # + # @param address [Increase::Models::EntityUpdateAddressParams::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Entity] @@ -186,13 +245,22 @@ def update_address(entity_id, params) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityUpdateBeneficialOwnerAddressParams} for more details. + # # Update the address for a beneficial owner belonging to a corporate Entity # # @overload update_beneficial_owner_address(entity_id, address:, beneficial_owner_id:, request_options: {}) # - # @param entity_id [String] - # @param address [Increase::Models::EntityUpdateBeneficialOwnerAddressParams::Address] - # @param beneficial_owner_id [String] + # @param entity_id [String] The identifier of the Entity associated with the Beneficial Owner whose address + # ... + # + # @param address [Increase::Models::EntityUpdateBeneficialOwnerAddressParams::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM + # ... + # + # @param beneficial_owner_id [String] The identifying details of anyone controlling or owning 25% or more of the corpo + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Entity] @@ -209,12 +277,19 @@ def update_beneficial_owner_address(entity_id, params) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::EntityUpdateIndustryCodeParams} for more details. + # # Update the industry code for a corporate Entity # # @overload update_industry_code(entity_id, industry_code:, request_options: {}) # - # @param entity_id [String] - # @param industry_code [String] + # @param entity_id [String] The identifier of the Entity to update. This endpoint only accepts `corporation` + # ... + # + # @param industry_code [String] The North American Industry Classification System (NAICS) code for the corporati + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Entity] diff --git a/lib/increase/resources/event_subscriptions.rb b/lib/increase/resources/event_subscriptions.rb index 0af3e3182..fd6c47014 100644 --- a/lib/increase/resources/event_subscriptions.rb +++ b/lib/increase/resources/event_subscriptions.rb @@ -3,14 +3,24 @@ module Increase module Resources class EventSubscriptions + # Some parameter documentations has been truncated, see + # {Increase::Models::EventSubscriptionCreateParams} for more details. + # # Create an Event Subscription # # @overload create(url:, oauth_connection_id: nil, selected_event_category: nil, shared_secret: nil, request_options: {}) # - # @param url [String] - # @param oauth_connection_id [String] - # @param selected_event_category [Symbol, Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory] - # @param shared_secret [String] + # @param url [String] The URL you'd like us to send webhooks to. + # + # @param oauth_connection_id [String] If specified, this subscription will only receive webhooks for Events associated + # ... + # + # @param selected_event_category [Symbol, Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory] If specified, this subscription will only receive webhooks for Events with the s + # ... + # + # @param shared_secret [String] The key that will be used to sign webhooks. If no value is passed, a random stri + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::EventSubscription] @@ -31,7 +41,8 @@ def create(params) # # @overload retrieve(event_subscription_id, request_options: {}) # - # @param event_subscription_id [String] + # @param event_subscription_id [String] The identifier of the Event Subscription. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::EventSubscription] @@ -50,8 +61,10 @@ def retrieve(event_subscription_id, params = {}) # # @overload update(event_subscription_id, status: nil, request_options: {}) # - # @param event_subscription_id [String] - # @param status [Symbol, Increase::Models::EventSubscriptionUpdateParams::Status] + # @param event_subscription_id [String] The identifier of the Event Subscription. + # + # @param status [Symbol, Increase::Models::EventSubscriptionUpdateParams::Status] The status to update the Event Subscription with. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::EventSubscription] @@ -68,13 +81,21 @@ def update(event_subscription_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::EventSubscriptionListParams} for more details. + # # List Event Subscriptions # # @overload list(cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) # - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # @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}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/events.rb b/lib/increase/resources/events.rb index 7db780c7a..d5a988bc2 100644 --- a/lib/increase/resources/events.rb +++ b/lib/increase/resources/events.rb @@ -7,7 +7,8 @@ class Events # # @overload retrieve(event_id, request_options: {}) # - # @param event_id [String] + # @param event_id [String] The identifier of the Event. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Event] @@ -22,15 +23,24 @@ def retrieve(event_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::EventListParams} for more details. + # # List Events # # @overload list(associated_object_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) # - # @param associated_object_id [String] + # @param associated_object_id [String] Filter Events to those belonging to the object with the provided identifier. + # # @param category [Increase::Models::EventListParams::Category] + # # @param created_at [Increase::Models::EventListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @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] diff --git a/lib/increase/resources/exports.rb b/lib/increase/resources/exports.rb index 05dd1500c..f0192a875 100644 --- a/lib/increase/resources/exports.rb +++ b/lib/increase/resources/exports.rb @@ -3,17 +3,33 @@ module Increase module Resources class Exports + # Some parameter documentations has been truncated, see + # {Increase::Models::ExportCreateParams} for more details. + # # Create an Export # # @overload create(category:, account_statement_ofx: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, entity_csv: nil, transaction_csv: nil, vendor_csv: nil, request_options: {}) # - # @param category [Symbol, Increase::Models::ExportCreateParams::Category] - # @param account_statement_ofx [Increase::Models::ExportCreateParams::AccountStatementOfx] - # @param balance_csv [Increase::Models::ExportCreateParams::BalanceCsv] - # @param bookkeeping_account_balance_csv [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv] - # @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv] - # @param transaction_csv [Increase::Models::ExportCreateParams::TransactionCsv] - # @param vendor_csv [Object] + # @param category [Symbol, Increase::Models::ExportCreateParams::Category] The type of Export to create. + # + # @param account_statement_ofx [Increase::Models::ExportCreateParams::AccountStatementOfx] Options for the created export. Required if `category` is equal to `account_stat + # ... + # + # @param balance_csv [Increase::Models::ExportCreateParams::BalanceCsv] Options for the created export. Required if `category` is equal to `balance_csv` + # ... + # + # @param bookkeeping_account_balance_csv [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv] Options for the created export. Required if `category` is equal to + # `bookkeeping\_ ... + # + # @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv] Options for the created export. Required if `category` is equal to `entity_csv`. + # ... + # + # @param transaction_csv [Increase::Models::ExportCreateParams::TransactionCsv] Options for the created export. Required if `category` is equal to + # `transaction\_ ... + # + # @param vendor_csv [Object] Options for the created export. Required if `category` is equal to `vendor_csv`. + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Export] @@ -34,7 +50,8 @@ def create(params) # # @overload retrieve(export_id, request_options: {}) # - # @param export_id [String] + # @param export_id [String] The identifier of the Export to retrieve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Export] @@ -49,16 +66,27 @@ def retrieve(export_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::ExportListParams} for more details. + # # List Exports # # @overload list(category: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) # # @param category [Increase::Models::ExportListParams::Category] + # # @param created_at [Increase::Models::ExportListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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::ExportListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/external_accounts.rb b/lib/increase/resources/external_accounts.rb index bd43295b2..f5fecc492 100644 --- a/lib/increase/resources/external_accounts.rb +++ b/lib/increase/resources/external_accounts.rb @@ -3,15 +3,24 @@ module Increase module Resources class ExternalAccounts + # Some parameter documentations has been truncated, see + # {Increase::Models::ExternalAccountCreateParams} for more details. + # # Create an External Account # # @overload create(account_number:, description:, routing_number:, account_holder: nil, funding: nil, request_options: {}) # - # @param account_number [String] - # @param description [String] - # @param routing_number [String] - # @param account_holder [Symbol, Increase::Models::ExternalAccountCreateParams::AccountHolder] - # @param funding [Symbol, Increase::Models::ExternalAccountCreateParams::Funding] + # @param account_number [String] The account number for the destination account. + # + # @param description [String] The name you choose for the Account. + # + # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des + # ... + # + # @param account_holder [Symbol, Increase::Models::ExternalAccountCreateParams::AccountHolder] The type of entity that owns the External Account. + # + # @param funding [Symbol, Increase::Models::ExternalAccountCreateParams::Funding] The type of the destination account. Defaults to `checking`. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::ExternalAccount] @@ -32,7 +41,8 @@ def create(params) # # @overload retrieve(external_account_id, request_options: {}) # - # @param external_account_id [String] + # @param external_account_id [String] The identifier of the External Account. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::ExternalAccount] @@ -51,11 +61,16 @@ def retrieve(external_account_id, params = {}) # # @overload update(external_account_id, account_holder: nil, description: nil, funding: nil, status: nil, request_options: {}) # - # @param external_account_id [String] - # @param account_holder [Symbol, Increase::Models::ExternalAccountUpdateParams::AccountHolder] - # @param description [String] - # @param funding [Symbol, Increase::Models::ExternalAccountUpdateParams::Funding] - # @param status [Symbol, Increase::Models::ExternalAccountUpdateParams::Status] + # @param external_account_id [String] The external account identifier. + # + # @param account_holder [Symbol, Increase::Models::ExternalAccountUpdateParams::AccountHolder] The type of entity that owns the External Account. + # + # @param description [String] The description you choose to give the external account. + # + # @param funding [Symbol, Increase::Models::ExternalAccountUpdateParams::Funding] The funding type of the External Account. + # + # @param status [Symbol, Increase::Models::ExternalAccountUpdateParams::Status] The status of the External Account. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::ExternalAccount] @@ -72,15 +87,25 @@ def update(external_account_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::ExternalAccountListParams} for more details. + # # List External Accounts # # @overload list(cursor: nil, idempotency_key: nil, limit: nil, routing_number: nil, status: nil, request_options: {}) # - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] - # @param routing_number [String] + # @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 routing_number [String] Filter External Accounts to those with the specified Routing Number. + # # @param status [Increase::Models::ExternalAccountListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/file_links.rb b/lib/increase/resources/file_links.rb index d53c40658..a79284e25 100644 --- a/lib/increase/resources/file_links.rb +++ b/lib/increase/resources/file_links.rb @@ -3,12 +3,18 @@ module Increase module Resources class FileLinks + # Some parameter documentations has been truncated, see + # {Increase::Models::FileLinkCreateParams} for more details. + # # Create a File Link # # @overload create(file_id:, expires_at: nil, request_options: {}) # - # @param file_id [String] - # @param expires_at [Time] + # @param file_id [String] The File to create a File Link for. + # + # @param expires_at [Time] The time at which the File Link will expire. The default is 1 hour from the time + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::FileLink] diff --git a/lib/increase/resources/files.rb b/lib/increase/resources/files.rb index 9f856e056..ff439e8d7 100644 --- a/lib/increase/resources/files.rb +++ b/lib/increase/resources/files.rb @@ -3,15 +3,22 @@ module Increase module Resources class Files + # Some parameter documentations has been truncated, see + # {Increase::Models::FileCreateParams} for more details. + # # To upload a file to Increase, you'll need to send a request of Content-Type # `multipart/form-data`. The request should contain the file you would like to # upload, as well as the parameters for creating a file. # # @overload create(file:, purpose:, description: nil, request_options: {}) # - # @param file [Pathname, StringIO] - # @param purpose [Symbol, Increase::Models::FileCreateParams::Purpose] - # @param description [String] + # @param file [Pathname, StringIO] The file contents. This should follow the specifications of [RFC 7578](https://d + # ... + # + # @param purpose [Symbol, Increase::Models::FileCreateParams::Purpose] What the File will be used for in Increase's systems. + # + # @param description [String] The description you choose to give the File. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::File] @@ -33,7 +40,8 @@ def create(params) # # @overload retrieve(file_id, request_options: {}) # - # @param file_id [String] + # @param file_id [String] The identifier of the File. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::File] @@ -48,15 +56,25 @@ def retrieve(file_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::FileListParams} for more details. + # # List Files # # @overload list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, purpose: nil, request_options: {}) # # @param created_at [Increase::Models::FileListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha + # ... + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # # @param purpose [Increase::Models::FileListParams::Purpose] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/inbound_ach_transfers.rb b/lib/increase/resources/inbound_ach_transfers.rb index 75e0466f3..f4adb5ce7 100644 --- a/lib/increase/resources/inbound_ach_transfers.rb +++ b/lib/increase/resources/inbound_ach_transfers.rb @@ -7,7 +7,8 @@ class InboundACHTransfers # # @overload retrieve(inbound_ach_transfer_id, request_options: {}) # - # @param inbound_ach_transfer_id [String] + # @param inbound_ach_transfer_id [String] The identifier of the Inbound ACH Transfer to get details for. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::InboundACHTransfer] @@ -22,16 +23,26 @@ def retrieve(inbound_ach_transfer_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundACHTransferListParams} for more details. + # # List Inbound ACH Transfers # # @overload list(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, status: nil, request_options: {}) # - # @param account_id [String] - # @param account_number_id [String] + # @param account_id [String] Filter Inbound ACH Transfers to ones belonging to the specified Account. + # + # @param account_number_id [String] Filter Inbound ACH Transfers to ones belonging to the specified Account Number. + # # @param created_at [Increase::Models::InboundACHTransferListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # # @param status [Increase::Models::InboundACHTransferListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] @@ -49,13 +60,21 @@ def list(params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundACHTransferCreateNotificationOfChangeParams} for more + # details. + # # Create a notification of change for an Inbound ACH Transfer # # @overload create_notification_of_change(inbound_ach_transfer_id, updated_account_number: nil, updated_routing_number: nil, request_options: {}) # - # @param inbound_ach_transfer_id [String] - # @param updated_account_number [String] - # @param updated_routing_number [String] + # @param inbound_ach_transfer_id [String] The identifier of the Inbound ACH Transfer for which to create a notification of + # ... + # + # @param updated_account_number [String] The updated account number to send in the notification of change. + # + # @param updated_routing_number [String] The updated routing number to send in the notification of change. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::InboundACHTransfer] @@ -73,12 +92,18 @@ def create_notification_of_change(inbound_ach_transfer_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundACHTransferDeclineParams} for more details. + # # Decline an Inbound ACH Transfer # # @overload decline(inbound_ach_transfer_id, reason: nil, request_options: {}) # - # @param inbound_ach_transfer_id [String] - # @param reason [Symbol, Increase::Models::InboundACHTransferDeclineParams::Reason] + # @param inbound_ach_transfer_id [String] The identifier of the Inbound ACH Transfer to decline. + # + # @param reason [Symbol, Increase::Models::InboundACHTransferDeclineParams::Reason] The reason why this transfer will be returned. If this parameter is unset, the r + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::InboundACHTransfer] @@ -95,12 +120,19 @@ def decline(inbound_ach_transfer_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundACHTransferTransferReturnParams} for more details. + # # Return an Inbound ACH Transfer # # @overload transfer_return(inbound_ach_transfer_id, reason:, request_options: {}) # - # @param inbound_ach_transfer_id [String] - # @param reason [Symbol, Increase::Models::InboundACHTransferTransferReturnParams::Reason] + # @param inbound_ach_transfer_id [String] The identifier of the Inbound ACH Transfer to return to the originating financia + # ... + # + # @param reason [Symbol, Increase::Models::InboundACHTransferTransferReturnParams::Reason] The reason why this transfer will be returned. The most usual return codes are ` + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::InboundACHTransfer] diff --git a/lib/increase/resources/inbound_check_deposits.rb b/lib/increase/resources/inbound_check_deposits.rb index 016e5dde3..b56096a18 100644 --- a/lib/increase/resources/inbound_check_deposits.rb +++ b/lib/increase/resources/inbound_check_deposits.rb @@ -7,7 +7,8 @@ class InboundCheckDeposits # # @overload retrieve(inbound_check_deposit_id, request_options: {}) # - # @param inbound_check_deposit_id [String] + # @param inbound_check_deposit_id [String] The identifier of the Inbound Check Deposit to get details for. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::InboundCheckDeposit] @@ -22,15 +23,25 @@ def retrieve(inbound_check_deposit_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundCheckDepositListParams} for more details. + # # List Inbound Check Deposits # # @overload list(account_id: nil, check_transfer_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) # - # @param account_id [String] - # @param check_transfer_id [String] + # @param account_id [String] Filter Inbound Check Deposits to those belonging to the specified Account. + # + # @param check_transfer_id [String] Filter Inbound Check Deposits to those belonging to the specified Check Transfer + # ... + # # @param created_at [Increase::Models::InboundCheckDepositListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @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] @@ -52,7 +63,8 @@ def list(params = {}) # # @overload decline(inbound_check_deposit_id, request_options: {}) # - # @param inbound_check_deposit_id [String] + # @param inbound_check_deposit_id [String] The identifier of the Inbound Check Deposit to decline. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::InboundCheckDeposit] @@ -71,8 +83,10 @@ def decline(inbound_check_deposit_id, params = {}) # # @overload return_(inbound_check_deposit_id, reason:, request_options: {}) # - # @param inbound_check_deposit_id [String] - # @param reason [Symbol, Increase::Models::InboundCheckDepositReturnParams::Reason] + # @param inbound_check_deposit_id [String] The identifier of the Inbound Check Deposit to return. + # + # @param reason [Symbol, Increase::Models::InboundCheckDepositReturnParams::Reason] The reason to return the Inbound Check Deposit. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::InboundCheckDeposit] diff --git a/lib/increase/resources/inbound_mail_items.rb b/lib/increase/resources/inbound_mail_items.rb index 9206ec9ec..df8d16611 100644 --- a/lib/increase/resources/inbound_mail_items.rb +++ b/lib/increase/resources/inbound_mail_items.rb @@ -7,7 +7,8 @@ class InboundMailItems # # @overload retrieve(inbound_mail_item_id, request_options: {}) # - # @param inbound_mail_item_id [String] + # @param inbound_mail_item_id [String] The identifier of the Inbound Mail Item to retrieve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::InboundMailItem] @@ -22,14 +23,22 @@ def retrieve(inbound_mail_item_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundMailItemListParams} for more details. + # # List Inbound Mail Items # # @overload list(created_at: nil, cursor: nil, limit: nil, lockbox_id: nil, request_options: {}) # # @param created_at [Increase::Models::InboundMailItemListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] - # @param lockbox_id [String] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # + # @param lockbox_id [String] Filter Inbound Mail Items to ones sent to the provided Lockbox. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/inbound_real_time_payments_transfers.rb b/lib/increase/resources/inbound_real_time_payments_transfers.rb index ffc9b0868..6eb208562 100755 --- a/lib/increase/resources/inbound_real_time_payments_transfers.rb +++ b/lib/increase/resources/inbound_real_time_payments_transfers.rb @@ -7,7 +7,8 @@ class InboundRealTimePaymentsTransfers # # @overload retrieve(inbound_real_time_payments_transfer_id, request_options: {}) # - # @param inbound_real_time_payments_transfer_id [String] + # @param inbound_real_time_payments_transfer_id [String] The identifier of the Inbound Real-Time Payments Transfer to get details for. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::InboundRealTimePaymentsTransfer] @@ -22,15 +23,26 @@ def retrieve(inbound_real_time_payments_transfer_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundRealTimePaymentsTransferListParams} for more details. + # # List Inbound Real-Time Payments Transfers # # @overload list(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) # - # @param account_id [String] - # @param account_number_id [String] + # @param account_id [String] Filter Inbound Real-Time Payments Transfers to those belonging to the specified + # ... + # + # @param account_number_id [String] Filter Inbound Real-Time Payments Transfers to ones belonging to the specified A + # ... + # # @param created_at [Increase::Models::InboundRealTimePaymentsTransferListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @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] diff --git a/lib/increase/resources/inbound_wire_drawdown_requests.rb b/lib/increase/resources/inbound_wire_drawdown_requests.rb index e73301aa9..43a35e764 100644 --- a/lib/increase/resources/inbound_wire_drawdown_requests.rb +++ b/lib/increase/resources/inbound_wire_drawdown_requests.rb @@ -7,7 +7,8 @@ class InboundWireDrawdownRequests # # @overload retrieve(inbound_wire_drawdown_request_id, request_options: {}) # - # @param inbound_wire_drawdown_request_id [String] + # @param inbound_wire_drawdown_request_id [String] The identifier of the Inbound Wire Drawdown Request to retrieve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::InboundWireDrawdownRequest] @@ -22,12 +23,18 @@ def retrieve(inbound_wire_drawdown_request_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundWireDrawdownRequestListParams} for more details. + # # List Inbound Wire Drawdown Requests # # @overload list(cursor: nil, limit: nil, request_options: {}) # - # @param cursor [String] - # @param limit [Integer] + # @param cursor [String] Return the page of entries after this one. + # + # @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] diff --git a/lib/increase/resources/inbound_wire_transfers.rb b/lib/increase/resources/inbound_wire_transfers.rb index 917db3398..266461b2e 100644 --- a/lib/increase/resources/inbound_wire_transfers.rb +++ b/lib/increase/resources/inbound_wire_transfers.rb @@ -7,7 +7,8 @@ class InboundWireTransfers # # @overload retrieve(inbound_wire_transfer_id, request_options: {}) # - # @param inbound_wire_transfer_id [String] + # @param inbound_wire_transfer_id [String] The identifier of the Inbound Wire Transfer to get details for. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::InboundWireTransfer] @@ -22,16 +23,27 @@ def retrieve(inbound_wire_transfer_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::InboundWireTransferListParams} for more details. + # # List Inbound Wire Transfers # # @overload list(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, status: nil, request_options: {}) # - # @param account_id [String] - # @param account_number_id [String] + # @param account_id [String] Filter Inbound Wire Transfers to ones belonging to the specified Account. + # + # @param account_number_id [String] Filter Inbound Wire Transfers to ones belonging to the specified Account Number. + # ... + # # @param created_at [Increase::Models::InboundWireTransferListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # # @param status [Increase::Models::InboundWireTransferListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/intrafi_account_enrollments.rb b/lib/increase/resources/intrafi_account_enrollments.rb index 8a1d156f4..0c69ed14e 100644 --- a/lib/increase/resources/intrafi_account_enrollments.rb +++ b/lib/increase/resources/intrafi_account_enrollments.rb @@ -7,8 +7,10 @@ class IntrafiAccountEnrollments # # @overload create(account_id:, email_address:, request_options: {}) # - # @param account_id [String] - # @param email_address [String] + # @param account_id [String] The identifier for the account to be added to IntraFi. + # + # @param email_address [String] The contact email for the account owner, to be shared with IntraFi. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::IntrafiAccountEnrollment] @@ -29,7 +31,8 @@ def create(params) # # @overload retrieve(intrafi_account_enrollment_id, request_options: {}) # - # @param intrafi_account_enrollment_id [String] + # @param intrafi_account_enrollment_id [String] The identifier of the IntraFi Account Enrollment to retrieve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::IntrafiAccountEnrollment] @@ -44,15 +47,25 @@ def retrieve(intrafi_account_enrollment_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::IntrafiAccountEnrollmentListParams} for more details. + # # List IntraFi Account Enrollments # # @overload list(account_id: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) # - # @param account_id [String] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # @param account_id [String] Filter IntraFi Account Enrollments to the one belonging to an account. + # + # @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::IntrafiAccountEnrollmentListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] @@ -74,7 +87,8 @@ def list(params = {}) # # @overload unenroll(intrafi_account_enrollment_id, request_options: {}) # - # @param intrafi_account_enrollment_id [String] + # @param intrafi_account_enrollment_id [String] The Identifier of the IntraFi Account Enrollment to remove from IntraFi. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::IntrafiAccountEnrollment] diff --git a/lib/increase/resources/intrafi_balances.rb b/lib/increase/resources/intrafi_balances.rb index 63075fcff..15f44195a 100644 --- a/lib/increase/resources/intrafi_balances.rb +++ b/lib/increase/resources/intrafi_balances.rb @@ -7,7 +7,8 @@ class IntrafiBalances # # @overload intrafi_balance(account_id, request_options: {}) # - # @param account_id [String] + # @param account_id [String] The identifier of the Account to get balances for. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::IntrafiBalance] diff --git a/lib/increase/resources/intrafi_exclusions.rb b/lib/increase/resources/intrafi_exclusions.rb index 6135be3b3..79e4cacad 100644 --- a/lib/increase/resources/intrafi_exclusions.rb +++ b/lib/increase/resources/intrafi_exclusions.rb @@ -7,8 +7,10 @@ class IntrafiExclusions # # @overload create(bank_name:, entity_id:, request_options: {}) # - # @param bank_name [String] - # @param entity_id [String] + # @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}, nil] # # @return [Increase::Models::IntrafiExclusion] @@ -29,7 +31,8 @@ def create(params) # # @overload retrieve(intrafi_exclusion_id, request_options: {}) # - # @param intrafi_exclusion_id [String] + # @param intrafi_exclusion_id [String] The identifier of the IntraFi Exclusion to retrieve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::IntrafiExclusion] @@ -44,14 +47,23 @@ def retrieve(intrafi_exclusion_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::IntrafiExclusionListParams} for more details. + # # List IntraFi Exclusions # # @overload list(cursor: nil, entity_id: nil, idempotency_key: nil, limit: nil, request_options: {}) # - # @param cursor [String] - # @param entity_id [String] - # @param idempotency_key [String] - # @param limit [Integer] + # @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}, nil] # # @return [Increase::Internal::Page] @@ -69,11 +81,16 @@ def list(params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::IntrafiExclusionArchiveParams} for more details. + # # Archive an IntraFi Exclusion # # @overload archive(intrafi_exclusion_id, request_options: {}) # - # @param intrafi_exclusion_id [String] + # @param intrafi_exclusion_id [String] The identifier of the IntraFi Exclusion request to archive. It may take 5 busine + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::IntrafiExclusion] diff --git a/lib/increase/resources/lockboxes.rb b/lib/increase/resources/lockboxes.rb index 0e139cf6c..f165808e7 100644 --- a/lib/increase/resources/lockboxes.rb +++ b/lib/increase/resources/lockboxes.rb @@ -7,9 +7,12 @@ class Lockboxes # # @overload create(account_id:, description: nil, recipient_name: nil, request_options: {}) # - # @param account_id [String] - # @param description [String] - # @param recipient_name [String] + # @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}, nil] # # @return [Increase::Models::Lockbox] @@ -30,7 +33,8 @@ def create(params) # # @overload retrieve(lockbox_id, request_options: {}) # - # @param lockbox_id [String] + # @param lockbox_id [String] The identifier of the Lockbox to retrieve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Lockbox] @@ -49,10 +53,14 @@ def retrieve(lockbox_id, params = {}) # # @overload update(lockbox_id, description: nil, recipient_name: nil, status: nil, request_options: {}) # - # @param lockbox_id [String] - # @param description [String] - # @param recipient_name [String] - # @param status [Symbol, Increase::Models::LockboxUpdateParams::Status] + # @param lockbox_id [String] The identifier of the Lockbox. + # + # @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}, nil] # # @return [Increase::Models::Lockbox] @@ -69,15 +77,25 @@ def update(lockbox_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::LockboxListParams} for more details. + # # List Lockboxes # # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) # - # @param account_id [String] + # @param account_id [String] Filter Lockboxes to those associated with the provided Account. + # # @param created_at [Increase::Models::LockboxListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/oauth_applications.rb b/lib/increase/resources/oauth_applications.rb index 7c43d596c..f89d1b516 100644 --- a/lib/increase/resources/oauth_applications.rb +++ b/lib/increase/resources/oauth_applications.rb @@ -7,7 +7,8 @@ class OAuthApplications # # @overload retrieve(oauth_application_id, request_options: {}) # - # @param oauth_application_id [String] + # @param oauth_application_id [String] The identifier of the OAuth Application. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::OAuthApplication] @@ -22,14 +23,22 @@ def retrieve(oauth_application_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::OAuthApplicationListParams} for more details. + # # List OAuth Applications # # @overload list(created_at: nil, cursor: nil, limit: nil, status: nil, request_options: {}) # # @param created_at [Increase::Models::OAuthApplicationListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # # @param status [Increase::Models::OAuthApplicationListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/oauth_connections.rb b/lib/increase/resources/oauth_connections.rb index 26c7675b5..868dc9e4c 100644 --- a/lib/increase/resources/oauth_connections.rb +++ b/lib/increase/resources/oauth_connections.rb @@ -7,7 +7,8 @@ class OAuthConnections # # @overload retrieve(oauth_connection_id, request_options: {}) # - # @param oauth_connection_id [String] + # @param oauth_connection_id [String] The identifier of the OAuth Connection. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::OAuthConnection] @@ -22,14 +23,23 @@ def retrieve(oauth_connection_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::OAuthConnectionListParams} for more details. + # # List OAuth Connections # # @overload list(cursor: nil, limit: nil, oauth_application_id: nil, status: nil, request_options: {}) # - # @param cursor [String] - # @param limit [Integer] - # @param oauth_application_id [String] + # @param cursor [String] Return the page of entries after this one. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # + # @param oauth_application_id [String] Filter results to only include OAuth Connections for a specific OAuth Applicatio + # ... + # # @param status [Increase::Models::OAuthConnectionListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/oauth_tokens.rb b/lib/increase/resources/oauth_tokens.rb index 93f564c0f..217bea5fd 100644 --- a/lib/increase/resources/oauth_tokens.rb +++ b/lib/increase/resources/oauth_tokens.rb @@ -3,15 +3,27 @@ module Increase module Resources class OAuthTokens + # Some parameter documentations has been truncated, see + # {Increase::Models::OAuthTokenCreateParams} for more details. + # # Create an OAuth Token # # @overload create(grant_type:, client_id: nil, client_secret: nil, code: nil, production_token: nil, request_options: {}) # - # @param grant_type [Symbol, Increase::Models::OAuthTokenCreateParams::GrantType] - # @param client_id [String] - # @param client_secret [String] - # @param code [String] - # @param production_token [String] + # @param grant_type [Symbol, Increase::Models::OAuthTokenCreateParams::GrantType] The credential you request in exchange for the code. In Production, this is alwa + # ... + # + # @param client_id [String] The public identifier for your application. + # + # @param client_secret [String] The secret that confirms you own the application. This is redundent given that t + # ... + # + # @param code [String] The authorization code generated by the user and given to you as a query paramet + # ... + # + # @param production_token [String] The production token you want to exchange for a sandbox token. This is only avai + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::OAuthToken] diff --git a/lib/increase/resources/pending_transactions.rb b/lib/increase/resources/pending_transactions.rb index 0404be196..4c5eecf3f 100644 --- a/lib/increase/resources/pending_transactions.rb +++ b/lib/increase/resources/pending_transactions.rb @@ -7,7 +7,8 @@ class PendingTransactions # # @overload retrieve(pending_transaction_id, request_options: {}) # - # @param pending_transaction_id [String] + # @param pending_transaction_id [String] The identifier of the Pending Transaction. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::PendingTransaction] @@ -22,17 +23,28 @@ def retrieve(pending_transaction_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::PendingTransactionListParams} for more details. + # # List Pending Transactions # # @overload list(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, status: nil, request_options: {}) # - # @param account_id [String] + # @param account_id [String] Filter pending transactions to those belonging to the specified Account. + # # @param category [Increase::Models::PendingTransactionListParams::Category] + # # @param created_at [Increase::Models::PendingTransactionListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] - # @param route_id [String] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # + # @param route_id [String] Filter pending transactions to those belonging to the specified Route. + # # @param status [Increase::Models::PendingTransactionListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/physical_card_profiles.rb b/lib/increase/resources/physical_card_profiles.rb index 378c8031b..c097d6217 100644 --- a/lib/increase/resources/physical_card_profiles.rb +++ b/lib/increase/resources/physical_card_profiles.rb @@ -7,11 +7,16 @@ class PhysicalCardProfiles # # @overload create(carrier_image_file_id:, contact_phone:, description:, front_image_file_id:, program_id:, request_options: {}) # - # @param carrier_image_file_id [String] - # @param contact_phone [String] - # @param description [String] - # @param front_image_file_id [String] - # @param program_id [String] + # @param carrier_image_file_id [String] The identifier of the File containing the physical card's carrier image. + # + # @param contact_phone [String] A phone number the user can contact to receive support for their card. + # + # @param description [String] A description you can use to identify the Card Profile. + # + # @param front_image_file_id [String] The identifier of the File containing the physical card's front image. + # + # @param program_id [String] The identifier for the Program that this Physical Card Profile falls under. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::PhysicalCardProfile] @@ -32,7 +37,8 @@ def create(params) # # @overload retrieve(physical_card_profile_id, request_options: {}) # - # @param physical_card_profile_id [String] + # @param physical_card_profile_id [String] The identifier of the Card Profile. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::PhysicalCardProfile] @@ -47,14 +53,23 @@ def retrieve(physical_card_profile_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::PhysicalCardProfileListParams} for more details. + # # List Physical Card Profiles # # @overload list(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) # - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # @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::PhysicalCardProfileListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] @@ -76,7 +91,8 @@ def list(params = {}) # # @overload archive(physical_card_profile_id, request_options: {}) # - # @param physical_card_profile_id [String] + # @param physical_card_profile_id [String] The identifier of the Physical Card Profile to archive. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::PhysicalCardProfile] @@ -91,16 +107,26 @@ def archive(physical_card_profile_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::PhysicalCardProfileCloneParams} for more details. + # # Clone a Physical Card Profile # # @overload clone_(physical_card_profile_id, carrier_image_file_id: nil, contact_phone: nil, description: nil, front_image_file_id: nil, front_text: nil, request_options: {}) # - # @param physical_card_profile_id [String] - # @param carrier_image_file_id [String] - # @param contact_phone [String] - # @param description [String] - # @param front_image_file_id [String] - # @param front_text [Increase::Models::PhysicalCardProfileCloneParams::FrontText] + # @param physical_card_profile_id [String] The identifier of the Physical Card Profile to clone. + # + # @param carrier_image_file_id [String] The identifier of the File containing the physical card's carrier image. + # + # @param contact_phone [String] A phone number the user can contact to receive support for their card. + # + # @param description [String] A description you can use to identify the Card Profile. + # + # @param front_image_file_id [String] The identifier of the File containing the physical card's front image. + # + # @param front_text [Increase::Models::PhysicalCardProfileCloneParams::FrontText] Text printed on the front of the card. Reach out to [support@increase.com](mailt + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::PhysicalCardProfile] diff --git a/lib/increase/resources/physical_cards.rb b/lib/increase/resources/physical_cards.rb index eebbfb499..ffb710abc 100644 --- a/lib/increase/resources/physical_cards.rb +++ b/lib/increase/resources/physical_cards.rb @@ -3,14 +3,22 @@ module Increase module Resources class PhysicalCards + # Some parameter documentations has been truncated, see + # {Increase::Models::PhysicalCardCreateParams} for more details. + # # Create a Physical Card # # @overload create(card_id:, cardholder:, shipment:, physical_card_profile_id: nil, request_options: {}) # - # @param card_id [String] - # @param cardholder [Increase::Models::PhysicalCardCreateParams::Cardholder] - # @param shipment [Increase::Models::PhysicalCardCreateParams::Shipment] - # @param physical_card_profile_id [String] + # @param card_id [String] The underlying card representing this physical card. + # + # @param cardholder [Increase::Models::PhysicalCardCreateParams::Cardholder] Details about the cardholder, as it will appear on the physical card. + # + # @param shipment [Increase::Models::PhysicalCardCreateParams::Shipment] The details used to ship this physical card. + # + # @param physical_card_profile_id [String] The physical card profile to use for this physical card. The latest default phys + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::PhysicalCard] @@ -31,7 +39,8 @@ def create(params) # # @overload retrieve(physical_card_id, request_options: {}) # - # @param physical_card_id [String] + # @param physical_card_id [String] The identifier of the Physical Card. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::PhysicalCard] @@ -50,8 +59,10 @@ def retrieve(physical_card_id, params = {}) # # @overload update(physical_card_id, status:, request_options: {}) # - # @param physical_card_id [String] - # @param status [Symbol, Increase::Models::PhysicalCardUpdateParams::Status] + # @param physical_card_id [String] The Physical Card identifier. + # + # @param status [Symbol, Increase::Models::PhysicalCardUpdateParams::Status] The status to update the Physical Card to. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::PhysicalCard] @@ -68,15 +79,25 @@ def update(physical_card_id, params) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::PhysicalCardListParams} for more details. + # # List Physical Cards # # @overload list(card_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) # - # @param card_id [String] + # @param card_id [String] Filter Physical Cards to ones belonging to the specified Card. + # # @param created_at [Increase::Models::PhysicalCardListParams::CreatedAt] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @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}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/programs.rb b/lib/increase/resources/programs.rb index 63eb408c8..be2bf226d 100644 --- a/lib/increase/resources/programs.rb +++ b/lib/increase/resources/programs.rb @@ -7,7 +7,8 @@ class Programs # # @overload retrieve(program_id, request_options: {}) # - # @param program_id [String] + # @param program_id [String] The identifier of the Program to retrieve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Program] @@ -22,12 +23,18 @@ def retrieve(program_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::ProgramListParams} for more details. + # # List Programs # # @overload list(cursor: nil, limit: nil, request_options: {}) # - # @param cursor [String] - # @param limit [Integer] + # @param cursor [String] Return the page of entries after this one. + # + # @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] diff --git a/lib/increase/resources/real_time_decisions.rb b/lib/increase/resources/real_time_decisions.rb index 0aa25487e..317c46ec9 100644 --- a/lib/increase/resources/real_time_decisions.rb +++ b/lib/increase/resources/real_time_decisions.rb @@ -7,7 +7,8 @@ class RealTimeDecisions # # @overload retrieve(real_time_decision_id, request_options: {}) # - # @param real_time_decision_id [String] + # @param real_time_decision_id [String] The identifier of the Real-Time Decision. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::RealTimeDecision] @@ -22,16 +23,30 @@ def retrieve(real_time_decision_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimeDecisionActionParams} for more details. + # # Action a Real-Time Decision # # @overload action(real_time_decision_id, card_authentication: nil, card_authentication_challenge: nil, card_authorization: nil, digital_wallet_authentication: nil, digital_wallet_token: nil, request_options: {}) # - # @param real_time_decision_id [String] - # @param card_authentication [Increase::Models::RealTimeDecisionActionParams::CardAuthentication] - # @param card_authentication_challenge [Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge] - # @param card_authorization [Increase::Models::RealTimeDecisionActionParams::CardAuthorization] - # @param digital_wallet_authentication [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication] - # @param digital_wallet_token [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken] + # @param real_time_decision_id [String] The identifier of the Real-Time Decision. + # + # @param card_authentication [Increase::Models::RealTimeDecisionActionParams::CardAuthentication] If the Real-Time Decision relates to a 3DS card authentication attempt, this obj + # ... + # + # @param card_authentication_challenge [Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge] If the Real-Time Decision relates to 3DS card authentication challenge delivery, + # ... + # + # @param card_authorization [Increase::Models::RealTimeDecisionActionParams::CardAuthorization] If the Real-Time Decision relates to a card authorization attempt, this object c + # ... + # + # @param digital_wallet_authentication [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication] If the Real-Time Decision relates to a digital wallet authentication attempt, th + # ... + # + # @param digital_wallet_token [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken] If the Real-Time Decision relates to a digital wallet token provisioning attempt + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::RealTimeDecision] diff --git a/lib/increase/resources/real_time_payments_transfers.rb b/lib/increase/resources/real_time_payments_transfers.rb index 76561006d..6f6f64f3b 100644 --- a/lib/increase/resources/real_time_payments_transfers.rb +++ b/lib/increase/resources/real_time_payments_transfers.rb @@ -3,21 +3,41 @@ module Increase module Resources class RealTimePaymentsTransfers + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimePaymentsTransferCreateParams} for more details. + # # Create a Real-Time Payments Transfer # # @overload create(amount:, creditor_name:, remittance_information:, source_account_number_id:, debtor_name: nil, destination_account_number: nil, destination_routing_number: nil, external_account_id: nil, require_approval: nil, ultimate_creditor_name: nil, ultimate_debtor_name: nil, request_options: {}) # - # @param amount [Integer] - # @param creditor_name [String] - # @param remittance_information [String] - # @param source_account_number_id [String] - # @param debtor_name [String] - # @param destination_account_number [String] - # @param destination_routing_number [String] - # @param external_account_id [String] - # @param require_approval [Boolean] - # @param ultimate_creditor_name [String] - # @param ultimate_debtor_name [String] + # @param amount [Integer] The transfer amount in USD cents. For Real-Time Payments transfers, must be posi + # ... + # + # @param creditor_name [String] The name of the transfer's recipient. + # + # @param remittance_information [String] Unstructured information that will show on the recipient's bank statement. + # + # @param source_account_number_id [String] The identifier of the Account Number from which to send the transfer. + # + # @param debtor_name [String] The name of the transfer's sender. If not provided, defaults to the name of the + # ... + # + # @param destination_account_number [String] The destination account number. + # + # @param destination_routing_number [String] The destination American Bankers' Association (ABA) Routing Transit Number (RTN) + # ... + # + # @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr + # ... + # + # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API. + # + # @param ultimate_creditor_name [String] The name of the ultimate recipient of the transfer. Set this if the creditor is + # ... + # + # @param ultimate_debtor_name [String] The name of the ultimate sender of the transfer. Set this if the funds are being + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::RealTimePaymentsTransfer] @@ -38,7 +58,8 @@ def create(params) # # @overload retrieve(real_time_payments_transfer_id, request_options: {}) # - # @param real_time_payments_transfer_id [String] + # @param real_time_payments_transfer_id [String] The identifier of the Real-Time Payments Transfer. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::RealTimePaymentsTransfer] @@ -53,17 +74,31 @@ def retrieve(real_time_payments_transfer_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::RealTimePaymentsTransferListParams} for more details. + # # List Real-Time Payments Transfers # # @overload list(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) # - # @param account_id [String] + # @param account_id [String] Filter Real-Time Payments Transfers to those belonging to the specified Account. + # ... + # # @param created_at [Increase::Models::RealTimePaymentsTransferListParams::CreatedAt] - # @param cursor [String] - # @param external_account_id [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param external_account_id [String] Filter Real-Time Payments Transfers to those made to the specified External Acco + # ... + # + # @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::RealTimePaymentsTransferListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/routing_numbers.rb b/lib/increase/resources/routing_numbers.rb index 7c1b547f4..3c642586c 100644 --- a/lib/increase/resources/routing_numbers.rb +++ b/lib/increase/resources/routing_numbers.rb @@ -3,6 +3,9 @@ module Increase module Resources class RoutingNumbers + # Some parameter documentations has been truncated, see + # {Increase::Models::RoutingNumberListParams} for more details. + # # You can use this API to confirm if a routing number is valid, such as when a # user is providing you with bank account details. Since routing numbers uniquely # identify a bank, this will always return 0 or 1 entry. In Sandbox, the only @@ -10,9 +13,13 @@ class RoutingNumbers # # @overload list(routing_number:, cursor: nil, limit: nil, request_options: {}) # - # @param routing_number [String] - # @param cursor [String] - # @param limit [Integer] + # @param routing_number [String] Filter financial institutions by routing number. + # + # @param cursor [String] Return the page of entries after this one. + # + # @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] diff --git a/lib/increase/resources/simulations/account_statements.rb b/lib/increase/resources/simulations/account_statements.rb index 3e66bbec3..09d2d0209 100644 --- a/lib/increase/resources/simulations/account_statements.rb +++ b/lib/increase/resources/simulations/account_statements.rb @@ -9,7 +9,8 @@ class AccountStatements # # @overload create(account_id:, request_options: {}) # - # @param account_id [String] + # @param account_id [String] The identifier of the Account the statement is for. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::AccountStatement] diff --git a/lib/increase/resources/simulations/account_transfers.rb b/lib/increase/resources/simulations/account_transfers.rb index bbbd003b7..822ce9910 100644 --- a/lib/increase/resources/simulations/account_transfers.rb +++ b/lib/increase/resources/simulations/account_transfers.rb @@ -11,7 +11,8 @@ class AccountTransfers # # @overload complete(account_transfer_id, request_options: {}) # - # @param account_transfer_id [String] + # @param account_transfer_id [String] The identifier of the Account Transfer you wish to complete. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::AccountTransfer] diff --git a/lib/increase/resources/simulations/ach_transfers.rb b/lib/increase/resources/simulations/ach_transfers.rb index 439cc49a2..8fb0daa45 100644 --- a/lib/increase/resources/simulations/ach_transfers.rb +++ b/lib/increase/resources/simulations/ach_transfers.rb @@ -13,7 +13,8 @@ class ACHTransfers # # @overload acknowledge(ach_transfer_id, request_options: {}) # - # @param ach_transfer_id [String] + # @param ach_transfer_id [String] The identifier of the ACH Transfer you wish to become acknowledged. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::ACHTransfer] @@ -28,14 +29,22 @@ def acknowledge(ach_transfer_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::ACHTransferCreateNotificationOfChangeParams} for + # more details. + # # Simulates receiving a Notification of Change for an # [ACH Transfer](#ach-transfers). # # @overload create_notification_of_change(ach_transfer_id, change_code:, corrected_data:, request_options: {}) # - # @param ach_transfer_id [String] - # @param change_code [Symbol, Increase::Models::Simulations::ACHTransferCreateNotificationOfChangeParams::ChangeCode] - # @param corrected_data [String] + # @param ach_transfer_id [String] The identifier of the ACH Transfer you wish to create a notification of change f + # ... + # + # @param change_code [Symbol, Increase::Models::Simulations::ACHTransferCreateNotificationOfChangeParams::ChangeCode] The reason for the notification of change. + # + # @param corrected_data [String] The corrected data for the notification of change (e.g., a new routing number). + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::ACHTransfer] @@ -53,14 +62,20 @@ def create_notification_of_change(ach_transfer_id, params) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::ACHTransferReturnParams} for more details. + # # Simulates the return of an [ACH Transfer](#ach-transfers) by the Federal Reserve # due to an error condition. This will also create a Transaction to account for # the returned funds. This transfer must first have a `status` of `submitted`. # # @overload return_(ach_transfer_id, reason: nil, request_options: {}) # - # @param ach_transfer_id [String] - # @param reason [Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason] + # @param ach_transfer_id [String] The identifier of the ACH Transfer you wish to return. + # + # @param reason [Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason] The reason why the Federal Reserve or destination bank returned this transfer. D + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::ACHTransfer] @@ -86,7 +101,8 @@ def return_(ach_transfer_id, params = {}) # # @overload settle(ach_transfer_id, request_options: {}) # - # @param ach_transfer_id [String] + # @param ach_transfer_id [String] The identifier of the ACH Transfer you wish to become settled. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::ACHTransfer] @@ -110,7 +126,8 @@ def settle(ach_transfer_id, params = {}) # # @overload submit(ach_transfer_id, request_options: {}) # - # @param ach_transfer_id [String] + # @param ach_transfer_id [String] The identifier of the ACH Transfer you wish to submit. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::ACHTransfer] diff --git a/lib/increase/resources/simulations/card_authorization_expirations.rb b/lib/increase/resources/simulations/card_authorization_expirations.rb index d8a673ce6..0819e6ba9 100644 --- a/lib/increase/resources/simulations/card_authorization_expirations.rb +++ b/lib/increase/resources/simulations/card_authorization_expirations.rb @@ -8,7 +8,8 @@ class CardAuthorizationExpirations # # @overload create(card_payment_id:, request_options: {}) # - # @param card_payment_id [String] + # @param card_payment_id [String] The identifier of the Card Payment to expire. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CardPayment] diff --git a/lib/increase/resources/simulations/card_authorizations.rb b/lib/increase/resources/simulations/card_authorizations.rb index c6a88b1c0..17a03056b 100644 --- a/lib/increase/resources/simulations/card_authorizations.rb +++ b/lib/increase/resources/simulations/card_authorizations.rb @@ -4,6 +4,9 @@ module Increase module Resources class Simulations class CardAuthorizations + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::CardAuthorizationCreateParams} for more details. + # # Simulates a purchase authorization on a [Card](#cards). Depending on the balance # available to the card and the `amount` submitted, the authorization activity # will result in a [Pending Transaction](#pending-transactions) of type @@ -14,23 +17,48 @@ class CardAuthorizations # # @overload create(amount:, authenticated_card_payment_id: nil, card_id: nil, decline_reason: nil, digital_wallet_token_id: nil, direction: nil, event_subscription_id: nil, merchant_acceptor_id: nil, merchant_category_code: nil, merchant_city: nil, merchant_country: nil, merchant_descriptor: nil, merchant_state: nil, network_details: nil, network_risk_score: nil, physical_card_id: nil, terminal_id: nil, request_options: {}) # - # @param amount [Integer] - # @param authenticated_card_payment_id [String] - # @param card_id [String] - # @param decline_reason [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::DeclineReason] - # @param digital_wallet_token_id [String] - # @param direction [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::Direction] - # @param event_subscription_id [String] - # @param merchant_acceptor_id [String] - # @param merchant_category_code [String] - # @param merchant_city [String] - # @param merchant_country [String] - # @param merchant_descriptor [String] - # @param merchant_state [String] - # @param network_details [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails] - # @param network_risk_score [Integer] - # @param physical_card_id [String] - # @param terminal_id [String] + # @param amount [Integer] The authorization amount in cents. + # + # @param authenticated_card_payment_id [String] The identifier of a Card Payment with a `card_authentication` if you want to sim + # ... + # + # @param card_id [String] The identifier of the Card to be authorized. + # + # @param decline_reason [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::DeclineReason] Forces a card decline with a specific reason. No real time decision will be sent + # ... + # + # @param digital_wallet_token_id [String] The identifier of the Digital Wallet Token to be authorized. + # + # @param direction [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::Direction] The direction describes the direction the funds will move, either from the cardh + # ... + # + # @param event_subscription_id [String] The identifier of the Event Subscription to use. If provided, will override the + # ... + # + # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i + # ... + # + # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car + # ... + # + # @param merchant_city [String] The city the merchant resides in. + # + # @param merchant_country [String] The country the merchant resides in. + # + # @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with. + # + # @param merchant_state [String] The state the merchant resides in. + # + # @param network_details [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails] Fields specific to a given card network. + # + # @param network_risk_score [Integer] The risk score generated by the card network. For Visa this is the Visa Advanced + # ... + # + # @param physical_card_id [String] The identifier of the Physical Card to be authorized. + # + # @param terminal_id [String] The terminal identifier (commonly abbreviated as TID) of the terminal the card i + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Simulations::CardAuthorizationCreateResponse] diff --git a/lib/increase/resources/simulations/card_disputes.rb b/lib/increase/resources/simulations/card_disputes.rb index 6bf9581f8..6d6f9ba22 100644 --- a/lib/increase/resources/simulations/card_disputes.rb +++ b/lib/increase/resources/simulations/card_disputes.rb @@ -11,9 +11,12 @@ class CardDisputes # # @overload action(card_dispute_id, status:, explanation: nil, request_options: {}) # - # @param card_dispute_id [String] - # @param status [Symbol, Increase::Models::Simulations::CardDisputeActionParams::Status] - # @param explanation [String] + # @param card_dispute_id [String] The dispute you would like to action. + # + # @param status [Symbol, Increase::Models::Simulations::CardDisputeActionParams::Status] The status to move the dispute to. + # + # @param explanation [String] Why the dispute was rejected. Not required for accepting disputes. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CardDispute] diff --git a/lib/increase/resources/simulations/card_fuel_confirmations.rb b/lib/increase/resources/simulations/card_fuel_confirmations.rb index 2576c929d..46399726e 100644 --- a/lib/increase/resources/simulations/card_fuel_confirmations.rb +++ b/lib/increase/resources/simulations/card_fuel_confirmations.rb @@ -4,14 +4,21 @@ module Increase module Resources class Simulations class CardFuelConfirmations + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::CardFuelConfirmationCreateParams} for more + # details. + # # Simulates the fuel confirmation of an authorization by a card acquirer. This # happens asynchronously right after a fuel pump transaction is completed. A fuel # confirmation can only happen once per authorization. # # @overload create(amount:, card_payment_id:, request_options: {}) # - # @param amount [Integer] - # @param card_payment_id [String] + # @param amount [Integer] The amount of the fuel_confirmation in minor units in the card authorization's c + # ... + # + # @param card_payment_id [String] The identifier of the Card Payment to create a fuel_confirmation on. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CardPayment] diff --git a/lib/increase/resources/simulations/card_increments.rb b/lib/increase/resources/simulations/card_increments.rb index 0a0701ea3..1447d67d9 100644 --- a/lib/increase/resources/simulations/card_increments.rb +++ b/lib/increase/resources/simulations/card_increments.rb @@ -4,14 +4,22 @@ module Increase module Resources class Simulations class CardIncrements + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::CardIncrementCreateParams} for more details. + # # Simulates the increment of an authorization by a card acquirer. An authorization # can be incremented multiple times. # # @overload create(amount:, card_payment_id:, event_subscription_id: nil, request_options: {}) # - # @param amount [Integer] - # @param card_payment_id [String] - # @param event_subscription_id [String] + # @param amount [Integer] The amount of the increment in minor units in the card authorization's currency. + # ... + # + # @param card_payment_id [String] The identifier of the Card Payment to create a increment on. + # + # @param event_subscription_id [String] The identifier of the Event Subscription to use. If provided, will override the + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CardPayment] diff --git a/lib/increase/resources/simulations/card_refunds.rb b/lib/increase/resources/simulations/card_refunds.rb index 09b79d2ca..296627c9c 100644 --- a/lib/increase/resources/simulations/card_refunds.rb +++ b/lib/increase/resources/simulations/card_refunds.rb @@ -4,12 +4,17 @@ module Increase module Resources class Simulations class CardRefunds + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::CardRefundCreateParams} for more details. + # # Simulates refunding a card transaction. The full value of the original sandbox # transaction is refunded. # # @overload create(transaction_id:, request_options: {}) # - # @param transaction_id [String] + # @param transaction_id [String] The identifier for the Transaction to refund. The Transaction's source must have + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Transaction] diff --git a/lib/increase/resources/simulations/card_reversals.rb b/lib/increase/resources/simulations/card_reversals.rb index bf2ce9b0e..93ca6cc00 100644 --- a/lib/increase/resources/simulations/card_reversals.rb +++ b/lib/increase/resources/simulations/card_reversals.rb @@ -4,6 +4,9 @@ module Increase module Resources class Simulations class CardReversals + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::CardReversalCreateParams} for more details. + # # Simulates the reversal of an authorization by a card acquirer. An authorization # can be partially reversed multiple times, up until the total authorized amount. # Marks the pending transaction as complete if the authorization is fully @@ -11,8 +14,11 @@ class CardReversals # # @overload create(card_payment_id:, amount: nil, request_options: {}) # - # @param card_payment_id [String] - # @param amount [Integer] + # @param card_payment_id [String] The identifier of the Card Payment to create a reversal on. + # + # @param amount [Integer] The amount of the reversal in minor units in the card authorization's currency. + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CardPayment] diff --git a/lib/increase/resources/simulations/card_settlements.rb b/lib/increase/resources/simulations/card_settlements.rb index f8f5e6032..842a2568f 100644 --- a/lib/increase/resources/simulations/card_settlements.rb +++ b/lib/increase/resources/simulations/card_settlements.rb @@ -4,6 +4,9 @@ module Increase module Resources class Simulations class CardSettlements + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::CardSettlementCreateParams} for more details. + # # Simulates the settlement of an authorization by a card acquirer. After a card # authorization is created, the merchant will eventually send a settlement. This # simulates that event, which may occur many days after the purchase in @@ -12,9 +15,14 @@ class CardSettlements # # @overload create(card_id:, pending_transaction_id:, amount: nil, request_options: {}) # - # @param card_id [String] - # @param pending_transaction_id [String] - # @param amount [Integer] + # @param card_id [String] The identifier of the Card to create a settlement on. + # + # @param pending_transaction_id [String] The identifier of the Pending Transaction for the Card Authorization you wish to + # ... + # + # @param amount [Integer] The amount to be settled. This defaults to the amount of the Pending Transaction + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Transaction] diff --git a/lib/increase/resources/simulations/check_deposits.rb b/lib/increase/resources/simulations/check_deposits.rb index 1857aac68..0a84bf986 100644 --- a/lib/increase/resources/simulations/check_deposits.rb +++ b/lib/increase/resources/simulations/check_deposits.rb @@ -10,7 +10,8 @@ class CheckDeposits # # @overload reject(check_deposit_id, request_options: {}) # - # @param check_deposit_id [String] + # @param check_deposit_id [String] The identifier of the Check Deposit you wish to reject. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CheckDeposit] @@ -30,7 +31,8 @@ def reject(check_deposit_id, params = {}) # # @overload return_(check_deposit_id, request_options: {}) # - # @param check_deposit_id [String] + # @param check_deposit_id [String] The identifier of the Check Deposit you wish to return. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CheckDeposit] @@ -50,7 +52,8 @@ def return_(check_deposit_id, params = {}) # # @overload submit(check_deposit_id, request_options: {}) # - # @param check_deposit_id [String] + # @param check_deposit_id [String] The identifier of the Check Deposit you wish to submit. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CheckDeposit] diff --git a/lib/increase/resources/simulations/check_transfers.rb b/lib/increase/resources/simulations/check_transfers.rb index ba77dfa59..b5b2c992e 100644 --- a/lib/increase/resources/simulations/check_transfers.rb +++ b/lib/increase/resources/simulations/check_transfers.rb @@ -11,7 +11,8 @@ class CheckTransfers # # @overload mail(check_transfer_id, request_options: {}) # - # @param check_transfer_id [String] + # @param check_transfer_id [String] The identifier of the Check Transfer you wish to mail. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::CheckTransfer] diff --git a/lib/increase/resources/simulations/digital_wallet_token_requests.rb b/lib/increase/resources/simulations/digital_wallet_token_requests.rb index bc45d11c2..b9dbbadc8 100644 --- a/lib/increase/resources/simulations/digital_wallet_token_requests.rb +++ b/lib/increase/resources/simulations/digital_wallet_token_requests.rb @@ -9,7 +9,8 @@ class DigitalWalletTokenRequests # # @overload create(card_id:, request_options: {}) # - # @param card_id [String] + # @param card_id [String] The identifier of the Card to be authorized. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse] diff --git a/lib/increase/resources/simulations/documents.rb b/lib/increase/resources/simulations/documents.rb index 816fafa04..e99b3efcf 100644 --- a/lib/increase/resources/simulations/documents.rb +++ b/lib/increase/resources/simulations/documents.rb @@ -8,7 +8,8 @@ class Documents # # @overload create(account_id:, request_options: {}) # - # @param account_id [String] + # @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] diff --git a/lib/increase/resources/simulations/inbound_ach_transfers.rb b/lib/increase/resources/simulations/inbound_ach_transfers.rb index f3446037f..b868ea775 100644 --- a/lib/increase/resources/simulations/inbound_ach_transfers.rb +++ b/lib/increase/resources/simulations/inbound_ach_transfers.rb @@ -4,6 +4,10 @@ module Increase module Resources class Simulations class InboundACHTransfers + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::InboundACHTransferCreateParams} for more + # details. + # # Simulates an inbound ACH transfer to your account. This imitates initiating a # transfer to an Increase account from a different financial institution. The # transfer may be either a credit or a debit depending on if the `amount` is @@ -17,17 +21,30 @@ class InboundACHTransfers # # @overload create(account_number_id:, amount:, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_id: nil, company_name: nil, receiver_id_number: nil, receiver_name: nil, resolve_at: nil, standard_entry_class_code: nil, request_options: {}) # - # @param account_number_id [String] - # @param amount [Integer] - # @param company_descriptive_date [String] - # @param company_discretionary_data [String] - # @param company_entry_description [String] - # @param company_id [String] - # @param company_name [String] - # @param receiver_id_number [String] - # @param receiver_name [String] - # @param resolve_at [Time] - # @param standard_entry_class_code [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode] + # @param account_number_id [String] The identifier of the Account Number the inbound ACH Transfer is for. + # + # @param amount [Integer] The transfer amount in cents. A positive amount originates a credit transfer pus + # ... + # + # @param company_descriptive_date [String] The description of the date of the transfer. + # + # @param company_discretionary_data [String] Data associated with the transfer set by the sender. + # + # @param company_entry_description [String] The description of the transfer set by the sender. + # + # @param company_id [String] The sender's company ID. + # + # @param company_name [String] The name of the sender. + # + # @param receiver_id_number [String] The ID of the receiver of the transfer. + # + # @param receiver_name [String] The name of the receiver of the transfer. + # + # @param resolve_at [Time] The time at which the transfer should be resolved. If not provided will resolve + # ... + # + # @param standard_entry_class_code [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode] The standard entry class code for the transfer. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::InboundACHTransfer] diff --git a/lib/increase/resources/simulations/inbound_check_deposits.rb b/lib/increase/resources/simulations/inbound_check_deposits.rb index 5a3b008f4..011a5fc94 100644 --- a/lib/increase/resources/simulations/inbound_check_deposits.rb +++ b/lib/increase/resources/simulations/inbound_check_deposits.rb @@ -13,9 +13,12 @@ class InboundCheckDeposits # # @overload create(account_number_id:, amount:, check_number:, request_options: {}) # - # @param account_number_id [String] - # @param amount [Integer] - # @param check_number [String] + # @param account_number_id [String] The identifier of the Account Number the Inbound Check Deposit will be against. + # + # @param amount [Integer] The check amount in cents. + # + # @param check_number [String] The check number on the check to be deposited. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::InboundCheckDeposit] diff --git a/lib/increase/resources/simulations/inbound_funds_holds.rb b/lib/increase/resources/simulations/inbound_funds_holds.rb index a1a5fdde5..3d2420c51 100644 --- a/lib/increase/resources/simulations/inbound_funds_holds.rb +++ b/lib/increase/resources/simulations/inbound_funds_holds.rb @@ -9,7 +9,8 @@ class InboundFundsHolds # # @overload release(inbound_funds_hold_id, request_options: {}) # - # @param inbound_funds_hold_id [String] + # @param inbound_funds_hold_id [String] The inbound funds hold to release. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Simulations::InboundFundsHoldReleaseResponse] diff --git a/lib/increase/resources/simulations/inbound_mail_items.rb b/lib/increase/resources/simulations/inbound_mail_items.rb index f84a630e3..6f6793515 100755 --- a/lib/increase/resources/simulations/inbound_mail_items.rb +++ b/lib/increase/resources/simulations/inbound_mail_items.rb @@ -4,14 +4,21 @@ module Increase module Resources class Simulations class InboundMailItems + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::InboundMailItemCreateParams} for more details. + # # Simulates an inbound mail item to your account, as if someone had mailed a # physical check to one of your account's Lockboxes. # # @overload create(amount:, lockbox_id:, contents_file_id: nil, request_options: {}) # - # @param amount [Integer] - # @param lockbox_id [String] - # @param contents_file_id [String] + # @param amount [Integer] The amount of the check to be simulated, in cents. + # + # @param lockbox_id [String] The identifier of the Lockbox to simulate inbound mail to. + # + # @param contents_file_id [String] The file containing the PDF contents. If not present, a default check image file + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::InboundMailItem] diff --git a/lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb b/lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb index 992bc5a04..2f7417b25 100644 --- a/lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb +++ b/lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb @@ -4,19 +4,32 @@ module Increase module Resources class Simulations class InboundRealTimePaymentsTransfers + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::InboundRealTimePaymentsTransferCreateParams} for + # more details. + # # Simulates an # [Inbound Real-Time Payments Transfer](#inbound-real-time-payments-transfers) to # your account. Real-Time Payments are a beta feature. # # @overload create(account_number_id:, amount:, debtor_account_number: nil, debtor_name: nil, debtor_routing_number: nil, remittance_information: nil, request_for_payment_id: nil, request_options: {}) # - # @param account_number_id [String] - # @param amount [Integer] - # @param debtor_account_number [String] - # @param debtor_name [String] - # @param debtor_routing_number [String] - # @param remittance_information [String] - # @param request_for_payment_id [String] + # @param account_number_id [String] The identifier of the Account Number the inbound Real-Time Payments Transfer is + # ... + # + # @param amount [Integer] The transfer amount in USD cents. Must be positive. + # + # @param debtor_account_number [String] The account number of the account that sent the transfer. + # + # @param debtor_name [String] The name provided by the sender of the transfer. + # + # @param debtor_routing_number [String] The routing number of the account that sent the transfer. + # + # @param remittance_information [String] Additional information included with the transfer. + # + # @param request_for_payment_id [String] The identifier of a pending Request for Payment that this transfer will fulfill. + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::InboundRealTimePaymentsTransfer] diff --git a/lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb b/lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb index 2e325ccbe..4efccff75 100644 --- a/lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb +++ b/lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb @@ -4,31 +4,61 @@ module Increase module Resources class Simulations class InboundWireDrawdownRequests + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::InboundWireDrawdownRequestCreateParams} for more + # details. + # # Simulates receiving an # [Inbound Wire Drawdown Request](#inbound-wire-drawdown-requests). # # @overload create(amount:, beneficiary_account_number:, beneficiary_routing_number:, currency:, message_to_recipient:, originator_account_number:, originator_routing_number:, recipient_account_number_id:, beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, beneficiary_name: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, originator_to_beneficiary_information_line1: nil, originator_to_beneficiary_information_line2: nil, originator_to_beneficiary_information_line3: nil, originator_to_beneficiary_information_line4: nil, request_options: {}) # - # @param amount [Integer] - # @param beneficiary_account_number [String] - # @param beneficiary_routing_number [String] - # @param currency [String] - # @param message_to_recipient [String] - # @param originator_account_number [String] - # @param originator_routing_number [String] - # @param recipient_account_number_id [String] - # @param beneficiary_address_line1 [String] - # @param beneficiary_address_line2 [String] - # @param beneficiary_address_line3 [String] - # @param beneficiary_name [String] - # @param originator_address_line1 [String] - # @param originator_address_line2 [String] - # @param originator_address_line3 [String] - # @param originator_name [String] - # @param originator_to_beneficiary_information_line1 [String] - # @param originator_to_beneficiary_information_line2 [String] - # @param originator_to_beneficiary_information_line3 [String] - # @param originator_to_beneficiary_information_line4 [String] + # @param amount [Integer] The amount being requested in cents. + # + # @param beneficiary_account_number [String] The drawdown request's beneficiary's account number. + # + # @param beneficiary_routing_number [String] The drawdown request's beneficiary's routing number. + # + # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being + # ... + # + # @param message_to_recipient [String] A message from the drawdown request's originator. + # + # @param originator_account_number [String] The drawdown request's originator's account number. + # + # @param originator_routing_number [String] The drawdown request's originator's routing number. + # + # @param recipient_account_number_id [String] The Account Number to which the recipient of this request is being requested to + # ... + # + # @param beneficiary_address_line1 [String] Line 1 of the drawdown request's beneficiary's address. + # + # @param beneficiary_address_line2 [String] Line 2 of the drawdown request's beneficiary's address. + # + # @param beneficiary_address_line3 [String] Line 3 of the drawdown request's beneficiary's address. + # + # @param beneficiary_name [String] The drawdown request's beneficiary's name. + # + # @param originator_address_line1 [String] Line 1 of the drawdown request's originator's address. + # + # @param originator_address_line2 [String] Line 2 of the drawdown request's originator's address. + # + # @param originator_address_line3 [String] Line 3 of the drawdown request's originator's address. + # + # @param originator_name [String] The drawdown request's originator's name. + # + # @param originator_to_beneficiary_information_line1 [String] Line 1 of the information conveyed from the originator of the message to the ben + # ... + # + # @param originator_to_beneficiary_information_line2 [String] Line 2 of the information conveyed from the originator of the message to the ben + # ... + # + # @param originator_to_beneficiary_information_line3 [String] Line 3 of the information conveyed from the originator of the message to the ben + # ... + # + # @param originator_to_beneficiary_information_line4 [String] Line 4 of the information conveyed from the originator of the message to the ben + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::InboundWireDrawdownRequest] diff --git a/lib/increase/resources/simulations/inbound_wire_transfers.rb b/lib/increase/resources/simulations/inbound_wire_transfers.rb index 6ca0bc8ec..9d7ad1133 100644 --- a/lib/increase/resources/simulations/inbound_wire_transfers.rb +++ b/lib/increase/resources/simulations/inbound_wire_transfers.rb @@ -4,27 +4,63 @@ module Increase module Resources class Simulations class InboundWireTransfers + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::InboundWireTransferCreateParams} for more + # details. + # # Simulates an [Inbound Wire Transfer](#inbound-wire-transfers) to your account. # # @overload create(account_number_id:, amount:, beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, beneficiary_name: nil, beneficiary_reference: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, originator_routing_number: nil, originator_to_beneficiary_information_line1: nil, originator_to_beneficiary_information_line2: nil, originator_to_beneficiary_information_line3: nil, originator_to_beneficiary_information_line4: nil, sender_reference: nil, request_options: {}) # - # @param account_number_id [String] - # @param amount [Integer] - # @param beneficiary_address_line1 [String] - # @param beneficiary_address_line2 [String] - # @param beneficiary_address_line3 [String] - # @param beneficiary_name [String] - # @param beneficiary_reference [String] - # @param originator_address_line1 [String] - # @param originator_address_line2 [String] - # @param originator_address_line3 [String] - # @param originator_name [String] - # @param originator_routing_number [String] - # @param originator_to_beneficiary_information_line1 [String] - # @param originator_to_beneficiary_information_line2 [String] - # @param originator_to_beneficiary_information_line3 [String] - # @param originator_to_beneficiary_information_line4 [String] - # @param sender_reference [String] + # @param account_number_id [String] The identifier of the Account Number the inbound Wire Transfer is for. + # + # @param amount [Integer] The transfer amount in cents. Must be positive. + # + # @param beneficiary_address_line1 [String] The sending bank will set beneficiary_address_line1 in production. You can simul + # ... + # + # @param beneficiary_address_line2 [String] The sending bank will set beneficiary_address_line2 in production. You can simul + # ... + # + # @param beneficiary_address_line3 [String] The sending bank will set beneficiary_address_line3 in production. You can simul + # ... + # + # @param beneficiary_name [String] The sending bank will set beneficiary_name in production. You can simulate any v + # ... + # + # @param beneficiary_reference [String] The sending bank will set beneficiary_reference in production. You can simulate + # ... + # + # @param originator_address_line1 [String] The sending bank will set originator_address_line1 in production. You can simula + # ... + # + # @param originator_address_line2 [String] The sending bank will set originator_address_line2 in production. You can simula + # ... + # + # @param originator_address_line3 [String] The sending bank will set originator_address_line3 in production. You can simula + # ... + # + # @param originator_name [String] The sending bank will set originator_name in production. You can simulate any va + # ... + # + # @param originator_routing_number [String] The sending bank will set originator_routing_number in production. You can simul + # ... + # + # @param originator_to_beneficiary_information_line1 [String] The sending bank will set originator_to_beneficiary_information_line1 in product + # ... + # + # @param originator_to_beneficiary_information_line2 [String] The sending bank will set originator_to_beneficiary_information_line2 in product + # ... + # + # @param originator_to_beneficiary_information_line3 [String] The sending bank will set originator_to_beneficiary_information_line3 in product + # ... + # + # @param originator_to_beneficiary_information_line4 [String] The sending bank will set originator_to_beneficiary_information_line4 in product + # ... + # + # @param sender_reference [String] The sending bank will set sender_reference in production. You can simulate any v + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::InboundWireTransfer] diff --git a/lib/increase/resources/simulations/interest_payments.rb b/lib/increase/resources/simulations/interest_payments.rb index ced32aae8..bd07f7760 100644 --- a/lib/increase/resources/simulations/interest_payments.rb +++ b/lib/increase/resources/simulations/interest_payments.rb @@ -4,16 +4,26 @@ module Increase module Resources class Simulations class InterestPayments + # Some parameter documentations has been truncated, see + # {Increase::Models::Simulations::InterestPaymentCreateParams} for more details. + # # Simulates an interest payment to your account. In production, this happens # automatically on the first of each month. # # @overload create(account_id:, amount:, accrued_on_account_id: nil, period_end: nil, period_start: nil, request_options: {}) # - # @param account_id [String] - # @param amount [Integer] - # @param accrued_on_account_id [String] - # @param period_end [Time] - # @param period_start [Time] + # @param account_id [String] The identifier of the Account the Interest Payment should be paid to is for. + # + # @param amount [Integer] The interest amount in cents. Must be positive. + # + # @param accrued_on_account_id [String] The identifier of the Account the Interest accrued on. Defaults to `account_id`. + # ... + # + # @param period_end [Time] The end of the interest period. If not provided, defaults to the current time. + # + # @param period_start [Time] The start of the interest period. If not provided, defaults to the current time. + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Transaction] diff --git a/lib/increase/resources/simulations/physical_cards.rb b/lib/increase/resources/simulations/physical_cards.rb index 33ab16f67..a346e6c52 100644 --- a/lib/increase/resources/simulations/physical_cards.rb +++ b/lib/increase/resources/simulations/physical_cards.rb @@ -10,8 +10,10 @@ class PhysicalCards # # @overload advance_shipment(physical_card_id, shipment_status:, request_options: {}) # - # @param physical_card_id [String] - # @param shipment_status [Symbol, Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus] + # @param physical_card_id [String] The Physical Card you would like to action. + # + # @param shipment_status [Symbol, Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus] The shipment status to move the Physical Card to. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::PhysicalCard] diff --git a/lib/increase/resources/simulations/programs.rb b/lib/increase/resources/simulations/programs.rb index 5af8cfd09..2982cbfd4 100644 --- a/lib/increase/resources/simulations/programs.rb +++ b/lib/increase/resources/simulations/programs.rb @@ -11,7 +11,8 @@ class Programs # # @overload create(name:, request_options: {}) # - # @param name [String] + # @param name [String] The name of the program being added. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Program] diff --git a/lib/increase/resources/simulations/real_time_payments_transfers.rb b/lib/increase/resources/simulations/real_time_payments_transfers.rb index b6267c919..bef33590e 100644 --- a/lib/increase/resources/simulations/real_time_payments_transfers.rb +++ b/lib/increase/resources/simulations/real_time_payments_transfers.rb @@ -11,8 +11,10 @@ class RealTimePaymentsTransfers # # @overload complete(real_time_payments_transfer_id, rejection: nil, request_options: {}) # - # @param real_time_payments_transfer_id [String] - # @param rejection [Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection] + # @param real_time_payments_transfer_id [String] The identifier of the Real-Time Payments Transfer you wish to complete. + # + # @param rejection [Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection] If set, the simulation will reject the transfer. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::RealTimePaymentsTransfer] diff --git a/lib/increase/resources/simulations/wire_transfers.rb b/lib/increase/resources/simulations/wire_transfers.rb index 02dfe1cdc..3f4081679 100644 --- a/lib/increase/resources/simulations/wire_transfers.rb +++ b/lib/increase/resources/simulations/wire_transfers.rb @@ -11,7 +11,8 @@ class WireTransfers # # @overload reverse(wire_transfer_id, request_options: {}) # - # @param wire_transfer_id [String] + # @param wire_transfer_id [String] The identifier of the Wire Transfer you wish to reverse. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::WireTransfer] @@ -32,7 +33,8 @@ def reverse(wire_transfer_id, params = {}) # # @overload submit(wire_transfer_id, request_options: {}) # - # @param wire_transfer_id [String] + # @param wire_transfer_id [String] The identifier of the Wire Transfer you wish to submit. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::WireTransfer] diff --git a/lib/increase/resources/supplemental_documents.rb b/lib/increase/resources/supplemental_documents.rb index 7aafc8686..884ff8f6c 100644 --- a/lib/increase/resources/supplemental_documents.rb +++ b/lib/increase/resources/supplemental_documents.rb @@ -7,8 +7,10 @@ class SupplementalDocuments # # @overload create(entity_id:, file_id:, request_options: {}) # - # @param entity_id [String] - # @param file_id [String] + # @param entity_id [String] The identifier of the Entity to associate with the supplemental document. + # + # @param file_id [String] The identifier of the File containing the document. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::EntitySupplementalDocument] @@ -25,14 +27,23 @@ def create(params) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::SupplementalDocumentListParams} for more details. + # # List Entity Supplemental Document Submissions # # @overload list(entity_id:, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) # - # @param entity_id [String] - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # @param entity_id [String] The identifier of the Entity to list supplemental documents for. + # + # @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}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/transactions.rb b/lib/increase/resources/transactions.rb index 03ac75f0d..2464501c3 100644 --- a/lib/increase/resources/transactions.rb +++ b/lib/increase/resources/transactions.rb @@ -7,7 +7,8 @@ class Transactions # # @overload retrieve(transaction_id, request_options: {}) # - # @param transaction_id [String] + # @param transaction_id [String] The identifier of the Transaction to retrieve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::Transaction] @@ -22,16 +23,27 @@ def retrieve(transaction_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::TransactionListParams} for more details. + # # List Transactions # # @overload list(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, request_options: {}) # - # @param account_id [String] + # @param account_id [String] Filter Transactions for those belonging to the specified Account. + # # @param category [Increase::Models::TransactionListParams::Category] + # # @param created_at [Increase::Models::TransactionListParams::CreatedAt] - # @param cursor [String] - # @param limit [Integer] - # @param route_id [String] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob + # ... + # + # @param route_id [String] Filter Transactions for those belonging to the specified route. This could be a + # ... + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/wire_drawdown_requests.rb b/lib/increase/resources/wire_drawdown_requests.rb index 578e571df..44ca2eff5 100644 --- a/lib/increase/resources/wire_drawdown_requests.rb +++ b/lib/increase/resources/wire_drawdown_requests.rb @@ -3,23 +3,43 @@ module Increase module Resources class WireDrawdownRequests + # Some parameter documentations has been truncated, see + # {Increase::Models::WireDrawdownRequestCreateParams} for more details. + # # Create a Wire Drawdown Request # # @overload create(account_number_id:, amount:, message_to_recipient:, recipient_account_number:, recipient_name:, recipient_routing_number:, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, recipient_address_line1: nil, recipient_address_line2: nil, recipient_address_line3: nil, request_options: {}) # - # @param account_number_id [String] - # @param amount [Integer] - # @param message_to_recipient [String] - # @param recipient_account_number [String] - # @param recipient_name [String] - # @param recipient_routing_number [String] - # @param originator_address_line1 [String] - # @param originator_address_line2 [String] - # @param originator_address_line3 [String] - # @param originator_name [String] - # @param recipient_address_line1 [String] - # @param recipient_address_line2 [String] - # @param recipient_address_line3 [String] + # @param account_number_id [String] The Account Number to which the recipient should send funds. + # + # @param amount [Integer] The amount requested from the recipient, in USD cents. + # + # @param message_to_recipient [String] A message the recipient will see as part of the request. + # + # @param recipient_account_number [String] The drawdown request's recipient's account number. + # + # @param recipient_name [String] The drawdown request's recipient's name. + # + # @param recipient_routing_number [String] The drawdown request's recipient's routing number. + # + # @param originator_address_line1 [String] The drawdown request originator's address line 1. This is only necessary if you' + # ... + # + # @param originator_address_line2 [String] The drawdown request originator's address line 2. This is only necessary if you' + # ... + # + # @param originator_address_line3 [String] The drawdown request originator's address line 3. This is only necessary if you' + # ... + # + # @param originator_name [String] The drawdown request originator's name. This is only necessary if you're request + # ... + # + # @param recipient_address_line1 [String] Line 1 of the drawdown request's recipient's address. + # + # @param recipient_address_line2 [String] Line 2 of the drawdown request's recipient's address. + # + # @param recipient_address_line3 [String] Line 3 of the drawdown request's recipient's address. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::WireDrawdownRequest] @@ -40,7 +60,8 @@ def create(params) # # @overload retrieve(wire_drawdown_request_id, request_options: {}) # - # @param wire_drawdown_request_id [String] + # @param wire_drawdown_request_id [String] The identifier of the Wire Drawdown Request to retrieve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::WireDrawdownRequest] @@ -55,14 +76,23 @@ def retrieve(wire_drawdown_request_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::WireDrawdownRequestListParams} for more details. + # # List Wire Drawdown Requests # # @overload list(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) # - # @param cursor [String] - # @param idempotency_key [String] - # @param limit [Integer] + # @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::WireDrawdownRequestListParams::Status] + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Internal::Page] diff --git a/lib/increase/resources/wire_transfers.rb b/lib/increase/resources/wire_transfers.rb index 411fa3f6b..e3d6d11ac 100644 --- a/lib/increase/resources/wire_transfers.rb +++ b/lib/increase/resources/wire_transfers.rb @@ -3,26 +3,51 @@ module Increase module Resources class WireTransfers + # Some parameter documentations has been truncated, see + # {Increase::Models::WireTransferCreateParams} for more details. + # # Create a Wire Transfer # # @overload create(account_id:, amount:, beneficiary_name:, message_to_recipient:, account_number: nil, beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, external_account_id: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, require_approval: nil, routing_number: nil, source_account_number_id: nil, request_options: {}) # - # @param account_id [String] - # @param amount [Integer] - # @param beneficiary_name [String] - # @param message_to_recipient [String] - # @param account_number [String] - # @param beneficiary_address_line1 [String] - # @param beneficiary_address_line2 [String] - # @param beneficiary_address_line3 [String] - # @param external_account_id [String] - # @param originator_address_line1 [String] - # @param originator_address_line2 [String] - # @param originator_address_line3 [String] - # @param originator_name [String] - # @param require_approval [Boolean] - # @param routing_number [String] - # @param source_account_number_id [String] + # @param account_id [String] The identifier for the account that will send the transfer. + # + # @param amount [Integer] The transfer amount in USD cents. + # + # @param beneficiary_name [String] The beneficiary's name. + # + # @param message_to_recipient [String] The message that will show on the recipient's bank statement. + # + # @param account_number [String] The account number for the destination account. + # + # @param beneficiary_address_line1 [String] The beneficiary's address line 1. + # + # @param beneficiary_address_line2 [String] The beneficiary's address line 2. + # + # @param beneficiary_address_line3 [String] The beneficiary's address line 3. + # + # @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr + # ... + # + # @param originator_address_line1 [String] The originator's address line 1. This is only necessary if you're transferring f + # ... + # + # @param originator_address_line2 [String] The originator's address line 2. This is only necessary if you're transferring f + # ... + # + # @param originator_address_line3 [String] The originator's address line 3. This is only necessary if you're transferring f + # ... + # + # @param originator_name [String] The originator's name. This is only necessary if you're transferring from a comm + # ... + # + # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API. + # + # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des + # ... + # + # @param source_account_number_id [String] The ID of an Account Number that will be passed to the wire's recipient + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::WireTransfer] @@ -43,7 +68,8 @@ def create(params) # # @overload retrieve(wire_transfer_id, request_options: {}) # - # @param wire_transfer_id [String] + # @param wire_transfer_id [String] The identifier of the Wire Transfer. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::WireTransfer] @@ -58,16 +84,27 @@ def retrieve(wire_transfer_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Increase::Models::WireTransferListParams} for more details. + # # List Wire Transfers # # @overload list(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, request_options: {}) # - # @param account_id [String] + # @param account_id [String] Filter Wire Transfers to those belonging to the specified Account. + # # @param created_at [Increase::Models::WireTransferListParams::CreatedAt] - # @param cursor [String] - # @param external_account_id [String] - # @param idempotency_key [String] - # @param limit [Integer] + # + # @param cursor [String] Return the page of entries after this one. + # + # @param external_account_id [String] Filter Wire Transfers to those made to the specified External Account. + # + # @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] @@ -89,7 +126,8 @@ def list(params = {}) # # @overload approve(wire_transfer_id, request_options: {}) # - # @param wire_transfer_id [String] + # @param wire_transfer_id [String] The identifier of the Wire Transfer to approve. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::WireTransfer] @@ -108,7 +146,8 @@ def approve(wire_transfer_id, params = {}) # # @overload cancel(wire_transfer_id, request_options: {}) # - # @param wire_transfer_id [String] + # @param wire_transfer_id [String] The identifier of the pending Wire Transfer to cancel. + # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Increase::Models::WireTransfer] diff --git a/rbi/lib/increase/models/account.rbi b/rbi/lib/increase/models/account.rbi index 8be82ee07..80ce3bd36 100644 --- a/rbi/lib/increase/models/account.rbi +++ b/rbi/lib/increase/models/account.rbi @@ -98,20 +98,47 @@ module Increase .returns(T.attached_class) end def self.new( + # The Account identifier. id:, + # The bank the Account is with. bank:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account + # was closed. closed_at:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account + # was created. created_at:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account + # currency. currency:, + # The identifier for the Entity the Account belongs to. entity_id:, + # 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). idempotency_key:, + # The identifier of an Entity that, while not owning the Account, is associated + # with its activity. informational_entity_id:, + # The interest accrued but not yet paid, expressed as a string containing a + # floating-point value. interest_accrued:, + # The latest [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which + # interest was accrued. interest_accrued_at:, + # The Interest Rate currently being earned on the account, as a string containing + # a decimal number. For example, a 1% interest rate would be represented as + # "0.01". interest_rate:, + # The name you choose for the Account. name:, + # The identifier of the Program determining the compliance and commercial terms of + # this Account. program_id:, + # The status of the Account. status:, + # A constant representing the object's type. For this resource it will always be + # `account`. type: ); end sig do diff --git a/rbi/lib/increase/models/account_balance_params.rbi b/rbi/lib/increase/models/account_balance_params.rbi index 61d22e48b..9a1d2ba84 100644 --- a/rbi/lib/increase/models/account_balance_params.rbi +++ b/rbi/lib/increase/models/account_balance_params.rbi @@ -17,8 +17,11 @@ module Increase params(at_time: Time, request_options: T.any(Increase::RequestOptions, Increase::Internal::AnyHash)) .returns(T.attached_class) end - def self.new(at_time: nil, request_options: {}); end - + def self.new( + # The moment to query the balance at. If not set, returns the current balances. + at_time: nil, + request_options: {} + ); end sig { override.returns({at_time: Time, request_options: Increase::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/increase/models/account_create_params.rbi b/rbi/lib/increase/models/account_create_params.rbi index a06a2a0d5..f257390c6 100644 --- a/rbi/lib/increase/models/account_create_params.rbi +++ b/rbi/lib/increase/models/account_create_params.rbi @@ -43,9 +43,19 @@ module Increase ) .returns(T.attached_class) end - def self.new(name:, entity_id: nil, informational_entity_id: nil, program_id: nil, request_options: {}) - end - + def self.new( + # The name you choose for the Account. + name:, + # The identifier for the Entity that will own the Account. + entity_id: nil, + # The identifier of an Entity that, while not owning the Account, is associated + # with its activity. Its relationship to your group must be `informational`. + informational_entity_id: nil, + # The identifier for the Program that this Account falls under. Required if you + # operate more than one Program. + program_id: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/account_list_params.rbi b/rbi/lib/increase/models/account_list_params.rbi index 74e48e5b6..a5631ed52 100644 --- a/rbi/lib/increase/models/account_list_params.rbi +++ b/rbi/lib/increase/models/account_list_params.rbi @@ -82,11 +82,21 @@ module Increase end def self.new( created_at: nil, + # Return the page of entries after this one. cursor: nil, + # Filter Accounts for those belonging to the specified Entity. entity_id: nil, + # 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). idempotency_key: nil, + # Filter Accounts for those belonging to the specified Entity as informational. informational_entity_id: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, + # Filter Accounts for those in a specific Program. program_id: nil, status: nil, request_options: {} @@ -145,8 +155,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end @@ -161,8 +183,11 @@ module Increase attr_writer :in_ sig { params(in_: T::Array[Increase::Models::AccountListParams::Status::In::OrSymbol]).returns(T.attached_class) } - def self.new(in_: nil); end - + def self.new( + # Filter Accounts for those with the specified status. For GET requests, this + # should be encoded as a comma-delimited string, such as `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::AccountListParams::Status::In::OrSymbol]}) } def to_hash; end diff --git a/rbi/lib/increase/models/account_number.rbi b/rbi/lib/increase/models/account_number.rbi index bc217afa6..8962c2a7b 100644 --- a/rbi/lib/increase/models/account_number.rbi +++ b/rbi/lib/increase/models/account_number.rbi @@ -83,16 +83,32 @@ module Increase .returns(T.attached_class) end def self.new( + # The Account Number identifier. id:, + # The identifier for the account this Account Number belongs to. account_id:, + # The account number. account_number:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account + # Number was created. created_at:, + # 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). idempotency_key:, + # Properties related to how this Account Number handles inbound ACH transfers. inbound_ach:, + # Properties related to how this Account Number should handle inbound check + # withdrawals. inbound_checks:, + # The name you choose for the Account Number. name:, + # The American Bankers' Association (ABA) Routing Transit Number (RTN). routing_number:, + # This indicates if payments can be made to the Account Number. status:, + # A constant representing the object's type. For this resource it will always be + # `account_number`. type: ); end sig do @@ -126,8 +142,11 @@ module Increase params(debit_status: Increase::Models::AccountNumber::InboundACH::DebitStatus::OrSymbol) .returns(T.attached_class) end - def self.new(debit_status:); end - + def self.new( + # Whether ACH debits are allowed against this Account Number. Note that they will + # still be declined if this is `allowed` if the Account Number is not active. + debit_status: + ); end sig { override.returns({debit_status: Increase::Models::AccountNumber::InboundACH::DebitStatus::TaggedSymbol}) } def to_hash; end @@ -158,8 +177,10 @@ module Increase # Properties related to how this Account Number should handle inbound check # withdrawals. sig { params(status: Increase::Models::AccountNumber::InboundChecks::Status::OrSymbol).returns(T.attached_class) } - def self.new(status:); end - + def self.new( + # How Increase should process checks with this account number printed on them. + status: + ); end sig { override.returns({status: Increase::Models::AccountNumber::InboundChecks::Status::TaggedSymbol}) } def to_hash; end diff --git a/rbi/lib/increase/models/account_number_create_params.rbi b/rbi/lib/increase/models/account_number_create_params.rbi index 75c7b6faa..63c407875 100644 --- a/rbi/lib/increase/models/account_number_create_params.rbi +++ b/rbi/lib/increase/models/account_number_create_params.rbi @@ -49,8 +49,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(account_id:, name:, inbound_ach: nil, inbound_checks: nil, request_options: {}); end - + def self.new( + # The Account the Account Number should belong to. + account_id:, + # The name you choose for the Account Number. + name:, + # Options related to how this Account Number should handle inbound ACH transfers. + inbound_ach: nil, + # Options related to how this Account Number should handle inbound check + # withdrawals. + inbound_checks: nil, + request_options: {} + ); end sig do override .returns( @@ -77,8 +87,12 @@ module Increase params(debit_status: Increase::Models::AccountNumberCreateParams::InboundACH::DebitStatus::OrSymbol) .returns(T.attached_class) end - def self.new(debit_status:); end - + def self.new( + # Whether ACH debits are allowed against this Account Number. Note that ACH debits + # will be declined if this is `allowed` but the Account Number is not active. If + # you do not specify this field, the default is `allowed`. + debit_status: + ); end sig do override .returns({debit_status: Increase::Models::AccountNumberCreateParams::InboundACH::DebitStatus::OrSymbol}) @@ -123,8 +137,11 @@ module Increase params(status: Increase::Models::AccountNumberCreateParams::InboundChecks::Status::OrSymbol) .returns(T.attached_class) end - def self.new(status:); end - + def self.new( + # How Increase should process checks with this account number printed on them. If + # you do not specify this field, the default is `check_transfers_only`. + status: + ); end sig { override.returns({status: Increase::Models::AccountNumberCreateParams::InboundChecks::Status::OrSymbol}) } def to_hash; end diff --git a/rbi/lib/increase/models/account_number_list_params.rbi b/rbi/lib/increase/models/account_number_list_params.rbi index b38211a3c..902f361c8 100644 --- a/rbi/lib/increase/models/account_number_list_params.rbi +++ b/rbi/lib/increase/models/account_number_list_params.rbi @@ -80,11 +80,19 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter Account Numbers to those belonging to the specified Account. account_id: nil, ach_debit_status: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # 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). idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, status: nil, request_options: {} @@ -119,8 +127,11 @@ module Increase params(in_: T::Array[Increase::Models::AccountNumberListParams::ACHDebitStatus::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # The ACH Debit status to retrieve Account Numbers for. For GET requests, this + # should be encoded as a comma-delimited string, such as `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::AccountNumberListParams::ACHDebitStatus::In::OrSymbol]}) } def to_hash; end @@ -178,8 +189,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end @@ -197,8 +220,11 @@ module Increase params(in_: T::Array[Increase::Models::AccountNumberListParams::Status::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # The status to retrieve Account Numbers for. For GET requests, this should be + # encoded as a comma-delimited string, such as `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::AccountNumberListParams::Status::In::OrSymbol]}) } def to_hash; end diff --git a/rbi/lib/increase/models/account_number_update_params.rbi b/rbi/lib/increase/models/account_number_update_params.rbi index 0ad23df6d..27071a281 100644 --- a/rbi/lib/increase/models/account_number_update_params.rbi +++ b/rbi/lib/increase/models/account_number_update_params.rbi @@ -55,8 +55,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(inbound_ach: nil, inbound_checks: nil, name: nil, status: nil, request_options: {}); end - + def self.new( + # Options related to how this Account Number handles inbound ACH transfers. + inbound_ach: nil, + # Options related to how this Account Number should handle inbound check + # withdrawals. + inbound_checks: nil, + # The name you choose for the Account Number. + name: nil, + # This indicates if transfers can be made to the Account Number. + status: nil, + request_options: {} + ); end sig do override .returns( @@ -85,8 +95,11 @@ module Increase params(debit_status: Increase::Models::AccountNumberUpdateParams::InboundACH::DebitStatus::OrSymbol) .returns(T.attached_class) end - def self.new(debit_status: nil); end - + def self.new( + # Whether ACH debits are allowed against this Account Number. Note that ACH debits + # will be declined if this is `allowed` but the Account Number is not active. + debit_status: nil + ); end sig do override .returns({debit_status: Increase::Models::AccountNumberUpdateParams::InboundACH::DebitStatus::OrSymbol}) @@ -129,8 +142,10 @@ module Increase params(status: Increase::Models::AccountNumberUpdateParams::InboundChecks::Status::OrSymbol) .returns(T.attached_class) end - def self.new(status:); end - + def self.new( + # How Increase should process checks with this account number printed on them. + status: + ); end sig { override.returns({status: Increase::Models::AccountNumberUpdateParams::InboundChecks::Status::OrSymbol}) } def to_hash; end diff --git a/rbi/lib/increase/models/account_statement.rbi b/rbi/lib/increase/models/account_statement.rbi index dde67a9fc..8c948832f 100644 --- a/rbi/lib/increase/models/account_statement.rbi +++ b/rbi/lib/increase/models/account_statement.rbi @@ -61,14 +61,27 @@ module Increase .returns(T.attached_class) end def self.new( + # The Account Statement identifier. id:, + # The identifier for the Account this Account Statement belongs to. account_id:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account + # Statement was created. created_at:, + # The Account's balance at the start of its statement period. ending_balance:, + # The identifier of the File containing a PDF of the statement. file_id:, + # The Account's balance at the start of its statement period. starting_balance:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end + # of the period the Account Statement covers. statement_period_end:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the + # start of the period the Account Statement covers. statement_period_start:, + # A constant representing the object's type. For this resource it will always be + # `account_statement`. type: ); end sig do diff --git a/rbi/lib/increase/models/account_statement_list_params.rbi b/rbi/lib/increase/models/account_statement_list_params.rbi index 0e852c7a6..c1f32495b 100644 --- a/rbi/lib/increase/models/account_statement_list_params.rbi +++ b/rbi/lib/increase/models/account_statement_list_params.rbi @@ -50,14 +50,16 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter Account Statements to those belonging to the specified Account. account_id: nil, + # Return the page of entries after this one. cursor: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, statement_period_start: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -108,8 +110,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end diff --git a/rbi/lib/increase/models/account_transfer.rbi b/rbi/lib/increase/models/account_transfer.rbi index fe1fc3b08..42e1910ba 100644 --- a/rbi/lib/increase/models/account_transfer.rbi +++ b/rbi/lib/increase/models/account_transfer.rbi @@ -130,22 +130,50 @@ module Increase .returns(T.attached_class) end def self.new( + # The account transfer's identifier. id:, + # The Account to which the transfer belongs. account_id:, + # The transfer amount in the minor unit of the destination account currency. For + # dollars, for example, this is cents. amount:, + # If your account requires approvals for transfers and the transfer was approved, + # this will contain details of the approval. approval:, + # If your account requires approvals for transfers and the transfer was not + # approved, this will contain details of the cancellation. cancellation:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the transfer was created. created_at:, + # What object created the transfer, either via the API or the dashboard. created_by:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination + # account currency. currency:, + # The description that will show on the transactions. description:, + # The destination account's identifier. destination_account_id:, + # The ID for the transaction receiving the transfer. destination_transaction_id:, + # 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). idempotency_key:, + # The transfer's network. network:, + # The ID for the pending transaction representing the transfer. A pending + # transaction is created when the transfer + # [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) + # by someone else in your organization. pending_transaction_id:, + # The lifecycle status of the transfer. status:, + # The ID for the transaction funding the transfer. transaction_id:, + # A constant representing the object's type. For this resource it will always be + # `account_transfer`. type: ); end sig do @@ -188,8 +216,14 @@ module Increase # If your account requires approvals for transfers and the transfer was approved, # this will contain details of the approval. sig { params(approved_at: Time, approved_by: T.nilable(String)).returns(T.attached_class) } - def self.new(approved_at:, approved_by:); end - + def self.new( + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the transfer was approved. + approved_at:, + # If the Transfer was approved by a user in the dashboard, the email address of + # that user. + approved_by: + ); end sig { override.returns({approved_at: Time, approved_by: T.nilable(String)}) } def to_hash; end end @@ -208,8 +242,14 @@ module Increase # If your account requires approvals for transfers and the transfer was not # approved, this will contain details of the cancellation. sig { params(canceled_at: Time, canceled_by: T.nilable(String)).returns(T.attached_class) } - def self.new(canceled_at:, canceled_by:); end - + def self.new( + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the Transfer was canceled. + canceled_at:, + # If the Transfer was canceled by a user in the dashboard, the email address of + # that user. + canceled_by: + ); end sig { override.returns({canceled_at: Time, canceled_by: T.nilable(String)}) } def to_hash; end end @@ -269,8 +309,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(api_key:, category:, oauth_application:, user:); end - + def self.new( + # If present, details about the API key that created the transfer. + api_key:, + # The type of object that created this transfer. + category:, + # If present, details about the OAuth Application that created the transfer. + oauth_application:, + # If present, details about the User that created the transfer. + user: + ); end sig do override .returns( @@ -291,8 +339,10 @@ module Increase # If present, details about the API key that created the transfer. sig { params(description: T.nilable(String)).returns(T.attached_class) } - def self.new(description:); end - + def self.new( + # The description set for the API key when it was created. + description: + ); end sig { override.returns({description: T.nilable(String)}) } def to_hash; end end @@ -325,8 +375,10 @@ module Increase # If present, details about the OAuth Application that created the transfer. sig { params(name: String).returns(T.attached_class) } - def self.new(name:); end - + def self.new( + # The name of the OAuth Application. + name: + ); end sig { override.returns({name: String}) } def to_hash; end end @@ -338,8 +390,10 @@ module Increase # If present, details about the User that created the transfer. sig { params(email: String).returns(T.attached_class) } - def self.new(email:); end - + def self.new( + # The email address of the User. + email: + ); end sig { override.returns({email: String}) } def to_hash; end end diff --git a/rbi/lib/increase/models/account_transfer_create_params.rbi b/rbi/lib/increase/models/account_transfer_create_params.rbi index 9f92d1999..34030b776 100644 --- a/rbi/lib/increase/models/account_transfer_create_params.rbi +++ b/rbi/lib/increase/models/account_transfer_create_params.rbi @@ -42,15 +42,19 @@ module Increase .returns(T.attached_class) end def self.new( + # The identifier for the account that will send the transfer. account_id:, + # The transfer amount in the minor unit of the account currency. For dollars, for + # example, this is cents. amount:, + # The description you choose to give the transfer. description:, + # The identifier for the account that will receive the transfer. destination_account_id:, + # Whether the transfer requires explicit approval via the dashboard or API. require_approval: nil, request_options: {} - ) - end - + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/account_transfer_list_params.rbi b/rbi/lib/increase/models/account_transfer_list_params.rbi index 56d59581d..de1950efa 100644 --- a/rbi/lib/increase/models/account_transfer_list_params.rbi +++ b/rbi/lib/increase/models/account_transfer_list_params.rbi @@ -61,15 +61,21 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter Account Transfers to those that originated from the specified Account. account_id: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # 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). idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -121,8 +127,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end diff --git a/rbi/lib/increase/models/account_update_params.rbi b/rbi/lib/increase/models/account_update_params.rbi index aec2d0554..013e0a3fa 100644 --- a/rbi/lib/increase/models/account_update_params.rbi +++ b/rbi/lib/increase/models/account_update_params.rbi @@ -17,8 +17,11 @@ module Increase params(name: String, request_options: T.any(Increase::RequestOptions, Increase::Internal::AnyHash)) .returns(T.attached_class) end - def self.new(name: nil, request_options: {}); end - + def self.new( + # The new name of the Account. + name: nil, + request_options: {} + ); end sig { override.returns({name: String, request_options: Increase::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/increase/models/ach_prenotification.rbi b/rbi/lib/increase/models/ach_prenotification.rbi index 964eecb86..755f47bf4 100644 --- a/rbi/lib/increase/models/ach_prenotification.rbi +++ b/rbi/lib/increase/models/ach_prenotification.rbi @@ -104,21 +104,42 @@ module Increase .returns(T.attached_class) end def self.new( + # The ACH Prenotification's identifier. id:, + # The destination account number. account_number:, + # Additional information for the recipient. addendum:, + # The description of the date of the notification. company_descriptive_date:, + # Optional data associated with the notification. company_discretionary_data:, + # The description of the notification. company_entry_description:, + # The name by which you know the company. company_name:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the prenotification was created. created_at:, + # If the notification is for a future credit or debit. credit_debit_indicator:, + # The effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. effective_date:, + # 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). idempotency_key:, + # If the receiving bank notifies that future transfers should use different + # details, this will contain those details. notifications_of_change:, + # If your prenotification is returned, this will contain details of the return. prenotification_return:, + # The American Bankers' Association (ABA) Routing Transit Number (RTN). routing_number:, + # The lifecycle status of the ACH Prenotification. status:, + # A constant representing the object's type. For this resource it will always be + # `ach_prenotification`. type: ); end sig do @@ -190,8 +211,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(change_code:, corrected_data:, created_at:); end - + def self.new( + # The required type of change that is being signaled by the receiving financial + # institution. + change_code:, + # The corrected data that should be used in future ACHs to this account. This may + # contain the suggested new account number or routing number. When the + # `change_code` is `incorrect_transaction_code`, this field contains an integer. + # Numbers starting with a 2 encourage changing the `funding` parameter to + # checking; numbers starting with a 3 encourage changing to savings. + corrected_data:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the notification occurred. + created_at: + ); end sig do override .returns( @@ -372,8 +405,13 @@ module Increase ) .returns(T.attached_class) end - def self.new(created_at:, return_reason_code:); end - + def self.new( + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the Prenotification was returned. + created_at:, + # Why the Prenotification was returned. + return_reason_code: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/ach_prenotification_create_params.rbi b/rbi/lib/increase/models/ach_prenotification_create_params.rbi index 462a8d989..9c246222c 100644 --- a/rbi/lib/increase/models/ach_prenotification_create_params.rbi +++ b/rbi/lib/increase/models/ach_prenotification_create_params.rbi @@ -121,18 +121,34 @@ module Increase .returns(T.attached_class) end def self.new( + # The Increase identifier for the account that will send the transfer. account_id:, + # The account number for the destination account. account_number:, + # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the + # destination account. routing_number:, + # Additional information that will be sent to the recipient. addendum: nil, + # The description of the date of the transfer. company_descriptive_date: nil, + # The data you choose to associate with the transfer. company_discretionary_data: nil, + # The description of the transfer you wish to be shown to the recipient. company_entry_description: nil, + # The name by which the recipient knows you. company_name: nil, + # Whether the Prenotification is for a future debit or credit. credit_debit_indicator: nil, + # The transfer effective date in + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. effective_date: nil, + # Your identifier for the transfer recipient. individual_id: nil, + # The name of the transfer recipient. This value is information and not verified + # by the recipient's bank. individual_name: nil, + # The Standard Entry Class (SEC) code to use for the ACH Prenotification. standard_entry_class_code: nil, request_options: {} ); end diff --git a/rbi/lib/increase/models/ach_prenotification_list_params.rbi b/rbi/lib/increase/models/ach_prenotification_list_params.rbi index 50687fcdb..6c94e0fd4 100644 --- a/rbi/lib/increase/models/ach_prenotification_list_params.rbi +++ b/rbi/lib/increase/models/ach_prenotification_list_params.rbi @@ -52,8 +52,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}); end - + def self.new( + created_at: nil, + # Return the page of entries after this one. + cursor: nil, + # 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). + idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. + limit: nil, + request_options: {} + ); end sig do override .returns( @@ -104,8 +116,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end diff --git a/rbi/lib/increase/models/ach_transfer.rbi b/rbi/lib/increase/models/ach_transfer.rbi index 47fd97578..b25cba21c 100644 --- a/rbi/lib/increase/models/ach_transfer.rbi +++ b/rbi/lib/increase/models/ach_transfer.rbi @@ -287,41 +287,103 @@ module Increase .returns(T.attached_class) end def self.new( + # The ACH transfer's identifier. id:, + # The Account to which the transfer belongs. account_id:, + # The destination account number. account_number:, + # After the transfer is acknowledged by FedACH, this will contain supplemental + # details. The Federal Reserve sends an acknowledgement message for each file that + # Increase submits. acknowledgement:, + # Additional information that will be sent to the recipient. addenda:, + # The transfer amount in USD cents. A positive amount indicates a credit transfer + # pushing funds to the receiving account. A negative amount indicates a debit + # transfer pulling funds from the receiving account. amount:, + # If your account requires approvals for transfers and the transfer was approved, + # this will contain details of the approval. approval:, + # If your account requires approvals for transfers and the transfer was not + # approved, this will contain details of the cancellation. cancellation:, + # The description of the date of the transfer. company_descriptive_date:, + # The data you chose to associate with the transfer. company_discretionary_data:, + # The description of the transfer you set to be shown to the recipient. company_entry_description:, + # The company ID associated with the transfer. company_id:, + # The name by which the recipient knows you. company_name:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the transfer was created. created_at:, + # What object created the transfer, either via the API or the dashboard. created_by:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's + # currency. For ACH transfers this is always equal to `usd`. currency:, + # The type of entity that owns the account to which the ACH Transfer is being + # sent. destination_account_holder:, + # The identifier of the External Account the transfer was made to, if any. external_account_id:, + # The type of the account to which the transfer will be sent. funding:, + # 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). idempotency_key:, + # Increase will sometimes hold the funds for ACH debit transfers. If funds are + # held, this sub-object will contain details of the hold. inbound_funds_hold:, + # Your identifier for the transfer recipient. individual_id:, + # The name of the transfer recipient. This value is information and not verified + # by the recipient's bank. individual_name:, + # The transfer's network. network:, + # If the receiving bank accepts the transfer but notifies that future transfers + # should use different details, this will contain those details. notifications_of_change:, + # The ID for the pending transaction representing the transfer. A pending + # transaction is created when the transfer + # [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) + # by someone else in your organization. pending_transaction_id:, + # Configuration for how the effective date of the transfer will be set. This + # determines same-day vs future-dated settlement timing. If not set, defaults to a + # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes + # must be set. preferred_effective_date:, + # If your transfer is returned, this will contain details of the return. return_:, + # The American Bankers' Association (ABA) Routing Transit Number (RTN). routing_number:, + # A subhash containing information about when and how the transfer settled at the + # Federal Reserve. settlement:, + # The Standard Entry Class (SEC) code to use for the transfer. standard_entry_class_code:, + # The descriptor that will show on the recipient's bank statement. statement_descriptor:, + # The lifecycle status of the transfer. status:, + # After the transfer is submitted to FedACH, this will contain supplemental + # details. Increase batches transfers and submits a file to the Federal Reserve + # roughly every 30 minutes. The Federal Reserve processes ACH transfers during + # weekdays according to their + # [posted schedule](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html). submission:, + # The ID for the transaction funding the transfer. transaction_id:, + # A constant representing the object's type. For this resource it will always be + # `ach_transfer`. type: ); end sig do @@ -379,8 +441,11 @@ module Increase # details. The Federal Reserve sends an acknowledgement message for each file that # Increase submits. sig { params(acknowledged_at: String).returns(T.attached_class) } - def self.new(acknowledged_at:); end - + def self.new( + # When the Federal Reserve acknowledged the submitted file containing this + # transfer. + acknowledged_at: + ); end sig { override.returns({acknowledged_at: String}) } def to_hash; end end @@ -429,8 +494,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(category:, freeform:, payment_order_remittance_advice:); end - + def self.new( + # The type of the resource. We may add additional possible values for this enum + # over time; your application should be able to handle such additions gracefully. + category:, + # Unstructured `payment_related_information` passed through with the transfer. + freeform:, + # Structured ASC X12 820 remittance advice records. Please reach out to + # [support@increase.com](mailto:support@increase.com) for more information. + payment_order_remittance_advice: + ); end sig do override .returns( @@ -477,8 +550,10 @@ module Increase ) .returns(T.attached_class) end - def self.new(entries:); end - + def self.new( + # Each entry represents an addendum sent with the transfer. + entries: + ); end sig { override.returns({entries: T::Array[Increase::Models::ACHTransfer::Addenda::Freeform::Entry]}) } def to_hash; end @@ -488,8 +563,10 @@ module Increase attr_accessor :payment_related_information sig { params(payment_related_information: String).returns(T.attached_class) } - def self.new(payment_related_information:); end - + def self.new( + # The payment related information passed in the addendum. + payment_related_information: + ); end sig { override.returns({payment_related_information: String}) } def to_hash; end end @@ -513,8 +590,10 @@ module Increase ) .returns(T.attached_class) end - def self.new(invoices:); end - + def self.new( + # ASC X12 RMR records for this specific transfer. + invoices: + ); end sig do override .returns( @@ -534,8 +613,13 @@ module Increase attr_accessor :paid_amount sig { params(invoice_number: String, paid_amount: Integer).returns(T.attached_class) } - def self.new(invoice_number:, paid_amount:); end - + def self.new( + # The invoice number for this reference, determined in advance with the receiver. + invoice_number:, + # The amount that was paid for this invoice in the minor unit of its currency. For + # dollars, for example, this is cents. + paid_amount: + ); end sig { override.returns({invoice_number: String, paid_amount: Integer}) } def to_hash; end end @@ -556,8 +640,14 @@ module Increase # If your account requires approvals for transfers and the transfer was approved, # this will contain details of the approval. sig { params(approved_at: Time, approved_by: T.nilable(String)).returns(T.attached_class) } - def self.new(approved_at:, approved_by:); end - + def self.new( + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the transfer was approved. + approved_at:, + # If the Transfer was approved by a user in the dashboard, the email address of + # that user. + approved_by: + ); end sig { override.returns({approved_at: Time, approved_by: T.nilable(String)}) } def to_hash; end end @@ -576,8 +666,14 @@ module Increase # If your account requires approvals for transfers and the transfer was not # approved, this will contain details of the cancellation. sig { params(canceled_at: Time, canceled_by: T.nilable(String)).returns(T.attached_class) } - def self.new(canceled_at:, canceled_by:); end - + def self.new( + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the Transfer was canceled. + canceled_at:, + # If the Transfer was canceled by a user in the dashboard, the email address of + # that user. + canceled_by: + ); end sig { override.returns({canceled_at: Time, canceled_by: T.nilable(String)}) } def to_hash; end end @@ -633,8 +729,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(api_key:, category:, oauth_application:, user:); end - + def self.new( + # If present, details about the API key that created the transfer. + api_key:, + # The type of object that created this transfer. + category:, + # If present, details about the OAuth Application that created the transfer. + oauth_application:, + # If present, details about the User that created the transfer. + user: + ); end sig do override .returns( @@ -655,8 +759,10 @@ module Increase # If present, details about the API key that created the transfer. sig { params(description: T.nilable(String)).returns(T.attached_class) } - def self.new(description:); end - + def self.new( + # The description set for the API key when it was created. + description: + ); end sig { override.returns({description: T.nilable(String)}) } def to_hash; end end @@ -689,8 +795,10 @@ module Increase # If present, details about the OAuth Application that created the transfer. sig { params(name: String).returns(T.attached_class) } - def self.new(name:); end - + def self.new( + # The name of the OAuth Application. + name: + ); end sig { override.returns({name: String}) } def to_hash; end end @@ -702,8 +810,10 @@ module Increase # If present, details about the User that created the transfer. sig { params(email: String).returns(T.attached_class) } - def self.new(email:); end - + def self.new( + # The email address of the User. + email: + ); end sig { override.returns({email: String}) } def to_hash; end end @@ -841,15 +951,30 @@ module Increase .returns(T.attached_class) end def self.new( + # The Inbound Funds Hold identifier. id:, + # The held amount in the minor unit of the account's currency. For dollars, for + # example, this is cents. amount:, + # When the hold will be released automatically. Certain conditions may cause it to + # be released before this time. automatically_releases_at:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold + # was created. created_at:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's + # currency. currency:, + # The ID of the Transaction for which funds were held. held_transaction_id:, + # The ID of the Pending Transaction representing the held funds. pending_transaction_id:, + # When the hold was released (if it has been released). released_at:, + # The status of the hold. status:, + # A constant representing the object's type. For this resource it will always be + # `inbound_funds_hold`. type: ); end sig do @@ -974,8 +1099,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(change_code:, corrected_data:, created_at:); end - + def self.new( + # The required type of change that is being signaled by the receiving financial + # institution. + change_code:, + # The corrected data that should be used in future ACHs to this account. This may + # contain the suggested new account number or routing number. When the + # `change_code` is `incorrect_transaction_code`, this field contains an integer. + # Numbers starting with a 2 encourage changing the `funding` parameter to + # checking; numbers starting with a 3 encourage changing to savings. + corrected_data:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the notification occurred. + created_at: + ); end sig do override .returns( @@ -1160,8 +1297,13 @@ module Increase ) .returns(T.attached_class) end - def self.new(date:, settlement_schedule:); end - + def self.new( + # A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to + # use as the effective date when submitting this transfer. + date:, + # A schedule by which Increase will choose an effective date for the transfer. + settlement_schedule: + ); end sig do override .returns( @@ -1246,15 +1388,24 @@ module Increase .returns(T.attached_class) end def self.new( + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the transfer was created. created_at:, + # The three character ACH return code, in the range R01 to R85. raw_return_reason_code:, + # Why the ACH Transfer was returned. This reason code is sent by the receiving + # bank back to Increase. return_reason_code:, + # A 15 digit number that was generated by the bank that initiated the return. The + # trace number of the return is different than that of the original transfer. ACH + # trace numbers are not unique, but along with the amount and date this number can + # be used to identify the ACH return at the bank that initiated it. trace_number:, + # The identifier of the Transaction associated with this return. transaction_id:, + # The identifier of the ACH Transfer associated with this return. transfer_id: - ) - end - + ); end sig do override .returns( @@ -1678,8 +1829,11 @@ module Increase # A subhash containing information about when and how the transfer settled at the # Federal Reserve. sig { params(settled_at: Time).returns(T.attached_class) } - def self.new(settled_at:); end - + def self.new( + # When the funds for this transfer have settled at the destination bank at the + # Federal Reserve. + settled_at: + ); end sig { override.returns({settled_at: Time}) } def to_hash; end end @@ -1802,10 +1956,27 @@ module Increase .returns(T.attached_class) end def self.new( + # The ACH transfer's effective date as sent to the Federal Reserve. If a specific + # date was configured using `preferred_effective_date`, this will match that + # value. Otherwise, it will be the date selected (following the specified + # settlement schedule) at the time the transfer was submitted. effective_date:, + # When the transfer is expected to settle in the recipient's account. Credits may + # be available sooner, at the receiving banks discretion. The FedACH schedule is + # published + # [here](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html). expected_funds_settlement_at:, + # The settlement schedule the transfer is expected to follow. This expectation + # takes into account the `effective_date`, `submitted_at`, and the amount of the + # transfer. expected_settlement_schedule:, + # When the ACH transfer was sent to FedACH. submitted_at:, + # A 15 digit number recorded in the Nacha file and transmitted to the receiving + # bank. Along with the amount, date, and originating routing number, this can be + # used to identify the ACH transfer at the receiving bank. ACH trace numbers are + # not unique, but are + # [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns). trace_number: ); end sig do diff --git a/rbi/lib/increase/models/ach_transfer_create_params.rbi b/rbi/lib/increase/models/ach_transfer_create_params.rbi index 9e6f24b50..648159eea 100644 --- a/rbi/lib/increase/models/ach_transfer_create_params.rbi +++ b/rbi/lib/increase/models/ach_transfer_create_params.rbi @@ -193,24 +193,62 @@ module Increase .returns(T.attached_class) end def self.new( + # The Increase identifier for the account that will send the transfer. account_id:, + # The transfer amount in USD cents. A positive amount originates a credit transfer + # pushing funds to the receiving account. A negative amount originates a debit + # transfer pulling funds from the receiving account. amount:, + # A description you choose to give the transfer. This will be saved with the + # transfer details, displayed in the dashboard, and returned by the API. If + # `individual_name` and `company_name` are not explicitly set by this API, the + # `statement_descriptor` will be sent in those fields to the receiving bank to + # help the customer recognize the transfer. You are highly encouraged to pass + # `individual_name` and `company_name` instead of relying on this fallback. statement_descriptor:, + # The account number for the destination account. account_number: nil, + # Additional information that will be sent to the recipient. This is included in + # the transfer data sent to the receiving bank. addenda: nil, + # The description of the date of the transfer, usually in the format `YYMMDD`. + # This is included in the transfer data sent to the receiving bank. company_descriptive_date: nil, + # The data you choose to associate with the transfer. This is included in the + # transfer data sent to the receiving bank. company_discretionary_data: nil, + # A description of the transfer. This is included in the transfer data sent to the + # receiving bank. company_entry_description: nil, + # The name by which the recipient knows you. This is included in the transfer data + # sent to the receiving bank. company_name: nil, + # The type of entity that owns the account to which the ACH Transfer is being + # sent. destination_account_holder: nil, + # The ID of an External Account to initiate a transfer to. If this parameter is + # provided, `account_number`, `routing_number`, and `funding` must be absent. external_account_id: nil, + # The type of the account to which the transfer will be sent. funding: nil, + # Your identifier for the transfer recipient. individual_id: nil, + # The name of the transfer recipient. This value is informational and not verified + # by the recipient's bank. individual_name: nil, + # Configuration for how the effective date of the transfer will be set. This + # determines same-day vs future-dated settlement timing. If not set, defaults to a + # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes + # must be set. preferred_effective_date: nil, + # Whether the transfer requires explicit approval via the dashboard or API. require_approval: nil, + # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the + # destination account. routing_number: nil, + # The Standard Entry Class (SEC) code to use for the transfer. standard_entry_class_code: nil, + # The timing of the transaction. transaction_timing: nil, request_options: {} ); end @@ -289,8 +327,15 @@ module Increase ) .returns(T.attached_class) end - def self.new(category:, freeform: nil, payment_order_remittance_advice: nil); end - + def self.new( + # The type of addenda to pass with the transfer. + category:, + # Unstructured `payment_related_information` passed through with the transfer. + freeform: nil, + # Structured ASC X12 820 remittance advice records. Please reach out to + # [support@increase.com](mailto:support@increase.com) for more information. + payment_order_remittance_advice: nil + ); end sig do override .returns( @@ -339,8 +384,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(entries:); end - + def self.new( + # Each entry represents an addendum sent with the transfer. Please reach out to + # [support@increase.com](mailto:support@increase.com) to send more than one + # addendum. + entries: + ); end sig { override.returns({entries: T::Array[Increase::Models::ACHTransferCreateParams::Addenda::Freeform::Entry]}) } def to_hash; end @@ -350,8 +399,10 @@ module Increase attr_accessor :payment_related_information sig { params(payment_related_information: String).returns(T.attached_class) } - def self.new(payment_related_information:); end - + def self.new( + # The payment related information passed in the addendum. + payment_related_information: + ); end sig { override.returns({payment_related_information: String}) } def to_hash; end end @@ -379,8 +430,10 @@ module Increase ) .returns(T.attached_class) end - def self.new(invoices:); end - + def self.new( + # ASC X12 RMR records for this specific transfer. + invoices: + ); end sig do override .returns( @@ -402,8 +455,13 @@ module Increase attr_accessor :paid_amount sig { params(invoice_number: String, paid_amount: Integer).returns(T.attached_class) } - def self.new(invoice_number:, paid_amount:); end - + def self.new( + # The invoice number for this reference, determined in advance with the receiver. + invoice_number:, + # The amount that was paid for this invoice in the minor unit of its currency. For + # dollars, for example, this is cents. + paid_amount: + ); end sig { override.returns({invoice_number: String, paid_amount: Integer}) } def to_hash; end end @@ -491,8 +549,13 @@ module Increase ) .returns(T.attached_class) end - def self.new(date: nil, settlement_schedule: nil); end - + def self.new( + # A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to + # use as the effective date when submitting this transfer. + date: nil, + # A schedule by which Increase will choose an effective date for the transfer. + settlement_schedule: nil + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/ach_transfer_list_params.rbi b/rbi/lib/increase/models/ach_transfer_list_params.rbi index ca8c47c66..390612b21 100644 --- a/rbi/lib/increase/models/ach_transfer_list_params.rbi +++ b/rbi/lib/increase/models/ach_transfer_list_params.rbi @@ -74,11 +74,20 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter ACH Transfers to those that originated from the specified Account. account_id: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # Filter ACH Transfers to those made to the specified External Account. external_account_id: nil, + # 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). idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, status: nil, request_options: {} @@ -136,8 +145,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end @@ -155,8 +176,11 @@ module Increase params(in_: T::Array[Increase::Models::ACHTransferListParams::Status::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # Return results whose value is in the provided list. For GET requests, this + # should be encoded as a comma-delimited string, such as `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::ACHTransferListParams::Status::In::OrSymbol]}) } def to_hash; end diff --git a/rbi/lib/increase/models/balance_lookup.rbi b/rbi/lib/increase/models/balance_lookup.rbi index 70ab299d6..2e2b1c6a3 100644 --- a/rbi/lib/increase/models/balance_lookup.rbi +++ b/rbi/lib/increase/models/balance_lookup.rbi @@ -33,8 +33,19 @@ module Increase ) .returns(T.attached_class) end - def self.new(account_id:, available_balance:, current_balance:, type:); end - + def self.new( + # The identifier for the account for which the balance was queried. + account_id:, + # The Account's available balance, representing the current balance less any open + # Pending Transactions on the Account. + available_balance:, + # The Account's current balance, representing the sum of all posted Transactions + # on the Account. + current_balance:, + # A constant representing the object's type. For this resource it will always be + # `balance_lookup`. + type: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/bookkeeping_account.rbi b/rbi/lib/increase/models/bookkeeping_account.rbi index 070460e30..977532b5d 100644 --- a/rbi/lib/increase/models/bookkeeping_account.rbi +++ b/rbi/lib/increase/models/bookkeeping_account.rbi @@ -49,8 +49,25 @@ module Increase ) .returns(T.attached_class) end - def self.new(id:, account_id:, compliance_category:, entity_id:, idempotency_key:, name:, type:); end - + def self.new( + # The account identifier. + id:, + # The API Account associated with this bookkeeping account. + account_id:, + # The compliance category of the account. + compliance_category:, + # The Entity associated with this bookkeeping account. + entity_id:, + # 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). + idempotency_key:, + # The name you choose for the account. + name:, + # A constant representing the object's type. For this resource it will always be + # `bookkeeping_account`. + type: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/bookkeeping_account_balance_params.rbi b/rbi/lib/increase/models/bookkeeping_account_balance_params.rbi index 91c6df550..267bbfb11 100644 --- a/rbi/lib/increase/models/bookkeeping_account_balance_params.rbi +++ b/rbi/lib/increase/models/bookkeeping_account_balance_params.rbi @@ -17,8 +17,11 @@ module Increase params(at_time: Time, request_options: T.any(Increase::RequestOptions, Increase::Internal::AnyHash)) .returns(T.attached_class) end - def self.new(at_time: nil, request_options: {}); end - + def self.new( + # The moment to query the balance at. If not set, returns the current balances. + at_time: nil, + request_options: {} + ); end sig { override.returns({at_time: Time, request_options: Increase::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/increase/models/bookkeeping_account_create_params.rbi b/rbi/lib/increase/models/bookkeeping_account_create_params.rbi index 148f025cb..f3a75ab88 100644 --- a/rbi/lib/increase/models/bookkeeping_account_create_params.rbi +++ b/rbi/lib/increase/models/bookkeeping_account_create_params.rbi @@ -46,8 +46,17 @@ module Increase ) .returns(T.attached_class) end - def self.new(name:, account_id: nil, compliance_category: nil, entity_id: nil, request_options: {}); end - + def self.new( + # The name you choose for the account. + name:, + # The entity, if `compliance_category` is `commingled_cash`. + account_id: nil, + # The account compliance category. + compliance_category: nil, + # The entity, if `compliance_category` is `customer_balance`. + entity_id: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/bookkeeping_account_list_params.rbi b/rbi/lib/increase/models/bookkeeping_account_list_params.rbi index 982098185..2cd9eabdd 100644 --- a/rbi/lib/increase/models/bookkeeping_account_list_params.rbi +++ b/rbi/lib/increase/models/bookkeeping_account_list_params.rbi @@ -40,8 +40,19 @@ module Increase ) .returns(T.attached_class) end - def self.new(cursor: nil, idempotency_key: nil, limit: nil, request_options: {}); end - + def self.new( + # Return the page of entries after this one. + cursor: nil, + # 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). + idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. + limit: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/bookkeeping_account_update_params.rbi b/rbi/lib/increase/models/bookkeeping_account_update_params.rbi index e36e6f485..ed8f3b151 100644 --- a/rbi/lib/increase/models/bookkeeping_account_update_params.rbi +++ b/rbi/lib/increase/models/bookkeeping_account_update_params.rbi @@ -14,8 +14,11 @@ module Increase params(name: String, request_options: T.any(Increase::RequestOptions, Increase::Internal::AnyHash)) .returns(T.attached_class) end - def self.new(name:, request_options: {}); end - + def self.new( + # The name you choose for the account. + name:, + request_options: {} + ); end sig { override.returns({name: String, request_options: Increase::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/increase/models/bookkeeping_balance_lookup.rbi b/rbi/lib/increase/models/bookkeeping_balance_lookup.rbi index 9227fb45b..fcffde1ef 100644 --- a/rbi/lib/increase/models/bookkeeping_balance_lookup.rbi +++ b/rbi/lib/increase/models/bookkeeping_balance_lookup.rbi @@ -27,8 +27,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(balance:, bookkeeping_account_id:, type:); end - + def self.new( + # The Bookkeeping Account's current balance, representing the sum of all + # Bookkeeping Entries on the Bookkeeping Account. + balance:, + # The identifier for the account for which the balance was queried. + bookkeeping_account_id:, + # A constant representing the object's type. For this resource it will always be + # `bookkeeping_balance_lookup`. + type: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/bookkeeping_entry.rbi b/rbi/lib/increase/models/bookkeeping_entry.rbi index 3832c3793..453277434 100644 --- a/rbi/lib/increase/models/bookkeeping_entry.rbi +++ b/rbi/lib/increase/models/bookkeeping_entry.rbi @@ -43,8 +43,22 @@ module Increase ) .returns(T.attached_class) end - def self.new(id:, account_id:, amount:, created_at:, entry_set_id:, type:); end - + def self.new( + # The entry identifier. + id:, + # The identifier for the Account the Entry belongs to. + account_id:, + # The Entry amount in the minor unit of its currency. For dollars, for example, + # this is cents. + amount:, + # When the entry set was created. + created_at:, + # The identifier for the Account the Entry belongs to. + entry_set_id:, + # A constant representing the object's type. For this resource it will always be + # `bookkeeping_entry`. + type: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/bookkeeping_entry_list_params.rbi b/rbi/lib/increase/models/bookkeeping_entry_list_params.rbi index d344e4949..d87344b77 100644 --- a/rbi/lib/increase/models/bookkeeping_entry_list_params.rbi +++ b/rbi/lib/increase/models/bookkeeping_entry_list_params.rbi @@ -37,8 +37,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(account_id: nil, cursor: nil, limit: nil, request_options: {}); end - + def self.new( + # The identifier for the Bookkeeping Account to filter by. + account_id: nil, + # Return the page of entries after this one. + cursor: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. + limit: nil, + request_options: {} + ); end sig do override .returns({ diff --git a/rbi/lib/increase/models/bookkeeping_entry_set.rbi b/rbi/lib/increase/models/bookkeeping_entry_set.rbi index 74b8da931..28dcd3289 100644 --- a/rbi/lib/increase/models/bookkeeping_entry_set.rbi +++ b/rbi/lib/increase/models/bookkeeping_entry_set.rbi @@ -50,8 +50,25 @@ module Increase ) .returns(T.attached_class) end - def self.new(id:, created_at:, date:, entries:, idempotency_key:, transaction_id:, type:); end - + def self.new( + # The entry set identifier. + id:, + # When the entry set was created. + created_at:, + # The timestamp of the entry set. + date:, + # The entries. + entries:, + # 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). + idempotency_key:, + # The transaction identifier, if any. + transaction_id:, + # A constant representing the object's type. For this resource it will always be + # `bookkeeping_entry_set`. + type: + ); end sig do override .returns( @@ -82,8 +99,14 @@ module Increase attr_accessor :amount sig { params(id: String, account_id: String, amount: Integer).returns(T.attached_class) } - def self.new(id:, account_id:, amount:); end - + def self.new( + # The entry identifier. + id:, + # The bookkeeping account impacted by the entry. + account_id:, + # The amount of the entry in minor units. + amount: + ); end sig { override.returns({id: String, account_id: String, amount: Integer}) } def to_hash; end end diff --git a/rbi/lib/increase/models/bookkeeping_entry_set_create_params.rbi b/rbi/lib/increase/models/bookkeeping_entry_set_create_params.rbi index 367e04787..699e6cbf6 100644 --- a/rbi/lib/increase/models/bookkeeping_entry_set_create_params.rbi +++ b/rbi/lib/increase/models/bookkeeping_entry_set_create_params.rbi @@ -34,8 +34,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(entries:, date: nil, transaction_id: nil, request_options: {}); end - + def self.new( + # The bookkeeping entries. + entries:, + # The date of the transaction. Optional if `transaction_id` is provided, in which + # case we use the `date` of that transaction. Required otherwise. + date: nil, + # The identifier of the Transaction related to this entry set, if any. + transaction_id: nil, + request_options: {} + ); end sig do override .returns( @@ -61,8 +69,14 @@ module Increase attr_accessor :amount sig { params(account_id: String, amount: Integer).returns(T.attached_class) } - def self.new(account_id:, amount:); end - + def self.new( + # The identifier for the Bookkeeping Account impacted by this entry. + account_id:, + # The entry amount in the minor unit of the account currency. For dollars, for + # example, this is cents. Debit entries have positive amounts; credit entries have + # negative amounts. + amount: + ); end sig { override.returns({account_id: String, amount: Integer}) } def to_hash; end end diff --git a/rbi/lib/increase/models/bookkeeping_entry_set_list_params.rbi b/rbi/lib/increase/models/bookkeeping_entry_set_list_params.rbi index c6fa3c8b5..81c75e786 100644 --- a/rbi/lib/increase/models/bookkeeping_entry_set_list_params.rbi +++ b/rbi/lib/increase/models/bookkeeping_entry_set_list_params.rbi @@ -48,9 +48,21 @@ module Increase ) .returns(T.attached_class) end - def self.new(cursor: nil, idempotency_key: nil, limit: nil, transaction_id: nil, request_options: {}) - end - + def self.new( + # Return the page of entries after this one. + cursor: nil, + # 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). + idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. + limit: nil, + # Filter to the Bookkeeping Entry Set that maps to this Transaction. + transaction_id: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/card.rbi b/rbi/lib/increase/models/card.rbi index e108864cf..130d578fd 100644 --- a/rbi/lib/increase/models/card.rbi +++ b/rbi/lib/increase/models/card.rbi @@ -95,18 +95,37 @@ module Increase .returns(T.attached_class) end def self.new( + # The card identifier. id:, + # The identifier for the account this card belongs to. account_id:, + # The Card's billing address. billing_address:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the Card was created. created_at:, + # The card's description for display purposes. description:, + # The contact information used in the two-factor steps for digital wallet card + # creation. At least one field must be present to complete the digital wallet + # steps. digital_wallet:, + # The identifier for the entity associated with this card. entity_id:, + # The month the card expires in M format (e.g., August is 8). expiration_month:, + # The year the card expires in YYYY format (e.g., 2025). expiration_year:, + # 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). idempotency_key:, + # The last 4 digits of the Card's Primary Account Number. last4:, + # This indicates if payments can be made with the card. status:, + # A constant representing the object's type. For this resource it will always be + # `card`. type: ); end sig do @@ -163,8 +182,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(city:, line1:, line2:, postal_code:, state:); end - + def self.new( + # The city of the billing address. + city:, + # The first line of the billing address. + line1:, + # The second line of the billing address. + line2:, + # The postal code of the billing address. + postal_code:, + # The US state of the billing address. + state: + ); end sig do override .returns( @@ -207,8 +236,17 @@ module Increase ) .returns(T.attached_class) end - def self.new(digital_card_profile_id:, email:, phone:); end - + def self.new( + # The digital card profile assigned to this digital card. Card profiles may also + # be assigned at the program level. + digital_card_profile_id:, + # An email address that can be used to verify the cardholder via one-time passcode + # over email. + email:, + # A phone number that can be used to verify the cardholder via one-time passcode + # over SMS. + phone: + ); end sig do override .returns({ diff --git a/rbi/lib/increase/models/card_create_params.rbi b/rbi/lib/increase/models/card_create_params.rbi index 2b3a6781e..9b063407e 100644 --- a/rbi/lib/increase/models/card_create_params.rbi +++ b/rbi/lib/increase/models/card_create_params.rbi @@ -65,10 +65,20 @@ module Increase .returns(T.attached_class) end def self.new( + # The Account the card should belong to. account_id:, + # The card's billing address. billing_address: nil, + # The description you choose to give the card. description: nil, + # The contact information used in the two-factor steps for digital wallet card + # creation. To add the card to a digital wallet, you may supply an email or phone + # number with this request. Otherwise, subscribe and then action a Real Time + # Decision with the category `digital_wallet_token_requested` or + # `digital_wallet_authentication_requested`. digital_wallet: nil, + # The Entity the card belongs to. You only need to supply this in rare situations + # when the card is not for the Account holder. entity_id: nil, request_options: {} ); end @@ -116,8 +126,18 @@ module Increase params(city: String, line1: String, postal_code: String, state: String, line2: String) .returns(T.attached_class) end - def self.new(city:, line1:, postal_code:, state:, line2: nil); end - + def self.new( + # The city of the billing address. + city:, + # The first line of the billing address. + line1:, + # The postal code of the billing address. + postal_code:, + # The US state of the billing address. + state:, + # The second line of the billing address. + line2: nil + ); end sig do override.returns({city: String, line1: String, postal_code: String, state: String, line2: String}) end @@ -156,8 +176,16 @@ module Increase sig do params(digital_card_profile_id: String, email: String, phone: String).returns(T.attached_class) end - def self.new(digital_card_profile_id: nil, email: nil, phone: nil); end - + def self.new( + # The digital card profile assigned to this digital card. + digital_card_profile_id: nil, + # An email address that can be used to contact and verify the cardholder via + # one-time passcode over email. + email: nil, + # A phone number that can be used to contact and verify the cardholder via + # one-time passcode over SMS. + phone: nil + ); end sig { override.returns({digital_card_profile_id: String, email: String, phone: String}) } def to_hash; end end diff --git a/rbi/lib/increase/models/card_details.rbi b/rbi/lib/increase/models/card_details.rbi index 8b969d98d..0a15c0183 100644 --- a/rbi/lib/increase/models/card_details.rbi +++ b/rbi/lib/increase/models/card_details.rbi @@ -43,15 +43,22 @@ module Increase .returns(T.attached_class) end def self.new( + # The identifier for the Card for which sensitive details have been returned. card_id:, + # The month the card expires in M format (e.g., August is 8). expiration_month:, + # The year the card expires in YYYY format (e.g., 2025). expiration_year:, + # The card number. primary_account_number:, + # A constant representing the object's type. For this resource it will always be + # `card_details`. type:, + # The three-digit verification code for the card. It's also known as the Card + # Verification Code (CVC), the Card Verification Value (CVV), or the Card + # Identification (CID). verification_code: - ) - end - + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/card_dispute.rbi b/rbi/lib/increase/models/card_dispute.rbi index 41abe8bf6..8f4792885 100644 --- a/rbi/lib/increase/models/card_dispute.rbi +++ b/rbi/lib/increase/models/card_dispute.rbi @@ -99,17 +99,37 @@ module Increase .returns(T.attached_class) end def self.new( + # The Card Dispute identifier. id:, + # If the Card Dispute's status is `accepted`, this will contain details of the + # successful dispute. acceptance:, + # The amount of the dispute, if provided, or the transaction amount otherwise. amount:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the Card Dispute was created. created_at:, + # The identifier of the Transaction that was disputed. disputed_transaction_id:, + # Why you disputed the Transaction in question. explanation:, + # 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). idempotency_key:, + # If the Card Dispute's status is `lost`, this will contain details of the lost + # dispute. loss:, + # If the Card Dispute's status is `rejected`, this will contain details of the + # unsuccessful dispute. rejection:, + # The results of the Dispute investigation. status:, + # A constant representing the object's type. For this resource it will always be + # `card_dispute`. type:, + # If the Card Dispute's status is `won`, this will contain details of the won + # dispute. win: ); end sig do @@ -153,8 +173,16 @@ module Increase sig do params(accepted_at: Time, card_dispute_id: String, transaction_id: String).returns(T.attached_class) end - def self.new(accepted_at:, card_dispute_id:, transaction_id:); end - + def self.new( + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the Card Dispute was accepted. + accepted_at:, + # The identifier of the Card Dispute that was accepted. + card_dispute_id:, + # The identifier of the Transaction that was created to return the disputed funds + # to your account. + transaction_id: + ); end sig { override.returns({accepted_at: Time, card_dispute_id: String, transaction_id: String}) } def to_hash; end end @@ -184,8 +212,18 @@ module Increase params(card_dispute_id: String, explanation: String, lost_at: Time, transaction_id: String) .returns(T.attached_class) end - def self.new(card_dispute_id:, explanation:, lost_at:, transaction_id:); end - + def self.new( + # The identifier of the Card Dispute that was lost. + card_dispute_id:, + # Why the Card Dispute was lost. + explanation:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the Card Dispute was lost. + lost_at:, + # The identifier of the Transaction that was created to debit the disputed funds + # from your account. + transaction_id: + ); end sig do override.returns( { @@ -218,8 +256,15 @@ module Increase sig do params(card_dispute_id: String, explanation: String, rejected_at: Time).returns(T.attached_class) end - def self.new(card_dispute_id:, explanation:, rejected_at:); end - + def self.new( + # The identifier of the Card Dispute that was rejected. + card_dispute_id:, + # Why the Card Dispute was rejected. + explanation:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the Card Dispute was rejected. + rejected_at: + ); end sig { override.returns({card_dispute_id: String, explanation: String, rejected_at: Time}) } def to_hash; end end @@ -281,8 +326,13 @@ module Increase # If the Card Dispute's status is `won`, this will contain details of the won # dispute. sig { params(card_dispute_id: String, won_at: Time).returns(T.attached_class) } - def self.new(card_dispute_id:, won_at:); end - + def self.new( + # The identifier of the Card Dispute that was won. + card_dispute_id:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the Card Dispute was won. + won_at: + ); end sig { override.returns({card_dispute_id: String, won_at: Time}) } def to_hash; end end diff --git a/rbi/lib/increase/models/card_dispute_create_params.rbi b/rbi/lib/increase/models/card_dispute_create_params.rbi index 88b88b7bb..65c53f4ea 100644 --- a/rbi/lib/increase/models/card_dispute_create_params.rbi +++ b/rbi/lib/increase/models/card_dispute_create_params.rbi @@ -34,8 +34,19 @@ module Increase ) .returns(T.attached_class) end - def self.new(disputed_transaction_id:, explanation:, amount: nil, request_options: {}); end - + def self.new( + # The Transaction you wish to dispute. This Transaction must have a `source_type` + # of `card_settlement`. + disputed_transaction_id:, + # Why you are disputing this Transaction. + explanation:, + # The monetary amount of the part of the transaction that is being disputed. This + # is optional and will default to the full amount of the transaction if not + # provided. If provided, the amount must be less than or equal to the amount of + # the transaction. + amount: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/card_dispute_list_params.rbi b/rbi/lib/increase/models/card_dispute_list_params.rbi index 4b51877cf..d6d3ea9f3 100644 --- a/rbi/lib/increase/models/card_dispute_list_params.rbi +++ b/rbi/lib/increase/models/card_dispute_list_params.rbi @@ -59,14 +59,19 @@ module Increase end def self.new( created_at: nil, + # Return the page of entries after this one. cursor: nil, + # 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). idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, status: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -118,8 +123,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end @@ -138,8 +155,12 @@ module Increase params(in_: T::Array[Increase::Models::CardDisputeListParams::Status::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # Filter Card Disputes for those with the specified status or statuses. For GET + # requests, this should be encoded as a comma-delimited string, such as + # `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::CardDisputeListParams::Status::In::OrSymbol]}) } def to_hash; end diff --git a/rbi/lib/increase/models/card_list_params.rbi b/rbi/lib/increase/models/card_list_params.rbi index 24f469e37..c37b81476 100644 --- a/rbi/lib/increase/models/card_list_params.rbi +++ b/rbi/lib/increase/models/card_list_params.rbi @@ -63,10 +63,18 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter Cards to ones belonging to the specified Account. account_id: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # 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). idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, status: nil, request_options: {} @@ -123,8 +131,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end @@ -139,8 +159,11 @@ module Increase attr_writer :in_ sig { params(in_: T::Array[Increase::Models::CardListParams::Status::In::OrSymbol]).returns(T.attached_class) } - def self.new(in_: nil); end - + def self.new( + # Filter Cards by status. For GET requests, this should be encoded as a + # comma-delimited string, such as `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::CardListParams::Status::In::OrSymbol]}) } def to_hash; end diff --git a/rbi/lib/increase/models/card_payment.rbi b/rbi/lib/increase/models/card_payment.rbi index 85a5a3f5b..7fda90b8b 100644 --- a/rbi/lib/increase/models/card_payment.rbi +++ b/rbi/lib/increase/models/card_payment.rbi @@ -61,14 +61,25 @@ module Increase .returns(T.attached_class) end def self.new( + # The Card Payment identifier. id:, + # The identifier for the Account the Transaction belongs to. account_id:, + # The Card identifier for this payment. card_id:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card + # Payment was created. created_at:, + # The Digital Wallet Token identifier for this payment. digital_wallet_token_id:, + # The interactions related to this card payment. elements:, + # The Physical Card identifier for this payment. physical_card_id:, + # The summarized state of this card payment. state:, + # A constant representing the object's type. For this resource it will always be + # `card_payment`. type: ); end sig do @@ -279,18 +290,61 @@ module Increase .returns(T.attached_class) end def self.new( + # A Card Authentication object. This field will be present in the JSON response if + # and only if `category` is equal to `card_authentication`. Card Authentications + # are attempts to authenticate a transaction or a card with 3DS. card_authentication:, + # A Card Authorization object. This field will be present in the JSON response if + # and only if `category` is equal to `card_authorization`. Card Authorizations are + # temporary holds placed on a customers funds with the intent to later clear a + # transaction. card_authorization:, + # A Card Authorization Expiration object. This field will be present in the JSON + # response if and only if `category` is equal to `card_authorization_expiration`. + # Card Authorization Expirations are cancellations of authorizations that were + # never settled by the acquirer. card_authorization_expiration:, + # A Card Decline object. This field will be present in the JSON response if and + # only if `category` is equal to `card_decline`. card_decline:, + # A Card Fuel Confirmation object. This field will be present in the JSON response + # if and only if `category` is equal to `card_fuel_confirmation`. Card Fuel + # Confirmations update the amount of a Card Authorization after a fuel pump + # transaction is completed. card_fuel_confirmation:, + # A Card Increment object. This field will be present in the JSON response if and + # only if `category` is equal to `card_increment`. Card Increments increase the + # pending amount of an authorized transaction. card_increment:, + # A Card Refund object. This field will be present in the JSON response if and + # only if `category` is equal to `card_refund`. Card Refunds move money back to + # the cardholder. While they are usually connected to a Card Settlement an + # acquirer can also refund money directly to a card without relation to a + # transaction. card_refund:, + # A Card Reversal object. This field will be present in the JSON response if and + # only if `category` is equal to `card_reversal`. Card Reversals cancel parts of + # or the entirety of an existing Card Authorization. card_reversal:, + # A Card Settlement object. This field will be present in the JSON response if and + # only if `category` is equal to `card_settlement`. Card Settlements are card + # transactions that have cleared and settled. While a settlement is usually + # preceded by an authorization, an acquirer can also directly clear a transaction + # without first authorizing it. card_settlement:, + # A Card Validation object. This field will be present in the JSON response if and + # only if `category` is equal to `card_validation`. Card Validations are requests + # from a merchant to verify that a card number and optionally its address and/or + # Card Verification Value are valid. card_validation:, + # The type of the resource. We may add additional possible values for this enum + # over time; your application should be able to handle such additions gracefully. category:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the card payment element was created. created_at:, + # If the category of this Transaction source is equal to `other`, this field will + # contain an empty object, otherwise it will contain null. other: ); end sig do @@ -432,22 +486,45 @@ module Increase .returns(T.attached_class) end def self.new( + # The Card Authentication identifier. id:, + # The identifier of the Card. card_id:, + # The ID of the Card Payment this transaction belongs to. card_payment_id:, + # The category of the card authentication attempt. category:, + # Details about the challenge, if one was requested. challenge:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card + # Authentication was attempted. created_at:, + # The reason why this authentication attempt was denied, if it was. deny_reason:, + # The device channel of the card authentication attempt. device_channel:, + # The merchant identifier (commonly abbreviated as MID) of the merchant the card + # is transacting with. merchant_acceptor_id:, + # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the + # card is transacting with. merchant_category_code:, + # The country the merchant resides in. merchant_country:, + # The name of the merchant. merchant_name:, + # The purchase amount in minor units. purchase_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # authentication attempt's purchase currency. purchase_currency:, + # The identifier of the Real-Time Decision sent to approve or decline this + # authentication attempt. real_time_decision_id:, + # The status of the card authentication. status:, + # A constant representing the object's type. For this resource it will always be + # `card_authentication`. type: ); end sig do @@ -548,9 +625,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(attempts:, created_at:, one_time_code:, verification_method:, verification_value:) - end - + def self.new( + # Details about the challenge verification attempts, if any happened. + attempts:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card + # Authentication Challenge was started. + created_at:, + # The one-time code used for the Card Authentication Challenge. + one_time_code:, + # The method used to verify the Card Authentication Challenge. + verification_method:, + # E.g., the email address or phone number used for the Card Authentication + # Challenge. + verification_value: + ); end sig do override .returns( @@ -586,8 +674,13 @@ module Increase ) .returns(T.attached_class) end - def self.new(created_at:, outcome:); end - + def self.new( + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time of the Card + # Authentication Challenge Attempt. + created_at:, + # The outcome of the Card Authentication Challenge Attempt. + outcome: + ); end sig do override .returns( @@ -1046,32 +1139,75 @@ module Increase .returns(T.attached_class) end def self.new( + # The Card Authorization identifier. id:, + # Whether this authorization was approved by Increase, the card network through + # stand-in processing, or the user through a real-time decision. actioner:, + # The pending amount in the minor unit of the transaction's currency. For dollars, + # for example, this is cents. amount:, + # The ID of the Card Payment this transaction belongs to. card_payment_id:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's currency. currency:, + # If the authorization was made via a Digital Wallet Token (such as an Apple Pay + # purchase), the identifier of the token that was used. digital_wallet_token_id:, + # The direction describes the direction the funds will move, either from the + # cardholder to the merchant or from the merchant to the cardholder. direction:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization + # will expire and the pending transaction will be released. expires_at:, + # The merchant identifier (commonly abbreviated as MID) of the merchant the card + # is transacting with. merchant_acceptor_id:, + # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the + # card is transacting with. merchant_category_code:, + # The city the merchant resides in. merchant_city:, + # The country the merchant resides in. merchant_country:, + # The merchant descriptor of the merchant the card is transacting with. merchant_descriptor:, + # The merchant's postal code. For US merchants this is either a 5-digit or 9-digit + # ZIP code, where the first 5 and last 4 are separated by a dash. merchant_postal_code:, + # The state the merchant resides in. merchant_state:, + # Fields specific to the `network`. network_details:, + # Network-specific identifiers for a specific request or transaction. network_identifiers:, + # The risk score generated by the card network. For Visa this is the Visa Advanced + # Authorization risk score, from 0 to 99, where 99 is the riskiest. network_risk_score:, + # The identifier of the Pending Transaction associated with this Transaction. pending_transaction_id:, + # If the authorization was made in-person with a physical card, the Physical Card + # that was used. physical_card_id:, + # The pending amount in the minor unit of the transaction's presentment currency. presentment_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's presentment currency. presentment_currency:, + # The processing category describes the intent behind the authorization, such as + # whether it was used for bill payments or an automatic fuel dispenser. processing_category:, + # The identifier of the Real-Time Decision sent to approve or decline this + # transaction. real_time_decision_id:, + # The terminal identifier (commonly abbreviated as TID) of the terminal the card + # is transacting with. terminal_id:, + # A constant representing the object's type. For this resource it will always be + # `card_authorization`. type:, + # Fields related to verification of cardholder-provided values. verification: ); end sig do @@ -1230,8 +1366,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(category:, visa:); end - + def self.new( + # The payment network used to process this card authorization. + category:, + # Fields specific to the `visa` network. + visa: + ); end sig do override .returns( @@ -1318,12 +1458,17 @@ module Increase .returns(T.attached_class) end def self.new( + # For electronic commerce transactions, this identifies the level of security used + # in obtaining the customer's payment credential. For mail or telephone order + # transactions, identifies the type of mail or telephone order. electronic_commerce_indicator:, + # The method used to enter the cardholder's primary account number and card + # expiration date. point_of_service_entry_mode:, + # Only present when `actioner: network`. Describes why a card authorization was + # approved or declined by Visa through stand-in processing. stand_in_processing_reason: - ) - end - + ); end sig do override .returns( @@ -1612,8 +1757,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(retrieval_reference_number:, trace_number:, transaction_id:); end - + def self.new( + # A life-cycle identifier used across e.g., an authorization and a reversal. + # Expected to be unique per acquirer within a window of time. For some card + # networks the retrieval reference number includes the trace counter. + retrieval_reference_number:, + # A counter used to verify an individual authorization. Expected to be unique per + # acquirer within a window of time. + trace_number:, + # A globally unique transaction identifier provided by the card network, used + # across multiple life-cycle requests. + transaction_id: + ); end sig do override .returns( @@ -1750,8 +1905,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(card_verification_code:, cardholder_address:); end - + def self.new( + # Fields related to verification of the Card Verification Code, a 3-digit code on + # the back of the card. + card_verification_code:, + # Cardholder address provided in the authorization request and the address on file + # we verified it against. + cardholder_address: + ); end sig do override .returns( @@ -1780,8 +1941,10 @@ module Increase ) .returns(T.attached_class) end - def self.new(result:); end - + def self.new( + # The result of verifying the Card Verification Code. + result: + ); end sig do override .returns( @@ -1874,14 +2037,18 @@ module Increase .returns(T.attached_class) end def self.new( + # Line 1 of the address on file for the cardholder. actual_line1:, + # The postal code of the address on file for the cardholder. actual_postal_code:, + # The cardholder address line 1 provided for verification in the authorization + # request. provided_line1:, + # The postal code provided for verification in the authorization request. provided_postal_code:, + # The address verification result returned to the card network. result: - ) - end - + ); end sig do override .returns( @@ -2005,8 +2172,23 @@ module Increase ) .returns(T.attached_class) end - def self.new(id:, card_authorization_id:, currency:, expired_amount:, network:, type:); end - + def self.new( + # The Card Authorization Expiration identifier. + id:, + # The identifier for the Card Authorization this reverses. + card_authorization_id:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's + # currency. + currency:, + # The amount of this authorization expiration in the minor unit of the + # transaction's currency. For dollars, for example, this is cents. + expired_amount:, + # The card network used to process this card authorization. + network:, + # A constant representing the object's type. For this resource it will always be + # `card_authorization_expiration`. + type: + ); end sig do override .returns( @@ -2301,32 +2483,74 @@ module Increase .returns(T.attached_class) end def self.new( + # The Card Decline identifier. id:, + # Whether this authorization was approved by Increase, the card network through + # stand-in processing, or the user through a real-time decision. actioner:, + # The declined amount in the minor unit of the destination account currency. For + # dollars, for example, this is cents. amount:, + # The ID of the Card Payment this transaction belongs to. card_payment_id:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination + # account currency. currency:, + # The identifier of the declined transaction created for this Card Decline. declined_transaction_id:, + # If the authorization was made via a Digital Wallet Token (such as an Apple Pay + # purchase), the identifier of the token that was used. digital_wallet_token_id:, + # The direction describes the direction the funds will move, either from the + # cardholder to the merchant or from the merchant to the cardholder. direction:, + # The merchant identifier (commonly abbreviated as MID) of the merchant the card + # is transacting with. merchant_acceptor_id:, + # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the + # card is transacting with. merchant_category_code:, + # The city the merchant resides in. merchant_city:, + # The country the merchant resides in. merchant_country:, + # The merchant descriptor of the merchant the card is transacting with. merchant_descriptor:, + # The merchant's postal code. For US merchants this is either a 5-digit or 9-digit + # ZIP code, where the first 5 and last 4 are separated by a dash. merchant_postal_code:, + # The state the merchant resides in. merchant_state:, + # Fields specific to the `network`. network_details:, + # Network-specific identifiers for a specific request or transaction. network_identifiers:, + # The risk score generated by the card network. For Visa this is the Visa Advanced + # Authorization risk score, from 0 to 99, where 99 is the riskiest. network_risk_score:, + # If the authorization was made in-person with a physical card, the Physical Card + # that was used. physical_card_id:, + # The declined amount in the minor unit of the transaction's presentment currency. presentment_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's presentment currency. presentment_currency:, + # The processing category describes the intent behind the authorization, such as + # whether it was used for bill payments or an automatic fuel dispenser. processing_category:, + # The identifier of the Real-Time Decision sent to approve or decline this + # transaction. real_time_decision_id:, + # This is present if a specific decline reason was given in the real-time + # decision. real_time_decision_reason:, + # Why the transaction was declined. reason:, + # The terminal identifier (commonly abbreviated as TID) of the terminal the card + # is transacting with. terminal_id:, + # Fields related to verification of cardholder-provided values. verification: ); end sig do @@ -2473,8 +2697,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(category:, visa:); end - + def self.new( + # The payment network used to process this card authorization. + category:, + # Fields specific to the `visa` network. + visa: + ); end sig do override .returns( @@ -2558,12 +2786,17 @@ module Increase .returns(T.attached_class) end def self.new( + # For electronic commerce transactions, this identifies the level of security used + # in obtaining the customer's payment credential. For mail or telephone order + # transactions, identifies the type of mail or telephone order. electronic_commerce_indicator:, + # The method used to enter the cardholder's primary account number and card + # expiration date. point_of_service_entry_mode:, + # Only present when `actioner: network`. Describes why a card authorization was + # approved or declined by Visa through stand-in processing. stand_in_processing_reason: - ) - end - + ); end sig do override .returns( @@ -2852,8 +3085,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(retrieval_reference_number:, trace_number:, transaction_id:); end - + def self.new( + # A life-cycle identifier used across e.g., an authorization and a reversal. + # Expected to be unique per acquirer within a window of time. For some card + # networks the retrieval reference number includes the trace counter. + retrieval_reference_number:, + # A counter used to verify an individual authorization. Expected to be unique per + # acquirer within a window of time. + trace_number:, + # A globally unique transaction identifier provided by the card network, used + # across multiple life-cycle requests. + transaction_id: + ); end sig do override .returns( @@ -3119,8 +3362,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(card_verification_code:, cardholder_address:); end - + def self.new( + # Fields related to verification of the Card Verification Code, a 3-digit code on + # the back of the card. + card_verification_code:, + # Cardholder address provided in the authorization request and the address on file + # we verified it against. + cardholder_address: + ); end sig do override .returns( @@ -3149,8 +3398,10 @@ module Increase ) .returns(T.attached_class) end - def self.new(result:); end - + def self.new( + # The result of verifying the Card Verification Code. + result: + ); end sig do override .returns( @@ -3243,14 +3494,18 @@ module Increase .returns(T.attached_class) end def self.new( + # Line 1 of the address on file for the cardholder. actual_line1:, + # The postal code of the address on file for the cardholder. actual_postal_code:, + # The cardholder address line 1 provided for verification in the authorization + # request. provided_line1:, + # The postal code provided for verification in the authorization request. provided_postal_code:, + # The address verification result returned to the card network. result: - ) - end - + ); end sig do override .returns( @@ -3398,13 +3653,25 @@ module Increase .returns(T.attached_class) end def self.new( + # The Card Fuel Confirmation identifier. id:, + # The identifier for the Card Authorization this updates. card_authorization_id:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's + # currency. currency:, + # The card network used to process this card authorization. network:, + # Network-specific identifiers for a specific request or transaction. network_identifiers:, + # The identifier of the Pending Transaction associated with this Card Fuel + # Confirmation. pending_transaction_id:, + # A constant representing the object's type. For this resource it will always be + # `card_fuel_confirmation`. type:, + # The updated authorization amount after this fuel confirmation, in the minor unit + # of the transaction's currency. For dollars, for example, this is cents. updated_authorization_amount: ); end sig do @@ -3502,8 +3769,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(retrieval_reference_number:, trace_number:, transaction_id:); end - + def self.new( + # A life-cycle identifier used across e.g., an authorization and a reversal. + # Expected to be unique per acquirer within a window of time. For some card + # networks the retrieval reference number includes the trace counter. + retrieval_reference_number:, + # A counter used to verify an individual authorization. Expected to be unique per + # acquirer within a window of time. + trace_number:, + # A globally unique transaction identifier provided by the card network, used + # across multiple life-cycle requests. + transaction_id: + ); end sig do override .returns( @@ -3631,17 +3908,36 @@ module Increase .returns(T.attached_class) end def self.new( + # The Card Increment identifier. id:, + # Whether this authorization was approved by Increase, the card network through + # stand-in processing, or the user through a real-time decision. actioner:, + # The amount of this increment in the minor unit of the transaction's currency. + # For dollars, for example, this is cents. amount:, + # The identifier for the Card Authorization this increments. card_authorization_id:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's + # currency. currency:, + # The card network used to process this card authorization. network:, + # Network-specific identifiers for a specific request or transaction. network_identifiers:, + # The risk score generated by the card network. For Visa this is the Visa Advanced + # Authorization risk score, from 0 to 99, where 99 is the riskiest. network_risk_score:, + # The identifier of the Pending Transaction associated with this Card Increment. pending_transaction_id:, + # The identifier of the Real-Time Decision sent to approve or decline this + # incremental authorization. real_time_decision_id:, + # A constant representing the object's type. For this resource it will always be + # `card_increment`. type:, + # The updated authorization amount after this increment, in the minor unit of the + # transaction's currency. For dollars, for example, this is cents. updated_authorization_amount: ); end sig do @@ -3760,8 +4056,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(retrieval_reference_number:, trace_number:, transaction_id:); end - + def self.new( + # A life-cycle identifier used across e.g., an authorization and a reversal. + # Expected to be unique per acquirer within a window of time. For some card + # networks the retrieval reference number includes the trace counter. + retrieval_reference_number:, + # A counter used to verify an individual authorization. Expected to be unique per + # acquirer within a window of time. + trace_number:, + # A globally unique transaction identifier provided by the card network, used + # across multiple life-cycle requests. + transaction_id: + ); end sig do override .returns( @@ -3950,24 +4256,50 @@ module Increase .returns(T.attached_class) end def self.new( + # The Card Refund identifier. id:, + # The amount in the minor unit of the transaction's settlement currency. For + # dollars, for example, this is cents. amount:, + # The ID of the Card Payment this transaction belongs to. card_payment_id:, + # Cashback debited for this transaction, if eligible. Cashback is paid out in + # aggregate, monthly. cashback:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's settlement currency. currency:, + # Interchange assessed as a part of this transaciton. interchange:, + # The merchant identifier (commonly abbreviated as MID) of the merchant the card + # is transacting with. merchant_acceptor_id:, + # The 4-digit MCC describing the merchant's business. merchant_category_code:, + # The city the merchant resides in. merchant_city:, + # The country the merchant resides in. merchant_country:, + # The name of the merchant. merchant_name:, + # The merchant's postal code. For US merchants this is always a 5-digit ZIP code. merchant_postal_code:, + # The state the merchant resides in. merchant_state:, + # Network-specific identifiers for this refund. network_identifiers:, + # The amount in the minor unit of the transaction's presentment currency. presentment_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's presentment currency. presentment_currency:, + # Additional details about the card purchase, such as tax and industry-specific + # fields. purchase_details:, + # The identifier of the Transaction associated with this Transaction. transaction_id:, + # A constant representing the object's type. For this resource it will always be + # `card_refund`. type: ); end sig do @@ -4018,8 +4350,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, currency:); end - + def self.new( + # The cashback amount given as a string containing a decimal number. The amount is + # a positive number if it will be credited to you (e.g., settlements) and a + # negative number if it will be debited (e.g., refunds). + amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. + currency: + ); end sig do override .returns( @@ -4122,8 +4460,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, code:, currency:); end - + def self.new( + # The interchange amount given as a string containing a decimal number in major + # units (so e.g., "3.14" for $3.14). The amount is a positive number if it is + # credited to Increase (e.g., settlements) and a negative number if it is debited + # (e.g., refunds). + amount:, + # The card network specific interchange code. + code:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange + # reimbursement. + currency: + ); end sig do override .returns( @@ -4201,8 +4549,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(acquirer_business_id:, acquirer_reference_number:, transaction_id:); end - + def self.new( + # A network assigned business ID that identifies the acquirer that processed this + # transaction. + acquirer_business_id:, + # A globally unique identifier for this settlement. + acquirer_reference_number:, + # A globally unique transaction identifier provided by the card network, used + # across multiple life-cycle requests. + transaction_id: + ); end sig do override .returns( @@ -4339,15 +4695,27 @@ module Increase .returns(T.attached_class) end def self.new( + # Fields specific to car rentals. car_rental:, + # An identifier from the merchant for the customer or consumer. customer_reference_identifier:, + # The state or provincial tax amount in minor units. local_tax_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax + # assessed. local_tax_currency:, + # Fields specific to lodging. lodging:, + # The national tax amount in minor units. national_tax_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax + # assessed. national_tax_currency:, + # An identifier from the merchant for the purchase to the issuer and cardholder. purchase_identifier:, + # The format of the purchase identifier. purchase_identifier_format:, + # Fields specific to travel. travel: ); end sig do @@ -4483,21 +4851,45 @@ module Increase .returns(T.attached_class) end def self.new( + # Code indicating the vehicle's class. car_class_code:, + # Date the customer picked up the car or, in the case of a no-show or pre-pay + # transaction, the scheduled pick up date. checkout_date:, + # Daily rate being charged for the vehicle. daily_rental_rate_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental + # rate. daily_rental_rate_currency:, + # Number of days the vehicle was rented. days_rented:, + # Additional charges (gas, late fee, etc.) being billed. extra_charges:, + # Fuel charges for the vehicle. fuel_charges_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges + # assessed. fuel_charges_currency:, + # Any insurance being charged for the vehicle. insurance_charges_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance + # charges assessed. insurance_charges_currency:, + # An indicator that the cardholder is being billed for a reserved vehicle that was + # not actually rented (that is, a "no-show" charge). no_show_indicator:, + # Charges for returning the vehicle at a different location than where it was + # picked up. one_way_drop_off_charges_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way + # drop-off charges assessed. one_way_drop_off_charges_currency:, + # Name of the person renting the vehicle. renter_name:, + # Weekly rate being charged for the vehicle. weekly_rental_rate_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly + # rental rate. weekly_rental_rate_currency: ); end sig do @@ -4738,21 +5130,44 @@ module Increase .returns(T.attached_class) end def self.new( + # Date the customer checked in. check_in_date:, + # Daily rate being charged for the room. daily_room_rate_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room + # rate. daily_room_rate_currency:, + # Additional charges (phone, late check-out, etc.) being billed. extra_charges:, + # Folio cash advances for the room. folio_cash_advances_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash + # advances. folio_cash_advances_currency:, + # Food and beverage charges for the room. food_beverage_charges_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and + # beverage charges. food_beverage_charges_currency:, + # Indicator that the cardholder is being billed for a reserved room that was not + # actually used. no_show_indicator:, + # Prepaid expenses being charged for the room. prepaid_expenses_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid + # expenses. prepaid_expenses_currency:, + # Number of nights the room was rented. room_nights:, + # Total room tax being charged. total_room_tax_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room + # tax. total_room_tax_currency:, + # Total tax being charged for the room. total_tax_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax + # assessed. total_tax_currency: ); end sig do @@ -5064,17 +5479,29 @@ module Increase .returns(T.attached_class) end def self.new( + # Ancillary purchases in addition to the airfare. ancillary:, + # Indicates the computerized reservation system used to book the ticket. computerized_reservation_system:, + # Indicates the reason for a credit to the cardholder. credit_reason_indicator:, + # Date of departure. departure_date:, + # Code for the originating city or airport. origination_city_airport_code:, + # Name of the passenger. passenger_name:, + # Indicates whether this ticket is non-refundable. restricted_ticket_indicator:, + # Indicates why a ticket was changed. ticket_change_indicator:, + # Ticket number. ticket_number:, + # Code for the travel agency if the ticket was issued by a travel agency. travel_agency_code:, + # Name of the travel agency if the ticket was issued by a travel agency. travel_agency_name:, + # Fields specific to each leg of the journey. trip_legs: ); end sig do @@ -5156,10 +5583,17 @@ module Increase .returns(T.attached_class) end def self.new( + # If this purchase has a connection or relationship to another purchase, such as a + # baggage fee for a passenger transport ticket, this field should contain the + # ticket document number for the other purchase. connected_ticket_document_number:, + # Indicates the reason for a credit to the cardholder. credit_reason_indicator:, + # Name of the passenger or description of the ancillary purchase. passenger_name_or_description:, + # Additional travel charges, such as baggage fees. services:, + # Ticket document number. ticket_document_number: ); end sig do @@ -5251,8 +5685,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(category:, sub_category:); end - + def self.new( + # Category of the ancillary service. + category:, + # Sub-category of the ancillary service, free-form. + sub_category: + ); end sig do override .returns( @@ -5642,11 +6080,17 @@ module Increase .returns(T.attached_class) end def self.new( + # Carrier code (e.g., United Airlines, Jet Blue, etc.). carrier_code:, + # Code for the destination city or airport. destination_city_airport_code:, + # Fare basis code. fare_basis_code:, + # Flight number. flight_number:, + # Service class (e.g., first class, business class, etc.). service_class:, + # Indicates whether a stopover is allowed on this ticket. stop_over_code: ); end sig do @@ -5848,23 +6292,49 @@ module Increase .returns(T.attached_class) end def self.new( + # The Card Reversal identifier. id:, + # The identifier for the Card Authorization this reverses. card_authorization_id:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's + # currency. currency:, + # The merchant identifier (commonly abbreviated as MID) of the merchant the card + # is transacting with. merchant_acceptor_id:, + # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the + # card is transacting with. merchant_category_code:, + # The city the merchant resides in. merchant_city:, + # The country the merchant resides in. merchant_country:, + # The merchant descriptor of the merchant the card is transacting with. merchant_descriptor:, + # The merchant's postal code. For US merchants this is either a 5-digit or 9-digit + # ZIP code, where the first 5 and last 4 are separated by a dash. merchant_postal_code:, + # The state the merchant resides in. merchant_state:, + # The card network used to process this card authorization. network:, + # Network-specific identifiers for a specific request or transaction. network_identifiers:, + # The identifier of the Pending Transaction associated with this Card Reversal. pending_transaction_id:, + # The amount of this reversal in the minor unit of the transaction's currency. For + # dollars, for example, this is cents. reversal_amount:, + # Why this reversal was initiated. reversal_reason:, + # The terminal identifier (commonly abbreviated as TID) of the terminal the card + # is transacting with. terminal_id:, + # A constant representing the object's type. For this resource it will always be + # `card_reversal`. type:, + # The amount left pending on the Card Authorization in the minor unit of the + # transaction's currency. For dollars, for example, this is cents. updated_authorization_amount: ); end sig do @@ -5966,8 +6436,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(retrieval_reference_number:, trace_number:, transaction_id:); end - + def self.new( + # A life-cycle identifier used across e.g., an authorization and a reversal. + # Expected to be unique per acquirer within a window of time. For some card + # networks the retrieval reference number includes the trace counter. + retrieval_reference_number:, + # A counter used to verify an individual authorization. Expected to be unique per + # acquirer within a window of time. + trace_number:, + # A globally unique transaction identifier provided by the card network, used + # across multiple life-cycle requests. + transaction_id: + ); end sig do override .returns( @@ -6221,26 +6701,55 @@ module Increase .returns(T.attached_class) end def self.new( + # The Card Settlement identifier. id:, + # The amount in the minor unit of the transaction's settlement currency. For + # dollars, for example, this is cents. amount:, + # The Card Authorization that was created prior to this Card Settlement, if one + # exists. card_authorization:, + # The ID of the Card Payment this transaction belongs to. card_payment_id:, + # Cashback earned on this transaction, if eligible. Cashback is paid out in + # aggregate, monthly. cashback:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's settlement currency. currency:, + # Interchange assessed as a part of this transaction. interchange:, + # The merchant identifier (commonly abbreviated as MID) of the merchant the card + # is transacting with. merchant_acceptor_id:, + # The 4-digit MCC describing the merchant's business. merchant_category_code:, + # The city the merchant resides in. merchant_city:, + # The country the merchant resides in. merchant_country:, + # The name of the merchant. merchant_name:, + # The merchant's postal code. For US merchants this is always a 5-digit ZIP code. merchant_postal_code:, + # The state the merchant resides in. merchant_state:, + # Network-specific identifiers for this refund. network_identifiers:, + # The identifier of the Pending Transaction associated with this Transaction. pending_transaction_id:, + # The amount in the minor unit of the transaction's presentment currency. presentment_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's presentment currency. presentment_currency:, + # Additional details about the card purchase, such as tax and industry-specific + # fields. purchase_details:, + # The identifier of the Transaction associated with this Transaction. transaction_id:, + # A constant representing the object's type. For this resource it will always be + # `card_settlement`. type: ); end sig do @@ -6293,8 +6802,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, currency:); end - + def self.new( + # The cashback amount given as a string containing a decimal number. The amount is + # a positive number if it will be credited to you (e.g., settlements) and a + # negative number if it will be debited (e.g., refunds). + amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. + currency: + ); end sig do override .returns( @@ -6405,8 +6920,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, code:, currency:); end - + def self.new( + # The interchange amount given as a string containing a decimal number in major + # units (so e.g., "3.14" for $3.14). The amount is a positive number if it is + # credited to Increase (e.g., settlements) and a negative number if it is debited + # (e.g., refunds). + amount:, + # The card network specific interchange code. + code:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange + # reimbursement. + currency: + ); end sig do override .returns( @@ -6486,8 +7011,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(acquirer_business_id:, acquirer_reference_number:, transaction_id:); end - + def self.new( + # A network assigned business ID that identifies the acquirer that processed this + # transaction. + acquirer_business_id:, + # A globally unique identifier for this settlement. + acquirer_reference_number:, + # A globally unique transaction identifier provided by the card network, used + # across multiple life-cycle requests. + transaction_id: + ); end sig do override .returns( @@ -6624,15 +7157,27 @@ module Increase .returns(T.attached_class) end def self.new( + # Fields specific to car rentals. car_rental:, + # An identifier from the merchant for the customer or consumer. customer_reference_identifier:, + # The state or provincial tax amount in minor units. local_tax_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax + # assessed. local_tax_currency:, + # Fields specific to lodging. lodging:, + # The national tax amount in minor units. national_tax_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax + # assessed. national_tax_currency:, + # An identifier from the merchant for the purchase to the issuer and cardholder. purchase_identifier:, + # The format of the purchase identifier. purchase_identifier_format:, + # Fields specific to travel. travel: ); end sig do @@ -6768,21 +7313,45 @@ module Increase .returns(T.attached_class) end def self.new( + # Code indicating the vehicle's class. car_class_code:, + # Date the customer picked up the car or, in the case of a no-show or pre-pay + # transaction, the scheduled pick up date. checkout_date:, + # Daily rate being charged for the vehicle. daily_rental_rate_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental + # rate. daily_rental_rate_currency:, + # Number of days the vehicle was rented. days_rented:, + # Additional charges (gas, late fee, etc.) being billed. extra_charges:, + # Fuel charges for the vehicle. fuel_charges_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges + # assessed. fuel_charges_currency:, + # Any insurance being charged for the vehicle. insurance_charges_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance + # charges assessed. insurance_charges_currency:, + # An indicator that the cardholder is being billed for a reserved vehicle that was + # not actually rented (that is, a "no-show" charge). no_show_indicator:, + # Charges for returning the vehicle at a different location than where it was + # picked up. one_way_drop_off_charges_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way + # drop-off charges assessed. one_way_drop_off_charges_currency:, + # Name of the person renting the vehicle. renter_name:, + # Weekly rate being charged for the vehicle. weekly_rental_rate_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly + # rental rate. weekly_rental_rate_currency: ); end sig do @@ -7025,21 +7594,44 @@ module Increase .returns(T.attached_class) end def self.new( + # Date the customer checked in. check_in_date:, + # Daily rate being charged for the room. daily_room_rate_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room + # rate. daily_room_rate_currency:, + # Additional charges (phone, late check-out, etc.) being billed. extra_charges:, + # Folio cash advances for the room. folio_cash_advances_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash + # advances. folio_cash_advances_currency:, + # Food and beverage charges for the room. food_beverage_charges_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and + # beverage charges. food_beverage_charges_currency:, + # Indicator that the cardholder is being billed for a reserved room that was not + # actually used. no_show_indicator:, + # Prepaid expenses being charged for the room. prepaid_expenses_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid + # expenses. prepaid_expenses_currency:, + # Number of nights the room was rented. room_nights:, + # Total room tax being charged. total_room_tax_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room + # tax. total_room_tax_currency:, + # Total tax being charged for the room. total_tax_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax + # assessed. total_tax_currency: ); end sig do @@ -7361,17 +7953,29 @@ module Increase .returns(T.attached_class) end def self.new( + # Ancillary purchases in addition to the airfare. ancillary:, + # Indicates the computerized reservation system used to book the ticket. computerized_reservation_system:, + # Indicates the reason for a credit to the cardholder. credit_reason_indicator:, + # Date of departure. departure_date:, + # Code for the originating city or airport. origination_city_airport_code:, + # Name of the passenger. passenger_name:, + # Indicates whether this ticket is non-refundable. restricted_ticket_indicator:, + # Indicates why a ticket was changed. ticket_change_indicator:, + # Ticket number. ticket_number:, + # Code for the travel agency if the ticket was issued by a travel agency. travel_agency_code:, + # Name of the travel agency if the ticket was issued by a travel agency. travel_agency_name:, + # Fields specific to each leg of the journey. trip_legs: ); end sig do @@ -7455,10 +8059,17 @@ module Increase .returns(T.attached_class) end def self.new( + # If this purchase has a connection or relationship to another purchase, such as a + # baggage fee for a passenger transport ticket, this field should contain the + # ticket document number for the other purchase. connected_ticket_document_number:, + # Indicates the reason for a credit to the cardholder. credit_reason_indicator:, + # Name of the passenger or description of the ancillary purchase. passenger_name_or_description:, + # Additional travel charges, such as baggage fees. services:, + # Ticket document number. ticket_document_number: ); end sig do @@ -7550,8 +8161,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(category:, sub_category:); end - + def self.new( + # Category of the ancillary service. + category:, + # Sub-category of the ancillary service, free-form. + sub_category: + ); end sig do override .returns( @@ -7941,11 +8556,17 @@ module Increase .returns(T.attached_class) end def self.new( + # Carrier code (e.g., United Airlines, Jet Blue, etc.). carrier_code:, + # Code for the destination city or airport. destination_city_airport_code:, + # Fare basis code. fare_basis_code:, + # Flight number. flight_number:, + # Service class (e.g., first class, business class, etc.). service_class:, + # Indicates whether a stopover is allowed on this ticket. stop_over_code: ); end sig do @@ -8179,25 +8800,56 @@ module Increase .returns(T.attached_class) end def self.new( + # The Card Validation identifier. id:, + # Whether this authorization was approved by Increase, the card network through + # stand-in processing, or the user through a real-time decision. actioner:, + # The ID of the Card Payment this transaction belongs to. card_payment_id:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's currency. currency:, + # If the authorization was made via a Digital Wallet Token (such as an Apple Pay + # purchase), the identifier of the token that was used. digital_wallet_token_id:, + # The merchant identifier (commonly abbreviated as MID) of the merchant the card + # is transacting with. merchant_acceptor_id:, + # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the + # card is transacting with. merchant_category_code:, + # The city the merchant resides in. merchant_city:, + # The country the merchant resides in. merchant_country:, + # The merchant descriptor of the merchant the card is transacting with. merchant_descriptor:, + # The merchant's postal code. For US merchants this is either a 5-digit or 9-digit + # ZIP code, where the first 5 and last 4 are separated by a dash. merchant_postal_code:, + # The state the merchant resides in. merchant_state:, + # Fields specific to the `network`. network_details:, + # Network-specific identifiers for a specific request or transaction. network_identifiers:, + # The risk score generated by the card network. For Visa this is the Visa Advanced + # Authorization risk score, from 0 to 99, where 99 is the riskiest. network_risk_score:, + # If the authorization was made in-person with a physical card, the Physical Card + # that was used. physical_card_id:, + # The identifier of the Real-Time Decision sent to approve or decline this + # transaction. real_time_decision_id:, + # The terminal identifier (commonly abbreviated as TID) of the terminal the card + # is transacting with. terminal_id:, + # A constant representing the object's type. For this resource it will always be + # `card_validation`. type:, + # Fields related to verification of cardholder-provided values. verification: ); end sig do @@ -8318,8 +8970,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(category:, visa:); end - + def self.new( + # The payment network used to process this card authorization. + category:, + # Fields specific to the `visa` network. + visa: + ); end sig do override .returns( @@ -8406,12 +9062,17 @@ module Increase .returns(T.attached_class) end def self.new( + # For electronic commerce transactions, this identifies the level of security used + # in obtaining the customer's payment credential. For mail or telephone order + # transactions, identifies the type of mail or telephone order. electronic_commerce_indicator:, + # The method used to enter the cardholder's primary account number and card + # expiration date. point_of_service_entry_mode:, + # Only present when `actioner: network`. Describes why a card authorization was + # approved or declined by Visa through stand-in processing. stand_in_processing_reason: - ) - end - + ); end sig do override .returns( @@ -8700,8 +9361,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(retrieval_reference_number:, trace_number:, transaction_id:); end - + def self.new( + # A life-cycle identifier used across e.g., an authorization and a reversal. + # Expected to be unique per acquirer within a window of time. For some card + # networks the retrieval reference number includes the trace counter. + retrieval_reference_number:, + # A counter used to verify an individual authorization. Expected to be unique per + # acquirer within a window of time. + trace_number:, + # A globally unique transaction identifier provided by the card network, used + # across multiple life-cycle requests. + transaction_id: + ); end sig do override .returns( @@ -8778,8 +9449,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(card_verification_code:, cardholder_address:); end - + def self.new( + # Fields related to verification of the Card Verification Code, a 3-digit code on + # the back of the card. + card_verification_code:, + # Cardholder address provided in the authorization request and the address on file + # we verified it against. + cardholder_address: + ); end sig do override .returns( @@ -8808,8 +9485,10 @@ module Increase ) .returns(T.attached_class) end - def self.new(result:); end - + def self.new( + # The result of verifying the Card Verification Code. + result: + ); end sig do override .returns( @@ -8902,14 +9581,18 @@ module Increase .returns(T.attached_class) end def self.new( + # Line 1 of the address on file for the cardholder. actual_line1:, + # The postal code of the address on file for the cardholder. actual_postal_code:, + # The cardholder address line 1 provided for verification in the authorization + # request. provided_line1:, + # The postal code provided for verification in the authorization request. provided_postal_code:, + # The address verification result returned to the card network. result: - ) - end - + ); end sig do override .returns( @@ -9078,14 +9761,22 @@ module Increase .returns(T.attached_class) end def self.new( + # The total authorized amount in the minor unit of the transaction's currency. For + # dollars, for example, this is cents. authorized_amount:, + # The total amount from fuel confirmations in the minor unit of the transaction's + # currency. For dollars, for example, this is cents. fuel_confirmed_amount:, + # The total incrementally updated authorized amount in the minor unit of the + # transaction's currency. For dollars, for example, this is cents. incremented_amount:, + # The total reversed amount in the minor unit of the transaction's currency. For + # dollars, for example, this is cents. reversed_amount:, + # The total settled or refunded amount in the minor unit of the transaction's + # currency. For dollars, for example, this is cents. settled_amount: - ) - end - + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/card_payment_list_params.rbi b/rbi/lib/increase/models/card_payment_list_params.rbi index 102a21d2c..c7981a393 100644 --- a/rbi/lib/increase/models/card_payment_list_params.rbi +++ b/rbi/lib/increase/models/card_payment_list_params.rbi @@ -56,15 +56,18 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter Card Payments to ones belonging to the specified Account. account_id: nil, + # Filter Card Payments to ones belonging to the specified Card. card_id: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -116,8 +119,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end diff --git a/rbi/lib/increase/models/card_purchase_supplement.rbi b/rbi/lib/increase/models/card_purchase_supplement.rbi index 83d90c2c4..ee5167f22 100644 --- a/rbi/lib/increase/models/card_purchase_supplement.rbi +++ b/rbi/lib/increase/models/card_purchase_supplement.rbi @@ -51,8 +51,21 @@ module Increase ) .returns(T.attached_class) end - def self.new(id:, card_payment_id:, invoice:, line_items:, transaction_id:, type:); end - + def self.new( + # The Card Purchase Supplement identifier. + id:, + # The ID of the Card Payment this transaction belongs to. + card_payment_id:, + # Invoice-level information about the payment. + invoice:, + # Line item information, such as individual products purchased. + line_items:, + # The ID of the transaction. + transaction_id:, + # A constant representing the object's type. For this resource it will always be + # `card_purchase_supplement`. + type: + ); end sig do override .returns( @@ -158,21 +171,39 @@ module Increase .returns(T.attached_class) end def self.new( + # Discount given to cardholder. discount_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the discount. discount_currency:, + # Indicates how the merchant applied the discount. discount_treatment_code:, + # Amount of duty taxes. duty_tax_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the duty tax. duty_tax_currency:, + # Date the order was taken. order_date:, + # The shipping cost. shipping_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the shipping + # cost. shipping_currency:, + # Country code of the shipping destination. shipping_destination_country_code:, + # Postal code of the shipping destination. shipping_destination_postal_code:, + # Postal code of the location being shipped from. shipping_source_postal_code:, + # Taxes paid for freight and shipping. shipping_tax_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the shipping + # tax. shipping_tax_currency:, + # Tax rate for freight and shipping. shipping_tax_rate:, + # Indicates how the merchant applied taxes. tax_treatments:, + # Value added tax invoice reference number. unique_value_added_tax_invoice_reference: ); end sig do @@ -379,22 +410,41 @@ module Increase .returns(T.attached_class) end def self.new( + # The Card Purchase Supplement Line Item identifier. id:, + # Indicates the type of line item. detail_indicator:, + # Discount amount for this specific line item. discount_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the discount. discount_currency:, + # Indicates how the merchant applied the discount for this specific line item. discount_treatment_code:, + # Code used to categorize the purchase item. item_commodity_code:, + # Description of the purchase item. item_descriptor:, + # The number of units of the product being purchased. item_quantity:, + # Code used to categorize the product being purchased. product_code:, + # Sales tax amount for this line item. sales_tax_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the sales tax + # assessed. sales_tax_currency:, + # Sales tax rate for this line item. sales_tax_rate:, + # Total amount of all line items. total_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total + # amount. total_amount_currency:, + # Cost of line item per unit of measure, in major units. unit_cost:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the unit cost. unit_cost_currency:, + # Code indicating unit of measure (gallons, etc.). unit_of_measure_code: ); end sig do diff --git a/rbi/lib/increase/models/card_purchase_supplement_list_params.rbi b/rbi/lib/increase/models/card_purchase_supplement_list_params.rbi index f34b7bc88..4ae87b80a 100644 --- a/rbi/lib/increase/models/card_purchase_supplement_list_params.rbi +++ b/rbi/lib/increase/models/card_purchase_supplement_list_params.rbi @@ -50,8 +50,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(card_payment_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}); end - + def self.new( + # Filter Card Purchase Supplements to ones belonging to the specified Card + # Payment. + card_payment_id: nil, + created_at: nil, + # Return the page of entries after this one. + cursor: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. + limit: nil, + request_options: {} + ); end sig do override .returns( @@ -102,8 +112,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end diff --git a/rbi/lib/increase/models/card_update_params.rbi b/rbi/lib/increase/models/card_update_params.rbi index c56585641..5c01d9334 100644 --- a/rbi/lib/increase/models/card_update_params.rbi +++ b/rbi/lib/increase/models/card_update_params.rbi @@ -66,10 +66,18 @@ module Increase .returns(T.attached_class) end def self.new( + # The card's updated billing address. billing_address: nil, + # The description you choose to give the card. description: nil, + # The contact information used in the two-factor steps for digital wallet card + # creation. At least one field must be present to complete the digital wallet + # steps. digital_wallet: nil, + # The Entity the card belongs to. You only need to supply this in rare situations + # when the card is not for the Account holder. entity_id: nil, + # The status to update the Card with. status: nil, request_options: {} ); end @@ -117,8 +125,18 @@ module Increase params(city: String, line1: String, postal_code: String, state: String, line2: String) .returns(T.attached_class) end - def self.new(city:, line1:, postal_code:, state:, line2: nil); end - + def self.new( + # The city of the billing address. + city:, + # The first line of the billing address. + line1:, + # The postal code of the billing address. + postal_code:, + # The US state of the billing address. + state:, + # The second line of the billing address. + line2: nil + ); end sig do override.returns({city: String, line1: String, postal_code: String, state: String, line2: String}) end @@ -155,8 +173,16 @@ module Increase sig do params(digital_card_profile_id: String, email: String, phone: String).returns(T.attached_class) end - def self.new(digital_card_profile_id: nil, email: nil, phone: nil); end - + def self.new( + # The digital card profile assigned to this digital card. + digital_card_profile_id: nil, + # An email address that can be used to verify the cardholder via one-time passcode + # over email. + email: nil, + # A phone number that can be used to verify the cardholder via one-time passcode + # over SMS. + phone: nil + ); end sig { override.returns({digital_card_profile_id: String, email: String, phone: String}) } def to_hash; end end diff --git a/rbi/lib/increase/models/check_deposit.rbi b/rbi/lib/increase/models/check_deposit.rbi index 84452181f..523861809 100644 --- a/rbi/lib/increase/models/check_deposit.rbi +++ b/rbi/lib/increase/models/check_deposit.rbi @@ -151,23 +151,52 @@ module Increase .returns(T.attached_class) end def self.new( + # The deposit's identifier. id:, + # The Account the check was deposited into. account_id:, + # The deposited amount in USD cents. amount:, + # The ID for the File containing the image of the back of the check. back_image_file_id:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the transfer was created. created_at:, + # If your deposit is successfully parsed and accepted by Increase, this will + # contain details of the parsed check. deposit_acceptance:, + # If your deposit is rejected by Increase, this will contain details as to why it + # was rejected. deposit_rejection:, + # If your deposit is returned, this will contain details as to why it was + # returned. deposit_return:, + # After the check is parsed, it is submitted to the Check21 network for + # processing. This will contain details of the submission. deposit_submission:, + # The description of the Check Deposit, for display purposes only. description:, + # The ID for the File containing the image of the front of the check. front_image_file_id:, + # 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). idempotency_key:, + # Increase will sometimes hold the funds for Check Deposits. If funds are held, + # this sub-object will contain details of the hold. inbound_funds_hold:, + # If the Check Deposit was the result of an Inbound Mail Item, this will contain + # the identifier of the Inbound Mail Item. inbound_mail_item_id:, + # If the Check Deposit was the result of an Inbound Mail Item, this will contain + # the identifier of the Lockbox that received it. lockbox_id:, + # The status of the Check Deposit. status:, + # The ID for the Transaction created by the deposit. transaction_id:, + # A constant representing the object's type. For this resource it will always be + # `check_deposit`. type: ); end sig do @@ -245,16 +274,25 @@ module Increase .returns(T.attached_class) end def self.new( + # The account number printed on the check. account_number:, + # The amount to be deposited in the minor unit of the transaction's currency. For + # dollars, for example, this is cents. amount:, + # An additional line of metadata printed on the check. This typically includes the + # check number for business checks. auxiliary_on_us:, + # The ID of the Check Deposit that was accepted. check_deposit_id:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's currency. currency:, + # The routing number printed on the check. routing_number:, + # The check serial number, if present, for consumer checks. For business checks, + # the serial number is usually in the `auxiliary_on_us` field. serial_number: - ) - end - + ); end sig do override .returns( @@ -344,9 +382,23 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, check_deposit_id:, currency:, declined_transaction_id:, reason:, rejected_at:) - end - + def self.new( + # The rejected amount in the minor unit of check's currency. For dollars, for + # example, this is cents. + amount:, + # The identifier of the Check Deposit that was rejected. + check_deposit_id:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's + # currency. + currency:, + # The identifier of the associated declined transaction. + declined_transaction_id:, + # Why the check deposit was rejected. + reason:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the check deposit was rejected. + rejected_at: + ); end sig do override .returns( @@ -494,9 +546,24 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, check_deposit_id:, currency:, return_reason:, returned_at:, transaction_id:) - end - + def self.new( + # The returned amount in USD cents. + amount:, + # The identifier of the Check Deposit that was returned. + check_deposit_id:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's currency. + currency:, + # Why this check was returned by the bank holding the account it was drawn + # against. + return_reason:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the check deposit was returned. + returned_at:, + # The identifier of the transaction that reversed the original check deposit + # transaction. + transaction_id: + ); end sig do override .returns( @@ -697,8 +764,18 @@ module Increase sig do params(back_file_id: String, front_file_id: String, submitted_at: Time).returns(T.attached_class) end - def self.new(back_file_id:, front_file_id:, submitted_at:); end - + def self.new( + # The ID for the File containing the check back image that was submitted to the + # Check21 network. + back_file_id:, + # The ID for the File containing the check front image that was submitted to the + # Check21 network. + front_file_id:, + # When the check deposit was submitted to the Check21 network for processing. + # During business days, this happens within a few hours of the check being + # accepted by Increase. + submitted_at: + ); end sig { override.returns({back_file_id: String, front_file_id: String, submitted_at: Time}) } def to_hash; end end @@ -767,15 +844,30 @@ module Increase .returns(T.attached_class) end def self.new( + # The Inbound Funds Hold identifier. id:, + # The held amount in the minor unit of the account's currency. For dollars, for + # example, this is cents. amount:, + # When the hold will be released automatically. Certain conditions may cause it to + # be released before this time. automatically_releases_at:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold + # was created. created_at:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's + # currency. currency:, + # The ID of the Transaction for which funds were held. held_transaction_id:, + # The ID of the Pending Transaction representing the held funds. pending_transaction_id:, + # When the hold was released (if it has been released). released_at:, + # The status of the hold. status:, + # A constant representing the object's type. For this resource it will always be + # `inbound_funds_hold`. type: ); end sig do diff --git a/rbi/lib/increase/models/check_deposit_create_params.rbi b/rbi/lib/increase/models/check_deposit_create_params.rbi index 692492b55..7f44490f9 100644 --- a/rbi/lib/increase/models/check_deposit_create_params.rbi +++ b/rbi/lib/increase/models/check_deposit_create_params.rbi @@ -41,15 +41,18 @@ module Increase .returns(T.attached_class) end def self.new( + # The identifier for the Account to deposit the check in. account_id:, + # The deposit amount in USD cents. amount:, + # The File containing the check's back image. back_image_file_id:, + # The File containing the check's front image. front_image_file_id:, + # The description you choose to give the Check Deposit, for display purposes only. description: nil, request_options: {} - ) - end - + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/check_deposit_list_params.rbi b/rbi/lib/increase/models/check_deposit_list_params.rbi index d4918f888..d3bce29f3 100644 --- a/rbi/lib/increase/models/check_deposit_list_params.rbi +++ b/rbi/lib/increase/models/check_deposit_list_params.rbi @@ -61,15 +61,21 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter Check Deposits to those belonging to the specified Account. account_id: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # 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). idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -121,8 +127,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end diff --git a/rbi/lib/increase/models/check_transfer.rbi b/rbi/lib/increase/models/check_transfer.rbi index 52866d031..0c93d6c19 100644 --- a/rbi/lib/increase/models/check_transfer.rbi +++ b/rbi/lib/increase/models/check_transfer.rbi @@ -202,28 +202,67 @@ module Increase .returns(T.attached_class) end def self.new( + # The Check transfer's identifier. id:, + # The identifier of the Account from which funds will be transferred. account_id:, + # The account number printed on the check. account_number:, + # The transfer amount in USD cents. amount:, + # If your account requires approvals for transfers and the transfer was approved, + # this will contain details of the approval. approval:, + # If the Check Transfer was successfully deposited, this will contain the + # identifier of the Inbound Check Deposit object with details of the deposit. approved_inbound_check_deposit_id:, + # If your account requires approvals for transfers and the transfer was not + # approved, this will contain details of the cancellation. cancellation:, + # The check number printed on the check. check_number:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the transfer was created. created_at:, + # What object created the transfer, either via the API or the dashboard. created_by:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's + # currency. currency:, + # Whether Increase will print and mail the check or if you will do it yourself. fulfillment_method:, + # 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). idempotency_key:, + # If the check has been mailed by Increase, this will contain details of the + # shipment. mailing:, + # The ID for the pending transaction representing the transfer. A pending + # transaction is created when the transfer + # [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) + # by someone else in your organization. pending_transaction_id:, + # Details relating to the physical check that Increase will print and mail. Will + # be present if and only if `fulfillment_method` is equal to `physical_check`. physical_check:, + # The routing number printed on the check. routing_number:, + # The identifier of the Account Number from which to send the transfer and print + # on the check. source_account_number_id:, + # The lifecycle status of the transfer. status:, + # After a stop-payment is requested on the check, this will contain supplemental + # details. stop_payment_request:, + # After the transfer is submitted, this will contain supplemental details. submission:, + # Details relating to the custom fulfillment you will perform. Will be present if + # and only if `fulfillment_method` is equal to `third_party`. third_party:, + # A constant representing the object's type. For this resource it will always be + # `check_transfer`. type: ); end sig do @@ -272,8 +311,14 @@ module Increase # If your account requires approvals for transfers and the transfer was approved, # this will contain details of the approval. sig { params(approved_at: Time, approved_by: T.nilable(String)).returns(T.attached_class) } - def self.new(approved_at:, approved_by:); end - + def self.new( + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the transfer was approved. + approved_at:, + # If the Transfer was approved by a user in the dashboard, the email address of + # that user. + approved_by: + ); end sig { override.returns({approved_at: Time, approved_by: T.nilable(String)}) } def to_hash; end end @@ -292,8 +337,14 @@ module Increase # If your account requires approvals for transfers and the transfer was not # approved, this will contain details of the cancellation. sig { params(canceled_at: Time, canceled_by: T.nilable(String)).returns(T.attached_class) } - def self.new(canceled_at:, canceled_by:); end - + def self.new( + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the Transfer was canceled. + canceled_at:, + # If the Transfer was canceled by a user in the dashboard, the email address of + # that user. + canceled_by: + ); end sig { override.returns({canceled_at: Time, canceled_by: T.nilable(String)}) } def to_hash; end end @@ -353,8 +404,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(api_key:, category:, oauth_application:, user:); end - + def self.new( + # If present, details about the API key that created the transfer. + api_key:, + # The type of object that created this transfer. + category:, + # If present, details about the OAuth Application that created the transfer. + oauth_application:, + # If present, details about the User that created the transfer. + user: + ); end sig do override .returns( @@ -375,8 +434,10 @@ module Increase # If present, details about the API key that created the transfer. sig { params(description: T.nilable(String)).returns(T.attached_class) } - def self.new(description:); end - + def self.new( + # The description set for the API key when it was created. + description: + ); end sig { override.returns({description: T.nilable(String)}) } def to_hash; end end @@ -409,8 +470,10 @@ module Increase # If present, details about the OAuth Application that created the transfer. sig { params(name: String).returns(T.attached_class) } - def self.new(name:); end - + def self.new( + # The name of the OAuth Application. + name: + ); end sig { override.returns({name: String}) } def to_hash; end end @@ -422,8 +485,10 @@ module Increase # If present, details about the User that created the transfer. sig { params(email: String).returns(T.attached_class) } - def self.new(email:); end - + def self.new( + # The email address of the User. + email: + ); end sig { override.returns({email: String}) } def to_hash; end end @@ -497,8 +562,16 @@ module Increase params(image_id: T.nilable(String), mailed_at: Time, tracking_number: T.nilable(String)) .returns(T.attached_class) end - def self.new(image_id:, mailed_at:, tracking_number:); end - + def self.new( + # The ID of the file corresponding to an image of the check that was mailed, if + # available. + image_id:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the check was mailed. + mailed_at:, + # The tracking number of the shipment, if available for the shipping method. + tracking_number: + ); end sig do override.returns({image_id: T.nilable(String), mailed_at: Time, tracking_number: T.nilable(String)}) end @@ -580,14 +653,24 @@ module Increase .returns(T.attached_class) end def self.new( + # The ID of the file for the check attachment. attachment_file_id:, + # Details for where Increase will mail the check. mailing_address:, + # The descriptor that will be printed on the memo field on the check. memo:, + # The descriptor that will be printed on the letter included with the check. note:, + # The name that will be printed on the check. recipient_name:, + # The return address to be printed on the check. return_address:, + # The shipping method for the check. shipping_method:, + # The text that will appear as the signature on the check in cursive font. If + # blank, the check will be printed with 'No signature required'. signature_text:, + # Tracking updates relating to the physical check's delivery. tracking_updates: ); end sig do @@ -645,8 +728,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(city:, line1:, line2:, name:, postal_code:, state:); end - + def self.new( + # The city of the check's destination. + city:, + # The street address of the check's destination. + line1:, + # The second line of the address of the check's destination. + line2:, + # The name component of the check's mailing address. + name:, + # The postal code of the check's destination. + postal_code:, + # The state of the check's destination. + state: + ); end sig do override .returns( @@ -700,8 +795,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(city:, line1:, line2:, name:, postal_code:, state:); end - + def self.new( + # The city of the check's destination. + city:, + # The street address of the check's destination. + line1:, + # The second line of the address of the check's destination. + line2:, + # The name component of the check's return address. + name:, + # The postal code of the check's destination. + postal_code:, + # The state of the check's destination. + state: + ); end sig do override .returns( @@ -760,8 +867,15 @@ module Increase ) .returns(T.attached_class) end - def self.new(category:, created_at:, postal_code:); end - + def self.new( + # The type of tracking event. + category:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the tracking event took place. + created_at:, + # The postal code where the event took place. + postal_code: + ); end sig do override .returns( @@ -883,8 +997,17 @@ module Increase ) .returns(T.attached_class) end - def self.new(reason:, requested_at:, transfer_id:, type:); end - + def self.new( + # The reason why this transfer was stopped. + reason:, + # The time the stop-payment was requested. + requested_at:, + # The ID of the check transfer that was stopped. + transfer_id:, + # A constant representing the object's type. For this resource it will always be + # `check_transfer_stop_payment_request`. + type: + ); end sig do override .returns( @@ -978,8 +1101,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(address_correction_action:, submitted_address:, submitted_at:); end - + def self.new( + # Per USPS requirements, Increase will standardize the address to USPS standards + # and check it against the USPS National Change of Address (NCOA) database before + # mailing it. This indicates what modifications, if any, were made to the address + # before printing and mailing the check. + address_correction_action:, + # The address we submitted to the printer. This is what is physically printed on + # the check. + submitted_address:, + # When this check transfer was submitted to our check printer. + submitted_at: + ); end sig do override .returns( @@ -1068,8 +1201,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(city:, line1:, line2:, recipient_name:, state:, zip:); end - + def self.new( + # The submitted address city. + city:, + # The submitted address line 1. + line1:, + # The submitted address line 2. + line2:, + # The submitted recipient name. + recipient_name:, + # The submitted address state. + state:, + # The submitted address zip. + zip: + ); end sig do override .returns( @@ -1095,8 +1240,10 @@ module Increase # Details relating to the custom fulfillment you will perform. Will be present if # and only if `fulfillment_method` is equal to `third_party`. sig { params(recipient_name: T.nilable(String)).returns(T.attached_class) } - def self.new(recipient_name:); end - + def self.new( + # The name that you will print on the check. + recipient_name: + ); end sig { override.returns({recipient_name: T.nilable(String)}) } def to_hash; end end diff --git a/rbi/lib/increase/models/check_transfer_create_params.rbi b/rbi/lib/increase/models/check_transfer_create_params.rbi index 1c7f0fcea..e1b18c19b 100644 --- a/rbi/lib/increase/models/check_transfer_create_params.rbi +++ b/rbi/lib/increase/models/check_transfer_create_params.rbi @@ -72,12 +72,24 @@ module Increase .returns(T.attached_class) end def self.new( + # The identifier for the account that will send the transfer. account_id:, + # The transfer amount in USD cents. amount:, + # Whether Increase will print and mail the check or if you will do it yourself. fulfillment_method:, + # The identifier of the Account Number from which to send the transfer and print + # on the check. source_account_number_id:, + # 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. physical_check: nil, + # Whether the transfer requires explicit approval via the dashboard or API. require_approval: nil, + # 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. third_party: nil, request_options: {} ); end @@ -229,14 +241,31 @@ module Increase .returns(T.attached_class) end def self.new( + # Details for where Increase will mail the check. mailing_address:, + # The descriptor that will be printed on the memo field on the check. memo:, + # The name that will be printed on the check in the 'To:' field. recipient_name:, + # 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 . attachment_file_id: nil, + # The check number Increase should print on 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. check_number: nil, + # The descriptor that will be printed on the letter included with the check. note: 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. return_address: nil, + # How to ship the check. For details on pricing, timing, and restrictions, see + # https://increase.com/documentation/originating-checks#printing-checks . shipping_method: nil, + # 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'. signature_text: nil ); end sig do @@ -286,8 +315,18 @@ module Increase params(city: String, line1: String, postal_code: String, state: String, line2: String) .returns(T.attached_class) end - def self.new(city:, line1:, postal_code:, state:, line2: nil); end - + def self.new( + # The city component of the check's destination address. + city:, + # The first line of the address component of the check's destination address. + line1:, + # The postal code component of the check's destination address. + postal_code:, + # The US state component of the check's destination address. + state:, + # The second line of the address component of the check's destination address. + line2: nil + ); end sig do override.returns({city: String, line1: String, postal_code: String, state: String, line2: String}) end @@ -336,8 +375,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(city:, line1:, name:, postal_code:, state:, line2: nil); end - + def self.new( + # The city of the return address. + city:, + # The first line of the return address. + line1:, + # The name of the return address. + name:, + # The postal code of the return address. + postal_code:, + # The US state of the return address. + state:, + # The second line of the return address. + line2: nil + ); end sig do override .returns({ @@ -399,8 +450,12 @@ module Increase # `fulfillment_method` is equal to `third_party`. It must not be included if any # other `fulfillment_method` is provided. sig { params(recipient_name: String).returns(T.attached_class) } - def self.new(recipient_name: nil); end - + def self.new( + # 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. + recipient_name: nil + ); end sig { override.returns({recipient_name: String}) } def to_hash; end end diff --git a/rbi/lib/increase/models/check_transfer_list_params.rbi b/rbi/lib/increase/models/check_transfer_list_params.rbi index d05c845af..1aa810d49 100644 --- a/rbi/lib/increase/models/check_transfer_list_params.rbi +++ b/rbi/lib/increase/models/check_transfer_list_params.rbi @@ -68,10 +68,18 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter Check Transfers to those that originated from the specified Account. account_id: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # 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). idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, status: nil, request_options: {} @@ -128,8 +136,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end @@ -148,8 +168,12 @@ module Increase params(in_: T::Array[Increase::Models::CheckTransferListParams::Status::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # 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`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::CheckTransferListParams::Status::In::OrSymbol]}) } def to_hash; end diff --git a/rbi/lib/increase/models/check_transfer_stop_payment_params.rbi b/rbi/lib/increase/models/check_transfer_stop_payment_params.rbi index 489d232d8..886696488 100644 --- a/rbi/lib/increase/models/check_transfer_stop_payment_params.rbi +++ b/rbi/lib/increase/models/check_transfer_stop_payment_params.rbi @@ -20,8 +20,11 @@ module Increase ) .returns(T.attached_class) end - def self.new(reason: nil, request_options: {}); end - + def self.new( + # The reason why this transfer should be stopped. + reason: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/declined_transaction.rbi b/rbi/lib/increase/models/declined_transaction.rbi index e15f5ef74..18ae95072 100644 --- a/rbi/lib/increase/models/declined_transaction.rbi +++ b/rbi/lib/increase/models/declined_transaction.rbi @@ -75,19 +75,37 @@ module Increase .returns(T.attached_class) end def self.new( + # The Declined Transaction identifier. id:, + # The identifier for the Account the Declined Transaction belongs to. account_id:, + # The Declined Transaction amount in the minor unit of its currency. For dollars, + # for example, this is cents. amount:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the + # Transaction occurred. created_at:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined + # Transaction's currency. This will match the currency on the Declined + # Transaction's Account. currency:, + # This is the description the vendor provides. description:, + # The identifier for the route this Declined Transaction came through. Routes are + # things like cards and ACH details. route_id:, + # The type of the route this Declined Transaction came through. route_type:, + # This is an object giving more details on the network-level event that caused the + # Declined Transaction. For example, for a card transaction this lists the + # merchant's industry and location. Note that for backwards compatibility reasons, + # additional undocumented keys may appear in this object. These should be treated + # as deprecated and will be removed in the future. source:, + # A constant representing the object's type. For this resource it will always be + # `declined_transaction`. type: - ) - end - + ); end sig do override .returns( @@ -281,13 +299,30 @@ module Increase .returns(T.attached_class) end def self.new( + # An ACH Decline object. This field will be present in the JSON response if and + # only if `category` is equal to `ach_decline`. ach_decline:, + # A Card Decline object. This field will be present in the JSON response if and + # only if `category` is equal to `card_decline`. card_decline:, + # The type of the resource. We may add additional possible values for this enum + # over time; your application should be able to handle such additions gracefully. category:, + # A Check Decline object. This field will be present in the JSON response if and + # only if `category` is equal to `check_decline`. check_decline:, + # A Check Deposit Rejection object. This field will be present in the JSON + # response if and only if `category` is equal to `check_deposit_rejection`. check_deposit_rejection:, + # An Inbound Real-Time Payments Transfer Decline object. This field will be + # present in the JSON response if and only if `category` is equal to + # `inbound_real_time_payments_transfer_decline`. inbound_real_time_payments_transfer_decline:, + # If the category of this Transaction source is equal to `other`, this field will + # contain an empty object, otherwise it will contain null. other:, + # A Wire Decline object. This field will be present in the JSON response if and + # only if `category` is equal to `wire_decline`. wire_decline: ); end sig do @@ -377,17 +412,30 @@ module Increase .returns(T.attached_class) end def self.new( + # The ACH Decline's identifier. id:, + # The declined amount in USD cents. amount:, + # The identifier of the Inbound ACH Transfer object associated with this decline. inbound_ach_transfer_id:, + # The descriptive date of the transfer. originator_company_descriptive_date:, + # The additional information included with the transfer. originator_company_discretionary_data:, + # The identifier of the company that initiated the transfer. originator_company_id:, + # The name of the company that initiated the transfer. originator_company_name:, + # Why the ACH transfer was declined. reason:, + # The id of the receiver of the transfer. receiver_id_number:, + # The name of the receiver of the transfer. receiver_name:, + # The trace number of the transfer. trace_number:, + # A constant representing the object's type. For this resource it will always be + # `ach_decline`. type: ); end sig do @@ -750,32 +798,74 @@ module Increase .returns(T.attached_class) end def self.new( + # The Card Decline identifier. id:, + # Whether this authorization was approved by Increase, the card network through + # stand-in processing, or the user through a real-time decision. actioner:, + # The declined amount in the minor unit of the destination account currency. For + # dollars, for example, this is cents. amount:, + # The ID of the Card Payment this transaction belongs to. card_payment_id:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination + # account currency. currency:, + # The identifier of the declined transaction created for this Card Decline. declined_transaction_id:, + # If the authorization was made via a Digital Wallet Token (such as an Apple Pay + # purchase), the identifier of the token that was used. digital_wallet_token_id:, + # The direction describes the direction the funds will move, either from the + # cardholder to the merchant or from the merchant to the cardholder. direction:, + # The merchant identifier (commonly abbreviated as MID) of the merchant the card + # is transacting with. merchant_acceptor_id:, + # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the + # card is transacting with. merchant_category_code:, + # The city the merchant resides in. merchant_city:, + # The country the merchant resides in. merchant_country:, + # The merchant descriptor of the merchant the card is transacting with. merchant_descriptor:, + # The merchant's postal code. For US merchants this is either a 5-digit or 9-digit + # ZIP code, where the first 5 and last 4 are separated by a dash. merchant_postal_code:, + # The state the merchant resides in. merchant_state:, + # Fields specific to the `network`. network_details:, + # Network-specific identifiers for a specific request or transaction. network_identifiers:, + # The risk score generated by the card network. For Visa this is the Visa Advanced + # Authorization risk score, from 0 to 99, where 99 is the riskiest. network_risk_score:, + # If the authorization was made in-person with a physical card, the Physical Card + # that was used. physical_card_id:, + # The declined amount in the minor unit of the transaction's presentment currency. presentment_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's presentment currency. presentment_currency:, + # The processing category describes the intent behind the authorization, such as + # whether it was used for bill payments or an automatic fuel dispenser. processing_category:, + # The identifier of the Real-Time Decision sent to approve or decline this + # transaction. real_time_decision_id:, + # This is present if a specific decline reason was given in the real-time + # decision. real_time_decision_reason:, + # Why the transaction was declined. reason:, + # The terminal identifier (commonly abbreviated as TID) of the terminal the card + # is transacting with. terminal_id:, + # Fields related to verification of cardholder-provided values. verification: ); end sig do @@ -940,8 +1030,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(category:, visa:); end - + def self.new( + # The payment network used to process this card authorization. + category:, + # Fields specific to the `visa` network. + visa: + ); end sig do override .returns( @@ -1028,12 +1122,17 @@ module Increase .returns(T.attached_class) end def self.new( + # For electronic commerce transactions, this identifies the level of security used + # in obtaining the customer's payment credential. For mail or telephone order + # transactions, identifies the type of mail or telephone order. electronic_commerce_indicator:, + # The method used to enter the cardholder's primary account number and card + # expiration date. point_of_service_entry_mode:, + # Only present when `actioner: network`. Describes why a card authorization was + # approved or declined by Visa through stand-in processing. stand_in_processing_reason: - ) - end - + ); end sig do override .returns( @@ -1322,8 +1421,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(retrieval_reference_number:, trace_number:, transaction_id:); end - + def self.new( + # A life-cycle identifier used across e.g., an authorization and a reversal. + # Expected to be unique per acquirer within a window of time. For some card + # networks the retrieval reference number includes the trace counter. + retrieval_reference_number:, + # A counter used to verify an individual authorization. Expected to be unique per + # acquirer within a window of time. + trace_number:, + # A globally unique transaction identifier provided by the card network, used + # across multiple life-cycle requests. + transaction_id: + ); end sig do override .returns( @@ -1621,8 +1730,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(card_verification_code:, cardholder_address:); end - + def self.new( + # Fields related to verification of the Card Verification Code, a 3-digit code on + # the back of the card. + card_verification_code:, + # Cardholder address provided in the authorization request and the address on file + # we verified it against. + cardholder_address: + ); end sig do override .returns( @@ -1651,8 +1766,10 @@ module Increase ) .returns(T.attached_class) end - def self.new(result:); end - + def self.new( + # The result of verifying the Card Verification Code. + result: + ); end sig do override .returns( @@ -1745,14 +1862,18 @@ module Increase .returns(T.attached_class) end def self.new( + # Line 1 of the address on file for the cardholder. actual_line1:, + # The postal code of the address on file for the cardholder. actual_postal_code:, + # The cardholder address line 1 provided for verification in the authorization + # request. provided_line1:, + # The postal code provided for verification in the authorization request. provided_postal_code:, + # The address verification result returned to the card network. result: - ) - end - + ); end sig do override .returns( @@ -1922,12 +2043,23 @@ module Increase .returns(T.attached_class) end def self.new( + # The declined amount in USD cents. amount:, + # A computer-readable number printed on the MICR line of business checks, usually + # the check number. This is useful for positive pay checks, but can be unreliably + # transmitted by the bank of first deposit. auxiliary_on_us:, + # The identifier of the API File object containing an image of the back of the + # declined check. back_image_file_id:, + # The identifier of the Check Transfer object associated with this decline. check_transfer_id:, + # The identifier of the API File object containing an image of the front of the + # declined check. front_image_file_id:, + # The identifier of the Inbound Check Deposit object associated with this decline. inbound_check_deposit_id:, + # Why the check was declined. reason: ); end sig do @@ -2102,15 +2234,22 @@ module Increase .returns(T.attached_class) end def self.new( + # The rejected amount in the minor unit of check's currency. For dollars, for + # example, this is cents. amount:, + # The identifier of the Check Deposit that was rejected. check_deposit_id:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's + # currency. currency:, + # The identifier of the associated declined transaction. declined_transaction_id:, + # Why the check deposit was rejected. reason:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the check deposit was rejected. rejected_at: - ) - end - + ); end sig do override .returns( @@ -2334,15 +2473,28 @@ module Increase .returns(T.attached_class) end def self.new( + # The declined amount in the minor unit of the destination account currency. For + # dollars, for example, this is cents. amount:, + # The name the sender of the transfer specified as the recipient of the transfer. creditor_name:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined + # transfer's currency. This will always be "USD" for a Real-Time Payments + # transfer. currency:, + # The account number of the account that sent the transfer. debtor_account_number:, + # The name provided by the sender of the transfer. debtor_name:, + # The routing number of the account that sent the transfer. debtor_routing_number:, + # Why the transfer was declined. reason:, + # Additional information included with the transfer. remittance_information:, + # The Real-Time Payments network identification of the declined transfer. transaction_identification:, + # The identifier of the Real-Time Payments Transfer that led to this Transaction. transfer_id: ); end sig do @@ -2511,8 +2663,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(inbound_wire_transfer_id:, reason:); end - + def self.new( + # The identifier of the Inbound Wire Transfer that was declined. + inbound_wire_transfer_id:, + # Why the wire transfer was declined. + reason: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/declined_transaction_list_params.rbi b/rbi/lib/increase/models/declined_transaction_list_params.rbi index 413884f9f..127450cb1 100644 --- a/rbi/lib/increase/models/declined_transaction_list_params.rbi +++ b/rbi/lib/increase/models/declined_transaction_list_params.rbi @@ -70,11 +70,16 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter Declined Transactions to ones belonging to the specified Account. account_id: nil, category: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, + # Filter Declined Transactions to those belonging to the specified route. route_id: nil, request_options: {} ); end @@ -107,8 +112,11 @@ module Increase params(in_: T::Array[Increase::Models::DeclinedTransactionListParams::Category::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # Return results whose value is in the provided list. For GET requests, this + # should be encoded as a comma-delimited string, such as `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::DeclinedTransactionListParams::Category::In::OrSymbol]}) } def to_hash; end @@ -193,8 +201,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end diff --git a/rbi/lib/increase/models/digital_card_profile.rbi b/rbi/lib/increase/models/digital_card_profile.rbi index ada1b2ba1..03db3582f 100644 --- a/rbi/lib/increase/models/digital_card_profile.rbi +++ b/rbi/lib/increase/models/digital_card_profile.rbi @@ -92,19 +92,37 @@ module Increase .returns(T.attached_class) end def self.new( + # The Card Profile identifier. id:, + # The identifier of the File containing the card's icon image. app_icon_file_id:, + # The identifier of the File containing the card's front image. background_image_file_id:, + # A user-facing description for the card itself. card_description:, + # An email address the user can contact to receive support for their card. contact_email:, + # A phone number the user can contact to receive support for their card. contact_phone:, + # A website the user can visit to view and receive support for their card. contact_website:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the Card Dispute was created. created_at:, + # A description you can use to identify the Card Profile. description:, + # 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). idempotency_key:, + # A user-facing description for whoever is issuing the card. issuer_name:, + # The status of the Card Profile. status:, + # The Card's text color, specified as an RGB triple. text_color:, + # A constant representing the object's type. For this resource it will always be + # `digital_card_profile`. type: ); end sig do @@ -168,8 +186,14 @@ module Increase # The Card's text color, specified as an RGB triple. sig { params(blue: Integer, green: Integer, red: Integer).returns(T.attached_class) } - def self.new(blue:, green:, red:); end - + def self.new( + # The value of the blue channel in the RGB color. + blue:, + # The value of the green channel in the RGB color. + green:, + # The value of the red channel in the RGB color. + red: + ); end sig { override.returns({blue: Integer, green: Integer, red: Integer}) } def to_hash; end end diff --git a/rbi/lib/increase/models/digital_card_profile_clone_params.rbi b/rbi/lib/increase/models/digital_card_profile_clone_params.rbi index 762a0d620..3b31f41f9 100644 --- a/rbi/lib/increase/models/digital_card_profile_clone_params.rbi +++ b/rbi/lib/increase/models/digital_card_profile_clone_params.rbi @@ -90,14 +90,23 @@ module Increase .returns(T.attached_class) end def self.new( + # The identifier of the File containing the card's icon image. app_icon_file_id: nil, + # The identifier of the File containing the card's front image. background_image_file_id: nil, + # A user-facing description for the card itself. card_description: nil, + # An email address the user can contact to receive support for their card. contact_email: nil, + # A phone number the user can contact to receive support for their card. contact_phone: nil, + # A website the user can visit to view and receive support for their card. contact_website: nil, + # A description you can use to identify the Card Profile. description: nil, + # A user-facing description for whoever is issuing the card. issuer_name: nil, + # The Card's text color, specified as an RGB triple. The default is white. text_color: nil, request_options: {} ); end @@ -135,8 +144,14 @@ module Increase # The Card's text color, specified as an RGB triple. The default is white. sig { params(blue: Integer, green: Integer, red: Integer).returns(T.attached_class) } - def self.new(blue:, green:, red:); end - + def self.new( + # The value of the blue channel in the RGB color. + blue:, + # The value of the green channel in the RGB color. + green:, + # The value of the red channel in the RGB color. + red: + ); end sig { override.returns({blue: Integer, green: Integer, red: Integer}) } def to_hash; end end diff --git a/rbi/lib/increase/models/digital_card_profile_create_params.rbi b/rbi/lib/increase/models/digital_card_profile_create_params.rbi index 744c0c343..a9f2111f9 100644 --- a/rbi/lib/increase/models/digital_card_profile_create_params.rbi +++ b/rbi/lib/increase/models/digital_card_profile_create_params.rbi @@ -75,14 +75,23 @@ module Increase .returns(T.attached_class) end def self.new( + # The identifier of the File containing the card's icon image. app_icon_file_id:, + # The identifier of the File containing the card's front image. background_image_file_id:, + # A user-facing description for the card itself. card_description:, + # A description you can use to identify the Card Profile. description:, + # A user-facing description for whoever is issuing the card. issuer_name:, + # An email address the user can contact to receive support for their card. contact_email: nil, + # A phone number the user can contact to receive support for their card. contact_phone: nil, + # A website the user can visit to view and receive support for their card. contact_website: nil, + # The Card's text color, specified as an RGB triple. The default is white. text_color: nil, request_options: {} ); end @@ -120,8 +129,14 @@ module Increase # The Card's text color, specified as an RGB triple. The default is white. sig { params(blue: Integer, green: Integer, red: Integer).returns(T.attached_class) } - def self.new(blue:, green:, red:); end - + def self.new( + # The value of the blue channel in the RGB color. + blue:, + # The value of the green channel in the RGB color. + green:, + # The value of the red channel in the RGB color. + red: + ); end sig { override.returns({blue: Integer, green: Integer, red: Integer}) } def to_hash; end end diff --git a/rbi/lib/increase/models/digital_card_profile_list_params.rbi b/rbi/lib/increase/models/digital_card_profile_list_params.rbi index 2017138ef..7af46f960 100644 --- a/rbi/lib/increase/models/digital_card_profile_list_params.rbi +++ b/rbi/lib/increase/models/digital_card_profile_list_params.rbi @@ -50,8 +50,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}); end - + def self.new( + # Return the page of entries after this one. + cursor: nil, + # 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). + idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. + limit: nil, + status: nil, + request_options: {} + ); end sig do override .returns( @@ -80,8 +92,12 @@ module Increase params(in_: T::Array[Increase::Models::DigitalCardProfileListParams::Status::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # Filter Digital Card Profiles for those with the specified digital wallet status + # or statuses. For GET requests, this should be encoded as a comma-delimited + # string, such as `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::DigitalCardProfileListParams::Status::In::OrSymbol]}) } def to_hash; end diff --git a/rbi/lib/increase/models/digital_wallet_token.rbi b/rbi/lib/increase/models/digital_wallet_token.rbi index ec7034d44..554be831c 100644 --- a/rbi/lib/increase/models/digital_wallet_token.rbi +++ b/rbi/lib/increase/models/digital_wallet_token.rbi @@ -68,18 +68,27 @@ module Increase .returns(T.attached_class) end def self.new( + # The Digital Wallet Token identifier. id:, + # The identifier for the Card this Digital Wallet Token belongs to. card_id:, + # The cardholder information given when the Digital Wallet Token was created. cardholder:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the Digital Wallet Token was created. created_at:, + # The device that was used to create the Digital Wallet Token. device:, + # This indicates if payments can be made with the Digital Wallet Token. status:, + # The digital wallet app being used. token_requestor:, + # A constant representing the object's type. For this resource it will always be + # `digital_wallet_token`. type:, + # Updates to the Digital Wallet Token. updates: - ) - end - + ); end sig do override .returns( @@ -105,8 +114,10 @@ module Increase # The cardholder information given when the Digital Wallet Token was created. sig { params(name: T.nilable(String)).returns(T.attached_class) } - def self.new(name:); end - + def self.new( + # Name of the cardholder, for example "John Smith". + name: + ); end sig { override.returns({name: T.nilable(String)}) } def to_hash; end end @@ -138,8 +149,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(device_type:, identifier:, ip_address:, name:); end - + def self.new( + # Device type. + device_type:, + # ID assigned to the device by the digital wallet provider. + identifier:, + # IP address of the device. + ip_address:, + # Name of the device, for example "My Work Phone". + name: + ); end sig do override .returns( @@ -272,8 +291,13 @@ module Increase params(status: Increase::Models::DigitalWalletToken::Update::Status::OrSymbol, timestamp: Time) .returns(T.attached_class) end - def self.new(status:, timestamp:); end - + def self.new( + # The status the update changed this Digital Wallet Token to. + status:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the update happened. + timestamp: + ); end sig do override .returns({status: Increase::Models::DigitalWalletToken::Update::Status::TaggedSymbol, timestamp: Time}) diff --git a/rbi/lib/increase/models/digital_wallet_token_list_params.rbi b/rbi/lib/increase/models/digital_wallet_token_list_params.rbi index 6914ccc74..e6c41d171 100644 --- a/rbi/lib/increase/models/digital_wallet_token_list_params.rbi +++ b/rbi/lib/increase/models/digital_wallet_token_list_params.rbi @@ -49,8 +49,17 @@ module Increase ) .returns(T.attached_class) end - def self.new(card_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}); end - + def self.new( + # Filter Digital Wallet Tokens to ones belonging to the specified Card. + card_id: nil, + created_at: nil, + # Return the page of entries after this one. + cursor: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. + limit: nil, + request_options: {} + ); end sig do override .returns( @@ -101,8 +110,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end diff --git a/rbi/lib/increase/models/document.rbi b/rbi/lib/increase/models/document.rbi index 9dd95aa88..d9dfe0366 100644 --- a/rbi/lib/increase/models/document.rbi +++ b/rbi/lib/increase/models/document.rbi @@ -42,8 +42,22 @@ module Increase ) .returns(T.attached_class) end - def self.new(id:, category:, created_at:, entity_id:, file_id:, type:); end - + def self.new( + # The Document identifier. + id:, + # The type of document. + category:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the + # Document was created. + created_at:, + # The identifier of the Entity the document was generated for. + entity_id:, + # The identifier of the File containing the Document's contents. + file_id:, + # A constant representing the object's type. For this resource it will always be + # `document`. + type: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/document_list_params.rbi b/rbi/lib/increase/models/document_list_params.rbi index d5d51bdb4..2e7338b5a 100644 --- a/rbi/lib/increase/models/document_list_params.rbi +++ b/rbi/lib/increase/models/document_list_params.rbi @@ -57,13 +57,15 @@ module Increase def self.new( category: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # Filter Documents to ones belonging to the specified Entity. entity_id: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -93,8 +95,12 @@ module Increase params(in_: T::Array[Increase::Models::DocumentListParams::Category::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # 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`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::DocumentListParams::Category::In::OrSymbol]}) } def to_hash; end @@ -159,8 +165,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end diff --git a/rbi/lib/increase/models/entity.rbi b/rbi/lib/increase/models/entity.rbi index 0c786b833..8f549c758 100644 --- a/rbi/lib/increase/models/entity.rbi +++ b/rbi/lib/increase/models/entity.rbi @@ -133,20 +133,46 @@ module Increase .returns(T.attached_class) end def self.new( + # The entity's identifier. id:, + # Details of the corporation entity. Will be present if `structure` is equal to + # `corporation`. corporation:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity + # was created. created_at:, + # The entity's description for display purposes. description:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the + # Entity's details were most recently confirmed. details_confirmed_at:, + # Details of the government authority entity. Will be present if `structure` is + # equal to `government_authority`. government_authority:, + # 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). idempotency_key:, + # Details of the joint entity. Will be present if `structure` is equal to `joint`. joint:, + # Details of the natural person entity. Will be present if `structure` is equal to + # `natural_person`. natural_person:, + # The status of the entity. status:, + # The entity's legal structure. structure:, + # Additional documentation associated with the entity. This is limited to the + # first 10 documents for an entity. If an entity has more than 10 documents, use + # the GET /entity_supplemental_documents list endpoint to retrieve them. supplemental_documents:, + # A reference to data stored in a third-party verification service. Your + # integration may or may not use this field. third_party_verification:, + # Details of the trust entity. Will be present if `structure` is equal to `trust`. trust:, + # A constant representing the object's type. For this resource it will always be + # `entity`. type: ); end sig do @@ -223,16 +249,24 @@ module Increase .returns(T.attached_class) end def self.new( + # The corporation's address. address:, + # The identifying details of anyone controlling or owning 25% or more of the + # corporation. beneficial_owners:, + # The two-letter United States Postal Service (USPS) abbreviation for the + # corporation's state of incorporation. incorporation_state:, + # The numeric North American Industry Classification System (NAICS) code submitted + # for the corporation. industry_code:, + # The legal name of the corporation. name:, + # The Employer Identification Number (EIN) for the corporation. tax_identifier:, + # The website of the corporation. website: - ) - end - + ); end sig do override .returns( @@ -276,8 +310,19 @@ module Increase params(city: String, line1: String, line2: T.nilable(String), state: String, zip: String) .returns(T.attached_class) end - def self.new(city:, line1:, line2:, state:, zip:); end - + def self.new( + # The city of the address. + city:, + # The first line of the address. + line1:, + # The second line of the address. + line2:, + # The two-letter United States Postal Service (USPS) abbreviation for the state of + # the address. + state:, + # The ZIP code of the address. + zip: + ); end sig do override.returns( { @@ -326,8 +371,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(beneficial_owner_id:, company_title:, individual:, prong:); end - + def self.new( + # The identifier of this beneficial owner. + beneficial_owner_id:, + # This person's role or title within the entity. + company_title:, + # Personal details for the beneficial owner. + individual:, + # Why this person is considered a beneficial owner of the entity. + prong: + ); end sig do override .returns( @@ -396,8 +449,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(address:, date_of_birth:, identification:, name:); end - + def self.new( + # The person's address. + address:, + # The person's date of birth in YYYY-MM-DD format. + date_of_birth:, + # A means of verifying the person's identity. + identification:, + # The person's legal name. + name: + ); end sig do override .returns( @@ -449,8 +510,21 @@ module Increase ) .returns(T.attached_class) end - def self.new(city:, country:, line1:, line2:, state:, zip:); end - + def self.new( + # The city, district, town, or village of the address. + city:, + # The two-letter ISO 3166-1 alpha-2 code for the country of the address. + country:, + # The first line of the address. + line1:, + # The second line of the address. + line2:, + # The two-letter United States Postal Service (USPS) abbreviation for the US + # state, province, or region of the address. + state:, + # The ZIP or postal code of the address. + zip: + ); end sig do override .returns( @@ -489,8 +563,13 @@ module Increase ) .returns(T.attached_class) end - def self.new(method_:, number_last4:); end - + def self.new( + # A method that can be used to verify the individual's identity. + method_:, + # The last 4 digits of the identification number that can be used to verify the + # individual's identity. + number_last4: + ); end sig do override .returns( @@ -623,8 +702,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(address:, authorized_persons:, category:, name:, tax_identifier:, website:); end - + def self.new( + # The government authority's address. + address:, + # The identifying details of authorized persons of the government authority. + authorized_persons:, + # The category of the government authority. + category:, + # The government authority's name. + name:, + # The Employer Identification Number (EIN) of the government authority. + tax_identifier:, + # The government authority's website. + website: + ); end sig do override .returns( @@ -667,8 +758,19 @@ module Increase params(city: String, line1: String, line2: T.nilable(String), state: String, zip: String) .returns(T.attached_class) end - def self.new(city:, line1:, line2:, state:, zip:); end - + def self.new( + # The city of the address. + city:, + # The first line of the address. + line1:, + # The second line of the address. + line2:, + # The two-letter United States Postal Service (USPS) abbreviation for the state of + # the address. + state:, + # The ZIP code of the address. + zip: + ); end sig do override.returns( { @@ -693,8 +795,12 @@ module Increase attr_accessor :name sig { params(authorized_person_id: String, name: String).returns(T.attached_class) } - def self.new(authorized_person_id:, name:); end - + def self.new( + # The identifier of this authorized person. + authorized_person_id:, + # The person's legal name. + name: + ); end sig { override.returns({authorized_person_id: String, name: String}) } def to_hash; end end @@ -732,8 +838,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(individuals:, name:); end - + def self.new( + # The two individuals that share control of the entity. + individuals:, + # The entity's name. + name: + ); end sig { override.returns({individuals: T::Array[Increase::Models::Entity::Joint::Individual], name: String}) } def to_hash; end @@ -777,8 +887,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(address:, date_of_birth:, identification:, name:); end - + def self.new( + # The person's address. + address:, + # The person's date of birth in YYYY-MM-DD format. + date_of_birth:, + # A means of verifying the person's identity. + identification:, + # The person's legal name. + name: + ); end sig do override .returns( @@ -819,8 +937,19 @@ module Increase params(city: String, line1: String, line2: T.nilable(String), state: String, zip: String) .returns(T.attached_class) end - def self.new(city:, line1:, line2:, state:, zip:); end - + def self.new( + # The city of the address. + city:, + # The first line of the address. + line1:, + # The second line of the address. + line2:, + # The two-letter United States Postal Service (USPS) abbreviation for the state of + # the address. + state:, + # The ZIP code of the address. + zip: + ); end sig do override.returns( { @@ -853,8 +982,13 @@ module Increase ) .returns(T.attached_class) end - def self.new(method_:, number_last4:); end - + def self.new( + # A method that can be used to verify the individual's identity. + method_:, + # The last 4 digits of the identification number that can be used to verify the + # individual's identity. + number_last4: + ); end sig do override .returns( @@ -948,8 +1082,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(address:, date_of_birth:, identification:, name:); end - + def self.new( + # The person's address. + address:, + # The person's date of birth in YYYY-MM-DD format. + date_of_birth:, + # A means of verifying the person's identity. + identification:, + # The person's legal name. + name: + ); end sig do override .returns( @@ -990,8 +1132,19 @@ module Increase params(city: String, line1: String, line2: T.nilable(String), state: String, zip: String) .returns(T.attached_class) end - def self.new(city:, line1:, line2:, state:, zip:); end - + def self.new( + # The city of the address. + city:, + # The first line of the address. + line1:, + # The second line of the address. + line2:, + # The two-letter United States Postal Service (USPS) abbreviation for the state of + # the address. + state:, + # The ZIP code of the address. + zip: + ); end sig do override.returns( { @@ -1024,8 +1177,13 @@ module Increase ) .returns(T.attached_class) end - def self.new(method_:, number_last4:); end - + def self.new( + # A method that can be used to verify the individual's identity. + method_:, + # The last 4 digits of the identification number that can be used to verify the + # individual's identity. + number_last4: + ); end sig do override .returns( @@ -1134,8 +1292,12 @@ module Increase params(reference: String, vendor: Increase::Models::Entity::ThirdPartyVerification::Vendor::OrSymbol) .returns(T.attached_class) end - def self.new(reference:, vendor:); end - + def self.new( + # The reference identifier for the third party verification. + reference:, + # The vendor that was used to perform the verification. + vendor: + ); end sig do override .returns( @@ -1220,13 +1382,22 @@ module Increase .returns(T.attached_class) end def self.new( + # The trust's address. address:, + # Whether the trust is `revocable` or `irrevocable`. category:, + # The ID for the File containing the formation document of the trust. formation_document_file_id:, + # The two-letter United States Postal Service (USPS) abbreviation for the state in + # which the trust was formed. formation_state:, + # The grantor of the trust. Will be present if the `category` is `revocable`. grantor:, + # The trust's name. name:, + # The Employer Identification Number (EIN) of the trust itself. tax_identifier:, + # The trustees of the trust. trustees: ); end sig do @@ -1273,8 +1444,19 @@ module Increase params(city: String, line1: String, line2: T.nilable(String), state: String, zip: String) .returns(T.attached_class) end - def self.new(city:, line1:, line2:, state:, zip:); end - + def self.new( + # The city of the address. + city:, + # The first line of the address. + line1:, + # The second line of the address. + line2:, + # The two-letter United States Postal Service (USPS) abbreviation for the state of + # the address. + state:, + # The ZIP code of the address. + zip: + ); end sig do override.returns( { @@ -1346,8 +1528,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(address:, date_of_birth:, identification:, name:); end - + def self.new( + # The person's address. + address:, + # The person's date of birth in YYYY-MM-DD format. + date_of_birth:, + # A means of verifying the person's identity. + identification:, + # The person's legal name. + name: + ); end sig do override .returns( @@ -1388,8 +1578,19 @@ module Increase params(city: String, line1: String, line2: T.nilable(String), state: String, zip: String) .returns(T.attached_class) end - def self.new(city:, line1:, line2:, state:, zip:); end - + def self.new( + # The city of the address. + city:, + # The first line of the address. + line1:, + # The second line of the address. + line2:, + # The two-letter United States Postal Service (USPS) abbreviation for the state of + # the address. + state:, + # The ZIP code of the address. + zip: + ); end sig do override.returns( { @@ -1422,8 +1623,13 @@ module Increase ) .returns(T.attached_class) end - def self.new(method_:, number_last4:); end - + def self.new( + # A method that can be used to verify the individual's identity. + method_:, + # The last 4 digits of the identification number that can be used to verify the + # individual's identity. + number_last4: + ); end sig do override .returns( @@ -1499,8 +1705,13 @@ module Increase ) .returns(T.attached_class) end - def self.new(individual:, structure:); end - + def self.new( + # The individual trustee of the trust. Will be present if the trustee's + # `structure` is equal to `individual`. + individual:, + # The structure of the trustee. Will always be equal to `individual`. + structure: + ); end sig do override .returns( @@ -1556,8 +1767,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(address:, date_of_birth:, identification:, name:); end - + def self.new( + # The person's address. + address:, + # The person's date of birth in YYYY-MM-DD format. + date_of_birth:, + # A means of verifying the person's identity. + identification:, + # The person's legal name. + name: + ); end sig do override .returns( @@ -1598,8 +1817,19 @@ module Increase params(city: String, line1: String, line2: T.nilable(String), state: String, zip: String) .returns(T.attached_class) end - def self.new(city:, line1:, line2:, state:, zip:); end - + def self.new( + # The city of the address. + city:, + # The first line of the address. + line1:, + # The second line of the address. + line2:, + # The two-letter United States Postal Service (USPS) abbreviation for the state of + # the address. + state:, + # The ZIP code of the address. + zip: + ); end sig do override.returns( { @@ -1632,8 +1862,13 @@ module Increase ) .returns(T.attached_class) end - def self.new(method_:, number_last4:); end - + def self.new( + # A method that can be used to verify the individual's identity. + method_:, + # The last 4 digits of the identification number that can be used to verify the + # individual's identity. + number_last4: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/entity_archive_beneficial_owner_params.rbi b/rbi/lib/increase/models/entity_archive_beneficial_owner_params.rbi index ce24e1e85..bb9ae24d2 100644 --- a/rbi/lib/increase/models/entity_archive_beneficial_owner_params.rbi +++ b/rbi/lib/increase/models/entity_archive_beneficial_owner_params.rbi @@ -18,8 +18,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(beneficial_owner_id:, request_options: {}); end - + def self.new( + # The identifying details of anyone controlling or owning 25% or more of the + # corporation. + beneficial_owner_id:, + request_options: {} + ); end sig { override.returns({beneficial_owner_id: String, request_options: Increase::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/increase/models/entity_confirm_params.rbi b/rbi/lib/increase/models/entity_confirm_params.rbi index 00dce439c..f515fa650 100644 --- a/rbi/lib/increase/models/entity_confirm_params.rbi +++ b/rbi/lib/increase/models/entity_confirm_params.rbi @@ -21,8 +21,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(confirmed_at: nil, request_options: {}); end - + def self.new( + # When your user confirmed the Entity's details. If not provided, the current time + # will be used. + confirmed_at: nil, + request_options: {} + ); end sig { override.returns({confirmed_at: Time, request_options: Increase::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/increase/models/entity_create_beneficial_owner_params.rbi b/rbi/lib/increase/models/entity_create_beneficial_owner_params.rbi index c0edf9698..e22449c3d 100644 --- a/rbi/lib/increase/models/entity_create_beneficial_owner_params.rbi +++ b/rbi/lib/increase/models/entity_create_beneficial_owner_params.rbi @@ -26,8 +26,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(beneficial_owner:, request_options: {}); end - + def self.new( + # The identifying details of anyone controlling or owning 25% or more of the + # corporation. + beneficial_owner:, + request_options: {} + ); end sig do override .returns( @@ -81,8 +85,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(individual:, prongs:, company_title: nil); end - + def self.new( + # Personal details for the beneficial owner. + individual:, + # Why this person is considered a beneficial owner of the entity. At least one + # option is required, if a person is both a control person and owner, submit an + # array containing both. + prongs:, + # This person's role or title within the entity. + company_title: nil + ); end sig do override .returns( @@ -162,8 +174,22 @@ module Increase ) .returns(T.attached_class) end - def self.new(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil); end - + def self.new( + # The individual's physical address. Mail receiving locations like PO Boxes and + # PMB's are disallowed. + address:, + # The person's date of birth in YYYY-MM-DD format. + date_of_birth:, + # A means of verifying the person's identity. + identification:, + # The person's legal name. + name:, + # The identification method for an individual can only be a passport, driver's + # license, or other document if you've confirmed the individual does not have a US + # tax id (either a Social Security Number or Individual Taxpayer Identification + # Number). + confirmed_no_us_tax_id: nil + ); end sig do override .returns( @@ -223,8 +249,22 @@ module Increase params(country: String, line1: String, city: String, line2: String, state: String, zip: String) .returns(T.attached_class) end - def self.new(country:, line1:, city: nil, line2: nil, state: nil, zip: nil); end - + def self.new( + # The two-letter ISO 3166-1 alpha-2 code for the country of the address. + country:, + # The first line of the address. This is usually the street number and street. + line1:, + # The city, district, town, or village of the address. Required in certain + # countries. + city: nil, + # The second line of the address. This might be the floor or room number. + line2: nil, + # The two-letter United States Postal Service (USPS) abbreviation for the US + # state, province, or region of the address. Required in certain countries. + state: nil, + # The ZIP or postal code of the address. Required in certain countries. + zip: nil + ); end sig do override.returns( { @@ -340,8 +380,22 @@ module Increase ) .returns(T.attached_class) end - def self.new(method_:, number:, drivers_license: nil, other: nil, passport: nil); end - + def self.new( + # A method that can be used to verify the individual's identity. + method_:, + # An identification number that can be used to verify the individual's identity, + # such as a social security number. + number:, + # Information about the United States driver's license used for identification. + # Required if `method` is equal to `drivers_license`. + drivers_license: nil, + # Information about the identification document provided. Required if `method` is + # equal to `other`. + other: nil, + # Information about the passport used for identification. Required if `method` is + # equal to `passport`. + passport: nil + ); end sig do override .returns( @@ -438,8 +492,16 @@ module Increase params(expiration_date: Date, file_id: String, state: String, back_file_id: String) .returns(T.attached_class) end - def self.new(expiration_date:, file_id:, state:, back_file_id: nil); end - + def self.new( + # The driver's license's expiration date in YYYY-MM-DD format. + expiration_date:, + # The identifier of the File containing the front of the driver's license. + file_id:, + # The state that issued the provided driver's license. + state:, + # The identifier of the File containing the back of the driver's license. + back_file_id: nil + ); end sig do override.returns( { @@ -494,8 +556,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(country:, description:, file_id:, back_file_id: nil, expiration_date: nil); end - + def self.new( + # The two-character ISO 3166-1 code representing the country that issued the + # document. + country:, + # A description of the document submitted. + description:, + # The identifier of the File containing the front of the document. + file_id:, + # The identifier of the File containing the back of the document. Not every + # document has a reverse side. + back_file_id: nil, + # The document's expiration date in YYYY-MM-DD format. + expiration_date: nil + ); end sig do override .returns( @@ -529,8 +603,14 @@ module Increase sig do params(country: String, expiration_date: Date, file_id: String).returns(T.attached_class) end - def self.new(country:, expiration_date:, file_id:); end - + def self.new( + # The country that issued the passport. + country:, + # The passport's expiration date in YYYY-MM-DD format. + expiration_date:, + # The identifier of the File containing the passport. + file_id: + ); end sig { override.returns({country: String, expiration_date: Date, file_id: String}) } def to_hash; end end diff --git a/rbi/lib/increase/models/entity_create_params.rbi b/rbi/lib/increase/models/entity_create_params.rbi index 66997df07..5f0b87f67 100644 --- a/rbi/lib/increase/models/entity_create_params.rbi +++ b/rbi/lib/increase/models/entity_create_params.rbi @@ -113,14 +113,31 @@ module Increase .returns(T.attached_class) end def self.new( + # The type of Entity to create. structure:, + # Details of the corporation entity to create. Required if `structure` is equal to + # `corporation`. corporation: nil, + # The description you choose to give the entity. description: nil, + # Details of the Government Authority entity to create. Required if `structure` is + # equal to `Government Authority`. government_authority: nil, + # Details of the joint entity to create. Required if `structure` is equal to + # `joint`. joint: nil, + # Details of the natural person entity to create. Required if `structure` is equal + # to `natural_person`. Natural people entities should be submitted with + # `social_security_number` or `individual_taxpayer_identification_number` + # identification methods. natural_person: nil, + # Additional documentation associated with the entity. supplemental_documents: nil, + # A reference to data stored in a third-party verification service. Your + # integration may or may not use this field. third_party_verification: nil, + # Details of the trust entity to create. Required if `structure` is equal to + # `trust`. trust: nil, request_options: {} ); end @@ -257,13 +274,30 @@ module Increase .returns(T.attached_class) end def self.new( + # The entity's physical address. Mail receiving locations like PO Boxes and PMB's + # are disallowed. address:, + # The identifying details of each person who owns 25% or more of the business and + # one control person, like the CEO, CFO, or other executive. You can submit + # between 1 and 5 people to this list. beneficial_owners:, + # The legal name of the corporation. name:, + # The Employer Identification Number (EIN) for the corporation. tax_identifier:, + # If the entity is exempt from the requirement to submit beneficial owners, + # provide the justification. If a reason is provided, you do not need to submit a + # list of beneficial owners. beneficial_ownership_exemption_reason: nil, + # The two-letter United States Postal Service (USPS) abbreviation for the + # corporation's state of incorporation. incorporation_state: nil, + # The North American Industry Classification System (NAICS) code for the + # corporation's primary line of business. This is a number, like `5132` for + # `Software Publishers`. A full list of classification codes is available + # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes). industry_code: nil, + # The website of the corporation. website: nil ); end sig do @@ -319,8 +353,19 @@ module Increase line2: String ).returns(T.attached_class) end - def self.new(city:, line1:, state:, zip:, line2: nil); end - + def self.new( + # The city of the address. + city:, + # The first line of the address. This is usually the street number and street. + line1:, + # The two-letter United States Postal Service (USPS) abbreviation for the state of + # the address. + state:, + # The ZIP code of the address. + zip:, + # The second line of the address. This might be the floor or room number. + line2: nil + ); end sig { override.returns({city: String, line1: String, state: String, zip: String, line2: String}) } def to_hash; end end @@ -365,8 +410,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(individual:, prongs:, company_title: nil); end - + def self.new( + # Personal details for the beneficial owner. + individual:, + # Why this person is considered a beneficial owner of the entity. At least one + # option is required, if a person is both a control person and owner, submit an + # array containing both. + prongs:, + # This person's role or title within the entity. + company_title: nil + ); end sig do override .returns( @@ -446,8 +499,22 @@ module Increase ) .returns(T.attached_class) end - def self.new(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil); end - + def self.new( + # The individual's physical address. Mail receiving locations like PO Boxes and + # PMB's are disallowed. + address:, + # The person's date of birth in YYYY-MM-DD format. + date_of_birth:, + # A means of verifying the person's identity. + identification:, + # The person's legal name. + name:, + # The identification method for an individual can only be a passport, driver's + # license, or other document if you've confirmed the individual does not have a US + # tax id (either a Social Security Number or Individual Taxpayer Identification + # Number). + confirmed_no_us_tax_id: nil + ); end sig do override .returns( @@ -514,8 +581,22 @@ module Increase ) .returns(T.attached_class) end - def self.new(country:, line1:, city: nil, line2: nil, state: nil, zip: nil); end - + def self.new( + # The two-letter ISO 3166-1 alpha-2 code for the country of the address. + country:, + # The first line of the address. This is usually the street number and street. + line1:, + # The city, district, town, or village of the address. Required in certain + # countries. + city: nil, + # The second line of the address. This might be the floor or room number. + line2: nil, + # The two-letter United States Postal Service (USPS) abbreviation for the US + # state, province, or region of the address. Required in certain countries. + state: nil, + # The ZIP or postal code of the address. Required in certain countries. + zip: nil + ); end sig do override.returns( { @@ -631,8 +712,22 @@ module Increase ) .returns(T.attached_class) end - def self.new(method_:, number:, drivers_license: nil, other: nil, passport: nil); end - + def self.new( + # A method that can be used to verify the individual's identity. + method_:, + # An identification number that can be used to verify the individual's identity, + # such as a social security number. + number:, + # Information about the United States driver's license used for identification. + # Required if `method` is equal to `drivers_license`. + drivers_license: nil, + # Information about the identification document provided. Required if `method` is + # equal to `other`. + other: nil, + # Information about the passport used for identification. Required if `method` is + # equal to `passport`. + passport: nil + ); end sig do override .returns( @@ -729,8 +824,16 @@ module Increase params(expiration_date: Date, file_id: String, state: String, back_file_id: String) .returns(T.attached_class) end - def self.new(expiration_date:, file_id:, state:, back_file_id: nil); end - + def self.new( + # The driver's license's expiration date in YYYY-MM-DD format. + expiration_date:, + # The identifier of the File containing the front of the driver's license. + file_id:, + # The state that issued the provided driver's license. + state:, + # The identifier of the File containing the back of the driver's license. + back_file_id: nil + ); end sig do override.returns( { @@ -785,8 +888,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(country:, description:, file_id:, back_file_id: nil, expiration_date: nil); end - + def self.new( + # The two-character ISO 3166-1 code representing the country that issued the + # document. + country:, + # A description of the document submitted. + description:, + # The identifier of the File containing the front of the document. + file_id:, + # The identifier of the File containing the back of the document. Not every + # document has a reverse side. + back_file_id: nil, + # The document's expiration date in YYYY-MM-DD format. + expiration_date: nil + ); end sig do override .returns( @@ -820,8 +935,14 @@ module Increase sig do params(country: String, expiration_date: Date, file_id: String).returns(T.attached_class) end - def self.new(country:, expiration_date:, file_id:); end - + def self.new( + # The country that issued the passport. + country:, + # The passport's expiration date in YYYY-MM-DD format. + expiration_date:, + # The identifier of the File containing the passport. + file_id: + ); end sig { override.returns({country: String, expiration_date: Date, file_id: String}) } def to_hash; end end @@ -947,8 +1068,21 @@ module Increase ) .returns(T.attached_class) end - def self.new(address:, authorized_persons:, category:, name:, tax_identifier:, website: nil); end - + def self.new( + # The entity's physical address. Mail receiving locations like PO Boxes and PMB's + # are disallowed. + address:, + # The identifying details of authorized officials acting on the entity's behalf. + authorized_persons:, + # The category of the government authority. + category:, + # The legal name of the government authority. + name:, + # The Employer Identification Number (EIN) for the government authority. + tax_identifier:, + # The website of the government authority. + website: nil + ); end sig do override .returns( @@ -1000,8 +1134,19 @@ module Increase line2: String ).returns(T.attached_class) end - def self.new(city:, line1:, state:, zip:, line2: nil); end - + def self.new( + # The city of the address. + city:, + # The first line of the address. This is usually the street number and street. + line1:, + # The two-letter United States Postal Service (USPS) abbreviation for the state of + # the address. + state:, + # The ZIP code of the address. + zip:, + # The second line of the address. This might be the floor or room number. + line2: nil + ); end sig { override.returns({city: String, line1: String, state: String, zip: String, line2: String}) } def to_hash; end end @@ -1012,8 +1157,10 @@ module Increase attr_accessor :name sig { params(name: String).returns(T.attached_class) } - def self.new(name:); end - + def self.new( + # The person's legal name. + name: + ); end sig { override.returns({name: String}) } def to_hash; end end @@ -1059,8 +1206,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(individuals:, name: nil); end - + def self.new( + # The two individuals that share control of the entity. + individuals:, + # The name of the joint entity. + name: nil + ); end sig do override .returns({individuals: T::Array[Increase::Models::EntityCreateParams::Joint::Individual], name: String}) @@ -1127,8 +1278,22 @@ module Increase ) .returns(T.attached_class) end - def self.new(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil); end - + def self.new( + # The individual's physical address. Mail receiving locations like PO Boxes and + # PMB's are disallowed. + address:, + # The person's date of birth in YYYY-MM-DD format. + date_of_birth:, + # A means of verifying the person's identity. + identification:, + # The person's legal name. + name:, + # The identification method for an individual can only be a passport, driver's + # license, or other document if you've confirmed the individual does not have a US + # tax id (either a Social Security Number or Individual Taxpayer Identification + # Number). + confirmed_no_us_tax_id: nil + ); end sig do override .returns( @@ -1179,8 +1344,19 @@ module Increase line2: String ).returns(T.attached_class) end - def self.new(city:, line1:, state:, zip:, line2: nil); end - + def self.new( + # The city of the address. + city:, + # The first line of the address. This is usually the street number and street. + line1:, + # The two-letter United States Postal Service (USPS) abbreviation for the state of + # the address. + state:, + # The ZIP code of the address. + zip:, + # The second line of the address. This might be the floor or room number. + line2: nil + ); end sig { override.returns({city: String, line1: String, state: String, zip: String, line2: String}) } def to_hash; end end @@ -1267,8 +1443,22 @@ module Increase ) .returns(T.attached_class) end - def self.new(method_:, number:, drivers_license: nil, other: nil, passport: nil); end - + def self.new( + # A method that can be used to verify the individual's identity. + method_:, + # An identification number that can be used to verify the individual's identity, + # such as a social security number. + number:, + # Information about the United States driver's license used for identification. + # Required if `method` is equal to `drivers_license`. + drivers_license: nil, + # Information about the identification document provided. Required if `method` is + # equal to `other`. + other: nil, + # Information about the passport used for identification. Required if `method` is + # equal to `passport`. + passport: nil + ); end sig do override .returns( @@ -1361,8 +1551,16 @@ module Increase params(expiration_date: Date, file_id: String, state: String, back_file_id: String) .returns(T.attached_class) end - def self.new(expiration_date:, file_id:, state:, back_file_id: nil); end - + def self.new( + # The driver's license's expiration date in YYYY-MM-DD format. + expiration_date:, + # The identifier of the File containing the front of the driver's license. + file_id:, + # The state that issued the provided driver's license. + state:, + # The identifier of the File containing the back of the driver's license. + back_file_id: nil + ); end sig do override.returns( { @@ -1417,8 +1615,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(country:, description:, file_id:, back_file_id: nil, expiration_date: nil); end - + def self.new( + # The two-character ISO 3166-1 code representing the country that issued the + # document. + country:, + # A description of the document submitted. + description:, + # The identifier of the File containing the front of the document. + file_id:, + # The identifier of the File containing the back of the document. Not every + # document has a reverse side. + back_file_id: nil, + # The document's expiration date in YYYY-MM-DD format. + expiration_date: nil + ); end sig do override .returns( @@ -1452,8 +1662,14 @@ module Increase sig do params(country: String, expiration_date: Date, file_id: String).returns(T.attached_class) end - def self.new(country:, expiration_date:, file_id:); end - + def self.new( + # The country that issued the passport. + country:, + # The passport's expiration date in YYYY-MM-DD format. + expiration_date:, + # The identifier of the File containing the passport. + file_id: + ); end sig { override.returns({country: String, expiration_date: Date, file_id: String}) } def to_hash; end end @@ -1519,8 +1735,22 @@ module Increase ) .returns(T.attached_class) end - def self.new(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil); end - + def self.new( + # The individual's physical address. Mail receiving locations like PO Boxes and + # PMB's are disallowed. + address:, + # The person's date of birth in YYYY-MM-DD format. + date_of_birth:, + # A means of verifying the person's identity. + identification:, + # The person's legal name. + name:, + # The identification method for an individual can only be a passport, driver's + # license, or other document if you've confirmed the individual does not have a US + # tax id (either a Social Security Number or Individual Taxpayer Identification + # Number). + confirmed_no_us_tax_id: nil + ); end sig do override .returns( @@ -1571,8 +1801,19 @@ module Increase line2: String ).returns(T.attached_class) end - def self.new(city:, line1:, state:, zip:, line2: nil); end - + def self.new( + # The city of the address. + city:, + # The first line of the address. This is usually the street number and street. + line1:, + # The two-letter United States Postal Service (USPS) abbreviation for the state of + # the address. + state:, + # The ZIP code of the address. + zip:, + # The second line of the address. This might be the floor or room number. + line2: nil + ); end sig { override.returns({city: String, line1: String, state: String, zip: String, line2: String}) } def to_hash; end end @@ -1655,8 +1896,22 @@ module Increase ) .returns(T.attached_class) end - def self.new(method_:, number:, drivers_license: nil, other: nil, passport: nil); end - + def self.new( + # A method that can be used to verify the individual's identity. + method_:, + # An identification number that can be used to verify the individual's identity, + # such as a social security number. + number:, + # Information about the United States driver's license used for identification. + # Required if `method` is equal to `drivers_license`. + drivers_license: nil, + # Information about the identification document provided. Required if `method` is + # equal to `other`. + other: nil, + # Information about the passport used for identification. Required if `method` is + # equal to `passport`. + passport: nil + ); end sig do override .returns( @@ -1746,8 +2001,16 @@ module Increase params(expiration_date: Date, file_id: String, state: String, back_file_id: String) .returns(T.attached_class) end - def self.new(expiration_date:, file_id:, state:, back_file_id: nil); end - + def self.new( + # The driver's license's expiration date in YYYY-MM-DD format. + expiration_date:, + # The identifier of the File containing the front of the driver's license. + file_id:, + # The state that issued the provided driver's license. + state:, + # The identifier of the File containing the back of the driver's license. + back_file_id: nil + ); end sig do override.returns({expiration_date: Date, file_id: String, state: String, back_file_id: String}) end @@ -1795,8 +2058,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(country:, description:, file_id:, back_file_id: nil, expiration_date: nil); end - + def self.new( + # The two-character ISO 3166-1 code representing the country that issued the + # document. + country:, + # A description of the document submitted. + description:, + # The identifier of the File containing the front of the document. + file_id:, + # The identifier of the File containing the back of the document. Not every + # document has a reverse side. + back_file_id: nil, + # The document's expiration date in YYYY-MM-DD format. + expiration_date: nil + ); end sig do override .returns( @@ -1828,8 +2103,14 @@ module Increase # Information about the passport used for identification. Required if `method` is # equal to `passport`. sig { params(country: String, expiration_date: Date, file_id: String).returns(T.attached_class) } - def self.new(country:, expiration_date:, file_id:); end - + def self.new( + # The country that issued the passport. + country:, + # The passport's expiration date in YYYY-MM-DD format. + expiration_date:, + # The identifier of the File containing the passport. + file_id: + ); end sig { override.returns({country: String, expiration_date: Date, file_id: String}) } def to_hash; end end @@ -1842,8 +2123,10 @@ module Increase attr_accessor :file_id sig { params(file_id: String).returns(T.attached_class) } - def self.new(file_id:); end - + def self.new( + # The identifier of the File containing the document. + file_id: + ); end sig { override.returns({file_id: String}) } def to_hash; end end @@ -1866,8 +2149,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(reference:, vendor:); end - + def self.new( + # The reference identifier for the third party verification. + reference:, + # The vendor that was used to perform the verification. + vendor: + ); end sig do override .returns( @@ -1974,13 +2261,26 @@ module Increase .returns(T.attached_class) end def self.new( + # The trust's physical address. Mail receiving locations like PO Boxes and PMB's + # are disallowed. address:, + # Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require + # their own Employer Identification Number. Revocable trusts require information + # about the individual `grantor` who created the trust. category:, + # The legal name of the trust. name:, + # The trustees of the trust. trustees:, + # The identifier of the File containing the formation document of the trust. formation_document_file_id: nil, + # The two-letter United States Postal Service (USPS) abbreviation for the state in + # which the trust was formed. formation_state: nil, + # The grantor of the trust. Required if `category` is equal to `revocable`. grantor: nil, + # The Employer Identification Number (EIN) for the trust. Required if `category` + # is equal to `irrevocable`. tax_identifier: nil ); end sig do @@ -2036,8 +2336,19 @@ module Increase line2: String ).returns(T.attached_class) end - def self.new(city:, line1:, state:, zip:, line2: nil); end - + def self.new( + # The city of the address. + city:, + # The first line of the address. This is usually the street number and street. + line1:, + # The two-letter United States Postal Service (USPS) abbreviation for the state of + # the address. + state:, + # The ZIP code of the address. + zip:, + # The second line of the address. This might be the floor or room number. + line2: nil + ); end sig { override.returns({city: String, line1: String, state: String, zip: String, line2: String}) } def to_hash; end end @@ -2086,8 +2397,13 @@ module Increase ) .returns(T.attached_class) end - def self.new(structure:, individual: nil); end - + def self.new( + # The structure of the trustee. + structure:, + # Details of the individual trustee. Required when the trustee `structure` is + # equal to `individual`. + individual: nil + ); end sig do override .returns( @@ -2183,8 +2499,22 @@ module Increase ) .returns(T.attached_class) end - def self.new(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil); end - + def self.new( + # The individual's physical address. Mail receiving locations like PO Boxes and + # PMB's are disallowed. + address:, + # The person's date of birth in YYYY-MM-DD format. + date_of_birth:, + # A means of verifying the person's identity. + identification:, + # The person's legal name. + name:, + # The identification method for an individual can only be a passport, driver's + # license, or other document if you've confirmed the individual does not have a US + # tax id (either a Social Security Number or Individual Taxpayer Identification + # Number). + confirmed_no_us_tax_id: nil + ); end sig do override .returns( @@ -2235,8 +2565,19 @@ module Increase line2: String ).returns(T.attached_class) end - def self.new(city:, line1:, state:, zip:, line2: nil); end - + def self.new( + # The city of the address. + city:, + # The first line of the address. This is usually the street number and street. + line1:, + # The two-letter United States Postal Service (USPS) abbreviation for the state of + # the address. + state:, + # The ZIP code of the address. + zip:, + # The second line of the address. This might be the floor or room number. + line2: nil + ); end sig do override.returns({city: String, line1: String, state: String, zip: String, line2: String}) end @@ -2339,8 +2680,22 @@ module Increase ) .returns(T.attached_class) end - def self.new(method_:, number:, drivers_license: nil, other: nil, passport: nil); end - + def self.new( + # A method that can be used to verify the individual's identity. + method_:, + # An identification number that can be used to verify the individual's identity, + # such as a social security number. + number:, + # Information about the United States driver's license used for identification. + # Required if `method` is equal to `drivers_license`. + drivers_license: nil, + # Information about the identification document provided. Required if `method` is + # equal to `other`. + other: nil, + # Information about the passport used for identification. Required if `method` is + # equal to `passport`. + passport: nil + ); end sig do override .returns( @@ -2433,8 +2788,16 @@ module Increase params(expiration_date: Date, file_id: String, state: String, back_file_id: String) .returns(T.attached_class) end - def self.new(expiration_date:, file_id:, state:, back_file_id: nil); end - + def self.new( + # The driver's license's expiration date in YYYY-MM-DD format. + expiration_date:, + # The identifier of the File containing the front of the driver's license. + file_id:, + # The state that issued the provided driver's license. + state:, + # The identifier of the File containing the back of the driver's license. + back_file_id: nil + ); end sig do override.returns( { @@ -2489,8 +2852,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(country:, description:, file_id:, back_file_id: nil, expiration_date: nil); end - + def self.new( + # The two-character ISO 3166-1 code representing the country that issued the + # document. + country:, + # A description of the document submitted. + description:, + # The identifier of the File containing the front of the document. + file_id:, + # The identifier of the File containing the back of the document. Not every + # document has a reverse side. + back_file_id: nil, + # The document's expiration date in YYYY-MM-DD format. + expiration_date: nil + ); end sig do override .returns( @@ -2524,8 +2899,14 @@ module Increase sig do params(country: String, expiration_date: Date, file_id: String).returns(T.attached_class) end - def self.new(country:, expiration_date:, file_id:); end - + def self.new( + # The country that issued the passport. + country:, + # The passport's expiration date in YYYY-MM-DD format. + expiration_date:, + # The identifier of the File containing the passport. + file_id: + ); end sig { override.returns({country: String, expiration_date: Date, file_id: String}) } def to_hash; end end @@ -2588,8 +2969,22 @@ module Increase ) .returns(T.attached_class) end - def self.new(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil); end - + def self.new( + # The individual's physical address. Mail receiving locations like PO Boxes and + # PMB's are disallowed. + address:, + # The person's date of birth in YYYY-MM-DD format. + date_of_birth:, + # A means of verifying the person's identity. + identification:, + # The person's legal name. + name:, + # The identification method for an individual can only be a passport, driver's + # license, or other document if you've confirmed the individual does not have a US + # tax id (either a Social Security Number or Individual Taxpayer Identification + # Number). + confirmed_no_us_tax_id: nil + ); end sig do override .returns( @@ -2640,8 +3035,19 @@ module Increase line2: String ).returns(T.attached_class) end - def self.new(city:, line1:, state:, zip:, line2: nil); end - + def self.new( + # The city of the address. + city:, + # The first line of the address. This is usually the street number and street. + line1:, + # The two-letter United States Postal Service (USPS) abbreviation for the state of + # the address. + state:, + # The ZIP code of the address. + zip:, + # The second line of the address. This might be the floor or room number. + line2: nil + ); end sig { override.returns({city: String, line1: String, state: String, zip: String, line2: String}) } def to_hash; end end @@ -2724,8 +3130,22 @@ module Increase ) .returns(T.attached_class) end - def self.new(method_:, number:, drivers_license: nil, other: nil, passport: nil); end - + def self.new( + # A method that can be used to verify the individual's identity. + method_:, + # An identification number that can be used to verify the individual's identity, + # such as a social security number. + number:, + # Information about the United States driver's license used for identification. + # Required if `method` is equal to `drivers_license`. + drivers_license: nil, + # Information about the identification document provided. Required if `method` is + # equal to `other`. + other: nil, + # Information about the passport used for identification. Required if `method` is + # equal to `passport`. + passport: nil + ); end sig do override .returns( @@ -2815,8 +3235,16 @@ module Increase params(expiration_date: Date, file_id: String, state: String, back_file_id: String) .returns(T.attached_class) end - def self.new(expiration_date:, file_id:, state:, back_file_id: nil); end - + def self.new( + # The driver's license's expiration date in YYYY-MM-DD format. + expiration_date:, + # The identifier of the File containing the front of the driver's license. + file_id:, + # The state that issued the provided driver's license. + state:, + # The identifier of the File containing the back of the driver's license. + back_file_id: nil + ); end sig do override.returns( { @@ -2871,8 +3299,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(country:, description:, file_id:, back_file_id: nil, expiration_date: nil); end - + def self.new( + # The two-character ISO 3166-1 code representing the country that issued the + # document. + country:, + # A description of the document submitted. + description:, + # The identifier of the File containing the front of the document. + file_id:, + # The identifier of the File containing the back of the document. Not every + # document has a reverse side. + back_file_id: nil, + # The document's expiration date in YYYY-MM-DD format. + expiration_date: nil + ); end sig do override .returns( @@ -2906,8 +3346,14 @@ module Increase sig do params(country: String, expiration_date: Date, file_id: String).returns(T.attached_class) end - def self.new(country:, expiration_date:, file_id:); end - + def self.new( + # The country that issued the passport. + country:, + # The passport's expiration date in YYYY-MM-DD format. + expiration_date:, + # The identifier of the File containing the passport. + file_id: + ); end sig { override.returns({country: String, expiration_date: Date, file_id: String}) } def to_hash; end end diff --git a/rbi/lib/increase/models/entity_list_params.rbi b/rbi/lib/increase/models/entity_list_params.rbi index 271dacf77..a0a3ab80c 100644 --- a/rbi/lib/increase/models/entity_list_params.rbi +++ b/rbi/lib/increase/models/entity_list_params.rbi @@ -56,14 +56,19 @@ module Increase end def self.new( created_at: nil, + # Return the page of entries after this one. cursor: nil, + # 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). idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, status: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -115,8 +120,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end @@ -132,8 +149,12 @@ module Increase attr_writer :in_ sig { params(in_: T::Array[Increase::Models::EntityListParams::Status::In::OrSymbol]).returns(T.attached_class) } - def self.new(in_: nil); end - + def self.new( + # Filter Entities for those with the specified status or statuses. For GET + # requests, this should be encoded as a comma-delimited string, such as + # `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::EntityListParams::Status::In::OrSymbol]}) } def to_hash; end diff --git a/rbi/lib/increase/models/entity_supplemental_document.rbi b/rbi/lib/increase/models/entity_supplemental_document.rbi index 96f8753da..ded763251 100644 --- a/rbi/lib/increase/models/entity_supplemental_document.rbi +++ b/rbi/lib/increase/models/entity_supplemental_document.rbi @@ -39,8 +39,22 @@ module Increase ) .returns(T.attached_class) end - def self.new(created_at:, entity_id:, file_id:, idempotency_key:, type:); end - + def self.new( + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the + # Supplemental Document was created. + created_at:, + # The Entity the supplemental document is attached to. + entity_id:, + # The File containing the document. + file_id:, + # 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). + idempotency_key:, + # A constant representing the object's type. For this resource it will always be + # `entity_supplemental_document`. + type: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/entity_update_address_params.rbi b/rbi/lib/increase/models/entity_update_address_params.rbi index 03939296d..5f50be51b 100644 --- a/rbi/lib/increase/models/entity_update_address_params.rbi +++ b/rbi/lib/increase/models/entity_update_address_params.rbi @@ -24,8 +24,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(address:, request_options: {}); end - + def self.new( + # The entity's physical address. Mail receiving locations like PO Boxes and PMB's + # are disallowed. + address:, + request_options: {} + ); end sig do override .returns( @@ -70,8 +74,19 @@ module Increase line2: String ).returns(T.attached_class) end - def self.new(city:, line1:, state:, zip:, line2: nil); end - + def self.new( + # The city of the address. + city:, + # The first line of the address. This is usually the street number and street. + line1:, + # The two-letter United States Postal Service (USPS) abbreviation for the state of + # the address. + state:, + # The ZIP code of the address. + zip:, + # The second line of the address. This might be the floor or room number. + line2: nil + ); end sig { override.returns({city: String, line1: String, state: String, zip: String, line2: String}) } def to_hash; end end diff --git a/rbi/lib/increase/models/entity_update_beneficial_owner_address_params.rbi b/rbi/lib/increase/models/entity_update_beneficial_owner_address_params.rbi index d26ff51fb..80e196bbe 100644 --- a/rbi/lib/increase/models/entity_update_beneficial_owner_address_params.rbi +++ b/rbi/lib/increase/models/entity_update_beneficial_owner_address_params.rbi @@ -32,8 +32,15 @@ module Increase ) .returns(T.attached_class) end - def self.new(address:, beneficial_owner_id:, request_options: {}); end - + def self.new( + # The individual's physical address. Mail receiving locations like PO Boxes and + # PMB's are disallowed. + address:, + # The identifying details of anyone controlling or owning 25% or more of the + # corporation. + beneficial_owner_id:, + request_options: {} + ); end sig do override .returns( @@ -91,8 +98,22 @@ module Increase params(country: String, line1: String, city: String, line2: String, state: String, zip: String) .returns(T.attached_class) end - def self.new(country:, line1:, city: nil, line2: nil, state: nil, zip: nil); end - + def self.new( + # The two-letter ISO 3166-1 alpha-2 code for the country of the address. + country:, + # The first line of the address. This is usually the street number and street. + line1:, + # The city, district, town, or village of the address. Required in certain + # countries. + city: nil, + # The second line of the address. This might be the floor or room number. + line2: nil, + # The two-letter United States Postal Service (USPS) abbreviation for the US + # state, province, or region of the address. Required in certain countries. + state: nil, + # The ZIP or postal code of the address. Required in certain countries. + zip: nil + ); end sig do override.returns( { diff --git a/rbi/lib/increase/models/entity_update_industry_code_params.rbi b/rbi/lib/increase/models/entity_update_industry_code_params.rbi index b850c7d6b..b362da89b 100644 --- a/rbi/lib/increase/models/entity_update_industry_code_params.rbi +++ b/rbi/lib/increase/models/entity_update_industry_code_params.rbi @@ -20,8 +20,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(industry_code:, request_options: {}); end - + def self.new( + # The North American Industry Classification System (NAICS) code for the + # corporation's primary line of business. This is a number, like `5132` for + # `Software Publishers`. A full list of classification codes is available + # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes). + industry_code:, + request_options: {} + ); end sig { override.returns({industry_code: String, request_options: Increase::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/increase/models/event.rbi b/rbi/lib/increase/models/event.rbi index 827fc86d6..abec81db9 100644 --- a/rbi/lib/increase/models/event.rbi +++ b/rbi/lib/increase/models/event.rbi @@ -44,8 +44,22 @@ module Increase ) .returns(T.attached_class) end - def self.new(id:, associated_object_id:, associated_object_type:, category:, created_at:, type:); end - + def self.new( + # The Event identifier. + id:, + # The identifier of the object that generated this Event. + associated_object_id:, + # The type of the object that generated this Event. + associated_object_type:, + # The category of the Event. We may add additional possible values for this enum + # over time; your application should be able to handle such additions gracefully. + category:, + # The time the Event was created. + created_at:, + # A constant representing the object's type. For this resource it will always be + # `event`. + type: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/event_list_params.rbi b/rbi/lib/increase/models/event_list_params.rbi index fa0b4ec85..df5562d40 100644 --- a/rbi/lib/increase/models/event_list_params.rbi +++ b/rbi/lib/increase/models/event_list_params.rbi @@ -52,15 +52,17 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter Events to those belonging to the object with the provided identifier. associated_object_id: nil, category: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -87,8 +89,12 @@ module Increase attr_writer :in_ sig { params(in_: T::Array[Increase::Models::EventListParams::Category::In::OrSymbol]).returns(T.attached_class) } - def self.new(in_: nil); end - + def self.new( + # Filter Events 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`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::EventListParams::Category::In::OrSymbol]}) } def to_hash; end @@ -529,8 +535,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end diff --git a/rbi/lib/increase/models/event_subscription.rbi b/rbi/lib/increase/models/event_subscription.rbi index 34e4f85f0..a2c2a8172 100644 --- a/rbi/lib/increase/models/event_subscription.rbi +++ b/rbi/lib/increase/models/event_subscription.rbi @@ -60,17 +60,28 @@ module Increase .returns(T.attached_class) end def self.new( + # The event subscription identifier. id:, + # The time the event subscription was created. created_at:, + # 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). idempotency_key:, + # If specified, this subscription will only receive webhooks for Events associated + # with this OAuth Connection. oauth_connection_id:, + # If specified, this subscription will only receive webhooks for Events with the + # specified `category`. selected_event_category:, + # This indicates if we'll send notifications to this subscription. status:, + # A constant representing the object's type. For this resource it will always be + # `event_subscription`. type:, + # The webhook url where we'll send notifications. url: - ) - end - + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/event_subscription_create_params.rbi b/rbi/lib/increase/models/event_subscription_create_params.rbi index 1c464d01c..65b38e469 100644 --- a/rbi/lib/increase/models/event_subscription_create_params.rbi +++ b/rbi/lib/increase/models/event_subscription_create_params.rbi @@ -50,14 +50,19 @@ module Increase .returns(T.attached_class) end def self.new( + # The URL you'd like us to send webhooks to. url:, + # If specified, this subscription will only receive webhooks for Events associated + # with the specified OAuth Connection. oauth_connection_id: nil, + # If specified, this subscription will only receive webhooks for Events with the + # specified `category`. selected_event_category: nil, + # The key that will be used to sign webhooks. If no value is passed, a random + # string will be used as default. shared_secret: nil, request_options: {} - ) - end - + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/event_subscription_list_params.rbi b/rbi/lib/increase/models/event_subscription_list_params.rbi index b76dbf368..5bf19af84 100644 --- a/rbi/lib/increase/models/event_subscription_list_params.rbi +++ b/rbi/lib/increase/models/event_subscription_list_params.rbi @@ -40,8 +40,19 @@ module Increase ) .returns(T.attached_class) end - def self.new(cursor: nil, idempotency_key: nil, limit: nil, request_options: {}); end - + def self.new( + # Return the page of entries after this one. + cursor: nil, + # 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). + idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. + limit: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/event_subscription_update_params.rbi b/rbi/lib/increase/models/event_subscription_update_params.rbi index b10323df3..a673ddcfb 100644 --- a/rbi/lib/increase/models/event_subscription_update_params.rbi +++ b/rbi/lib/increase/models/event_subscription_update_params.rbi @@ -20,8 +20,11 @@ module Increase ) .returns(T.attached_class) end - def self.new(status: nil, request_options: {}); end - + def self.new( + # The status to update the Event Subscription with. + status: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/export.rbi b/rbi/lib/increase/models/export.rbi index df1acb785..5434545bb 100644 --- a/rbi/lib/increase/models/export.rbi +++ b/rbi/lib/increase/models/export.rbi @@ -60,17 +60,29 @@ module Increase .returns(T.attached_class) end def self.new( + # The Export identifier. id:, + # The category of the Export. We may add additional possible values for this enum + # over time; your application should be able to handle that gracefully. category:, + # The time the Export was created. created_at:, + # A URL at which the Export's file can be downloaded. This will be present when + # the Export's status transitions to `complete`. file_download_url:, + # The File containing the contents of the Export. This will be present when the + # Export's status transitions to `complete`. file_id:, + # 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). idempotency_key:, + # The status of the Export. status:, + # A constant representing the object's type. For this resource it will always be + # `export`. type: - ) - end - + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/export_create_params.rbi b/rbi/lib/increase/models/export_create_params.rbi index 860d06684..3558c2d8e 100644 --- a/rbi/lib/increase/models/export_create_params.rbi +++ b/rbi/lib/increase/models/export_create_params.rbi @@ -91,12 +91,23 @@ module Increase .returns(T.attached_class) end def self.new( + # The type of Export to create. category:, + # Options for the created export. Required if `category` is equal to + # `account_statement_ofx`. account_statement_ofx: nil, + # Options for the created export. Required if `category` is equal to + # `balance_csv`. balance_csv: nil, + # Options for the created export. Required if `category` is equal to + # `bookkeeping_account_balance_csv`. bookkeeping_account_balance_csv: nil, + # Options for the created export. Required if `category` is equal to `entity_csv`. entity_csv: nil, + # Options for the created export. Required if `category` is equal to + # `transaction_csv`. transaction_csv: nil, + # Options for the created export. Required if `category` is equal to `vendor_csv`. vendor_csv: nil, request_options: {} ); end @@ -174,8 +185,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(account_id:, created_at: nil); end - + def self.new( + # The Account to create a statement for. + account_id:, + # Filter results by time range on the `created_at` attribute. + created_at: nil + ); end sig do override .returns( @@ -221,8 +236,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end @@ -265,8 +292,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(account_id: nil, created_at: nil, program_id: nil); end - + def self.new( + # Filter exported Transactions to the specified Account. + account_id: nil, + # Filter results by time range on the `created_at` attribute. + created_at: nil, + # Filter exported Transactions to the specified Program. + program_id: nil + ); end sig do override .returns( @@ -316,8 +349,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end @@ -358,8 +403,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(bookkeeping_account_id: nil, created_at: nil); end - + def self.new( + # Filter exported Transactions to the specified Bookkeeping Account. + bookkeeping_account_id: nil, + # Filter results by time range on the `created_at` attribute. + created_at: nil + ); end sig do override .returns( @@ -408,8 +457,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end @@ -435,8 +496,10 @@ module Increase ) .returns(T.attached_class) end - def self.new(status: nil); end - + def self.new( + # Entity statuses to filter by. + status: nil + ); end sig { override.returns({status: Increase::Models::ExportCreateParams::EntityCsv::Status}) } def to_hash; end @@ -451,8 +514,11 @@ module Increase params(in_: T::Array[Increase::Models::ExportCreateParams::EntityCsv::Status::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_:); end - + def self.new( + # Entity statuses to filter by. For GET requests, this should be encoded as a + # comma-delimited string, such as `?in=one,two,three`. + in_: + ); end sig { override.returns({in_: T::Array[Increase::Models::ExportCreateParams::EntityCsv::Status::In::OrSymbol]}) } def to_hash; end @@ -515,8 +581,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(account_id: nil, created_at: nil, program_id: nil); end - + def self.new( + # Filter exported Transactions to the specified Account. + account_id: nil, + # Filter results by time range on the `created_at` attribute. + created_at: nil, + # Filter exported Transactions to the specified Program. + program_id: nil + ); end sig do override .returns( @@ -566,8 +638,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end diff --git a/rbi/lib/increase/models/export_list_params.rbi b/rbi/lib/increase/models/export_list_params.rbi index a6bc1b983..4fff8f79b 100644 --- a/rbi/lib/increase/models/export_list_params.rbi +++ b/rbi/lib/increase/models/export_list_params.rbi @@ -64,8 +64,15 @@ module Increase def self.new( category: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # 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). idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, status: nil, request_options: {} @@ -99,8 +106,12 @@ module Increase sig do params(in_: T::Array[Increase::Models::ExportListParams::Category::In::OrSymbol]).returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # Filter Exports 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`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::ExportListParams::Category::In::OrSymbol]}) } def to_hash; end @@ -175,8 +186,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end @@ -192,8 +215,12 @@ module Increase attr_writer :in_ sig { params(in_: T::Array[Increase::Models::ExportListParams::Status::In::OrSymbol]).returns(T.attached_class) } - def self.new(in_: nil); end - + def self.new( + # Filter Exports for those with the specified status or statuses. For GET + # requests, this should be encoded as a comma-delimited string, such as + # `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::ExportListParams::Status::In::OrSymbol]}) } def to_hash; end diff --git a/rbi/lib/increase/models/external_account.rbi b/rbi/lib/increase/models/external_account.rbi index da596344b..349ec929f 100644 --- a/rbi/lib/increase/models/external_account.rbi +++ b/rbi/lib/increase/models/external_account.rbi @@ -70,16 +70,31 @@ module Increase .returns(T.attached_class) end def self.new( + # The External Account's identifier. id:, + # The type of entity that owns the External Account. account_holder:, + # The destination account number. account_number:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the External Account was created. created_at:, + # The External Account's description for display purposes. description:, + # The type of the account to which the transfer will be sent. funding:, + # 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). idempotency_key:, + # The American Bankers' Association (ABA) Routing Transit Number (RTN). routing_number:, + # The External Account's status. status:, + # A constant representing the object's type. For this resource it will always be + # `external_account`. type:, + # If you have verified ownership of the External Account. verification_status: ); end sig do diff --git a/rbi/lib/increase/models/external_account_create_params.rbi b/rbi/lib/increase/models/external_account_create_params.rbi index ea72a5cc5..6217a3e63 100644 --- a/rbi/lib/increase/models/external_account_create_params.rbi +++ b/rbi/lib/increase/models/external_account_create_params.rbi @@ -45,15 +45,19 @@ module Increase .returns(T.attached_class) end def self.new( + # The account number for the destination account. account_number:, + # The name you choose for the Account. description:, + # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the + # destination account. routing_number:, + # The type of entity that owns the External Account. account_holder: nil, + # The type of the destination account. Defaults to `checking`. funding: nil, request_options: {} - ) - end - + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/external_account_list_params.rbi b/rbi/lib/increase/models/external_account_list_params.rbi index b8d2d38e3..0d4af3bcb 100644 --- a/rbi/lib/increase/models/external_account_list_params.rbi +++ b/rbi/lib/increase/models/external_account_list_params.rbi @@ -59,15 +59,21 @@ module Increase .returns(T.attached_class) end def self.new( + # Return the page of entries after this one. cursor: nil, + # 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). idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, + # Filter External Accounts to those with the specified Routing Number. routing_number: nil, status: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -97,8 +103,12 @@ module Increase params(in_: T::Array[Increase::Models::ExternalAccountListParams::Status::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # Filter External Accounts for those with the specified status or statuses. For + # GET requests, this should be encoded as a comma-delimited string, such as + # `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::ExternalAccountListParams::Status::In::OrSymbol]}) } def to_hash; end diff --git a/rbi/lib/increase/models/external_account_update_params.rbi b/rbi/lib/increase/models/external_account_update_params.rbi index 8f11acada..a20e30b9e 100644 --- a/rbi/lib/increase/models/external_account_update_params.rbi +++ b/rbi/lib/increase/models/external_account_update_params.rbi @@ -44,8 +44,17 @@ module Increase ) .returns(T.attached_class) end - def self.new(account_holder: nil, description: nil, funding: nil, status: nil, request_options: {}); end - + def self.new( + # The type of entity that owns the External Account. + account_holder: nil, + # The description you choose to give the external account. + description: nil, + # The funding type of the External Account. + funding: nil, + # The status of the External Account. + status: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/file.rbi b/rbi/lib/increase/models/file.rbi index 58c22154d..102ebbadc 100644 --- a/rbi/lib/increase/models/file.rbi +++ b/rbi/lib/increase/models/file.rbi @@ -63,18 +63,30 @@ module Increase .returns(T.attached_class) end def self.new( + # The File's identifier. id:, + # The time the File was created. created_at:, + # A description of the File. description:, + # Whether the File was generated by Increase or by you and sent to Increase. direction:, + # The filename that was provided upon upload or generated by Increase. filename:, + # 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). idempotency_key:, + # The MIME type of the file. mime_type:, + # What the File will be used for. We may add additional possible values for this + # enum over time; your application should be able to handle such additions + # gracefully. purpose:, + # A constant representing the object's type. For this resource it will always be + # `file`. type: - ) - end - + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/file_create_params.rbi b/rbi/lib/increase/models/file_create_params.rbi index 385fc3454..1994255ea 100644 --- a/rbi/lib/increase/models/file_create_params.rbi +++ b/rbi/lib/increase/models/file_create_params.rbi @@ -32,8 +32,17 @@ module Increase ) .returns(T.attached_class) end - def self.new(file:, purpose:, description: nil, request_options: {}); end - + def self.new( + # The file contents. This should follow the specifications of + # [RFC 7578](https://datatracker.ietf.org/doc/html/rfc7578) which defines file + # transfers for the multipart/form-data protocol. + file:, + # What the File will be used for in Increase's systems. + purpose:, + # The description you choose to give the File. + description: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/file_link.rbi b/rbi/lib/increase/models/file_link.rbi index 7e575d97a..d8c8cee3c 100644 --- a/rbi/lib/increase/models/file_link.rbi +++ b/rbi/lib/increase/models/file_link.rbi @@ -51,9 +51,29 @@ module Increase ) .returns(T.attached_class) end - def self.new(id:, created_at:, expires_at:, file_id:, idempotency_key:, type:, unauthenticated_url:) - end - + def self.new( + # The File Link identifier. + id:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the File + # Link was created. + created_at:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the File + # Link will expire. + expires_at:, + # The identifier of the File the File Link points to. + file_id:, + # 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). + idempotency_key:, + # A constant representing the object's type. For this resource it will always be + # `file_link`. + type:, + # A URL where the File can be downloaded. The URL will expire after the + # `expires_at` time. This URL is unauthenticated and can be used to download the + # File without an Increase API key. + unauthenticated_url: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/file_link_create_params.rbi b/rbi/lib/increase/models/file_link_create_params.rbi index eb50f8409..fc2ea2aad 100644 --- a/rbi/lib/increase/models/file_link_create_params.rbi +++ b/rbi/lib/increase/models/file_link_create_params.rbi @@ -26,8 +26,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(file_id:, expires_at: nil, request_options: {}); end - + def self.new( + # The File to create a File Link for. + file_id:, + # The time at which the File Link will expire. The default is 1 hour from the time + # of the request. The maxiumum is 1 day from the time of the request. + expires_at: nil, + request_options: {} + ); end sig { override.returns({file_id: String, expires_at: Time, request_options: Increase::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/increase/models/file_list_params.rbi b/rbi/lib/increase/models/file_list_params.rbi index a88328849..03d87dca3 100644 --- a/rbi/lib/increase/models/file_list_params.rbi +++ b/rbi/lib/increase/models/file_list_params.rbi @@ -56,14 +56,19 @@ module Increase end def self.new( created_at: nil, + # Return the page of entries after this one. cursor: nil, + # 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). idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, purpose: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -115,8 +120,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end @@ -131,8 +148,11 @@ module Increase attr_writer :in_ sig { params(in_: T::Array[Increase::Models::FileListParams::Purpose::In::OrSymbol]).returns(T.attached_class) } - def self.new(in_: nil); end - + def self.new( + # Filter Files for those with the specified purpose or purposes. For GET requests, + # this should be encoded as a comma-delimited string, such as `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::FileListParams::Purpose::In::OrSymbol]}) } def to_hash; end diff --git a/rbi/lib/increase/models/group.rbi b/rbi/lib/increase/models/group.rbi index 8db3b6b54..476c5e138 100644 --- a/rbi/lib/increase/models/group.rbi +++ b/rbi/lib/increase/models/group.rbi @@ -39,8 +39,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(id:, ach_debit_status:, activation_status:, created_at:, type:); end - + def self.new( + # The Group identifier. + id:, + # If the Group is allowed to create ACH debits. + ach_debit_status:, + # If the Group is activated or not. + activation_status:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Group + # was created. + created_at:, + # A constant representing the object's type. For this resource it will always be + # `group`. + type: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/inbound_ach_transfer.rbi b/rbi/lib/increase/models/inbound_ach_transfer.rbi index 270a01b39..927d32e2c 100644 --- a/rbi/lib/increase/models/inbound_ach_transfer.rbi +++ b/rbi/lib/increase/models/inbound_ach_transfer.rbi @@ -203,32 +203,68 @@ module Increase .returns(T.attached_class) end def self.new( + # The inbound ACH transfer's identifier. id:, + # If your transfer is accepted, this will contain details of the acceptance. acceptance:, + # The Account to which the transfer belongs. account_id:, + # The identifier of the Account Number to which this transfer was sent. account_number_id:, + # Additional information sent from the originator. addenda:, + # The transfer amount in USD cents. amount:, + # The time at which the transfer will be automatically resolved. automatically_resolves_at:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the inbound ACH transfer was created. created_at:, + # If your transfer is declined, this will contain details of the decline. decline:, + # The direction of the transfer. direction:, + # The effective date of the transfer. This is sent by the sending bank and is a + # factor in determining funds availability. effective_date:, + # The settlement schedule the transfer is expected to follow. expected_settlement_schedule:, + # If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will + # contain fields pertaining to the International ACH Transaction. international_addenda:, + # If you initiate a notification of change in response to the transfer, this will + # contain its details. notification_of_change:, + # The descriptive date of the transfer. originator_company_descriptive_date:, + # The additional information included with the transfer. originator_company_discretionary_data:, + # The description of the transfer. originator_company_entry_description:, + # The id of the company that initiated the transfer. originator_company_id:, + # The name of the company that initiated the transfer. originator_company_name:, + # The American Banking Association (ABA) routing number of the bank originating + # the transfer. originator_routing_number:, + # The id of the receiver of the transfer. receiver_id_number:, + # The name of the receiver of the transfer. receiver_name:, + # The Standard Entry Class (SEC) code of the transfer. standard_entry_class_code:, + # The status of the transfer. status:, + # A 15 digit number set by the sending bank and transmitted to the receiving bank. + # Along with the amount, date, and originating routing number, this can be used to + # identify the ACH transfer. ACH trace numbers are not unique, but are + # [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns). trace_number:, + # If your transfer is returned, this will contain details of the return. transfer_return:, + # A constant representing the object's type. For this resource it will always be + # `inbound_ach_transfer`. type: ); end sig do @@ -278,8 +314,12 @@ module Increase # If your transfer is accepted, this will contain details of the acceptance. sig { params(accepted_at: Time, transaction_id: String).returns(T.attached_class) } - def self.new(accepted_at:, transaction_id:); end - + def self.new( + # The time at which the transfer was accepted. + accepted_at:, + # The id of the transaction for the accepted transfer. + transaction_id: + ); end sig { override.returns({accepted_at: Time, transaction_id: String}) } def to_hash; end end @@ -309,8 +349,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(category:, freeform:); end - + def self.new( + # The type of addendum. + category:, + # Unstructured `payment_related_information` passed through by the originator. + freeform: + ); end sig do override .returns( @@ -348,8 +392,10 @@ module Increase ) .returns(T.attached_class) end - def self.new(entries:); end - + def self.new( + # Each entry represents an addendum received from the originator. + entries: + ); end sig { override.returns({entries: T::Array[Increase::Models::InboundACHTransfer::Addenda::Freeform::Entry]}) } def to_hash; end @@ -359,8 +405,10 @@ module Increase attr_accessor :payment_related_information sig { params(payment_related_information: String).returns(T.attached_class) } - def self.new(payment_related_information:); end - + def self.new( + # The payment related information passed in the addendum. + payment_related_information: + ); end sig { override.returns({payment_related_information: String}) } def to_hash; end end @@ -389,8 +437,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(declined_at:, declined_transaction_id:, reason:); end - + def self.new( + # The time at which the transfer was declined. + declined_at:, + # The id of the transaction for the declined transfer. + declined_transaction_id:, + # The reason for the transfer decline. + reason: + ); end sig do override .returns( @@ -751,38 +805,91 @@ module Increase .returns(T.attached_class) end def self.new( + # The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 + # country code of the destination country. destination_country_code:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the + # destination bank account. destination_currency_code:, + # A description of how the foreign exchange rate was calculated. foreign_exchange_indicator:, + # Depending on the `foreign_exchange_reference_indicator`, an exchange rate or a + # reference to a well-known rate. foreign_exchange_reference:, + # An instruction of how to interpret the `foreign_exchange_reference` field for + # this Transaction. foreign_exchange_reference_indicator:, + # The amount in the minor unit of the foreign payment currency. For dollars, for + # example, this is cents. foreign_payment_amount:, + # A reference number in the foreign banking infrastructure. foreign_trace_number:, + # The type of transfer. Set by the originator. international_transaction_type_code:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the + # originating bank account. originating_currency_code:, + # The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 + # country code of the originating branch country. originating_depository_financial_institution_branch_country:, + # An identifier for the originating bank. One of an International Bank Account + # Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a + # domestic identifier like a US Routing Number. originating_depository_financial_institution_id:, + # An instruction of how to interpret the + # `originating_depository_financial_institution_id` field for this Transaction. originating_depository_financial_institution_id_qualifier:, + # The name of the originating bank. Sometimes this will refer to an American bank + # and obscure the correspondent foreign bank. originating_depository_financial_institution_name:, + # A portion of the originator address. This may be incomplete. originator_city:, + # A portion of the originator address. The + # [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country + # code of the originator country. originator_country:, + # An identifier for the originating company. This is generally stable across + # multiple ACH transfers. originator_identification:, + # Either the name of the originator or an intermediary money transmitter. originator_name:, + # A portion of the originator address. This may be incomplete. originator_postal_code:, + # A portion of the originator address. This may be incomplete. originator_state_or_province:, + # A portion of the originator address. This may be incomplete. originator_street_address:, + # A description field set by the originator. payment_related_information:, + # A description field set by the originator. payment_related_information2:, + # A portion of the receiver address. This may be incomplete. receiver_city:, + # A portion of the receiver address. The + # [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country + # code of the receiver country. receiver_country:, + # An identification number the originator uses for the receiver. receiver_identification_number:, + # A portion of the receiver address. This may be incomplete. receiver_postal_code:, + # A portion of the receiver address. This may be incomplete. receiver_state_or_province:, + # A portion of the receiver address. This may be incomplete. receiver_street_address:, + # The name of the receiver of the transfer. This is not verified by Increase. receiving_company_or_individual_name:, + # The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 + # country code of the receiving bank country. receiving_depository_financial_institution_country:, + # An identifier for the receiving bank. One of an International Bank Account + # Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a + # domestic identifier like a US Routing Number. receiving_depository_financial_institution_id:, + # An instruction of how to interpret the + # `receiving_depository_financial_institution_id` field for this Transaction. receiving_depository_financial_institution_id_qualifier:, + # The name of the receiving bank, as set by the sending financial institution. receiving_depository_financial_institution_name: ); end sig do @@ -1169,8 +1276,12 @@ module Increase params(updated_account_number: T.nilable(String), updated_routing_number: T.nilable(String)) .returns(T.attached_class) end - def self.new(updated_account_number:, updated_routing_number:); end - + def self.new( + # The new account number provided in the notification of change. + updated_account_number:, + # The new account number provided in the notification of change. + updated_routing_number: + ); end sig do override.returns( { @@ -1318,8 +1429,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(reason:, returned_at:, transaction_id:); end - + def self.new( + # The reason for the transfer return. + reason:, + # The time at which the transfer was returned. + returned_at:, + # The id of the transaction for the returned transfer. + transaction_id: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rbi b/rbi/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rbi index 87c28ce6e..a580655ab 100644 --- a/rbi/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rbi +++ b/rbi/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rbi @@ -28,8 +28,13 @@ module Increase ) .returns(T.attached_class) end - def self.new(updated_account_number: nil, updated_routing_number: nil, request_options: {}); end - + def self.new( + # The updated account number to send in the notification of change. + updated_account_number: nil, + # The updated routing number to send in the notification of change. + updated_routing_number: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/inbound_ach_transfer_decline_params.rbi b/rbi/lib/increase/models/inbound_ach_transfer_decline_params.rbi index 30ce9022f..6872ef2c4 100644 --- a/rbi/lib/increase/models/inbound_ach_transfer_decline_params.rbi +++ b/rbi/lib/increase/models/inbound_ach_transfer_decline_params.rbi @@ -22,8 +22,13 @@ module Increase ) .returns(T.attached_class) end - def self.new(reason: nil, request_options: {}); end - + def self.new( + # The reason why this transfer will be returned. If this parameter is unset, the + # return codes will be `payment_stopped` for debits and + # `credit_entry_refused_by_receiver` for credits. + reason: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/inbound_ach_transfer_list_params.rbi b/rbi/lib/increase/models/inbound_ach_transfer_list_params.rbi index cedf811d0..0c0bf1988 100644 --- a/rbi/lib/increase/models/inbound_ach_transfer_list_params.rbi +++ b/rbi/lib/increase/models/inbound_ach_transfer_list_params.rbi @@ -68,10 +68,15 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter Inbound ACH Transfers to ones belonging to the specified Account. account_id: nil, + # Filter Inbound ACH Transfers to ones belonging to the specified Account Number. account_number_id: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, status: nil, request_options: {} @@ -128,8 +133,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end @@ -148,8 +165,12 @@ module Increase params(in_: T::Array[Increase::Models::InboundACHTransferListParams::Status::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # Filter Inbound ACH Transfers to those with the specified status. For GET + # requests, this should be encoded as a comma-delimited string, such as + # `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::InboundACHTransferListParams::Status::In::OrSymbol]}) } def to_hash; end diff --git a/rbi/lib/increase/models/inbound_ach_transfer_transfer_return_params.rbi b/rbi/lib/increase/models/inbound_ach_transfer_transfer_return_params.rbi index ae20df4a7..e3b58c980 100644 --- a/rbi/lib/increase/models/inbound_ach_transfer_transfer_return_params.rbi +++ b/rbi/lib/increase/models/inbound_ach_transfer_transfer_return_params.rbi @@ -18,8 +18,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(reason:, request_options: {}); end - + def self.new( + # The reason why this transfer will be returned. The most usual return codes are + # `payment_stopped` for debits and `credit_entry_refused_by_receiver` for credits. + reason:, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/inbound_check_deposit.rbi b/rbi/lib/increase/models/inbound_check_deposit.rbi index 715cdd599..b91ccc31e 100644 --- a/rbi/lib/increase/models/inbound_check_deposit.rbi +++ b/rbi/lib/increase/models/inbound_check_deposit.rbi @@ -133,25 +133,59 @@ module Increase .returns(T.attached_class) end def self.new( + # The deposit's identifier. id:, + # If the Inbound Check Deposit was accepted, the + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this + # took place. accepted_at:, + # The Account the check is being deposited against. account_id:, + # The Account Number the check is being deposited against. account_number_id:, + # If the deposit or the return was adjusted by the sending institution, this will + # contain details of the adjustments. adjustments:, + # The deposited amount in USD cents. amount:, + # The ID for the File containing the image of the back of the check. back_image_file_id:, + # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the + # bank depositing this check. In some rare cases, this is not transmitted via + # Check21 and the value will be null. bank_of_first_deposit_routing_number:, + # The check number printed on the check being deposited. check_number:, + # If this deposit is for an existing Check Transfer, the identifier of that Check + # Transfer. check_transfer_id:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the deposit was attempted. created_at:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit. currency:, + # If the Inbound Check Deposit was declined, the + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this + # took place. declined_at:, + # If the deposit attempt has been rejected, the identifier of the Declined + # Transaction object created as a result of the failed deposit. declined_transaction_id:, + # If you requested a return of this deposit, this will contain details of the + # return. deposit_return:, + # The ID for the File containing the image of the front of the check. front_image_file_id:, + # Whether the details on the check match the recipient name of the check transfer. + # This is an optional feature, contact sales to enable. payee_name_analysis:, + # The status of the Inbound Check Deposit. status:, + # If the deposit attempt has been accepted, the identifier of the Transaction + # object created as a result of the successful deposit. transaction_id:, + # A constant representing the object's type. For this resource it will always be + # `inbound_check_deposit`. type: ); end sig do @@ -209,8 +243,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(adjusted_at:, amount:, reason:, transaction_id:); end - + def self.new( + # The time at which the return adjustment was received. + adjusted_at:, + # The amount of the adjustment. + amount:, + # The reason for the adjustment. + reason:, + # The id of the transaction for the adjustment. + transaction_id: + ); end sig do override .returns( @@ -304,8 +346,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(reason:, returned_at:, transaction_id:); end - + def self.new( + # The reason the deposit was returned. + reason:, + # The time at which the deposit was returned. + returned_at:, + # The id of the transaction for the returned deposit. + transaction_id: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/inbound_check_deposit_list_params.rbi b/rbi/lib/increase/models/inbound_check_deposit_list_params.rbi index e3dfb22db..fb8ef87fd 100644 --- a/rbi/lib/increase/models/inbound_check_deposit_list_params.rbi +++ b/rbi/lib/increase/models/inbound_check_deposit_list_params.rbi @@ -59,15 +59,19 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter Inbound Check Deposits to those belonging to the specified Account. account_id: nil, + # Filter Inbound Check Deposits to those belonging to the specified Check + # Transfer. check_transfer_id: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -119,8 +123,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end diff --git a/rbi/lib/increase/models/inbound_check_deposit_return_params.rbi b/rbi/lib/increase/models/inbound_check_deposit_return_params.rbi index a2bbef5c5..bcff70bd0 100644 --- a/rbi/lib/increase/models/inbound_check_deposit_return_params.rbi +++ b/rbi/lib/increase/models/inbound_check_deposit_return_params.rbi @@ -17,8 +17,11 @@ module Increase ) .returns(T.attached_class) end - def self.new(reason:, request_options: {}); end - + def self.new( + # The reason to return the Inbound Check Deposit. + reason:, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/inbound_mail_item.rbi b/rbi/lib/increase/models/inbound_mail_item.rbi index ed45cddb0..6dc7c9505 100644 --- a/rbi/lib/increase/models/inbound_mail_item.rbi +++ b/rbi/lib/increase/models/inbound_mail_item.rbi @@ -53,17 +53,26 @@ module Increase .returns(T.attached_class) end def self.new( + # The Inbound Mail Item identifier. id:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Inbound + # Mail Item was created. created_at:, + # The identifier for the File containing the scanned contents of the mail item. file_id:, + # The identifier for the Lockbox that received this mail item. For mail items that + # could not be processed due to an invalid address, this will be null. lockbox_id:, + # The recipient name as written on the mail item. recipient_name:, + # If the mail item has been rejected, why it was rejected. rejection_reason:, + # If the mail item has been processed. status:, + # A constant representing the object's type. For this resource it will always be + # `inbound_mail_item`. type: - ) - end - + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/inbound_mail_item_list_params.rbi b/rbi/lib/increase/models/inbound_mail_item_list_params.rbi index 0368a0d3a..a012cf780 100644 --- a/rbi/lib/increase/models/inbound_mail_item_list_params.rbi +++ b/rbi/lib/increase/models/inbound_mail_item_list_params.rbi @@ -49,8 +49,17 @@ module Increase ) .returns(T.attached_class) end - def self.new(created_at: nil, cursor: nil, limit: nil, lockbox_id: nil, request_options: {}); end - + def self.new( + created_at: nil, + # Return the page of entries after this one. + cursor: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. + limit: nil, + # Filter Inbound Mail Items to ones sent to the provided Lockbox. + lockbox_id: nil, + request_options: {} + ); end sig do override .returns( @@ -101,8 +110,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end diff --git a/rbi/lib/increase/models/inbound_real_time_payments_transfer.rbi b/rbi/lib/increase/models/inbound_real_time_payments_transfer.rbi index 4ded64d5a..36dcd4e4d 100644 --- a/rbi/lib/increase/models/inbound_real_time_payments_transfer.rbi +++ b/rbi/lib/increase/models/inbound_real_time_payments_transfer.rbi @@ -114,21 +114,40 @@ module Increase .returns(T.attached_class) end def self.new( + # The inbound Real-Time Payments transfer's identifier. id:, + # The Account to which the transfer was sent. account_id:, + # The identifier of the Account Number to which this transfer was sent. account_number_id:, + # The amount in USD cents. amount:, + # If your transfer is confirmed, this will contain details of the confirmation. confirmation:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the transfer was created. created_at:, + # The name the sender of the transfer specified as the recipient of the transfer. creditor_name:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's + # currency. This will always be "USD" for a Real-Time Payments transfer. currency:, + # The account number of the account that sent the transfer. debtor_account_number:, + # The name provided by the sender of the transfer. debtor_name:, + # The routing number of the account that sent the transfer. debtor_routing_number:, + # If your transfer is declined, this will contain details of the decline. decline:, + # Additional information included with the transfer. remittance_information:, + # The lifecycle status of the transfer. status:, + # The Real-Time Payments network identification of the transfer. transaction_identification:, + # A constant representing the object's type. For this resource it will always be + # `inbound_real_time_payments_transfer`. type: ); end sig do @@ -167,8 +186,12 @@ module Increase # If your transfer is confirmed, this will contain details of the confirmation. sig { params(confirmed_at: Time, transaction_id: String).returns(T.attached_class) } - def self.new(confirmed_at:, transaction_id:); end - + def self.new( + # The time at which the transfer was confirmed. + confirmed_at:, + # The id of the transaction for the confirmed transfer. + transaction_id: + ); end sig { override.returns({confirmed_at: Time, transaction_id: String}) } def to_hash; end end @@ -226,8 +249,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(declined_at:, declined_transaction_id:, reason:); end - + def self.new( + # The time at which the transfer was declined. + declined_at:, + # The id of the transaction for the declined transfer. + declined_transaction_id:, + # The reason for the transfer decline. + reason: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/inbound_real_time_payments_transfer_list_params.rbi b/rbi/lib/increase/models/inbound_real_time_payments_transfer_list_params.rbi index 214c69222..116085ac5 100644 --- a/rbi/lib/increase/models/inbound_real_time_payments_transfer_list_params.rbi +++ b/rbi/lib/increase/models/inbound_real_time_payments_transfer_list_params.rbi @@ -60,15 +60,20 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter Inbound Real-Time Payments Transfers to those belonging to the specified + # Account. account_id: nil, + # Filter Inbound Real-Time Payments Transfers to ones belonging to the specified + # Account Number. account_number_id: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -120,8 +125,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end diff --git a/rbi/lib/increase/models/inbound_wire_drawdown_request.rbi b/rbi/lib/increase/models/inbound_wire_drawdown_request.rbi index 4c83bcce5..cae6aeeeb 100644 --- a/rbi/lib/increase/models/inbound_wire_drawdown_request.rbi +++ b/rbi/lib/increase/models/inbound_wire_drawdown_request.rbi @@ -135,28 +135,59 @@ module Increase .returns(T.attached_class) end def self.new( + # The Wire drawdown request identifier. id:, + # The amount being requested in cents. amount:, + # The drawdown request's beneficiary's account number. beneficiary_account_number:, + # Line 1 of the drawdown request's beneficiary's address. beneficiary_address_line1:, + # Line 2 of the drawdown request's beneficiary's address. beneficiary_address_line2:, + # Line 3 of the drawdown request's beneficiary's address. beneficiary_address_line3:, + # The drawdown request's beneficiary's name. beneficiary_name:, + # The drawdown request's beneficiary's routing number. beneficiary_routing_number:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the inbound wire drawdown requested was created. created_at:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being + # requested. Will always be "USD". currency:, + # A message from the drawdown request's originator. message_to_recipient:, + # The drawdown request's originator's account number. originator_account_number:, + # Line 1 of the drawdown request's originator's address. originator_address_line1:, + # Line 2 of the drawdown request's originator's address. originator_address_line2:, + # Line 3 of the drawdown request's originator's address. originator_address_line3:, + # The drawdown request's originator's name. originator_name:, + # The drawdown request's originator's routing number. originator_routing_number:, + # Line 1 of the information conveyed from the originator of the message to the + # beneficiary. originator_to_beneficiary_information_line1:, + # Line 2 of the information conveyed from the originator of the message to the + # beneficiary. originator_to_beneficiary_information_line2:, + # Line 3 of the information conveyed from the originator of the message to the + # beneficiary. originator_to_beneficiary_information_line3:, + # Line 4 of the information conveyed from the originator of the message to the + # beneficiary. originator_to_beneficiary_information_line4:, + # The Account Number from which the recipient of this request is being requested + # to send funds. recipient_account_number_id:, + # A constant representing the object's type. For this resource it will always be + # `inbound_wire_drawdown_request`. type: ); end sig do diff --git a/rbi/lib/increase/models/inbound_wire_drawdown_request_list_params.rbi b/rbi/lib/increase/models/inbound_wire_drawdown_request_list_params.rbi index 8368a8613..b8884b396 100644 --- a/rbi/lib/increase/models/inbound_wire_drawdown_request_list_params.rbi +++ b/rbi/lib/increase/models/inbound_wire_drawdown_request_list_params.rbi @@ -29,8 +29,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(cursor: nil, limit: nil, request_options: {}); end - + def self.new( + # Return the page of entries after this one. + cursor: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. + limit: nil, + request_options: {} + ); end sig { override.returns({cursor: String, limit: Integer, request_options: Increase::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/increase/models/inbound_wire_transfer.rbi b/rbi/lib/increase/models/inbound_wire_transfer.rbi index d568b774b..f9afef8b1 100644 --- a/rbi/lib/increase/models/inbound_wire_transfer.rbi +++ b/rbi/lib/increase/models/inbound_wire_transfer.rbi @@ -141,30 +141,60 @@ module Increase .returns(T.attached_class) end def self.new( + # The inbound wire transfer's identifier. id:, + # The Account to which the transfer belongs. account_id:, + # The identifier of the Account Number to which this transfer was sent. account_number_id:, + # The amount in USD cents. amount:, + # A free-form address field set by the sender. beneficiary_address_line1:, + # A free-form address field set by the sender. beneficiary_address_line2:, + # A free-form address field set by the sender. beneficiary_address_line3:, + # A name set by the sender. beneficiary_name:, + # A free-form reference string set by the sender, to help identify the transfer. beneficiary_reference:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the inbound wire transfer was created. created_at:, + # An Increase-constructed description of the transfer. description:, + # A unique identifier available to the originating and receiving banks, commonly + # abbreviated as IMAD. It is created when the wire is submitted to the Fedwire + # service and is helpful when debugging wires with the originating bank. input_message_accountability_data:, + # The address of the wire originator, set by the sending bank. originator_address_line1:, + # The address of the wire originator, set by the sending bank. originator_address_line2:, + # The address of the wire originator, set by the sending bank. originator_address_line3:, + # The originator of the wire, set by the sending bank. originator_name:, + # The American Banking Association (ABA) routing number of the bank originating + # the transfer. originator_routing_number:, + # An Increase-created concatenation of the Originator-to-Beneficiary lines. originator_to_beneficiary_information:, + # A free-form message set by the wire originator. originator_to_beneficiary_information_line1:, + # A free-form message set by the wire originator. originator_to_beneficiary_information_line2:, + # A free-form message set by the wire originator. originator_to_beneficiary_information_line3:, + # A free-form message set by the wire originator. originator_to_beneficiary_information_line4:, + # The sending bank's reference number for the wire transfer. sender_reference:, + # The status of the transfer. status:, + # A constant representing the object's type. For this resource it will always be + # `inbound_wire_transfer`. type: ); end sig do diff --git a/rbi/lib/increase/models/inbound_wire_transfer_list_params.rbi b/rbi/lib/increase/models/inbound_wire_transfer_list_params.rbi index 97d1e8861..3607d9953 100644 --- a/rbi/lib/increase/models/inbound_wire_transfer_list_params.rbi +++ b/rbi/lib/increase/models/inbound_wire_transfer_list_params.rbi @@ -70,10 +70,15 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter Inbound Wire Transfers to ones belonging to the specified Account. account_id: nil, + # Filter Inbound Wire Transfers to ones belonging to the specified Account Number. account_number_id: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, status: nil, request_options: {} @@ -130,8 +135,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end @@ -150,8 +167,12 @@ module Increase params(in_: T::Array[Increase::Models::InboundWireTransferListParams::Status::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # Filter Inbound Wire Transfers to those with the specified status. For GET + # requests, this should be encoded as a comma-delimited string, such as + # `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::InboundWireTransferListParams::Status::In::OrSymbol]}) } def to_hash; end diff --git a/rbi/lib/increase/models/intrafi_account_enrollment.rbi b/rbi/lib/increase/models/intrafi_account_enrollment.rbi index cf25c1bc2..04fb93c7d 100644 --- a/rbi/lib/increase/models/intrafi_account_enrollment.rbi +++ b/rbi/lib/increase/models/intrafi_account_enrollment.rbi @@ -56,8 +56,28 @@ module Increase ) .returns(T.attached_class) end - def self.new(id:, account_id:, created_at:, idempotency_key:, intrafi_id:, status:, type:); end - + def self.new( + # The identifier of this enrollment at IntraFi. + id:, + # The identifier of the Increase Account being swept into the network. + account_id:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the enrollment was created. + created_at:, + # 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). + idempotency_key:, + # The identifier of the account in IntraFi's system. This identifier will be + # printed on any IntraFi statements or documents. + intrafi_id:, + # The status of the account in the network. An account takes about one business + # day to go from `pending_enrolling` to `enrolled`. + status:, + # A constant representing the object's type. For this resource it will always be + # `intrafi_account_enrollment`. + type: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/intrafi_account_enrollment_create_params.rbi b/rbi/lib/increase/models/intrafi_account_enrollment_create_params.rbi index 2afe98d94..1901b7834 100644 --- a/rbi/lib/increase/models/intrafi_account_enrollment_create_params.rbi +++ b/rbi/lib/increase/models/intrafi_account_enrollment_create_params.rbi @@ -22,8 +22,13 @@ module Increase ) .returns(T.attached_class) end - def self.new(account_id:, email_address:, request_options: {}); end - + def self.new( + # The identifier for the account to be added to IntraFi. + account_id:, + # The contact email for the account owner, to be shared with IntraFi. + email_address:, + request_options: {} + ); end sig do override.returns( { diff --git a/rbi/lib/increase/models/intrafi_account_enrollment_list_params.rbi b/rbi/lib/increase/models/intrafi_account_enrollment_list_params.rbi index 71c506948..933539108 100644 --- a/rbi/lib/increase/models/intrafi_account_enrollment_list_params.rbi +++ b/rbi/lib/increase/models/intrafi_account_enrollment_list_params.rbi @@ -61,15 +61,21 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter IntraFi Account Enrollments to the one belonging to an account. account_id: nil, + # Return the page of entries after this one. cursor: nil, + # 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). idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, status: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -99,8 +105,12 @@ module Increase params(in_: T::Array[Increase::Models::IntrafiAccountEnrollmentListParams::Status::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # Filter IntraFi Account Enrollments for those with the specified status or + # statuses. For GET requests, this should be encoded as a comma-delimited string, + # such as `?in=one,two,three`. + in_: nil + ); end sig do override .returns({in_: T::Array[Increase::Models::IntrafiAccountEnrollmentListParams::Status::In::OrSymbol]}) diff --git a/rbi/lib/increase/models/intrafi_balance.rbi b/rbi/lib/increase/models/intrafi_balance.rbi index 8d41c734d..9d709db19 100644 --- a/rbi/lib/increase/models/intrafi_balance.rbi +++ b/rbi/lib/increase/models/intrafi_balance.rbi @@ -45,8 +45,24 @@ module Increase ) .returns(T.attached_class) end - def self.new(id:, balances:, currency:, effective_date:, total_balance:, type:); end - + def self.new( + # The identifier of this balance. + id:, + # Each entry represents a balance held at a different bank. IntraFi separates the + # total balance across many participating banks in the network. + balances:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the account + # currency. + currency:, + # The date this balance reflects. + effective_date:, + # The total balance, in minor units of `currency`. Increase reports this balance + # to IntraFi daily. + total_balance:, + # A constant representing the object's type. For this resource it will always be + # `intrafi_balance`. + type: + ); end sig do override .returns( @@ -103,8 +119,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(id:, balance:, bank:, bank_location:, fdic_certificate_number:); end - + def self.new( + # The identifier of this balance. + id:, + # The balance, in minor units of `currency`, held with this bank. + balance:, + # The name of the bank holding these funds. + bank:, + # The primary location of the bank. + bank_location:, + # The Federal Deposit Insurance Corporation (FDIC) certificate number of the bank. + # Because many banks have the same or similar names, this can be used to uniquely + # identify the institution. + fdic_certificate_number: + ); end sig do override .returns( @@ -130,8 +158,12 @@ module Increase # The primary location of the bank. sig { params(city: String, state: String).returns(T.attached_class) } - def self.new(city:, state:); end - + def self.new( + # The bank's city. + city:, + # The bank's state. + state: + ); end sig { override.returns({city: String, state: String}) } def to_hash; end end diff --git a/rbi/lib/increase/models/intrafi_exclusion.rbi b/rbi/lib/increase/models/intrafi_exclusion.rbi index ee4525c5c..28f3f068e 100644 --- a/rbi/lib/increase/models/intrafi_exclusion.rbi +++ b/rbi/lib/increase/models/intrafi_exclusion.rbi @@ -68,15 +68,30 @@ module Increase .returns(T.attached_class) end def self.new( + # The identifier of this exclusion request. id:, + # The name of the excluded institution. bank_name:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the exclusion was created. created_at:, + # The entity for which this institution is excluded. entity_id:, + # When this was exclusion was confirmed by IntraFi. excluded_at:, + # The Federal Deposit Insurance Corporation's certificate number for the + # institution. fdic_certificate_number:, + # 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). idempotency_key:, + # The status of the exclusion request. status:, + # When this was exclusion was submitted to IntraFi by Increase. submitted_at:, + # A constant representing the object's type. For this resource it will always be + # `intrafi_exclusion`. type: ); end sig do diff --git a/rbi/lib/increase/models/intrafi_exclusion_create_params.rbi b/rbi/lib/increase/models/intrafi_exclusion_create_params.rbi index d93fd624d..f6caaba54 100644 --- a/rbi/lib/increase/models/intrafi_exclusion_create_params.rbi +++ b/rbi/lib/increase/models/intrafi_exclusion_create_params.rbi @@ -22,8 +22,13 @@ module Increase ) .returns(T.attached_class) end - def self.new(bank_name:, entity_id:, request_options: {}); end - + def self.new( + # The name of the financial institution to be excluded. + bank_name:, + # The identifier of the Entity whose deposits will be excluded. + entity_id:, + request_options: {} + ); end sig do override.returns({bank_name: String, entity_id: String, request_options: Increase::RequestOptions}) end diff --git a/rbi/lib/increase/models/intrafi_exclusion_list_params.rbi b/rbi/lib/increase/models/intrafi_exclusion_list_params.rbi index 2f0ebe595..0cb4ef8fc 100644 --- a/rbi/lib/increase/models/intrafi_exclusion_list_params.rbi +++ b/rbi/lib/increase/models/intrafi_exclusion_list_params.rbi @@ -48,8 +48,21 @@ module Increase ) .returns(T.attached_class) end - def self.new(cursor: nil, entity_id: nil, idempotency_key: nil, limit: nil, request_options: {}); end - + def self.new( + # Return the page of entries after this one. + cursor: nil, + # Filter IntraFi Exclusions for those belonging to the specified Entity. + entity_id: nil, + # 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). + idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. + limit: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/lockbox.rbi b/rbi/lib/increase/models/lockbox.rbi index b417b1a9e..1c626958c 100644 --- a/rbi/lib/increase/models/lockbox.rbi +++ b/rbi/lib/increase/models/lockbox.rbi @@ -64,18 +64,30 @@ module Increase .returns(T.attached_class) end def self.new( + # The Lockbox identifier. id:, + # The identifier for the Account checks sent to this lockbox will be deposited + # into. account_id:, + # The mailing address for the Lockbox. address:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox + # was created. created_at:, + # The description you choose for the Lockbox. description:, + # 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). idempotency_key:, + # The recipient name you choose for the Lockbox. recipient_name:, + # This indicates if mail can be sent to this address. status:, + # A constant representing the object's type. For this resource it will always be + # `lockbox`. type: - ) - end - + ); end sig do override .returns( @@ -135,8 +147,24 @@ module Increase ) .returns(T.attached_class) end - def self.new(city:, line1:, line2:, postal_code:, recipient:, state:); end - + def self.new( + # The city of the address. + city:, + # The first line of the address. + line1:, + # The second line of the address. + line2:, + # The postal code of the address. + postal_code:, + # 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. + recipient:, + # The two-letter United States Postal Service (USPS) abbreviation for the state of + # the address. + state: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/lockbox_create_params.rbi b/rbi/lib/increase/models/lockbox_create_params.rbi index 5dd4bd97c..1667b64f9 100644 --- a/rbi/lib/increase/models/lockbox_create_params.rbi +++ b/rbi/lib/increase/models/lockbox_create_params.rbi @@ -33,8 +33,15 @@ module Increase ) .returns(T.attached_class) end - def self.new(account_id:, description: nil, recipient_name: nil, request_options: {}); end - + def self.new( + # The Account checks sent to this Lockbox should be deposited into. + account_id:, + # The description you choose for the Lockbox, for display purposes. + description: nil, + # The name of the recipient that will receive mail at this location. + recipient_name: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/lockbox_list_params.rbi b/rbi/lib/increase/models/lockbox_list_params.rbi index d3368f6f8..39c01f946 100644 --- a/rbi/lib/increase/models/lockbox_list_params.rbi +++ b/rbi/lib/increase/models/lockbox_list_params.rbi @@ -58,15 +58,21 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter Lockboxes to those associated with the provided Account. account_id: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # 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). idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -118,8 +124,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end diff --git a/rbi/lib/increase/models/lockbox_update_params.rbi b/rbi/lib/increase/models/lockbox_update_params.rbi index 2341c86da..8daaf2f7d 100644 --- a/rbi/lib/increase/models/lockbox_update_params.rbi +++ b/rbi/lib/increase/models/lockbox_update_params.rbi @@ -36,8 +36,15 @@ module Increase ) .returns(T.attached_class) end - def self.new(description: nil, recipient_name: nil, status: nil, request_options: {}); end - + def self.new( + # The description you choose for the Lockbox. + description: nil, + # The recipient name you choose for the Lockbox. + recipient_name: nil, + # This indicates if checks can be sent to the Lockbox. + status: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/oauth_application.rbi b/rbi/lib/increase/models/oauth_application.rbi index 56b264f2c..d32169189 100644 --- a/rbi/lib/increase/models/oauth_application.rbi +++ b/rbi/lib/increase/models/oauth_application.rbi @@ -51,8 +51,26 @@ module Increase ) .returns(T.attached_class) end - def self.new(id:, client_id:, created_at:, deleted_at:, name:, status:, type:); end - + def self.new( + # The OAuth Application's identifier. + id:, + # The OAuth Application's client_id. Use this to authenticate with the OAuth + # Application. + client_id:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth + # Application was created. + created_at:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth + # Application was deleted. + deleted_at:, + # The name you chose for this OAuth Application. + name:, + # Whether the application is active. + status:, + # A constant representing the object's type. For this resource it will always be + # `oauth_application`. + type: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/oauth_application_list_params.rbi b/rbi/lib/increase/models/oauth_application_list_params.rbi index 75cfa6883..5cce942b2 100644 --- a/rbi/lib/increase/models/oauth_application_list_params.rbi +++ b/rbi/lib/increase/models/oauth_application_list_params.rbi @@ -51,8 +51,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(created_at: nil, cursor: nil, limit: nil, status: nil, request_options: {}); end - + def self.new( + created_at: nil, + # Return the page of entries after this one. + cursor: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. + limit: nil, + status: nil, + request_options: {} + ); end sig do override .returns( @@ -103,8 +111,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end @@ -122,8 +142,11 @@ module Increase params(in_: T::Array[Increase::Models::OAuthApplicationListParams::Status::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # Return results whose value is in the provided list. For GET requests, this + # should be encoded as a comma-delimited string, such as `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::OAuthApplicationListParams::Status::In::OrSymbol]}) } def to_hash; end diff --git a/rbi/lib/increase/models/oauth_connection.rbi b/rbi/lib/increase/models/oauth_connection.rbi index ecd7acde4..a29f7945b 100644 --- a/rbi/lib/increase/models/oauth_connection.rbi +++ b/rbi/lib/increase/models/oauth_connection.rbi @@ -49,8 +49,25 @@ module Increase ) .returns(T.attached_class) end - def self.new(id:, created_at:, deleted_at:, group_id:, oauth_application_id:, status:, type:); end - + def self.new( + # The OAuth Connection's identifier. + id:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth + # Connection was created. + created_at:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth + # Connection was deleted. + deleted_at:, + # The identifier of the Group that has authorized your OAuth application. + group_id:, + # The identifier of the OAuth application this connection is for. + oauth_application_id:, + # Whether the connection is active. + status:, + # A constant representing the object's type. For this resource it will always be + # `oauth_connection`. + type: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/oauth_connection_list_params.rbi b/rbi/lib/increase/models/oauth_connection_list_params.rbi index 59936d7e6..f20d859c5 100644 --- a/rbi/lib/increase/models/oauth_connection_list_params.rbi +++ b/rbi/lib/increase/models/oauth_connection_list_params.rbi @@ -48,8 +48,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(cursor: nil, limit: nil, oauth_application_id: nil, status: nil, request_options: {}); end - + def self.new( + # Return the page of entries after this one. + cursor: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. + limit: nil, + # Filter results to only include OAuth Connections for a specific OAuth + # Application. + oauth_application_id: nil, + status: nil, + request_options: {} + ); end sig do override .returns( @@ -78,8 +88,12 @@ module Increase params(in_: T::Array[Increase::Models::OAuthConnectionListParams::Status::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # Filter to OAuth Connections by their status. By default, return only the + # `active` ones. For GET requests, this should be encoded as a comma-delimited + # string, such as `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::OAuthConnectionListParams::Status::In::OrSymbol]}) } def to_hash; end diff --git a/rbi/lib/increase/models/oauth_token.rbi b/rbi/lib/increase/models/oauth_token.rbi index 33833fbb3..df9688850 100644 --- a/rbi/lib/increase/models/oauth_token.rbi +++ b/rbi/lib/increase/models/oauth_token.rbi @@ -28,8 +28,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(access_token:, token_type:, type:); end - + def self.new( + # You may use this token in place of an API key to make OAuth requests on a user's + # behalf. + access_token:, + # The type of OAuth token. + token_type:, + # A constant representing the object's type. For this resource it will always be + # `oauth_token`. + type: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/oauth_token_create_params.rbi b/rbi/lib/increase/models/oauth_token_create_params.rbi index 6ed968e1c..77ba0216e 100644 --- a/rbi/lib/increase/models/oauth_token_create_params.rbi +++ b/rbi/lib/increase/models/oauth_token_create_params.rbi @@ -56,15 +56,24 @@ module Increase .returns(T.attached_class) end def self.new( + # The credential you request in exchange for the code. In Production, this is + # always `authorization_code`. In Sandbox, you can pass either enum value. grant_type:, + # The public identifier for your application. client_id: nil, + # The secret that confirms you own the application. This is redundent given that + # the request is made with your API key but it's a required component of OAuth + # 2.0. client_secret: nil, + # The authorization code generated by the user and given to you as a query + # parameter. code: nil, + # The production token you want to exchange for a sandbox token. This is only + # available in Sandbox. Set `grant_type` to `production_token` to use this + # parameter. production_token: nil, request_options: {} - ) - end - + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/pending_transaction.rbi b/rbi/lib/increase/models/pending_transaction.rbi index e54c5e3c7..84a7a73ea 100644 --- a/rbi/lib/increase/models/pending_transaction.rbi +++ b/rbi/lib/increase/models/pending_transaction.rbi @@ -86,17 +86,41 @@ module Increase .returns(T.attached_class) end def self.new( + # The Pending Transaction identifier. id:, + # The identifier for the account this Pending Transaction belongs to. account_id:, + # The Pending Transaction amount in the minor unit of its currency. For dollars, + # for example, this is cents. amount:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending + # Transaction was completed. completed_at:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending + # Transaction occurred. created_at:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending + # Transaction's currency. This will match the currency on the Pending + # Transaction's Account. currency:, + # For a Pending Transaction related to a transfer, this is the description you + # provide. For a Pending Transaction related to a payment, this is the description + # the vendor provides. description:, + # The identifier for the route this Pending Transaction came through. Routes are + # things like cards and ACH details. route_id:, + # The type of the route this Pending Transaction came through. route_type:, + # This is an object giving more details on the network-level event that caused the + # Pending Transaction. For example, for a card transaction this lists the + # merchant's industry and location. source:, + # Whether the Pending Transaction has been confirmed and has an associated + # Transaction. status:, + # A constant representing the object's type. For this resource it will always be + # `pending_transaction`. type: ); end sig do @@ -380,16 +404,45 @@ module Increase .returns(T.attached_class) end def self.new( + # An Account Transfer Instruction object. This field will be present in the JSON + # response if and only if `category` is equal to `account_transfer_instruction`. account_transfer_instruction:, + # An ACH Transfer Instruction object. This field will be present in the JSON + # response if and only if `category` is equal to `ach_transfer_instruction`. ach_transfer_instruction:, + # A Card Authorization object. This field will be present in the JSON response if + # and only if `category` is equal to `card_authorization`. Card Authorizations are + # temporary holds placed on a customers funds with the intent to later clear a + # transaction. card_authorization:, + # The type of the resource. We may add additional possible values for this enum + # over time; your application should be able to handle such additions gracefully. category:, + # A Check Deposit Instruction object. This field will be present in the JSON + # response if and only if `category` is equal to `check_deposit_instruction`. check_deposit_instruction:, + # A Check Transfer Instruction object. This field will be present in the JSON + # response if and only if `category` is equal to `check_transfer_instruction`. check_transfer_instruction:, + # An Inbound Funds Hold object. This field will be present in the JSON response if + # and only if `category` is equal to `inbound_funds_hold`. We hold funds for + # certain transaction types to account for return windows where funds might still + # be clawed back by the sending institution. inbound_funds_hold:, + # An Inbound Wire Transfer Reversal object. This field will be present in the JSON + # response if and only if `category` is equal to `inbound_wire_transfer_reversal`. + # An Inbound Wire Transfer Reversal is created when Increase has received a wire + # and the User requests that it be reversed. inbound_wire_transfer_reversal:, + # If the category of this Transaction source is equal to `other`, this field will + # contain an empty object, otherwise it will contain null. other:, + # A Real-Time Payments Transfer Instruction object. This field will be present in + # the JSON response if and only if `category` is equal to + # `real_time_payments_transfer_instruction`. real_time_payments_transfer_instruction:, + # A Wire Transfer Instruction object. This field will be present in the JSON + # response if and only if `category` is equal to `wire_transfer_instruction`. wire_transfer_instruction: ); end sig do @@ -437,8 +490,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, currency:, transfer_id:); end - + def self.new( + # The pending amount in the minor unit of the transaction's currency. For dollars, + # for example, this is cents. + amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination + # account currency. + currency:, + # The identifier of the Account Transfer that led to this Pending Transaction. + transfer_id: + ); end sig do override .returns( @@ -524,8 +585,12 @@ module Increase # An ACH Transfer Instruction object. This field will be present in the JSON # response if and only if `category` is equal to `ach_transfer_instruction`. sig { params(amount: Integer, transfer_id: String).returns(T.attached_class) } - def self.new(amount:, transfer_id:); end - + def self.new( + # The pending amount in USD cents. + amount:, + # The identifier of the ACH Transfer that led to this Pending Transaction. + transfer_id: + ); end sig { override.returns({amount: Integer, transfer_id: String}) } def to_hash; end end @@ -734,32 +799,75 @@ module Increase .returns(T.attached_class) end def self.new( + # The Card Authorization identifier. id:, + # Whether this authorization was approved by Increase, the card network through + # stand-in processing, or the user through a real-time decision. actioner:, + # The pending amount in the minor unit of the transaction's currency. For dollars, + # for example, this is cents. amount:, + # The ID of the Card Payment this transaction belongs to. card_payment_id:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's currency. currency:, + # If the authorization was made via a Digital Wallet Token (such as an Apple Pay + # purchase), the identifier of the token that was used. digital_wallet_token_id:, + # The direction describes the direction the funds will move, either from the + # cardholder to the merchant or from the merchant to the cardholder. direction:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization + # will expire and the pending transaction will be released. expires_at:, + # The merchant identifier (commonly abbreviated as MID) of the merchant the card + # is transacting with. merchant_acceptor_id:, + # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the + # card is transacting with. merchant_category_code:, + # The city the merchant resides in. merchant_city:, + # The country the merchant resides in. merchant_country:, + # The merchant descriptor of the merchant the card is transacting with. merchant_descriptor:, + # The merchant's postal code. For US merchants this is either a 5-digit or 9-digit + # ZIP code, where the first 5 and last 4 are separated by a dash. merchant_postal_code:, + # The state the merchant resides in. merchant_state:, + # Fields specific to the `network`. network_details:, + # Network-specific identifiers for a specific request or transaction. network_identifiers:, + # The risk score generated by the card network. For Visa this is the Visa Advanced + # Authorization risk score, from 0 to 99, where 99 is the riskiest. network_risk_score:, + # The identifier of the Pending Transaction associated with this Transaction. pending_transaction_id:, + # If the authorization was made in-person with a physical card, the Physical Card + # that was used. physical_card_id:, + # The pending amount in the minor unit of the transaction's presentment currency. presentment_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's presentment currency. presentment_currency:, + # The processing category describes the intent behind the authorization, such as + # whether it was used for bill payments or an automatic fuel dispenser. processing_category:, + # The identifier of the Real-Time Decision sent to approve or decline this + # transaction. real_time_decision_id:, + # The terminal identifier (commonly abbreviated as TID) of the terminal the card + # is transacting with. terminal_id:, + # A constant representing the object's type. For this resource it will always be + # `card_authorization`. type:, + # Fields related to verification of cardholder-provided values. verification: ); end sig do @@ -934,8 +1042,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(category:, visa:); end - + def self.new( + # The payment network used to process this card authorization. + category:, + # Fields specific to the `visa` network. + visa: + ); end sig do override .returns( @@ -1022,12 +1134,17 @@ module Increase .returns(T.attached_class) end def self.new( + # For electronic commerce transactions, this identifies the level of security used + # in obtaining the customer's payment credential. For mail or telephone order + # transactions, identifies the type of mail or telephone order. electronic_commerce_indicator:, + # The method used to enter the cardholder's primary account number and card + # expiration date. point_of_service_entry_mode:, + # Only present when `actioner: network`. Describes why a card authorization was + # approved or declined by Visa through stand-in processing. stand_in_processing_reason: - ) - end - + ); end sig do override .returns( @@ -1316,8 +1433,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(retrieval_reference_number:, trace_number:, transaction_id:); end - + def self.new( + # A life-cycle identifier used across e.g., an authorization and a reversal. + # Expected to be unique per acquirer within a window of time. For some card + # networks the retrieval reference number includes the trace counter. + retrieval_reference_number:, + # A counter used to verify an individual authorization. Expected to be unique per + # acquirer within a window of time. + trace_number:, + # A globally unique transaction identifier provided by the card network, used + # across multiple life-cycle requests. + transaction_id: + ); end sig do override .returns( @@ -1464,8 +1591,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(card_verification_code:, cardholder_address:); end - + def self.new( + # Fields related to verification of the Card Verification Code, a 3-digit code on + # the back of the card. + card_verification_code:, + # Cardholder address provided in the authorization request and the address on file + # we verified it against. + cardholder_address: + ); end sig do override .returns( @@ -1494,8 +1627,10 @@ module Increase ) .returns(T.attached_class) end - def self.new(result:); end - + def self.new( + # The result of verifying the Card Verification Code. + result: + ); end sig do override .returns( @@ -1588,14 +1723,18 @@ module Increase .returns(T.attached_class) end def self.new( + # Line 1 of the address on file for the cardholder. actual_line1:, + # The postal code of the address on file for the cardholder. actual_postal_code:, + # The cardholder address line 1 provided for verification in the authorization + # request. provided_line1:, + # The postal code provided for verification in the authorization request. provided_postal_code:, + # The address verification result returned to the card network. result: - ) - end - + ); end sig do override .returns( @@ -1769,8 +1908,21 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, back_image_file_id:, check_deposit_id:, currency:, front_image_file_id:); end - + def self.new( + # The pending amount in USD cents. + amount:, + # The identifier of the File containing the image of the back of the check that + # was deposited. + back_image_file_id:, + # The identifier of the Check Deposit. + check_deposit_id:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's currency. + currency:, + # The identifier of the File containing the image of the front of the check that + # was deposited. + front_image_file_id: + ); end sig do override .returns( @@ -1852,8 +2004,15 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, currency:, transfer_id:); end - + def self.new( + # The transfer amount in USD cents. + amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's + # currency. + currency:, + # The identifier of the Check Transfer that led to this Pending Transaction. + transfer_id: + ); end sig do override .returns( @@ -1993,15 +2152,30 @@ module Increase .returns(T.attached_class) end def self.new( + # The Inbound Funds Hold identifier. id:, + # The held amount in the minor unit of the account's currency. For dollars, for + # example, this is cents. amount:, + # When the hold will be released automatically. Certain conditions may cause it to + # be released before this time. automatically_releases_at:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold + # was created. created_at:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's + # currency. currency:, + # The ID of the Transaction for which funds were held. held_transaction_id:, + # The ID of the Pending Transaction representing the held funds. pending_transaction_id:, + # When the hold was released (if it has been released). released_at:, + # The status of the hold. status:, + # A constant representing the object's type. For this resource it will always be + # `inbound_funds_hold`. type: ); end sig do @@ -2112,8 +2286,10 @@ module Increase # An Inbound Wire Transfer Reversal is created when Increase has received a wire # and the User requests that it be reversed. sig { params(inbound_wire_transfer_id: String).returns(T.attached_class) } - def self.new(inbound_wire_transfer_id:); end - + def self.new( + # The ID of the Inbound Wire Transfer that is being reversed. + inbound_wire_transfer_id: + ); end sig { override.returns({inbound_wire_transfer_id: String}) } def to_hash; end end @@ -2132,8 +2308,13 @@ module Increase # the JSON response if and only if `category` is equal to # `real_time_payments_transfer_instruction`. sig { params(amount: Integer, transfer_id: String).returns(T.attached_class) } - def self.new(amount:, transfer_id:); end - + def self.new( + # The transfer amount in USD cents. + amount:, + # The identifier of the Real-Time Payments Transfer that led to this Pending + # Transaction. + transfer_id: + ); end sig { override.returns({amount: Integer, transfer_id: String}) } def to_hash; end end @@ -2172,8 +2353,19 @@ module Increase ) .returns(T.attached_class) end - def self.new(account_number:, amount:, message_to_recipient:, routing_number:, transfer_id:); end - + def self.new( + # The account number for the destination account. + account_number:, + # The transfer amount in USD cents. + amount:, + # The message that will show on the recipient's bank statement. + message_to_recipient:, + # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the + # destination account. + routing_number:, + # The identifier of the Wire Transfer that led to this Pending Transaction. + transfer_id: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/pending_transaction_list_params.rbi b/rbi/lib/increase/models/pending_transaction_list_params.rbi index da8517d56..94383f729 100644 --- a/rbi/lib/increase/models/pending_transaction_list_params.rbi +++ b/rbi/lib/increase/models/pending_transaction_list_params.rbi @@ -80,11 +80,16 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter pending transactions to those belonging to the specified Account. account_id: nil, category: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, + # Filter pending transactions to those belonging to the specified Route. route_id: nil, status: nil, request_options: {} @@ -119,8 +124,11 @@ module Increase params(in_: T::Array[Increase::Models::PendingTransactionListParams::Category::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # Return results whose value is in the provided list. For GET requests, this + # should be encoded as a comma-delimited string, such as `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::PendingTransactionListParams::Category::In::OrSymbol]}) } def to_hash; end @@ -232,8 +240,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end @@ -253,8 +273,13 @@ module Increase params(in_: T::Array[Increase::Models::PendingTransactionListParams::Status::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # Filter Pending Transactions for those with the specified status. By default only + # Pending Transactions in with status `pending` will be returned. For GET + # requests, this should be encoded as a comma-delimited string, such as + # `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::PendingTransactionListParams::Status::In::OrSymbol]}) } def to_hash; end diff --git a/rbi/lib/increase/models/physical_card.rbi b/rbi/lib/increase/models/physical_card.rbi index 95abffbc9..926841c18 100644 --- a/rbi/lib/increase/models/physical_card.rbi +++ b/rbi/lib/increase/models/physical_card.rbi @@ -69,14 +69,27 @@ module Increase .returns(T.attached_class) end def self.new( + # The physical card identifier. id:, + # The identifier for the Card this Physical Card represents. card_id:, + # Details about the cardholder, as it appears on the printed card. cardholder:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the Physical Card was created. created_at:, + # 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). idempotency_key:, + # The Physical Card Profile used for this Physical Card. physical_card_profile_id:, + # The details used to ship this physical card. shipment:, + # The status of the Physical Card. status:, + # A constant representing the object's type. For this resource it will always be + # `physical_card`. type: ); end sig do @@ -108,8 +121,12 @@ module Increase # Details about the cardholder, as it appears on the printed card. sig { params(first_name: String, last_name: String).returns(T.attached_class) } - def self.new(first_name:, last_name:); end - + def self.new( + # The cardholder's first name. + first_name:, + # The cardholder's last name. + last_name: + ); end sig { override.returns({first_name: String, last_name: String}) } def to_hash; end end @@ -154,8 +171,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(address:, method_:, status:, tracking:); end - + def self.new( + # The location to where the card's packing label is addressed. + address:, + # The shipping method. + method_:, + # The status of this shipment. + status:, + # Tracking details for the shipment. + tracking: + ); end sig do override .returns( @@ -211,8 +236,22 @@ module Increase ) .returns(T.attached_class) end - def self.new(city:, line1:, line2:, line3:, name:, postal_code:, state:); end - + def self.new( + # The city of the shipping address. + city:, + # The first line of the shipping address. + line1:, + # The second line of the shipping address. + line2:, + # The third line of the shipping address. + line3:, + # The name of the recipient. + name:, + # The postal code of the shipping address. + postal_code:, + # The US state of the shipping address. + state: + ); end sig do override .returns( @@ -312,8 +351,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(number:, return_number:, return_reason:, shipped_at:); end - + def self.new( + # The tracking number. + number:, + # For returned shipments, the tracking number of the return shipment. + return_number:, + # For returned shipments, this describes why the package was returned. + return_reason:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the fulfillment provider marked the card as ready for pick-up by the shipment + # carrier. + shipped_at: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/physical_card_create_params.rbi b/rbi/lib/increase/models/physical_card_create_params.rbi index 05177eeb9..aab5a14e6 100644 --- a/rbi/lib/increase/models/physical_card_create_params.rbi +++ b/rbi/lib/increase/models/physical_card_create_params.rbi @@ -50,8 +50,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(card_id:, cardholder:, shipment:, physical_card_profile_id: nil, request_options: {}); end - + def self.new( + # The underlying card representing this physical card. + card_id:, + # Details about the cardholder, as it will appear on the physical card. + cardholder:, + # The details used to ship this physical card. + shipment:, + # The physical card profile to use for this physical card. The latest default + # physical card profile will be used if not provided. + physical_card_profile_id: nil, + request_options: {} + ); end sig do override .returns( @@ -77,8 +87,12 @@ module Increase # Details about the cardholder, as it will appear on the physical card. sig { params(first_name: String, last_name: String).returns(T.attached_class) } - def self.new(first_name:, last_name:); end - + def self.new( + # The cardholder's first name. + first_name:, + # The cardholder's last name. + last_name: + ); end sig { override.returns({first_name: String, last_name: String}) } def to_hash; end end @@ -108,8 +122,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(address:, method_:); end - + def self.new( + # The address to where the card should be shipped. + address:, + # The shipping method to use. + method_: + ); end sig do override .returns( @@ -177,9 +195,24 @@ module Increase ) .returns(T.attached_class) end - def self.new(city:, line1:, name:, postal_code:, state:, line2: nil, line3: nil, phone_number: nil) - end - + def self.new( + # The city of the shipping address. + city:, + # The first line of the shipping address. + line1:, + # The name of the recipient. + name:, + # The postal code of the shipping address. + postal_code:, + # The US state of the shipping address. + state:, + # The second line of the shipping address. + line2: nil, + # The third line of the shipping address. + line3: nil, + # The phone number of the recipient. + phone_number: nil + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/physical_card_list_params.rbi b/rbi/lib/increase/models/physical_card_list_params.rbi index 8c847b60d..62f5709a0 100644 --- a/rbi/lib/increase/models/physical_card_list_params.rbi +++ b/rbi/lib/increase/models/physical_card_list_params.rbi @@ -61,15 +61,21 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter Physical Cards to ones belonging to the specified Card. card_id: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # 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). idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -121,8 +127,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end diff --git a/rbi/lib/increase/models/physical_card_profile.rbi b/rbi/lib/increase/models/physical_card_profile.rbi index 91c792f84..1fda1a6f1 100644 --- a/rbi/lib/increase/models/physical_card_profile.rbi +++ b/rbi/lib/increase/models/physical_card_profile.rbi @@ -82,18 +82,36 @@ module Increase .returns(T.attached_class) end def self.new( + # The Card Profile identifier. id:, + # The identifier of the File containing the physical card's back image. back_image_file_id:, + # The identifier of the File containing the physical card's carrier image. carrier_image_file_id:, + # A phone number the user can contact to receive support for their card. contact_phone:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the Card Dispute was created. created_at:, + # The creator of this Physical Card Profile. creator:, + # A description you can use to identify the Physical Card Profile. description:, + # The identifier of the File containing the physical card's front image. front_image_file_id:, + # 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). idempotency_key:, + # Whether this Physical Card Profile is the default for all cards in its Increase + # group. is_default:, + # The identifier for the Program this Physical Card Profile belongs to. program_id:, + # The status of the Physical Card Profile. status:, + # A constant representing the object's type. For this resource it will always be + # `physical_card_profile`. type: ); end sig do diff --git a/rbi/lib/increase/models/physical_card_profile_clone_params.rbi b/rbi/lib/increase/models/physical_card_profile_clone_params.rbi index 5bae9823a..16467a225 100644 --- a/rbi/lib/increase/models/physical_card_profile_clone_params.rbi +++ b/rbi/lib/increase/models/physical_card_profile_clone_params.rbi @@ -59,10 +59,16 @@ module Increase .returns(T.attached_class) end def self.new( + # The identifier of the File containing the physical card's carrier image. carrier_image_file_id: nil, + # A phone number the user can contact to receive support for their card. contact_phone: nil, + # A description you can use to identify the Card Profile. description: nil, + # The identifier of the File containing the physical card's front image. front_image_file_id: nil, + # Text printed on the front of the card. Reach out to + # [support@increase.com](mailto:support@increase.com) for more information. front_text: nil, request_options: {} ); end @@ -98,8 +104,14 @@ module Increase # Text printed on the front of the card. Reach out to # [support@increase.com](mailto:support@increase.com) for more information. sig { params(line1: String, line2: String).returns(T.attached_class) } - def self.new(line1:, line2: nil); end - + def self.new( + # The first line of text on the front of the card. + line1:, + # The second line of text on the front of the card. Providing a second line moves + # the first line slightly higher and prints the second line in the spot where the + # first line would have otherwise been printed. + line2: nil + ); end sig { override.returns({line1: String, line2: String}) } def to_hash; end end diff --git a/rbi/lib/increase/models/physical_card_profile_create_params.rbi b/rbi/lib/increase/models/physical_card_profile_create_params.rbi index e05f1ef85..ec9d27630 100644 --- a/rbi/lib/increase/models/physical_card_profile_create_params.rbi +++ b/rbi/lib/increase/models/physical_card_profile_create_params.rbi @@ -38,10 +38,15 @@ module Increase .returns(T.attached_class) end def self.new( + # The identifier of the File containing the physical card's carrier image. carrier_image_file_id:, + # A phone number the user can contact to receive support for their card. contact_phone:, + # A description you can use to identify the Card Profile. description:, + # The identifier of the File containing the physical card's front image. front_image_file_id:, + # The identifier for the Program that this Physical Card Profile falls under. program_id:, request_options: {} ); end diff --git a/rbi/lib/increase/models/physical_card_profile_list_params.rbi b/rbi/lib/increase/models/physical_card_profile_list_params.rbi index ffc55f88b..b077b5c27 100644 --- a/rbi/lib/increase/models/physical_card_profile_list_params.rbi +++ b/rbi/lib/increase/models/physical_card_profile_list_params.rbi @@ -52,8 +52,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}); end - + def self.new( + # Return the page of entries after this one. + cursor: nil, + # 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). + idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. + limit: nil, + status: nil, + request_options: {} + ); end sig do override .returns( @@ -82,8 +94,12 @@ module Increase params(in_: T::Array[Increase::Models::PhysicalCardProfileListParams::Status::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # Filter Physical Card Profiles for those with the specified statuses. For GET + # requests, this should be encoded as a comma-delimited string, such as + # `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::PhysicalCardProfileListParams::Status::In::OrSymbol]}) } def to_hash; end diff --git a/rbi/lib/increase/models/physical_card_update_params.rbi b/rbi/lib/increase/models/physical_card_update_params.rbi index 18e7d9eab..cd5a9a534 100644 --- a/rbi/lib/increase/models/physical_card_update_params.rbi +++ b/rbi/lib/increase/models/physical_card_update_params.rbi @@ -17,8 +17,11 @@ module Increase ) .returns(T.attached_class) end - def self.new(status:, request_options: {}); end - + def self.new( + # The status to update the Physical Card to. + status:, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/program.rbi b/rbi/lib/increase/models/program.rbi index 0927a9076..a0616d3ad 100644 --- a/rbi/lib/increase/models/program.rbi +++ b/rbi/lib/increase/models/program.rbi @@ -63,14 +63,28 @@ module Increase .returns(T.attached_class) end def self.new( + # The Program identifier. id:, + # The Bank the Program is with. bank:, + # The Program billing account. billing_account_id:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program + # was created. created_at:, + # The default configuration for digital cards attached to this Program. default_digital_card_profile_id:, + # The Interest Rate currently being earned on the accounts in this program, as a + # string containing a decimal number. For example, a 1% interest rate would be + # represented as "0.01". interest_rate:, + # The name of the Program. name:, + # A constant representing the object's type. For this resource it will always be + # `program`. type:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program + # was last updated. updated_at: ); end sig do diff --git a/rbi/lib/increase/models/program_list_params.rbi b/rbi/lib/increase/models/program_list_params.rbi index af6af18b8..46a19deb4 100644 --- a/rbi/lib/increase/models/program_list_params.rbi +++ b/rbi/lib/increase/models/program_list_params.rbi @@ -29,8 +29,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(cursor: nil, limit: nil, request_options: {}); end - + def self.new( + # Return the page of entries after this one. + cursor: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. + limit: nil, + request_options: {} + ); end sig { override.returns({cursor: String, limit: Integer, request_options: Increase::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/increase/models/real_time_decision.rbi b/rbi/lib/increase/models/real_time_decision.rbi index 8c9c0e2ff..5b8ce9b08 100644 --- a/rbi/lib/increase/models/real_time_decision.rbi +++ b/rbi/lib/increase/models/real_time_decision.rbi @@ -119,16 +119,30 @@ module Increase .returns(T.attached_class) end def self.new( + # The Real-Time Decision identifier. id:, + # Fields related to a 3DS authentication attempt. card_authentication:, + # Fields related to a 3DS authentication attempt. card_authentication_challenge:, + # Fields related to a card authorization. card_authorization:, + # The category of the Real-Time Decision. category:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the Real-Time Decision was created. created_at:, + # Fields related to a digital wallet authentication attempt. digital_wallet_authentication:, + # Fields related to a digital wallet token provisioning attempt. digital_wallet_token:, + # The status of the Real-Time Decision. status:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # your application can no longer respond to the Real-Time Decision. timeout_at:, + # A constant representing the object's type. For this resource it will always be + # `real_time_decision`. type: ); end sig do @@ -179,8 +193,17 @@ module Increase ) .returns(T.attached_class) end - def self.new(account_id:, card_id:, decision:, upcoming_card_payment_id:); end - + def self.new( + # The identifier of the Account the card belongs to. + account_id:, + # The identifier of the Card that is being tokenized. + card_id:, + # Whether or not the authentication attempt was approved. + decision:, + # The identifier of the Card Payment this authentication attempt will belong to. + # Available in the API once the card authentication has completed. + upcoming_card_payment_id: + ); end sig do override .returns( @@ -250,8 +273,19 @@ module Increase ) .returns(T.attached_class) end - def self.new(account_id:, card_id:, card_payment_id:, one_time_code:, result:); end - + def self.new( + # The identifier of the Account the card belongs to. + account_id:, + # The identifier of the Card that is being tokenized. + card_id:, + # The identifier of the Card Payment this authentication challenge attempt belongs + # to. + card_payment_id:, + # The one-time code delivered to the cardholder. + one_time_code:, + # Whether or not the challenge was delivered to the cardholder. + result: + ); end sig do override .returns( @@ -476,30 +510,70 @@ module Increase .returns(T.attached_class) end def self.new( + # The identifier of the Account the authorization will debit. account_id:, + # The identifier of the Card that is being authorized. card_id:, + # Whether or not the authorization was approved. decision:, + # If the authorization was made via a Digital Wallet Token (such as an Apple Pay + # purchase), the identifier of the token that was used. digital_wallet_token_id:, + # The direction describes the direction the funds will move, either from the + # cardholder to the merchant or from the merchant to the cardholder. direction:, + # The merchant identifier (commonly abbreviated as MID) of the merchant the card + # is transacting with. merchant_acceptor_id:, + # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the + # card is transacting with. merchant_category_code:, + # The city the merchant resides in. merchant_city:, + # The country the merchant resides in. merchant_country:, + # The merchant descriptor of the merchant the card is transacting with. merchant_descriptor:, + # The merchant's postal code. For US merchants this is either a 5-digit or 9-digit + # ZIP code, where the first 5 and last 4 are separated by a dash. merchant_postal_code:, + # The state the merchant resides in. merchant_state:, + # Fields specific to the `network`. network_details:, + # Network-specific identifiers for a specific request or transaction. network_identifiers:, + # The risk score generated by the card network. For Visa this is the Visa Advanced + # Authorization risk score, from 0 to 99, where 99 is the riskiest. network_risk_score:, + # If the authorization was made in-person with a physical card, the Physical Card + # that was used. physical_card_id:, + # The amount of the attempted authorization in the currency the card user sees at + # the time of purchase, in the minor unit of that currency. For dollars, for + # example, this is cents. presentment_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the + # user sees at the time of purchase. presentment_currency:, + # The processing category describes the intent behind the authorization, such as + # whether it was used for bill payments or an automatic fuel dispenser. processing_category:, + # Fields specific to the type of request, such as an incremental authorization. request_details:, + # The amount of the attempted authorization in the currency it will be settled in. + # This currency is the same as that of the Account the card belongs to. settlement_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the + # transaction will be settled in. settlement_currency:, + # The terminal identifier (commonly abbreviated as TID) of the terminal the card + # is transacting with. terminal_id:, + # The identifier of the Card Payment this authorization will belong to. Available + # in the API once the card authorization has completed. upcoming_card_payment_id:, + # Fields related to verification of cardholder-provided values. verification: ); end sig do @@ -609,8 +683,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(category:, visa:); end - + def self.new( + # The payment network used to process this card authorization. + category:, + # Fields specific to the `visa` network. + visa: + ); end sig do override .returns( @@ -697,12 +775,17 @@ module Increase .returns(T.attached_class) end def self.new( + # For electronic commerce transactions, this identifies the level of security used + # in obtaining the customer's payment credential. For mail or telephone order + # transactions, identifies the type of mail or telephone order. electronic_commerce_indicator:, + # The method used to enter the cardholder's primary account number and card + # expiration date. point_of_service_entry_mode:, + # Only present when `actioner: network`. Describes why a card authorization was + # approved or declined by Visa through stand-in processing. stand_in_processing_reason: - ) - end - + ); end sig do override .returns( @@ -991,8 +1074,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(retrieval_reference_number:, trace_number:, transaction_id:); end - + def self.new( + # A life-cycle identifier used across e.g., an authorization and a reversal. + # Expected to be unique per acquirer within a window of time. For some card + # networks the retrieval reference number includes the trace counter. + retrieval_reference_number:, + # A counter used to verify an individual authorization. Expected to be unique per + # acquirer within a window of time. + trace_number:, + # A globally unique transaction identifier provided by the card network, used + # across multiple life-cycle requests. + transaction_id: + ); end sig do override .returns( @@ -1103,8 +1196,15 @@ module Increase ) .returns(T.attached_class) end - def self.new(category:, incremental_authorization:, initial_authorization:); end - + def self.new( + # The type of this request (e.g., an initial authorization or an incremental + # authorization). + category:, + # Fields specific to the category `incremental_authorization`. + incremental_authorization:, + # Fields specific to the category `initial_authorization`. + initial_authorization: + ); end sig do override .returns( @@ -1166,8 +1266,13 @@ module Increase original_card_authorization_id: String ).returns(T.attached_class) end - def self.new(card_payment_id:, original_card_authorization_id:); end - + def self.new( + # The card payment for this authorization and increment. + card_payment_id:, + # The identifier of the card authorization this request is attempting to + # increment. + original_card_authorization_id: + ); end sig { override.returns({card_payment_id: String, original_card_authorization_id: String}) } def to_hash; end end @@ -1220,8 +1325,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(card_verification_code:, cardholder_address:); end - + def self.new( + # Fields related to verification of the Card Verification Code, a 3-digit code on + # the back of the card. + card_verification_code:, + # Cardholder address provided in the authorization request and the address on file + # we verified it against. + cardholder_address: + ); end sig do override .returns( @@ -1250,8 +1361,10 @@ module Increase ) .returns(T.attached_class) end - def self.new(result:); end - + def self.new( + # The result of verifying the Card Verification Code. + result: + ); end sig do override .returns( @@ -1343,9 +1456,19 @@ module Increase ) .returns(T.attached_class) end - def self.new(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:) - end - + def self.new( + # Line 1 of the address on file for the cardholder. + actual_line1:, + # The postal code of the address on file for the cardholder. + actual_postal_code:, + # The cardholder address line 1 provided for verification in the authorization + # request. + provided_line1:, + # The postal code provided for verification in the authorization request. + provided_postal_code:, + # The address verification result returned to the card network. + result: + ); end sig do override .returns( @@ -1506,8 +1629,23 @@ module Increase ) .returns(T.attached_class) end - def self.new(card_id:, channel:, digital_wallet:, email:, one_time_passcode:, phone:, result:); end - + def self.new( + # The identifier of the Card that is being tokenized. + card_id:, + # The channel to send the card user their one-time passcode. + channel:, + # The digital wallet app being used. + digital_wallet:, + # The email to send the one-time passcode to if `channel` is equal to `email`. + email:, + # The one-time passcode to send the card user. + one_time_passcode:, + # The phone number to send the one-time passcode to if `channel` is equal to + # `sms`. + phone:, + # Whether your application successfully delivered the one-time passcode. + result: + ); end sig do override .returns( @@ -1658,8 +1796,21 @@ module Increase ) .returns(T.attached_class) end - def self.new(card_id:, card_profile_id:, decision:, device:, digital_wallet:); end - + def self.new( + # The identifier of the Card that is being tokenized. + card_id:, + # The identifier of the Card Profile that was set via the real time decision. This + # will be null until the real time decision is responded to or if the real time + # decision did not set a card profile. + card_profile_id:, + # Whether or not the provisioning request was approved. This will be null until + # the real time decision is responded to. + decision:, + # Device that is being used to provision the digital wallet token. + device:, + # The digital wallet app being used. + digital_wallet: + ); end sig do override .returns( @@ -1700,8 +1851,10 @@ module Increase # Device that is being used to provision the digital wallet token. sig { params(identifier: T.nilable(String)).returns(T.attached_class) } - def self.new(identifier:); end - + def self.new( + # ID assigned to the device by the digital wallet provider. + identifier: + ); end sig { override.returns({identifier: T.nilable(String)}) } def to_hash; end end diff --git a/rbi/lib/increase/models/real_time_decision_action_params.rbi b/rbi/lib/increase/models/real_time_decision_action_params.rbi index e4f4c3689..603dd8bf9 100644 --- a/rbi/lib/increase/models/real_time_decision_action_params.rbi +++ b/rbi/lib/increase/models/real_time_decision_action_params.rbi @@ -95,10 +95,20 @@ module Increase .returns(T.attached_class) end def self.new( + # If the Real-Time Decision relates to a 3DS card authentication attempt, this + # object contains your response to the authentication. card_authentication: nil, + # If the Real-Time Decision relates to 3DS card authentication challenge delivery, + # this object contains your response. card_authentication_challenge: nil, + # If the Real-Time Decision relates to a card authorization attempt, this object + # contains your response to the authorization. card_authorization: nil, + # If the Real-Time Decision relates to a digital wallet authentication attempt, + # this object contains your response to the authentication. digital_wallet_authentication: nil, + # If the Real-Time Decision relates to a digital wallet token provisioning + # attempt, this object contains your response to the attempt. digital_wallet_token: nil, request_options: {} ); end @@ -128,8 +138,10 @@ module Increase params(decision: Increase::Models::RealTimeDecisionActionParams::CardAuthentication::Decision::OrSymbol) .returns(T.attached_class) end - def self.new(decision:); end - + def self.new( + # Whether the card authentication attempt should be approved or declined. + decision: + ); end sig do override .returns( @@ -188,8 +200,11 @@ module Increase ) .returns(T.attached_class) end - def self.new(result:); end - + def self.new( + # Whether the card authentication challenge was successfully delivered to the + # cardholder. + result: + ); end sig do override .returns( @@ -262,8 +277,13 @@ module Increase ) .returns(T.attached_class) end - def self.new(decision:, decline_reason: nil); end - + def self.new( + # Whether the card authorization should be approved or declined. + decision:, + # The reason the card authorization was declined. This translates to a specific + # decline code that is sent to the card network. + decline_reason: nil + ); end sig do override .returns( @@ -392,8 +412,11 @@ module Increase ) .returns(T.attached_class) end - def self.new(result:, success: nil); end - + def self.new( + # Whether your application was able to deliver the one-time passcode. + result:, + success: nil + ); end sig do override .returns( @@ -453,8 +476,13 @@ module Increase attr_writer :phone sig { params(email: String, phone: String).returns(T.attached_class) } - def self.new(email: nil, phone: nil); end - + def self.new( + # The email address that was used to verify the cardholder via one-time passcode. + email: nil, + # The phone number that was used to verify the cardholder via one-time passcode + # over SMS. + phone: nil + ); end sig { override.returns({email: String, phone: String}) } def to_hash; end end @@ -508,8 +536,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(approval: nil, decline: nil); end - + def self.new( + # If your application approves the provisioning attempt, this contains metadata + # about the digital wallet token that will be generated. + approval: nil, + # If your application declines the provisioning attempt, this contains details + # about the decline. + decline: nil + ); end sig do override .returns( @@ -541,8 +575,14 @@ module Increase # If your application approves the provisioning attempt, this contains metadata # about the digital wallet token that will be generated. sig { params(email: String, phone: String).returns(T.attached_class) } - def self.new(email: nil, phone: nil); end - + def self.new( + # An email address that can be used to verify the cardholder via one-time + # passcode. + email: nil, + # A phone number that can be used to verify the cardholder via one-time passcode + # over SMS. + phone: nil + ); end sig { override.returns({email: String, phone: String}) } def to_hash; end end @@ -559,8 +599,11 @@ module Increase # If your application declines the provisioning attempt, this contains details # about the decline. sig { params(reason: String).returns(T.attached_class) } - def self.new(reason: nil); end - + def self.new( + # Why the tokenization attempt was declined. This is for logging purposes only and + # is not displayed to the end-user. + reason: nil + ); end sig { override.returns({reason: String}) } def to_hash; end end diff --git a/rbi/lib/increase/models/real_time_payments_transfer.rbi b/rbi/lib/increase/models/real_time_payments_transfer.rbi index 07921bc3e..f1529517c 100644 --- a/rbi/lib/increase/models/real_time_payments_transfer.rbi +++ b/rbi/lib/increase/models/real_time_payments_transfer.rbi @@ -202,30 +202,73 @@ module Increase .returns(T.attached_class) end def self.new( + # The Real-Time Payments Transfer's identifier. id:, + # The Account from which the transfer was sent. account_id:, + # If the transfer is acknowledged by the recipient bank, this will contain + # supplemental details. acknowledgement:, + # The transfer amount in USD cents. amount:, + # If your account requires approvals for transfers and the transfer was approved, + # this will contain details of the approval. approval:, + # If your account requires approvals for transfers and the transfer was not + # approved, this will contain details of the cancellation. cancellation:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the transfer was created. created_at:, + # What object created the transfer, either via the API or the dashboard. created_by:, + # The name of the transfer's recipient. This is set by the sender when creating + # the transfer. creditor_name:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's + # currency. For real-time payments transfers this is always equal to `USD`. currency:, + # The name of the transfer's sender. If not provided, defaults to the name of the + # account's entity. debtor_name:, + # The destination account number. destination_account_number:, + # The destination American Bankers' Association (ABA) Routing Transit Number + # (RTN). destination_routing_number:, + # The identifier of the External Account the transfer was made to, if any. external_account_id:, + # 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). idempotency_key:, + # The ID for the pending transaction representing the transfer. A pending + # transaction is created when the transfer + # [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) + # by someone else in your organization. pending_transaction_id:, + # If the transfer is rejected by Real-Time Payments or the destination financial + # institution, this will contain supplemental details. rejection:, + # Unstructured information that will show on the recipient's bank statement. remittance_information:, + # The Account Number the recipient will see as having sent the transfer. source_account_number_id:, + # The lifecycle status of the transfer. status:, + # After the transfer is submitted to Real-Time Payments, this will contain + # supplemental details. submission:, + # The Transaction funding the transfer once it is complete. transaction_id:, + # A constant representing the object's type. For this resource it will always be + # `real_time_payments_transfer`. type:, + # The name of the ultimate recipient of the transfer. Set this if the creditor is + # an intermediary receiving the payment for someone else. ultimate_creditor_name:, + # The name of the ultimate sender of the transfer. Set this if the funds are being + # sent on behalf of someone who is not the account holder at Increase. ultimate_debtor_name: ); end sig do @@ -270,8 +313,10 @@ module Increase # If the transfer is acknowledged by the recipient bank, this will contain # supplemental details. sig { params(acknowledged_at: Time).returns(T.attached_class) } - def self.new(acknowledged_at:); end - + def self.new( + # When the transfer was acknowledged. + acknowledged_at: + ); end sig { override.returns({acknowledged_at: Time}) } def to_hash; end end @@ -290,8 +335,14 @@ module Increase # If your account requires approvals for transfers and the transfer was approved, # this will contain details of the approval. sig { params(approved_at: Time, approved_by: T.nilable(String)).returns(T.attached_class) } - def self.new(approved_at:, approved_by:); end - + def self.new( + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the transfer was approved. + approved_at:, + # If the Transfer was approved by a user in the dashboard, the email address of + # that user. + approved_by: + ); end sig { override.returns({approved_at: Time, approved_by: T.nilable(String)}) } def to_hash; end end @@ -310,8 +361,14 @@ module Increase # If your account requires approvals for transfers and the transfer was not # approved, this will contain details of the cancellation. sig { params(canceled_at: Time, canceled_by: T.nilable(String)).returns(T.attached_class) } - def self.new(canceled_at:, canceled_by:); end - + def self.new( + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the Transfer was canceled. + canceled_at:, + # If the Transfer was canceled by a user in the dashboard, the email address of + # that user. + canceled_by: + ); end sig { override.returns({canceled_at: Time, canceled_by: T.nilable(String)}) } def to_hash; end end @@ -381,8 +438,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(api_key:, category:, oauth_application:, user:); end - + def self.new( + # If present, details about the API key that created the transfer. + api_key:, + # The type of object that created this transfer. + category:, + # If present, details about the OAuth Application that created the transfer. + oauth_application:, + # If present, details about the User that created the transfer. + user: + ); end sig do override .returns( @@ -403,8 +468,10 @@ module Increase # If present, details about the API key that created the transfer. sig { params(description: T.nilable(String)).returns(T.attached_class) } - def self.new(description:); end - + def self.new( + # The description set for the API key when it was created. + description: + ); end sig { override.returns({description: T.nilable(String)}) } def to_hash; end end @@ -438,8 +505,10 @@ module Increase # If present, details about the OAuth Application that created the transfer. sig { params(name: String).returns(T.attached_class) } - def self.new(name:); end - + def self.new( + # The name of the OAuth Application. + name: + ); end sig { override.returns({name: String}) } def to_hash; end end @@ -451,8 +520,10 @@ module Increase # If present, details about the User that created the transfer. sig { params(email: String).returns(T.attached_class) } - def self.new(email:); end - + def self.new( + # The email address of the User. + email: + ); end sig { override.returns({email: String}) } def to_hash; end end @@ -514,8 +585,17 @@ module Increase ) .returns(T.attached_class) end - def self.new(reject_reason_additional_information:, reject_reason_code:, rejected_at:); end - + def self.new( + # Additional information about the rejection provided by the recipient bank when + # the `reject_reason_code` is `NARRATIVE`. + reject_reason_additional_information:, + # The reason the transfer was rejected as provided by the recipient bank or the + # Real-Time Payments network. + reject_reason_code:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the transfer was rejected. + rejected_at: + ); end sig do override .returns( @@ -737,8 +817,13 @@ module Increase sig do params(submitted_at: T.nilable(Time), transaction_identification: String).returns(T.attached_class) end - def self.new(submitted_at:, transaction_identification:); end - + def self.new( + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the transfer was submitted to The Clearing House. + submitted_at:, + # The Real-Time Payments network identification of the transfer. + transaction_identification: + ); end sig { override.returns({submitted_at: T.nilable(Time), transaction_identification: String}) } def to_hash; end end diff --git a/rbi/lib/increase/models/real_time_payments_transfer_create_params.rbi b/rbi/lib/increase/models/real_time_payments_transfer_create_params.rbi index 75d841dbf..317556550 100644 --- a/rbi/lib/increase/models/real_time_payments_transfer_create_params.rbi +++ b/rbi/lib/increase/models/real_time_payments_transfer_create_params.rbi @@ -96,16 +96,34 @@ module Increase .returns(T.attached_class) end def self.new( + # The transfer amount in USD cents. For Real-Time Payments transfers, must be + # positive. amount:, + # The name of the transfer's recipient. creditor_name:, + # Unstructured information that will show on the recipient's bank statement. remittance_information:, + # The identifier of the Account Number from which to send the transfer. source_account_number_id:, + # The name of the transfer's sender. If not provided, defaults to the name of the + # account's entity. debtor_name: nil, + # The destination account number. destination_account_number: nil, + # The destination American Bankers' Association (ABA) Routing Transit Number + # (RTN). destination_routing_number: nil, + # The ID of an External Account to initiate a transfer to. If this parameter is + # provided, `destination_account_number` and `destination_routing_number` must be + # absent. external_account_id: nil, + # Whether the transfer requires explicit approval via the dashboard or API. require_approval: nil, + # The name of the ultimate recipient of the transfer. Set this if the creditor is + # an intermediary receiving the payment for someone else. ultimate_creditor_name: nil, + # The name of the ultimate sender of the transfer. Set this if the funds are being + # sent on behalf of someone who is not the account holder at Increase. ultimate_debtor_name: nil, request_options: {} ); end diff --git a/rbi/lib/increase/models/real_time_payments_transfer_list_params.rbi b/rbi/lib/increase/models/real_time_payments_transfer_list_params.rbi index 6b22b540d..d96e99451 100644 --- a/rbi/lib/increase/models/real_time_payments_transfer_list_params.rbi +++ b/rbi/lib/increase/models/real_time_payments_transfer_list_params.rbi @@ -82,11 +82,21 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter Real-Time Payments Transfers to those belonging to the specified Account. account_id: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # Filter Real-Time Payments Transfers to those made to the specified External + # Account. external_account_id: nil, + # 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). idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, status: nil, request_options: {} @@ -144,8 +154,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end @@ -163,8 +185,11 @@ module Increase params(in_: T::Array[Increase::Models::RealTimePaymentsTransferListParams::Status::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # Return results whose value is in the provided list. For GET requests, this + # should be encoded as a comma-delimited string, such as `?in=one,two,three`. + in_: nil + ); end sig do override .returns({in_: T::Array[Increase::Models::RealTimePaymentsTransferListParams::Status::In::OrSymbol]}) diff --git a/rbi/lib/increase/models/routing_number_list_params.rbi b/rbi/lib/increase/models/routing_number_list_params.rbi index bf357b2f9..a8e71cb5f 100644 --- a/rbi/lib/increase/models/routing_number_list_params.rbi +++ b/rbi/lib/increase/models/routing_number_list_params.rbi @@ -34,8 +34,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(routing_number:, cursor: nil, limit: nil, request_options: {}); end - + def self.new( + # Filter financial institutions by routing number. + routing_number:, + # Return the page of entries after this one. + cursor: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. + limit: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/routing_number_list_response.rbi b/rbi/lib/increase/models/routing_number_list_response.rbi index 59c2fccb1..c6ee14aa9 100644 --- a/rbi/lib/increase/models/routing_number_list_response.rbi +++ b/rbi/lib/increase/models/routing_number_list_response.rbi @@ -41,15 +41,20 @@ module Increase .returns(T.attached_class) end def self.new( + # This routing number's support for ACH Transfers. ach_transfers:, + # The name of the financial institution belonging to a routing number. name:, + # This routing number's support for Real-Time Payments Transfers. real_time_payments_transfers:, + # The nine digit routing number identifier. routing_number:, + # A constant representing the object's type. For this resource it will always be + # `routing_number`. type:, + # This routing number's support for Wire Transfers. wire_transfers: - ) - end - + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/simulations/account_statement_create_params.rbi b/rbi/lib/increase/models/simulations/account_statement_create_params.rbi index e61433587..6066dd7a7 100644 --- a/rbi/lib/increase/models/simulations/account_statement_create_params.rbi +++ b/rbi/lib/increase/models/simulations/account_statement_create_params.rbi @@ -21,8 +21,11 @@ module Increase ) .returns(T.attached_class) end - def self.new(account_id:, request_options: {}); end - + def self.new( + # The identifier of the Account the statement is for. + account_id:, + request_options: {} + ); end sig { override.returns({account_id: String, request_options: Increase::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbi b/rbi/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbi index d4e1bc5d9..625088ccf 100644 --- a/rbi/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbi +++ b/rbi/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbi @@ -23,8 +23,13 @@ module Increase ) .returns(T.attached_class) end - def self.new(change_code:, corrected_data:, request_options: {}); end - + def self.new( + # The reason for the notification of change. + change_code:, + # The corrected data for the notification of change (e.g., a new routing number). + corrected_data:, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/simulations/ach_transfer_return_params.rbi b/rbi/lib/increase/models/simulations/ach_transfer_return_params.rbi index 23681d2ed..01863bbbc 100644 --- a/rbi/lib/increase/models/simulations/ach_transfer_return_params.rbi +++ b/rbi/lib/increase/models/simulations/ach_transfer_return_params.rbi @@ -22,8 +22,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(reason: nil, request_options: {}); end - + def self.new( + # The reason why the Federal Reserve or destination bank returned this transfer. + # Defaults to `no_account`. + reason: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/simulations/card_authorization_create_params.rbi b/rbi/lib/increase/models/simulations/card_authorization_create_params.rbi index 5c37e7dc2..ca0fb252a 100644 --- a/rbi/lib/increase/models/simulations/card_authorization_create_params.rbi +++ b/rbi/lib/increase/models/simulations/card_authorization_create_params.rbi @@ -173,22 +173,49 @@ module Increase .returns(T.attached_class) end def self.new( + # The authorization amount in cents. amount:, + # The identifier of a Card Payment with a `card_authentication` if you want to + # simulate an authenticated authorization. authenticated_card_payment_id: nil, + # The identifier of the Card to be authorized. card_id: nil, + # Forces a card decline with a specific reason. No real time decision will be + # sent. decline_reason: nil, + # The identifier of the Digital Wallet Token to be authorized. digital_wallet_token_id: nil, + # The direction describes the direction the funds will move, either from the + # cardholder to the merchant or from the merchant to the cardholder. direction: nil, + # The identifier of the Event Subscription to use. If provided, will override the + # default real time event subscription. Because you can only create one real time + # decision event subscription, you can use this field to route events to any + # specified event subscription for testing purposes. event_subscription_id: nil, + # The merchant identifier (commonly abbreviated as MID) of the merchant the card + # is transacting with. merchant_acceptor_id: nil, + # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the + # card is transacting with. merchant_category_code: nil, + # The city the merchant resides in. merchant_city: nil, + # The country the merchant resides in. merchant_country: nil, + # The merchant descriptor of the merchant the card is transacting with. merchant_descriptor: nil, + # The state the merchant resides in. merchant_state: nil, + # Fields specific to a given card network. network_details: nil, + # The risk score generated by the card network. For Visa this is the Visa Advanced + # Authorization risk score, from 0 to 99, where 99 is the riskiest. network_risk_score: nil, + # The identifier of the Physical Card to be authorized. physical_card_id: nil, + # The terminal identifier (commonly abbreviated as TID) of the terminal the card + # is transacting with. terminal_id: nil, request_options: {} ); end @@ -413,8 +440,10 @@ module Increase ) .returns(T.attached_class) end - def self.new(visa:); end - + def self.new( + # Fields specific to the Visa network. + visa: + ); end sig do override .returns({visa: Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa}) @@ -447,8 +476,10 @@ module Increase ) .returns(T.attached_class) end - def self.new(stand_in_processing_reason: nil); end - + def self.new( + # The reason code for the stand-in processing. + stand_in_processing_reason: nil + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/simulations/card_authorization_create_response.rbi b/rbi/lib/increase/models/simulations/card_authorization_create_response.rbi index 7b0e1fb7b..ae8201db5 100644 --- a/rbi/lib/increase/models/simulations/card_authorization_create_response.rbi +++ b/rbi/lib/increase/models/simulations/card_authorization_create_response.rbi @@ -46,8 +46,19 @@ module Increase ) .returns(T.attached_class) end - def self.new(declined_transaction:, pending_transaction:, type:); end - + def self.new( + # If the authorization attempt fails, this will contain the resulting + # [Declined Transaction](#declined-transactions) object. The Declined + # Transaction's `source` will be of `category: card_decline`. + declined_transaction:, + # If the authorization attempt succeeds, this will contain the resulting Pending + # Transaction object. The Pending Transaction's `source` will be of + # `category: card_authorization`. + pending_transaction:, + # A constant representing the object's type. For this resource it will always be + # `inbound_card_authorization_simulation_result`. + type: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/simulations/card_authorization_expiration_create_params.rbi b/rbi/lib/increase/models/simulations/card_authorization_expiration_create_params.rbi index 27646b6ed..94f8e442b 100644 --- a/rbi/lib/increase/models/simulations/card_authorization_expiration_create_params.rbi +++ b/rbi/lib/increase/models/simulations/card_authorization_expiration_create_params.rbi @@ -18,8 +18,11 @@ module Increase ) .returns(T.attached_class) end - def self.new(card_payment_id:, request_options: {}); end - + def self.new( + # The identifier of the Card Payment to expire. + card_payment_id:, + request_options: {} + ); end sig { override.returns({card_payment_id: String, request_options: Increase::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/increase/models/simulations/card_dispute_action_params.rbi b/rbi/lib/increase/models/simulations/card_dispute_action_params.rbi index 9a5840103..774186ddd 100644 --- a/rbi/lib/increase/models/simulations/card_dispute_action_params.rbi +++ b/rbi/lib/increase/models/simulations/card_dispute_action_params.rbi @@ -26,8 +26,13 @@ module Increase ) .returns(T.attached_class) end - def self.new(status:, explanation: nil, request_options: {}); end - + def self.new( + # The status to move the dispute to. + status:, + # Why the dispute was rejected. Not required for accepting disputes. + explanation: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/simulations/card_fuel_confirmation_create_params.rbi b/rbi/lib/increase/models/simulations/card_fuel_confirmation_create_params.rbi index 9d21be714..9c942962d 100644 --- a/rbi/lib/increase/models/simulations/card_fuel_confirmation_create_params.rbi +++ b/rbi/lib/increase/models/simulations/card_fuel_confirmation_create_params.rbi @@ -24,8 +24,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, card_payment_id:, request_options: {}); end - + def self.new( + # The amount of the fuel_confirmation in minor units in the card authorization's + # currency. + amount:, + # The identifier of the Card Payment to create a fuel_confirmation on. + card_payment_id:, + request_options: {} + ); end sig do override.returns( { diff --git a/rbi/lib/increase/models/simulations/card_increment_create_params.rbi b/rbi/lib/increase/models/simulations/card_increment_create_params.rbi index 61e268488..03413a216 100644 --- a/rbi/lib/increase/models/simulations/card_increment_create_params.rbi +++ b/rbi/lib/increase/models/simulations/card_increment_create_params.rbi @@ -34,8 +34,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, card_payment_id:, event_subscription_id: nil, request_options: {}); end - + def self.new( + # The amount of the increment in minor units in the card authorization's currency. + amount:, + # The identifier of the Card Payment to create a increment on. + card_payment_id:, + # The identifier of the Event Subscription to use. If provided, will override the + # default real time event subscription. Because you can only create one real time + # decision event subscription, you can use this field to route events to any + # specified event subscription for testing purposes. + event_subscription_id: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/simulations/card_refund_create_params.rbi b/rbi/lib/increase/models/simulations/card_refund_create_params.rbi index 90cac2fd4..3d9ff4853 100644 --- a/rbi/lib/increase/models/simulations/card_refund_create_params.rbi +++ b/rbi/lib/increase/models/simulations/card_refund_create_params.rbi @@ -19,8 +19,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(transaction_id:, request_options: {}); end - + def self.new( + # The identifier for the Transaction to refund. The Transaction's source must have + # a category of card_settlement. + transaction_id:, + request_options: {} + ); end sig { override.returns({transaction_id: String, request_options: Increase::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/increase/models/simulations/card_reversal_create_params.rbi b/rbi/lib/increase/models/simulations/card_reversal_create_params.rbi index 87fb30bee..ac62cb391 100644 --- a/rbi/lib/increase/models/simulations/card_reversal_create_params.rbi +++ b/rbi/lib/increase/models/simulations/card_reversal_create_params.rbi @@ -27,8 +27,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(card_payment_id:, amount: nil, request_options: {}); end - + def self.new( + # The identifier of the Card Payment to create a reversal on. + card_payment_id:, + # The amount of the reversal in minor units in the card authorization's currency. + # This defaults to the authorization amount. + amount: nil, + request_options: {} + ); end sig do override.returns( { diff --git a/rbi/lib/increase/models/simulations/card_settlement_create_params.rbi b/rbi/lib/increase/models/simulations/card_settlement_create_params.rbi index ec9a6a813..9724e94a7 100644 --- a/rbi/lib/increase/models/simulations/card_settlement_create_params.rbi +++ b/rbi/lib/increase/models/simulations/card_settlement_create_params.rbi @@ -33,8 +33,17 @@ module Increase ) .returns(T.attached_class) end - def self.new(card_id:, pending_transaction_id:, amount: nil, request_options: {}); end - + def self.new( + # The identifier of the Card to create a settlement on. + card_id:, + # The identifier of the Pending Transaction for the Card Authorization you wish to + # settle. + pending_transaction_id:, + # The amount to be settled. This defaults to the amount of the Pending Transaction + # being settled. + amount: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/simulations/digital_wallet_token_request_create_params.rbi b/rbi/lib/increase/models/simulations/digital_wallet_token_request_create_params.rbi index 4a587a7e0..f478dee9c 100644 --- a/rbi/lib/increase/models/simulations/digital_wallet_token_request_create_params.rbi +++ b/rbi/lib/increase/models/simulations/digital_wallet_token_request_create_params.rbi @@ -21,8 +21,11 @@ module Increase ) .returns(T.attached_class) end - def self.new(card_id:, request_options: {}); end - + def self.new( + # The identifier of the Card to be authorized. + card_id:, + request_options: {} + ); end sig { override.returns({card_id: String, request_options: Increase::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/increase/models/simulations/digital_wallet_token_request_create_response.rbi b/rbi/lib/increase/models/simulations/digital_wallet_token_request_create_response.rbi index c0ae0e91c..30c621856 100644 --- a/rbi/lib/increase/models/simulations/digital_wallet_token_request_create_response.rbi +++ b/rbi/lib/increase/models/simulations/digital_wallet_token_request_create_response.rbi @@ -34,8 +34,17 @@ module Increase ) .returns(T.attached_class) end - def self.new(decline_reason:, digital_wallet_token_id:, type:); end - + def self.new( + # If the simulated tokenization attempt was declined, this field contains details + # as to why. + decline_reason:, + # If the simulated tokenization attempt was accepted, this field contains the id + # of the Digital Wallet Token that was created. + digital_wallet_token_id:, + # A constant representing the object's type. For this resource it will always be + # `inbound_digital_wallet_token_request_simulation_result`. + type: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/simulations/document_create_params.rbi b/rbi/lib/increase/models/simulations/document_create_params.rbi index 7dae80732..1baaad886 100644 --- a/rbi/lib/increase/models/simulations/document_create_params.rbi +++ b/rbi/lib/increase/models/simulations/document_create_params.rbi @@ -21,8 +21,11 @@ module Increase ) .returns(T.attached_class) end - def self.new(account_id:, request_options: {}); end - + def self.new( + # The identifier of the Account the tax document is for. + account_id:, + request_options: {} + ); end sig { override.returns({account_id: String, request_options: Increase::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/increase/models/simulations/inbound_ach_transfer_create_params.rbi b/rbi/lib/increase/models/simulations/inbound_ach_transfer_create_params.rbi index 54390fd3b..0de09d14a 100644 --- a/rbi/lib/increase/models/simulations/inbound_ach_transfer_create_params.rbi +++ b/rbi/lib/increase/models/simulations/inbound_ach_transfer_create_params.rbi @@ -108,16 +108,30 @@ module Increase .returns(T.attached_class) end def self.new( + # The identifier of the Account Number the inbound ACH Transfer is for. account_number_id:, + # The transfer amount in cents. A positive amount originates a credit transfer + # pushing funds to the receiving account. A negative amount originates a debit + # transfer pulling funds from the receiving account. amount:, + # The description of the date of the transfer. company_descriptive_date: nil, + # Data associated with the transfer set by the sender. company_discretionary_data: nil, + # The description of the transfer set by the sender. company_entry_description: nil, + # The sender's company ID. company_id: nil, + # The name of the sender. company_name: nil, + # The ID of the receiver of the transfer. receiver_id_number: nil, + # The name of the receiver of the transfer. receiver_name: nil, + # The time at which the transfer should be resolved. If not provided will resolve + # immediately. resolve_at: nil, + # The standard entry class code for the transfer. standard_entry_class_code: nil, request_options: {} ); end diff --git a/rbi/lib/increase/models/simulations/inbound_check_deposit_create_params.rbi b/rbi/lib/increase/models/simulations/inbound_check_deposit_create_params.rbi index 90ef937fa..9f0736ddb 100644 --- a/rbi/lib/increase/models/simulations/inbound_check_deposit_create_params.rbi +++ b/rbi/lib/increase/models/simulations/inbound_check_deposit_create_params.rbi @@ -28,8 +28,15 @@ module Increase ) .returns(T.attached_class) end - def self.new(account_number_id:, amount:, check_number:, request_options: {}); end - + def self.new( + # The identifier of the Account Number the Inbound Check Deposit will be against. + account_number_id:, + # The check amount in cents. + amount:, + # The check number on the check to be deposited. + check_number:, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/simulations/inbound_funds_hold_release_response.rbi b/rbi/lib/increase/models/simulations/inbound_funds_hold_release_response.rbi index d778eb306..aacc38b29 100644 --- a/rbi/lib/increase/models/simulations/inbound_funds_hold_release_response.rbi +++ b/rbi/lib/increase/models/simulations/inbound_funds_hold_release_response.rbi @@ -67,15 +67,30 @@ module Increase .returns(T.attached_class) end def self.new( + # The Inbound Funds Hold identifier. id:, + # The held amount in the minor unit of the account's currency. For dollars, for + # example, this is cents. amount:, + # When the hold will be released automatically. Certain conditions may cause it to + # be released before this time. automatically_releases_at:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold + # was created. created_at:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's + # currency. currency:, + # The ID of the Transaction for which funds were held. held_transaction_id:, + # The ID of the Pending Transaction representing the held funds. pending_transaction_id:, + # When the hold was released (if it has been released). released_at:, + # The status of the hold. status:, + # A constant representing the object's type. For this resource it will always be + # `inbound_funds_hold`. type: ); end sig do diff --git a/rbi/lib/increase/models/simulations/inbound_mail_item_create_params.rbi b/rbi/lib/increase/models/simulations/inbound_mail_item_create_params.rbi index 66279dbcf..5c7538a79 100644 --- a/rbi/lib/increase/models/simulations/inbound_mail_item_create_params.rbi +++ b/rbi/lib/increase/models/simulations/inbound_mail_item_create_params.rbi @@ -32,8 +32,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, lockbox_id:, contents_file_id: nil, request_options: {}); end - + def self.new( + # The amount of the check to be simulated, in cents. + amount:, + # The identifier of the Lockbox to simulate inbound mail to. + lockbox_id:, + # The file containing the PDF contents. If not present, a default check image file + # will be used. + contents_file_id: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rbi b/rbi/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rbi index 06b7bd2e6..fff7818eb 100644 --- a/rbi/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rbi +++ b/rbi/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rbi @@ -65,12 +65,20 @@ module Increase .returns(T.attached_class) end def self.new( + # The identifier of the Account Number the inbound Real-Time Payments Transfer is + # for. account_number_id:, + # The transfer amount in USD cents. Must be positive. amount:, + # The account number of the account that sent the transfer. debtor_account_number: nil, + # The name provided by the sender of the transfer. debtor_name: nil, + # The routing number of the account that sent the transfer. debtor_routing_number: nil, + # Additional information included with the transfer. remittance_information: nil, + # The identifier of a pending Request for Payment that this transfer will fulfill. request_for_payment_id: nil, request_options: {} ); end diff --git a/rbi/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rbi b/rbi/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rbi index f3a1f1ec3..e689c9ce6 100644 --- a/rbi/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rbi +++ b/rbi/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rbi @@ -156,25 +156,51 @@ module Increase .returns(T.attached_class) end def self.new( + # The amount being requested in cents. amount:, + # The drawdown request's beneficiary's account number. beneficiary_account_number:, + # The drawdown request's beneficiary's routing number. beneficiary_routing_number:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being + # requested. Will always be "USD". currency:, + # A message from the drawdown request's originator. message_to_recipient:, + # The drawdown request's originator's account number. originator_account_number:, + # The drawdown request's originator's routing number. originator_routing_number:, + # The Account Number to which the recipient of this request is being requested to + # send funds from. recipient_account_number_id:, + # Line 1 of the drawdown request's beneficiary's address. beneficiary_address_line1: nil, + # Line 2 of the drawdown request's beneficiary's address. beneficiary_address_line2: nil, + # Line 3 of the drawdown request's beneficiary's address. beneficiary_address_line3: nil, + # The drawdown request's beneficiary's name. beneficiary_name: nil, + # Line 1 of the drawdown request's originator's address. originator_address_line1: nil, + # Line 2 of the drawdown request's originator's address. originator_address_line2: nil, + # Line 3 of the drawdown request's originator's address. originator_address_line3: nil, + # The drawdown request's originator's name. originator_name: nil, + # Line 1 of the information conveyed from the originator of the message to the + # beneficiary. originator_to_beneficiary_information_line1: nil, + # Line 2 of the information conveyed from the originator of the message to the + # beneficiary. originator_to_beneficiary_information_line2: nil, + # Line 3 of the information conveyed from the originator of the message to the + # beneficiary. originator_to_beneficiary_information_line3: nil, + # Line 4 of the information conveyed from the originator of the message to the + # beneficiary. originator_to_beneficiary_information_line4: nil, request_options: {} ); end diff --git a/rbi/lib/increase/models/simulations/inbound_wire_transfer_create_params.rbi b/rbi/lib/increase/models/simulations/inbound_wire_transfer_create_params.rbi index eef7a5c1a..e471b85f5 100644 --- a/rbi/lib/increase/models/simulations/inbound_wire_transfer_create_params.rbi +++ b/rbi/lib/increase/models/simulations/inbound_wire_transfer_create_params.rbi @@ -159,22 +159,54 @@ module Increase .returns(T.attached_class) end def self.new( + # The identifier of the Account Number the inbound Wire Transfer is for. account_number_id:, + # The transfer amount in cents. Must be positive. amount:, + # The sending bank will set beneficiary_address_line1 in production. You can + # simulate any value here. beneficiary_address_line1: nil, + # The sending bank will set beneficiary_address_line2 in production. You can + # simulate any value here. beneficiary_address_line2: nil, + # The sending bank will set beneficiary_address_line3 in production. You can + # simulate any value here. beneficiary_address_line3: nil, + # The sending bank will set beneficiary_name in production. You can simulate any + # value here. beneficiary_name: nil, + # The sending bank will set beneficiary_reference in production. You can simulate + # any value here. beneficiary_reference: nil, + # The sending bank will set originator_address_line1 in production. You can + # simulate any value here. originator_address_line1: nil, + # The sending bank will set originator_address_line2 in production. You can + # simulate any value here. originator_address_line2: nil, + # The sending bank will set originator_address_line3 in production. You can + # simulate any value here. originator_address_line3: nil, + # The sending bank will set originator_name in production. You can simulate any + # value here. originator_name: nil, + # The sending bank will set originator_routing_number in production. You can + # simulate any value here. originator_routing_number: nil, + # The sending bank will set originator_to_beneficiary_information_line1 in + # production. You can simulate any value here. originator_to_beneficiary_information_line1: nil, + # The sending bank will set originator_to_beneficiary_information_line2 in + # production. You can simulate any value here. originator_to_beneficiary_information_line2: nil, + # The sending bank will set originator_to_beneficiary_information_line3 in + # production. You can simulate any value here. originator_to_beneficiary_information_line3: nil, + # The sending bank will set originator_to_beneficiary_information_line4 in + # production. You can simulate any value here. originator_to_beneficiary_information_line4: nil, + # The sending bank will set sender_reference in production. You can simulate any + # value here. sender_reference: nil, request_options: {} ); end diff --git a/rbi/lib/increase/models/simulations/interest_payment_create_params.rbi b/rbi/lib/increase/models/simulations/interest_payment_create_params.rbi index f1239baf1..1cfd47253 100644 --- a/rbi/lib/increase/models/simulations/interest_payment_create_params.rbi +++ b/rbi/lib/increase/models/simulations/interest_payment_create_params.rbi @@ -48,15 +48,18 @@ module Increase .returns(T.attached_class) end def self.new( + # The identifier of the Account the Interest Payment should be paid to is for. account_id:, + # The interest amount in cents. Must be positive. amount:, + # The identifier of the Account the Interest accrued on. Defaults to `account_id`. accrued_on_account_id: nil, + # The end of the interest period. If not provided, defaults to the current time. period_end: nil, + # The start of the interest period. If not provided, defaults to the current time. period_start: nil, request_options: {} - ) - end - + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/simulations/physical_card_advance_shipment_params.rbi b/rbi/lib/increase/models/simulations/physical_card_advance_shipment_params.rbi index ea3638b9d..0626076dc 100644 --- a/rbi/lib/increase/models/simulations/physical_card_advance_shipment_params.rbi +++ b/rbi/lib/increase/models/simulations/physical_card_advance_shipment_params.rbi @@ -18,8 +18,11 @@ module Increase ) .returns(T.attached_class) end - def self.new(shipment_status:, request_options: {}); end - + def self.new( + # The shipment status to move the Physical Card to. + shipment_status:, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/simulations/program_create_params.rbi b/rbi/lib/increase/models/simulations/program_create_params.rbi index 1ac8d0daf..f63090db0 100644 --- a/rbi/lib/increase/models/simulations/program_create_params.rbi +++ b/rbi/lib/increase/models/simulations/program_create_params.rbi @@ -15,8 +15,11 @@ module Increase params(name: String, request_options: T.any(Increase::RequestOptions, Increase::Internal::AnyHash)) .returns(T.attached_class) end - def self.new(name:, request_options: {}); end - + def self.new( + # The name of the program being added. + name:, + request_options: {} + ); end sig { override.returns({name: String, request_options: Increase::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rbi b/rbi/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rbi index 4c8f0da33..7ff742801 100644 --- a/rbi/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rbi +++ b/rbi/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rbi @@ -32,8 +32,11 @@ module Increase ) .returns(T.attached_class) end - def self.new(rejection: nil, request_options: {}); end - + def self.new( + # If set, the simulation will reject the transfer. + rejection: nil, + request_options: {} + ); end sig do override .returns( @@ -61,8 +64,10 @@ module Increase ) .returns(T.attached_class) end - def self.new(reject_reason_code:); end - + def self.new( + # The reason code that the simulated rejection will have. + reject_reason_code: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/supplemental_document_create_params.rbi b/rbi/lib/increase/models/supplemental_document_create_params.rbi index 825b8ceff..0aa58fe58 100644 --- a/rbi/lib/increase/models/supplemental_document_create_params.rbi +++ b/rbi/lib/increase/models/supplemental_document_create_params.rbi @@ -22,8 +22,13 @@ module Increase ) .returns(T.attached_class) end - def self.new(entity_id:, file_id:, request_options: {}); end - + def self.new( + # The identifier of the Entity to associate with the supplemental document. + entity_id:, + # The identifier of the File containing the document. + file_id:, + request_options: {} + ); end sig do override.returns({entity_id: String, file_id: String, request_options: Increase::RequestOptions}) end diff --git a/rbi/lib/increase/models/supplemental_document_list_params.rbi b/rbi/lib/increase/models/supplemental_document_list_params.rbi index 0fdb775de..a93e95d9b 100644 --- a/rbi/lib/increase/models/supplemental_document_list_params.rbi +++ b/rbi/lib/increase/models/supplemental_document_list_params.rbi @@ -45,8 +45,21 @@ module Increase ) .returns(T.attached_class) end - def self.new(entity_id:, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}); end - + def self.new( + # The identifier of the Entity to list supplemental documents for. + entity_id:, + # Return the page of entries after this one. + cursor: nil, + # 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). + idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. + limit: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/transaction.rbi b/rbi/lib/increase/models/transaction.rbi index 04ad2ca81..373896e4a 100644 --- a/rbi/lib/increase/models/transaction.rbi +++ b/rbi/lib/increase/models/transaction.rbi @@ -75,19 +75,38 @@ module Increase .returns(T.attached_class) end def self.new( + # The Transaction identifier. id:, + # The identifier for the Account the Transaction belongs to. account_id:, + # The Transaction amount in the minor unit of its currency. For dollars, for + # example, this is cents. amount:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the + # Transaction occurred. created_at:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # Transaction's currency. This will match the currency on the Transaction's + # Account. currency:, + # An informational message describing this transaction. Use the fields in `source` + # to get more detailed information. This field appears as the line-item on the + # statement. description:, + # The identifier for the route this Transaction came through. Routes are things + # like cards and ACH details. route_id:, + # The type of the route this Transaction came through. route_type:, + # This is an object giving more details on the network-level event that caused the + # Transaction. Note that for backwards compatibility reasons, additional + # undocumented keys may appear in this object. These should be treated as + # deprecated and will be removed in the future. source:, + # A constant representing the object's type. For this resource it will always be + # `transaction`. type: - ) - end - + ); end sig do override .returns( @@ -708,35 +727,156 @@ module Increase .returns(T.attached_class) end def self.new( + # An Account Transfer Intention object. This field will be present in the JSON + # response if and only if `category` is equal to `account_transfer_intention`. Two + # Account Transfer Intentions are created from each Account Transfer. One + # decrements the source account, and the other increments the destination account. account_transfer_intention:, + # An ACH Transfer Intention object. This field will be present in the JSON + # response if and only if `category` is equal to `ach_transfer_intention`. An ACH + # Transfer Intention is created from an ACH Transfer. It reflects the intention to + # move money into or out of an Increase account via the ACH network. ach_transfer_intention:, + # An ACH Transfer Rejection object. This field will be present in the JSON + # response if and only if `category` is equal to `ach_transfer_rejection`. An ACH + # Transfer Rejection is created when an ACH Transfer is rejected by Increase. It + # offsets the ACH Transfer Intention. These rejections are rare. ach_transfer_rejection:, + # An ACH Transfer Return object. This field will be present in the JSON response + # if and only if `category` is equal to `ach_transfer_return`. An ACH Transfer + # Return is created when an ACH Transfer is returned by the receiving bank. It + # offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within + # the first two business days after the transfer is initiated, but can occur much + # later. ach_transfer_return:, + # A Card Dispute Acceptance object. This field will be present in the JSON + # response if and only if `category` is equal to `card_dispute_acceptance`. + # Contains the details of a successful Card Dispute. card_dispute_acceptance:, + # A Card Dispute Loss object. This field will be present in the JSON response if + # and only if `category` is equal to `card_dispute_loss`. Contains the details of + # a lost Card Dispute. card_dispute_loss:, + # A Card Refund object. This field will be present in the JSON response if and + # only if `category` is equal to `card_refund`. Card Refunds move money back to + # the cardholder. While they are usually connected to a Card Settlement an + # acquirer can also refund money directly to a card without relation to a + # transaction. card_refund:, + # A Card Revenue Payment object. This field will be present in the JSON response + # if and only if `category` is equal to `card_revenue_payment`. Card Revenue + # Payments reflect earnings from fees on card transactions. card_revenue_payment:, + # A Card Settlement object. This field will be present in the JSON response if and + # only if `category` is equal to `card_settlement`. Card Settlements are card + # transactions that have cleared and settled. While a settlement is usually + # preceded by an authorization, an acquirer can also directly clear a transaction + # without first authorizing it. card_settlement:, + # A Cashback Payment object. This field will be present in the JSON response if + # and only if `category` is equal to `cashback_payment`. A Cashback Payment + # represents the cashback paid to a cardholder for a given period. Cashback is + # usually paid monthly for the prior month's transactions. cashback_payment:, + # The type of the resource. We may add additional possible values for this enum + # over time; your application should be able to handle such additions gracefully. category:, + # A Check Deposit Acceptance object. This field will be present in the JSON + # response if and only if `category` is equal to `check_deposit_acceptance`. A + # Check Deposit Acceptance is created when a Check Deposit is processed and its + # details confirmed. Check Deposits may be returned by the receiving bank, which + # will appear as a Check Deposit Return. check_deposit_acceptance:, + # A Check Deposit Return object. This field will be present in the JSON response + # if and only if `category` is equal to `check_deposit_return`. A Check Deposit + # Return is created when a Check Deposit is returned by the bank holding the + # account it was drawn against. Check Deposits may be returned for a variety of + # reasons, including insufficient funds or a mismatched account number. Usually, + # checks are returned within the first 7 days after the deposit is made. check_deposit_return:, + # A Check Transfer Deposit object. This field will be present in the JSON response + # if and only if `category` is equal to `check_transfer_deposit`. An Inbound Check + # is a check drawn on an Increase account that has been deposited by an external + # bank account. These types of checks are not pre-registered. check_transfer_deposit:, + # A Fee Payment object. This field will be present in the JSON response if and + # only if `category` is equal to `fee_payment`. A Fee Payment represents a payment + # made to Increase. fee_payment:, + # An Inbound ACH Transfer Intention object. This field will be present in the JSON + # response if and only if `category` is equal to `inbound_ach_transfer`. An + # Inbound ACH Transfer Intention is created when an ACH transfer is initiated at + # another bank and received by Increase. inbound_ach_transfer:, + # An Inbound ACH Transfer Return Intention object. This field will be present in + # the JSON response if and only if `category` is equal to + # `inbound_ach_transfer_return_intention`. An Inbound ACH Transfer Return + # Intention is created when an ACH transfer is initiated at another bank and + # returned by Increase. inbound_ach_transfer_return_intention:, + # An Inbound Check Adjustment object. This field will be present in the JSON + # response if and only if `category` is equal to `inbound_check_adjustment`. An + # Inbound Check Adjustment is created when Increase receives an adjustment for a + # check or return deposited through Check21. inbound_check_adjustment:, + # An Inbound Check Deposit Return Intention object. This field will be present in + # the JSON response if and only if `category` is equal to + # `inbound_check_deposit_return_intention`. An Inbound Check Deposit Return + # Intention is created when Increase receives an Inbound Check and the User + # requests that it be returned. inbound_check_deposit_return_intention:, + # An Inbound Real-Time Payments Transfer Confirmation object. This field will be + # present in the JSON response if and only if `category` is equal to + # `inbound_real_time_payments_transfer_confirmation`. An Inbound Real-Time + # Payments Transfer Confirmation is created when a Real-Time Payments transfer is + # initiated at another bank and received by Increase. inbound_real_time_payments_transfer_confirmation:, + # An Inbound Real-Time Payments Transfer Decline object. This field will be + # present in the JSON response if and only if `category` is equal to + # `inbound_real_time_payments_transfer_decline`. inbound_real_time_payments_transfer_decline:, + # An Inbound Wire Reversal object. This field will be present in the JSON response + # if and only if `category` is equal to `inbound_wire_reversal`. An Inbound Wire + # Reversal represents a reversal of a wire transfer that was initiated via + # Increase. The other bank is sending the money back. This most often happens when + # the original destination account details were incorrect. inbound_wire_reversal:, + # An Inbound Wire Transfer Intention object. This field will be present in the + # JSON response if and only if `category` is equal to `inbound_wire_transfer`. An + # Inbound Wire Transfer Intention is created when a wire transfer is initiated at + # another bank and received by Increase. inbound_wire_transfer:, + # An Inbound Wire Transfer Reversal Intention object. This field will be present + # in the JSON response if and only if `category` is equal to + # `inbound_wire_transfer_reversal`. An Inbound Wire Transfer Reversal Intention is + # created when Increase has received a wire and the User requests that it be + # reversed. inbound_wire_transfer_reversal:, + # An Interest Payment object. This field will be present in the JSON response if + # and only if `category` is equal to `interest_payment`. An Interest Payment + # represents a payment of interest on an account. Interest is usually paid + # monthly. interest_payment:, + # An Internal Source object. This field will be present in the JSON response if + # and only if `category` is equal to `internal_source`. A transaction between the + # user and Increase. See the `reason` attribute for more information. internal_source:, + # If the category of this Transaction source is equal to `other`, this field will + # contain an empty object, otherwise it will contain null. other:, + # A Real-Time Payments Transfer Acknowledgement object. This field will be present + # in the JSON response if and only if `category` is equal to + # `real_time_payments_transfer_acknowledgement`. A Real-Time Payments Transfer + # Acknowledgement is created when a Real-Time Payments Transfer sent from Increase + # is acknowledged by the receiving bank. real_time_payments_transfer_acknowledgement:, + # A Sample Funds object. This field will be present in the JSON response if and + # only if `category` is equal to `sample_funds`. Sample funds for testing + # purposes. sample_funds:, + # A Wire Transfer Intention object. This field will be present in the JSON + # response if and only if `category` is equal to `wire_transfer_intention`. A Wire + # Transfer initiated via Increase and sent to a different bank. wire_transfer_intention: ); end sig do @@ -821,15 +961,21 @@ module Increase .returns(T.attached_class) end def self.new( + # The pending amount in the minor unit of the transaction's currency. For dollars, + # for example, this is cents. amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination + # account currency. currency:, + # The description you chose to give the transfer. description:, + # The identifier of the Account to where the Account Transfer was sent. destination_account_id:, + # The identifier of the Account from where the Account Transfer was sent. source_account_id:, + # The identifier of the Account Transfer that led to this Pending Transaction. transfer_id: - ) - end - + ); end sig do override .returns( @@ -923,8 +1069,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(account_number:, amount:, routing_number:, statement_descriptor:, transfer_id:); end - + def self.new( + # The account number for the destination account. + account_number:, + # The amount in the minor unit of the transaction's currency. For dollars, for + # example, this is cents. + amount:, + # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the + # destination account. + routing_number:, + # A description set when the ACH Transfer was created. + statement_descriptor:, + # The identifier of the ACH Transfer that led to this Transaction. + transfer_id: + ); end sig do override .returns( @@ -950,8 +1108,10 @@ module Increase # Transfer Rejection is created when an ACH Transfer is rejected by Increase. It # offsets the ACH Transfer Intention. These rejections are rare. sig { params(transfer_id: String).returns(T.attached_class) } - def self.new(transfer_id:); end - + def self.new( + # The identifier of the ACH Transfer that led to this Transaction. + transfer_id: + ); end sig { override.returns({transfer_id: String}) } def to_hash; end end @@ -1004,15 +1164,24 @@ module Increase .returns(T.attached_class) end def self.new( + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the transfer was created. created_at:, + # The three character ACH return code, in the range R01 to R85. raw_return_reason_code:, + # Why the ACH Transfer was returned. This reason code is sent by the receiving + # bank back to Increase. return_reason_code:, + # A 15 digit number that was generated by the bank that initiated the return. The + # trace number of the return is different than that of the original transfer. ACH + # trace numbers are not unique, but along with the amount and date this number can + # be used to identify the ACH return at the bank that initiated it. trace_number:, + # The identifier of the Transaction associated with this return. transaction_id:, + # The identifier of the ACH Transfer associated with this return. transfer_id: - ) - end - + ); end sig do override .returns( @@ -1562,8 +1731,16 @@ module Increase transaction_id: String ).returns(T.attached_class) end - def self.new(accepted_at:, card_dispute_id:, transaction_id:); end - + def self.new( + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the Card Dispute was accepted. + accepted_at:, + # The identifier of the Card Dispute that was accepted. + card_dispute_id:, + # The identifier of the Transaction that was created to return the disputed funds + # to your account. + transaction_id: + ); end sig { override.returns({accepted_at: Time, card_dispute_id: String, transaction_id: String}) } def to_hash; end end @@ -1594,8 +1771,18 @@ module Increase params(card_dispute_id: String, explanation: String, lost_at: Time, transaction_id: String) .returns(T.attached_class) end - def self.new(card_dispute_id:, explanation:, lost_at:, transaction_id:); end - + def self.new( + # The identifier of the Card Dispute that was lost. + card_dispute_id:, + # Why the Card Dispute was lost. + explanation:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the Card Dispute was lost. + lost_at:, + # The identifier of the Transaction that was created to debit the disputed funds + # from your account. + transaction_id: + ); end sig do override.returns( { @@ -1763,24 +1950,50 @@ module Increase .returns(T.attached_class) end def self.new( + # The Card Refund identifier. id:, + # The amount in the minor unit of the transaction's settlement currency. For + # dollars, for example, this is cents. amount:, + # The ID of the Card Payment this transaction belongs to. card_payment_id:, + # Cashback debited for this transaction, if eligible. Cashback is paid out in + # aggregate, monthly. cashback:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's settlement currency. currency:, + # Interchange assessed as a part of this transaciton. interchange:, + # The merchant identifier (commonly abbreviated as MID) of the merchant the card + # is transacting with. merchant_acceptor_id:, + # The 4-digit MCC describing the merchant's business. merchant_category_code:, + # The city the merchant resides in. merchant_city:, + # The country the merchant resides in. merchant_country:, + # The name of the merchant. merchant_name:, + # The merchant's postal code. For US merchants this is always a 5-digit ZIP code. merchant_postal_code:, + # The state the merchant resides in. merchant_state:, + # Network-specific identifiers for this refund. network_identifiers:, + # The amount in the minor unit of the transaction's presentment currency. presentment_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's presentment currency. presentment_currency:, + # Additional details about the card purchase, such as tax and industry-specific + # fields. purchase_details:, + # The identifier of the Transaction associated with this Transaction. transaction_id:, + # A constant representing the object's type. For this resource it will always be + # `card_refund`. type: ); end sig do @@ -1831,8 +2044,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, currency:); end - + def self.new( + # The cashback amount given as a string containing a decimal number. The amount is + # a positive number if it will be credited to you (e.g., settlements) and a + # negative number if it will be debited (e.g., refunds). + amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. + currency: + ); end sig do override .returns( @@ -1935,8 +2154,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, code:, currency:); end - + def self.new( + # The interchange amount given as a string containing a decimal number in major + # units (so e.g., "3.14" for $3.14). The amount is a positive number if it is + # credited to Increase (e.g., settlements) and a negative number if it is debited + # (e.g., refunds). + amount:, + # The card network specific interchange code. + code:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange + # reimbursement. + currency: + ); end sig do override .returns( @@ -2008,8 +2237,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(acquirer_business_id:, acquirer_reference_number:, transaction_id:); end - + def self.new( + # A network assigned business ID that identifies the acquirer that processed this + # transaction. + acquirer_business_id:, + # A globally unique identifier for this settlement. + acquirer_reference_number:, + # A globally unique transaction identifier provided by the card network, used + # across multiple life-cycle requests. + transaction_id: + ); end sig do override .returns( @@ -2146,15 +2383,27 @@ module Increase .returns(T.attached_class) end def self.new( + # Fields specific to car rentals. car_rental:, + # An identifier from the merchant for the customer or consumer. customer_reference_identifier:, + # The state or provincial tax amount in minor units. local_tax_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax + # assessed. local_tax_currency:, + # Fields specific to lodging. lodging:, + # The national tax amount in minor units. national_tax_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax + # assessed. national_tax_currency:, + # An identifier from the merchant for the purchase to the issuer and cardholder. purchase_identifier:, + # The format of the purchase identifier. purchase_identifier_format:, + # Fields specific to travel. travel: ); end sig do @@ -2290,21 +2539,45 @@ module Increase .returns(T.attached_class) end def self.new( + # Code indicating the vehicle's class. car_class_code:, + # Date the customer picked up the car or, in the case of a no-show or pre-pay + # transaction, the scheduled pick up date. checkout_date:, + # Daily rate being charged for the vehicle. daily_rental_rate_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental + # rate. daily_rental_rate_currency:, + # Number of days the vehicle was rented. days_rented:, + # Additional charges (gas, late fee, etc.) being billed. extra_charges:, + # Fuel charges for the vehicle. fuel_charges_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges + # assessed. fuel_charges_currency:, + # Any insurance being charged for the vehicle. insurance_charges_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance + # charges assessed. insurance_charges_currency:, + # An indicator that the cardholder is being billed for a reserved vehicle that was + # not actually rented (that is, a "no-show" charge). no_show_indicator:, + # Charges for returning the vehicle at a different location than where it was + # picked up. one_way_drop_off_charges_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way + # drop-off charges assessed. one_way_drop_off_charges_currency:, + # Name of the person renting the vehicle. renter_name:, + # Weekly rate being charged for the vehicle. weekly_rental_rate_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly + # rental rate. weekly_rental_rate_currency: ); end sig do @@ -2543,21 +2816,44 @@ module Increase .returns(T.attached_class) end def self.new( + # Date the customer checked in. check_in_date:, + # Daily rate being charged for the room. daily_room_rate_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room + # rate. daily_room_rate_currency:, + # Additional charges (phone, late check-out, etc.) being billed. extra_charges:, + # Folio cash advances for the room. folio_cash_advances_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash + # advances. folio_cash_advances_currency:, + # Food and beverage charges for the room. food_beverage_charges_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and + # beverage charges. food_beverage_charges_currency:, + # Indicator that the cardholder is being billed for a reserved room that was not + # actually used. no_show_indicator:, + # Prepaid expenses being charged for the room. prepaid_expenses_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid + # expenses. prepaid_expenses_currency:, + # Number of nights the room was rented. room_nights:, + # Total room tax being charged. total_room_tax_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room + # tax. total_room_tax_currency:, + # Total tax being charged for the room. total_tax_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax + # assessed. total_tax_currency: ); end sig do @@ -2865,17 +3161,29 @@ module Increase .returns(T.attached_class) end def self.new( + # Ancillary purchases in addition to the airfare. ancillary:, + # Indicates the computerized reservation system used to book the ticket. computerized_reservation_system:, + # Indicates the reason for a credit to the cardholder. credit_reason_indicator:, + # Date of departure. departure_date:, + # Code for the originating city or airport. origination_city_airport_code:, + # Name of the passenger. passenger_name:, + # Indicates whether this ticket is non-refundable. restricted_ticket_indicator:, + # Indicates why a ticket was changed. ticket_change_indicator:, + # Ticket number. ticket_number:, + # Code for the travel agency if the ticket was issued by a travel agency. travel_agency_code:, + # Name of the travel agency if the ticket was issued by a travel agency. travel_agency_name:, + # Fields specific to each leg of the journey. trip_legs: ); end sig do @@ -2957,10 +3265,17 @@ module Increase .returns(T.attached_class) end def self.new( + # If this purchase has a connection or relationship to another purchase, such as a + # baggage fee for a passenger transport ticket, this field should contain the + # ticket document number for the other purchase. connected_ticket_document_number:, + # Indicates the reason for a credit to the cardholder. credit_reason_indicator:, + # Name of the passenger or description of the ancillary purchase. passenger_name_or_description:, + # Additional travel charges, such as baggage fees. services:, + # Ticket document number. ticket_document_number: ); end sig do @@ -3052,8 +3367,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(category:, sub_category:); end - + def self.new( + # Category of the ancillary service. + category:, + # Sub-category of the ancillary service, free-form. + sub_category: + ); end sig do override .returns( @@ -3443,11 +3762,17 @@ module Increase .returns(T.attached_class) end def self.new( + # Carrier code (e.g., United Airlines, Jet Blue, etc.). carrier_code:, + # Code for the destination city or airport. destination_city_airport_code:, + # Fare basis code. fare_basis_code:, + # Flight number. flight_number:, + # Service class (e.g., first class, business class, etc.). service_class:, + # Indicates whether a stopover is allowed on this ticket. stop_over_code: ); end sig do @@ -3563,8 +3888,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, currency:, period_end:, period_start:, transacted_on_account_id:); end - + def self.new( + # The amount in the minor unit of the transaction's currency. For dollars, for + # example, this is cents. + amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction + # currency. + currency:, + # The end of the period for which this transaction paid interest. + period_end:, + # The start of the period for which this transaction paid interest. + period_start:, + # The account the card belonged to. + transacted_on_account_id: + ); end sig do override .returns( @@ -3789,26 +4126,55 @@ module Increase .returns(T.attached_class) end def self.new( + # The Card Settlement identifier. id:, + # The amount in the minor unit of the transaction's settlement currency. For + # dollars, for example, this is cents. amount:, + # The Card Authorization that was created prior to this Card Settlement, if one + # exists. card_authorization:, + # The ID of the Card Payment this transaction belongs to. card_payment_id:, + # Cashback earned on this transaction, if eligible. Cashback is paid out in + # aggregate, monthly. cashback:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's settlement currency. currency:, + # Interchange assessed as a part of this transaction. interchange:, + # The merchant identifier (commonly abbreviated as MID) of the merchant the card + # is transacting with. merchant_acceptor_id:, + # The 4-digit MCC describing the merchant's business. merchant_category_code:, + # The city the merchant resides in. merchant_city:, + # The country the merchant resides in. merchant_country:, + # The name of the merchant. merchant_name:, + # The merchant's postal code. For US merchants this is always a 5-digit ZIP code. merchant_postal_code:, + # The state the merchant resides in. merchant_state:, + # Network-specific identifiers for this refund. network_identifiers:, + # The identifier of the Pending Transaction associated with this Transaction. pending_transaction_id:, + # The amount in the minor unit of the transaction's presentment currency. presentment_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's presentment currency. presentment_currency:, + # Additional details about the card purchase, such as tax and industry-specific + # fields. purchase_details:, + # The identifier of the Transaction associated with this Transaction. transaction_id:, + # A constant representing the object's type. For this resource it will always be + # `card_settlement`. type: ); end sig do @@ -3861,8 +4227,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, currency:); end - + def self.new( + # The cashback amount given as a string containing a decimal number. The amount is + # a positive number if it will be credited to you (e.g., settlements) and a + # negative number if it will be debited (e.g., refunds). + amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. + currency: + ); end sig do override .returns( @@ -3971,8 +4343,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, code:, currency:); end - + def self.new( + # The interchange amount given as a string containing a decimal number in major + # units (so e.g., "3.14" for $3.14). The amount is a positive number if it is + # credited to Increase (e.g., settlements) and a negative number if it is debited + # (e.g., refunds). + amount:, + # The card network specific interchange code. + code:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange + # reimbursement. + currency: + ); end sig do override .returns( @@ -4052,8 +4434,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(acquirer_business_id:, acquirer_reference_number:, transaction_id:); end - + def self.new( + # A network assigned business ID that identifies the acquirer that processed this + # transaction. + acquirer_business_id:, + # A globally unique identifier for this settlement. + acquirer_reference_number:, + # A globally unique transaction identifier provided by the card network, used + # across multiple life-cycle requests. + transaction_id: + ); end sig do override .returns( @@ -4190,15 +4580,27 @@ module Increase .returns(T.attached_class) end def self.new( + # Fields specific to car rentals. car_rental:, + # An identifier from the merchant for the customer or consumer. customer_reference_identifier:, + # The state or provincial tax amount in minor units. local_tax_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax + # assessed. local_tax_currency:, + # Fields specific to lodging. lodging:, + # The national tax amount in minor units. national_tax_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax + # assessed. national_tax_currency:, + # An identifier from the merchant for the purchase to the issuer and cardholder. purchase_identifier:, + # The format of the purchase identifier. purchase_identifier_format:, + # Fields specific to travel. travel: ); end sig do @@ -4334,21 +4736,45 @@ module Increase .returns(T.attached_class) end def self.new( + # Code indicating the vehicle's class. car_class_code:, + # Date the customer picked up the car or, in the case of a no-show or pre-pay + # transaction, the scheduled pick up date. checkout_date:, + # Daily rate being charged for the vehicle. daily_rental_rate_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental + # rate. daily_rental_rate_currency:, + # Number of days the vehicle was rented. days_rented:, + # Additional charges (gas, late fee, etc.) being billed. extra_charges:, + # Fuel charges for the vehicle. fuel_charges_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges + # assessed. fuel_charges_currency:, + # Any insurance being charged for the vehicle. insurance_charges_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance + # charges assessed. insurance_charges_currency:, + # An indicator that the cardholder is being billed for a reserved vehicle that was + # not actually rented (that is, a "no-show" charge). no_show_indicator:, + # Charges for returning the vehicle at a different location than where it was + # picked up. one_way_drop_off_charges_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way + # drop-off charges assessed. one_way_drop_off_charges_currency:, + # Name of the person renting the vehicle. renter_name:, + # Weekly rate being charged for the vehicle. weekly_rental_rate_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly + # rental rate. weekly_rental_rate_currency: ); end sig do @@ -4591,21 +5017,44 @@ module Increase .returns(T.attached_class) end def self.new( + # Date the customer checked in. check_in_date:, + # Daily rate being charged for the room. daily_room_rate_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room + # rate. daily_room_rate_currency:, + # Additional charges (phone, late check-out, etc.) being billed. extra_charges:, + # Folio cash advances for the room. folio_cash_advances_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash + # advances. folio_cash_advances_currency:, + # Food and beverage charges for the room. food_beverage_charges_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and + # beverage charges. food_beverage_charges_currency:, + # Indicator that the cardholder is being billed for a reserved room that was not + # actually used. no_show_indicator:, + # Prepaid expenses being charged for the room. prepaid_expenses_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid + # expenses. prepaid_expenses_currency:, + # Number of nights the room was rented. room_nights:, + # Total room tax being charged. total_room_tax_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room + # tax. total_room_tax_currency:, + # Total tax being charged for the room. total_tax_amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax + # assessed. total_tax_currency: ); end sig do @@ -4927,17 +5376,29 @@ module Increase .returns(T.attached_class) end def self.new( + # Ancillary purchases in addition to the airfare. ancillary:, + # Indicates the computerized reservation system used to book the ticket. computerized_reservation_system:, + # Indicates the reason for a credit to the cardholder. credit_reason_indicator:, + # Date of departure. departure_date:, + # Code for the originating city or airport. origination_city_airport_code:, + # Name of the passenger. passenger_name:, + # Indicates whether this ticket is non-refundable. restricted_ticket_indicator:, + # Indicates why a ticket was changed. ticket_change_indicator:, + # Ticket number. ticket_number:, + # Code for the travel agency if the ticket was issued by a travel agency. travel_agency_code:, + # Name of the travel agency if the ticket was issued by a travel agency. travel_agency_name:, + # Fields specific to each leg of the journey. trip_legs: ); end sig do @@ -5021,10 +5482,17 @@ module Increase .returns(T.attached_class) end def self.new( + # If this purchase has a connection or relationship to another purchase, such as a + # baggage fee for a passenger transport ticket, this field should contain the + # ticket document number for the other purchase. connected_ticket_document_number:, + # Indicates the reason for a credit to the cardholder. credit_reason_indicator:, + # Name of the passenger or description of the ancillary purchase. passenger_name_or_description:, + # Additional travel charges, such as baggage fees. services:, + # Ticket document number. ticket_document_number: ); end sig do @@ -5116,8 +5584,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(category:, sub_category:); end - + def self.new( + # Category of the ancillary service. + category:, + # Sub-category of the ancillary service, free-form. + sub_category: + ); end sig do override .returns( @@ -5507,11 +5979,17 @@ module Increase .returns(T.attached_class) end def self.new( + # Carrier code (e.g., United Airlines, Jet Blue, etc.). carrier_code:, + # Code for the destination city or airport. destination_city_airport_code:, + # Fare basis code. fare_basis_code:, + # Flight number. flight_number:, + # Service class (e.g., first class, business class, etc.). service_class:, + # Indicates whether a stopover is allowed on this ticket. stop_over_code: ); end sig do @@ -5630,8 +6108,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(accrued_on_card_id:, amount:, currency:, period_end:, period_start:); end - + def self.new( + # The card on which the cashback was accrued. + accrued_on_card_id:, + # The amount in the minor unit of the transaction's currency. For dollars, for + # example, this is cents. + amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction + # currency. + currency:, + # The end of the period for which this transaction paid cashback. + period_end:, + # The start of the period for which this transaction paid cashback. + period_start: + ); end sig do override .returns( @@ -5866,16 +6356,25 @@ module Increase .returns(T.attached_class) end def self.new( + # The account number printed on the check. account_number:, + # The amount to be deposited in the minor unit of the transaction's currency. For + # dollars, for example, this is cents. amount:, + # An additional line of metadata printed on the check. This typically includes the + # check number for business checks. auxiliary_on_us:, + # The ID of the Check Deposit that was accepted. check_deposit_id:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's currency. currency:, + # The routing number printed on the check. routing_number:, + # The check serial number, if present, for consumer checks. For business checks, + # the serial number is usually in the `auxiliary_on_us` field. serial_number: - ) - end - + ); end sig do override .returns( @@ -5973,9 +6472,24 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, check_deposit_id:, currency:, return_reason:, returned_at:, transaction_id:) - end - + def self.new( + # The returned amount in USD cents. + amount:, + # The identifier of the Check Deposit that was returned. + check_deposit_id:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + # transaction's currency. + currency:, + # Why this check was returned by the bank holding the account it was drawn + # against. + return_reason:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the check deposit was returned. + returned_at:, + # The identifier of the transaction that reversed the original check deposit + # transaction. + transaction_id: + ); end sig do override .returns( @@ -6272,13 +6786,27 @@ module Increase .returns(T.attached_class) end def self.new( + # The identifier of the API File object containing an image of the back of the + # deposited check. back_image_file_id:, + # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the + # bank depositing this check. In some rare cases, this is not transmitted via + # Check21 and the value will be null. bank_of_first_deposit_routing_number:, + # When the check was deposited. deposited_at:, + # The identifier of the API File object containing an image of the front of the + # deposited check. front_image_file_id:, + # The identifier of the Inbound Check Deposit object associated with this + # transaction. inbound_check_deposit_id:, + # The identifier of the Transaction object created when the check was deposited. transaction_id:, + # The identifier of the Check Transfer object that was deposited. transfer_id:, + # A constant representing the object's type. For this resource it will always be + # `check_transfer_deposit`. type: ); end sig do @@ -6351,8 +6879,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, currency:, fee_period_start:, program_id:); end - + def self.new( + # The amount in the minor unit of the transaction's currency. For dollars, for + # example, this is cents. + amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction + # currency. + currency:, + # The start of this payment's fee period, usually the first day of a month. + fee_period_start:, + # The Program for which this fee was incurred. + program_id: + ); end sig do override .returns( @@ -6482,16 +7020,33 @@ module Increase .returns(T.attached_class) end def self.new( + # Additional information sent from the originator. addenda:, + # The transfer amount in USD cents. amount:, + # The description of the date of the transfer, usually in the format `YYMMDD`. originator_company_descriptive_date:, + # Data set by the originator. originator_company_discretionary_data:, + # An informational description of the transfer. originator_company_entry_description:, + # An identifier for the originating company. This is generally, but not always, a + # stable identifier across multiple transfers. originator_company_id:, + # A name set by the originator to identify themselves. originator_company_name:, + # The originator's identifier for the transfer recipient. receiver_id_number:, + # The name of the transfer recipient. This value is informational and not verified + # by Increase. receiver_name:, + # A 15 digit number recorded in the Nacha file and available to both the + # originating and receiving bank. Along with the amount, date, and originating + # routing number, this can be used to identify the ACH transfer at either bank. + # ACH trace numbers are not unique, but are + # [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns). trace_number:, + # The Inbound ACH Transfer's identifier. transfer_id: ); end sig do @@ -6549,8 +7104,12 @@ module Increase ) .returns(T.attached_class) end - def self.new(category:, freeform:); end - + def self.new( + # The type of addendum. + category:, + # Unstructured `payment_related_information` passed through by the originator. + freeform: + ); end sig do override .returns( @@ -6603,8 +7162,10 @@ module Increase ) .returns(T.attached_class) end - def self.new(entries:); end - + def self.new( + # Each entry represents an addendum received from the originator. + entries: + ); end sig do override .returns( @@ -6619,8 +7180,10 @@ module Increase attr_accessor :payment_related_information sig { params(payment_related_information: String).returns(T.attached_class) } - def self.new(payment_related_information:); end - + def self.new( + # The payment related information passed in the addendum. + payment_related_information: + ); end sig { override.returns({payment_related_information: String}) } def to_hash; end end @@ -6639,8 +7202,10 @@ module Increase # Intention is created when an ACH transfer is initiated at another bank and # returned by Increase. sig { params(inbound_ach_transfer_id: String).returns(T.attached_class) } - def self.new(inbound_ach_transfer_id:); end - + def self.new( + # The ID of the Inbound ACH Transfer that is being returned. + inbound_ach_transfer_id: + ); end sig { override.returns({inbound_ach_transfer_id: String}) } def to_hash; end end @@ -6670,8 +7235,14 @@ module Increase ) .returns(T.attached_class) end - def self.new(adjusted_transaction_id:, amount:, reason:); end - + def self.new( + # The ID of the transaction that was adjusted. + adjusted_transaction_id:, + # The amount of the check adjustment. + amount:, + # The reason for the adjustment. + reason: + ); end sig do override .returns( @@ -6742,8 +7313,12 @@ module Increase sig do params(inbound_check_deposit_id: String, transfer_id: T.nilable(String)).returns(T.attached_class) end - def self.new(inbound_check_deposit_id:, transfer_id:); end - + def self.new( + # The ID of the Inbound Check Deposit that is being returned. + inbound_check_deposit_id:, + # The identifier of the Check Transfer object that was deposited. + transfer_id: + ); end sig { override.returns({inbound_check_deposit_id: String, transfer_id: T.nilable(String)}) } def to_hash; end end @@ -6811,14 +7386,25 @@ module Increase .returns(T.attached_class) end def self.new( + # The amount in the minor unit of the transfer's currency. For dollars, for + # example, this is cents. amount:, + # The name the sender of the transfer specified as the recipient of the transfer. creditor_name:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's + # currency. This will always be "USD" for a Real-Time Payments transfer. currency:, + # The account number of the account that sent the transfer. debtor_account_number:, + # The name provided by the sender of the transfer. debtor_name:, + # The routing number of the account that sent the transfer. debtor_routing_number:, + # Additional information included with the transfer. remittance_information:, + # The Real-Time Payments network identification of the transfer. transaction_identification:, + # The identifier of the Real-Time Payments Transfer that led to this Transaction. transfer_id: ); end sig do @@ -6973,15 +7559,28 @@ module Increase .returns(T.attached_class) end def self.new( + # The declined amount in the minor unit of the destination account currency. For + # dollars, for example, this is cents. amount:, + # The name the sender of the transfer specified as the recipient of the transfer. creditor_name:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined + # transfer's currency. This will always be "USD" for a Real-Time Payments + # transfer. currency:, + # The account number of the account that sent the transfer. debtor_account_number:, + # The name provided by the sender of the transfer. debtor_name:, + # The routing number of the account that sent the transfer. debtor_routing_number:, + # Why the transfer was declined. reason:, + # Additional information included with the transfer. remittance_information:, + # The Real-Time Payments network identification of the declined transfer. transaction_identification:, + # The identifier of the Real-Time Payments Transfer that led to this Transaction. transfer_id: ); end sig do @@ -7226,22 +7825,44 @@ module Increase .returns(T.attached_class) end def self.new( + # The amount that was reversed in USD cents. amount:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the reversal was created. created_at:, + # The description on the reversal message from Fedwire, set by the reversing bank. description:, + # Additional financial institution information included in the wire reversal. financial_institution_to_financial_institution_information:, + # The Fedwire cycle date for the wire reversal. The "Fedwire day" begins at 9:00 + # PM Eastern Time on the evening before the `cycle date`. input_cycle_date:, + # The Fedwire transaction identifier. input_message_accountability_data:, + # The Fedwire sequence number. input_sequence_number:, + # The Fedwire input source identifier. input_source:, + # The American Banking Association (ABA) routing number of the bank originating + # the transfer. originator_routing_number:, + # The Fedwire cycle date for the wire transfer that is being reversed by this + # message. previous_message_input_cycle_date:, + # The Fedwire transaction identifier for the wire transfer that was reversed. previous_message_input_message_accountability_data:, + # The Fedwire sequence number for the wire transfer that was reversed. previous_message_input_sequence_number:, + # The Fedwire input source identifier for the wire transfer that was reversed. previous_message_input_source:, + # Information included in the wire reversal for the receiving financial + # institution. receiver_financial_institution_information:, + # The sending bank's reference number for the wire reversal. sender_reference:, + # The ID for the Transaction associated with the transfer reversal. transaction_id:, + # The ID for the Wire Transfer that is being reversed. wire_transfer_id: ); end sig do @@ -7380,24 +8001,46 @@ module Increase .returns(T.attached_class) end def self.new( + # The amount in USD cents. amount:, + # A free-form address field set by the sender. beneficiary_address_line1:, + # A free-form address field set by the sender. beneficiary_address_line2:, + # A free-form address field set by the sender. beneficiary_address_line3:, + # A name set by the sender. beneficiary_name:, + # A free-form reference string set by the sender, to help identify the transfer. beneficiary_reference:, + # An Increase-constructed description of the transfer. description:, + # A unique identifier available to the originating and receiving banks, commonly + # abbreviated as IMAD. It is created when the wire is submitted to the Fedwire + # service and is helpful when debugging wires with the originating bank. input_message_accountability_data:, + # The address of the wire originator, set by the sending bank. originator_address_line1:, + # The address of the wire originator, set by the sending bank. originator_address_line2:, + # The address of the wire originator, set by the sending bank. originator_address_line3:, + # The originator of the wire, set by the sending bank. originator_name:, + # The American Banking Association (ABA) routing number of the bank originating + # the transfer. originator_routing_number:, + # An Increase-created concatenation of the Originator-to-Beneficiary lines. originator_to_beneficiary_information:, + # A free-form message set by the wire originator. originator_to_beneficiary_information_line1:, + # A free-form message set by the wire originator. originator_to_beneficiary_information_line2:, + # A free-form message set by the wire originator. originator_to_beneficiary_information_line3:, + # A free-form message set by the wire originator. originator_to_beneficiary_information_line4:, + # The ID of the Inbound Wire Transfer object that resulted in this Transaction. transfer_id: ); end sig do @@ -7440,8 +8083,10 @@ module Increase # created when Increase has received a wire and the User requests that it be # reversed. sig { params(inbound_wire_transfer_id: String).returns(T.attached_class) } - def self.new(inbound_wire_transfer_id:); end - + def self.new( + # The ID of the Inbound Wire Transfer that is being reversed. + inbound_wire_transfer_id: + ); end sig { override.returns({inbound_wire_transfer_id: String}) } def to_hash; end end @@ -7483,8 +8128,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(accrued_on_account_id:, amount:, currency:, period_end:, period_start:); end - + def self.new( + # The account on which the interest was accrued. + accrued_on_account_id:, + # The amount in the minor unit of the transaction's currency. For dollars, for + # example, this is cents. + amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction + # currency. + currency:, + # The end of the period for which this transaction paid interest. + period_end:, + # The start of the period for which this transaction paid interest. + period_start: + ); end sig do override .returns( @@ -7558,8 +8215,17 @@ module Increase ) .returns(T.attached_class) end - def self.new(amount:, currency:, reason:); end - + def self.new( + # The amount in the minor unit of the transaction's currency. For dollars, for + # example, this is cents. + amount:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction + # currency. + currency:, + # An Internal Source is a transaction between you and Increase. This describes the + # reason for the transaction. + reason: + ); end sig do override .returns( @@ -7717,14 +8383,17 @@ module Increase .returns(T.attached_class) end def self.new( + # The transfer amount in USD cents. amount:, + # The destination account number. destination_account_number:, + # The American Bankers' Association (ABA) Routing Transit Number (RTN). destination_routing_number:, + # Unstructured information that will show on the recipient's bank statement. remittance_information:, + # The identifier of the Real-Time Payments Transfer that led to this Transaction. transfer_id: - ) - end - + ); end sig do override .returns( @@ -7749,8 +8418,10 @@ module Increase # only if `category` is equal to `sample_funds`. Sample funds for testing # purposes. sig { params(originator: String).returns(T.attached_class) } - def self.new(originator:); end - + def self.new( + # Where the sample funds came from. + originator: + ); end sig { override.returns({originator: String}) } def to_hash; end end @@ -7789,8 +8460,18 @@ module Increase ) .returns(T.attached_class) end - def self.new(account_number:, amount:, message_to_recipient:, routing_number:, transfer_id:); end - + def self.new( + # The destination account number. + account_number:, + # The transfer amount in USD cents. + amount:, + # The message that will show on the recipient's bank statement. + message_to_recipient:, + # The American Bankers' Association (ABA) Routing Transit Number (RTN). + routing_number:, + # The identifier of the Wire Transfer that led to this Transaction. + transfer_id: + ); end sig do override .returns( diff --git a/rbi/lib/increase/models/transaction_list_params.rbi b/rbi/lib/increase/models/transaction_list_params.rbi index 8adfb946f..e67d92548 100644 --- a/rbi/lib/increase/models/transaction_list_params.rbi +++ b/rbi/lib/increase/models/transaction_list_params.rbi @@ -67,11 +67,17 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter Transactions for those belonging to the specified Account. account_id: nil, category: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, + # Filter Transactions for those belonging to the specified route. This could be a + # Card ID or an Account Number ID. route_id: nil, request_options: {} ); end @@ -104,8 +110,11 @@ module Increase params(in_: T::Array[Increase::Models::TransactionListParams::Category::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # Return results whose value is in the provided list. For GET requests, this + # should be encoded as a comma-delimited string, such as `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::TransactionListParams::Category::In::OrSymbol]}) } def to_hash; end @@ -286,8 +295,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end diff --git a/rbi/lib/increase/models/wire_drawdown_request.rbi b/rbi/lib/increase/models/wire_drawdown_request.rbi index 76c892a3b..56b7bb4e6 100644 --- a/rbi/lib/increase/models/wire_drawdown_request.rbi +++ b/rbi/lib/increase/models/wire_drawdown_request.rbi @@ -133,26 +133,55 @@ module Increase .returns(T.attached_class) end def self.new( + # The Wire drawdown request identifier. id:, + # The Account Number to which the recipient of this request is being requested to + # send funds. account_number_id:, + # The amount being requested in cents. amount:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the wire drawdown request was created. created_at:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being + # requested. Will always be "USD". currency:, + # If the recipient fulfills the drawdown request by sending funds, then this will + # be the identifier of the corresponding Transaction. fulfillment_inbound_wire_transfer_id:, + # 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). idempotency_key:, + # The message the recipient will see as part of the drawdown request. message_to_recipient:, + # The originator's address line 1. originator_address_line1:, + # The originator's address line 2. originator_address_line2:, + # The originator's address line 3. originator_address_line3:, + # The originator's name. originator_name:, + # The drawdown request's recipient's account number. recipient_account_number:, + # Line 1 of the drawdown request's recipient's address. recipient_address_line1:, + # Line 2 of the drawdown request's recipient's address. recipient_address_line2:, + # Line 3 of the drawdown request's recipient's address. recipient_address_line3:, + # The drawdown request's recipient's name. recipient_name:, + # The drawdown request's recipient's routing number. recipient_routing_number:, + # The lifecycle status of the drawdown request. status:, + # After the drawdown request is submitted to Fedwire, this will contain + # supplemental details. submission:, + # A constant representing the object's type. For this resource it will always be + # `wire_drawdown_request`. type: ); end sig do @@ -218,8 +247,11 @@ module Increase # After the drawdown request is submitted to Fedwire, this will contain # supplemental details. sig { params(input_message_accountability_data: String).returns(T.attached_class) } - def self.new(input_message_accountability_data:); end - + def self.new( + # The input message accountability data (IMAD) uniquely identifying the submission + # with Fedwire. + input_message_accountability_data: + ); end sig { override.returns({input_message_accountability_data: String}) } def to_hash; end end diff --git a/rbi/lib/increase/models/wire_drawdown_request_create_params.rbi b/rbi/lib/increase/models/wire_drawdown_request_create_params.rbi index dca461462..ab34a21c1 100644 --- a/rbi/lib/increase/models/wire_drawdown_request_create_params.rbi +++ b/rbi/lib/increase/models/wire_drawdown_request_create_params.rbi @@ -107,18 +107,39 @@ module Increase .returns(T.attached_class) end def self.new( + # The Account Number to which the recipient should send funds. account_number_id:, + # The amount requested from the recipient, in USD cents. amount:, + # A message the recipient will see as part of the request. message_to_recipient:, + # The drawdown request's recipient's account number. recipient_account_number:, + # The drawdown request's recipient's name. recipient_name:, + # The drawdown request's recipient's routing number. recipient_routing_number:, + # The drawdown request originator's address line 1. This is only necessary if + # you're requesting a payment to a commingled account. Otherwise, we'll use the + # associated entity's details. originator_address_line1: nil, + # The drawdown request originator's address line 2. This is only necessary if + # you're requesting a payment to a commingled account. Otherwise, we'll use the + # associated entity's details. originator_address_line2: nil, + # The drawdown request originator's address line 3. This is only necessary if + # you're requesting a payment to a commingled account. Otherwise, we'll use the + # associated entity's details. originator_address_line3: nil, + # The drawdown request originator's name. This is only necessary if you're + # requesting a payment to a commingled account. Otherwise, we'll use the + # associated entity's details. originator_name: nil, + # Line 1 of the drawdown request's recipient's address. recipient_address_line1: nil, + # Line 2 of the drawdown request's recipient's address. recipient_address_line2: nil, + # Line 3 of the drawdown request's recipient's address. recipient_address_line3: nil, request_options: {} ); end diff --git a/rbi/lib/increase/models/wire_drawdown_request_list_params.rbi b/rbi/lib/increase/models/wire_drawdown_request_list_params.rbi index 85e91dcb6..aea2aa616 100644 --- a/rbi/lib/increase/models/wire_drawdown_request_list_params.rbi +++ b/rbi/lib/increase/models/wire_drawdown_request_list_params.rbi @@ -52,8 +52,20 @@ module Increase ) .returns(T.attached_class) end - def self.new(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}); end - + def self.new( + # Return the page of entries after this one. + cursor: nil, + # 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). + idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. + limit: nil, + status: nil, + request_options: {} + ); end sig do override .returns( @@ -82,8 +94,12 @@ module Increase params(in_: T::Array[Increase::Models::WireDrawdownRequestListParams::Status::In::OrSymbol]) .returns(T.attached_class) end - def self.new(in_: nil); end - + def self.new( + # Filter Wire Drawdown Requests for those with the specified status. For GET + # requests, this should be encoded as a comma-delimited string, such as + # `?in=one,two,three`. + in_: nil + ); end sig { override.returns({in_: T::Array[Increase::Models::WireDrawdownRequestListParams::Status::In::OrSymbol]}) } def to_hash; end diff --git a/rbi/lib/increase/models/wire_transfer.rbi b/rbi/lib/increase/models/wire_transfer.rbi index 6aa81e3e1..e6d314498 100644 --- a/rbi/lib/increase/models/wire_transfer.rbi +++ b/rbi/lib/increase/models/wire_transfer.rbi @@ -203,34 +203,74 @@ module Increase .returns(T.attached_class) end def self.new( + # The wire transfer's identifier. id:, + # The Account to which the transfer belongs. account_id:, + # The destination account number. account_number:, + # The transfer amount in USD cents. amount:, + # If your account requires approvals for transfers and the transfer was approved, + # this will contain details of the approval. approval:, + # The beneficiary's address line 1. beneficiary_address_line1:, + # The beneficiary's address line 2. beneficiary_address_line2:, + # The beneficiary's address line 3. beneficiary_address_line3:, + # The beneficiary's name. beneficiary_name:, + # If your account requires approvals for transfers and the transfer was not + # approved, this will contain details of the cancellation. cancellation:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the transfer was created. created_at:, + # What object created the transfer, either via the API or the dashboard. created_by:, + # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's + # currency. For wire transfers this is always equal to `usd`. currency:, + # The identifier of the External Account the transfer was made to, if any. external_account_id:, + # 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). idempotency_key:, + # The message that will show on the recipient's bank statement. message_to_recipient:, + # The transfer's network. network:, + # The originator's address line 1. originator_address_line1:, + # The originator's address line 2. originator_address_line2:, + # The originator's address line 3. originator_address_line3:, + # The originator's name. originator_name:, + # The ID for the pending transaction representing the transfer. A pending + # transaction is created when the transfer + # [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) + # by someone else in your organization. pending_transaction_id:, + # If your transfer is reversed, this will contain details of the reversal. reversal:, + # The American Bankers' Association (ABA) Routing Transit Number (RTN). routing_number:, + # The Account Number that was passed to the wire's recipient. source_account_number_id:, + # The lifecycle status of the transfer. status:, + # After the transfer is submitted to Fedwire, this will contain supplemental + # details. submission:, + # The ID for the transaction funding the transfer. transaction_id:, + # A constant representing the object's type. For this resource it will always be + # `wire_transfer`. type: ); end sig do @@ -285,8 +325,14 @@ module Increase # If your account requires approvals for transfers and the transfer was approved, # this will contain details of the approval. sig { params(approved_at: Time, approved_by: T.nilable(String)).returns(T.attached_class) } - def self.new(approved_at:, approved_by:); end - + def self.new( + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the transfer was approved. + approved_at:, + # If the Transfer was approved by a user in the dashboard, the email address of + # that user. + approved_by: + ); end sig { override.returns({approved_at: Time, approved_by: T.nilable(String)}) } def to_hash; end end @@ -305,8 +351,14 @@ module Increase # If your account requires approvals for transfers and the transfer was not # approved, this will contain details of the cancellation. sig { params(canceled_at: Time, canceled_by: T.nilable(String)).returns(T.attached_class) } - def self.new(canceled_at:, canceled_by:); end - + def self.new( + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the Transfer was canceled. + canceled_at:, + # If the Transfer was canceled by a user in the dashboard, the email address of + # that user. + canceled_by: + ); end sig { override.returns({canceled_at: Time, canceled_by: T.nilable(String)}) } def to_hash; end end @@ -362,8 +414,16 @@ module Increase ) .returns(T.attached_class) end - def self.new(api_key:, category:, oauth_application:, user:); end - + def self.new( + # If present, details about the API key that created the transfer. + api_key:, + # The type of object that created this transfer. + category:, + # If present, details about the OAuth Application that created the transfer. + oauth_application:, + # If present, details about the User that created the transfer. + user: + ); end sig do override .returns( @@ -384,8 +444,10 @@ module Increase # If present, details about the API key that created the transfer. sig { params(description: T.nilable(String)).returns(T.attached_class) } - def self.new(description:); end - + def self.new( + # The description set for the API key when it was created. + description: + ); end sig { override.returns({description: T.nilable(String)}) } def to_hash; end end @@ -418,8 +480,10 @@ module Increase # If present, details about the OAuth Application that created the transfer. sig { params(name: String).returns(T.attached_class) } - def self.new(name:); end - + def self.new( + # The name of the OAuth Application. + name: + ); end sig { override.returns({name: String}) } def to_hash; end end @@ -431,8 +495,10 @@ module Increase # If present, details about the User that created the transfer. sig { params(email: String).returns(T.attached_class) } - def self.new(email:); end - + def self.new( + # The email address of the User. + email: + ); end sig { override.returns({email: String}) } def to_hash; end end @@ -579,22 +645,44 @@ module Increase .returns(T.attached_class) end def self.new( + # The amount that was reversed in USD cents. amount:, + # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which + # the reversal was created. created_at:, + # The description on the reversal message from Fedwire, set by the reversing bank. description:, + # Additional financial institution information included in the wire reversal. financial_institution_to_financial_institution_information:, + # The Fedwire cycle date for the wire reversal. The "Fedwire day" begins at 9:00 + # PM Eastern Time on the evening before the `cycle date`. input_cycle_date:, + # The Fedwire transaction identifier. input_message_accountability_data:, + # The Fedwire sequence number. input_sequence_number:, + # The Fedwire input source identifier. input_source:, + # The American Banking Association (ABA) routing number of the bank originating + # the transfer. originator_routing_number:, + # The Fedwire cycle date for the wire transfer that is being reversed by this + # message. previous_message_input_cycle_date:, + # The Fedwire transaction identifier for the wire transfer that was reversed. previous_message_input_message_accountability_data:, + # The Fedwire sequence number for the wire transfer that was reversed. previous_message_input_sequence_number:, + # The Fedwire input source identifier for the wire transfer that was reversed. previous_message_input_source:, + # Information included in the wire reversal for the receiving financial + # institution. receiver_financial_institution_information:, + # The sending bank's reference number for the wire reversal. sender_reference:, + # The ID for the Transaction associated with the transfer reversal. transaction_id:, + # The ID for the Wire Transfer that is being reversed. wire_transfer_id: ); end sig do @@ -676,8 +764,12 @@ module Increase sig do params(input_message_accountability_data: String, submitted_at: Time).returns(T.attached_class) end - def self.new(input_message_accountability_data:, submitted_at:); end - + def self.new( + # The accountability data for the submission. + input_message_accountability_data:, + # When this wire transfer was submitted to Fedwire. + submitted_at: + ); end sig { override.returns({input_message_accountability_data: String, submitted_at: Time}) } def to_hash; end end diff --git a/rbi/lib/increase/models/wire_transfer_create_params.rbi b/rbi/lib/increase/models/wire_transfer_create_params.rbi index 687ca189d..46ed2608c 100644 --- a/rbi/lib/increase/models/wire_transfer_create_params.rbi +++ b/rbi/lib/increase/models/wire_transfer_create_params.rbi @@ -135,21 +135,43 @@ module Increase .returns(T.attached_class) end def self.new( + # The identifier for the account that will send the transfer. account_id:, + # The transfer amount in USD cents. amount:, + # The beneficiary's name. beneficiary_name:, + # The message that will show on the recipient's bank statement. message_to_recipient:, + # The account number for the destination account. account_number: nil, + # The beneficiary's address line 1. beneficiary_address_line1: nil, + # The beneficiary's address line 2. beneficiary_address_line2: nil, + # The beneficiary's address line 3. beneficiary_address_line3: nil, + # The ID of an External Account to initiate a transfer to. If this parameter is + # provided, `account_number` and `routing_number` must be absent. external_account_id: nil, + # The originator's address line 1. This is only necessary if you're transferring + # from a commingled account. Otherwise, we'll use the associated entity's details. originator_address_line1: nil, + # The originator's address line 2. This is only necessary if you're transferring + # from a commingled account. Otherwise, we'll use the associated entity's details. originator_address_line2: nil, + # The originator's address line 3. This is only necessary if you're transferring + # from a commingled account. Otherwise, we'll use the associated entity's details. originator_address_line3: nil, + # The originator's name. This is only necessary if you're transferring from a + # commingled account. Otherwise, we'll use the associated entity's details. originator_name: nil, + # Whether the transfer requires explicit approval via the dashboard or API. require_approval: nil, + # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the + # destination account. routing_number: nil, + # The ID of an Account Number that will be passed to the wire's recipient source_account_number_id: nil, request_options: {} ); end diff --git a/rbi/lib/increase/models/wire_transfer_list_params.rbi b/rbi/lib/increase/models/wire_transfer_list_params.rbi index 036de0e65..9572d048f 100644 --- a/rbi/lib/increase/models/wire_transfer_list_params.rbi +++ b/rbi/lib/increase/models/wire_transfer_list_params.rbi @@ -69,11 +69,20 @@ module Increase .returns(T.attached_class) end def self.new( + # Filter Wire Transfers to those belonging to the specified Account. account_id: nil, created_at: nil, + # Return the page of entries after this one. cursor: nil, + # Filter Wire Transfers to those made to the specified External Account. external_account_id: nil, + # 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). idempotency_key: nil, + # Limit the size of the list that is returned. The default (and maximum) is 100 + # objects. limit: nil, request_options: {} ); end @@ -129,8 +138,20 @@ module Increase sig do params(after: Time, before: Time, on_or_after: Time, on_or_before: Time).returns(T.attached_class) end - def self.new(after: nil, before: nil, on_or_after: nil, on_or_before: nil); end - + def self.new( + # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + after: nil, + # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + # timestamp. + before: nil, + # Return results on or after this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_after: nil, + # Return results on or before this + # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. + on_or_before: nil + ); end sig { override.returns({after: Time, before: Time, on_or_after: Time, on_or_before: Time}) } def to_hash; end end From f7348dc4328a7e2111a67be09dc77843c83b2e49 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 24 Apr 2025 16:04:38 +0000 Subject: [PATCH 08/16] feat(api): api update --- .stats.yml | 4 +- lib/increase/models/pending_transaction.rb | 32 ++++++++++++- .../models/pending_transaction_list_params.rb | 3 ++ lib/increase/models/transaction.rb | 34 +++++++++++++- .../models/transaction_list_params.rb | 3 ++ .../increase/models/pending_transaction.rbi | 42 +++++++++++++++++ .../pending_transaction_list_params.rbi | 7 +++ rbi/lib/increase/models/transaction.rbi | 45 +++++++++++++++++++ .../models/transaction_list_params.rbi | 4 ++ sig/increase/models/pending_transaction.rbs | 18 ++++++++ .../pending_transaction_list_params.rbs | 4 ++ sig/increase/models/transaction.rbs | 18 ++++++++ .../models/transaction_list_params.rbs | 4 ++ 13 files changed, 214 insertions(+), 4 deletions(-) diff --git a/.stats.yml b/.stats.yml index 3ebab9869..ef1d3d99d 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 194 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-7eefcf9e79e89a7e4a2a064d93c40f83d3efe93ea91c0e9ba7112e491fb69e8f.yml -openapi_spec_hash: 3e3ee435a96bbb79dfe7c28d4bdab846 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-ea1cbc57d35054776bb4114a558a9a752b9402c1c35e9ae8b3110b829621f68f.yml +openapi_spec_hash: 2d965f5c4e7347b2a9b916e13d7f8433 config_hash: 6ae27f935d24d38237894dd4fd6bd749 diff --git a/lib/increase/models/pending_transaction.rb b/lib/increase/models/pending_transaction.rb index a4c508299..ee3c98911 100644 --- a/lib/increase/models/pending_transaction.rb +++ b/lib/increase/models/pending_transaction.rb @@ -272,6 +272,15 @@ class Source < Increase::Internal::Type::BaseModel -> { Increase::Models::PendingTransaction::Source::RealTimePaymentsTransferInstruction }, nil?: true + # @!attribute swift_transfer_instruction + # A Swift Transfer Instruction object. This field will be present in the JSON + # response if and only if `category` is equal to `swift_transfer_instruction`. + # + # @return [Increase::Models::PendingTransaction::Source::SwiftTransferInstruction, nil] + required :swift_transfer_instruction, + -> { Increase::Models::PendingTransaction::Source::SwiftTransferInstruction }, + nil?: true + # @!attribute wire_transfer_instruction # A Wire Transfer Instruction object. This field will be present in the JSON # response if and only if `category` is equal to `wire_transfer_instruction`. @@ -281,7 +290,7 @@ class Source < Increase::Internal::Type::BaseModel -> { Increase::Models::PendingTransaction::Source::WireTransferInstruction }, nil?: true - # @!method initialize(account_transfer_instruction:, ach_transfer_instruction:, card_authorization:, category:, check_deposit_instruction:, check_transfer_instruction:, inbound_funds_hold:, inbound_wire_transfer_reversal:, other:, real_time_payments_transfer_instruction:, wire_transfer_instruction:) + # @!method initialize(account_transfer_instruction:, ach_transfer_instruction:, card_authorization:, category:, check_deposit_instruction:, check_transfer_instruction:, inbound_funds_hold:, inbound_wire_transfer_reversal:, other:, real_time_payments_transfer_instruction:, swift_transfer_instruction:, wire_transfer_instruction:) # Some parameter documentations has been truncated, see # {Increase::Models::PendingTransaction::Source} for more details. # @@ -319,6 +328,9 @@ class Source < Increase::Internal::Type::BaseModel # @param real_time_payments_transfer_instruction [Increase::Models::PendingTransaction::Source::RealTimePaymentsTransferInstruction, nil] A Real-Time Payments Transfer Instruction object. This field will be present in # ... # + # @param swift_transfer_instruction [Increase::Models::PendingTransaction::Source::SwiftTransferInstruction, nil] A Swift Transfer Instruction object. This field will be present in the JSON resp + # ... + # # @param wire_transfer_instruction [Increase::Models::PendingTransaction::Source::WireTransferInstruction, nil] A Wire Transfer Instruction object. This field will be present in the JSON respo # ... @@ -1209,6 +1221,9 @@ module Category # Inbound Wire Transfer Reversal: details will be under the `inbound_wire_transfer_reversal` object. INBOUND_WIRE_TRANSFER_REVERSAL = :inbound_wire_transfer_reversal + # Swift Transfer Instruction: details will be under the `swift_transfer_instruction` object. + SWIFT_TRANSFER_INSTRUCTION = :swift_transfer_instruction + # The Pending Transaction was made for an undocumented or deprecated reason. OTHER = :other @@ -1578,6 +1593,21 @@ class RealTimePaymentsTransferInstruction < Increase::Internal::Type::BaseModel # ... end + # @see Increase::Models::PendingTransaction::Source#swift_transfer_instruction + class SwiftTransferInstruction < Increase::Internal::Type::BaseModel + # @!attribute transfer_id + # The identifier of the Swift Transfer that led to this Pending Transaction. + # + # @return [String] + required :transfer_id, String + + # @!method initialize(transfer_id:) + # A Swift Transfer Instruction object. This field will be present in the JSON + # response if and only if `category` is equal to `swift_transfer_instruction`. + # + # @param transfer_id [String] The identifier of the Swift Transfer that led to this Pending Transaction. + end + # @see Increase::Models::PendingTransaction::Source#wire_transfer_instruction class WireTransferInstruction < Increase::Internal::Type::BaseModel # @!attribute account_number diff --git a/lib/increase/models/pending_transaction_list_params.rb b/lib/increase/models/pending_transaction_list_params.rb index 9fd992671..34496e4c3 100644 --- a/lib/increase/models/pending_transaction_list_params.rb +++ b/lib/increase/models/pending_transaction_list_params.rb @@ -115,6 +115,9 @@ module In # Inbound Wire Transfer Reversal: details will be under the `inbound_wire_transfer_reversal` object. INBOUND_WIRE_TRANSFER_REVERSAL = :inbound_wire_transfer_reversal + # Swift Transfer Instruction: details will be under the `swift_transfer_instruction` object. + SWIFT_TRANSFER_INSTRUCTION = :swift_transfer_instruction + # The Pending Transaction was made for an undocumented or deprecated reason. OTHER = :other diff --git a/lib/increase/models/transaction.rb b/lib/increase/models/transaction.rb index 8798a064c..01892a96b 100644 --- a/lib/increase/models/transaction.rb +++ b/lib/increase/models/transaction.rb @@ -459,6 +459,16 @@ class Source < Increase::Internal::Type::BaseModel # @return [Increase::Models::Transaction::Source::SampleFunds, nil] required :sample_funds, -> { Increase::Models::Transaction::Source::SampleFunds }, nil?: true + # @!attribute swift_transfer_intention + # A Swift Transfer Intention object. This field will be present in the JSON + # response if and only if `category` is equal to `swift_transfer_intention`. A + # Swift Transfer initiated via Increase. + # + # @return [Increase::Models::Transaction::Source::SwiftTransferIntention, nil] + required :swift_transfer_intention, + -> { Increase::Models::Transaction::Source::SwiftTransferIntention }, + nil?: true + # @!attribute wire_transfer_intention # A Wire Transfer Intention object. This field will be present in the JSON # response if and only if `category` is equal to `wire_transfer_intention`. A Wire @@ -469,7 +479,7 @@ class Source < Increase::Internal::Type::BaseModel -> { Increase::Models::Transaction::Source::WireTransferIntention }, nil?: true - # @!method initialize(account_transfer_intention:, ach_transfer_intention:, ach_transfer_rejection:, ach_transfer_return:, card_dispute_acceptance:, card_dispute_loss:, card_refund:, card_revenue_payment:, card_settlement:, cashback_payment:, category:, check_deposit_acceptance:, check_deposit_return:, check_transfer_deposit:, fee_payment:, inbound_ach_transfer:, inbound_ach_transfer_return_intention:, inbound_check_adjustment:, inbound_check_deposit_return_intention:, inbound_real_time_payments_transfer_confirmation:, inbound_real_time_payments_transfer_decline:, inbound_wire_reversal:, inbound_wire_transfer:, inbound_wire_transfer_reversal:, interest_payment:, internal_source:, other:, real_time_payments_transfer_acknowledgement:, sample_funds:, wire_transfer_intention:) + # @!method initialize(account_transfer_intention:, ach_transfer_intention:, ach_transfer_rejection:, ach_transfer_return:, card_dispute_acceptance:, card_dispute_loss:, card_refund:, card_revenue_payment:, card_settlement:, cashback_payment:, category:, check_deposit_acceptance:, check_deposit_return:, check_transfer_deposit:, fee_payment:, inbound_ach_transfer:, inbound_ach_transfer_return_intention:, inbound_check_adjustment:, inbound_check_deposit_return_intention:, inbound_real_time_payments_transfer_confirmation:, inbound_real_time_payments_transfer_decline:, inbound_wire_reversal:, inbound_wire_transfer:, inbound_wire_transfer_reversal:, interest_payment:, internal_source:, other:, real_time_payments_transfer_acknowledgement:, sample_funds:, swift_transfer_intention:, wire_transfer_intention:) # Some parameter documentations has been truncated, see # {Increase::Models::Transaction::Source} for more details. # @@ -565,6 +575,9 @@ class Source < Increase::Internal::Type::BaseModel # @param sample_funds [Increase::Models::Transaction::Source::SampleFunds, nil] A Sample Funds object. This field will be present in the JSON response if and on # ... # + # @param swift_transfer_intention [Increase::Models::Transaction::Source::SwiftTransferIntention, nil] A Swift Transfer Intention object. This field will be present in the JSON respon + # ... + # # @param wire_transfer_intention [Increase::Models::Transaction::Source::WireTransferIntention, nil] A Wire Transfer Intention object. This field will be present in the JSON respons # ... @@ -4108,6 +4121,9 @@ module Category # Wire Transfer Intention: details will be under the `wire_transfer_intention` object. WIRE_TRANSFER_INTENTION = :wire_transfer_intention + # Swift Transfer Intention: details will be under the `swift_transfer_intention` object. + SWIFT_TRANSFER_INTENTION = :swift_transfer_intention + # The Transaction was made for an undocumented or deprecated reason. OTHER = :other @@ -5760,6 +5776,22 @@ class SampleFunds < Increase::Internal::Type::BaseModel # @param originator [String] Where the sample funds came from. end + # @see Increase::Models::Transaction::Source#swift_transfer_intention + class SwiftTransferIntention < Increase::Internal::Type::BaseModel + # @!attribute transfer_id + # The identifier of the Swift Transfer that led to this Transaction. + # + # @return [String] + required :transfer_id, String + + # @!method initialize(transfer_id:) + # A Swift Transfer Intention object. This field will be present in the JSON + # response if and only if `category` is equal to `swift_transfer_intention`. A + # Swift Transfer initiated via Increase. + # + # @param transfer_id [String] The identifier of the Swift Transfer that led to this Transaction. + end + # @see Increase::Models::Transaction::Source#wire_transfer_intention class WireTransferIntention < Increase::Internal::Type::BaseModel # @!attribute account_number diff --git a/lib/increase/models/transaction_list_params.rb b/lib/increase/models/transaction_list_params.rb index e99f2b427..bcd5a8dcd 100644 --- a/lib/increase/models/transaction_list_params.rb +++ b/lib/increase/models/transaction_list_params.rb @@ -167,6 +167,9 @@ module In # Wire Transfer Intention: details will be under the `wire_transfer_intention` object. WIRE_TRANSFER_INTENTION = :wire_transfer_intention + # Swift Transfer Intention: details will be under the `swift_transfer_intention` object. + SWIFT_TRANSFER_INTENTION = :swift_transfer_intention + # The Transaction was made for an undocumented or deprecated reason. OTHER = :other diff --git a/rbi/lib/increase/models/pending_transaction.rbi b/rbi/lib/increase/models/pending_transaction.rbi index 84a7a73ea..d9040388b 100644 --- a/rbi/lib/increase/models/pending_transaction.rbi +++ b/rbi/lib/increase/models/pending_transaction.rbi @@ -342,6 +342,21 @@ module Increase end attr_writer :real_time_payments_transfer_instruction + # A Swift Transfer Instruction object. This field will be present in the JSON + # response if and only if `category` is equal to `swift_transfer_instruction`. + sig { returns(T.nilable(Increase::Models::PendingTransaction::Source::SwiftTransferInstruction)) } + attr_reader :swift_transfer_instruction + + sig do + params( + swift_transfer_instruction: T.nilable( + T.any(Increase::Models::PendingTransaction::Source::SwiftTransferInstruction, Increase::Internal::AnyHash) + ) + ) + .void + end + attr_writer :swift_transfer_instruction + # A Wire Transfer Instruction object. This field will be present in the JSON # response if and only if `category` is equal to `wire_transfer_instruction`. sig { returns(T.nilable(Increase::Models::PendingTransaction::Source::WireTransferInstruction)) } @@ -397,6 +412,9 @@ module Increase Increase::Internal::AnyHash ) ), + swift_transfer_instruction: T.nilable( + T.any(Increase::Models::PendingTransaction::Source::SwiftTransferInstruction, Increase::Internal::AnyHash) + ), wire_transfer_instruction: T.nilable( T.any(Increase::Models::PendingTransaction::Source::WireTransferInstruction, Increase::Internal::AnyHash) ) @@ -441,6 +459,9 @@ module Increase # the JSON response if and only if `category` is equal to # `real_time_payments_transfer_instruction`. real_time_payments_transfer_instruction:, + # A Swift Transfer Instruction object. This field will be present in the JSON + # response if and only if `category` is equal to `swift_transfer_instruction`. + swift_transfer_instruction:, # A Wire Transfer Instruction object. This field will be present in the JSON # response if and only if `category` is equal to `wire_transfer_instruction`. wire_transfer_instruction: @@ -459,6 +480,7 @@ module Increase inbound_wire_transfer_reversal: T.nilable(Increase::Models::PendingTransaction::Source::InboundWireTransferReversal), other: T.nilable(T.anything), real_time_payments_transfer_instruction: T.nilable(Increase::Models::PendingTransaction::Source::RealTimePaymentsTransferInstruction), + swift_transfer_instruction: T.nilable(Increase::Models::PendingTransaction::Source::SwiftTransferInstruction), wire_transfer_instruction: T.nilable(Increase::Models::PendingTransaction::Source::WireTransferInstruction) } ) @@ -1865,6 +1887,10 @@ module Increase Increase::Models::PendingTransaction::Source::Category::TaggedSymbol ) + # Swift Transfer Instruction: details will be under the `swift_transfer_instruction` object. + SWIFT_TRANSFER_INSTRUCTION = + T.let(:swift_transfer_instruction, Increase::Models::PendingTransaction::Source::Category::TaggedSymbol) + # The Pending Transaction was made for an undocumented or deprecated reason. OTHER = T.let(:other, Increase::Models::PendingTransaction::Source::Category::TaggedSymbol) @@ -2319,6 +2345,22 @@ module Increase def to_hash; end end + class SwiftTransferInstruction < Increase::Internal::Type::BaseModel + # The identifier of the Swift Transfer that led to this Pending Transaction. + sig { returns(String) } + attr_accessor :transfer_id + + # A Swift Transfer Instruction object. This field will be present in the JSON + # response if and only if `category` is equal to `swift_transfer_instruction`. + sig { params(transfer_id: String).returns(T.attached_class) } + def self.new( + # The identifier of the Swift Transfer that led to this Pending Transaction. + transfer_id: + ); end + sig { override.returns({transfer_id: String}) } + def to_hash; end + end + class WireTransferInstruction < Increase::Internal::Type::BaseModel # The account number for the destination account. sig { returns(String) } diff --git a/rbi/lib/increase/models/pending_transaction_list_params.rbi b/rbi/lib/increase/models/pending_transaction_list_params.rbi index 94383f729..bf2bc0525 100644 --- a/rbi/lib/increase/models/pending_transaction_list_params.rbi +++ b/rbi/lib/increase/models/pending_transaction_list_params.rbi @@ -196,6 +196,13 @@ module Increase Increase::Models::PendingTransactionListParams::Category::In::TaggedSymbol ) + # Swift Transfer Instruction: details will be under the `swift_transfer_instruction` object. + SWIFT_TRANSFER_INSTRUCTION = + T.let( + :swift_transfer_instruction, + Increase::Models::PendingTransactionListParams::Category::In::TaggedSymbol + ) + # The Pending Transaction was made for an undocumented or deprecated reason. OTHER = T.let(:other, Increase::Models::PendingTransactionListParams::Category::In::TaggedSymbol) diff --git a/rbi/lib/increase/models/transaction.rbi b/rbi/lib/increase/models/transaction.rbi index 373896e4a..3b5b52388 100644 --- a/rbi/lib/increase/models/transaction.rbi +++ b/rbi/lib/increase/models/transaction.rbi @@ -634,6 +634,22 @@ module Increase end attr_writer :sample_funds + # A Swift Transfer Intention object. This field will be present in the JSON + # response if and only if `category` is equal to `swift_transfer_intention`. A + # Swift Transfer initiated via Increase. + sig { returns(T.nilable(Increase::Models::Transaction::Source::SwiftTransferIntention)) } + attr_reader :swift_transfer_intention + + sig do + params( + swift_transfer_intention: T.nilable( + T.any(Increase::Models::Transaction::Source::SwiftTransferIntention, Increase::Internal::AnyHash) + ) + ) + .void + end + attr_writer :swift_transfer_intention + # A Wire Transfer Intention object. This field will be present in the JSON # response if and only if `category` is equal to `wire_transfer_intention`. A Wire # Transfer initiated via Increase and sent to a different bank. @@ -720,6 +736,9 @@ module Increase ) ), sample_funds: T.nilable(T.any(Increase::Models::Transaction::Source::SampleFunds, Increase::Internal::AnyHash)), + swift_transfer_intention: T.nilable( + T.any(Increase::Models::Transaction::Source::SwiftTransferIntention, Increase::Internal::AnyHash) + ), wire_transfer_intention: T.nilable( T.any(Increase::Models::Transaction::Source::WireTransferIntention, Increase::Internal::AnyHash) ) @@ -874,6 +893,10 @@ module Increase # only if `category` is equal to `sample_funds`. Sample funds for testing # purposes. sample_funds:, + # A Swift Transfer Intention object. This field will be present in the JSON + # response if and only if `category` is equal to `swift_transfer_intention`. A + # Swift Transfer initiated via Increase. + swift_transfer_intention:, # A Wire Transfer Intention object. This field will be present in the JSON # response if and only if `category` is equal to `wire_transfer_intention`. A Wire # Transfer initiated via Increase and sent to a different bank. @@ -912,6 +935,7 @@ module Increase other: T.nilable(T.anything), real_time_payments_transfer_acknowledgement: T.nilable(Increase::Models::Transaction::Source::RealTimePaymentsTransferAcknowledgement), sample_funds: T.nilable(Increase::Models::Transaction::Source::SampleFunds), + swift_transfer_intention: T.nilable(Increase::Models::Transaction::Source::SwiftTransferIntention), wire_transfer_intention: T.nilable(Increase::Models::Transaction::Source::WireTransferIntention) } ) @@ -6298,6 +6322,10 @@ module Increase WIRE_TRANSFER_INTENTION = T.let(:wire_transfer_intention, Increase::Models::Transaction::Source::Category::TaggedSymbol) + # Swift Transfer Intention: details will be under the `swift_transfer_intention` object. + SWIFT_TRANSFER_INTENTION = + T.let(:swift_transfer_intention, Increase::Models::Transaction::Source::Category::TaggedSymbol) + # The Transaction was made for an undocumented or deprecated reason. OTHER = T.let(:other, Increase::Models::Transaction::Source::Category::TaggedSymbol) @@ -8426,6 +8454,23 @@ module Increase def to_hash; end end + class SwiftTransferIntention < Increase::Internal::Type::BaseModel + # The identifier of the Swift Transfer that led to this Transaction. + sig { returns(String) } + attr_accessor :transfer_id + + # A Swift Transfer Intention object. This field will be present in the JSON + # response if and only if `category` is equal to `swift_transfer_intention`. A + # Swift Transfer initiated via Increase. + sig { params(transfer_id: String).returns(T.attached_class) } + def self.new( + # The identifier of the Swift Transfer that led to this Transaction. + transfer_id: + ); end + sig { override.returns({transfer_id: String}) } + def to_hash; end + end + class WireTransferIntention < Increase::Internal::Type::BaseModel # The destination account number. sig { returns(String) } diff --git a/rbi/lib/increase/models/transaction_list_params.rbi b/rbi/lib/increase/models/transaction_list_params.rbi index e67d92548..df4075ffc 100644 --- a/rbi/lib/increase/models/transaction_list_params.rbi +++ b/rbi/lib/increase/models/transaction_list_params.rbi @@ -251,6 +251,10 @@ module Increase WIRE_TRANSFER_INTENTION = T.let(:wire_transfer_intention, Increase::Models::TransactionListParams::Category::In::TaggedSymbol) + # Swift Transfer Intention: details will be under the `swift_transfer_intention` object. + SWIFT_TRANSFER_INTENTION = + T.let(:swift_transfer_intention, Increase::Models::TransactionListParams::Category::In::TaggedSymbol) + # The Transaction was made for an undocumented or deprecated reason. OTHER = T.let(:other, Increase::Models::TransactionListParams::Category::In::TaggedSymbol) diff --git a/sig/increase/models/pending_transaction.rbs b/sig/increase/models/pending_transaction.rbs index 38aa8e1b1..19eea55c6 100644 --- a/sig/increase/models/pending_transaction.rbs +++ b/sig/increase/models/pending_transaction.rbs @@ -113,6 +113,7 @@ module Increase inbound_wire_transfer_reversal: Increase::Models::PendingTransaction::Source::InboundWireTransferReversal?, other: top?, real_time_payments_transfer_instruction: Increase::Models::PendingTransaction::Source::RealTimePaymentsTransferInstruction?, + swift_transfer_instruction: Increase::Models::PendingTransaction::Source::SwiftTransferInstruction?, wire_transfer_instruction: Increase::Models::PendingTransaction::Source::WireTransferInstruction? } @@ -137,6 +138,8 @@ module Increase attr_accessor real_time_payments_transfer_instruction: Increase::Models::PendingTransaction::Source::RealTimePaymentsTransferInstruction? + attr_accessor swift_transfer_instruction: Increase::Models::PendingTransaction::Source::SwiftTransferInstruction? + attr_accessor wire_transfer_instruction: Increase::Models::PendingTransaction::Source::WireTransferInstruction? def initialize: ( @@ -150,6 +153,7 @@ module Increase inbound_wire_transfer_reversal: Increase::Models::PendingTransaction::Source::InboundWireTransferReversal?, other: top?, real_time_payments_transfer_instruction: Increase::Models::PendingTransaction::Source::RealTimePaymentsTransferInstruction?, + swift_transfer_instruction: Increase::Models::PendingTransaction::Source::SwiftTransferInstruction?, wire_transfer_instruction: Increase::Models::PendingTransaction::Source::WireTransferInstruction? ) -> void @@ -758,6 +762,7 @@ module Increase | :real_time_payments_transfer_instruction | :wire_transfer_instruction | :inbound_wire_transfer_reversal + | :swift_transfer_instruction | :other module Category @@ -790,6 +795,9 @@ module Increase # Inbound Wire Transfer Reversal: details will be under the `inbound_wire_transfer_reversal` object. INBOUND_WIRE_TRANSFER_REVERSAL: :inbound_wire_transfer_reversal + # Swift Transfer Instruction: details will be under the `swift_transfer_instruction` object. + SWIFT_TRANSFER_INSTRUCTION: :swift_transfer_instruction + # The Pending Transaction was made for an undocumented or deprecated reason. OTHER: :other @@ -1027,6 +1035,16 @@ module Increase def to_hash: -> Increase::Models::PendingTransaction::Source::real_time_payments_transfer_instruction end + type swift_transfer_instruction = { transfer_id: String } + + class SwiftTransferInstruction < Increase::Internal::Type::BaseModel + attr_accessor transfer_id: String + + def initialize: (transfer_id: String) -> void + + def to_hash: -> Increase::Models::PendingTransaction::Source::swift_transfer_instruction + end + type wire_transfer_instruction = { account_number: String, diff --git a/sig/increase/models/pending_transaction_list_params.rbs b/sig/increase/models/pending_transaction_list_params.rbs index a44562446..cd0c8ed3d 100644 --- a/sig/increase/models/pending_transaction_list_params.rbs +++ b/sig/increase/models/pending_transaction_list_params.rbs @@ -91,6 +91,7 @@ module Increase | :real_time_payments_transfer_instruction | :wire_transfer_instruction | :inbound_wire_transfer_reversal + | :swift_transfer_instruction | :other module In @@ -123,6 +124,9 @@ module Increase # Inbound Wire Transfer Reversal: details will be under the `inbound_wire_transfer_reversal` object. INBOUND_WIRE_TRANSFER_REVERSAL: :inbound_wire_transfer_reversal + # Swift Transfer Instruction: details will be under the `swift_transfer_instruction` object. + SWIFT_TRANSFER_INSTRUCTION: :swift_transfer_instruction + # The Pending Transaction was made for an undocumented or deprecated reason. OTHER: :other diff --git a/sig/increase/models/transaction.rbs b/sig/increase/models/transaction.rbs index 556bc39e2..dc9b75d92 100644 --- a/sig/increase/models/transaction.rbs +++ b/sig/increase/models/transaction.rbs @@ -124,6 +124,7 @@ module Increase other: top?, real_time_payments_transfer_acknowledgement: Increase::Models::Transaction::Source::RealTimePaymentsTransferAcknowledgement?, sample_funds: Increase::Models::Transaction::Source::SampleFunds?, + swift_transfer_intention: Increase::Models::Transaction::Source::SwiftTransferIntention?, wire_transfer_intention: Increase::Models::Transaction::Source::WireTransferIntention? } @@ -186,6 +187,8 @@ module Increase attr_accessor sample_funds: Increase::Models::Transaction::Source::SampleFunds? + attr_accessor swift_transfer_intention: Increase::Models::Transaction::Source::SwiftTransferIntention? + attr_accessor wire_transfer_intention: Increase::Models::Transaction::Source::WireTransferIntention? def initialize: ( @@ -218,6 +221,7 @@ module Increase other: top?, real_time_payments_transfer_acknowledgement: Increase::Models::Transaction::Source::RealTimePaymentsTransferAcknowledgement?, sample_funds: Increase::Models::Transaction::Source::SampleFunds?, + swift_transfer_intention: Increase::Models::Transaction::Source::SwiftTransferIntention?, wire_transfer_intention: Increase::Models::Transaction::Source::WireTransferIntention? ) -> void @@ -2687,6 +2691,7 @@ module Increase | :real_time_payments_transfer_acknowledgement | :sample_funds | :wire_transfer_intention + | :swift_transfer_intention | :other module Category @@ -2776,6 +2781,9 @@ module Increase # Wire Transfer Intention: details will be under the `wire_transfer_intention` object. WIRE_TRANSFER_INTENTION: :wire_transfer_intention + # Swift Transfer Intention: details will be under the `swift_transfer_intention` object. + SWIFT_TRANSFER_INTENTION: :swift_transfer_intention + # The Transaction was made for an undocumented or deprecated reason. OTHER: :other @@ -3884,6 +3892,16 @@ module Increase def to_hash: -> Increase::Models::Transaction::Source::sample_funds end + type swift_transfer_intention = { transfer_id: String } + + class SwiftTransferIntention < Increase::Internal::Type::BaseModel + attr_accessor transfer_id: String + + def initialize: (transfer_id: String) -> void + + def to_hash: -> Increase::Models::Transaction::Source::swift_transfer_intention + end + type wire_transfer_intention = { account_number: String, diff --git a/sig/increase/models/transaction_list_params.rbs b/sig/increase/models/transaction_list_params.rbs index 9f0f359ae..bc96aabd1 100644 --- a/sig/increase/models/transaction_list_params.rbs +++ b/sig/increase/models/transaction_list_params.rbs @@ -100,6 +100,7 @@ module Increase | :real_time_payments_transfer_acknowledgement | :sample_funds | :wire_transfer_intention + | :swift_transfer_intention | :other module In @@ -189,6 +190,9 @@ module Increase # Wire Transfer Intention: details will be under the `wire_transfer_intention` object. WIRE_TRANSFER_INTENTION: :wire_transfer_intention + # Swift Transfer Intention: details will be under the `swift_transfer_intention` object. + SWIFT_TRANSFER_INTENTION: :swift_transfer_intention + # The Transaction was made for an undocumented or deprecated reason. OTHER: :other From 05afd7274f7881cdef4bc4292d9c7eb8104f0c27 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 24 Apr 2025 18:59:46 +0000 Subject: [PATCH 09/16] feat: support specifying content-type with FilePart class --- lib/increase.rb | 3 +- lib/increase/file_part.rb | 55 +++++++++++ lib/increase/internal/type/converter.rb | 2 +- .../type/{io_like.rb => file_input.rb} | 12 ++- lib/increase/internal/util.rb | 96 ++++++++++--------- lib/increase/models/file_create_params.rb | 6 +- lib/increase/resources/files.rb | 2 +- rbi/lib/increase/file_part.rbi | 34 +++++++ .../type/{io_like.rbi => file_input.rbi} | 8 +- rbi/lib/increase/internal/util.rbi | 28 +++--- .../increase/models/file_create_params.rbi | 6 +- rbi/lib/increase/resources/files.rbi | 2 +- sig/increase/file_part.rbs | 21 ++++ .../type/{io_like.rbs => file_input.rbs} | 2 +- sig/increase/internal/util.rbs | 17 ++-- sig/increase/models/file_create_params.rbs | 6 +- sig/increase/resources/files.rbs | 2 +- .../increase/internal/type/base_model_test.rb | 2 +- test/increase/internal/util_test.rb | 14 ++- 19 files changed, 221 insertions(+), 97 deletions(-) create mode 100644 lib/increase/file_part.rb rename lib/increase/internal/type/{io_like.rb => file_input.rb} (84%) create mode 100644 rbi/lib/increase/file_part.rbi rename rbi/lib/increase/internal/type/{io_like.rbi => file_input.rbi} (82%) create mode 100644 sig/increase/file_part.rbs rename sig/increase/internal/type/{io_like.rbs => file_input.rbs} (96%) diff --git a/lib/increase.rb b/lib/increase.rb index de8559a30..97d6296d4 100644 --- a/lib/increase.rb +++ b/lib/increase.rb @@ -31,7 +31,7 @@ require_relative "increase/internal/type/converter" require_relative "increase/internal/type/unknown" require_relative "increase/internal/type/boolean" -require_relative "increase/internal/type/io_like" +require_relative "increase/internal/type/file_input" require_relative "increase/internal/type/enum" require_relative "increase/internal/type/union" require_relative "increase/internal/type/array_of" @@ -41,6 +41,7 @@ require_relative "increase/internal/type/request_parameters" require_relative "increase/internal" require_relative "increase/request_options" +require_relative "increase/file_part" require_relative "increase/errors" require_relative "increase/internal/transport/base_client" require_relative "increase/internal/transport/pooled_net_requester" diff --git a/lib/increase/file_part.rb b/lib/increase/file_part.rb new file mode 100644 index 000000000..1f975f603 --- /dev/null +++ b/lib/increase/file_part.rb @@ -0,0 +1,55 @@ +# frozen_string_literal: true + +module Increase + class FilePart + # @return [Pathname, StringIO, IO, String] + attr_reader :content + + # @return [String, nil] + attr_reader :content_type + + # @return [String, nil] + attr_reader :filename + + # @api private + # + # @return [String] + private def read + case contents + in Pathname + contents.read(binmode: true) + in StringIO + contents.string + in IO + contents.read + in String + contents + end + end + + # @param a [Object] + # + # @return [String] + def to_json(*a) = read.to_json(*a) + + # @param a [Object] + # + # @return [String] + def to_yaml(*a) = read.to_yaml(*a) + + # @param content [Pathname, StringIO, IO, String] + # @param filename [String, nil] + # @param content_type [String, nil] + def initialize(content, filename: nil, content_type: nil) + @content = content + @filename = + case content + in Pathname + filename.nil? ? content.basename.to_path : File.basename(filename) + else + filename.nil? ? nil : File.basename(filename) + end + @content_type = content_type + end + end +end diff --git a/lib/increase/internal/type/converter.rb b/lib/increase/internal/type/converter.rb index eea85f1ad..4447e2b93 100644 --- a/lib/increase/internal/type/converter.rb +++ b/lib/increase/internal/type/converter.rb @@ -43,7 +43,7 @@ def dump(value, state:) value.string in Pathname | IO state[:can_retry] = false if value.is_a?(IO) - Increase::Internal::Util::SerializationAdapter.new(value) + Increase::FilePart.new(value) else value end diff --git a/lib/increase/internal/type/io_like.rb b/lib/increase/internal/type/file_input.rb similarity index 84% rename from lib/increase/internal/type/io_like.rb rename to lib/increase/internal/type/file_input.rb index 986a717f0..88270c509 100644 --- a/lib/increase/internal/type/io_like.rb +++ b/lib/increase/internal/type/file_input.rb @@ -7,8 +7,12 @@ module Type # # @abstract # - # Either `Pathname` or `StringIO`. - class IOLike + # Either `Pathname` or `StringIO`, or `IO`, or + # `Increase::Internal::Type::FileInput`. + # + # Note: when `IO` is used, all retries are disabled, since many IO` streams are + # not rewindable. + class FileInput extend Increase::Internal::Type::Converter private_class_method :new @@ -20,7 +24,7 @@ class IOLike # @return [Boolean] def self.===(other) case other - in StringIO | Pathname | IO + in Pathname | StringIO | IO | String | Increase::FilePart true else false @@ -32,7 +36,7 @@ def self.===(other) # @param other [Object] # # @return [Boolean] - def self.==(other) = other.is_a?(Class) && other <= Increase::Internal::Type::IOLike + def self.==(other) = other.is_a?(Class) && other <= Increase::Internal::Type::FileInput class << self # @api private diff --git a/lib/increase/internal/util.rb b/lib/increase/internal/util.rb index b3e863fab..0fdf39bef 100644 --- a/lib/increase/internal/util.rb +++ b/lib/increase/internal/util.rb @@ -348,27 +348,6 @@ def normalized_headers(*headers) end end - # @api private - class SerializationAdapter - # @return [Pathname, IO] - attr_reader :inner - - # @param a [Object] - # - # @return [String] - def to_json(*a) = (inner.is_a?(IO) ? inner.read : inner.read(binmode: true)).to_json(*a) - - # @param a [Object] - # - # @return [String] - def to_yaml(*a) = (inner.is_a?(IO) ? inner.read : inner.read(binmode: true)).to_yaml(*a) - - # @api private - # - # @param inner [Pathname, IO] - def initialize(inner) = @inner = inner - end - # @api private # # An adapter that satisfies the IO interface required by `::IO.copy_stream` @@ -480,42 +459,35 @@ class << self # @api private # # @param y [Enumerator::Yielder] - # @param boundary [String] - # @param key [Symbol, String] # @param val [Object] # @param closing [Array] - private def write_multipart_chunk(y, boundary:, key:, val:, closing:) - val = val.inner if val.is_a?(Increase::Internal::Util::SerializationAdapter) + # @param content_type [String, nil] + private def write_multipart_content(y, val:, closing:, content_type: nil) + content_type ||= "application/octet-stream" - y << "--#{boundary}\r\n" - y << "Content-Disposition: form-data" - unless key.nil? - name = ERB::Util.url_encode(key.to_s) - y << "; name=\"#{name}\"" - end - case val - in Pathname | IO - filename = ERB::Util.url_encode(File.basename(val.to_path)) - y << "; filename=\"#{filename}\"" - else - end - y << "\r\n" case val + in Increase::FilePart + return write_multipart_content( + y, + val: val.content, + closing: closing, + content_type: val.content_type + ) in Pathname - y << "Content-Type: application/octet-stream\r\n\r\n" + y << "Content-Type: #{content_type}\r\n\r\n" io = val.open(binmode: true) closing << io.method(:close) IO.copy_stream(io, y) in IO - y << "Content-Type: application/octet-stream\r\n\r\n" + y << "Content-Type: #{content_type}\r\n\r\n" IO.copy_stream(val, y) in StringIO - y << "Content-Type: application/octet-stream\r\n\r\n" + y << "Content-Type: #{content_type}\r\n\r\n" y << val.string in String - y << "Content-Type: application/octet-stream\r\n\r\n" + y << "Content-Type: #{content_type}\r\n\r\n" y << val.to_s - in _ if primitive?(val) + in -> { primitive?(_1) } y << "Content-Type: text/plain\r\n\r\n" y << val.to_s else @@ -525,6 +497,36 @@ class << self y << "\r\n" end + # @api private + # + # @param y [Enumerator::Yielder] + # @param boundary [String] + # @param key [Symbol, String] + # @param val [Object] + # @param closing [Array] + private def write_multipart_chunk(y, boundary:, key:, val:, closing:) + y << "--#{boundary}\r\n" + y << "Content-Disposition: form-data" + + unless key.nil? + name = ERB::Util.url_encode(key.to_s) + y << "; name=\"#{name}\"" + end + + case val + in Increase::FilePart unless val.filename.nil? + filename = ERB::Util.url_encode(val.filename) + y << "; filename=\"#{filename}\"" + in Pathname | IO + filename = ERB::Util.url_encode(File.basename(val.to_path)) + y << "; filename=\"#{filename}\"" + else + end + y << "\r\n" + + write_multipart_content(y, val: val, closing: closing) + end + # @api private # # @param body [Object] @@ -565,14 +567,12 @@ class << self # @return [Object] def encode_content(headers, body) content_type = headers["content-type"] - body = body.inner if body.is_a?(Increase::Internal::Util::SerializationAdapter) - case [content_type, body] in [Increase::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }] [headers, JSON.fast_generate(body)] - in [Increase::Internal::Util::JSONL_CONTENT, Enumerable] unless body.is_a?(StringIO) || body.is_a?(IO) + in [Increase::Internal::Util::JSONL_CONTENT, Enumerable] unless body.is_a?(Increase::Internal::Type::FileInput) [headers, body.lazy.map { JSON.fast_generate(_1) }] - in [%r{^multipart/form-data}, Hash | Pathname | StringIO | IO] + in [%r{^multipart/form-data}, Hash | Increase::Internal::Type::FileInput] boundary, strio = encode_multipart_streaming(body) headers = {**headers, "content-type" => "#{content_type}; boundary=#{boundary}"} [headers, strio] @@ -580,6 +580,8 @@ def encode_content(headers, body) [headers, body.to_s] in [_, StringIO] [headers, body.string] + in [_, Increase::FilePart] + [headers, body.content] else [headers, body] end diff --git a/lib/increase/models/file_create_params.rb b/lib/increase/models/file_create_params.rb index 4f80030a8..6570bea52 100644 --- a/lib/increase/models/file_create_params.rb +++ b/lib/increase/models/file_create_params.rb @@ -12,8 +12,8 @@ class FileCreateParams < Increase::Internal::Type::BaseModel # [RFC 7578](https://datatracker.ietf.org/doc/html/rfc7578) which defines file # transfers for the multipart/form-data protocol. # - # @return [Pathname, StringIO] - required :file, Increase::Internal::Type::IOLike + # @return [Pathname, StringIO, IO, Increase::FilePart] + required :file, Increase::Internal::Type::FileInput # @!attribute purpose # What the File will be used for in Increase's systems. @@ -31,7 +31,7 @@ class FileCreateParams < Increase::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Increase::Models::FileCreateParams} for more details. # - # @param file [Pathname, StringIO] The file contents. This should follow the specifications of [RFC 7578](https://d + # @param file [Pathname, StringIO, IO, Increase::FilePart] The file contents. This should follow the specifications of [RFC 7578](https://d # ... # # @param purpose [Symbol, Increase::Models::FileCreateParams::Purpose] What the File will be used for in Increase's systems. diff --git a/lib/increase/resources/files.rb b/lib/increase/resources/files.rb index ff439e8d7..1b2404590 100644 --- a/lib/increase/resources/files.rb +++ b/lib/increase/resources/files.rb @@ -12,7 +12,7 @@ class Files # # @overload create(file:, purpose:, description: nil, request_options: {}) # - # @param file [Pathname, StringIO] The file contents. This should follow the specifications of [RFC 7578](https://d + # @param file [Pathname, StringIO, IO, Increase::FilePart] The file contents. This should follow the specifications of [RFC 7578](https://d # ... # # @param purpose [Symbol, Increase::Models::FileCreateParams::Purpose] What the File will be used for in Increase's systems. diff --git a/rbi/lib/increase/file_part.rbi b/rbi/lib/increase/file_part.rbi new file mode 100644 index 000000000..44ab65d63 --- /dev/null +++ b/rbi/lib/increase/file_part.rbi @@ -0,0 +1,34 @@ +# typed: strong + +module Increase + class FilePart + sig { returns(T.any(Pathname, StringIO, IO, String)) } + attr_reader :content + + sig { returns(T.nilable(String)) } + attr_reader :content_type + + sig { returns(T.nilable(String)) } + attr_reader :filename + + # @api private + sig { returns(String) } + private def read; end + + sig { params(a: T.anything).returns(String) } + def to_json(*a); end + + sig { params(a: T.anything).returns(String) } + def to_yaml(*a); end + + sig do + params( + content: T.any(Pathname, StringIO, IO, String), + filename: T.nilable(String), + content_type: T.nilable(String) + ) + .returns(T.attached_class) + end + def self.new(content, filename: nil, content_type: nil); end + end +end diff --git a/rbi/lib/increase/internal/type/io_like.rbi b/rbi/lib/increase/internal/type/file_input.rbi similarity index 82% rename from rbi/lib/increase/internal/type/io_like.rbi rename to rbi/lib/increase/internal/type/file_input.rbi index 5afc5243f..30f4cc6a9 100644 --- a/rbi/lib/increase/internal/type/io_like.rbi +++ b/rbi/lib/increase/internal/type/file_input.rbi @@ -5,8 +5,12 @@ module Increase module Type # @api private # - # Either `Pathname` or `StringIO`. - class IOLike + # Either `Pathname` or `StringIO`, or `IO`, or + # `Increase::Internal::Type::FileInput`. + # + # Note: when `IO` is used, all retries are disabled, since many IO` streams are + # not rewindable. + class FileInput extend Increase::Internal::Type::Converter abstract! diff --git a/rbi/lib/increase/internal/util.rbi b/rbi/lib/increase/internal/util.rbi index ad5e1b3df..b39ec4fe1 100644 --- a/rbi/lib/increase/internal/util.rbi +++ b/rbi/lib/increase/internal/util.rbi @@ -140,22 +140,6 @@ module Increase def normalized_headers(*headers); end end - # @api private - class SerializationAdapter - sig { returns(T.any(Pathname, IO)) } - attr_reader :inner - - sig { params(a: T.anything).returns(String) } - def to_json(*a); end - - sig { params(a: T.anything).returns(String) } - def to_yaml(*a); end - - # @api private - sig { params(inner: T.any(Pathname, IO)).returns(T.attached_class) } - def self.new(inner); end - end - # @api private # # An adapter that satisfies the IO interface required by `::IO.copy_stream` @@ -196,6 +180,18 @@ module Increase JSONL_CONTENT = T.let(%r{^application/(?:x-)?jsonl}, Regexp) class << self + # @api private + sig do + params( + y: Enumerator::Yielder, + val: T.anything, + closing: T::Array[T.proc.void], + content_type: T.nilable(String) + ) + .void + end + private def write_multipart_content(y, val:, closing:, content_type: nil); end + # @api private sig do params( diff --git a/rbi/lib/increase/models/file_create_params.rbi b/rbi/lib/increase/models/file_create_params.rbi index 1994255ea..9798436b6 100644 --- a/rbi/lib/increase/models/file_create_params.rbi +++ b/rbi/lib/increase/models/file_create_params.rbi @@ -9,7 +9,7 @@ module Increase # The file contents. This should follow the specifications of # [RFC 7578](https://datatracker.ietf.org/doc/html/rfc7578) which defines file # transfers for the multipart/form-data protocol. - sig { returns(T.any(Pathname, StringIO)) } + sig { returns(T.any(Pathname, StringIO, IO, Increase::FilePart)) } attr_accessor :file # What the File will be used for in Increase's systems. @@ -25,7 +25,7 @@ module Increase sig do params( - file: T.any(Pathname, StringIO), + file: T.any(Pathname, StringIO, IO, Increase::FilePart), purpose: Increase::Models::FileCreateParams::Purpose::OrSymbol, description: String, request_options: T.any(Increase::RequestOptions, Increase::Internal::AnyHash) @@ -47,7 +47,7 @@ module Increase override .returns( { - file: T.any(Pathname, StringIO), + file: T.any(Pathname, StringIO, IO, Increase::FilePart), purpose: Increase::Models::FileCreateParams::Purpose::OrSymbol, description: String, request_options: Increase::RequestOptions diff --git a/rbi/lib/increase/resources/files.rbi b/rbi/lib/increase/resources/files.rbi index 0b43fa54a..ee7c09abf 100644 --- a/rbi/lib/increase/resources/files.rbi +++ b/rbi/lib/increase/resources/files.rbi @@ -8,7 +8,7 @@ module Increase # upload, as well as the parameters for creating a file. sig do params( - file: T.any(Pathname, StringIO), + file: T.any(Pathname, StringIO, IO, Increase::FilePart), purpose: Increase::Models::FileCreateParams::Purpose::OrSymbol, description: String, request_options: T.nilable(T.any(Increase::RequestOptions, Increase::Internal::AnyHash)) diff --git a/sig/increase/file_part.rbs b/sig/increase/file_part.rbs new file mode 100644 index 000000000..a6470d2c4 --- /dev/null +++ b/sig/increase/file_part.rbs @@ -0,0 +1,21 @@ +module Increase + class FilePart + attr_reader content: Pathname | StringIO | IO | String + + attr_reader content_type: String? + + attr_reader filename: String? + + private def read: -> String + + def to_json: (*top a) -> String + + def to_yaml: (*top a) -> String + + def initialize: ( + Pathname | StringIO | IO | String content, + ?filename: String?, + ?content_type: String? + ) -> void + end +end diff --git a/sig/increase/internal/type/io_like.rbs b/sig/increase/internal/type/file_input.rbs similarity index 96% rename from sig/increase/internal/type/io_like.rbs rename to sig/increase/internal/type/file_input.rbs index 4a53f1d01..6db29dce8 100644 --- a/sig/increase/internal/type/io_like.rbs +++ b/sig/increase/internal/type/file_input.rbs @@ -1,7 +1,7 @@ module Increase module Internal module Type - class IOLike + class FileInput extend Increase::Internal::Type::Converter def self.===: (top other) -> bool diff --git a/sig/increase/internal/util.rbs b/sig/increase/internal/util.rbs index f9e9d3ed8..ea8c86a42 100644 --- a/sig/increase/internal/util.rbs +++ b/sig/increase/internal/util.rbs @@ -73,16 +73,6 @@ module Increase | ::Array[(String | Integer)?])?] headers ) -> ::Hash[String, String] - class SerializationAdapter - attr_reader inner: Pathname | IO - - def to_json: (*top a) -> String - - def to_yaml: (*top a) -> String - - def initialize: (Pathname | IO inner) -> void - end - class ReadIOAdapter def close?: -> bool? @@ -106,6 +96,13 @@ module Increase JSON_CONTENT: Regexp JSONL_CONTENT: Regexp + def self?.write_multipart_content: ( + Enumerator::Yielder y, + val: top, + closing: ::Array[^-> void], + ?content_type: String? + ) -> void + def self?.write_multipart_chunk: ( Enumerator::Yielder y, boundary: String, diff --git a/sig/increase/models/file_create_params.rbs b/sig/increase/models/file_create_params.rbs index bc450649a..0a0227671 100644 --- a/sig/increase/models/file_create_params.rbs +++ b/sig/increase/models/file_create_params.rbs @@ -2,7 +2,7 @@ module Increase module Models type file_create_params = { - file: (Pathname | StringIO), + file: (Pathname | StringIO | IO | Increase::FilePart), purpose: Increase::Models::FileCreateParams::purpose, description: String } @@ -12,7 +12,7 @@ module Increase extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - attr_accessor file: Pathname | StringIO + attr_accessor file: Pathname | StringIO | IO | Increase::FilePart attr_accessor purpose: Increase::Models::FileCreateParams::purpose @@ -21,7 +21,7 @@ module Increase def description=: (String) -> String def initialize: ( - file: Pathname | StringIO, + file: Pathname | StringIO | IO | Increase::FilePart, purpose: Increase::Models::FileCreateParams::purpose, ?description: String, ?request_options: Increase::request_opts diff --git a/sig/increase/resources/files.rbs b/sig/increase/resources/files.rbs index 18447e39c..fd5728294 100644 --- a/sig/increase/resources/files.rbs +++ b/sig/increase/resources/files.rbs @@ -2,7 +2,7 @@ module Increase module Resources class Files def create: ( - file: Pathname | StringIO, + file: Pathname | StringIO | IO | Increase::FilePart, purpose: Increase::Models::FileCreateParams::purpose, ?description: String, ?request_options: Increase::request_opts diff --git a/test/increase/internal/type/base_model_test.rb b/test/increase/internal/type/base_model_test.rb index 1dcc64101..5adab9f8e 100644 --- a/test/increase/internal/type/base_model_test.rb +++ b/test/increase/internal/type/base_model_test.rb @@ -94,7 +94,7 @@ def test_dump [:a, :b] => :b, [:a, "a"] => "a", [String, StringIO.new("one")] => "one", - [String, Pathname(__FILE__)] => Increase::Internal::Util::SerializationAdapter + [String, Pathname(__FILE__)] => Increase::FilePart } cases.each do diff --git a/test/increase/internal/util_test.rb b/test/increase/internal/util_test.rb index cb585d2c1..8d21ad88f 100644 --- a/test/increase/internal/util_test.rb +++ b/test/increase/internal/util_test.rb @@ -200,8 +200,12 @@ def test_file_encode file = Pathname(__FILE__) headers = {"content-type" => "multipart/form-data"} cases = { + "abc" => "abc", StringIO.new("abc") => "abc", - file => /^class Increase/ + Increase::FilePart.new("abc") => "abc", + Increase::FilePart.new(StringIO.new("abc")) => "abc", + file => /^class Increase/, + Increase::FilePart.new(file) => /^class Increase/ } cases.each do |body, val| encoded = Increase::Internal::Util.encode_content(headers, body) @@ -219,7 +223,13 @@ def test_hash_encode {a: 2, b: nil} => {"a" => "2", "b" => "null"}, {a: 2, b: [1, 2, 3]} => {"a" => "2", "b" => "1"}, {strio: StringIO.new("a")} => {"strio" => "a"}, - {pathname: Pathname(__FILE__)} => {"pathname" => -> { _1.read in /^class Increase/ }} + {strio: Increase::FilePart.new("a")} => {"strio" => "a"}, + {pathname: Pathname(__FILE__)} => {"pathname" => -> { _1.read in /^class Increase/ }}, + {pathname: Increase::FilePart.new(Pathname(__FILE__))} => { + "pathname" => -> { + _1.read in /^class Increase/ + } + } } cases.each do |body, testcase| encoded = Increase::Internal::Util.encode_content(headers, body) From e87d2db29255f5f9372f82a2e9ecd5da02cc2ca6 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 24 Apr 2025 19:46:35 +0000 Subject: [PATCH 10/16] chore: consistently use string in examples, even for enums --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4ef4d7fb9..ff86135e8 100644 --- a/README.md +++ b/README.md @@ -81,11 +81,11 @@ Request parameters that correspond to file uploads can be passed as `StringIO`, require "pathname" # using `Pathname`, the file will be lazily read, without reading everything in to memory -file = increase.files.create(file: Pathname("my/file.txt"), purpose: :check_image_front) +file = increase.files.create(file: Pathname("my/file.txt"), purpose: "check_image_front") file = File.read("my/file.txt") # using `StringIO`, useful if you already have the data in memory -file = increase.files.create(file: StringIO.new(file), purpose: :check_image_front) +file = increase.files.create(file: StringIO.new(file), purpose: "check_image_front") puts(file.id) ``` From b3f18d4820ff1d2a1f3b4b551f3abd0530a5b77c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 24 Apr 2025 23:04:10 +0000 Subject: [PATCH 11/16] chore(internal): improve response envelope unwrap functionality --- .../internal/transport/base_client.rb | 4 ++-- lib/increase/internal/util.rb | 23 ++++++++++--------- .../internal/transport/base_client.rbi | 18 +++++++++++++-- rbi/lib/increase/internal/util.rbi | 12 +++++++--- .../internal/transport/base_client.rbs | 10 ++++++-- sig/increase/internal/util.rbs | 6 +++-- test/increase/internal/util_test.rb | 7 +++--- 7 files changed, 55 insertions(+), 25 deletions(-) diff --git a/lib/increase/internal/transport/base_client.rb b/lib/increase/internal/transport/base_client.rb index ebe5c3941..5f3487e43 100644 --- a/lib/increase/internal/transport/base_client.rb +++ b/lib/increase/internal/transport/base_client.rb @@ -214,7 +214,7 @@ def initialize( # # @option req [Object, nil] :body # - # @option req [Symbol, nil] :unwrap + # @option req [Symbol, Integer, Array, Proc, nil] :unwrap # # @option req [Class, nil] :page # @@ -415,7 +415,7 @@ def initialize( # # @param body [Object, nil] # - # @param unwrap [Symbol, nil] + # @param unwrap [Symbol, Integer, Array, Proc, nil] # # @param page [Class, nil] # diff --git a/lib/increase/internal/util.rb b/lib/increase/internal/util.rb index 0fdf39bef..c09ea9b5d 100644 --- a/lib/increase/internal/util.rb +++ b/lib/increase/internal/util.rb @@ -175,18 +175,17 @@ def deep_merge(*values, sentinel: nil, concat: false) # @api private # # @param data [Hash{Symbol=>Object}, Array, Object] - # @param pick [Symbol, Integer, Array, nil] - # @param sentinel [Object, nil] + # @param pick [Symbol, Integer, Array, Proc, nil] # @param blk [Proc, nil] # # @return [Object, nil] - def dig(data, pick, sentinel = nil, &blk) - case [data, pick, blk] - in [_, nil, nil] + def dig(data, pick, &blk) + case [data, pick] + in [_, nil] data - in [Hash, Symbol, _] | [Array, Integer, _] - blk.nil? ? data.fetch(pick, sentinel) : data.fetch(pick, &blk) - in [Hash | Array, Array, _] + in [Hash, Symbol] | [Array, Integer] + data.fetch(pick) { blk&.call } + in [Hash | Array, Array] pick.reduce(data) do |acc, key| case acc in Hash if acc.key?(key) @@ -194,11 +193,13 @@ def dig(data, pick, sentinel = nil, &blk) in Array if key.is_a?(Integer) && key < acc.length acc[key] else - return blk.nil? ? sentinel : blk.call + return blk&.call end end - in _ - blk.nil? ? sentinel : blk.call + in [_, Proc] + pick.call(data) + else + blk&.call end end end diff --git a/rbi/lib/increase/internal/transport/base_client.rbi b/rbi/lib/increase/internal/transport/base_client.rbi index 16685f27c..ac13db0fd 100644 --- a/rbi/lib/increase/internal/transport/base_client.rbi +++ b/rbi/lib/increase/internal/transport/base_client.rbi @@ -24,7 +24,14 @@ module Increase )] ), body: T.nilable(T.anything), - unwrap: T.nilable(Symbol), + unwrap: T.nilable( + T.any( + Symbol, + Integer, + T::Array[T.any(Symbol, Integer)], + T.proc.params(arg0: T.anything).returns(T.anything) + ) + ), page: T.nilable(T::Class[Increase::Internal::Type::BasePage[Increase::Internal::Type::BaseModel]]), stream: T.nilable(T::Class[T.anything]), model: T.nilable(Increase::Internal::Type::Converter::Input), @@ -170,7 +177,14 @@ module Increase )] ), body: T.nilable(T.anything), - unwrap: T.nilable(Symbol), + unwrap: T.nilable( + T.any( + Symbol, + Integer, + T::Array[T.any(Symbol, Integer)], + T.proc.params(arg0: T.anything).returns(T.anything) + ) + ), page: T.nilable(T::Class[Increase::Internal::Type::BasePage[Increase::Internal::Type::BaseModel]]), stream: T.nilable(T::Class[T.anything]), model: T.nilable(Increase::Internal::Type::Converter::Input), diff --git a/rbi/lib/increase/internal/util.rbi b/rbi/lib/increase/internal/util.rbi index b39ec4fe1..060e9c306 100644 --- a/rbi/lib/increase/internal/util.rbi +++ b/rbi/lib/increase/internal/util.rbi @@ -68,13 +68,19 @@ module Increase sig do params( data: T.any(Increase::Internal::AnyHash, T::Array[T.anything], T.anything), - pick: T.nilable(T.any(Symbol, Integer, T::Array[T.any(Symbol, Integer)])), - sentinel: T.nilable(T.anything), + pick: T.nilable( + T.any( + Symbol, + Integer, + T::Array[T.any(Symbol, Integer)], + T.proc.params(arg0: T.anything).returns(T.anything) + ) + ), blk: T.nilable(T.proc.returns(T.anything)) ) .returns(T.nilable(T.anything)) end - def dig(data, pick, sentinel = nil, &blk); end + def dig(data, pick, &blk); end end class << self diff --git a/sig/increase/internal/transport/base_client.rbs b/sig/increase/internal/transport/base_client.rbs index c190123d1..ef890770b 100644 --- a/sig/increase/internal/transport/base_client.rbs +++ b/sig/increase/internal/transport/base_client.rbs @@ -11,7 +11,10 @@ module Increase | Integer | ::Array[(String | Integer)?])?]?, body: top?, - unwrap: Symbol?, + unwrap: (Symbol + | Integer + | ::Array[(Symbol | Integer)] + | (^(top arg0) -> top))?, page: Class?, stream: Class?, model: Increase::Internal::Type::Converter::input?, @@ -96,7 +99,10 @@ module Increase | Integer | ::Array[(String | Integer)?])?]?, ?body: top?, - ?unwrap: Symbol?, + ?unwrap: (Symbol + | Integer + | ::Array[(Symbol | Integer)] + | (^(top arg0) -> top))?, ?page: Class?, ?stream: Class?, ?model: Increase::Internal::Type::Converter::input?, diff --git a/sig/increase/internal/util.rbs b/sig/increase/internal/util.rbs index ea8c86a42..fadbb6d86 100644 --- a/sig/increase/internal/util.rbs +++ b/sig/increase/internal/util.rbs @@ -29,8 +29,10 @@ module Increase def self?.dig: ( ::Hash[Symbol, top] | ::Array[top] | top data, - (Symbol | Integer | ::Array[(Symbol | Integer)])? pick, - ?top? sentinel + (Symbol + | Integer + | ::Array[(Symbol | Integer)] + | (^(top arg0) -> top))? pick ) { -> top? } -> top? diff --git a/test/increase/internal/util_test.rb b/test/increase/internal/util_test.rb index 8d21ad88f..9ae247e67 100644 --- a/test/increase/internal/util_test.rb +++ b/test/increase/internal/util_test.rb @@ -87,8 +87,9 @@ def test_dig Increase::Internal::Util.dig([], 1.0) => nil Increase::Internal::Util.dig(Object, 1) => nil - Increase::Internal::Util.dig([], 1.0, 2) => 2 Increase::Internal::Util.dig([], 1.0) { 2 } => 2 + Increase::Internal::Util.dig([], ->(_) { 2 }) => 2 + Increase::Internal::Util.dig([1], -> { _1 in [1] }) => true end end end @@ -165,9 +166,9 @@ def test_json_content "application/vnd.github.v3+json" => true, "application/vnd.api+json" => true } - cases.each do |header, _verdict| + cases.each do |header, verdict| assert_pattern do - Increase::Internal::Util::JSON_CONTENT.match?(header) => verdict + Increase::Internal::Util::JSON_CONTENT.match?(header) => ^verdict end end end From 8127e3dc622ab4cc511986b41f6b09f2826ecf52 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 25 Apr 2025 00:39:25 +0000 Subject: [PATCH 12/16] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index ef1d3d99d..07e53313c 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 194 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-ea1cbc57d35054776bb4114a558a9a752b9402c1c35e9ae8b3110b829621f68f.yml -openapi_spec_hash: 2d965f5c4e7347b2a9b916e13d7f8433 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-bcb90ff3968f198d1d36120f0abb49b80b4a3f3acbc1d88af9d9c8de94c10c32.yml +openapi_spec_hash: f649e94adde0f37d7f211b3a4e9de28b config_hash: 6ae27f935d24d38237894dd4fd6bd749 From c0a0fb79e9b89a36d3dfbcb0dac08919e4eea8c4 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 25 Apr 2025 16:33:56 +0000 Subject: [PATCH 13/16] fix: ensure gem release is unaffected by renaming --- Rakefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Rakefile b/Rakefile index ca9453d6c..2e5368f21 100644 --- a/Rakefile +++ b/Rakefile @@ -135,5 +135,5 @@ end desc("Release ruby gem") multitask(release: [:"build:gem"]) do - sh(*%w[gem push], *FileList["increase-*.gem"]) + sh(*%w[gem push], *FileList["*.gem"]) end From 666183d2e524186260dcca5505a794c545840183 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 25 Apr 2025 17:00:10 +0000 Subject: [PATCH 14/16] feat(api): api update --- .stats.yml | 4 +-- .../models/check_transfer_create_params.rb | 26 ++++++++-------- lib/increase/resources/check_transfers.rb | 5 +++- .../models/check_transfer_create_params.rbi | 30 +++++++++---------- .../increase/resources/check_transfers.rbi | 5 ++++ .../models/check_transfer_create_params.rbs | 12 ++++---- sig/increase/resources/check_transfers.rbs | 1 + 7 files changed, 46 insertions(+), 37 deletions(-) diff --git a/.stats.yml b/.stats.yml index 07e53313c..fc9313a0c 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 194 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-bcb90ff3968f198d1d36120f0abb49b80b4a3f3acbc1d88af9d9c8de94c10c32.yml -openapi_spec_hash: f649e94adde0f37d7f211b3a4e9de28b +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-27dc46bb403d49303c0a407c619e63dfcb1be14d16536390f0b4a8dd3b3d8e38.yml +openapi_spec_hash: 679632c6d91d4a35625ce94adc2c6ea0 config_hash: 6ae27f935d24d38237894dd4fd6bd749 diff --git a/lib/increase/models/check_transfer_create_params.rb b/lib/increase/models/check_transfer_create_params.rb index aab2eaf13..6537ee71b 100644 --- a/lib/increase/models/check_transfer_create_params.rb +++ b/lib/increase/models/check_transfer_create_params.rb @@ -32,6 +32,14 @@ class CheckTransferCreateParams < Increase::Internal::Type::BaseModel # @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 @@ -54,7 +62,7 @@ class CheckTransferCreateParams < Increase::Internal::Type::BaseModel # @return [Increase::Models::CheckTransferCreateParams::ThirdParty, nil] optional :third_party, -> { Increase::Models::CheckTransferCreateParams::ThirdParty } - # @!method initialize(account_id:, amount:, fulfillment_method:, source_account_number_id:, physical_check: nil, require_approval: nil, third_party: nil, request_options: {}) + # @!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. # @@ -67,6 +75,9 @@ class CheckTransferCreateParams < Increase::Internal::Type::BaseModel # @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 # ... # @@ -119,14 +130,6 @@ class PhysicalCheck < Increase::Internal::Type::BaseModel # @return [String, nil] optional :attachment_file_id, String - # @!attribute check_number - # The check number Increase should print on 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 note # The descriptor that will be printed on the letter included with the check. # @@ -156,7 +159,7 @@ class PhysicalCheck < Increase::Internal::Type::BaseModel # @return [String, nil] optional :signature_text, String - # @!method initialize(mailing_address:, memo:, recipient_name:, attachment_file_id: nil, check_number: nil, note: nil, return_address: nil, shipping_method: nil, signature_text: nil) + # @!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. # @@ -173,9 +176,6 @@ class PhysicalCheck < Increase::Internal::Type::BaseModel # @param attachment_file_id [String] The ID of a File to be attached to the check. This must have `purpose: check_att # ... # - # @param check_number [String] The check number Increase should print on the check. This should not contain lea - # ... - # # @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 diff --git a/lib/increase/resources/check_transfers.rb b/lib/increase/resources/check_transfers.rb index c59d45d29..1737e662b 100644 --- a/lib/increase/resources/check_transfers.rb +++ b/lib/increase/resources/check_transfers.rb @@ -8,7 +8,7 @@ class CheckTransfers # # Create a Check Transfer # - # @overload create(account_id:, amount:, fulfillment_method:, source_account_number_id:, physical_check: nil, require_approval: nil, third_party: nil, request_options: {}) + # @overload create(account_id:, amount:, fulfillment_method:, source_account_number_id:, check_number: nil, physical_check: nil, require_approval: nil, third_party: nil, request_options: {}) # # @param account_id [String] The identifier for the account that will send the transfer. # @@ -19,6 +19,9 @@ class CheckTransfers # @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 # ... # diff --git a/rbi/lib/increase/models/check_transfer_create_params.rbi b/rbi/lib/increase/models/check_transfer_create_params.rbi index e1b18c19b..dae5651d1 100644 --- a/rbi/lib/increase/models/check_transfer_create_params.rbi +++ b/rbi/lib/increase/models/check_transfer_create_params.rbi @@ -23,6 +23,15 @@ module Increase sig { returns(String) } attr_accessor :source_account_number_id + # 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. + sig { returns(T.nilable(String)) } + attr_reader :check_number + + sig { params(check_number: String).void } + attr_writer :check_number + # 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. @@ -64,6 +73,7 @@ module Increase amount: Integer, fulfillment_method: Increase::Models::CheckTransferCreateParams::FulfillmentMethod::OrSymbol, source_account_number_id: String, + check_number: String, physical_check: T.any(Increase::Models::CheckTransferCreateParams::PhysicalCheck, Increase::Internal::AnyHash), require_approval: T::Boolean, third_party: T.any(Increase::Models::CheckTransferCreateParams::ThirdParty, Increase::Internal::AnyHash), @@ -81,6 +91,10 @@ module Increase # The identifier of the Account Number from which to send the transfer and print # on the check. source_account_number_id:, + # 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. + check_number: nil, # 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. @@ -101,6 +115,7 @@ module Increase amount: Integer, fulfillment_method: Increase::Models::CheckTransferCreateParams::FulfillmentMethod::OrSymbol, source_account_number_id: String, + check_number: String, physical_check: Increase::Models::CheckTransferCreateParams::PhysicalCheck, require_approval: T::Boolean, third_party: Increase::Models::CheckTransferCreateParams::ThirdParty, @@ -163,15 +178,6 @@ module Increase sig { params(attachment_file_id: String).void } attr_writer :attachment_file_id - # The check number Increase should print on 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. - sig { returns(T.nilable(String)) } - attr_reader :check_number - - sig { params(check_number: String).void } - attr_writer :check_number - # The descriptor that will be printed on the letter included with the check. sig { returns(T.nilable(String)) } attr_reader :note @@ -229,7 +235,6 @@ module Increase memo: String, recipient_name: String, attachment_file_id: String, - check_number: String, note: String, return_address: T.any( Increase::Models::CheckTransferCreateParams::PhysicalCheck::ReturnAddress, @@ -251,10 +256,6 @@ module Increase # `purpose: check_attachment`. For details on pricing and restrictions, see # https://increase.com/documentation/originating-checks#printing-checks . attachment_file_id: nil, - # The check number Increase should print on 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. - check_number: nil, # The descriptor that will be printed on the letter included with the check. note: nil, # The return address to be printed on the check. If omitted this will default to @@ -276,7 +277,6 @@ module Increase memo: String, recipient_name: String, attachment_file_id: String, - check_number: String, note: String, return_address: Increase::Models::CheckTransferCreateParams::PhysicalCheck::ReturnAddress, shipping_method: Increase::Models::CheckTransferCreateParams::PhysicalCheck::ShippingMethod::OrSymbol, diff --git a/rbi/lib/increase/resources/check_transfers.rbi b/rbi/lib/increase/resources/check_transfers.rbi index 9d28f0e26..00d06d430 100644 --- a/rbi/lib/increase/resources/check_transfers.rbi +++ b/rbi/lib/increase/resources/check_transfers.rbi @@ -10,6 +10,7 @@ module Increase amount: Integer, fulfillment_method: Increase::Models::CheckTransferCreateParams::FulfillmentMethod::OrSymbol, source_account_number_id: String, + check_number: String, physical_check: T.any(Increase::Models::CheckTransferCreateParams::PhysicalCheck, Increase::Internal::AnyHash), require_approval: T::Boolean, third_party: T.any(Increase::Models::CheckTransferCreateParams::ThirdParty, Increase::Internal::AnyHash), @@ -27,6 +28,10 @@ module Increase # The identifier of the Account Number from which to send the transfer and print # on the check. source_account_number_id:, + # 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. + check_number: nil, # 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. diff --git a/sig/increase/models/check_transfer_create_params.rbs b/sig/increase/models/check_transfer_create_params.rbs index 2f81db72e..93927b081 100644 --- a/sig/increase/models/check_transfer_create_params.rbs +++ b/sig/increase/models/check_transfer_create_params.rbs @@ -6,6 +6,7 @@ module Increase amount: Integer, fulfillment_method: Increase::Models::CheckTransferCreateParams::fulfillment_method, source_account_number_id: String, + check_number: String, physical_check: Increase::Models::CheckTransferCreateParams::PhysicalCheck, require_approval: bool, third_party: Increase::Models::CheckTransferCreateParams::ThirdParty @@ -24,6 +25,10 @@ module Increase attr_accessor source_account_number_id: String + attr_reader check_number: String? + + def check_number=: (String) -> String + attr_reader physical_check: Increase::Models::CheckTransferCreateParams::PhysicalCheck? def physical_check=: ( @@ -45,6 +50,7 @@ module Increase amount: Integer, fulfillment_method: Increase::Models::CheckTransferCreateParams::fulfillment_method, source_account_number_id: String, + ?check_number: String, ?physical_check: Increase::Models::CheckTransferCreateParams::PhysicalCheck, ?require_approval: bool, ?third_party: Increase::Models::CheckTransferCreateParams::ThirdParty, @@ -73,7 +79,6 @@ module Increase memo: String, recipient_name: String, attachment_file_id: String, - check_number: String, note: String, return_address: Increase::Models::CheckTransferCreateParams::PhysicalCheck::ReturnAddress, shipping_method: Increase::Models::CheckTransferCreateParams::PhysicalCheck::shipping_method, @@ -91,10 +96,6 @@ module Increase def attachment_file_id=: (String) -> String - attr_reader check_number: String? - - def check_number=: (String) -> String - attr_reader note: String? def note=: (String) -> String @@ -120,7 +121,6 @@ module Increase memo: String, recipient_name: String, ?attachment_file_id: String, - ?check_number: String, ?note: String, ?return_address: Increase::Models::CheckTransferCreateParams::PhysicalCheck::ReturnAddress, ?shipping_method: Increase::Models::CheckTransferCreateParams::PhysicalCheck::shipping_method, diff --git a/sig/increase/resources/check_transfers.rbs b/sig/increase/resources/check_transfers.rbs index 42d898c3c..ea4114a12 100644 --- a/sig/increase/resources/check_transfers.rbs +++ b/sig/increase/resources/check_transfers.rbs @@ -6,6 +6,7 @@ module Increase amount: Integer, fulfillment_method: Increase::Models::CheckTransferCreateParams::fulfillment_method, source_account_number_id: String, + ?check_number: String, ?physical_check: Increase::Models::CheckTransferCreateParams::PhysicalCheck, ?require_approval: bool, ?third_party: Increase::Models::CheckTransferCreateParams::ThirdParty, From a080024a471808e2fb1cf1eade231d93c652e411 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 25 Apr 2025 21:07:24 +0000 Subject: [PATCH 15/16] fix: make a typo for `FilePart.content` --- lib/increase/file_part.rb | 10 +++---- lib/increase/internal/type/converter.rb | 3 +++ lib/increase/internal/type/file_input.rb | 33 ++++++++++++++++-------- test/increase/file_part_test.rb | 12 +++++++++ 4 files changed, 42 insertions(+), 16 deletions(-) create mode 100644 test/increase/file_part_test.rb diff --git a/lib/increase/file_part.rb b/lib/increase/file_part.rb index 1f975f603..7b5f0dc22 100644 --- a/lib/increase/file_part.rb +++ b/lib/increase/file_part.rb @@ -15,15 +15,15 @@ class FilePart # # @return [String] private def read - case contents + case content in Pathname - contents.read(binmode: true) + content.read(binmode: true) in StringIO - contents.string + content.string in IO - contents.read + content.read in String - contents + content end end diff --git a/lib/increase/internal/type/converter.rb b/lib/increase/internal/type/converter.rb index 4447e2b93..c087a4efa 100644 --- a/lib/increase/internal/type/converter.rb +++ b/lib/increase/internal/type/converter.rb @@ -44,6 +44,9 @@ def dump(value, state:) in Pathname | IO state[:can_retry] = false if value.is_a?(IO) Increase::FilePart.new(value) + in Increase::FilePart + state[:can_retry] = false if value.content.is_a?(IO) + value else value end diff --git a/lib/increase/internal/type/file_input.rb b/lib/increase/internal/type/file_input.rb index 88270c509..b318d21a1 100644 --- a/lib/increase/internal/type/file_input.rb +++ b/lib/increase/internal/type/file_input.rb @@ -67,17 +67,28 @@ def coerce(value, state:) end end - # @!parse - # # @api private - # # - # # @param value [Pathname, StringIO, IO, String, Object] - # # - # # @param state [Hash{Symbol=>Object}] . - # # - # # @option state [Boolean] :can_retry - # # - # # @return [Pathname, StringIO, IO, String, Object] - # def dump(value, state:) = super + # @api private + # + # @param value [Pathname, StringIO, IO, String, Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :can_retry + # + # @return [Pathname, StringIO, IO, String, Object] + def dump(value, state:) + # rubocop:disable Lint/DuplicateBranch + case value + in IO + state[:can_retry] = false + in Increase::FilePart if value.content.is_a?(IO) + state[:can_retry] = false + else + end + # rubocop:enable Lint/DuplicateBranch + + value + end end end end diff --git a/test/increase/file_part_test.rb b/test/increase/file_part_test.rb new file mode 100644 index 000000000..eb8155acf --- /dev/null +++ b/test/increase/file_part_test.rb @@ -0,0 +1,12 @@ +# frozen_string_literal: true + +require_relative "test_helper" + +class Increase::Test::FilePartTest < Minitest::Test + def test_to_json + text = "gray" + filepart = Increase::FilePart.new(StringIO.new(text)) + + assert_equal(text.to_json, filepart.to_json) + end +end From 498bc52eff7dbb80db97f519d760daa2a3d2263f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 25 Apr 2025 21:07:45 +0000 Subject: [PATCH 16/16] release: 0.1.0-alpha.12 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 29 +++++++++++++++++++++++++++++ Gemfile.lock | 2 +- README.md | 2 +- lib/increase/version.rb | 2 +- 5 files changed, 33 insertions(+), 4 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index ee49ac2dc..fd0ccba9b 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.1.0-alpha.11" + ".": "0.1.0-alpha.12" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index c5021dcb5..0db9116c1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,34 @@ # Changelog +## 0.1.0-alpha.12 (2025-04-25) + +Full Changelog: [v0.1.0-alpha.11...v0.1.0-alpha.12](https://github.com/Increase/increase-ruby/compare/v0.1.0-alpha.11...v0.1.0-alpha.12) + +### Features + +* **api:** api update ([666183d](https://github.com/Increase/increase-ruby/commit/666183d2e524186260dcca5505a794c545840183)) +* **api:** api update ([f7348dc](https://github.com/Increase/increase-ruby/commit/f7348dc4328a7e2111a67be09dc77843c83b2e49)) +* **api:** api update ([7d7ab72](https://github.com/Increase/increase-ruby/commit/7d7ab72a46faa7274855639846a130f2a9e0ad41)) +* support specifying content-type with FilePart class ([05afd72](https://github.com/Increase/increase-ruby/commit/05afd7274f7881cdef4bc4292d9c7eb8104f0c27)) +* support webmock for testing ([995c8ba](https://github.com/Increase/increase-ruby/commit/995c8baa67995d921ea02054f120e9bdaebe01ad)) + + +### Bug Fixes + +* ensure gem release is unaffected by renaming ([c0a0fb7](https://github.com/Increase/increase-ruby/commit/c0a0fb79e9b89a36d3dfbcb0dac08919e4eea8c4)) +* make a typo for `FilePart.content` ([a080024](https://github.com/Increase/increase-ruby/commit/a080024a471808e2fb1cf1eade231d93c652e411)) + + +### Chores + +* broadly detect json family of content-type headers ([6ce04be](https://github.com/Increase/increase-ruby/commit/6ce04be506ecb273342936ed47e4996cd2173fef)) +* **ci:** only use depot for staging repos ([0ab95d5](https://github.com/Increase/increase-ruby/commit/0ab95d54a80ef309144a61b51543bfb298f44f22)) +* **ci:** run on more branches and use depot runners ([81e1f3a](https://github.com/Increase/increase-ruby/commit/81e1f3ac48fe1e256ae0f203b902a1b3e87901f9)) +* consistently use string in examples, even for enums ([e87d2db](https://github.com/Increase/increase-ruby/commit/e87d2db29255f5f9372f82a2e9ecd5da02cc2ca6)) +* **internal:** codegen related update ([79b309d](https://github.com/Increase/increase-ruby/commit/79b309d21bf855bdd27c7822cf6735e83d3cb484)) +* **internal:** improve response envelope unwrap functionality ([b3f18d4](https://github.com/Increase/increase-ruby/commit/b3f18d4820ff1d2a1f3b4b551f3abd0530a5b77c)) +* show truncated parameter docs in yard ([294b347](https://github.com/Increase/increase-ruby/commit/294b3473dff35162a9f5e64552579261b1babed6)) + ## 0.1.0-alpha.11 (2025-04-21) Full Changelog: [v0.1.0-alpha.10...v0.1.0-alpha.11](https://github.com/Increase/increase-ruby/compare/v0.1.0-alpha.10...v0.1.0-alpha.11) diff --git a/Gemfile.lock b/Gemfile.lock index 344952aac..96a09384f 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - increase (0.1.0.pre.alpha.11) + increase (0.1.0.pre.alpha.12) connection_pool GEM diff --git a/README.md b/README.md index ff86135e8..7f8d952e5 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "increase", "~> 0.1.0.pre.alpha.11" +gem "increase", "~> 0.1.0.pre.alpha.12" ``` diff --git a/lib/increase/version.rb b/lib/increase/version.rb index 8b14b025b..e5496e6a0 100644 --- a/lib/increase/version.rb +++ b/lib/increase/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Increase - VERSION = "0.1.0.pre.alpha.11" + VERSION = "0.1.0.pre.alpha.12" end