@scaleleap/selling-partner-api-sdk/lib/api-models/services-api-model/api.d.ts

📦 A fully typed TypeScript and Node.js SDK library for Amazon Selling Partner API

/**
 * 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 { Configuration } from './configuration';
import { AxiosPromise, AxiosInstance } from 'axios';
import { RequestArgs, BaseAPI } from './base';
/**
 * Input for add appointment operation.
 * @export
 * @interface AddAppointmentRequest
 */
export interface AddAppointmentRequest {
    /**
     *
     * @type {AppointmentTimeInput}
     * @memberof AddAppointmentRequest
     */
    appointmentTime: AppointmentTimeInput;
}
/**
 * The shipping address for the service job.
 * @export
 * @interface Address
 */
export interface Address {
    /**
     * The name of the person, business, or institution.
     * @type {string}
     * @memberof Address
     */
    name: string;
    /**
     * The first line of the address.
     * @type {string}
     * @memberof Address
     */
    addressLine1: string;
    /**
     * Additional address information, if required.
     * @type {string}
     * @memberof Address
     */
    addressLine2?: string;
    /**
     * Additional address information, if required.
     * @type {string}
     * @memberof Address
     */
    addressLine3?: string;
    /**
     * The city.
     * @type {string}
     * @memberof Address
     */
    city?: string;
    /**
     * The county.
     * @type {string}
     * @memberof Address
     */
    county?: string;
    /**
     * The district.
     * @type {string}
     * @memberof Address
     */
    district?: string;
    /**
     * The state or region.
     * @type {string}
     * @memberof Address
     */
    stateOrRegion?: string;
    /**
     * The postal code. This can contain letters, digits, spaces, and/or punctuation.
     * @type {string}
     * @memberof Address
     */
    postalCode?: string;
    /**
     * The two digit country code, in ISO 3166-1 alpha-2 format.
     * @type {string}
     * @memberof Address
     */
    countryCode?: string;
    /**
     * The phone number.
     * @type {string}
     * @memberof Address
     */
    phone?: string;
}
/**
 * The details of an appointment.
 * @export
 * @interface Appointment
 */
export interface Appointment {
    /**
     * The appointment identifier.
     * @type {string}
     * @memberof Appointment
     */
    appointmentId?: string;
    /**
     * The status of the appointment.
     * @type {string}
     * @memberof Appointment
     */
    appointmentStatus?: AppointmentAppointmentStatusEnum | 'ACTIVE' | 'CANCELLED' | 'COMPLETED';
    /**
     *
     * @type {AppointmentTime}
     * @memberof Appointment
     */
    appointmentTime?: AppointmentTime;
    /**
     * A list of technicians assigned to the service job.
     * @type {Array<Technician>}
     * @memberof Appointment
     */
    assignedTechnicians?: Array<Technician>;
    /**
     * The appointment identifier.
     * @type {string}
     * @memberof Appointment
     */
    rescheduledAppointmentId?: string;
    /**
     *
     * @type {Poa}
     * @memberof Appointment
     */
    poa?: Poa;
}
/**
    * @export
    * @enum {string}
    */
export declare enum AppointmentAppointmentStatusEnum {
    Active = "ACTIVE",
    Cancelled = "CANCELLED",
    Completed = "COMPLETED"
}
/**
 * The resource that performs or performed appointment fulfillment.
 * @export
 * @interface AppointmentResource
 */
export interface AppointmentResource {
    /**
     * The resource identifier.
     * @type {string}
     * @memberof AppointmentResource
     */
    resourceId?: string;
}
/**
 * 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;
}
/**
 * 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 | 'REAL_TIME_SCHEDULING' | 'NON_REAL_TIME_SCHEDULING';
    /**
     * 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
    * @enum {string}
    */
export declare enum AppointmentSlotReportSchedulingTypeEnum {
    RealTimeScheduling = "REAL_TIME_SCHEDULING",
    NonRealTimeScheduling = "NON_REAL_TIME_SCHEDULING"
}
/**
 * The time of the appointment window.
 * @export
 * @interface AppointmentTime
 */
