Class: Stigg::Models::V1::Credits::CreditGrantResponse::Data::LatestInvoice

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

Overview

See Also:

  • Stigg::Models::V1::Credits::CreditGrantResponse::Data#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:, billing_reason:, created_at:, currency:, due_date:, error_message:, payment_url:, pdf_url:, requires_action:, status:, sub_total:, tax:, total:, updated_at:) ⇒ Object

The latest invoice details for this grant

Parameters:

  • billing_id (String) —

    The billing provider invoice ID

  • billing_reason (Symbol, Stigg::Models::V1::Credits::CreditGrantResponse::Data::LatestInvoice::BillingReason, nil) —

    The billing reason for the invoice

  • created_at (Time) —

    The invoice creation date

  • currency (String, nil) —

    The invoice currency

  • due_date (Time, nil) —

    The invoice due date

  • error_message (String, nil) —

    Error message if payment failed

  • payment_url (String, nil) —

    The payment URL for settling the invoice

  • pdf_url (String, nil) —

    The PDF URL of the invoice

  • requires_action (Boolean) —

    Whether the invoice requires user action

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

    The invoice status

  • sub_total (Float, nil) —

    The subtotal amount before tax

  • tax (Float, nil) —

    The tax amount

  • total (Float, nil) —

    The total amount including tax

  • updated_at (Time) —

    The invoice last update date




# File 'lib/stigg/models/v1/credits/credit_grant_response.rb', line 352

Instance Attribute Details

#billing_id ⇒ String

The billing provider invoice ID

Parameters:

  • value (String)

Returns:

  • (String) 


267
 
# File 'lib/stigg/models/v1/credits/credit_grant_response.rb', line 267

required :billing_id, String, api_name: :billingId

#billing_reason ⇒ Symbol, ...

The billing reason for the invoice

Parameters:

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

Returns:



273
274
275
276
277
278
 
# File 'lib/stigg/models/v1/credits/credit_grant_response.rb', line 273

required :billing_reason,
enum: -> {
  Stigg::V1::Credits::CreditGrantResponse::Data::LatestInvoice::BillingReason
},
api_name: :billingReason,
nil?: true

#created_at ⇒ Time

The invoice creation date

Parameters:

  • value (Time)

Returns:

  • (Time) 


284
 
# File 'lib/stigg/models/v1/credits/credit_grant_response.rb', line 284

required :created_at, Time, api_name: :createdAt

#currency ⇒ String?

The invoice currency

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


290
 
# File 'lib/stigg/models/v1/credits/credit_grant_response.rb', line 290

required :currency, String, nil?: true

#due_date ⇒ Time?

The invoice due date

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


296
 
# File 'lib/stigg/models/v1/credits/credit_grant_response.rb', line 296

required :due_date, Time, api_name: :dueDate, nil?: true

#error_message ⇒ String?

Error message if payment failed

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


302
 
# File 'lib/stigg/models/v1/credits/credit_grant_response.rb', line 302

required :error_message, String, api_name: :errorMessage, nil?: true

#payment_url ⇒ String?

The payment URL for settling the invoice

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


308
 
# File 'lib/stigg/models/v1/credits/credit_grant_response.rb', line 308

required :payment_url, String, api_name: :paymentUrl, nil?: true

#pdf_url ⇒ String?

The PDF URL of the invoice

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


314
 
# File 'lib/stigg/models/v1/credits/credit_grant_response.rb', line 314

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

#requires_action ⇒ Boolean

Whether the invoice requires user action

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


320
 
# File 'lib/stigg/models/v1/credits/credit_grant_response.rb', line 320

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

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

The invoice status

Parameters:

  • value (Stigg::Models::V1::Credits::CreditGrantResponse::Data::LatestInvoice::status)

Returns:



326
 
# File 'lib/stigg/models/v1/credits/credit_grant_response.rb', line 326

required :status, enum: -> { Stigg::V1::Credits::CreditGrantResponse::Data::LatestInvoice::Status }

#sub_total ⇒ Float?

The subtotal amount before tax

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


332
 
# File 'lib/stigg/models/v1/credits/credit_grant_response.rb', line 332

required :sub_total, Float, api_name: :subTotal, nil?: true

#tax ⇒ Float?

The tax amount

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


338
 
# File 'lib/stigg/models/v1/credits/credit_grant_response.rb', line 338

required :tax, Float, nil?: true

#total ⇒ Float?

The total amount including tax

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


344
 
# File 'lib/stigg/models/v1/credits/credit_grant_response.rb', line 344

required :total, Float, nil?: true

#updated_at ⇒ Time

The invoice last update date

Parameters:

  • value (Time)

Returns:

  • (Time) 


350
 
# File 'lib/stigg/models/v1/credits/credit_grant_response.rb', line 350

required :updated_at, Time, api_name: :updatedAt

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/stigg/models/v1/credits/credit_grant_response.rb', line 392

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


236
 
# File 'sig/stigg/models/v1/credits/credit_grant_response.rbs', line 236

def to_hash: -> {