@envoy/envoy-integrations-sdk 2.0.1-beta.5 → 2.0.2

package/dist/resources/LocationResource.d.ts

@@ -0,0 +1,64 @@
+import JSONAPIModel from '../util/json-api/JSONAPIModel';
+/**
+ * @category API Resource
+ */
+export declare type LocationSortFields = 'name' | 'created_at' | '-name' | '-created_at';
+/**
+ * @category API Resource
+ */
+export interface LocationFilterFields {
+    disabled?: boolean;
+    company?: string;
+}
+/**
+ * @category API Resource
+ */
+export interface LocationAttributes {
+    name: string;
+    address: string;
+    'address-line-1': string | null;
+    'address-line-2': string | null;
+    city: string | null;
+    state: string | null;
+    country: string | null;
+    zip: string | null;
+    latitude: number | null;
+    longitude: number | null;
+    locale: string | null;
+    timezone: string;
+    'company-name-override': string | null;
+    'logo-small-url': string | null;
+    'logo-thumb-url': string | null;
+    'logo-url': string | null;
+    disabled: boolean | null;
+    'visitors-onboarding-complete': boolean | null;
+    'registration-eligibility-end-offset': number | null;
+    'registration-eligibility-start-offset': number | null;
+    'visitor-registration-eligibility-start-offset': number | null;
+    'welcome-email-preference': string | null;
+    'average-monthly-visitors': number | null;
+    'capacity-limit': number | null;
+    'auto-sign-out-at-midnight': boolean | null;
+    'employee-screening-enabled': boolean | null;
+    'pre-registration-enabled': boolean | null;
+    'pre-registration-required-enabled': boolean | null;
+    'host-approval-enabled': boolean | null;
+    'multiple-languages-enabled': boolean | null;
+    'near-visit-screening-enabled': boolean | null;
+    'printer-notifications-enabled': boolean | null;
+    'security-desk-link-enabled': boolean | null;
+    'touchless-signin-enabled': boolean | null;
+    'visitor-survey-enabled': boolean | null;
+    'visual-compliance-enabled': boolean | null;
+    'created-at': string;
+    'updated-at': string;
+}
+/**
+ * @category API Resource
+ */
+export declare type LocationRelationships = 'company' | 'employees' | 'flows' | 'employee-screening-flow';
+/**
+ * @category API Resource
+ */
+export declare type LocationModel = JSONAPIModel<LocationAttributes, LocationRelationships>;
+//# sourceMappingURL=LocationResource.d.ts.map

package/dist/resources/LocationResource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocationResource.d.ts","sourceRoot":"","sources":["../../src/resources/LocationResource.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,+BAA+B,CAAC;AAEzD;;GAEG;AACH,oBAAY,kBAAkB,GAAG,MAAM,GAAG,YAAY,GAAG,OAAO,GAAG,aAAa,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;IACzB,8BAA8B,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/C,qCAAqC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrD,uCAAuC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvD,+CAA+C,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/D,0BAA0B,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C,0BAA0B,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,2BAA2B,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5C,4BAA4B,EAAE,OAAO,GAAG,IAAI,CAAC;IAC7C,0BAA0B,EAAE,OAAO,GAAG,IAAI,CAAC;IAC3C,mCAAmC,EAAE,OAAO,GAAG,IAAI,CAAC;IACpD,uBAAuB,EAAE,OAAO,GAAG,IAAI,CAAC;IACxC,4BAA4B,EAAE,OAAO,GAAG,IAAI,CAAC;IAC7C,8BAA8B,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/C,+BAA+B,EAAE,OAAO,GAAG,IAAI,CAAC;IAChD,4BAA4B,EAAE,OAAO,GAAG,IAAI,CAAC;IAC7C,0BAA0B,EAAE,OAAO,GAAG,IAAI,CAAC;IAC3C,wBAAwB,EAAE,OAAO,GAAG,IAAI,CAAC;IACzC,2BAA2B,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5C,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,oBAAY,qBAAqB,GAAG,SAAS,GAAG,WAAW,GAAG,OAAO,GAAG,yBAAyB,CAAC;AAElG;;GAEG;AACH,oBAAY,aAAa,GAAG,YAAY,CAAC,kBAAkB,EAAE,qBAAqB,CAAC,CAAC"}

package/dist/resources/LocationResource.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/resources/LocationRoleResource.d.ts

