Class: AmzSpApi::ServicesApiModel::ServiceApi

Inherits:
Object
  • Object
show all
Defined in:
lib/services-api-model/api/service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ServiceApi

Returns a new instance of ServiceApi.



16
17
18
 
# File 'lib/services-api-model/api/service_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/services-api-model/api/service_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#add_appointment_for_service_job_by_service_job_id(body, service_job_id, opts = {}) ⇒ SetAppointmentResponse

Adds an appointment to the service job indicated by the service job identifier specified. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body —

    Add appointment operation input details.

  • service_job_id —

    An Amazon defined service job identifier.

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

    the optional parameters

Returns:



24
25
26
27
 
# File 'lib/services-api-model/api/service_api.rb', line 24

def add_appointment_for_service_job_by_service_job_id(body, service_job_id, opts = {})
  data, _status_code, _headers = add_appointment_for_service_job_by_service_job_id_with_http_info(body, service_job_id, opts)
  data
end

#add_appointment_for_service_job_by_service_job_id_with_http_info(body, service_job_id, opts = {}) ⇒ Array<(SetAppointmentResponse, Integer, Hash)>

Adds an appointment to the service job indicated by the service job identifier specified. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body —

    Add appointment operation input details.

  • service_job_id —

    An Amazon defined service job identifier.

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

    the optional parameters

Returns:

  • (Array<(SetAppointmentResponse, Integer, Hash)>) —

    SetAppointmentResponse data, response status code and response headers



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/services-api-model/api/service_api.rb', line 34

