@envoy/envoy-integrations-sdk 2.3.1 → 2.3.3

package/src/payloads/NotificationPayload.ts

@@ -1,54 +1,54 @@
 type NotificationPayload = {
   recipient: {
     name: {
-      full: string,
-    },
-    email: string | null,
-    user_id: number | null,
-    employee_id: number | null,
-    phone_number: string | null,
-  },
-  message?: string,
+      full: string;
+    };
+    email: string | null;
+    user_id: number | null;
+    employee_id: number | null;
+    phone_number: string | null;
+  };
+  message?: string;
   details?: Array<{
-    label: string,
-    value: string,
-  }>,
+    label: string;
+    value: string;
+  }>;
   actions?: Array<{
-    label: string,
-    callback_url: string,
-  }>,
+    label: string;
+    callback_url: string;
+  }>;
   attachments?: Array<{
-    url: string,
-  }>,
+    url: string;
+  }>;
   channel_overrides?: {
     slack?: {
-      dm_only?: boolean,
-      footer_text?: string,
-      short_details?: boolean,
-      large_image?: boolean,
-      attachments?: Array<Record<string, any>>,
-      message?: string,
-      text?: string,
-    },
+      dm_only?: boolean;
+      footer_text?: string;
+      short_details?: boolean;
+      large_image?: boolean;
+      attachments?: Array<Record<string, any>>;
+      message?: string;
+      text?: string;
+    };
     email?: {
-      from: string,
-      subject: string,
-      html_body: string,
-      text_body: string,
+      from: string;
+      subject: string;
+      html_body: string;
+      text_body: string;
       reply_to?: {
         name: {
-          full: string,
-        },
-        email: string,
-      },
+          full: string;
+        };
+        email: string;
+      };
       bcc?: Array<{
         name: {
-          full: string,
-        },
-        email: string,
-      }>
-    }
-  },
+          full: string;
+        };
+        email: string;
+      }>;
+    };
+  };
 };
 
 export default NotificationPayload;

package/src/resources/FlowResource.ts

@@ -23,12 +23,13 @@ export interface FlowAttributes {
   enabled: boolean;
   'created-at': string;
   'updated-at': string;
+  type: string;
 }
 
 /**
  * @category API Resource
  */
-export type FlowRelationships = 'location' | 'sign-in-field-page' | 'agreement-page';
+export type FlowRelationships = 'location' | 'sign-in-field-page' | 'agreement-page' | 'global-flow';
 
 /**
  * @category API Resource

package/src/resources/ReservationResource.ts

@@ -1,19 +1,19 @@
-import JSONAPIModel from "../util/json-api/JSONAPIModel";
+import JSONAPIModel from '../util/json-api/JSONAPIModel';
 
 export interface ReservationAttributes {
-    'is-partial-day': boolean;
-    'updated-at': number;
-    'is-assignable': boolean;
-    'name': string;
-    'assigned-to': string | null;
-    'neighborhood-id': number;
-    'created-at': number;
-    'neighborhood': number | null;
-    'parent-desk-id': string | null;
-    'availability': string | null;
-    'enabled': boolean;
-    'x-pos': number | null;
-    'y-pos': number | null;
+  'is-partial-day': boolean;
+  'updated-at': number;
+  'is-assignable': boolean;
+  name: string;
+  'assigned-to': string | null;
+  'neighborhood-id': number;
+  'created-at': number;
+  neighborhood: number | null;
+  'parent-desk-id': string | null;
+  availability: string | null;
+  enabled: boolean;
+  'x-pos': number | null;
+  'y-pos': number | null;
 }
 
 export interface ReservationCreationAttributes {
@@ -25,16 +25,22 @@ export interface ReservationCreationAttributes {
   locationId?: number | null;
   inviteId?: number | null;
   entryId?: number | null;
-  startTime?: number | null;  // Unix timestamp
-  endTime?: number | null;    // Unix timestamp
+  startTime?: number | null; // Unix timestamp
+  endTime?: number | null; // Unix timestamp
 
   meta?: {
     autoAssignDesk?: boolean;
   };
 }
 
-export type ReservationRelationships = 'location' | 'desk' | 'company' | 'floor' | 'employee' | 'entry' | 'invite' | 'user';
-
-export type ReservationModel = JSONAPIModel<ReservationAttributes, ReservationRelationships, 'reservations'>
-
-
+export type ReservationRelationships =
+  | 'location'
+  | 'desk'
+  | 'company'
+  | 'floor'
+  | 'employee'
+  | 'entry'
+  | 'invite'
+  | 'user';
+
+export type ReservationModel = JSONAPIModel<ReservationAttributes, ReservationRelationships, 'reservations'>;

package/src/resources/SignInFieldPageResource.ts

@@ -11,11 +11,12 @@ export type SignInFieldPageAttributes = {
 /**
  * @category API Resource
  */
