Class: ApiReference::MinimumInterval

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/api_reference/models/minimum_interval.rb

Overview

MinimumInterval Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(start_date:, end_date:, filters:, applies_to_price_interval_ids:, minimum_amount:, additional_properties: nil) ⇒ MinimumInterval

Returns a new instance of MinimumInterval.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/api_reference/models/minimum_interval.rb', line 58

def initialize(start_date:, end_date:, filters:,
               applies_to_price_interval_ids:, minimum_amount:,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @start_date = start_date
  @end_date = end_date
  @filters = filters
  @applies_to_price_interval_ids = applies_to_price_interval_ids
  @minimum_amount = minimum_amount
  @additional_properties = additional_properties
end

Instance Attribute Details

#applies_to_price_interval_ids ⇒ Array[String]

The price interval ids that this minimum interval applies to.

Returns:

  • (Array[String]) 


27
28
29
 
# File 'lib/api_reference/models/minimum_interval.rb', line 27

def applies_to_price_interval_ids
  @applies_to_price_interval_ids
end

#end_date ⇒ DateTime

The end date of the minimum interval.

Returns:

  • (DateTime) 


19
20
21
 
# File 'lib/api_reference/models/minimum_interval.rb', line 19

def end_date
  @end_date
end

#filters ⇒ Array[PriceFilter]

The filters that determine which prices this minimum interval applies to.

Returns:



23
24
25
 
# File 'lib/api_reference/models/minimum_interval.rb', line 23

def filters
  @filters
end

#minimum_amount ⇒ String

The minimum amount to charge in a given billing period for the price intervals this minimum applies to.

Returns:

  • (String) 


32
33
34
 
# File 'lib/api_reference/models/minimum_interval.rb', line 32

def minimum_amount
  @minimum_amount
end

#start_date ⇒ DateTime

The start date of the minimum interval.

Returns:

  • (DateTime) 


15
16
17
 
# File 'lib/api_reference/models/minimum_interval.rb', line 15

def start_date
  @start_date
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
 
# File 'lib/api_reference/models/minimum_interval.rb', line 73

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  start_date = if hash.key?('start_date')
                 (DateTimeHelper.from_rfc3339(hash['start_date']) if hash['start_date'])
               end
  end_date = if hash.key?('end_date')
               (DateTimeHelper.from_rfc3339(hash['end_date']) if hash['end_date'])
             end
  # Parameter is an array, so we need to iterate through it
  filters = nil
  unless hash['filters'].nil?
    filters = []
    hash['filters'].each do |structure|
      filters << (PriceFilter.from_hash(structure) if structure)
    end
  end

  filters = nil unless hash.key?('filters')
  applies_to_price_interval_ids =
    hash.key?('applies_to_price_interval_ids') ? hash['applies_to_price_interval_ids'] : nil
  minimum_amount =
    hash.key?('minimum_amount') ? hash['minimum_amount'] : nil

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  MinimumInterval.new(start_date: start_date,
                      end_date: end_date,
                      filters: filters,
                      applies_to_price_interval_ids: applies_to_price_interval_ids,
                      minimum_amount: minimum_amount,
                      additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/api_reference/models/minimum_interval.rb', line 35

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['start_date'] = 'start_date'
  @_hash['end_date'] = 'end_date'
  @_hash['filters'] = 'filters'
  @_hash['applies_to_price_interval_ids'] =
    'applies_to_price_interval_ids'
  @_hash['minimum_amount'] = 'minimum_amount'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



52
53
54
55
56
 
# File 'lib/api_reference/models/minimum_interval.rb', line 52

def self.nullables
  %w[
    end_date
  ]
end

.optionals ⇒ Object

An array for optional fields



47
48
49
 
# File 'lib/api_reference/models/minimum_interval.rb', line 47

def self.optionals
  []
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:

  • The (MinimumInterval | Hash) —

    value against the validation is performed.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/api_reference/models/minimum_interval.rb', line 124

def self.validate(value)
  if value.instance_of? self
    return (
      APIHelper.valid_type?(value.start_date,
                            ->(val) { val.instance_of? DateTime }) and
        APIHelper.valid_type?(value.end_date,
                              ->(val) { val.instance_of? DateTime }) and
        APIHelper.valid_type?(value.filters,
                              ->(val) { PriceFilter.validate(val) },
                              is_model_hash: true,
                              is_inner_model_hash: true) and
        APIHelper.valid_type?(value.applies_to_price_interval_ids,
                              ->(val) { val.instance_of? String }) and
        APIHelper.valid_type?(value.minimum_amount,
                              ->(val) { val.instance_of? String })
    )
  end

  return false unless value.instance_of? Hash

  (
    APIHelper.valid_type?(value['start_date'],
                          ->(val) { val.instance_of? String }) and
      APIHelper.valid_type?(value['end_date'],
                            ->(val) { val.instance_of? String }) and
      APIHelper.valid_type?(value['filters'],
                            ->(val) { PriceFilter.validate(val) },
                            is_model_hash: true,
                            is_inner_model_hash: true) and
      APIHelper.valid_type?(value['applies_to_price_interval_ids'],
                            ->(val) { val.instance_of? String }) and
      APIHelper.valid_type?(value['minimum_amount'],
                            ->(val) { val.instance_of? String })
  )
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



169
170
171
172
173
174
175
 
# File 'lib/api_reference/models/minimum_interval.rb', line 169

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} start_date: #{@start_date.inspect}, end_date: #{@end_date.inspect},"\
  " filters: #{@filters.inspect}, applies_to_price_interval_ids:"\
  " #{@applies_to_price_interval_ids.inspect}, minimum_amount: #{@minimum_amount.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_custom_end_date ⇒ Object 



118
119
120
 
# File 'lib/api_reference/models/minimum_interval.rb', line 118

def to_custom_end_date
  DateTimeHelper.to_rfc3339(end_date)
end

#to_custom_start_date ⇒ Object 



114
115
116
 
# File 'lib/api_reference/models/minimum_interval.rb', line 114

def to_custom_start_date
  DateTimeHelper.to_rfc3339(start_date)
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



161
162
163
164
165
166
 
# File 'lib/api_reference/models/minimum_interval.rb', line 161

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} start_date: #{@start_date}, end_date: #{@end_date}, filters: #{@filters},"\
  " applies_to_price_interval_ids: #{@applies_to_price_interval_ids}, minimum_amount:"\
  " #{@minimum_amount}, additional_properties: #{@additional_properties}>"
end