@sp-api-sdk/services-api-v1 1.8.9 → 1.9.2

package/dist/types/src/api-model/models/reschedule-appointment-request.d.ts

@@ -1,6 +1,6 @@
 /**
  * Selling Partner API for Services
- * With the Services API, you can build applications that help service providers get and modify their service orders.
+ * With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
  *
  * The version of the OpenAPI document: v1
  *
@@ -23,7 +23,7 @@ export interface RescheduleAppointmentRequest {
      */
     'appointmentTime': AppointmentTimeInput;
     /**
-     * Appointment reschedule reason code.
+     * The appointment reschedule reason code.
      * @type {string}
      * @memberof RescheduleAppointmentRequest
      */

package/dist/types/src/api-model/models/reservation.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Selling Partner API for Services
+ * With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AvailabilityRecord } from './availability-record';
+/**
+ * Reservation object reduces the capacity of a resource.
+ * @export
+ * @interface Reservation
+ */
+export interface Reservation {
+    /**
+     * Unique identifier for a reservation. If present, it is treated as an update reservation request and will update the corresponding reservation. Otherwise, it is treated as a new create reservation request.
+     * @type {string}
+     * @memberof Reservation
+     */
+    'reservationId'?: string;
+    /**
+     * Type of reservation.
+     * @type {string}
+     * @memberof Reservation
+     */
+    'type': ReservationTypeEnum;
+    /**
+     *
+     * @type {AvailabilityRecord}
+     * @memberof Reservation
+     */
+    'availability': AvailabilityRecord;
+}
+export declare const ReservationTypeEnum: {
+    readonly Appointment: "APPOINTMENT";
+    readonly Travel: "TRAVEL";
+    readonly Vacation: "VACATION";
+    readonly Break: "BREAK";
+    readonly Training: "TRAINING";
+};
+export declare type ReservationTypeEnum = typeof ReservationTypeEnum[keyof typeof ReservationTypeEnum];

package/dist/types/src/api-model/models/scope-of-work.d.ts

@@ -1,6 +1,6 @@
 /**
  * Selling Partner API for Services
- * With the Services API, you can build applications that help service providers get and modify their service orders.
+ * With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
  *
  * The version of the OpenAPI document: v1
  *

package/dist/types/src/api-model/models/seller.d.ts

@@ -1,6 +1,6 @@
 /**
  * Selling Partner API for Services
- * With the Services API, you can build applications that help service providers get and modify their service orders.
+ * With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
  *
  * The version of the OpenAPI document: v1
  *

package/dist/types/src/api-model/models/service-document-upload-destination.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Selling Partner API for Services
+ * With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { EncryptionDetails } from './encryption-details';
+/**
+ * Information about an upload destination.
+ * @export
+ * @interface ServiceDocumentUploadDestination
+ */
+export interface ServiceDocumentUploadDestination {
+    /**
+     * The unique identifier to be used by APIs that reference the upload destination.
+     * @type {string}
+     * @memberof ServiceDocumentUploadDestination
+     */
+    'uploadDestinationId': string;
+    /**
+     * The URL to which to upload the file.
+     * @type {string}
+     * @memberof ServiceDocumentUploadDestination
+     */
+    'url': string;
+    /**
+     *
+     * @type {EncryptionDetails}
+     * @memberof ServiceDocumentUploadDestination
+     */
+    'encryptionDetails': EncryptionDetails;
+    /**
+     * The headers to include in the upload request.
+     * @type {object}
+     * @memberof ServiceDocumentUploadDestination
+     */
+    'headers'?: object;
+}

package/dist/types/src/api-model/models/service-job-provider.d.ts

