@shipengine/connect-inventory-api
Version:
OpenAPI specification and TypeScript definitions for the Connect Inventory API
89 lines • 2.61 kB
JavaScript
Object.defineProperty(exports, "__esModule", { value: true });
exports.PushPaging = exports.PushDone = exports.FetchPaging = exports.FetchDone = exports.PushProcessing = exports.FetchProcessing = exports.OperationProcessing = exports.OperationReady = exports.OperationStatus = void 0;
/**
* Enumeration of possible states for fetch or push operations.
* A representation of an 'error' state is omitted since an error
* outcome results in throwing one of the predefined Connect-runtime
* error objects.
*/
var OperationStatus;
(function (OperationStatus) {
OperationStatus["DONE"] = "DONE";
OperationStatus["PROCESSING"] = "PROCESSING";
OperationStatus["PAGING"] = "PAGING";
OperationStatus["READY"] = "READY";
})(OperationStatus || (exports.OperationStatus = OperationStatus = {}));
/**
* Return shape of a fetch or push operation that is done
* processing and ready for the client to consume results.
*/
class OperationReady {
status;
cursor;
message;
}
exports.OperationReady = OperationReady;
/**
* Return shape of a fetch or push operation that is still
* processing at the inventory source, not yet ready for the
* client to consume results.
*/
class OperationProcessing {
status;
message;
cursor;
poll_after_seconds;
}
exports.OperationProcessing = OperationProcessing;
/** Return shape for a fetch operation that's still processing. */
class FetchProcessing extends OperationProcessing {
}
exports.FetchProcessing = FetchProcessing;
/** Return shape for a push operation that's still processing. */
class PushProcessing extends OperationProcessing {
}
exports.PushProcessing = PushProcessing;
/**
* Return shape for a completed fetch operation that has
* no further result data for the client to consume.
*/
class FetchDone {
status;
items;
message;
}
exports.FetchDone = FetchDone;
/**
* Return shape for a completed fetch operation that still has
* more result data for the client to page through & consume.
*/
class FetchPaging {
status;
items;
message;
next_cursor;
}
exports.FetchPaging = FetchPaging;
/**
* Return shape for a completed push operation that has
* no further result data for the client to consume.
*/
class PushDone {
status;
skus_updated;
message;
}
exports.PushDone = PushDone;
/**
* Return shape for a completed push operation that still has
* more result data for the client to page through & consume.
*/
class PushPaging {
status;
skus_updated;
message;
next_cursor;
}
exports.PushPaging = PushPaging;
//# sourceMappingURL=responses.js.map
;