@@ -0,0 +1,8 @@
+import JSONAPIModel from '../util/json-api/JSONAPIModel';
+export interface LocationRoleAttributes {
+    'role-name': string;
+    'confirmed-at': string;
+}
+export declare type LocationRoleRelationships = 'location';
+export declare type LocationRoleModel = JSONAPIModel<LocationRoleAttributes, LocationRoleRelationships>;
+//# sourceMappingURL=LocationRoleResource.d.ts.map

package/dist/resources/LocationRoleResource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocationRoleResource.d.ts","sourceRoot":"","sources":["../../src/resources/LocationRoleResource.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,+BAA+B,CAAC;AAEzD,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,oBAAY,yBAAyB,GAAG,UAAU,CAAC;AAEnD,oBAAY,iBAAiB,GAAG,YAAY,CAAC,sBAAsB,EAAE,yBAAyB,CAAC,CAAC"}

package/dist/resources/LocationRoleResource.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/resources/SignInFieldPageResource.d.ts

@@ -0,0 +1,17 @@
+import JSONAPIModel from '../util/json-api/JSONAPIModel';
+/**
+ * @category API Resource
+ */
+export declare type SignInFieldPageAttributes = {
+    enabled?: boolean;
+    position?: number;
+};
+/**
+ * @category API Resource
+ */
+export declare type SignInFieldPageRelationships = 'flow' | 'actionable-sign-in-field-actions' | 'actionable-sign-in-fields' | 'sign-in-field-actions' | 'sign-in-fields';
+/**
+ * @category API Resource
+ */
+export declare type SignInFieldPageModel = JSONAPIModel<SignInFieldPageAttributes, SignInFieldPageRelationships>;
+//# sourceMappingURL=SignInFieldPageResource.d.ts.map

package/dist/resources/SignInFieldPageResource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SignInFieldPageResource.d.ts","sourceRoot":"","sources":["../../src/resources/SignInFieldPageResource.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,+BAA+B,CAAC;AAEzD;;GAEG;AACH,oBAAY,yBAAyB,GAAG;IACtC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,oBAAY,4BAA4B,GAAG,MAAM,GAC/C,kCAAkC,GAClC,2BAA2B,GAC3B,uBAAuB,GACvB,gBAAgB,CAAC;AAEnB;;GAEG;AACH,oBAAY,oBAAoB,GAAG,YAAY,CAAC,yBAAyB,EAAE,4BAA4B,CAAC,CAAC"}

package/dist/resources/SignInFieldPageResource.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/resources/SignInFieldResource.d.ts

@@ -0,0 +1,33 @@
+import JSONAPIModel from '../util/json-api/JSONAPIModel';
+/**
+ * @category API Resource
+ */
+export interface SignInFieldAttributes {
+    name: string;
+    kind: string;
+    required: boolean;
+    identifier?: string;
+    localized?: string;
+    'ipad-localized-names': Array<{
+        'language-code': string;
+        'region-code'?: string;
+        'display-name': string;
+    }>;
+    options?: Array<{
+        value: string;
+        position: number;
+    }>;
+    position?: number;
+    'store-response'?: boolean;
+    'created-at'?: string;
+    'updated-at'?: string;
+}
+/**
+ * @category API Resource
+ */
+export declare type SignInFieldRelationships = 'sign-in-field-page';
+/**
+ * @category API Resource
+ */
+export declare type SignInFieldModel = JSONAPIModel<SignInFieldAttributes, SignInFieldRelationships>;
+//# sourceMappingURL=SignInFieldResource.d.ts.map

package/dist/resources/SignInFieldResource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SignInFieldResource.d.ts","sourceRoot":"","sources":["../../src/resources/SignInFieldResource.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,+BAA+B,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sBAAsB,EAAE,KAAK,CAAC;QAC5B,eAAe,EAAE,MAAM,CAAC;QACxB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;KACxB,CAAC,CAAC;IACH,OAAO,CAAC,EAAE,KAAK,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC,CAAC;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,oBAAY,wBAAwB,GAAG,oBAAoB,CAAC;AAE5D;;GAEG;AACH,oBAAY,gBAAgB,GAAG,YAAY,CAAC,qBAAqB,EAAE,wBAAwB,CAAC,CAAC"}

package/dist/resources/SignInFieldResource.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/resources/UserResource.d.ts

@@ -0,0 +1,13 @@
+import JSONAPIModel from '../util/json-api/JSONAPIModel';
+/**
+ * @category API Resource
+ */
+export declare type UserAttributes = {
+    name: string;
+    email: string;
+};
+/**
+ * @category API Resource
+ */
+export declare type UserModel = JSONAPIModel<UserAttributes, ''>;
+//# sourceMappingURL=UserResource.d.ts.map