@@ -1,6 +1,6 @@
 /**
  * Selling Partner API for Services
- * With the Services API, you can build applications that help service providers get and modify their service orders.
+ * With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
  *
  * The version of the OpenAPI document: v1
  *

package/dist/types/src/api-model/models/service-job.d.ts

@@ -1,6 +1,6 @@
 /**
  * Selling Partner API for Services
- * With the Services API, you can build applications that help service providers get and modify their service orders.
+ * With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
  *
  * The version of the OpenAPI document: v1
  *
@@ -24,7 +24,7 @@ import { ServiceLocation } from './service-location';
  */
 export interface ServiceJob {
     /**
-     * The date and time of the creation of the job, in ISO 8601 format.
+     * The date and time of the creation of the job in ISO 8601 format.
      * @type {string}
      * @memberof ServiceJob
      */
@@ -83,6 +83,12 @@ export interface ServiceJob {
      * @memberof ServiceJob
      */
     'marketplaceId'?: string;
+    /**
+     * The Amazon-defined identifier for the region scope.
+     * @type {string}
+     * @memberof ServiceJob
+     */
+    'storeId'?: string;
     /**
      *
      * @type {Buyer}

package/dist/types/src/api-model/models/service-location.d.ts

@@ -1,6 +1,6 @@
 /**
  * Selling Partner API for Services
- * With the Services API, you can build applications that help service providers get and modify their service orders.
+ * With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
  *
  * The version of the OpenAPI document: v1
  *

package/dist/types/src/api-model/models/service-upload-document.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Selling Partner API for Services
+ * With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Input for to be uploaded document.
+ * @export
+ * @interface ServiceUploadDocument
+ */
+export interface ServiceUploadDocument {
+    /**
+     * The content type of the to-be-uploaded file
+     * @type {string}
+     * @memberof ServiceUploadDocument
+     */
+    'contentType': ServiceUploadDocumentContentTypeEnum;
+    /**
+     * The content length of the to-be-uploaded file
+     * @type {number}
+     * @memberof ServiceUploadDocument
+     */
+    'contentLength': number;
+    /**
+     * An MD5 hash of the content to be submitted to the upload destination. This value is used to determine if the data has been corrupted or tampered with during transit.
+     * @type {string}
+     * @memberof ServiceUploadDocument
+     */
+    'contentMD5'?: string;
+}
+export declare const ServiceUploadDocumentContentTypeEnum: {
+    readonly Tiff: "TIFF";
+    readonly Jpg: "JPG";
+    readonly Png: "PNG";
+    readonly Jpeg: "JPEG";
+    readonly Gif: "GIF";
+    readonly Pdf: "PDF";
+};
+export declare type ServiceUploadDocumentContentTypeEnum = typeof ServiceUploadDocumentContentTypeEnum[keyof typeof ServiceUploadDocumentContentTypeEnum];

package/dist/types/src/api-model/models/set-appointment-fulfillment-data-request.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Selling Partner API for Services
+ * With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AppointmentResource } from './appointment-resource';
+import { FulfillmentDocument } from './fulfillment-document';
+import { FulfillmentTime } from './fulfillment-time';
+/**
+ * Input for set appointment fulfillment data operation.
+ * @export
+ * @interface SetAppointmentFulfillmentDataRequest
+ */
+export interface SetAppointmentFulfillmentDataRequest {
+    /**
+     *
+     * @type {FulfillmentTime}
+     * @memberof SetAppointmentFulfillmentDataRequest
+     */
+    'fulfillmentTime'?: FulfillmentTime;
+    /**
+     * List of resources that performs or performed job appointment fulfillment.
+     * @type {Array<AppointmentResource>}
+     * @memberof SetAppointmentFulfillmentDataRequest
+     */
+    'appointmentResources'?: Array<AppointmentResource>;
+    /**
+     * List of documents captured during service appointment fulfillment.
+     * @type {Array<FulfillmentDocument>}
+     * @memberof SetAppointmentFulfillmentDataRequest
+     */
+    'fulfillmentDocuments'?: Array<FulfillmentDocument>;
+}

package/dist/types/src/api-model/models/set-appointment-response.d.ts

@@ -1,6 +1,6 @@
 /**
  * Selling Partner API for Services
- * With the Services API, you can build applications that help service providers get and modify their service orders.
+ * With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
  *
  * The version of the OpenAPI document: v1
  *
@@ -11,7 +11,7 @@
  */
 import { Warning } from './warning';
 /**
- * Response schema for add or reschedule appointment operation.
+ * Response schema for the `addAppointmentForServiceJobByServiceJobId` and `rescheduleAppointmentForServiceJobByServiceJobId` operations.
  * @export
  * @interface SetAppointmentResponse
  */

package/dist/types/src/api-model/models/technician.d.ts

@@ -1,6 +1,6 @@
 /**
  * Selling Partner API for Services
- * With the Services API, you can build applications that help service providers get and modify their service orders.
+ * With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
  *
  * The version of the OpenAPI document: v1
  *

package/dist/types/src/api-model/models/update-reservation-record.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Selling Partner API for Services
+ * With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Reservation } from './reservation';
+import { Warning } from './warning';
+/**
+ * `UpdateReservationRecord` entity contains the `Reservation` if there is an error/warning while performing the requested operation on it, otherwise it will contain the new `reservationId`.
+ * @export
+ * @interface UpdateReservationRecord
+ */
+export interface UpdateReservationRecord {
+    /**
+     *
+     * @type {Reservation}
+     * @memberof UpdateReservationRecord
+     */
+    'reservation'?: Reservation;
+    /**
+     * A list of warnings returned in the sucessful execution response of an API request.
+     * @type {Array<Warning>}
+     * @memberof UpdateReservationRecord
+     */
+    'warnings'?: Array<Warning>;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof UpdateReservationRecord
+     */
+    'errors'?: Array<Error>;
+}

package/dist/types/src/api-model/models/update-reservation-request.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Services
+ * With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Reservation } from './reservation';
+/**
+ * Request schema for the `updateReservation` operation.
+ * @export
+ * @interface UpdateReservationRequest
+ */
+export interface UpdateReservationRequest {
+    /**
+     * Resource (store) identifier.
+     * @type {string}
+     * @memberof UpdateReservationRequest
+     */
+    'resourceId': string;
+    /**
+     *
+     * @type {Reservation}
+     * @memberof UpdateReservationRequest
+     */
+    'reservation': Reservation;
+}

