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

package/dist/types/src/api-model/api.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/base.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/common.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/configuration.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/index.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/add-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
  *

package/dist/types/src/api-model/models/address.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/appointment-resource.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 resource that performs or performed appointment fulfillment.
+ * @export
+ * @interface AppointmentResource
+ */
+export interface AppointmentResource {
+    /**
+     * The resource identifier.
+     * @type {string}
+     * @memberof AppointmentResource
+     */
+    'resourceId'?: string;
+}

package/dist/types/src/api-model/models/appointment-slot-report.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.
+ */
+import { AppointmentSlot } from './appointment-slot';
+/**
+ * Availability information as per the service context queried.
+ * @export
+ * @interface AppointmentSlotReport
+ */
+export interface AppointmentSlotReport {
+    /**
+     * Defines the type of slots.
+     * @type {string}
+     * @memberof AppointmentSlotReport
+     */
+    'schedulingType'?: AppointmentSlotReportSchedulingTypeEnum;
+    /**
+     * Start Time from which the appointment slots are generated in ISO 8601 format.
+     * @type {string}
+     * @memberof AppointmentSlotReport
+     */
+    'startTime'?: string;
+    /**
+     * End Time up to which the appointment slots are generated in ISO 8601 format.
+     * @type {string}
+     * @memberof AppointmentSlotReport
+     */
+    'endTime'?: string;
+    /**
+     * A list of time windows along with associated capacity in which the service can be performed.
+     * @type {Array<AppointmentSlot>}
+     * @memberof AppointmentSlotReport
+     */
+    'appointmentSlots'?: Array<AppointmentSlot>;
+}
+export declare const AppointmentSlotReportSchedulingTypeEnum: {
+    readonly RealTimeScheduling: "REAL_TIME_SCHEDULING";
+    readonly NonRealTimeScheduling: "NON_REAL_TIME_SCHEDULING";
+};
+export declare type AppointmentSlotReportSchedulingTypeEnum = typeof AppointmentSlotReportSchedulingTypeEnum[keyof typeof AppointmentSlotReportSchedulingTypeEnum];

package/dist/types/src/api-model/models/appointment-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.
+ */
+/**
+ * A time window along with associated capacity in which the service can be performed.
+ * @export
+ * @interface AppointmentSlot
+ */
+export interface AppointmentSlot {
+    /**
+     * Time window start time in ISO 8601 format.
+     * @type {string}
+     * @memberof AppointmentSlot
+     */
+    'startTime'?: string;
+    /**
+     * Time window end time in ISO 8601 format.
+     * @type {string}
+     * @memberof AppointmentSlot
+     */
+    'endTime'?: string;
+    /**
+     * Number of resources for which a slot can be reserved.
+     * @type {number}
+     * @memberof AppointmentSlot
+     */
+    'capacity'?: number;
+}

