Class: Increase::BaseModel

Inherits:

Object

Object
Increase::BaseModel

show all

Defined in:: lib/increase/base_model.rb

Direct Known Subclasses

Models::ACHPrenotification, Models::ACHPrenotification::NotificationsOfChange, Models::ACHPrenotification::PrenotificationReturn, Models::ACHTransfer, Models::ACHTransfer::Acknowledgement, Models::ACHTransfer::Addenda, Models::ACHTransfer::Addenda::Freeform, Models::ACHTransfer::Addenda::Freeform::Entry, Models::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice, Models::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice::Invoice, Models::ACHTransfer::Approval, Models::ACHTransfer::Cancellation, Models::ACHTransfer::CreatedBy, Models::ACHTransfer::CreatedBy::APIKey, Models::ACHTransfer::CreatedBy::OAuthApplication, Models::ACHTransfer::CreatedBy::User, Models::ACHTransfer::NotificationsOfChange, Models::ACHTransfer::PreferredEffectiveDate, Models::ACHTransfer::Return, Models::ACHTransfer::Submission, Models::Account, Models::AccountNumber, Models::AccountNumber::InboundACH, Models::AccountNumber::InboundChecks, Models::AccountStatement, Models::AccountTransfer, Models::AccountTransfer::Approval, Models::AccountTransfer::Cancellation, Models::AccountTransfer::CreatedBy, Models::AccountTransfer::CreatedBy::APIKey, Models::AccountTransfer::CreatedBy::OAuthApplication, Models::AccountTransfer::CreatedBy::User, Models::BalanceLookup, Models::BookkeepingAccount, Models::BookkeepingBalanceLookup, Models::BookkeepingEntry, Models::BookkeepingEntrySet, Models::BookkeepingEntrySet::Entry, Models::Card, Models::Card::BillingAddress, Models::Card::DigitalWallet, Models::CardAuthorizationCreateResponse, Models::CardDetails, Models::CardDispute, Models::CardDispute::Acceptance, Models::CardDispute::Loss, Models::CardDispute::Rejection, Models::CardDispute::Win, Models::CardPayment, Models::CardPayment::Element, Models::CardPayment::Element::CardAuthorization, Models::CardPayment::Element::CardAuthorization::NetworkDetails, Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa, Models::CardPayment::Element::CardAuthorization::NetworkIdentifiers, Models::CardPayment::Element::CardAuthorization::Verification, Models::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode, Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress, Models::CardPayment::Element::CardAuthorizationExpiration, Models::CardPayment::Element::CardDecline, Models::CardPayment::Element::CardDecline::NetworkDetails, Models::CardPayment::Element::CardDecline::NetworkDetails::Visa, Models::CardPayment::Element::CardDecline::NetworkIdentifiers, Models::CardPayment::Element::CardDecline::Verification, Models::CardPayment::Element::CardDecline::Verification::CardVerificationCode, Models::CardPayment::Element::CardDecline::Verification::CardholderAddress, Models::CardPayment::Element::CardFuelConfirmation, Models::CardPayment::Element::CardFuelConfirmation::NetworkIdentifiers, Models::CardPayment::Element::CardIncrement, Models::CardPayment::Element::CardIncrement::NetworkIdentifiers, Models::CardPayment::Element::CardRefund, Models::CardPayment::Element::CardRefund::NetworkIdentifiers, Models::CardPayment::Element::CardRefund::PurchaseDetails, Models::CardPayment::Element::CardRefund::PurchaseDetails::CarRental, Models::CardPayment::Element::CardRefund::PurchaseDetails::Lodging, Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel, Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::Ancillary, Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::Ancillary::Service, Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::TripLeg, Models::CardPayment::Element::CardReversal, Models::CardPayment::Element::CardReversal::NetworkIdentifiers, Models::CardPayment::Element::CardSettlement, Models::CardPayment::Element::CardSettlement::NetworkIdentifiers, Models::CardPayment::Element::CardSettlement::PurchaseDetails, Models::CardPayment::Element::CardSettlement::PurchaseDetails::CarRental, Models::CardPayment::Element::CardSettlement::PurchaseDetails::Lodging, Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel, Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::Ancillary, Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::Ancillary::Service, Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::TripLeg, Models::CardPayment::Element::CardValidation, Models::CardPayment::Element::CardValidation::NetworkDetails, Models::CardPayment::Element::CardValidation::NetworkDetails::Visa, Models::CardPayment::Element::CardValidation::NetworkIdentifiers, Models::CardPayment::Element::CardValidation::Verification, Models::CardPayment::Element::CardValidation::Verification::CardVerificationCode, Models::CardPayment::Element::CardValidation::Verification::CardholderAddress, Models::CardPayment::State, Models::CardPurchaseSupplement, Models::CardPurchaseSupplement::Invoice, Models::CardPurchaseSupplement::LineItem, Models::CheckDeposit, Models::CheckDeposit::DepositAcceptance, Models::CheckDeposit::DepositRejection, Models::CheckDeposit::DepositReturn, Models::CheckDeposit::DepositSubmission, Models::CheckTransfer, Models::CheckTransfer::Approval, Models::CheckTransfer::Cancellation, Models::CheckTransfer::CreatedBy, Models::CheckTransfer::CreatedBy::APIKey, Models::CheckTransfer::CreatedBy::OAuthApplication, Models::CheckTransfer::CreatedBy::User, Models::CheckTransfer::Mailing, Models::CheckTransfer::PhysicalCheck, Models::CheckTransfer::PhysicalCheck::MailingAddress, Models::CheckTransfer::PhysicalCheck::ReturnAddress, Models::CheckTransfer::StopPaymentRequest, Models::CheckTransfer::Submission, Models::CheckTransfer::ThirdParty, Models::DeclinedTransaction, Models::DeclinedTransaction::Source, Models::DeclinedTransaction::Source::ACHDecline, Models::DeclinedTransaction::Source::CardDecline, Models::DeclinedTransaction::Source::CardDecline::NetworkDetails, Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa, Models::DeclinedTransaction::Source::CardDecline::NetworkIdentifiers, Models::DeclinedTransaction::Source::CardDecline::Verification, Models::DeclinedTransaction::Source::CardDecline::Verification::CardVerificationCode, Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress, Models::DeclinedTransaction::Source::CheckDecline, Models::DeclinedTransaction::Source::CheckDepositRejection, Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline, Models::DeclinedTransaction::Source::WireDecline, Models::DigitalCardProfile, Models::DigitalCardProfile::TextColor, Models::DigitalWalletToken, Models::DigitalWalletTokenRequestCreateResponse, Models::Document, Models::Entity, Models::Entity::Corporation, Models::Entity::Corporation::Address, Models::Entity::Corporation::BeneficialOwner, Models::Entity::Corporation::BeneficialOwner::Individual, Models::Entity::Corporation::BeneficialOwner::Individual::Address, Models::Entity::Corporation::BeneficialOwner::Individual::Identification, Models::Entity::GovernmentAuthority, Models::Entity::GovernmentAuthority::Address, Models::Entity::GovernmentAuthority::AuthorizedPerson, Models::Entity::Joint, Models::Entity::Joint::Individual, Models::Entity::Joint::Individual::Address, Models::Entity::Joint::Individual::Identification, Models::Entity::NaturalPerson, Models::Entity::NaturalPerson::Address, Models::Entity::NaturalPerson::Identification, Models::Entity::Trust, Models::Entity::Trust::Address, Models::Entity::Trust::Grantor, Models::Entity::Trust::Grantor::Address, Models::Entity::Trust::Grantor::Identification, Models::Entity::Trust::Trustee, Models::Entity::Trust::Trustee::Individual, Models::Entity::Trust::Trustee::Individual::Address, Models::Entity::Trust::Trustee::Individual::Identification, Models::EntitySupplementalDocument, Models::Event, Models::EventSubscription, Models::Export, Models::ExternalAccount, Models::File, Models::Group, Models::InboundACHTransfer, Models::InboundACHTransfer::Acceptance, Models::InboundACHTransfer::Addenda, Models::InboundACHTransfer::Addenda::Freeform, Models::InboundACHTransfer::Addenda::Freeform::Entry, Models::InboundACHTransfer::Decline, Models::InboundACHTransfer::InternationalAddenda, Models::InboundACHTransfer::NotificationOfChange, Models::InboundACHTransfer::TransferReturn, Models::InboundCheckDeposit, Models::InboundCheckDeposit::DepositReturn, Models::InboundFundsHoldReleaseResponse, Models::InboundMailItem, Models::InboundMailItem::ReturnAddress, Models::InboundRealTimePaymentsTransferCreateResponse, Models::InboundWireDrawdownRequest, Models::InboundWireTransfer, Models::IntrafiAccountEnrollment, Models::IntrafiBalance, Models::IntrafiBalance::Balance, Models::IntrafiBalance::Balance::BankLocation, Models::IntrafiExclusion, Models::Lockbox, Models::Lockbox::Address, Models::OAuthConnection, Models::OAuthToken, Models::PendingTransaction, Models::PendingTransaction::Source, Models::PendingTransaction::Source::ACHTransferInstruction, Models::PendingTransaction::Source::AccountTransferInstruction, Models::PendingTransaction::Source::CardAuthorization, Models::PendingTransaction::Source::CardAuthorization::NetworkDetails, Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa, Models::PendingTransaction::Source::CardAuthorization::NetworkIdentifiers, Models::PendingTransaction::Source::CardAuthorization::Verification, Models::PendingTransaction::Source::CardAuthorization::Verification::CardVerificationCode, Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress, Models::PendingTransaction::Source::CheckDepositInstruction, Models::PendingTransaction::Source::CheckTransferInstruction, Models::PendingTransaction::Source::InboundFundsHold, Models::PendingTransaction::Source::RealTimePaymentsTransferInstruction, Models::PendingTransaction::Source::WireTransferInstruction, Models::PhysicalCard, Models::PhysicalCard::Cardholder, Models::PhysicalCard::Shipment, Models::PhysicalCard::Shipment::Address, Models::PhysicalCard::Shipment::Tracking, Models::PhysicalCardProfile, Models::Program, Models::ProofOfAuthorizationRequest, Models::ProofOfAuthorizationRequest::ACHTransfer, Models::ProofOfAuthorizationRequestSubmission, Models::RealTimeDecision, Models::RealTimeDecision::CardAuthorization, Models::RealTimeDecision::CardAuthorization::NetworkDetails, Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa, Models::RealTimeDecision::CardAuthorization::NetworkIdentifiers, Models::RealTimeDecision::CardAuthorization::RequestDetails, Models::RealTimeDecision::CardAuthorization::RequestDetails::IncrementalAuthorization, Models::RealTimeDecision::CardAuthorization::Verification, Models::RealTimeDecision::CardAuthorization::Verification::CardVerificationCode, Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress, Models::RealTimeDecision::DigitalWalletAuthentication, Models::RealTimeDecision::DigitalWalletToken, Models::RealTimePaymentsRequestForPayment, Models::RealTimePaymentsRequestForPayment::Refusal, Models::RealTimePaymentsRequestForPayment::Rejection, Models::RealTimePaymentsRequestForPayment::Submission, Models::RealTimePaymentsTransfer, Models::RealTimePaymentsTransfer::Approval, Models::RealTimePaymentsTransfer::Cancellation, Models::RealTimePaymentsTransfer::CreatedBy, Models::RealTimePaymentsTransfer::CreatedBy::APIKey, Models::RealTimePaymentsTransfer::CreatedBy::OAuthApplication, Models::RealTimePaymentsTransfer::CreatedBy::User, Models::RealTimePaymentsTransfer::Rejection, Models::RealTimePaymentsTransfer::Submission, Models::RoutingNumberListResponse, Models::Transaction, Models::Transaction::Source, Models::Transaction::Source::ACHTransferIntention, Models::Transaction::Source::ACHTransferRejection, Models::Transaction::Source::ACHTransferReturn, Models::Transaction::Source::AccountTransferIntention, Models::Transaction::Source::CardDisputeAcceptance, Models::Transaction::Source::CardDisputeLoss, Models::Transaction::Source::CardRefund, Models::Transaction::Source::CardRefund::NetworkIdentifiers, Models::Transaction::Source::CardRefund::PurchaseDetails, Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental, Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging, Models::Transaction::Source::CardRefund::PurchaseDetails::Travel, Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary, Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::Service, Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TripLeg, Models::Transaction::Source::CardRevenuePayment, Models::Transaction::Source::CardSettlement, Models::Transaction::Source::CardSettlement::NetworkIdentifiers, Models::Transaction::Source::CardSettlement::PurchaseDetails, Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental, Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging, Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel, Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary, Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::Service, Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TripLeg, Models::Transaction::Source::CashbackPayment, Models::Transaction::Source::CheckDepositAcceptance, Models::Transaction::Source::CheckDepositReturn, Models::Transaction::Source::CheckTransferDeposit, Models::Transaction::Source::FeePayment, Models::Transaction::Source::InboundACHTransfer, Models::Transaction::Source::InboundACHTransfer::Addenda, Models::Transaction::Source::InboundACHTransfer::Addenda::Freeform, Models::Transaction::Source::InboundACHTransfer::Addenda::Freeform::Entry, Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation, Models::Transaction::Source::InboundWireDrawdownPayment, Models::Transaction::Source::InboundWireReversal, Models::Transaction::Source::InboundWireTransfer, Models::Transaction::Source::InterestPayment, Models::Transaction::Source::InternalSource, Models::Transaction::Source::RealTimePaymentsTransferAcknowledgement, Models::Transaction::Source::SampleFunds, Models::Transaction::Source::WireTransferIntention, Models::Transaction::Source::WireTransferRejection, Models::WireDrawdownRequest, Models::WireDrawdownRequest::Submission, Models::WireTransfer, Models::WireTransfer::Approval, Models::WireTransfer::Cancellation, Models::WireTransfer::CreatedBy, Models::WireTransfer::CreatedBy::APIKey, Models::WireTransfer::CreatedBy::OAuthApplication, Models::WireTransfer::CreatedBy::User, Models::WireTransfer::Reversal, Models::WireTransfer::Submission

