Class: MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::Selector

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

Defined Under Namespace

Modules: BillingFrequency

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(billing_frequency: nil, partial_pricing_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil) ⇒ Object

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

Parameters:

  • billing_frequency (Symbol, MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::Selector::BillingFrequency) (defaults to: nil) —

    Subscription rates matching the billing frequency will be included in the respon

  • partial_pricing_group_values (Hash{Symbol=>String}) (defaults to: nil) —

    List of pricing group key value pairs, rates containing the matching key / value

  • pricing_group_values (Hash{Symbol=>String}) (defaults to: nil) —

    List of pricing group key value pairs, rates matching all of the key / value pai

  • product_id (String) (defaults to: nil) —

    Rates matching the product id will be included in the response.

  • product_tags (Array<String>) (defaults to: nil) —

    List of product tags, rates matching any of the tags will be included in the res



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb', line 68

class Selector < MetronomeSDK::Internal::Type::BaseModel
  # @!attribute billing_frequency
  #   Subscription rates matching the billing frequency will be included in the
  #   response.
  #
  #   @return [Symbol, MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::Selector::BillingFrequency, nil]
  optional :billing_frequency,
           enum: -> { MetronomeSDK::V1::ContractRetrieveRateScheduleParams::Selector::BillingFrequency }

  # @!attribute partial_pricing_group_values
  #   List of pricing group key value pairs, rates containing the matching key / value
  #   pairs will be included in the response.
  #
  #   @return [Hash{Symbol=>String}, nil]
  optional :partial_pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]

  # @!attribute pricing_group_values
  #   List of pricing group key value pairs, rates matching all of the key / value
  #   pairs will be included in the response.
  #
  #   @return [Hash{Symbol=>String}, nil]
  optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]

  # @!attribute product_id
  #   Rates matching the product id will be included in the response.
  #
  #   @return [String, nil]
  optional :product_id, String

  # @!attribute product_tags
  #   List of product tags, rates matching any of the tags will be included in the
  #   response.
  #
  #   @return [Array<String>, nil]
  optional :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]

  # @!method initialize(billing_frequency: nil, partial_pricing_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil)
  #   Some parameter documentations has been truncated, see
  #   {MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::Selector} for
  #   more details.
  #
  #   @param billing_frequency [Symbol, MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::Selector::BillingFrequency] Subscription rates matching the billing frequency will be included in the respon
  #
  #   @param partial_pricing_group_values [Hash{Symbol=>String}] List of pricing group key value pairs, rates containing the matching key / value
  #
  #   @param pricing_group_values [Hash{Symbol=>String}] List of pricing group key value pairs, rates matching all of the key / value pai
  #
  #   @param product_id [String] Rates matching the product id will be included in the response.
  #
  #   @param product_tags [Array<String>] List of product tags, rates matching any of the tags will be included in the res

  # Subscription rates matching the billing frequency will be included in the
  # response.
  #
  # @see MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::Selector#billing_frequency
  module BillingFrequency
    extend MetronomeSDK::Internal::Type::Enum

    MONTHLY = :MONTHLY
    QUARTERLY = :QUARTERLY
    ANNUAL = :ANNUAL
    WEEKLY = :WEEKLY

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

Instance Attribute Details

#billing_frequency ⇒ Symbol, ...

Subscription rates matching the billing frequency will be included in the response.

Returns:



74
75
 
# File 'lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb', line 74

optional :billing_frequency,
enum: -> { MetronomeSDK::V1::ContractRetrieveRateScheduleParams::Selector::BillingFrequency }

#partial_pricing_group_values ⇒ Hash{Symbol=>String}?

List of pricing group key value pairs, rates containing the matching key / value pairs will be included in the response.

Returns:

  • (Hash{Symbol=>String}, nil) 


82
 
# File 'lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb', line 82

optional :partial_pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]

#pricing_group_values ⇒ Hash{Symbol=>String}?

List of pricing group key value pairs, rates matching all of the key / value pairs will be included in the response.

Returns:

  • (Hash{Symbol=>String}, nil) 


89
 
# File 'lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb', line 89

optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]

#product_id ⇒ String?

Rates matching the product id will be included in the response.

Returns:

  • (String, nil) 


95
 
# File 'lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb', line 95

optional :product_id, String

#product_tags ⇒ Array<String>?

List of product tags, rates matching any of the tags will be included in the response.

Returns:

  • (Array<String>, nil) 


102
 
# File 'lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb', line 102

optional :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]