Class: MetronomeSDK::Models::Contract::Amendment

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

Defined Under Namespace

Classes: ResellerRoyalty

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:, amendments:, current:, customer_id:, initial:, archived_at: nil, custom_fields: nil, customer_billing_provider_configuration: nil, package_id: nil, prepaid_balance_threshold_configuration: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, spend_trackers: nil, subscriptions: nil, uniqueness_key: nil) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::Contract for more details.

Parameters:



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/metronome_sdk/models/contract.rb', line 133

class Amendment < MetronomeSDK::Internal::Type::BaseModel
  # @!attribute id
  #
  #   @return [String]
  required :id, String

  # @!attribute commits
  #
  #   @return [Array<MetronomeSDK::Models::Commit>]
  required :commits, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Commit] }

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

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

  # @!attribute overrides
  #
  #   @return [Array<MetronomeSDK::Models::Override>]
  required :overrides, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Override] }

  # @!attribute scheduled_charges
  #
  #   @return [Array<MetronomeSDK::Models::ScheduledCharge>]
  required :scheduled_charges, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ScheduledCharge] }

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

  # @!attribute credits
  #
  #   @return [Array<MetronomeSDK::Models::Credit>, nil]
  optional :credits, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Credit] }

  # @!attribute discounts
  #   This field's availability is dependent on your client's configuration.
  #
  #   @return [Array<MetronomeSDK::Models::Discount>, nil]
  optional :discounts, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Discount] }

  # @!attribute netsuite_sales_order_id
  #   This field's availability is dependent on your client's configuration.
  #
  #   @return [String, nil]
  optional :netsuite_sales_order_id, String

  # @!attribute professional_services
  #   This field's availability is dependent on your client's configuration.
  #
  #   @return [Array<MetronomeSDK::Models::ProService>, nil]
  optional :professional_services, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ProService] }

  # @!attribute reseller_royalties
  #   This field's availability is dependent on your client's configuration.
  #
  #   @return [Array<MetronomeSDK::Models::Contract::Amendment::ResellerRoyalty>, nil]
  optional :reseller_royalties,
           -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Contract::Amendment::ResellerRoyalty] }

  # @!attribute salesforce_opportunity_id
  #   This field's availability is dependent on your client's configuration.
  #
  #   @return [String, nil]
  optional :salesforce_opportunity_id, String

  # @!method initialize(id:, commits:, created_at:, created_by:, overrides:, scheduled_charges:, starting_at:, credits: nil, discounts: nil, netsuite_sales_order_id: nil, professional_services: nil, reseller_royalties: nil, salesforce_opportunity_id: nil)
  #   @param id [String]
  #
  #   @param commits [Array<MetronomeSDK::Models::Commit>]
  #
  #   @param created_at [Time]
  #
  #   @param created_by [String]
  #
  #   @param overrides [Array<MetronomeSDK::Models::Override>]
  #
  #   @param scheduled_charges [Array<MetronomeSDK::Models::ScheduledCharge>]
  #
  #   @param starting_at [Time]
  #
  #   @param credits [Array<MetronomeSDK::Models::Credit>]
  #
  #   @param discounts [Array<MetronomeSDK::Models::Discount>] This field's availability is dependent on your client's configuration.
  #
  #   @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
  #
  #   @param professional_services [Array<MetronomeSDK::Models::ProService>] This field's availability is dependent on your client's configuration.
  #
  #   @param reseller_royalties [Array<MetronomeSDK::Models::Contract::Amendment::ResellerRoyalty>] This field's availability is dependent on your client's configuration.
  #
  #   @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.

  class ResellerRoyalty < MetronomeSDK::Internal::Type::BaseModel
    # @!attribute reseller_type
    #
    #   @return [Symbol, MetronomeSDK::Models::Contract::Amendment::ResellerRoyalty::ResellerType]
    required :reseller_type, enum: -> { MetronomeSDK::Contract::Amendment::ResellerRoyalty::ResellerType }

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

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

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

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

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

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

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

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

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

    # @!attribute starting_at
    #
    #   @return [Time, nil]
    optional :starting_at, Time

    # @!method initialize(reseller_type:, aws_account_number: nil, aws_offer_id: nil, aws_payer_reference_id: nil, ending_before: nil, fraction: nil, gcp_account_id: nil, gcp_offer_id: nil, netsuite_reseller_id: nil, reseller_contract_value: nil, starting_at: nil)
    #   @param reseller_type [Symbol, MetronomeSDK::Models::Contract::Amendment::ResellerRoyalty::ResellerType]
    #   @param aws_account_number [String]
    #   @param aws_offer_id [String]
    #   @param aws_payer_reference_id [String]
    #   @param ending_before [Time, nil]
    #   @param fraction [Float]
    #   @param gcp_account_id [String]
    #   @param gcp_offer_id [String]
    #   @param netsuite_reseller_id [String]
    #   @param reseller_contract_value [Float]
    #   @param starting_at [Time]

    # @see MetronomeSDK::Models::Contract::Amendment::ResellerRoyalty#reseller_type
    module ResellerType
      extend MetronomeSDK::Internal::Type::Enum

      AWS = :AWS
      AWS_PRO_SERVICE = :AWS_PRO_SERVICE
      GCP = :GCP
      GCP_PRO_SERVICE = :GCP_PRO_SERVICE

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

