@compassdigital/sdk.typescript 3.4.0 → 3.5.0

package/lib/interface/vendor.js

@@ -0,0 +1,4 @@
+"use strict";
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=vendor.js.map

package/lib/interface/vendor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vendor.js","sourceRoot":"","sources":["../../src/interface/vendor.ts"],"names":[],"mappings":";AAAA,sDAAsD"}

package/manifest.json

@@ -26,11 +26,11 @@
         },
         {
             "name": "task",
-            "swagger": "https://api.compassdigital.org/dev/task/swagger.json"
+            "swagger": "../../compassdigital.service.task/swagger.json"
         },
         {
             "name": "kds",
-            "swagger": "https://api.compassdigital.org/dev/kds/swagger.json"
+            "swagger": "../../compassdigital.service.kds/swagger.json"
         },
         {
             "name": "mealplan",
@@ -74,7 +74,7 @@
         },
         {
             "name": "calendar",
-            "swagger": "https://api.compassdigital.org/dev/calendar/swagger.json"
+            "swagger": "../../compassdigital.service.calendar/swagger.json"
         },
         {
             "name": "delivery",
@@ -107,6 +107,22 @@
         {
             "name": "notification",
             "swagger": "https://api.compassdigital.org/dev/notification/swagger.json"
-        }
+        },
+		{
+			"name": "compassconnect",
+			"swagger": "../../compassdigital.service.compassconnect/swagger.json"
+		},
+		{
+			"name": "vendor",
+			"swagger": "../../compassdigital.service.vendor/swagger.json"
+		},
+		{
+			"name": "sms",
+			"swagger": "../../compassdigital.service.sms/swagger.json"
+		},
+		{
+			"name": "permission",
+			"swagger": "../../compassdigital.service.permission/swagger.json"
+		}
     ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compassdigital/sdk.typescript",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "Compass Digital Labs TypeScript SDK",
   "type": "commonjs",
   "bin": "./bin/index.js",

package/src/index.ts

@@ -557,6 +557,52 @@ import {
   GetNotificationSwaggerResponse,
 } from "./interface/notification";
 
+import {
+  GetCompassconnectOmsTokenQuery,
+  GetCompassconnectOmsTokenResponse,
+} from "./interface/compassconnect";
+
+import {
+  PostVendorBody,
+  PostVendorResponse,
+  GetVendorsResponse,
+  GetVendorResponse,
+  PatchVendorBody,
+  PatchVendorResponse,
+  GetVendorAuthResponse,
+  PostVendorAuthBody,
+  PostVendorAuthResponse,
+  GetVendorKeysResponse,
+  PostVendorKeyBody,
+  PostVendorKeyResponse,
+  GetVendorKeyQuery,
+  GetVendorKeyResponse,
+  PatchVendorKeyBody,
+  PatchVendorKeyResponse,
+  DeleteVendorKeyResponse,
+  PostVendorKeyRotateQuery,
+  PostVendorKeyRotateResponse,
+} from "./interface/vendor";
+
+import {
+  PostPermissionBody,
+  PostPermissionResponse,
+  DeletePermissionResponse,
+  GetPermissionRoleQuery,
+  GetPermissionRoleResponse,
+  PostPermissionRoleBody,
+  PostPermissionRoleResponse,
+  PatchPermissionRoleBody,
+  PatchPermissionRoleResponse,
+  GetPermissionRecipientQuery,
+  GetPermissionRecipientResponse,
+  GetPermissionRoleUserResponse,
+  PostPermissionRoleUserBody,
+  PostPermissionRoleUserResponse,
+  DeletePermissionRoleUserBody,
+  DeletePermissionRoleUserResponse,
+} from "./interface/permission";
+
 import { BaseServiceClient, RequestOptions, ResponsePromise } from "./base";
 export * from "./base";
 
@@ -5705,4 +5751,390 @@ export class ServiceClient extends BaseServiceClient {
       options
     );
   }
