Class: AmznSpApi::ServicesApiModel::ServiceJob

Inherits:
Object
  • Object
show all
Defined in:
lib/services_api_model/models/service_job.rb

Overview

The job details of a service.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ServiceJob

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/services_api_model/models/service_job.rb', line 106

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::ServicesApiModel::ServiceJob` initialize method' unless attributes.is_a?(Hash)

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

    h[k.to_sym] = v
  end

  self.create_time = attributes[:create_time] if attributes.key?(:create_time)

  self.service_job_id = attributes[:service_job_id] if attributes.key?(:service_job_id)

  self.service_job_status = attributes[:service_job_status] if attributes.key?(:service_job_status)

  self.scope_of_work = attributes[:scope_of_work] if attributes.key?(:scope_of_work)

  self.seller = attributes[:seller] if attributes.key?(:seller)

  self.service_job_provider = attributes[:service_job_provider] if attributes.key?(:service_job_provider)

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

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

  self.service_order_id = attributes[:service_order_id] if attributes.key?(:service_order_id)

  self.marketplace_id = attributes[:marketplace_id] if attributes.key?(:marketplace_id)

  self.store_id = attributes[:store_id] if attributes.key?(:store_id)

  self.buyer = attributes[:buyer] if attributes.key?(:buyer)

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

  return unless attributes.key?(:service_location)

  self.service_location = attributes[:service_location]
end

Instance Attribute Details

#appointments ⇒ Object

A list of appointments.



27
28
29
 
# File 'lib/services_api_model/models/service_job.rb', line 27

def appointments
  @appointments
end

#associated_items ⇒ Object

A list of items associated with the service job.



36
37
38
 
# File 'lib/services_api_model/models/service_job.rb', line 36

def associated_items
  @associated_items
end

#buyer ⇒ Object

Returns the value of attribute buyer.



18
19
20
 
# File 'lib/services_api_model/models/service_job.rb', line 18

def buyer
  @buyer
end

#create_time ⇒ Object

The date and time of the creation of the job in ISO 8601 format.



16
17
18
 
# File 'lib/services_api_model/models/service_job.rb', line 16

def create_time
  @create_time
end

#marketplace_id ⇒ Object

The marketplace identifier.



30
31
32
 
# File 'lib/services_api_model/models/service_job.rb', line 30

def marketplace_id
  @marketplace_id
end

#preferred_appointment_times ⇒ Object

A list of appointment windows preferred by the buyer. Included only if the buyer selected appointment windows when creating the order.



24
25
26
 
# File 'lib/services_api_model/models/service_job.rb', line 24

def preferred_appointment_times
  @preferred_appointment_times
end

#scope_of_work ⇒ Object

Returns the value of attribute scope_of_work.



18
19
20
 
# File 'lib/services_api_model/models/service_job.rb', line 18

def scope_of_work
  @scope_of_work
end

#seller ⇒ Object

Returns the value of attribute seller.



18
19
20
 
# File 'lib/services_api_model/models/service_job.rb', line 18

def seller
  @seller
end

#service_job_id ⇒ Object

Returns the value of attribute service_job_id.



18
19
20
 
# File 'lib/services_api_model/models/service_job.rb', line 18

def service_job_id
  @service_job_id
end

#service_job_provider ⇒ Object

Returns the value of attribute service_job_provider.



18
19
20
 
# File 'lib/services_api_model/models/service_job.rb', line 18

def service_job_provider
  @service_job_provider
end

#service_job_status ⇒ Object

The status of the service job.



21
22
23
 
# File 'lib/services_api_model/models/service_job.rb', line 21

def service_job_status
  @service_job_status
end

#service_location ⇒ Object

Returns the value of attribute service_location.



18
19
20
 
# File 'lib/services_api_model/models/service_job.rb', line 18

def service_location
  @service_location
end

#service_order_id ⇒ Object

Returns the value of attribute service_order_id.



18
19
20
 
# File 'lib/services_api_model/models/service_job.rb', line 18

def service_order_id
  @service_order_id
end

#store_id ⇒ Object

The Amazon-defined identifier for the region scope.



33
34
35
 
# File 'lib/services_api_model/models/service_job.rb', line 33

def store_id
  @store_id
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/services_api_model/models/service_job.rb', line 60

def self.attribute_map
  {
    'create_time': :createTime,
    'service_job_id': :serviceJobId,
    'service_job_status': :serviceJobStatus,
    'scope_of_work': :scopeOfWork,
    'seller': :seller,
    'service_job_provider': :serviceJobProvider,
    'preferred_appointment_times': :preferredAppointmentTimes,
    'appointments': :appointments,
    'service_order_id': :serviceOrderId,
    'marketplace_id': :marketplaceId,
    'store_id': :storeId,
    'buyer': :buyer,
    'associated_items': :associatedItems,
    'service_location': :serviceLocation
  }
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



214
215
216
 
# File 'lib/services_api_model/models/service_job.rb', line 214

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
 
# File 'lib/services_api_model/models/service_job.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/services_api_model/models/service_job.rb', line 80

def self.openapi_types
  {
    'create_time': :Object,
    'service_job_id': :Object,
    'service_job_status': :Object,
    'scope_of_work': :Object,
    'seller': :Object,
    'service_job_provider': :Object,
    'preferred_appointment_times': :Object,
    'appointments': :Object,
    'service_order_id': :Object,
    'marketplace_id': :Object,
    'store_id': :Object,
    'buyer': :Object,
    'associated_items': :Object,
    'service_location': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/services_api_model/models/service_job.rb', line 179

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    create_time == other.create_time &&
    service_job_id == other.service_job_id &&
    service_job_status == other.service_job_status &&
    scope_of_work == other.scope_of_work &&
    seller == other.seller &&
    service_job_provider == other.service_job_provider &&
    preferred_appointment_times == other.preferred_appointment_times &&
    appointments == other.appointments &&
    service_order_id == other.service_order_id &&
    marketplace_id == other.marketplace_id &&
    store_id == other.store_id &&
    buyer == other.buyer &&
    associated_items == other.associated_items &&
    service_location == other.service_location
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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/services_api_model/models/service_job.rb', line 243

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    AmznSpApi::ServicesApiModel.const_get(type).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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/services_api_model/models/service_job.rb', line 312

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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/services_api_model/models/service_job.rb', line 221

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

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

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


201
202
203
 
# File 'lib/services_api_model/models/service_job.rb', line 201

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



207
208
209
 
# File 'lib/services_api_model/models/service_job.rb', line 207

def hash
  [create_time, service_job_id, service_job_status, scope_of_work, seller, service_job_provider, preferred_appointment_times, appointments, service_order_id, marketplace_id, store_id, buyer, associated_items, service_location].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



155
156
157
 
# File 'lib/services_api_model/models/service_job.rb', line 155

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



288
289
290
 
# File 'lib/services_api_model/models/service_job.rb', line 288

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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/services_api_model/models/service_job.rb', line 294

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



282
283
284
 
# File 'lib/services_api_model/models/service_job.rb', line 282

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



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

def valid?
  service_job_status_validator = EnumAttributeValidator.new('Object', %w[NOT_SERVICED CANCELLED COMPLETED PENDING_SCHEDULE NOT_FULFILLABLE HOLD PAYMENT_DECLINED])
  return false unless service_job_status_validator.valid?(@service_job_status)

  true
end