-export type SignInFieldPageRelationships = 'flow'
-| 'actionable-sign-in-field-actions'
-| 'actionable-sign-in-fields'
-| 'sign-in-field-actions'
-| 'sign-in-fields';
+export type SignInFieldPageRelationships =
+  | 'flow'
+  | 'actionable-sign-in-field-actions'
+  | 'actionable-sign-in-fields'
+  | 'sign-in-field-actions'
+  | 'sign-in-fields';
 
 /**
  * @category API Resource

package/src/resources/SignInFieldResource.ts

@@ -15,9 +15,9 @@ export interface SignInFieldAttributes {
     'display-name': string;
   }>;
   options?: Array<{
-    value: string,
-    position: number,
-  }>,
+    value: string;
+    position: number;
+  }>;
   position?: number;
   'store-response'?: boolean;
   'created-at'?: string;

package/src/resources/TakeoverResource.ts

@@ -8,6 +8,7 @@ export interface TakeoverAttributes {
     title: string;
     message: string;
     created_at: string;
+    type: 'critical' | 'normal';
   };
   'start-at': number;
   'end-at': number | null;

package/src/sdk/EnvoyMeta.ts

@@ -2,60 +2,60 @@
  * @category Meta
  */
 export type EnvoyMetaJob<Event extends string = string> = {
-  id: string,
-  name: Event,
-  identifier: string,
+  id: string;
+  name: Event;
+  identifier: string;
 };
 
 /**
  * @category Meta
  */
 export type EnvoyMetaLocation = {
-  id: string,
-  type: 'locations',
+  id: string;
+  type: 'locations';
   attributes: {
-    name: string,
-    'company-name-override': string | null,
-    timezone: string,
-    locale: string | null,
-    address: string,
-    'address-line-one': string | null,
-    'address-line-two': string | null,
-    city: string | null,
-    state: string | null,
-    country: string | null,
-    zip: string | null,
-    longitude: number | null,
-    latitude: number | null,
-    'created-at': string,
-  }
+    name: string;
+    'company-name-override': string | null;
+    timezone: string;
+    locale: string | null;
+    address: string;
+    'address-line-one': string | null;
+    'address-line-two': string | null;
+    city: string | null;
+    state: string | null;
+    country: string | null;
+    zip: string | null;
+    longitude: number | null;
+    latitude: number | null;
+    'created-at': string;
+  };
 };
 
 /**
  * @category Meta
  */
 export type EnvoyMetaCompany = {
-  id: string,
-  type: 'companies',
+  id: string;
+  type: 'companies';
   attributes: {
-    name: string,
-    active: boolean,
-    'created-at': string,
-  }
+    name: string;
+    active: boolean;
+    'created-at': string;
+  };
 };
 
 /**
  * @category Meta
  */
 export type EnvoyMetaZone = {
-  id: string,
-  type: 'zones',
+  id: string;
+  type: 'zones';
   attributes: {
-    address: string | null,
-    'logo-url': string | null,
-    name: string,
-    'time-zone': string,
-  }
+    address: string | null;
+    'logo-url': string | null;
+    name: string;
+    'time-zone': string;
+  };
 };
 
 /**
@@ -65,11 +65,11 @@ export type EnvoyMetaZone = {
  * @category Meta
  */
 export type EnvoyMetaAuth = {
-  token_type: 'Bearer',
-  access_token: string,
-  expires_in: number,
-  refresh_token: string | null,
-  refresh_token_expires_in: number | null,
+  token_type: 'Bearer';
+  access_token: string;
+  expires_in: number;
+  refresh_token: string | null;
+  refresh_token_expires_in: number | null;
 };
 
 /**
@@ -78,15 +78,15 @@ export type EnvoyMetaAuth = {
  * @category Meta
  */
 export type EnvoyEventMeta<Event extends string = string, Config = Record<string, unknown>> = {
-  event: Event,
-  plugin_id: string,
-  install_id: string,
-  config: Config,
-  job: EnvoyMetaJob<Event>,
-  location: EnvoyMetaLocation,
-  company: EnvoyMetaCompany,
-  zone: EnvoyMetaZone,
-  auth: EnvoyMetaAuth | null,
+  event: Event;
+  plugin_id: string;
+  install_id: string;
+  config: Config;
+  job: EnvoyMetaJob<Event>;
+  location: EnvoyMetaLocation;
+  company: EnvoyMetaCompany;
+  zone: EnvoyMetaZone;
+  auth: EnvoyMetaAuth | null;
 };
 
 /**
@@ -96,16 +96,16 @@ export type EnvoyEventMeta<Event extends string = string, Config = Record<string
  * @category Meta
  */
 export type EnvoyRouteMeta<Config = Record<string, unknown>, Params = Record<string, unknown>> = {
-  route: string,
-  plugin_id: string,
-  install_id: string,
-  config: Config,
-  params: Params,
-  location: EnvoyMetaLocation,
-  company: EnvoyMetaCompany,
-  zone: EnvoyMetaZone,
-  auth: EnvoyMetaAuth | null,
-  forwarded_bearer_token?: string,
+  route: string;
+  plugin_id: string;
+  install_id: string;
+  config: Config;
+  params: Params;
+  location: EnvoyMetaLocation;
+  company: EnvoyMetaCompany;
+  zone: EnvoyMetaZone;
+  auth: EnvoyMetaAuth | null;
+  forwarded_bearer_token?: string;
 };
 
 /**

package/src/sdk/EnvoyPluginAPI.ts

@@ -70,7 +70,11 @@ export default class EnvoyPluginAPI extends EnvoyAPI {
   /**
    * Gets a plugin access token using `client_credentials` as the grant type.
    */
