@esri/hub-common 14.105.0 → 14.107.0

package/dist/node/newsletters/api/orval/custom-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-client.js","sourceRoot":"","sources":["../../../../../src/newsletters/api/orval/custom-client.ts"],"names":[],"mappings":";;;AAuBO,KAAK,UAAU,YAAY,CAChC,WAAyB,EACzB,YAA2B;IAE3B,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;IAC1C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,YAAY,CAAC;IAClD,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IAErE,MAAM,OAAO,GAAG,mBAAmB,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAC5D,MAAM,UAAU,GAAG,GAAG,OAAO,GAAG,GAAG,IAAI,IAAI,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;IAErE,MAAM,cAAc,GAAgB;QAClC,OAAO;QACP,MAAM;QACN,KAAK;QACL,WAAW;QACX,IAAI;KACL,CAAC;IACF,IAAI,IAAI,EAAE;QACR,cAAc,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;KAC5C;IAED,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IACpD,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEnC,IAAI,GAAG,CAAC,EAAE,EAAE;QACV,OAAO,GAAG,CAAC,IAAI,EAAE,CAAC;KACnB;IAED,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;IAC/B,MAAM,IAAI,iBAAiB,CACzB,UAAU,EACV,UAAU,EACV,MAAM,EACN,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAC9B,CAAC;AACJ,CAAC;AApCD,oCAoCC;AAED,SAAS,mBAAmB,CAAC,SAAS,GAAG,wBAAwB;IAC/D,OAAO,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AACtC,CAAC;AAED,SAAS,aAAa,CAAC,WAAyB,EAAE,OAAsB;IACtE,MAAM,OAAO,GAAG,IAAI,OAAO,iCACtB,WAAW,CAAC,OAAO,GACnB,OAAO,CAAC,OAAO,EAClB,CAAC;IACH,IAAI,OAAO,CAAC,KAAK,EAAE;QACjB,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;KAC7C;IAED,MAAM,MAAM,mCACP,WAAW,CAAC,MAAM,GAClB,OAAO,CAAC,MAAM,CAClB,CAAC;IAEF,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;AAC7B,CAAC;AAED,MAAM,iBAAkB,SAAQ,KAAK;IAKnC,YAAY,OAAe,EAAE,GAAW,EAAE,MAAc,EAAE,KAAa;QACrE,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF"}

package/dist/node/newsletters/api/subscriptions.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateSubscription = exports.getSubscription = exports.getSubscriptions = exports.createSubscription = exports.subscribe = void 0;
+const authenticate_request_1 = require("./utils/authenticate-request");
+const orval_newsletters_1 = require("./orval/api/orval-newsletters");
+/**
+ * create a subscription for user (existing or not) to a newsletter
+ *
+ * @param {ISubscribeParams} options
+ * @return {Promise<ISubscription>}
+ */
+async function subscribe(options) {
+    options.token = await authenticate_request_1.authenticateRequest(options);
+    return orval_newsletters_1.subscribe(options.data, options);
+}
+exports.subscribe = subscribe;
+/**
+ * create a subscription for user (existing) to a newsletter
+ *
+ * @param {ICreateSubscriptionParams} options
+ * @return {Promise<ISubscription>}
+ */
+async function createSubscription(options) {
+    options.token = await authenticate_request_1.authenticateRequest(options);
+    return orval_newsletters_1.createSubscription(options.data, options);
+}
+exports.createSubscription = createSubscription;
+/**
+ * get subscriptions
+ *
+ * @param {IGetSubscriptionsParams} options
+ * @return {Promise<ISubscription[]>}
+ */
+async function getSubscriptions(options) {
+    options.token = await authenticate_request_1.authenticateRequest(options);
+    return orval_newsletters_1.getSubscriptions(options.data, options);
+}
+exports.getSubscriptions = getSubscriptions;
+/**
+ * get a subscription
+ *
+ * @param {IGetSubscriptionParams} options
+ * @return {Promise<ISubscription>}
+ */
+async function getSubscription(options) {
+    options.token = await authenticate_request_1.authenticateRequest(options);
+    return orval_newsletters_1.getSubscription(options.subscriptionId, options);
+}
+exports.getSubscription = getSubscription;
+/**
+ * update a subscription
+ *
+ * @param {IUpdateSubscriptionParams} options
+ * @return {Promise<ISubscription>}
+ */
+async function updateSubscription(options) {
+    options.token = await authenticate_request_1.authenticateRequest(options);
+    return orval_newsletters_1.updateSubscription(options.subscriptionId, options.data, options);
+}
+exports.updateSubscription = updateSubscription;
+//# sourceMappingURL=subscriptions.js.map

