Class: Dodopayments::Models::CustomerListCreditEntitlementsResponse::Item

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dodopayments/models/customer_list_credit_entitlements_response.rb

Instance Attribute 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(balance:, credit_entitlement_id:, name:, overage:, unit:, description: nil) ⇒ Object

A credit entitlement with the customer’s current balance

Parameters:

  • balance (String) —

    Customer’s current remaining credit balance

  • credit_entitlement_id (String) —

    Credit entitlement ID

  • name (String) —

    Name of the credit entitlement

  • overage (String) —

    Customer’s current overage balance

  • unit (String) —

    Unit label (e.g. “API Calls”, “Tokens”)

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

    Description of the credit entitlement



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/dodopayments/models/customer_list_credit_entitlements_response.rb', line 16

class Item < Dodopayments::Internal::Type::BaseModel
  # @!attribute balance
  #   Customer's current remaining credit balance
  #
  #   @return [String]
  required :balance, String

  # @!attribute credit_entitlement_id
  #   Credit entitlement ID
  #
  #   @return [String]
  required :credit_entitlement_id, String

  # @!attribute name
  #   Name of the credit entitlement
  #
  #   @return [String]
  required :name, String

  # @!attribute overage
  #   Customer's current overage balance
  #
  #   @return [String]
  required :overage, String

  # @!attribute unit
  #   Unit label (e.g. "API Calls", "Tokens")
  #
  #   @return [String]
  required :unit, String

  # @!attribute description
  #   Description of the credit entitlement
  #
  #   @return [String, nil]
  optional :description, String, nil?: true

  # @!method initialize(balance:, credit_entitlement_id:, name:, overage:, unit:, description: nil)
  #   A credit entitlement with the customer's current balance
  #
  #   @param balance [String] Customer's current remaining credit balance
  #
  #   @param credit_entitlement_id [String] Credit entitlement ID
  #
  #   @param name [String] Name of the credit entitlement
  #
  #   @param overage [String] Customer's current overage balance
  #
  #   @param unit [String] Unit label (e.g. "API Calls", "Tokens")
  #
  #   @param description [String, nil] Description of the credit entitlement
end

Instance Attribute Details

#balance ⇒ String

Customer’s current remaining credit balance

Returns:

  • (String) 


21
 
# File 'lib/dodopayments/models/customer_list_credit_entitlements_response.rb', line 21

required :balance, String

#credit_entitlement_id ⇒ String

Credit entitlement ID

Returns:

  • (String) 


27
 
# File 'lib/dodopayments/models/customer_list_credit_entitlements_response.rb', line 27

required :credit_entitlement_id, String

#description ⇒ String?

Description of the credit entitlement

Returns:

  • (String, nil) 


51
 
# File 'lib/dodopayments/models/customer_list_credit_entitlements_response.rb', line 51

optional :description, String, nil?: true

#name ⇒ String

Name of the credit entitlement

Returns:

  • (String) 


33
 
# File 'lib/dodopayments/models/customer_list_credit_entitlements_response.rb', line 33

required :name, String

#overage ⇒ String

Customer’s current overage balance

Returns:

  • (String) 


39
 
# File 'lib/dodopayments/models/customer_list_credit_entitlements_response.rb', line 39

required :overage, String

#unit ⇒ String

Unit label (e.g. “API Calls”, “Tokens”)

Returns:

  • (String) 


45
 
# File 'lib/dodopayments/models/customer_list_credit_entitlements_response.rb', line 45

required :unit, String