Class: Crisphive::JobRequestTimeSegmentsSlot

Inherits:
Object
  • Object
show all
Defined in:
lib/crisphive/models/job_request_time_segments_slot.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JobRequestTimeSegmentsSlot

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 125

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Crisphive::JobRequestTimeSegmentsSlot` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Crisphive::JobRequestTimeSegmentsSlot`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'available_workers')
    if (value = attributes[:'available_workers']).is_a?(Array)
      self.available_workers = value
    end
  end

  if attributes.key?(:'best_time')
    self.best_time = attributes[:'best_time']
  end

  if attributes.key?(:'business_time')
    self.business_time = attributes[:'business_time']
  end

  if attributes.key?(:'datetime')
    self.datetime = attributes[:'datetime']
  end

  if attributes.key?(:'ends_at')
    self.ends_at = attributes[:'ends_at']
  end

  if attributes.key?(:'multi_day')
    self.multi_day = attributes[:'multi_day']
  end

  if attributes.key?(:'sessions')
    if (value = attributes[:'sessions']).is_a?(Array)
      self.sessions = value
    end
  end

  if attributes.key?(:'time')
    self.time = attributes[:'time']
  end

  if attributes.key?(:'time_end')
    self.time_end = attributes[:'time_end']
  end

  if attributes.key?(:'time_period')
    self.time_period = attributes[:'time_period']
  end

  if attributes.key?(:'time_period_label')
    self.time_period_label = attributes[:'time_period_label']
  end

  if attributes.key?(:'workers_count')
    self.workers_count = attributes[:'workers_count']
  end
end

Instance Attribute Details

#available_workers ⇒ Object

Technicians feasible for this slot, engine-ranked best first, each with its score breakdown.



19
20
21
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 19

def available_workers
  @available_workers
end

#best_time ⇒ Object

True on the first slot of each day — the suggested "BEST" pick (UI hint).



22
23
24
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 22

def best_time
  @best_time
end

#business_time ⇒ Object

The same arrival window expressed in BUSINESS-local time; its naive datetime is the value to send back on confirm.



25
26
27
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 25

def business_time
  @business_time
end

#datetime ⇒ Object

Window start as an RFC3339 customer-local instant (with UTC offset).



28
29
30
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 28

def datetime
  @datetime
end

#ends_at ⇒ Object

Span end (UTC) of a multi-day visit — render in business/customer timezone. Omitted for single-day slots.



31
32
33
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 31

def ends_at
  @ends_at
end

#multi_day ⇒ Object

MultiDay flags a slot whose visit cannot finish in one day and spans consecutive days. EndsAt + Sessions are then populated (for the best-ranked candidate — the one auto-assign would pick) so the picker can show the customer "this start runs until , over N days" BEFORE they confirm. Single-day slots leave these empty (the slot itself is the visit).



34
35
36
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 34

def multi_day
  @multi_day
end

#sessions ⇒ Object

Per-day session plan of a multi-day visit (for the best-ranked candidate). Omitted for single-day slots.



37
38
39
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 37

def sessions
  @sessions
end

#time ⇒ Object

Arrival-window start, HH:MM customer-local.



40
41
42
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 40

def time
  @time
end

#time_end ⇒ Object

Arrival-window end, HH:MM customer-local (= time + time_slot_step_minutes).



43
44
45
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 43

def time_end
  @time_end
end

#time_period ⇒ Object

Period bucket of the window start: 1=morning, 2=afternoon, 3=evening.



46
47
48
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 46

def time_period
  @time_period
end

#time_period_label ⇒ Object

Localized label for time_period.



49
50
51
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 49

def time_period_label
  @time_period_label
end

#workers_count ⇒ Object

Number of entries in available_workers.



52
53
54
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 52

def workers_count
  @workers_count
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 288

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Crisphive.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



95
96
97
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 95

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 77

def self.attribute_map
  {
    :'available_workers' => :'available_workers',
    :'best_time' => :'best_time',
    :'business_time' => :'business_time',
    :'datetime' => :'datetime',
    :'ends_at' => :'ends_at',
    :'multi_day' => :'multi_day',
    :'sessions' => :'sessions',
    :'time' => :'time',
    :'time_end' => :'time_end',
    :'time_period' => :'time_period',
    :'time_period_label' => :'time_period_label',
    :'workers_count' => :'workers_count'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 264

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 118

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 100

def self.openapi_types
  {
    :'available_workers' => :'Array<JobRequestTimeSegmentsWorker>',
    :'best_time' => :'Boolean',
    :'business_time' => :'JobRequestTimeSegmentsBusinessTime',
    :'datetime' => :'Time',
    :'ends_at' => :'Time',
    :'multi_day' => :'Boolean',
    :'sessions' => :'Array<JobRequestSession>',
    :'time' => :'String',
    :'time_end' => :'String',
    :'time_period' => :'Integer',
    :'time_period_label' => :'String',
    :'workers_count' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 232

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      available_workers == o.available_workers &&
      best_time == o.best_time &&
      business_time == o.business_time &&
      datetime == o.datetime &&
      ends_at == o.ends_at &&
      multi_day == o.multi_day &&
      sessions == o.sessions &&
      time == o.time &&
      time_end == o.time_end &&
      time_period == o.time_period &&
      time_period_label == o.time_period_label &&
      workers_count == o.workers_count
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 359

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


251
252
253
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 251

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



257
258
259
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 257

def hash
  [available_workers, best_time, business_time, datetime, ends_at, multi_day, sessions, time, time_end, time_period, time_period_label, workers_count].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



193
194
195
196
197
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 193

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



335
336
337
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 335

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 341

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



329
330
331
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 329

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



201
202
203
204
205
206
207
208
 
# File 'lib/crisphive/models/job_request_time_segments_slot.rb', line 201

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  time_period_validator = EnumAttributeValidator.new('Integer', [1, 2, 3])
  return false unless time_period_validator.valid?(@time_period)
  time_period_label_validator = EnumAttributeValidator.new('String', ["Morning", "Afternoon", "Evening"])
  return false unless time_period_label_validator.valid?(@time_period_label)
  true
end