export interface AppointmentTime {
    /**
     * The date and time of the start of the appointment window in ISO 8601 format.
     * @type {string}
     * @memberof AppointmentTime
     */
    startTime: string;
    /**
     * The duration of the appointment window, in minutes.
     * @type {number}
     * @memberof AppointmentTime
     */
    durationInMinutes: number;
}
/**
 * The input appointment time details.
 * @export
 * @interface AppointmentTimeInput
 */
export interface AppointmentTimeInput {
    /**
     * The date, time in UTC for the start time of an appointment in ISO 8601 format.
     * @type {string}
     * @memberof AppointmentTimeInput
     */
    startTime: string;
    /**
     * The duration of an appointment in minutes.
     * @type {number}
     * @memberof AppointmentTimeInput
     */
    durationInMinutes?: number;
}
/**
 * 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>;
}
/**
 * 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>;
}
/**
 * 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>;
}
/**
 * Information about an item associated with the service job.
 * @export
 * @interface AssociatedItem
 */
export interface AssociatedItem {
    /**
     * The Amazon Standard Identification Number (ASIN) of the item.
     * @type {string}
     * @memberof AssociatedItem
     */
    asin?: string;
    /**
     * The title of the item.
     * @type {string}
     * @memberof AssociatedItem
     */
    title?: string;
    /**
     * The total number of items included in the order.
     * @type {number}
     * @memberof AssociatedItem
     */
    quantity?: number;
    /**
     * The Amazon-defined identifier for an order placed by the buyer, in 3-7-7 format.
     * @type {string}
     * @memberof AssociatedItem
     */
    orderId?: string;
    /**
     * The status of the item.
     * @type {string}
     * @memberof AssociatedItem
     */
    itemStatus?: AssociatedItemItemStatusEnum | 'ACTIVE' | 'CANCELLED' | 'SHIPPED' | 'DELIVERED';
    /**
     * The brand name of the item.
     * @type {string}
     * @memberof AssociatedItem
     */
    brandName?: string;
    /**
     *
     * @type {ItemDelivery}
     * @memberof AssociatedItem
     */
    itemDelivery?: ItemDelivery;
}
/**
    * @export
    * @enum {string}
    */
export declare enum AssociatedItemItemStatusEnum {
    Active = "ACTIVE",
    Cancelled = "CANCELLED",
    Shipped = "SHIPPED",
    Delivered = "DELIVERED"
}
/**
 * `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;
}
/**
 * Information about the buyer.
 * @export
 * @interface Buyer
 */
export interface Buyer {
    /**
     * The identifier of the buyer.
     * @type {string}
     * @memberof Buyer
     */
    buyerId?: string;
    /**
     * The name of the buyer.
     * @type {string}
     * @memberof Buyer
     */
    name?: string;
    /**
     * The phone number of the buyer.
     * @type {string}
     * @memberof Buyer
     */
    phone?: string;
    /**
     * When true, the service is for an Amazon Prime buyer.
     * @type {boolean}
     * @memberof Buyer
     */
    isPrimeMember?: boolean;
}
/**
 * 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>;
}
/**
 * Response schema for the `cancelServiceJobByServiceJobId` operation.
 * @export
 * @interface CancelServiceJobByServiceJobIdResponse
 */
export interface CancelServiceJobByServiceJobIdResponse {
    /**
     * A list of error responses returned when a request is unsuccessful.
     * @type {Array<Error>}
     * @memberof CancelServiceJobByServiceJobIdResponse
     */
    errors?: Array<Error>;
}
/**
 * Type of capacity
 * @export
 * @enum {string}
 */
export declare enum CapacityType {
    ScheduledCapacity = "SCHEDULED_CAPACITY",
    AvailableCapacity = "AVAILABLE_CAPACITY",
    EncumberedCapacity = "ENCUMBERED_CAPACITY",
    ReservedCapacity = "RESERVED_CAPACITY"
}
/**
 * Response schema for the `completeServiceJobByServiceJobId` operation.
 * @export
 * @interface CompleteServiceJobByServiceJobIdResponse
 */
export interface CompleteServiceJobByServiceJobIdResponse {
    /**
     * A list of error responses returned when a request is unsuccessful.
     * @type {Array<Error>}
     * @memberof CompleteServiceJobByServiceJobIdResponse
     */
    errors?: Array<Error>;
}
/**
 * `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>;
}
/**
 * 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;
}
/**
 * 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>;
}
/**
 * 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>;
}
/**
 * The day of the week.
 * @export
 * @enum {string}
 */
