@sprucelabs/mercury-core-events 25.0.131 → 25.1.1

package/build/.spruce/events/mercury/unregisterSkill.v2020_12_25.contract.d.ts

@@ -2,6 +2,7 @@ import './../../permissions/permissions.types';
 declare const unregisterSkillEventContract: {
     eventSignatures: {
         'unregister-skill::v2020_12_25': {
+            description: string;
             emitPayloadSchema: import("@sprucelabs/mercury-types").SpruceSchemas.Mercury.v2020_12_25.UnregisterSkillEmitTargetAndPayloadSchema;
             responsePayloadSchema: import("@sprucelabs/mercury-types").SpruceSchemas.Mercury.v2020_12_25.UnregisterSkillResponsePayloadSchema;
         };

package/build/.spruce/events/mercury/unregisterSkill.v2020_12_25.contract.js

@@ -10,6 +10,7 @@ const mercury_types_1 = require("@sprucelabs/mercury-types");
 const unregisterSkillEventContract = (0, mercury_types_1.buildEventContract)({
     eventSignatures: {
         'unregister-skill::v2020_12_25': {
+            description: `Unregister a skill.`,
             emitPayloadSchema: unregisterSkillEmitTargetAndPayload_schema_1.default,
             responsePayloadSchema: unregisterSkillResponsePayload_schema_1.default,
         }

package/build/.spruce/events/mercury/updateLocation.v2020_12_25.contract.d.ts

@@ -2,6 +2,8 @@ import './../../permissions/permissions.types';
 declare const updateLocationEventContract: {
     eventSignatures: {
         'update-location::v2020_12_25': {
+            description: string;
+            aiInstructions: string;
             emitPayloadSchema: import("@sprucelabs/mercury-types").SpruceSchemas.Mercury.v2020_12_25.UpdateLocationEmitTargetAndPayloadSchema;
             responsePayloadSchema: import("@sprucelabs/mercury-types").SpruceSchemas.Mercury.v2020_12_25.UpdateLocationResponsePayloadSchema;
         };

package/build/.spruce/events/mercury/updateLocation.v2020_12_25.contract.js

@@ -10,6 +10,8 @@ const mercury_types_1 = require("@sprucelabs/mercury-types");
 const updateLocationEventContract = (0, mercury_types_1.buildEventContract)({
     eventSignatures: {
         'update-location::v2020_12_25': {
+            description: `Update a new location at your organization.`,
+            aiInstructions: `This will allow someone to update any location where they work (if they have permissions). Since you need a location id, you will have to start with the list-locations event.`,
             emitPayloadSchema: updateLocationEmitTargetAndPayload_schema_1.default,
             responsePayloadSchema: updateLocationResponsePayload_schema_1.default,
         }

package/build/.spruce/events/mercury/updateOrganization.v2020_12_25.contract.d.ts

@@ -2,6 +2,8 @@ import './../../permissions/permissions.types';
 declare const updateOrganizationEventContract: {
     eventSignatures: {
         'update-organization::v2020_12_25': {
+            description: string;
+            aiInstructions: string;
             emitPayloadSchema: import("@sprucelabs/mercury-types").SpruceSchemas.Mercury.v2020_12_25.UpdateOrganizationEmitTargetAndPayloadSchema;
             responsePayloadSchema: import("@sprucelabs/mercury-types").SpruceSchemas.Mercury.v2020_12_25.UpdateOrgResponsePayloadSchema;
         };

package/build/.spruce/events/mercury/updateOrganization.v2020_12_25.contract.js

@@ -10,6 +10,8 @@ const mercury_types_1 = require("@sprucelabs/mercury-types");
 const updateOrganizationEventContract = (0, mercury_types_1.buildEventContract)({
     eventSignatures: {
         'update-organization::v2020_12_25': {
+            description: `Update your organization.`,
+            aiInstructions: `This will allow someone to update any organization where they work (if they have permissions). Since you need an organization's id, you will have to start with the list-organizations event.`,
             emitPayloadSchema: updateOrganizationEmitTargetAndPayload_schema_1.default,
             responsePayloadSchema: updateOrgResponsePayload_schema_1.default,
         }

package/build/.spruce/events/mercury/updatePerson.v2020_12_25.contract.d.ts

@@ -2,6 +2,8 @@ import './../../permissions/permissions.types';
 declare const updatePersonEventContract: {
     eventSignatures: {
         'update-person::v2020_12_25': {
+            description: string;
+            aiInstructions: string;
             emitPayloadSchema: import("@sprucelabs/mercury-types").SpruceSchemas.Mercury.v2020_12_25.UpdatePersonEmitTargetAndPayloadSchema;
             responsePayloadSchema: import("@sprucelabs/mercury-types").SpruceSchemas.Mercury.v2020_12_25.UpdatePersonResponsePayloadSchema;
         };

package/build/.spruce/events/mercury/updatePerson.v2020_12_25.contract.js

@@ -10,6 +10,8 @@ const mercury_types_1 = require("@sprucelabs/mercury-types");
 const updatePersonEventContract = (0, mercury_types_1.buildEventContract)({
     eventSignatures: {
         'update-person::v2020_12_25': {
+            description: `Update person.`,
+            aiInstructions: `This will let a person update their own or somenone else's profile. But, the API won't let anyone update someone else's profile for now.`,
             emitPayloadSchema: updatePersonEmitTargetAndPayload_schema_1.default,
             responsePayloadSchema: updatePersonResponsePayload_schema_1.default,
         }

package/build/.spruce/events/mercury/updateRole.v2020_12_25.contract.d.ts

@@ -2,6 +2,7 @@ import './../../permissions/permissions.types';
 declare const updateRoleEventContract: {
     eventSignatures: {
         'update-role::v2020_12_25': {
+            description: string;
             emitPayloadSchema: import("@sprucelabs/mercury-types").SpruceSchemas.Mercury.v2020_12_25.UpdateRoleEmitTargetAndPayloadSchema;
             responsePayloadSchema: import("@sprucelabs/mercury-types").SpruceSchemas.Mercury.v2020_12_25.UpdateRoleResponsePayloadSchema;
         };

package/build/.spruce/events/mercury/updateRole.v2020_12_25.contract.js

@@ -10,6 +10,7 @@ const mercury_types_1 = require("@sprucelabs/mercury-types");
 const updateRoleEventContract = (0, mercury_types_1.buildEventContract)({
     eventSignatures: {
         'update-role::v2020_12_25': {
+            description: `Update a new role at your organization.`,
             emitPayloadSchema: updateRoleEmitTargetAndPayload_schema_1.default,
             responsePayloadSchema: updateRoleResponsePayload_schema_1.default,
         }

package/build/.spruce/events/mercury/upsertPermissionContract.v2020_12_25.contract.d.ts

@@ -2,6 +2,7 @@ import './../../permissions/permissions.types';
 declare const upsertPermissionContractEventContract: {
     eventSignatures: {
         'upsert-permission-contract::v2020_12_25': {
+            description: string;
             emitPayloadSchema: import("@sprucelabs/mercury-types").SpruceSchemas.Mercury.v2020_12_25.UpsertPermissionContractEmitTargetAndPayloadSchema;
             responsePayloadSchema: import("@sprucelabs/mercury-types").SpruceSchemas.Mercury.v2020_12_25.UpsertPermissionContractResponsePayloadSchema;
         };

package/build/.spruce/events/mercury/upsertPermissionContract.v2020_12_25.contract.js

@@ -10,6 +10,7 @@ const mercury_types_1 = require("@sprucelabs/mercury-types");
 const upsertPermissionContractEventContract = (0, mercury_types_1.buildEventContract)({
     eventSignatures: {
         'upsert-permission-contract::v2020_12_25': {
+            description: `Upsert a permission contract by contract id.`,
             emitPayloadSchema: upsertPermissionContractEmitTargetAndPayload_schema_1.default,
             responsePayloadSchema: upsertPermissionContractResponsePayload_schema_1.default,
         }

package/build/.spruce/events/mercury/voteForFeature.v2020_12_25.contract.d.ts

@@ -2,6 +2,7 @@ import './../../permissions/permissions.types';
 declare const voteForFeatureEventContract: {
     eventSignatures: {
         'vote-for-feature::v2020_12_25': {
+            description: string;
             emitPayloadSchema: import("@sprucelabs/mercury-types").SpruceSchemas.Mercury.v2020_12_25.VoteForFeatureEmitTargetAndPayloadSchema;
             responsePayloadSchema: import("@sprucelabs/mercury-types").SpruceSchemas.Mercury.v2020_12_25.VoteForFeatureResponsePayloadSchema;
         };

package/build/.spruce/events/mercury/voteForFeature.v2020_12_25.contract.js

@@ -10,6 +10,7 @@ const mercury_types_1 = require("@sprucelabs/mercury-types");
 const voteForFeatureEventContract = (0, mercury_types_1.buildEventContract)({
     eventSignatures: {
         'vote-for-feature::v2020_12_25': {
+            description: `Vote for a feature and let the Sprucebot team know your thoughts!`,
             emitPayloadSchema: voteForFeatureEmitTargetAndPayload_schema_1.default,
             responsePayloadSchema: voteForFeatureResponsePayload_schema_1.default,
         }

package/build/.spruce/events/mercury/whoami.v2020_12_25.contract.d.ts

@@ -2,6 +2,8 @@ import './../../permissions/permissions.types';
 declare const whoamiEventContract: {
     eventSignatures: {
         'whoami::v2020_12_25': {
+            description: string;
+            aiInstructions: string;
             emitPayloadSchema: import("@sprucelabs/mercury-types").SpruceSchemas.Mercury.v2020_12_25.WhoamiEmitTargetAndPayloadSchema;
             responsePayloadSchema: import("@sprucelabs/mercury-types").SpruceSchemas.Mercury.v2020_12_25.AuthenticateResponsePayloadSchema;
         };

package/build/.spruce/events/mercury/whoami.v2020_12_25.contract.js

@@ -10,6 +10,8 @@ const mercury_types_1 = require("@sprucelabs/mercury-types");
 const whoamiEventContract = (0, mercury_types_1.buildEventContract)({
     eventSignatures: {
         'whoami::v2020_12_25': {
+            description: `Who Am I? We want to know!`,
+            aiInstructions: `Use it get the logged in person.`,
             emitPayloadSchema: whoamiEmitTargetAndPayload_schema_1.default,
             responsePayloadSchema: authenticateResponsePayload_schema_1.default,
         }

package/build/.spruce/schemas/mercury/v2020_12_25/getPersonEmitPayload.schema.js

@@ -7,9 +7,10 @@ const getPersonEmitPayloadSchema = {
     namespace: 'Mercury',
     name: '',
     fields: {
-        /** . */
+        /** . Includes PII fields like full name and phone number. */
         'shouldIncludePrivateFields': {
             type: 'boolean',
+            hint: 'Includes PII fields like full name and phone number.',
             options: undefined
         },
     }

package/build/.spruce/schemas/mercury/v2020_12_25/listLocationsEmitPayload.schema.js

@@ -11,9 +11,10 @@ const listLocationsEmitPayloadSchema = {
     namespace: 'Mercury',
     name: '',
     fields: {
-        /** . */
+        /** . Will only return locations where a person has a role that respresent they work there. */
         'shouldOnlyShowWhereIAmEmployed': {
             type: 'boolean',
+            hint: 'Will only return locations where a person has a role that respresent they work there.',
             options: undefined
         },
         /** . */

package/build/.spruce/schemas/mercury/v2020_12_25/listLocationsEmitTarget.schema.js

@@ -7,9 +7,10 @@ const listLocationsEmitTargetSchema = {
     namespace: 'Mercury',
     name: '',
     fields: {
-        /** . */
+        /** . Will filter locations by this organization. */
         'organizationId': {
             type: 'id',
+            hint: 'Will filter locations by this organization.',
             options: undefined
         },
         /** . */

package/build/.spruce/schemas/mercury/v2020_12_25/listOrgsEmitPayload.schema.js

@@ -11,19 +11,22 @@ const listOrgsEmitPayloadSchema = {
     namespace: 'Mercury',
     name: '',
     fields: {
-        /** . */
+        /** . Will only return organizations where a person has a role (including guest). */
         'shouldOnlyShowMine': {
             type: 'boolean',
+            hint: 'Will only return organizations where a person has a role (including guest).',
             options: undefined
         },
-        /** . */
+        /** . Will only return organizations where a person has a role that indicates they work there. */
         'shouldOnlyShowWhereIAmEmployed': {
             type: 'boolean',
+            hint: 'Will only return organizations where a person has a role that indicates they work there.',
             options: undefined
         },
-        /** . */
+        /** . Will include organizations that are marked as private. You have to have permissions to see these (usually means employed there as owner). */
         'shouldIncludePrivateOrganizations': {
             type: 'boolean',
+            hint: 'Will include organizations that are marked as private. You have to have permissions to see these (usually means employed there as owner).',
             options: undefined
         },
         /** . */

package/build/.spruce/schemas/schemas.types.d.ts

@@ -6232,6 +6232,7 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
     }
     namespace SpruceSchemas.Mercury.v2020_12_25 {
         interface GetPersonEmitPayload {
+            /** . Includes PII fields like full name and phone number. */
             'shouldIncludePrivateFields'?: boolean | undefined | null;
         }
         interface GetPersonEmitPayloadSchema extends SpruceSchema.Schema {
@@ -6240,9 +6241,10 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
             namespace: 'Mercury';
             name: '';
             fields: {
-                /** . */
+                /** . Includes PII fields like full name and phone number. */
                 'shouldIncludePrivateFields': {
                     type: 'boolean';
+                    hint: 'Includes PII fields like full name and phone number.';
                     options: undefined;
                 };
             };
@@ -7174,6 +7176,7 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
     }
     namespace SpruceSchemas.Mercury.v2020_12_25 {
         interface ListLocationsEmitTarget {
+            /** . Will filter locations by this organization. */
             'organizationId'?: string | undefined | null;
             'locationIds'?: string[] | undefined | null;
         }
@@ -7183,9 +7186,10 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
             namespace: 'Mercury';
             name: '';
             fields: {
-                /** . */
+                /** . Will filter locations by this organization. */
                 'organizationId': {
                     type: 'id';
+                    hint: 'Will filter locations by this organization.';
                     options: undefined;
                 };
                 /** . */
@@ -7201,6 +7205,7 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
     }
     namespace SpruceSchemas.Mercury.v2020_12_25 {
         interface ListLocationsEmitPayload {
+            /** . Will only return locations where a person has a role that respresent they work there. */
             'shouldOnlyShowWhereIAmEmployed'?: boolean | undefined | null;
             'paging'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventPagingRequest | undefined | null;
         }
@@ -7210,9 +7215,10 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
             namespace: 'Mercury';
             name: '';
             fields: {
-                /** . */
+                /** . Will only return locations where a person has a role that respresent they work there. */
                 'shouldOnlyShowWhereIAmEmployed': {
                     type: 'boolean';
+                    hint: 'Will only return locations where a person has a role that respresent they work there.';
                     options: undefined;
                 };
                 /** . */
@@ -7368,8 +7374,11 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
     }
     namespace SpruceSchemas.Mercury.v2020_12_25 {
         interface ListOrgsEmitPayload {
+            /** . Will only return organizations where a person has a role (including guest). */
             'shouldOnlyShowMine'?: boolean | undefined | null;
+            /** . Will only return organizations where a person has a role that indicates they work there. */
             'shouldOnlyShowWhereIAmEmployed'?: boolean | undefined | null;
+            /** . Will include organizations that are marked as private. You have to have permissions to see these (usually means employed there as owner). */
             'shouldIncludePrivateOrganizations'?: boolean | undefined | null;
             'paging'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventPagingRequest | undefined | null;
         }
@@ -7379,19 +7388,22 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
             namespace: 'Mercury';
             name: '';
             fields: {
-                /** . */
+                /** . Will only return organizations where a person has a role (including guest). */
                 'shouldOnlyShowMine': {
                     type: 'boolean';
+                    hint: 'Will only return organizations where a person has a role (including guest).';
                     options: undefined;
                 };
-                /** . */
+                /** . Will only return organizations where a person has a role that indicates they work there. */
                 'shouldOnlyShowWhereIAmEmployed': {
                     type: 'boolean';
+                    hint: 'Will only return organizations where a person has a role that indicates they work there.';
                     options: undefined;
                 };
-                /** . */
+                /** . Will include organizations that are marked as private. You have to have permissions to see these (usually means employed there as owner). */
                 'shouldIncludePrivateOrganizations': {
                     type: 'boolean';
+                    hint: 'Will include organizations that are marked as private. You have to have permissions to see these (usually means employed there as owner).';
                     options: undefined;
                 };
                 /** . */