@bigfootai/bigfoot-types 2.10.2 → 2.10.4

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 +16 -19
  2. package/model.ts +20 -81
  3. package/package.json +1 -1
package/model.js CHANGED
@@ -23,7 +23,7 @@ var BusinessObjectType;
23
23
  })(BusinessObjectType || (exports.BusinessObjectType = BusinessObjectType = {}));
24
24
  var BlockType;
25
25
  (function (BlockType) {
26
- BlockType["Note"] = "section";
26
+ BlockType["Note"] = "note";
27
27
  BlockType["Section"] = "section";
28
28
  BlockType["Task"] = "task";
29
29
  BlockType["Data"] = "data";
@@ -216,16 +216,13 @@ class Tag extends Primitive {
216
216
  }
217
217
  exports.Tag = Tag;
218
218
  class BusinessObject extends Primitive {
219
- constructor(provider, uri, externalId, businessObjectType, externalResponse) {
219
+ constructor(provider, application, uri) {
220
220
  super();
221
221
  this.processingStage = ProcessingStage.NotProcessed;
222
222
  this.processingAttempts = 0;
223
223
  this.dateProcessed = 0;
224
224
  this.provider = provider;
225
225
  this.uri = uri;
226
- this.externalId = externalId;
227
- this.businessObjectType = businessObjectType;
228
- this.externalResponse = externalResponse;
229
226
  }
230
227
  }
231
228
  exports.BusinessObject = BusinessObject;
@@ -290,8 +287,8 @@ class Task extends Block {
290
287
  }
291
288
  exports.Task = Task;
292
289
  class Conference extends BusinessObject {
293
- constructor(provider, uri, externalId, externalResponse, entryPoints) {
294
- super(provider, uri, externalId, BusinessObjectType.Conference, externalResponse);
290
+ constructor(provider, application, uri, entryPoints) {
291
+ super(provider, application, uri);
295
292
  this.entryPoints = entryPoints;
296
293
  }
297
294
  }
@@ -312,15 +309,15 @@ var ResponseStatus;
312
309
  ResponseStatus["Accepted"] = "accepted";
313
310
  })(ResponseStatus || (exports.ResponseStatus = ResponseStatus = {}));
314
311
  class Calendar extends BusinessObject {
315
- constructor(provider, uri, externalId, externalResponse, timeZone) {
316
- super(provider, uri, externalId, BusinessObjectType.Calendar, externalResponse);
312
+ constructor(provider, application, uri, timeZone) {
313
+ super(provider, application, uri);
317
314
  this.timeZone = timeZone;
318
315
  }
319
316
  }
320
317
  exports.Calendar = Calendar;
321
318
  class Event extends BusinessObject {
322
- constructor(provider, uri, externalId, externalResponse, calendarId, status, dateStart, organizedBy) {
323
- super(provider, uri, externalId, BusinessObjectType.Event, externalResponse);
319
+ constructor(provider, application, uri, calendarId, status, dateStart, organizedBy) {
320
+ super(provider, application, uri);
324
321
  this.calendarId = calendarId;
325
322
  this.status = status;
326
323
  this.dateStart = dateStart;
@@ -331,8 +328,8 @@ exports.Event = Event;
331
328
  //// EVENT END
332
329
  //// EXTERNAL TASK START
333
330
  class ExternalTask extends BusinessObject {
334
- constructor(provider, uri, externalId, externalResponse, status, dateDue) {
335
- super(provider, uri, externalId, BusinessObjectType.Task, externalResponse);
331
+ constructor(provider, application, uri, status, dateDue) {
332
+ super(provider, application, uri);
336
333
  this.status = status;
337
334
  this.dateDue = dateDue;
338
335
  }
@@ -341,14 +338,14 @@ exports.ExternalTask = ExternalTask;
341
338
  //// EXTERNAL TASK END
342
339
  //// MESSAGING START
343
340
  class Thread extends BusinessObject {
344
- constructor(provider, uri, externalId, externalResponse) {
345
- super(provider, uri, externalId, BusinessObjectType.Thread, externalResponse);
341
+ constructor(provider, application, uri) {
342
+ super(provider, application, uri);
346
343
  }
347
344
  }
348
345
  exports.Thread = Thread;
349
346
  class Template extends BusinessObject {
350
- constructor(provider, uri, externalId, externalResponse, metadata) {
351
- super(provider, uri, externalId, BusinessObjectType.Template, externalResponse);
347
+ constructor(provider, application, uri, metadata) {
348
+ super(provider, application, uri);
352
349
  this.metadata = metadata;
353
350
  }
354
351
  }
@@ -374,8 +371,8 @@ var FieldVariation;
374
371
  FieldVariation["Url"] = "url";
375
372
  })(FieldVariation || (exports.FieldVariation = FieldVariation = {}));
376
373
  class Table extends BusinessObject {
377
- constructor(provider, uri, externalId, externalResponse, recordType, metadata, values) {
378
- super(provider, uri, externalId, BusinessObjectType.Table, externalResponse);
374
+ constructor(provider, application, uri, recordType, metadata, values) {
375
+ super(provider, application, uri);
379
376
  this.recordType = recordType;
380
377
  this.metadata = metadata;
381
378
  this.values = values;
package/model.ts CHANGED
@@ -401,25 +401,20 @@ export class Tag extends Primitive {
401
401
  }
402
402
 
403
403
  export class BusinessObject extends Primitive {
404
- provider: string; // A unique string representing the provider e.g. "salesforce", "jira", etc
404
+ provider: string; // A unique string representing the provider e.g. "salesforce", "atlassian", etc
405
+ application: string; // A unique string representing the provider application e.g. "service", "jira", etc
405
406
  uri: string; // A uri to locate the specific instance of the business object
406
- externalId: string; // An identifier that allows us to do entity resolution
407
- businessObjectType: BusinessObjectType;
408
- externalResponse: any; // The full response from the external system that created this object
409
407
  processingStage: ProcessingStage; // Indicates if the business object has been processed yet
410
408
  processingAttempts: number; // Indicates the number of attempts made to process this business object
411
409
  dateProcessed: number; // The date this document was last processed
410
+ externalId?: string; // An identifier that allows us to do entity resolution
411
+ businessObjectType?: BusinessObjectType;
412
+ externalResponse?: any; // The full response from the external system that created this object
412
413
  iconUrl?: string | null; // The url of an icon that represents the business object
413
414
  document?: any | null; // The business object formatted as a document for ML to ingest
414
415
  parentId?: string | null; // The business object that is the parent of this business object
415
416
 
416
- constructor(
417
- provider: string,
418
- uri: string,
419
- externalId: string,
420
- businessObjectType: BusinessObjectType,
421
- externalResponse: any
422
- ) {
417
+ constructor(provider: string, application: string, uri: string) {
423
418
  super();
424
419
 
425
420
  this.processingStage = ProcessingStage.NotProcessed;
@@ -428,9 +423,6 @@ export class BusinessObject extends Primitive {
428
423
 
429
424
  this.provider = provider;
430
425
  this.uri = uri;
431
- this.externalId = externalId;
432
- this.businessObjectType = businessObjectType;
433
- this.externalResponse = externalResponse;
434
426
  }
435
427
  }
436
428
 
@@ -615,18 +607,11 @@ export class Conference extends BusinessObject {
615
607
 
616
608
  constructor(
617
609
  provider: string,
610
+ application: string,
618
611
  uri: string,
619
- externalId: string,
620
- externalResponse: any,
621
612
  entryPoints: ConferenceEntrypoint[]
622
613
  ) {
623
- super(
624
- provider,
625
- uri,
626
- externalId,
627
- BusinessObjectType.Conference,
628
- externalResponse
629
- );
614
+ super(provider, application, uri);
630
615
 
631
616
  this.entryPoints = entryPoints;
632
617
  }
@@ -678,18 +663,11 @@ export class Calendar extends BusinessObject {
678
663
 
679
664
  constructor(
680
665
  provider: string,
666
+ application: string,
681
667
  uri: string,
682
- externalId: string,
683
- externalResponse: any,
684
668
  timeZone: string
685
669
  ) {
686
- super(
687
- provider,
688
- uri,
689
- externalId,
690
- BusinessObjectType.Calendar,
691
- externalResponse
692
- );
670
+ super(provider, application, uri);
693
671
 
694
672
  this.timeZone = timeZone;
695
673
  }
@@ -712,21 +690,14 @@ export class Event extends BusinessObject {
712
690
 
713
691
  constructor(
714
692
  provider: string,
693
+ application: string,
715
694
  uri: string,
716
- externalId: string,
717
- externalResponse: any,
718
695
  calendarId: string,
719
696
  status: EventStatus,
720
697
  dateStart: number,
721
698
  organizedBy: PersonReference
722
699
  ) {
723
- super(
724
- provider,
725
- uri,
726
- externalId,
727
- BusinessObjectType.Event,
728
- externalResponse
729
- );
700
+ super(provider, application, uri);
730
701
 
731
702
  this.calendarId = calendarId;
732
703
  this.status = status;
@@ -746,19 +717,12 @@ export class ExternalTask extends BusinessObject {
746
717
 
747
718
  constructor(
748
719
  provider: string,
720
+ application: string,
749
721
  uri: string,
750
- externalId: string,
751
- externalResponse: any,
752
722
  status: TaskStatus,
753
723
  dateDue: number
754
724
  ) {
755
- super(
756
- provider,
757
- uri,
758
- externalId,
759
- BusinessObjectType.Task,
760
- externalResponse
761
- );
725
+ super(provider, application, uri);
762
726
 
763
727
  this.status = status;
764
728
  this.dateDue = dateDue;
@@ -768,19 +732,8 @@ export class ExternalTask extends BusinessObject {
768
732
 
769
733
  //// MESSAGING START
770
734
  export class Thread extends BusinessObject {
771
- constructor(
772
- provider: string,
773
- uri: string,
774
- externalId: string,
775
- externalResponse: any
776
- ) {
777
- super(
778
- provider,
779
- uri,
780
- externalId,
781
- BusinessObjectType.Thread,
782
- externalResponse
783
- );
735
+ constructor(provider: string, application: string, uri: string) {
736
+ super(provider, application, uri);
784
737
  }
785
738
  }
786
739
  //// MESSAGING END
@@ -810,18 +763,11 @@ export class Template extends BusinessObject {
810
763
 
811
764
  constructor(
812
765
  provider: string,
766
+ application: string,
813
767
  uri: string,
814
- externalId: string,
815
- externalResponse: any,
816
768
  metadata: DocumentMetadata
817
769
  ) {
818
- super(
819
- provider,
820
- uri,
821
- externalId,
822
- BusinessObjectType.Template,
823
- externalResponse
824
- );
770
+ super(provider, application, uri);
825
771
 
826
772
  this.metadata = metadata;
827
773
  }
@@ -887,20 +833,13 @@ export class Table extends BusinessObject {
887
833
 
888
834
  constructor(
889
835
  provider: string,
836
+ application: string,
890
837
  uri: string,
891
- externalId: string,
892
- externalResponse: any,
893
838
  recordType: string,
894
839
  metadata: TableMetadata,
895
840
  values: FieldValue[]
896
841
  ) {
897
- super(
898
- provider,
899
- uri,
900
- externalId,
901
- BusinessObjectType.Table,
902
- externalResponse
903
- );
842
+ super(provider, application, uri);
904
843
 
905
844
  this.recordType = recordType;
906
845
  this.metadata = metadata;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "author": "Bigfoot",
3
3
  "name": "@bigfootai/bigfoot-types",
4
- "version": "2.10.2",
4
+ "version": "2.10.4",
5
5
  "description": "The internal library for the types used in the Bigfoot platform",
6
6
  "main": "model.js",
7
7
  "license": "ISC",