export declare enum DayOfWeek {
    Monday = "MONDAY",
    Tuesday = "TUESDAY",
    Wednesday = "WEDNESDAY",
    Thursday = "THURSDAY",
    Friday = "FRIDAY",
    Saturday = "SATURDAY",
    Sunday = "SUNDAY"
}
/**
 * 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 | 'AES';
    /**
     * 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
    * @enum {string}
    */
export declare enum EncryptionDetailsStandardEnum {
    Aes = "AES"
}
/**
 * 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;
}
/**
 * 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;
}
/**
 * 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>;
}
/**
 * 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 | 'SCHEDULED_CAPACITY' | 'AVAILABLE_CAPACITY' | 'ENCUMBERED_CAPACITY' | 'RESERVED_CAPACITY')>;
    /**
     * 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;
}
/**
 * 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;
}
/**
 * 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;
}
/**
 * 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>;
}
/**
 * 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>;
}
/**
 * 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>;
}
/**
 * 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;
}
/**
 * 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;
}
/**
 * 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>;
}
/**
 * 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 in a human-readable form.
     * @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 | 'ERROR' | 'WARNING';
}
/**
    * @export
    * @enum {string}
    */
export declare enum ModelErrorErrorLevelEnum {
    Error = "ERROR",
    Warning = "WARNING"
}
/**
 * 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 | 'NO_SIGNATURE_DUMMY_POS' | 'CUSTOMER_SIGNATURE' | 'DUMMY_RECEIPT' | 'POA_RECEIPT';
}
/**
    * @export
    * @enum {string}
    */
export declare enum PoaPoaTypeEnum {
    NoSignatureDummyPos = "NO_SIGNATURE_DUMMY_POS",
    CustomerSignature = "CUSTOMER_SIGNATURE",
    DummyReceipt = "DUMMY_RECEIPT",
    PoaReceipt = "POA_RECEIPT"
}
/**
 * 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 | 'SCHEDULED_CAPACITY' | 'AVAILABLE_CAPACITY' | 'ENCUMBERED_CAPACITY' | 'RESERVED_CAPACITY';
    /**
     * Array of capacity slots in range slot format.
     * @type {Array<RangeSlot>}
     * @memberof RangeCapacity
     */
    slots?: Array<RangeSlot>;
}
/**
 * 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;
}
/**
 * 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;
}
/**
 * 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>;
}
/**
 * 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 | 'SCHEDULED_CAPACITY' | 'AVAILABLE_CAPACITY' | 'ENCUMBERED_CAPACITY' | 'RESERVED_CAPACITY')>;
    /**
     * 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;
}
/**
 * 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 | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY')>;
    /**
     * Days of the month when recurrence is valid.
     * @type {Array<number>}
     * @memberof Recurrence
     */
    daysOfMonth?: Array<number>;
}
/**
 * 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;
}
/**
 * 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 | 'APPOINTMENT' | 'TRAVEL' | 'VACATION' | 'BREAK' | 'TRAINING';
    /**
     *
     * @type {AvailabilityRecord}
     * @memberof Reservation
     */
    availability: AvailabilityRecord;
}
/**
    * @export
    * @enum {string}
    */
export declare enum ReservationTypeEnum {
    Appointment = "APPOINTMENT",
    Travel = "TRAVEL",
    Vacation = "VACATION",
    Break = "BREAK",
    Training = "TRAINING"
}
/**
 * The scope of work for the order.
 * @export
 * @interface ScopeOfWork
 */
export interface ScopeOfWork {
    /**
     * The Amazon Standard Identification Number (ASIN) of the service job.
     * @type {string}
     * @memberof ScopeOfWork
     */
    asin?: string;
    /**
     * The title of the service job.
     * @type {string}
     * @memberof ScopeOfWork
     */
    title?: string;
    /**
     * The number of service jobs.
     * @type {number}
     * @memberof ScopeOfWork
     */
    quantity?: number;
    /**
     * A list of skills required to perform the job.
     * @type {Array<string>}
     * @memberof ScopeOfWork
     */
    requiredSkills?: Array<string>;
}
/**
 * Information about the seller of the service job.
 * @export
 * @interface Seller
 */
