Class: MetronomeSDK::Models::V1::ContractCreateParams::BillingProviderConfiguration

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/v1/contract_create_params.rb

Defined Under Namespace

Modules: BillingProvider, DeliveryMethod

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(billing_provider: nil, billing_provider_configuration_id: nil, delivery_method: nil) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::ContractCreateParams::BillingProviderConfiguration for more details.

The billing provider configuration associated with a contract. Provide either an ID or the provider and delivery method.

Parameters:



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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 284

class BillingProviderConfiguration < MetronomeSDK::Internal::Type::BaseModel
  # @!attribute billing_provider
  #   Do not specify if using billing_provider_configuration_id.
  #
  #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::BillingProviderConfiguration::BillingProvider, nil]
  optional :billing_provider,
           enum: -> { MetronomeSDK::V1::ContractCreateParams::BillingProviderConfiguration::BillingProvider }

  # @!attribute billing_provider_configuration_id
  #   The Metronome ID of the billing provider configuration. Use when a customer has
  #   multiple configurations with the same billing provider and delivery method.
  #   Otherwise, specify the billing_provider and delivery_method.
  #
  #   @return [String, nil]
  optional :billing_provider_configuration_id, String

  # @!attribute delivery_method
  #   Do not specify if using billing_provider_configuration_id.
  #
  #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::BillingProviderConfiguration::DeliveryMethod, nil]
  optional :delivery_method,
           enum: -> { MetronomeSDK::V1::ContractCreateParams::BillingProviderConfiguration::DeliveryMethod }

  # @!method initialize(billing_provider: nil, billing_provider_configuration_id: nil, delivery_method: nil)
  #   Some parameter documentations has been truncated, see
  #   {MetronomeSDK::Models::V1::ContractCreateParams::BillingProviderConfiguration}
  #   for more details.
  #
  #   The billing provider configuration associated with a contract. Provide either an
  #   ID or the provider and delivery method.
  #
  #   @param billing_provider [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::BillingProviderConfiguration::BillingProvider] Do not specify if using billing_provider_configuration_id.
  #
  #   @param billing_provider_configuration_id [String] The Metronome ID of the billing provider configuration. Use when a customer has
  #
  #   @param delivery_method [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::BillingProviderConfiguration::DeliveryMethod] Do not specify if using billing_provider_configuration_id.

  # Do not specify if using billing_provider_configuration_id.
  #
  # @see MetronomeSDK::Models::V1::ContractCreateParams::BillingProviderConfiguration#billing_provider
  module BillingProvider
    extend MetronomeSDK::Internal::Type::Enum

    AWS_MARKETPLACE = :aws_marketplace
    AZURE_MARKETPLACE = :azure_marketplace
    GCP_MARKETPLACE = :gcp_marketplace
    STRIPE = :stripe
    NETSUITE = :netsuite

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

  # Do not specify if using billing_provider_configuration_id.
  #
  # @see MetronomeSDK::Models::V1::ContractCreateParams::BillingProviderConfiguration#delivery_method
  module DeliveryMethod
    extend MetronomeSDK::Internal::Type::Enum

    DIRECT_TO_BILLING_PROVIDER = :direct_to_billing_provider
    AWS_SQS = :aws_sqs
    TACKLE = :tackle
    AWS_SNS = :aws_sns

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

Instance Attribute Details

#billing_providerSymbol, ...

Do not specify if using billing_provider_configuration_id.



289
290
# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 289

optional :billing_provider,
enum: -> { MetronomeSDK::V1::ContractCreateParams::BillingProviderConfiguration::BillingProvider }

#billing_provider_configuration_idString?

The Metronome ID of the billing provider configuration. Use when a customer has multiple configurations with the same billing provider and delivery method. Otherwise, specify the billing_provider and delivery_method.

Returns:

  • (String, nil)


298
# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 298

optional :billing_provider_configuration_id, String

#delivery_methodSymbol, ...

Do not specify if using billing_provider_configuration_id.



304
305
# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 304

optional :delivery_method,
enum: -> { MetronomeSDK::V1::ContractCreateParams::BillingProviderConfiguration::DeliveryMethod }

Class Method Details

.valuesArray<Symbol>

Returns:

  • (Array<Symbol>)


# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 333