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

package/dist/sdk/EnvoyRequest.d.ts

@@ -0,0 +1,116 @@
+import { Request } from 'express';
+import EnvoyPluginSDK from './EnvoyPluginSDK';
+import EnvoyMeta, { EnvoyEventMeta, EnvoyRouteMeta } from './EnvoyMeta';
+import EntryPayload from '../payloads/EntryPayload';
+import InvitePayload from '../payloads/InvitePayload';
+import LocationPayload from '../payloads/LocationPayload';
+import NotificationPayload from '../payloads/NotificationPayload';
+import EnvoyEntryEvent from '../internal/EnvoyEntryEvent';
+import EnvoyInviteEvent from '../internal/EnvoyInviteEvent';
+import EnvoyLocationEvent from '../internal/EnvoyLocationEvent';
+import EnvoyOptionsRouteResponseBody from '../internal/EnvoyOptionsRouteResponseBody';
+import EnvoyOptionsRouteParams from '../internal/EnvoyOptionsRouteParams';
+import EnvoySelectedValuesRouteResponseBody from '../internal/EnvoySelectedValuesRouteResponseBody';
+import EnvoySelectedValuesRouteParams from '../internal/EnvoySelectedValuesRouteParams';
+import EnvoyRemoteValueRouteResponseBody from '../internal/EnvoyRemoteValueRouteResponseBody';
+/**
+ * @internal
+ */
+export declare const VERIFIED: unique symbol;
+/**
+ * @internal
+ */
+export interface VerifiedRequest extends Request {
+    [VERIFIED]: boolean;
+}
+/**
+ * Base type for Envoy requests.
+ * You probably won't need to use this type directly.
+ * For routes, use {@link EnvoyRouteRequest},
+ * and for events, use {@link EnvoyEntryEventRequest} or {@link EnvoyInviteEventRequest}.
+ *
+ * @category Base
+ */
+export interface EnvoyBaseRequest<Meta = EnvoyMeta, Payload = unknown> extends VerifiedRequest {
+    envoy: EnvoyPluginSDK<Meta, Payload>;
+}
+/**
+ * Use to type your `req` object in Envoy route handlers such as validation URLs.
+ *
+ * @category Request
+ */
+export declare type EnvoyRouteRequest<Payload = unknown, Config = Record<string, unknown>, Params = Record<string, unknown>> = EnvoyBaseRequest<EnvoyRouteMeta<Config, Params>, Payload>;
+/**
+ * Use to type your `req` object in Envoy "migration" route handlers.
+ *
+ * @category Request
+ */
+export declare type EnvoyMigrationRouteRequest<OldConfig = Record<string, unknown>> = EnvoyRouteRequest<never, OldConfig, never>;
+/**
+ * Use to type your `req` object in Envoy "options URL" route handlers.
+ *
+ * @category Request
+ */
+export declare type EnvoyOptionsRouteRequest<Config = Record<string, unknown>> = EnvoyRouteRequest<EnvoyOptionsRouteResponseBody, Config, EnvoyOptionsRouteParams>;
+/**
+ * Use to type your `req` object in Envoy "selected values URL" route handlers.
+ *
+ * @category Request
+ */
+export declare type EnvoySelectedValuesRouteRequest<Config = Record<string, unknown>> = EnvoyRouteRequest<EnvoySelectedValuesRouteResponseBody, Config, EnvoySelectedValuesRouteParams>;
+/**
+ * Use to type your `req` object in Envoy "remote value URL" route handlers.
+ *
+ * @category Request
+ */
+export declare type EnvoyRemoteValueRouteRequest<Config = Record<string, unknown>> = EnvoyRouteRequest<EnvoyRemoteValueRouteResponseBody, Config, never>;
+/**
+ * Use to type your `req` object in Envoy "validation URL" route handlers.
+ *
+ * @category Request
+ */
+export declare type EnvoyValidationRouteRequest<Payload = Record<string, unknown>, Config = Record<string, unknown>> = EnvoyRouteRequest<Payload, Config, never>;
+/**
+ * Base type for event requests.
+ * You should use {@link EnvoyEntryEventRequest} or {@link EnvoyInviteEventRequest}.
+ *
+ * @category Request
+ */
+export declare type EnvoyEventRequest<Event extends string = string, Payload = unknown, Config = Record<string, unknown>> = EnvoyBaseRequest<EnvoyEventMeta<Event, Config>, Payload>;
+/**
+ * Use to type your `req` object in entry event handlers,
+ * such as handlers for `entry_sign_in`.
+ *
+ * @category Request
+ */
+export declare type EnvoyEntryEventRequest<Config = Record<string, unknown>> = EnvoyEventRequest<EnvoyEntryEvent, EntryPayload, Config>;
+/**
+ * Use to type your `req` object in invite event handlers,
+ * such as handlers for `invite_created` or `upcoming_visit`.
+ *
+ * @category Request
+ */
+export declare type EnvoyInviteEventRequest<Config = Record<string, unknown>> = EnvoyEventRequest<EnvoyInviteEvent, InvitePayload, Config>;
+/**
+ * Use to type your `req` object in location event handlers,
+ * such as handlers for `location_capacity_updated`.
+ *
+ * @category Request
+ */
+export declare type EnvoyLocationEventRequest<Config = Record<string, unknown>> = EnvoyEventRequest<EnvoyLocationEvent, LocationPayload, Config>;
+/**
+ * Use to type your `req` object in your notification event handler.
+ *
+ * @category Request
+ */
+export declare type EnvoyNotificationEventRequest<Config = Record<string, unknown>> = EnvoyEventRequest<string, NotificationPayload, Config>;
+/**
+ * You probably won't need to use this type directly.
+ * For routes, use {@link EnvoyRouteRequest},
+ * and for events, use {@link EnvoyEntryEventRequest} or {@link EnvoyInviteEventRequest}.
+ *
+ * @category Base
+ */
+declare type EnvoyRequest<Payload = unknown, Config = Record<string, unknown>> = EnvoyBaseRequest<EnvoyRouteMeta<Config> | EnvoyEventMeta<string, Config>, Payload>;
+export default EnvoyRequest;
+//# sourceMappingURL=EnvoyRequest.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"EnvoyRequest.d.ts","sourceRoot":"","sources":["../../src/sdk/EnvoyRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,SAAS,EAAE,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACxE,OAAO,YAAY,MAAM,0BAA0B,CAAC;AACpD,OAAO,aAAa,MAAM,2BAA2B,CAAC;AACtD,OAAO,eAAe,MAAM,6BAA6B,CAAC;AAC1D,OAAO,mBAAmB,MAAM,iCAAiC,CAAC;AAClE,OAAO,eAAe,MAAM,6BAA6B,CAAC;AAC1D,OAAO,gBAAgB,MAAM,8BAA8B,CAAC;AAC5D,OAAO,kBAAkB,MAAM,gCAAgC,CAAC;AAChE,OAAO,6BAA6B,MAAM,2CAA2C,CAAC;AACtF,OAAO,uBAAuB,MAAM,qCAAqC,CAAC;AAC1E,OAAO,oCAAoC,MAAM,kDAAkD,CAAC;AACpG,OAAO,8BAA8B,MAAM,4CAA4C,CAAC;AACxF,OAAO,iCAAiC,MAAM,+CAA+C,CAAC;AAE9F;;GAEG;AACH,eAAO,MAAM,QAAQ,eAAqB,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,OAAO;IAC9C,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB,CAAC,IAAI,GAAG,SAAS,EAAE,OAAO,GAAG,OAAO,CAAE,SAAQ,eAAe;IAC5F,KAAK,EAAE,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;CACrC;AAED;;;;GAIG;AACH,oBAAY,iBAAiB,CAC3B,OAAO,GAAG,OAAO,EACjB,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC5B,gBAAgB,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;AAEhE;;;;GAIG;AACH,oBAAY,0BAA0B,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACxE,iBAAiB,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;AAE7C;;;;GAIG;AACH,oBAAY,wBAAwB,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACnE,iBAAiB,CAAC,6BAA6B,EAAE,MAAM,EAAE,uBAAuB,CAAC,CAAC;AAEpF;;;;GAIG;AACH,oBAAY,+BAA+B,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC1E,iBAAiB,CAAC,oCAAoC,EAAE,MAAM,EAAE,8BAA8B,CAAC,CAAC;AAElG;;;;GAIG;AACH,oBAAY,4BAA4B,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACvE,iBAAiB,CAAC,iCAAiC,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AAEtE;;;;GAIG;AACH,oBAAY,2BAA2B,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACzG,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AAE5C;;;;;GAKG;AACH,oBAAY,iBAAiB,CAAC,KAAK,SAAS,MAAM,GAAG,MAAM,EAAE,OAAO,GAAG,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC9G,gBAAgB,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;AAE3D;;;;;GAKG;AACH,oBAAY,sBAAsB,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACjE,iBAAiB,CAAC,eAAe,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;AAE3D;;;;;GAKG;AACH,oBAAY,uBAAuB,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAClE,iBAAiB,CAAC,gBAAgB,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;AAE7D;;;;;GAKG;AACH,oBAAY,yBAAyB,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACpE,iBAAiB,CAAC,kBAAkB,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;AAEjE;;;;GAIG;AACH,oBAAY,6BAA6B,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACxE,iBAAiB,CAAC,MAAM,EAAE,mBAAmB,EAAE,MAAM,CAAC,CAAC;AAEzD;;;;;;GAMG;AACH,aAAK,YAAY,CAAC,OAAO,GAAG,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACnE,gBAAgB,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;AACrF,eAAe,YAAY,CAAC"}

