@sp-api-sdk/services-api-v1 4.0.0 → 4.0.2

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

@@ -12,20 +12,11 @@
 import type { 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/api-model/models/create-reservation-response.d.ts

@@ -12,20 +12,11 @@
 import type { 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/api-model/models/create-service-document-upload-destination.d.ts

@@ -12,20 +12,11 @@
 import type { 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/api-model/models/date-time-range.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * A range of time.
- * @export
- * @interface DateTimeRange
  */
 export interface DateTimeRange {
     /**
      * The beginning of the time range. Must be in UTC in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-     * @type {string}
-     * @memberof DateTimeRange
      */
     'startTime': string;
     /**
      * The end of the time range. Must be in UTC in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-     * @type {string}
-     * @memberof DateTimeRange
      */
     'endTime': string;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * The day of the week.
- * @export
- * @enum {string}
  */
 export declare const DayOfWeek: {
     readonly Monday: "MONDAY";

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

@@ -11,26 +11,18 @@
  */
 /**
  * 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;
 }

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

@@ -11,14 +11,10 @@
  */
 /**
  * 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/api-model/models/fixed-slot-capacity-query.d.ts

@@ -12,32 +12,22 @@
 import type { 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/api-model/models/fixed-slot-capacity.d.ts

@@ -12,32 +12,22 @@
 import type { 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/api-model/models/fixed-slot.d.ts

@@ -11,38 +11,26 @@
  */
 /**
  * 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/api-model/models/fulfillment-document.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * 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/api-model/models/fulfillment-time.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * 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/api-model/models/get-appointment-slots-response.d.ts

@@ -12,20 +12,11 @@
 import type { 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/api-model/models/get-service-job-by-service-job-id-response.d.ts

@@ -12,20 +12,11 @@
 import type { ServiceJob } from './service-job';
 /**
  * The response schema for the `getServiceJobByServiceJobId` operation.
- * @export
- * @interface GetServiceJobByServiceJobIdResponse
  */
 export interface GetServiceJobByServiceJobIdResponse {
-    /**
-     *
-     * @type {ServiceJob}
-     * @memberof GetServiceJobByServiceJobIdResponse
-     */
     'payload'?: ServiceJob;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof GetServiceJobByServiceJobIdResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/get-service-jobs-response.d.ts

@@ -12,20 +12,11 @@
 import type { JobListing } from './job-listing';
 /**
  * Response schema for the `getServiceJobs` operation.
- * @export
- * @interface GetServiceJobsResponse
  */
 export interface GetServiceJobsResponse {
-    /**
-     *
-     * @type {JobListing}
-     * @memberof GetServiceJobsResponse
-     */
     'payload'?: JobListing;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof GetServiceJobsResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/item-delivery-promise.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * Promised delivery information for the item.
- * @export
- * @interface ItemDeliveryPromise
  */
 export interface ItemDeliveryPromise {
     /**
      * 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.
-     * @type {string}
-     * @memberof ItemDeliveryPromise
      */
     'endTime'?: string;
 }

package/dist/types/api-model/models/item-delivery.d.ts

@@ -12,20 +12,11 @@
 import type { ItemDeliveryPromise } from './item-delivery-promise';
 /**
  * Delivery information for the item.
- * @export
- * @interface ItemDelivery
  */
 export interface ItemDelivery {
     /**
      * The date and time of the latest Estimated Delivery Date (EDD) of all the items with an EDD. In ISO 8601 format.
-     * @type {string}
-     * @memberof ItemDelivery
      */
     'estimatedDeliveryDate'?: string;
-    /**
-     *
-     * @type {ItemDeliveryPromise}
-     * @memberof ItemDelivery
-     */
     'itemDeliveryPromise'?: ItemDeliveryPromise;
 }

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

@@ -12,32 +12,22 @@
 import type { ServiceJob } from './service-job';
 /**
  * The payload for the `getServiceJobs` operation.
- * @export
- * @interface JobListing
  */
 export interface JobListing {
     /**
      * Total result size of the query result.
-     * @type {number}
-     * @memberof 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.
-     * @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.
-     * @type {string}
-     * @memberof JobListing
      */
     'previousPageToken'?: string;
     /**
      * List of job details for the given input.
-     * @type {Array<ServiceJob>}
-     * @memberof JobListing
      */
     'jobs'?: Array<ServiceJob>;
 }

package/dist/types/api-model/models/model-error.d.ts

@@ -11,32 +11,22 @@
  */
 /**
  * Error response returned when the request is unsuccessful.
- * @export
- * @interface ModelError
  */
 export interface ModelError {
     /**
      * An error code that identifies the type of error that occurred.
-     * @type {string}
-     * @memberof ModelError
      */
     'code': string;
     /**
      * A message that describes the error condition.
-     * @type {string}
-     * @memberof ModelError
      */
     'message': string;
     /**
      * Additional details that can help the caller understand or fix the issue.
-     * @type {string}
-     * @memberof ModelError
      */
     'details'?: string;
     /**
      * The type of error.
-     * @type {string}
-     * @memberof ModelError
      */
     'errorLevel'?: ModelErrorErrorLevelEnum;
 }

package/dist/types/api-model/models/poa.d.ts

@@ -13,38 +13,23 @@ import type { AppointmentTime } from './appointment-time';
 import type { Technician } from './technician';
 /**
  * Proof of Appointment (POA) details.
- * @export
- * @interface Poa
  */
 export interface Poa {
-    /**
-     *
-     * @type {AppointmentTime}
-     * @memberof Poa
-     */
     'appointmentTime'?: AppointmentTime;
     /**
      * A list of technicians.
-     * @type {Array<Technician>}
-     * @memberof Poa
      */
     'technicians'?: Array<Technician>;
     /**
      * The identifier of the technician who uploaded the POA.
-     * @type {string}
-     * @memberof Poa
      */
     'uploadingTechnician'?: string;
     /**
      * The date and time when the POA was uploaded in ISO 8601 format.
-     * @type {string}
-     * @memberof Poa
      */
     'uploadTime'?: string;
     /**
      * The type of POA uploaded.
-     * @type {string}
-     * @memberof Poa
      */
     'poaType'?: PoaPoaTypeEnum;
 }

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

@@ -13,20 +13,11 @@ import type { CapacityType } from './capacity-type';
 import type { 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/api-model/models/range-slot-capacity-errors.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * 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/api-model/models/range-slot-capacity-query.d.ts

@@ -12,26 +12,18 @@
 import type { 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/api-model/models/range-slot-capacity.d.ts

@@ -12,26 +12,18 @@
 import type { 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/api-model/models/range-slot.d.ts

@@ -11,26 +11,18 @@
  */
 /**
  * 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/api-model/models/recurrence.d.ts

@@ -12,26 +12,18 @@
 import type { 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>;
 }

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

@@ -12,20 +12,11 @@
 import type { AppointmentTimeInput } from './appointment-time-input';
 /**
  * Input for rescheduled appointment operation.
- * @export
- * @interface RescheduleAppointmentRequest
  */
 export interface RescheduleAppointmentRequest {
-    /**
-     *
-     * @type {AppointmentTimeInput}
-     * @memberof RescheduleAppointmentRequest
-     */
     'appointmentTime': AppointmentTimeInput;
     /**
      * The appointment reschedule reason code.
-     * @type {string}
-     * @memberof RescheduleAppointmentRequest
      */
     'rescheduleReasonCode': string;
 }