@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.
Files changed (108) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +58 -0
  3. package/dist/cjs/index.js +6 -0
  4. package/dist/cjs/src/api-model/api/service-api.js +505 -0
  5. package/dist/cjs/src/api-model/api.js +17 -0
  6. package/dist/cjs/src/api-model/base.js +62 -0
  7. package/dist/cjs/src/api-model/common.js +137 -0
  8. package/dist/cjs/src/api-model/configuration.js +42 -0
  9. package/dist/cjs/src/api-model/index.js +19 -0
  10. package/dist/cjs/src/api-model/models/add-appointment-request.js +15 -0
  11. package/dist/cjs/src/api-model/models/address.js +15 -0
  12. package/dist/cjs/src/api-model/models/appointment-time-input.js +15 -0
  13. package/dist/cjs/src/api-model/models/appointment-time.js +15 -0
  14. package/dist/cjs/src/api-model/models/appointment.js +26 -0
  15. package/dist/cjs/src/api-model/models/associated-item.js +27 -0
  16. package/dist/cjs/src/api-model/models/buyer.js +15 -0
  17. package/dist/cjs/src/api-model/models/cancel-service-job-by-service-job-id-response.js +15 -0
  18. package/dist/cjs/src/api-model/models/complete-service-job-by-service-job-id-response.js +15 -0
  19. package/dist/cjs/src/api-model/models/get-service-job-by-service-job-id-response.js +15 -0
  20. package/dist/cjs/src/api-model/models/get-service-jobs-response.js +15 -0
  21. package/dist/cjs/src/api-model/models/index.js +28 -0
  22. package/dist/cjs/src/api-model/models/item-delivery-promise.js +15 -0
  23. package/dist/cjs/src/api-model/models/item-delivery.js +15 -0
  24. package/dist/cjs/src/api-model/models/job-listing.js +15 -0
  25. package/dist/cjs/src/api-model/models/model-error.js +25 -0
  26. package/dist/cjs/src/api-model/models/poa.js +27 -0
  27. package/dist/cjs/src/api-model/models/reschedule-appointment-request.js +15 -0
  28. package/dist/cjs/src/api-model/models/scope-of-work.js +15 -0
  29. package/dist/cjs/src/api-model/models/seller.js +15 -0
  30. package/dist/cjs/src/api-model/models/service-job-provider.js +15 -0
  31. package/dist/cjs/src/api-model/models/service-job.js +30 -0
  32. package/dist/cjs/src/api-model/models/service-location.js +26 -0
  33. package/dist/cjs/src/api-model/models/set-appointment-response.js +15 -0
  34. package/dist/cjs/src/api-model/models/technician.js +15 -0
  35. package/dist/cjs/src/api-model/models/warning.js +15 -0
  36. package/dist/cjs/src/client.js +65 -0
  37. package/dist/cjs/src/error.js +10 -0
  38. package/dist/es/index.js +3 -0
  39. package/dist/es/src/api-model/api/service-api.js +497 -0
  40. package/dist/es/src/api-model/api.js +14 -0
  41. package/dist/es/src/api-model/base.js +56 -0
  42. package/dist/es/src/api-model/common.js +125 -0
  43. package/dist/es/src/api-model/configuration.js +38 -0
  44. package/dist/es/src/api-model/index.js +16 -0
  45. package/dist/es/src/api-model/models/add-appointment-request.js +14 -0
  46. package/dist/es/src/api-model/models/address.js +14 -0
  47. package/dist/es/src/api-model/models/appointment-time-input.js +14 -0
  48. package/dist/es/src/api-model/models/appointment-time.js +14 -0
  49. package/dist/es/src/api-model/models/appointment.js +23 -0
  50. package/dist/es/src/api-model/models/associated-item.js +24 -0
  51. package/dist/es/src/api-model/models/buyer.js +14 -0
  52. package/dist/es/src/api-model/models/cancel-service-job-by-service-job-id-response.js +14 -0
  53. package/dist/es/src/api-model/models/complete-service-job-by-service-job-id-response.js +14 -0
  54. package/dist/es/src/api-model/models/get-service-job-by-service-job-id-response.js +14 -0
  55. package/dist/es/src/api-model/models/get-service-jobs-response.js +14 -0
  56. package/dist/es/src/api-model/models/index.js +25 -0
  57. package/dist/es/src/api-model/models/item-delivery-promise.js +14 -0
  58. package/dist/es/src/api-model/models/item-delivery.js +14 -0
  59. package/dist/es/src/api-model/models/job-listing.js +14 -0
  60. package/dist/es/src/api-model/models/model-error.js +22 -0
  61. package/dist/es/src/api-model/models/poa.js +24 -0
  62. package/dist/es/src/api-model/models/reschedule-appointment-request.js +14 -0
  63. package/dist/es/src/api-model/models/scope-of-work.js +14 -0
  64. package/dist/es/src/api-model/models/seller.js +14 -0
  65. package/dist/es/src/api-model/models/service-job-provider.js +14 -0
  66. package/dist/es/src/api-model/models/service-job.js +27 -0
  67. package/dist/es/src/api-model/models/service-location.js +23 -0
  68. package/dist/es/src/api-model/models/set-appointment-response.js +14 -0
  69. package/dist/es/src/api-model/models/technician.js +14 -0
  70. package/dist/es/src/api-model/models/warning.js +14 -0
  71. package/dist/es/src/client.js +61 -0
  72. package/dist/es/src/error.js +6 -0
  73. package/dist/types/index.d.ts +3 -0
  74. package/dist/types/src/api-model/api/service-api.d.ts +443 -0
  75. package/dist/types/src/api-model/api.d.ts +12 -0
  76. package/dist/types/src/api-model/base.d.ts +55 -0
  77. package/dist/types/src/api-model/common.d.ts +65 -0
  78. package/dist/types/src/api-model/configuration.d.ts +83 -0
  79. package/dist/types/src/api-model/index.d.ts +14 -0
  80. package/dist/types/src/api-model/models/add-appointment-request.d.ts +25 -0
  81. package/dist/types/src/api-model/models/address.d.ts +84 -0
  82. package/dist/types/src/api-model/models/appointment-time-input.d.ts +30 -0
  83. package/dist/types/src/api-model/models/appointment-time.d.ts +30 -0
  84. package/dist/types/src/api-model/models/appointment.d.ts +66 -0
  85. package/dist/types/src/api-model/models/associated-item.d.ts +71 -0
  86. package/dist/types/src/api-model/models/buyer.d.ts +42 -0
  87. package/dist/types/src/api-model/models/cancel-service-job-by-service-job-id-response.d.ts +24 -0
  88. package/dist/types/src/api-model/models/complete-service-job-by-service-job-id-response.d.ts +24 -0
  89. package/dist/types/src/api-model/models/get-service-job-by-service-job-id-response.d.ts +31 -0
  90. package/dist/types/src/api-model/models/get-service-jobs-response.d.ts +31 -0
  91. package/dist/types/src/api-model/models/index.d.ts +25 -0
  92. package/dist/types/src/api-model/models/item-delivery-promise.d.ts +30 -0
  93. package/dist/types/src/api-model/models/item-delivery.d.ts +31 -0
  94. package/dist/types/src/api-model/models/job-listing.d.ts +43 -0
  95. package/dist/types/src/api-model/models/model-error.d.ts +50 -0
  96. package/dist/types/src/api-model/models/poa.d.ts +60 -0
  97. package/dist/types/src/api-model/models/reschedule-appointment-request.d.ts +31 -0
  98. package/dist/types/src/api-model/models/scope-of-work.d.ts +42 -0
  99. package/dist/types/src/api-model/models/seller.d.ts +24 -0
  100. package/dist/types/src/api-model/models/service-job-provider.d.ts +24 -0
  101. package/dist/types/src/api-model/models/service-job.d.ts +117 -0
  102. package/dist/types/src/api-model/models/service-location.d.ts +40 -0
  103. package/dist/types/src/api-model/models/set-appointment-response.d.ts +37 -0
  104. package/dist/types/src/api-model/models/technician.d.ts +30 -0
  105. package/dist/types/src/api-model/models/warning.d.ts +36 -0
  106. package/dist/types/src/client.d.ts +13 -0
  107. package/dist/types/src/error.d.ts +3 -0
  108. package/package.json +53 -0
