@esri/hub-common 28.2.0 → 28.3.1

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

@@ -5,6 +5,56 @@
  * OpenAPI spec version: 0.0.1
  */
 import { customClient } from "../custom-client";
+export type GetRegistrationsParams = {
+    /**
+     * Event id being registered for
+     */
+    eventId?: string;
+    /**
+     * ArcGIS Online id for a user
+     */
+    userId?: string;
+    /**
+     * comma separated string list of registration roles
+     */
+    role?: string;
+    /**
+     * comma separated string list of registration statuses
+     */
+    status?: string;
+    /**
+     * comma separated string list of registration types
+     */
+    type?: string;
+    /**
+     * latest ISO8601 updatedAt for the registrations
+     */
+    updatedAtBefore?: string;
+    /**
+     * earliest ISO8601 updatedAt for the registrations
+     */
+    updatedAtAfter?: string;
+    /**
+     * filter to be matched to firstName, lastName, or username
+     */
+    name?: string;
+    /**
+     * the max amount of registrations to return
+     */
+    num?: string;
+    /**
+     * the index to start at
+     */
+    start?: string;
+    /**
+     * property to sort results by
+     */
+    sortBy?: RegistrationSort;
+    /**
+     * sort order desc or asc
+     */
+    sortOrder?: EventSortOrder;
+};
 export type GetEventParams = {
     /**
      * Comma-separated list of relations to include (e.g. resources)
@@ -23,6 +73,18 @@ export declare enum RegistrationSort {
     lastName = "lastName",
     username = "username"
 }
+export interface IInviteRegistrations {
+    /** Event id to invite registrants to */
+    eventId: string;
+    /** Array of user agoIds to invite (max 25) */
+    inviteeIds: string[];
+    /** Role for the registrants */
+    role?: RegistrationRole;
+    /** Registration status to assign to invitees */
+    status?: RegistrationStatus;
+    /** Attendance type for the registrations */
+    type: EventAttendanceType;
+}
 /**
  * Type of the event resource
  */
@@ -147,56 +209,6 @@ export declare enum EventSortOrder {
     asc = "asc",
     desc = "desc"
 }
