Class: MetronomeSDK::Models::V1::PlanDetail::CreditGrant

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/v1/plan_detail.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(id: , custom_fields: , name: , credit_grants: nil, description: nil, minimums: nil, overage_rates: nil) ⇒ Object

Parameters:



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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 60

class CreditGrant < MetronomeSDK::Internal::Type::BaseModel
  # @!attribute amount_granted
  #
  #   @return [Float]
  required :amount_granted, Float

  # @!attribute amount_granted_credit_type
  #
  #   @return [MetronomeSDK::Models::CreditTypeData]
  required :amount_granted_credit_type, -> { MetronomeSDK::CreditTypeData }

  # @!attribute amount_paid
  #
  #   @return [Float]
  required :amount_paid, Float

  # @!attribute amount_paid_credit_type
  #
  #   @return [MetronomeSDK::Models::CreditTypeData]
  required :amount_paid_credit_type, -> { MetronomeSDK::CreditTypeData }

  # @!attribute effective_duration
  #
  #   @return [Float]
  required :effective_duration, Float

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

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

  # @!attribute send_invoice
  #
  #   @return [Boolean]
  required :send_invoice, MetronomeSDK::Internal::Type::Boolean

  # @!attribute reason
  #
  #   @return [String, nil]
  optional :reason, String

  # @!attribute recurrence_duration
  #
  #   @return [Float, nil]
  optional :recurrence_duration, Float

  # @!attribute recurrence_interval
  #
  #   @return [Float, nil]
  optional :recurrence_interval, Float

  # @!method initialize(amount_granted:, amount_granted_credit_type:, amount_paid:, amount_paid_credit_type:, effective_duration:, name:, priority:, send_invoice:, reason: nil, recurrence_duration: nil, recurrence_interval: nil)
  #   @param amount_granted [Float]
  #   @param amount_granted_credit_type [MetronomeSDK::Models::CreditTypeData]
  #   @param amount_paid [Float]
  #   @param amount_paid_credit_type [MetronomeSDK::Models::CreditTypeData]
  #   @param effective_duration [Float]
  #   @param name [String]
  #   @param priority [String]
  #   @param send_invoice [Boolean]
  #   @param reason [String]
  #   @param recurrence_duration [Float]
  #   @param recurrence_interval [Float]
end

Instance Attribute Details

#amount_granted ⇒ Float

Returns:

  • (Float) 


64
 
# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 64

required :amount_granted, Float

#amount_granted_credit_type ⇒ MetronomeSDK::Models::CreditTypeData

Returns:



69
 
# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 69

required :amount_granted_credit_type, -> { MetronomeSDK::CreditTypeData }

#amount_paid ⇒ Float

Returns:

  • (Float) 


74
 
# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 74

required :amount_paid, Float

#amount_paid_credit_type ⇒ MetronomeSDK::Models::CreditTypeData

Returns:



79
 
# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 79

required :amount_paid_credit_type, -> { MetronomeSDK::CreditTypeData }

#effective_duration ⇒ Float

Returns:

  • (Float) 


84
 
# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 84

required :effective_duration, Float

#name ⇒ String

Returns:

  • (String) 


89
 
# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 89

required :name, String

#priority ⇒ String

Returns:

  • (String) 


94
 
# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 94

required :priority, String

#reason ⇒ String?

Returns:

  • (String, nil) 


104
 
# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 104

optional :reason, String

#recurrence_duration ⇒ Float?

Returns:

  • (Float, nil) 


109
 
# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 109

optional :recurrence_duration, Float

#recurrence_interval ⇒ Float?

Returns:

  • (Float, nil) 


114
 
# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 114

optional :recurrence_interval, Float

#send_invoice ⇒ Boolean

Returns:

  • (Boolean) 


99
 
# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 99

required :send_invoice, MetronomeSDK::Internal::Type::Boolean