Skip to content

feat(api): api update #549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
increase-releases wants to merge 1 commit into from
Closed

feat(api): api update #549

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .stats.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
configured_endpoints: 239
openapi_spec_hash: f8d2bbed3081c9ffc1547d28f89a8a34
openapi_spec_hash: b78c7cac48ab62be926da8d1cf128fe1
config_hash: 1ca082e374ef7000e2a5971e8da740e0
4 changes: 2 additions & 2 deletions lib/increase/models/ach_prenotification_create_params.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ class ACHPrenotificationCreateParams < Increase::Internal::Type::BaseModel
optional :individual_id, String

# @!attribute individual_name
# The name of therecipient. This value is informational and not verified by the
# The name of the recipient. This value is informational and not verified by the
# recipient's bank.
#
# @return [String, nil]
Expand Down Expand Up @@ -127,7 +127,7 @@ class ACHPrenotificationCreateParams < Increase::Internal::Type::BaseModel
# @param individual_id [String] Your identifier for the recipient.
#
# @param individual_name [String]
# The name of therecipient. This value is informational and not verified by the
# The name of the recipient. This value is informational and not verified by the
# recipient's bank.
#
# @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode]
Expand Down
4 changes: 2 additions & 2 deletions lib/increase/models/ach_transfer.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1497,7 +1497,7 @@ module Status
class Submission < Increase::Internal::Type::BaseModel
# @!attribute administrative_returns_expected_by
# The timestamp by which any administrative returns are expected to be received
# by. This follows the NACHA guidelines for return windows, which are: "In
# by. This follows the Nacha guidelines for return windows, which are: "In
# general, return entries must be received by the RDFI’s ACH Operator by its
# deposit deadline for the return entry to be made available to the ODFI no later
# than the opening of business on the second banking day following the Settlement
Expand Down Expand Up @@ -1558,7 +1558,7 @@ class Submission < Increase::Internal::Type::BaseModel
#
# @param administrative_returns_expected_by [Time]
# The timestamp by which any administrative returns are expected to be received
# by. This follows the NACHA guidelines for return windows, which are: "In
# by. This follows the Nacha guidelines for return windows, which are: "In
# general, return entries must be received by the RDFI’s ACH Operator by its
# deposit deadline for the return entry to be made available to the ODFI no later
# than the opening of business on the second banking day following the Settlement
Expand Down
25 changes: 1 addition & 24 deletions lib/increase/models/ach_transfer_create_params.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,13 +151,7 @@ class ACHTransferCreateParams < Increase::Internal::Type::BaseModel
optional :standard_entry_class_code,
enum: -> { Increase::ACHTransferCreateParams::StandardEntryClassCode }

# @!attribute transaction_timing
# The timing of the transaction.
#
# @return [Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming, nil]
optional :transaction_timing, enum: -> { Increase::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: {})
# @!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, request_options: {})
# @param account_id [String] The Increase identifier for the account that will send the transfer.
#
# @param amount [Integer]
Expand Down Expand Up @@ -245,9 +239,6 @@ class ACHTransferCreateParams < Increase::Internal::Type::BaseModel
# to use for the transfer. If not provided, the default is
# `corporate_credit_or_debit`.
#
# @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
Expand Down Expand Up @@ -487,20 +478,6 @@ module StandardEntryClassCode
# @!method self.values
# @return [Array<Symbol>]
end

# The timing of the transaction.
module TransactionTiming
extend Increase::Internal::Type::Enum

# A Transaction will be created immediately.
SYNCHRONOUS = :synchronous

# A Transaction will be created when the funds settle at the Federal Reserve.
ASYNCHRONOUS = :asynchronous

# @!method self.values
# @return [Array<Symbol>]
end
end
end
end
50 changes: 49 additions & 1 deletion lib/increase/models/balance_lookup.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,42 @@ class Loan < Increase::Internal::Type::BaseModel
# @return [Integer]
required :due_balance, Integer

# @!attribute due_fees
# The fees on the loan that are due and unpaid.
#
# @return [Integer, nil]
required :due_fees, Integer, nil?: true

# @!attribute due_interest
# The interest on the loan that is due and unpaid.
#
# @return [Integer, nil]
required :due_interest, Integer, nil?: true

# @!attribute due_principal
# The principal on the loan that is due and unpaid.
#
# @return [Integer, nil]
required :due_principal, Integer, nil?: true

# @!attribute not_due_fees
# The fees on the loan that are not yet due.
#
# @return [Integer, nil]
required :not_due_fees, Integer, nil?: true

# @!attribute not_due_interest
# The interest on the loan that is not yet due.
#
# @return [Integer, nil]
required :not_due_interest, Integer, nil?: true

# @!attribute not_due_principal
# The principal on the loan that is not yet due.
#
# @return [Integer, nil]
required :not_due_principal, Integer, nil?: true

