@bigfootai/bigfoot-types 4.7.24 → 4.7.26

package/model.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReferenceBlockInputQL = exports.ConnectedProviderQL = exports.CredentialQL = exports.StandardObjectsQL = exports.ProviderResponseQL = exports.ProviderRequestQL = exports.ProviderInfoQL = exports.DateEntityEntryQL = exports.EntityEntryQL = exports.EntityEntryFields = exports.RelationEntryQL = exports.ArgumentEntryQL = exports.EntityReferenceQL = exports.DocumentSentimentQL = exports.TaskStepQL = exports.TaskStepInputQL = exports.ReactionQL = exports.ReactionSkinToneQL = exports.BusinessObjectLinkQL = exports.BusinessObjectLinkInputQL = exports.SharingTenantQL = exports.SharingDomainQL = exports.SharingTagQL = exports.SharingTagInputQL = exports.InviteSharingTagInputQL = exports.EditorQL = exports.EditorInputQL = exports.HighlightQL = exports.RelationType = exports.EntityType = exports.RecordType = exports.ProcessingStage = exports.MutationType = exports.MarkType = exports.DocumentType = exports.RecurrenceRFC = exports.TagRecommendationVariation = exports.TagRecommendationType = exports.InviteStatus = exports.OrderByDirection = exports.SharingApproach = exports.StepStatus = exports.TaskStatus = exports.TaskPriority = exports.SharingLevel = exports.ClientType = exports.TagType = exports.UpsertType = exports.RecommendationType = exports.BlockType = void 0;
-exports.TaskFields = exports.Note = exports.NoteQL = exports.BusinessObject = exports.BusinessObjectQL = exports.BusinessObjectFields = exports.BusinessObjectIngestionRequest = exports.History = exports.BlockProcessingResponse = exports.BlockProcessingRequest = exports.Block = exports.BlockFields = exports.Article = exports.ArticleQL = exports.Person = exports.Organization = exports.Domain = exports.DomainQL = exports.Tenant = exports.TenantQL = exports.Recommendation = exports.RecommendationQL = exports.UpsertRecommendationQL = exports.ConnectRecommendationQL = exports.TagRecommendationQL = exports.Tag = exports.TagQL = exports.TagFieldsJustSharing = exports.TagFieldsWithoutSharing = exports.Provider = exports.ProviderQL = exports.ProviderApplicationQL = exports.Sync = exports.SyncQL = exports.Search = exports.SearchQL = exports.Folder = exports.FolderQL = exports.Metadata = exports.MetadataQL = exports.MetadataFields = exports.SharedPrimitive = exports.SharedPrimitiveFields = exports.Primitive = exports.PrimitiveFields = exports.PersonReferenceQL = exports.PersonReferenceFields = exports.ChangesQL = exports.ChangesInputQL = exports.ReferenceBlockQL = void 0;
-exports.SharingDomainInputQL = exports.FindSyncInputQL = exports.FindProviderInputQL = exports.ArchiveNoteOutputQL = exports.ArchiveNoteInputQL = exports.FindNotesInputQL = exports.FindNoteInputQL = exports.UpsertNoteInputQL = exports.FindEventInputQL = exports.FindCalendarInputQL = exports.FindArticlesInputQL = exports.FindArticleInputQL = exports.FindDomainInputQL = exports.FindTenantInputQL = exports.Table = exports.TableQL = exports.Record = exports.RecordQL = exports.TableMetadata = exports.TableMetadataQL = exports.FieldValueQL = exports.FieldQL = exports.OptionQL = exports.FieldVariation = exports.FieldType = exports.Template = exports.TemplateQL = exports.DocumentMetadata = exports.DocumentMetadataQL = exports.BlockDescriptionQL = exports.Website = exports.WebsiteQL = exports.Document = exports.DocumentQL = exports.Thread = exports.Todo = exports.Calendar = exports.CalendarQL = exports.Event = exports.EventQL = exports.PersonAcceptanceQL = exports.ResponseStatus = exports.EventStatus = exports.Conference = exports.ConferenceQL = exports.ConferenceEntrypointQL = exports.TranscriptionQL = exports.TranscriptionEntryQL = exports.Task = exports.TaskQL = void 0;
-exports.GraphQLTypes = exports.SearchInputQL = exports.SearchTagsInputQL = exports.ArchiveSearchOutputQL = exports.ArchiveSearchInputQL = exports.FindSearchesInputQL = exports.FindSearchInputQL = exports.UpsertSearchInputQL = exports.ArchiveFolderOutputQL = exports.ArchiveFolderInputQL = exports.FindFoldersInputQL = exports.FindFolderInputQL = exports.UpsertFolderInputQL = exports.ArchiveTaskOutputQL = exports.ArchiveTaskInputQL = exports.FindTasksInputQL = exports.FindTaskInputQL = exports.UpdateTaskInputQL = exports.DeleteSharingTagInputQL = exports.SetSharingTagInputQL = exports.MergeTagInputQL = exports.ArchiveTagOutputQL = exports.ArchiveTagInputQL = exports.FindTagsInputQL = exports.FindTagInputQL = exports.UpsertTagInputQL = exports.SharingTenantInputQL = void 0;
+exports.ConnectedProviderQL = exports.CredentialQL = exports.StandardObjectsQL = exports.ProviderResponseQL = exports.ProviderRequestQL = exports.ProviderInfoQL = exports.DateEntityEntryQL = exports.EntityEntryQL = exports.EntityEntryFields = exports.RelationEntryQL = exports.ArgumentEntryQL = exports.EntityReferenceQL = exports.DocumentSentimentQL = exports.TaskStepQL = exports.TaskStepInputQL = exports.ReactionQL = exports.ReactionSkinToneQL = exports.BusinessObjectLinkQL = exports.BusinessObjectLinkInputQL = exports.SharingTenantQL = exports.SharingDomainQL = exports.SharingTagQL = exports.SharingTagInputQL = exports.InviteSharingTagInputQL = exports.EditorQL = exports.EditorInputQL = exports.HighlightQL = exports.RelationType = exports.EntityType = exports.RecordType = exports.ThumbsDirection = exports.ProcessingStage = exports.MutationType = exports.MarkType = exports.DocumentType = exports.RecurrenceRFC = exports.TagRecommendationVariation = exports.TagRecommendationType = exports.InviteStatus = exports.OrderByDirection = exports.SharingApproach = exports.StepStatus = exports.TaskStatus = exports.TaskPriority = exports.SharingLevel = exports.ClientType = exports.TagType = exports.UpsertType = exports.RecommendationType = exports.BlockType = void 0;
+exports.NoteQL = exports.BusinessObject = exports.BusinessObjectQL = exports.BusinessObjectFields = exports.BusinessObjectIngestionRequest = exports.History = exports.BlockProcessingResponse = exports.BlockProcessingRequest = exports.Block = exports.BlockFields = exports.Article = exports.ArticleQL = exports.Person = exports.Organization = exports.Domain = exports.DomainQL = exports.Tenant = exports.TenantQL = exports.Recommendation = exports.RecommendationQL = exports.UpsertRecommendationQL = exports.ConnectRecommendationQL = exports.TagRecommendationQL = exports.Tag = exports.TagQL = exports.TagFieldsJustSharing = exports.TagFieldsWithoutSharing = exports.Provider = exports.ProviderQL = exports.ProviderApplicationQL = exports.BusinessObjectLinkingToTagQL = exports.Sync = exports.SyncQL = exports.Search = exports.SearchQL = exports.Folder = exports.FolderQL = exports.Metadata = exports.MetadataQL = exports.MetadataFields = exports.SharedPrimitive = exports.SharedPrimitiveFields = exports.Primitive = exports.PrimitiveFields = exports.PersonReferenceQL = exports.PersonReferenceFields = exports.ChangesQL = exports.ChangesInputQL = exports.ReferenceBlockQL = exports.ReferenceBlockInputQL = void 0;
+exports.UpdateRecommendationInputQL = exports.ArchiveNoteOutputQL = exports.ArchiveNoteInputQL = exports.FindNotesInputQL = exports.FindNoteInputQL = exports.UpsertNoteInputQL = exports.FindEventInputQL = exports.FindCalendarInputQL = exports.FindArticlesInputQL = exports.FindArticleInputQL = exports.FindDomainInputQL = exports.FindTenantInputQL = exports.Table = exports.TableQL = exports.Record = exports.RecordQL = exports.TableMetadata = exports.TableMetadataQL = exports.FieldValueQL = exports.FieldQL = exports.OptionQL = exports.FieldVariation = exports.FieldType = exports.Template = exports.TemplateQL = exports.DocumentMetadata = exports.DocumentMetadataQL = exports.BlockDescriptionQL = exports.Website = exports.WebsiteQL = exports.Document = exports.DocumentQL = exports.Thread = exports.Todo = exports.Calendar = exports.CalendarQL = exports.Event = exports.EventQL = exports.PersonAcceptanceQL = exports.ResponseStatus = exports.EventStatus = exports.Conference = exports.ConferenceQL = exports.ConferenceEntrypointQL = exports.TranscriptionQL = exports.TranscriptionEntryQL = exports.Task = exports.TaskQL = exports.TaskFields = exports.Note = void 0;
+exports.GraphQLTypes = exports.SearchInputQL = exports.SearchTagsInputQL = exports.ArchiveSearchOutputQL = exports.ArchiveSearchInputQL = exports.FindSearchesInputQL = exports.FindSearchInputQL = exports.UpsertSearchInputQL = exports.ArchiveFolderOutputQL = exports.ArchiveFolderInputQL = exports.FindFoldersInputQL = exports.FindFolderInputQL = exports.UpsertFolderInputQL = exports.ArchiveTaskOutputQL = exports.ArchiveTaskInputQL = exports.FindTasksInputQL = exports.FindTaskInputQL = exports.UpdateTaskInputQL = exports.DeleteSharingTagInputQL = exports.SetSharingTagInputQL = exports.MergeTagInputQL = exports.ArchiveTagOutputQL = exports.ArchiveTagInputQL = exports.FindTagsInputQL = exports.FindTagInputQL = exports.UpsertTagInputQL = exports.SharingTenantInputQL = exports.SharingDomainInputQL = exports.FindSyncInputQL = exports.FindProviderInputQL = exports.ArchiveRecommendationOutputQL = exports.ArchiveRecommendationInputQL = void 0;
 const uuid_1 = require("uuid");
 /*
 These are the core primitives of our model. These represent the entities that show
@@ -163,6 +163,11 @@ var ProcessingStage;
     ProcessingStage["Waiting"] = "waiting";
     ProcessingStage["Stopped"] = "stopped";
 })(ProcessingStage || (exports.ProcessingStage = ProcessingStage = {}));
+var ThumbsDirection;
+(function (ThumbsDirection) {
+    ThumbsDirection["Up"] = "up";
+    ThumbsDirection["Down"] = "down";
+})(ThumbsDirection || (exports.ThumbsDirection = ThumbsDirection = {}));
 var RecordType;
 (function (RecordType) {
     RecordType["Opportunity"] = "opportunity";
@@ -279,10 +284,11 @@ type SharingDomain {
 exports.SharingTenantQL = `
 type SharingTenant {
   tenantId: String!
+	sharingLevel: Int!
 	favorite: Boolean
   hasAutoShareNotesOn: Boolean
 	hasAutoShareTasksOn: Boolean
-	sharingLevel: Int!
+	businessObjects: [BusinessObjectLink]
 }`;
 exports.BusinessObjectLinkInputQL = `
 input BusinessObjectLinkInput {
@@ -551,6 +557,11 @@ class Sync extends Primitive {
     }
 }
 exports.Sync = Sync;
+exports.BusinessObjectLinkingToTagQL = `
+type BusinessObjectLinkingToTag {
+	documentTypeSubscriptions: [String]!
+	tagType: String!
+}`;
 exports.ProviderApplicationQL = `
 type ProviderApplication {
   name: String!
@@ -558,9 +569,10 @@ type ProviderApplication {
   description: String!
 	iconUrl: String
 	sobjects: StandardObjects!
-	linkSubscriptions: [String]!
-	recordTypeSubscriptions: [String]!
-	documentTypeSubscriptions: [String]!
+	linkSubscriptions: [String]
+	recordTypeSubscriptions: [String]
+	documentTypeSubscriptions: [String]
+	businessObjectLinkingToTags: [BusinessObjectLinkingToTag]
 	authentication: Boolean!
 }`;
 exports.ProviderQL = `
@@ -571,8 +583,8 @@ type Provider {${exports.PrimitiveFields}
 	iconUrl: String
   instanceUrl: String!
   applications: [ProviderApplication]!
-	tableMetadata: [TableMetadata]!
-	documentMetadata: [DocumentMetadata]!
+	tableMetadata: [TableMetadata]
+	documentMetadata: [DocumentMetadata]
 }`;
 class Provider extends Primitive {
     constructor(name, label, description, instanceUrl, applications) {
@@ -582,8 +594,6 @@ class Provider extends Primitive {
         this.description = description;
         this.instanceUrl = instanceUrl;
         this.applications = applications;
-        this.tableMetadata = [];
-        this.documentMetadata = [];
     }
 }
 exports.Provider = Provider;
@@ -672,6 +682,8 @@ type Recommendation {${exports.SharedPrimitiveFields}
 	archived: Boolean!
 	favorite: Boolean!
 	snoozed: Boolean!
+	thumbs: String
+	comment: String
 	status: Int
 }`;
 class Recommendation extends SharedPrimitive {
@@ -1209,6 +1221,22 @@ type ArchiveNoteOutput {
   _id: String!
   archived: Boolean!
 }`;
+exports.UpdateRecommendationInputQL = `
+input UpdateRecommendationInput {
+  _id: String!
+	thumbs: String
+	comment: String
+}`;
+exports.ArchiveRecommendationInputQL = `
+input ArchiveRecommendationInput {
+  _id: String!
+  archive: Boolean
+}`;
+exports.ArchiveRecommendationOutputQL = `
+type ArchiveRecommendationOutput {
+  _id: String!
+  archived: Boolean!
+}`;
 exports.FindProviderInputQL = `
 input FindProviderInput {
   provider: String!
@@ -1468,6 +1496,7 @@ ${exports.MetadataQL}
 ${exports.FolderQL}
 ${exports.SearchQL}
 ${exports.SyncQL}
+${exports.BusinessObjectLinkingToTagQL}
 ${exports.ProviderApplicationQL}
 ${exports.ProviderQL}
 ${exports.TagQL}
@@ -1513,6 +1542,9 @@ ${exports.FindNoteInputQL}
 ${exports.FindNotesInputQL}
 ${exports.ArchiveNoteInputQL}
 ${exports.ArchiveNoteOutputQL}
+${exports.UpdateRecommendationInputQL}
+${exports.ArchiveRecommendationInputQL}
+${exports.ArchiveRecommendationOutputQL}
 ${exports.FindProviderInputQL}
 ${exports.FindSyncInputQL}
 ${exports.SharingDomainInputQL}

package/model.ts

@@ -158,6 +158,11 @@ export enum ProcessingStage {
 	Stopped = 'stopped',
 }
 
+export enum ThumbsDirection {
+	Up = 'up',
+	Down = 'down',
+}
+
 export enum RecordType {
 	Opportunity = 'opportunity',
 	Case = 'case',
@@ -317,10 +322,11 @@ export interface SharingDomain {
 export const SharingTenantQL = `
 type SharingTenant {
   tenantId: String!
+	sharingLevel: Int!
 	favorite: Boolean
   hasAutoShareNotesOn: Boolean
 	hasAutoShareTasksOn: Boolean
-	sharingLevel: Int!
+	businessObjects: [BusinessObjectLink]
 }`;
 export interface SharingTenant {
 	tenantId: string;
@@ -328,7 +334,8 @@ export interface SharingTenant {
 	hasAutoShareNotesOn: boolean; // Indicates if the tenant has auto sharing of notes switched on
 	hasAutoShareTasksOn: boolean; // Indicates if the tenant has auto sharing of tasks switched on
 	sharingLevel: SharingLevel; // Determines what tenants can do with the tag beyond tenant specific settings above
-	_savedSearchId?: string;
+	businessObjects?: BusinessObjectLink[]; // The business objects that are linked to the tag specific to the tenant
+	_savedSearchId?: string; // Used to help manage searches that are based on favoriting a tag
 }
 
 export const BusinessObjectLinkInputQL = `
@@ -814,6 +821,16 @@ export class Sync extends Primitive {
 	}
 }
 
+export const BusinessObjectLinkingToTagQL = `
+type BusinessObjectLinkingToTag {
+	documentTypeSubscriptions: [String]!
+	tagType: String!
+}`;
+export interface BusinessObjectLinkingToTag {
+	documentTypeSubscriptions: string[];
+	tagType: TagType;
+}
+
 export const ProviderApplicationQL = `
 type ProviderApplication {
   name: String!
@@ -821,9 +838,10 @@ type ProviderApplication {
   description: String!
 	iconUrl: String
 	sobjects: StandardObjects!
-	linkSubscriptions: [String]!
-	recordTypeSubscriptions: [String]!
-	documentTypeSubscriptions: [String]!
+	linkSubscriptions: [String]
+	recordTypeSubscriptions: [String]
+	documentTypeSubscriptions: [String]
+	businessObjectLinkingToTags: [BusinessObjectLinkingToTag]
 	authentication: Boolean!
 }`;
 export interface ProviderApplication {
@@ -832,9 +850,10 @@ export interface ProviderApplication {
 	description: string;
 	iconUrl?: string;
 	sobjects: StandardObjects;
-	linkSubscriptions: string[];
-	recordTypeSubscriptions: string[];
-	documentTypeSubscriptions: string[];
+	linkSubscriptions?: string[];
+	recordTypeSubscriptions?: string[];
+	documentTypeSubscriptions?: string[];
+	businessObjectLinkingToTags?: BusinessObjectLinkingToTag[];
 	authentication: boolean;
 }
 
@@ -846,8 +865,8 @@ type Provider {${PrimitiveFields}
 	iconUrl: String
   instanceUrl: String!
   applications: [ProviderApplication]!
-	tableMetadata: [TableMetadata]!
-	documentMetadata: [DocumentMetadata]!
+	tableMetadata: [TableMetadata]
+	documentMetadata: [DocumentMetadata]
 }`;
 export class Provider extends Primitive {
 	name: string;
@@ -856,8 +875,8 @@ export class Provider extends Primitive {
 	iconUrl?: string;
 	instanceUrl: string;
 	applications: ProviderApplication[];
-	tableMetadata: TableMetadata[];
-	documentMetadata: DocumentMetadata[];
+	tableMetadata?: TableMetadata[];
+	documentMetadata?: DocumentMetadata[];
 
 	constructor(
 		name: string,
@@ -873,9 +892,6 @@ export class Provider extends Primitive {
 		this.description = description;
 		this.instanceUrl = instanceUrl;
 		this.applications = applications;
-
-		this.tableMetadata = [];
-		this.documentMetadata = [];
 	}
 }
 
@@ -1028,6 +1044,8 @@ type Recommendation {${SharedPrimitiveFields}
 	archived: Boolean!
 	favorite: Boolean!
 	snoozed: Boolean!
+	thumbs: String
+	comment: String
 	status: Int
 }`;
 export class Recommendation extends SharedPrimitive implements BaseTask {
@@ -1041,6 +1059,8 @@ export class Recommendation extends SharedPrimitive implements BaseTask {
 	archived: boolean;
 	favorite: boolean;
 	snoozed: boolean;
+	thumbs: ThumbsDirection; // Added so we can get some basic feedback on recommendations
+	comment: String; // Added likely just for the private beta, but perhaps longer!
 	status?: TaskStatus;
 
 	constructor(
@@ -2197,6 +2217,38 @@ export interface ArchiveNoteOutput {
 	archived: boolean;
 }
 
+export const UpdateRecommendationInputQL = `
+input UpdateRecommendationInput {
+  _id: String!
+	thumbs: String
+	comment: String
+}`;
+export interface UpdateRecommendationInput {
+	_id?: string;
+	thumbs: ThumbsDirection;
+	comment: string;
+}
+
+export const ArchiveRecommendationInputQL = `
+input ArchiveRecommendationInput {
+  _id: String!
+  archive: Boolean
+}`;
+export interface ArchiveRecommendationInput {
+	_id: string;
+	archive?: boolean;
+}
+
+export const ArchiveRecommendationOutputQL = `
+type ArchiveRecommendationOutput {
+  _id: String!
+  archived: Boolean!
+}`;
+export interface ArchiveRecommendationOutput {
+	_id: string;
+	archived: boolean;
+}
+
 export const FindProviderInputQL = `
 input FindProviderInput {
   provider: String!
@@ -2654,6 +2706,7 @@ ${MetadataQL}
 ${FolderQL}
 ${SearchQL}
 ${SyncQL}
+${BusinessObjectLinkingToTagQL}
 ${ProviderApplicationQL}
 ${ProviderQL}
 ${TagQL}
@@ -2699,6 +2752,9 @@ ${FindNoteInputQL}
 ${FindNotesInputQL}
 ${ArchiveNoteInputQL}
 ${ArchiveNoteOutputQL}
+${UpdateRecommendationInputQL}
+${ArchiveRecommendationInputQL}
+${ArchiveRecommendationOutputQL}
 ${FindProviderInputQL}
 ${FindSyncInputQL}
 ${SharingDomainInputQL}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"author": "Bigfoot",
 	"name": "@bigfootai/bigfoot-types",
-	"version": "4.7.24",
+	"version": "4.7.26",
 	"description": "The internal library for the types used in the Bigfoot platform",
 	"main": "model.js",
 	"license": "ISC",