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

package/dist/types/src/api-model/models/fixed-slot-capacity-errors.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ * The error response schema for the `getFixedSlotCapacity` operation.
+ * @export
+ * @interface FixedSlotCapacityErrors
+ */
+export interface FixedSlotCapacityErrors {
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof FixedSlotCapacityErrors
+     */
+    'errors'?: Array<Error>;
+}

package/dist/types/src/api-model/models/fixed-slot-capacity-query.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 { CapacityType } from './capacity-type';
+/**
+ * Request schema for the `getFixedSlotCapacity` operation. This schema is used to define the time range, capacity types and slot duration which are being queried.
+ * @export
+ * @interface FixedSlotCapacityQuery
+ */
+export interface FixedSlotCapacityQuery {
+    /**
+     * An array of capacity types which are being requested. Default value is `[SCHEDULED_CAPACITY]`.
+     * @type {Array<CapacityType>}
+     * @memberof FixedSlotCapacityQuery
+     */
+    'capacityTypes'?: Array<CapacityType>;
+    /**
+     * Size in which slots are being requested. This value should be a multiple of 5 and fall in the range: 5 <= `slotDuration` <= 360.
+     * @type {number}
+     * @memberof FixedSlotCapacityQuery
+     */
+    'slotDuration'?: number;
+    /**
+     * Start date time from which the capacity slots are being requested in ISO 8601 format.
+     * @type {string}
+     * @memberof FixedSlotCapacityQuery
+     */
+    'startDateTime': string;
+    /**
+     * End date time up to which the capacity slots are being requested in ISO 8601 format.
+     * @type {string}
+     * @memberof FixedSlotCapacityQuery
+     */
+    'endDateTime': string;
+}

package/dist/types/src/api-model/models/fixed-slot-capacity.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 { FixedSlot } from './fixed-slot';
+/**
+ * Response schema for the `getFixedSlotCapacity` operation.
+ * @export
+ * @interface FixedSlotCapacity
+ */
+export interface FixedSlotCapacity {
+    /**
+     * Resource Identifier.
+     * @type {string}
+     * @memberof FixedSlotCapacity
+     */
+    'resourceId'?: string;
+    /**
+     * The duration of each slot which is returned. This value will be a multiple of 5 and fall in the following range: 5 <= `slotDuration` <= 360.
+     * @type {number}
+     * @memberof FixedSlotCapacity
+     */
+    'slotDuration'?: number;
+    /**
+     * Array of capacity slots in fixed slot format.
+     * @type {Array<FixedSlot>}
+     * @memberof FixedSlotCapacity
+     */
+    'capacities'?: Array<FixedSlot>;
+    /**
+     * Next page token, if there are more pages.
+     * @type {string}
+     * @memberof FixedSlotCapacity
+     */
+    'nextPageToken'?: string;
+}

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

@@ -0,0 +1,48 @@
+/**
+ * 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.
+ */
+/**
+ * In this slot format each slot only has the requested capacity types. This slot size is as specified by slot duration.
+ * @export
+ * @interface FixedSlot
+ */
+export interface FixedSlot {
+    /**
+     * Start date time of slot in ISO 8601 format with precision of seconds.
+     * @type {string}
+     * @memberof FixedSlot
+     */
+    'startDateTime'?: string;
+    /**
+     * Scheduled capacity corresponding to the slot. This capacity represents the originally allocated capacity as per resource schedule.
+     * @type {number}
+     * @memberof FixedSlot
+     */
+    'scheduledCapacity'?: number;
+    /**
+     * Available capacity corresponding to the slot. This capacity represents the capacity available for allocation to reservations.
+     * @type {number}
+     * @memberof FixedSlot
+     */
+    'availableCapacity'?: number;
+    /**
+     * Encumbered capacity corresponding to the slot. This capacity represents the capacity allocated for Amazon Jobs/Appointments/Orders.
+     * @type {number}
+     * @memberof FixedSlot
+     */
+    'encumberedCapacity'?: number;
+    /**
+     * Reserved capacity corresponding to the slot. This capacity represents the capacity made unavailable due to events like Breaks/Leaves/Lunch.
+     * @type {number}
+     * @memberof FixedSlot
+     */
+    'reservedCapacity'?: number;
+}

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

@@ -0,0 +1,30 @@
+/**
+ * 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.
+ */
+/**
+ * Document that captured during service appointment fulfillment that portrays proof of completion
+ * @export
+ * @interface FulfillmentDocument
+ */
+export interface FulfillmentDocument {
+    /**
+     * The identifier of the upload destination. Get this value by calling the `createServiceDocumentUploadDestination` operation of the Services API.
+     * @type {string}
+     * @memberof FulfillmentDocument
+     */
+    'uploadDestinationId'?: string;
+    /**
+     * Sha256 hash of the file content. This value is used to determine if the file has been corrupted or tampered with during transit.
+     * @type {string}
+     * @memberof FulfillmentDocument
+     */
+    'contentSha256'?: string;
+}

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