export interface Seller {
    /**
     * The identifier of the seller of the service job.
     * @type {string}
     * @memberof Seller
     */
    sellerId?: string;
}
/**
 * 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;
}
/**
 * The job details of a service.
 * @export
 * @interface ServiceJob
 */
export interface ServiceJob {
    /**
     * The date and time of the creation of the job in ISO 8601 format.
     * @type {string}
     * @memberof ServiceJob
     */
    createTime?: string;
    /**
     * Amazon identifier for the service job.
     * @type {string}
     * @memberof ServiceJob
     */
    serviceJobId?: string;
    /**
     * The status of the service job.
     * @type {string}
     * @memberof ServiceJob
     */
    serviceJobStatus?: ServiceJobServiceJobStatusEnum | 'NOT_SERVICED' | 'CANCELLED' | 'COMPLETED' | 'PENDING_SCHEDULE' | 'NOT_FULFILLABLE' | 'HOLD' | 'PAYMENT_DECLINED';
    /**
     *
     * @type {ScopeOfWork}
     * @memberof ServiceJob
     */
    scopeOfWork?: ScopeOfWork;
    /**
     *
     * @type {Seller}
     * @memberof ServiceJob
     */
    seller?: Seller;
    /**
     *
     * @type {ServiceJobProvider}
     * @memberof ServiceJob
     */
    serviceJobProvider?: ServiceJobProvider;
    /**
     * A list of appointment windows preferred by the buyer. Included only if the buyer selected appointment windows when creating the order.
     * @type {Array<AppointmentTime>}
     * @memberof ServiceJob
     */
    preferredAppointmentTimes?: Array<AppointmentTime>;
    /**
     * A list of appointments.
     * @type {Array<Appointment>}
     * @memberof ServiceJob
     */
    appointments?: Array<Appointment>;
    /**
     * The Amazon-defined identifier for an order placed by the buyer, in 3-7-7 format.
     * @type {string}
     * @memberof ServiceJob
     */
    serviceOrderId?: string;
    /**
     * The marketplace identifier.
     * @type {string}
     * @memberof ServiceJob
     */
    marketplaceId?: string;
    /**
     * The Amazon-defined identifier for the region scope.
     * @type {string}
     * @memberof ServiceJob
     */
    storeId?: string;
    /**
     *
     * @type {Buyer}
     * @memberof ServiceJob
     */
    buyer?: Buyer;
    /**
     * A list of items associated with the service job.
     * @type {Array<AssociatedItem>}
     * @memberof ServiceJob
     */
    associatedItems?: Array<AssociatedItem>;
    /**
     *
     * @type {ServiceLocation}
     * @memberof ServiceJob
     */
    serviceLocation?: ServiceLocation;
}
/**
    * @export
    * @enum {string}
    */
export declare enum ServiceJobServiceJobStatusEnum {
    NotServiced = "NOT_SERVICED",
    Cancelled = "CANCELLED",
    Completed = "COMPLETED",
    PendingSchedule = "PENDING_SCHEDULE",
    NotFulfillable = "NOT_FULFILLABLE",
    Hold = "HOLD",
    PaymentDeclined = "PAYMENT_DECLINED"
}
/**
 * Information about the service job provider.
 * @export
 * @interface ServiceJobProvider
 */
export interface ServiceJobProvider {
    /**
     * The identifier of the service job provider.
     * @type {string}
     * @memberof ServiceJobProvider
     */
    serviceJobProviderId?: string;
}
/**
 * Information about the location of the service job.
 * @export
 * @interface ServiceLocation
 */
export interface ServiceLocation {
    /**
     * The location of the service job.
     * @type {string}
     * @memberof ServiceLocation
     */
    serviceLocationType?: ServiceLocationServiceLocationTypeEnum | 'IN_HOME' | 'IN_STORE' | 'ONLINE';
    /**
     *
     * @type {Address}
     * @memberof ServiceLocation
     */
    address?: Address;
}
/**
    * @export
    * @enum {string}
    */
export declare enum ServiceLocationServiceLocationTypeEnum {
    InHome = "IN_HOME",
    InStore = "IN_STORE",
    Online = "ONLINE"
}
/**
 * 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 | 'TIFF' | 'JPG' | 'PNG' | 'JPEG' | 'GIF' | 'PDF';
    /**
     * 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
    * @enum {string}
    */
