Class: MetronomeSDK::Models::V1::PackageCreateParams::Credit::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::Credit::AccessSchedule::ScheduleItem for more details.

Parameters:



720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 720

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::Credit::AccessSchedule::ScheduleItem::Duration]
  required :duration,
           -> { MetronomeSDK::V1::PackageCreateParams::Credit::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::Credit::AccessSchedule::ScheduleItem::StartingAtOffset]
  required :starting_at_offset,
           -> { MetronomeSDK::V1::PackageCreateParams::Credit::AccessSchedule::ScheduleItem::StartingAtOffset }

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

  # @see MetronomeSDK::Models::V1::PackageCreateParams::Credit::AccessSchedule::ScheduleItem#duration
  class Duration < MetronomeSDK::Internal::Type::BaseModel
    # @!attribute unit
    #
    #   @return [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::Credit::AccessSchedule::ScheduleItem::Duration::Unit]
    required :unit,
             enum: -> { MetronomeSDK::V1::PackageCreateParams::Credit::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::Credit::AccessSchedule::ScheduleItem::Duration::Unit]
    #   @param value [Integer]

    # @see MetronomeSDK::Models::V1::PackageCreateParams::Credit::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::Credit::AccessSchedule::ScheduleItem#starting_at_offset
  class StartingAtOffset < MetronomeSDK::Internal::Type::BaseModel
    # @!attribute unit
    #
    #   @return [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::Credit::AccessSchedule::ScheduleItem::StartingAtOffset::Unit]
    required :unit,
             enum: -> { MetronomeSDK::V1::PackageCreateParams::Credit::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::Credit::AccessSchedule::ScheduleItem::StartingAtOffset::Unit]
    #   @param value [Integer]

    # @see MetronomeSDK::Models::V1::PackageCreateParams::Credit::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) 


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

required :amount, Float

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

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

Returns:



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

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

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

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

Returns:



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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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