Instance Method Summary collapse

#[](key) ⇒ Object
Lookup attribute value by key in the object.
#inspect ⇒ String
#to_h ⇒ Hash{Symbol => Object} (also: #to_hash)
Returns a Hash of the data underlying this object.
#to_s ⇒ String

Instance Method Details

#[](key) ⇒ `Object`

Lookup attribute value by key in the object. If this key was not provided when the object was formed (e.g. because the API response did not include that key), returns nil. It is valid to lookup keys that are not in the API spec, for example to access undocumented features. Lookup by anything other than a Symbol is an ArgumentError.

Parameters:

key (Symbol) —
Key to look up by.

Returns:

(Object) —
Parsed / typed value at the given key, or nil if no data is available.

# File 'lib/increase/base_model.rb', line 183

def [](key)
  if !key.instance_of?(Symbol)
    raise ArgumentError, "Expected symbol key for lookup, got #{key.inspect}"
  end
  @data[key]
end

#inspect ⇒ `String`

Returns:

(String)



191
192
193

# File 'lib/increase/base_model.rb', line 191

def inspect
  "#<#{self.class.name}:0x#{object_id.to_s(16)} #{@data.inspect}>"
end

#to_h ⇒ `Hash{Symbol => Object}` Also known as: to_hash

Returns a Hash of the data underlying this object. Keys are Symbols and values are the parsed / typed domain objects. The return value indicates which values were ever set on the object - i.e. there will be a key in this hash if they ever were, even if the set value was nil. This method is not recursive. The returned value is shared by the object, so it should not be mutated.

Returns:

(Hash{Symbol => Object}) —
Data for this object.



167
168
169

# File 'lib/increase/base_model.rb', line 167

def to_h
  @data
end

#to_s ⇒ `String`

Returns:

(String)



196
197
198

# File 'lib/increase/base_model.rb', line 196

def to_s
  @data.to_s
end