package/dist/resources/UserResource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserResource.d.ts","sourceRoot":"","sources":["../../src/resources/UserResource.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,+BAA+B,CAAC;AAEzD;;GAEG;AACH,oBAAY,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,oBAAY,SAAS,GAAG,YAAY,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC"}

package/dist/resources/UserResource.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sdk/EnvoyMeta.d.ts

@@ -0,0 +1,96 @@
+/**
+ * @category Meta
+ */
+export declare type EnvoyMetaJob<Event extends string = string> = {
+    id: string;
+    name: Event;
+    identifier: string;
+};
+/**
+ * @category Meta
+ */
+export declare type EnvoyMetaLocation = {
+    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;
+    };
+};
+/**
+ * @category Meta
+ */
+export declare type EnvoyMetaCompany = {
+    id: string;
+    type: 'companies';
+    attributes: {
+        name: string;
+        active: boolean;
+        'created-at': string;
+    };
+};
+/**
+ * A short-lived `userAPI` token.
+ * Will be used to construct the `userAPI` property found in `req.envoy.userAPI`.
+ *
+ * @category Meta
+ */
+export declare type EnvoyMetaAuth = {
+    token_type: 'Bearer';
+    access_token: string;
+    expires_in: number;
+    refresh_token: string | null;
+    refresh_token_expires_in: number | null;
+};
+/**
+ * Metadata that will be included in the request body for events.
+ *
+ * @category Meta
+ */
+export declare 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;
+    auth: EnvoyMetaAuth | null;
+};
+/**
+ * Metadata that will be included in the request body for setup routes,
+ * like validation URLs or options URLs.
+ *
+ * @category Meta
+ */
+export declare 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;
+    auth: EnvoyMetaAuth | null;
+    forwarded_bearer_token?: string;
+};
+/**
+ * Metadata that will be included in every request Envoy sends to your plugin.
+ *
+ * @category Meta
+ */
+declare type EnvoyMeta = EnvoyEventMeta | EnvoyRouteMeta;
+export default EnvoyMeta;
+//# sourceMappingURL=EnvoyMeta.d.ts.map

package/dist/sdk/EnvoyMeta.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnvoyMeta.d.ts","sourceRoot":"","sources":["../../src/sdk/EnvoyMeta.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,YAAY,CAAC,KAAK,SAAS,MAAM,GAAG,MAAM,IAAI;IACxD,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,KAAK,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,WAAW,CAAC;IAClB,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;QACb,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;QACvC,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QACtB,OAAO,EAAE,MAAM,CAAC;QAChB,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;QAClC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;QAClC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QACpB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QACnB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB,YAAY,EAAE,MAAM,CAAC;KACtB,CAAA;CACF,CAAC;AAEF;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,WAAW,CAAC;IAClB,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,OAAO,CAAC;QAChB,YAAY,EAAE,MAAM,CAAC;KACtB,CAAA;CACF,CAAC;AAEF;;;;;GAKG;AACH,oBAAY,aAAa,GAAG;IAC1B,UAAU,EAAE,QAAQ,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;CACzC,CAAC;AAEF;;;;GAIG;AACH,oBAAY,cAAc,CAAC,KAAK,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAC5F,KAAK,EAAE,KAAK,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC;IACzB,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,OAAO,EAAE,gBAAgB,CAAC;IAC1B,IAAI,EAAE,aAAa,GAAG,IAAI,CAAC;CAC5B,CAAC;AAEF;;;;;GAKG;AACH,oBAAY,cAAc,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAC/F,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,OAAO,EAAE,gBAAgB,CAAC;IAC1B,IAAI,EAAE,aAAa,GAAG,IAAI,CAAC;IAC3B,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC,CAAC;AAEF;;;;GAIG;AACH,aAAK,SAAS,GAAG,cAAc,GAAG,cAAc,CAAC;AACjD,eAAe,SAAS,CAAC"}

package/dist/sdk/EnvoyMeta.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sdk/EnvoyPluginAPI.d.ts

