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

package/dist/types/api-model/base.d.ts

@@ -12,42 +12,22 @@
 import type { Configuration } from './configuration';
 import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
 export declare const BASE_PATH: string;
-/**
- *
- * @export
- */
 export declare const COLLECTION_FORMATS: {
     csv: string;
     ssv: string;
     tsv: string;
     pipes: string;
 };
-/**
- *
- * @export
- * @interface RequestArgs
- */
 export interface RequestArgs {
     url: string;
     options: RawAxiosRequestConfig;
 }
-/**
- *
- * @export
- * @class BaseAPI
- */
 export declare class BaseAPI {
     protected basePath: string;
     protected axios: AxiosInstance;
     protected configuration: Configuration | undefined;
     constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
 }
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 export declare class RequiredError extends Error {
     field: string;
     constructor(field: string, msg?: string);
@@ -58,9 +38,5 @@ interface ServerMap {
         description: string;
     }[];
 }
-/**
- *
- * @export
- */
 export declare const operationServerMap: ServerMap;
 export {};

package/dist/types/api-model/common.d.ts

@@ -12,54 +12,17 @@
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
 import type { AxiosInstance, AxiosResponse } from 'axios';
-/**
- *
- * @export
- */
 export declare const DUMMY_BASE_URL = "https://example.com";
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
-/**
- *
- * @export
- */
 export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
-/**
- *
- * @export
- */
 export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
-/**
- *
- * @export
- */
 export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
-/**
- *
- * @export
- */
 export declare const toPathString: (url: URL) => string;
-/**
- *
- * @export
- */
 export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/types/api-model/configuration.d.ts

@@ -23,49 +23,32 @@ export declare class Configuration {
     /**
      * parameter for apiKey security
      * @param name security name
-     * @memberof Configuration
      */
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     username?: string;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     password?: string;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
-     * @memberof Configuration
      */
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     /**
      * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     basePath?: string;
     /**
      * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
      */
     serverIndex?: number;
     /**
      * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
      */
     baseOptions?: any;
     /**

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

@@ -12,14 +12,7 @@
 import type { AppointmentTimeInput } from './appointment-time-input';
 /**
  * Input for add appointment operation.
- * @export
- * @interface AddAppointmentRequest
  */
 export interface AddAppointmentRequest {
-    /**
-     *
-     * @type {AppointmentTimeInput}
-     * @memberof AddAppointmentRequest
-     */
     'appointmentTime': AppointmentTimeInput;
 }

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

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

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

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

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

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

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

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

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

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

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

@@ -14,45 +14,25 @@ import type { Poa } from './poa';
 import type { Technician } from './technician';
 /**
  * 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;
-    /**
-     *
-     * @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 declare const AppointmentAppointmentStatusEnum: {

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

@@ -12,14 +12,10 @@
 import type { 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/api-model/models/assign-appointment-resources-response-payload.d.ts

@@ -12,14 +12,10 @@
 import type { 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/api-model/models/assign-appointment-resources-response.d.ts

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

@@ -12,51 +12,32 @@
 import type { ItemDelivery } from './item-delivery';
 /**
  * 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;
     /**
      * The brand name of the item.
-     * @type {string}
-     * @memberof AssociatedItem
      */
     'brandName'?: string;
-    /**
-     *
-     * @type {ItemDelivery}
-     * @memberof AssociatedItem
-     */
     'itemDelivery'?: ItemDelivery;
 }
 export declare const AssociatedItemItemStatusEnum: {

package/dist/types/api-model/models/availability-record.d.ts

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

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

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

@@ -11,14 +11,10 @@
  */
 /**
  * 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/api-model/models/cancel-service-job-by-service-job-id-response.d.ts

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

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

@@ -11,8 +11,6 @@
  */
 /**
  * Type of capacity
- * @export
- * @enum {string}
  */
 export declare const CapacityType: {
     readonly ScheduledCapacity: "SCHEDULED_CAPACITY";

package/dist/types/api-model/models/complete-service-job-by-service-job-id-response.d.ts

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

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

@@ -13,26 +13,15 @@ import type { Reservation } from './reservation';
 import type { 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>;
 }