package/dist/node/newsletters/api/subscriptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../../../../src/newsletters/api/subscriptions.ts"],"names":[],"mappings":";;;AAQA,uEAAmE;AACnE,qEAMuC;AAEvC;;;;;GAKG;AACI,KAAK,UAAU,SAAS,CAC7B,OAAyB;IAEzB,OAAO,CAAC,KAAK,GAAG,MAAM,0CAAmB,CAAC,OAAO,CAAC,CAAC;IACnD,OAAO,6BAAU,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC3C,CAAC;AALD,8BAKC;AAED;;;;;GAKG;AACI,KAAK,UAAU,kBAAkB,CACtC,OAAkC;IAElC,OAAO,CAAC,KAAK,GAAG,MAAM,0CAAmB,CAAC,OAAO,CAAC,CAAC;IACnD,OAAO,sCAAmB,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AACpD,CAAC;AALD,gDAKC;AAED;;;;;GAKG;AACI,KAAK,UAAU,gBAAgB,CACpC,OAAgC;IAEhC,OAAO,CAAC,KAAK,GAAG,MAAM,0CAAmB,CAAC,OAAO,CAAC,CAAC;IACnD,OAAO,oCAAiB,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAClD,CAAC;AALD,4CAKC;AAED;;;;;GAKG;AACI,KAAK,UAAU,eAAe,CACnC,OAA+B;IAE/B,OAAO,CAAC,KAAK,GAAG,MAAM,0CAAmB,CAAC,OAAO,CAAC,CAAC;IACnD,OAAO,mCAAgB,CAAC,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;AAC3D,CAAC;AALD,0CAKC;AAED;;;;;GAKG;AACI,KAAK,UAAU,kBAAkB,CACtC,OAAkC;IAElC,OAAO,CAAC,KAAK,GAAG,MAAM,0CAAmB,CAAC,OAAO,CAAC,CAAC;IACnD,OAAO,sCAAmB,CAAC,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC5E,CAAC;AALD,gDAKC"}

package/dist/node/newsletters/api/types.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var orval_newsletters_1 = require("./orval/api/orval-newsletters");
+Object.defineProperty(exports, "Cadence", { enumerable: true, get: function () { return orval_newsletters_1.Cadence; } });
+Object.defineProperty(exports, "DeliveryMethod", { enumerable: true, get: function () { return orval_newsletters_1.DeliveryMethod; } });
+Object.defineProperty(exports, "SystemNotificationSpecNames", { enumerable: true, get: function () { return orval_newsletters_1.SystemNotificationSpecNames; } });
+//# sourceMappingURL=types.js.map

package/dist/node/newsletters/api/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/newsletters/api/types.ts"],"names":[],"mappings":";;AAAA,mEAWuC;AAVrC,4GAAA,OAAO,OAAA;AACP,mHAAA,cAAc,OAAA;AAQd,gIAAA,2BAA2B,OAAA"}

package/dist/node/newsletters/api/users.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteUser = exports.updateUser = exports.getUser = exports.createUser = void 0;
+const authenticate_request_1 = require("./utils/authenticate-request");
+const orval_newsletters_1 = require("./orval/api/orval-newsletters");
+/**
+ * create a user
+ *
+ * @param {ICreateUserParams} options
+ * @return {Promise<IUser>}
+ */
+async function createUser(options) {
+    options.token = await authenticate_request_1.authenticateRequest(options);
+    return orval_newsletters_1.createUser(options.data, options);
+}
+exports.createUser = createUser;
+/**
+ * get a user
+ *
+ * @param {IGetUserParams} options
+ * @return {Promise<IUser>}
+ */
+async function getUser(options) {
+    options.token = await authenticate_request_1.authenticateRequest(options);
+    return orval_newsletters_1.getUser(options.userId, options);
+}
+exports.getUser = getUser;
+/**
+ * update a user
+ *
+ * @param {IUpdateUserParams} options
+ * @return {Promise<IUser>}
+ */
+async function updateUser(options) {
+    options.token = await authenticate_request_1.authenticateRequest(options);
+    return orval_newsletters_1.updateUser(options.userId, options.data, options);
+}
+exports.updateUser = updateUser;
+/**
+ * delete a user
+ *
+ * @param {IDeleteUserParams} options
+ * @return {Promise<IUser>}
+ */
+async function deleteUser(options) {
+    options.token = await authenticate_request_1.authenticateRequest(options);
+    return orval_newsletters_1.deleteUser(options.userId, options);
+}
+exports.deleteUser = deleteUser;
+//# sourceMappingURL=users.js.map

