@shipengine/connect-fulfillment-provider-api 0.3.0 → 0.3.1

package/lib/app/fulfillment-provider-app-definition.d.ts

@@ -1,6 +1,6 @@
 import { FulfillmentProviderAppMetadata } from './fulfillment-provider-app-metadata';
-import { ConnectRequest, DelegationRequest, StatusRequest, CancellationRequest, GetRatesRequest, GetRecentChangesRequest } from '..';
-import { ConnectResponse, DelegationResponse, StatusResponse, CancellationResponse, GetRatesResponse, GetRecentChangesResponse } from '..';
+import { ConnectRequest, DelegateFulfillmentRequest, GetFulfillmentRequest, CancelFulfillmentRequest, GetInventoryRequest, GetRatesRequest, GetRecentChangesRequest } from '..';
+import { ConnectResponse, DelegateFulfillmentResponse, GetFulfillmentResponse, CancelFulfillmentResponse, GetInventoryResponse, GetRatesResponse, GetRecentChangesResponse } from '..';
 /**
  * Definition for an Fulfillment Provider App implementation
  */
@@ -13,21 +13,25 @@ export interface FulfillmentProviderAppDefinition {
     /**
      * Delegate a fulfillment to a provider.
      */
-    delegateFulfillment: (request: DelegationRequest) => Promise<DelegationResponse>;
+    delegateFulfillment: (request: DelegateFulfillmentRequest) => Promise<DelegateFulfillmentResponse>;
     /**
      * Get the current status of a single fulfillment from a provider.
      */
-    getStatus: (request: StatusRequest) => Promise<StatusResponse>;
+    getFulfillment: (request: GetFulfillmentRequest) => Promise<GetFulfillmentResponse>;
     /**
      * Request that a delegated fulfillment be cancelled by the provider.
      */
-    requestCancellation: (request: CancellationRequest) => Promise<CancellationResponse>;
+    cancelFulfillment: (request: CancelFulfillmentRequest) => Promise<CancelFulfillmentResponse>;
     /**
      * Get rates for a fulfillment preview from a provider.
      */
     getRates: (request: GetRatesRequest) => Promise<GetRatesResponse>;
     /**
-     * Get recent changes for all fulfillments since a specified time
+     * Get recent changes for all fulfillments since a specified time.
      */
     getRecentChanges: (request: GetRecentChangesRequest) => Promise<GetRecentChangesResponse>;
+    /**
+     * Get pages results of inventory from a provider.
+     */
+    getInventory: (request: GetInventoryRequest) => Promise<GetInventoryResponse>;
 }

package/lib/app/fulfillment-provider-app.js

@@ -19,29 +19,34 @@ class FulfillmentProviderApp {
             },
             {
                 method: internal_1.Method.POST,
-                path: '/fulfillment/delegation',
+                path: '/delegate_fulfillment',
                 handler: handleRequest(definition.delegateFulfillment),
             },
             {
                 method: internal_1.Method.POST,
-                path: '/fulfillment/status',
-                handler: handleRequest(definition.getStatus),
+                path: '/get_fulfillment',
+                handler: handleRequest(definition.getFulfillment),
             },
             {
                 method: internal_1.Method.POST,
-                path: '/fulfillment/cancellation',
-                handler: handleRequest(definition.requestCancellation),
+                path: '/cancel_fulfillment',
+                handler: handleRequest(definition.cancelFulfillment),
             },
             {
                 method: internal_1.Method.POST,
-                path: '/rates',
+                path: '/get_rates',
                 handler: handleRequest(definition.getRates),
             },
             {
                 method: internal_1.Method.POST,
-                path: '/get-recent-changes',
+                path: '/get_recent_changes',
                 handler: handleRequest(definition.getRecentChanges),
             },
+            {
+                method: internal_1.Method.POST,
+                path: '/get_inventory',
+                handler: handleRequest(definition.getInventory),
+            },
         ];
         this.data = new internal_1.FulfillmentProviderAppSpecification(definition.metadata, this.routes);
     }

package/lib/app/fulfillment-provider-app.js.map

