@sp-api-sdk/services-api-v1 1.8.9 → 1.9.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/cjs/src/api-model/api/service-api.js +860 -49
- package/dist/cjs/src/api-model/api.js +1 -1
- package/dist/cjs/src/api-model/base.js +1 -1
- package/dist/cjs/src/api-model/common.js +1 -1
- package/dist/cjs/src/api-model/configuration.js +1 -1
- package/dist/cjs/src/api-model/index.js +1 -1
- package/dist/cjs/src/api-model/models/add-appointment-request.js +1 -1
- package/dist/cjs/src/api-model/models/address.js +1 -1
- package/dist/cjs/src/api-model/models/appointment-resource.js +15 -0
- package/dist/cjs/src/api-model/models/appointment-slot-report.js +20 -0
- package/dist/cjs/src/api-model/models/appointment-slot.js +15 -0
- package/dist/cjs/src/api-model/models/appointment-time-input.js +1 -1
- package/dist/cjs/src/api-model/models/appointment-time.js +1 -1
- package/dist/cjs/src/api-model/models/appointment.js +1 -1
- package/dist/cjs/src/api-model/models/assign-appointment-resources-request.js +15 -0
- package/dist/cjs/src/api-model/models/assign-appointment-resources-response-payload.js +15 -0
- package/dist/cjs/src/api-model/models/assign-appointment-resources-response.js +15 -0
- package/dist/cjs/src/api-model/models/associated-item.js +1 -1
- package/dist/cjs/src/api-model/models/availability-record.js +15 -0
- package/dist/cjs/src/api-model/models/buyer.js +1 -1
- package/dist/cjs/src/api-model/models/cancel-reservation-response.js +15 -0
- package/dist/cjs/src/api-model/models/cancel-service-job-by-service-job-id-response.js +1 -1
- package/dist/cjs/src/api-model/models/capacity-type.js +27 -0
- package/dist/cjs/src/api-model/models/complete-service-job-by-service-job-id-response.js +1 -1
- package/dist/cjs/src/api-model/models/create-reservation-record.js +15 -0
- package/dist/cjs/src/api-model/models/create-reservation-request.js +15 -0
- package/dist/cjs/src/api-model/models/create-reservation-response.js +15 -0
- package/dist/cjs/src/api-model/models/create-service-document-upload-destination.js +15 -0
- package/dist/cjs/src/api-model/models/day-of-week.js +30 -0
- package/dist/cjs/src/api-model/models/encryption-details.js +19 -0
- package/dist/cjs/src/api-model/models/fixed-slot-capacity-errors.js +15 -0
- package/dist/cjs/src/api-model/models/fixed-slot-capacity-query.js +15 -0
- package/dist/cjs/src/api-model/models/fixed-slot-capacity.js +15 -0
- package/dist/cjs/src/api-model/models/fixed-slot.js +15 -0
- package/dist/cjs/src/api-model/models/fulfillment-document.js +15 -0
- package/dist/cjs/src/api-model/models/fulfillment-time.js +15 -0
- package/dist/cjs/src/api-model/models/get-appointment-slots-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-service-job-by-service-job-id-response.js +1 -1
- package/dist/cjs/src/api-model/models/get-service-jobs-response.js +1 -1
- package/dist/cjs/src/api-model/models/index.js +38 -0
- package/dist/cjs/src/api-model/models/item-delivery-promise.js +1 -1
- package/dist/cjs/src/api-model/models/item-delivery.js +1 -1
- package/dist/cjs/src/api-model/models/job-listing.js +1 -1
- package/dist/cjs/src/api-model/models/model-error.js +1 -1
- package/dist/cjs/src/api-model/models/poa.js +1 -1
- package/dist/cjs/src/api-model/models/range-capacity.js +15 -0
- package/dist/cjs/src/api-model/models/range-slot-capacity-errors.js +15 -0
- package/dist/cjs/src/api-model/models/range-slot-capacity-query.js +15 -0
- package/dist/cjs/src/api-model/models/range-slot-capacity.js +15 -0
- package/dist/cjs/src/api-model/models/range-slot.js +15 -0
- package/dist/cjs/src/api-model/models/recurrence.js +15 -0
- package/dist/cjs/src/api-model/models/reschedule-appointment-request.js +1 -1
- package/dist/cjs/src/api-model/models/reservation.js +23 -0
- package/dist/cjs/src/api-model/models/scope-of-work.js +1 -1
- package/dist/cjs/src/api-model/models/seller.js +1 -1
- package/dist/cjs/src/api-model/models/service-document-upload-destination.js +15 -0
- package/dist/cjs/src/api-model/models/service-job-provider.js +1 -1
- package/dist/cjs/src/api-model/models/service-job.js +1 -1
- package/dist/cjs/src/api-model/models/service-location.js +1 -1
- package/dist/cjs/src/api-model/models/service-upload-document.js +24 -0
- package/dist/cjs/src/api-model/models/set-appointment-fulfillment-data-request.js +15 -0
- package/dist/cjs/src/api-model/models/set-appointment-response.js +1 -1
- package/dist/cjs/src/api-model/models/technician.js +1 -1
- package/dist/cjs/src/api-model/models/update-reservation-record.js +15 -0
- package/dist/cjs/src/api-model/models/update-reservation-request.js +15 -0
- package/dist/cjs/src/api-model/models/update-reservation-response.js +15 -0
- package/dist/cjs/src/api-model/models/update-schedule-record.js +15 -0
- package/dist/cjs/src/api-model/models/update-schedule-request.js +15 -0
- package/dist/cjs/src/api-model/models/update-schedule-response.js +15 -0
- package/dist/cjs/src/api-model/models/warning.js +1 -1
- package/dist/cjs/src/client.js +77 -0
- package/dist/es/src/api-model/api/service-api.js +860 -49
- package/dist/es/src/api-model/api.js +1 -1
- package/dist/es/src/api-model/base.js +1 -1
- package/dist/es/src/api-model/common.js +1 -1
- package/dist/es/src/api-model/configuration.js +1 -1
- package/dist/es/src/api-model/index.js +1 -1
- package/dist/es/src/api-model/models/add-appointment-request.js +1 -1
- package/dist/es/src/api-model/models/address.js +1 -1
- package/dist/es/src/api-model/models/appointment-resource.js +14 -0
- package/dist/es/src/api-model/models/appointment-slot-report.js +17 -0
- package/dist/es/src/api-model/models/appointment-slot.js +14 -0
- package/dist/es/src/api-model/models/appointment-time-input.js +1 -1
- package/dist/es/src/api-model/models/appointment-time.js +1 -1
- package/dist/es/src/api-model/models/appointment.js +1 -1
- package/dist/es/src/api-model/models/assign-appointment-resources-request.js +14 -0
- package/dist/es/src/api-model/models/assign-appointment-resources-response-payload.js +14 -0
- package/dist/es/src/api-model/models/assign-appointment-resources-response.js +14 -0
- package/dist/es/src/api-model/models/associated-item.js +1 -1
- package/dist/es/src/api-model/models/availability-record.js +14 -0
- package/dist/es/src/api-model/models/buyer.js +1 -1
- package/dist/es/src/api-model/models/cancel-reservation-response.js +14 -0
- package/dist/es/src/api-model/models/cancel-service-job-by-service-job-id-response.js +1 -1
- package/dist/es/src/api-model/models/capacity-type.js +24 -0
- package/dist/es/src/api-model/models/complete-service-job-by-service-job-id-response.js +1 -1
- package/dist/es/src/api-model/models/create-reservation-record.js +14 -0
- package/dist/es/src/api-model/models/create-reservation-request.js +14 -0
- package/dist/es/src/api-model/models/create-reservation-response.js +14 -0
- package/dist/es/src/api-model/models/create-service-document-upload-destination.js +14 -0
- package/dist/es/src/api-model/models/day-of-week.js +27 -0
- package/dist/es/src/api-model/models/encryption-details.js +16 -0
- package/dist/es/src/api-model/models/fixed-slot-capacity-errors.js +14 -0
- package/dist/es/src/api-model/models/fixed-slot-capacity-query.js +14 -0
- package/dist/es/src/api-model/models/fixed-slot-capacity.js +14 -0
- package/dist/es/src/api-model/models/fixed-slot.js +14 -0
- package/dist/es/src/api-model/models/fulfillment-document.js +14 -0
- package/dist/es/src/api-model/models/fulfillment-time.js +14 -0
- package/dist/es/src/api-model/models/get-appointment-slots-response.js +14 -0
- package/dist/es/src/api-model/models/get-service-job-by-service-job-id-response.js +1 -1
- package/dist/es/src/api-model/models/get-service-jobs-response.js +1 -1
- package/dist/es/src/api-model/models/index.js +38 -0
- package/dist/es/src/api-model/models/item-delivery-promise.js +1 -1
- package/dist/es/src/api-model/models/item-delivery.js +1 -1
- package/dist/es/src/api-model/models/job-listing.js +1 -1
- package/dist/es/src/api-model/models/model-error.js +1 -1
- package/dist/es/src/api-model/models/poa.js +1 -1
- package/dist/es/src/api-model/models/range-capacity.js +14 -0
- package/dist/es/src/api-model/models/range-slot-capacity-errors.js +14 -0
- package/dist/es/src/api-model/models/range-slot-capacity-query.js +14 -0
- package/dist/es/src/api-model/models/range-slot-capacity.js +14 -0
- package/dist/es/src/api-model/models/range-slot.js +14 -0
- package/dist/es/src/api-model/models/recurrence.js +14 -0
- package/dist/es/src/api-model/models/reschedule-appointment-request.js +1 -1
- package/dist/es/src/api-model/models/reservation.js +20 -0
- package/dist/es/src/api-model/models/scope-of-work.js +1 -1
- package/dist/es/src/api-model/models/seller.js +1 -1
- package/dist/es/src/api-model/models/service-document-upload-destination.js +14 -0
- package/dist/es/src/api-model/models/service-job-provider.js +1 -1
- package/dist/es/src/api-model/models/service-job.js +1 -1
- package/dist/es/src/api-model/models/service-location.js +1 -1
- package/dist/es/src/api-model/models/service-upload-document.js +21 -0
- package/dist/es/src/api-model/models/set-appointment-fulfillment-data-request.js +14 -0
- package/dist/es/src/api-model/models/set-appointment-response.js +1 -1
- package/dist/es/src/api-model/models/technician.js +1 -1
- package/dist/es/src/api-model/models/update-reservation-record.js +14 -0
- package/dist/es/src/api-model/models/update-reservation-request.js +14 -0
- package/dist/es/src/api-model/models/update-reservation-response.js +14 -0
- package/dist/es/src/api-model/models/update-schedule-record.js +14 -0
- package/dist/es/src/api-model/models/update-schedule-request.js +14 -0
- package/dist/es/src/api-model/models/update-schedule-response.js +14 -0
- package/dist/es/src/api-model/models/warning.js +1 -1
- package/dist/es/src/client.js +77 -0
- package/dist/types/src/api-model/api/service-api.d.ts +765 -52
- package/dist/types/src/api-model/api.d.ts +1 -1
- package/dist/types/src/api-model/base.d.ts +1 -1
- package/dist/types/src/api-model/common.d.ts +1 -1
- package/dist/types/src/api-model/configuration.d.ts +1 -1
- package/dist/types/src/api-model/index.d.ts +1 -1
- package/dist/types/src/api-model/models/add-appointment-request.d.ts +1 -1
- package/dist/types/src/api-model/models/address.d.ts +1 -1
- package/dist/types/src/api-model/models/appointment-resource.d.ts +24 -0
- package/dist/types/src/api-model/models/appointment-slot-report.d.ts +48 -0
- package/dist/types/src/api-model/models/appointment-slot.d.ts +36 -0
- package/dist/types/src/api-model/models/appointment-time-input.d.ts +1 -1
- package/dist/types/src/api-model/models/appointment-time.d.ts +2 -2
- package/dist/types/src/api-model/models/appointment.d.ts +1 -1
- package/dist/types/src/api-model/models/assign-appointment-resources-request.d.ts +25 -0
- package/dist/types/src/api-model/models/assign-appointment-resources-response-payload.d.ts +25 -0
- package/dist/types/src/api-model/models/assign-appointment-resources-response.d.ts +31 -0
- package/dist/types/src/api-model/models/associated-item.d.ts +1 -1
- package/dist/types/src/api-model/models/availability-record.d.ts +43 -0
- package/dist/types/src/api-model/models/buyer.d.ts +1 -1
- package/dist/types/src/api-model/models/cancel-reservation-response.d.ts +24 -0
- package/dist/types/src/api-model/models/cancel-service-job-by-service-job-id-response.d.ts +2 -2
- package/dist/types/src/api-model/models/capacity-type.d.ts +23 -0
- package/dist/types/src/api-model/models/complete-service-job-by-service-job-id-response.d.ts +2 -2
- package/dist/types/src/api-model/models/create-reservation-record.d.ts +38 -0
- package/dist/types/src/api-model/models/create-reservation-request.d.ts +31 -0
- package/dist/types/src/api-model/models/create-reservation-response.d.ts +31 -0
- package/dist/types/src/api-model/models/create-service-document-upload-destination.d.ts +31 -0
- package/dist/types/src/api-model/models/day-of-week.d.ts +26 -0
- package/dist/types/src/api-model/models/encryption-details.d.ts +40 -0
- package/dist/types/src/api-model/models/fixed-slot-capacity-errors.d.ts +24 -0
- package/dist/types/src/api-model/models/fixed-slot-capacity-query.d.ts +43 -0
- package/dist/types/src/api-model/models/fixed-slot-capacity.d.ts +43 -0
- package/dist/types/src/api-model/models/fixed-slot.d.ts +48 -0
- package/dist/types/src/api-model/models/fulfillment-document.d.ts +30 -0
- package/dist/types/src/api-model/models/fulfillment-time.d.ts +30 -0
- package/dist/types/src/api-model/models/get-appointment-slots-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-service-job-by-service-job-id-response.d.ts +2 -2
- package/dist/types/src/api-model/models/get-service-jobs-response.d.ts +2 -2
- package/dist/types/src/api-model/models/index.d.ts +38 -0
- package/dist/types/src/api-model/models/item-delivery-promise.d.ts +3 -3
- package/dist/types/src/api-model/models/item-delivery.d.ts +1 -1
- package/dist/types/src/api-model/models/job-listing.d.ts +4 -4
- package/dist/types/src/api-model/models/model-error.d.ts +1 -1
- package/dist/types/src/api-model/models/poa.d.ts +2 -2
- package/dist/types/src/api-model/models/range-capacity.d.ts +32 -0
- package/dist/types/src/api-model/models/range-slot-capacity-errors.d.ts +24 -0
- package/dist/types/src/api-model/models/range-slot-capacity-query.d.ts +37 -0
- package/dist/types/src/api-model/models/range-slot-capacity.d.ts +37 -0
- package/dist/types/src/api-model/models/range-slot.d.ts +36 -0
- package/dist/types/src/api-model/models/recurrence.d.ts +37 -0
- package/dist/types/src/api-model/models/reschedule-appointment-request.d.ts +2 -2
- package/dist/types/src/api-model/models/reservation.d.ts +45 -0
- package/dist/types/src/api-model/models/scope-of-work.d.ts +1 -1
- package/dist/types/src/api-model/models/seller.d.ts +1 -1
- package/dist/types/src/api-model/models/service-document-upload-destination.d.ts +43 -0
- package/dist/types/src/api-model/models/service-job-provider.d.ts +1 -1
- package/dist/types/src/api-model/models/service-job.d.ts +8 -2
- package/dist/types/src/api-model/models/service-location.d.ts +1 -1
- package/dist/types/src/api-model/models/service-upload-document.d.ts +45 -0
- package/dist/types/src/api-model/models/set-appointment-fulfillment-data-request.d.ts +39 -0
- package/dist/types/src/api-model/models/set-appointment-response.d.ts +2 -2
- package/dist/types/src/api-model/models/technician.d.ts +1 -1
- package/dist/types/src/api-model/models/update-reservation-record.d.ts +38 -0
- package/dist/types/src/api-model/models/update-reservation-request.d.ts +31 -0
- package/dist/types/src/api-model/models/update-reservation-response.d.ts +31 -0
- package/dist/types/src/api-model/models/update-schedule-record.d.ts +38 -0
- package/dist/types/src/api-model/models/update-schedule-request.d.ts +25 -0
- package/dist/types/src/api-model/models/update-schedule-response.d.ts +31 -0
- package/dist/types/src/api-model/models/warning.d.ts +2 -2
- package/package.json +5 -5
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Selling Partner API for Services
|
|
5
|
-
* With the Services API, you can build applications that help service providers get and modify their service orders.
|
|
5
|
+
* With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: v1
|
|
8
8
|
*
|
|
@@ -24,7 +24,7 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
|
|
|
24
24
|
export const ServiceApiAxiosParamCreator = function (configuration) {
|
|
25
25
|
return {
|
|
26
26
|
/**
|
|
27
|
-
* Adds an appointment to the service job indicated by the service job identifier
|
|
27
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
28
28
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
29
29
|
* @param {AddAppointmentRequest} body Add appointment operation input details.
|
|
30
30
|
* @param {*} [options] Override http request option.
|
|
@@ -57,7 +57,78 @@ export const ServiceApiAxiosParamCreator = function (configuration) {
|
|
|
57
57
|
};
|
|
58
58
|
},
|
|
59
59
|
/**
|
|
60
|
-
*
|
|
60
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
61
|
+
* @param {string} serviceJobId An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.
|
|
62
|
+
* @param {string} appointmentId An Amazon-defined identifier of active service job appointment.
|
|
63
|
+
* @param {AssignAppointmentResourcesRequest} body
|
|
64
|
+
* @param {*} [options] Override http request option.
|
|
65
|
+
* @throws {RequiredError}
|
|
66
|
+
*/
|
|
67
|
+
assignAppointmentResources: async (serviceJobId, appointmentId, body, options = {}) => {
|
|
68
|
+
// verify required parameter 'serviceJobId' is not null or undefined
|
|
69
|
+
assertParamExists('assignAppointmentResources', 'serviceJobId', serviceJobId);
|
|
70
|
+
// verify required parameter 'appointmentId' is not null or undefined
|
|
71
|
+
assertParamExists('assignAppointmentResources', 'appointmentId', appointmentId);
|
|
72
|
+
// verify required parameter 'body' is not null or undefined
|
|
73
|
+
assertParamExists('assignAppointmentResources', 'body', body);
|
|
74
|
+
const localVarPath = `/service/v1/serviceJobs/{serviceJobId}/appointments/{appointmentId}/resources`
|
|
75
|
+
.replace(`{${"serviceJobId"}}`, encodeURIComponent(String(serviceJobId)))
|
|
76
|
+
.replace(`{${"appointmentId"}}`, encodeURIComponent(String(appointmentId)));
|
|
77
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
78
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
79
|
+
let baseOptions;
|
|
80
|
+
if (configuration) {
|
|
81
|
+
baseOptions = configuration.baseOptions;
|
|
82
|
+
}
|
|
83
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
84
|
+
const localVarHeaderParameter = {};
|
|
85
|
+
const localVarQueryParameter = {};
|
|
86
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
87
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
88
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
89
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
90
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
91
|
+
return {
|
|
92
|
+
url: toPathString(localVarUrlObj),
|
|
93
|
+
options: localVarRequestOptions,
|
|
94
|
+
};
|
|
95
|
+
},
|
|
96
|
+
/**
|
|
97
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
98
|
+
* @param {string} reservationId Reservation Identifier
|
|
99
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
100
|
+
* @param {*} [options] Override http request option.
|
|
101
|
+
* @throws {RequiredError}
|
|
102
|
+
*/
|
|
103
|
+
cancelReservation: async (reservationId, marketplaceIds, options = {}) => {
|
|
104
|
+
// verify required parameter 'reservationId' is not null or undefined
|
|
105
|
+
assertParamExists('cancelReservation', 'reservationId', reservationId);
|
|
106
|
+
// verify required parameter 'marketplaceIds' is not null or undefined
|
|
107
|
+
assertParamExists('cancelReservation', 'marketplaceIds', marketplaceIds);
|
|
108
|
+
const localVarPath = `/service/v1/reservation/{reservationId}`
|
|
109
|
+
.replace(`{${"reservationId"}}`, encodeURIComponent(String(reservationId)));
|
|
110
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
111
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
112
|
+
let baseOptions;
|
|
113
|
+
if (configuration) {
|
|
114
|
+
baseOptions = configuration.baseOptions;
|
|
115
|
+
}
|
|
116
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
117
|
+
const localVarHeaderParameter = {};
|
|
118
|
+
const localVarQueryParameter = {};
|
|
119
|
+
if (marketplaceIds) {
|
|
120
|
+
localVarQueryParameter['marketplaceIds'] = marketplaceIds.join(COLLECTION_FORMATS.csv);
|
|
121
|
+
}
|
|
122
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
123
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
124
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
125
|
+
return {
|
|
126
|
+
url: toPathString(localVarUrlObj),
|
|
127
|
+
options: localVarRequestOptions,
|
|
128
|
+
};
|
|
129
|
+
},
|
|
130
|
+
/**
|
|
131
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
61
132
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
62
133
|
* @param {string} cancellationReasonCode A cancel reason code that specifies the reason for cancelling a service job.
|
|
63
134
|
* @param {*} [options] Override http request option.
|
|
@@ -91,7 +162,7 @@ export const ServiceApiAxiosParamCreator = function (configuration) {
|
|
|
91
162
|
};
|
|
92
163
|
},
|
|
93
164
|
/**
|
|
94
|
-
* Completes the service job indicated by the service job identifier
|
|
165
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
95
166
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
96
167
|
* @param {*} [options] Override http request option.
|
|
97
168
|
* @throws {RequiredError}
|
|
@@ -119,7 +190,249 @@ export const ServiceApiAxiosParamCreator = function (configuration) {
|
|
|
119
190
|
};
|
|
120
191
|
},
|
|
121
192
|
/**
|
|
122
|
-
*
|
|
193
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
194
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
195
|
+
* @param {CreateReservationRequest} body Reservation details
|
|
196
|
+
* @param {*} [options] Override http request option.
|
|
197
|
+
* @throws {RequiredError}
|
|
198
|
+
*/
|
|
199
|
+
createReservation: async (marketplaceIds, body, options = {}) => {
|
|
200
|
+
// verify required parameter 'marketplaceIds' is not null or undefined
|
|
201
|
+
assertParamExists('createReservation', 'marketplaceIds', marketplaceIds);
|
|
202
|
+
// verify required parameter 'body' is not null or undefined
|
|
203
|
+
assertParamExists('createReservation', 'body', body);
|
|
204
|
+
const localVarPath = `/service/v1/reservation`;
|
|
205
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
206
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
207
|
+
let baseOptions;
|
|
208
|
+
if (configuration) {
|
|
209
|
+
baseOptions = configuration.baseOptions;
|
|
210
|
+
}
|
|
211
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
212
|
+
const localVarHeaderParameter = {};
|
|
213
|
+
const localVarQueryParameter = {};
|
|
214
|
+
if (marketplaceIds) {
|
|
215
|
+
localVarQueryParameter['marketplaceIds'] = marketplaceIds.join(COLLECTION_FORMATS.csv);
|
|
216
|
+
}
|
|
217
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
218
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
219
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
220
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
221
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
222
|
+
return {
|
|
223
|
+
url: toPathString(localVarUrlObj),
|
|
224
|
+
options: localVarRequestOptions,
|
|
225
|
+
};
|
|
226
|
+
},
|
|
227
|
+
/**
|
|
228
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
229
|
+
* @param {ServiceUploadDocument} body Upload document operation input details.
|
|
230
|
+
* @param {*} [options] Override http request option.
|
|
231
|
+
* @throws {RequiredError}
|
|
232
|
+
*/
|
|
233
|
+
createServiceDocumentUploadDestination: async (body, options = {}) => {
|
|
234
|
+
// verify required parameter 'body' is not null or undefined
|
|
235
|
+
assertParamExists('createServiceDocumentUploadDestination', 'body', body);
|
|
236
|
+
const localVarPath = `/service/v1/documents`;
|
|
237
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
238
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
239
|
+
let baseOptions;
|
|
240
|
+
if (configuration) {
|
|
241
|
+
baseOptions = configuration.baseOptions;
|
|
242
|
+
}
|
|
243
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
244
|
+
const localVarHeaderParameter = {};
|
|
245
|
+
const localVarQueryParameter = {};
|
|
246
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
247
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
248
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
249
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
250
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
251
|
+
return {
|
|
252
|
+
url: toPathString(localVarUrlObj),
|
|
253
|
+
options: localVarRequestOptions,
|
|
254
|
+
};
|
|
255
|
+
},
|
|
256
|
+
/**
|
|
257
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
258
|
+
* @param {string} asin ASIN associated with the service.
|
|
259
|
+
* @param {string} storeId Store identifier defining the region scope to retrive appointment slots.
|
|
260
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace for which appointment slots are queried
|
|
261
|
+
* @param {string} [startTime] A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `startTime` is provided, `endTime` should also be provided. Default value is as per business configuration.
|
|
262
|
+
* @param {string} [endTime] A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `endTime` is provided, `startTime` should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.
|
|
263
|
+
* @param {*} [options] Override http request option.
|
|
264
|
+
* @throws {RequiredError}
|
|
265
|
+
*/
|
|
266
|
+
getAppointmentSlots: async (asin, storeId, marketplaceIds, startTime, endTime, options = {}) => {
|
|
267
|
+
// verify required parameter 'asin' is not null or undefined
|
|
268
|
+
assertParamExists('getAppointmentSlots', 'asin', asin);
|
|
269
|
+
// verify required parameter 'storeId' is not null or undefined
|
|
270
|
+
assertParamExists('getAppointmentSlots', 'storeId', storeId);
|
|
271
|
+
// verify required parameter 'marketplaceIds' is not null or undefined
|
|
272
|
+
assertParamExists('getAppointmentSlots', 'marketplaceIds', marketplaceIds);
|
|
273
|
+
const localVarPath = `/service/v1/appointmentSlots`;
|
|
274
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
275
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
276
|
+
let baseOptions;
|
|
277
|
+
if (configuration) {
|
|
278
|
+
baseOptions = configuration.baseOptions;
|
|
279
|
+
}
|
|
280
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
281
|
+
const localVarHeaderParameter = {};
|
|
282
|
+
const localVarQueryParameter = {};
|
|
283
|
+
if (asin !== undefined) {
|
|
284
|
+
localVarQueryParameter['asin'] = asin;
|
|
285
|
+
}
|
|
286
|
+
if (storeId !== undefined) {
|
|
287
|
+
localVarQueryParameter['storeId'] = storeId;
|
|
288
|
+
}
|
|
289
|
+
if (marketplaceIds) {
|
|
290
|
+
localVarQueryParameter['marketplaceIds'] = marketplaceIds.join(COLLECTION_FORMATS.csv);
|
|
291
|
+
}
|
|
292
|
+
if (startTime !== undefined) {
|
|
293
|
+
localVarQueryParameter['startTime'] = startTime;
|
|
294
|
+
}
|
|
295
|
+
if (endTime !== undefined) {
|
|
296
|
+
localVarQueryParameter['endTime'] = endTime;
|
|
297
|
+
}
|
|
298
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
299
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
300
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
301
|
+
return {
|
|
302
|
+
url: toPathString(localVarUrlObj),
|
|
303
|
+
options: localVarRequestOptions,
|
|
304
|
+
};
|
|
305
|
+
},
|
|
306
|
+
/**
|
|
307
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
308
|
+
* @param {string} serviceJobId A service job identifier to retrive appointment slots for associated service.
|
|
309
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
310
|
+
* @param {string} [startTime] A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `startTime` is provided, `endTime` should also be provided. Default value is as per business configuration.
|
|
311
|
+
* @param {string} [endTime] A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `endTime` is provided, `startTime` should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.
|
|
312
|
+
* @param {*} [options] Override http request option.
|
|
313
|
+
* @throws {RequiredError}
|
|
314
|
+
*/
|
|
315
|
+
getAppointmmentSlotsByJobId: async (serviceJobId, marketplaceIds, startTime, endTime, options = {}) => {
|
|
316
|
+
// verify required parameter 'serviceJobId' is not null or undefined
|
|
317
|
+
assertParamExists('getAppointmmentSlotsByJobId', 'serviceJobId', serviceJobId);
|
|
318
|
+
// verify required parameter 'marketplaceIds' is not null or undefined
|
|
319
|
+
assertParamExists('getAppointmmentSlotsByJobId', 'marketplaceIds', marketplaceIds);
|
|
320
|
+
const localVarPath = `/service/v1/serviceJobs/{serviceJobId}/appointmentSlots`
|
|
321
|
+
.replace(`{${"serviceJobId"}}`, encodeURIComponent(String(serviceJobId)));
|
|
322
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
323
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
324
|
+
let baseOptions;
|
|
325
|
+
if (configuration) {
|
|
326
|
+
baseOptions = configuration.baseOptions;
|
|
327
|
+
}
|
|
328
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
329
|
+
const localVarHeaderParameter = {};
|
|
330
|
+
const localVarQueryParameter = {};
|
|
331
|
+
if (marketplaceIds) {
|
|
332
|
+
localVarQueryParameter['marketplaceIds'] = marketplaceIds.join(COLLECTION_FORMATS.csv);
|
|
333
|
+
}
|
|
334
|
+
if (startTime !== undefined) {
|
|
335
|
+
localVarQueryParameter['startTime'] = startTime;
|
|
336
|
+
}
|
|
337
|
+
if (endTime !== undefined) {
|
|
338
|
+
localVarQueryParameter['endTime'] = endTime;
|
|
339
|
+
}
|
|
340
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
341
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
342
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
343
|
+
return {
|
|
344
|
+
url: toPathString(localVarUrlObj),
|
|
345
|
+
options: localVarRequestOptions,
|
|
346
|
+
};
|
|
347
|
+
},
|
|
348
|
+
/**
|
|
349
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
350
|
+
* @param {string} resourceId Resource Identifier.
|
|
351
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
352
|
+
* @param {FixedSlotCapacityQuery} body Request body.
|
|
353
|
+
* @param {string} [nextPageToken] Next page token returned in the response of your previous request.
|
|
354
|
+
* @param {*} [options] Override http request option.
|
|
355
|
+
* @throws {RequiredError}
|
|
356
|
+
*/
|
|
357
|
+
getFixedSlotCapacity: async (resourceId, marketplaceIds, body, nextPageToken, options = {}) => {
|
|
358
|
+
// verify required parameter 'resourceId' is not null or undefined
|
|
359
|
+
assertParamExists('getFixedSlotCapacity', 'resourceId', resourceId);
|
|
360
|
+
// verify required parameter 'marketplaceIds' is not null or undefined
|
|
361
|
+
assertParamExists('getFixedSlotCapacity', 'marketplaceIds', marketplaceIds);
|
|
362
|
+
// verify required parameter 'body' is not null or undefined
|
|
363
|
+
assertParamExists('getFixedSlotCapacity', 'body', body);
|
|
364
|
+
const localVarPath = `/service/v1/serviceResources/{resourceId}/capacity/fixed`
|
|
365
|
+
.replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId)));
|
|
366
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
367
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
368
|
+
let baseOptions;
|
|
369
|
+
if (configuration) {
|
|
370
|
+
baseOptions = configuration.baseOptions;
|
|
371
|
+
}
|
|
372
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
373
|
+
const localVarHeaderParameter = {};
|
|
374
|
+
const localVarQueryParameter = {};
|
|
375
|
+
if (marketplaceIds) {
|
|
376
|
+
localVarQueryParameter['marketplaceIds'] = marketplaceIds.join(COLLECTION_FORMATS.csv);
|
|
377
|
+
}
|
|
378
|
+
if (nextPageToken !== undefined) {
|
|
379
|
+
localVarQueryParameter['nextPageToken'] = nextPageToken;
|
|
380
|
+
}
|
|
381
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
382
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
383
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
384
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
385
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
386
|
+
return {
|
|
387
|
+
url: toPathString(localVarUrlObj),
|
|
388
|
+
options: localVarRequestOptions,
|
|
389
|
+
};
|
|
390
|
+
},
|
|
391
|
+
/**
|
|
392
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
393
|
+
* @param {string} resourceId Resource Identifier.
|
|
394
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
395
|
+
* @param {RangeSlotCapacityQuery} body Request body.
|
|
396
|
+
* @param {string} [nextPageToken] Next page token returned in the response of your previous request.
|
|
397
|
+
* @param {*} [options] Override http request option.
|
|
398
|
+
* @throws {RequiredError}
|
|
399
|
+
*/
|
|
400
|
+
getRangeSlotCapacity: async (resourceId, marketplaceIds, body, nextPageToken, options = {}) => {
|
|
401
|
+
// verify required parameter 'resourceId' is not null or undefined
|
|
402
|
+
assertParamExists('getRangeSlotCapacity', 'resourceId', resourceId);
|
|
403
|
+
// verify required parameter 'marketplaceIds' is not null or undefined
|
|
404
|
+
assertParamExists('getRangeSlotCapacity', 'marketplaceIds', marketplaceIds);
|
|
405
|
+
// verify required parameter 'body' is not null or undefined
|
|
406
|
+
assertParamExists('getRangeSlotCapacity', 'body', body);
|
|
407
|
+
const localVarPath = `/service/v1/serviceResources/{resourceId}/capacity/range`
|
|
408
|
+
.replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId)));
|
|
409
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
410
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
411
|
+
let baseOptions;
|
|
412
|
+
if (configuration) {
|
|
413
|
+
baseOptions = configuration.baseOptions;
|
|
414
|
+
}
|
|
415
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
416
|
+
const localVarHeaderParameter = {};
|
|
417
|
+
const localVarQueryParameter = {};
|
|
418
|
+
if (marketplaceIds) {
|
|
419
|
+
localVarQueryParameter['marketplaceIds'] = marketplaceIds.join(COLLECTION_FORMATS.csv);
|
|
420
|
+
}
|
|
421
|
+
if (nextPageToken !== undefined) {
|
|
422
|
+
localVarQueryParameter['nextPageToken'] = nextPageToken;
|
|
423
|
+
}
|
|
424
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
425
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
426
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
427
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
428
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
429
|
+
return {
|
|
430
|
+
url: toPathString(localVarUrlObj),
|
|
431
|
+
options: localVarRequestOptions,
|
|
432
|
+
};
|
|
433
|
+
},
|
|
434
|
+
/**
|
|
435
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
123
436
|
* @param {string} serviceJobId A service job identifier.
|
|
124
437
|
* @param {*} [options] Override http request option.
|
|
125
438
|
* @throws {RequiredError}
|
|
@@ -147,7 +460,7 @@ export const ServiceApiAxiosParamCreator = function (configuration) {
|
|
|
147
460
|
};
|
|
148
461
|
},
|
|
149
462
|
/**
|
|
150
|
-
* Gets service job details for the specified filter query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 40 | For more information, see
|
|
463
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
151
464
|
* @param {Array<string>} marketplaceIds Used to select jobs that were placed in the specified marketplaces.
|
|
152
465
|
* @param {Array<string>} [serviceOrderIds] List of service order ids for the query you want to perform.Max values supported 20.
|
|
153
466
|
* @param {Array<'NOT_SERVICED' | 'CANCELLED' | 'COMPLETED' | 'PENDING_SCHEDULE' | 'NOT_FULFILLABLE' | 'HOLD' | 'PAYMENT_DECLINED'>} [serviceJobStatus] A list of one or more job status by which to filter the list of jobs.
|
|
@@ -155,16 +468,19 @@ export const ServiceApiAxiosParamCreator = function (configuration) {
|
|
|
155
468
|
* @param {number} [pageSize] A non-negative integer that indicates the maximum number of jobs to return in the list, Value must be 1 - 20. Default 20.
|
|
156
469
|
* @param {'JOB_DATE' | 'JOB_STATUS'} [sortField] Sort fields on which you want to sort the output.
|
|
157
470
|
* @param {'ASC' | 'DESC'} [sortOrder] Sort order for the query you want to perform.
|
|
158
|
-
* @param {string} [createdAfter] A date used for selecting jobs created
|
|
159
|
-
* @param {string} [createdBefore] A date used for selecting jobs created
|
|
160
|
-
* @param {string} [lastUpdatedAfter] A date used for selecting jobs updated
|
|
161
|
-
* @param {string} [lastUpdatedBefore] A date used for selecting jobs updated
|
|
162
|
-
* @param {string} [scheduleStartDate] A date used for filtering jobs
|
|
163
|
-
* @param {string} [scheduleEndDate] A date used for filtering jobs
|
|
471
|
+
* @param {string} [createdAfter] A date used for selecting jobs created at or after a specified time. Must be in ISO 8601 format. Required if `LastUpdatedAfter` is not specified. Specifying both `CreatedAfter` and `LastUpdatedAfter` returns an error.
|
|
472
|
+
* @param {string} [createdBefore] A date used for selecting jobs created at or before a specified time. Must be in ISO 8601 format.
|
|
473
|
+
* @param {string} [lastUpdatedAfter] A date used for selecting jobs updated at or after a specified time. Must be in ISO 8601 format. Required if `createdAfter` is not specified. Specifying both `CreatedAfter` and `LastUpdatedAfter` returns an error.
|
|
474
|
+
* @param {string} [lastUpdatedBefore] A date used for selecting jobs updated at or before a specified time. Must be in ISO 8601 format.
|
|
475
|
+
* @param {string} [scheduleStartDate] 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.
|
|
476
|
+
* @param {string} [scheduleEndDate] 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.
|
|
477
|
+
* @param {Array<string>} [asins] List of Amazon Standard Identification Numbers (ASIN) of the items. Max values supported is 20.
|
|
478
|
+
* @param {Array<string>} [requiredSkills] 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.
|
|
479
|
+
* @param {Array<string>} [storeIds] List of Amazon-defined identifiers for the region scope. Max values supported is 50.
|
|
164
480
|
* @param {*} [options] Override http request option.
|
|
165
481
|
* @throws {RequiredError}
|
|
166
482
|
*/
|
|
167
|
-
getServiceJobs: async (marketplaceIds, serviceOrderIds, serviceJobStatus, pageToken, pageSize, sortField, sortOrder, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, scheduleStartDate, scheduleEndDate, options = {}) => {
|
|
483
|
+
getServiceJobs: async (marketplaceIds, serviceOrderIds, serviceJobStatus, pageToken, pageSize, sortField, sortOrder, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, scheduleStartDate, scheduleEndDate, asins, requiredSkills, storeIds, options = {}) => {
|
|
168
484
|
// verify required parameter 'marketplaceIds' is not null or undefined
|
|
169
485
|
assertParamExists('getServiceJobs', 'marketplaceIds', marketplaceIds);
|
|
170
486
|
const localVarPath = `/service/v1/serviceJobs`;
|
|
@@ -216,6 +532,15 @@ export const ServiceApiAxiosParamCreator = function (configuration) {
|
|
|
216
532
|
if (marketplaceIds) {
|
|
217
533
|
localVarQueryParameter['marketplaceIds'] = marketplaceIds.join(COLLECTION_FORMATS.csv);
|
|
218
534
|
}
|
|
535
|
+
if (asins) {
|
|
536
|
+
localVarQueryParameter['asins'] = asins.join(COLLECTION_FORMATS.csv);
|
|
537
|
+
}
|
|
538
|
+
if (requiredSkills) {
|
|
539
|
+
localVarQueryParameter['requiredSkills'] = requiredSkills.join(COLLECTION_FORMATS.csv);
|
|
540
|
+
}
|
|
541
|
+
if (storeIds) {
|
|
542
|
+
localVarQueryParameter['storeIds'] = storeIds.join(COLLECTION_FORMATS.csv);
|
|
543
|
+
}
|
|
219
544
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
220
545
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
221
546
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -225,7 +550,7 @@ export const ServiceApiAxiosParamCreator = function (configuration) {
|
|
|
225
550
|
};
|
|
226
551
|
},
|
|
227
552
|
/**
|
|
228
|
-
* Reschedules an appointment for the service job indicated by the service job identifier
|
|
553
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
229
554
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
230
555
|
* @param {string} appointmentId An existing appointment identifier for the Service Job.
|
|
231
556
|
* @param {RescheduleAppointmentRequest} body Reschedule appointment operation input details.
|
|
@@ -261,6 +586,121 @@ export const ServiceApiAxiosParamCreator = function (configuration) {
|
|
|
261
586
|
options: localVarRequestOptions,
|
|
262
587
|
};
|
|
263
588
|
},
|
|
589
|
+
/**
|
|
590
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
591
|
+
* @param {string} serviceJobId An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.
|
|
592
|
+
* @param {string} appointmentId An Amazon-defined identifier of active service job appointment.
|
|
593
|
+
* @param {SetAppointmentFulfillmentDataRequest} body Appointment fulfillment data collection details.
|
|
594
|
+
* @param {*} [options] Override http request option.
|
|
595
|
+
* @throws {RequiredError}
|
|
596
|
+
*/
|
|
597
|
+
setAppointmentFulfillmentData: async (serviceJobId, appointmentId, body, options = {}) => {
|
|
598
|
+
// verify required parameter 'serviceJobId' is not null or undefined
|
|
599
|
+
assertParamExists('setAppointmentFulfillmentData', 'serviceJobId', serviceJobId);
|
|
600
|
+
// verify required parameter 'appointmentId' is not null or undefined
|
|
601
|
+
assertParamExists('setAppointmentFulfillmentData', 'appointmentId', appointmentId);
|
|
602
|
+
// verify required parameter 'body' is not null or undefined
|
|
603
|
+
assertParamExists('setAppointmentFulfillmentData', 'body', body);
|
|
604
|
+
const localVarPath = `/service/v1/serviceJobs/{serviceJobId}/appointments/{appointmentId}/fulfillment`
|
|
605
|
+
.replace(`{${"serviceJobId"}}`, encodeURIComponent(String(serviceJobId)))
|
|
606
|
+
.replace(`{${"appointmentId"}}`, encodeURIComponent(String(appointmentId)));
|
|
607
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
608
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
609
|
+
let baseOptions;
|
|
610
|
+
if (configuration) {
|
|
611
|
+
baseOptions = configuration.baseOptions;
|
|
612
|
+
}
|
|
613
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
614
|
+
const localVarHeaderParameter = {};
|
|
615
|
+
const localVarQueryParameter = {};
|
|
616
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
617
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
618
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
619
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
620
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
621
|
+
return {
|
|
622
|
+
url: toPathString(localVarUrlObj),
|
|
623
|
+
options: localVarRequestOptions,
|
|
624
|
+
};
|
|
625
|
+
},
|
|
626
|
+
/**
|
|
627
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
628
|
+
* @param {string} reservationId Reservation Identifier
|
|
629
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
630
|
+
* @param {UpdateReservationRequest} body Reservation details
|
|
631
|
+
* @param {*} [options] Override http request option.
|
|
632
|
+
* @throws {RequiredError}
|
|
633
|
+
*/
|
|
634
|
+
updateReservation: async (reservationId, marketplaceIds, body, options = {}) => {
|
|
635
|
+
// verify required parameter 'reservationId' is not null or undefined
|
|
636
|
+
assertParamExists('updateReservation', 'reservationId', reservationId);
|
|
637
|
+
// verify required parameter 'marketplaceIds' is not null or undefined
|
|
638
|
+
assertParamExists('updateReservation', 'marketplaceIds', marketplaceIds);
|
|
639
|
+
// verify required parameter 'body' is not null or undefined
|
|
640
|
+
assertParamExists('updateReservation', 'body', body);
|
|
641
|
+
const localVarPath = `/service/v1/reservation/{reservationId}`
|
|
642
|
+
.replace(`{${"reservationId"}}`, encodeURIComponent(String(reservationId)));
|
|
643
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
644
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
645
|
+
let baseOptions;
|
|
646
|
+
if (configuration) {
|
|
647
|
+
baseOptions = configuration.baseOptions;
|
|
648
|
+
}
|
|
649
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
650
|
+
const localVarHeaderParameter = {};
|
|
651
|
+
const localVarQueryParameter = {};
|
|
652
|
+
if (marketplaceIds) {
|
|
653
|
+
localVarQueryParameter['marketplaceIds'] = marketplaceIds.join(COLLECTION_FORMATS.csv);
|
|
654
|
+
}
|
|
655
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
656
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
657
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
658
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
659
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
660
|
+
return {
|
|
661
|
+
url: toPathString(localVarUrlObj),
|
|
662
|
+
options: localVarRequestOptions,
|
|
663
|
+
};
|
|
664
|
+
},
|
|
665
|
+
/**
|
|
666
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
667
|
+
* @param {string} resourceId Resource (store) Identifier
|
|
668
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
669
|
+
* @param {UpdateScheduleRequest} body Schedule details
|
|
670
|
+
* @param {*} [options] Override http request option.
|
|
671
|
+
* @throws {RequiredError}
|
|
672
|
+
*/
|
|
673
|
+
updateSchedule: async (resourceId, marketplaceIds, body, options = {}) => {
|
|
674
|
+
// verify required parameter 'resourceId' is not null or undefined
|
|
675
|
+
assertParamExists('updateSchedule', 'resourceId', resourceId);
|
|
676
|
+
// verify required parameter 'marketplaceIds' is not null or undefined
|
|
677
|
+
assertParamExists('updateSchedule', 'marketplaceIds', marketplaceIds);
|
|
678
|
+
// verify required parameter 'body' is not null or undefined
|
|
679
|
+
assertParamExists('updateSchedule', 'body', body);
|
|
680
|
+
const localVarPath = `/service/v1/serviceResources/{resourceId}/schedules`
|
|
681
|
+
.replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId)));
|
|
682
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
683
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
684
|
+
let baseOptions;
|
|
685
|
+
if (configuration) {
|
|
686
|
+
baseOptions = configuration.baseOptions;
|
|
687
|
+
}
|
|
688
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
689
|
+
const localVarHeaderParameter = {};
|
|
690
|
+
const localVarQueryParameter = {};
|
|
691
|
+
if (marketplaceIds) {
|
|
692
|
+
localVarQueryParameter['marketplaceIds'] = marketplaceIds.join(COLLECTION_FORMATS.csv);
|
|
693
|
+
}
|
|
694
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
695
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
696
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
697
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
698
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
699
|
+
return {
|
|
700
|
+
url: toPathString(localVarUrlObj),
|
|
701
|
+
options: localVarRequestOptions,
|
|
702
|
+
};
|
|
703
|
+
},
|
|
264
704
|
};
|
|
265
705
|
};
|
|
266
706
|
/**
|
|
@@ -271,7 +711,7 @@ export const ServiceApiFp = function (configuration) {
|
|
|
271
711
|
const localVarAxiosParamCreator = ServiceApiAxiosParamCreator(configuration);
|
|
272
712
|
return {
|
|
273
713
|
/**
|
|
274
|
-
* Adds an appointment to the service job indicated by the service job identifier
|
|
714
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
275
715
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
276
716
|
* @param {AddAppointmentRequest} body Add appointment operation input details.
|
|
277
717
|
* @param {*} [options] Override http request option.
|
|
@@ -282,7 +722,30 @@ export const ServiceApiFp = function (configuration) {
|
|
|
282
722
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
283
723
|
},
|
|
284
724
|
/**
|
|
285
|
-
*
|
|
725
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
726
|
+
* @param {string} serviceJobId An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.
|
|
727
|
+
* @param {string} appointmentId An Amazon-defined identifier of active service job appointment.
|
|
728
|
+
* @param {AssignAppointmentResourcesRequest} body
|
|
729
|
+
* @param {*} [options] Override http request option.
|
|
730
|
+
* @throws {RequiredError}
|
|
731
|
+
*/
|
|
732
|
+
async assignAppointmentResources(serviceJobId, appointmentId, body, options) {
|
|
733
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.assignAppointmentResources(serviceJobId, appointmentId, body, options);
|
|
734
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
735
|
+
},
|
|
736
|
+
/**
|
|
737
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
738
|
+
* @param {string} reservationId Reservation Identifier
|
|
739
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
740
|
+
* @param {*} [options] Override http request option.
|
|
741
|
+
* @throws {RequiredError}
|
|
742
|
+
*/
|
|
743
|
+
async cancelReservation(reservationId, marketplaceIds, options) {
|
|
744
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.cancelReservation(reservationId, marketplaceIds, options);
|
|
745
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
746
|
+
},
|
|
747
|
+
/**
|
|
748
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
286
749
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
287
750
|
* @param {string} cancellationReasonCode A cancel reason code that specifies the reason for cancelling a service job.
|
|
288
751
|
* @param {*} [options] Override http request option.
|
|
@@ -293,7 +756,7 @@ export const ServiceApiFp = function (configuration) {
|
|
|
293
756
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
294
757
|
},
|
|
295
758
|
/**
|
|
296
|
-
* Completes the service job indicated by the service job identifier
|
|
759
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
297
760
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
298
761
|
* @param {*} [options] Override http request option.
|
|
299
762
|
* @throws {RequiredError}
|
|
@@ -303,7 +766,81 @@ export const ServiceApiFp = function (configuration) {
|
|
|
303
766
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
304
767
|
},
|
|
305
768
|
/**
|
|
306
|
-
*
|
|
769
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
770
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
771
|
+
* @param {CreateReservationRequest} body Reservation details
|
|
772
|
+
* @param {*} [options] Override http request option.
|
|
773
|
+
* @throws {RequiredError}
|
|
774
|
+
*/
|
|
775
|
+
async createReservation(marketplaceIds, body, options) {
|
|
776
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createReservation(marketplaceIds, body, options);
|
|
777
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
778
|
+
},
|
|
779
|
+
/**
|
|
780
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
781
|
+
* @param {ServiceUploadDocument} body Upload document operation input details.
|
|
782
|
+
* @param {*} [options] Override http request option.
|
|
783
|
+
* @throws {RequiredError}
|
|
784
|
+
*/
|
|
785
|
+
async createServiceDocumentUploadDestination(body, options) {
|
|
786
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createServiceDocumentUploadDestination(body, options);
|
|
787
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
788
|
+
},
|
|
789
|
+
/**
|
|
790
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
791
|
+
* @param {string} asin ASIN associated with the service.
|
|
792
|
+
* @param {string} storeId Store identifier defining the region scope to retrive appointment slots.
|
|
793
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace for which appointment slots are queried
|
|
794
|
+
* @param {string} [startTime] A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `startTime` is provided, `endTime` should also be provided. Default value is as per business configuration.
|
|
795
|
+
* @param {string} [endTime] A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `endTime` is provided, `startTime` should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.
|
|
796
|
+
* @param {*} [options] Override http request option.
|
|
797
|
+
* @throws {RequiredError}
|
|
798
|
+
*/
|
|
799
|
+
async getAppointmentSlots(asin, storeId, marketplaceIds, startTime, endTime, options) {
|
|
800
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAppointmentSlots(asin, storeId, marketplaceIds, startTime, endTime, options);
|
|
801
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
802
|
+
},
|
|
803
|
+
/**
|
|
804
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
805
|
+
* @param {string} serviceJobId A service job identifier to retrive appointment slots for associated service.
|
|
806
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
807
|
+
* @param {string} [startTime] A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `startTime` is provided, `endTime` should also be provided. Default value is as per business configuration.
|
|
808
|
+
* @param {string} [endTime] A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `endTime` is provided, `startTime` should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.
|
|
809
|
+
* @param {*} [options] Override http request option.
|
|
810
|
+
* @throws {RequiredError}
|
|
811
|
+
*/
|
|
812
|
+
async getAppointmmentSlotsByJobId(serviceJobId, marketplaceIds, startTime, endTime, options) {
|
|
813
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAppointmmentSlotsByJobId(serviceJobId, marketplaceIds, startTime, endTime, options);
|
|
814
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
815
|
+
},
|
|
816
|
+
/**
|
|
817
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
818
|
+
* @param {string} resourceId Resource Identifier.
|
|
819
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
820
|
+
* @param {FixedSlotCapacityQuery} body Request body.
|
|
821
|
+
* @param {string} [nextPageToken] Next page token returned in the response of your previous request.
|
|
822
|
+
* @param {*} [options] Override http request option.
|
|
823
|
+
* @throws {RequiredError}
|
|
824
|
+
*/
|
|
825
|
+
async getFixedSlotCapacity(resourceId, marketplaceIds, body, nextPageToken, options) {
|
|
826
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getFixedSlotCapacity(resourceId, marketplaceIds, body, nextPageToken, options);
|
|
827
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
828
|
+
},
|
|
829
|
+
/**
|
|
830
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
831
|
+
* @param {string} resourceId Resource Identifier.
|
|
832
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
833
|
+
* @param {RangeSlotCapacityQuery} body Request body.
|
|
834
|
+
* @param {string} [nextPageToken] Next page token returned in the response of your previous request.
|
|
835
|
+
* @param {*} [options] Override http request option.
|
|
836
|
+
* @throws {RequiredError}
|
|
837
|
+
*/
|
|
838
|
+
async getRangeSlotCapacity(resourceId, marketplaceIds, body, nextPageToken, options) {
|
|
839
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getRangeSlotCapacity(resourceId, marketplaceIds, body, nextPageToken, options);
|
|
840
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
841
|
+
},
|
|
842
|
+
/**
|
|
843
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
307
844
|
* @param {string} serviceJobId A service job identifier.
|
|
308
845
|
* @param {*} [options] Override http request option.
|
|
309
846
|
* @throws {RequiredError}
|
|
@@ -313,7 +850,7 @@ export const ServiceApiFp = function (configuration) {
|
|
|
313
850
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
314
851
|
},
|
|
315
852
|
/**
|
|
316
|
-
* Gets service job details for the specified filter query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 40 | For more information, see
|
|
853
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
317
854
|
* @param {Array<string>} marketplaceIds Used to select jobs that were placed in the specified marketplaces.
|
|
318
855
|
* @param {Array<string>} [serviceOrderIds] List of service order ids for the query you want to perform.Max values supported 20.
|
|
319
856
|
* @param {Array<'NOT_SERVICED' | 'CANCELLED' | 'COMPLETED' | 'PENDING_SCHEDULE' | 'NOT_FULFILLABLE' | 'HOLD' | 'PAYMENT_DECLINED'>} [serviceJobStatus] A list of one or more job status by which to filter the list of jobs.
|
|
@@ -321,21 +858,24 @@ export const ServiceApiFp = function (configuration) {
|
|
|
321
858
|
* @param {number} [pageSize] A non-negative integer that indicates the maximum number of jobs to return in the list, Value must be 1 - 20. Default 20.
|
|
322
859
|
* @param {'JOB_DATE' | 'JOB_STATUS'} [sortField] Sort fields on which you want to sort the output.
|
|
323
860
|
* @param {'ASC' | 'DESC'} [sortOrder] Sort order for the query you want to perform.
|
|
324
|
-
* @param {string} [createdAfter] A date used for selecting jobs created
|
|
325
|
-
* @param {string} [createdBefore] A date used for selecting jobs created
|
|
326
|
-
* @param {string} [lastUpdatedAfter] A date used for selecting jobs updated
|
|
327
|
-
* @param {string} [lastUpdatedBefore] A date used for selecting jobs updated
|
|
328
|
-
* @param {string} [scheduleStartDate] A date used for filtering jobs
|
|
329
|
-
* @param {string} [scheduleEndDate] A date used for filtering jobs
|
|
861
|
+
* @param {string} [createdAfter] A date used for selecting jobs created at or after a specified time. Must be in ISO 8601 format. Required if `LastUpdatedAfter` is not specified. Specifying both `CreatedAfter` and `LastUpdatedAfter` returns an error.
|
|
862
|
+
* @param {string} [createdBefore] A date used for selecting jobs created at or before a specified time. Must be in ISO 8601 format.
|
|
863
|
+
* @param {string} [lastUpdatedAfter] A date used for selecting jobs updated at or after a specified time. Must be in ISO 8601 format. Required if `createdAfter` is not specified. Specifying both `CreatedAfter` and `LastUpdatedAfter` returns an error.
|
|
864
|
+
* @param {string} [lastUpdatedBefore] A date used for selecting jobs updated at or before a specified time. Must be in ISO 8601 format.
|
|
865
|
+
* @param {string} [scheduleStartDate] 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.
|
|
866
|
+
* @param {string} [scheduleEndDate] 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.
|
|
867
|
+
* @param {Array<string>} [asins] List of Amazon Standard Identification Numbers (ASIN) of the items. Max values supported is 20.
|
|
868
|
+
* @param {Array<string>} [requiredSkills] 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.
|
|
869
|
+
* @param {Array<string>} [storeIds] List of Amazon-defined identifiers for the region scope. Max values supported is 50.
|
|
330
870
|
* @param {*} [options] Override http request option.
|
|
331
871
|
* @throws {RequiredError}
|
|
332
872
|
*/
|
|
333
|
-
async getServiceJobs(marketplaceIds, serviceOrderIds, serviceJobStatus, pageToken, pageSize, sortField, sortOrder, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, scheduleStartDate, scheduleEndDate, options) {
|
|
334
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceJobs(marketplaceIds, serviceOrderIds, serviceJobStatus, pageToken, pageSize, sortField, sortOrder, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, scheduleStartDate, scheduleEndDate, options);
|
|
873
|
+
async getServiceJobs(marketplaceIds, serviceOrderIds, serviceJobStatus, pageToken, pageSize, sortField, sortOrder, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, scheduleStartDate, scheduleEndDate, asins, requiredSkills, storeIds, options) {
|
|
874
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceJobs(marketplaceIds, serviceOrderIds, serviceJobStatus, pageToken, pageSize, sortField, sortOrder, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, scheduleStartDate, scheduleEndDate, asins, requiredSkills, storeIds, options);
|
|
335
875
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
336
876
|
},
|
|
337
877
|
/**
|
|
338
|
-
* Reschedules an appointment for the service job indicated by the service job identifier
|
|
878
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
339
879
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
340
880
|
* @param {string} appointmentId An existing appointment identifier for the Service Job.
|
|
341
881
|
* @param {RescheduleAppointmentRequest} body Reschedule appointment operation input details.
|
|
@@ -346,6 +886,42 @@ export const ServiceApiFp = function (configuration) {
|
|
|
346
886
|
const localVarAxiosArgs = await localVarAxiosParamCreator.rescheduleAppointmentForServiceJobByServiceJobId(serviceJobId, appointmentId, body, options);
|
|
347
887
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
348
888
|
},
|
|
889
|
+
/**
|
|
890
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
891
|
+
* @param {string} serviceJobId An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.
|
|
892
|
+
* @param {string} appointmentId An Amazon-defined identifier of active service job appointment.
|
|
893
|
+
* @param {SetAppointmentFulfillmentDataRequest} body Appointment fulfillment data collection details.
|
|
894
|
+
* @param {*} [options] Override http request option.
|
|
895
|
+
* @throws {RequiredError}
|
|
896
|
+
*/
|
|
897
|
+
async setAppointmentFulfillmentData(serviceJobId, appointmentId, body, options) {
|
|
898
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setAppointmentFulfillmentData(serviceJobId, appointmentId, body, options);
|
|
899
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
900
|
+
},
|
|
901
|
+
/**
|
|
902
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
903
|
+
* @param {string} reservationId Reservation Identifier
|
|
904
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
905
|
+
* @param {UpdateReservationRequest} body Reservation details
|
|
906
|
+
* @param {*} [options] Override http request option.
|
|
907
|
+
* @throws {RequiredError}
|
|
908
|
+
*/
|
|
909
|
+
async updateReservation(reservationId, marketplaceIds, body, options) {
|
|
910
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateReservation(reservationId, marketplaceIds, body, options);
|
|
911
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
912
|
+
},
|
|
913
|
+
/**
|
|
914
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
915
|
+
* @param {string} resourceId Resource (store) Identifier
|
|
916
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
917
|
+
* @param {UpdateScheduleRequest} body Schedule details
|
|
918
|
+
* @param {*} [options] Override http request option.
|
|
919
|
+
* @throws {RequiredError}
|
|
920
|
+
*/
|
|
921
|
+
async updateSchedule(resourceId, marketplaceIds, body, options) {
|
|
922
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateSchedule(resourceId, marketplaceIds, body, options);
|
|
923
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
924
|
+
},
|
|
349
925
|
};
|
|
350
926
|
};
|
|
351
927
|
/**
|
|
@@ -356,7 +932,7 @@ export const ServiceApiFactory = function (configuration, basePath, axios) {
|
|
|
356
932
|
const localVarFp = ServiceApiFp(configuration);
|
|
357
933
|
return {
|
|
358
934
|
/**
|
|
359
|
-
* Adds an appointment to the service job indicated by the service job identifier
|
|
935
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
360
936
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
361
937
|
* @param {AddAppointmentRequest} body Add appointment operation input details.
|
|
362
938
|
* @param {*} [options] Override http request option.
|
|
@@ -366,7 +942,28 @@ export const ServiceApiFactory = function (configuration, basePath, axios) {
|
|
|
366
942
|
return localVarFp.addAppointmentForServiceJobByServiceJobId(serviceJobId, body, options).then((request) => request(axios, basePath));
|
|
367
943
|
},
|
|
368
944
|
/**
|
|
369
|
-
*
|
|
945
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
946
|
+
* @param {string} serviceJobId An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.
|
|
947
|
+
* @param {string} appointmentId An Amazon-defined identifier of active service job appointment.
|
|
948
|
+
* @param {AssignAppointmentResourcesRequest} body
|
|
949
|
+
* @param {*} [options] Override http request option.
|
|
950
|
+
* @throws {RequiredError}
|
|
951
|
+
*/
|
|
952
|
+
assignAppointmentResources(serviceJobId, appointmentId, body, options) {
|
|
953
|
+
return localVarFp.assignAppointmentResources(serviceJobId, appointmentId, body, options).then((request) => request(axios, basePath));
|
|
954
|
+
},
|
|
955
|
+
/**
|
|
956
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
957
|
+
* @param {string} reservationId Reservation Identifier
|
|
958
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
959
|
+
* @param {*} [options] Override http request option.
|
|
960
|
+
* @throws {RequiredError}
|
|
961
|
+
*/
|
|
962
|
+
cancelReservation(reservationId, marketplaceIds, options) {
|
|
963
|
+
return localVarFp.cancelReservation(reservationId, marketplaceIds, options).then((request) => request(axios, basePath));
|
|
964
|
+
},
|
|
965
|
+
/**
|
|
966
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
370
967
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
371
968
|
* @param {string} cancellationReasonCode A cancel reason code that specifies the reason for cancelling a service job.
|
|
372
969
|
* @param {*} [options] Override http request option.
|
|
@@ -376,7 +973,7 @@ export const ServiceApiFactory = function (configuration, basePath, axios) {
|
|
|
376
973
|
return localVarFp.cancelServiceJobByServiceJobId(serviceJobId, cancellationReasonCode, options).then((request) => request(axios, basePath));
|
|
377
974
|
},
|
|
378
975
|
/**
|
|
379
|
-
* Completes the service job indicated by the service job identifier
|
|
976
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
380
977
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
381
978
|
* @param {*} [options] Override http request option.
|
|
382
979
|
* @throws {RequiredError}
|
|
@@ -385,7 +982,75 @@ export const ServiceApiFactory = function (configuration, basePath, axios) {
|
|
|
385
982
|
return localVarFp.completeServiceJobByServiceJobId(serviceJobId, options).then((request) => request(axios, basePath));
|
|
386
983
|
},
|
|
387
984
|
/**
|
|
388
|
-
*
|
|
985
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
986
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
987
|
+
* @param {CreateReservationRequest} body Reservation details
|
|
988
|
+
* @param {*} [options] Override http request option.
|
|
989
|
+
* @throws {RequiredError}
|
|
990
|
+
*/
|
|
991
|
+
createReservation(marketplaceIds, body, options) {
|
|
992
|
+
return localVarFp.createReservation(marketplaceIds, body, options).then((request) => request(axios, basePath));
|
|
993
|
+
},
|
|
994
|
+
/**
|
|
995
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
996
|
+
* @param {ServiceUploadDocument} body Upload document operation input details.
|
|
997
|
+
* @param {*} [options] Override http request option.
|
|
998
|
+
* @throws {RequiredError}
|
|
999
|
+
*/
|
|
1000
|
+
createServiceDocumentUploadDestination(body, options) {
|
|
1001
|
+
return localVarFp.createServiceDocumentUploadDestination(body, options).then((request) => request(axios, basePath));
|
|
1002
|
+
},
|
|
1003
|
+
/**
|
|
1004
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1005
|
+
* @param {string} asin ASIN associated with the service.
|
|
1006
|
+
* @param {string} storeId Store identifier defining the region scope to retrive appointment slots.
|
|
1007
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace for which appointment slots are queried
|
|
1008
|
+
* @param {string} [startTime] A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `startTime` is provided, `endTime` should also be provided. Default value is as per business configuration.
|
|
1009
|
+
* @param {string} [endTime] A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `endTime` is provided, `startTime` should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.
|
|
1010
|
+
* @param {*} [options] Override http request option.
|
|
1011
|
+
* @throws {RequiredError}
|
|
1012
|
+
*/
|
|
1013
|
+
getAppointmentSlots(asin, storeId, marketplaceIds, startTime, endTime, options) {
|
|
1014
|
+
return localVarFp.getAppointmentSlots(asin, storeId, marketplaceIds, startTime, endTime, options).then((request) => request(axios, basePath));
|
|
1015
|
+
},
|
|
1016
|
+
/**
|
|
1017
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1018
|
+
* @param {string} serviceJobId A service job identifier to retrive appointment slots for associated service.
|
|
1019
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
1020
|
+
* @param {string} [startTime] A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `startTime` is provided, `endTime` should also be provided. Default value is as per business configuration.
|
|
1021
|
+
* @param {string} [endTime] A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `endTime` is provided, `startTime` should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.
|
|
1022
|
+
* @param {*} [options] Override http request option.
|
|
1023
|
+
* @throws {RequiredError}
|
|
1024
|
+
*/
|
|
1025
|
+
getAppointmmentSlotsByJobId(serviceJobId, marketplaceIds, startTime, endTime, options) {
|
|
1026
|
+
return localVarFp.getAppointmmentSlotsByJobId(serviceJobId, marketplaceIds, startTime, endTime, options).then((request) => request(axios, basePath));
|
|
1027
|
+
},
|
|
1028
|
+
/**
|
|
1029
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1030
|
+
* @param {string} resourceId Resource Identifier.
|
|
1031
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
1032
|
+
* @param {FixedSlotCapacityQuery} body Request body.
|
|
1033
|
+
* @param {string} [nextPageToken] Next page token returned in the response of your previous request.
|
|
1034
|
+
* @param {*} [options] Override http request option.
|
|
1035
|
+
* @throws {RequiredError}
|
|
1036
|
+
*/
|
|
1037
|
+
getFixedSlotCapacity(resourceId, marketplaceIds, body, nextPageToken, options) {
|
|
1038
|
+
return localVarFp.getFixedSlotCapacity(resourceId, marketplaceIds, body, nextPageToken, options).then((request) => request(axios, basePath));
|
|
1039
|
+
},
|
|
1040
|
+
/**
|
|
1041
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1042
|
+
* @param {string} resourceId Resource Identifier.
|
|
1043
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
1044
|
+
* @param {RangeSlotCapacityQuery} body Request body.
|
|
1045
|
+
* @param {string} [nextPageToken] Next page token returned in the response of your previous request.
|
|
1046
|
+
* @param {*} [options] Override http request option.
|
|
1047
|
+
* @throws {RequiredError}
|
|
1048
|
+
*/
|
|
1049
|
+
getRangeSlotCapacity(resourceId, marketplaceIds, body, nextPageToken, options) {
|
|
1050
|
+
return localVarFp.getRangeSlotCapacity(resourceId, marketplaceIds, body, nextPageToken, options).then((request) => request(axios, basePath));
|
|
1051
|
+
},
|
|
1052
|
+
/**
|
|
1053
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
389
1054
|
* @param {string} serviceJobId A service job identifier.
|
|
390
1055
|
* @param {*} [options] Override http request option.
|
|
391
1056
|
* @throws {RequiredError}
|
|
@@ -394,7 +1059,7 @@ export const ServiceApiFactory = function (configuration, basePath, axios) {
|
|
|
394
1059
|
return localVarFp.getServiceJobByServiceJobId(serviceJobId, options).then((request) => request(axios, basePath));
|
|
395
1060
|
},
|
|
396
1061
|
/**
|
|
397
|
-
* Gets service job details for the specified filter query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 40 | For more information, see
|
|
1062
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
398
1063
|
* @param {Array<string>} marketplaceIds Used to select jobs that were placed in the specified marketplaces.
|
|
399
1064
|
* @param {Array<string>} [serviceOrderIds] List of service order ids for the query you want to perform.Max values supported 20.
|
|
400
1065
|
* @param {Array<'NOT_SERVICED' | 'CANCELLED' | 'COMPLETED' | 'PENDING_SCHEDULE' | 'NOT_FULFILLABLE' | 'HOLD' | 'PAYMENT_DECLINED'>} [serviceJobStatus] A list of one or more job status by which to filter the list of jobs.
|
|
@@ -402,20 +1067,23 @@ export const ServiceApiFactory = function (configuration, basePath, axios) {
|
|
|
402
1067
|
* @param {number} [pageSize] A non-negative integer that indicates the maximum number of jobs to return in the list, Value must be 1 - 20. Default 20.
|
|
403
1068
|
* @param {'JOB_DATE' | 'JOB_STATUS'} [sortField] Sort fields on which you want to sort the output.
|
|
404
1069
|
* @param {'ASC' | 'DESC'} [sortOrder] Sort order for the query you want to perform.
|
|
405
|
-
* @param {string} [createdAfter] A date used for selecting jobs created
|
|
406
|
-
* @param {string} [createdBefore] A date used for selecting jobs created
|
|
407
|
-
* @param {string} [lastUpdatedAfter] A date used for selecting jobs updated
|
|
408
|
-
* @param {string} [lastUpdatedBefore] A date used for selecting jobs updated
|
|
409
|
-
* @param {string} [scheduleStartDate] A date used for filtering jobs
|
|
410
|
-
* @param {string} [scheduleEndDate] A date used for filtering jobs
|
|
1070
|
+
* @param {string} [createdAfter] A date used for selecting jobs created at or after a specified time. Must be in ISO 8601 format. Required if `LastUpdatedAfter` is not specified. Specifying both `CreatedAfter` and `LastUpdatedAfter` returns an error.
|
|
1071
|
+
* @param {string} [createdBefore] A date used for selecting jobs created at or before a specified time. Must be in ISO 8601 format.
|
|
1072
|
+
* @param {string} [lastUpdatedAfter] A date used for selecting jobs updated at or after a specified time. Must be in ISO 8601 format. Required if `createdAfter` is not specified. Specifying both `CreatedAfter` and `LastUpdatedAfter` returns an error.
|
|
1073
|
+
* @param {string} [lastUpdatedBefore] A date used for selecting jobs updated at or before a specified time. Must be in ISO 8601 format.
|
|
1074
|
+
* @param {string} [scheduleStartDate] 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.
|
|
1075
|
+
* @param {string} [scheduleEndDate] 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.
|
|
1076
|
+
* @param {Array<string>} [asins] List of Amazon Standard Identification Numbers (ASIN) of the items. Max values supported is 20.
|
|
1077
|
+
* @param {Array<string>} [requiredSkills] 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.
|
|
1078
|
+
* @param {Array<string>} [storeIds] List of Amazon-defined identifiers for the region scope. Max values supported is 50.
|
|
411
1079
|
* @param {*} [options] Override http request option.
|
|
412
1080
|
* @throws {RequiredError}
|
|
413
1081
|
*/
|
|
414
|
-
getServiceJobs(marketplaceIds, serviceOrderIds, serviceJobStatus, pageToken, pageSize, sortField, sortOrder, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, scheduleStartDate, scheduleEndDate, options) {
|
|
415
|
-
return localVarFp.getServiceJobs(marketplaceIds, serviceOrderIds, serviceJobStatus, pageToken, pageSize, sortField, sortOrder, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, scheduleStartDate, scheduleEndDate, options).then((request) => request(axios, basePath));
|
|
1082
|
+
getServiceJobs(marketplaceIds, serviceOrderIds, serviceJobStatus, pageToken, pageSize, sortField, sortOrder, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, scheduleStartDate, scheduleEndDate, asins, requiredSkills, storeIds, options) {
|
|
1083
|
+
return localVarFp.getServiceJobs(marketplaceIds, serviceOrderIds, serviceJobStatus, pageToken, pageSize, sortField, sortOrder, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, scheduleStartDate, scheduleEndDate, asins, requiredSkills, storeIds, options).then((request) => request(axios, basePath));
|
|
416
1084
|
},
|
|
417
1085
|
/**
|
|
418
|
-
* Reschedules an appointment for the service job indicated by the service job identifier
|
|
1086
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
419
1087
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
420
1088
|
* @param {string} appointmentId An existing appointment identifier for the Service Job.
|
|
421
1089
|
* @param {RescheduleAppointmentRequest} body Reschedule appointment operation input details.
|
|
@@ -425,6 +1093,39 @@ export const ServiceApiFactory = function (configuration, basePath, axios) {
|
|
|
425
1093
|
rescheduleAppointmentForServiceJobByServiceJobId(serviceJobId, appointmentId, body, options) {
|
|
426
1094
|
return localVarFp.rescheduleAppointmentForServiceJobByServiceJobId(serviceJobId, appointmentId, body, options).then((request) => request(axios, basePath));
|
|
427
1095
|
},
|
|
1096
|
+
/**
|
|
1097
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1098
|
+
* @param {string} serviceJobId An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.
|
|
1099
|
+
* @param {string} appointmentId An Amazon-defined identifier of active service job appointment.
|
|
1100
|
+
* @param {SetAppointmentFulfillmentDataRequest} body Appointment fulfillment data collection details.
|
|
1101
|
+
* @param {*} [options] Override http request option.
|
|
1102
|
+
* @throws {RequiredError}
|
|
1103
|
+
*/
|
|
1104
|
+
setAppointmentFulfillmentData(serviceJobId, appointmentId, body, options) {
|
|
1105
|
+
return localVarFp.setAppointmentFulfillmentData(serviceJobId, appointmentId, body, options).then((request) => request(axios, basePath));
|
|
1106
|
+
},
|
|
1107
|
+
/**
|
|
1108
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1109
|
+
* @param {string} reservationId Reservation Identifier
|
|
1110
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
1111
|
+
* @param {UpdateReservationRequest} body Reservation details
|
|
1112
|
+
* @param {*} [options] Override http request option.
|
|
1113
|
+
* @throws {RequiredError}
|
|
1114
|
+
*/
|
|
1115
|
+
updateReservation(reservationId, marketplaceIds, body, options) {
|
|
1116
|
+
return localVarFp.updateReservation(reservationId, marketplaceIds, body, options).then((request) => request(axios, basePath));
|
|
1117
|
+
},
|
|
1118
|
+
/**
|
|
1119
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1120
|
+
* @param {string} resourceId Resource (store) Identifier
|
|
1121
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
1122
|
+
* @param {UpdateScheduleRequest} body Schedule details
|
|
1123
|
+
* @param {*} [options] Override http request option.
|
|
1124
|
+
* @throws {RequiredError}
|
|
1125
|
+
*/
|
|
1126
|
+
updateSchedule(resourceId, marketplaceIds, body, options) {
|
|
1127
|
+
return localVarFp.updateSchedule(resourceId, marketplaceIds, body, options).then((request) => request(axios, basePath));
|
|
1128
|
+
},
|
|
428
1129
|
};
|
|
429
1130
|
};
|
|
430
1131
|
/**
|
|
@@ -435,7 +1136,7 @@ export const ServiceApiFactory = function (configuration, basePath, axios) {
|
|
|
435
1136
|
*/
|
|
436
1137
|
export class ServiceApi extends BaseAPI {
|
|
437
1138
|
/**
|
|
438
|
-
* Adds an appointment to the service job indicated by the service job identifier
|
|
1139
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
439
1140
|
* @param {ServiceApiAddAppointmentForServiceJobByServiceJobIdRequest} requestParameters Request parameters.
|
|
440
1141
|
* @param {*} [options] Override http request option.
|
|
441
1142
|
* @throws {RequiredError}
|
|
@@ -445,7 +1146,27 @@ export class ServiceApi extends BaseAPI {
|
|
|
445
1146
|
return ServiceApiFp(this.configuration).addAppointmentForServiceJobByServiceJobId(requestParameters.serviceJobId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
446
1147
|
}
|
|
447
1148
|
/**
|
|
448
|
-
*
|
|
1149
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1150
|
+
* @param {ServiceApiAssignAppointmentResourcesRequest} requestParameters Request parameters.
|
|
1151
|
+
* @param {*} [options] Override http request option.
|
|
1152
|
+
* @throws {RequiredError}
|
|
1153
|
+
* @memberof ServiceApi
|
|
1154
|
+
*/
|
|
1155
|
+
assignAppointmentResources(requestParameters, options) {
|
|
1156
|
+
return ServiceApiFp(this.configuration).assignAppointmentResources(requestParameters.serviceJobId, requestParameters.appointmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
1157
|
+
}
|
|
1158
|
+
/**
|
|
1159
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1160
|
+
* @param {ServiceApiCancelReservationRequest} requestParameters Request parameters.
|
|
1161
|
+
* @param {*} [options] Override http request option.
|
|
1162
|
+
* @throws {RequiredError}
|
|
1163
|
+
* @memberof ServiceApi
|
|
1164
|
+
*/
|
|
1165
|
+
cancelReservation(requestParameters, options) {
|
|
1166
|
+
return ServiceApiFp(this.configuration).cancelReservation(requestParameters.reservationId, requestParameters.marketplaceIds, options).then((request) => request(this.axios, this.basePath));
|
|
1167
|
+
}
|
|
1168
|
+
/**
|
|
1169
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
449
1170
|
* @param {ServiceApiCancelServiceJobByServiceJobIdRequest} requestParameters Request parameters.
|
|
450
1171
|
* @param {*} [options] Override http request option.
|
|
451
1172
|
* @throws {RequiredError}
|
|
@@ -455,7 +1176,7 @@ export class ServiceApi extends BaseAPI {
|
|
|
455
1176
|
return ServiceApiFp(this.configuration).cancelServiceJobByServiceJobId(requestParameters.serviceJobId, requestParameters.cancellationReasonCode, options).then((request) => request(this.axios, this.basePath));
|
|
456
1177
|
}
|
|
457
1178
|
/**
|
|
458
|
-
* Completes the service job indicated by the service job identifier
|
|
1179
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
459
1180
|
* @param {ServiceApiCompleteServiceJobByServiceJobIdRequest} requestParameters Request parameters.
|
|
460
1181
|
* @param {*} [options] Override http request option.
|
|
461
1182
|
* @throws {RequiredError}
|
|
@@ -465,7 +1186,67 @@ export class ServiceApi extends BaseAPI {
|
|
|
465
1186
|
return ServiceApiFp(this.configuration).completeServiceJobByServiceJobId(requestParameters.serviceJobId, options).then((request) => request(this.axios, this.basePath));
|
|
466
1187
|
}
|
|
467
1188
|
/**
|
|
468
|
-
*
|
|
1189
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1190
|
+
* @param {ServiceApiCreateReservationRequest} requestParameters Request parameters.
|
|
1191
|
+
* @param {*} [options] Override http request option.
|
|
1192
|
+
* @throws {RequiredError}
|
|
1193
|
+
* @memberof ServiceApi
|
|
1194
|
+
*/
|
|
1195
|
+
createReservation(requestParameters, options) {
|
|
1196
|
+
return ServiceApiFp(this.configuration).createReservation(requestParameters.marketplaceIds, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
1197
|
+
}
|
|
1198
|
+
/**
|
|
1199
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1200
|
+
* @param {ServiceApiCreateServiceDocumentUploadDestinationRequest} requestParameters Request parameters.
|
|
1201
|
+
* @param {*} [options] Override http request option.
|
|
1202
|
+
* @throws {RequiredError}
|
|
1203
|
+
* @memberof ServiceApi
|
|
1204
|
+
*/
|
|
1205
|
+
createServiceDocumentUploadDestination(requestParameters, options) {
|
|
1206
|
+
return ServiceApiFp(this.configuration).createServiceDocumentUploadDestination(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
1207
|
+
}
|
|
1208
|
+
/**
|
|
1209
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1210
|
+
* @param {ServiceApiGetAppointmentSlotsRequest} requestParameters Request parameters.
|
|
1211
|
+
* @param {*} [options] Override http request option.
|
|
1212
|
+
* @throws {RequiredError}
|
|
1213
|
+
* @memberof ServiceApi
|
|
1214
|
+
*/
|
|
1215
|
+
getAppointmentSlots(requestParameters, options) {
|
|
1216
|
+
return ServiceApiFp(this.configuration).getAppointmentSlots(requestParameters.asin, requestParameters.storeId, requestParameters.marketplaceIds, requestParameters.startTime, requestParameters.endTime, options).then((request) => request(this.axios, this.basePath));
|
|
1217
|
+
}
|
|
1218
|
+
/**
|
|
1219
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1220
|
+
* @param {ServiceApiGetAppointmmentSlotsByJobIdRequest} requestParameters Request parameters.
|
|
1221
|
+
* @param {*} [options] Override http request option.
|
|
1222
|
+
* @throws {RequiredError}
|
|
1223
|
+
* @memberof ServiceApi
|
|
1224
|
+
*/
|
|
1225
|
+
getAppointmmentSlotsByJobId(requestParameters, options) {
|
|
1226
|
+
return ServiceApiFp(this.configuration).getAppointmmentSlotsByJobId(requestParameters.serviceJobId, requestParameters.marketplaceIds, requestParameters.startTime, requestParameters.endTime, options).then((request) => request(this.axios, this.basePath));
|
|
1227
|
+
}
|
|
1228
|
+
/**
|
|
1229
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1230
|
+
* @param {ServiceApiGetFixedSlotCapacityRequest} requestParameters Request parameters.
|
|
1231
|
+
* @param {*} [options] Override http request option.
|
|
1232
|
+
* @throws {RequiredError}
|
|
1233
|
+
* @memberof ServiceApi
|
|
1234
|
+
*/
|
|
1235
|
+
getFixedSlotCapacity(requestParameters, options) {
|
|
1236
|
+
return ServiceApiFp(this.configuration).getFixedSlotCapacity(requestParameters.resourceId, requestParameters.marketplaceIds, requestParameters.body, requestParameters.nextPageToken, options).then((request) => request(this.axios, this.basePath));
|
|
1237
|
+
}
|
|
1238
|
+
/**
|
|
1239
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1240
|
+
* @param {ServiceApiGetRangeSlotCapacityRequest} requestParameters Request parameters.
|
|
1241
|
+
* @param {*} [options] Override http request option.
|
|
1242
|
+
* @throws {RequiredError}
|
|
1243
|
+
* @memberof ServiceApi
|
|
1244
|
+
*/
|
|
1245
|
+
getRangeSlotCapacity(requestParameters, options) {
|
|
1246
|
+
return ServiceApiFp(this.configuration).getRangeSlotCapacity(requestParameters.resourceId, requestParameters.marketplaceIds, requestParameters.body, requestParameters.nextPageToken, options).then((request) => request(this.axios, this.basePath));
|
|
1247
|
+
}
|
|
1248
|
+
/**
|
|
1249
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
469
1250
|
* @param {ServiceApiGetServiceJobByServiceJobIdRequest} requestParameters Request parameters.
|
|
470
1251
|
* @param {*} [options] Override http request option.
|
|
471
1252
|
* @throws {RequiredError}
|
|
@@ -475,17 +1256,17 @@ export class ServiceApi extends BaseAPI {
|
|
|
475
1256
|
return ServiceApiFp(this.configuration).getServiceJobByServiceJobId(requestParameters.serviceJobId, options).then((request) => request(this.axios, this.basePath));
|
|
476
1257
|
}
|
|
477
1258
|
/**
|
|
478
|
-
* Gets service job details for the specified filter query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 40 | For more information, see
|
|
1259
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
479
1260
|
* @param {ServiceApiGetServiceJobsRequest} requestParameters Request parameters.
|
|
480
1261
|
* @param {*} [options] Override http request option.
|
|
481
1262
|
* @throws {RequiredError}
|
|
482
1263
|
* @memberof ServiceApi
|
|
483
1264
|
*/
|
|
484
1265
|
getServiceJobs(requestParameters, options) {
|
|
485
|
-
return ServiceApiFp(this.configuration).getServiceJobs(requestParameters.marketplaceIds, requestParameters.serviceOrderIds, requestParameters.serviceJobStatus, requestParameters.pageToken, requestParameters.pageSize, requestParameters.sortField, requestParameters.sortOrder, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.scheduleStartDate, requestParameters.scheduleEndDate, options).then((request) => request(this.axios, this.basePath));
|
|
1266
|
+
return ServiceApiFp(this.configuration).getServiceJobs(requestParameters.marketplaceIds, requestParameters.serviceOrderIds, requestParameters.serviceJobStatus, requestParameters.pageToken, requestParameters.pageSize, requestParameters.sortField, requestParameters.sortOrder, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.scheduleStartDate, requestParameters.scheduleEndDate, requestParameters.asins, requestParameters.requiredSkills, requestParameters.storeIds, options).then((request) => request(this.axios, this.basePath));
|
|
486
1267
|
}
|
|
487
1268
|
/**
|
|
488
|
-
* Reschedules an appointment for the service job indicated by the service job identifier
|
|
1269
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
489
1270
|
* @param {ServiceApiRescheduleAppointmentForServiceJobByServiceJobIdRequest} requestParameters Request parameters.
|
|
490
1271
|
* @param {*} [options] Override http request option.
|
|
491
1272
|
* @throws {RequiredError}
|
|
@@ -494,4 +1275,34 @@ export class ServiceApi extends BaseAPI {
|
|
|
494
1275
|
rescheduleAppointmentForServiceJobByServiceJobId(requestParameters, options) {
|
|
495
1276
|
return ServiceApiFp(this.configuration).rescheduleAppointmentForServiceJobByServiceJobId(requestParameters.serviceJobId, requestParameters.appointmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
496
1277
|
}
|
|
1278
|
+
/**
|
|
1279
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1280
|
+
* @param {ServiceApiSetAppointmentFulfillmentDataRequest} requestParameters Request parameters.
|
|
1281
|
+
* @param {*} [options] Override http request option.
|
|
1282
|
+
* @throws {RequiredError}
|
|
1283
|
+
* @memberof ServiceApi
|
|
1284
|
+
*/
|
|
1285
|
+
setAppointmentFulfillmentData(requestParameters, options) {
|
|
1286
|
+
return ServiceApiFp(this.configuration).setAppointmentFulfillmentData(requestParameters.serviceJobId, requestParameters.appointmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
1287
|
+
}
|
|
1288
|
+
/**
|
|
1289
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1290
|
+
* @param {ServiceApiUpdateReservationRequest} requestParameters Request parameters.
|
|
1291
|
+
* @param {*} [options] Override http request option.
|
|
1292
|
+
* @throws {RequiredError}
|
|
1293
|
+
* @memberof ServiceApi
|
|
1294
|
+
*/
|
|
1295
|
+
updateReservation(requestParameters, options) {
|
|
1296
|
+
return ServiceApiFp(this.configuration).updateReservation(requestParameters.reservationId, requestParameters.marketplaceIds, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
1297
|
+
}
|
|
1298
|
+
/**
|
|
1299
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1300
|
+
* @param {ServiceApiUpdateScheduleRequest} requestParameters Request parameters.
|
|
1301
|
+
* @param {*} [options] Override http request option.
|
|
1302
|
+
* @throws {RequiredError}
|
|
1303
|
+
* @memberof ServiceApi
|
|
1304
|
+
*/
|
|
1305
|
+
updateSchedule(requestParameters, options) {
|
|
1306
|
+
return ServiceApiFp(this.configuration).updateSchedule(requestParameters.resourceId, requestParameters.marketplaceIds, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
1307
|
+
}
|
|
497
1308
|
}
|