@sp-api-sdk/services-api-v1 1.6.15

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

@@ -0,0 +1,12 @@
+/**
+ * Selling Partner API for Services
+ * With the Services API, you can build applications that help service providers get and modify their service orders.
+ *
+ * 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.
+ */
+export * from './api/service-api';

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

@@ -0,0 +1,55 @@
+/**
+ * Selling Partner API for Services
+ * With the Services API, you can build applications that help service providers get and modify their service orders.
+ *
+ * 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 { AxiosInstance } 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: any;
+}
+/**
+ *
+ * @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;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}

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

@@ -0,0 +1,65 @@
+/**
+ * Selling Partner API for Services
+ * With the Services API, you can build applications that help service providers get and modify their service orders.
+ *
+ * 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 { RequestArgs } from "./base";
+import { AxiosInstance } 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 | undefined) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setBasicAuthToObject: (object: any, configuration?: Configuration | undefined) => void;
+/**
+ *
+ * @export
+ */
+export declare const setBearerAuthToObject: (object: any, configuration?: Configuration | undefined) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration | undefined) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
+/**
+ *
+ * @export
+ */
+export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration | undefined) => any;
+/**
+ *
+ * @export
+ */
+export declare const toPathString: (url: URL) => string;
+/**
+ *
+ * @export
+ */
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration | undefined) => (axios?: AxiosInstance, basePath?: string) => Promise<import("axios").AxiosResponse<any>>;

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

@@ -0,0 +1,83 @@
+/**
+ * Selling Partner API for Services
+ * With the Services API, you can build applications that help service providers get and modify their service orders.
+ *
+ * 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.
+ */
+export interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+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;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * Selling Partner API for Services
+ * With the Services API, you can build applications that help service providers get and modify their service orders.
+ *
+ * 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.
+ */
+export * from "./api";
+export * from "./configuration";
+export * from "./models";

package/dist/types/src/api-model/models/add-appointment-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.
+ *
+ * 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 { 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/src/api-model/models/address.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Selling Partner API for Services
+ * With the Services API, you can build applications that help service providers get and modify their service orders.
+ *
+ * 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 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/src/api-model/models/appointment-time-input.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Selling Partner API for Services
+ * With the Services API, you can build applications that help service providers get and modify their service orders.
+ *
+ * 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 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/src/api-model/models/appointment-time.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Selling Partner API for Services
+ * With the Services API, you can build applications that help service providers get and modify their service orders.
+ *
+ * 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 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/src/api-model/models/appointment.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Selling Partner API for Services
+ * With the Services API, you can build applications that help service providers get and modify their service orders.
+ *
+ * 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 { AppointmentTime } from './appointment-time';
+import { Poa } from './poa';
+import { 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
+    * @enum {string}
+    */
+export declare enum AppointmentAppointmentStatusEnum {
+    Active = "ACTIVE",
+    Cancelled = "CANCELLED",
+    Completed = "COMPLETED"
+}