package/dist/types/src/api-model/models/update-reservation-response.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Services
+ * With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { UpdateReservationRecord } from './update-reservation-record';
+/**
+ * Response schema for the `updateReservation` operation.
+ * @export
+ * @interface UpdateReservationResponse
+ */
+export interface UpdateReservationResponse {
+    /**
+     *
+     * @type {UpdateReservationRecord}
+     * @memberof UpdateReservationResponse
+     */
+    'payload'?: UpdateReservationRecord;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof UpdateReservationResponse
+     */
+    'errors'?: Array<Error>;
+}

package/dist/types/src/api-model/models/update-schedule-record.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Selling Partner API for Services
+ * With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AvailabilityRecord } from './availability-record';
+import { Warning } from './warning';
+/**
+ * `UpdateScheduleRecord` entity contains the `AvailabilityRecord` if there is an error/warning while performing the requested operation on it.
+ * @export
+ * @interface UpdateScheduleRecord
+ */
+export interface UpdateScheduleRecord {
+    /**
+     *
+     * @type {AvailabilityRecord}
+     * @memberof UpdateScheduleRecord
+     */
+    'availability'?: AvailabilityRecord;
+    /**
+     * A list of warnings returned in the sucessful execution response of an API request.
+     * @type {Array<Warning>}
+     * @memberof UpdateScheduleRecord
+     */
+    'warnings'?: Array<Warning>;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof UpdateScheduleRecord
+     */
+    'errors'?: Array<Error>;
+}

package/dist/types/src/api-model/models/update-schedule-request.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Selling Partner API for Services
+ * With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AvailabilityRecord } from './availability-record';
+/**
+ * Request schema for the `updateSchedule` operation.
+ * @export
+ * @interface UpdateScheduleRequest
+ */
+export interface UpdateScheduleRequest {
+    /**
+     * List of `AvailabilityRecord`s to represent the capacity of a resource over a time range.
+     * @type {Array<AvailabilityRecord>}
+     * @memberof UpdateScheduleRequest
+     */
+    'schedules': Array<AvailabilityRecord>;
+}

package/dist/types/src/api-model/models/update-schedule-response.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Services
+ * With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { UpdateScheduleRecord } from './update-schedule-record';
+/**
+ * Response schema for the `updateSchedule` operation.
+ * @export
+ * @interface UpdateScheduleResponse
+ */
+export interface UpdateScheduleResponse {
+    /**
+     * Contains the `UpdateScheduleRecords` for which the error/warning has occurred.
+     * @type {Array<UpdateScheduleRecord>}
+     * @memberof UpdateScheduleResponse
+     */
+    'payload'?: Array<UpdateScheduleRecord>;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof UpdateScheduleResponse
+     */
+    'errors'?: Array<Error>;
+}

package/dist/types/src/api-model/models/warning.d.ts

@@ -1,6 +1,6 @@
 /**
  * Selling Partner API for Services
- * With the Services API, you can build applications that help service providers get and modify their service orders.
+ * With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.
  *
  * The version of the OpenAPI document: v1
  *
@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- * Warning returned when the request is successful but execution have some important callouts on basis of which API clients should take defined actions.
+ * Warning returned when the request is successful, but there are important callouts based on which API clients should take defined actions.
  * @export
  * @interface Warning
  */

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@sp-api-sdk/services-api-v1",
   "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
-  "description": "With the Services API, you can build applications that help service providers get and modify their service orders.",
-  "version": "1.8.9",
+  "description": "With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.",
+  "version": "1.9.2",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
   "types": "dist/types/index.d.ts",
@@ -26,8 +26,8 @@
     "test": "jest"
   },
   "dependencies": {
-    "@sp-api-sdk/auth": "^1.9.21",
-    "@sp-api-sdk/common": "^1.9.7",
+    "@sp-api-sdk/auth": "^1.9.23",
+    "@sp-api-sdk/common": "^1.9.9",
     "axios": "^0.27.2"
   },
   "repository": {
@@ -52,5 +52,5 @@
   "typedoc": {
     "entryPoint": "./index.ts"
   },
-  "gitHead": "87de54d3e7d47fd187a15c558350620d6c5b50af"
+  "gitHead": "6e5341c171eec45c0956f2333c20a568a3f878b2"
 }