export declare enum ServiceUploadDocumentContentTypeEnum {
    Tiff = "TIFF",
    Jpg = "JPG",
    Png = "PNG",
    Jpeg = "JPEG",
    Gif = "GIF",
    Pdf = "PDF"
}
/**
 * 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>;
}
/**
 * Response schema for the `addAppointmentForServiceJobByServiceJobId` and `rescheduleAppointmentForServiceJobByServiceJobId` operations.
 * @export
 * @interface SetAppointmentResponse
 */
export interface SetAppointmentResponse {
    /**
     * The appointment identifier.
     * @type {string}
     * @memberof SetAppointmentResponse
     */
    appointmentId?: string;
    /**
     * A list of warnings returned in the sucessful execution response of an API request.
     * @type {Array<Warning>}
     * @memberof SetAppointmentResponse
     */
    warnings?: Array<Warning>;
    /**
     * A list of error responses returned when a request is unsuccessful.
     * @type {Array<Error>}
     * @memberof SetAppointmentResponse
     */
    errors?: Array<Error>;
}
/**
 * A technician who is assigned to perform the service job in part or in full.
 * @export
 * @interface Technician
 */
export interface Technician {
    /**
     * The technician identifier.
     * @type {string}
     * @memberof Technician
     */
    technicianId?: string;
    /**
     * The name of the technician.
     * @type {string}
     * @memberof Technician
     */
    name?: string;
}
/**
 * `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>;
}
/**
 * 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;
}
/**
 * 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>;
}
/**
 * `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>;
}
/**
 * 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>;
}
/**
 * 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>;
}
/**
 * Warning returned when the request is successful, but there are important callouts based on which API clients should take defined actions.
 * @export
 * @interface Warning
 */
export interface Warning {
    /**
     * An warning code that identifies the type of warning that occurred.
     * @type {string}
     * @memberof Warning
     */
    code: string;
    /**
     * A message that describes the warning condition in a human-readable form.
     * @type {string}
     * @memberof Warning
     */
    message: string;
    /**
     * Additional details that can help the caller understand or address the warning.
     * @type {string}
     * @memberof Warning
     */
    details?: string;
}
/**
 * ServiceApi - axios parameter creator
 * @export
 */
export declare const ServiceApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Adds an appointment to the service job indicated by the service job identifier specified.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).
     * @param {string} serviceJobId An Amazon defined service job identifier.
     * @param {AddAppointmentRequest} body Add appointment operation input details.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addAppointmentForServiceJobByServiceJobId: (serviceJobId: string, body: AddAppointmentRequest, options?: any) => Promise<RequestArgs>;
    /**
     * Assigns new resource(s) or overwrite/update the existing one(s) to a service job appointment.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).
     * @param {string} serviceJobId An Amazon-defined service job identifier. Get this value by calling the &#x60;getServiceJobs&#x60; operation of the Services API.
     * @param {string} appointmentId An Amazon-defined identifier of active service job appointment.
     * @param {AssignAppointmentResourcesRequest} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    assignAppointmentResources: (serviceJobId: string, appointmentId: string, body: AssignAppointmentResourcesRequest, options?: any) => Promise<RequestArgs>;
    /**
     * Cancel a reservation.   **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).
     * @param {string} reservationId Reservation Identifier
     * @param {Array<string>} marketplaceIds An identifier for the marketplace in which the resource operates.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    cancelReservation: (reservationId: string, marketplaceIds: Array<string>, options?: any) => Promise<RequestArgs>;
    /**
     * Cancels the service job indicated by the service job identifier specified.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).
     * @param {string} serviceJobId An Amazon defined service job identifier.
     * @param {string} cancellationReasonCode A cancel reason code that specifies the reason for cancelling a service job.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    cancelServiceJobByServiceJobId: (serviceJobId: string, cancellationReasonCode: string, options?: any) => Promise<RequestArgs>;
    /**
     * Completes the service job indicated by the service job identifier specified.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).
     * @param {string} serviceJobId An Amazon defined service job identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    completeServiceJobByServiceJobId: (serviceJobId: string, options?: any) => Promise<RequestArgs>;
    /**
     * Create a reservation.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-