Class: MetronomeSDK::Models::V1::PackageCreateParams::UsageStatementSchedule

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

Defined Under Namespace

Modules: Day, Frequency Classes: InvoiceGenerationStartingAtOffset

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(frequency:, day: nil, invoice_generation_starting_at_offset: nil) ⇒ Object

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

Parameters:




# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2706

Instance Attribute Details

#day ⇒ Symbol, ...

If not provided, defaults to the first day of the month.

Returns:



2693
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2693

optional :day, enum: -> { MetronomeSDK::V1::PackageCreateParams::UsageStatementSchedule::Day }

#frequency ⇒ Symbol, MetronomeSDK::Models::V1::PackageCreateParams::UsageStatementSchedule::Frequency

Returns:



2687
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2687

required :frequency, enum: -> { MetronomeSDK::V1::PackageCreateParams::UsageStatementSchedule::Frequency }

#invoice_generation_starting_at_offset ⇒ MetronomeSDK::Models::V1::PackageCreateParams::UsageStatementSchedule::InvoiceGenerationStartingAtOffset?

The offset at which Metronome should start generating usage invoices, relative to the contract start date. If unspecified, contract start date will be used. This is useful to set if you want to import historical invoices via our ‘Create Historical Invoices’ API rather than having Metronome automatically generate them.

Returns:



2703
2704
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2703

optional :invoice_generation_starting_at_offset,
-> { MetronomeSDK::V1::PackageCreateParams::UsageStatementSchedule::InvoiceGenerationStartingAtOffset }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2726