Class: Stigg::Models::V1::ContractListResponse::LatestInvoice

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stigg/models/v1/contract_list_response.rb,
sig/stigg/models/v1/contract_list_response.rbs

Overview

See Also:

  • Stigg::Models::V1::ContractListResponse#latest_invoice

Defined Under Namespace

Modules: BillingReason, Status

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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:




# File 'lib/stigg/models/v1/contract_list_response.rb', line 231

Instance Attribute Details

#amount_due ⇒ Float?

Amount due

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


202
 
# File 'lib/stigg/models/v1/contract_list_response.rb', line 202

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

#billing_id ⇒ String

Invoice billing ID

Parameters:

  • value (String)

Returns:

  • (String) 


178
 
# File 'lib/stigg/models/v1/contract_list_response.rb', line 178

required :billing_id, String, api_name: :billingId

#billing_reason ⇒ Symbol, ...

Billing reason

Parameters:

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

Returns:



208
209
210
211
 
# File 'lib/stigg/models/v1/contract_list_response.rb', line 208

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

#created_at ⇒ Time

Invoice creation date

Parameters:

  • value (Time)

Returns:

  • (Time) 


184
 
# File 'lib/stigg/models/v1/contract_list_response.rb', line 184

required :created_at, Time, api_name: :createdAt

#currency ⇒ String?

Invoice currency

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


217
 
# File 'lib/stigg/models/v1/contract_list_response.rb', line 217

optional :currency, String, nil?: true

#pdf_url ⇒ String?

Invoice PDF URL

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


223
 
# File 'lib/stigg/models/v1/contract_list_response.rb', line 223

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

#requires_action ⇒ Boolean

Whether payment requires action

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


190
 
# File 'lib/stigg/models/v1/contract_list_response.rb', line 190

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

#status ⇒ Symbol, Stigg::Models::V1::ContractListResponse::LatestInvoice::Status

Invoice status

Parameters:

  • value (Stigg::Models::V1::ContractListResponse::LatestInvoice::status)

Returns:



196
 
# File 'lib/stigg/models/v1/contract_list_response.rb', line 196

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

#total ⇒ Float?

Total amount

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


229
 
# File 'lib/stigg/models/v1/contract_list_response.rb', line 229

optional :total, Float, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/stigg/models/v1/contract_list_response.rb', line 263

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


152
 
# File 'sig/stigg/models/v1/contract_list_response.rbs', line 152

def to_hash: -> {