package/dist/node/newsletters/api/users.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.js","sourceRoot":"","sources":["../../../../src/newsletters/api/users.ts"],"names":[],"mappings":";;;AAOA,uEAAmE;AACnE,qEAKuC;AAEvC;;;;;GAKG;AACI,KAAK,UAAU,UAAU,CAAC,OAA0B;IACzD,OAAO,CAAC,KAAK,GAAG,MAAM,0CAAmB,CAAC,OAAO,CAAC,CAAC;IACnD,OAAO,8BAAW,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC5C,CAAC;AAHD,gCAGC;AAED;;;;;GAKG;AACI,KAAK,UAAU,OAAO,CAAC,OAAuB;IACnD,OAAO,CAAC,KAAK,GAAG,MAAM,0CAAmB,CAAC,OAAO,CAAC,CAAC;IACnD,OAAO,2BAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC3C,CAAC;AAHD,0BAGC;AAED;;;;;GAKG;AACI,KAAK,UAAU,UAAU,CAAC,OAA0B;IACzD,OAAO,CAAC,KAAK,GAAG,MAAM,0CAAmB,CAAC,OAAO,CAAC,CAAC;IACnD,OAAO,8BAAW,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC5D,CAAC;AAHD,gCAGC;AAED;;;;;GAKG;AACI,KAAK,UAAU,UAAU,CAAC,OAA0B;IACzD,OAAO,CAAC,KAAK,GAAG,MAAM,0CAAmB,CAAC,OAAO,CAAC,CAAC;IACnD,OAAO,8BAAW,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC9C,CAAC;AAHD,gCAGC"}

package/dist/node/newsletters/api/utils/authenticate-request.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.authenticateRequest = void 0;
+/**
+ * return a token created using options.authentication or set on options.token
+ *
+ * @export
+ * @param {INewslettersRequestOptions} options
+ * @return {*}  {Promise<string>}
+ */
+function authenticateRequest(options) {
+    const { token, authentication } = options;
+    if (authentication) {
+        return authentication.getToken(authentication.portal);
+    }
+    return Promise.resolve(token);
+}
+exports.authenticateRequest = authenticateRequest;
+//# sourceMappingURL=authenticate-request.js.map

package/dist/node/newsletters/api/utils/authenticate-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authenticate-request.js","sourceRoot":"","sources":["../../../../../src/newsletters/api/utils/authenticate-request.ts"],"names":[],"mappings":";;;AAEA;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,OAAmC;IAEnC,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;IAE1C,IAAI,cAAc,EAAE;QAClB,OAAO,cAAc,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;KACvD;IAED,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAChC,CAAC;AAVD,kDAUC"}

package/dist/node/newsletters/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./api"), exports);
+//# sourceMappingURL=index.js.map

package/dist/node/newsletters/index.js.map

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

package/dist/types/core/schemas/types.d.ts

