@bigfootai/bigfoot-types 4.9.15 → 4.9.16

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.
@@ -13,9 +13,16 @@ exports.AccountOverview = {
13
13
  {
14
14
  name: 'summary',
15
15
  title: 'Exec Summary',
16
- description: 'A short summary about the account',
16
+ description: 'Write short summary about the topic or topics provided. Keep the response to 3 to 5 sentences. Focus on key milestones, issues and opportunities.',
17
17
  blockType: model_1.BlockType.Section,
18
18
  },
19
+ {
20
+ name: 'overview',
21
+ title: 'Overview',
22
+ description: 'The data below represents key metrics that we evaluate our customers using.',
23
+ metadataType: 'organization',
24
+ blockType: model_1.BlockType.Record,
25
+ },
19
26
  {
20
27
  name: 'opportunities',
21
28
  title: 'Opportunities',
@@ -1,6 +1,6 @@
1
- import { BlockType, DocumentMetadata } from '../../model';
1
+ import { BlockType, DashboardMetadata } from '../../model';
2
2
 
3
- export const AccountOverview: DocumentMetadata = {
3
+ export const AccountOverview: DashboardMetadata = {
4
4
  _id: '',
5
5
  dateCreated: 0,
6
6
  dateUpdated: 0,
@@ -12,9 +12,18 @@ export const AccountOverview: DocumentMetadata = {
12
12
  {
13
13
  name: 'summary',
14
14
  title: 'Exec Summary',
15
- description: 'A short summary about the account',
15
+ description:
16
+ 'Write short summary about the topic or topics provided. Keep the response to 3 to 5 sentences. Focus on key milestones, issues and opportunities.',
16
17
  blockType: BlockType.Section,
17
18
  },
19
+ {
20
+ name: 'overview',
21
+ title: 'Overview',
22
+ description:
23
+ 'The data below represents key metrics that we evaluate our customers using.',
24
+ metadataType: 'organization',
25
+ blockType: BlockType.Record,
26
+ },
18
27
  {
19
28
  name: 'opportunities',
20
29
  title: 'Opportunities',
@@ -0,0 +1,75 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Organization = void 0;
4
+ const model_1 = require("../../model");
5
+ exports.Organization = {
6
+ _id: '',
7
+ dateCreated: 0,
8
+ dateUpdated: 0,
9
+ label: 'Organization',
10
+ description: 'Represents an organization, which is a company we are working with.',
11
+ metadataType: 'organization',
12
+ references: [
13
+ 'https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_account.htm',
14
+ ],
15
+ fields: [
16
+ {
17
+ label: 'Annual Recurring Revenue (ARR)',
18
+ name: 'ARR',
19
+ description: 'The annual recurring revenue for this organization.',
20
+ fieldType: model_1.FieldType.Text,
21
+ fieldVariation: model_1.FieldVariation.Currency,
22
+ readOnly: false,
23
+ important: true,
24
+ status: false,
25
+ },
26
+ {
27
+ label: 'Status',
28
+ name: 'Status',
29
+ description: 'The status/sentiment of the organizations relationship. This can be red (bad/negative), yellow (ok/neutral), or green (good/positive)',
30
+ fieldType: model_1.FieldType.Select,
31
+ options: [
32
+ {
33
+ label: 'Green',
34
+ value: 'Green',
35
+ },
36
+ {
37
+ label: 'Yellow',
38
+ value: 'Yellow',
39
+ },
40
+ {
41
+ label: 'Red',
42
+ value: 'Red',
43
+ },
44
+ ],
45
+ readOnly: false,
46
+ important: true,
47
+ status: false,
48
+ },
49
+ {
50
+ label: 'Stage',
51
+ name: 'StageName',
52
+ description: 'An indication of what customer lifecycle stage this organization is at. This can be expansion (they are interested in working with us more), sustain (they are OK, but unlikely to purchase more), risk (they are at risk of no longer using our product or service).',
53
+ fieldType: model_1.FieldType.Select,
54
+ readOnly: false,
55
+ options: [
56
+ {
57
+ label: 'Expansion',
58
+ value: 'Expansion',
59
+ },
60
+ {
61
+ label: 'Sustain',
62
+ value: 'Sustain',
63
+ },
64
+ {
65
+ label: 'Risk',
66
+ value: 'Risk',
67
+ },
68
+ ],
69
+ important: true,
70
+ status: true,
71
+ },
72
+ ],
73
+ classifiers: [],
74
+ threshold: 0,
75
+ };
@@ -0,0 +1,76 @@
1
+ import { FieldType, FieldVariation, TableMetadata } from '../../model';
2
+
3
+ export const Organization: TableMetadata = {
4
+ _id: '',
5
+ dateCreated: 0,
6
+ dateUpdated: 0,
7
+ label: 'Organization',
8
+ description:
9
+ 'Represents an organization, which is a company we are working with.',
10
+ metadataType: 'organization',
11
+ references: [
12
+ 'https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_account.htm',
13
+ ],
14
+ fields: [
15
+ {
16
+ label: 'Annual Recurring Revenue (ARR)',
17
+ name: 'ARR',
18
+ description: 'The annual recurring revenue for this organization.',
19
+ fieldType: FieldType.Text,
20
+ fieldVariation: FieldVariation.Currency,
21
+ readOnly: false,
22
+ important: true,
23
+ status: false,
24
+ },
25
+ {
26
+ label: 'Status',
27
+ name: 'Status',
28
+ description:
29
+ 'The status/sentiment of the organizations relationship. This can be red (bad/negative), yellow (ok/neutral), or green (good/positive)',
30
+ fieldType: FieldType.Select,
31
+ options: [
32
+ {
33
+ label: 'Green',
34
+ value: 'Green',
35
+ },
36
+ {
37
+ label: 'Yellow',
38
+ value: 'Yellow',
39
+ },
40
+ {
41
+ label: 'Red',
42
+ value: 'Red',
43
+ },
44
+ ],
45
+ readOnly: false,
46
+ important: true,
47
+ status: false,
48
+ },
49
+ {
50
+ label: 'Stage',
51
+ name: 'StageName',
52
+ description:
53
+ 'An indication of what customer lifecycle stage this organization is at. This can be expansion (they are interested in working with us more), sustain (they are OK, but unlikely to purchase more), risk (they are at risk of no longer using our product or service).',
54
+ fieldType: FieldType.Select,
55
+ readOnly: false,
56
+ options: [
57
+ {
58
+ label: 'Expansion',
59
+ value: 'Expansion',
60
+ },
61
+ {
62
+ label: 'Sustain',
63
+ value: 'Sustain',
64
+ },
65
+ {
66
+ label: 'Risk',
67
+ value: 'Risk',
68
+ },
69
+ ],
70
+ important: true,
71
+ status: true,
72
+ },
73
+ ],
74
+ classifiers: [],
75
+ threshold: 0,
76
+ };
package/model.ts CHANGED
@@ -2226,6 +2226,8 @@ export class Record extends BusinessObject {
2226
2226
  enabled: boolean;
2227
2227
  processingStage?: ProcessingStage;
2228
2228
  processingReason?: string;
2229
+ dashboardId?: string;
2230
+ blockDescriptionName?: string;
2229
2231
 
2230
2232
  constructor(
2231
2233
  tenantIdCreated: string,
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "author": "Bigfoot",
3
3
  "name": "@bigfootai/bigfoot-types",
4
- "version": "4.9.15",
4
+ "version": "4.9.16",
5
5
  "description": "The internal library for the types used in the Bigfoot platform",
6
6
  "main": "model.js",
7
7
  "license": "ISC",