# @!attribute past_due_balance
# The amount past due on the loan.
#
Expand All @@ -84,7 +120,7 @@ class Loan < Increase::Internal::Type::BaseModel
# @return [Increase::Models::BalanceLookup::Loan::Receivables, nil]
required :receivables, -> { Increase::BalanceLookup::Loan::Receivables }, nil?: true

# @!method initialize(due_at:, due_balance:, past_due_balance:, receivables:)
# @!method initialize(due_at:, due_balance:, due_fees:, due_interest:, due_principal:, not_due_fees:, not_due_interest:, not_due_principal:, past_due_balance:, receivables:)
# The loan balances for the Account.
#
# @param due_at [Time, nil]
Expand All @@ -93,6 +129,18 @@ class Loan < Increase::Internal::Type::BaseModel
#
# @param due_balance [Integer] The total amount due on the loan.
#
# @param due_fees [Integer, nil] The fees on the loan that are due and unpaid.
#
# @param due_interest [Integer, nil] The interest on the loan that is due and unpaid.
#
# @param due_principal [Integer, nil] The principal on the loan that is due and unpaid.
#
# @param not_due_fees [Integer, nil] The fees on the loan that are not yet due.
#
# @param not_due_interest [Integer, nil] The interest on the loan that is not yet due.
#
# @param not_due_principal [Integer, nil] The principal on the loan that is not yet due.
#
# @param past_due_balance [Integer] The amount past due on the loan.
#
# @param receivables [Increase::Models::BalanceLookup::Loan::Receivables, nil]
Expand Down
44 changes: 43 additions & 1 deletion lib/increase/models/card.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,13 @@ class Card < Increase::Internal::Type::BaseModel
# @return [String]
required :bin, String

# @!attribute cardholder_name
# The name of the cardholder. Used to respond to Account Name Inquiry requests
# from acquirers in Card Validations.
#
# @return [Increase::Models::Card::CardholderName, nil]
required :cardholder_name, -> { Increase::Card::CardholderName }, nil?: true

# @!attribute created_at
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
# the Card was created.
Expand Down Expand Up @@ -100,7 +107,7 @@ class Card < Increase::Internal::Type::BaseModel
# @return [Symbol, Increase::Models::Card::Type]
required :type, enum: -> { Increase::Card::Type }

# @!method initialize(id:, account_id:, authorization_controls:, billing_address:, bin:, created_at:, description:, digital_wallet:, entity_id:, expiration_month:, expiration_year:, idempotency_key:, last4:, status:, type:)
# @!method initialize(id:, account_id:, authorization_controls:, billing_address:, bin:, cardholder_name:, created_at:, description:, digital_wallet:, entity_id:, expiration_month:, expiration_year:, idempotency_key:, last4:, status:, type:)
# Cards may operate on credit, debit, or prepaid BINs. They’ll immediately work
# for online purchases after you create them. All cards work on a good funds
# model, and maintain a maximum limit of 100% of the Account’s available balance
Expand All @@ -118,6 +125,10 @@ class Card < Increase::Internal::Type::BaseModel
#
# @param bin [String] The Bank Identification Number (BIN) of the Card.
#
# @param cardholder_name [Increase::Models::Card::CardholderName, nil]
# The name of the cardholder. Used to respond to Account Name Inquiry requests
# from acquirers in Card Validations.
#
# @param created_at [Time]
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
# the Card was created.
Expand Down Expand Up @@ -613,6 +624,37 @@ class BillingAddress < Increase::Internal::Type::BaseModel
# @param state [String, nil] The US state of the billing address.
end

# @see Increase::Models::Card#cardholder_name
class CardholderName < Increase::Internal::Type::BaseModel
# @!attribute first
# The cardholder's first name.
#
# @return [String]
required :first, String

# @!attribute last
# The cardholder's last name.
#
# @return [String]
required :last, String

# @!attribute middle
# The cardholder's middle name.
#
# @return [String, nil]
required :middle, String, nil?: true

# @!method initialize(first:, last:, middle:)
# The name of the cardholder. Used to respond to Account Name Inquiry requests
# from acquirers in Card Validations.
#
# @param first [String] The cardholder's first name.
#
# @param last [String] The cardholder's last name.
#
# @param middle [String, nil] The cardholder's middle name.
end

# @see Increase::Models::Card#digital_wallet
class DigitalWallet < Increase::Internal::Type::BaseModel
# @!attribute digital_card_profile_id
Expand Down
43 changes: 42 additions & 1 deletion lib/increase/models/card_create_params.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ class CardCreateParams < Increase::Internal::Type::BaseModel
# @return [Increase::Models::CardCreateParams::BillingAddress, nil]
optional :billing_address, -> { Increase::CardCreateParams::BillingAddress }

# @!attribute cardholder_name
# The name of the cardholder. Used to respond to Account Name Inquiry requests
# from acquirers in Card Validations.
#
# @return [Increase::Models::CardCreateParams::CardholderName, nil]
optional :cardholder_name, -> { Increase::CardCreateParams::CardholderName }

