@bigfootai/bigfoot-types 4.3.9 → 4.4.1

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.
@@ -1,127 +1,121 @@
1
1
  {
2
- "label": "Opportunity",
3
- "name": "Opportunity",
4
- "references": [ "https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunity.htm" ],
5
- "description": "Represents an opportunity, which is a sale or pending deal.",
6
- "fields": [
7
- {
8
- "label": "Name",
9
- "name": "Name",
10
- "description": "A name for this opportunity.",
11
- "doMonitor": true,
12
- "fieldType": "input",
13
- "maximumCharacters": 120,
14
- "order": 0,
15
- "isReadOnly": false
16
- },
17
- {
18
- "label": "Account",
19
- "name": "Account.Name",
20
- "description": "Name of the account associated with this opportunity.",
21
- "doMonitor": true,
22
- "fieldType": "input",
23
- "order": 1,
24
- "isReadOnly": false
25
- },
26
- {
27
- "label": "Amount",
28
- "name": "Amount",
29
- "description": "Estimated total sale amount.",
30
- "doMonitor": true,
31
- "fieldType": "input",
32
- "fieldVariation": "currency",
33
- "order": 2,
34
- "isReadOnly": false
35
- },
36
- {
37
- "label": "Close Date",
38
- "name": "CloseDate",
39
- "description": "Date when the opportunity is expected to close.",
40
- "doMonitor": true,
41
- "fieldType": "input",
42
- "fieldVariation": "date",
43
- "order": 3,
44
- "isReadOnly": false
45
- },
46
- {
47
- "label": "Stage",
48
- "name": "StageName",
49
- "description": "Current stage of this opportunity.",
50
- "doMonitor": true,
51
- "fieldType": "select",
52
- "order": 4,
53
- "isReadOnly": false,
54
- "options": [
55
- {
56
- "label": "Prospecting",
57
- "value": "Prospecting"
58
- },
59
- {
60
- "label": "Qualification",
61
- "value": "Qualification"
62
- },
63
- {
64
- "label": "Needs Analysis",
65
- "value": "Needs Analysis"
66
- },
67
- {
68
- "label": "Value Proposition",
69
- "value": "Value Proposition"
70
- },
71
- {
72
- "label": "Id. Decision Makers",
73
- "value": "Id. Decision Makers"
74
- },
75
- {
76
- "label": "Perception Analysis",
77
- "value": "Perception Analysis"
78
- },
79
- {
80
- "label": "Proposal/Price Quote",
81
- "value": "Proposal/Price Quote"
82
- },
83
- {
84
- "label": "Negotiation/Review",
85
- "value": "Negotiation/Review"
86
- },
87
- {
88
- "label": "Closed Won",
89
- "value": "Closed Won"
90
- },
91
- {
92
- "label": "Closed Lost",
93
- "value": "Closed Lost"
94
- }
95
- ]
96
- },
97
- {
98
- "label": "Owner.Name",
99
- "name": "Owner",
100
- "description": "Name of the User who has been assigned to work on this opportunity.",
101
- "doMonitor": true,
102
- "fieldType": "input",
103
- "order": 5,
104
- "isReadOnly": false
105
- },
106
- {
107
- "label": "Next Step",
108
- "name": "NextStep",
109
- "description": "A short description of next task in closing opportunity.",
110
- "doMonitor": true,
111
- "fieldType": "input",
112
- "maximumCharacters": 250,
113
- "order": 6,
114
- "isReadOnly": false
115
- },
116
- {
117
- "label": "Description",
118
- "name": "Description",
119
- "description": "Text description of the opportunity.",
120
- "doMonitor": false,
121
- "fieldType": "textarea",
122
- "maximumCharacters": 32000,
123
- "order": 7,
124
- "isReadOnly": false
125
- }
126
- ]
2
+ "label": "Opportunity",
3
+ "name": "Opportunity",
4
+ "references": [
5
+ "https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunity.htm"
6
+ ],
7
+ "description": "Represents an opportunity, which is a sale or pending deal.",
8
+ "fields": [
9
+ {
10
+ "label": "Name",
11
+ "name": "Name",
12
+ "description": "A name for this opportunity.",
13
+ "monitor": true,
14
+ "fieldType": "input",
15
+ "maximumCharacters": 120,
16
+ "readOnly": false
17
+ },
18
+ {
19
+ "label": "Account",
20
+ "name": "Account.Name",
21
+ "description": "Name of the account associated with this opportunity.",
22
+ "monitor": true,
23
+ "fieldType": "input",
24
+ "readOnly": false
25
+ },
26
+ {
27
+ "label": "Amount",
28
+ "name": "Amount",
29
+ "description": "Estimated total sale amount.",
30
+ "monitor": true,
31
+ "fieldType": "input",
32
+ "fieldVariation": "currency",
33
+ "readOnly": false
34
+ },
35
+ {
36
+ "label": "Close Date",
37
+ "name": "CloseDate",
38
+ "description": "Date when the opportunity is expected to close.",
39
+ "monitor": true,
40
+ "fieldType": "input",
41
+ "fieldVariation": "date",
42
+ "readOnly": false
43
+ },
44
+ {
45
+ "label": "Stage",
46
+ "name": "StageName",
47
+ "description": "Current stage of this opportunity.",
48
+ "monitor": true,
49
+ "fieldType": "select",
50
+ "readOnly": false,
51
+ "options": [
52
+ {
53
+ "label": "Prospecting",
54
+ "value": "Prospecting"
55
+ },
56
+ {
57
+ "label": "Qualification",
58
+ "value": "Qualification"
59
+ },
60
+ {
61
+ "label": "Needs Analysis",
62
+ "value": "Needs Analysis"
63
+ },
64
+ {
65
+ "label": "Value Proposition",
66
+ "value": "Value Proposition"
67
+ },
68
+ {
69
+ "label": "Id. Decision Makers",
70
+ "value": "Id. Decision Makers"
71
+ },
72
+ {
73
+ "label": "Perception Analysis",
74
+ "value": "Perception Analysis"
75
+ },
76
+ {
77
+ "label": "Proposal/Price Quote",
78
+ "value": "Proposal/Price Quote"
79
+ },
80
+ {
81
+ "label": "Negotiation/Review",
82
+ "value": "Negotiation/Review"
83
+ },
84
+ {
85
+ "label": "Closed Won",
86
+ "value": "Closed Won"
87
+ },
88
+ {
89
+ "label": "Closed Lost",
90
+ "value": "Closed Lost"
91
+ }
92
+ ]
93
+ },
94
+ {
95
+ "label": "Owner.Name",
96
+ "name": "Owner",
97
+ "description": "Name of the User who has been assigned to work on this opportunity.",
98
+ "monitor": true,
99
+ "fieldType": "input",
100
+ "readOnly": false
101
+ },
102
+ {
103
+ "label": "Next Step",
104
+ "name": "NextStep",
105
+ "description": "A short description of next task in closing opportunity.",
106
+ "monitor": true,
107
+ "fieldType": "input",
108
+ "maximumCharacters": 250,
109
+ "readOnly": false
110
+ },
111
+ {
112
+ "label": "Description",
113
+ "name": "Description",
114
+ "description": "Text description of the opportunity.",
115
+ "monitor": false,
116
+ "fieldType": "textarea",
117
+ "maximumCharacters": 32000,
118
+ "readOnly": false
119
+ }
120
+ ]
127
121
  }