+
+  /**
+   * GET /compassconnect/get_oms_token - Gets an OMS token
+   *
+   * @param options - additional request options
+   */
+  get_compassconnect_oms_token(
+    options: {
+      query: GetCompassconnectOmsTokenQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetCompassconnectOmsTokenResponse> {
+    return this.request(
+      "compassconnect",
+      "get_compassconnect_oms_token",
+      "get",
+      `/compassconnect/get_oms_token`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * POST /vendor - Create new vendor
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  post_vendor(body: PostVendorBody, options?: RequestOptions): ResponsePromise<PostVendorResponse> {
+    return this.request("vendor", "post_vendor", "post", `/vendor`, body, options);
+  }
+
+  /**
+   * GET /vendor - Get all Vendors
+   *
+   * @param options - additional request options
+   */
+  get_vendors(options?: RequestOptions): ResponsePromise<GetVendorsResponse> {
+    return this.request("vendor", "get_vendors", "get", `/vendor`, null, options);
+  }
+
+  /**
+   * GET /vendor/{id} - Get info about the Vendor
+   *
+   * @param id - vendor
+   * @param options - additional request options
+   */
+  get_vendor(id: string, options?: RequestOptions): ResponsePromise<GetVendorResponse> {
+    return this.request("vendor", "get_vendor", "get", `/vendor/${id}`, null, options);
+  }
+
+  /**
+   * PATCH /vendor/{id} - Update info about the Vendor
+   *
+   * @param id - vendor
+   * @param body
+   * @param options - additional request options
+   */
+  patch_vendor(
+    id: string,
+    body: PatchVendorBody,
+    options?: RequestOptions
+  ): ResponsePromise<PatchVendorResponse> {
+    return this.request("vendor", "patch_vendor", "patch", `/vendor/${id}`, body, options);
+  }
+
+  /**
+   * GET /vendor/auth - Get access/refresh tokens for accessing our APIs
+   *
+   * @param options - additional request options
+   */
+  get_vendor_auth(options?: RequestOptions): ResponsePromise<GetVendorAuthResponse> {
+    return this.request("vendor", "get_vendor_auth", "get", `/vendor/auth`, null, options);
+  }
+
+  /**
+   * POST /vendor/auth - Get new access token using refresh token and previous token
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  post_vendor_auth(
+    body: PostVendorAuthBody,
+    options?: RequestOptions
+  ): ResponsePromise<PostVendorAuthResponse> {
+    return this.request("vendor", "post_vendor_auth", "post", `/vendor/auth`, body, options);
+  }
+
+  /**
+   * GET /vendor/{id}/key - Get list of Vendor keys
+   *
+   * @param id - vendor
+   * @param options - additional request options
+   */
+  get_vendor_keys(id: string, options?: RequestOptions): ResponsePromise<GetVendorKeysResponse> {
+    return this.request("vendor", "get_vendor_keys", "get", `/vendor/${id}/key`, null, options);
+  }
+
+  /**
+   * POST /vendor/{id}/key - Create new key for the vendor
+   *
+   * @param id - vendor
+   * @param body
+   * @param options - additional request options
+   */
+  post_vendor_key(
+    id: string,
+    body: PostVendorKeyBody,
+    options?: RequestOptions
+  ): ResponsePromise<PostVendorKeyResponse> {
+    return this.request("vendor", "post_vendor_key", "post", `/vendor/${id}/key`, body, options);
+  }
+
+  /**
+   * GET /vendor/{id}/key/{key} - Get info about vendor key
+   *
+   * @param id - vendor
+   * @param key - key
+   * @param options - additional request options
+   */
+  get_vendor_key(
+    id: string,
+    key: string,
+    options?: {
+      query?: GetVendorKeyQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetVendorKeyResponse> {
+    return this.request(
+      "vendor",
+      "get_vendor_key",
+      "get",
+      `/vendor/${id}/key/${key}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * PATCH /vendor/{id}/key/{key} - Update info for vendor key
+   *
+   * @param id - vendor
+   * @param key - key
+   * @param body
+   * @param options - additional request options
+   */
+  patch_vendor_key(
+    id: string,
+    key: string,
+    body: PatchVendorKeyBody,
+    options?: RequestOptions
+  ): ResponsePromise<PatchVendorKeyResponse> {
+    return this.request(
+      "vendor",
+      "patch_vendor_key",
+      "patch",
+      `/vendor/${id}/key/${key}`,
+      body,
+      options
+    );
+  }
+
+  /**
+   * DELETE /vendor/{id}/key/{key} - Mark key as expired
+   *
+   * @param id - vendor
+   * @param key - key
+   * @param options - additional request options
+   */
+  delete_vendor_key(
+    id: string,
+    key: string,
+    options?: RequestOptions
+  ): ResponsePromise<DeleteVendorKeyResponse> {
+    return this.request(
+      "vendor",
+      "delete_vendor_key",
+      "delete",
+      `/vendor/${id}/key/${key}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * POST /vendor/{id}/key/{key}/rotate - Rotate vendor key
+   *
+   * @param id - vendor
+   * @param key - key
+   * @param options - additional request options
+   */
+  post_vendor_key_rotate(
+    id: string,
+    key: string,
+    options?: {
+      query?: PostVendorKeyRotateQuery;
+    } & RequestOptions
+  ): ResponsePromise<PostVendorKeyRotateResponse> {
+    return this.request(
+      "vendor",
+      "post_vendor_key_rotate",
+      "post",
+      `/vendor/${id}/key/${key}/rotate`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * POST /permission - Creates a new permission for a role or a user
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  post_permission(
+    body: PostPermissionBody,
+    options?: RequestOptions
+  ): ResponsePromise<PostPermissionResponse> {
+    return this.request("permission", "post_permission", "post", `/permission`, body, options);
+  }
+
+  /**
+   * DELETE /permission/{id} - Delete a permission from a role or a user
+   *
+   * @param id - permission
+   * @param options - additional request options
+   */
+  delete_permission(
+    id: string,
+    options?: RequestOptions
+  ): ResponsePromise<DeletePermissionResponse> {
+    return this.request(
+      "permission",
+      "delete_permission",
+      "delete",
+      `/permission/${id}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /permission/role - Get Roles, with pagination and filters
+   *
+   * @param options - additional request options
+   */
+  get_permission_role(
+    options: {
+      query: GetPermissionRoleQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetPermissionRoleResponse> {
+    return this.request(
+      "permission",
+      "get_permission_role",
+      "get",
+      `/permission/role`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * POST /permission/role - Create a new role
+   *
+   * @param body
+   * @param options - additional request options
+   */
+  post_permission_role(
+    body: PostPermissionRoleBody,
+    options?: RequestOptions
+  ): ResponsePromise<PostPermissionRoleResponse> {
+    return this.request(
+      "permission",
+      "post_permission_role",
+      "post",
+      `/permission/role`,
+      body,
+      options
+    );
+  }
+
+  /**
+   * PATCH /permission/role/{id} - Update a role
+   *
+   * @param id - role
+   * @param body
+   * @param options - additional request options
+   */
+  patch_permission_role(
+    id: string,
+    body: PatchPermissionRoleBody,
+    options?: RequestOptions
+  ): ResponsePromise<PatchPermissionRoleResponse> {
+    return this.request(
+      "permission",
+      "patch_permission_role",
+      "patch",
+      `/permission/role/${id}`,
+      body,
+      options
+    );
+  }
+
+  /**
+   * GET /permission/recipient/{recipient_id} - Get permissions for a recipient(role or user id)
+   *
+   * @param recipient_id - TODO: add parameter to swagger.json
+   * @param options - additional request options
+   */
+  get_permission_recipient(
+    recipient_id: string,
+    options?: {
+      query?: GetPermissionRecipientQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetPermissionRecipientResponse> {
+    return this.request(
+      "permission",
+      "get_permission_recipient",
+      "get",
+      `/permission/recipient/${recipient_id}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * GET /permission/role/user/{user_id} - Get a list of role assignments for a user
+   *
+   * @param user_id - Id of a user
+   * @param options - additional request options
+   */
+  get_permission_role_user(
+    user_id: string,
+    options?: RequestOptions
+  ): ResponsePromise<GetPermissionRoleUserResponse> {
+    return this.request(
+      "permission",
+      "get_permission_role_user",
+      "get",
+      `/permission/role/user/${user_id}`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * POST /permission/role/user/{user_id} - Assign a role to a user
+   *
+   * @param user_id - Id of a user
+   * @param body
+   * @param options - additional request options
+   */
+  post_permission_role_user(
+    user_id: string,
+    body: PostPermissionRoleUserBody,
+    options?: RequestOptions
+  ): ResponsePromise<PostPermissionRoleUserResponse> {
+    return this.request(
+      "permission",
+      "post_permission_role_user",
+      "post",
+      `/permission/role/user/${user_id}`,
+      body,
+      options
+    );
+  }
+
+  /**
+   * DELETE /permission/role/user/{user_id} - Remove a role from a user
+   *
+   * @param user_id - Id of a user
+   * @param body
+   * @param options - additional request options
+   */
+  delete_permission_role_user(
+    user_id: string,
+    body: DeletePermissionRoleUserBody,
+    options?: RequestOptions
+  ): ResponsePromise<DeletePermissionRoleUserResponse> {
+    return this.request(
+      "permission",
+      "delete_permission_role_user",
+      "delete",
+      `/permission/role/user/${user_id}`,
+      body,
+      options
+    );
+  }
 }

package/src/interface/compassconnect.ts

@@ -0,0 +1,50 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface OMSRequest {
+  code: string;
+  client_id: string;
+  callback_uri: string;
+  oms_url: string;
+}
+
+export interface Error {
+  message?: string;
+  code?: number;
+}
+
+export interface Auth {
+  access?: {
+    token?: string;
+    expires?: string;
+  };
+  refresh?: {
+    token?: string;
+    expires?: string;
+  };
+}
+
+export interface Compassconnect {
+  // compassconnect
+  id: string;
+}
+
+export interface Compassconnects {
+  compassconnects: Compassconnect[];
+}
+
+// GET /compassconnect/get_oms_token - Gets an OMS token
+
+export interface GetCompassconnectOmsTokenQuery {
+  // The SSO code recieved from login
+  code: string;
+  // The client id of the application getting the token
+  client_id: string;
+  // The callback uri of the application calling the service
+  callback_uri: string;
+  // The urle
+  oms_url: string;
+}
+
+export type GetCompassconnectOmsTokenResponse = Auth;
+
+export interface GetCompassconnectOmsTokenRequest extends GetCompassconnectOmsTokenQuery {}

package/src/interface/kds.ts

@@ -84,9 +84,7 @@ export interface PutKdsDeviceInfoPath {
   device_id: string;
 }
 
-export interface PutKdsDeviceInfoBody {
-  brands?: string[];
-}
+export type PutKdsDeviceInfoBody = string[];
 
 export type PutKdsDeviceInfoResponse = Error;