-  static async loginAsPlugin(id = envoyClientId, secret = envoyClientSecret, scope: string[] = ['plugin', 'token.refresh']): Promise<EnvoyMetaAuth> {
+  static async loginAsPlugin(
+    id = envoyClientId,
+    secret = envoyClientSecret,
+    scope: string[] = ['plugin', 'token.refresh'],
+  ): Promise<EnvoyMetaAuth> {
     try {
       const { data } = await axios({
         auth: {

package/src/sdk/EnvoyPluginJobAttachment.ts

@@ -4,9 +4,9 @@
  * @category Attachment
  */
 export interface EnvoyPluginTextJobAttachment {
-  type?: 'text' | 'password' | string,
-  label: string,
-  value: string,
+  type?: 'text' | 'password' | string;
+  label: string;
+  value: string;
 }
 
 /**
@@ -15,8 +15,8 @@ export interface EnvoyPluginTextJobAttachment {
  * @category Attachment
  */
 export interface EnvoyPluginLinkJobAttachment extends EnvoyPluginTextJobAttachment {
-  type: 'link',
-  url: string,
+  type: 'link';
+  url: string;
 }
 
 /**
@@ -26,12 +26,12 @@ export interface EnvoyPluginLinkJobAttachment extends EnvoyPluginTextJobAttachme
  * @category Attachment
  */
 export interface EnvoyPluginCredentialJobAttachment extends EnvoyPluginTextJobAttachment {
-  type: 'credential_image',
-  title: string,
+  type: 'credential_image';
+  title: string;
   image: {
-    type: 's3',
-    link: string,
-  },
+    type: 's3';
+    link: string;
+  };
 }
 
 /**
@@ -41,8 +41,9 @@ export interface EnvoyPluginCredentialJobAttachment extends EnvoyPluginTextJobAt
  *
  * @category Attachment
  */
-type EnvoyPluginJobAttachment = EnvoyPluginTextJobAttachment
-| EnvoyPluginLinkJobAttachment
-| EnvoyPluginCredentialJobAttachment;
+type EnvoyPluginJobAttachment =
+  | EnvoyPluginTextJobAttachment
+  | EnvoyPluginLinkJobAttachment
+  | EnvoyPluginCredentialJobAttachment;
 
 export default EnvoyPluginJobAttachment;

package/src/sdk/EnvoyPluginSDK.ts

@@ -13,8 +13,8 @@ import InvitePayload, { normalizeInvitePayload } from '../payloads/InvitePayload
  * @category Request
  */
 export interface EnvoyRequestBody<Meta, Payload> {
-  meta: Meta,
-  payload: Payload,
+  meta: Meta;
+  payload: Payload;
 }
 
 /**
@@ -24,7 +24,7 @@ export interface EnvoyRequestBody<Meta, Payload> {
  *
  * @category SDK
  */
-export default class EnvoyPluginSDK<Meta = unknown, Payload = unknown> {
+export default class EnvoyPluginSDK<Meta extends object = Record<string, any>, Payload = unknown> {
   /**
    * Body of the request.
    * use `meta` or `payload` to access the relevant properties,
@@ -96,7 +96,7 @@ export default class EnvoyPluginSDK<Meta = unknown, Payload = unknown> {
     const meta = this.meta as unknown as EnvoyRouteMeta;
     const { auth } = meta;
     let accessToken: string | undefined = auth?.access_token;
-    if (!accessToken && ('forwarded_bearer_token' in meta)) {
+    if (!accessToken && 'forwarded_bearer_token' in meta) {
       accessToken = meta.forwarded_bearer_token;
     }
     if (!accessToken) {

package/src/sdk/EnvoyPluginStorage.ts

@@ -33,7 +33,7 @@ export default class EnvoyPluginStorage {
    * Wrapper for single pipeline get.
    */
   get<Value = unknown>(key: string) {
-    return this.pipeline().get(key).executeSingle<EnvoyStorageItem<Value> | { key: string, 'value': undefined }>();
+    return this.pipeline().get(key).executeSingle<EnvoyStorageItem<Value> | { key: string; value: undefined }>();
   }
 
   /**
@@ -51,7 +51,9 @@ export default class EnvoyPluginStorage {
    * Wrapper for single pipeline setUnique.
    */
   setUnique(key: string, options: EnvoyStorageSetUniqueOptions = {}) {
-    return this.pipeline().setUnique(key, options).executeSingle<EnvoyStorageItem<string> | { key: string, 'value': undefined }>();
+    return this.pipeline()
+      .setUnique(key, options)
+      .executeSingle<EnvoyStorageItem<string> | { key: string; value: undefined }>();
   }
 
   /**
@@ -60,7 +62,9 @@ export default class EnvoyPluginStorage {
    * Wrapper for single pipeline setUnique.
    */
   setUniqueNum(key: string, options: EnvoyStorageSetUniqueNumOptions = {}) {
-    return this.pipeline().setUniqueNum(key, options).executeSingle<EnvoyStorageItem<number> | { key: string, 'value': undefined }>();
+    return this.pipeline()
+      .setUniqueNum(key, options)
+      .executeSingle<EnvoyStorageItem<number> | { key: string; value: undefined }>();
   }
 
   /**
@@ -69,7 +73,7 @@ export default class EnvoyPluginStorage {
    * Wrapper for single pipeline unset.
    */
   unset<Value = unknown>(key: string) {
-    return this.pipeline().unset(key).executeSingle<EnvoyStorageItem<Value> | { key: string, 'value': undefined }>();
+    return this.pipeline().unset(key).executeSingle<EnvoyStorageItem<Value> | { key: string; value: undefined }>();
   }
 
   /**