@@ -12,7 +12,7 @@ export interface IEditorConfig {
  * to the supported/defined uiSchema configurations
  */
 export declare type EntityEditorType = (typeof validEntityEditorTypes)[number];
-export declare const validEntityEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:project:metrics", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:initiative:metrics", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:initiativeTemplate:edit", "hub:survey:edit", "hub:survey:settings"];
+export declare const validEntityEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:project:metrics", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:initiative:metrics", "hub:initiative:associations", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:initiativeTemplate:edit", "hub:survey:edit", "hub:survey:settings"];
 /** Defines the possible editor type values for a stat card. These
  * correspond to the supported/defined uiSchema configurations. This should
  * have its own signature in the getEditorConfig function.
@@ -36,7 +36,7 @@ export declare const validCardEditorTypes: readonly ["hub:card:stat", "hub:card:
  * to defined schema/uiSchema configurations
  */
 export declare type EditorType = (typeof validEditorTypes)[number];
-export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:project:metrics", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:initiative:metrics", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:initiativeTemplate:edit", "hub:survey:edit", "hub:survey:settings", "hub:card:stat", "hub:card:follow"];
+export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:project:metrics", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:initiative:metrics", "hub:initiative:associations", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:initiativeTemplate:edit", "hub:survey:edit", "hub:survey:settings", "hub:card:stat", "hub:card:follow"];
 /**
  * An editor's module when dynamically imported depending on the EditorType. This
  * will always have a buildUiSchema function, and sometimes it will have a

package/dist/types/core/types/IHubItemEntity.d.ts

@@ -1,6 +1,6 @@
 import { IHubEntityBase } from "./IHubEntityBase";
 import { IHubGeography } from "../../types";
-import { AccessLevel } from "./types";
+import { AccessLevel, MembershipAccess } from "./types";
 import { IWithPermissions, IWithViewSettings, IWithDiscussions } from "../traits";
 import { IHubLocation } from "./IHubLocation";
 import { IWithFollowers } from "../traits/IWithFollowers";
@@ -129,5 +129,14 @@ export declare type IHubItemEntityEditor<T> = Omit<T, "extent"> & {
         showFollowAction?: boolean;
         isDiscussable?: boolean;
     };
+    /**
+     * Association group settings. These settings are only used in the
+     * Editor and is persisted appropriately in the fromEditor
+     * method on the Class
+     */
+    _associations?: {
+        groupAccess?: AccessLevel;
+        membershipAccess?: MembershipAccess;
+    };
     _metric?: IMetricEditorValues;
 };

package/dist/types/events/api/events.d.ts

@@ -16,7 +16,7 @@ export declare function getEvents(options: IGetEventsParams): Promise<IEvent[]>;
 /**
  * get an event
  *
- * @param {ICreateEventParams} options
+ * @param {IGetEventParams} options
  * @return {Promise<IEvent>}
  */
 export declare function getEvent(options: IGetEventParams): Promise<IEvent>;

package/dist/types/events/api/utils/authenticate-request.d.ts

@@ -3,7 +3,7 @@ import { IEventsRequestOptions } from "../types";
  * return a token created using options.authentication or set on options.token
  *
  * @export
- * @param {IDiscussionsRequestOptions} options
+ * @param {IEventsRequestOptions} options
  * @return {*}  {Promise<string>}
  */
 export declare function authenticateRequest(options: IEventsRequestOptions): Promise<string>;

package/dist/types/initiatives/HubInitiatives.d.ts

@@ -1,10 +1,11 @@
 import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
 import { IHubRequestOptions, IHubInitiativeEditor } from "../index";
 import { IQuery } from "../search/types/IHubCatalog";
-import { IItem, IPortal } from "@esri/arcgis-rest-portal";
+import { IItem } from "@esri/arcgis-rest-portal";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IEntityInfo, IHubInitiative } from "../core/types";
 import { IHubSearchResult } from "../search";
+import { IArcGISContext } from "../ArcGISContext";
 /**
  * @private
  * Create a new Hub Initiative item
@@ -21,7 +22,7 @@ export declare function createInitiative(partialInitiative: Partial<IHubInitiati
  * @param portal
  * @returns
  */
-export declare function editorToInitiative(editor: IHubInitiativeEditor, portal: IPortal): IHubInitiative;
+export declare function editorToInitiative(editor: IHubInitiativeEditor, context: IArcGISContext): Promise<IHubInitiative>;
 /**
  * @private
  * Update a Hub Initiative

package/dist/types/initiatives/_internal/InitiativeSchema.d.ts

@@ -1,6 +1,6 @@
 import { IConfigurationSchema } from "../../core";
 export declare type InitiativeEditorType = (typeof InitiativeEditorTypes)[number];
-export declare const InitiativeEditorTypes: readonly ["hub:initiative:edit", "hub:initiative:create", "hub:initiative:metrics"];
+export declare const InitiativeEditorTypes: readonly ["hub:initiative:edit", "hub:initiative:create", "hub:initiative:metrics", "hub:initiative:associations"];
 /**
  * defines the JSON schema for a Hub Initiative's editable fields
  */

package/dist/types/initiatives/_internal/InitiativeUiSchemaAssociations.d.ts

