Class: Dodopayments::Models::CustomerListEntitlementsResponse::Item

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dodopayments/models/customer_list_entitlements_response.rb,
sig/dodopayments/models/customer_list_entitlements_response.rbs

Defined Under Namespace

Modules: Status

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(created_at:, entitlement_id:, entitlement_name:, grant_id:, integration_type:, status:, updated_at:, delivered_at: nil, entitlement_description: nil, revoked_at: nil) ⇒ Object

Parameters:



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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/dodopayments/models/customer_list_entitlements_response.rb', line 16

class Item < Dodopayments::Internal::Type::BaseModel
  # @!attribute created_at
  #
  #   @return [Time]
  required :created_at, Time

  # @!attribute entitlement_id
  #   The entitlement this grant belongs to.
  #
  #   @return [String]
  required :entitlement_id, String

  # @!attribute entitlement_name
  #
  #   @return [String]
  required :entitlement_name, String

  # @!attribute grant_id
  #   Grant id (the per-customer row in `entitlement_grants`).
  #
  #   @return [String]
  required :grant_id, String

  # @!attribute integration_type
  #
  #   @return [Symbol, Dodopayments::Models::EntitlementIntegrationType]
  required :integration_type, enum: -> { Dodopayments::EntitlementIntegrationType }

  # @!attribute status
  #
  #   @return [Symbol, Dodopayments::Models::CustomerListEntitlementsResponse::Item::Status]
  required :status, enum: -> { Dodopayments::Models::CustomerListEntitlementsResponse::Item::Status }

  # @!attribute updated_at
  #
  #   @return [Time]
  required :updated_at, Time

  # @!attribute delivered_at
  #
  #   @return [Time, nil]
  optional :delivered_at, Time, nil?: true

  # @!attribute entitlement_description
  #
  #   @return [String, nil]
  optional :entitlement_description, String, nil?: true

  # @!attribute revoked_at
  #
  #   @return [Time, nil]
  optional :revoked_at, Time, nil?: true

  # @!method initialize(created_at:, entitlement_id:, entitlement_name:, grant_id:, integration_type:, status:, updated_at:, delivered_at: nil, entitlement_description: nil, revoked_at: nil)
  #   @param created_at [Time]
  #
  #   @param entitlement_id [String] The entitlement this grant belongs to.
  #
  #   @param entitlement_name [String]
  #
  #   @param grant_id [String] Grant id (the per-customer row in `entitlement_grants`).
  #
  #   @param integration_type [Symbol, Dodopayments::Models::EntitlementIntegrationType]
  #
  #   @param status [Symbol, Dodopayments::Models::CustomerListEntitlementsResponse::Item::Status]
  #
  #   @param updated_at [Time]
  #
  #   @param delivered_at [Time, nil]
  #
  #   @param entitlement_description [String, nil]
  #
  #   @param revoked_at [Time, nil]

  # @see Dodopayments::Models::CustomerListEntitlementsResponse::Item#status
  module Status
    extend Dodopayments::Internal::Type::Enum

    PENDING = :pending
    DELIVERED = :delivered
    FAILED = :failed
    REVOKED = :revoked

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


20
 
# File 'lib/dodopayments/models/customer_list_entitlements_response.rb', line 20

required :created_at, Time

#delivered_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


57
 
# File 'lib/dodopayments/models/customer_list_entitlements_response.rb', line 57

optional :delivered_at, Time, nil?: true

#entitlement_description ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


62
 
# File 'lib/dodopayments/models/customer_list_entitlements_response.rb', line 62

optional :entitlement_description, String, nil?: true

#entitlement_id ⇒ String

The entitlement this grant belongs to.

Parameters:

  • value (String)

Returns:

  • (String) 


26
 
# File 'lib/dodopayments/models/customer_list_entitlements_response.rb', line 26

required :entitlement_id, String

#entitlement_name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


31
 
# File 'lib/dodopayments/models/customer_list_entitlements_response.rb', line 31

required :entitlement_name, String

#grant_id ⇒ String

Grant id (the per-customer row in entitlement_grants).

Parameters:

  • value (String)

Returns:

  • (String) 


37
 
# File 'lib/dodopayments/models/customer_list_entitlements_response.rb', line 37

required :grant_id, String

#integration_type ⇒ Symbol, Dodopayments::Models::EntitlementIntegrationType

Parameters:

  • value (Dodopayments::Models::entitlement_integration_type)

Returns:



42
 
# File 'lib/dodopayments/models/customer_list_entitlements_response.rb', line 42

required :integration_type, enum: -> { Dodopayments::EntitlementIntegrationType }

#revoked_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


67
 
# File 'lib/dodopayments/models/customer_list_entitlements_response.rb', line 67

optional :revoked_at, Time, nil?: true

#status ⇒ Symbol, Dodopayments::Models::CustomerListEntitlementsResponse::Item::Status

Parameters:

  • value (Dodopayments::Models::CustomerListEntitlementsResponse::Item::status)

Returns:



47
 
# File 'lib/dodopayments/models/customer_list_entitlements_response.rb', line 47

required :status, enum: -> { Dodopayments::Models::CustomerListEntitlementsResponse::Item::Status }

#updated_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


52
 
# File 'lib/dodopayments/models/customer_list_entitlements_response.rb', line 52

required :updated_at, Time

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


67
 
# File 'sig/dodopayments/models/customer_list_entitlements_response.rbs', line 67

def to_hash: -> {