@@ -1 +1 @@
-{"version":3,"file":"fulfillment-provider-app.js","sourceRoot":"","sources":["../../src/app/fulfillment-provider-app.ts"],"names":[],"mappings":";;;AAGA,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,yBAAyB;gBAC/B,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,mBAAmB,CAAC;aACvD;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,qBAAqB;gBAC3B,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC;aAC7C;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,2BAA2B;gBACjC,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,mBAAmB,CAAC;aACvD;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,QAAQ;gBACd,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;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;AAnDD,wDAmDC"}
+{"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"}

package/lib/requests/{cancellation-request.d.ts → cancel-fulfillment-request.d.ts}

@@ -1,5 +1,5 @@
 import { Auth } from '..';
-export declare type CancellationRequest = {
+export declare type CancelFulfillmentRequest = {
     auth: Auth;
     fulfillment_provider_order_id: string;
     reason: string;

package/lib/requests/cancel-fulfillment-request.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=cancel-fulfillment-request.js.map

package/lib/requests/cancel-fulfillment-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancel-fulfillment-request.js","sourceRoot":"","sources":["../../src/requests/cancel-fulfillment-request.ts"],"names":[],"mappings":""}

package/lib/requests/{delegation-request.d.ts → delegate-fulfillment-request.d.ts}

@@ -1,5 +1,5 @@
 import { Auth } from '..';
 import { SalesOrder } from '..';
-export interface DelegationRequest extends SalesOrder {
+export interface DelegateFulfillmentRequest extends SalesOrder {
     auth: Auth;
 }

package/lib/requests/delegate-fulfillment-request.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=delegate-fulfillment-request.js.map

package/lib/requests/delegate-fulfillment-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delegate-fulfillment-request.js","sourceRoot":"","sources":["../../src/requests/delegate-fulfillment-request.ts"],"names":[],"mappings":""}

package/lib/requests/{status-request.d.ts → get-fulfillment-request.d.ts}

@@ -1,5 +1,5 @@
 import { Auth } from '..';
-export declare type StatusRequest = {
+export declare type GetFulfillmentRequest = {
     auth: Auth;
     fulfillment_provider_order_id: string;
 };

package/lib/requests/{inventory-request.js → get-fulfillment-request.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=inventory-request.js.map
+//# sourceMappingURL=get-fulfillment-request.js.map

package/lib/requests/get-fulfillment-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-fulfillment-request.js","sourceRoot":"","sources":["../../src/requests/get-fulfillment-request.ts"],"names":[],"mappings":""}

package/lib/requests/{inventory-request.d.ts → get-inventory-request.d.ts}

@@ -1,5 +1,5 @@
 import { Auth } from '..';
-export declare type InventoryRequest = {
+export declare type GetInventoryRequest = {
     auth: Auth;
     next_request?: any;
 };

package/lib/requests/{delegation-request.js → get-inventory-request.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=delegation-request.js.map
+//# sourceMappingURL=get-inventory-request.js.map

package/lib/requests/get-inventory-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-inventory-request.js","sourceRoot":"","sources":["../../src/requests/get-inventory-request.ts"],"names":[],"mappings":""}

package/lib/requests/index.d.ts

@@ -1,8 +1,8 @@
-export * from './cancellation-request';
+export * from './cancel-fulfillment-request';
 export * from './connect-request';
-export * from './delegation-request';
+export * from './delegate-fulfillment-request';
 export * from './reconnect-request';
-export * from './status-request';
-export * from './inventory-request';
+export * from './get-fulfillment-request';
+export * from './get-inventory-request';
 export * from './get-rates-request';
 export * from './get-recent-changes-request';

package/lib/requests/index.js

@@ -10,12 +10,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./cancellation-request"), exports);
+__exportStar(require("./cancel-fulfillment-request"), exports);
 __exportStar(require("./connect-request"), exports);
-__exportStar(require("./delegation-request"), exports);
+__exportStar(require("./delegate-fulfillment-request"), exports);
 __exportStar(require("./reconnect-request"), exports);
-__exportStar(require("./status-request"), exports);
-__exportStar(require("./inventory-request"), exports);
+__exportStar(require("./get-fulfillment-request"), exports);
+__exportStar(require("./get-inventory-request"), exports);
 __exportStar(require("./get-rates-request"), exports);
 __exportStar(require("./get-recent-changes-request"), exports);
 //# sourceMappingURL=index.js.map

package/lib/requests/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/requests/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAAuC;AACvC,oDAAkC;AAClC,uDAAqC;AACrC,sDAAoC;AACpC,mDAAiC;AACjC,sDAAoC;AACpC,sDAAoC;AACpC,+DAA6C"}
+{"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"}

package/lib/responses/cancel-fulfillment-response.d.ts

@@ -0,0 +1 @@
+export declare type CancelFulfillmentResponse = {};

package/lib/responses/cancel-fulfillment-response.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=cancel-fulfillment-response.js.map

package/lib/responses/cancel-fulfillment-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancel-fulfillment-response.js","sourceRoot":"","sources":["../../src/responses/cancel-fulfillment-response.ts"],"names":[],"mappings":""}

package/lib/responses/delegate-fulfillment-response.d.ts

@@ -0,0 +1,3 @@
+export declare type DelegateFulfillmentResponse = {
+    fulfillment_provider_order_id: string;
+};

package/lib/responses/delegate-fulfillment-response.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=delegate-fulfillment-response.js.map

package/lib/responses/delegate-fulfillment-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delegate-fulfillment-response.js","sourceRoot":"","sources":["../../src/responses/delegate-fulfillment-response.ts"],"names":[],"mappings":""}

package/lib/responses/{status-response.d.ts → get-fulfillment-response.d.ts}

@@ -1,5 +1,5 @@
 import { SalesOrderStatusChange } from '..';
-export declare type StatusResponse = {
+export declare type GetFulfillmentResponse = {
     status: SalesOrderStatusChange;
     polling?: {
         is_final_update_state?: boolean;

package/lib/{requests/status-request.js → responses/get-fulfillment-response.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=status-request.js.map
+//# sourceMappingURL=get-fulfillment-response.js.map

package/lib/responses/get-fulfillment-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-fulfillment-response.js","sourceRoot":"","sources":["../../src/responses/get-fulfillment-response.ts"],"names":[],"mappings":""}

package/lib/responses/{inventory-response.d.ts → get-inventory-response.d.ts}

@@ -1,4 +1,4 @@
-export declare type InventoryResponse = {
+export declare type GetInventoryResponse = {
     inventory: [
         {
             sku: string;

package/lib/{requests/cancellation-request.js → responses/get-inventory-response.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=cancellation-request.js.map
+//# sourceMappingURL=get-inventory-response.js.map

package/lib/responses/get-inventory-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-inventory-response.js","sourceRoot":"","sources":["../../src/responses/get-inventory-response.ts"],"names":[],"mappings":""}

package/lib/responses/index.d.ts

@@ -1,8 +1,8 @@
-export * from './cancellation-response';
+export * from './cancel-fulfillment-response';
 export * from './connect-response';
-export * from './delegation-response';
+export * from './delegate-fulfillment-response';
 export * from './reconnect-response';
-export * from './status-response';
-export * from './inventory-response';
+export * from './get-fulfillment-response';
+export * from './get-inventory-response';
 export * from './get-rates-response';
 export * from './get-recent-changes-response';

package/lib/responses/index.js

@@ -10,12 +10,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./cancellation-response"), exports);
+__exportStar(require("./cancel-fulfillment-response"), exports);
 __exportStar(require("./connect-response"), exports);
-__exportStar(require("./delegation-response"), exports);
+__exportStar(require("./delegate-fulfillment-response"), exports);
 __exportStar(require("./reconnect-response"), exports);
-__exportStar(require("./status-response"), exports);
-__exportStar(require("./inventory-response"), exports);
+__exportStar(require("./get-fulfillment-response"), exports);
+__exportStar(require("./get-inventory-response"), exports);
 __exportStar(require("./get-rates-response"), exports);
 __exportStar(require("./get-recent-changes-response"), exports);
 //# sourceMappingURL=index.js.map

package/lib/responses/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/responses/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0DAAwC;AACxC,qDAAmC;AACnC,wDAAsC;AACtC,uDAAqC;AACrC,oDAAkC;AAClC,uDAAqC;AACrC,uDAAqC;AACrC,gEAA8C"}
+{"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

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-fulfillment-provider-api",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "OpenAPI specification and TypeScript definitions for the Connect Fulfillment Provider API",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",