Instance Attribute Details

#commits ⇒ Array<MetronomeSDK::Models::Commit>

Parameters:

Returns:



142
 
# File 'lib/metronome_sdk/models/contract.rb', line 142

required :commits, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Commit] }

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


147
 
# File 'lib/metronome_sdk/models/contract.rb', line 147

required :created_at, Time

#created_by ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


152
 
# File 'lib/metronome_sdk/models/contract.rb', line 152

required :created_by, String

#credits ⇒ Array<MetronomeSDK::Models::Credit>?

Returns:



172
 
# File 'lib/metronome_sdk/models/contract.rb', line 172

optional :credits, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Credit] }

#discounts ⇒ Array<MetronomeSDK::Models::Discount>?

This field's availability is dependent on your client's configuration.

Returns:



178
 
# File 'lib/metronome_sdk/models/contract.rb', line 178

optional :discounts, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Discount] }

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


137
 
# File 'lib/metronome_sdk/models/contract.rb', line 137

required :id, String

#netsuite_sales_order_id ⇒ String?

This field's availability is dependent on your client's configuration.

Parameters:

  • (String)

Returns:

  • (String, nil) 


184
 
# File 'lib/metronome_sdk/models/contract.rb', line 184

optional :netsuite_sales_order_id, String

#overrides ⇒ Array<MetronomeSDK::Models::Override>

Parameters:

Returns:



157
 
# File 'lib/metronome_sdk/models/contract.rb', line 157

required :overrides, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Override] }

#professional_services ⇒ Array<MetronomeSDK::Models::ProService>?

This field's availability is dependent on your client's configuration.

Returns:



190
 
# File 'lib/metronome_sdk/models/contract.rb', line 190

optional :professional_services, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ProService] }

#reseller_royalties ⇒ Array<MetronomeSDK::Models::Contract::Amendment::ResellerRoyalty>?

This field's availability is dependent on your client's configuration.

Returns:



196
197
 
# File 'lib/metronome_sdk/models/contract.rb', line 196

optional :reseller_royalties,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Contract::Amendment::ResellerRoyalty] }

#salesforce_opportunity_id ⇒ String?

This field's availability is dependent on your client's configuration.

Parameters:

  • (String)

Returns:

  • (String, nil) 


203
 
# File 'lib/metronome_sdk/models/contract.rb', line 203

optional :salesforce_opportunity_id, String

#scheduled_charges ⇒ Array<MetronomeSDK::Models::ScheduledCharge>

Parameters:

Returns:



162
 
# File 'lib/metronome_sdk/models/contract.rb', line 162

required :scheduled_charges, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ScheduledCharge] }

#starting_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


167
 
# File 'lib/metronome_sdk/models/contract.rb', line 167

required :starting_at, Time

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


201
 
# File 'sig/metronome_sdk/models/contract.rbs', line 201

def to_hash: -> {