package/dist/types/src/api-model/models/appointment-time-input.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/appointment-time.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,7 +16,7 @@
  */
 export interface AppointmentTime {
     /**
-     * The date and time of the start of the appointment window, in ISO 8601 format.
+     * The date and time of the start of the appointment window in ISO 8601 format.
      * @type {string}
      * @memberof AppointmentTime
      */

package/dist/types/src/api-model/models/appointment.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/assign-appointment-resources-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 { AppointmentResource } from './appointment-resource';
+/**
+ * Request schema for the `assignAppointmentResources` operation.
+ * @export
+ * @interface AssignAppointmentResourcesRequest
+ */
+export interface AssignAppointmentResourcesRequest {
+    /**
+     * List of resources that performs or performed job appointment fulfillment.
+     * @type {Array<AppointmentResource>}
+     * @memberof AssignAppointmentResourcesRequest
+     */
+    'resources': Array<AppointmentResource>;
+}

package/dist/types/src/api-model/models/assign-appointment-resources-response-payload.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 { Warning } from './warning';
+/**
+ * The payload for the `assignAppointmentResource` operation.
+ * @export
+ * @interface AssignAppointmentResourcesResponsePayload
+ */
+export interface AssignAppointmentResourcesResponsePayload {
+    /**
+     * A list of warnings returned in the sucessful execution response of an API request.
+     * @type {Array<Warning>}
+     * @memberof AssignAppointmentResourcesResponsePayload
+     */
+    'warnings'?: Array<Warning>;
+}

package/dist/types/src/api-model/models/assign-appointment-resources-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 { AssignAppointmentResourcesResponsePayload } from './assign-appointment-resources-response-payload';
+/**
+ * Response schema for the `assignAppointmentResources` operation.
+ * @export
+ * @interface AssignAppointmentResourcesResponse
+ */
+export interface AssignAppointmentResourcesResponse {
+    /**
+     *
+     * @type {AssignAppointmentResourcesResponsePayload}
+     * @memberof AssignAppointmentResourcesResponse
+     */
+    'payload'?: AssignAppointmentResourcesResponsePayload;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof AssignAppointmentResourcesResponse
+     */
+    'errors'?: Array<Error>;
+}

package/dist/types/src/api-model/models/associated-item.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/availability-record.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 { Recurrence } from './recurrence';
+/**
+ * `AvailabilityRecord` to represent the capacity of a resource over a time range.
+ * @export
+ * @interface AvailabilityRecord
+ */
+export interface AvailabilityRecord {
+    /**
+     * Denotes the time from when the resource is available in a day in ISO-8601 format.
+     * @type {string}
+     * @memberof AvailabilityRecord
+     */
+    'startTime': string;
+    /**
+     * Denotes the time till when the resource is available in a day in ISO-8601 format.
+     * @type {string}
+     * @memberof AvailabilityRecord
+     */
+    'endTime': string;
+    /**
+     *
+     * @type {Recurrence}
+     * @memberof AvailabilityRecord
+     */
+    'recurrence'?: Recurrence;
+    /**
+     * Signifies the capacity of a resource which is available.
+     * @type {number}
+     * @memberof AvailabilityRecord
+     */
+    'capacity'?: number;
+}

package/dist/types/src/api-model/models/buyer.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/cancel-reservation-response.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.
+ */
+/**
+ * Response schema for the `cancelReservation` operation.
+ * @export
+ * @interface CancelReservationResponse
+ */
+export interface CancelReservationResponse {
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof CancelReservationResponse
+     */
+    'errors'?: Array<Error>;
+}

package/dist/types/src/api-model/models/cancel-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
  *
@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- * Response schema for CancelServiceJobByServiceJobId operation.
+ * Response schema for the `cancelServiceJobByServiceJobId` operation.
  * @export
  * @interface CancelServiceJobByServiceJobIdResponse
  */

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

@@ -0,0 +1,23 @@
+/**
+ * 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.
+ */
+/**
+ * Type of capacity
+ * @export
+ * @enum {string}
+ */
+export declare const CapacityType: {
+    readonly ScheduledCapacity: "SCHEDULED_CAPACITY";
+    readonly AvailableCapacity: "AVAILABLE_CAPACITY";
+    readonly EncumberedCapacity: "ENCUMBERED_CAPACITY";
+    readonly ReservedCapacity: "RESERVED_CAPACITY";
+};
+export declare type CapacityType = typeof CapacityType[keyof typeof CapacityType];

package/dist/types/src/api-model/models/complete-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
  *
@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- * Response schema for CompleteServiceJobByServiceJobId operation.
+ * Response schema for the `completeServiceJobByServiceJobId` operation.
  * @export
  * @interface CompleteServiceJobByServiceJobIdResponse
  */

package/dist/types/src/api-model/models/create-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';
+/**
+ * `CreateReservationRecord` 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 CreateReservationRecord
+ */
+export interface CreateReservationRecord {
+    /**
+     *
+     * @type {Reservation}
+     * @memberof CreateReservationRecord
+     */
+    'reservation'?: Reservation;
+    /**
+     * A list of warnings returned in the sucessful execution response of an API request.
+     * @type {Array<Warning>}
+     * @memberof CreateReservationRecord
+     */
+    'warnings'?: Array<Warning>;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof CreateReservationRecord
+     */
+    'errors'?: Array<Error>;
+}

package/dist/types/src/api-model/models/create-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 `createReservation` operation.
+ * @export
+ * @interface CreateReservationRequest
+ */
+export interface CreateReservationRequest {
+    /**
+     * Resource (store) identifier.
+     * @type {string}
+     * @memberof CreateReservationRequest
+     */
+    'resourceId': string;
+    /**
+     *
+     * @type {Reservation}
+     * @memberof CreateReservationRequest
+     */
+    'reservation': Reservation;
+}

package/dist/types/src/api-model/models/create-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 { CreateReservationRecord } from './create-reservation-record';
+/**
+ * Response schema for the `createReservation` operation.
+ * @export
+ * @interface CreateReservationResponse
+ */
+export interface CreateReservationResponse {
+    /**
+     *
+     * @type {CreateReservationRecord}
+     * @memberof CreateReservationResponse
+     */
+    'payload'?: CreateReservationRecord;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof CreateReservationResponse
+     */
+    'errors'?: Array<Error>;
+}

package/dist/types/src/api-model/models/create-service-document-upload-destination.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 { ServiceDocumentUploadDestination } from './service-document-upload-destination';
+/**
+ * The response schema for the `createServiceDocumentUploadDestination` operation.
+ * @export
+ * @interface CreateServiceDocumentUploadDestination
+ */
+export interface CreateServiceDocumentUploadDestination {
+    /**
+     *
+     * @type {ServiceDocumentUploadDestination}
+     * @memberof CreateServiceDocumentUploadDestination
+     */
+    'payload'?: ServiceDocumentUploadDestination;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof CreateServiceDocumentUploadDestination
+     */
+    'errors'?: Array<Error>;
+}

package/dist/types/src/api-model/models/day-of-week.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 day of the week.
+ * @export
+ * @enum {string}
+ */
+export declare const DayOfWeek: {
+    readonly Monday: "MONDAY";
+    readonly Tuesday: "TUESDAY";
+    readonly Wednesday: "WEDNESDAY";
+    readonly Thursday: "THURSDAY";
+    readonly Friday: "FRIDAY";
+    readonly Saturday: "SATURDAY";
+    readonly Sunday: "SUNDAY";
+};
+export declare type DayOfWeek = typeof DayOfWeek[keyof typeof DayOfWeek];

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

@@ -0,0 +1,40 @@
+/**
+ * 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.
+ */
+/**
+ * Encryption details for required client-side encryption and decryption of document contents.
+ * @export
+ * @interface EncryptionDetails
+ */
+export interface EncryptionDetails {
+    /**
+     * The encryption standard required to encrypt or decrypt the document contents.
+     * @type {string}
+     * @memberof EncryptionDetails
+     */
+    'standard': EncryptionDetailsStandardEnum;
+    /**
+     * The vector to encrypt or decrypt the document contents using Cipher Block Chaining (CBC).
+     * @type {string}
+     * @memberof EncryptionDetails
+     */
+    'initializationVector': string;
+    /**
+     * The encryption key used to encrypt or decrypt the document contents.
+     * @type {string}
+     * @memberof EncryptionDetails
+     */
+    'key': string;
+}
+export declare const EncryptionDetailsStandardEnum: {
+    readonly Aes: "AES";
+};
+export declare type EncryptionDetailsStandardEnum = typeof EncryptionDetailsStandardEnum[keyof typeof EncryptionDetailsStandardEnum];