@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
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Services
|
|
3
|
-
* With the Services API, you can build applications that help service providers get and modify their service orders.
|
|
3
|
+
* With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v1
|
|
6
6
|
*
|
|
@@ -13,19 +13,36 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { AddAppointmentRequest } from '../models';
|
|
16
|
+
import { AssignAppointmentResourcesRequest } from '../models';
|
|
17
|
+
import { AssignAppointmentResourcesResponse } from '../models';
|
|
18
|
+
import { CancelReservationResponse } from '../models';
|
|
16
19
|
import { CancelServiceJobByServiceJobIdResponse } from '../models';
|
|
17
20
|
import { CompleteServiceJobByServiceJobIdResponse } from '../models';
|
|
21
|
+
import { CreateReservationRequest } from '../models';
|
|
22
|
+
import { CreateReservationResponse } from '../models';
|
|
23
|
+
import { CreateServiceDocumentUploadDestination } from '../models';
|
|
24
|
+
import { FixedSlotCapacity } from '../models';
|
|
25
|
+
import { FixedSlotCapacityQuery } from '../models';
|
|
26
|
+
import { GetAppointmentSlotsResponse } from '../models';
|
|
18
27
|
import { GetServiceJobByServiceJobIdResponse } from '../models';
|
|
19
28
|
import { GetServiceJobsResponse } from '../models';
|
|
29
|
+
import { RangeSlotCapacity } from '../models';
|
|
30
|
+
import { RangeSlotCapacityQuery } from '../models';
|
|
20
31
|
import { RescheduleAppointmentRequest } from '../models';
|
|
32
|
+
import { ServiceUploadDocument } from '../models';
|
|
33
|
+
import { SetAppointmentFulfillmentDataRequest } from '../models';
|
|
21
34
|
import { SetAppointmentResponse } from '../models';
|
|
35
|
+
import { UpdateReservationRequest } from '../models';
|
|
36
|
+
import { UpdateReservationResponse } from '../models';
|
|
37
|
+
import { UpdateScheduleRequest } from '../models';
|
|
38
|
+
import { UpdateScheduleResponse } from '../models';
|
|
22
39
|
/**
|
|
23
40
|
* ServiceApi - axios parameter creator
|
|
24
41
|
* @export
|
|
25
42
|
*/
|
|
26
43
|
export declare const ServiceApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
27
44
|
/**
|
|
28
|
-
* Adds an appointment to the service job indicated by the service job identifier
|
|
45
|
+
* 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).
|
|
29
46
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
30
47
|
* @param {AddAppointmentRequest} body Add appointment operation input details.
|
|
31
48
|
* @param {*} [options] Override http request option.
|
|
@@ -33,7 +50,24 @@ export declare const ServiceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
33
50
|
*/
|
|
34
51
|
addAppointmentForServiceJobByServiceJobId: (serviceJobId: string, body: AddAppointmentRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
52
|
/**
|
|
36
|
-
*
|
|
53
|
+
* 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).
|
|
54
|
+
* @param {string} serviceJobId An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.
|
|
55
|
+
* @param {string} appointmentId An Amazon-defined identifier of active service job appointment.
|
|
56
|
+
* @param {AssignAppointmentResourcesRequest} body
|
|
57
|
+
* @param {*} [options] Override http request option.
|
|
58
|
+
* @throws {RequiredError}
|
|
59
|
+
*/
|
|
60
|
+
assignAppointmentResources: (serviceJobId: string, appointmentId: string, body: AssignAppointmentResourcesRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
61
|
+
/**
|
|
62
|
+
* 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).
|
|
63
|
+
* @param {string} reservationId Reservation Identifier
|
|
64
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
65
|
+
* @param {*} [options] Override http request option.
|
|
66
|
+
* @throws {RequiredError}
|
|
67
|
+
*/
|
|
68
|
+
cancelReservation: (reservationId: string, marketplaceIds: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
|
+
/**
|
|
70
|
+
* 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).
|
|
37
71
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
38
72
|
* @param {string} cancellationReasonCode A cancel reason code that specifies the reason for cancelling a service job.
|
|
39
73
|
* @param {*} [options] Override http request option.
|
|
@@ -41,21 +75,77 @@ export declare const ServiceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
41
75
|
*/
|
|
42
76
|
cancelServiceJobByServiceJobId: (serviceJobId: string, cancellationReasonCode: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43
77
|
/**
|
|
44
|
-
* Completes the service job indicated by the service job identifier
|
|
78
|
+
* 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).
|
|
45
79
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
46
80
|
* @param {*} [options] Override http request option.
|
|
47
81
|
* @throws {RequiredError}
|
|
48
82
|
*/
|
|
49
83
|
completeServiceJobByServiceJobId: (serviceJobId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
50
84
|
/**
|
|
51
|
-
*
|
|
85
|
+
* 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).
|
|
86
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
87
|
+
* @param {CreateReservationRequest} body Reservation details
|
|
88
|
+
* @param {*} [options] Override http request option.
|
|
89
|
+
* @throws {RequiredError}
|
|
90
|
+
*/
|
|
91
|
+
createReservation: (marketplaceIds: Array<string>, body: CreateReservationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
92
|
+
/**
|
|
93
|
+
* 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).
|
|
94
|
+
* @param {ServiceUploadDocument} body Upload document operation input details.
|
|
95
|
+
* @param {*} [options] Override http request option.
|
|
96
|
+
* @throws {RequiredError}
|
|
97
|
+
*/
|
|
98
|
+
createServiceDocumentUploadDestination: (body: ServiceUploadDocument, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
99
|
+
/**
|
|
100
|
+
* 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).
|
|
101
|
+
* @param {string} asin ASIN associated with the service.
|
|
102
|
+
* @param {string} storeId Store identifier defining the region scope to retrive appointment slots.
|
|
103
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace for which appointment slots are queried
|
|
104
|
+
* @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.
|
|
105
|
+
* @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.
|
|
106
|
+
* @param {*} [options] Override http request option.
|
|
107
|
+
* @throws {RequiredError}
|
|
108
|
+
*/
|
|
109
|
+
getAppointmentSlots: (asin: string, storeId: string, marketplaceIds: Array<string>, startTime?: string, endTime?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
110
|
+
/**
|
|
111
|
+
* 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).
|
|
112
|
+
* @param {string} serviceJobId A service job identifier to retrive appointment slots for associated service.
|
|
113
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
114
|
+
* @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.
|
|
115
|
+
* @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.
|
|
116
|
+
* @param {*} [options] Override http request option.
|
|
117
|
+
* @throws {RequiredError}
|
|
118
|
+
*/
|
|
119
|
+
getAppointmmentSlotsByJobId: (serviceJobId: string, marketplaceIds: Array<string>, startTime?: string, endTime?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
120
|
+
/**
|
|
121
|
+
* 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).
|
|
122
|
+
* @param {string} resourceId Resource Identifier.
|
|
123
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
124
|
+
* @param {FixedSlotCapacityQuery} body Request body.
|
|
125
|
+
* @param {string} [nextPageToken] Next page token returned in the response of your previous request.
|
|
126
|
+
* @param {*} [options] Override http request option.
|
|
127
|
+
* @throws {RequiredError}
|
|
128
|
+
*/
|
|
129
|
+
getFixedSlotCapacity: (resourceId: string, marketplaceIds: Array<string>, body: FixedSlotCapacityQuery, nextPageToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
130
|
+
/**
|
|
131
|
+
* 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).
|
|
132
|
+
* @param {string} resourceId Resource Identifier.
|
|
133
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
134
|
+
* @param {RangeSlotCapacityQuery} body Request body.
|
|
135
|
+
* @param {string} [nextPageToken] Next page token returned in the response of your previous request.
|
|
136
|
+
* @param {*} [options] Override http request option.
|
|
137
|
+
* @throws {RequiredError}
|
|
138
|
+
*/
|
|
139
|
+
getRangeSlotCapacity: (resourceId: string, marketplaceIds: Array<string>, body: RangeSlotCapacityQuery, nextPageToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
140
|
+
/**
|
|
141
|
+
* 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).
|
|
52
142
|
* @param {string} serviceJobId A service job identifier.
|
|
53
143
|
* @param {*} [options] Override http request option.
|
|
54
144
|
* @throws {RequiredError}
|
|
55
145
|
*/
|
|
56
146
|
getServiceJobByServiceJobId: (serviceJobId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
57
147
|
/**
|
|
58
|
-
* Gets service job details for the specified filter query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 40 | For more information, see
|
|
148
|
+
* 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).
|
|
59
149
|
* @param {Array<string>} marketplaceIds Used to select jobs that were placed in the specified marketplaces.
|
|
60
150
|
* @param {Array<string>} [serviceOrderIds] List of service order ids for the query you want to perform.Max values supported 20.
|
|
61
151
|
* @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.
|
|
@@ -63,18 +153,21 @@ export declare const ServiceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
63
153
|
* @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.
|
|
64
154
|
* @param {'JOB_DATE' | 'JOB_STATUS'} [sortField] Sort fields on which you want to sort the output.
|
|
65
155
|
* @param {'ASC' | 'DESC'} [sortOrder] Sort order for the query you want to perform.
|
|
66
|
-
* @param {string} [createdAfter] A date used for selecting jobs created
|
|
67
|
-
* @param {string} [createdBefore] A date used for selecting jobs created
|
|
68
|
-
* @param {string} [lastUpdatedAfter] A date used for selecting jobs updated
|
|
69
|
-
* @param {string} [lastUpdatedBefore] A date used for selecting jobs updated
|
|
70
|
-
* @param {string} [scheduleStartDate] A date used for filtering jobs
|
|
71
|
-
* @param {string} [scheduleEndDate] A date used for filtering jobs
|
|
156
|
+
* @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.
|
|
157
|
+
* @param {string} [createdBefore] A date used for selecting jobs created at or before a specified time. Must be in ISO 8601 format.
|
|
158
|
+
* @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.
|
|
159
|
+
* @param {string} [lastUpdatedBefore] A date used for selecting jobs updated at or before a specified time. Must be in ISO 8601 format.
|
|
160
|
+
* @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.
|
|
161
|
+
* @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.
|
|
162
|
+
* @param {Array<string>} [asins] List of Amazon Standard Identification Numbers (ASIN) of the items. Max values supported is 20.
|
|
163
|
+
* @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.
|
|
164
|
+
* @param {Array<string>} [storeIds] List of Amazon-defined identifiers for the region scope. Max values supported is 50.
|
|
72
165
|
* @param {*} [options] Override http request option.
|
|
73
166
|
* @throws {RequiredError}
|
|
74
167
|
*/
|
|
75
|
-
getServiceJobs: (marketplaceIds: Array<string>, serviceOrderIds?: Array<string>, serviceJobStatus?: Array<'NOT_SERVICED' | 'CANCELLED' | 'COMPLETED' | 'PENDING_SCHEDULE' | 'NOT_FULFILLABLE' | 'HOLD' | 'PAYMENT_DECLINED'>, pageToken?: string, pageSize?: number, sortField?: 'JOB_DATE' | 'JOB_STATUS', sortOrder?: 'ASC' | 'DESC', createdAfter?: string, createdBefore?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, scheduleStartDate?: string, scheduleEndDate?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
168
|
+
getServiceJobs: (marketplaceIds: Array<string>, serviceOrderIds?: Array<string>, serviceJobStatus?: Array<'NOT_SERVICED' | 'CANCELLED' | 'COMPLETED' | 'PENDING_SCHEDULE' | 'NOT_FULFILLABLE' | 'HOLD' | 'PAYMENT_DECLINED'>, pageToken?: string, pageSize?: number, sortField?: 'JOB_DATE' | 'JOB_STATUS', sortOrder?: 'ASC' | 'DESC', createdAfter?: string, createdBefore?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, scheduleStartDate?: string, scheduleEndDate?: string, asins?: Array<string>, requiredSkills?: Array<string>, storeIds?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
76
169
|
/**
|
|
77
|
-
* Reschedules an appointment for the service job indicated by the service job identifier
|
|
170
|
+
* 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).
|
|
78
171
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
79
172
|
* @param {string} appointmentId An existing appointment identifier for the Service Job.
|
|
80
173
|
* @param {RescheduleAppointmentRequest} body Reschedule appointment operation input details.
|
|
@@ -82,6 +175,33 @@ export declare const ServiceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
82
175
|
* @throws {RequiredError}
|
|
83
176
|
*/
|
|
84
177
|
rescheduleAppointmentForServiceJobByServiceJobId: (serviceJobId: string, appointmentId: string, body: RescheduleAppointmentRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
178
|
+
/**
|
|
179
|
+
* 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).
|
|
180
|
+
* @param {string} serviceJobId An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.
|
|
181
|
+
* @param {string} appointmentId An Amazon-defined identifier of active service job appointment.
|
|
182
|
+
* @param {SetAppointmentFulfillmentDataRequest} body Appointment fulfillment data collection details.
|
|
183
|
+
* @param {*} [options] Override http request option.
|
|
184
|
+
* @throws {RequiredError}
|
|
185
|
+
*/
|
|
186
|
+
setAppointmentFulfillmentData: (serviceJobId: string, appointmentId: string, body: SetAppointmentFulfillmentDataRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
187
|
+
/**
|
|
188
|
+
* 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).
|
|
189
|
+
* @param {string} reservationId Reservation Identifier
|
|
190
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
191
|
+
* @param {UpdateReservationRequest} body Reservation details
|
|
192
|
+
* @param {*} [options] Override http request option.
|
|
193
|
+
* @throws {RequiredError}
|
|
194
|
+
*/
|
|
195
|
+
updateReservation: (reservationId: string, marketplaceIds: Array<string>, body: UpdateReservationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
196
|
+
/**
|
|
197
|
+
* 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).
|
|
198
|
+
* @param {string} resourceId Resource (store) Identifier
|
|
199
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
200
|
+
* @param {UpdateScheduleRequest} body Schedule details
|
|
201
|
+
* @param {*} [options] Override http request option.
|
|
202
|
+
* @throws {RequiredError}
|
|
203
|
+
*/
|
|
204
|
+
updateSchedule: (resourceId: string, marketplaceIds: Array<string>, body: UpdateScheduleRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
85
205
|
};
|
|
86
206
|
/**
|
|
87
207
|
* ServiceApi - functional programming interface
|
|
@@ -89,7 +209,7 @@ export declare const ServiceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
89
209
|
*/
|
|
90
210
|
export declare const ServiceApiFp: (configuration?: Configuration) => {
|
|
91
211
|
/**
|
|
92
|
-
* Adds an appointment to the service job indicated by the service job identifier
|
|
212
|
+
* 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).
|
|
93
213
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
94
214
|
* @param {AddAppointmentRequest} body Add appointment operation input details.
|
|
95
215
|
* @param {*} [options] Override http request option.
|
|
@@ -97,7 +217,24 @@ export declare const ServiceApiFp: (configuration?: Configuration) => {
|
|
|
97
217
|
*/
|
|
98
218
|
addAppointmentForServiceJobByServiceJobId(serviceJobId: string, body: AddAppointmentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetAppointmentResponse>>;
|
|
99
219
|
/**
|
|
100
|
-
*
|
|
220
|
+
* 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).
|
|
221
|
+
* @param {string} serviceJobId An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.
|
|
222
|
+
* @param {string} appointmentId An Amazon-defined identifier of active service job appointment.
|
|
223
|
+
* @param {AssignAppointmentResourcesRequest} body
|
|
224
|
+
* @param {*} [options] Override http request option.
|
|
225
|
+
* @throws {RequiredError}
|
|
226
|
+
*/
|
|
227
|
+
assignAppointmentResources(serviceJobId: string, appointmentId: string, body: AssignAppointmentResourcesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AssignAppointmentResourcesResponse>>;
|
|
228
|
+
/**
|
|
229
|
+
* 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).
|
|
230
|
+
* @param {string} reservationId Reservation Identifier
|
|
231
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
232
|
+
* @param {*} [options] Override http request option.
|
|
233
|
+
* @throws {RequiredError}
|
|
234
|
+
*/
|
|
235
|
+
cancelReservation(reservationId: string, marketplaceIds: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelReservationResponse>>;
|
|
236
|
+
/**
|
|
237
|
+
* 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).
|
|
101
238
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
102
239
|
* @param {string} cancellationReasonCode A cancel reason code that specifies the reason for cancelling a service job.
|
|
103
240
|
* @param {*} [options] Override http request option.
|
|
@@ -105,21 +242,77 @@ export declare const ServiceApiFp: (configuration?: Configuration) => {
|
|
|
105
242
|
*/
|
|
106
243
|
cancelServiceJobByServiceJobId(serviceJobId: string, cancellationReasonCode: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelServiceJobByServiceJobIdResponse>>;
|
|
107
244
|
/**
|
|
108
|
-
* Completes the service job indicated by the service job identifier
|
|
245
|
+
* 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).
|
|
109
246
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
110
247
|
* @param {*} [options] Override http request option.
|
|
111
248
|
* @throws {RequiredError}
|
|
112
249
|
*/
|
|
113
250
|
completeServiceJobByServiceJobId(serviceJobId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompleteServiceJobByServiceJobIdResponse>>;
|
|
114
251
|
/**
|
|
115
|
-
*
|
|
252
|
+
* 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).
|
|
253
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
254
|
+
* @param {CreateReservationRequest} body Reservation details
|
|
255
|
+
* @param {*} [options] Override http request option.
|
|
256
|
+
* @throws {RequiredError}
|
|
257
|
+
*/
|
|
258
|
+
createReservation(marketplaceIds: Array<string>, body: CreateReservationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReservationResponse>>;
|
|
259
|
+
/**
|
|
260
|
+
* 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).
|
|
261
|
+
* @param {ServiceUploadDocument} body Upload document operation input details.
|
|
262
|
+
* @param {*} [options] Override http request option.
|
|
263
|
+
* @throws {RequiredError}
|
|
264
|
+
*/
|
|
265
|
+
createServiceDocumentUploadDestination(body: ServiceUploadDocument, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateServiceDocumentUploadDestination>>;
|
|
266
|
+
/**
|
|
267
|
+
* 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).
|
|
268
|
+
* @param {string} asin ASIN associated with the service.
|
|
269
|
+
* @param {string} storeId Store identifier defining the region scope to retrive appointment slots.
|
|
270
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace for which appointment slots are queried
|
|
271
|
+
* @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.
|
|
272
|
+
* @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.
|
|
273
|
+
* @param {*} [options] Override http request option.
|
|
274
|
+
* @throws {RequiredError}
|
|
275
|
+
*/
|
|
276
|
+
getAppointmentSlots(asin: string, storeId: string, marketplaceIds: Array<string>, startTime?: string, endTime?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAppointmentSlotsResponse>>;
|
|
277
|
+
/**
|
|
278
|
+
* 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).
|
|
279
|
+
* @param {string} serviceJobId A service job identifier to retrive appointment slots for associated service.
|
|
280
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
281
|
+
* @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.
|
|
282
|
+
* @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.
|
|
283
|
+
* @param {*} [options] Override http request option.
|
|
284
|
+
* @throws {RequiredError}
|
|
285
|
+
*/
|
|
286
|
+
getAppointmmentSlotsByJobId(serviceJobId: string, marketplaceIds: Array<string>, startTime?: string, endTime?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAppointmentSlotsResponse>>;
|
|
287
|
+
/**
|
|
288
|
+
* 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).
|
|
289
|
+
* @param {string} resourceId Resource Identifier.
|
|
290
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
291
|
+
* @param {FixedSlotCapacityQuery} body Request body.
|
|
292
|
+
* @param {string} [nextPageToken] Next page token returned in the response of your previous request.
|
|
293
|
+
* @param {*} [options] Override http request option.
|
|
294
|
+
* @throws {RequiredError}
|
|
295
|
+
*/
|
|
296
|
+
getFixedSlotCapacity(resourceId: string, marketplaceIds: Array<string>, body: FixedSlotCapacityQuery, nextPageToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FixedSlotCapacity>>;
|
|
297
|
+
/**
|
|
298
|
+
* 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).
|
|
299
|
+
* @param {string} resourceId Resource Identifier.
|
|
300
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
301
|
+
* @param {RangeSlotCapacityQuery} body Request body.
|
|
302
|
+
* @param {string} [nextPageToken] Next page token returned in the response of your previous request.
|
|
303
|
+
* @param {*} [options] Override http request option.
|
|
304
|
+
* @throws {RequiredError}
|
|
305
|
+
*/
|
|
306
|
+
getRangeSlotCapacity(resourceId: string, marketplaceIds: Array<string>, body: RangeSlotCapacityQuery, nextPageToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RangeSlotCapacity>>;
|
|
307
|
+
/**
|
|
308
|
+
* 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).
|
|
116
309
|
* @param {string} serviceJobId A service job identifier.
|
|
117
310
|
* @param {*} [options] Override http request option.
|
|
118
311
|
* @throws {RequiredError}
|
|
119
312
|
*/
|
|
120
313
|
getServiceJobByServiceJobId(serviceJobId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetServiceJobByServiceJobIdResponse>>;
|
|
121
314
|
/**
|
|
122
|
-
* Gets service job details for the specified filter query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 40 | For more information, see
|
|
315
|
+
* 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).
|
|
123
316
|
* @param {Array<string>} marketplaceIds Used to select jobs that were placed in the specified marketplaces.
|
|
124
317
|
* @param {Array<string>} [serviceOrderIds] List of service order ids for the query you want to perform.Max values supported 20.
|
|
125
318
|
* @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.
|
|
@@ -127,18 +320,21 @@ export declare const ServiceApiFp: (configuration?: Configuration) => {
|
|
|
127
320
|
* @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.
|
|
128
321
|
* @param {'JOB_DATE' | 'JOB_STATUS'} [sortField] Sort fields on which you want to sort the output.
|
|
129
322
|
* @param {'ASC' | 'DESC'} [sortOrder] Sort order for the query you want to perform.
|
|
130
|
-
* @param {string} [createdAfter] A date used for selecting jobs created
|
|
131
|
-
* @param {string} [createdBefore] A date used for selecting jobs created
|
|
132
|
-
* @param {string} [lastUpdatedAfter] A date used for selecting jobs updated
|
|
133
|
-
* @param {string} [lastUpdatedBefore] A date used for selecting jobs updated
|
|
134
|
-
* @param {string} [scheduleStartDate] A date used for filtering jobs
|
|
135
|
-
* @param {string} [scheduleEndDate] A date used for filtering jobs
|
|
323
|
+
* @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.
|
|
324
|
+
* @param {string} [createdBefore] A date used for selecting jobs created at or before a specified time. Must be in ISO 8601 format.
|
|
325
|
+
* @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.
|
|
326
|
+
* @param {string} [lastUpdatedBefore] A date used for selecting jobs updated at or before a specified time. Must be in ISO 8601 format.
|
|
327
|
+
* @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.
|
|
328
|
+
* @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.
|
|
329
|
+
* @param {Array<string>} [asins] List of Amazon Standard Identification Numbers (ASIN) of the items. Max values supported is 20.
|
|
330
|
+
* @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.
|
|
331
|
+
* @param {Array<string>} [storeIds] List of Amazon-defined identifiers for the region scope. Max values supported is 50.
|
|
136
332
|
* @param {*} [options] Override http request option.
|
|
137
333
|
* @throws {RequiredError}
|
|
138
334
|
*/
|
|
139
|
-
getServiceJobs(marketplaceIds: Array<string>, serviceOrderIds?: Array<string>, serviceJobStatus?: Array<'NOT_SERVICED' | 'CANCELLED' | 'COMPLETED' | 'PENDING_SCHEDULE' | 'NOT_FULFILLABLE' | 'HOLD' | 'PAYMENT_DECLINED'>, pageToken?: string, pageSize?: number, sortField?: 'JOB_DATE' | 'JOB_STATUS', sortOrder?: 'ASC' | 'DESC', createdAfter?: string, createdBefore?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, scheduleStartDate?: string, scheduleEndDate?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetServiceJobsResponse>>;
|
|
335
|
+
getServiceJobs(marketplaceIds: Array<string>, serviceOrderIds?: Array<string>, serviceJobStatus?: Array<'NOT_SERVICED' | 'CANCELLED' | 'COMPLETED' | 'PENDING_SCHEDULE' | 'NOT_FULFILLABLE' | 'HOLD' | 'PAYMENT_DECLINED'>, pageToken?: string, pageSize?: number, sortField?: 'JOB_DATE' | 'JOB_STATUS', sortOrder?: 'ASC' | 'DESC', createdAfter?: string, createdBefore?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, scheduleStartDate?: string, scheduleEndDate?: string, asins?: Array<string>, requiredSkills?: Array<string>, storeIds?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetServiceJobsResponse>>;
|
|
140
336
|
/**
|
|
141
|
-
* Reschedules an appointment for the service job indicated by the service job identifier
|
|
337
|
+
* 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).
|
|
142
338
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
143
339
|
* @param {string} appointmentId An existing appointment identifier for the Service Job.
|
|
144
340
|
* @param {RescheduleAppointmentRequest} body Reschedule appointment operation input details.
|
|
@@ -146,6 +342,33 @@ export declare const ServiceApiFp: (configuration?: Configuration) => {
|
|
|
146
342
|
* @throws {RequiredError}
|
|
147
343
|
*/
|
|
148
344
|
rescheduleAppointmentForServiceJobByServiceJobId(serviceJobId: string, appointmentId: string, body: RescheduleAppointmentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetAppointmentResponse>>;
|
|
345
|
+
/**
|
|
346
|
+
* 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).
|
|
347
|
+
* @param {string} serviceJobId An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.
|
|
348
|
+
* @param {string} appointmentId An Amazon-defined identifier of active service job appointment.
|
|
349
|
+
* @param {SetAppointmentFulfillmentDataRequest} body Appointment fulfillment data collection details.
|
|
350
|
+
* @param {*} [options] Override http request option.
|
|
351
|
+
* @throws {RequiredError}
|
|
352
|
+
*/
|
|
353
|
+
setAppointmentFulfillmentData(serviceJobId: string, appointmentId: string, body: SetAppointmentFulfillmentDataRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
354
|
+
/**
|
|
355
|
+
* 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).
|
|
356
|
+
* @param {string} reservationId Reservation Identifier
|
|
357
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
358
|
+
* @param {UpdateReservationRequest} body Reservation details
|
|
359
|
+
* @param {*} [options] Override http request option.
|
|
360
|
+
* @throws {RequiredError}
|
|
361
|
+
*/
|
|
362
|
+
updateReservation(reservationId: string, marketplaceIds: Array<string>, body: UpdateReservationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateReservationResponse>>;
|
|
363
|
+
/**
|
|
364
|
+
* 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).
|
|
365
|
+
* @param {string} resourceId Resource (store) Identifier
|
|
366
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
367
|
+
* @param {UpdateScheduleRequest} body Schedule details
|
|
368
|
+
* @param {*} [options] Override http request option.
|
|
369
|
+
* @throws {RequiredError}
|
|
370
|
+
*/
|
|
371
|
+
updateSchedule(resourceId: string, marketplaceIds: Array<string>, body: UpdateScheduleRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateScheduleResponse>>;
|
|
149
372
|
};
|
|
150
373
|
/**
|
|
151
374
|
* ServiceApi - factory interface
|
|
@@ -153,7 +376,7 @@ export declare const ServiceApiFp: (configuration?: Configuration) => {
|
|
|
153
376
|
*/
|
|
154
377
|
export declare const ServiceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
155
378
|
/**
|
|
156
|
-
* Adds an appointment to the service job indicated by the service job identifier
|
|
379
|
+
* 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).
|
|
157
380
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
158
381
|
* @param {AddAppointmentRequest} body Add appointment operation input details.
|
|
159
382
|
* @param {*} [options] Override http request option.
|
|
@@ -161,7 +384,24 @@ export declare const ServiceApiFactory: (configuration?: Configuration, basePath
|
|
|
161
384
|
*/
|
|
162
385
|
addAppointmentForServiceJobByServiceJobId(serviceJobId: string, body: AddAppointmentRequest, options?: any): AxiosPromise<SetAppointmentResponse>;
|
|
163
386
|
/**
|
|
164
|
-
*
|
|
387
|
+
* 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).
|
|
388
|
+
* @param {string} serviceJobId An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.
|
|
389
|
+
* @param {string} appointmentId An Amazon-defined identifier of active service job appointment.
|
|
390
|
+
* @param {AssignAppointmentResourcesRequest} body
|
|
391
|
+
* @param {*} [options] Override http request option.
|
|
392
|
+
* @throws {RequiredError}
|
|
393
|
+
*/
|
|
394
|
+
assignAppointmentResources(serviceJobId: string, appointmentId: string, body: AssignAppointmentResourcesRequest, options?: any): AxiosPromise<AssignAppointmentResourcesResponse>;
|
|
395
|
+
/**
|
|
396
|
+
* 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).
|
|
397
|
+
* @param {string} reservationId Reservation Identifier
|
|
398
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
399
|
+
* @param {*} [options] Override http request option.
|
|
400
|
+
* @throws {RequiredError}
|
|
401
|
+
*/
|
|
402
|
+
cancelReservation(reservationId: string, marketplaceIds: Array<string>, options?: any): AxiosPromise<CancelReservationResponse>;
|
|
403
|
+
/**
|
|
404
|
+
* 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).
|
|
165
405
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
166
406
|
* @param {string} cancellationReasonCode A cancel reason code that specifies the reason for cancelling a service job.
|
|
167
407
|
* @param {*} [options] Override http request option.
|
|
@@ -169,21 +409,77 @@ export declare const ServiceApiFactory: (configuration?: Configuration, basePath
|
|
|
169
409
|
*/
|
|
170
410
|
cancelServiceJobByServiceJobId(serviceJobId: string, cancellationReasonCode: string, options?: any): AxiosPromise<CancelServiceJobByServiceJobIdResponse>;
|
|
171
411
|
/**
|
|
172
|
-
* Completes the service job indicated by the service job identifier
|
|
412
|
+
* 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).
|
|
173
413
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
174
414
|
* @param {*} [options] Override http request option.
|
|
175
415
|
* @throws {RequiredError}
|
|
176
416
|
*/
|
|
177
417
|
completeServiceJobByServiceJobId(serviceJobId: string, options?: any): AxiosPromise<CompleteServiceJobByServiceJobIdResponse>;
|
|
178
418
|
/**
|
|
179
|
-
*
|
|
419
|
+
* 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).
|
|
420
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
421
|
+
* @param {CreateReservationRequest} body Reservation details
|
|
422
|
+
* @param {*} [options] Override http request option.
|
|
423
|
+
* @throws {RequiredError}
|
|
424
|
+
*/
|
|
425
|
+
createReservation(marketplaceIds: Array<string>, body: CreateReservationRequest, options?: any): AxiosPromise<CreateReservationResponse>;
|
|
426
|
+
/**
|
|
427
|
+
* 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).
|
|
428
|
+
* @param {ServiceUploadDocument} body Upload document operation input details.
|
|
429
|
+
* @param {*} [options] Override http request option.
|
|
430
|
+
* @throws {RequiredError}
|
|
431
|
+
*/
|
|
432
|
+
createServiceDocumentUploadDestination(body: ServiceUploadDocument, options?: any): AxiosPromise<CreateServiceDocumentUploadDestination>;
|
|
433
|
+
/**
|
|
434
|
+
* 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).
|
|
435
|
+
* @param {string} asin ASIN associated with the service.
|
|
436
|
+
* @param {string} storeId Store identifier defining the region scope to retrive appointment slots.
|
|
437
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace for which appointment slots are queried
|
|
438
|
+
* @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.
|
|
439
|
+
* @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.
|
|
440
|
+
* @param {*} [options] Override http request option.
|
|
441
|
+
* @throws {RequiredError}
|
|
442
|
+
*/
|
|
443
|
+
getAppointmentSlots(asin: string, storeId: string, marketplaceIds: Array<string>, startTime?: string, endTime?: string, options?: any): AxiosPromise<GetAppointmentSlotsResponse>;
|
|
444
|
+
/**
|
|
445
|
+
* 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).
|
|
446
|
+
* @param {string} serviceJobId A service job identifier to retrive appointment slots for associated service.
|
|
447
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
448
|
+
* @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.
|
|
449
|
+
* @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.
|
|
450
|
+
* @param {*} [options] Override http request option.
|
|
451
|
+
* @throws {RequiredError}
|
|
452
|
+
*/
|
|
453
|
+
getAppointmmentSlotsByJobId(serviceJobId: string, marketplaceIds: Array<string>, startTime?: string, endTime?: string, options?: any): AxiosPromise<GetAppointmentSlotsResponse>;
|
|
454
|
+
/**
|
|
455
|
+
* 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).
|
|
456
|
+
* @param {string} resourceId Resource Identifier.
|
|
457
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
458
|
+
* @param {FixedSlotCapacityQuery} body Request body.
|
|
459
|
+
* @param {string} [nextPageToken] Next page token returned in the response of your previous request.
|
|
460
|
+
* @param {*} [options] Override http request option.
|
|
461
|
+
* @throws {RequiredError}
|
|
462
|
+
*/
|
|
463
|
+
getFixedSlotCapacity(resourceId: string, marketplaceIds: Array<string>, body: FixedSlotCapacityQuery, nextPageToken?: string, options?: any): AxiosPromise<FixedSlotCapacity>;
|
|
464
|
+
/**
|
|
465
|
+
* 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).
|
|
466
|
+
* @param {string} resourceId Resource Identifier.
|
|
467
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
468
|
+
* @param {RangeSlotCapacityQuery} body Request body.
|
|
469
|
+
* @param {string} [nextPageToken] Next page token returned in the response of your previous request.
|
|
470
|
+
* @param {*} [options] Override http request option.
|
|
471
|
+
* @throws {RequiredError}
|
|
472
|
+
*/
|
|
473
|
+
getRangeSlotCapacity(resourceId: string, marketplaceIds: Array<string>, body: RangeSlotCapacityQuery, nextPageToken?: string, options?: any): AxiosPromise<RangeSlotCapacity>;
|
|
474
|
+
/**
|
|
475
|
+
* 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).
|
|
180
476
|
* @param {string} serviceJobId A service job identifier.
|
|
181
477
|
* @param {*} [options] Override http request option.
|
|
182
478
|
* @throws {RequiredError}
|
|
183
479
|
*/
|
|
184
480
|
getServiceJobByServiceJobId(serviceJobId: string, options?: any): AxiosPromise<GetServiceJobByServiceJobIdResponse>;
|
|
185
481
|
/**
|
|
186
|
-
* Gets service job details for the specified filter query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 40 | For more information, see
|
|
482
|
+
* 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).
|
|
187
483
|
* @param {Array<string>} marketplaceIds Used to select jobs that were placed in the specified marketplaces.
|
|
188
484
|
* @param {Array<string>} [serviceOrderIds] List of service order ids for the query you want to perform.Max values supported 20.
|
|
189
485
|
* @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.
|
|
@@ -191,18 +487,21 @@ export declare const ServiceApiFactory: (configuration?: Configuration, basePath
|
|
|
191
487
|
* @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.
|
|
192
488
|
* @param {'JOB_DATE' | 'JOB_STATUS'} [sortField] Sort fields on which you want to sort the output.
|
|
193
489
|
* @param {'ASC' | 'DESC'} [sortOrder] Sort order for the query you want to perform.
|
|
194
|
-
* @param {string} [createdAfter] A date used for selecting jobs created
|
|
195
|
-
* @param {string} [createdBefore] A date used for selecting jobs created
|
|
196
|
-
* @param {string} [lastUpdatedAfter] A date used for selecting jobs updated
|
|
197
|
-
* @param {string} [lastUpdatedBefore] A date used for selecting jobs updated
|
|
198
|
-
* @param {string} [scheduleStartDate] A date used for filtering jobs
|
|
199
|
-
* @param {string} [scheduleEndDate] A date used for filtering jobs
|
|
490
|
+
* @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.
|
|
491
|
+
* @param {string} [createdBefore] A date used for selecting jobs created at or before a specified time. Must be in ISO 8601 format.
|
|
492
|
+
* @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.
|
|
493
|
+
* @param {string} [lastUpdatedBefore] A date used for selecting jobs updated at or before a specified time. Must be in ISO 8601 format.
|
|
494
|
+
* @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.
|
|
495
|
+
* @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.
|
|
496
|
+
* @param {Array<string>} [asins] List of Amazon Standard Identification Numbers (ASIN) of the items. Max values supported is 20.
|
|
497
|
+
* @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.
|
|
498
|
+
* @param {Array<string>} [storeIds] List of Amazon-defined identifiers for the region scope. Max values supported is 50.
|
|
200
499
|
* @param {*} [options] Override http request option.
|
|
201
500
|
* @throws {RequiredError}
|
|
202
501
|
*/
|
|
203
|
-
getServiceJobs(marketplaceIds: Array<string>, serviceOrderIds?: Array<string>, serviceJobStatus?: Array<'NOT_SERVICED' | 'CANCELLED' | 'COMPLETED' | 'PENDING_SCHEDULE' | 'NOT_FULFILLABLE' | 'HOLD' | 'PAYMENT_DECLINED'>, pageToken?: string, pageSize?: number, sortField?: 'JOB_DATE' | 'JOB_STATUS', sortOrder?: 'ASC' | 'DESC', createdAfter?: string, createdBefore?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, scheduleStartDate?: string, scheduleEndDate?: string, options?: any): AxiosPromise<GetServiceJobsResponse>;
|
|
502
|
+
getServiceJobs(marketplaceIds: Array<string>, serviceOrderIds?: Array<string>, serviceJobStatus?: Array<'NOT_SERVICED' | 'CANCELLED' | 'COMPLETED' | 'PENDING_SCHEDULE' | 'NOT_FULFILLABLE' | 'HOLD' | 'PAYMENT_DECLINED'>, pageToken?: string, pageSize?: number, sortField?: 'JOB_DATE' | 'JOB_STATUS', sortOrder?: 'ASC' | 'DESC', createdAfter?: string, createdBefore?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, scheduleStartDate?: string, scheduleEndDate?: string, asins?: Array<string>, requiredSkills?: Array<string>, storeIds?: Array<string>, options?: any): AxiosPromise<GetServiceJobsResponse>;
|
|
204
503
|
/**
|
|
205
|
-
* Reschedules an appointment for the service job indicated by the service job identifier
|
|
504
|
+
* 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).
|
|
206
505
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
207
506
|
* @param {string} appointmentId An existing appointment identifier for the Service Job.
|
|
208
507
|
* @param {RescheduleAppointmentRequest} body Reschedule appointment operation input details.
|
|
@@ -210,6 +509,33 @@ export declare const ServiceApiFactory: (configuration?: Configuration, basePath
|
|
|
210
509
|
* @throws {RequiredError}
|
|
211
510
|
*/
|
|
212
511
|
rescheduleAppointmentForServiceJobByServiceJobId(serviceJobId: string, appointmentId: string, body: RescheduleAppointmentRequest, options?: any): AxiosPromise<SetAppointmentResponse>;
|
|
512
|
+
/**
|
|
513
|
+
* 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).
|
|
514
|
+
* @param {string} serviceJobId An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.
|
|
515
|
+
* @param {string} appointmentId An Amazon-defined identifier of active service job appointment.
|
|
516
|
+
* @param {SetAppointmentFulfillmentDataRequest} body Appointment fulfillment data collection details.
|
|
517
|
+
* @param {*} [options] Override http request option.
|
|
518
|
+
* @throws {RequiredError}
|
|
519
|
+
*/
|
|
520
|
+
setAppointmentFulfillmentData(serviceJobId: string, appointmentId: string, body: SetAppointmentFulfillmentDataRequest, options?: any): AxiosPromise<string>;
|
|
521
|
+
/**
|
|
522
|
+
* 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).
|
|
523
|
+
* @param {string} reservationId Reservation Identifier
|
|
524
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
525
|
+
* @param {UpdateReservationRequest} body Reservation details
|
|
526
|
+
* @param {*} [options] Override http request option.
|
|
527
|
+
* @throws {RequiredError}
|
|
528
|
+
*/
|
|
529
|
+
updateReservation(reservationId: string, marketplaceIds: Array<string>, body: UpdateReservationRequest, options?: any): AxiosPromise<UpdateReservationResponse>;
|
|
530
|
+
/**
|
|
531
|
+
* 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).
|
|
532
|
+
* @param {string} resourceId Resource (store) Identifier
|
|
533
|
+
* @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
|
|
534
|
+
* @param {UpdateScheduleRequest} body Schedule details
|
|
535
|
+
* @param {*} [options] Override http request option.
|
|
536
|
+
* @throws {RequiredError}
|
|
537
|
+
*/
|
|
538
|
+
updateSchedule(resourceId: string, marketplaceIds: Array<string>, body: UpdateScheduleRequest, options?: any): AxiosPromise<UpdateScheduleResponse>;
|
|
213
539
|
};
|
|
214
540
|
/**
|
|
215
541
|
* Request parameters for addAppointmentForServiceJobByServiceJobId operation in ServiceApi.
|
|
@@ -230,6 +556,50 @@ export interface ServiceApiAddAppointmentForServiceJobByServiceJobIdRequest {
|
|
|
230
556
|
*/
|
|
231
557
|
readonly body: AddAppointmentRequest;
|
|
232
558
|
}
|
|
559
|
+
/**
|
|
560
|
+
* Request parameters for assignAppointmentResources operation in ServiceApi.
|
|
561
|
+
* @export
|
|
562
|
+
* @interface ServiceApiAssignAppointmentResourcesRequest
|
|
563
|
+
*/
|
|
564
|
+
export interface ServiceApiAssignAppointmentResourcesRequest {
|
|
565
|
+
/**
|
|
566
|
+
* An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.
|
|
567
|
+
* @type {string}
|
|
568
|
+
* @memberof ServiceApiAssignAppointmentResources
|
|
569
|
+
*/
|
|
570
|
+
readonly serviceJobId: string;
|
|
571
|
+
/**
|
|
572
|
+
* An Amazon-defined identifier of active service job appointment.
|
|
573
|
+
* @type {string}
|
|
574
|
+
* @memberof ServiceApiAssignAppointmentResources
|
|
575
|
+
*/
|
|
576
|
+
readonly appointmentId: string;
|
|
577
|
+
/**
|
|
578
|
+
*
|
|
579
|
+
* @type {AssignAppointmentResourcesRequest}
|
|
580
|
+
* @memberof ServiceApiAssignAppointmentResources
|
|
581
|
+
*/
|
|
582
|
+
readonly body: AssignAppointmentResourcesRequest;
|
|
583
|
+
}
|
|
584
|
+
/**
|
|
585
|
+
* Request parameters for cancelReservation operation in ServiceApi.
|
|
586
|
+
* @export
|
|
587
|
+
* @interface ServiceApiCancelReservationRequest
|
|
588
|
+
*/
|
|
589
|
+
export interface ServiceApiCancelReservationRequest {
|
|
590
|
+
/**
|
|
591
|
+
* Reservation Identifier
|
|
592
|
+
* @type {string}
|
|
593
|
+
* @memberof ServiceApiCancelReservation
|
|
594
|
+
*/
|
|
595
|
+
readonly reservationId: string;
|
|
596
|
+
/**
|
|
597
|
+
* An identifier for the marketplace in which the resource operates.
|
|
598
|
+
* @type {Array<string>}
|
|
599
|
+
* @memberof ServiceApiCancelReservation
|
|
600
|
+
*/
|
|
601
|
+
readonly marketplaceIds: Array<string>;
|
|
602
|
+
}
|
|
233
603
|
/**
|
|
234
604
|
* Request parameters for cancelServiceJobByServiceJobId operation in ServiceApi.
|
|
235
605
|
* @export
|
|
@@ -262,6 +632,168 @@ export interface ServiceApiCompleteServiceJobByServiceJobIdRequest {
|
|
|
262
632
|
*/
|
|
263
633
|
readonly serviceJobId: string;
|
|
264
634
|
}
|
|
635
|
+
/**
|
|
636
|
+
* Request parameters for createReservation operation in ServiceApi.
|
|
637
|
+
* @export
|
|
638
|
+
* @interface ServiceApiCreateReservationRequest
|
|
639
|
+
*/
|
|
640
|
+
export interface ServiceApiCreateReservationRequest {
|
|
641
|
+
/**
|
|
642
|
+
* An identifier for the marketplace in which the resource operates.
|
|
643
|
+
* @type {Array<string>}
|
|
644
|
+
* @memberof ServiceApiCreateReservation
|
|
645
|
+
*/
|
|
646
|
+
readonly marketplaceIds: Array<string>;
|
|
647
|
+
/**
|
|
648
|
+
* Reservation details
|
|
649
|
+
* @type {CreateReservationRequest}
|
|
650
|
+
* @memberof ServiceApiCreateReservation
|
|
651
|
+
*/
|
|
652
|
+
readonly body: CreateReservationRequest;
|
|
653
|
+
}
|
|
654
|
+
/**
|
|
655
|
+
* Request parameters for createServiceDocumentUploadDestination operation in ServiceApi.
|
|
656
|
+
* @export
|
|
657
|
+
* @interface ServiceApiCreateServiceDocumentUploadDestinationRequest
|
|
658
|
+
*/
|
|
659
|
+
export interface ServiceApiCreateServiceDocumentUploadDestinationRequest {
|
|
660
|
+
/**
|
|
661
|
+
* Upload document operation input details.
|
|
662
|
+
* @type {ServiceUploadDocument}
|
|
663
|
+
* @memberof ServiceApiCreateServiceDocumentUploadDestination
|
|
664
|
+
*/
|
|
665
|
+
readonly body: ServiceUploadDocument;
|
|
666
|
+
}
|
|
667
|
+
/**
|
|
668
|
+
* Request parameters for getAppointmentSlots operation in ServiceApi.
|
|
669
|
+
* @export
|
|
670
|
+
* @interface ServiceApiGetAppointmentSlotsRequest
|
|
671
|
+
*/
|
|
672
|
+
export interface ServiceApiGetAppointmentSlotsRequest {
|
|
673
|
+
/**
|
|
674
|
+
* ASIN associated with the service.
|
|
675
|
+
* @type {string}
|
|
676
|
+
* @memberof ServiceApiGetAppointmentSlots
|
|
677
|
+
*/
|
|
678
|
+
readonly asin: string;
|
|
679
|
+
/**
|
|
680
|
+
* Store identifier defining the region scope to retrive appointment slots.
|
|
681
|
+
* @type {string}
|
|
682
|
+
* @memberof ServiceApiGetAppointmentSlots
|
|
683
|
+
*/
|
|
684
|
+
readonly storeId: string;
|
|
685
|
+
/**
|
|
686
|
+
* An identifier for the marketplace for which appointment slots are queried
|
|
687
|
+
* @type {Array<string>}
|
|
688
|
+
* @memberof ServiceApiGetAppointmentSlots
|
|
689
|
+
*/
|
|
690
|
+
readonly marketplaceIds: Array<string>;
|
|
691
|
+
/**
|
|
692
|
+
* 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.
|
|
693
|
+
* @type {string}
|
|
694
|
+
* @memberof ServiceApiGetAppointmentSlots
|
|
695
|
+
*/
|
|
696
|
+
readonly startTime?: string;
|
|
697
|
+
/**
|
|
698
|
+
* 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.
|
|
699
|
+
* @type {string}
|
|
700
|
+
* @memberof ServiceApiGetAppointmentSlots
|
|
701
|
+
*/
|
|
702
|
+
readonly endTime?: string;
|
|
703
|
+
}
|
|
704
|
+
/**
|
|
705
|
+
* Request parameters for getAppointmmentSlotsByJobId operation in ServiceApi.
|
|
706
|
+
* @export
|
|
707
|
+
* @interface ServiceApiGetAppointmmentSlotsByJobIdRequest
|
|
708
|
+
*/
|
|
709
|
+
export interface ServiceApiGetAppointmmentSlotsByJobIdRequest {
|
|
710
|
+
/**
|
|
711
|
+
* A service job identifier to retrive appointment slots for associated service.
|
|
712
|
+
* @type {string}
|
|
713
|
+
* @memberof ServiceApiGetAppointmmentSlotsByJobId
|
|
714
|
+
*/
|
|
715
|
+
readonly serviceJobId: string;
|
|
716
|
+
/**
|
|
717
|
+
* An identifier for the marketplace in which the resource operates.
|
|
718
|
+
* @type {Array<string>}
|
|
719
|
+
* @memberof ServiceApiGetAppointmmentSlotsByJobId
|
|
720
|
+
*/
|
|
721
|
+
readonly marketplaceIds: Array<string>;
|
|
722
|
+
/**
|
|
723
|
+
* 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.
|
|
724
|
+
* @type {string}
|
|
725
|
+
* @memberof ServiceApiGetAppointmmentSlotsByJobId
|
|
726
|
+
*/
|
|
727
|
+
readonly startTime?: string;
|
|
728
|
+
/**
|
|
729
|
+
* 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.
|
|
730
|
+
* @type {string}
|
|
731
|
+
* @memberof ServiceApiGetAppointmmentSlotsByJobId
|
|
732
|
+
*/
|
|
733
|
+
readonly endTime?: string;
|
|
734
|
+
}
|
|
735
|
+
/**
|
|
736
|
+
* Request parameters for getFixedSlotCapacity operation in ServiceApi.
|
|
737
|
+
* @export
|
|
738
|
+
* @interface ServiceApiGetFixedSlotCapacityRequest
|
|
739
|
+
*/
|
|
740
|
+
export interface ServiceApiGetFixedSlotCapacityRequest {
|
|
741
|
+
/**
|
|
742
|
+
* Resource Identifier.
|
|
743
|
+
* @type {string}
|
|
744
|
+
* @memberof ServiceApiGetFixedSlotCapacity
|
|
745
|
+
*/
|
|
746
|
+
readonly resourceId: string;
|
|
747
|
+
/**
|
|
748
|
+
* An identifier for the marketplace in which the resource operates.
|
|
749
|
+
* @type {Array<string>}
|
|
750
|
+
* @memberof ServiceApiGetFixedSlotCapacity
|
|
751
|
+
*/
|
|
752
|
+
readonly marketplaceIds: Array<string>;
|
|
753
|
+
/**
|
|
754
|
+
* Request body.
|
|
755
|
+
* @type {FixedSlotCapacityQuery}
|
|
756
|
+
* @memberof ServiceApiGetFixedSlotCapacity
|
|
757
|
+
*/
|
|
758
|
+
readonly body: FixedSlotCapacityQuery;
|
|
759
|
+
/**
|
|
760
|
+
* Next page token returned in the response of your previous request.
|
|
761
|
+
* @type {string}
|
|
762
|
+
* @memberof ServiceApiGetFixedSlotCapacity
|
|
763
|
+
*/
|
|
764
|
+
readonly nextPageToken?: string;
|
|
765
|
+
}
|
|
766
|
+
/**
|
|
767
|
+
* Request parameters for getRangeSlotCapacity operation in ServiceApi.
|
|
768
|
+
* @export
|
|
769
|
+
* @interface ServiceApiGetRangeSlotCapacityRequest
|
|
770
|
+
*/
|
|
771
|
+
export interface ServiceApiGetRangeSlotCapacityRequest {
|
|
772
|
+
/**
|
|
773
|
+
* Resource Identifier.
|
|
774
|
+
* @type {string}
|
|
775
|
+
* @memberof ServiceApiGetRangeSlotCapacity
|
|
776
|
+
*/
|
|
777
|
+
readonly resourceId: string;
|
|
778
|
+
/**
|
|
779
|
+
* An identifier for the marketplace in which the resource operates.
|
|
780
|
+
* @type {Array<string>}
|
|
781
|
+
* @memberof ServiceApiGetRangeSlotCapacity
|
|
782
|
+
*/
|
|
783
|
+
readonly marketplaceIds: Array<string>;
|
|
784
|
+
/**
|
|
785
|
+
* Request body.
|
|
786
|
+
* @type {RangeSlotCapacityQuery}
|
|
787
|
+
* @memberof ServiceApiGetRangeSlotCapacity
|
|
788
|
+
*/
|
|
789
|
+
readonly body: RangeSlotCapacityQuery;
|
|
790
|
+
/**
|
|
791
|
+
* Next page token returned in the response of your previous request.
|
|
792
|
+
* @type {string}
|
|
793
|
+
* @memberof ServiceApiGetRangeSlotCapacity
|
|
794
|
+
*/
|
|
795
|
+
readonly nextPageToken?: string;
|
|
796
|
+
}
|
|
265
797
|
/**
|
|
266
798
|
* Request parameters for getServiceJobByServiceJobId operation in ServiceApi.
|
|
267
799
|
* @export
|
|
@@ -324,41 +856,59 @@ export interface ServiceApiGetServiceJobsRequest {
|
|
|
324
856
|
*/
|
|
325
857
|
readonly sortOrder?: 'ASC' | 'DESC';
|
|
326
858
|
/**
|
|
327
|
-
* A date used for selecting jobs created
|
|
859
|
+
* 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.
|
|
328
860
|
* @type {string}
|
|
329
861
|
* @memberof ServiceApiGetServiceJobs
|
|
330
862
|
*/
|
|
331
863
|
readonly createdAfter?: string;
|
|
332
864
|
/**
|
|
333
|
-
* A date used for selecting jobs created
|
|
865
|
+
* A date used for selecting jobs created at or before a specified time. Must be in ISO 8601 format.
|
|
334
866
|
* @type {string}
|
|
335
867
|
* @memberof ServiceApiGetServiceJobs
|
|
336
868
|
*/
|
|
337
869
|
readonly createdBefore?: string;
|
|
338
870
|
/**
|
|
339
|
-
* A date used for selecting jobs updated
|
|
871
|
+
* 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.
|
|
340
872
|
* @type {string}
|
|
341
873
|
* @memberof ServiceApiGetServiceJobs
|
|
342
874
|
*/
|
|
343
875
|
readonly lastUpdatedAfter?: string;
|
|
344
876
|
/**
|
|
345
|
-
* A date used for selecting jobs updated
|
|
877
|
+
* A date used for selecting jobs updated at or before a specified time. Must be in ISO 8601 format.
|
|
346
878
|
* @type {string}
|
|
347
879
|
* @memberof ServiceApiGetServiceJobs
|
|
348
880
|
*/
|
|
349
881
|
readonly lastUpdatedBefore?: string;
|
|
350
882
|
/**
|
|
351
|
-
* A date used for filtering jobs
|
|
883
|
+
* 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.
|
|
352
884
|
* @type {string}
|
|
353
885
|
* @memberof ServiceApiGetServiceJobs
|
|
354
886
|
*/
|
|
355
887
|
readonly scheduleStartDate?: string;
|
|
356
888
|
/**
|
|
357
|
-
* A date used for filtering jobs
|
|
889
|
+
* 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.
|
|
358
890
|
* @type {string}
|
|
359
891
|
* @memberof ServiceApiGetServiceJobs
|
|
360
892
|
*/
|
|
361
893
|
readonly scheduleEndDate?: string;
|
|
894
|
+
/**
|
|
895
|
+
* List of Amazon Standard Identification Numbers (ASIN) of the items. Max values supported is 20.
|
|
896
|
+
* @type {Array<string>}
|
|
897
|
+
* @memberof ServiceApiGetServiceJobs
|
|
898
|
+
*/
|
|
899
|
+
readonly asins?: Array<string>;
|
|
900
|
+
/**
|
|
901
|
+
* 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.
|
|
902
|
+
* @type {Array<string>}
|
|
903
|
+
* @memberof ServiceApiGetServiceJobs
|
|
904
|
+
*/
|
|
905
|
+
readonly requiredSkills?: Array<string>;
|
|
906
|
+
/**
|
|
907
|
+
* List of Amazon-defined identifiers for the region scope. Max values supported is 50.
|
|
908
|
+
* @type {Array<string>}
|
|
909
|
+
* @memberof ServiceApiGetServiceJobs
|
|
910
|
+
*/
|
|
911
|
+
readonly storeIds?: Array<string>;
|
|
362
912
|
}
|
|
363
913
|
/**
|
|
364
914
|
* Request parameters for rescheduleAppointmentForServiceJobByServiceJobId operation in ServiceApi.
|
|
@@ -385,6 +935,81 @@ export interface ServiceApiRescheduleAppointmentForServiceJobByServiceJobIdReque
|
|
|
385
935
|
*/
|
|
386
936
|
readonly body: RescheduleAppointmentRequest;
|
|
387
937
|
}
|
|
938
|
+
/**
|
|
939
|
+
* Request parameters for setAppointmentFulfillmentData operation in ServiceApi.
|
|
940
|
+
* @export
|
|
941
|
+
* @interface ServiceApiSetAppointmentFulfillmentDataRequest
|
|
942
|
+
*/
|
|
943
|
+
export interface ServiceApiSetAppointmentFulfillmentDataRequest {
|
|
944
|
+
/**
|
|
945
|
+
* An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.
|
|
946
|
+
* @type {string}
|
|
947
|
+
* @memberof ServiceApiSetAppointmentFulfillmentData
|
|
948
|
+
*/
|
|
949
|
+
readonly serviceJobId: string;
|
|
950
|
+
/**
|
|
951
|
+
* An Amazon-defined identifier of active service job appointment.
|
|
952
|
+
* @type {string}
|
|
953
|
+
* @memberof ServiceApiSetAppointmentFulfillmentData
|
|
954
|
+
*/
|
|
955
|
+
readonly appointmentId: string;
|
|
956
|
+
/**
|
|
957
|
+
* Appointment fulfillment data collection details.
|
|
958
|
+
* @type {SetAppointmentFulfillmentDataRequest}
|
|
959
|
+
* @memberof ServiceApiSetAppointmentFulfillmentData
|
|
960
|
+
*/
|
|
961
|
+
readonly body: SetAppointmentFulfillmentDataRequest;
|
|
962
|
+
}
|
|
963
|
+
/**
|
|
964
|
+
* Request parameters for updateReservation operation in ServiceApi.
|
|
965
|
+
* @export
|
|
966
|
+
* @interface ServiceApiUpdateReservationRequest
|
|
967
|
+
*/
|
|
968
|
+
export interface ServiceApiUpdateReservationRequest {
|
|
969
|
+
/**
|
|
970
|
+
* Reservation Identifier
|
|
971
|
+
* @type {string}
|
|
972
|
+
* @memberof ServiceApiUpdateReservation
|
|
973
|
+
*/
|
|
974
|
+
readonly reservationId: string;
|
|
975
|
+
/**
|
|
976
|
+
* An identifier for the marketplace in which the resource operates.
|
|
977
|
+
* @type {Array<string>}
|
|
978
|
+
* @memberof ServiceApiUpdateReservation
|
|
979
|
+
*/
|
|
980
|
+
readonly marketplaceIds: Array<string>;
|
|
981
|
+
/**
|
|
982
|
+
* Reservation details
|
|
983
|
+
* @type {UpdateReservationRequest}
|
|
984
|
+
* @memberof ServiceApiUpdateReservation
|
|
985
|
+
*/
|
|
986
|
+
readonly body: UpdateReservationRequest;
|
|
987
|
+
}
|
|
988
|
+
/**
|
|
989
|
+
* Request parameters for updateSchedule operation in ServiceApi.
|
|
990
|
+
* @export
|
|
991
|
+
* @interface ServiceApiUpdateScheduleRequest
|
|
992
|
+
*/
|
|
993
|
+
export interface ServiceApiUpdateScheduleRequest {
|
|
994
|
+
/**
|
|
995
|
+
* Resource (store) Identifier
|
|
996
|
+
* @type {string}
|
|
997
|
+
* @memberof ServiceApiUpdateSchedule
|
|
998
|
+
*/
|
|
999
|
+
readonly resourceId: string;
|
|
1000
|
+
/**
|
|
1001
|
+
* An identifier for the marketplace in which the resource operates.
|
|
1002
|
+
* @type {Array<string>}
|
|
1003
|
+
* @memberof ServiceApiUpdateSchedule
|
|
1004
|
+
*/
|
|
1005
|
+
readonly marketplaceIds: Array<string>;
|
|
1006
|
+
/**
|
|
1007
|
+
* Schedule details
|
|
1008
|
+
* @type {UpdateScheduleRequest}
|
|
1009
|
+
* @memberof ServiceApiUpdateSchedule
|
|
1010
|
+
*/
|
|
1011
|
+
readonly body: UpdateScheduleRequest;
|
|
1012
|
+
}
|
|
388
1013
|
/**
|
|
389
1014
|
* ServiceApi - object-oriented interface
|
|
390
1015
|
* @export
|
|
@@ -393,7 +1018,7 @@ export interface ServiceApiRescheduleAppointmentForServiceJobByServiceJobIdReque
|
|
|
393
1018
|
*/
|
|
394
1019
|
export declare class ServiceApi extends BaseAPI {
|
|
395
1020
|
/**
|
|
396
|
-
* Adds an appointment to the service job indicated by the service job identifier
|
|
1021
|
+
* 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).
|
|
397
1022
|
* @param {ServiceApiAddAppointmentForServiceJobByServiceJobIdRequest} requestParameters Request parameters.
|
|
398
1023
|
* @param {*} [options] Override http request option.
|
|
399
1024
|
* @throws {RequiredError}
|
|
@@ -401,7 +1026,23 @@ export declare class ServiceApi extends BaseAPI {
|
|
|
401
1026
|
*/
|
|
402
1027
|
addAppointmentForServiceJobByServiceJobId(requestParameters: ServiceApiAddAppointmentForServiceJobByServiceJobIdRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SetAppointmentResponse, any>>;
|
|
403
1028
|
/**
|
|
404
|
-
*
|
|
1029
|
+
* 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).
|
|
1030
|
+
* @param {ServiceApiAssignAppointmentResourcesRequest} requestParameters Request parameters.
|
|
1031
|
+
* @param {*} [options] Override http request option.
|
|
1032
|
+
* @throws {RequiredError}
|
|
1033
|
+
* @memberof ServiceApi
|
|
1034
|
+
*/
|
|
1035
|
+
assignAppointmentResources(requestParameters: ServiceApiAssignAppointmentResourcesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AssignAppointmentResourcesResponse, any>>;
|
|
1036
|
+
/**
|
|
1037
|
+
* 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).
|
|
1038
|
+
* @param {ServiceApiCancelReservationRequest} requestParameters Request parameters.
|
|
1039
|
+
* @param {*} [options] Override http request option.
|
|
1040
|
+
* @throws {RequiredError}
|
|
1041
|
+
* @memberof ServiceApi
|
|
1042
|
+
*/
|
|
1043
|
+
cancelReservation(requestParameters: ServiceApiCancelReservationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CancelReservationResponse, any>>;
|
|
1044
|
+
/**
|
|
1045
|
+
* 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).
|
|
405
1046
|
* @param {ServiceApiCancelServiceJobByServiceJobIdRequest} requestParameters Request parameters.
|
|
406
1047
|
* @param {*} [options] Override http request option.
|
|
407
1048
|
* @throws {RequiredError}
|
|
@@ -409,7 +1050,7 @@ export declare class ServiceApi extends BaseAPI {
|
|
|
409
1050
|
*/
|
|
410
1051
|
cancelServiceJobByServiceJobId(requestParameters: ServiceApiCancelServiceJobByServiceJobIdRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CancelServiceJobByServiceJobIdResponse, any>>;
|
|
411
1052
|
/**
|
|
412
|
-
* Completes the service job indicated by the service job identifier
|
|
1053
|
+
* 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).
|
|
413
1054
|
* @param {ServiceApiCompleteServiceJobByServiceJobIdRequest} requestParameters Request parameters.
|
|
414
1055
|
* @param {*} [options] Override http request option.
|
|
415
1056
|
* @throws {RequiredError}
|
|
@@ -417,7 +1058,55 @@ export declare class ServiceApi extends BaseAPI {
|
|
|
417
1058
|
*/
|
|
418
1059
|
completeServiceJobByServiceJobId(requestParameters: ServiceApiCompleteServiceJobByServiceJobIdRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CompleteServiceJobByServiceJobIdResponse, any>>;
|
|
419
1060
|
/**
|
|
420
|
-
*
|
|
1061
|
+
* 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).
|
|
1062
|
+
* @param {ServiceApiCreateReservationRequest} requestParameters Request parameters.
|
|
1063
|
+
* @param {*} [options] Override http request option.
|
|
1064
|
+
* @throws {RequiredError}
|
|
1065
|
+
* @memberof ServiceApi
|
|
1066
|
+
*/
|
|
1067
|
+
createReservation(requestParameters: ServiceApiCreateReservationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateReservationResponse, any>>;
|
|
1068
|
+
/**
|
|
1069
|
+
* 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).
|
|
1070
|
+
* @param {ServiceApiCreateServiceDocumentUploadDestinationRequest} requestParameters Request parameters.
|
|
1071
|
+
* @param {*} [options] Override http request option.
|
|
1072
|
+
* @throws {RequiredError}
|
|
1073
|
+
* @memberof ServiceApi
|
|
1074
|
+
*/
|
|
1075
|
+
createServiceDocumentUploadDestination(requestParameters: ServiceApiCreateServiceDocumentUploadDestinationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateServiceDocumentUploadDestination, any>>;
|
|
1076
|
+
/**
|
|
1077
|
+
* 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).
|
|
1078
|
+
* @param {ServiceApiGetAppointmentSlotsRequest} requestParameters Request parameters.
|
|
1079
|
+
* @param {*} [options] Override http request option.
|
|
1080
|
+
* @throws {RequiredError}
|
|
1081
|
+
* @memberof ServiceApi
|
|
1082
|
+
*/
|
|
1083
|
+
getAppointmentSlots(requestParameters: ServiceApiGetAppointmentSlotsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAppointmentSlotsResponse, any>>;
|
|
1084
|
+
/**
|
|
1085
|
+
* 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).
|
|
1086
|
+
* @param {ServiceApiGetAppointmmentSlotsByJobIdRequest} requestParameters Request parameters.
|
|
1087
|
+
* @param {*} [options] Override http request option.
|
|
1088
|
+
* @throws {RequiredError}
|
|
1089
|
+
* @memberof ServiceApi
|
|
1090
|
+
*/
|
|
1091
|
+
getAppointmmentSlotsByJobId(requestParameters: ServiceApiGetAppointmmentSlotsByJobIdRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAppointmentSlotsResponse, any>>;
|
|
1092
|
+
/**
|
|
1093
|
+
* 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).
|
|
1094
|
+
* @param {ServiceApiGetFixedSlotCapacityRequest} requestParameters Request parameters.
|
|
1095
|
+
* @param {*} [options] Override http request option.
|
|
1096
|
+
* @throws {RequiredError}
|
|
1097
|
+
* @memberof ServiceApi
|
|
1098
|
+
*/
|
|
1099
|
+
getFixedSlotCapacity(requestParameters: ServiceApiGetFixedSlotCapacityRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FixedSlotCapacity, any>>;
|
|
1100
|
+
/**
|
|
1101
|
+
* 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).
|
|
1102
|
+
* @param {ServiceApiGetRangeSlotCapacityRequest} requestParameters Request parameters.
|
|
1103
|
+
* @param {*} [options] Override http request option.
|
|
1104
|
+
* @throws {RequiredError}
|
|
1105
|
+
* @memberof ServiceApi
|
|
1106
|
+
*/
|
|
1107
|
+
getRangeSlotCapacity(requestParameters: ServiceApiGetRangeSlotCapacityRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RangeSlotCapacity, any>>;
|
|
1108
|
+
/**
|
|
1109
|
+
* 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).
|
|
421
1110
|
* @param {ServiceApiGetServiceJobByServiceJobIdRequest} requestParameters Request parameters.
|
|
422
1111
|
* @param {*} [options] Override http request option.
|
|
423
1112
|
* @throws {RequiredError}
|
|
@@ -425,7 +1114,7 @@ export declare class ServiceApi extends BaseAPI {
|
|
|
425
1114
|
*/
|
|
426
1115
|
getServiceJobByServiceJobId(requestParameters: ServiceApiGetServiceJobByServiceJobIdRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetServiceJobByServiceJobIdResponse, any>>;
|
|
427
1116
|
/**
|
|
428
|
-
* Gets service job details for the specified filter query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 40 | For more information, see
|
|
1117
|
+
* 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).
|
|
429
1118
|
* @param {ServiceApiGetServiceJobsRequest} requestParameters Request parameters.
|
|
430
1119
|
* @param {*} [options] Override http request option.
|
|
431
1120
|
* @throws {RequiredError}
|
|
@@ -433,11 +1122,35 @@ export declare class ServiceApi extends BaseAPI {
|
|
|
433
1122
|
*/
|
|
434
1123
|
getServiceJobs(requestParameters: ServiceApiGetServiceJobsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetServiceJobsResponse, any>>;
|
|
435
1124
|
/**
|
|
436
|
-
* Reschedules an appointment for the service job indicated by the service job identifier
|
|
1125
|
+
* 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).
|
|
437
1126
|
* @param {ServiceApiRescheduleAppointmentForServiceJobByServiceJobIdRequest} requestParameters Request parameters.
|
|
438
1127
|
* @param {*} [options] Override http request option.
|
|
439
1128
|
* @throws {RequiredError}
|
|
440
1129
|
* @memberof ServiceApi
|
|
441
1130
|
*/
|
|
442
1131
|
rescheduleAppointmentForServiceJobByServiceJobId(requestParameters: ServiceApiRescheduleAppointmentForServiceJobByServiceJobIdRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SetAppointmentResponse, any>>;
|
|
1132
|
+
/**
|
|
1133
|
+
* 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).
|
|
1134
|
+
* @param {ServiceApiSetAppointmentFulfillmentDataRequest} requestParameters Request parameters.
|
|
1135
|
+
* @param {*} [options] Override http request option.
|
|
1136
|
+
* @throws {RequiredError}
|
|
1137
|
+
* @memberof ServiceApi
|
|
1138
|
+
*/
|
|
1139
|
+
setAppointmentFulfillmentData(requestParameters: ServiceApiSetAppointmentFulfillmentDataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
1140
|
+
/**
|
|
1141
|
+
* 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).
|
|
1142
|
+
* @param {ServiceApiUpdateReservationRequest} requestParameters Request parameters.
|
|
1143
|
+
* @param {*} [options] Override http request option.
|
|
1144
|
+
* @throws {RequiredError}
|
|
1145
|
+
* @memberof ServiceApi
|
|
1146
|
+
*/
|
|
1147
|
+
updateReservation(requestParameters: ServiceApiUpdateReservationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateReservationResponse, any>>;
|
|
1148
|
+
/**
|
|
1149
|
+
* 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).
|
|
1150
|
+
* @param {ServiceApiUpdateScheduleRequest} requestParameters Request parameters.
|
|
1151
|
+
* @param {*} [options] Override http request option.
|
|
1152
|
+
* @throws {RequiredError}
|
|
1153
|
+
* @memberof ServiceApi
|
|
1154
|
+
*/
|
|
1155
|
+
updateSchedule(requestParameters: ServiceApiUpdateScheduleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateScheduleResponse, any>>;
|
|
443
1156
|
}
|