@shipengine/connect-fulfillment-provider-api 0.2.1 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/app/fulfillment-provider-app-definition.d.ts +10 -6
- package/lib/app/fulfillment-provider-app-metadata.d.ts +2 -0
- package/lib/app/fulfillment-provider-app-metadata.js.map +1 -1
- package/lib/app/fulfillment-provider-app.js +12 -7
- package/lib/app/fulfillment-provider-app.js.map +1 -1
- package/lib/requests/{cancellation-request.d.ts → cancel-fulfillment-request.d.ts} +1 -1
- package/lib/requests/cancel-fulfillment-request.js +3 -0
- package/lib/requests/cancel-fulfillment-request.js.map +1 -0
- package/lib/requests/{delegation-request.d.ts → delegate-fulfillment-request.d.ts} +1 -1
- package/lib/requests/delegate-fulfillment-request.js +3 -0
- package/lib/requests/delegate-fulfillment-request.js.map +1 -0
- package/lib/requests/{status-request.d.ts → get-fulfillment-request.d.ts} +1 -1
- package/lib/requests/{inventory-request.js → get-fulfillment-request.js} +1 -1
- package/lib/requests/get-fulfillment-request.js.map +1 -0
- package/lib/requests/{inventory-request.d.ts → get-inventory-request.d.ts} +1 -1
- package/lib/requests/{delegation-request.js → get-inventory-request.js} +1 -1
- package/lib/requests/get-inventory-request.js.map +1 -0
- package/lib/requests/index.d.ts +4 -4
- package/lib/requests/index.js +4 -4
- package/lib/requests/index.js.map +1 -1
- package/lib/responses/cancel-fulfillment-response.d.ts +1 -0
- package/lib/responses/cancel-fulfillment-response.js +3 -0
- package/lib/responses/cancel-fulfillment-response.js.map +1 -0
- package/lib/responses/delegate-fulfillment-response.d.ts +3 -0
- package/lib/responses/delegate-fulfillment-response.js +3 -0
- package/lib/responses/delegate-fulfillment-response.js.map +1 -0
- package/lib/responses/{status-response.d.ts → get-fulfillment-response.d.ts} +2 -2
- package/lib/{requests/status-request.js → responses/get-fulfillment-response.js} +1 -1
- package/lib/responses/get-fulfillment-response.js.map +1 -0
- package/lib/responses/{inventory-response.d.ts → get-inventory-response.d.ts} +1 -1
- package/lib/{requests/cancellation-request.js → responses/get-inventory-response.js} +1 -1
- package/lib/responses/get-inventory-response.js.map +1 -0
- package/lib/responses/index.d.ts +4 -4
- package/lib/responses/index.js +4 -4
- package/lib/responses/index.js.map +1 -1
- package/package.json +1 -1
- package/spec.json +2762 -2698
- package/spec.yaml +69 -28
- package/tsconfig.tsbuildinfo +1 -1
- package/lib/requests/cancellation-request.js.map +0 -1
- package/lib/requests/delegation-request.js.map +0 -1
- package/lib/requests/inventory-request.js.map +0 -1
- package/lib/requests/status-request.js.map +0 -1
- package/lib/responses/cancellation-response.d.ts +0 -3
- package/lib/responses/cancellation-response.js +0 -3
- package/lib/responses/cancellation-response.js.map +0 -1
- package/lib/responses/delegation-response.d.ts +0 -3
- package/lib/responses/delegation-response.js +0 -3
- package/lib/responses/delegation-response.js.map +0 -1
- package/lib/responses/inventory-response.js +0 -3
- package/lib/responses/inventory-response.js.map +0 -1
- package/lib/responses/status-response.js +0 -3
- package/lib/responses/status-response.js.map +0 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { FulfillmentProviderAppMetadata } from './fulfillment-provider-app-metadata';
|
|
2
|
-
import { ConnectRequest,
|
|
3
|
-
import { ConnectResponse,
|
|
2
|
+
import { ConnectRequest, DelegateFulfillmentRequest, GetFulfillmentRequest, CancelFulfillmentRequest, GetInventoryRequest, GetRatesRequest, GetRecentChangesRequest } from '..';
|
|
3
|
+
import { ConnectResponse, DelegateFulfillmentResponse, GetFulfillmentResponse, CancelFulfillmentResponse, GetInventoryResponse, GetRatesResponse, GetRecentChangesResponse } from '..';
|
|
4
4
|
/**
|
|
5
5
|
* Definition for an Fulfillment Provider App implementation
|
|
6
6
|
*/
|
|
@@ -13,21 +13,25 @@ export interface FulfillmentProviderAppDefinition {
|
|
|
13
13
|
/**
|
|
14
14
|
* Delegate a fulfillment to a provider.
|
|
15
15
|
*/
|
|
16
|
-
delegateFulfillment: (request:
|
|
16
|
+
delegateFulfillment: (request: DelegateFulfillmentRequest) => Promise<DelegateFulfillmentResponse>;
|
|
17
17
|
/**
|
|
18
18
|
* Get the current status of a single fulfillment from a provider.
|
|
19
19
|
*/
|
|
20
|
-
|
|
20
|
+
getFulfillment: (request: GetFulfillmentRequest) => Promise<GetFulfillmentResponse>;
|
|
21
21
|
/**
|
|
22
22
|
* Request that a delegated fulfillment be cancelled by the provider.
|
|
23
23
|
*/
|
|
24
|
-
|
|
24
|
+
cancelFulfillment: (request: CancelFulfillmentRequest) => Promise<CancelFulfillmentResponse>;
|
|
25
25
|
/**
|
|
26
26
|
* Get rates for a fulfillment preview from a provider.
|
|
27
27
|
*/
|
|
28
28
|
getRates: (request: GetRatesRequest) => Promise<GetRatesResponse>;
|
|
29
29
|
/**
|
|
30
|
-
* Get recent changes for all fulfillments since a specified time
|
|
30
|
+
* Get recent changes for all fulfillments since a specified time.
|
|
31
31
|
*/
|
|
32
32
|
getRecentChanges: (request: GetRecentChangesRequest) => Promise<GetRecentChangesResponse>;
|
|
33
|
+
/**
|
|
34
|
+
* Get pages results of inventory from a provider.
|
|
35
|
+
*/
|
|
36
|
+
getInventory: (request: GetInventoryRequest) => Promise<GetInventoryResponse>;
|
|
33
37
|
}
|
|
@@ -14,6 +14,8 @@ export declare type FulfillmentServiceDefinition = {
|
|
|
14
14
|
Name: string;
|
|
15
15
|
/** @description Shortened name of the shipping service */
|
|
16
16
|
Abbreviation?: string;
|
|
17
|
+
/** @description Api service code used for rates and labels */
|
|
18
|
+
Code: string;
|
|
17
19
|
};
|
|
18
20
|
/** @description Defined metadata for a branded fulfillment provider */
|
|
19
21
|
export declare type FulfillmentProviderDefinition = {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fulfillment-provider-app-metadata.js","sourceRoot":"","sources":["../../src/app/fulfillment-provider-app-metadata.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"fulfillment-provider-app-metadata.js","sourceRoot":"","sources":["../../src/app/fulfillment-provider-app-metadata.ts"],"names":[],"mappings":";;;AAqDA,oFAAoF;AACpF,MAAa,iBAAiB;CAsB7B;AAtBD,8CAsBC;AAED,MAAa,cAAc;CAI1B;AAJD,wCAIC;AAED,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,qCAAe,CAAA;IACf,qCAAe,CAAA;IACf,uCAAiB,CAAA;AACnB,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B;AAED,MAAa,WAAW;CAGvB;AAHD,kCAGC;AAED,MAAa,0BAA0B;CAetC;AAfD,gEAeC;AAED,MAAa,SAAS;CAKrB;AALD,8BAKC;AAED,MAAa,kBAAkB;CAE9B;AAFD,gDAEC;AAED,MAAa,yBAAyB;CAarC;AAbD,8DAaC;AAED,MAAa,mCAAmC;CAqB/C;AArBD,kFAqBC;AAED,MAAa,qBAAqB;CAMjC;AAND,sDAMC;AAMD,MAAa,yBAAyB;CAarC;AAbD,8DAaC;AAED,MAAa,4BAA4B;CAKxC;AALD,oEAKC"}
|
|
@@ -19,29 +19,34 @@ class FulfillmentProviderApp {
|
|
|
19
19
|
},
|
|
20
20
|
{
|
|
21
21
|
method: internal_1.Method.POST,
|
|
22
|
-
path: '/
|
|
22
|
+
path: '/delegate_fulfillment',
|
|
23
23
|
handler: handleRequest(definition.delegateFulfillment),
|
|
24
24
|
},
|
|
25
25
|
{
|
|
26
26
|
method: internal_1.Method.POST,
|
|
27
|
-
path: '/
|
|
28
|
-
handler: handleRequest(definition.
|
|
27
|
+
path: '/get_fulfillment',
|
|
28
|
+
handler: handleRequest(definition.getFulfillment),
|
|
29
29
|
},
|
|
30
30
|
{
|
|
31
31
|
method: internal_1.Method.POST,
|
|
32
|
-
path: '/
|
|
33
|
-
handler: handleRequest(definition.
|
|
32
|
+
path: '/cancel_fulfillment',
|
|
33
|
+
handler: handleRequest(definition.cancelFulfillment),
|
|
34
34
|
},
|
|
35
35
|
{
|
|
36
36
|
method: internal_1.Method.POST,
|
|
37
|
-
path: '/
|
|
37
|
+
path: '/get_rates',
|
|
38
38
|
handler: handleRequest(definition.getRates),
|
|
39
39
|
},
|
|
40
40
|
{
|
|
41
41
|
method: internal_1.Method.POST,
|
|
42
|
-
path: '/
|
|
42
|
+
path: '/get_recent_changes',
|
|
43
43
|
handler: handleRequest(definition.getRecentChanges),
|
|
44
44
|
},
|
|
45
|
+
{
|
|
46
|
+
method: internal_1.Method.POST,
|
|
47
|
+
path: '/get_inventory',
|
|
48
|
+
handler: handleRequest(definition.getInventory),
|
|
49
|
+
},
|
|
45
50
|
];
|
|
46
51
|
this.data = new internal_1.FulfillmentProviderAppSpecification(definition.metadata, this.routes);
|
|
47
52
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fulfillment-provider-app.js","sourceRoot":"","sources":["../../src/app/fulfillment-provider-app.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"fulfillment-provider-app.js","sourceRoot":"","sources":["../../src/app/fulfillment-provider-app.ts"],"names":[],"mappings":";;;AACA,kCAA+C;AAC/C,yCAMoB;AAEpB,MAAM,aAAa,GAAG,CAAC,cAAwB,EAAO,EAAE;IACtD,OAAO,CAAC,OAAY,EAAE,EAAE;QACtB,OAAO,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAa,sBAAsB;IAKjC,YAAY,UAA4C;QAFxD,UAAK,GAAG,IAAI,CAAC,SAAS,CAAC,2BAAoB,CAAC,CAAC;QAG3C,IAAI,CAAC,MAAM,GAAG;YACZ;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC;aAC3C;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,uBAAuB;gBAC7B,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,mBAAmB,CAAC;aACvD;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,cAAc,CAAC;aAClD;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,qBAAqB;gBAC3B,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,iBAAiB,CAAC;aACrD;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,YAAY;gBAClB,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,QAAQ,CAAC;aAC5C;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,qBAAqB;gBAC3B,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,gBAAgB,CAAC;aACpD;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,gBAAgB;gBACtB,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,YAAY,CAAC;aAChD;SACF,CAAC;QAEF,IAAI,CAAC,IAAI,GAAG,IAAI,8CAAmC,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACxF,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;YACrD,OAAO;gBACL,EAAE,EAAE,QAAQ,CAAC,EAAE;gBACf,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO;gBAC7B,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO;aAC9B,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAxDD,wDAwDC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cancel-fulfillment-request.js","sourceRoot":"","sources":["../../src/requests/cancel-fulfillment-request.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"delegate-fulfillment-request.js","sourceRoot":"","sources":["../../src/requests/delegate-fulfillment-request.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"get-fulfillment-request.js","sourceRoot":"","sources":["../../src/requests/get-fulfillment-request.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"get-inventory-request.js","sourceRoot":"","sources":["../../src/requests/get-inventory-request.ts"],"names":[],"mappings":""}
|
package/lib/requests/index.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
export * from './
|
|
1
|
+
export * from './cancel-fulfillment-request';
|
|
2
2
|
export * from './connect-request';
|
|
3
|
-
export * from './
|
|
3
|
+
export * from './delegate-fulfillment-request';
|
|
4
4
|
export * from './reconnect-request';
|
|
5
|
-
export * from './
|
|
6
|
-
export * from './inventory-request';
|
|
5
|
+
export * from './get-fulfillment-request';
|
|
6
|
+
export * from './get-inventory-request';
|
|
7
7
|
export * from './get-rates-request';
|
|
8
8
|
export * from './get-recent-changes-request';
|
package/lib/requests/index.js
CHANGED
|
@@ -10,12 +10,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
10
10
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
11
11
|
};
|
|
12
12
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
13
|
-
__exportStar(require("./
|
|
13
|
+
__exportStar(require("./cancel-fulfillment-request"), exports);
|
|
14
14
|
__exportStar(require("./connect-request"), exports);
|
|
15
|
-
__exportStar(require("./
|
|
15
|
+
__exportStar(require("./delegate-fulfillment-request"), exports);
|
|
16
16
|
__exportStar(require("./reconnect-request"), exports);
|
|
17
|
-
__exportStar(require("./
|
|
18
|
-
__exportStar(require("./inventory-request"), exports);
|
|
17
|
+
__exportStar(require("./get-fulfillment-request"), exports);
|
|
18
|
+
__exportStar(require("./get-inventory-request"), exports);
|
|
19
19
|
__exportStar(require("./get-rates-request"), exports);
|
|
20
20
|
__exportStar(require("./get-recent-changes-request"), exports);
|
|
21
21
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/requests/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/requests/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+DAA6C;AAC7C,oDAAkC;AAClC,iEAA+C;AAC/C,sDAAoC;AACpC,4DAA0C;AAC1C,0DAAwC;AACxC,sDAAoC;AACpC,+DAA6C"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare type CancelFulfillmentResponse = {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cancel-fulfillment-response.js","sourceRoot":"","sources":["../../src/responses/cancel-fulfillment-response.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"delegate-fulfillment-response.js","sourceRoot":"","sources":["../../src/responses/delegate-fulfillment-response.ts"],"names":[],"mappings":""}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { SalesOrderStatusChange } from '..';
|
|
2
|
-
export declare type
|
|
3
|
-
|
|
2
|
+
export declare type GetFulfillmentResponse = {
|
|
3
|
+
fulfillment: SalesOrderStatusChange;
|
|
4
4
|
polling?: {
|
|
5
5
|
is_final_update_state?: boolean;
|
|
6
6
|
max_age_seconds?: number;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"get-fulfillment-response.js","sourceRoot":"","sources":["../../src/responses/get-fulfillment-response.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"get-inventory-response.js","sourceRoot":"","sources":["../../src/responses/get-inventory-response.ts"],"names":[],"mappings":""}
|
package/lib/responses/index.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
export * from './
|
|
1
|
+
export * from './cancel-fulfillment-response';
|
|
2
2
|
export * from './connect-response';
|
|
3
|
-
export * from './
|
|
3
|
+
export * from './delegate-fulfillment-response';
|
|
4
4
|
export * from './reconnect-response';
|
|
5
|
-
export * from './
|
|
6
|
-
export * from './inventory-response';
|
|
5
|
+
export * from './get-fulfillment-response';
|
|
6
|
+
export * from './get-inventory-response';
|
|
7
7
|
export * from './get-rates-response';
|
|
8
8
|
export * from './get-recent-changes-response';
|
package/lib/responses/index.js
CHANGED
|
@@ -10,12 +10,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
10
10
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
11
11
|
};
|
|
12
12
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
13
|
-
__exportStar(require("./
|
|
13
|
+
__exportStar(require("./cancel-fulfillment-response"), exports);
|
|
14
14
|
__exportStar(require("./connect-response"), exports);
|
|
15
|
-
__exportStar(require("./
|
|
15
|
+
__exportStar(require("./delegate-fulfillment-response"), exports);
|
|
16
16
|
__exportStar(require("./reconnect-response"), exports);
|
|
17
|
-
__exportStar(require("./
|
|
18
|
-
__exportStar(require("./inventory-response"), exports);
|
|
17
|
+
__exportStar(require("./get-fulfillment-response"), exports);
|
|
18
|
+
__exportStar(require("./get-inventory-response"), exports);
|
|
19
19
|
__exportStar(require("./get-rates-response"), exports);
|
|
20
20
|
__exportStar(require("./get-recent-changes-response"), exports);
|
|
21
21
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/responses/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/responses/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,gEAA8C;AAC9C,qDAAmC;AACnC,kEAAgD;AAChD,uDAAqC;AACrC,6DAA2C;AAC3C,2DAAyC;AACzC,uDAAqC;AACrC,gEAA8C"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shipengine/connect-fulfillment-provider-api",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"description": "OpenAPI specification and TypeScript definitions for the Connect Fulfillment Provider API",
|
|
5
5
|
"main": "./lib/index.js",
|
|
6
6
|
"types": "./lib/index.d.ts",
|