-export type GetRegistrationsParams = {
-    /**
-     * Event id being registered for
-     */
-    eventId?: string;
-    /**
-     * ArcGIS Online id for a user
-     */
-    userId?: string;
-    /**
-     * comma separated string list of registration roles
-     */
-    role?: string;
-    /**
-     * comma separated string list of registration statuses
-     */
-    status?: string;
-    /**
-     * comma separated string list of registration types
-     */
-    type?: string;
-    /**
-     * latest ISO8601 updatedAt for the registrations
-     */
-    updatedAtBefore?: string;
-    /**
-     * earliest ISO8601 updatedAt for the registrations
-     */
-    updatedAtAfter?: string;
-    /**
-     * filter to be matched to firstName, lastName, or username
-     */
-    name?: string;
-    /**
-     * the max amount of registrations to return
-     */
-    num?: string;
-    /**
-     * the index to start at
-     */
-    start?: string;
-    /**
-     * property to sort results by
-     */
-    sortBy?: RegistrationSort;
-    /**
-     * sort order desc or asc
-     */
-    sortOrder?: EventSortOrder;
-};
 export declare enum EventSort {
     title = "title",
     startDateTime = "startDateTime",
@@ -414,9 +426,11 @@ export interface IEventLocation {
     /** @nullable */
     placeAddr: string | null;
     /** @nullable */
+    placeAddr2: string | null;
+    /** @nullable */
     placeName: string | null;
     /** @nullable */
-    postal: number | null;
+    postal: string | null;
     /** @nullable */
     region: string | null;
     /** @nullable */
@@ -580,7 +594,8 @@ export declare enum EventLocationType {
     none = "none",
     custom = "custom",
     org = "org",
-    item = "item"
+    item = "item",
+    address = "address"
 }
 export interface ICreateLocationSpatialReference {
     latestVcsWkid?: number;
@@ -605,10 +620,12 @@ export interface ICreateEventLocation {
     nbrhd?: string;
     /** Place address */
     placeAddr?: string;
+    /** Place address 2 (e.g. building number, room number, or other directions) */
+    placeAddr2?: string;
     /** Place name */
     placeName?: string;
-    /** Postal */
-    postal?: number;
+    /** Postal code */
+    postal?: string;
     /** Region */
     region?: string;
     /** Spatial reference */
@@ -686,6 +703,10 @@ export declare const createRegistration: (iCreateRegistration: ICreateRegistrati
  * Get a list of registrations matching request criteria.
  */
 export declare const getRegistrations: (params?: GetRegistrationsParams, options?: SecondParameter<typeof customClient>) => Promise<IPagedRegistrationResponse>;
+/**
+ * Invite users to register for an event. Requires event edit permission.
+ */
+export declare const inviteRegistrations: (iInviteRegistrations: IInviteRegistrations, options?: SecondParameter<typeof customClient>) => Promise<IRegistration[]>;
 /**
  * Get a registration by id.
  */
@@ -707,6 +728,7 @@ export type CreateEventResourceResult = NonNullable<Awaited<ReturnType<typeof cr
 export type DeleteEventResourceResult = NonNullable<Awaited<ReturnType<typeof deleteEventResource>>>;
 export type CreateRegistrationResult = NonNullable<Awaited<ReturnType<typeof createRegistration>>>;
 export type GetRegistrationsResult = NonNullable<Awaited<ReturnType<typeof getRegistrations>>>;
+export type InviteRegistrationsResult = NonNullable<Awaited<ReturnType<typeof inviteRegistrations>>>;
 export type GetRegistrationResult = NonNullable<Awaited<ReturnType<typeof getRegistration>>>;
 export type UpdateRegistrationResult = NonNullable<Awaited<ReturnType<typeof updateRegistration>>>;
 export type DeleteRegistrationResult = NonNullable<Awaited<ReturnType<typeof deleteRegistration>>>;

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

@@ -1,4 +1,4 @@
-import { IRegistration, ICreateRegistrationParams, IDeleteRegistrationParams, IGetRegistrationParams, IUpdateRegistrationParams, IGetRegistrationsParams, IPagedRegistrationResponse } from "./types";
+import { IRegistration, ICreateRegistrationParams, IDeleteRegistrationParams, IGetRegistrationParams, IUpdateRegistrationParams, IGetRegistrationsParams, IInviteRegistrationsParams, IPagedRegistrationResponse } from "./types";
 /**
  * create an event registration
  *
@@ -34,3 +34,10 @@ export declare function updateRegistration(options: IUpdateRegistrationParams):
  * @return {Promise<IRegistration>}
  */
 export declare function deleteRegistration(options: IDeleteRegistrationParams): Promise<IRegistration>;
+/**
+ * invite users to register for an event
+ *
+ * @param {IInviteRegistrationsParams} options
+ * @return {Promise<IRegistration[]>}
+ */
+export declare function inviteRegistrations(options: IInviteRegistrationsParams): Promise<IRegistration[]>;

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

@@ -1,6 +1,6 @@
-export { EventAssociationEntityType, EventAccess, EventAttendanceType, EventStatus, ISearchEvents, IEventAssociation, ICreateEventAssociation, IOnlineMeeting, ICreateOnlineMeeting, ICreateEvent, ICreateRegistration, IEvent, IEventPermission, IEventLocation, IEventLocationGeometriesItem, ILocationSpatialReference, IEventLocationSpatialReference, ICreateLocationSpatialReference, IEventRegistrationCount, ICreateEventLocation, ICreateEventLocationGeometriesItem, IRegistration, IRegistrationPermission, IUpdateEvent, IUpdateRegistration, GetRegistrationsParams, GetEventParams, IUser, RegistrationRole, RegistrationStatus, RegistrationSort, EventSortOrder, EventSort, EventLocationType, IPagedRegistrationResponse, IPagedEventResponse, CreateEventResourceDto, CreateEventResourceDtoResourceType, CreateEventResourceDtoMimeType, GetEventsInclude, EventsSearchFormat, IUpdateEventOnlineMeeting, IUpdateEventLocation, IUpdateEventCapabilities, ICreateEventCapabilities, IEventCapabilities, ICreateEventLocationProperty, IEventResourcesItem, ISearchEventsGeometry, } from "./orval/api/orval-events";
+export { EventAssociationEntityType, EventAccess, EventAttendanceType, EventStatus, ISearchEvents, IEventAssociation, ICreateEventAssociation, IOnlineMeeting, ICreateOnlineMeeting, ICreateEvent, ICreateRegistration, IEvent, IEventPermission, IEventLocation, IEventLocationGeometriesItem, ILocationSpatialReference, IEventLocationSpatialReference, ICreateLocationSpatialReference, IEventRegistrationCount, ICreateEventLocation, ICreateEventLocationGeometriesItem, IRegistration, IRegistrationPermission, IUpdateEvent, IUpdateRegistration, GetRegistrationsParams, GetEventParams, IUser, RegistrationRole, RegistrationStatus, RegistrationSort, EventSortOrder, EventSort, EventLocationType, IInviteRegistrations, IPagedRegistrationResponse, IPagedEventResponse, CreateEventResourceDto, CreateEventResourceDtoResourceType, CreateEventResourceDtoMimeType, GetEventsInclude, EventsSearchFormat, IUpdateEventOnlineMeeting, IUpdateEventLocation, IUpdateEventCapabilities, ICreateEventCapabilities, IEventCapabilities, ICreateEventLocationProperty, IEventResourcesItem, ISearchEventsGeometry, } from "./orval/api/orval-events";
 import { IHubRequestOptions } from "../../hub-types";
-import { ICreateEvent, IUpdateEvent, ISearchEvents, ICreateRegistration, IUpdateRegistration, GetRegistrationsParams, CreateEventResourceDto } from "./orval/api/orval-events";
+import { ICreateEvent, IUpdateEvent, ISearchEvents, ICreateRegistration, IUpdateRegistration, IInviteRegistrations, GetRegistrationsParams, CreateEventResourceDto } from "./orval/api/orval-events";
 /**
  * options for making requests against the Events API
  *
@@ -49,6 +49,9 @@ export interface IUpdateRegistrationParams extends IEventsRequestOptions {
 export interface IDeleteRegistrationParams extends IEventsRequestOptions {
     registrationId: string;
 }
+export interface IInviteRegistrationsParams extends IEventsRequestOptions {
+    data: IInviteRegistrations;
+}
 export interface ICreateEventResourceParams extends IEventsRequestOptions {
     eventId: string;
     data: CreateEventResourceDto;

package/dist/types/items/_internal/slugs.d.ts

@@ -1,4 +1,10 @@
+import { IWithSlug } from "../../core/traits/IWithSlug";
 export declare const TYPEKEYWORD_SLUG_PREFIX = "slug";
+/**
+ * Construct a slug for an entity, ensuring it is properly namespaced with the org key
+ * and truncated to fit within typekeyword limits
+ */
+export declare function constructEntitySlug(entity: IWithSlug): string;
 /**
  * truncate a slug, namespaced to an org and accounting for the 256 character limit
  * of individual typekeywords.

package/dist/types/items/slugs.d.ts

@@ -2,8 +2,9 @@ import { IRequestOptions } from "@esri/arcgis-rest-request";
 import type { IItem } from "@esri/arcgis-rest-portal";
 /**
  * Create a slug, namespaced to an org and accounting for the 256 character limit
- * of individual typekeywords. Typically used to lookup items by a human readable name in urls
- *
+ * of individual typekeywords. Slugs are typically used to lookup items by a
+ * human readable name in urls. There is no means to ensure they are unique,
+ * so they should be used in conjunction with an id or other unique identifier.
  * @param title
  * @param orgKey
  * @returns

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "28.2.0",
+  "version": "28.3.1",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",