@@ -0,0 +1,30 @@
+/**
+ * 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 fulfillment time details
+ * @export
+ * @interface FulfillmentTime
+ */
+export interface FulfillmentTime {
+    /**
+     * The date, time in UTC of the fulfillment start time in ISO 8601 format.
+     * @type {string}
+     * @memberof FulfillmentTime
+     */
+    'startTime'?: string;
+    /**
+     * The date, time in UTC of the fulfillment end time in ISO 8601 format.
+     * @type {string}
+     * @memberof FulfillmentTime
+     */
+    'endTime'?: string;
+}

package/dist/types/src/api-model/models/get-appointment-slots-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 { AppointmentSlotReport } from './appointment-slot-report';
+/**
+ * The response of fetching appointment slots based on service context.
+ * @export
+ * @interface GetAppointmentSlotsResponse
+ */
+export interface GetAppointmentSlotsResponse {
+    /**
+     *
+     * @type {AppointmentSlotReport}
+     * @memberof GetAppointmentSlotsResponse
+     */
+    'payload'?: AppointmentSlotReport;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof GetAppointmentSlotsResponse
+     */
+    'errors'?: Array<Error>;
+}

package/dist/types/src/api-model/models/get-service-job-by-service-job-id-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 { ServiceJob } from './service-job';
 /**
- * The response schema for the GetServiceJobByServiceJobId operation.
+ * The response schema for the `getServiceJobByServiceJobId` operation.
  * @export
  * @interface GetServiceJobByServiceJobIdResponse
  */

package/dist/types/src/api-model/models/get-service-jobs-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 { JobListing } from './job-listing';
 /**
- * Response schema for GetJobs operation.
+ * Response schema for the `getServiceJobs` operation.
  * @export
  * @interface GetServiceJobsResponse
  */

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

@@ -1,12 +1,34 @@
 export * from './add-appointment-request';
 export * from './address';
 export * from './appointment';
+export * from './appointment-resource';
+export * from './appointment-slot';
+export * from './appointment-slot-report';
 export * from './appointment-time';
 export * from './appointment-time-input';
+export * from './assign-appointment-resources-request';
+export * from './assign-appointment-resources-response';
+export * from './assign-appointment-resources-response-payload';
 export * from './associated-item';
+export * from './availability-record';
 export * from './buyer';
+export * from './cancel-reservation-response';
 export * from './cancel-service-job-by-service-job-id-response';
+export * from './capacity-type';
 export * from './complete-service-job-by-service-job-id-response';
+export * from './create-reservation-record';
+export * from './create-reservation-request';
+export * from './create-reservation-response';
+export * from './create-service-document-upload-destination';
+export * from './day-of-week';
+export * from './encryption-details';
+export * from './fixed-slot';
+export * from './fixed-slot-capacity';
+export * from './fixed-slot-capacity-errors';
+export * from './fixed-slot-capacity-query';
+export * from './fulfillment-document';
+export * from './fulfillment-time';
+export * from './get-appointment-slots-response';
 export * from './get-service-job-by-service-job-id-response';
 export * from './get-service-jobs-response';
 export * from './item-delivery';
@@ -14,12 +36,28 @@ export * from './item-delivery-promise';
 export * from './job-listing';
 export * from './model-error';
 export * from './poa';
+export * from './range-capacity';
+export * from './range-slot';
+export * from './range-slot-capacity';
+export * from './range-slot-capacity-errors';
+export * from './range-slot-capacity-query';
+export * from './recurrence';
 export * from './reschedule-appointment-request';
+export * from './reservation';
 export * from './scope-of-work';
 export * from './seller';
+export * from './service-document-upload-destination';
 export * from './service-job';
 export * from './service-job-provider';
 export * from './service-location';
+export * from './service-upload-document';
+export * from './set-appointment-fulfillment-data-request';
 export * from './set-appointment-response';
 export * from './technician';
+export * from './update-reservation-record';
+export * from './update-reservation-request';
+export * from './update-reservation-response';
+export * from './update-schedule-record';
+export * from './update-schedule-request';
+export * from './update-schedule-response';
 export * from './warning';

package/dist/types/src/api-model/models/item-delivery-promise.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
  *