package/dist/sdk/EnvoyRequest.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERIFIED = void 0;
+/**
+ * @internal
+ */
+exports.VERIFIED = Symbol('verified');

package/dist/sdk/EnvoyResponse.d.ts

@@ -0,0 +1,42 @@
+import { Response } from 'express';
+import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment';
+import EnvoyOptionsRouteResponseBody from '../internal/EnvoyOptionsRouteResponseBody';
+import EnvoySelectedValuesRouteResponseBody from '../internal/EnvoySelectedValuesRouteResponseBody';
+import EnvoyRemoteValueRouteResponseBody from '../internal/EnvoyRemoteValueRouteResponseBody';
+/**
+ * Use to type your `res` object in Envoy event handlers.
+ * @category Response
+ */
+export default interface EnvoyResponse<Body = unknown> extends Response {
+    send: (body?: Body) => this;
+    /**
+     * Marks the job as "ongoing". This is useful for long-running event handling.
+     * Later on, you should update the job using
+     * {@link EnvoyPluginJob.complete}, {@link EnvoyPluginJob.fail}, or {@link EnvoyPluginJob.ignore}.
+     */
+    sendOngoing: (debugInfo?: unknown) => void;
+    /**
+     * Marks the job as "ignored". Useful when you explicitly do not want to handle the event.
+     */
+    sendIgnored: (message: string, debugInfo?: unknown, ...attachments: Array<EnvoyPluginJobAttachment>) => void;
+    /**
+     * Marks the job as "failed". The message will be communicated to the Envoy Dashboard user.
+     */
+    sendFailed: (message: string, debugInfo?: unknown, ...attachments: Array<EnvoyPluginJobAttachment>) => void;
+}
+/**
+ * Use to type your `res` object in Envoy "options URL" route handlers.
+ * @category Response
+ */
+export declare type EnvoyOptionsRouteResponse = EnvoyResponse<EnvoyOptionsRouteResponseBody>;
+/**
+ * Use to type your `res` object in Envoy "remote value URL" route handlers.
+ * @category Response
+ */
+export declare type EnvoyRemoteValueRouteResponse = EnvoyResponse<EnvoyRemoteValueRouteResponseBody>;
+/**
+ * Use to type your `res` object in Envoy "selected values URL" route handlers.
+ * @category Response
+ */
+export declare type EnvoySelectedValuesRouteResponse = EnvoyResponse<EnvoySelectedValuesRouteResponseBody>;
+//# sourceMappingURL=EnvoyResponse.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"EnvoyResponse.d.ts","sourceRoot":"","sources":["../../src/sdk/EnvoyResponse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,wBAAwB,MAAM,4BAA4B,CAAC;AAClE,OAAO,6BAA6B,MAAM,2CAA2C,CAAC;AACtF,OAAO,oCAAoC,MAAM,kDAAkD,CAAC;AACpG,OAAO,iCAAiC,MAAM,+CAA+C,CAAC;AAE9F;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC,IAAI,GAAG,OAAO,CAAE,SAAQ,QAAQ;IACrE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,IAAI,KAAK,IAAI,CAAC;IAC5B;;;;OAIG;IACH,WAAW,EAAE,CAAC,SAAS,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IAC3C;;OAEG;IACH,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,KAAK,CAAC,wBAAwB,CAAC,KAAK,IAAI,CAAC;IAE7G;;OAEG;IACH,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,KAAK,CAAC,wBAAwB,CAAC,KAAK,IAAI,CAAC;CAC7G;AAED;;;GAGG;AACH,oBAAY,yBAAyB,GAAG,aAAa,CAAC,6BAA6B,CAAC,CAAC;AAErF;;;GAGG;AACH,oBAAY,6BAA6B,GAAG,aAAa,CAAC,iCAAiC,CAAC,CAAC;AAE7F;;;GAGG;AACH,oBAAY,gCAAgC,GAAG,aAAa,CAAC,oCAAoC,CAAC,CAAC"}

