@sprucelabs/spruce-core-schemas 41.2.1 → 41.3.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.
- package/build/.spruce/schemas/core.schemas.types.d.ts +379 -310
- package/build/.spruce/schemas/spruce/v2020_07_22/agent.schema.d.ts +3 -0
- package/build/.spruce/schemas/spruce/v2020_07_22/agent.schema.js +41 -0
- package/build/.spruce/schemas/spruce/v2020_07_22/agentSource.schema.d.ts +3 -0
- package/build/.spruce/schemas/spruce/v2020_07_22/agentSource.schema.js +24 -0
- package/build/esm/.spruce/schemas/core.schemas.types.d.ts +379 -310
- package/build/esm/schemas/v2020_07_22/agent.builder.d.ts +35 -0
- package/build/esm/schemas/v2020_07_22/agent.builder.js +35 -0
- package/build/schemas/v2020_07_22/agent.builder.d.ts +35 -0
- package/build/schemas/v2020_07_22/agent.builder.js +37 -0
- package/package.json +3 -2
|
@@ -133,6 +133,146 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
|
133
133
|
}
|
|
134
134
|
type SkillEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.SkillSchema>;
|
|
135
135
|
}
|
|
136
|
+
export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
137
|
+
interface SendMessage {
|
|
138
|
+
/** . An arbitrary id that can be used to track this message when being sent and not yet assigned an Id. */
|
|
139
|
+
'trackingId'?: string | undefined | null;
|
|
140
|
+
/** . If this message is a reply to another message, this is the id of that original message. */
|
|
141
|
+
'inReplyToMessageId'?: string | undefined | null;
|
|
142
|
+
'dateSent'?: number | undefined | null;
|
|
143
|
+
'target': SpruceSchemas.Spruce.v2020_07_22.MessageTarget;
|
|
144
|
+
'errors'?: string[] | undefined | null;
|
|
145
|
+
'classification': ("auth" | "transactional" | "promotional" | "incoming");
|
|
146
|
+
'status'?: ("pending" | "processing" | "sent" | "failed" | "ignored") | undefined | null;
|
|
147
|
+
'body': string;
|
|
148
|
+
'context'?: (Record<string, any>) | undefined | null;
|
|
149
|
+
'topicId'?: string | undefined | null;
|
|
150
|
+
'links'?: SpruceSchemas.Spruce.v2020_07_22.Link[] | undefined | null;
|
|
151
|
+
'choices'?: SpruceSchemas.Spruce.v2020_07_22.Choice[] | undefined | null;
|
|
152
|
+
}
|
|
153
|
+
interface SendMessageSchema extends SpruceSchema.Schema {
|
|
154
|
+
id: 'sendMessage';
|
|
155
|
+
version: 'v2020_07_22';
|
|
156
|
+
namespace: 'Spruce';
|
|
157
|
+
name: '';
|
|
158
|
+
moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas';
|
|
159
|
+
fields: {
|
|
160
|
+
/** . An arbitrary id that can be used to track this message when being sent and not yet assigned an Id. */
|
|
161
|
+
'trackingId': {
|
|
162
|
+
type: 'id';
|
|
163
|
+
hint: 'An arbitrary id that can be used to track this message when being sent and not yet assigned an Id.';
|
|
164
|
+
options: undefined;
|
|
165
|
+
};
|
|
166
|
+
/** . If this message is a reply to another message, this is the id of that original message. */
|
|
167
|
+
'inReplyToMessageId': {
|
|
168
|
+
type: 'id';
|
|
169
|
+
hint: 'If this message is a reply to another message, this is the id of that original message.';
|
|
170
|
+
options: undefined;
|
|
171
|
+
};
|
|
172
|
+
/** . */
|
|
173
|
+
'dateSent': {
|
|
174
|
+
type: 'number';
|
|
175
|
+
options: undefined;
|
|
176
|
+
};
|
|
177
|
+
/** . */
|
|
178
|
+
'target': {
|
|
179
|
+
type: 'schema';
|
|
180
|
+
isRequired: true;
|
|
181
|
+
options: {
|
|
182
|
+
schema: SpruceSchemas.Spruce.v2020_07_22.MessageTargetSchema;
|
|
183
|
+
};
|
|
184
|
+
};
|
|
185
|
+
/** . */
|
|
186
|
+
'errors': {
|
|
187
|
+
type: 'text';
|
|
188
|
+
isPrivate: true;
|
|
189
|
+
isArray: true;
|
|
190
|
+
options: undefined;
|
|
191
|
+
};
|
|
192
|
+
/** . */
|
|
193
|
+
'classification': {
|
|
194
|
+
type: 'select';
|
|
195
|
+
isRequired: true;
|
|
196
|
+
options: {
|
|
197
|
+
choices: [{
|
|
198
|
+
"value": "auth";
|
|
199
|
+
"label": "Auth";
|
|
200
|
+
}, {
|
|
201
|
+
"value": "transactional";
|
|
202
|
+
"label": "transactional";
|
|
203
|
+
}, {
|
|
204
|
+
"value": "promotional";
|
|
205
|
+
"label": "Promotional";
|
|
206
|
+
}, {
|
|
207
|
+
"value": "incoming";
|
|
208
|
+
"label": "incoming";
|
|
209
|
+
}];
|
|
210
|
+
};
|
|
211
|
+
};
|
|
212
|
+
/** . */
|
|
213
|
+
'status': {
|
|
214
|
+
type: 'select';
|
|
215
|
+
isPrivate: true;
|
|
216
|
+
defaultValue: "pending";
|
|
217
|
+
options: {
|
|
218
|
+
choices: [{
|
|
219
|
+
"value": "pending";
|
|
220
|
+
"label": "Pending";
|
|
221
|
+
}, {
|
|
222
|
+
"value": "processing";
|
|
223
|
+
"label": "Processing";
|
|
224
|
+
}, {
|
|
225
|
+
"value": "sent";
|
|
226
|
+
"label": "Sent";
|
|
227
|
+
}, {
|
|
228
|
+
"value": "failed";
|
|
229
|
+
"label": "Failed";
|
|
230
|
+
}, {
|
|
231
|
+
"value": "ignored";
|
|
232
|
+
"label": "Ignored";
|
|
233
|
+
}];
|
|
234
|
+
};
|
|
235
|
+
};
|
|
236
|
+
/** . */
|
|
237
|
+
'body': {
|
|
238
|
+
type: 'text';
|
|
239
|
+
isRequired: true;
|
|
240
|
+
options: undefined;
|
|
241
|
+
};
|
|
242
|
+
/** . */
|
|
243
|
+
'context': {
|
|
244
|
+
type: 'raw';
|
|
245
|
+
isPrivate: true;
|
|
246
|
+
options: {
|
|
247
|
+
valueType: `Record<string, any>`;
|
|
248
|
+
};
|
|
249
|
+
};
|
|
250
|
+
/** . */
|
|
251
|
+
'topicId': {
|
|
252
|
+
type: 'id';
|
|
253
|
+
options: undefined;
|
|
254
|
+
};
|
|
255
|
+
/** . */
|
|
256
|
+
'links': {
|
|
257
|
+
type: 'schema';
|
|
258
|
+
isArray: true;
|
|
259
|
+
minArrayLength: 0;
|
|
260
|
+
options: {
|
|
261
|
+
schema: SpruceSchemas.Spruce.v2020_07_22.LinkSchema;
|
|
262
|
+
};
|
|
263
|
+
};
|
|
264
|
+
/** . */
|
|
265
|
+
'choices': {
|
|
266
|
+
type: 'schema';
|
|
267
|
+
isArray: true;
|
|
268
|
+
options: {
|
|
269
|
+
schema: SpruceSchemas.Spruce.v2020_07_22.ChoiceSchema;
|
|
270
|
+
};
|
|
271
|
+
};
|
|
272
|
+
};
|
|
273
|
+
}
|
|
274
|
+
type SendMessageEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.SendMessageSchema>;
|
|
275
|
+
}
|
|
136
276
|
export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
137
277
|
/** Every role in Spruce inherits from 5 bases. Anon, Logged in (person not associated with any org), Org Owner, Group Manager, Manager, Teammate, and Guest. */
|
|
138
278
|
interface Role {
|
|
@@ -744,249 +884,84 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
|
744
884
|
type MessageTargetEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.MessageTargetSchema>;
|
|
745
885
|
}
|
|
746
886
|
export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
747
|
-
/** A
|
|
748
|
-
interface
|
|
887
|
+
/** A physical location where people meet. An organization has at least one of them. */
|
|
888
|
+
interface Location {
|
|
889
|
+
/** Id. */
|
|
749
890
|
'id': string;
|
|
750
|
-
/** .
|
|
751
|
-
'
|
|
752
|
-
/** .
|
|
753
|
-
'
|
|
754
|
-
|
|
755
|
-
'
|
|
756
|
-
|
|
757
|
-
'
|
|
758
|
-
|
|
759
|
-
'
|
|
760
|
-
|
|
761
|
-
'
|
|
762
|
-
|
|
763
|
-
'
|
|
764
|
-
|
|
765
|
-
'
|
|
891
|
+
/** Name. */
|
|
892
|
+
'name': string;
|
|
893
|
+
/** Location number. You can use other symbols, like # or dashes. #123 or 32-US-5 */
|
|
894
|
+
'num'?: string | undefined | null;
|
|
895
|
+
/** Slug. */
|
|
896
|
+
'slug': string;
|
|
897
|
+
/** Public. Is this location viewable by guests? */
|
|
898
|
+
'isPublic'?: boolean | undefined | null;
|
|
899
|
+
/** Main Phone. */
|
|
900
|
+
'phone'?: string | undefined | null;
|
|
901
|
+
/** Timezone. */
|
|
902
|
+
'timezone'?: ("UTC" | "Pacific/Honolulu" | "America/Anchorage" | "America/Los_Angeles" | "America/Denver" | "America/Phoenix" | "America/Chicago" | "America/Guatemala" | "America/New_York" | "America/Panama" | "America/Sao_Paulo" | "America/Argentina/Buenos_Aires" | "Europe/London" | "Europe/Berlin" | "Europe/Athens" | "Europe/Moscow" | "Africa/Lagos" | "Africa/Cairo" | "Africa/Johannesburg" | "Asia/Dubai" | "Asia/Karachi" | "Asia/Kolkata" | "Asia/Shanghai" | "Asia/Tokyo" | "Asia/Seoul" | "Australia/Perth" | "Australia/Adelaide" | "Australia/Sydney" | "Pacific/Auckland" | "Pacific/Port_Moresby") | undefined | null;
|
|
903
|
+
/** Address. */
|
|
904
|
+
'address'?: SpruceSchema.AddressFieldValue | undefined | null;
|
|
905
|
+
/** Virtual. Is this a virtual location? */
|
|
906
|
+
'isVirtual'?: boolean | undefined | null;
|
|
907
|
+
'dateCreated': SpruceSchema.DateTimeFieldValue;
|
|
908
|
+
'dateDeleted'?: SpruceSchema.DateTimeFieldValue | undefined | null;
|
|
909
|
+
'dateUpdated'?: SpruceSchema.DateTimeFieldValue | undefined | null;
|
|
910
|
+
'organizationId': string;
|
|
766
911
|
}
|
|
767
|
-
interface
|
|
768
|
-
id: '
|
|
912
|
+
interface LocationSchema extends SpruceSchema.Schema {
|
|
913
|
+
id: 'location';
|
|
769
914
|
version: 'v2020_07_22';
|
|
770
915
|
namespace: 'Spruce';
|
|
771
|
-
name: '';
|
|
916
|
+
name: 'Location';
|
|
772
917
|
moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas';
|
|
773
|
-
description: 'A
|
|
918
|
+
description: 'A physical location where people meet. An organization has at least one of them.';
|
|
774
919
|
fields: {
|
|
775
|
-
/** . */
|
|
920
|
+
/** Id. */
|
|
776
921
|
'id': {
|
|
922
|
+
label: 'Id';
|
|
777
923
|
type: 'id';
|
|
778
924
|
isRequired: true;
|
|
779
925
|
options: undefined;
|
|
780
926
|
};
|
|
781
|
-
/** .
|
|
782
|
-
'
|
|
783
|
-
|
|
784
|
-
|
|
927
|
+
/** Name. */
|
|
928
|
+
'name': {
|
|
929
|
+
label: 'Name';
|
|
930
|
+
type: 'text';
|
|
931
|
+
isRequired: true;
|
|
785
932
|
options: undefined;
|
|
786
933
|
};
|
|
787
|
-
/** .
|
|
788
|
-
'
|
|
789
|
-
|
|
790
|
-
|
|
934
|
+
/** Location number. You can use other symbols, like # or dashes. #123 or 32-US-5 */
|
|
935
|
+
'num': {
|
|
936
|
+
label: 'Location number';
|
|
937
|
+
type: 'text';
|
|
938
|
+
hint: 'You can use other symbols, like # or dashes. #123 or 32-US-5';
|
|
791
939
|
options: undefined;
|
|
792
940
|
};
|
|
793
|
-
/** . */
|
|
794
|
-
'
|
|
795
|
-
|
|
941
|
+
/** Slug. */
|
|
942
|
+
'slug': {
|
|
943
|
+
label: 'Slug';
|
|
944
|
+
type: 'text';
|
|
796
945
|
isRequired: true;
|
|
797
946
|
options: undefined;
|
|
798
947
|
};
|
|
799
|
-
/** . */
|
|
800
|
-
'
|
|
801
|
-
|
|
948
|
+
/** Public. Is this location viewable by guests? */
|
|
949
|
+
'isPublic': {
|
|
950
|
+
label: 'Public';
|
|
951
|
+
type: 'boolean';
|
|
952
|
+
hint: 'Is this location viewable by guests?';
|
|
953
|
+
defaultValue: false;
|
|
802
954
|
options: undefined;
|
|
803
955
|
};
|
|
804
|
-
/** . */
|
|
805
|
-
'
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
options: {
|
|
809
|
-
schema: SpruceSchemas.Spruce.v2020_07_22.MessageTargetSchema;
|
|
810
|
-
};
|
|
811
|
-
};
|
|
812
|
-
/** . */
|
|
813
|
-
'source': {
|
|
814
|
-
type: 'schema';
|
|
815
|
-
isRequired: true;
|
|
816
|
-
options: {
|
|
817
|
-
schema: SpruceSchemas.Spruce.v2020_07_22.MessageSourceSchema;
|
|
818
|
-
};
|
|
819
|
-
};
|
|
820
|
-
/** . */
|
|
821
|
-
'errors': {
|
|
822
|
-
type: 'text';
|
|
823
|
-
isPrivate: true;
|
|
824
|
-
isArray: true;
|
|
956
|
+
/** Main Phone. */
|
|
957
|
+
'phone': {
|
|
958
|
+
label: 'Main Phone';
|
|
959
|
+
type: 'phone';
|
|
825
960
|
options: undefined;
|
|
826
961
|
};
|
|
827
|
-
/** . */
|
|
828
|
-
'
|
|
829
|
-
|
|
830
|
-
isRequired: true;
|
|
831
|
-
options: {
|
|
832
|
-
choices: [{
|
|
833
|
-
"value": "auth";
|
|
834
|
-
"label": "Auth";
|
|
835
|
-
}, {
|
|
836
|
-
"value": "transactional";
|
|
837
|
-
"label": "transactional";
|
|
838
|
-
}, {
|
|
839
|
-
"value": "promotional";
|
|
840
|
-
"label": "Promotional";
|
|
841
|
-
}, {
|
|
842
|
-
"value": "incoming";
|
|
843
|
-
"label": "incoming";
|
|
844
|
-
}];
|
|
845
|
-
};
|
|
846
|
-
};
|
|
847
|
-
/** . */
|
|
848
|
-
'status': {
|
|
849
|
-
type: 'select';
|
|
850
|
-
isPrivate: true;
|
|
851
|
-
defaultValue: "pending";
|
|
852
|
-
options: {
|
|
853
|
-
choices: [{
|
|
854
|
-
"value": "pending";
|
|
855
|
-
"label": "Pending";
|
|
856
|
-
}, {
|
|
857
|
-
"value": "processing";
|
|
858
|
-
"label": "Processing";
|
|
859
|
-
}, {
|
|
860
|
-
"value": "sent";
|
|
861
|
-
"label": "Sent";
|
|
862
|
-
}, {
|
|
863
|
-
"value": "failed";
|
|
864
|
-
"label": "Failed";
|
|
865
|
-
}, {
|
|
866
|
-
"value": "ignored";
|
|
867
|
-
"label": "Ignored";
|
|
868
|
-
}];
|
|
869
|
-
};
|
|
870
|
-
};
|
|
871
|
-
/** . */
|
|
872
|
-
'body': {
|
|
873
|
-
type: 'text';
|
|
874
|
-
isRequired: true;
|
|
875
|
-
options: undefined;
|
|
876
|
-
};
|
|
877
|
-
/** . */
|
|
878
|
-
'context': {
|
|
879
|
-
type: 'raw';
|
|
880
|
-
isPrivate: true;
|
|
881
|
-
options: {
|
|
882
|
-
valueType: `Record<string, any>`;
|
|
883
|
-
};
|
|
884
|
-
};
|
|
885
|
-
/** . */
|
|
886
|
-
'topicId': {
|
|
887
|
-
type: 'id';
|
|
888
|
-
options: undefined;
|
|
889
|
-
};
|
|
890
|
-
/** . */
|
|
891
|
-
'links': {
|
|
892
|
-
type: 'schema';
|
|
893
|
-
isArray: true;
|
|
894
|
-
minArrayLength: 0;
|
|
895
|
-
options: {
|
|
896
|
-
schema: SpruceSchemas.Spruce.v2020_07_22.LinkSchema;
|
|
897
|
-
};
|
|
898
|
-
};
|
|
899
|
-
/** . */
|
|
900
|
-
'choices': {
|
|
901
|
-
type: 'schema';
|
|
902
|
-
isArray: true;
|
|
903
|
-
options: {
|
|
904
|
-
schema: SpruceSchemas.Spruce.v2020_07_22.ChoiceSchema;
|
|
905
|
-
};
|
|
906
|
-
};
|
|
907
|
-
};
|
|
908
|
-
}
|
|
909
|
-
type MessageEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.MessageSchema>;
|
|
910
|
-
}
|
|
911
|
-
export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
912
|
-
/** A physical location where people meet. An organization has at least one of them. */
|
|
913
|
-
interface Location {
|
|
914
|
-
/** Id. */
|
|
915
|
-
'id': string;
|
|
916
|
-
/** Name. */
|
|
917
|
-
'name': string;
|
|
918
|
-
/** Location number. You can use other symbols, like # or dashes. #123 or 32-US-5 */
|
|
919
|
-
'num'?: string | undefined | null;
|
|
920
|
-
/** Slug. */
|
|
921
|
-
'slug': string;
|
|
922
|
-
/** Public. Is this location viewable by guests? */
|
|
923
|
-
'isPublic'?: boolean | undefined | null;
|
|
924
|
-
/** Main Phone. */
|
|
925
|
-
'phone'?: string | undefined | null;
|
|
926
|
-
/** Timezone. */
|
|
927
|
-
'timezone'?: ("UTC" | "Pacific/Honolulu" | "America/Anchorage" | "America/Los_Angeles" | "America/Denver" | "America/Phoenix" | "America/Chicago" | "America/Guatemala" | "America/New_York" | "America/Panama" | "America/Sao_Paulo" | "America/Argentina/Buenos_Aires" | "Europe/London" | "Europe/Berlin" | "Europe/Athens" | "Europe/Moscow" | "Africa/Lagos" | "Africa/Cairo" | "Africa/Johannesburg" | "Asia/Dubai" | "Asia/Karachi" | "Asia/Kolkata" | "Asia/Shanghai" | "Asia/Tokyo" | "Asia/Seoul" | "Australia/Perth" | "Australia/Adelaide" | "Australia/Sydney" | "Pacific/Auckland" | "Pacific/Port_Moresby") | undefined | null;
|
|
928
|
-
/** Address. */
|
|
929
|
-
'address'?: SpruceSchema.AddressFieldValue | undefined | null;
|
|
930
|
-
/** Virtual. Is this a virtual location? */
|
|
931
|
-
'isVirtual'?: boolean | undefined | null;
|
|
932
|
-
'dateCreated': SpruceSchema.DateTimeFieldValue;
|
|
933
|
-
'dateDeleted'?: SpruceSchema.DateTimeFieldValue | undefined | null;
|
|
934
|
-
'dateUpdated'?: SpruceSchema.DateTimeFieldValue | undefined | null;
|
|
935
|
-
'organizationId': string;
|
|
936
|
-
}
|
|
937
|
-
interface LocationSchema extends SpruceSchema.Schema {
|
|
938
|
-
id: 'location';
|
|
939
|
-
version: 'v2020_07_22';
|
|
940
|
-
namespace: 'Spruce';
|
|
941
|
-
name: 'Location';
|
|
942
|
-
moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas';
|
|
943
|
-
description: 'A physical location where people meet. An organization has at least one of them.';
|
|
944
|
-
fields: {
|
|
945
|
-
/** Id. */
|
|
946
|
-
'id': {
|
|
947
|
-
label: 'Id';
|
|
948
|
-
type: 'id';
|
|
949
|
-
isRequired: true;
|
|
950
|
-
options: undefined;
|
|
951
|
-
};
|
|
952
|
-
/** Name. */
|
|
953
|
-
'name': {
|
|
954
|
-
label: 'Name';
|
|
955
|
-
type: 'text';
|
|
956
|
-
isRequired: true;
|
|
957
|
-
options: undefined;
|
|
958
|
-
};
|
|
959
|
-
/** Location number. You can use other symbols, like # or dashes. #123 or 32-US-5 */
|
|
960
|
-
'num': {
|
|
961
|
-
label: 'Location number';
|
|
962
|
-
type: 'text';
|
|
963
|
-
hint: 'You can use other symbols, like # or dashes. #123 or 32-US-5';
|
|
964
|
-
options: undefined;
|
|
965
|
-
};
|
|
966
|
-
/** Slug. */
|
|
967
|
-
'slug': {
|
|
968
|
-
label: 'Slug';
|
|
969
|
-
type: 'text';
|
|
970
|
-
isRequired: true;
|
|
971
|
-
options: undefined;
|
|
972
|
-
};
|
|
973
|
-
/** Public. Is this location viewable by guests? */
|
|
974
|
-
'isPublic': {
|
|
975
|
-
label: 'Public';
|
|
976
|
-
type: 'boolean';
|
|
977
|
-
hint: 'Is this location viewable by guests?';
|
|
978
|
-
defaultValue: false;
|
|
979
|
-
options: undefined;
|
|
980
|
-
};
|
|
981
|
-
/** Main Phone. */
|
|
982
|
-
'phone': {
|
|
983
|
-
label: 'Main Phone';
|
|
984
|
-
type: 'phone';
|
|
985
|
-
options: undefined;
|
|
986
|
-
};
|
|
987
|
-
/** Timezone. */
|
|
988
|
-
'timezone': {
|
|
989
|
-
label: 'Timezone';
|
|
962
|
+
/** Timezone. */
|
|
963
|
+
'timezone': {
|
|
964
|
+
label: 'Timezone';
|
|
990
965
|
type: 'select';
|
|
991
966
|
options: {
|
|
992
967
|
choices: [{
|
|
@@ -1175,98 +1150,17 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
|
1175
1150
|
type LinkEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.LinkSchema>;
|
|
1176
1151
|
}
|
|
1177
1152
|
export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
'
|
|
1181
|
-
'avatar'?: SpruceSchema.ImageFieldValue | undefined | null;
|
|
1182
|
-
'skillId'?: string | undefined | null;
|
|
1183
|
-
'isMe': boolean;
|
|
1184
|
-
'isSprucebot': boolean;
|
|
1185
|
-
}
|
|
1186
|
-
interface FeedItemTargetSchema extends SpruceSchema.Schema {
|
|
1187
|
-
id: 'feedItemTarget';
|
|
1188
|
-
version: 'v2020_07_22';
|
|
1189
|
-
namespace: 'Spruce';
|
|
1190
|
-
name: '';
|
|
1191
|
-
moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas';
|
|
1192
|
-
fields: {
|
|
1193
|
-
/** . */
|
|
1194
|
-
'personId': {
|
|
1195
|
-
type: 'id';
|
|
1196
|
-
options: undefined;
|
|
1197
|
-
};
|
|
1198
|
-
/** . */
|
|
1199
|
-
'casualName': {
|
|
1200
|
-
type: 'text';
|
|
1201
|
-
isRequired: true;
|
|
1202
|
-
options: undefined;
|
|
1203
|
-
};
|
|
1204
|
-
/** . */
|
|
1205
|
-
'avatar': {
|
|
1206
|
-
type: 'image';
|
|
1207
|
-
options: {
|
|
1208
|
-
requiredSizes: ["*"];
|
|
1209
|
-
};
|
|
1210
|
-
};
|
|
1211
|
-
/** . */
|
|
1212
|
-
'skillId': {
|
|
1213
|
-
type: 'id';
|
|
1214
|
-
options: undefined;
|
|
1215
|
-
};
|
|
1216
|
-
/** . */
|
|
1217
|
-
'isMe': {
|
|
1218
|
-
type: 'boolean';
|
|
1219
|
-
isRequired: true;
|
|
1220
|
-
options: undefined;
|
|
1221
|
-
};
|
|
1222
|
-
/** . */
|
|
1223
|
-
'isSprucebot': {
|
|
1224
|
-
type: 'boolean';
|
|
1225
|
-
isRequired: true;
|
|
1226
|
-
options: undefined;
|
|
1227
|
-
};
|
|
1228
|
-
};
|
|
1229
|
-
}
|
|
1230
|
-
type FeedItemTargetEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.FeedItemTargetSchema>;
|
|
1231
|
-
}
|
|
1232
|
-
export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
1233
|
-
interface Choice {
|
|
1234
|
-
'value': (string | number);
|
|
1235
|
-
'label': string;
|
|
1236
|
-
}
|
|
1237
|
-
interface ChoiceSchema extends SpruceSchema.Schema {
|
|
1238
|
-
id: 'choice';
|
|
1239
|
-
version: 'v2020_07_22';
|
|
1240
|
-
namespace: 'Spruce';
|
|
1241
|
-
name: '';
|
|
1242
|
-
moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas';
|
|
1243
|
-
fields: {
|
|
1244
|
-
/** . */
|
|
1245
|
-
'value': {
|
|
1246
|
-
type: 'raw';
|
|
1247
|
-
isRequired: true;
|
|
1248
|
-
options: {
|
|
1249
|
-
valueType: `string | number`;
|
|
1250
|
-
};
|
|
1251
|
-
};
|
|
1252
|
-
/** . */
|
|
1253
|
-
'label': {
|
|
1254
|
-
type: 'text';
|
|
1255
|
-
isRequired: true;
|
|
1256
|
-
options: undefined;
|
|
1257
|
-
};
|
|
1258
|
-
};
|
|
1259
|
-
}
|
|
1260
|
-
type ChoiceEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.ChoiceSchema>;
|
|
1261
|
-
}
|
|
1262
|
-
export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
1263
|
-
interface SendMessage {
|
|
1153
|
+
/** A discrete communication between two humans or a human and a machine. */
|
|
1154
|
+
interface Message {
|
|
1155
|
+
'id': string;
|
|
1264
1156
|
/** . An arbitrary id that can be used to track this message when being sent and not yet assigned an Id. */
|
|
1265
1157
|
'trackingId'?: string | undefined | null;
|
|
1266
1158
|
/** . If this message is a reply to another message, this is the id of that original message. */
|
|
1267
1159
|
'inReplyToMessageId'?: string | undefined | null;
|
|
1160
|
+
'dateCreated': number;
|
|
1268
1161
|
'dateSent'?: number | undefined | null;
|
|
1269
1162
|
'target': SpruceSchemas.Spruce.v2020_07_22.MessageTarget;
|
|
1163
|
+
'source': SpruceSchemas.Spruce.v2020_07_22.MessageSource;
|
|
1270
1164
|
'errors'?: string[] | undefined | null;
|
|
1271
1165
|
'classification': ("auth" | "transactional" | "promotional" | "incoming");
|
|
1272
1166
|
'status'?: ("pending" | "processing" | "sent" | "failed" | "ignored") | undefined | null;
|
|
@@ -1276,13 +1170,20 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
|
1276
1170
|
'links'?: SpruceSchemas.Spruce.v2020_07_22.Link[] | undefined | null;
|
|
1277
1171
|
'choices'?: SpruceSchemas.Spruce.v2020_07_22.Choice[] | undefined | null;
|
|
1278
1172
|
}
|
|
1279
|
-
interface
|
|
1280
|
-
id: '
|
|
1173
|
+
interface MessageSchema extends SpruceSchema.Schema {
|
|
1174
|
+
id: 'message';
|
|
1281
1175
|
version: 'v2020_07_22';
|
|
1282
1176
|
namespace: 'Spruce';
|
|
1283
1177
|
name: '';
|
|
1284
1178
|
moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas';
|
|
1179
|
+
description: 'A discrete communication between two humans or a human and a machine.';
|
|
1285
1180
|
fields: {
|
|
1181
|
+
/** . */
|
|
1182
|
+
'id': {
|
|
1183
|
+
type: 'id';
|
|
1184
|
+
isRequired: true;
|
|
1185
|
+
options: undefined;
|
|
1186
|
+
};
|
|
1286
1187
|
/** . An arbitrary id that can be used to track this message when being sent and not yet assigned an Id. */
|
|
1287
1188
|
'trackingId': {
|
|
1288
1189
|
type: 'id';
|
|
@@ -1296,6 +1197,12 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
|
1296
1197
|
options: undefined;
|
|
1297
1198
|
};
|
|
1298
1199
|
/** . */
|
|
1200
|
+
'dateCreated': {
|
|
1201
|
+
type: 'number';
|
|
1202
|
+
isRequired: true;
|
|
1203
|
+
options: undefined;
|
|
1204
|
+
};
|
|
1205
|
+
/** . */
|
|
1299
1206
|
'dateSent': {
|
|
1300
1207
|
type: 'number';
|
|
1301
1208
|
options: undefined;
|
|
@@ -1309,6 +1216,14 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
|
1309
1216
|
};
|
|
1310
1217
|
};
|
|
1311
1218
|
/** . */
|
|
1219
|
+
'source': {
|
|
1220
|
+
type: 'schema';
|
|
1221
|
+
isRequired: true;
|
|
1222
|
+
options: {
|
|
1223
|
+
schema: SpruceSchemas.Spruce.v2020_07_22.MessageSourceSchema;
|
|
1224
|
+
};
|
|
1225
|
+
};
|
|
1226
|
+
/** . */
|
|
1312
1227
|
'errors': {
|
|
1313
1228
|
type: 'text';
|
|
1314
1229
|
isPrivate: true;
|
|
@@ -1397,7 +1312,92 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
|
1397
1312
|
};
|
|
1398
1313
|
};
|
|
1399
1314
|
}
|
|
1400
|
-
type
|
|
1315
|
+
type MessageEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.MessageSchema>;
|
|
1316
|
+
}
|
|
1317
|
+
export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
1318
|
+
interface FeedItemTarget {
|
|
1319
|
+
'personId'?: string | undefined | null;
|
|
1320
|
+
'casualName': string;
|
|
1321
|
+
'avatar'?: SpruceSchema.ImageFieldValue | undefined | null;
|
|
1322
|
+
'skillId'?: string | undefined | null;
|
|
1323
|
+
'isMe': boolean;
|
|
1324
|
+
'isSprucebot': boolean;
|
|
1325
|
+
}
|
|
1326
|
+
interface FeedItemTargetSchema extends SpruceSchema.Schema {
|
|
1327
|
+
id: 'feedItemTarget';
|
|
1328
|
+
version: 'v2020_07_22';
|
|
1329
|
+
namespace: 'Spruce';
|
|
1330
|
+
name: '';
|
|
1331
|
+
moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas';
|
|
1332
|
+
fields: {
|
|
1333
|
+
/** . */
|
|
1334
|
+
'personId': {
|
|
1335
|
+
type: 'id';
|
|
1336
|
+
options: undefined;
|
|
1337
|
+
};
|
|
1338
|
+
/** . */
|
|
1339
|
+
'casualName': {
|
|
1340
|
+
type: 'text';
|
|
1341
|
+
isRequired: true;
|
|
1342
|
+
options: undefined;
|
|
1343
|
+
};
|
|
1344
|
+
/** . */
|
|
1345
|
+
'avatar': {
|
|
1346
|
+
type: 'image';
|
|
1347
|
+
options: {
|
|
1348
|
+
requiredSizes: ["*"];
|
|
1349
|
+
};
|
|
1350
|
+
};
|
|
1351
|
+
/** . */
|
|
1352
|
+
'skillId': {
|
|
1353
|
+
type: 'id';
|
|
1354
|
+
options: undefined;
|
|
1355
|
+
};
|
|
1356
|
+
/** . */
|
|
1357
|
+
'isMe': {
|
|
1358
|
+
type: 'boolean';
|
|
1359
|
+
isRequired: true;
|
|
1360
|
+
options: undefined;
|
|
1361
|
+
};
|
|
1362
|
+
/** . */
|
|
1363
|
+
'isSprucebot': {
|
|
1364
|
+
type: 'boolean';
|
|
1365
|
+
isRequired: true;
|
|
1366
|
+
options: undefined;
|
|
1367
|
+
};
|
|
1368
|
+
};
|
|
1369
|
+
}
|
|
1370
|
+
type FeedItemTargetEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.FeedItemTargetSchema>;
|
|
1371
|
+
}
|
|
1372
|
+
export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
1373
|
+
interface Choice {
|
|
1374
|
+
'value': (string | number);
|
|
1375
|
+
'label': string;
|
|
1376
|
+
}
|
|
1377
|
+
interface ChoiceSchema extends SpruceSchema.Schema {
|
|
1378
|
+
id: 'choice';
|
|
1379
|
+
version: 'v2020_07_22';
|
|
1380
|
+
namespace: 'Spruce';
|
|
1381
|
+
name: '';
|
|
1382
|
+
moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas';
|
|
1383
|
+
fields: {
|
|
1384
|
+
/** . */
|
|
1385
|
+
'value': {
|
|
1386
|
+
type: 'raw';
|
|
1387
|
+
isRequired: true;
|
|
1388
|
+
options: {
|
|
1389
|
+
valueType: `string | number`;
|
|
1390
|
+
};
|
|
1391
|
+
};
|
|
1392
|
+
/** . */
|
|
1393
|
+
'label': {
|
|
1394
|
+
type: 'text';
|
|
1395
|
+
isRequired: true;
|
|
1396
|
+
options: undefined;
|
|
1397
|
+
};
|
|
1398
|
+
};
|
|
1399
|
+
}
|
|
1400
|
+
type ChoiceEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.ChoiceSchema>;
|
|
1401
1401
|
}
|
|
1402
1402
|
export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
1403
1403
|
interface FeedItem {
|
|
@@ -1485,3 +1485,72 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
|
1485
1485
|
}
|
|
1486
1486
|
type FeedItemEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.FeedItemSchema>;
|
|
1487
1487
|
}
|
|
1488
|
+
export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
1489
|
+
interface AgentSource {
|
|
1490
|
+
'personId'?: string | undefined | null;
|
|
1491
|
+
'skillId'?: string | undefined | null;
|
|
1492
|
+
}
|
|
1493
|
+
interface AgentSourceSchema extends SpruceSchema.Schema {
|
|
1494
|
+
id: 'agentSource';
|
|
1495
|
+
version: 'v2020_07_22';
|
|
1496
|
+
namespace: 'Spruce';
|
|
1497
|
+
name: '';
|
|
1498
|
+
moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas';
|
|
1499
|
+
fields: {
|
|
1500
|
+
/** . */
|
|
1501
|
+
'personId': {
|
|
1502
|
+
type: 'id';
|
|
1503
|
+
options: undefined;
|
|
1504
|
+
};
|
|
1505
|
+
/** . */
|
|
1506
|
+
'skillId': {
|
|
1507
|
+
type: 'id';
|
|
1508
|
+
options: undefined;
|
|
1509
|
+
};
|
|
1510
|
+
};
|
|
1511
|
+
}
|
|
1512
|
+
type AgentSourceEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.AgentSourceSchema>;
|
|
1513
|
+
}
|
|
1514
|
+
export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
|
|
1515
|
+
interface Agent {
|
|
1516
|
+
'id': string;
|
|
1517
|
+
'name': string;
|
|
1518
|
+
'systemPrompt': string;
|
|
1519
|
+
'source'?: SpruceSchemas.Spruce.v2020_07_22.AgentSource | undefined | null;
|
|
1520
|
+
}
|
|
1521
|
+
interface AgentSchema extends SpruceSchema.Schema {
|
|
1522
|
+
id: 'agent';
|
|
1523
|
+
version: 'v2020_07_22';
|
|
1524
|
+
namespace: 'Spruce';
|
|
1525
|
+
name: 'Agent';
|
|
1526
|
+
moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas';
|
|
1527
|
+
fields: {
|
|
1528
|
+
/** . */
|
|
1529
|
+
'id': {
|
|
1530
|
+
type: 'id';
|
|
1531
|
+
isRequired: true;
|
|
1532
|
+
options: undefined;
|
|
1533
|
+
};
|
|
1534
|
+
/** . */
|
|
1535
|
+
'name': {
|
|
1536
|
+
type: 'text';
|
|
1537
|
+
isRequired: true;
|
|
1538
|
+
options: undefined;
|
|
1539
|
+
};
|
|
1540
|
+
/** . */
|
|
1541
|
+
'systemPrompt': {
|
|
1542
|
+
type: 'text';
|
|
1543
|
+
isRequired: true;
|
|
1544
|
+
options: undefined;
|
|
1545
|
+
};
|
|
1546
|
+
/** . */
|
|
1547
|
+
'source': {
|
|
1548
|
+
type: 'schema';
|
|
1549
|
+
options: {
|
|
1550
|
+
schema: SpruceSchemas.Spruce.v2020_07_22.AgentSourceSchema;
|
|
1551
|
+
};
|
|
1552
|
+
};
|
|
1553
|
+
};
|
|
1554
|
+
}
|
|
1555
|
+
type AgentEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.AgentSchema>;
|
|
1556
|
+
}
|