@sp-api-sdk/services-api-v1 1.6.15
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/LICENSE +21 -0
- package/README.md +58 -0
- package/dist/cjs/index.js +6 -0
- package/dist/cjs/src/api-model/api/service-api.js +505 -0
- package/dist/cjs/src/api-model/api.js +17 -0
- package/dist/cjs/src/api-model/base.js +62 -0
- package/dist/cjs/src/api-model/common.js +137 -0
- package/dist/cjs/src/api-model/configuration.js +42 -0
- package/dist/cjs/src/api-model/index.js +19 -0
- package/dist/cjs/src/api-model/models/add-appointment-request.js +15 -0
- package/dist/cjs/src/api-model/models/address.js +15 -0
- package/dist/cjs/src/api-model/models/appointment-time-input.js +15 -0
- package/dist/cjs/src/api-model/models/appointment-time.js +15 -0
- package/dist/cjs/src/api-model/models/appointment.js +26 -0
- package/dist/cjs/src/api-model/models/associated-item.js +27 -0
- package/dist/cjs/src/api-model/models/buyer.js +15 -0
- package/dist/cjs/src/api-model/models/cancel-service-job-by-service-job-id-response.js +15 -0
- package/dist/cjs/src/api-model/models/complete-service-job-by-service-job-id-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-service-job-by-service-job-id-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-service-jobs-response.js +15 -0
- package/dist/cjs/src/api-model/models/index.js +28 -0
- package/dist/cjs/src/api-model/models/item-delivery-promise.js +15 -0
- package/dist/cjs/src/api-model/models/item-delivery.js +15 -0
- package/dist/cjs/src/api-model/models/job-listing.js +15 -0
- package/dist/cjs/src/api-model/models/model-error.js +25 -0
- package/dist/cjs/src/api-model/models/poa.js +27 -0
- package/dist/cjs/src/api-model/models/reschedule-appointment-request.js +15 -0
- package/dist/cjs/src/api-model/models/scope-of-work.js +15 -0
- package/dist/cjs/src/api-model/models/seller.js +15 -0
- package/dist/cjs/src/api-model/models/service-job-provider.js +15 -0
- package/dist/cjs/src/api-model/models/service-job.js +30 -0
- package/dist/cjs/src/api-model/models/service-location.js +26 -0
- package/dist/cjs/src/api-model/models/set-appointment-response.js +15 -0
- package/dist/cjs/src/api-model/models/technician.js +15 -0
- package/dist/cjs/src/api-model/models/warning.js +15 -0
- package/dist/cjs/src/client.js +65 -0
- package/dist/cjs/src/error.js +10 -0
- package/dist/es/index.js +3 -0
- package/dist/es/src/api-model/api/service-api.js +497 -0
- package/dist/es/src/api-model/api.js +14 -0
- package/dist/es/src/api-model/base.js +56 -0
- package/dist/es/src/api-model/common.js +125 -0
- package/dist/es/src/api-model/configuration.js +38 -0
- package/dist/es/src/api-model/index.js +16 -0
- package/dist/es/src/api-model/models/add-appointment-request.js +14 -0
- package/dist/es/src/api-model/models/address.js +14 -0
- package/dist/es/src/api-model/models/appointment-time-input.js +14 -0
- package/dist/es/src/api-model/models/appointment-time.js +14 -0
- package/dist/es/src/api-model/models/appointment.js +23 -0
- package/dist/es/src/api-model/models/associated-item.js +24 -0
- package/dist/es/src/api-model/models/buyer.js +14 -0
- package/dist/es/src/api-model/models/cancel-service-job-by-service-job-id-response.js +14 -0
- package/dist/es/src/api-model/models/complete-service-job-by-service-job-id-response.js +14 -0
- package/dist/es/src/api-model/models/get-service-job-by-service-job-id-response.js +14 -0
- package/dist/es/src/api-model/models/get-service-jobs-response.js +14 -0
- package/dist/es/src/api-model/models/index.js +25 -0
- package/dist/es/src/api-model/models/item-delivery-promise.js +14 -0
- package/dist/es/src/api-model/models/item-delivery.js +14 -0
- package/dist/es/src/api-model/models/job-listing.js +14 -0
- package/dist/es/src/api-model/models/model-error.js +22 -0
- package/dist/es/src/api-model/models/poa.js +24 -0
- package/dist/es/src/api-model/models/reschedule-appointment-request.js +14 -0
- package/dist/es/src/api-model/models/scope-of-work.js +14 -0
- package/dist/es/src/api-model/models/seller.js +14 -0
- package/dist/es/src/api-model/models/service-job-provider.js +14 -0
- package/dist/es/src/api-model/models/service-job.js +27 -0
- package/dist/es/src/api-model/models/service-location.js +23 -0
- package/dist/es/src/api-model/models/set-appointment-response.js +14 -0
- package/dist/es/src/api-model/models/technician.js +14 -0
- package/dist/es/src/api-model/models/warning.js +14 -0
- package/dist/es/src/client.js +61 -0
- package/dist/es/src/error.js +6 -0
- package/dist/types/index.d.ts +3 -0
- package/dist/types/src/api-model/api/service-api.d.ts +443 -0
- package/dist/types/src/api-model/api.d.ts +12 -0
- package/dist/types/src/api-model/base.d.ts +55 -0
- package/dist/types/src/api-model/common.d.ts +65 -0
- package/dist/types/src/api-model/configuration.d.ts +83 -0
- package/dist/types/src/api-model/index.d.ts +14 -0
- package/dist/types/src/api-model/models/add-appointment-request.d.ts +25 -0
- package/dist/types/src/api-model/models/address.d.ts +84 -0
- package/dist/types/src/api-model/models/appointment-time-input.d.ts +30 -0
- package/dist/types/src/api-model/models/appointment-time.d.ts +30 -0
- package/dist/types/src/api-model/models/appointment.d.ts +66 -0
- package/dist/types/src/api-model/models/associated-item.d.ts +71 -0
- package/dist/types/src/api-model/models/buyer.d.ts +42 -0
- package/dist/types/src/api-model/models/cancel-service-job-by-service-job-id-response.d.ts +24 -0
- package/dist/types/src/api-model/models/complete-service-job-by-service-job-id-response.d.ts +24 -0
- package/dist/types/src/api-model/models/get-service-job-by-service-job-id-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-service-jobs-response.d.ts +31 -0
- package/dist/types/src/api-model/models/index.d.ts +25 -0
- package/dist/types/src/api-model/models/item-delivery-promise.d.ts +30 -0
- package/dist/types/src/api-model/models/item-delivery.d.ts +31 -0
- package/dist/types/src/api-model/models/job-listing.d.ts +43 -0
- package/dist/types/src/api-model/models/model-error.d.ts +50 -0
- package/dist/types/src/api-model/models/poa.d.ts +60 -0
- package/dist/types/src/api-model/models/reschedule-appointment-request.d.ts +31 -0
- package/dist/types/src/api-model/models/scope-of-work.d.ts +42 -0
- package/dist/types/src/api-model/models/seller.d.ts +24 -0
- package/dist/types/src/api-model/models/service-job-provider.d.ts +24 -0
- package/dist/types/src/api-model/models/service-job.d.ts +117 -0
- package/dist/types/src/api-model/models/service-location.d.ts +40 -0
- package/dist/types/src/api-model/models/set-appointment-response.d.ts +37 -0
- package/dist/types/src/api-model/models/technician.d.ts +30 -0
- package/dist/types/src/api-model/models/warning.d.ts +36 -0
- package/dist/types/src/client.d.ts +13 -0
- package/dist/types/src/error.d.ts +3 -0
- package/package.json +53 -0
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
export * from './add-appointment-request';
|
|
2
|
+
export * from './address';
|
|
3
|
+
export * from './appointment';
|
|
4
|
+
export * from './appointment-time';
|
|
5
|
+
export * from './appointment-time-input';
|
|
6
|
+
export * from './associated-item';
|
|
7
|
+
export * from './buyer';
|
|
8
|
+
export * from './cancel-service-job-by-service-job-id-response';
|
|
9
|
+
export * from './complete-service-job-by-service-job-id-response';
|
|
10
|
+
export * from './get-service-job-by-service-job-id-response';
|
|
11
|
+
export * from './get-service-jobs-response';
|
|
12
|
+
export * from './item-delivery';
|
|
13
|
+
export * from './item-delivery-promise';
|
|
14
|
+
export * from './job-listing';
|
|
15
|
+
export * from './model-error';
|
|
16
|
+
export * from './poa';
|
|
17
|
+
export * from './reschedule-appointment-request';
|
|
18
|
+
export * from './scope-of-work';
|
|
19
|
+
export * from './seller';
|
|
20
|
+
export * from './service-job';
|
|
21
|
+
export * from './service-job-provider';
|
|
22
|
+
export * from './service-location';
|
|
23
|
+
export * from './set-appointment-response';
|
|
24
|
+
export * from './technician';
|
|
25
|
+
export * from './warning';
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Services
|
|
5
|
+
* With the Services API, you can build applications that help service providers get and modify their service orders.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v1
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Services
|
|
5
|
+
* With the Services API, you can build applications that help service providers get and modify their service orders.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v1
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Services
|
|
5
|
+
* With the Services API, you can build applications that help service providers get and modify their service orders.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v1
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Services
|
|
5
|
+
* With the Services API, you can build applications that help service providers get and modify their service orders.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v1
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* @export
|
|
16
|
+
* @enum {string}
|
|
17
|
+
*/
|
|
18
|
+
export var ModelErrorErrorLevelEnum;
|
|
19
|
+
(function (ModelErrorErrorLevelEnum) {
|
|
20
|
+
ModelErrorErrorLevelEnum["Error"] = "ERROR";
|
|
21
|
+
ModelErrorErrorLevelEnum["Warning"] = "WARNING";
|
|
22
|
+
})(ModelErrorErrorLevelEnum || (ModelErrorErrorLevelEnum = {}));
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Services
|
|
5
|
+
* With the Services API, you can build applications that help service providers get and modify their service orders.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v1
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* @export
|
|
16
|
+
* @enum {string}
|
|
17
|
+
*/
|
|
18
|
+
export var PoaPoaTypeEnum;
|
|
19
|
+
(function (PoaPoaTypeEnum) {
|
|
20
|
+
PoaPoaTypeEnum["NoSignatureDummyPos"] = "NO_SIGNATURE_DUMMY_POS";
|
|
21
|
+
PoaPoaTypeEnum["CustomerSignature"] = "CUSTOMER_SIGNATURE";
|
|
22
|
+
PoaPoaTypeEnum["DummyReceipt"] = "DUMMY_RECEIPT";
|
|
23
|
+
PoaPoaTypeEnum["PoaReceipt"] = "POA_RECEIPT";
|
|
24
|
+
})(PoaPoaTypeEnum || (PoaPoaTypeEnum = {}));
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Services
|
|
5
|
+
* With the Services API, you can build applications that help service providers get and modify their service orders.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v1
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Services
|
|
5
|
+
* With the Services API, you can build applications that help service providers get and modify their service orders.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v1
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Services
|
|
5
|
+
* With the Services API, you can build applications that help service providers get and modify their service orders.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v1
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Services
|
|
5
|
+
* With the Services API, you can build applications that help service providers get and modify their service orders.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v1
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Services
|
|
5
|
+
* With the Services API, you can build applications that help service providers get and modify their service orders.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v1
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* @export
|
|
16
|
+
* @enum {string}
|
|
17
|
+
*/
|
|
18
|
+
export var ServiceJobServiceJobStatusEnum;
|
|
19
|
+
(function (ServiceJobServiceJobStatusEnum) {
|
|
20
|
+
ServiceJobServiceJobStatusEnum["NotServiced"] = "NOT_SERVICED";
|
|
21
|
+
ServiceJobServiceJobStatusEnum["Cancelled"] = "CANCELLED";
|
|
22
|
+
ServiceJobServiceJobStatusEnum["Completed"] = "COMPLETED";
|
|
23
|
+
ServiceJobServiceJobStatusEnum["PendingSchedule"] = "PENDING_SCHEDULE";
|
|
24
|
+
ServiceJobServiceJobStatusEnum["NotFulfillable"] = "NOT_FULFILLABLE";
|
|
25
|
+
ServiceJobServiceJobStatusEnum["Hold"] = "HOLD";
|
|
26
|
+
ServiceJobServiceJobStatusEnum["PaymentDeclined"] = "PAYMENT_DECLINED";
|
|
27
|
+
})(ServiceJobServiceJobStatusEnum || (ServiceJobServiceJobStatusEnum = {}));
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Services
|
|
5
|
+
* With the Services API, you can build applications that help service providers get and modify their service orders.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v1
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* @export
|
|
16
|
+
* @enum {string}
|
|
17
|
+
*/
|
|
18
|
+
export var ServiceLocationServiceLocationTypeEnum;
|
|
19
|
+
(function (ServiceLocationServiceLocationTypeEnum) {
|
|
20
|
+
ServiceLocationServiceLocationTypeEnum["InHome"] = "IN_HOME";
|
|
21
|
+
ServiceLocationServiceLocationTypeEnum["InStore"] = "IN_STORE";
|
|
22
|
+
ServiceLocationServiceLocationTypeEnum["Online"] = "ONLINE";
|
|
23
|
+
})(ServiceLocationServiceLocationTypeEnum || (ServiceLocationServiceLocationTypeEnum = {}));
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Services
|
|
5
|
+
* With the Services API, you can build applications that help service providers get and modify their service orders.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v1
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Services
|
|
5
|
+
* With the Services API, you can build applications that help service providers get and modify their service orders.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v1
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Services
|
|
5
|
+
* With the Services API, you can build applications that help service providers get and modify their service orders.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v1
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
/* eslint-disable prefer-regex-literals */
|
|
2
|
+
import { endpoints, awsRegionByCode, createAxiosInstance } from '@sp-api-sdk/common';
|
|
3
|
+
import { Configuration, ServiceApi } from './api-model';
|
|
4
|
+
import { ServicesApiError } from './error';
|
|
5
|
+
export const RATE_LIMITS = [
|
|
6
|
+
{
|
|
7
|
+
method: 'get',
|
|
8
|
+
urlRegex: new RegExp('^/service/v1/serviceJobs/[^/]*$'),
|
|
9
|
+
rate: 20,
|
|
10
|
+
burst: 40,
|
|
11
|
+
},
|
|
12
|
+
{
|
|
13
|
+
method: 'put',
|
|
14
|
+
urlRegex: new RegExp('^/service/v1/serviceJobs/[^/]*/cancellations$'),
|
|
15
|
+
rate: 5,
|
|
16
|
+
burst: 20,
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
method: 'put',
|
|
20
|
+
urlRegex: new RegExp('^/service/v1/serviceJobs/[^/]*/completions$'),
|
|
21
|
+
rate: 5,
|
|
22
|
+
burst: 20,
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
method: 'get',
|
|
26
|
+
urlRegex: new RegExp('^/service/v1/serviceJobs$'),
|
|
27
|
+
rate: 10,
|
|
28
|
+
burst: 40,
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
method: 'post',
|
|
32
|
+
urlRegex: new RegExp('^/service/v1/serviceJobs/[^/]*/appointments$'),
|
|
33
|
+
rate: 5,
|
|
34
|
+
burst: 20,
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
method: 'post',
|
|
38
|
+
urlRegex: new RegExp('^/service/v1/serviceJobs/[^/]*$'),
|
|
39
|
+
rate: 5,
|
|
40
|
+
burst: 20,
|
|
41
|
+
},
|
|
42
|
+
];
|
|
43
|
+
export class ServicesApiClient extends ServiceApi {
|
|
44
|
+
constructor(parameters) {
|
|
45
|
+
const region = awsRegionByCode[parameters.region] ?? parameters.region;
|
|
46
|
+
const { rateLimiting, ...clientParameters } = parameters;
|
|
47
|
+
const axiosParameters = { ...clientParameters, region };
|
|
48
|
+
if (rateLimiting?.retry) {
|
|
49
|
+
axiosParameters.rateLimits = RATE_LIMITS;
|
|
50
|
+
axiosParameters.onRetry = rateLimiting.onRetry;
|
|
51
|
+
}
|
|
52
|
+
const axiosInstance = createAxiosInstance(axiosParameters);
|
|
53
|
+
const configuration = new Configuration();
|
|
54
|
+
const environment = parameters.sandbox ? 'sandbox' : 'production';
|
|
55
|
+
const endpoint = endpoints[environment][region];
|
|
56
|
+
if (!endpoint) {
|
|
57
|
+
throw new ServicesApiError(`Unknown region : ${region}`);
|
|
58
|
+
}
|
|
59
|
+
super(configuration, endpoint, axiosInstance);
|
|
60
|
+
}
|
|
61
|
+
}
|
|
@@ -0,0 +1,443 @@
|
|
|
1
|
+
/**
|
|
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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v1
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { AxiosPromise, AxiosInstance } from 'axios';
|
|
13
|
+
import { Configuration } from '../configuration';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { AddAppointmentRequest } from '../models';
|
|
16
|
+
import { CancelServiceJobByServiceJobIdResponse } from '../models';
|
|
17
|
+
import { CompleteServiceJobByServiceJobIdResponse } from '../models';
|
|
18
|
+
import { GetServiceJobByServiceJobIdResponse } from '../models';
|
|
19
|
+
import { GetServiceJobsResponse } from '../models';
|
|
20
|
+
import { RescheduleAppointmentRequest } from '../models';
|
|
21
|
+
import { SetAppointmentResponse } from '../models';
|
|
22
|
+
/**
|
|
23
|
+
* ServiceApi - axios parameter creator
|
|
24
|
+
* @export
|
|
25
|
+
*/
|
|
26
|
+
export declare const ServiceApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
27
|
+
/**
|
|
28
|
+
* Adds an appointment to the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
29
|
+
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
30
|
+
* @param {AddAppointmentRequest} body Add appointment operation input details.
|
|
31
|
+
* @param {*} [options] Override http request option.
|
|
32
|
+
* @throws {RequiredError}
|
|
33
|
+
*/
|
|
34
|
+
addAppointmentForServiceJobByServiceJobId: (serviceJobId: string, body: AddAppointmentRequest, options?: any) => Promise<RequestArgs>;
|
|
35
|
+
/**
|
|
36
|
+
* Cancels the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
37
|
+
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
38
|
+
* @param {string} cancellationReasonCode A cancel reason code that specifies the reason for cancelling a service job.
|
|
39
|
+
* @param {*} [options] Override http request option.
|
|
40
|
+
* @throws {RequiredError}
|
|
41
|
+
*/
|
|
42
|
+
cancelServiceJobByServiceJobId: (serviceJobId: string, cancellationReasonCode: string, options?: any) => Promise<RequestArgs>;
|
|
43
|
+
/**
|
|
44
|
+
* Completes the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
45
|
+
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
46
|
+
* @param {*} [options] Override http request option.
|
|
47
|
+
* @throws {RequiredError}
|
|
48
|
+
*/
|
|
49
|
+
completeServiceJobByServiceJobId: (serviceJobId: string, options?: any) => Promise<RequestArgs>;
|
|
50
|
+
/**
|
|
51
|
+
* Gets service job details for the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 20 | 40 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
52
|
+
* @param {string} serviceJobId A service job identifier.
|
|
53
|
+
* @param {*} [options] Override http request option.
|
|
54
|
+
* @throws {RequiredError}
|
|
55
|
+
*/
|
|
56
|
+
getServiceJobByServiceJobId: (serviceJobId: string, options?: any) => Promise<RequestArgs>;
|
|
57
|
+
/**
|
|
58
|
+
* Gets service job details for the specified filter query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 40 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
59
|
+
* @param {Array<string>} marketplaceIds Used to select jobs that were placed in the specified marketplaces.
|
|
60
|
+
* @param {Array<string>} [serviceOrderIds] List of service order ids for the query you want to perform.Max values supported 20.
|
|
61
|
+
* @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.
|
|
62
|
+
* @param {string} [pageToken] String returned in the response of your previous request.
|
|
63
|
+
* @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
|
+
* @param {'JOB_DATE' | 'JOB_STATUS'} [sortField] Sort fields on which you want to sort the output.
|
|
65
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort order for the query you want to perform.
|
|
66
|
+
* @param {string} [createdAfter] A date used for selecting jobs created after (or at) a specified time must be in ISO 8601 format. Required if LastUpdatedAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error.
|
|
67
|
+
* @param {string} [createdBefore] A date used for selecting jobs created before (or at) a specified time must be in ISO 8601 format.
|
|
68
|
+
* @param {string} [lastUpdatedAfter] A date used for selecting jobs updated after (or at) a specified time must be in ISO 8601 format. Required if createdAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error.
|
|
69
|
+
* @param {string} [lastUpdatedBefore] A date used for selecting jobs updated before (or at) a specified time must be in ISO 8601 format.
|
|
70
|
+
* @param {string} [scheduleStartDate] A date used for filtering jobs schedule after (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date.
|
|
71
|
+
* @param {string} [scheduleEndDate] A date used for filtering jobs schedule before (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date.
|
|
72
|
+
* @param {*} [options] Override http request option.
|
|
73
|
+
* @throws {RequiredError}
|
|
74
|
+
*/
|
|
75
|
+
getServiceJobs: (marketplaceIds: Array<string>, serviceOrderIds?: string[] | undefined, serviceJobStatus?: ("NOT_SERVICED" | "CANCELLED" | "COMPLETED" | "PENDING_SCHEDULE" | "NOT_FULFILLABLE" | "HOLD" | "PAYMENT_DECLINED")[] | undefined, pageToken?: string | undefined, pageSize?: number | undefined, sortField?: "JOB_DATE" | "JOB_STATUS" | undefined, sortOrder?: "ASC" | "DESC" | undefined, createdAfter?: string | undefined, createdBefore?: string | undefined, lastUpdatedAfter?: string | undefined, lastUpdatedBefore?: string | undefined, scheduleStartDate?: string | undefined, scheduleEndDate?: string | undefined, options?: any) => Promise<RequestArgs>;
|
|
76
|
+
/**
|
|
77
|
+
* Reschedules an appointment for the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
78
|
+
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
79
|
+
* @param {string} appointmentId An existing appointment identifier for the Service Job.
|
|
80
|
+
* @param {RescheduleAppointmentRequest} body Reschedule appointment operation input details.
|
|
81
|
+
* @param {*} [options] Override http request option.
|
|
82
|
+
* @throws {RequiredError}
|
|
83
|
+
*/
|
|
84
|
+
rescheduleAppointmentForServiceJobByServiceJobId: (serviceJobId: string, appointmentId: string, body: RescheduleAppointmentRequest, options?: any) => Promise<RequestArgs>;
|
|
85
|
+
};
|
|
86
|
+
/**
|
|
87
|
+
* ServiceApi - functional programming interface
|
|
88
|
+
* @export
|
|
89
|
+
*/
|
|
90
|
+
export declare const ServiceApiFp: (configuration?: Configuration | undefined) => {
|
|
91
|
+
/**
|
|
92
|
+
* Adds an appointment to the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
93
|
+
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
94
|
+
* @param {AddAppointmentRequest} body Add appointment operation input details.
|
|
95
|
+
* @param {*} [options] Override http request option.
|
|
96
|
+
* @throws {RequiredError}
|
|
97
|
+
*/
|
|
98
|
+
addAppointmentForServiceJobByServiceJobId(serviceJobId: string, body: AddAppointmentRequest, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SetAppointmentResponse>>;
|
|
99
|
+
/**
|
|
100
|
+
* Cancels the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
101
|
+
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
102
|
+
* @param {string} cancellationReasonCode A cancel reason code that specifies the reason for cancelling a service job.
|
|
103
|
+
* @param {*} [options] Override http request option.
|
|
104
|
+
* @throws {RequiredError}
|
|
105
|
+
*/
|
|
106
|
+
cancelServiceJobByServiceJobId(serviceJobId: string, cancellationReasonCode: string, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<CancelServiceJobByServiceJobIdResponse>>;
|
|
107
|
+
/**
|
|
108
|
+
* Completes the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
109
|
+
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
110
|
+
* @param {*} [options] Override http request option.
|
|
111
|
+
* @throws {RequiredError}
|
|
112
|
+
*/
|
|
113
|
+
completeServiceJobByServiceJobId(serviceJobId: string, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<CompleteServiceJobByServiceJobIdResponse>>;
|
|
114
|
+
/**
|
|
115
|
+
* Gets service job details for the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 20 | 40 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
116
|
+
* @param {string} serviceJobId A service job identifier.
|
|
117
|
+
* @param {*} [options] Override http request option.
|
|
118
|
+
* @throws {RequiredError}
|
|
119
|
+
*/
|
|
120
|
+
getServiceJobByServiceJobId(serviceJobId: string, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetServiceJobByServiceJobIdResponse>>;
|
|
121
|
+
/**
|
|
122
|
+
* Gets service job details for the specified filter query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 40 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
123
|
+
* @param {Array<string>} marketplaceIds Used to select jobs that were placed in the specified marketplaces.
|
|
124
|
+
* @param {Array<string>} [serviceOrderIds] List of service order ids for the query you want to perform.Max values supported 20.
|
|
125
|
+
* @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.
|
|
126
|
+
* @param {string} [pageToken] String returned in the response of your previous request.
|
|
127
|
+
* @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
|
+
* @param {'JOB_DATE' | 'JOB_STATUS'} [sortField] Sort fields on which you want to sort the output.
|
|
129
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort order for the query you want to perform.
|
|
130
|
+
* @param {string} [createdAfter] A date used for selecting jobs created after (or at) a specified time must be in ISO 8601 format. Required if LastUpdatedAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error.
|
|
131
|
+
* @param {string} [createdBefore] A date used for selecting jobs created before (or at) a specified time must be in ISO 8601 format.
|
|
132
|
+
* @param {string} [lastUpdatedAfter] A date used for selecting jobs updated after (or at) a specified time must be in ISO 8601 format. Required if createdAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error.
|
|
133
|
+
* @param {string} [lastUpdatedBefore] A date used for selecting jobs updated before (or at) a specified time must be in ISO 8601 format.
|
|
134
|
+
* @param {string} [scheduleStartDate] A date used for filtering jobs schedule after (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date.
|
|
135
|
+
* @param {string} [scheduleEndDate] A date used for filtering jobs schedule before (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date.
|
|
136
|
+
* @param {*} [options] Override http request option.
|
|
137
|
+
* @throws {RequiredError}
|
|
138
|
+
*/
|
|
139
|
+
getServiceJobs(marketplaceIds: Array<string>, serviceOrderIds?: string[] | undefined, serviceJobStatus?: ("NOT_SERVICED" | "CANCELLED" | "COMPLETED" | "PENDING_SCHEDULE" | "NOT_FULFILLABLE" | "HOLD" | "PAYMENT_DECLINED")[] | undefined, pageToken?: string | undefined, pageSize?: number | undefined, sortField?: "JOB_DATE" | "JOB_STATUS" | undefined, sortOrder?: "ASC" | "DESC" | undefined, createdAfter?: string | undefined, createdBefore?: string | undefined, lastUpdatedAfter?: string | undefined, lastUpdatedBefore?: string | undefined, scheduleStartDate?: string | undefined, scheduleEndDate?: string | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetServiceJobsResponse>>;
|
|
140
|
+
/**
|
|
141
|
+
* Reschedules an appointment for the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
142
|
+
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
143
|
+
* @param {string} appointmentId An existing appointment identifier for the Service Job.
|
|
144
|
+
* @param {RescheduleAppointmentRequest} body Reschedule appointment operation input details.
|
|
145
|
+
* @param {*} [options] Override http request option.
|
|
146
|
+
* @throws {RequiredError}
|
|
147
|
+
*/
|
|
148
|
+
rescheduleAppointmentForServiceJobByServiceJobId(serviceJobId: string, appointmentId: string, body: RescheduleAppointmentRequest, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SetAppointmentResponse>>;
|
|
149
|
+
};
|
|
150
|
+
/**
|
|
151
|
+
* ServiceApi - factory interface
|
|
152
|
+
* @export
|
|
153
|
+
*/
|
|
154
|
+
export declare const ServiceApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
155
|
+
/**
|
|
156
|
+
* Adds an appointment to the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
157
|
+
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
158
|
+
* @param {AddAppointmentRequest} body Add appointment operation input details.
|
|
159
|
+
* @param {*} [options] Override http request option.
|
|
160
|
+
* @throws {RequiredError}
|
|
161
|
+
*/
|
|
162
|
+
addAppointmentForServiceJobByServiceJobId(serviceJobId: string, body: AddAppointmentRequest, options?: any): AxiosPromise<SetAppointmentResponse>;
|
|
163
|
+
/**
|
|
164
|
+
* Cancels the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
165
|
+
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
166
|
+
* @param {string} cancellationReasonCode A cancel reason code that specifies the reason for cancelling a service job.
|
|
167
|
+
* @param {*} [options] Override http request option.
|
|
168
|
+
* @throws {RequiredError}
|
|
169
|
+
*/
|
|
170
|
+
cancelServiceJobByServiceJobId(serviceJobId: string, cancellationReasonCode: string, options?: any): AxiosPromise<CancelServiceJobByServiceJobIdResponse>;
|
|
171
|
+
/**
|
|
172
|
+
* Completes the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
173
|
+
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
174
|
+
* @param {*} [options] Override http request option.
|
|
175
|
+
* @throws {RequiredError}
|
|
176
|
+
*/
|
|
177
|
+
completeServiceJobByServiceJobId(serviceJobId: string, options?: any): AxiosPromise<CompleteServiceJobByServiceJobIdResponse>;
|
|
178
|
+
/**
|
|
179
|
+
* Gets service job details for the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 20 | 40 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
180
|
+
* @param {string} serviceJobId A service job identifier.
|
|
181
|
+
* @param {*} [options] Override http request option.
|
|
182
|
+
* @throws {RequiredError}
|
|
183
|
+
*/
|
|
184
|
+
getServiceJobByServiceJobId(serviceJobId: string, options?: any): AxiosPromise<GetServiceJobByServiceJobIdResponse>;
|
|
185
|
+
/**
|
|
186
|
+
* Gets service job details for the specified filter query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 40 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
187
|
+
* @param {Array<string>} marketplaceIds Used to select jobs that were placed in the specified marketplaces.
|
|
188
|
+
* @param {Array<string>} [serviceOrderIds] List of service order ids for the query you want to perform.Max values supported 20.
|
|
189
|
+
* @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.
|
|
190
|
+
* @param {string} [pageToken] String returned in the response of your previous request.
|
|
191
|
+
* @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
|
+
* @param {'JOB_DATE' | 'JOB_STATUS'} [sortField] Sort fields on which you want to sort the output.
|
|
193
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort order for the query you want to perform.
|
|
194
|
+
* @param {string} [createdAfter] A date used for selecting jobs created after (or at) a specified time must be in ISO 8601 format. Required if LastUpdatedAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error.
|
|
195
|
+
* @param {string} [createdBefore] A date used for selecting jobs created before (or at) a specified time must be in ISO 8601 format.
|
|
196
|
+
* @param {string} [lastUpdatedAfter] A date used for selecting jobs updated after (or at) a specified time must be in ISO 8601 format. Required if createdAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error.
|
|
197
|
+
* @param {string} [lastUpdatedBefore] A date used for selecting jobs updated before (or at) a specified time must be in ISO 8601 format.
|
|
198
|
+
* @param {string} [scheduleStartDate] A date used for filtering jobs schedule after (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date.
|
|
199
|
+
* @param {string} [scheduleEndDate] A date used for filtering jobs schedule before (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date.
|
|
200
|
+
* @param {*} [options] Override http request option.
|
|
201
|
+
* @throws {RequiredError}
|
|
202
|
+
*/
|
|
203
|
+
getServiceJobs(marketplaceIds: Array<string>, serviceOrderIds?: string[] | undefined, serviceJobStatus?: ("NOT_SERVICED" | "CANCELLED" | "COMPLETED" | "PENDING_SCHEDULE" | "NOT_FULFILLABLE" | "HOLD" | "PAYMENT_DECLINED")[] | undefined, pageToken?: string | undefined, pageSize?: number | undefined, sortField?: "JOB_DATE" | "JOB_STATUS" | undefined, sortOrder?: "ASC" | "DESC" | undefined, createdAfter?: string | undefined, createdBefore?: string | undefined, lastUpdatedAfter?: string | undefined, lastUpdatedBefore?: string | undefined, scheduleStartDate?: string | undefined, scheduleEndDate?: string | undefined, options?: any): AxiosPromise<GetServiceJobsResponse>;
|
|
204
|
+
/**
|
|
205
|
+
* Reschedules an appointment for the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
206
|
+
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
207
|
+
* @param {string} appointmentId An existing appointment identifier for the Service Job.
|
|
208
|
+
* @param {RescheduleAppointmentRequest} body Reschedule appointment operation input details.
|
|
209
|
+
* @param {*} [options] Override http request option.
|
|
210
|
+
* @throws {RequiredError}
|
|
211
|
+
*/
|
|
212
|
+
rescheduleAppointmentForServiceJobByServiceJobId(serviceJobId: string, appointmentId: string, body: RescheduleAppointmentRequest, options?: any): AxiosPromise<SetAppointmentResponse>;
|
|
213
|
+
};
|
|
214
|
+
/**
|
|
215
|
+
* Request parameters for addAppointmentForServiceJobByServiceJobId operation in ServiceApi.
|
|
216
|
+
* @export
|
|
217
|
+
* @interface ServiceApiAddAppointmentForServiceJobByServiceJobIdRequest
|
|
218
|
+
*/
|
|
219
|
+
export interface ServiceApiAddAppointmentForServiceJobByServiceJobIdRequest {
|
|
220
|
+
/**
|
|
221
|
+
* An Amazon defined service job identifier.
|
|
222
|
+
* @type {string}
|
|
223
|
+
* @memberof ServiceApiAddAppointmentForServiceJobByServiceJobId
|
|
224
|
+
*/
|
|
225
|
+
readonly serviceJobId: string;
|
|
226
|
+
/**
|
|
227
|
+
* Add appointment operation input details.
|
|
228
|
+
* @type {AddAppointmentRequest}
|
|
229
|
+
* @memberof ServiceApiAddAppointmentForServiceJobByServiceJobId
|
|
230
|
+
*/
|
|
231
|
+
readonly body: AddAppointmentRequest;
|
|
232
|
+
}
|
|
233
|
+
/**
|
|
234
|
+
* Request parameters for cancelServiceJobByServiceJobId operation in ServiceApi.
|
|
235
|
+
* @export
|
|
236
|
+
* @interface ServiceApiCancelServiceJobByServiceJobIdRequest
|
|
237
|
+
*/
|
|
238
|
+
export interface ServiceApiCancelServiceJobByServiceJobIdRequest {
|
|
239
|
+
/**
|
|
240
|
+
* An Amazon defined service job identifier.
|
|
241
|
+
* @type {string}
|
|
242
|
+
* @memberof ServiceApiCancelServiceJobByServiceJobId
|
|
243
|
+
*/
|
|
244
|
+
readonly serviceJobId: string;
|
|
245
|
+
/**
|
|
246
|
+
* A cancel reason code that specifies the reason for cancelling a service job.
|
|
247
|
+
* @type {string}
|
|
248
|
+
* @memberof ServiceApiCancelServiceJobByServiceJobId
|
|
249
|
+
*/
|
|
250
|
+
readonly cancellationReasonCode: string;
|
|
251
|
+
}
|
|
252
|
+
/**
|
|
253
|
+
* Request parameters for completeServiceJobByServiceJobId operation in ServiceApi.
|
|
254
|
+
* @export
|
|
255
|
+
* @interface ServiceApiCompleteServiceJobByServiceJobIdRequest
|
|
256
|
+
*/
|
|
257
|
+
export interface ServiceApiCompleteServiceJobByServiceJobIdRequest {
|
|
258
|
+
/**
|
|
259
|
+
* An Amazon defined service job identifier.
|
|
260
|
+
* @type {string}
|
|
261
|
+
* @memberof ServiceApiCompleteServiceJobByServiceJobId
|
|
262
|
+
*/
|
|
263
|
+
readonly serviceJobId: string;
|
|
264
|
+
}
|
|
265
|
+
/**
|
|
266
|
+
* Request parameters for getServiceJobByServiceJobId operation in ServiceApi.
|
|
267
|
+
* @export
|
|
268
|
+
* @interface ServiceApiGetServiceJobByServiceJobIdRequest
|
|
269
|
+
*/
|
|
270
|
+
export interface ServiceApiGetServiceJobByServiceJobIdRequest {
|
|
271
|
+
/**
|
|
272
|
+
* A service job identifier.
|
|
273
|
+
* @type {string}
|
|
274
|
+
* @memberof ServiceApiGetServiceJobByServiceJobId
|
|
275
|
+
*/
|
|
276
|
+
readonly serviceJobId: string;
|
|
277
|
+
}
|
|
278
|
+
/**
|
|
279
|
+
* Request parameters for getServiceJobs operation in ServiceApi.
|
|
280
|
+
* @export
|
|
281
|
+
* @interface ServiceApiGetServiceJobsRequest
|
|
282
|
+
*/
|
|
283
|
+
export interface ServiceApiGetServiceJobsRequest {
|
|
284
|
+
/**
|
|
285
|
+
* Used to select jobs that were placed in the specified marketplaces.
|
|
286
|
+
* @type {Array<string>}
|
|
287
|
+
* @memberof ServiceApiGetServiceJobs
|
|
288
|
+
*/
|
|
289
|
+
readonly marketplaceIds: Array<string>;
|
|
290
|
+
/**
|
|
291
|
+
* List of service order ids for the query you want to perform.Max values supported 20.
|
|
292
|
+
* @type {Array<string>}
|
|
293
|
+
* @memberof ServiceApiGetServiceJobs
|
|
294
|
+
*/
|
|
295
|
+
readonly serviceOrderIds?: Array<string>;
|
|
296
|
+
/**
|
|
297
|
+
* A list of one or more job status by which to filter the list of jobs.
|
|
298
|
+
* @type {Array<'NOT_SERVICED' | 'CANCELLED' | 'COMPLETED' | 'PENDING_SCHEDULE' | 'NOT_FULFILLABLE' | 'HOLD' | 'PAYMENT_DECLINED'>}
|
|
299
|
+
* @memberof ServiceApiGetServiceJobs
|
|
300
|
+
*/
|
|
301
|
+
readonly serviceJobStatus?: Array<'NOT_SERVICED' | 'CANCELLED' | 'COMPLETED' | 'PENDING_SCHEDULE' | 'NOT_FULFILLABLE' | 'HOLD' | 'PAYMENT_DECLINED'>;
|
|
302
|
+
/**
|
|
303
|
+
* String returned in the response of your previous request.
|
|
304
|
+
* @type {string}
|
|
305
|
+
* @memberof ServiceApiGetServiceJobs
|
|
306
|
+
*/
|
|
307
|
+
readonly pageToken?: string;
|
|
308
|
+
/**
|
|
309
|
+
* A non-negative integer that indicates the maximum number of jobs to return in the list, Value must be 1 - 20. Default 20.
|
|
310
|
+
* @type {number}
|
|
311
|
+
* @memberof ServiceApiGetServiceJobs
|
|
312
|
+
*/
|
|
313
|
+
readonly pageSize?: number;
|
|
314
|
+
/**
|
|
315
|
+
* Sort fields on which you want to sort the output.
|
|
316
|
+
* @type {'JOB_DATE' | 'JOB_STATUS'}
|
|
317
|
+
* @memberof ServiceApiGetServiceJobs
|
|
318
|
+
*/
|
|
319
|
+
readonly sortField?: 'JOB_DATE' | 'JOB_STATUS';
|
|
320
|
+
/**
|
|
321
|
+
* Sort order for the query you want to perform.
|
|
322
|
+
* @type {'ASC' | 'DESC'}
|
|
323
|
+
* @memberof ServiceApiGetServiceJobs
|
|
324
|
+
*/
|
|
325
|
+
readonly sortOrder?: 'ASC' | 'DESC';
|
|
326
|
+
/**
|
|
327
|
+
* A date used for selecting jobs created after (or at) a specified time must be in ISO 8601 format. Required if LastUpdatedAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error.
|
|
328
|
+
* @type {string}
|
|
329
|
+
* @memberof ServiceApiGetServiceJobs
|
|
330
|
+
*/
|
|
331
|
+
readonly createdAfter?: string;
|
|
332
|
+
/**
|
|
333
|
+
* A date used for selecting jobs created before (or at) a specified time must be in ISO 8601 format.
|
|
334
|
+
* @type {string}
|
|
335
|
+
* @memberof ServiceApiGetServiceJobs
|
|
336
|
+
*/
|
|
337
|
+
readonly createdBefore?: string;
|
|
338
|
+
/**
|
|
339
|
+
* A date used for selecting jobs updated after (or at) a specified time must be in ISO 8601 format. Required if createdAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error.
|
|
340
|
+
* @type {string}
|
|
341
|
+
* @memberof ServiceApiGetServiceJobs
|
|
342
|
+
*/
|
|
343
|
+
readonly lastUpdatedAfter?: string;
|
|
344
|
+
/**
|
|
345
|
+
* A date used for selecting jobs updated before (or at) a specified time must be in ISO 8601 format.
|
|
346
|
+
* @type {string}
|
|
347
|
+
* @memberof ServiceApiGetServiceJobs
|
|
348
|
+
*/
|
|
349
|
+
readonly lastUpdatedBefore?: string;
|
|
350
|
+
/**
|
|
351
|
+
* A date used for filtering jobs schedule after (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date.
|
|
352
|
+
* @type {string}
|
|
353
|
+
* @memberof ServiceApiGetServiceJobs
|
|
354
|
+
*/
|
|
355
|
+
readonly scheduleStartDate?: string;
|
|
356
|
+
/**
|
|
357
|
+
* A date used for filtering jobs schedule before (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date.
|
|
358
|
+
* @type {string}
|
|
359
|
+
* @memberof ServiceApiGetServiceJobs
|
|
360
|
+
*/
|
|
361
|
+
readonly scheduleEndDate?: string;
|
|
362
|
+
}
|
|
363
|
+
/**
|
|
364
|
+
* Request parameters for rescheduleAppointmentForServiceJobByServiceJobId operation in ServiceApi.
|
|
365
|
+
* @export
|
|
366
|
+
* @interface ServiceApiRescheduleAppointmentForServiceJobByServiceJobIdRequest
|
|
367
|
+
*/
|
|
368
|
+
export interface ServiceApiRescheduleAppointmentForServiceJobByServiceJobIdRequest {
|
|
369
|
+
/**
|
|
370
|
+
* An Amazon defined service job identifier.
|
|
371
|
+
* @type {string}
|
|
372
|
+
* @memberof ServiceApiRescheduleAppointmentForServiceJobByServiceJobId
|
|
373
|
+
*/
|
|
374
|
+
readonly serviceJobId: string;
|
|
375
|
+
/**
|
|
376
|
+
* An existing appointment identifier for the Service Job.
|
|
377
|
+
* @type {string}
|
|
378
|
+
* @memberof ServiceApiRescheduleAppointmentForServiceJobByServiceJobId
|
|
379
|
+
*/
|
|
380
|
+
readonly appointmentId: string;
|
|
381
|
+
/**
|
|
382
|
+
* Reschedule appointment operation input details.
|
|
383
|
+
* @type {RescheduleAppointmentRequest}
|
|
384
|
+
* @memberof ServiceApiRescheduleAppointmentForServiceJobByServiceJobId
|
|
385
|
+
*/
|
|
386
|
+
readonly body: RescheduleAppointmentRequest;
|
|
387
|
+
}
|
|
388
|
+
/**
|
|
389
|
+
* ServiceApi - object-oriented interface
|
|
390
|
+
* @export
|
|
391
|
+
* @class ServiceApi
|
|
392
|
+
* @extends {BaseAPI}
|
|
393
|
+
*/
|
|
394
|
+
export declare class ServiceApi extends BaseAPI {
|
|
395
|
+
/**
|
|
396
|
+
* Adds an appointment to the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
397
|
+
* @param {ServiceApiAddAppointmentForServiceJobByServiceJobIdRequest} requestParameters Request parameters.
|
|
398
|
+
* @param {*} [options] Override http request option.
|
|
399
|
+
* @throws {RequiredError}
|
|
400
|
+
* @memberof ServiceApi
|
|
401
|
+
*/
|
|
402
|
+
addAppointmentForServiceJobByServiceJobId(requestParameters: ServiceApiAddAppointmentForServiceJobByServiceJobIdRequest, options?: any): Promise<import("axios").AxiosResponse<SetAppointmentResponse>>;
|
|
403
|
+
/**
|
|
404
|
+
* Cancels the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
405
|
+
* @param {ServiceApiCancelServiceJobByServiceJobIdRequest} requestParameters Request parameters.
|
|
406
|
+
* @param {*} [options] Override http request option.
|
|
407
|
+
* @throws {RequiredError}
|
|
408
|
+
* @memberof ServiceApi
|
|
409
|
+
*/
|
|
410
|
+
cancelServiceJobByServiceJobId(requestParameters: ServiceApiCancelServiceJobByServiceJobIdRequest, options?: any): Promise<import("axios").AxiosResponse<CancelServiceJobByServiceJobIdResponse>>;
|
|
411
|
+
/**
|
|
412
|
+
* Completes the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
413
|
+
* @param {ServiceApiCompleteServiceJobByServiceJobIdRequest} requestParameters Request parameters.
|
|
414
|
+
* @param {*} [options] Override http request option.
|
|
415
|
+
* @throws {RequiredError}
|
|
416
|
+
* @memberof ServiceApi
|
|
417
|
+
*/
|
|
418
|
+
completeServiceJobByServiceJobId(requestParameters: ServiceApiCompleteServiceJobByServiceJobIdRequest, options?: any): Promise<import("axios").AxiosResponse<CompleteServiceJobByServiceJobIdResponse>>;
|
|
419
|
+
/**
|
|
420
|
+
* Gets service job details for the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 20 | 40 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
421
|
+
* @param {ServiceApiGetServiceJobByServiceJobIdRequest} requestParameters Request parameters.
|
|
422
|
+
* @param {*} [options] Override http request option.
|
|
423
|
+
* @throws {RequiredError}
|
|
424
|
+
* @memberof ServiceApi
|
|
425
|
+
*/
|
|
426
|
+
getServiceJobByServiceJobId(requestParameters: ServiceApiGetServiceJobByServiceJobIdRequest, options?: any): Promise<import("axios").AxiosResponse<GetServiceJobByServiceJobIdResponse>>;
|
|
427
|
+
/**
|
|
428
|
+
* Gets service job details for the specified filter query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 40 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
429
|
+
* @param {ServiceApiGetServiceJobsRequest} requestParameters Request parameters.
|
|
430
|
+
* @param {*} [options] Override http request option.
|
|
431
|
+
* @throws {RequiredError}
|
|
432
|
+
* @memberof ServiceApi
|
|
433
|
+
*/
|
|
434
|
+
getServiceJobs(requestParameters: ServiceApiGetServiceJobsRequest, options?: any): Promise<import("axios").AxiosResponse<GetServiceJobsResponse>>;
|
|
435
|
+
/**
|
|
436
|
+
* Reschedules an appointment for the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
437
|
+
* @param {ServiceApiRescheduleAppointmentForServiceJobByServiceJobIdRequest} requestParameters Request parameters.
|
|
438
|
+
* @param {*} [options] Override http request option.
|
|
439
|
+
* @throws {RequiredError}
|
|
440
|
+
* @memberof ServiceApi
|
|
441
|
+
*/
|
|
442
|
+
rescheduleAppointmentForServiceJobByServiceJobId(requestParameters: ServiceApiRescheduleAppointmentForServiceJobByServiceJobIdRequest, options?: any): Promise<import("axios").AxiosResponse<SetAppointmentResponse>>;
|
|
443
|
+
}
|