Class: Stigg::Models::V1::Credits::GrantListResponse::LatestInvoice

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Stigg::Models::V1::Credits::GrantListResponse::LatestInvoice

Defined in:

lib/stigg/models/v1/credits/grant_list_response.rb,
sig/stigg/models/v1/credits/grant_list_response.rbs

Overview

See Also:

• Stigg::Models::V1::Credits::GrantListResponse#latest_invoice

Defined Under Namespace

Modules: BillingReason, Status

Instance Attribute Summary

• #billing_id ⇒ String

  The billing provider invoice ID.

• #billing_reason ⇒ Symbol, ...

  The billing reason for the invoice.

• #created_at ⇒ Time

  The invoice creation date.

• #currency ⇒ String^?

  The invoice currency.

• #due_date ⇒ Time^?

  The invoice due date.

• #error_message ⇒ String^?

  Error message if payment failed.

• #payment_url ⇒ String^?

  The payment URL for settling the invoice.

• #pdf_url ⇒ String^?

  The PDF URL of the invoice.

• #requires_action ⇒ Boolean

  Whether the invoice requires user action.

• #status ⇒ Symbol, Stigg::Models::V1::Credits::GrantListResponse::LatestInvoice::Status

  The invoice status.

• #sub_total ⇒ Float^?

  The subtotal amount before tax.

• #tax ⇒ Float^?

  The tax amount.

• #total ⇒ Float^?

  The total amount including tax.

• #updated_at ⇒ Time

  The invoice last update date.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #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 constructor

  The latest invoice details for this grant.

• #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:, 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::GrantListResponse::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::GrantListResponse::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/grant_list_response.rb', line 335

Instance Attribute Details

#billing_id ⇒ String

The billing provider invoice ID

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/stigg/models/v1/credits/grant_list_response.rb', line 252

required :billing_id, String, api_name: :billingId

#billing_reason ⇒ Symbol, ...

The billing reason for the invoice

Parameters:

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

Returns:

• (Symbol, Stigg::Models::V1::Credits::GrantListResponse::LatestInvoice::BillingReason, nil)

# File 'lib/stigg/models/v1/credits/grant_list_response.rb', line 258

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

#created_at ⇒ Time

The invoice creation date

Parameters:

• value (Time)

Returns:

• (Time)

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

required :created_at, Time, api_name: :createdAt

#currency ⇒ String^?

The invoice currency

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/credits/grant_list_response.rb', line 273

required :currency, String, nil?: true

#due_date ⇒ Time^?

The invoice due date

Parameters:

• value (Time, nil)

Returns:

• (Time, nil)

# File 'lib/stigg/models/v1/credits/grant_list_response.rb', line 279

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

#error_message ⇒ String^?

Error message if payment failed

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/credits/grant_list_response.rb', line 285

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)

# File 'lib/stigg/models/v1/credits/grant_list_response.rb', line 291

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)

# File 'lib/stigg/models/v1/credits/grant_list_response.rb', line 297

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

#requires_action ⇒ Boolean

Whether the invoice requires user action

Parameters:

• value (Boolean)

Returns:

• (Boolean)

# File 'lib/stigg/models/v1/credits/grant_list_response.rb', line 303

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

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

The invoice status

Parameters:

• value (Stigg::Models::V1::Credits::GrantListResponse::LatestInvoice::status)

Returns:

• (Symbol, Stigg::Models::V1::Credits::GrantListResponse::LatestInvoice::Status)

# File 'lib/stigg/models/v1/credits/grant_list_response.rb', line 309

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

#sub_total ⇒ Float^?

The subtotal amount before tax

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/stigg/models/v1/credits/grant_list_response.rb', line 315

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

#tax ⇒ Float^?

The tax amount

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/stigg/models/v1/credits/grant_list_response.rb', line 321

required :tax, Float, nil?: true

#total ⇒ Float^?

The total amount including tax

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/stigg/models/v1/credits/grant_list_response.rb', line 327

required :total, Float, nil?: true

#updated_at ⇒ Time

The invoice last update date

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/stigg/models/v1/credits/grant_list_response.rb', line 333

required :updated_at, Time, api_name: :updatedAt

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/stigg/models/v1/credits/grant_list_response.rb', line 375

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/stigg/models/v1/credits/grant_list_response.rbs', line 220

def to_hash: -> {