Class: AmznSpApi::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.



14
15
16
 
# File 'lib/services_api_model/api/service_api.rb', line 14

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



12
13
14
 
# File 'lib/services_api_model/api/service_api.rb', line 12

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:



23
24
25
26
 
# File 'lib/services_api_model/api/service_api.rb', line 23

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

Raises:

  • (ArgumentError) 


33
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
 
# File 'lib/services_api_model/api/service_api.rb', line 33

def add_appointment_for_service_job_by_service_job_id_with_http_info(body, service_job_id, opts = {})
  @api_client.config.logger.debug 'Calling API: ServiceApi.add_appointment_for_service_job_by_service_job_id ...' if @api_client.config.debugging
  # verify the required parameter 'body' is set
  raise ArgumentError, "Missing the required parameter 'body' when calling ServiceApi.add_appointment_for_service_job_by_service_job_id" if @api_client.config.client_side_validation && body.nil?
  # verify the required parameter 'service_job_id' is set
  raise ArgumentError, "Missing the required parameter 'service_job_id' when calling ServiceApi.add_appointment_for_service_job_by_service_job_id" if @api_client.config.client_side_validation && service_job_id.nil?

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

  @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}" if @api_client.config.debugging
  [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:



80
81
82
83
 
# File 'lib/services_api_model/api/service_api.rb', line 80

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:

Raises:

  • (ArgumentError) 


91
92
93
94
95
96
97
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
 
# File 'lib/services_api_model/api/service_api.rb', line 91

def assign_appointment_resources_with_http_info(body, service_job_id, appointment_id, opts = {})
  @api_client.config.logger.debug 'Calling API: ServiceApi.assign_appointment_resources ...' if @api_client.config.debugging
  # verify the required parameter 'body' is set
  raise ArgumentError, "Missing the required parameter 'body' when calling ServiceApi.assign_appointment_resources" if @api_client.config.client_side_validation && body.nil?
  # verify the required parameter 'service_job_id' is set
  raise ArgumentError, "Missing the required parameter 'service_job_id' when calling ServiceApi.assign_appointment_resources" if @api_client.config.client_side_validation && service_job_id.nil?
  # verify the required parameter 'appointment_id' is set
  raise ArgumentError, "Missing the required parameter 'appointment_id' when calling ServiceApi.assign_appointment_resources" if @api_client.config.client_side_validation && appointment_id.nil?

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

  @api_client.config.logger.debug "API called: ServiceApi#assign_appointment_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



139
140
141
142
 
# File 'lib/services_api_model/api/service_api.rb', line 139

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

Raises:

  • (ArgumentError) 


149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/services_api_model/api/service_api.rb', line 149

def cancel_reservation_with_http_info(reservation_id, marketplace_ids, opts = {})
  @api_client.config.logger.debug 'Calling API: ServiceApi.cancel_reservation ...' if @api_client.config.debugging
  # verify the required parameter 'reservation_id' is set
  raise ArgumentError, "Missing the required parameter 'reservation_id' when calling ServiceApi.cancel_reservation" if @api_client.config.client_side_validation && reservation_id.nil?
  # verify the required parameter 'marketplace_ids' is set
  raise ArgumentError, "Missing the required parameter 'marketplace_ids' when calling ServiceApi.cancel_reservation" if @api_client.config.client_side_validation && marketplace_ids.nil?

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

  @api_client.config.logger.debug "API called: ServiceApi#cancel_reservation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



194
195
196
197
 
# File 'lib/services_api_model/api/service_api.rb', line 194

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:

Raises:

  • (ArgumentError) 


204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/services_api_model/api/service_api.rb', line 204

def cancel_service_job_by_service_job_id_with_http_info(service_job_id, cancellation_reason_code, opts = {})
  @api_client.config.logger.debug 'Calling API: ServiceApi.cancel_service_job_by_service_job_id ...' if @api_client.config.debugging
  # verify the required parameter 'service_job_id' is set
  raise ArgumentError, "Missing the required parameter 'service_job_id' when calling ServiceApi.cancel_service_job_by_service_job_id" if @api_client.config.client_side_validation && service_job_id.nil?
  # verify the required parameter 'cancellation_reason_code' is set
  raise ArgumentError, "Missing the required parameter 'cancellation_reason_code' when calling ServiceApi.cancel_service_job_by_service_job_id" if @api_client.config.client_side_validation && cancellation_reason_code.nil?

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

  @api_client.config.logger.debug "API called: ServiceApi#cancel_service_job_by_service_job_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



248
249
250
251
 
# File 'lib/services_api_model/api/service_api.rb', line 248

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:

Raises:

  • (ArgumentError) 


257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/services_api_model/api/service_api.rb', line 257

def complete_service_job_by_service_job_id_with_http_info(service_job_id, opts = {})
  @api_client.config.logger.debug 'Calling API: ServiceApi.complete_service_job_by_service_job_id ...' if @api_client.config.debugging
  # verify the required parameter 'service_job_id' is set
  raise ArgumentError, "Missing the required parameter 'service_job_id' when calling ServiceApi.complete_service_job_by_service_job_id" if @api_client.config.client_side_validation && service_job_id.nil?

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

  @api_client.config.logger.debug "API called: ServiceApi#complete_service_job_by_service_job_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



299
300
301
302
 
# File 'lib/services_api_model/api/service_api.rb', line 299

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

Raises:

  • (ArgumentError) 


309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/services_api_model/api/service_api.rb', line 309

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

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

  @api_client.config.logger.debug "API called: ServiceApi#create_reservation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



355
356
357
358
 
# File 'lib/services_api_model/api/service_api.rb', line 355

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:

Raises:

  • (ArgumentError) 


364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/services_api_model/api/service_api.rb', line 364

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

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

  @api_client.config.logger.debug "API called: ServiceApi#create_service_document_upload_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



411
412
413
414
 
# File 'lib/services_api_model/api/service_api.rb', line 411

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

Raises:

  • (ArgumentError) 


424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/services_api_model/api/service_api.rb', line 424

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

  # 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] unless opts[:start_time].nil?
  query_params[:endTime] = opts[:end_time] unless 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)

  @api_client.config.logger.debug "API called: ServiceApi#get_appointment_slots\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



