@compassdigital/sdk.typescript 3.0.0-beta.13 → 3.0.0-beta.14

package/src/{index.ts → client/index.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 import {
   PostPaymentTransactionBody,
   PostPaymentTransactionResponse,
@@ -26,7 +28,7 @@ import {
   GetPaymentMethodsResponse,
   GetPaymentHpcQuery,
   GetPaymentHpcResponse,
-} from "./payment";
+} from "../interface/payment";
 
 import {
   PostOrderQuery,
@@ -49,7 +51,7 @@ import {
   GetOrderLocationOrdersResponse,
   GetOrderGroupOrdersQuery,
   GetOrderGroupOrdersResponse,
-} from "./order";
+} from "../interface/order";
 
 import {
   PostLocationBody,
@@ -146,7 +148,7 @@ import {
   GetLocationCompanyResponse,
   PatchLocationCompanyBody,
   PatchLocationCompanyResponse,
-} from "./location";
+} from "../interface/location";
 
 import {
   PostShoppingcartCartBody,
@@ -171,16 +173,17 @@ import {
   PostShoppingcartCloneCartResponse,
   PostShoppingcartBulkBody,
   PostShoppingcartBulkResponse,
-} from "./shoppingcart";
+} from "../interface/shoppingcart";
 
 import {
   PostPartnerStandardcognitionShoppingcartBody,
   PostPartnerStandardcognitionShoppingcartResponse,
   GetPartnerStandardcognitionLocationsResponse,
+  GetPartnerStandardcognitionStoresResponse,
   GetPartnerCoolrLocationsResponse,
   GetPartnerCoolrImagesResponse,
   GetPartnerSwaggerResponse,
-} from "./partner";
+} from "../interface/partner";
 
 import {
   PostTaskBody,
@@ -199,7 +202,7 @@ import {
   GetTaskLocationBrandResponse,
   GetTaskLocationGroupQuery,
   GetTaskLocationGroupResponse,
-} from "./task";
+} from "../interface/task";
 
 import {
   GetKdsDevicesQuery,
@@ -208,7 +211,7 @@ import {
   PostKdsDeviceAuthResponse,
   DeleteKdsDeviceAuthResponse,
   GetKdsSwaggerResponse,
-} from "./kds";
+} from "../interface/kds";
 
 import {
   PostMealplanBody,
@@ -230,9 +233,13 @@ import {
   PutMealplanVerifyResponse,
   PostMealplanAuthorizeBody,
   PostMealplanAuthorizeResponse,
-} from "./mealplan";
+} from "../interface/mealplan";
 
-import { PostDatalakeSqlBody, PostDatalakeSqlResponse, GetSwaggerResponse } from "./datalake";
+import {
+  PostDatalakeSqlBody,
+  PostDatalakeSqlResponse,
+  GetSwaggerResponse,
+} from "../interface/datalake";
 
 import {
   PostPromoBody,
@@ -265,9 +272,9 @@ import {
   PostPromoVoucherifyActivityExecuteBody,
   PostPromoVoucherifyActivityExecuteResponse,
   GetPromoVoucherifyActivityConfigResponse,
-} from "./promo";
+} from "../interface/promo";
 
-import { PostDhSqlResponse } from "./dh";
+import { PostDhSqlResponse } from "../interface/dh";
 
 import {
   GetConfigResponse,
@@ -282,7 +289,7 @@ import {
   PutConfigPublicBody,
   PutConfigPublicResponse,
   DeleteConfigPublicResponse,
-} from "./config";
+} from "../interface/config";
 
 import {
   PostAnnouncementBody,
@@ -295,7 +302,7 @@ import {
   PutAnnouncementBody,
   PutAnnouncementResponse,
   DeleteAnnouncementResponse,
-} from "./announcement";
+} from "../interface/announcement";
 
 import {
   GetReportAnalyticsGroupQuery,
@@ -323,7 +330,7 @@ import {
   DeleteReportDiscrepancySubscribersResponse,
   PostReportDiscrepancySubscribersBody,
   PostReportDiscrepancySubscribersResponse,
-} from "./report";
+} from "../interface/report";
 
 import {
   GetUserAuthQuery,
@@ -378,7 +385,7 @@ import {
   PostUserSendEmailVerificationResponse,
   PutUserVerifyUserEmailBody,
   PutUserVerifyUserEmailResponse,
-} from "./user";
+} from "../interface/user";
 
 import {
   PostLoyaltyEnrollQuery,
@@ -415,9 +422,9 @@ import {
   GetLoyaltyUsersResponse,
   GetLoyaltyEventsQuery,
   GetLoyaltyEventsResponse,
-} from "./loyalty";
+} from "../interface/loyalty";
 