package/model.js CHANGED
@@ -1,8 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
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.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 = exports.NoteQL = exports.BusinessObject = exports.BusinessObjectQL = exports.BusinessObjectFields = exports.BusinessObjectIngestionRequest = exports.BusinessObjectIngestionResponse = 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.ProviderApplication = exports.ProviderApplicationQL = exports.Sync = exports.SyncQL = exports.Search = exports.SearchQL = exports.SharedPrimitive = void 0;
5
- exports.GraphQLTypes = exports.SearchInputQL = exports.SearchTagsInputQL = exports.ArchiveSearchOutputQL = 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.FieldVariation = exports.FieldType = exports.Template = exports.Website = exports.Document = 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.ArchiveSearchOutputQL = 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.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 = void 0;
6
7
  const uuid_1 = require("uuid");
7
8
  /*
8
9
  These are the core primitives of our model. These represent the entities that show
@@ -400,6 +401,20 @@ class SharedPrimitive extends Primitive {
400
401
  }
401
402
  }
402
403
  exports.SharedPrimitive = SharedPrimitive;
404
+ exports.MetadataFields = `${exports.PrimitiveFields}
405
+ label: String!
406
+ name: String!
407
+ description: String!
408
+ references: [String]`;
409
+ class Metadata extends Primitive {
410
+ constructor(name, label, description) {
411
+ super();
412
+ this.name = name;
413
+ this.label = label;
414
+ this.description = description;
415
+ }
416
+ }
417
+ exports.Metadata = Metadata;
403
418
  exports.SearchQL = `
404
419
  type Search {${exports.SharedPrimitiveFields}
405
420
  search: String
@@ -437,9 +452,6 @@ type ProviderApplication {
437
452
  sobjects: StandardObjects!
438
453
  linkSubscriptions: [String]!
439
454
  }`;
440
- class ProviderApplication {
441
- }
442
- exports.ProviderApplication = ProviderApplication;
443
455
  exports.ProviderQL = `
444
456
  type Provider {${exports.PrimitiveFields}
445
457
  provider: String!
@@ -615,9 +627,6 @@ class History extends Primitive {
615
627
  }
616
628
  }
617
629
  exports.History = History;
618
- class BusinessObjectIngestionResponse {
619
- }
620
- exports.BusinessObjectIngestionResponse = BusinessObjectIngestionResponse;
621
630
  class BusinessObjectIngestionRequest extends Primitive {
622
631
  constructor(tenantIdCreated, originReferenceBlock, uri) {
623
632
  super();
@@ -655,6 +664,14 @@ class BusinessObject extends Block {
655
664
  }
656
665
  }
657
666
  exports.BusinessObject = BusinessObject;
667
+ exports.MetadataBusinessObjectFields = `${exports.BusinessObjectFields}
668
+ metadataId: String`;
669
+ class MetadataBusinessObject extends BusinessObject {
670
+ constructor(tenantIdCreated, editors, sharingTags, version, blockType, provider, application, uri, externalId) {
671
+ super(tenantIdCreated, editors, sharingTags, version, blockType, provider, application, uri, externalId);
672
+ }
673
+ }
674
+ exports.MetadataBusinessObject = MetadataBusinessObject;
658
675
  exports.NoteQL = `
659
676
  type Note {${exports.BlockFields}
660
677
  }`;
@@ -811,6 +828,13 @@ class Thread extends BusinessObject {
811
828
  exports.Thread = Thread;
812
829
  //// MESSAGING END
813
830
  //// DOCUMENT START
831
+ exports.DocumentQL = `
832
+ type Document {${exports.BusinessObjectFields}
833
+ title: String
834
+ description: String
835
+ previewImage: String
836
+ htmlContent: String
837
+ }`;
814
838
  class Document extends BusinessObject {
815
839
  constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId) {
816
840
  super(tenantIdCreated, editors, sharingTags, version, BlockType.Document, provider, application, uri, externalId);
@@ -819,16 +843,47 @@ class Document extends BusinessObject {
819
843
  exports.Document = Document;
820
844
  //// DOCUMENT END
821
845
  //// WEBSITE START
846
+ exports.WebsiteQL = `
847
+ type Website {${exports.BusinessObjectFields}
848
+ title: String
849
+ description: String
850
+ bannerImage: String
851
+ htmlContent: String
852
+ }`;
822
853
  class Website extends BusinessObject {
823
854
  constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId) {
824
855
  super(tenantIdCreated, editors, sharingTags, version, BlockType.Website, provider, application, uri, externalId);
825
856
  }
826
857
  }
827
858
  exports.Website = Website;
828
- class Template extends BusinessObject {
829
- constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId, metadata) {
859
+ //// WEBSITE END
860
+ // BUSINESS OBJECTS END
861
+ // METADATA OBJECTS START
862
+ //// FOR DOCUMENTS START
863
+ exports.BlockDescriptionQL = `
864
+ type BlockDescription {
865
+ title: String
866
+ name: String!
867
+ description: String!
868
+ }`;
869
+ exports.DocumentMetadataQL = `
870
+ type DocumentMetadata {${exports.MetadataFields}
871
+ contentBlocks: [BlockDescription]!
872
+ }`;
873
+ class DocumentMetadata extends Metadata {
874
+ constructor(name, label, description, contentBlocks) {
875
+ super(name, label, description);
876
+ this.contentBlocks = contentBlocks;
877
+ }
878
+ }
879
+ exports.DocumentMetadata = DocumentMetadata;
880
+ exports.TemplateQL = `
881
+ type Template {${exports.MetadataBusinessObjectFields}
882
+ metadata: DocumentMetadata
883
+ }`;
884
+ class Template extends MetadataBusinessObject {
885
+ constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId) {
830
886
  super(tenantIdCreated, editors, sharingTags, version, BlockType.Template, provider, application, uri, externalId);
831
- this.metadata = metadata;
832
887
  }
833
888
  }
834
889
  exports.Template = Template;
@@ -852,11 +907,50 @@ var FieldVariation;
852
907
  FieldVariation["Phone"] = "phone";
853
908
  FieldVariation["Url"] = "url";
854
909
  })(FieldVariation || (exports.FieldVariation = FieldVariation = {}));
855
- class Table extends BusinessObject {
856
- constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId, recordType, metadata, values) {
910
+ exports.OptionQL = `
911
+ type Option {
912
+ label: String!
913
+ value: String!
914
+ }`;
915
+ exports.FieldQL = `
916
+ type Field {
917
+ label: String!
918
+ name: String!
919
+ description: String!
920
+ monitor: Boolean!
921
+ fieldType: String!
922
+ fieldVariation: String
923
+ maximumCharacters: Int
924
+ readOnly: Boolean!
925
+ options: [Option]
926
+ }`;
927
+ exports.FieldValueQL = `
928
+ type FieldValue {
929
+ name: String!
930
+ previousValue: String!
931
+ nextValue: String!
932
+ value: String!
933
+ changed: Boolean!
934
+ }`;
935
+ exports.TableMetadataQL = `
936
+ type TableMetadata {${exports.MetadataFields}
937
+ fields: [Field]!
938
+ }`;
939
+ class TableMetadata extends Metadata {
940
+ constructor(name, label, description, fields) {
941
+ super(name, label, description);
942
+ this.fields = fields;
943
+ }
944
+ }
945
+ exports.TableMetadata = TableMetadata;
946
+ exports.TableQL = `
947
+ type Table {${exports.MetadataBusinessObjectFields}
948
+ values: [FieldValue]!
949
+ metadata: TableMetadata
950
+ }`;
951
+ class Table extends MetadataBusinessObject {
952
+ constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId, values) {
857
953
  super(tenantIdCreated, editors, sharingTags, version, BlockType.Table, provider, application, uri, externalId);
858
- this.recordType = recordType;
859
- this.metadata = metadata;
860
954
  this.values = values;
861
955
  }
862
956
  }
@@ -1133,6 +1227,16 @@ ${exports.ConferenceQL}
1133
1227
  ${exports.PersonAcceptanceQL}
1134
1228
  ${exports.EventQL}
1135
1229
  ${exports.CalendarQL}
1230
+ ${exports.DocumentQL}
1231
+ ${exports.WebsiteQL}
1232
+ ${exports.BlockDescriptionQL}
1233
+ ${exports.DocumentMetadataQL}
1234
+ ${exports.TemplateQL}
1235
+ ${exports.OptionQL}
1236
+ ${exports.FieldQL}
1237
+ ${exports.FieldValueQL}
1238
+ ${exports.TableMetadataQL}
1239
+ ${exports.TableQL}
1136
1240
  ${exports.FindArticleInputQL}
1137
1241
  ${exports.FindArticlesInputQL}
1138
1242
  ${exports.FindCalendarInputQL}
package/model.ts CHANGED
@@ -583,6 +583,26 @@ export class SharedPrimitive extends Primitive {
583
583
  }
584
584
  }
585
585
 
586
+ export const MetadataFields = `${PrimitiveFields}
587
+ label: String!
588
+ name: String!
589
+ description: String!
590
+ references: [String]`;
591
+ export class Metadata extends Primitive {
592
+ name: string;
593
+ label: string;
594
+ description: string;
595
+ references?: string[];
596
+
597
+ constructor(name: string, label: string, description: string) {
598
+ super();
599
+
600
+ this.name = name;
601
+ this.label = label;
602
+ this.description = description;
603
+ }
604
+ }
605
+
586
606
  export const SearchQL = `
587
607
  type Search {${SharedPrimitiveFields}
588
608
  search: String
@@ -634,7 +654,7 @@ type ProviderApplication {
634
654
  sobjects: StandardObjects!
635
655
  linkSubscriptions: [String]!
636
656
  }`;
637
- export class ProviderApplication {
657
+ export interface ProviderApplication {
638
658
  name: string;
639
659
  sobjects: StandardObjects;
640
660
  linkSubscriptions: string[];
@@ -947,7 +967,7 @@ export interface SubscribingProviderApplication {
947
967
  application: ProviderApplication;
948
968
  }
949
969
 
950
- export class BusinessObjectIngestionResponse {
970
+ export interface BusinessObjectIngestionResponse {
951
971
  callbackId: string;
952
972
  processingStage: ProcessingStage;
953
973
  processingReason: string;
@@ -957,15 +977,15 @@ export class BusinessObjectIngestionResponse {
957
977
  export class BusinessObjectIngestionRequest extends Primitive {
958
978
  referenceBlock?: ReferenceBlock; // A reference to the block created/updated by this ingestion
959
979
  subscribingProviderApplication?: SubscribingProviderApplication;
960
- provider: string; // A unique string representing the provider e.g. "salesforce", "atlassian", etc
961
- application: string; // A unique string representing the provider application e.g. "service", "jira", etc
980
+ provider?: string; // A unique string representing the provider e.g. "salesforce", "atlassian", etc
981
+ application?: string; // A unique string representing the provider application e.g. "service", "jira", etc
962
982
  uri: string; // A uri to locate the specific instance of the business object
963
- processingStage: ProcessingStage; // Indicates if the business object has been processed yet
964
- processingAttempts: number; // Indicates the number of attempts made to process this business object
983
+ processingStage?: ProcessingStage; // Indicates if the business object has been processed yet
984
+ processingAttempts?: number; // Indicates the number of attempts made to process this business object
965
985
  processingReason?: string; // The reason the processing is at this stage
966
- dateProcessed: number; // The date this document was last processed
967
- dateToProcess: number; // The date this ingestion should be processed - default is now
968
- originReferenceBlock: ReferenceBlock; // The block that this request originally came from (though the ingestion may be referenced from many future blocks)
986
+ dateProcessed?: number; // The date this document was last processed
987
+ dateToProcess?: number; // The date this ingestion should be processed - default is now
988
+ originReferenceBlock?: ReferenceBlock; // The block that this request originally came from (though the ingestion may be referenced from many future blocks)
969
989
  callbackId?: string; // A callback id that can be used for async requests
970
990
  businessObject?: BusinessObject; // The ingested business object - used for async request callbacks
971
991
 
@@ -1030,6 +1050,36 @@ export class BusinessObject extends Block {
1030
1050
  }
1031
1051
  }
1032
1052
 
1053
+ export const MetadataBusinessObjectFields = `${BusinessObjectFields}
1054
+ metadataId: String`;
1055
+ export class MetadataBusinessObject extends BusinessObject {
1056
+ metadataId?: string;
1057
+
1058
+ constructor(
1059
+ tenantIdCreated: string,
1060
+ editors: Editor[],
1061
+ sharingTags: SharingTag[],
1062
+ version: number,
1063
+ blockType: BlockType,
1064
+ provider: string,
1065
+ application: string,
1066
+ uri: string,
1067
+ externalId: string
1068
+ ) {
1069
+ super(
1070
+ tenantIdCreated,
1071
+ editors,
1072
+ sharingTags,
1073
+ version,
1074
+ blockType,
1075
+ provider,
1076
+ application,
1077
+ uri,
1078
+ externalId
1079
+ );
1080
+ }
1081
+ }
1082
+
1033
1083
  export const NoteQL = `
1034
1084
  type Note {${BlockFields}
1035
1085
  }`;
@@ -1398,6 +1448,13 @@ export class Thread extends BusinessObject {
1398
1448
  //// MESSAGING END
1399
1449
 
1400
1450
  //// DOCUMENT START
1451
+ export const DocumentQL = `
1452
+ type Document {${BusinessObjectFields}
1453
+ title: String
1454
+ description: String
1455
+ previewImage: String
1456
+ htmlContent: String
1457
+ }`;
1401
1458
  export class Document extends BusinessObject {
1402
1459
  title?: string;
1403
1460
  description?: string;
@@ -1430,6 +1487,13 @@ export class Document extends BusinessObject {
1430
1487
  //// DOCUMENT END
1431
1488
 
1432
1489
  //// WEBSITE START
1490
+ export const WebsiteQL = `
1491
+ type Website {${BusinessObjectFields}
1492
+ title: String
1493
+ description: String
1494
+ bannerImage: String
1495
+ htmlContent: String
1496
+ }`;
1433
1497
  export class Website extends BusinessObject {
1434
1498
  title?: string;
1435
1499
  description?: string;
@@ -1466,19 +1530,43 @@ export class Website extends BusinessObject {
1466
1530
  // METADATA OBJECTS START
1467
1531
 
1468
1532
  //// FOR DOCUMENTS START
1533
+ export const BlockDescriptionQL = `
1534
+ type BlockDescription {
1535
+ title: String
1536
+ name: String!
1537
+ description: String!
1538
+ }`;
1469
1539
  export interface BlockDescription {
1470
1540
  title?: string;
1471
1541
  name: string;
1472
1542
  description: string;
1473
- blockType: BlockType;
1474
1543
  }
1475
1544
 
1476
- export interface DocumentMetadata {
1545
+ export const DocumentMetadataQL = `
1546
+ type DocumentMetadata {${MetadataFields}
1547
+ contentBlocks: [BlockDescription]!
1548
+ }`;
1549
+ export class DocumentMetadata extends Metadata {
1477
1550
  contentBlocks: BlockDescription[];
1551
+
1552
+ constructor(
1553
+ name: string,
1554
+ label: string,
1555
+ description: string,
1556
+ contentBlocks: BlockDescription[]
1557
+ ) {
1558
+ super(name, label, description);
1559
+
1560
+ this.contentBlocks = contentBlocks;
1561
+ }
1478
1562
  }
1479
1563
 
1480
- export class Template extends BusinessObject {
1481
- metadata: DocumentMetadata;
1564
+ export const TemplateQL = `
1565
+ type Template {${MetadataBusinessObjectFields}
1566
+ metadata: DocumentMetadata
1567
+ }`;
1568
+ export class Template extends MetadataBusinessObject {
1569
+ metadata?: DocumentMetadata;
1482
1570
 
1483
1571
  constructor(
1484
1572
  tenantIdCreated: string,
@@ -1488,8 +1576,7 @@ export class Template extends BusinessObject {
1488
1576
  provider: string,
1489
1577
  application: string,
1490
1578
  uri: string,
1491
- externalId: string,
1492
- metadata: DocumentMetadata
1579
+ externalId: string
1493
1580
  ) {
1494
1581
  super(
1495
1582
  tenantIdCreated,
@@ -1502,8 +1589,6 @@ export class Template extends BusinessObject {
1502
1589
  uri,
1503
1590
  externalId
1504
1591
  );
1505
-
1506
- this.metadata = metadata;
1507
1592
  }
1508
1593
  }
1509
1594
  //// FOR DOCUMENTS END
@@ -1527,24 +1612,48 @@ export enum FieldVariation {
1527
1612
  Url = 'url',
1528
1613
  }
1529
1614
 
1615
+ export const OptionQL = `
1616
+ type Option {
1617
+ label: String!
1618
+ value: String!
1619
+ }`;
1530
1620
  export interface Option {
1531
1621
  label: string;
1532
1622
  value: string;
1533
1623
  }
1534
1624
 
1625
+ export const FieldQL = `
1626
+ type Field {
1627
+ label: String!
1628
+ name: String!
1629
+ description: String!
1630
+ monitor: Boolean!
1631
+ fieldType: String!
1632
+ fieldVariation: String
1633
+ maximumCharacters: Int
1634
+ readOnly: Boolean!
1635
+ options: [Option]
1636
+ }`;
1535
1637
  export interface Field {
1536
- label?: string;
1638
+ label: string;
1537
1639
  name: string;
1538
1640
  description: string;
1539
- doMonitor: boolean;
1641
+ monitor: boolean;
1540
1642
  fieldType: FieldType;
1541
1643
  fieldVariation?: FieldVariation;
1542
- order: number;
1543
1644
  maximumCharacters?: number;
1544
- isReadOnly: boolean;
1645
+ readOnly: boolean;
1545
1646
  options?: Option[];
1546
1647
  }
1547
1648
 
1649
+ export const FieldValueQL = `
1650
+ type FieldValue {
1651
+ name: String!
1652
+ previousValue: String!
1653
+ nextValue: String!
1654
+ value: String!
1655
+ changed: Boolean!
1656
+ }`;
1548
1657
  export interface FieldValue {
1549
1658
  name: string;
1550
1659
  previousValue: string;
@@ -1553,17 +1662,33 @@ export interface FieldValue {
1553
1662
  changed: boolean;
1554
1663
  }
1555
1664
 
1556
- export interface TableMetadata {
1557
- label: string;
1558
- name: string;
1559
- description: string;
1665
+ export const TableMetadataQL = `
1666
+ type TableMetadata {${MetadataFields}
1667
+ fields: [Field]!
1668
+ }`;
1669
+ export class TableMetadata extends Metadata {
1560
1670
  fields: Field[];
1671
+
1672
+ constructor(
1673
+ name: string,
1674
+ label: string,
1675
+ description: string,
1676
+ fields: Field[]
1677
+ ) {
1678
+ super(name, label, description);
1679
+
1680
+ this.fields = fields;
1681
+ }
1561
1682
  }
1562
1683
 
1563
- export class Table extends BusinessObject {
1564
- recordType: string;
1565
- metadata: TableMetadata;
1684
+ export const TableQL = `
1685
+ type Table {${MetadataBusinessObjectFields}
1686
+ values: [FieldValue]!
1687
+ metadata: TableMetadata
1688
+ }`;
1689
+ export class Table extends MetadataBusinessObject {
1566
1690
  values: FieldValue[];
1691
+ metadata?: TableMetadata;
1567
1692
 
1568
1693
  constructor(
1569
1694
  tenantIdCreated: string,
@@ -1574,8 +1699,6 @@ export class Table extends BusinessObject {
1574
1699
  application: string,
1575
1700
  uri: string,
1576
1701
  externalId: string,
1577
- recordType: string,
1578
- metadata: TableMetadata,
1579
1702
  values: FieldValue[]
1580
1703
  ) {
1581
1704
  super(
@@ -1590,8 +1713,6 @@ export class Table extends BusinessObject {
1590
1713
  externalId
1591
1714
  );
1592
1715
 
1593
- this.recordType = recordType;
1594
- this.metadata = metadata;
1595
1716
  this.values = values;
1596
1717
  }
1597
1718
  }
@@ -2064,6 +2185,16 @@ ${ConferenceQL}
2064
2185
  ${PersonAcceptanceQL}
2065
2186
  ${EventQL}
2066
2187
  ${CalendarQL}
2188
+ ${DocumentQL}
2189
+ ${WebsiteQL}
2190
+ ${BlockDescriptionQL}
2191
+ ${DocumentMetadataQL}
2192
+ ${TemplateQL}
2193
+ ${OptionQL}
2194
+ ${FieldQL}
2195
+ ${FieldValueQL}
2196
+ ${TableMetadataQL}
2197
+ ${TableQL}
2067
2198
  ${FindArticleInputQL}
2068
2199
  ${FindArticlesInputQL}
2069
2200
  ${FindCalendarInputQL}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "author": "Bigfoot",
3
3
  "name": "@bigfootai/bigfoot-types",
4
- "version": "4.3.9",
4
+ "version": "4.4.1",
5
5
  "description": "The internal library for the types used in the Bigfoot platform",
6
6
  "main": "model.js",
7
7
  "license": "ISC",