@@ -0,0 +1,10 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { IUiSchema } from "../../core/schemas/types";
+import { IHubInitiative } from "../../core/types";
+/**
+ * @private
+ * constructs the minimal association group settings uiSchema for Hub Initiatives.
+ * This defines how the schema properties should be rendered
+ * in the initiative creation experience
+ */
+export declare const buildUiSchema: (i18nScope: string, options: Partial<IHubInitiative>, context: IArcGISContext) => Promise<IUiSchema>;

package/dist/types/newsletters/api/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./subscriptions";
+export * from "./users";
+export * from "./types";

package/dist/types/newsletters/api/orval/api/orval-newsletters.d.ts

@@ -0,0 +1,215 @@
+import { Awaited } from "../awaited-type";
+/**
+ * Generated by orval v6.24.0 🍺
+ * Do not edit manually.
+ * Hub Newsletters Service
+ * OpenAPI spec version: 0.0.1
+ */
+import { customClient } from "../custom-client";
+export declare type GetSubscriptionsParams = {
+    /**
+     * Optional array of matching notification spec names to filter by
+     */
+    names?: string[];
+    /**
+     * Optional cadence to filter by
+     */
+    cadence?: Cadence;
+    /**
+     * Optional user id to filter by. Note this gets extracted/overridden from AGO token if provided
+     */
+    userId?: string;
+    /**
+     * Optional flag for filtering active subscriptions
+     */
+    active?: boolean;
+};
+export interface IUpdateNotificationSpec {
+    /** Description of the notification spec */
+    description?: string;
+    /** Name identifier for the notification spec */
+    name?: string;
+}
+export interface ICreateNotificationSpec {
+    /** Description of the notification spec */
+    description?: string;
+    /** Name identifier for the notification spec */
+    name: string;
+}
+export interface IUpdateUser {
+    /** Flag for deleted user */
+    deleted?: boolean;
+    /** Email for the subscriber. Will always be extracted from the token unless service token is used. */
+    email?: string;
+    /** First name for the subscriber. Will always be extracted from the token unless service token is used. */
+    firstName?: string;
+    /** Last name for the subscriber. Will always be extracted from the token unless service token is used. */
+    lastName?: string;
+    /** Flag for unsubscribed user */
+    optedOut?: boolean;
+    /** Username for the subscriber. Will always be extracted from the token unless service token is used. */
+    username?: string;
+}
+export interface ICreateUser {
+    /** ArcGIS Online id for a user. Will always be extracted from the token unless service token is used. */
+    agoId?: string;
+    /** Flag for deleted user */
+    deleted?: boolean;
+    /** Email for the subscriber. Will always be extracted from the token unless service token is used. */
+    email?: string;
+    /** First name for the subscriber. Will always be extracted from the token unless service token is used. */
+    firstName?: string;
+    /** Last name for the subscriber. Will always be extracted from the token unless service token is used. */
+    lastName?: string;
+    /** Flag for unsubscribed user */
+    optedOut?: boolean;
+    /** Username for the subscriber. Will always be extracted from the token unless service token is used. */
+    username?: string;
+}
+/**
+ * Metadata for the subscription
+ */
+export declare type ISubscribeMetadata = ICreateEventMetadata | ICreateTelemetryReportMetadata;
+export declare type ISubscriptionMetadata = {
+    [key: string]: any;
+};
+export interface IUser {
+    agoId: string;
+    createdAt: string;
+    deleted: boolean;
+    email: string;
+    firstName: string;
+    lastName: string;
+    optedOut: boolean;
+    updatedAt: string;
+    username: string;
+}
+export interface INotificationSpec {
+    createdAt: string;
+    createdById: string;
+    description: string;
+    id: number;
+    name: string;
+    updatedAt: string;
+}
+/**
+ * Metadata for the subscription
+ */
+export declare type ICreateSubscriptionMetadata = ICreateEventMetadata | ICreateTelemetryReportMetadata;
+export declare enum DeliveryMethod {
+    EMAIL = "EMAIL"
+}
+export declare enum Cadence {
+    ON_EVENT = "ON_EVENT",
+    DAILY = "DAILY",
+    WEEKLY = "WEEKLY",
+    MONTHLY = "MONTHLY"
+}
+export interface IUpdateSubscription {
+    /** Flag to opt user in or out of subscription */
+    active?: boolean;
+    /** Frequency of the subscription */
+    cadence?: Cadence;
+    /** Delivery method for subscription, ie email or text */
+    deliveryMethod?: DeliveryMethod;
+    /** Last delivered datetime string of the subscription in ISO 8601 format */
+    lastDelivery?: string;
+    /** ArcGIS Online id for a user. Will always be extracted from the token unless service token is used. */
+    userId?: string;
+}
+export interface ISubscription {
+    active: boolean;
+    cadence: Cadence;
+    createdAt: string;
+    deliveryMethod: DeliveryMethod;
+    id: number;
+    lastDelivery: string;
+    metadata: ISubscriptionMetadata;
+    notificationSpec?: INotificationSpec;
+    notificationSpecId: number;
+    updatedAt: string;
+    user?: IUser;
+    userId: string;
+}
+export declare enum SystemNotificationSpecNames {
+    TELEMETRY_REPORT = "TELEMETRY_REPORT",
+    EVENT = "EVENT"
+}
+export interface ISubscribe {
+    /** ArcGIS Online id for a user. Will always be extracted from the token unless service token is used. */
+    agoId?: string;
+    /** Frequency of the subscription */
+    cadence: Cadence;
+    /** Flag for deleted user */
+    deleted?: boolean;
+    /** Delivery method for subscription, ie email or text */
+    deliveryMethod: DeliveryMethod;
+    /** Email for the subscriber. Will always be extracted from the token unless service token is used. */
+    email?: string;
+    /** First name for the subscriber. Will always be extracted from the token unless service token is used. */
+    firstName?: string;
+    /** Last name for the subscriber. Will always be extracted from the token unless service token is used. */
+    lastName?: string;
+    /** Metadata for the subscription */
+    metadata: ISubscribeMetadata;
+    /** Notification spec name for the subscription */
+    notificationSpecName: SystemNotificationSpecNames;
+    /** Flag for unsubscribed user */
+    optedOut?: boolean;
+    /** Username for the subscriber. Will always be extracted from the token unless service token is used. */
+    username?: string;
+}
+export interface ICreateSubscription {
+    /** Frequency of the subscription */
+    cadence: Cadence;
+    /** Delivery method for subscription, ie email or text */
+    deliveryMethod: DeliveryMethod;
+    /** Metadata for the subscription */
+    metadata: ICreateSubscriptionMetadata;
+    /** Notification spec name for the subscription */
+    notificationSpecName: SystemNotificationSpecNames;
+    /** AGO id for user which subscription belongs to */
+    userId: string;
+}
+export interface ICreateEventMetadata {
+    /** Event id for the subscription */
+    eventId: string;
+}
+export interface ICreateTelemetryReportMetadata {
+    /** Hostname for telemetry report. */
+    hostname: string;
+}
+declare type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
+export declare const createSubscription: (iCreateSubscription: ICreateSubscription, options?: SecondParameter<typeof customClient>) => Promise<ISubscription>;
+export declare const getSubscriptions: (params?: GetSubscriptionsParams, options?: SecondParameter<typeof customClient>) => Promise<ISubscription[]>;
+export declare const subscribe: (iSubscribe: ISubscribe, options?: SecondParameter<typeof customClient>) => Promise<ISubscription>;
+export declare const getSubscription: (id: number, options?: SecondParameter<typeof customClient>) => Promise<ISubscription>;
+export declare const updateSubscription: (id: number, iUpdateSubscription: IUpdateSubscription, options?: SecondParameter<typeof customClient>) => Promise<ISubscription>;
+export declare const deleteSubscription: (id: number, options?: SecondParameter<typeof customClient>) => Promise<ISubscription>;
+export declare const createUser: (iCreateUser: ICreateUser, options?: SecondParameter<typeof customClient>) => Promise<IUser>;
+export declare const getUsers: (options?: SecondParameter<typeof customClient>) => Promise<IUser[]>;
+export declare const getUser: (userId: string, options?: SecondParameter<typeof customClient>) => Promise<IUser>;
+export declare const updateUser: (userId: string, iUpdateUser: IUpdateUser, options?: SecondParameter<typeof customClient>) => Promise<IUser>;
+export declare const deleteUser: (userId: string, options?: SecondParameter<typeof customClient>) => Promise<IUser>;
+export declare const createNotificationSpec: (iCreateNotificationSpec: ICreateNotificationSpec, options?: SecondParameter<typeof customClient>) => Promise<INotificationSpec>;
+export declare const getNotificationSpecs: (options?: SecondParameter<typeof customClient>) => Promise<INotificationSpec[]>;
+export declare const getNotificationSpec: (id: number, options?: SecondParameter<typeof customClient>) => Promise<INotificationSpec>;
+export declare const updateNotificationSpec: (id: number, iUpdateNotificationSpec: IUpdateNotificationSpec, options?: SecondParameter<typeof customClient>) => Promise<INotificationSpec>;
+export declare const deleteNotificationSpec: (id: number, options?: SecondParameter<typeof customClient>) => Promise<INotificationSpec>;
+export declare type CreateSubscriptionResult = NonNullable<Awaited<ReturnType<typeof createSubscription>>>;
+export declare type GetSubscriptionsResult = NonNullable<Awaited<ReturnType<typeof getSubscriptions>>>;
+export declare type SubscribeResult = NonNullable<Awaited<ReturnType<typeof subscribe>>>;
+export declare type GetSubscriptionResult = NonNullable<Awaited<ReturnType<typeof getSubscription>>>;
+export declare type UpdateSubscriptionResult = NonNullable<Awaited<ReturnType<typeof updateSubscription>>>;
+export declare type DeleteSubscriptionResult = NonNullable<Awaited<ReturnType<typeof deleteSubscription>>>;
+export declare type CreateUserResult = NonNullable<Awaited<ReturnType<typeof createUser>>>;
+export declare type GetUsersResult = NonNullable<Awaited<ReturnType<typeof getUsers>>>;
+export declare type GetUserResult = NonNullable<Awaited<ReturnType<typeof getUser>>>;
+export declare type UpdateUserResult = NonNullable<Awaited<ReturnType<typeof updateUser>>>;
+export declare type DeleteUserResult = NonNullable<Awaited<ReturnType<typeof deleteUser>>>;
+export declare type CreateNotificationSpecResult = NonNullable<Awaited<ReturnType<typeof createNotificationSpec>>>;
+export declare type GetNotificationSpecsResult = NonNullable<Awaited<ReturnType<typeof getNotificationSpecs>>>;
+export declare type GetNotificationSpecResult = NonNullable<Awaited<ReturnType<typeof getNotificationSpec>>>;
+export declare type UpdateNotificationSpecResult = NonNullable<Awaited<ReturnType<typeof updateNotificationSpec>>>;
+export declare type DeleteNotificationSpecResult = NonNullable<Awaited<ReturnType<typeof deleteNotificationSpec>>>;
+export {};