-import { GetBrandResponse, GetBrandsResponse } from "./brand";
+import { GetBrandResponse, GetBrandsResponse } from "../interface/brand";
 
 import {
   GetCalendarResponse,
@@ -427,14 +434,14 @@ import {
   GetCalendarCdlResponse,
   GetCalendarSwaggerResponse,
   PostCalendarSyncResponse,
-} from "./calendar";
+} from "../interface/calendar";
 
 import {
   PostDeliveryOrderBody,
   PostDeliveryOrderResponse,
   PatchDeliveryOrderResponse,
   GetDeliveryOrderResponse,
-} from "./delivery";
+} from "../interface/delivery";
 
 import {
   PostScheduleBody,
@@ -445,15 +452,20 @@ import {
   PutScheduleBody,
   PutScheduleResponse,
   DeleteScheduleResponse,
-} from "./schedule";
+} from "../interface/schedule";
 
-import { PostVoteBody, PostVoteResponse, GetVoteIdfaQuery, GetVoteIdfaResponse } from "./vote";
+import {
+  PostVoteBody,
+  PostVoteResponse,
+  GetVoteIdfaQuery,
+  GetVoteIdfaResponse,
+} from "../interface/vote";
 
-import { PostFileBody, PostFileResponse } from "./file";
+import { PostFileBody, PostFileResponse } from "../interface/file";
 
-import { PostMessageBody, PostMessageResponse, GetMessageResponse } from "./message";
+import { PostMessageBody, PostMessageResponse, GetMessageResponse } from "../interface/message";
 
-import { GetLoggerBrandStatusQuery, GetLoggerBrandStatusResponse } from "./logger";
+import { GetLoggerBrandStatusQuery, GetLoggerBrandStatusResponse } from "../interface/logger";
 
 import { BaseServiceClient, RequestOptions, ResponsePromise } from "./base";
 export * from "./base";