@@ -0,0 +1,31 @@
+import EnvoyAPI from '../base/EnvoyAPI';
+import EnvoyPluginJobUpdate from '../internal/EnvoyPluginJobUpdate';
+import EnvoyStorageCommand from '../internal/EnvoyStorageCommand';
+import EnvoyStorageResult from '../internal/EnvoyStorageResult';
+import { EnvoyMetaAuth } from './EnvoyMeta';
+/**
+ * API endpoints for *plugin-scoped* tokens.
+ *
+ * @category API
+ * @category Request Object
+ */
+export default class EnvoyPluginAPI extends EnvoyAPI {
+    updateJob(jobId: string, update: EnvoyPluginJobUpdate): Promise<void>;
+    /**
+     * Fetches the current `config` saved for this install during setup by the customer.
+     */
+    getPluginInstallConfig(installId: string): Promise<Record<string, unknown>>;
+    /**
+     * Merges changes with the current `config` saved for this install during setup by the customer.
+     *
+     * To remove an item from the saved `config`, set the item's key to `null`.
+     */
+    setPluginInstallConfig(installId: string, config: Record<string, unknown>): Promise<void>;
+    storagePipeline<Result extends EnvoyStorageResult = EnvoyStorageResult>(commands: Array<EnvoyStorageCommand>, installId?: string): Promise<Array<Result>>;
+    createNotification(installId: string, params?: {}): Promise<void>;
+    /**
+     * Gets a plugin access token using `client_credentials` as the grant type.
+     */
+    static loginAsPlugin(id?: string, secret?: string, scope?: string[]): Promise<EnvoyMetaAuth>;
+}
+//# sourceMappingURL=EnvoyPluginAPI.d.ts.map

package/dist/sdk/EnvoyPluginAPI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnvoyPluginAPI.d.ts","sourceRoot":"","sources":["../../src/sdk/EnvoyPluginAPI.ts"],"names":[],"mappings":"AACA,OAAO,QAAQ,MAAM,kBAAkB,CAAC;AACxC,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AACpE,OAAO,mBAAmB,MAAM,iCAAiC,CAAC;AAClE,OAAO,kBAAkB,MAAM,gCAAgC,CAAC;AAEhE,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAG5C;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,QAAQ;IAC5C,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ3E;;OAEG;IACG,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAKjF;;;;OAIG;IACG,sBAAsB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAQzF,eAAe,CAAC,MAAM,SAAS,kBAAkB,GAAG,kBAAkB,EAC1E,QAAQ,EAAE,KAAK,CAAC,mBAAmB,CAAC,EACpC,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAanB,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAQvE;;OAEG;WACU,aAAa,CAAC,EAAE,SAAgB,EAAE,MAAM,SAAoB,EAAE,KAAK,GAAE,MAAM,EAAgC,GAAG,OAAO,CAAC,aAAa,CAAC;CAsBlJ"}

package/dist/sdk/EnvoyPluginAPI.js

@@ -0,0 +1,205 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var axios_1 = __importDefault(require("axios"));
+var EnvoyAPI_1 = __importDefault(require("../base/EnvoyAPI"));
+var constants_1 = require("../constants");
+var axiosConstructor_1 = require("../util/axiosConstructor");
+/**
+ * API endpoints for *plugin-scoped* tokens.
+ *
+ * @category API
+ * @category Request Object
+ */
+var EnvoyPluginAPI = /** @class */ (function (_super) {
+    __extends(EnvoyPluginAPI, _super);
+    function EnvoyPluginAPI() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    EnvoyPluginAPI.prototype.updateJob = function (jobId, update) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.axios({
+                            method: 'PATCH',
+                            url: "/api/v2/plugin-services/jobs/" + jobId,
+                            data: update,
+                        })];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Fetches the current `config` saved for this install during setup by the customer.
+     */
+    EnvoyPluginAPI.prototype.getPluginInstallConfig = function (installId) {
+        return __awaiter(this, void 0, void 0, function () {
+            var data;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.axios.get("/api/v2/plugin-services/installs/" + installId + "/config")];
+                    case 1:
+                        data = (_a.sent()).data;
+                        return [2 /*return*/, data.data];
+                }
+            });
+        });
+    };
+    /**
+     * Merges changes with the current `config` saved for this install during setup by the customer.
+     *
+     * To remove an item from the saved `config`, set the item's key to `null`.
+     */
+    EnvoyPluginAPI.prototype.setPluginInstallConfig = function (installId, config) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.axios({
+                            method: 'PUT',
+                            url: "/api/v2/plugin-services/installs/" + installId + "/config",
+                            data: config,
+                        })];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    EnvoyPluginAPI.prototype.storagePipeline = function (commands, installId) {
+        return __awaiter(this, void 0, void 0, function () {
+            var request, data;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        request = { commands: commands };
+                        if (installId) {
+                            request.install_id = installId;
+                        }
+                        return [4 /*yield*/, this.axios({
+                                method: 'POST',
+                                url: '/api/v2/plugin-services/storage',
+                                data: request,
+                            })];
+                    case 1:
+                        data = (_a.sent()).data;
+                        return [2 /*return*/, data.data];
+                }
+            });
+        });
+    };
+    EnvoyPluginAPI.prototype.createNotification = function (installId, params) {
+        if (params === void 0) { params = {}; }
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.axios({
+                            method: 'POST',
+                            url: "/api/v2/plugin-services/installs/" + installId + "/notifications",
+                            data: params,
+                        })];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Gets a plugin access token using `client_credentials` as the grant type.
+     */
+    EnvoyPluginAPI.loginAsPlugin = function (id, secret, scope) {
+        if (id === void 0) { id = constants_1.envoyClientId; }
+        if (secret === void 0) { secret = constants_1.envoyClientSecret; }
+        if (scope === void 0) { scope = ['plugin', 'token.refresh']; }
+        return __awaiter(this, void 0, void 0, function () {
+            var data, error_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, axios_1.default({
+                                auth: {
+                                    username: id,
+                                    password: secret,
+                                },
+                                method: 'POST',
+                                data: {
+                                    grant_type: 'client_credentials',
+                                    client_id: id,
+                                    client_secret: secret,
+                                    scope: scope.join(','),
+                                },
+                                url: '/a/auth/v0/token',
+                                baseURL: constants_1.envoyBaseURL,
+                            })];
+                    case 1:
+                        data = (_a.sent()).data;
+                        return [2 /*return*/, data];
+                    case 2:
+                        error_1 = _a.sent();
+                        throw axiosConstructor_1.sanitizeAxiosError(error_1);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    return EnvoyPluginAPI;
+}(EnvoyAPI_1.default));
+exports.default = EnvoyPluginAPI;

