@bigfootai/bigfoot-types 4.4.8 → 4.4.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/model.js +25 -23
  2. package/model.ts +41 -49
  3. package/package.json +1 -1
package/model.js CHANGED
@@ -1,9 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SharedPrimitiveFields = exports.Primitive = exports.PrimitiveFields = exports.PersonReferenceQL = exports.PersonReferenceFields = exports.ChangesQL = exports.ChangesInputQL = exports.ReferenceBlockQL = exports.ReferenceBlockInputQL = exports.ConnectedProviderQL = exports.CredentialQL = exports.StandardObjectsQL = 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.SharingTenantQL = exports.SharingDomainQL = exports.SharingTagQL = exports.SharingTagInputQL = exports.EditorQL = exports.EditorInputQL = exports.HighlightQL = exports.RelationType = exports.EntityType = 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.SharingLevel = exports.ClientType = exports.TagType = exports.BlockType = void 0;
4
- 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 = exports.NoteQL = exports.MetadataBusinessObject = exports.MetadataBusinessObjectFields = 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.Tenant = exports.TenantQL = 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.Metadata = exports.MetadataFields = exports.SharedPrimitive = void 0;
5
- exports.FindSearchesInputQL = exports.FindSearchInputQL = exports.UpsertSearchInputQL = exports.ArchiveTaskOutputQL = exports.ArchiveTaskInputQL = exports.FindTasksInputQL = exports.FindTaskInputQL = exports.UpdateTaskInputQL = exports.DeleteSharingTagInputQL = exports.SetSharingTagInputQL = exports.ArchiveTagOutputQL = exports.ArchiveTagInputQL = exports.FindTagsInputQL = exports.FindTagInputQL = exports.UpsertTagInputQL = exports.SharingTenantInputQL = 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.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 = void 0;
6
- exports.GraphQLTypes = exports.SearchInputQL = exports.SearchTagsInputQL = exports.ArchiveSearchOutputQL = exports.ArchiveSearchInputQL = void 0;
3
+ exports.Primitive = exports.PrimitiveFields = exports.PersonReferenceQL = exports.PersonReferenceFields = exports.ChangesQL = exports.ChangesInputQL = exports.ReferenceBlockQL = exports.ReferenceBlockInputQL = exports.ConnectedProviderQL = exports.CredentialQL = exports.StandardObjectsQL = 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.SharingTenantQL = exports.SharingDomainQL = exports.SharingTagQL = exports.SharingTagInputQL = 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.SharingLevel = exports.ClientType = exports.TagType = exports.BlockType = void 0;
4
+ 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 = 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.Tenant = exports.TenantQL = 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.Metadata = exports.MetadataFields = exports.SharedPrimitive = exports.SharedPrimitiveFields = void 0;
5
+ exports.ArchiveSearchInputQL = exports.FindSearchesInputQL = exports.FindSearchInputQL = exports.UpsertSearchInputQL = exports.ArchiveTaskOutputQL = exports.ArchiveTaskInputQL = exports.FindTasksInputQL = exports.FindTaskInputQL = exports.UpdateTaskInputQL = exports.DeleteSharingTagInputQL = exports.SetSharingTagInputQL = exports.ArchiveTagOutputQL = exports.ArchiveTagInputQL = exports.FindTagsInputQL = exports.FindTagInputQL = exports.UpsertTagInputQL = exports.SharingTenantInputQL = 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.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 = void 0;
6
+ exports.GraphQLTypes = exports.SearchInputQL = exports.SearchTagsInputQL = exports.ArchiveSearchOutputQL = void 0;
7
7
  const uuid_1 = require("uuid");