@@ -2267,6 +2279,24 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
+  /**
+   * GET /partner/standardcognition/stores - Gets the UUID for all the Standard Cognition external locations
+   *
+   * @param options - additional request options
+   */
+  get_partner_standardcognition_stores(
+    options?: RequestOptions
+  ): ResponsePromise<GetPartnerStandardcognitionStoresResponse> {
+    return this.request(
+      "partner",
+      "get_partner_standardcognition_stores",
+      "get",
+      `/partner/standardcognition/stores`,
+      null,
+      options
+    );
+  }
+
   /**
    * GET /partner/coolr/locations - Gets the locations where Coolr is available
    *

package/src/{announcement.ts → interface/announcement.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   code?: number;
   message?: string;

package/src/{brand.ts → interface/brand.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Brand {
   // brand
   id?: string;

package/src/{calendar.ts → interface/calendar.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   message?: string;
   code?: number;

package/src/{config.ts → interface/config.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export type CreateConfig = any;
 
 export interface Config {

package/src/{datalake.ts → interface/datalake.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   error?: string;
   code?: number;

package/src/{delivery.ts → interface/delivery.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   code?: number;
   message?: string;

package/src/{dh.ts → interface/dh.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   error?: string;
   code?: number;

package/src/{email.ts → interface/email.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   message?: string;
   code?: number;

package/src/{file.ts → interface/file.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   message?: string;
   code?: number;

package/src/{kds.ts → interface/kds.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   error?: string;
   message?: string;

package/src/{location.ts → interface/location.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface POS {
   // pos
   id?: string;

package/src/{logger.ts → interface/logger.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   error?: string;
   code?: number;

package/src/{loyalty.ts → interface/loyalty.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   message?: string;
   code?: number;

package/src/{mealplan.ts → interface/mealplan.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   code?: number;
   message?: string;

package/src/{message.ts → interface/message.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   message?: string;
   code?: number;

package/src/{order.ts → interface/order.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface CreateOrder {
   // brand
   location_brand?: string;

package/src/{partner.ts → interface/partner.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   message?: string;
   code?: number;
@@ -395,6 +397,23 @@ export type Hours = any;
 
 export type DeliveryHours = any;
 
+export interface CognitionStore {
+  // UUID for external store
+  uuid?: string;
+  // Store name
+  name?: string;
+  // Full address
+  address?: string;
+  city?: string;
+  state?: string;
+  // Abbreviated address
+  street_address?: string;
+  // ISO code for currency
+  currency_code?: string;
+  latitude?: number;
+  longitude?: number;
+}
+
 export interface CoolrLocations {
   // location
   id?: string;
@@ -438,6 +457,12 @@ export interface GetPartnerStandardcognitionLocationsResponse {
 
 export type GetPartnerStandardcognitionLocationsRequest = {};
 
+// GET /partner/standardcognition/stores - Gets the UUID for all the Standard Cognition external locations
+
+export type GetPartnerStandardcognitionStoresResponse = CognitionStore;
+
+export type GetPartnerStandardcognitionStoresRequest = {};
+
 // GET /partner/coolr/locations - Gets the locations where Coolr is available
 
 export interface GetPartnerCoolrLocationsResponse {

package/src/{payment.ts → interface/payment.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Transaction {
   success?: boolean;
   [index: string]: any;

package/src/{promo.ts → interface/promo.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   message?: string;
   code?: number;

package/src/{report.ts → interface/report.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Success {
   success?: boolean;
 }

package/src/{schedule.ts → interface/schedule.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   message?: string;
   code?: number;

package/src/{shoppingcart.ts → interface/shoppingcart.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   message?: string;
   code?: number;

package/src/{task.ts → interface/task.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface location {
   // Location ID
   location_id: string;

package/src/{user.ts → interface/user.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   message?: string;
   code?: number;

package/src/{vote.ts → interface/vote.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   message?: string;
   code?: number;

package/test/client.test.ts

@@ -1,92 +1,90 @@
 
-import { ServiceClient, ResponseData, ServiceError } from "../src";
-import { Task } from "../src/task";
+import { ServiceClient, ResponseData, ServiceError, RequestData, InterceptFn } from "../src/client";
+import { Task } from "../src/interface/task";
 
 describe("ServiceClient", () => {
 
-  const empty: ResponseData = { ok: true, status: 200, body: "" };
+  function response(status: number, body?: any): ResponseData {
+    const res = { ok: status === 200, status: status, body: "" };
+    if (body) {
+      res.body = JSON.stringify(body);
+    }
+    return res;
+  }
+
+  function interceptor(status: number, body?: any): InterceptFn {
+    return (req: RequestData) => Promise.resolve(response(status, body));
+  }
 
   test("makes basic request", async () => {
     const fake: Task = { id: "some_id" };
-    const api = new ServiceClient({
-      intercept: async (req) => {
-        expect(req.name).toBe("get_task");
-        expect(req.service).toBe("task");
-        expect(req.url).toBe("https://api.compassdigital.org/dev/task/some_id");
-        return {
-          ok: true,
-          status: 200,
-          body: JSON.stringify(fake)
-        };
-      },
-    });
+    const intercept = jest.fn(interceptor(200, fake));
+    const api = new ServiceClient({ intercept });
     const task = await api.get_task("some_id");
     expect(task).toEqual(fake);
+    const req = intercept.mock.calls[0][0];
+    expect(req).toEqual({
+      name: "get_task",
+      service: "task",
+      url: "https://api.compassdigital.org/dev/task/some_id",
+      method: "get",
+      headers: {
+        "User-Agent": "CDL/ServiceClient",
+      },
+    })
   });
 
   test("token gets passed", async () => {
     const token = "this is a token";
-    const api = new ServiceClient({
-      intercept: async (req) => {
-        expect(req.headers).toHaveProperty("Authorization", `Bearer ${token}`);
-        return empty;
-      },
-    });
+    const intercept = jest.fn(interceptor(200));
+    const api = new ServiceClient({ intercept });
     await api.get_task("", { token });
+    const req = intercept.mock.calls[0][0];
+    expect(req.headers).toHaveProperty("Authorization", `Bearer ${token}`);
   });
 
   test("headers get merged", async () => {
+    const intercept = jest.fn(interceptor(200));
     const api = new ServiceClient({
+      intercept,
       headers: {
         "a": "a from constructor",
         "b": "b from constructor",
       },
-      intercept: async (req) => {
-        expect(req.headers).toEqual({
-          "User-Agent": "CDL/ServiceClient",
-          "a": "a from constructor",
-          "b": "b from method",
-          "c": "c from method",
-        })
-        return empty;
-      }
     });
     await api.get_task("", {
       headers: {
         "b": "b from method",
         "c": "c from method",
       },
-    })
+    });
+    const req = intercept.mock.calls[0][0];
+    expect(req.headers).toEqual({
+      "User-Agent": "CDL/ServiceClient",
+      "a": "a from constructor",
+      "b": "b from method",
+      "c": "c from method",
+    });
   });
 
   test("client retries on failure", async () => {
-    let attempts = 0;
-    const api = new ServiceClient({
-      intercept: async (req) => {
-        attempts++;
-        if (attempts === 3) {
-          return { ok: true, status: 200, body: "{}" };
-        }
-        return { ok: false, status: 500, body: "something went wrong"};
+    const intercept = jest.fn(async (req: RequestData) => {
+      if (intercept.mock.calls.length === 3) {
+        return response(200, "{}");
       }
+      return response(500, "something went wrong");
     });
+    const api = new ServiceClient({ intercept });
     const task = await api.get_task("", { retry: 2 });
+    expect(intercept.mock.calls.length).toBe(3);
   });
 
   test("client gives up after retry limit", async () => {
-    let attempts = 0;
-    const api = new ServiceClient({
-      intercept: async (req) => {
-        attempts++;
-        return { ok: false, status: 500, body: "something went wrong"};
-      },
-    });
-    try {
-      const task = await api.get_task("", { retry: 5 });
-      throw new Error("request should not have succeeded");
-    } catch (_) {
-      expect(attempts).toEqual(6);
-    }
+    const intercept = jest.fn(interceptor(500));
+    const api = new ServiceClient({ intercept });
+    const promise = api.get_task("", { retry: 5 });
+    await expect(promise).rejects.toBeInstanceOf(ServiceError);
+    expect(intercept.mock.calls.length).toEqual(6);
   });
 
   describe("ServiceError", () => {
@@ -99,9 +97,7 @@ describe("ServiceClient", () => {
 
     test("returns null for ignored http status", async () => {
       const api = new ServiceClient({
-        intercept: async (req) => {
-          return { ok: false, status: 501, body: "" };
-        }
+        intercept: interceptor(501),
       });
       const task = await api.get_task("").ignore(501);
       expect(task).toBeNull();
@@ -109,9 +105,7 @@ describe("ServiceClient", () => {
 
     test("returns null for ignored service error code", async () => {
       const api = new ServiceClient({
-        intercept: async (req) => {
-          return { ok: false, status: 500, body: JSON.stringify({ code: 500.4, message: "uh oh" }) };
-        }
+        intercept: interceptor(500, { code: 500.4, message: "uh oh" }),
       });
       const task = await api.get_task("").ignore(500.4);
       expect(task).toBeNull();
@@ -119,9 +113,7 @@ describe("ServiceClient", () => {
 
     test("throws ServiceError for non-ignored errors", async () => {
       const api = new ServiceClient({
-        intercept: async (req) => {
-          return { ok: false, status: 500, body: JSON.stringify({ code: 500.4, message: "hello world" }) };
-        }
+        intercept: interceptor(500, { code: 500.4, message: "hello world"}),
       });
       try {
         await api.get_task("");
@@ -134,9 +126,7 @@ describe("ServiceClient", () => {
 
     test("either should be true with 200 response", async () => {
       const api = new ServiceClient({
-        intercept: async (req) => {
-          return { ok: true, status: 200, body: "{}" };
-        }
+        intercept: interceptor(200, "{}"),
       });
       const res = await api.get_task("{}").combine();
       expect(res.ok).toBe(true);
@@ -146,9 +136,7 @@ describe("ServiceClient", () => {
 
     test("either should be false with non-200 response", async () => {
       const api = new ServiceClient({
-        intercept: async (req) => {
-          return { ok: false, status: 400, body: "{}" };
-        }
+        intercept: interceptor(400, "{}"),
       });
       const res = await api.get_task("{}").combine();
       expect(res.ok).toBe(false);
@@ -158,9 +146,7 @@ describe("ServiceClient", () => {
 
     test("either should be false with matching code", async () => {
       const api = new ServiceClient({
-        intercept: async (req) => {
-          return { ok: false, status: 400, body: "{}" };
-        }
+        intercept: interceptor(400, "{}"),
       });
       const res = await api.get_task("{}").combine(400);
       expect(res.ok).toBe(false);
@@ -169,9 +155,7 @@ describe("ServiceClient", () => {
 
     test("method should throw if code is not specified", async () => {
       const api = new ServiceClient({
-        intercept: async (req) => {
-          return { ok: false, status: 400, body: "{}" };
-        }
+        intercept: interceptor(400, "{}"),
       });
       const promise = api.get_task("").combine(500);
       expect(promise).rejects.toThrow();