477
478
479
480
 
# File 'lib/services_api_model/api/service_api.rb', line 477

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

Raises:

  • (ArgumentError) 


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
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/services_api_model/api/service_api.rb', line 489

def get_appointmment_slots_by_job_id_with_http_info(service_job_id, marketplace_ids, opts = {})
  @api_client.config.logger.debug 'Calling API: ServiceApi.get_appointmment_slots_by_job_id ...' if @api_client.config.debugging
  # verify the required parameter 'service_job_id' is set
  raise ArgumentError, "Missing the required parameter 'service_job_id' when calling ServiceApi.get_appointmment_slots_by_job_id" if @api_client.config.client_side_validation && service_job_id.nil?
  # verify the required parameter 'marketplace_ids' is set
  raise ArgumentError, "Missing the required parameter 'marketplace_ids' when calling ServiceApi.get_appointmment_slots_by_job_id" if @api_client.config.client_side_validation && marketplace_ids.nil?

  # 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] unless opts[:start_time].nil?
  query_params[:endTime] = opts[:end_time] unless 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)

  @api_client.config.logger.debug "API called: ServiceApi#get_appointmment_slots_by_job_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



538
539
540
541
 
# File 'lib/services_api_model/api/service_api.rb', line 538

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

Raises:

  • (ArgumentError) 


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
586
587
588
589
590
591
592
593
 
# File 'lib/services_api_model/api/service_api.rb', line 550

def get_fixed_slot_capacity_with_http_info(body, marketplace_ids, resource_id, opts = {})
  @api_client.config.logger.debug 'Calling API: ServiceApi.get_fixed_slot_capacity ...' if @api_client.config.debugging
  # verify the required parameter 'body' is set
  raise ArgumentError, "Missing the required parameter 'body' when calling ServiceApi.get_fixed_slot_capacity" if @api_client.config.client_side_validation && body.nil?
  # verify the required parameter 'marketplace_ids' is set
  raise ArgumentError, "Missing the required parameter 'marketplace_ids' when calling ServiceApi.get_fixed_slot_capacity" if @api_client.config.client_side_validation && marketplace_ids.nil?
  # verify the required parameter 'resource_id' is set
  raise ArgumentError, "Missing the required parameter 'resource_id' when calling ServiceApi.get_fixed_slot_capacity" if @api_client.config.client_side_validation && resource_id.nil?

  # 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] unless 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)

  @api_client.config.logger.debug "API called: ServiceApi#get_fixed_slot_capacity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