@@ -0,0 +1,31 @@
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 { AppointmentTimeInput } from './appointment-time-input';
13
+ /**
14
+ * Input for rescheduled appointment operation.
15
+ * @export
16
+ * @interface RescheduleAppointmentRequest
17
+ */
18
+ export interface RescheduleAppointmentRequest {
19
+ /**
20
+ *
21
+ * @type {AppointmentTimeInput}
22
+ * @memberof RescheduleAppointmentRequest
23
+ */
24
+ appointmentTime: AppointmentTimeInput;
25
+ /**
26
+ * Appointment reschedule reason code.
27
+ * @type {string}
28
+ * @memberof RescheduleAppointmentRequest
29
+ */
30
+ rescheduleReasonCode: string;
31
+ }
@@ -0,0 +1,42 @@
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
+ /**
13
+ * The scope of work for the order.
14
+ * @export
15
+ * @interface ScopeOfWork
16
+ */
17
+ export interface ScopeOfWork {
18
+ /**
19
+ * The Amazon Standard Identification Number (ASIN) of the service job.
20
+ * @type {string}
21
+ * @memberof ScopeOfWork
22
+ */
23
+ asin?: string;
24
+ /**
25
+ * The title of the service job.
26
+ * @type {string}
27
+ * @memberof ScopeOfWork
28
+ */
29
+ title?: string;
30
+ /**
31
+ * The number of service jobs.
32
+ * @type {number}
33
+ * @memberof ScopeOfWork
34
+ */
35
+ quantity?: number;
36
+ /**
37
+ * A list of skills required to perform the job.
38
+ * @type {Array<string>}
39
+ * @memberof ScopeOfWork
40
+ */
41
+ requiredSkills?: Array<string>;
42
+ }
@@ -0,0 +1,24 @@
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
+ /**
13
+ * Information about the seller of the service job.
14
+ * @export
15
+ * @interface Seller
16
+ */
17
+ export interface Seller {
18
+ /**
19
+ * The identifier of the seller of the service job.
20
+ * @type {string}
21
+ * @memberof Seller
22
+ */
23
+ sellerId?: string;
24
+ }
@@ -0,0 +1,24 @@
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
+ /**
13
+ * Information about the service job provider.
14
+ * @export
15
+ * @interface ServiceJobProvider
16
+ */
17
+ export interface ServiceJobProvider {
18
+ /**
19
+ * The identifier of the service job provider.
20
+ * @type {string}
21
+ * @memberof ServiceJobProvider
22
+ */
23
+ serviceJobProviderId?: string;
24
+ }
@@ -0,0 +1,117 @@
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 { Appointment } from './appointment';
13
+ import { AppointmentTime } from './appointment-time';
14
+ import { AssociatedItem } from './associated-item';
15
+ import { Buyer } from './buyer';
16
+ import { ScopeOfWork } from './scope-of-work';
17
+ import { Seller } from './seller';
18
+ import { ServiceJobProvider } from './service-job-provider';
19
+ import { ServiceLocation } from './service-location';
20
+ /**
21
+ * The job details of a service.
22
+ * @export
23
+ * @interface ServiceJob
24
+ */
25
+ export interface ServiceJob {
26
+ /**
27
+ * The date and time of the creation of the job, in ISO 8601 format.
28
+ * @type {string}
29
+ * @memberof ServiceJob
30
+ */
31
+ createTime?: string;
32
+ /**
33
+ * Amazon identifier for the service job.
34
+ * @type {string}
35
+ * @memberof ServiceJob
36
+ */
37
+ serviceJobId?: string;
38
+ /**
39
+ * The status of the service job.
40
+ * @type {string}
41
+ * @memberof ServiceJob
42
+ */
43
+ serviceJobStatus?: ServiceJobServiceJobStatusEnum;
44
+ /**
45
+ *
46
+ * @type {ScopeOfWork}
47
+ * @memberof ServiceJob
48
+ */
49
+ scopeOfWork?: ScopeOfWork;
50
+ /**
51
+ *
52
+ * @type {Seller}
53
+ * @memberof ServiceJob
54
+ */
55
+ seller?: Seller;
56
+ /**
57
+ *
58
+ * @type {ServiceJobProvider}
59
+ * @memberof ServiceJob
60
+ */
61
+ serviceJobProvider?: ServiceJobProvider;
62
+ /**
63
+ * A list of appointment windows preferred by the buyer. Included only if the buyer selected appointment windows when creating the order.
64
+ * @type {Array<AppointmentTime>}
65
+ * @memberof ServiceJob
66
+ */
67
+ preferredAppointmentTimes?: Array<AppointmentTime>;
68
+ /**
69
+ * A list of appointments.
70
+ * @type {Array<Appointment>}
71
+ * @memberof ServiceJob
72
+ */
73
+ appointments?: Array<Appointment>;
74
+ /**
75
+ * The Amazon-defined identifier for an order placed by the buyer, in 3-7-7 format.
76
+ * @type {string}
77
+ * @memberof ServiceJob
78
+ */
79
+ serviceOrderId?: string;
80
+ /**
81
+ * The marketplace identifier.
82
+ * @type {string}
83
+ * @memberof ServiceJob
84
+ */
85
+ marketplaceId?: string;
86
+ /**
87
+ *
88
+ * @type {Buyer}
89
+ * @memberof ServiceJob
90
+ */
91
+ buyer?: Buyer;
92
+ /**
93
+ * A list of items associated with the service job.
94
+ * @type {Array<AssociatedItem>}
95
+ * @memberof ServiceJob
96
+ */
97
+ associatedItems?: Array<AssociatedItem>;
98
+ /**
99
+ *
100
+ * @type {ServiceLocation}
101
+ * @memberof ServiceJob
102
+ */
103
+ serviceLocation?: ServiceLocation;
104
+ }
105
+ /**
106
+ * @export
107
+ * @enum {string}
108
+ */
109
+ export declare enum ServiceJobServiceJobStatusEnum {
110
+ NotServiced = "NOT_SERVICED",
111
+ Cancelled = "CANCELLED",
112
+ Completed = "COMPLETED",
113
+ PendingSchedule = "PENDING_SCHEDULE",
114
+ NotFulfillable = "NOT_FULFILLABLE",
115
+ Hold = "HOLD",
116
+ PaymentDeclined = "PAYMENT_DECLINED"
117
+ }
@@ -0,0 +1,40 @@
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 { Address } from './address';
13
+ /**
14
+ * Information about the location of the service job.
15
+ * @export
16
+ * @interface ServiceLocation
17
+ */
18
+ export interface ServiceLocation {
19
+ /**
20
+ * The location of the service job.
21
+ * @type {string}
22
+ * @memberof ServiceLocation
23
+ */
24
+ serviceLocationType?: ServiceLocationServiceLocationTypeEnum;
25
+ /**
26
+ *
27
+ * @type {Address}
28
+ * @memberof ServiceLocation
29
+ */
30
+ address?: Address;
31
+ }
32
+ /**
33
+ * @export
34
+ * @enum {string}
35
+ */
36
+ export declare enum ServiceLocationServiceLocationTypeEnum {
37
+ InHome = "IN_HOME",
38
+ InStore = "IN_STORE",
39
+ Online = "ONLINE"
40
+ }
@@ -0,0 +1,37 @@
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 { Warning } from './warning';
13
+ /**
14
+ * Response schema for add or reschedule appointment operation.
15
+ * @export
16
+ * @interface SetAppointmentResponse
17
+ */
18
+ export interface SetAppointmentResponse {
19
+ /**
20
+ * The appointment identifier.
21
+ * @type {string}
22
+ * @memberof SetAppointmentResponse
23
+ */
24
+ appointmentId?: string;
25
+ /**
26
+ * A list of warnings returned in the sucessful execution response of an API request.
27
+ * @type {Array<Warning>}
28
+ * @memberof SetAppointmentResponse
29
+ */
30
+ warnings?: Array<Warning>;
31
+ /**
32
+ * A list of error responses returned when a request is unsuccessful.
33
+ * @type {Array<Error>}
34
+ * @memberof SetAppointmentResponse
35
+ */
36
+ errors?: Array<Error>;
37
+ }
@@ -0,0 +1,30 @@
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
+ /**
13
+ * A technician who is assigned to perform the service job in part or in full.
14
+ * @export
15
+ * @interface Technician
16
+ */
17
+ export interface Technician {
18
+ /**
19
+ * The technician identifier.
20
+ * @type {string}
21
+ * @memberof Technician
22
+ */
23
+ technicianId?: string;
24
+ /**
25
+ * The name of the technician.
26
+ * @type {string}
27
+ * @memberof Technician
28
+ */
29
+ name?: string;
30
+ }
@@ -0,0 +1,36 @@
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
+ /**
13
+ * Warning returned when the request is successful but execution have some important callouts on basis of which API clients should take defined actions.
14
+ * @export
15
+ * @interface Warning
16
+ */
17
+ export interface Warning {
18
+ /**
19
+ * An warning code that identifies the type of warning that occurred.
20
+ * @type {string}
21
+ * @memberof Warning
22
+ */
23
+ code: string;
24
+ /**
25
+ * A message that describes the warning condition in a human-readable form.
26
+ * @type {string}
27
+ * @memberof Warning
28
+ */
29
+ message: string;
30
+ /**
31
+ * Additional details that can help the caller understand or address the warning.
32
+ * @type {string}
33
+ * @memberof Warning
34
+ */
35
+ details?: string;
36
+ }
@@ -0,0 +1,13 @@
1
+ import { onRetry } from '@sp-api-sdk/common';
2
+ import type { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
3
+ import { ServiceApi } from './api-model';
4
+ export declare const RATE_LIMITS: RateLimit[];
5
+ export interface ClientParameters extends Omit<ClientConfiguration, 'rateLimits' | 'onRetry'> {
6
+ rateLimiting?: {
7
+ retry: boolean;
8
+ onRetry?: onRetry;
9
+ };
10
+ }
11
+ export declare class ServicesApiClient extends ServiceApi {
12
+ constructor(parameters: ClientParameters);
13
+ }
@@ -0,0 +1,3 @@
1
+ export declare class ServicesApiError extends Error {
2
+ constructor(message: string);
3
+ }
package/package.json ADDED
@@ -0,0 +1,53 @@
1
+ {
2
+ "name": "@sp-api-sdk/services-api-v1",
3
+ "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
4
+ "description": "With the Services API, you can build applications that help service providers get and modify their service orders.",
5
+ "version": "1.6.15",
6
+ "main": "dist/cjs/index.js",
7
+ "module": "dist/es/index.js",
8
+ "types": "dist/types/index.d.ts",
9
+ "license": "MIT",
10
+ "publishConfig": {
11
+ "access": "public"
12
+ },
13
+ "directories": {
14
+ "lib": "dist"
15
+ },
16
+ "files": [
17
+ "dist/**/*.js",
18
+ "dist/**/*.d.ts"
19
+ ],
20
+ "scripts": {
21
+ "build:cjs": "tsc -p tsconfig.json",
22
+ "build:es": "tsc -p tsconfig.es.json",
23
+ "build": "yarn build:cjs && yarn build:es",
24
+ "clean": "rimraf dist",
25
+ "lint": "xo --cwd=../../ $PWD",
26
+ "test": "NODE_ENV='test' yarn jest"
27
+ },
28
+ "dependencies": {
29
+ "@sp-api-sdk/auth": "^1.9.1",
30
+ "@sp-api-sdk/common": "^1.7.2",
31
+ "axios": "^0.21.1"
32
+ },
33
+ "repository": {
34
+ "type": "git",
35
+ "url": "https://github.com/bizon/selling-partner-api-sdk.git",
36
+ "directory": "clients/services-api-v1"
37
+ },
38
+ "bugs": {
39
+ "url": "https://github.com/bizon/selling-partner-api-sdk/issues"
40
+ },
41
+ "homepage": "https://github.com/bizon/selling-partner-api-sdk/tree/master/clients/services-api-v1",
42
+ "keywords": [
43
+ "amazon",
44
+ "bizon",
45
+ "marketplace web services",
46
+ "mws",
47
+ "selling partner api",
48
+ "sp api",
49
+ "sp sdk",
50
+ "services api"
51
+ ],
52
+ "gitHead": "dc4286920dc77e99d6ad71f71bcb78ae22b9ab06"
53
+ }