Class: MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem

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

Defined Under Namespace

Classes: Duration, StartingAtOffset

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(amount:, duration:, starting_at_offset:) ⇒ Object

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

Parameters:



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 385

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

  # @!attribute duration
  #   Offset relative to the start of this segment indicating when it should end.
  #
  #   @return [MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem::Duration]
  required :duration,
           -> { MetronomeSDK::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem::Duration }

  # @!attribute starting_at_offset
  #   Date relative to the contract start date indicating the start of this schedule
  #   segment.
  #
  #   @return [MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem::StartingAtOffset]
  required :starting_at_offset,
           -> { MetronomeSDK::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem::StartingAtOffset }

  # @!method initialize(amount:, duration:, starting_at_offset:)
  #   Some parameter documentations has been truncated, see
  #   {MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem}
  #   for more details.
  #
  #   @param amount [Float]
  #
  #   @param duration [MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem::Duration] Offset relative to the start of this segment indicating when it should end.
  #
  #   @param starting_at_offset [MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem::StartingAtOffset] Date relative to the contract start date indicating the start of this schedule s

  # @see MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem#duration
  class Duration < MetronomeSDK::Internal::Type::BaseModel
    # @!attribute unit
    #
    #   @return [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem::Duration::Unit]
    required :unit,
             enum: -> { MetronomeSDK::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem::Duration::Unit }

    # @!attribute value
    #
    #   @return [Integer]
    required :value, Integer

    # @!method initialize(unit:, value:)
    #   Offset relative to the start of this segment indicating when it should end.
    #
    #   @param unit [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem::Duration::Unit]
    #   @param value [Integer]

    # @see MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem::Duration#unit
    module Unit
      extend MetronomeSDK::Internal::Type::Enum

      DAYS = :DAYS
      WEEKS = :WEEKS
      MONTHS = :MONTHS
      YEARS = :YEARS

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

  # @see MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem#starting_at_offset
  class StartingAtOffset < MetronomeSDK::Internal::Type::BaseModel
    # @!attribute unit
    #
    #   @return [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem::StartingAtOffset::Unit]
    required :unit,
             enum: -> { MetronomeSDK::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem::StartingAtOffset::Unit }

    # @!attribute value
    #
    #   @return [Integer]
    required :value, Integer

    # @!method initialize(unit:, value:)
    #   Date relative to the contract start date indicating the start of this schedule
    #   segment.
    #
    #   @param unit [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem::StartingAtOffset::Unit]
    #   @param value [Integer]

    # @see MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem::StartingAtOffset#unit
    module Unit
      extend MetronomeSDK::Internal::Type::Enum

      DAYS = :DAYS
      WEEKS = :WEEKS
      MONTHS = :MONTHS
      YEARS = :YEARS

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

Instance Attribute Details

#amount ⇒ Float

Returns:

  • (Float) 


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

required :amount, Float

#duration ⇒ MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem::Duration

Offset relative to the start of this segment indicating when it should end.

Returns:



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

required :duration,
-> { MetronomeSDK::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem::Duration }

#starting_at_offset ⇒ MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem::StartingAtOffset

Date relative to the contract start date indicating the start of this schedule segment.

Returns:



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

required :starting_at_offset,
-> { MetronomeSDK::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem::StartingAtOffset }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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