@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,71 @@
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 { ItemDelivery } from './item-delivery';
13
+ /**
14
+ * Information about an item associated with the service job.
15
+ * @export
16
+ * @interface AssociatedItem
17
+ */
18
+ export interface AssociatedItem {
19
+ /**
20
+ * The Amazon Standard Identification Number (ASIN) of the item.
21
+ * @type {string}
22
+ * @memberof AssociatedItem
23
+ */
24
+ asin?: string;
25
+ /**
26
+ * The title of the item.
27
+ * @type {string}
28
+ * @memberof AssociatedItem
29
+ */
30
+ title?: string;
31
+ /**
32
+ * The total number of items included in the order.
33
+ * @type {number}
34
+ * @memberof AssociatedItem
35
+ */
36
+ quantity?: number;
37
+ /**
38
+ * The Amazon-defined identifier for an order placed by the buyer, in 3-7-7 format.
39
+ * @type {string}
40
+ * @memberof AssociatedItem
41
+ */
42
+ orderId?: string;
43
+ /**
44
+ * The status of the item.
45
+ * @type {string}
46
+ * @memberof AssociatedItem
47
+ */
48
+ itemStatus?: AssociatedItemItemStatusEnum;
49
+ /**
50
+ * The brand name of the item.
51
+ * @type {string}
52
+ * @memberof AssociatedItem
53
+ */
54
+ brandName?: string;
55
+ /**
56
+ *
57
+ * @type {ItemDelivery}
58
+ * @memberof AssociatedItem
59
+ */
60
+ itemDelivery?: ItemDelivery;
61
+ }
62
+ /**
63
+ * @export
64
+ * @enum {string}
65
+ */
66
+ export declare enum AssociatedItemItemStatusEnum {
67
+ Active = "ACTIVE",
68
+ Cancelled = "CANCELLED",
69
+ Shipped = "SHIPPED",
70
+ Delivered = "DELIVERED"
71
+ }
@@ -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
+ * Information about the buyer.
14
+ * @export
15
+ * @interface Buyer
16
+ */
17
+ export interface Buyer {
18
+ /**
19
+ * The identifier of the buyer.
20
+ * @type {string}
21
+ * @memberof Buyer
22
+ */
23
+ buyerId?: string;
24
+ /**
25
+ * The name of the buyer.
26
+ * @type {string}
27
+ * @memberof Buyer
28
+ */
29
+ name?: string;
30
+ /**
31
+ * The phone number of the buyer.
32
+ * @type {string}
33
+ * @memberof Buyer
34
+ */
35
+ phone?: string;
36
+ /**
37
+ * When true, the service is for an Amazon Prime buyer.
38
+ * @type {boolean}
39
+ * @memberof Buyer
40
+ */
41
+ isPrimeMember?: boolean;
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
+ * Response schema for CancelServiceJobByServiceJobId operation.
14
+ * @export
15
+ * @interface CancelServiceJobByServiceJobIdResponse
16
+ */
17
+ export interface CancelServiceJobByServiceJobIdResponse {
18
+ /**
19
+ * A list of error responses returned when a request is unsuccessful.
20
+ * @type {Array<Error>}
21
+ * @memberof CancelServiceJobByServiceJobIdResponse
22
+ */
23
+ errors?: Array<Error>;
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
+ * Response schema for CompleteServiceJobByServiceJobId operation.
14
+ * @export
15
+ * @interface CompleteServiceJobByServiceJobIdResponse
16
+ */
17
+ export interface CompleteServiceJobByServiceJobIdResponse {
18
+ /**
19
+ * A list of error responses returned when a request is unsuccessful.
20
+ * @type {Array<Error>}
21
+ * @memberof CompleteServiceJobByServiceJobIdResponse
22
+ */
23
+ errors?: Array<Error>;
24
+ }
@@ -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 { ServiceJob } from './service-job';
13
+ /**
14
+ * The response schema for the GetServiceJobByServiceJobId operation.
15
+ * @export
16
+ * @interface GetServiceJobByServiceJobIdResponse
17
+ */
18
+ export interface GetServiceJobByServiceJobIdResponse {
19
+ /**
20
+ *
21
+ * @type {ServiceJob}
22
+ * @memberof GetServiceJobByServiceJobIdResponse
23
+ */
24
+ payload?: ServiceJob;
25
+ /**
26
+ * A list of error responses returned when a request is unsuccessful.
27
+ * @type {Array<Error>}
28
+ * @memberof GetServiceJobByServiceJobIdResponse
29
+ */
30
+ errors?: Array<Error>;
31
+ }
@@ -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 { JobListing } from './job-listing';
13
+ /**
14
+ * Response schema for GetJobs operation.
15
+ * @export
16
+ * @interface GetServiceJobsResponse
17
+ */
18
+ export interface GetServiceJobsResponse {
19
+ /**
20
+ *
21
+ * @type {JobListing}
22
+ * @memberof GetServiceJobsResponse
23
+ */
24
+ payload?: JobListing;
25
+ /**
26
+ * A list of error responses returned when a request is unsuccessful.
27
+ * @type {Array<Error>}
28
+ * @memberof GetServiceJobsResponse
29
+ */
30
+ errors?: Array<Error>;
31
+ }
@@ -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,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
+ * Promised delivery information for the item.
14
+ * @export
15
+ * @interface ItemDeliveryPromise
16
+ */
17
+ export interface ItemDeliveryPromise {
18
+ /**
19
+ * The date and time of the start of the promised delivery window, in ISO 8601 format.
20
+ * @type {string}
21
+ * @memberof ItemDeliveryPromise
22
+ */
23
+ startTime?: string;
24
+ /**
25
+ * The date and time of the end of the promised delivery window, in ISO 8601 format.
26
+ * @type {string}
27
+ * @memberof ItemDeliveryPromise
28
+ */
29
+ endTime?: string;
30
+ }
@@ -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 { ItemDeliveryPromise } from './item-delivery-promise';
13
+ /**
14
+ * Delivery information for the item.
15
+ * @export
16
+ * @interface ItemDelivery
17
+ */
18
+ export interface ItemDelivery {
19
+ /**
20
+ * The date and time of the latest Estimated Delivery Date (EDD) of all the items with an EDD. In ISO 8601 format.
21
+ * @type {string}
22
+ * @memberof ItemDelivery
23
+ */
24
+ estimatedDeliveryDate?: string;
25
+ /**
26
+ *
27
+ * @type {ItemDeliveryPromise}
28
+ * @memberof ItemDelivery
29
+ */
30
+ itemDeliveryPromise?: ItemDeliveryPromise;
31
+ }
@@ -0,0 +1,43 @@
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 { ServiceJob } from './service-job';
13
+ /**
14
+ * The payload for the GetJobs operation.
15
+ * @export
16
+ * @interface JobListing
17
+ */
18
+ export interface JobListing {
19
+ /**
20
+ * Total result size of the query result.
21
+ * @type {number}
22
+ * @memberof JobListing
23
+ */
24
+ totalResultSize?: number;
25
+ /**
26
+ * A generated string used to pass information to your next request.If nextPageToken is returned, pass the value of nextPageToken to the pageToken to get next results.
27
+ * @type {string}
28
+ * @memberof JobListing
29
+ */
30
+ nextPageToken?: string;
31
+ /**
32
+ * A generated string used to pass information to your next request.If previousPageToken is returned, pass the value of previousPageToken to the pageToken to get previous page results.
33
+ * @type {string}
34
+ * @memberof JobListing
35
+ */
36
+ previousPageToken?: string;
37
+ /**
38
+ * List of job details for the given input.
39
+ * @type {Array<ServiceJob>}
40
+ * @memberof JobListing
41
+ */
42
+ jobs?: Array<ServiceJob>;
43
+ }
@@ -0,0 +1,50 @@
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
+ * Error response returned when the request is unsuccessful.
14
+ * @export
15
+ * @interface ModelError
16
+ */
17
+ export interface ModelError {
18
+ /**
19
+ * An error code that identifies the type of error that occurred.
20
+ * @type {string}
21
+ * @memberof ModelError
22
+ */
23
+ code: string;
24
+ /**
25
+ * A message that describes the error condition in a human-readable form.
26
+ * @type {string}
27
+ * @memberof ModelError
28
+ */
29
+ message: string;
30
+ /**
31
+ * Additional details that can help the caller understand or fix the issue.
32
+ * @type {string}
33
+ * @memberof ModelError
34
+ */
35
+ details?: string;
36
+ /**
37
+ * The type of error.
38
+ * @type {string}
39
+ * @memberof ModelError
40
+ */
41
+ errorLevel?: ModelErrorErrorLevelEnum;
42
+ }
43
+ /**
44
+ * @export
45
+ * @enum {string}
46
+ */
47
+ export declare enum ModelErrorErrorLevelEnum {
48
+ Error = "ERROR",
49
+ Warning = "WARNING"
50
+ }
@@ -0,0 +1,60 @@
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 { AppointmentTime } from './appointment-time';
13
+ import { Technician } from './technician';
14
+ /**
15
+ * Proof of Appointment (POA) details.
16
+ * @export
17
+ * @interface Poa
18
+ */
19
+ export interface Poa {
20
+ /**
21
+ *
22
+ * @type {AppointmentTime}
23
+ * @memberof Poa
24
+ */
25
+ appointmentTime?: AppointmentTime;
26
+ /**
27
+ * A list of technicians.
28
+ * @type {Array<Technician>}
29
+ * @memberof Poa
30
+ */
31
+ technicians?: Array<Technician>;
32
+ /**
33
+ * The identifier of the technician who uploaded the POA.
34
+ * @type {string}
35
+ * @memberof Poa
36
+ */
37
+ uploadingTechnician?: string;
38
+ /**
39
+ * The date and time when the POA was uploaded, in ISO 8601 format.
40
+ * @type {string}
41
+ * @memberof Poa
42
+ */
43
+ uploadTime?: string;
44
+ /**
45
+ * The type of POA uploaded.
46
+ * @type {string}
47
+ * @memberof Poa
48
+ */
49
+ poaType?: PoaPoaTypeEnum;
50
+ }
51
+ /**
52
+ * @export
53
+ * @enum {string}
54
+ */
55
+ export declare enum PoaPoaTypeEnum {
56
+ NoSignatureDummyPos = "NO_SIGNATURE_DUMMY_POS",
57
+ CustomerSignature = "CUSTOMER_SIGNATURE",
58
+ DummyReceipt = "DUMMY_RECEIPT",
59
+ PoaReceipt = "POA_RECEIPT"
60
+ }