Class: UltracartClient::WorkflowTasksRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/workflow_tasks_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkflowTasksRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 164

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::WorkflowTasksRequest` 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 `UltracartClient::WorkflowTasksRequest`. 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?(:'assigned_to_group')
    self.assigned_to_group = attributes[:'assigned_to_group']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#assigned_to_group ⇒ Object

Assigned to group



19
20
21
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 19

def assigned_to_group
  @assigned_to_group
end

#assigned_to_group_id ⇒ Object

Assigned to group ID



22
23
24
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 22

def assigned_to_group_id
  @assigned_to_group_id
end

#assigned_to_me ⇒ Object

Tasks are assigned to me either by direct user id or a group that the user is a member of



25
26
27
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 25

def assigned_to_me
  @assigned_to_me
end

#assigned_to_user ⇒ Object

Assigned to user



28
29
30
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 28

def assigned_to_user
  @assigned_to_user
end

#assigned_to_user_id ⇒ Object

Assigned to user ID



31
32
33
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 31

def assigned_to_user_id
  @assigned_to_user_id
end

#created_by ⇒ Object

Returns the value of attribute created_by.



33
34
35
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 33

def created_by
  @created_by
end

#created_dts_begin ⇒ Object

Date/time that the workflow task was created



36
37
38
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 36

def created_dts_begin
  @created_dts_begin
end

#created_dts_end ⇒ Object

Date/time that the workflow task was created



39
40
41
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 39

def created_dts_end
  @created_dts_end
end

#delay_until_dts_begin ⇒ Object

Date/time that the workflow task should delay until



42
43
44
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 42

def delay_until_dts_begin
  @delay_until_dts_begin
end

#delay_until_dts_end ⇒ Object

Date/time that the workflow task should delay until



45
46
47
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 45

def delay_until_dts_end
  @delay_until_dts_end
end

#due_dts_begin ⇒ Object

Date/time that the workflow task is due



48
49
50
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 48

def due_dts_begin
  @due_dts_begin
end

#due_dts_end ⇒ Object

Date/time that the workflow task is due



51
52
53
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 51

def due_dts_end
  @due_dts_end
end

#last_update_dts_begin ⇒ Object

Date/time that the workflow task was last updated



54
55
56
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 54

def last_update_dts_begin
  @last_update_dts_begin
end

#last_update_dts_end ⇒ Object

Date/time that the workflow task was last updated



57
58
59
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 57

def last_update_dts_end
  @last_update_dts_end
end

#object_email ⇒ Object

Object is associated with customer email



60
61
62
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 60

def object_email
  @object_email
end

#object_type ⇒ Object

Object Type



63
64
65
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 63

def object_type
  @object_type
end

#priority ⇒ Object

Priority



66
67
68
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 66

def priority
  @priority
end

#status ⇒ Object

Status of the workflow task



69
70
71
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 69

def status
  @status
end

#tags ⇒ Object

Tasks that are tagged with the specified tags



72
73
74
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 72

def tags
  @tags
end

#unassigned ⇒ Object

Tasks that are unassigned to a user or group



75
76
77
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 75

def unassigned
  @unassigned
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



126
127
128
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 126

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 100

def self.attribute_map
  {
    :'assigned_to_group' => :'assigned_to_group',
    :'assigned_to_group_id' => :'assigned_to_group_id',
    :'assigned_to_me' => :'assigned_to_me',
    :'assigned_to_user' => :'assigned_to_user',
    :'assigned_to_user_id' => :'assigned_to_user_id',
    :'created_by' => :'created_by',
    :'created_dts_begin' => :'created_dts_begin',
    :'created_dts_end' => :'created_dts_end',
    :'delay_until_dts_begin' => :'delay_until_dts_begin',
    :'delay_until_dts_end' => :'delay_until_dts_end',
    :'due_dts_begin' => :'due_dts_begin',
    :'due_dts_end' => :'due_dts_end',
    :'last_update_dts_begin' => :'last_update_dts_begin',
    :'last_update_dts_end' => :'last_update_dts_end',
    :'object_email' => :'object_email',
    :'object_type' => :'object_type',
    :'priority' => :'priority',
    :'status' => :'status',
    :'tags' => :'tags',
    :'unassigned' => :'unassigned'
  }
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



351
352
353
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 351

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



157
158
159
160
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 157

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

.openapi_types ⇒ Object

Attribute type mapping.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 131

def self.openapi_types
  {
    :'assigned_to_group' => :'String',
    :'assigned_to_group_id' => :'Integer',
    :'assigned_to_me' => :'Boolean',
    :'assigned_to_user' => :'String',
    :'assigned_to_user_id' => :'Integer',
    :'created_by' => :'WorkflowUser',
    :'created_dts_begin' => :'String',
    :'created_dts_end' => :'String',
    :'delay_until_dts_begin' => :'String',
    :'delay_until_dts_end' => :'String',
    :'due_dts_begin' => :'String',
    :'due_dts_end' => :'String',
    :'last_update_dts_begin' => :'String',
    :'last_update_dts_end' => :'String',
    :'object_email' => :'String',
    :'object_type' => :'String',
    :'priority' => :'String',
    :'status' => :'String',
    :'tags' => :'Array<String>',
    :'unassigned' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 311

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      assigned_to_group == o.assigned_to_group &&
      assigned_to_group_id == o.assigned_to_group_id &&
      assigned_to_me == o.assigned_to_me &&
      assigned_to_user == o.assigned_to_user &&
      assigned_to_user_id == o.assigned_to_user_id &&
      created_by == o.created_by &&
      created_dts_begin == o.created_dts_begin &&
      created_dts_end == o.created_dts_end &&
      delay_until_dts_begin == o.delay_until_dts_begin &&
      delay_until_dts_end == o.delay_until_dts_end &&
      due_dts_begin == o.due_dts_begin &&
      due_dts_end == o.due_dts_end &&
      last_update_dts_begin == o.last_update_dts_begin &&
      last_update_dts_end == o.last_update_dts_end &&
      object_email == o.object_email &&
      object_type == o.object_type &&
      priority == o.priority &&
      status == o.status &&
      tags == o.tags &&
      unassigned == o.unassigned
end

#_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



382
383
384
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
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 382

def _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 = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
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



453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 453

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

#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



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 358

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


338
339
340
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 338

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



344
345
346
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 344

def hash
  [assigned_to_group, assigned_to_group_id, assigned_to_me, assigned_to_user, assigned_to_user_id, created_by, created_dts_begin, created_dts_end, delay_until_dts_begin, delay_until_dts_end, due_dts_begin, due_dts_end, last_update_dts_begin, last_update_dts_end, object_email, object_type, priority, status, tags, unassigned].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



262
263
264
265
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 262

def list_invalid_properties
  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



429
430
431
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 429

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



435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 435

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



423
424
425
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 423

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



269
270
271
272
273
274
275
276
277
 
# File 'lib/ultracart_api/models/workflow_tasks_request.rb', line 269

def valid?
  object_type_validator = EnumAttributeValidator.new('String', ["order", "auto order", "item", "customer profile"])
  return false unless object_type_validator.valid?(@object_type)
  priority_validator = EnumAttributeValidator.new('String', ["1 - low", "2 - medium", "3 - high", "4 - critical"])
  return false unless priority_validator.valid?(@priority)
  status_validator = EnumAttributeValidator.new('String', ["open", "closed", "delayed", "awaiting customer feedback"])
  return false unless status_validator.valid?(@status)
  true
end