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

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

Overview

See Also:

Defined Under Namespace

Modules: GrantType, PaymentCollection, SourceType, Status Classes: Cost, LatestInvoice

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(amount:, currency:) ⇒ Object

The monetary cost of the credit grant

Parameters:

  • amount (Float) —

    The cost amount

  • currency (String) —

    The currency code




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

Instance Attribute Details

#amount ⇒ Float

The total credits granted

Returns:

  • (Float) 


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

required :amount, Float

#comment ⇒ String?

An optional comment on the credit grant

Returns:

  • (String, nil) 


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

required :comment, String, nil?: true

#consumed_amount ⇒ Float

The total credits consumed from this grant

Returns:

  • (Float) 


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

required :consumed_amount, Float, api_name: :consumedAmount

#cost ⇒ Stigg::Models::V1::Events::Credits::CreditGrantResponse::Data::Cost

The monetary cost of the credit grant

Returns:



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

required :cost, -> { Stigg::V1::Events::Credits::CreditGrantResponse::Data::Cost }

#created_at ⇒ Time

Timestamp of when the record was created

Returns:

  • (Time) 


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

required :created_at, Time, api_name: :createdAt

#currency_id ⇒ String

The currency identifier for this grant

Returns:

  • (String) 


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

required :currency_id, String, api_name: :currencyId

#customer_id ⇒ String

The customer ID this grant belongs to

Returns:

  • (String) 


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

required :customer_id, String, api_name: :customerId

#display_name ⇒ String

The display name of the credit grant

Returns:

  • (String) 


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

required :display_name, String, api_name: :displayName

#effective_at ⇒ Time

The date when the credit grant becomes effective

Returns:

  • (Time) 


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

required :effective_at, Time, api_name: :effectiveAt

#expire_at ⇒ Time?

The date when the credit grant expires

Returns:

  • (Time, nil) 


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

required :expire_at, Time, api_name: :expireAt, nil?: true

#grant_type ⇒ Symbol, Stigg::Models::V1::Events::Credits::CreditGrantResponse::Data::GrantType

The type of credit grant (PAID, PROMOTIONAL, RECURRING)

Returns:



93
94
95
 
# File 'lib/stigg/models/v1/events/credits/credit_grant_response.rb', line 93

required :grant_type,
enum: -> { Stigg::V1::Events::Credits::CreditGrantResponse::Data::GrantType },
api_name: :grantType

#id ⇒ String

The unique readable identifier of the credit grant

Returns:

  • (String) 


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

required :id, String

#invoice_id ⇒ String?

The billing invoice ID associated with this grant

Returns:

  • (String, nil) 


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

required :invoice_id, String, api_name: :invoiceId, nil?: true

#latest_invoice ⇒ Stigg::Models::V1::Events::Credits::CreditGrantResponse::Data::LatestInvoice?

The latest invoice details for this grant

Returns:



107
108
109
110
 
# File 'lib/stigg/models/v1/events/credits/credit_grant_response.rb', line 107

required :latest_invoice,
-> { Stigg::V1::Events::Credits::CreditGrantResponse::Data::LatestInvoice },
api_name: :latestInvoice,
nil?: true

#metadata ⇒ Hash{Symbol=>String}

Metadata associated with the entity

Returns:

  • (Hash{Symbol=>String}) 


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

required :metadata, Stigg::Internal::Type::HashOf[String]

#payment_collection ⇒ Symbol, Stigg::Models::V1::Events::Credits::CreditGrantResponse::Data::PaymentCollection

The payment collection status

Returns:



122
123
124
 
# File 'lib/stigg/models/v1/events/credits/credit_grant_response.rb', line 122

required :payment_collection,
enum: -> { Stigg::V1::Events::Credits::CreditGrantResponse::Data::PaymentCollection },
api_name: :paymentCollection

#priority ⇒ Float

The priority of the credit grant (lower number = higher priority)

Returns:

  • (Float) 


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

required :priority, Float

#resource_id ⇒ String?

The resource ID this grant is scoped to

Returns:

  • (String, nil) 


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

required :resource_id, String, api_name: :resourceId, nil?: true

#source_type ⇒ Symbol, ...

The source type of the grant (PRICE, PLAN_ENTITLEMENT, ADDON_ENTITLEMENT)

Returns:



142
143
144
145
 
# File 'lib/stigg/models/v1/events/credits/credit_grant_response.rb', line 142

required :source_type,
enum: -> { Stigg::V1::Events::Credits::CreditGrantResponse::Data::SourceType },
api_name: :sourceType,
nil?: true

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

The effective status of the credit grant

Returns:



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

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

#updated_at ⇒ Time

Timestamp of when the record was last updated

Returns:

  • (Time) 


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

required :updated_at, Time, api_name: :updatedAt

#voided_at ⇒ Time?

The date when the credit grant was voided

Returns:

  • (Time, nil) 


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

required :voided_at, Time, api_name: :voidedAt, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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