def add_appointment_for_service_job_by_service_job_id_with_http_info(body, service_job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.add_appointment_for_service_job_by_service_job_id ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ServiceApi.add_appointment_for_service_job_by_service_job_id"
  end
  # verify the required parameter 'service_job_id' is set
  if @api_client.config.client_side_validation && service_job_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_job_id' when calling ServiceApi.add_appointment_for_service_job_by_service_job_id"
  end
  # resource path
  local_var_path = '/service/v1/serviceJobs/{serviceJobId}/appointments'.sub('{' + 'serviceJobId' + '}', service_job_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'SetAppointmentResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#add_appointment_for_service_job_by_service_job_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#assign_appointment_resources(body, service_job_id, appointment_id, opts = {}) ⇒ AssignAppointmentResourcesResponse

Assigns new resource(s) or overwrite/update the existing one(s) to a service job appointment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 2 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body
  • service_job_id —

    An Amazon-defined service job identifier. Get this value by calling the &#x60;getServiceJobs&#x60; operation of the Services API.

  • appointment_id —

    An Amazon-defined identifier of active service job appointment.

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

    the optional parameters

Returns:



87
88
89
90
 
# File 'lib/services-api-model/api/service_api.rb', line 87

def assign_appointment_resources(body, service_job_id, appointment_id, opts = {})
  data, _status_code, _headers = assign_appointment_resources_with_http_info(body, service_job_id, appointment_id, opts)
  data
end

#assign_appointment_resources_with_http_info(body, service_job_id, appointment_id, opts = {}) ⇒ Array<(AssignAppointmentResourcesResponse, Integer, Hash)>

Assigns new resource(s) or overwrite/update the existing one(s) to a service job appointment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 2 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body
  • service_job_id —

    An Amazon-defined service job identifier. Get this value by calling the &#x60;getServiceJobs&#x60; operation of the Services API.

  • appointment_id —

    An Amazon-defined identifier of active service job appointment.

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

    the optional parameters

Returns:



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/services-api-model/api/service_api.rb', line 98

def assign_appointment_resources_with_http_info(body, service_job_id, appointment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.assign_appointment_resources ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ServiceApi.assign_appointment_resources"
  end
  # verify the required parameter 'service_job_id' is set
  if @api_client.config.client_side_validation && service_job_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_job_id' when calling ServiceApi.assign_appointment_resources"
  end
  # verify the required parameter 'appointment_id' is set
  if @api_client.config.client_side_validation && appointment_id.nil?
    fail ArgumentError, "Missing the required parameter 'appointment_id' when calling ServiceApi.assign_appointment_resources"
  end
  # resource path
  local_var_path = '/service/v1/serviceJobs/{serviceJobId}/appointments/{appointmentId}/resources'.sub('{' + 'serviceJobId' + '}', service_job_id.to_s).sub('{' + 'appointmentId' + '}', appointment_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'AssignAppointmentResourcesResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#assign_appointment_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cancel_reservation(reservation_id, marketplace_ids, opts = {}) ⇒ CancelReservationResponse

Cancel a reservation. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • reservation_id —

    Reservation Identifier

  • marketplace_ids —

    An identifier for the marketplace in which the resource operates.

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

    the optional parameters

Returns:



154
155
156
157
 
# File 'lib/services-api-model/api/service_api.rb', line 154

def cancel_reservation(reservation_id, marketplace_ids, opts = {})
  data, _status_code, _headers = cancel_reservation_with_http_info(reservation_id, marketplace_ids, opts)
  data
end

#cancel_reservation_with_http_info(reservation_id, marketplace_ids, opts = {}) ⇒ Array<(CancelReservationResponse, Integer, Hash)>

Cancel a reservation. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • reservation_id —

    Reservation Identifier

  • marketplace_ids —

    An identifier for the marketplace in which the resource operates.

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

    the optional parameters

Returns:

  • (Array<(CancelReservationResponse, Integer, Hash)>) —

    CancelReservationResponse data, response status code and response headers



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
 
# File 'lib/services-api-model/api/service_api.rb', line 164

def cancel_reservation_with_http_info(reservation_id, marketplace_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.cancel_reservation ...'
  end
  # verify the required parameter 'reservation_id' is set
  if @api_client.config.client_side_validation && reservation_id.nil?
    fail ArgumentError, "Missing the required parameter 'reservation_id' when calling ServiceApi.cancel_reservation"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling ServiceApi.cancel_reservation"
  end
  # resource path
  local_var_path = '/service/v1/reservation/{reservationId}'.sub('{' + 'reservationId' + '}', reservation_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'CancelReservationResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#cancel_reservation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cancel_service_job_by_service_job_id(service_job_id, cancellation_reason_code, opts = {}) ⇒ CancelServiceJobByServiceJobIdResponse

Cancels the service job indicated by the service job identifier specified. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • service_job_id —

    An Amazon defined service job identifier.

  • cancellation_reason_code —

    A cancel reason code that specifies the reason for cancelling a service job.

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

    the optional parameters

Returns:



215
216
217
218
 
# File 'lib/services-api-model/api/service_api.rb', line 215

def cancel_service_job_by_service_job_id(service_job_id, cancellation_reason_code, opts = {})
  data, _status_code, _headers = cancel_service_job_by_service_job_id_with_http_info(service_job_id, cancellation_reason_code, opts)
  data
end

#cancel_service_job_by_service_job_id_with_http_info(service_job_id, cancellation_reason_code, opts = {}) ⇒ Array<(CancelServiceJobByServiceJobIdResponse, Integer, Hash)>

Cancels the service job indicated by the service job identifier specified. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • service_job_id —

    An Amazon defined service job identifier.

  • cancellation_reason_code —

    A cancel reason code that specifies the reason for cancelling a service job.

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

    the optional parameters

Returns:



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
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/services-api-model/api/service_api.rb', line 225

def cancel_service_job_by_service_job_id_with_http_info(service_job_id, cancellation_reason_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.cancel_service_job_by_service_job_id ...'
  end
  # verify the required parameter 'service_job_id' is set
  if @api_client.config.client_side_validation && service_job_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_job_id' when calling ServiceApi.cancel_service_job_by_service_job_id"
  end
  # verify the required parameter 'cancellation_reason_code' is set
  if @api_client.config.client_side_validation && cancellation_reason_code.nil?
    fail ArgumentError, "Missing the required parameter 'cancellation_reason_code' when calling ServiceApi.cancel_service_job_by_service_job_id"
  end
  # resource path
  local_var_path = '/service/v1/serviceJobs/{serviceJobId}/cancellations'.sub('{' + 'serviceJobId' + '}', service_job_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cancellationReasonCode'] = cancellation_reason_code

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'CancelServiceJobByServiceJobIdResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#cancel_service_job_by_service_job_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#complete_service_job_by_service_job_id(service_job_id, opts = {}) ⇒ CompleteServiceJobByServiceJobIdResponse

Completes the service job indicated by the service job identifier specified. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • service_job_id —

    An Amazon defined service job identifier.

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

    the optional parameters

Returns:



275
276
277
278
 
# File 'lib/services-api-model/api/service_api.rb', line 275

def complete_service_job_by_service_job_id(service_job_id, opts = {})
  data, _status_code, _headers = complete_service_job_by_service_job_id_with_http_info(service_job_id, opts)
  data
end

#complete_service_job_by_service_job_id_with_http_info(service_job_id, opts = {}) ⇒ Array<(CompleteServiceJobByServiceJobIdResponse, Integer, Hash)>

Completes the service job indicated by the service job identifier specified. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • service_job_id —

    An Amazon defined service job identifier.

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

    the optional parameters

Returns:



284
285
286
287
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
 
# File 'lib/services-api-model/api/service_api.rb', line 284

def complete_service_job_by_service_job_id_with_http_info(service_job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.complete_service_job_by_service_job_id ...'
  end
  # verify the required parameter 'service_job_id' is set
  if @api_client.config.client_side_validation && service_job_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_job_id' when calling ServiceApi.complete_service_job_by_service_job_id"
  end
  # resource path
  local_var_path = '/service/v1/serviceJobs/{serviceJobId}/completions'.sub('{' + 'serviceJobId' + '}', service_job_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'CompleteServiceJobByServiceJobIdResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#complete_service_job_by_service_job_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_reservation(body, marketplace_ids, opts = {}) ⇒ CreateReservationResponse

Create a reservation. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body —

    Reservation details

  • marketplace_ids —

    An identifier for the marketplace in which the resource operates.

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

    the optional parameters

Returns:



330
331
332
333
 
# File 'lib/services-api-model/api/service_api.rb', line 330

def create_reservation(body, marketplace_ids, opts = {})
  data, _status_code, _headers = create_reservation_with_http_info(body, marketplace_ids, opts)
  data
end

#create_reservation_with_http_info(body, marketplace_ids, opts = {}) ⇒ Array<(CreateReservationResponse, Integer, Hash)>

Create a reservation. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body —

    Reservation details

  • marketplace_ids —

    An identifier for the marketplace in which the resource operates.

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

    the optional parameters

Returns:

  • (Array<(CreateReservationResponse, Integer, Hash)>) —

    CreateReservationResponse data, response status code and response headers



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/services-api-model/api/service_api.rb', line 340

def create_reservation_with_http_info(body, marketplace_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.create_reservation ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ServiceApi.create_reservation"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling ServiceApi.create_reservation"
  end
  # resource path
  local_var_path = '/service/v1/reservation'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'CreateReservationResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#create_reservation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_service_document_upload_destination(body, opts = {}) ⇒ CreateServiceDocumentUploadDestination

Creates an upload destination. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body —

    Upload document operation input details.

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

    the optional parameters

Returns:



392
393
394
395
 
# File 'lib/services-api-model/api/service_api.rb', line 392

def create_service_document_upload_destination(body, opts = {})
  data, _status_code, _headers = create_service_document_upload_destination_with_http_info(body, opts)
  data
end

#create_service_document_upload_destination_with_http_info(body, opts = {}) ⇒ Array<(CreateServiceDocumentUploadDestination, Integer, Hash)>

Creates an upload destination. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body —

    Upload document operation input details.

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

    the optional parameters

Returns:



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/services-api-model/api/service_api.rb', line 401

def create_service_document_upload_destination_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.create_service_document_upload_destination ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ServiceApi.create_service_document_upload_destination"
  end
  # resource path
  local_var_path = '/service/v1/documents'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'CreateServiceDocumentUploadDestination' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#create_service_document_upload_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_appointment_slots(asin, store_id, marketplace_ids, opts = {}) ⇒ GetAppointmentSlotsResponse

Gets appointment slots as per the service context specified. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 20 | 40 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • asin —

    ASIN associated with the service.

  • store_id —

    Store identifier defining the region scope to retrive appointment slots.

  • marketplace_ids —

    An identifier for the marketplace for which appointment slots are queried

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

    the optional parameters

Options Hash (opts):

  • :start_time (String) —

    A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;startTime&#x60; is provided, &#x60;endTime&#x60; should also be provided. Default value is as per business configuration.

  • :end_time (String) —

    A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;endTime&#x60; is provided, &#x60;startTime&#x60; should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.

Returns:



452
453
454
455
 
# File 'lib/services-api-model/api/service_api.rb', line 452

def get_appointment_slots(asin, store_id, marketplace_ids, opts = {})
  data, _status_code, _headers = get_appointment_slots_with_http_info(asin, store_id, marketplace_ids, opts)
  data
end

#get_appointment_slots_with_http_info(asin, store_id, marketplace_ids, opts = {}) ⇒ Array<(GetAppointmentSlotsResponse, Integer, Hash)>

Gets appointment slots as per the service context specified. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 20 | 40 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • asin —

    ASIN associated with the service.

  • store_id —

    Store identifier defining the region scope to retrive appointment slots.

  • marketplace_ids —

    An identifier for the marketplace for which appointment slots are queried

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

    the optional parameters

Options Hash (opts):

  • :start_time (String) —

    A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;startTime&#x60; is provided, &#x60;endTime&#x60; should also be provided. Default value is as per business configuration.

  • :end_time (String) —

    A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;endTime&#x60; is provided, &#x60;startTime&#x60; should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.

Returns:

  • (Array<(GetAppointmentSlotsResponse, Integer, Hash)>) —

    GetAppointmentSlotsResponse data, response status code and response headers



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/services-api-model/api/service_api.rb', line 465

def get_appointment_slots_with_http_info(asin, store_id, marketplace_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.get_appointment_slots ...'
  end
  # verify the required parameter 'asin' is set
  if @api_client.config.client_side_validation && asin.nil?
    fail ArgumentError, "Missing the required parameter 'asin' when calling ServiceApi.get_appointment_slots"
  end
  # verify the required parameter 'store_id' is set
  if @api_client.config.client_side_validation && store_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_id' when calling ServiceApi.get_appointment_slots"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling ServiceApi.get_appointment_slots"
  end
  # resource path
  local_var_path = '/service/v1/appointmentSlots'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'asin'] = asin
  query_params[:'storeId'] = store_id
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)
  query_params[:'startTime'] = opts[:'start_time'] if !opts[:'start_time'].nil?
  query_params[:'endTime'] = opts[:'end_time'] if !opts[:'end_time'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'GetAppointmentSlotsResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#get_appointment_slots\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_appointmment_slots_by_job_id(service_job_id, marketplace_ids, opts = {}) ⇒ GetAppointmentSlotsResponse

Gets appointment slots for the service associated with the service job id specified. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • service_job_id —

    A service job identifier to retrive appointment slots for associated service.

  • marketplace_ids —

    An identifier for the marketplace in which the resource operates.

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

    the optional parameters

Options Hash (opts):

  • :start_time (String) —

    A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;startTime&#x60; is provided, &#x60;endTime&#x60; should also be provided. Default value is as per business configuration.

  • :end_time (String) —

    A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;endTime&#x60; is provided, &#x60;startTime&#x60; should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.

Returns:



526
527
528
529
 
# File 'lib/services-api-model/api/service_api.rb', line 526

def get_appointmment_slots_by_job_id(service_job_id, marketplace_ids, opts = {})
  data, _status_code, _headers = get_appointmment_slots_by_job_id_with_http_info(service_job_id, marketplace_ids, opts)
  data
end

#get_appointmment_slots_by_job_id_with_http_info(service_job_id, marketplace_ids, opts = {}) ⇒ Array<(GetAppointmentSlotsResponse, Integer, Hash)>

Gets appointment slots for the service associated with the service job id specified. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • service_job_id —

    A service job identifier to retrive appointment slots for associated service.

  • marketplace_ids —

    An identifier for the marketplace in which the resource operates.

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

    the optional parameters

Options Hash (opts):

  • :start_time (String) —

    A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;startTime&#x60; is provided, &#x60;endTime&#x60; should also be provided. Default value is as per business configuration.

  • :end_time (String) —

    A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If &#x60;endTime&#x60; is provided, &#x60;startTime&#x60; should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.

Returns:

  • (Array<(GetAppointmentSlotsResponse, Integer, Hash)>) —

    GetAppointmentSlotsResponse data, response status code and response headers



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/services-api-model/api/service_api.rb', line 538

def get_appointmment_slots_by_job_id_with_http_info(service_job_id, marketplace_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.get_appointmment_slots_by_job_id ...'
  end
  # verify the required parameter 'service_job_id' is set
  if @api_client.config.client_side_validation && service_job_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_job_id' when calling ServiceApi.get_appointmment_slots_by_job_id"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling ServiceApi.get_appointmment_slots_by_job_id"
  end
  # resource path
  local_var_path = '/service/v1/serviceJobs/{serviceJobId}/appointmentSlots'.sub('{' + 'serviceJobId' + '}', service_job_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)
  query_params[:'startTime'] = opts[:'start_time'] if !opts[:'start_time'].nil?
  query_params[:'endTime'] = opts[:'end_time'] if !opts[:'end_time'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'GetAppointmentSlotsResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#get_appointmment_slots_by_job_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_fixed_slot_capacity(body, marketplace_ids, resource_id, opts = {}) ⇒ FixedSlotCapacity

Provides capacity in fixed-size slots. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body —

    Request body.

  • marketplace_ids —

    An identifier for the marketplace in which the resource operates.

  • resource_id —

    Resource Identifier.

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

    the optional parameters

Options Hash (opts):

  • :next_page_token (String) —

    Next page token returned in the response of your previous request.

Returns:



593
594
595
596
 
# File 'lib/services-api-model/api/service_api.rb', line 593

def get_fixed_slot_capacity(body, marketplace_ids, resource_id, opts = {})
  data, _status_code, _headers = get_fixed_slot_capacity_with_http_info(body, marketplace_ids, resource_id, opts)
  data
end

#get_fixed_slot_capacity_with_http_info(body, marketplace_ids, resource_id, opts = {}) ⇒ Array<(FixedSlotCapacity, Integer, Hash)>

Provides capacity in fixed-size slots. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body —

    Request body.

  • marketplace_ids —

    An identifier for the marketplace in which the resource operates.

  • resource_id —

    Resource Identifier.

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

    the optional parameters

Options Hash (opts):

  • :next_page_token (String) —

    Next page token returned in the response of your previous request.

Returns:

  • (Array<(FixedSlotCapacity, Integer, Hash)>) —

    FixedSlotCapacity data, response status code and response headers



605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/services-api-model/api/service_api.rb', line 605

def get_fixed_slot_capacity_with_http_info(body, marketplace_ids, resource_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.get_fixed_slot_capacity ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ServiceApi.get_fixed_slot_capacity"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling ServiceApi.get_fixed_slot_capacity"
  end
  # verify the required parameter 'resource_id' is set
  if @api_client.config.client_side_validation && resource_id.nil?
    fail ArgumentError, "Missing the required parameter 'resource_id' when calling ServiceApi.get_fixed_slot_capacity"
  end
  # resource path
  local_var_path = '/service/v1/serviceResources/{resourceId}/capacity/fixed'.sub('{' + 'resourceId' + '}', resource_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)
  query_params[:'nextPageToken'] = opts[:'next_page_token'] if !opts[:'next_page_token'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'FixedSlotCapacity' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#get_fixed_slot_capacity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_range_slot_capacity(body, marketplace_ids, resource_id, opts = {}) ⇒ RangeSlotCapacity

Provides capacity slots in a format similar to availability records. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body —

    Request body.

  • marketplace_ids —

    An identifier for the marketplace in which the resource operates.

  • resource_id —

    Resource Identifier.

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

    the optional parameters

Options Hash (opts):

  • :next_page_token (String) —

    Next page token returned in the response of your previous request.

Returns:



665
666
667
668
 
# File 'lib/services-api-model/api/service_api.rb', line 665

def get_range_slot_capacity(body, marketplace_ids, resource_id, opts = {})
  data, _status_code, _headers = get_range_slot_capacity_with_http_info(body, marketplace_ids, resource_id, opts)
  data
end

#get_range_slot_capacity_with_http_info(body, marketplace_ids, resource_id, opts = {}) ⇒ Array<(RangeSlotCapacity, Integer, Hash)>

Provides capacity slots in a format similar to availability records. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body —

    Request body.

  • marketplace_ids —

    An identifier for the marketplace in which the resource operates.

  • resource_id —

    Resource Identifier.

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

    the optional parameters

Options Hash (opts):

  • :next_page_token (String) —

    Next page token returned in the response of your previous request.

Returns:

  • (Array<(RangeSlotCapacity, Integer, Hash)>) —

    RangeSlotCapacity data, response status code and response headers



677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
 
# File 'lib/services-api-model/api/service_api.rb', line 677

def get_range_slot_capacity_with_http_info(body, marketplace_ids, resource_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.get_range_slot_capacity ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ServiceApi.get_range_slot_capacity"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling ServiceApi.get_range_slot_capacity"
  end
  # verify the required parameter 'resource_id' is set
  if @api_client.config.client_side_validation && resource_id.nil?
    fail ArgumentError, "Missing the required parameter 'resource_id' when calling ServiceApi.get_range_slot_capacity"
  end
  # resource path
  local_var_path = '/service/v1/serviceResources/{resourceId}/capacity/range'.sub('{' + 'resourceId' + '}', resource_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)
  query_params[:'nextPageToken'] = opts[:'next_page_token'] if !opts[:'next_page_token'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'RangeSlotCapacity' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#get_range_slot_capacity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_service_job_by_service_job_id(service_job_id, opts = {}) ⇒ GetServiceJobByServiceJobIdResponse

Gets details of service job indicated by the provided ‘serviceJobID`. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 20 | 40 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • service_job_id —

    A service job identifier.

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

    the optional parameters

Returns:



734
735
736
737
 
# File 'lib/services-api-model/api/service_api.rb', line 734

def get_service_job_by_service_job_id(service_job_id, opts = {})
  data, _status_code, _headers = get_service_job_by_service_job_id_with_http_info(service_job_id, opts)
  data
end

#get_service_job_by_service_job_id_with_http_info(service_job_id, opts = {}) ⇒ Array<(GetServiceJobByServiceJobIdResponse, Integer, Hash)>

Gets details of service job indicated by the provided &#x60;serviceJobID&#x60;. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 20 | 40 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • service_job_id —

    A service job identifier.

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

    the optional parameters

Returns:



743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
 
# File 'lib/services-api-model/api/service_api.rb', line 743

def get_service_job_by_service_job_id_with_http_info(service_job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.get_service_job_by_service_job_id ...'
  end
  # verify the required parameter 'service_job_id' is set
  if @api_client.config.client_side_validation && service_job_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_job_id' when calling ServiceApi.get_service_job_by_service_job_id"
  end
  # resource path
  local_var_path = '/service/v1/serviceJobs/{serviceJobId}'.sub('{' + 'serviceJobId' + '}', service_job_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'GetServiceJobByServiceJobIdResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#get_service_job_by_service_job_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_service_jobs(marketplace_ids, opts = {}) ⇒ GetServiceJobsResponse

Gets service job details for the specified filter query. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 10 | 40 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • marketplace_ids —

    Used to select jobs that were placed in the specified marketplaces.

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

    the optional parameters

Options Hash (opts):

  • :service_order_ids (Array<String>) —

    List of service order ids for the query you want to perform.Max values supported 20.

  • :service_job_status (Array<String>) —

    A list of one or more job status by which to filter the list of jobs.

  • :page_token (String) —

    String returned in the response of your previous request.

  • :page_size (Integer) —

    A non-negative integer that indicates the maximum number of jobs to return in the list, Value must be 1 - 20. Default 20. (default to 20)

  • :sort_field (String) —

    Sort fields on which you want to sort the output.

  • :sort_order (String) —

    Sort order for the query you want to perform.

  • :created_after (String) —

    A date used for selecting jobs created at or after a specified time. Must be in ISO 8601 format. Required if &#x60;LastUpdatedAfter&#x60; is not specified. Specifying both &#x60;CreatedAfter&#x60; and &#x60;LastUpdatedAfter&#x60; returns an error.

  • :created_before (String) —

    A date used for selecting jobs created at or before a specified time. Must be in ISO 8601 format.

  • :last_updated_after (String) —

    A date used for selecting jobs updated at or after a specified time. Must be in ISO 8601 format. Required if &#x60;createdAfter&#x60; is not specified. Specifying both &#x60;CreatedAfter&#x60; and &#x60;LastUpdatedAfter&#x60; returns an error.

  • :last_updated_before (String) —

    A date used for selecting jobs updated at or before a specified time. Must be in ISO 8601 format.

  • :schedule_start_date (String) —

    A date used for filtering jobs schedules at or after a specified time. Must be in ISO 8601 format. Schedule end date should not be earlier than schedule start date.

  • :schedule_end_date (String) —

    A date used for filtering jobs schedules at or before a specified time. Must be in ISO 8601 format. Schedule end date should not be earlier than schedule start date.

  • :asins (Array<String>) —

    List of Amazon Standard Identification Numbers (ASIN) of the items. Max values supported is 20.

  • :required_skills (Array<String>) —

    A defined set of related knowledge, skills, experience, tools, materials, and work processes common to service delivery for a set of products and/or service scenarios. Max values supported is 20.

  • :store_ids (Array<String>) —

    List of Amazon-defined identifiers for the region scope. Max values supported is 50.

Returns:



803
804
805
806
 
# File 'lib/services-api-model/api/service_api.rb', line 803

def get_service_jobs(marketplace_ids, opts = {})
  data, _status_code, _headers = get_service_jobs_with_http_info(marketplace_ids, opts)
  data
end

#get_service_jobs_with_http_info(marketplace_ids, opts = {}) ⇒ Array<(GetServiceJobsResponse, Integer, Hash)>

Gets service job details for the specified filter query. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 10 | 40 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • marketplace_ids —

    Used to select jobs that were placed in the specified marketplaces.

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

    the optional parameters

Options Hash (opts):

  • :service_order_ids (Array<String>) —

    List of service order ids for the query you want to perform.Max values supported 20.

  • :service_job_status (Array<String>) —

    A list of one or more job status by which to filter the list of jobs.

  • :page_token (String) —

    String returned in the response of your previous request.

  • :page_size (Integer) —

    A non-negative integer that indicates the maximum number of jobs to return in the list, Value must be 1 - 20. Default 20.

  • :sort_field (String) —

    Sort fields on which you want to sort the output.

  • :sort_order (String) —

    Sort order for the query you want to perform.

  • :created_after (String) —

    A date used for selecting jobs created at or after a specified time. Must be in ISO 8601 format. Required if &#x60;LastUpdatedAfter&#x60; is not specified. Specifying both &#x60;CreatedAfter&#x60; and &#x60;LastUpdatedAfter&#x60; returns an error.

  • :created_before (String) —

    A date used for selecting jobs created at or before a specified time. Must be in ISO 8601 format.

  • :last_updated_after (String) —

    A date used for selecting jobs updated at or after a specified time. Must be in ISO 8601 format. Required if &#x60;createdAfter&#x60; is not specified. Specifying both &#x60;CreatedAfter&#x60; and &#x60;LastUpdatedAfter&#x60; returns an error.

  • :last_updated_before (String) —

    A date used for selecting jobs updated at or before a specified time. Must be in ISO 8601 format.

  • :schedule_start_date (String) —

    A date used for filtering jobs schedules at or after a specified time. Must be in ISO 8601 format. Schedule end date should not be earlier than schedule start date.

  • :schedule_end_date (String) —

    A date used for filtering jobs schedules at or before a specified time. Must be in ISO 8601 format. Schedule end date should not be earlier than schedule start date.

  • :asins (Array<String>) —

    List of Amazon Standard Identification Numbers (ASIN) of the items. Max values supported is 20.

  • :required_skills (Array<String>) —

    A defined set of related knowledge, skills, experience, tools, materials, and work processes common to service delivery for a set of products and/or service scenarios. Max values supported is 20.

  • :store_ids (Array<String>) —

    List of Amazon-defined identifiers for the region scope. Max values supported is 50.

Returns:

  • (Array<(GetServiceJobsResponse, Integer, Hash)>) —

    GetServiceJobsResponse data, response status code and response headers



827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/services-api-model/api/service_api.rb', line 827

def get_service_jobs_with_http_info(marketplace_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.get_service_jobs ...'
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling ServiceApi.get_service_jobs"
  end
  if @api_client.config.client_side_validation && opts[:'service_job_status'] && !opts[:'service_job_status'].all? { |item| ['NOT_SERVICED', 'CANCELLED', 'COMPLETED', 'PENDING_SCHEDULE', 'NOT_FULFILLABLE', 'HOLD', 'PAYMENT_DECLINED'].include?(item) }
    fail ArgumentError, 'invalid value for "service_job_status", must include one of NOT_SERVICED, CANCELLED, COMPLETED, PENDING_SCHEDULE, NOT_FULFILLABLE, HOLD, PAYMENT_DECLINED'
  end
  if @api_client.config.client_side_validation && opts[:'sort_field'] && !['JOB_DATE', 'JOB_STATUS'].include?(opts[:'sort_field'])
    fail ArgumentError, 'invalid value for "sort_field", must be one of JOB_DATE, JOB_STATUS'
  end
  if @api_client.config.client_side_validation && opts[:'sort_order'] && !['ASC', 'DESC'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = '/service/v1/serviceJobs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)
  query_params[:'serviceOrderIds'] = @api_client.build_collection_param(opts[:'service_order_ids'], :csv) if !opts[:'service_order_ids'].nil?
  query_params[:'serviceJobStatus'] = @api_client.build_collection_param(opts[:'service_job_status'], :csv) if !opts[:'service_job_status'].nil?
  query_params[:'pageToken'] = opts[:'page_token'] if !opts[:'page_token'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'sortField'] = opts[:'sort_field'] if !opts[:'sort_field'].nil?
  query_params[:'sortOrder'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'lastUpdatedAfter'] = opts[:'last_updated_after'] if !opts[:'last_updated_after'].nil?
  query_params[:'lastUpdatedBefore'] = opts[:'last_updated_before'] if !opts[:'last_updated_before'].nil?
  query_params[:'scheduleStartDate'] = opts[:'schedule_start_date'] if !opts[:'schedule_start_date'].nil?
  query_params[:'scheduleEndDate'] = opts[:'schedule_end_date'] if !opts[:'schedule_end_date'].nil?
  query_params[:'asins'] = @api_client.build_collection_param(opts[:'asins'], :csv) if !opts[:'asins'].nil?
  query_params[:'requiredSkills'] = @api_client.build_collection_param(opts[:'required_skills'], :csv) if !opts[:'required_skills'].nil?
  query_params[:'storeIds'] = @api_client.build_collection_param(opts[:'store_ids'], :csv) if !opts[:'store_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'GetServiceJobsResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#get_service_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reschedule_appointment_for_service_job_by_service_job_id(body, service_job_id, appointment_id, opts = {}) ⇒ SetAppointmentResponse

Reschedules an appointment for the service job indicated by the service job identifier specified. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body —

    Reschedule appointment operation input details.

  • service_job_id —

    An Amazon defined service job identifier.

  • appointment_id —

    An existing appointment identifier for the Service Job.

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

    the optional parameters

Returns:



899
900
901
902
 
# File 'lib/services-api-model/api/service_api.rb', line 899

def reschedule_appointment_for_service_job_by_service_job_id(body, service_job_id, appointment_id, opts = {})
  data, _status_code, _headers = reschedule_appointment_for_service_job_by_service_job_id_with_http_info(body, service_job_id, appointment_id, opts)
  data
end

#reschedule_appointment_for_service_job_by_service_job_id_with_http_info(body, service_job_id, appointment_id, opts = {}) ⇒ Array<(SetAppointmentResponse, Integer, Hash)>

Reschedules an appointment for the service job indicated by the service job identifier specified. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body —

    Reschedule appointment operation input details.

  • service_job_id —

    An Amazon defined service job identifier.

  • appointment_id —

    An existing appointment identifier for the Service Job.

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

    the optional parameters

Returns:

  • (Array<(SetAppointmentResponse, Integer, Hash)>) —

    SetAppointmentResponse data, response status code and response headers



910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
 
# File 'lib/services-api-model/api/service_api.rb', line 910

def reschedule_appointment_for_service_job_by_service_job_id_with_http_info(body, service_job_id, appointment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.reschedule_appointment_for_service_job_by_service_job_id ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ServiceApi.reschedule_appointment_for_service_job_by_service_job_id"
  end
  # verify the required parameter 'service_job_id' is set
  if @api_client.config.client_side_validation && service_job_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_job_id' when calling ServiceApi.reschedule_appointment_for_service_job_by_service_job_id"
  end
  # verify the required parameter 'appointment_id' is set
  if @api_client.config.client_side_validation && appointment_id.nil?
    fail ArgumentError, "Missing the required parameter 'appointment_id' when calling ServiceApi.reschedule_appointment_for_service_job_by_service_job_id"
  end
  # resource path
  local_var_path = '/service/v1/serviceJobs/{serviceJobId}/appointments/{appointmentId}'.sub('{' + 'serviceJobId' + '}', service_job_id.to_s).sub('{' + 'appointmentId' + '}', appointment_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'SetAppointmentResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#reschedule_appointment_for_service_job_by_service_job_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_appointment_fulfillment_data(body, service_job_id, appointment_id, opts = {}) ⇒ String

Updates the appointment fulfillment data related to a given ‘jobID` and `appointmentID`. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body —

    Appointment fulfillment data collection details.

  • service_job_id —

    An Amazon-defined service job identifier. Get this value by calling the &#x60;getServiceJobs&#x60; operation of the Services API.

  • appointment_id —

    An Amazon-defined identifier of active service job appointment.

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

    the optional parameters

Returns:

  • (String) 


967
968
969
970
 
# File 'lib/services-api-model/api/service_api.rb', line 967

def set_appointment_fulfillment_data(body, service_job_id, appointment_id, opts = {})
  data, _status_code, _headers = set_appointment_fulfillment_data_with_http_info(body, service_job_id, appointment_id, opts)
  data
end

#set_appointment_fulfillment_data_with_http_info(body, service_job_id, appointment_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Updates the appointment fulfillment data related to a given &#x60;jobID&#x60; and &#x60;appointmentID&#x60;. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body —

    Appointment fulfillment data collection details.

  • service_job_id —

    An Amazon-defined service job identifier. Get this value by calling the &#x60;getServiceJobs&#x60; operation of the Services API.

  • appointment_id —

    An Amazon-defined identifier of active service job appointment.

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

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'lib/services-api-model/api/service_api.rb', line 978

def set_appointment_fulfillment_data_with_http_info(body, service_job_id, appointment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.set_appointment_fulfillment_data ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ServiceApi.set_appointment_fulfillment_data"
  end
  # verify the required parameter 'service_job_id' is set
  if @api_client.config.client_side_validation && service_job_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_job_id' when calling ServiceApi.set_appointment_fulfillment_data"
  end
  # verify the required parameter 'appointment_id' is set
  if @api_client.config.client_side_validation && appointment_id.nil?
    fail ArgumentError, "Missing the required parameter 'appointment_id' when calling ServiceApi.set_appointment_fulfillment_data"
  end
  # resource path
  local_var_path = '/service/v1/serviceJobs/{serviceJobId}/appointments/{appointmentId}/fulfillment'.sub('{' + 'serviceJobId' + '}', service_job_id.to_s).sub('{' + 'appointmentId' + '}', appointment_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'String' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#set_appointment_fulfillment_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_reservation(body, marketplace_ids, reservation_id, opts = {}) ⇒ UpdateReservationResponse

Update a reservation. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body —

    Reservation details

  • marketplace_ids —

    An identifier for the marketplace in which the resource operates.

  • reservation_id —

    Reservation Identifier

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

    the optional parameters

Returns:



1035
1036
1037
1038
 
# File 'lib/services-api-model/api/service_api.rb', line 1035

def update_reservation(body, marketplace_ids, reservation_id, opts = {})
  data, _status_code, _headers = update_reservation_with_http_info(body, marketplace_ids, reservation_id, opts)
  data
end

#update_reservation_with_http_info(body, marketplace_ids, reservation_id, opts = {}) ⇒ Array<(UpdateReservationResponse, Integer, Hash)>

Update a reservation. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body —

    Reservation details

  • marketplace_ids —

    An identifier for the marketplace in which the resource operates.

  • reservation_id —

    Reservation Identifier

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

    the optional parameters

Returns:

  • (Array<(UpdateReservationResponse, Integer, Hash)>) —

    UpdateReservationResponse data, response status code and response headers



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
 
# File 'lib/services-api-model/api/service_api.rb', line 1046

def update_reservation_with_http_info(body, marketplace_ids, reservation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.update_reservation ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ServiceApi.update_reservation"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling ServiceApi.update_reservation"
  end
  # verify the required parameter 'reservation_id' is set
  if @api_client.config.client_side_validation && reservation_id.nil?
    fail ArgumentError, "Missing the required parameter 'reservation_id' when calling ServiceApi.update_reservation"
  end
  # resource path
  local_var_path = '/service/v1/reservation/{reservationId}'.sub('{' + 'reservationId' + '}', reservation_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'UpdateReservationResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#update_reservation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_schedule(body, marketplace_ids, resource_id, opts = {}) ⇒ UpdateScheduleResponse

Update the schedule of the given resource. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body —

    Schedule details

  • marketplace_ids —

    An identifier for the marketplace in which the resource operates.

  • resource_id —

    Resource (store) Identifier

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

    the optional parameters

Returns:



1104
1105
1106
1107
 
# File 'lib/services-api-model/api/service_api.rb', line 1104

def update_schedule(body, marketplace_ids, resource_id, opts = {})
  data, _status_code, _headers = update_schedule_with_http_info(body, marketplace_ids, resource_id, opts)
  data
end

#update_schedule_with_http_info(body, marketplace_ids, resource_id, opts = {}) ⇒ Array<(UpdateScheduleResponse, Integer, Hash)>

Update the schedule of the given resource. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 20 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body —

    Schedule details

  • marketplace_ids —

    An identifier for the marketplace in which the resource operates.

  • resource_id —

    Resource (store) Identifier

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

    the optional parameters

Returns:

  • (Array<(UpdateScheduleResponse, Integer, Hash)>) —

    UpdateScheduleResponse data, response status code and response headers



1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
 
# File 'lib/services-api-model/api/service_api.rb', line 1115

def update_schedule_with_http_info(body, marketplace_ids, resource_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceApi.update_schedule ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ServiceApi.update_schedule"
  end
  # verify the required parameter 'marketplace_ids' is set
  if @api_client.config.client_side_validation && marketplace_ids.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling ServiceApi.update_schedule"
  end
  # verify the required parameter 'resource_id' is set
  if @api_client.config.client_side_validation && resource_id.nil?
    fail ArgumentError, "Missing the required parameter 'resource_id' when calling ServiceApi.update_schedule"
  end
  # resource path
  local_var_path = '/service/v1/serviceResources/{resourceId}/schedules'.sub('{' + 'resourceId' + '}', resource_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'UpdateScheduleResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceApi#update_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end