8
8
  /*
9
9
  These are the core primitives of our model. These represent the entities that show
@@ -142,7 +142,13 @@ var ProcessingStage;
142
142
  ProcessingStage["NoCredential"] = "no_credential";
143
143
  ProcessingStage["Failed"] = "failed";
144
144
  ProcessingStage["Waiting"] = "waiting";
145
+ ProcessingStage["Stopped"] = "stopped";
145
146
  })(ProcessingStage || (exports.ProcessingStage = ProcessingStage = {}));
147
+ var RecordType;
148
+ (function (RecordType) {
149
+ RecordType["Opportunity"] = "opportunity";
150
+ RecordType["Case"] = "case";
151
+ })(RecordType || (exports.RecordType = RecordType = {}));
146
152
  // Referenced here: https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-entity-types-version-2
147
153
  var EntityType;
148
154
  (function (EntityType) {
@@ -403,13 +409,11 @@ class SharedPrimitive extends Primitive {
403
409
  exports.SharedPrimitive = SharedPrimitive;
404
410
  exports.MetadataFields = `${exports.PrimitiveFields}
405
411
  label: String!
406
- name: String!
407
412
  description: String!
408
413
  references: [String]`;
409
414
  class Metadata extends Primitive {
410
- constructor(name, label, description) {
415
+ constructor(label, description) {
411
416
  super();
412
- this.name = name;
413
417
  this.label = label;
414
418
  this.description = description;
415
419
  }
@@ -455,6 +459,7 @@ type ProviderApplication {
455
459
  name: String!
456
460
  sobjects: StandardObjects!
457
461
  linkSubscriptions: [String]!
462
+ recordTypeSubscriptions: [String]!
458
463
  }`;
459
464
  exports.ProviderQL = `
460
465
  type Provider {${exports.PrimitiveFields}
@@ -463,6 +468,7 @@ type Provider {${exports.PrimitiveFields}
463
468
  description: String!
464
469
  instanceUrl: String!
465
470
  applications: [ProviderApplication]!
471
+ tableMetadata: [TableMetadata]!
466
472
  }`;
467
473
  class Provider extends Primitive {
468
474
  constructor(provider, name, description, instanceUrl, applications) {
@@ -668,14 +674,6 @@ class BusinessObject extends Block {
668
674
  }
669
675
  }
670
676
  exports.BusinessObject = BusinessObject;
671
- exports.MetadataBusinessObjectFields = `${exports.BusinessObjectFields}
672
- metadataId: String`;
673
- class MetadataBusinessObject extends BusinessObject {
674
- constructor(tenantIdCreated, editors, sharingTags, version, blockType, provider, application, uri, externalId) {
675
- super(tenantIdCreated, editors, sharingTags, version, blockType, provider, application, uri, externalId);
676
- }
677
- }
678
- exports.MetadataBusinessObject = MetadataBusinessObject;
679
677
  exports.NoteQL = `
680
678
  type Note {${exports.BlockFields}
681
679
  }`;
@@ -876,16 +874,16 @@ type DocumentMetadata {${exports.MetadataFields}
876
874
  }`;
877
875
  class DocumentMetadata extends Metadata {
878
876
  constructor(name, label, description, contentBlocks) {
879
- super(name, label, description);
877
+ super(label, description);
880
878
  this.contentBlocks = contentBlocks;
881
879
  }
882
880
  }
883
881
  exports.DocumentMetadata = DocumentMetadata;
884
882
  exports.TemplateQL = `
885
- type Template {${exports.MetadataBusinessObjectFields}
883
+ type Template {${exports.BusinessObjectFields}
886
884
  metadata: DocumentMetadata
887
885
  }`;
888
- class Template extends MetadataBusinessObject {
886
+ class Template extends BusinessObject {
889
887
  constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId) {
890
888
  super(tenantIdCreated, editors, sharingTags, version, BlockType.Template, provider, application, uri, externalId);
891
889
  }
@@ -937,11 +935,13 @@ type FieldValue {
937
935
  exports.TableMetadataQL = `
938
936
  type TableMetadata {${exports.MetadataFields}
939
937
  fields: [Field]!
938
+ recordType: String!
940
939
  }`;
941
940
  class TableMetadata extends Metadata {
942
- constructor(name, label, description, fields) {
943
- super(name, label, description);
941
+ constructor(label, description, fields, recordType) {
942
+ super(label, description);
944
943
  this.fields = fields;
944
+ this.recordType = recordType;
945
945
  }
946
946
  }
947
947
  exports.TableMetadata = TableMetadata;
@@ -953,17 +953,19 @@ class Record extends BusinessObject {
953
953
  constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId, values) {
954
954
  super(tenantIdCreated, editors, sharingTags, version, BlockType.Record, provider, application, uri, externalId);
955
955
  this.values = values;
956
+ this.enabled = true;
956
957
  }
957
958
  }
958
959
  exports.Record = Record;
959
960
  exports.TableQL = `
960
- type Table {${exports.MetadataBusinessObjectFields}
961
+ type Table {${exports.BusinessObjectFields}
961
962
  records: [Record]
962
963
  metadata: TableMetadata
963
964
  }`;
964
- class Table extends MetadataBusinessObject {
965
- constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId) {
965
+ class Table extends BusinessObject {
966
+ constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId, metadata) {
966
967
  super(tenantIdCreated, editors, sharingTags, version, BlockType.Table, provider, application, uri, externalId);
968
+ this.metadata = metadata;
967
969
  }
968
970
  }
969
971
  exports.Table = Table;
package/model.ts CHANGED
@@ -136,6 +136,12 @@ export enum ProcessingStage {
136
136
  NoCredential = 'no_credential',
137
137
  Failed = 'failed',
138
138
  Waiting = 'waiting',
139
+ Stopped = 'stopped',
140
+ }
141
+
142
+ export enum RecordType {
143
+ Opportunity = 'opportunity',
144
+ Case = 'case',
139
145
  }
140
146
 
141
147
  // Referenced here: https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-entity-types-version-2
@@ -453,6 +459,7 @@ export interface LinkSubscriptionProviderRequest {
453
459
  callbackId: string;
454
460
  url: string;
455
461
  connectedProvider: ConnectedProvider;
462
+ tableMetadata?: TableMetadata[];
456
463
  }
457
464
 
458
465
  export const CredentialQL = `
@@ -585,19 +592,16 @@ export class SharedPrimitive extends Primitive {
585
592
 
586
593
  export const MetadataFields = `${PrimitiveFields}
587
594
  label: String!
588
- name: String!
589
595
  description: String!
590
596
  references: [String]`;
591
597
  export class Metadata extends Primitive {
592
- name: string;
593
598
  label: string;
594
599
  description: string;
595
600
  references?: string[];
596
601
 
597
- constructor(name: string, label: string, description: string) {
602
+ constructor(label: string, description: string) {
598
603
  super();
599
604
 
600
- this.name = name;
601
605
  this.label = label;
602
606
  this.description = description;
603
607
  }
@@ -660,11 +664,13 @@ type ProviderApplication {
660
664
  name: String!
661
665
  sobjects: StandardObjects!
662
666
  linkSubscriptions: [String]!
667
+ recordTypeSubscriptions: [String]!
663
668
  }`;
664
669
  export interface ProviderApplication {
665
670
  name: string;
666
671
  sobjects: StandardObjects;
667
672
  linkSubscriptions: string[];
673
+ recordTypeSubscriptions: string[];
668
674
  }
669
675
 
670
676
  export const ProviderQL = `
@@ -674,6 +680,7 @@ type Provider {${PrimitiveFields}
674
680
  description: String!
675
681
  instanceUrl: String!
676
682
  applications: [ProviderApplication]!
683
+ tableMetadata: [TableMetadata]!
677
684
  }`;
678
685
  export class Provider extends Primitive {
679
686
  provider: string;
@@ -681,6 +688,7 @@ export class Provider extends Primitive {
681
688
  description: string;
682
689
  instanceUrl: string;
683
690
  applications: ProviderApplication[];
691
+ tableMetadata: TableMetadata[];
684
692
 
685
693
  constructor(
686
694
  provider: string,
@@ -1057,36 +1065,6 @@ export class BusinessObject extends Block {
1057
1065
  }
1058
1066
  }
1059
1067
 
1060
- export const MetadataBusinessObjectFields = `${BusinessObjectFields}
1061
- metadataId: String`;
1062
- export class MetadataBusinessObject extends BusinessObject {
1063
- metadataId?: string;
1064
-
1065
- constructor(
1066
- tenantIdCreated: string,
1067
- editors: Editor[],
1068
- sharingTags: SharingTag[],
1069
- version: number,
1070
- blockType: BlockType,
1071
- provider: string,
1072
- application: string,
1073
- uri: string,
1074
- externalId: string
1075
- ) {
1076
- super(
1077
- tenantIdCreated,
1078
- editors,
1079
- sharingTags,
1080
- version,
1081
- blockType,
1082
- provider,
1083
- application,
1084
- uri,
1085
- externalId
1086
- );
1087
- }
1088
- }
1089
-
1090
1068
  export const NoteQL = `
1091
1069
  type Note {${BlockFields}
1092
1070
  }`;
@@ -1278,22 +1256,26 @@ export interface CalendarFilter {
1278
1256
  }
1279
1257
 
1280
1258
  export interface SyncCalendarProviderRequest {
1281
- filter: CalendarFilter;
1259
+ calendarFilter: CalendarFilter;
1282
1260
  connectedProvider: ConnectedProvider;
1283
1261
  }
1284
1262
 
1285
1263
  export interface RecordTypeFilter {
1286
1264
  recordType: string;
1287
- recordIds: string[];
1265
+ externalIds: string[];
1288
1266
  }
1289
1267
 
1290
1268
  export interface RecordFilter {
1291
- provideMetadata: boolean;
1292
- records: RecordTypeFilter[];
1269
+ recordTypeFilters: RecordTypeFilter[];
1293
1270
  }
1294
1271
 
1295
1272
  export interface SyncTableProviderRequest {
1296
- filter: RecordFilter;
1273
+ recordFilter: RecordFilter;
1274
+ connectedProvider: ConnectedProvider;
1275
+ }
1276
+
1277
+ export interface SyncTableMetadataProviderRequest {
1278
+ tableMetadata: TableMetadata[];
1297
1279
  connectedProvider: ConnectedProvider;
1298
1280
  }
1299
1281
 
@@ -1577,17 +1559,17 @@ export class DocumentMetadata extends Metadata {
1577
1559
  description: string,
1578
1560
  contentBlocks: BlockDescription[]
1579
1561
  ) {
1580
- super(name, label, description);
1562
+ super(label, description);
1581
1563
 
1582
1564
  this.contentBlocks = contentBlocks;
1583
1565
  }
1584
1566
  }
1585
1567
 
1586
1568
  export const TemplateQL = `
1587
- type Template {${MetadataBusinessObjectFields}
1569
+ type Template {${BusinessObjectFields}
1588
1570
  metadata: DocumentMetadata
1589
1571
  }`;
1590
- export class Template extends MetadataBusinessObject {
1572
+ export class Template extends BusinessObject {
1591
1573
  metadata?: DocumentMetadata;
1592
1574
 
1593
1575
  constructor(
@@ -1683,19 +1665,22 @@ export interface FieldValue {
1683
1665
  export const TableMetadataQL = `
1684
1666
  type TableMetadata {${MetadataFields}
1685
1667
  fields: [Field]!
1668
+ recordType: String!
1686
1669
  }`;
1687
1670
  export class TableMetadata extends Metadata {
1688
1671
  fields: Field[];
1672
+ recordType: string;
1689
1673
 
1690
1674
  constructor(
1691
- name: string,
1692
1675
  label: string,
1693
1676
  description: string,
1694
- fields: Field[]
1677
+ fields: Field[],
1678
+ recordType: string
1695
1679
  ) {
1696
- super(name, label, description);
1680
+ super(label, description);
1697
1681
 
1698
1682
  this.fields = fields;
1683
+ this.recordType = recordType;
1699
1684
  }
1700
1685
  }
1701
1686
 
@@ -1705,6 +1690,9 @@ type Record {${BusinessObjectFields}
1705
1690
  }`;
1706
1691
  export class Record extends BusinessObject {
1707
1692
  values: FieldValue[];
1693
+ enabled: boolean;
1694
+ processingStage?: ProcessingStage;
1695
+ processingReason?: string;
1708
1696
 
1709
1697
  constructor(
1710
1698
  tenantIdCreated: string,
@@ -1730,17 +1718,18 @@ export class Record extends BusinessObject {
1730
1718
  );
1731
1719
 
1732
1720
  this.values = values;
1721
+ this.enabled = true;
1733
1722
  }
1734
1723
  }
1735
1724
 
1736
1725
  export const TableQL = `
1737
- type Table {${MetadataBusinessObjectFields}
1726
+ type Table {${BusinessObjectFields}
1738
1727
  records: [Record]
1739
1728
  metadata: TableMetadata
1740
1729
  }`;
1741
- export class Table extends MetadataBusinessObject {
1730
+ export class Table extends BusinessObject {
1731
+ metadata: TableMetadata;
1742
1732
  records?: Record[];
1743
- metadata?: TableMetadata;
1744
1733
 
1745
1734
  constructor(
1746
1735
  tenantIdCreated: string,
@@ -1750,7 +1739,8 @@ export class Table extends MetadataBusinessObject {
1750
1739
  provider: string,
1751
1740
  application: string,
1752
1741
  uri: string,
1753
- externalId: string
1742
+ externalId: string,
1743
+ metadata: TableMetadata
1754
1744
  ) {
1755
1745
  super(
1756
1746
  tenantIdCreated,
@@ -1763,6 +1753,8 @@ export class Table extends MetadataBusinessObject {
1763
1753
  uri,
1764
1754
  externalId
1765
1755
  );
1756
+
1757
+ this.metadata = metadata;
1766
1758
  }
1767
1759
  }
1768
1760
  //// FOR RECORDS END
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "author": "Bigfoot",
3
3
  "name": "@bigfootai/bigfoot-types",
4
- "version": "4.4.8",
4
+ "version": "4.4.10",
5
5
  "description": "The internal library for the types used in the Bigfoot platform",
6
6
  "main": "model.js",
7
7
  "license": "ISC",