@@ -16,13 +16,13 @@
  */
 export interface ItemDeliveryPromise {
     /**
-     * The date and time of the start of the promised delivery window, in ISO 8601 format.
+     * The date and time of the start of the promised delivery window in ISO 8601 format.
      * @type {string}
      * @memberof ItemDeliveryPromise
      */
     'startTime'?: string;
     /**
-     * The date and time of the end of the promised delivery window, in ISO 8601 format.
+     * The date and time of the end of the promised delivery window in ISO 8601 format.
      * @type {string}
      * @memberof ItemDeliveryPromise
      */

package/dist/types/src/api-model/models/item-delivery.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/job-listing.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 { ServiceJob } from './service-job';
 /**
- * The payload for the GetJobs operation.
+ * The payload for the `getServiceJobs` operation.
  * @export
  * @interface JobListing
  */
@@ -23,13 +23,13 @@ export interface JobListing {
      */
     'totalResultSize'?: number;
     /**
-     * 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.
+     * 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.
      * @type {string}
      * @memberof JobListing
      */
     'nextPageToken'?: string;
     /**
-     * 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.
+     * 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.
      * @type {string}
      * @memberof JobListing
      */

package/dist/types/src/api-model/models/model-error.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/poa.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
  *
@@ -36,7 +36,7 @@ export interface Poa {
      */
     'uploadingTechnician'?: string;
     /**
-     * The date and time when the POA was uploaded, in ISO 8601 format.
+     * The date and time when the POA was uploaded in ISO 8601 format.
      * @type {string}
      * @memberof Poa
      */

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

@@ -0,0 +1,32 @@
+/**
+ * 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 { CapacityType } from './capacity-type';
+import { RangeSlot } from './range-slot';
+/**
+ * Range capacity entity where each entry has a capacity type and corresponding slots.
+ * @export
+ * @interface RangeCapacity
+ */
+export interface RangeCapacity {
+    /**
+     *
+     * @type {CapacityType}
+     * @memberof RangeCapacity
+     */
+    'capacityType'?: CapacityType;
+    /**
+     * Array of capacity slots in range slot format.
+     * @type {Array<RangeSlot>}
+     * @memberof RangeCapacity
+     */
+    'slots'?: Array<RangeSlot>;
+}

package/dist/types/src/api-model/models/range-slot-capacity-errors.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ * The error response schema for the `getRangeSlotCapacity` operation.
+ * @export
+ * @interface RangeSlotCapacityErrors
+ */
+export interface RangeSlotCapacityErrors {
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof RangeSlotCapacityErrors
+     */
+    'errors'?: Array<Error>;
+}

package/dist/types/src/api-model/models/range-slot-capacity-query.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 { CapacityType } from './capacity-type';
+/**
+ * Request schema for the `getRangeSlotCapacity` operation. This schema is used to define the time range and capacity types that are being queried.
+ * @export
+ * @interface RangeSlotCapacityQuery
+ */
+export interface RangeSlotCapacityQuery {
+    /**
+     * An array of capacity types which are being requested. Default value is `[SCHEDULED_CAPACITY]`.
+     * @type {Array<CapacityType>}
+     * @memberof RangeSlotCapacityQuery
+     */
+    'capacityTypes'?: Array<CapacityType>;
+    /**
+     * Start date time from which the capacity slots are being requested in ISO 8601 format.
+     * @type {string}
+     * @memberof RangeSlotCapacityQuery
+     */
+    'startDateTime': string;
+    /**
+     * End date time up to which the capacity slots are being requested in ISO 8601 format.
+     * @type {string}
+     * @memberof RangeSlotCapacityQuery
+     */
+    'endDateTime': string;
+}

package/dist/types/src/api-model/models/range-slot-capacity.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 { RangeCapacity } from './range-capacity';
+/**
+ * Response schema for the `getRangeSlotCapacity` operation.
+ * @export
+ * @interface RangeSlotCapacity
+ */
+export interface RangeSlotCapacity {
+    /**
+     * Resource Identifier.
+     * @type {string}
+     * @memberof RangeSlotCapacity
+     */
+    'resourceId'?: string;
+    /**
+     * Array of range capacities where each entry is for a specific capacity type.
+     * @type {Array<RangeCapacity>}
+     * @memberof RangeSlotCapacity
+     */
+    'capacities'?: Array<RangeCapacity>;
+    /**
+     * Next page token, if there are more pages.
+     * @type {string}
+     * @memberof RangeSlotCapacity
+     */
+    'nextPageToken'?: string;
+}

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

@@ -0,0 +1,36 @@
+/**
+ * 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.
+ */
+/**
+ * Capacity slots represented in a format similar to availability rules.
+ * @export
+ * @interface RangeSlot
+ */
+export interface RangeSlot {
+    /**
+     * Start date time of slot in ISO 8601 format with precision of seconds.
+     * @type {string}
+     * @memberof RangeSlot
+     */
+    'startDateTime'?: string;
+    /**
+     * End date time of slot in ISO 8601 format with precision of seconds.
+     * @type {string}
+     * @memberof RangeSlot
+     */
+    'endDateTime'?: string;
+    /**
+     * Capacity of the slot.
+     * @type {number}
+     * @memberof RangeSlot
+     */
+    'capacity'?: number;
+}

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

@@ -0,0 +1,37 @@
+/**
+ * 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 { DayOfWeek } from './day-of-week';
+/**
+ * Repeated occurrence of an event in a time range.
+ * @export
+ * @interface Recurrence
+ */
+export interface Recurrence {
+    /**
+     * End time of the recurrence.
+     * @type {string}
+     * @memberof Recurrence
+     */
+    'endTime': string;
+    /**
+     * Days of the week when recurrence is valid. If the schedule is valid every Monday, input will only contain `MONDAY` in the list.
+     * @type {Array<DayOfWeek>}
+     * @memberof Recurrence
+     */
+    'daysOfWeek'?: Array<DayOfWeek>;
+    /**
+     * Days of the month when recurrence is valid.
+     * @type {Array<number>}
+     * @memberof Recurrence
+     */
+    'daysOfMonth'?: Array<number>;
+}