@sp-api-sdk/services-api-v1 1.8.5 → 1.8.8
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.
|
@@ -23,7 +23,7 @@ import { SetAppointmentResponse } from '../models';
|
|
|
23
23
|
* ServiceApi - axios parameter creator
|
|
24
24
|
* @export
|
|
25
25
|
*/
|
|
26
|
-
export declare const ServiceApiAxiosParamCreator: (configuration?: Configuration
|
|
26
|
+
export declare const ServiceApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
27
27
|
/**
|
|
28
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
29
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
@@ -72,7 +72,7 @@ export declare const ServiceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
72
72
|
* @param {*} [options] Override http request option.
|
|
73
73
|
* @throws {RequiredError}
|
|
74
74
|
*/
|
|
75
|
-
getServiceJobs: (marketplaceIds: Array<string>, serviceOrderIds?: string
|
|
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>;
|
|
76
76
|
/**
|
|
77
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
78
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
@@ -87,7 +87,7 @@ export declare const ServiceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
87
87
|
* ServiceApi - functional programming interface
|
|
88
88
|
* @export
|
|
89
89
|
*/
|
|
90
|
-
export declare const ServiceApiFp: (configuration?: Configuration
|
|
90
|
+
export declare const ServiceApiFp: (configuration?: Configuration) => {
|
|
91
91
|
/**
|
|
92
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
93
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
@@ -95,7 +95,7 @@ export declare const ServiceApiFp: (configuration?: Configuration | undefined) =
|
|
|
95
95
|
* @param {*} [options] Override http request option.
|
|
96
96
|
* @throws {RequiredError}
|
|
97
97
|
*/
|
|
98
|
-
addAppointmentForServiceJobByServiceJobId(serviceJobId: string, body: AddAppointmentRequest, options?: AxiosRequestConfig
|
|
98
|
+
addAppointmentForServiceJobByServiceJobId(serviceJobId: string, body: AddAppointmentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetAppointmentResponse>>;
|
|
99
99
|
/**
|
|
100
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
101
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
@@ -103,21 +103,21 @@ export declare const ServiceApiFp: (configuration?: Configuration | undefined) =
|
|
|
103
103
|
* @param {*} [options] Override http request option.
|
|
104
104
|
* @throws {RequiredError}
|
|
105
105
|
*/
|
|
106
|
-
cancelServiceJobByServiceJobId(serviceJobId: string, cancellationReasonCode: string, options?: AxiosRequestConfig
|
|
106
|
+
cancelServiceJobByServiceJobId(serviceJobId: string, cancellationReasonCode: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelServiceJobByServiceJobIdResponse>>;
|
|
107
107
|
/**
|
|
108
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
109
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
110
110
|
* @param {*} [options] Override http request option.
|
|
111
111
|
* @throws {RequiredError}
|
|
112
112
|
*/
|
|
113
|
-
completeServiceJobByServiceJobId(serviceJobId: string, options?: AxiosRequestConfig
|
|
113
|
+
completeServiceJobByServiceJobId(serviceJobId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompleteServiceJobByServiceJobIdResponse>>;
|
|
114
114
|
/**
|
|
115
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
116
|
* @param {string} serviceJobId A service job identifier.
|
|
117
117
|
* @param {*} [options] Override http request option.
|
|
118
118
|
* @throws {RequiredError}
|
|
119
119
|
*/
|
|
120
|
-
getServiceJobByServiceJobId(serviceJobId: string, options?: AxiosRequestConfig
|
|
120
|
+
getServiceJobByServiceJobId(serviceJobId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetServiceJobByServiceJobIdResponse>>;
|
|
121
121
|
/**
|
|
122
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
123
|
* @param {Array<string>} marketplaceIds Used to select jobs that were placed in the specified marketplaces.
|
|
@@ -136,7 +136,7 @@ export declare const ServiceApiFp: (configuration?: Configuration | undefined) =
|
|
|
136
136
|
* @param {*} [options] Override http request option.
|
|
137
137
|
* @throws {RequiredError}
|
|
138
138
|
*/
|
|
139
|
-
getServiceJobs(marketplaceIds: Array<string>, serviceOrderIds?: string
|
|
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>>;
|
|
140
140
|
/**
|
|
141
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
142
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
@@ -145,13 +145,13 @@ export declare const ServiceApiFp: (configuration?: Configuration | undefined) =
|
|
|
145
145
|
* @param {*} [options] Override http request option.
|
|
146
146
|
* @throws {RequiredError}
|
|
147
147
|
*/
|
|
148
|
-
rescheduleAppointmentForServiceJobByServiceJobId(serviceJobId: string, appointmentId: string, body: RescheduleAppointmentRequest, options?: AxiosRequestConfig
|
|
148
|
+
rescheduleAppointmentForServiceJobByServiceJobId(serviceJobId: string, appointmentId: string, body: RescheduleAppointmentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetAppointmentResponse>>;
|
|
149
149
|
};
|
|
150
150
|
/**
|
|
151
151
|
* ServiceApi - factory interface
|
|
152
152
|
* @export
|
|
153
153
|
*/
|
|
154
|
-
export declare const ServiceApiFactory: (configuration?: Configuration
|
|
154
|
+
export declare const ServiceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
155
155
|
/**
|
|
156
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
157
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
@@ -200,7 +200,7 @@ export declare const ServiceApiFactory: (configuration?: Configuration | undefin
|
|
|
200
200
|
* @param {*} [options] Override http request option.
|
|
201
201
|
* @throws {RequiredError}
|
|
202
202
|
*/
|
|
203
|
-
getServiceJobs(marketplaceIds: Array<string>, serviceOrderIds?: string
|
|
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>;
|
|
204
204
|
/**
|
|
205
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
206
|
* @param {string} serviceJobId An Amazon defined service job identifier.
|
|
@@ -27,22 +27,22 @@ export declare const assertParamExists: (functionName: string, paramName: string
|
|
|
27
27
|
*
|
|
28
28
|
* @export
|
|
29
29
|
*/
|
|
30
|
-
export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration
|
|
30
|
+
export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
|
|
31
31
|
/**
|
|
32
32
|
*
|
|
33
33
|
* @export
|
|
34
34
|
*/
|
|
35
|
-
export declare const setBasicAuthToObject: (object: any, configuration?: Configuration
|
|
35
|
+
export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
|
|
36
36
|
/**
|
|
37
37
|
*
|
|
38
38
|
* @export
|
|
39
39
|
*/
|
|
40
|
-
export declare const setBearerAuthToObject: (object: any, configuration?: Configuration
|
|
40
|
+
export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
|
|
41
41
|
/**
|
|
42
42
|
*
|
|
43
43
|
* @export
|
|
44
44
|
*/
|
|
45
|
-
export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration
|
|
45
|
+
export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
|
|
46
46
|
/**
|
|
47
47
|
*
|
|
48
48
|
* @export
|
|
@@ -52,7 +52,7 @@ export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
|
|
|
52
52
|
*
|
|
53
53
|
* @export
|
|
54
54
|
*/
|
|
55
|
-
export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration
|
|
55
|
+
export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
|
|
56
56
|
/**
|
|
57
57
|
*
|
|
58
58
|
* @export
|
|
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
|
|
|
62
62
|
*
|
|
63
63
|
* @export
|
|
64
64
|
*/
|
|
65
|
-
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
package/package.json
CHANGED
|
@@ -2,11 +2,10 @@
|
|
|
2
2
|
"name": "@sp-api-sdk/services-api-v1",
|
|
3
3
|
"author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
|
|
4
4
|
"description": "With the Services API, you can build applications that help service providers get and modify their service orders.",
|
|
5
|
-
"version": "1.8.
|
|
5
|
+
"version": "1.8.8",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
7
7
|
"module": "dist/es/index.js",
|
|
8
8
|
"types": "dist/types/index.d.ts",
|
|
9
|
-
"typedocMain": "./index.ts",
|
|
10
9
|
"license": "MIT",
|
|
11
10
|
"publishConfig": {
|
|
12
11
|
"access": "public"
|
|
@@ -27,8 +26,8 @@
|
|
|
27
26
|
"test": "jest"
|
|
28
27
|
},
|
|
29
28
|
"dependencies": {
|
|
30
|
-
"@sp-api-sdk/auth": "^1.9.
|
|
31
|
-
"@sp-api-sdk/common": "^1.9.
|
|
29
|
+
"@sp-api-sdk/auth": "^1.9.20",
|
|
30
|
+
"@sp-api-sdk/common": "^1.9.6",
|
|
32
31
|
"axios": "^0.27.2"
|
|
33
32
|
},
|
|
34
33
|
"repository": {
|
|
@@ -50,5 +49,8 @@
|
|
|
50
49
|
"sp sdk",
|
|
51
50
|
"services api"
|
|
52
51
|
],
|
|
53
|
-
"
|
|
52
|
+
"typedoc": {
|
|
53
|
+
"entryPoint": "./index.ts"
|
|
54
|
+
},
|
|
55
|
+
"gitHead": "c28c9ce8bfa10271bba79c0067c5c9f63a5f6dc0"
|
|
54
56
|
}
|