package/dist/types/newsletters/api/orval/awaited-type.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Orval generates return types for functions using utility type Awaited
+ * This was introduced in Typescript 4.5, but hub.js is using Typescript 3
+ */
+export declare type Awaited<T> = T extends PromiseLike<infer U> ? U : T;

package/dist/types/newsletters/api/orval/custom-client.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated and copied from the [hub engagement repo](https://github.com/ArcGIS/hub-newsletters/blob/master/orval/custom-client.ts)
+ * Do not edit manually
+ */
+export interface IOrvalParams {
+    url: string;
+    method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+    headers?: HeadersInit;
+    params?: Record<string, any>;
+    data?: Record<string, any>;
+}
+export interface ICustomParams {
+    hubApiUrl?: string;
+    token?: string;
+    headers?: HeadersInit;
+    params?: Record<string, any>;
+    data?: Record<string, any>;
+    mode?: RequestMode;
+    cache?: RequestCache;
+    credentials?: RequestCredentials;
+}
+export declare function customClient<T>(orvalParams: IOrvalParams, customParams: ICustomParams): Promise<T>;

package/dist/types/newsletters/api/subscriptions.d.ts

@@ -0,0 +1,36 @@
+import { ISubscribeParams, ISubscription, ICreateSubscriptionParams, IGetSubscriptionsParams, IGetSubscriptionParams, IUpdateSubscriptionParams } from "./types";
+/**
+ * create a subscription for user (existing or not) to a newsletter
+ *
+ * @param {ISubscribeParams} options
+ * @return {Promise<ISubscription>}
+ */
+export declare function subscribe(options: ISubscribeParams): Promise<ISubscription>;
+/**
+ * create a subscription for user (existing) to a newsletter
+ *
+ * @param {ICreateSubscriptionParams} options
+ * @return {Promise<ISubscription>}
+ */
+export declare function createSubscription(options: ICreateSubscriptionParams): Promise<ISubscription>;
+/**
+ * get subscriptions
+ *
+ * @param {IGetSubscriptionsParams} options
+ * @return {Promise<ISubscription[]>}
+ */
+export declare function getSubscriptions(options: IGetSubscriptionsParams): Promise<ISubscription[]>;
+/**
+ * get a subscription
+ *
+ * @param {IGetSubscriptionParams} options
+ * @return {Promise<ISubscription>}
+ */
+export declare function getSubscription(options: IGetSubscriptionParams): Promise<ISubscription>;
+/**
+ * update a subscription
+ *
+ * @param {IUpdateSubscriptionParams} options
+ * @return {Promise<ISubscription>}
+ */
+export declare function updateSubscription(options: IUpdateSubscriptionParams): Promise<ISubscription>;

package/dist/types/newsletters/api/types.d.ts

@@ -0,0 +1,47 @@
+export { Cadence, DeliveryMethod, ICreateEventMetadata, ICreateTelemetryReportMetadata, INotificationSpec, ISubscribeMetadata, ISubscription, ISubscriptionMetadata, IUser, SystemNotificationSpecNames, } from "./orval/api/orval-newsletters";
+import { IHubRequestOptions } from "../../types";
+import { GetSubscriptionsParams, ICreateSubscription, ICreateUser, ISubscribe, IUpdateSubscription, IUpdateUser } from "./orval/api/orval-newsletters";
+/**
+ * options for making requests against the Newsletters API
+ *
+ * @export
+ * @interface INewslettersRequestOptions
+ * @extends IHubRequestOptions
+ */
+export interface INewslettersRequestOptions extends Omit<IHubRequestOptions, "httpMethod" | "isPortal">, Pick<RequestInit, "mode" | "cache" | "credentials"> {
+    httpMethod?: "GET" | "POST" | "PATCH" | "DELETE";
+    isPortal?: boolean;
+    token?: string;
+    data?: {
+        [key: string]: any;
+    };
+}
+export interface ICreateUserParams extends INewslettersRequestOptions {
+    data: ICreateUser;
+}
+export interface IGetUserParams extends INewslettersRequestOptions {
+    userId: string;
+}
+export interface IUpdateUserParams extends INewslettersRequestOptions {
+    userId: string;
+    data: IUpdateUser;
+}
+export interface IDeleteUserParams extends INewslettersRequestOptions {
+    userId: string;
+}
+export interface ISubscribeParams extends INewslettersRequestOptions {
+    data: ISubscribe;
+}
+export interface ICreateSubscriptionParams extends INewslettersRequestOptions {
+    data: ICreateSubscription;
+}
+export interface IGetSubscriptionsParams extends INewslettersRequestOptions {
+    data: GetSubscriptionsParams;
+}
+export interface IGetSubscriptionParams extends INewslettersRequestOptions {
+    subscriptionId: number;
+}
+export interface IUpdateSubscriptionParams extends INewslettersRequestOptions {
+    subscriptionId: number;
+    data: IUpdateSubscription;
+}

package/dist/types/newsletters/api/users.d.ts

@@ -0,0 +1,29 @@
+import { ICreateUserParams, IDeleteUserParams, IGetUserParams, IUpdateUserParams, IUser } from "./types";
+/**
+ * create a user
+ *
+ * @param {ICreateUserParams} options
+ * @return {Promise<IUser>}
+ */
+export declare function createUser(options: ICreateUserParams): Promise<IUser>;
+/**
+ * get a user
+ *
+ * @param {IGetUserParams} options
+ * @return {Promise<IUser>}
+ */
+export declare function getUser(options: IGetUserParams): Promise<IUser>;
+/**
+ * update a user
+ *
+ * @param {IUpdateUserParams} options
+ * @return {Promise<IUser>}
+ */
+export declare function updateUser(options: IUpdateUserParams): Promise<IUser>;
+/**
+ * delete a user
+ *
+ * @param {IDeleteUserParams} options
+ * @return {Promise<IUser>}
+ */
+export declare function deleteUser(options: IDeleteUserParams): Promise<IUser>;