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

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

@@ -1,6 +1,6 @@
 import { FulfillmentProviderAppMetadata } from './fulfillment-provider-app-metadata';
-import { ConnectRequest, DelegateFulfillmentRequest, GetFulfillmentRequest, CancelFulfillmentRequest, GetInventoryRequest, GetRatesRequest, GetRecentChangesRequest } from '..';
-import { ConnectResponse, DelegateFulfillmentResponse, GetFulfillmentResponse, CancelFulfillmentResponse, GetInventoryResponse, GetRatesResponse, GetRecentChangesResponse } from '..';
+import { ConnectRequest, DelegateFulfillmentRequest, GetFulfillmentsRequest, CancelFulfillmentRequest, GetInventoryRequest, GetRatesRequest, GetRecentChangesRequest } from '..';
+import { ConnectResponse, DelegateFulfillmentResponse, GetFulfillmentsResponse, CancelFulfillmentResponse, GetInventoryResponse, GetRatesResponse, GetRecentChangesResponse } from '..';
 /**
  * Definition for an Fulfillment Provider App implementation
  */
@@ -17,7 +17,7 @@ export interface FulfillmentProviderAppDefinition {
     /**
      * Get the current status of a single fulfillment from a provider.
      */
-    getFulfillment: (request: GetFulfillmentRequest) => Promise<GetFulfillmentResponse>;
+    getFulfillments: (request: GetFulfillmentsRequest) => Promise<GetFulfillmentsResponse>;
     /**
      * Request that a delegated fulfillment be cancelled by the provider.
      */

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

@@ -3,13 +3,15 @@ export declare type FulfillmentProviderAppMetadata = {
     Id: string;
     /** @description The name of this integration */
     Name: string;
-    /** @description The specification for authorizing with this order source */
+    /** @description The specification for authorizing with this fulfillment provider */
     AuthProcess: AuthSpecification;
-    /** @description A list of branded order sources associated with this integration */
+    /** @description A list of branded fulfillment providers associated with this integration */
     FulfillmentProviders: FulfillmentProviderDefinition[];
 };
 /** @description Shipping service for a fulfillment provider */
 export declare type FulfillmentServiceDefinition = {
+    /** @description This is a unique GUID identifier for this shipping service */
+    Id: string;
     /** @description Name of the shipping service */
     Name: string;
     /** @description Shortened name of the shipping service */
@@ -19,7 +21,7 @@ export declare type FulfillmentServiceDefinition = {
 };
 /** @description Defined metadata for a branded fulfillment provider */
 export declare type FulfillmentProviderDefinition = {
-    /** @description This is a unique GUID identifier for this order source */
+    /** @description This is a unique GUID identifier for this fulfillment provider source */
     Id: string;
     /** @description The branded name for this fulfillment provider @example "FBA", "Shipwore" */
     Name: string;
@@ -40,11 +42,11 @@ export declare type FulfillmentProviderDefinition = {
             UiSchema: object;
         };
     };
-    /** @description Images that will be used for this branded order source */
+    /** @description Images that will be used for this branded fulfillment provider */
     Images: {
-        /** @description The full path to the logo used in modals and other areas of our platform for this order source. Use join(__dirname, '../assets/logo.svg') @example "/dev/integration/assets/ordersource1/logo.svg" */
+        /** @description The full path to the logo used in modals and other areas of our platform for this fulfillment provider. Use join(__dirname, '../assets/logo.svg') @example "/dev/integration/assets/fulfillmentprovider1/logo.svg" */
         LogoUrl: string;
-        /** @description The full path to the icon used for this order source. Use join(__dirname, '../assets/logo.svg') @example "/dev/integration/assets/ordersource1/icon.svg" */
+        /** @description The full path to the icon used for this fulfillment provider. Use join(__dirname, '../assets/logo.svg') @example "/dev/integration/assets/fulfillmentprovider1/icon.svg" */
         IconUrl: string;
     };
 };

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

@@ -1 +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"}
+{"version":3,"file":"fulfillment-provider-app-metadata.js","sourceRoot":"","sources":["../../src/app/fulfillment-provider-app-metadata.ts"],"names":[],"mappings":";;;AAuDA,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"}

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

@@ -24,8 +24,8 @@ class FulfillmentProviderApp {
             },
             {
                 method: internal_1.Method.POST,
-                path: '/get_fulfillment',
-                handler: handleRequest(definition.getFulfillment),
+                path: '/get_fulfillments',
+                handler: handleRequest(definition.getFulfillments),
             },
             {
                 method: internal_1.Method.POST,

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":";;;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"}
+{"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,mBAAmB;gBACzB,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,eAAe,CAAC;aACnD;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/models/index.d.ts

@@ -4,4 +4,4 @@ export * from './auth';
 export * from './documents';
 export * from './errors';
 export * from './units';
-export * from './sales-order-status-change';
+export * from './sales-order-fulfillments';

package/lib/models/index.js

@@ -16,5 +16,5 @@ __exportStar(require("./auth"), exports);
 __exportStar(require("./documents"), exports);
 __exportStar(require("./errors"), exports);
 __exportStar(require("./units"), exports);
-__exportStar(require("./sales-order-status-change"), exports);
+__exportStar(require("./sales-order-fulfillments"), exports);
 //# sourceMappingURL=index.js.map

package/lib/models/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAA0B;AAC1B,iDAA+B;AAC/B,yCAAuB;AACvB,8CAA4B;AAC5B,2CAAyB;AACzB,0CAAwB;AACxB,8DAA4C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAA0B;AAC1B,iDAA+B;AAC/B,yCAAuB;AACvB,8CAA4B;AAC5B,2CAAyB;AACzB,0CAAwB;AACxB,6DAA2C"}

package/lib/models/sales-order-fulfillments.d.ts

@@ -0,0 +1,19 @@
+import { ShipmentNotification } from '.';
+export declare type SalesOrderFulfillments = {
+    fulfillment_provider_order_id: string;
+    status?: ShippingStatus;
+    fulfillments?: SalesOrderFulfillment[];
+    shipments?: ShipmentNotification[];
+};
+export declare type SalesOrderFulfillment = {
+    status?: ShippingStatus;
+    reason?: string;
+    explanation?: string;
+    line_items: FulfillmentLineItem[];
+};
+export declare type FulfillmentLineItem = {
+    line_item_id?: string;
+    sku?: string;
+    quantity: number;
+};
+export declare type ShippingStatus = 'processing' | 'shipped' | 'cancelled' | 'rejected';

package/lib/{requests/get-fulfillment-request.js → models/sales-order-fulfillments.js}

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

package/lib/models/sales-order-fulfillments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sales-order-fulfillments.js","sourceRoot":"","sources":["../../src/models/sales-order-fulfillments.ts"],"names":[],"mappings":""}

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

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

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

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

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

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

package/lib/requests/index.d.ts

@@ -2,7 +2,7 @@ export * from './cancel-fulfillment-request';
 export * from './connect-request';
 export * from './delegate-fulfillment-request';
 export * from './reconnect-request';
-export * from './get-fulfillment-request';
+export * from './get-fulfillments-request';
 export * from './get-inventory-request';
 export * from './get-rates-request';
 export * from './get-recent-changes-request';

package/lib/requests/index.js

@@ -14,7 +14,7 @@ __exportStar(require("./cancel-fulfillment-request"), exports);
 __exportStar(require("./connect-request"), exports);
 __exportStar(require("./delegate-fulfillment-request"), exports);
 __exportStar(require("./reconnect-request"), exports);
-__exportStar(require("./get-fulfillment-request"), exports);
+__exportStar(require("./get-fulfillments-request"), exports);
 __exportStar(require("./get-inventory-request"), exports);
 __exportStar(require("./get-rates-request"), exports);
 __exportStar(require("./get-recent-changes-request"), exports);

package/lib/requests/index.js.map

@@ -1 +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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/requests/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+DAA6C;AAC7C,oDAAkC;AAClC,iEAA+C;AAC/C,sDAAoC;AACpC,6DAA2C;AAC3C,0DAAwC;AACxC,sDAAoC;AACpC,+DAA6C"}

package/lib/responses/get-fulfillments-response.d.ts

@@ -0,0 +1,7 @@
+import { SalesOrderFulfillments } from '..';
+export declare type GetFulfillmentsResponse = SalesOrderFulfillments & {
+    polling?: {
+        is_final_update_state?: boolean;
+        max_age_seconds?: number;
+    };
+};

package/lib/{models/sales-order-status-change.js → responses/get-fulfillments-response.js}

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

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

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

package/lib/responses/get-recent-changes-response.d.ts

@@ -1,5 +1,5 @@
-import { SalesOrderStatusChange } from '..';
+import { SalesOrderFulfillments } from '..';
 export declare type GetRecentChangesResponse = {
-    changes: SalesOrderStatusChange[];
+    changes: SalesOrderFulfillments[];
     next_request?: any;
 };

package/lib/responses/index.d.ts

@@ -2,7 +2,7 @@ export * from './cancel-fulfillment-response';
 export * from './connect-response';
 export * from './delegate-fulfillment-response';
 export * from './reconnect-response';
-export * from './get-fulfillment-response';
+export * from './get-fulfillments-response';
 export * from './get-inventory-response';
 export * from './get-rates-response';
 export * from './get-recent-changes-response';

package/lib/responses/index.js

@@ -14,7 +14,7 @@ __exportStar(require("./cancel-fulfillment-response"), exports);
 __exportStar(require("./connect-response"), exports);
 __exportStar(require("./delegate-fulfillment-response"), exports);
 __exportStar(require("./reconnect-response"), exports);
-__exportStar(require("./get-fulfillment-response"), exports);
+__exportStar(require("./get-fulfillments-response"), exports);
 __exportStar(require("./get-inventory-response"), exports);
 __exportStar(require("./get-rates-response"), exports);
 __exportStar(require("./get-recent-changes-response"), exports);

package/lib/responses/index.js.map

@@ -1 +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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/responses/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,gEAA8C;AAC9C,qDAAmC;AACnC,kEAAgD;AAChD,uDAAqC;AACrC,8DAA4C;AAC5C,2DAAyC;AACzC,uDAAqC;AACrC,gEAA8C"}

package/package.json

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