package/dist/sdk/EnvoyResponse.js

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

package/dist/sdk/EnvoyStorageItem.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @category Storage
+ */
+declare type EnvoyStorageItem<Value = unknown> = {
+    key: string;
+    value: Value;
+};
+export default EnvoyStorageItem;
+//# sourceMappingURL=EnvoyStorageItem.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"EnvoyStorageItem.d.ts","sourceRoot":"","sources":["../../src/sdk/EnvoyStorageItem.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,aAAK,gBAAgB,CAAC,KAAK,GAAG,OAAO,IAAI;IACvC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,KAAK,CAAC;CACd,CAAC;AAEF,eAAe,gBAAgB,CAAC"}

package/dist/sdk/EnvoyStorageItem.js

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

package/dist/sdk/EnvoyUserAPI.d.ts

@@ -0,0 +1,119 @@
+import EnvoyAPI from '../base/EnvoyAPI';
+import { AgreementPageModel } from '../resources/AgreementPageResource';
+import { AgreementModel } from '../resources/AgreementResource';
+import { CompanyModel } from '../resources/CompanyResource';
+import { EmployeeFilterFields, EmployeeModel, EmployeeSortFields } from '../resources/EmployeeResource';
+import { FlowFilterFields, FlowModel, FlowSortFields } from '../resources/FlowResource';
+import { LocationFilterFields, LocationModel, LocationSortFields } from '../resources/LocationResource';
+import { SignInFieldPageModel } from '../resources/SignInFieldPageResource';
+import { SignInFieldModel } from '../resources/SignInFieldResource';
+import JSONAPIPaginationParams from '../util/json-api/JSONAPIPaginationParams';
+import { InviteCreationModel, InviteFilterFields, InviteModel, InviteSortFields } from '../resources/InviteResource';
+import { UserModel } from '../resources/UserResource';
+import { EnvoyMetaAuth } from './EnvoyMeta';
+export declare type EnvoyUserAPIScope = 'flows.read' | 'entries.read' | 'entries.write' | 'invites.read' | 'invites.write' | 'invites.attest' | 'locations.read' | 'companies.read' | 'agreements.read' | 'agreements.write' | 'sign-in-field-pages.read' | 'sign-in-fields.read' | 'sign-in-fields.write' | 'employees.read' | 'employees.write' | 'badges.read' | 'blacklist-filters.read' | 'blacklist-filters.write' | 'tickets.read' | 'tickets.write' | 'spaces.read' | 'reservations.read' | 'reservations.write' | string;
+/**
+ * API endpoints for *user-scoped* tokens.
+ * To access Envoy resources, this is the API you'd want.
+ *
+ * @category API
+ * @category Request Object
+ */
+export default class EnvoyUserAPI extends EnvoyAPI {
+    /**
+     *
+     * {@link AgreementPageModel}
+     */
+    getAgreementPage(id: string, include?: string): Promise<AgreementPageModel>;
+    /**
+     * Requires `agreements.read` scope.
+     */
+    getAgreement(id: string, include?: string): Promise<AgreementModel>;
+    /**
+     * Requires `companies.read` scope.
+     */
+    getCompany(id: string, include?: string): Promise<CompanyModel>;
+    /**
+     * Requires `employees.read` scope.
+     */
+    getEmployee(id: string, include?: string): Promise<EmployeeModel>;
+    /**
+     * Requires `flows.read` scope.
+     */
+    getFlow(id: string, include?: string): Promise<FlowModel>;
+    /**
+     * Requires `locations.read` scope.
+     */
+    getLocation(id: string, include?: string): Promise<LocationModel>;
+    /**
+     * Requires `sign-in-field-pages.read` scope.
+     */
+    getSignInFieldPage(id: string, include?: string): Promise<SignInFieldPageModel>;
+    /**
+     * Requires `sign-in-fields.read` scope.
+     */
+    getSignInField(id: string, include?: string): Promise<SignInFieldModel>;
+    /**
+     * Requires `employees.read` scope.
+     */
+    getEmployeeByEmail(email: string, include?: string): Promise<EmployeeModel>;
+    /**
+     * Requires `employees.read` scope.
+     */
+    getEmployees(params?: JSONAPIPaginationParams<EmployeeFilterFields, EmployeeSortFields>): Promise<Array<EmployeeModel>>;
+    /**
+     * Requires `flows.read` scope.
+     */
+    getFlows(params?: JSONAPIPaginationParams<FlowFilterFields, FlowSortFields>): Promise<Array<FlowModel>>;
+    /**
+     * Requires `locations.read` scope.
+     */
+    getLocations(params?: JSONAPIPaginationParams<LocationFilterFields, LocationSortFields>): Promise<Array<LocationModel>>;
+    /**
+     * Requires `sign-in-fields.read` scope.
+     */
+    getSignInFields(signInFieldPageId: string): Promise<Array<SignInFieldModel>>;
+    /**
+     * Requires `invites.read` scope.
+     */
+    getInvites(params?: JSONAPIPaginationParams<InviteFilterFields, InviteSortFields>): Promise<Array<InviteModel>>;
+    me(): Promise<UserModel>;
+    /**
+     * Requires `invites.write` scope.
+     * May also require `invites.attest` scope if setting `attested: true`.
+     */
+    createInvite(invite: InviteCreationModel): Promise<InviteModel>;
+    /**
+     * Requires `invites.write` scope.
+     */
+    updateInvite(inviteId: string, invite: InviteCreationModel): Promise<InviteModel>;
+    /**
+     * Requires `invites.write` scope.
+     */
+    partialUpdateInvite(inviteId: string, invite: InviteCreationModel): Promise<InviteModel>;
+    /**
+     * Requires `invites.write` scope.
+     */
+    removeInvite(inviteId: string): Promise<void>;
+    /**
+     * Builds the authorize URL to redirect a user to initiate the auth code oauth2 flow.
+     *
+     * Upon completion, they will be redirected to `redirectURL`, with a `code` query param in the url.
+     *
+     * Use the {@link loginAsUserWithCode} method to exchange that code for an access token.
+     */
+    static getAuthorizeURL(redirectURL: string, scope: Array<EnvoyUserAPIScope>, clientId?: string): string;
+    /**
+     * Gets a user access token using `password` as the grant type (discouraged - use {@link loginAsUserWithCode} below).
+     */
+    static loginAsUserWithPassword(username: string, password: string, scope: Array<EnvoyUserAPIScope>, clientId?: string, clientSecret?: string): Promise<EnvoyMetaAuth>;
+    /**
+     * Gets a user access token using `code` as the grant type.
+     */
+    static loginAsUserWithCode(code: string, scope: Array<EnvoyUserAPIScope>, clientId?: string, clientSecret?: string): Promise<EnvoyMetaAuth>;
+    /**
+     * Gets a user access token using `plugin_install` as the grant type.
+     */
+    static loginAsPluginInstaller(installId: string, clientId?: string, clientSecret?: string): Promise<EnvoyMetaAuth>;
+}
+//# sourceMappingURL=EnvoyUserAPI.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"EnvoyUserAPI.d.ts","sourceRoot":"","sources":["../../src/sdk/EnvoyUserAPI.ts"],"names":[],"mappings":"AAEA,OAAO,QAAQ,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACxE,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACxG,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACxF,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACxG,OAAO,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,uBAAuB,MAAM,0CAA0C,CAAC;AAC/E,OAAO,EACL,mBAAmB,EAAE,kBAAkB,EAAE,WAAW,EAAE,gBAAgB,EACvE,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAEtD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAG5C,oBAAY,iBAAiB,GAC3B,YAAY,GACZ,cAAc,GACd,eAAe,GACf,cAAc,GACd,eAAe,GACf,gBAAgB,GAChB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,GACjB,kBAAkB,GAClB,0BAA0B,GAC1B,qBAAqB,GACrB,sBAAsB,GACtB,gBAAgB,GAChB,iBAAiB,GACjB,aAAa,GACb,wBAAwB,GACxB,yBAAyB,GACzB,cAAc,GACd,eAAe,GACf,aAAa,GACb,mBAAmB,GACnB,oBAAoB,GACpB,MAAM,CAAC;AAET;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,QAAQ;IAChD;;;OAGG;IACG,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAIjF;;OAEG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAIzE;;OAEG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAIrE;;OAEG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAIvE;;OAEG;IACG,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAI/D;;OAEG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAIvE;;OAEG;IACG,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAIrF;;OAEG;IACG,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI7E;;OAEG;IACG,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAmBjF;;OAEG;IACG,YAAY,CAChB,MAAM,CAAC,EAAE,uBAAuB,CAAC,oBAAoB,EAAE,kBAAkB,CAAC,GACzE,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IAKhC;;OAEG;IACG,QAAQ,CAAC,MAAM,CAAC,EAAE,uBAAuB,CAAC,gBAAgB,EAAE,cAAc,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAK7G;;OAEG;IACG,YAAY,CAChB,MAAM,CAAC,EAAE,uBAAuB,CAAC,oBAAoB,EAAE,kBAAkB,CAAC,GACzE,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IAKhC;;OAEG;IACG,eAAe,CAAC,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAKlF;;OAEG;IACG,UAAU,CACd,MAAM,CAAC,EAAE,uBAAuB,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,GACrE,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAKxB,EAAE,IAAI,OAAO,CAAC,SAAS,CAAC;IAK9B;;;OAGG;IACG,YAAY,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,CAAC;IASrE;;OAEG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,CAAC;IAUvF;;OAEG;IACG,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,CAAC;IAU9F;;OAEG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOnD;;;;;;OAMG;IACH,MAAM,CAAC,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,iBAAiB,CAAC,EAAE,QAAQ,SAAgB,GAAG,MAAM;IAS9G;;OAEG;WACU,uBAAuB,CAClC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,KAAK,CAAC,iBAAiB,CAAC,EAC/B,QAAQ,SAAgB,EACxB,YAAY,SAAoB,GAC/B,OAAO,CAAC,aAAa,CAAC;IAuBzB;;OAEG;WACU,mBAAmB,CAC9B,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,KAAK,CAAC,iBAAiB,CAAC,EAC/B,QAAQ,SAAgB,EACxB,YAAY,SAAoB,GAC/B,OAAO,CAAC,aAAa,CAAC;IAsBzB;;OAEG;WACU,sBAAsB,CACjC,SAAS,EAAE,MAAM,EACjB,QAAQ,SAAgB,EACxB,YAAY,SAAoB,GAC/B,OAAO,CAAC,aAAa,CAAC;CAoB1B"}