@shipengine/connect-order-source-api/lib/requests/request-base.js

This is the typescript/javascript definitions for the order source api

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.RequestBase = exports.SalesOrderStatusMapping = exports.Auth = void 0;
/**
 * @description Represents the auth information sent with every request
 */
class Auth {
    /** @description The unique identifier for the type of order source */
    order_source_api_code;
    /** @description The username of the seller making the request for this order source */
    username;
    /** @description The password of the seller making the request for this order source */
    password;
    /** @description The access token of the seller making the request for this order source */
    access_token;
    /** @description The api key of the seller making the request for this order source */
    api_key;
    /** @description The url of the sellers store, only used in cases where the 3rd party api can be hosted on a seller by seller basis */
    url;
    /** @description Additional source-specific information needed to connect to the API. */
    connection_context;
    /** @description The name of the connection used, if this order source has
     * {@link AccountConnectionSpecification.ConnectionNames} and
     * {@link AccountConnectionSpecification.DefaultConnectionName} defined*/
    connection_name;
}
exports.Auth = Auth;
/** @description seller specified mappings for custom statuses coming from the 3rd parties api and the SalesOrderStatus they should map to. */
class SalesOrderStatusMapping {
    /** @description The raw status string used by the order source */
    source_status;
    /**
     * @description The sales order status.
     * @example 'AwaitingPayment','AwaitingShipment','Cancelled','Completed','OnHold','PendingFulfillment'
     */
    maps_to;
}
exports.SalesOrderStatusMapping = SalesOrderStatusMapping;
/**
 * @description This represents information shared by all requests
 */
class RequestBase {
    /** @description A randomly generated transaction ID, used to correlate the request and response */
    transaction_id;
    /** @description The authorization information necessary to fulfill this request. */
    auth;
}
exports.RequestBase = RequestBase;
//# sourceMappingURL=request-base.js.map