# @!attribute description
# The description you choose to give the card.
#
Expand All @@ -48,14 +55,18 @@ class CardCreateParams < Increase::Internal::Type::BaseModel
# @return [String, nil]
optional :entity_id, String

# @!method initialize(account_id:, authorization_controls: nil, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, request_options: {})
# @!method initialize(account_id:, authorization_controls: nil, billing_address: nil, cardholder_name: nil, description: nil, digital_wallet: nil, entity_id: nil, request_options: {})
# @param account_id [String] The Account the card should belong to.
#
# @param authorization_controls [Increase::Models::CardCreateParams::AuthorizationControls]
# Controls that restrict how this card can be used.
#
# @param billing_address [Increase::Models::CardCreateParams::BillingAddress] The card's billing address.
#
# @param cardholder_name [Increase::Models::CardCreateParams::CardholderName]
# The name of the cardholder. Used to respond to Account Name Inquiry requests
# from acquirers in Card Validations.
#
# @param description [String] The description you choose to give the card.
#
# @param digital_wallet [Increase::Models::CardCreateParams::DigitalWallet]
Expand Down Expand Up @@ -519,6 +530,36 @@ class BillingAddress < Increase::Internal::Type::BaseModel
# @param line2 [String] The second line of the billing address.
end

class CardholderName < Increase::Internal::Type::BaseModel
# @!attribute first
# The cardholder's first name.
#
# @return [String]
required :first, String

# @!attribute last
# The cardholder's last name.
#
# @return [String]
required :last, String

# @!attribute middle
# The cardholder's middle name.
#
# @return [String, nil]
optional :middle, String

# @!method initialize(first:, last:, middle: nil)
# The name of the cardholder. Used to respond to Account Name Inquiry requests
# from acquirers in Card Validations.
#
# @param first [String] The cardholder's first name.
#
# @param last [String] The cardholder's last name.
#
# @param middle [String] The cardholder's middle name.
end

class DigitalWallet < Increase::Internal::Type::BaseModel
# @!attribute digital_card_profile_id
# The digital card profile assigned to this digital card.
Expand Down
2 changes: 1 addition & 1 deletion lib/increase/models/card_dispute.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ module Status
# The Card Dispute has been won and no further action can be taken.
WON = :won

# The Card Dispute has been reviewed and rejected, please review the explanation for more details.
# The Card Dispute was rejected before it was submitted to the network, either by Increase or because the user withdrew it. Please review the explanation for more details.
REJECTED = :rejected

# @!method self.values
Expand Down
2 changes: 1 addition & 1 deletion lib/increase/models/card_dispute_list_params.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ module In
# The Card Dispute has been won and no further action can be taken.
WON = :won

# The Card Dispute has been reviewed and rejected, please review the explanation for more details.
# The Card Dispute was rejected before it was submitted to the network, either by Increase or because the user withdrew it. Please review the explanation for more details.
REJECTED = :rejected

# @!method self.values
Expand Down
19 changes: 18 additions & 1 deletion lib/increase/models/card_payment.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1512,6 +1512,16 @@ class CardAuthorization < Increase::Internal::Type::BaseModel
# @return [Integer, nil]
required :network_risk_score, Integer, nil?: true

# @!attribute original_card_payment_id
# The ID of the Card Payment containing the original authorization or card
# validation this transaction references. For a merchant-initiated transaction,
# this is the Card Payment from when the card was first stored, which is typically
# where the CVV2 was verified. The reference this is derived from is supplied by
# the merchant or their acquirer, so it is not guaranteed to be present.
#
# @return [String, nil]
required :original_card_payment_id, String, nil?: true

# @!attribute pending_transaction_id
# The identifier of the Pending Transaction associated with this Transaction.
#
Expand Down Expand Up @@ -1580,7 +1590,7 @@ class CardAuthorization < Increase::Internal::Type::BaseModel
# @return [Increase::Models::CardPayment::Element::CardAuthorization::Verification]
required :verification, -> { Increase::CardPayment::Element::CardAuthorization::Verification }

# @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, expires_at:, healthcare:, 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:, scheme_fees:, terminal_id:, type:, verification:)
# @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, expires_at:, healthcare:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, original_card_payment_id:, pending_transaction_id:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, scheme_fees:, terminal_id:, type:, verification:)
# 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 customer's funds with the intent to later clear a
Expand Down Expand Up @@ -1654,6 +1664,13 @@ class CardAuthorization < Increase::Internal::Type::BaseModel
# Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
# score is from 0 to 999, where 999 is the riskiest.
#
# @param original_card_payment_id [String, nil]
# The ID of the Card Payment containing the original authorization or card
# validation this transaction references. For a merchant-initiated transaction,
# this is the Card Payment from when the card was first stored, which is typically
# where the CVV2 was verified. The reference this is derived from is supplied by
# the merchant or their acquirer, so it is not guaranteed to be present.
#
# @param pending_transaction_id [String, nil]
# The identifier of the Pending Transaction associated with this Transaction.
#
Expand Down
Loading