Class: Stigg::Models::V1::ContractRetrieveResponse::Data::LatestInvoice

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Stigg::Models::V1::ContractRetrieveResponse::Data::LatestInvoice

Defined in:

lib/stigg/models/v1/contract_retrieve_response.rb,
sig/stigg/models/v1/contract_retrieve_response.rbs

Overview

See Also:

• Stigg::Models::V1::ContractRetrieveResponse::Data#latest_invoice

Defined Under Namespace

Modules: BillingReason, Status

Instance Attribute Summary

• #amount_due ⇒ Float^?

  Amount due.

• #billing_id ⇒ String

  Invoice billing ID.

• #billing_reason ⇒ Symbol, ...

  Billing reason.

• #created_at ⇒ Time

  Invoice creation date.

• #currency ⇒ String^?

  Invoice currency.

• #pdf_url ⇒ String^?

  Invoice PDF URL.

• #requires_action ⇒ Boolean

  Whether payment requires action.

• #status ⇒ Symbol, Stigg::Models::V1::ContractRetrieveResponse::Data::LatestInvoice::Status

  Invoice status.

• #total ⇒ Float^?

  Total amount.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(billing_id:, created_at:, requires_action:, status:, amount_due: nil, billing_reason: nil, currency: nil, pdf_url: nil, total: nil) ⇒ Object constructor

  The most recent non-draft invoice for this contract (open, paid, or canceled), or null when none exists.

• #to_hash ⇒ {

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(billing_id:, created_at:, requires_action:, status:, amount_due: nil, billing_reason: nil, currency: nil, pdf_url: nil, total: nil) ⇒ Object

The most recent non-draft invoice for this contract (open, paid, or canceled), or null when none exists

Parameters:

• billing_id (String) —

  Invoice billing ID

• created_at (Time) —

  Invoice creation date

• requires_action (Boolean) —

  Whether payment requires action

• status (Symbol, Stigg::Models::V1::ContractRetrieveResponse::Data::LatestInvoice::Status) —

  Invoice status

• amount_due (Float, nil) (defaults to: nil) —

  Amount due

• billing_reason (Symbol, Stigg::Models::V1::ContractRetrieveResponse::Data::LatestInvoice::BillingReason, nil) (defaults to: nil) —

  Billing reason

• currency (String, nil) (defaults to: nil) —

  Invoice currency

• pdf_url (String, nil) (defaults to: nil) —

  Invoice PDF URL

• total (Float, nil) (defaults to: nil) —

  Total amount

# File 'lib/stigg/models/v1/contract_retrieve_response.rb', line 218

Instance Attribute Details

#amount_due ⇒ Float^?

Amount due

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/stigg/models/v1/contract_retrieve_response.rb', line 189

optional :amount_due, Float, api_name: :amountDue, nil?: true

#billing_id ⇒ String

Invoice billing ID

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/stigg/models/v1/contract_retrieve_response.rb', line 165

required :billing_id, String, api_name: :billingId

#billing_reason ⇒ Symbol, ...

Billing reason

Parameters:

• value (Stigg::Models::V1::ContractRetrieveResponse::Data::LatestInvoice::billing_reason, nil)

Returns:

• (Symbol, Stigg::Models::V1::ContractRetrieveResponse::Data::LatestInvoice::BillingReason, nil)

# File 'lib/stigg/models/v1/contract_retrieve_response.rb', line 195

optional :billing_reason,
enum: -> { Stigg::Models::V1::ContractRetrieveResponse::Data::LatestInvoice::BillingReason },
api_name: :billingReason,
nil?: true

#created_at ⇒ Time

Invoice creation date

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/stigg/models/v1/contract_retrieve_response.rb', line 171

required :created_at, Time, api_name: :createdAt

#currency ⇒ String^?

Invoice currency

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/contract_retrieve_response.rb', line 204

optional :currency, String, nil?: true

#pdf_url ⇒ String^?

Invoice PDF URL

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/contract_retrieve_response.rb', line 210

optional :pdf_url, String, api_name: :pdfUrl, nil?: true

#requires_action ⇒ Boolean

Whether payment requires action

Parameters:

• value (Boolean)

Returns:

• (Boolean)

# File 'lib/stigg/models/v1/contract_retrieve_response.rb', line 177

required :requires_action, Stigg::Internal::Type::Boolean, api_name: :requiresAction

#status ⇒ Symbol, Stigg::Models::V1::ContractRetrieveResponse::Data::LatestInvoice::Status

Invoice status

Parameters:

• value (Stigg::Models::V1::ContractRetrieveResponse::Data::LatestInvoice::status)

Returns:

• (Symbol, Stigg::Models::V1::ContractRetrieveResponse::Data::LatestInvoice::Status)

# File 'lib/stigg/models/v1/contract_retrieve_response.rb', line 183

required :status, enum: -> { Stigg::Models::V1::ContractRetrieveResponse::Data::LatestInvoice::Status }

#total ⇒ Float^?

Total amount

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/stigg/models/v1/contract_retrieve_response.rb', line 216

optional :total, Float, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/stigg/models/v1/contract_retrieve_response.rb', line 250

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/stigg/models/v1/contract_retrieve_response.rbs', line 148

def to_hash: -> {