602
603
604
605
 
# File 'lib/services_api_model/api/service_api.rb', line 602

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

Raises:

  • (ArgumentError) 


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 614

def get_range_slot_capacity_with_http_info(body, marketplace_ids, resource_id, opts = {})
  @api_client.config.logger.debug 'Calling API: ServiceApi.get_range_slot_capacity ...' if @api_client.config.debugging
  # verify the required parameter 'body' is set
  raise ArgumentError, "Missing the required parameter 'body' when calling ServiceApi.get_range_slot_capacity" if @api_client.config.client_side_validation && body.nil?
  # verify the required parameter 'marketplace_ids' is set
  raise ArgumentError, "Missing the required parameter 'marketplace_ids' when calling ServiceApi.get_range_slot_capacity" if @api_client.config.client_side_validation && marketplace_ids.nil?
  # verify the required parameter 'resource_id' is set
  raise ArgumentError, "Missing the required parameter 'resource_id' when calling ServiceApi.get_range_slot_capacity" if @api_client.config.client_side_validation && resource_id.nil?

  # 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] unless 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)

  @api_client.config.logger.debug "API called: ServiceApi#get_range_slot_capacity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



663
664
665
666
 
# File 'lib/services_api_model/api/service_api.rb', line 663

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:

Raises:

  • (ArgumentError) 


672
673
674
675
676
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
 
# File 'lib/services_api_model/api/service_api.rb', line 672

def get_service_job_by_service_job_id_with_http_info(service_job_id, opts = {})
  @api_client.config.logger.debug 'Calling API: ServiceApi.get_service_job_by_service_job_id ...' if @api_client.config.debugging
  # verify the required parameter 'service_job_id' is set
  raise ArgumentError, "Missing the required parameter 'service_job_id' when calling ServiceApi.get_service_job_by_service_job_id" if @api_client.config.client_side_validation && service_job_id.nil?

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

  @api_client.config.logger.debug "API called: ServiceApi#get_service_job_by_service_job_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



728
729
730
731
 
# File 'lib/services_api_model/api/service_api.rb', line 728

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

Raises:

  • (ArgumentError) 


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
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'lib/services_api_model/api/service_api.rb', line 752

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

  # 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) unless opts[:service_order_ids].nil?
  query_params[:serviceJobStatus] = @api_client.build_collection_param(opts[:service_job_status], :csv) unless opts[:service_job_status].nil?
  query_params[:pageToken] = opts[:page_token] unless opts[:page_token].nil?
  query_params[:pageSize] = opts[:page_size] unless opts[:page_size].nil?
  query_params[:sortField] = opts[:sort_field] unless opts[:sort_field].nil?
  query_params[:sortOrder] = opts[:sort_order] unless opts[:sort_order].nil?
  query_params[:createdAfter] = opts[:created_after] unless opts[:created_after].nil?
  query_params[:createdBefore] = opts[:created_before] unless opts[:created_before].nil?
  query_params[:lastUpdatedAfter] = opts[:last_updated_after] unless opts[:last_updated_after].nil?
  query_params[:lastUpdatedBefore] = opts[:last_updated_before] unless opts[:last_updated_before].nil?
  query_params[:scheduleStartDate] = opts[:schedule_start_date] unless opts[:schedule_start_date].nil?
  query_params[:scheduleEndDate] = opts[:schedule_end_date] unless opts[:schedule_end_date].nil?
  query_params[:asins] = @api_client.build_collection_param(opts[:asins], :csv) unless opts[:asins].nil?
  query_params[:requiredSkills] = @api_client.build_collection_param(opts[:required_skills], :csv) unless opts[:required_skills].nil?
  query_params[:storeIds] = @api_client.build_collection_param(opts[:store_ids], :csv) unless 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)

  @api_client.config.logger.debug "API called: ServiceApi#get_service_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



814
815
816
817
 
# File 'lib/services_api_model/api/service_api.rb', line 814

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

Raises:

  • (ArgumentError) 


825
826
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
 
# File 'lib/services_api_model/api/service_api.rb', line 825