package/dist/sdk/EnvoyPluginJob.d.ts

@@ -0,0 +1,49 @@
+import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment';
+import EnvoyPluginAPI from './EnvoyPluginAPI';
+/**
+ * A "job" is an event, like `entry_sign_in`.
+ * When your plugin handles the event, you can use this job concept
+ * to update the status (e.g. complete, failed, ignored)
+ * as well as attach extra data to the event's subject
+ * (e.g. showing a generated card number in the dashboard for a visitor on `entry_sign_in`).
+ *
+ * @category Request Object
+ */
+export default class EnvoyPluginJob {
+    protected readonly api: EnvoyPluginAPI;
+    readonly id: string;
+    constructor(pluginAPI: EnvoyPluginAPI, jobId: string);
+    private execute;
+    /**
+     * Add attachments to this job.
+     */
+    attach(...attachments: Array<EnvoyPluginJobAttachment>): Promise<void>;
+    /**
+     * Reports that the job is complete.
+     *
+     * Instead of calling this directly, you can return a 200 response from the job's event handler,
+     * using {@link EnvoyRequest.send}.
+     */
+    complete(message: string, ...attachments: Array<EnvoyPluginJobAttachment>): Promise<void>;
+    /**
+     * Reports that the job is ignored.
+     *
+     * Instead of calling this directly, you can return a 400 response from the job's event handler,
+     * using {@link EnvoyRequest.sendIgnored}.
+     */
+    ignore(message: string, reason: string): Promise<void>;
+    /**
+     * Reports that the job is ignored.
+     *
+     * Instead of calling this directly, you can return a 400 response from the job's event handler,
+     * using {@link EnvoyRequest.sendFailed}.
+     */
+    fail(message: string, reason: string): Promise<void>;
+    /**
+     * Updates the job with a new message and attachments.
+     *
+     * Can be used to periodically update long-running jobs.
+     */
+    update(message: string, ...attachments: Array<EnvoyPluginJobAttachment>): Promise<void>;
+}
+//# sourceMappingURL=EnvoyPluginJob.d.ts.map

package/dist/sdk/EnvoyPluginJob.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnvoyPluginJob.d.ts","sourceRoot":"","sources":["../../src/sdk/EnvoyPluginJob.ts"],"names":[],"mappings":"AAAA,OAAO,wBAAwB,MAAM,4BAA4B,CAAC;AAElE,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAE9C;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;IAEvC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;gBAER,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM;IAKpD,OAAO,CAAC,OAAO;IAqBf;;OAEG;IACH,MAAM,CAAC,GAAG,WAAW,EAAE,KAAK,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAItE;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,WAAW,EAAE,KAAK,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzF;;;;;OAKG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD;;;;;OAKG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpD;;;;OAIG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,WAAW,EAAE,KAAK,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAGxF"}