def reschedule_appointment_for_service_job_by_service_job_id_with_http_info(body, service_job_id, appointment_id, opts = {})
  @api_client.config.logger.debug 'Calling API: ServiceApi.reschedule_appointment_for_service_job_by_service_job_id ...' if @api_client.config.debugging
  # verify the required parameter 'body' is set
  raise ArgumentError, "Missing the required parameter 'body' when calling ServiceApi.reschedule_appointment_for_service_job_by_service_job_id" if @api_client.config.client_side_validation && body.nil?
  # verify the required parameter 'service_job_id' is set
  raise ArgumentError, "Missing the required parameter 'service_job_id' when calling ServiceApi.reschedule_appointment_for_service_job_by_service_job_id" if @api_client.config.client_side_validation && service_job_id.nil?
  # verify the required parameter 'appointment_id' is set
  raise ArgumentError, "Missing the required parameter 'appointment_id' when calling ServiceApi.reschedule_appointment_for_service_job_by_service_job_id" if @api_client.config.client_side_validation && appointment_id.nil?

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

  @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}" if @api_client.config.debugging
  [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) 


874
875
876
877
 
# File 'lib/services_api_model/api/service_api.rb', line 874

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

Raises:

  • (ArgumentError) 


885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
 
# File 'lib/services_api_model/api/service_api.rb', line 885

def set_appointment_fulfillment_data_with_http_info(body, service_job_id, appointment_id, opts = {})
  @api_client.config.logger.debug 'Calling API: ServiceApi.set_appointment_fulfillment_data ...' if @api_client.config.debugging
  # verify the required parameter 'body' is set
  raise ArgumentError, "Missing the required parameter 'body' when calling ServiceApi.set_appointment_fulfillment_data" if @api_client.config.client_side_validation && body.nil?
  # verify the required parameter 'service_job_id' is set
  raise ArgumentError, "Missing the required parameter 'service_job_id' when calling ServiceApi.set_appointment_fulfillment_data" if @api_client.config.client_side_validation && service_job_id.nil?
  # verify the required parameter 'appointment_id' is set
  raise ArgumentError, "Missing the required parameter 'appointment_id' when calling ServiceApi.set_appointment_fulfillment_data" if @api_client.config.client_side_validation && appointment_id.nil?

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

  @api_client.config.logger.debug "API called: ServiceApi#set_appointment_fulfillment_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



934
935
936
937
 
# File 'lib/services_api_model/api/service_api.rb', line 934

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

Raises:

  • (ArgumentError) 


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
 
# File 'lib/services_api_model/api/service_api.rb', line 945

def update_reservation_with_http_info(body, marketplace_ids, reservation_id, opts = {})
  @api_client.config.logger.debug 'Calling API: ServiceApi.update_reservation ...' if @api_client.config.debugging
  # verify the required parameter 'body' is set
  raise ArgumentError, "Missing the required parameter 'body' when calling ServiceApi.update_reservation" if @api_client.config.client_side_validation && body.nil?
  # verify the required parameter 'marketplace_ids' is set
  raise ArgumentError, "Missing the required parameter 'marketplace_ids' when calling ServiceApi.update_reservation" if @api_client.config.client_side_validation && marketplace_ids.nil?
  # verify the required parameter 'reservation_id' is set
  raise ArgumentError, "Missing the required parameter 'reservation_id' when calling ServiceApi.update_reservation" if @api_client.config.client_side_validation && reservation_id.nil?

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

  @api_client.config.logger.debug "API called: ServiceApi#update_reservation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



995
996
997
998
 
# File 'lib/services_api_model/api/service_api.rb', line 995

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

Raises:

  • (ArgumentError) 


1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/services_api_model/api/service_api.rb', line 1006

def update_schedule_with_http_info(body, marketplace_ids, resource_id, opts = {})
  @api_client.config.logger.debug 'Calling API: ServiceApi.update_schedule ...' if @api_client.config.debugging
  # verify the required parameter 'body' is set
  raise ArgumentError, "Missing the required parameter 'body' when calling ServiceApi.update_schedule" if @api_client.config.client_side_validation && body.nil?
  # verify the required parameter 'marketplace_ids' is set
  raise ArgumentError, "Missing the required parameter 'marketplace_ids' when calling ServiceApi.update_schedule" if @api_client.config.client_side_validation && marketplace_ids.nil?
  # verify the required parameter 'resource_id' is set
  raise ArgumentError, "Missing the required parameter 'resource_id' when calling ServiceApi.update_schedule" if @api_client.config.client_side_validation && resource_id.nil?

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

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