@devrev/typescript-sdk 1.1.3 → 1.1.5

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.
@@ -0,0 +1,4302 @@
1
+ /** account */
2
+ export type Account = OrgBase & {
3
+ /** Custom fields. */
4
+ custom_fields?: object;
5
+ /**
6
+ * Custom schema fragments.
7
+ * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
8
+ */
9
+ custom_schema_fragments?: string[];
10
+ /** Description of the corresponding Account. */
11
+ description?: string;
12
+ /** Company's domain names. Example - 'devrev.ai'. */
13
+ domains?: string[];
14
+ /**
15
+ * External refs are unique identifiers from your customer system of
16
+ * records, stored as a list.
17
+ */
18
+ external_refs: string[];
19
+ /** List of Dev user IDs owning this Account. */
20
+ owned_by: UserSummary[];
21
+ /**
22
+ * Stock schema fragment.
23
+ * @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
24
+ */
25
+ stock_schema_fragment?: string;
26
+ /** The Tier of the corresponding Account. */
27
+ tier?: string;
28
+ };
29
+ /** account-summary */
30
+ export type AccountSummary = OrgBaseSummary;
31
+ /**
32
+ * accounts-create-request
33
+ * Request object to create a new account in the Dev organization.
34
+ */
35
+ export interface AccountsCreateRequest {
36
+ /** Application-defined custom fields. */
37
+ custom_fields?: object;
38
+ /** Description of the account. */
39
+ description?: string;
40
+ /** Name of the account. */
41
+ display_name: string;
42
+ /** List of company's domain names. Example - ['devrev.ai']. */
43
+ domains?: string[];
44
+ /**
45
+ * External refs are unique identifiers from your customer system of
46
+ * records, stored as a list. Currently the length of this field is
47
+ * limited to 1.
48
+ */
49
+ external_refs?: string[];
50
+ /** List of Dev users owning this account. */
51
+ owned_by?: string[];
52
+ /**
53
+ * Schema fragment IDs associated with this account SOR.
54
+ * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
55
+ */
56
+ schema_fragment_ids?: string[];
57
+ /** The tier of the account. */
58
+ tier?: string;
59
+ }
60
+ /**
61
+ * accounts-create-response
62
+ * Response object for request to create a new account.
63
+ */
64
+ export interface AccountsCreateResponse {
65
+ account: Account;
66
+ }
67
+ /**
68
+ * accounts-delete-request
69
+ * Request object to delete an account.
70
+ */
71
+ export interface AccountsDeleteRequest {
72
+ /**
73
+ * The ID of account to delete.
74
+ * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
75
+ */
76
+ id: string;
77
+ }
78
+ /**
79
+ * accounts-delete-response
80
+ * The response to deleting an account.
81
+ */
82
+ export type AccountsDeleteResponse = object;
83
+ /**
84
+ * accounts-export-response
85
+ * The response to exporting a collection of accounts.
86
+ */
87
+ export interface AccountsExportResponse {
88
+ /** The exported accounts. */
89
+ accounts: Account[];
90
+ }
91
+ /**
92
+ * accounts-get-response
93
+ * The returned account.
94
+ */
95
+ export interface AccountsGetResponse {
96
+ account: Account;
97
+ }
98
+ /**
99
+ * accounts-list-response
100
+ * The response to listing all accounts matching the filter criteria.
101
+ */
102
+ export interface AccountsListResponse {
103
+ /** List containing all the accounts */
104
+ accounts: Account[];
105
+ /**
106
+ * The cursor used to iterate subsequent results in accordance to the
107
+ * sort order. If not set, then no later elements exist.
108
+ */
109
+ next_cursor?: string;
110
+ /**
111
+ * The cursor used to iterate preceding results in accordance to the
112
+ * sort order. If not set, then no prior elements exist.
113
+ */
114
+ prev_cursor?: string;
115
+ }
116
+ /**
117
+ * accounts-update-request
118
+ * Request to update details of the account.
119
+ */
120
+ export interface AccountsUpdateRequest {
121
+ /** Application-defined custom fields. */
122
+ custom_fields?: object;
123
+ /** Updated description of the account. */
124
+ description?: string;
125
+ /** Updated display name for the account. */
126
+ display_name?: string;
127
+ /** Updated list of company's domain names. Example - ['devrev.ai']. */
128
+ domains?: string[];
129
+ /**
130
+ * Updated External Refs of account. Currently the length of this
131
+ * field is limited to 1.
132
+ */
133
+ external_refs?: string[];
134
+ /**
135
+ * The ID of account to update.
136
+ * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
137
+ */
138
+ id: string;
139
+ /** Updated list of the users owning this account. */
140
+ owned_by?: string[];
141
+ /**
142
+ * Schema fragment IDs associated with this account SOR.
143
+ * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
144
+ */
145
+ schema_fragment_ids?: string[];
146
+ /** Updated tier of the account. */
147
+ tier?: string;
148
+ }
149
+ /**
150
+ * accounts-update-response
151
+ * Updated account object.
152
+ */
153
+ export interface AccountsUpdateResponse {
154
+ account: Account;
155
+ }
156
+ /**
157
+ * aggregated-schema
158
+ * List of custom fields from multiple source fragments.
159
+ */
160
+ export type AggregatedSchema = object;
161
+ /** aggregated-schema-get-response */
162
+ export interface AggregatedSchemaGetResponse {
163
+ /** List of custom fields from multiple source fragments. */
164
+ schema: AggregatedSchema;
165
+ }
166
+ /** artifact-summary */
167
+ export type ArtifactSummary = AtomBaseSummary;
168
+ /** atom-base */
169
+ export interface AtomBase {
170
+ created_by?: UserSummary;
171
+ /**
172
+ * Timestamp when the object was created.
173
+ * @format date-time
174
+ */
175
+ created_date?: string;
176
+ /** Human-readable object ID unique to the Dev organization. */
177
+ display_id?: string;
178
+ /** Globally unique object ID. */
179
+ id: string;
180
+ modified_by?: UserSummary;
181
+ /**
182
+ * Timestamp when the object was last modified.
183
+ * @format date-time
184
+ */
185
+ modified_date?: string;
186
+ }
187
+ /** atom-base-summary */
188
+ export interface AtomBaseSummary {
189
+ /** Human-readable object ID unique to the Dev organization. */
190
+ display_id?: string;
191
+ /** Globally unique object ID. */
192
+ id: string;
193
+ }
194
+ /** capability-summary */
195
+ export type CapabilitySummary = PartBaseSummary;
196
+ /** conversation */
197
+ export type Conversation = AtomBase & {
198
+ /** Description of the conversation object. */
199
+ description?: string;
200
+ group?: GroupSummary;
201
+ /** The users in the conversation. */
202
+ members: UserSummary[];
203
+ /** The latest messages on the conversation. */
204
+ messages?: TimelineEntry[];
205
+ /** Metadata on conversation. */
206
+ metadata?: ConversationMetadata;
207
+ /** Owner IDs for the conversation. */
208
+ owned_by?: UserSummary[];
209
+ /** Describes the current stage of a work item. */
210
+ stage?: Stage;
211
+ /** Title of the conversation object. */
212
+ title?: string;
213
+ };
214
+ /**
215
+ * conversation-metadata
216
+ * Metadata on conversation.
217
+ */
218
+ export interface ConversationMetadata {
219
+ /**
220
+ * URL from which the conversation was created if the conversation was
221
+ * created via PLuG.
222
+ */
223
+ url_context?: string;
224
+ }
225
+ /** conversation-summary */
226
+ export type ConversationSummary = AtomBaseSummary & {
227
+ /** Title of the conversation object. */
228
+ title?: string;
229
+ };
230
+ /**
231
+ * conversations-create-request
232
+ * The request to create a new conversation.
233
+ */
234
+ export interface ConversationsCreateRequest {
235
+ /** Description for the conversation. */
236
+ description?: string;
237
+ /** The group that the conversation is associated with. */
238
+ group?: string;
239
+ /** Whether the conversation is spam. */
240
+ is_spam?: boolean;
241
+ /**
242
+ * The users in the conversation.
243
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
244
+ */
245
+ members?: string[];
246
+ /** Initial messages on the conversation. */
247
+ messages?: ConversationsCreateRequestMessage[];
248
+ metadata?: ConversationsCreateRequestMetadata;
249
+ /** Whether the conversation is from a source channel. */
250
+ source_channel?: string;
251
+ /** Sets an object's initial stage. */
252
+ stage?: StageInit;
253
+ /** Tags associated with the conversation. */
254
+ tags?: SetTagWithValue[];
255
+ /** The title for the conversation. */
256
+ title?: string;
257
+ type: ConversationsCreateRequestTypeValue;
258
+ /** The IDs of user sessions associated with the conversation. */
259
+ user_sessions?: string[];
260
+ }
261
+ /** conversations-create-request-message */
262
+ export interface ConversationsCreateRequestMessage {
263
+ /**
264
+ * The IDs of the artifacts to the message.
265
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
266
+ */
267
+ artifacts?: string[];
268
+ /** The message's body. */
269
+ body?: string;
270
+ }
271
+ /** conversations-create-request-metadata */
272
+ export interface ConversationsCreateRequestMetadata {
273
+ url_context?: string;
274
+ }
275
+ export declare enum ConversationsCreateRequestTypeValue {
276
+ Support = "support"
277
+ }
278
+ /**
279
+ * conversations-create-response
280
+ * The response to creating a new conversation.
281
+ */
282
+ export interface ConversationsCreateResponse {
283
+ conversation: Conversation;
284
+ }
285
+ /**
286
+ * conversations-delete-request
287
+ * The request to delete a conversation.
288
+ */
289
+ export interface ConversationsDeleteRequest {
290
+ /** The ID of the conversation to delete. */
291
+ id: string;
292
+ }
293
+ /**
294
+ * conversations-delete-response
295
+ * The response for deleting a conversation.
296
+ */
297
+ export type ConversationsDeleteResponse = object;
298
+ /** conversations-export-response */
299
+ export interface ConversationsExportResponse {
300
+ /** The resulting collection of conversation items. */
301
+ conversations: Conversation[];
302
+ }
303
+ /**
304
+ * conversations-get-response
305
+ * The response to getting a conversation's information.
306
+ */
307
+ export interface ConversationsGetResponse {
308
+ conversation: Conversation;
309
+ }
310
+ /**
311
+ * conversations-list-response
312
+ * The response to listing the conversations.
313
+ */
314
+ export interface ConversationsListResponse {
315
+ /** The list of conversations. */
316
+ conversations: Conversation[];
317
+ /**
318
+ * The cursor used to iterate subsequent results in accordance to the
319
+ * sort order. If not set, then no later elements exist.
320
+ */
321
+ next_cursor?: string;
322
+ /**
323
+ * The cursor used to iterate preceding results in accordance to the
324
+ * sort order. If not set, then no prior elements exist.
325
+ */
326
+ prev_cursor?: string;
327
+ }
328
+ /**
329
+ * conversations-update-request
330
+ * The request to update a conversation.
331
+ */
332
+ export interface ConversationsUpdateRequest {
333
+ applies_to_parts?: ConversationsUpdateRequestAppliesToParts;
334
+ /** The updated description for the conversation. */
335
+ description?: string;
336
+ /** The group that the conversation is associated with. */
337
+ group?: string;
338
+ /** The ID of the conversation to update. */
339
+ id: string;
340
+ /** Whether the conversation is spam. */
341
+ is_spam?: boolean;
342
+ metadata?: ConversationsUpdateRequestMetadata;
343
+ /** Updates an object's stage. */
344
+ stage?: StageUpdate;
345
+ /** The updated status of the conversation. */
346
+ status?: string;
347
+ tags?: ConversationsUpdateRequestTags;
348
+ /** The updated title of the conversation. */
349
+ title?: string;
350
+ user_sessions?: ConversationsUpdateRequestUserSessions;
351
+ }
352
+ /** conversations-update-request-applies-to-parts */
353
+ export interface ConversationsUpdateRequestAppliesToParts {
354
+ /**
355
+ * Updates the parts that the conversation applies to.
356
+ * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
357
+ */
358
+ set?: string[];
359
+ }
360
+ /** conversations-update-request-metadata */
361
+ export interface ConversationsUpdateRequestMetadata {
362
+ url_context?: string;
363
+ }
364
+ /** conversations-update-request-tags */
365
+ export interface ConversationsUpdateRequestTags {
366
+ /** Sets the tag IDs to the provided tags. */
367
+ set?: SetTagWithValue[];
368
+ }
369
+ /** conversations-update-request-user-sessions */
370
+ export interface ConversationsUpdateRequestUserSessions {
371
+ /** The updated user sessions that the conversation is associated with. */
372
+ set?: string[];
373
+ }
374
+ /**
375
+ * conversations-update-response
376
+ * The response for updating a conversation.
377
+ */
378
+ export interface ConversationsUpdateResponse {
379
+ conversation: Conversation;
380
+ }
381
+ /** create-org-schedule-interval */
382
+ export interface CreateOrgScheduleInterval {
383
+ /**
384
+ * Date (inclusive) on which the interval begins.
385
+ * @format date-time
386
+ */
387
+ from: string;
388
+ /**
389
+ * If true, no organization schedule is looked up for these days and
390
+ * they are marked as holidays.
391
+ */
392
+ is_excluded?: boolean;
393
+ /**
394
+ * The name of the period, for example the event or holiday it
395
+ * represents.
396
+ */
397
+ name: string;
398
+ /**
399
+ * Date (exclusive) on which the interval ends. If omitted, it is a
400
+ * single day interval.
401
+ * @format date-time
402
+ */
403
+ to?: string;
404
+ }
405
+ /** create-weekly-org-schedule-interval */
406
+ export interface CreateWeeklyOrgScheduleInterval {
407
+ /**
408
+ * Duration in minutes of the week when the interval starts. 0 is
409
+ * Sunday midnight, when Sunday ends and Monday begins.
410
+ * @format int64
411
+ */
412
+ from: number;
413
+ /**
414
+ * Duration in minutes of the week when the interval ends (must be
415
+ * larger than 'from'). 0 is Sunday midnight, when Sunday ends and
416
+ * Monday begins.
417
+ * @format int64
418
+ */
419
+ to: number;
420
+ }
421
+ /** custom-schema-fragment */
422
+ export interface CustomSchemaFragment {
423
+ type: CustomSchemaFragmentType;
424
+ }
425
+ /**
426
+ * custom-schema-fragment-condition
427
+ * The condition associated with a field.
428
+ */
429
+ export type CustomSchemaFragmentCondition = object;
430
+ export type CustomSchemaFragmentType = string;
431
+ /** custom-schema-fragments-get-response */
432
+ export interface CustomSchemaFragmentsGetResponse {
433
+ fragment: CustomSchemaFragment;
434
+ }
435
+ /** custom-schema-fragments-list-response */
436
+ export interface CustomSchemaFragmentsListResponse {
437
+ /**
438
+ * The cursor to resume iteration from, otherwise if not provided,
439
+ * then iteration starts from the beginning.
440
+ */
441
+ cursor?: string;
442
+ /** The custom schema fragments. */
443
+ result: CustomSchemaFragment[];
444
+ }
445
+ /** custom-schema-fragments-set-request */
446
+ export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAppFragment | CustomSchemaFragmentsSetRequestCustomTypeFragment | CustomSchemaFragmentsSetRequestTenantFragment) & {
447
+ /** List of conditions for this fragment. */
448
+ conditions?: CustomSchemaFragmentCondition[];
449
+ /** List of field names which are being dropped. */
450
+ deleted_fields?: string[];
451
+ /** Whether this fragment has been deprecated. */
452
+ deprecated?: boolean;
453
+ /** The description of the custom schema fragment. */
454
+ description: string;
455
+ /** List of all fields in this fragment. */
456
+ fields?: SchemaFieldDescriptor[];
457
+ /** The leaf type this fragment applies to. */
458
+ leaf_type: string;
459
+ type: CustomSchemaFragmentsSetRequestType;
460
+ };
461
+ /** custom-schema-fragments-set-request-app-fragment */
462
+ export interface CustomSchemaFragmentsSetRequestAppFragment {
463
+ /** The app this fragment applies to. */
464
+ app: string;
465
+ /** The name of the app fragment. */
466
+ app_fragment_name: string;
467
+ }
468
+ /** custom-schema-fragments-set-request-custom-type-fragment */
469
+ export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
470
+ /** The ID of the associated custom stage diagram. */
471
+ stage_diagram?: string;
472
+ /** List of stock field enum overrides. */
473
+ stock_field_enum_overrides?: StockFieldEnumOverride[];
474
+ /** The string used to populate the subtype in the leaf type. */
475
+ subtype: string;
476
+ /** The display name of the subtype. */
477
+ subtype_display_name?: string;
478
+ }
479
+ /** custom-schema-fragments-set-request-tenant-fragment */
480
+ export type CustomSchemaFragmentsSetRequestTenantFragment = object;
481
+ export declare enum CustomSchemaFragmentsSetRequestType {
482
+ AppFragment = "app_fragment",
483
+ CustomTypeFragment = "custom_type_fragment",
484
+ TenantFragment = "tenant_fragment"
485
+ }
486
+ /** custom-schema-fragments-set-response */
487
+ export interface CustomSchemaFragmentsSetResponse {
488
+ /** The ID of the custom schema fragment. */
489
+ id: string;
490
+ }
491
+ /** dev-user-summary */
492
+ export type DevUserSummary = UserBaseSummary;
493
+ /** empty */
494
+ export type Empty = object;
495
+ /** engagement */
496
+ export type Engagement = AtomBase & {
497
+ /** Description of the engagement object. */
498
+ description?: string;
499
+ };
500
+ /** Type of engagement. */
501
+ export declare enum EngagementType {
502
+ Call = "call",
503
+ Default = "default",
504
+ Email = "email",
505
+ LinkedIn = "linked_in",
506
+ Meeting = "meeting",
507
+ Offline = "offline",
508
+ Survey = "survey"
509
+ }
510
+ /** engagements-count-response */
511
+ export interface EngagementsCountResponse {
512
+ /**
513
+ * The number of engagements matching the filter.
514
+ * @format int64
515
+ */
516
+ count: number;
517
+ }
518
+ /** engagements-create-request */
519
+ export interface EngagementsCreateRequest {
520
+ /**
521
+ * The IDs of the artifacts to associate with the engagement.
522
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
523
+ */
524
+ artifacts?: string[];
525
+ /** The description of the engagement. */
526
+ description?: string;
527
+ /** The type of engagement. */
528
+ engagement_type?: EngagementsCreateRequestEngagementType;
529
+ /** External Reference for the engagement. */
530
+ external_ref?: string;
531
+ /** External URL for the engagement. */
532
+ external_url?: string;
533
+ /**
534
+ * IDs of the users that were part of the engagement.
535
+ * @maxItems 50
536
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
537
+ */
538
+ members?: string[];
539
+ /**
540
+ * The parent object ID in which the engagement was created.
541
+ * Currently, only accounts and opportunities are supported.
542
+ * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
543
+ */
544
+ parent: string;
545
+ /**
546
+ * The date and time when the engagement was scheduled.
547
+ * @format date-time
548
+ */
549
+ scheduled_date?: string;
550
+ /** Tags associated with the engagement. */
551
+ tags?: SetTagWithValue[];
552
+ /** The title of the engagement. */
553
+ title: string;
554
+ }
555
+ /** The type of engagement. */
556
+ export declare enum EngagementsCreateRequestEngagementType {
557
+ Call = "call",
558
+ Default = "default",
559
+ Email = "email",
560
+ LinkedIn = "linked_in",
561
+ Offline = "offline"
562
+ }
563
+ /** engagements-create-response */
564
+ export interface EngagementsCreateResponse {
565
+ engagement: Engagement;
566
+ }
567
+ /** engagements-delete-request */
568
+ export interface EngagementsDeleteRequest {
569
+ /** The engagement ID. */
570
+ id: string;
571
+ }
572
+ /** engagements-delete-response */
573
+ export type EngagementsDeleteResponse = object;
574
+ /** engagements-get-response */
575
+ export interface EngagementsGetResponse {
576
+ engagement: Engagement;
577
+ }
578
+ /** engagements-list-response */
579
+ export interface EngagementsListResponse {
580
+ /** The list of engagements. */
581
+ engagements: Engagement[];
582
+ /**
583
+ * The cursor used to iterate subsequent results in accordance to the
584
+ * sort order. If not set, then no later elements exist.
585
+ */
586
+ next_cursor?: string;
587
+ /**
588
+ * The cursor used to iterate preceding results in accordance to the
589
+ * sort order. If not set, then no prior elements exist.
590
+ */
591
+ prev_cursor?: string;
592
+ }
593
+ /** engagements-update-request */
594
+ export interface EngagementsUpdateRequest {
595
+ artifacts?: EngagementsUpdateRequestArtifactIds;
596
+ /** Updates the description of the engagement. */
597
+ description?: string;
598
+ /** External Reference for the engagement. */
599
+ external_ref?: string;
600
+ /** Updates the external URL for the engagement. */
601
+ external_url?: string;
602
+ /** The engagement ID. */
603
+ id: string;
604
+ members?: EngagementsUpdateRequestMembers;
605
+ /**
606
+ * Updates the date and time when the engagement was scheduled.
607
+ * @format date-time
608
+ */
609
+ scheduled_date?: string | null;
610
+ tags?: EngagementsUpdateRequestTags;
611
+ /** Updates the title of the engagement. */
612
+ title?: string;
613
+ }
614
+ /** engagements-update-request-artifact-ids */
615
+ export interface EngagementsUpdateRequestArtifactIds {
616
+ /**
617
+ * Sets the IDs to the provided artifact IDs.
618
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
619
+ */
620
+ set?: string[];
621
+ }
622
+ /** engagements-update-request-members */
623
+ export interface EngagementsUpdateRequestMembers {
624
+ /**
625
+ * Sets the members to the provided user IDs. If specified, this must
626
+ * not be empty.
627
+ * @maxItems 50
628
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
629
+ */
630
+ set?: string[];
631
+ }
632
+ /** engagements-update-request-tags */
633
+ export interface EngagementsUpdateRequestTags {
634
+ /** Sets the provided tags on the engagement item. */
635
+ set?: SetTagWithValue[];
636
+ }
637
+ /** engagements-update-response */
638
+ export interface EngagementsUpdateResponse {
639
+ engagement: Engagement;
640
+ }
641
+ /** enhancement-summary */
642
+ export type EnhancementSummary = PartBaseSummary;
643
+ /** error */
644
+ export interface Error {
645
+ /** Information about the error. */
646
+ message: string;
647
+ /**
648
+ * The corresponding HTTP status code.
649
+ * @format int32
650
+ */
651
+ status: number;
652
+ /** The error type. */
653
+ type?: string;
654
+ }
655
+ /** error-bad-request */
656
+ export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestValueNotPermitted) & {
657
+ type: ErrorBadRequestType;
658
+ };
659
+ /** error-bad-request-bad-request */
660
+ export type ErrorBadRequestBadRequest = object;
661
+ /** error-bad-request-invalid-enum-value */
662
+ export interface ErrorBadRequestInvalidEnumValue {
663
+ /** The allowed values for the field. */
664
+ allowed_values: string[];
665
+ /** The field whose enum value is invalid. */
666
+ field_name: string;
667
+ /** The value that was received. */
668
+ value: string;
669
+ }
670
+ /** error-bad-request-invalid-field */
671
+ export interface ErrorBadRequestInvalidField {
672
+ /** The field name that's invalid. */
673
+ field_name: string;
674
+ }
675
+ /** error-bad-request-missing-required-field */
676
+ export interface ErrorBadRequestMissingRequiredField {
677
+ /** The missing field's name. */
678
+ field_name: string;
679
+ }
680
+ /** error-bad-request-parse-error */
681
+ export type ErrorBadRequestParseError = object;
682
+ export declare enum ErrorBadRequestType {
683
+ BadRequest = "bad_request",
684
+ InvalidEnumValue = "invalid_enum_value",
685
+ InvalidField = "invalid_field",
686
+ MissingRequiredField = "missing_required_field",
687
+ ParseError = "parse_error",
688
+ ValueNotPermitted = "value_not_permitted"
689
+ }
690
+ /** error-bad-request-value-not-permitted */
691
+ export interface ErrorBadRequestValueNotPermitted {
692
+ /** The field whose value is not permitted. */
693
+ field_name: string;
694
+ /** The reason the value isn't permitted. */
695
+ reason?: string;
696
+ }
697
+ /** error-base */
698
+ export interface ErrorBase {
699
+ /** Error detail information. */
700
+ detail?: string;
701
+ /** The message associated with the error. */
702
+ message?: string;
703
+ }
704
+ /** error-forbidden */
705
+ export type ErrorForbidden = ErrorBase & ErrorForbiddenForbidden & {
706
+ type: ErrorForbiddenType;
707
+ };
708
+ /** error-forbidden-forbidden */
709
+ export type ErrorForbiddenForbidden = object;
710
+ export declare enum ErrorForbiddenType {
711
+ Forbidden = "forbidden"
712
+ }
713
+ /** error-internal-server-error */
714
+ export type ErrorInternalServerError = ErrorBase & ErrorInternalServerErrorInternalError & {
715
+ /**
716
+ * A unique ID that's generated for the error that can be used for
717
+ * inquiry.
718
+ */
719
+ reference_id?: string;
720
+ type: ErrorInternalServerErrorType;
721
+ };
722
+ /** error-internal-server-error-internal-error */
723
+ export type ErrorInternalServerErrorInternalError = object;
724
+ export declare enum ErrorInternalServerErrorType {
725
+ InternalError = "internal_error"
726
+ }
727
+ /** error-not-found */
728
+ export type ErrorNotFound = ErrorBase & ErrorNotFoundNotFound & {
729
+ type: ErrorNotFoundType;
730
+ };
731
+ /** error-not-found-not-found */
732
+ export type ErrorNotFoundNotFound = object;
733
+ export declare enum ErrorNotFoundType {
734
+ NotFound = "not_found"
735
+ }
736
+ /** error-service-unavailable */
737
+ export type ErrorServiceUnavailable = ErrorBase & ErrorServiceUnavailableServiceUnavailable & {
738
+ type: ErrorServiceUnavailableType;
739
+ };
740
+ /** error-service-unavailable-service-unavailable */
741
+ export type ErrorServiceUnavailableServiceUnavailable = object;
742
+ export declare enum ErrorServiceUnavailableType {
743
+ ServiceUnavailable = "service_unavailable"
744
+ }
745
+ /** error-too-many-requests */
746
+ export type ErrorTooManyRequests = ErrorBase & ErrorTooManyRequestsTooManyRequests & {
747
+ /**
748
+ * The number of seconds after which the client should retry.
749
+ * @format int64
750
+ */
751
+ retry_after?: number;
752
+ type: ErrorTooManyRequestsType;
753
+ };
754
+ /** error-too-many-requests-too-many-requests */
755
+ export type ErrorTooManyRequestsTooManyRequests = object;
756
+ export declare enum ErrorTooManyRequestsType {
757
+ TooManyRequests = "too_many_requests"
758
+ }
759
+ /** error-unauthorized */
760
+ export type ErrorUnauthorized = ErrorBase & ErrorUnauthorizedUnauthenticated & {
761
+ type: ErrorUnauthorizedType;
762
+ };
763
+ export declare enum ErrorUnauthorizedType {
764
+ Unauthenticated = "unauthenticated"
765
+ }
766
+ /** error-unauthorized-unauthenticated */
767
+ export type ErrorUnauthorizedUnauthenticated = object;
768
+ /** event-sources-delete-scheduled-event-request */
769
+ export interface EventSourcesDeleteScheduledEventRequest {
770
+ /** The event key for the event which we want to delete. */
771
+ event_key: string;
772
+ /** The event source's ID. */
773
+ id: string;
774
+ }
775
+ /** event-sources-schedule-event-request */
776
+ export interface EventSourcesScheduleEventRequest {
777
+ /**
778
+ * A unique key for this event (scoped to an event source) used for
779
+ * updating/getting/deleting scheduled events.
780
+ */
781
+ event_key?: string;
782
+ /** The type of the event. */
783
+ event_type: string;
784
+ /** The event source's ID. */
785
+ id: string;
786
+ /**
787
+ * The raw payload of the event.
788
+ * @format byte
789
+ */
790
+ payload: string;
791
+ /**
792
+ * The timestamp at which the event should be published. The event is
793
+ * guaranteed to be published after this. If omitted, the event is
794
+ * published immediately.
795
+ * @format date-time
796
+ */
797
+ publish_at?: string;
798
+ /**
799
+ * Whether or not to update an existing scheduled event with the same
800
+ * event key. If this is false, and an event is already scheduled with
801
+ * the same event key, then HTTP 409 Conflict is returned.
802
+ */
803
+ update_if_exists?: boolean;
804
+ }
805
+ /** event-sources-schedule-event-response */
806
+ export interface EventSourcesScheduleEventResponse {
807
+ /**
808
+ * The event key for this event. Auto-generated if the caller doesn't
809
+ * specify the event key. This may be empty if the event was published
810
+ * immediately.
811
+ */
812
+ event_key?: string;
813
+ }
814
+ /** feature-summary */
815
+ export type FeatureSummary = PartBaseSummary;
816
+ /** group-summary */
817
+ export type GroupSummary = AtomBaseSummary;
818
+ /** issue */
819
+ export type Issue = WorkBase & {
820
+ /** Priority of the work based upon impact and criticality. */
821
+ priority?: IssuePriority;
822
+ };
823
+ /** Priority of the work based upon impact and criticality. */
824
+ export declare enum IssuePriority {
825
+ P0 = "p0",
826
+ P1 = "p1",
827
+ P2 = "p2",
828
+ P3 = "p3"
829
+ }
830
+ /** issue-summary */
831
+ export type IssueSummary = WorkBaseSummary & {
832
+ /** Priority of the work based upon impact and criticality. */
833
+ priority?: IssuePriority;
834
+ };
835
+ /** link */
836
+ export type Link = AtomBase & {
837
+ /** Type of link used to define the relationship. */
838
+ link_type: LinkType;
839
+ source: LinkEndpointSummary;
840
+ target: LinkEndpointSummary;
841
+ };
842
+ /** link-endpoint-summary */
843
+ export type LinkEndpointSummary = (CapabilitySummary | ConversationSummary | EnhancementSummary | FeatureSummary | IssueSummary | OpportunitySummary | ProductSummary | TaskSummary | TicketSummary) & {
844
+ type: LinkEndpointType;
845
+ };
846
+ export declare enum LinkEndpointType {
847
+ Capability = "capability",
848
+ Conversation = "conversation",
849
+ Enhancement = "enhancement",
850
+ Feature = "feature",
851
+ Issue = "issue",
852
+ Opportunity = "opportunity",
853
+ Product = "product",
854
+ Task = "task",
855
+ Ticket = "ticket"
856
+ }
857
+ /**
858
+ * link-rev-user-to-rev-org-request
859
+ * A request to link a rev user to a rev org.
860
+ */
861
+ export interface LinkRevUserToRevOrgRequest {
862
+ /**
863
+ * The don of the rev org to link the rev user to.
864
+ * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
865
+ */
866
+ rev_org_don: string;
867
+ /** The don of the rev user to link. */
868
+ user_don: string;
869
+ }
870
+ /**
871
+ * link-rev-user-to-rev-org-response
872
+ * The response to link a rev user to a rev org.
873
+ */
874
+ export interface LinkRevUserToRevOrgResponse {
875
+ rev_user: RevUser;
876
+ }
877
+ /** Type of link used to define the relationship. */
878
+ export declare enum LinkType {
879
+ DevelopedWith = "developed_with",
880
+ Imports = "imports",
881
+ IsDependentOn = "is_dependent_on",
882
+ IsDuplicateOf = "is_duplicate_of",
883
+ IsParentOf = "is_parent_of",
884
+ IsPartOf = "is_part_of",
885
+ IsRelatedTo = "is_related_to",
886
+ Serves = "serves"
887
+ }
888
+ /**
889
+ * links-create-request
890
+ * The request to create a new link.
891
+ */
892
+ export interface LinksCreateRequest {
893
+ /** Type of link used to define the relationship. */
894
+ link_type: LinkType;
895
+ /** The ID of the source object. */
896
+ source: string;
897
+ /** The ID of the target object. */
898
+ target: string;
899
+ }
900
+ /**
901
+ * links-create-response
902
+ * The response to creating a new link.
903
+ */
904
+ export interface LinksCreateResponse {
905
+ link: Link;
906
+ }
907
+ /**
908
+ * links-delete-request
909
+ * The request to delete a link.
910
+ */
911
+ export interface LinksDeleteRequest {
912
+ /** The ID of the link to delete. */
913
+ id: string;
914
+ }
915
+ /**
916
+ * links-delete-response
917
+ * The response for deleting a link.
918
+ */
919
+ export type LinksDeleteResponse = object;
920
+ /**
921
+ * The direction of link, which can either be outbound such that the
922
+ * object is the source of the link, otherwise inbound where the object is
923
+ * the target of the link.
924
+ */
925
+ export declare enum LinksDirection {
926
+ IsSource = "is_source",
927
+ IsTarget = "is_target"
928
+ }
929
+ /**
930
+ * links-get-response
931
+ * The response to getting a link's information.
932
+ */
933
+ export interface LinksGetResponse {
934
+ link: Link;
935
+ }
936
+ /**
937
+ * links-list-response
938
+ * The response to listing the links.
939
+ */
940
+ export interface LinksListResponse {
941
+ /** The list of links. */
942
+ links: Link[];
943
+ /**
944
+ * The cursor used to iterate subsequent results in accordance to the
945
+ * sort order. If not set, then no later elements exist.
946
+ */
947
+ next_cursor?: string;
948
+ /**
949
+ * The cursor used to iterate preceding results in accordance to the
950
+ * sort order. If not set, then no prior elements exist.
951
+ */
952
+ prev_cursor?: string;
953
+ }
954
+ /**
955
+ * The iteration mode to use. If "after", then entries after the provided
956
+ * cursor will be returned, or if no cursor is provided, then from the
957
+ * beginning. If "before", then entries before the provided cursor will be
958
+ * returned, or if no cursor is provided, then from the end. Entries will
959
+ * always be returned in the specified sort-by order.
960
+ */
961
+ export declare enum ListMode {
962
+ After = "after",
963
+ Before = "before"
964
+ }
965
+ /** metric-definition */
966
+ export type MetricDefinition = AtomBase;
967
+ /** The list of item types on which the metric might be applied. */
968
+ export declare enum MetricDefinitionAppliesTo {
969
+ Conversation = "conversation",
970
+ Issue = "issue",
971
+ Task = "task",
972
+ Ticket = "ticket"
973
+ }
974
+ /**
975
+ * The type of the metric. 'time' metrics track the time spent in some
976
+ * state, supporting operations like 'start', 'stop', 'pause', 'resume'.
977
+ * 'value' metrics track a value, supporting operations like 'set',
978
+ * 'increment', 'decrement'.
979
+ */
980
+ export declare enum MetricDefinitionMetricType {
981
+ Time = "time",
982
+ Value = "value"
983
+ }
984
+ /** metric-definitions-list-response */
985
+ export interface MetricDefinitionsListResponse {
986
+ /** The list of metric definitions. */
987
+ metric_definitions: MetricDefinition[];
988
+ /**
989
+ * The cursor used to iterate subsequent results in accordance to the
990
+ * sort order. If not set, then no later elements exist.
991
+ */
992
+ next_cursor?: string;
993
+ /**
994
+ * The cursor used to iterate preceding results in accordance to the
995
+ * sort order. If not set, then no prior elements exist.
996
+ */
997
+ prev_cursor?: string;
998
+ }
999
+ /** opportunity */
1000
+ export type Opportunity = WorkBase;
1001
+ /** Forecast category of the opportunity. */
1002
+ export declare enum OpportunityForecastCategory {
1003
+ BestCase = "best_case",
1004
+ Commit = "commit",
1005
+ MostLikely = "most_likely",
1006
+ Omitted = "omitted",
1007
+ Pipeline = "pipeline",
1008
+ Won = "won"
1009
+ }
1010
+ /** Priority of the opportunity. */
1011
+ export declare enum OpportunityPriority {
1012
+ P0 = "p0",
1013
+ P1 = "p1",
1014
+ P2 = "p2",
1015
+ P3 = "p3"
1016
+ }
1017
+ /** opportunity-summary */
1018
+ export type OpportunitySummary = WorkBaseSummary;
1019
+ /** org-base */
1020
+ export type OrgBase = AtomBase & {
1021
+ /** Name of the Organization. */
1022
+ display_name?: string;
1023
+ };
1024
+ /** org-base-summary */
1025
+ export type OrgBaseSummary = AtomBaseSummary & {
1026
+ /** Name of the Organization. */
1027
+ display_name?: string;
1028
+ };
1029
+ /** The environment of the Org. Defaults to 'production' if not specified. */
1030
+ export declare enum OrgEnvironment {
1031
+ Production = "production",
1032
+ Staging = "staging",
1033
+ Test = "test"
1034
+ }
1035
+ /** org-schedule */
1036
+ export type OrgSchedule = AtomBase & {
1037
+ /** The schedule for each week. */
1038
+ default_weekly_org_schedule?: WeeklyOrgSchedule;
1039
+ /**
1040
+ * The schedule must be valid and well-defined for at least this many
1041
+ * days in the future, otherwise a warning notification is generated.
1042
+ * Default is 0 if not specified.
1043
+ * @format int32
1044
+ */
1045
+ min_valid_days?: number;
1046
+ /** Human-readable name. */
1047
+ name?: string;
1048
+ /**
1049
+ * The list of schedule fragments. It must be an ordered list of
1050
+ * contiguous fragments (the next starting when the previous one
1051
+ * ends), updates in a published schedule are only allowed to add new
1052
+ * ones to the future.
1053
+ */
1054
+ org_schedule_fragments?: OrgScheduleFragmentOverview[];
1055
+ /**
1056
+ * Status determines how an item can be used. In 'draft' status an item
1057
+ * can be edited but can't be used. When 'published' the item can longer
1058
+ * be edited but can be used. 'Archived' is read-only.
1059
+ */
1060
+ status: OrgScheduleStatus;
1061
+ /**
1062
+ * Timezone in which this is defined. Only organization schedules in
1063
+ * the same timezone can be directly combined.
1064
+ */
1065
+ timezone?: string;
1066
+ /**
1067
+ * Derived field indicating when a valid organization schedule will
1068
+ * become invalid. If omitted, the schedule is already invalid. A
1069
+ * schedule is valid if it has a weekly schedule for all named periods
1070
+ * for all its schedule fragments, and if it has a schedule fragment
1071
+ * for the time period in question.
1072
+ * @format date-time
1073
+ */
1074
+ valid_until?: string;
1075
+ /**
1076
+ * If the organization schedule fragment specifies that the given day
1077
+ * belongs to a named period, a weekly schedule from this list with
1078
+ * the matching name will be selected.
1079
+ */
1080
+ weekly_org_schedules?: WeeklyOrgSchedule[];
1081
+ };
1082
+ /** org-schedule-fragment */
1083
+ export type OrgScheduleFragment = AtomBase & {
1084
+ /**
1085
+ * The date (inclusive) on which the organization schedule fragment
1086
+ * begins.
1087
+ * @format date-time
1088
+ */
1089
+ from?: string;
1090
+ /**
1091
+ * Periods during which the schedule is considered to be 'off' or to
1092
+ * be in some specific named period.
1093
+ */
1094
+ intervals?: OrgScheduleInterval[];
1095
+ /** Human-readable name, indicating the purpose of the schedule. */
1096
+ name?: string;
1097
+ /**
1098
+ * CLDR region code of the countries/regions it is meant to be valid
1099
+ * for. Does not drive logic, serves only for easier filtering and
1100
+ * organization.
1101
+ */
1102
+ region_codes?: string[];
1103
+ /**
1104
+ * Status determines how an item can be used. In 'draft' status an item
1105
+ * can be edited but can't be used. When 'published' the item can longer
1106
+ * be edited but can be used. 'Archived' is read-only.
1107
+ */
1108
+ status: OrgScheduleFragmentStatus;
1109
+ /**
1110
+ * The date (exclusive) on which the organization schedule fragment's
1111
+ * validity ends.
1112
+ * @format date-time
1113
+ */
1114
+ to?: string;
1115
+ };
1116
+ /**
1117
+ * org-schedule-fragment-overview
1118
+ * The representation of the organization schedule fragment embedded
1119
+ * inside a organization schedule, used to quickly look up the schedule
1120
+ * fragment for the right period.
1121
+ */
1122
+ export type OrgScheduleFragmentOverview = object;
1123
+ /**
1124
+ * Status determines how an item can be used. In 'draft' status an item
1125
+ * can be edited but can't be used. When 'published' the item can longer
1126
+ * be edited but can be used. 'Archived' is read-only.
1127
+ */
1128
+ export declare enum OrgScheduleFragmentStatus {
1129
+ Archived = "archived",
1130
+ Draft = "draft",
1131
+ Published = "published"
1132
+ }
1133
+ /** org-schedule-fragments-create-request */
1134
+ export interface OrgScheduleFragmentsCreateRequest {
1135
+ /**
1136
+ * Date (inclusive) on which the organization schedule fragment
1137
+ * begins.
1138
+ * @format date-time
1139
+ */
1140
+ from: string;
1141
+ /** The intervals that comprise the schedule fragment. */
1142
+ intervals: CreateOrgScheduleInterval[];
1143
+ /** Name of the organization schedule fragment. */
1144
+ name: string;
1145
+ /**
1146
+ * CLDR region code of the countries/regions it is meant to be valid
1147
+ * for. Does not drive logic, serves only for easier filtering and
1148
+ * organization.
1149
+ */
1150
+ region_codes?: string[];
1151
+ /**
1152
+ * Date (exclusive) on which the organization schedule fragment's
1153
+ * validity ends.
1154
+ * @format date-time
1155
+ */
1156
+ to: string;
1157
+ }
1158
+ /** org-schedule-fragments-create-response */
1159
+ export interface OrgScheduleFragmentsCreateResponse {
1160
+ org_schedule_fragment: OrgScheduleFragment;
1161
+ }
1162
+ /** org-schedule-fragments-get-response */
1163
+ export interface OrgScheduleFragmentsGetResponse {
1164
+ org_schedule_fragment: OrgScheduleFragment;
1165
+ }
1166
+ /** org-schedule-fragments-transition-request */
1167
+ export interface OrgScheduleFragmentsTransitionRequest {
1168
+ /** Organization schedule Fragment ID. */
1169
+ id: string;
1170
+ /**
1171
+ * Status determines how an item can be used. In 'draft' status an item
1172
+ * can be edited but can't be used. When 'published' the item can longer
1173
+ * be edited but can be used. 'Archived' is read-only.
1174
+ */
1175
+ status: OrgScheduleFragmentStatus;
1176
+ }
1177
+ /** org-schedule-fragments-transition-response */
1178
+ export interface OrgScheduleFragmentsTransitionResponse {
1179
+ org_schedule_fragment: OrgScheduleFragment;
1180
+ }
1181
+ /**
1182
+ * org-schedule-interval
1183
+ * An optionally named period on day granularity.
1184
+ */
1185
+ export type OrgScheduleInterval = object;
1186
+ /**
1187
+ * Status determines how an item can be used. In 'draft' status an item
1188
+ * can be edited but can't be used. When 'published' the item can longer
1189
+ * be edited but can be used. 'Archived' is read-only.
1190
+ */
1191
+ export declare enum OrgScheduleStatus {
1192
+ Archived = "archived",
1193
+ Draft = "draft",
1194
+ Published = "published"
1195
+ }
1196
+ /** org-schedules-create-request */
1197
+ export interface OrgSchedulesCreateRequest {
1198
+ default_weekly_org_schedule?: SetWeeklyOrgSchedule;
1199
+ /**
1200
+ * Organization schedule must be valid for at least this many days in
1201
+ * the future. Meaning organization schedule fragments must cover this
1202
+ * period. 0 if omitted.
1203
+ * @format int64
1204
+ */
1205
+ min_valid_days?: number;
1206
+ /** Human-readable name. */
1207
+ name: string;
1208
+ /** List of organization schedule fragments with no overlaps or gaps. */
1209
+ org_schedule_fragments?: SetOrgScheduleFragmentSummary[];
1210
+ /**
1211
+ * Timezone in which the organization schedule applies. Expected to be
1212
+ * a valid IANA time zone name such as America/New_York.
1213
+ */
1214
+ timezone: string;
1215
+ /**
1216
+ * If this day belongs to a named period according to the currently
1217
+ * active organization schedule fragment, a weekly organization
1218
+ * schedule from this list with the corresponding name will apply.
1219
+ */
1220
+ weekly_org_schedules?: SetWeeklyOrgSchedule[];
1221
+ }
1222
+ /** org-schedules-create-response */
1223
+ export interface OrgSchedulesCreateResponse {
1224
+ org_schedule: OrgSchedule;
1225
+ }
1226
+ /** org-schedules-get-response */
1227
+ export interface OrgSchedulesGetResponse {
1228
+ org_schedule: OrgSchedule;
1229
+ }
1230
+ /** org-schedules-list-response */
1231
+ export interface OrgSchedulesListResponse {
1232
+ /**
1233
+ * The cursor used to iterate subsequent results in accordance to the
1234
+ * sort order. If not set, then no later elements exist.
1235
+ */
1236
+ next_cursor?: string;
1237
+ /** The list of organization schedules. */
1238
+ org_schedules: OrgSchedule[];
1239
+ /**
1240
+ * The cursor used to iterate preceding results in accordance to the
1241
+ * sort order. If not set, then no prior elements exist.
1242
+ */
1243
+ prev_cursor?: string;
1244
+ }
1245
+ /** org-schedules-set-future-request */
1246
+ export interface OrgSchedulesSetFutureRequest {
1247
+ /** Organization schedule ID. */
1248
+ id: string;
1249
+ /** Organization schedule Fragment ID. */
1250
+ org_schedule_fragment_id: string;
1251
+ }
1252
+ /** org-schedules-set-future-response */
1253
+ export interface OrgSchedulesSetFutureResponse {
1254
+ org_schedule: OrgSchedule;
1255
+ }
1256
+ /** org-schedules-transition-request */
1257
+ export interface OrgSchedulesTransitionRequest {
1258
+ /** Organization schedule ID. */
1259
+ id: string;
1260
+ /**
1261
+ * Status determines how an item can be used. In 'draft' status an item
1262
+ * can be edited but can't be used. When 'published' the item can longer
1263
+ * be edited but can be used. 'Archived' is read-only.
1264
+ */
1265
+ status: OrgScheduleStatus;
1266
+ }
1267
+ /** org-schedules-transition-response */
1268
+ export interface OrgSchedulesTransitionResponse {
1269
+ org_schedule: OrgSchedule;
1270
+ }
1271
+ /** org-schedules-update-request */
1272
+ export interface OrgSchedulesUpdateRequest {
1273
+ default_weekly_org_schedule?: SetWeeklyOrgSchedule;
1274
+ /** Organization schedule ID. */
1275
+ id: string;
1276
+ /**
1277
+ * Organization schedule must be valid for at least this many days in
1278
+ * the future. Meaning organization schedule fragments must cover this
1279
+ * period. 0 if omitted.
1280
+ * @format int64
1281
+ */
1282
+ min_valid_days?: number;
1283
+ /** Human-readable name. */
1284
+ name?: string;
1285
+ /** List of organization schedule fragments with no overlaps or gaps. */
1286
+ org_schedule_fragments?: SetOrgScheduleFragmentSummary[];
1287
+ /**
1288
+ * Timezone in which the organization schedule applies. Expected to be
1289
+ * a valid IANA time zone name such as America/New_York.
1290
+ */
1291
+ timezone?: string;
1292
+ /**
1293
+ * If this day belongs to a named period according to the currently
1294
+ * active organization schedule fragment, a weekly organization
1295
+ * schedule from this list with the corresponding name will apply.
1296
+ */
1297
+ weekly_org_schedules?: SetWeeklyOrgSchedule[];
1298
+ }
1299
+ /** org-schedules-update-response */
1300
+ export interface OrgSchedulesUpdateResponse {
1301
+ org_schedule: OrgSchedule;
1302
+ }
1303
+ /** org-summary */
1304
+ export type OrgSummary = (AccountSummary | RevOrgSummary) & {
1305
+ type: OrgType;
1306
+ };
1307
+ export declare enum OrgType {
1308
+ Account = "account",
1309
+ RevOrg = "rev_org"
1310
+ }
1311
+ /** part-base-summary */
1312
+ export type PartBaseSummary = AtomBaseSummary & {
1313
+ /** Name of the part. */
1314
+ name: string;
1315
+ };
1316
+ /** part-summary */
1317
+ export type PartSummary = (CapabilitySummary | EnhancementSummary | FeatureSummary | ProductSummary) & {
1318
+ type: PartType;
1319
+ };
1320
+ export declare enum PartType {
1321
+ Capability = "capability",
1322
+ Enhancement = "enhancement",
1323
+ Feature = "feature",
1324
+ Product = "product"
1325
+ }
1326
+ /** product-summary */
1327
+ export type ProductSummary = PartBaseSummary;
1328
+ /** rev-org */
1329
+ export type RevOrg = OrgBase & {
1330
+ /** Custom fields. */
1331
+ custom_fields?: object;
1332
+ /**
1333
+ * Custom schema fragments.
1334
+ * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
1335
+ */
1336
+ custom_schema_fragments?: string[];
1337
+ /** Description of the Rev organization. */
1338
+ description?: string;
1339
+ /** Company's domain name. Example - 'devrev.ai'. */
1340
+ domain?: string;
1341
+ /**
1342
+ * External ref is a unique identifier for the Rev (customer)
1343
+ * organization from your primary customer system of records. If none
1344
+ * is specified, a system-generated identifier will be assigned to the
1345
+ * organization.
1346
+ */
1347
+ external_ref?: string;
1348
+ /**
1349
+ * Stock schema fragment.
1350
+ * @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
1351
+ */
1352
+ stock_schema_fragment?: string;
1353
+ };
1354
+ /** rev-org-summary */
1355
+ export type RevOrgSummary = OrgBaseSummary;
1356
+ /**
1357
+ * rev-orgs-create-request
1358
+ * Request object to create a new Rev organization in the Dev
1359
+ * organization.
1360
+ */
1361
+ export interface RevOrgsCreateRequest {
1362
+ /** Application-defined custom fields. */
1363
+ custom_fields?: object;
1364
+ /**
1365
+ * Schema fragment IDs associated with this Rev organization.
1366
+ * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
1367
+ */
1368
+ custom_schema_fragments?: string[];
1369
+ /** Description of the Rev organization. */
1370
+ description?: string;
1371
+ /** Name of the Rev organization. */
1372
+ display_name: string;
1373
+ /** Company's domain name. Example - 'devrev.ai'. */
1374
+ domain?: string;
1375
+ /** The environment of the Org. Defaults to 'production' if not specified. */
1376
+ environment?: OrgEnvironment;
1377
+ /**
1378
+ * External ref is a custom unique identifier which is a reference to
1379
+ * an unique id for this organization's data in some system of
1380
+ * records.
1381
+ */
1382
+ external_ref?: string;
1383
+ /** The tier of the RevOrg. */
1384
+ tier?: string;
1385
+ }
1386
+ /**
1387
+ * rev-orgs-create-response
1388
+ * Response object for request to create a new Rev organization.
1389
+ */
1390
+ export interface RevOrgsCreateResponse {
1391
+ rev_org: RevOrg;
1392
+ }
1393
+ /**
1394
+ * rev-orgs-get-response
1395
+ * The response to getting a Rev organization's information.
1396
+ */
1397
+ export interface RevOrgsGetResponse {
1398
+ rev_org: RevOrg;
1399
+ }
1400
+ /**
1401
+ * rev-orgs-list-response
1402
+ * The response to getting a list of Rev organizations' information.
1403
+ */
1404
+ export interface RevOrgsListResponse {
1405
+ /**
1406
+ * The cursor used to iterate subsequent results in accordance to the
1407
+ * sort order. If not set, then no later elements exist.
1408
+ */
1409
+ next_cursor?: string;
1410
+ /**
1411
+ * The cursor used to iterate preceding results in accordance to the
1412
+ * sort order. If not set, then no prior elements exist.
1413
+ */
1414
+ prev_cursor?: string;
1415
+ /** List with all of the Rev organizations' information. */
1416
+ rev_orgs: RevOrg[];
1417
+ }
1418
+ /**
1419
+ * rev-orgs-update-request
1420
+ * Request object to update information of the Rev organization.
1421
+ */
1422
+ export interface RevOrgsUpdateRequest {
1423
+ /**
1424
+ * Schema fragment IDs associated with this Rev organization.
1425
+ * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
1426
+ */
1427
+ custom_schema_fragments?: string[];
1428
+ /** Description of the Rev organization. */
1429
+ description?: string;
1430
+ /** Customer chosen name for the Rev organization. */
1431
+ display_name?: string;
1432
+ /** Company's domain name. Example - 'devrev.ai'. */
1433
+ domain?: string;
1434
+ /** The environment of the Org. Defaults to 'production' if not specified. */
1435
+ environment?: OrgEnvironment;
1436
+ /**
1437
+ * External ref is a custom unique identifier which is a reference to
1438
+ * an unique id for this organization's data in some system of
1439
+ * records.
1440
+ */
1441
+ external_ref?: string;
1442
+ /**
1443
+ * The ID of Rev organization to update.
1444
+ * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
1445
+ */
1446
+ id: string;
1447
+ /** The tier of the RevOrg. */
1448
+ tier?: string;
1449
+ }
1450
+ /**
1451
+ * rev-orgs-update-response
1452
+ * Response object to updating Rev organization's information.
1453
+ */
1454
+ export interface RevOrgsUpdateResponse {
1455
+ rev_org: RevOrg;
1456
+ }
1457
+ /** rev-user */
1458
+ export type RevUser = UserBase & {
1459
+ /** Custom fields. */
1460
+ custom_fields?: object;
1461
+ /**
1462
+ * Custom schema fragments.
1463
+ * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
1464
+ */
1465
+ custom_schema_fragments?: string[];
1466
+ /** Description of the Rev user. */
1467
+ description?: string;
1468
+ /**
1469
+ * External ref is a mutable unique identifier for a user within the
1470
+ * Rev organization from your primary customer record. If none is
1471
+ * available, a good alternative is the email address/phone number
1472
+ * which could uniquely identify the user. If none is specified, a
1473
+ * system-generated identifier will be assigned to the user.
1474
+ */
1475
+ external_ref?: string;
1476
+ rev_org?: OrgSummary;
1477
+ /**
1478
+ * Stock schema fragment.
1479
+ * @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
1480
+ */
1481
+ stock_schema_fragment?: string;
1482
+ };
1483
+ /** rev-user-summary */
1484
+ export type RevUserSummary = UserBaseSummary & {
1485
+ /**
1486
+ * External ref is a mutable unique identifier for a user within the
1487
+ * Rev organization from your primary customer record. If none is
1488
+ * available, a good alternative is the email address/phone number
1489
+ * which could uniquely identify the user. If none is specified, a
1490
+ * system-generated identifier will be assigned to the user.
1491
+ */
1492
+ external_ref?: string;
1493
+ rev_org?: OrgSummary;
1494
+ };
1495
+ /**
1496
+ * rev-users-create-request
1497
+ * Request object to create a new Rev user for a Rev organization.
1498
+ */
1499
+ export interface RevUsersCreateRequest {
1500
+ /** Application-defined custom fields. */
1501
+ custom_fields?: object;
1502
+ /**
1503
+ * The schema fragment IDs associated with the Rev user.
1504
+ * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
1505
+ */
1506
+ custom_schema_fragments?: string[];
1507
+ /** Description of the Rev user. */
1508
+ description?: string;
1509
+ /** The user's display name. The name is non-unique and mutable. */
1510
+ display_name?: string;
1511
+ /** Email address of the Rev user. */
1512
+ email?: string;
1513
+ /**
1514
+ * External ref is a mutable unique identifier for a user within the
1515
+ * Dev organization from your primary customer record. If none is
1516
+ * available, a good alternative is the email address/phone number
1517
+ * which could uniquely identify the user. If none is specified, a
1518
+ * system-generated identifier will be assigned to the user.
1519
+ */
1520
+ external_ref?: string;
1521
+ /** Phone numbers of the Rev user. */
1522
+ phone_numbers?: string[];
1523
+ /**
1524
+ * The ID of Rev organization for which a Rev user is to be created.
1525
+ * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
1526
+ */
1527
+ rev_org?: string;
1528
+ }
1529
+ /**
1530
+ * rev-users-create-response
1531
+ * Response object for creating a new Rev user for Rev organization.
1532
+ */
1533
+ export interface RevUsersCreateResponse {
1534
+ rev_user: RevUser;
1535
+ }
1536
+ /**
1537
+ * rev-users-delete-request
1538
+ * Request object to delete a Rev user.
1539
+ */
1540
+ export interface RevUsersDeleteRequest {
1541
+ /** The ID of Rev user to delete. */
1542
+ id: string;
1543
+ }
1544
+ /**
1545
+ * rev-users-delete-response
1546
+ * The response to deleting a Rev user of a Rev organization.
1547
+ */
1548
+ export type RevUsersDeleteResponse = object;
1549
+ /**
1550
+ * rev-users-get-response
1551
+ * The returned Rev user.
1552
+ */
1553
+ export interface RevUsersGetResponse {
1554
+ rev_user: RevUser;
1555
+ }
1556
+ /**
1557
+ * rev-users-list-response
1558
+ * The response to listing all Rev users matching the filter criteria.
1559
+ */
1560
+ export interface RevUsersListResponse {
1561
+ /**
1562
+ * The cursor used to iterate subsequent results in accordance to the
1563
+ * sort order. If not set, then no later elements exist.
1564
+ */
1565
+ next_cursor?: string;
1566
+ /**
1567
+ * The cursor used to iterate preceding results in accordance to the
1568
+ * sort order. If not set, then no prior elements exist.
1569
+ */
1570
+ prev_cursor?: string;
1571
+ /** List containing all the Rev users. */
1572
+ rev_users: RevUser[];
1573
+ }
1574
+ /**
1575
+ * rev-users-update-request
1576
+ * Request to update details of a Rev user.
1577
+ */
1578
+ export interface RevUsersUpdateRequest {
1579
+ /** Application-defined custom fields. */
1580
+ custom_fields?: object;
1581
+ custom_schema_fragments?: RevUsersUpdateRequestCustomSchemaFragments;
1582
+ /** Updated description of the Rev user. */
1583
+ description?: string;
1584
+ /** Updated display name of the Rev user. */
1585
+ display_name?: string;
1586
+ /** Updated email address of the Rev user. */
1587
+ email?: string;
1588
+ /** Updated external ref value of the Rev user. */
1589
+ external_ref?: string;
1590
+ /** The ID of Rev user to update. */
1591
+ id: string;
1592
+ }
1593
+ /** rev-users-update-request-custom-schema-fragments */
1594
+ export interface RevUsersUpdateRequestCustomSchemaFragments {
1595
+ /**
1596
+ * Sets the IDs to the provided schema fragment IDs.
1597
+ * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
1598
+ */
1599
+ set?: string[];
1600
+ }
1601
+ /**
1602
+ * rev-users-update-response
1603
+ * Updated Rev user object.
1604
+ */
1605
+ export interface RevUsersUpdateResponse {
1606
+ rev_user: RevUser;
1607
+ }
1608
+ /** schema-bool-field-descriptor */
1609
+ export type SchemaBoolFieldDescriptor = SchemaFieldDescriptorBase & {
1610
+ /** Default value. */
1611
+ default_value?: boolean;
1612
+ };
1613
+ /** schema-bool-list-field-descriptor */
1614
+ export type SchemaBoolListFieldDescriptor = SchemaFieldDescriptorBase & {
1615
+ /** Default value. */
1616
+ default_value?: boolean[];
1617
+ };
1618
+ /** schema-composite-field-descriptor */
1619
+ export type SchemaCompositeFieldDescriptor = SchemaFieldDescriptorBase & {
1620
+ /** Composite type. Required when field type is composite. */
1621
+ composite_type?: string;
1622
+ };
1623
+ /** schema-composite-list-field-descriptor */
1624
+ export type SchemaCompositeListFieldDescriptor = SchemaFieldDescriptorBase & {
1625
+ /** Composite type. Required when field type is composite. */
1626
+ composite_type?: string;
1627
+ };
1628
+ /** schema-date-field-descriptor */
1629
+ export type SchemaDateFieldDescriptor = SchemaFieldDescriptorBase & {
1630
+ /** Default value. */
1631
+ default_value?: string;
1632
+ };
1633
+ /** schema-date-list-field-descriptor */
1634
+ export type SchemaDateListFieldDescriptor = SchemaFieldDescriptorBase & {
1635
+ /** Default value. */
1636
+ default_value?: string[];
1637
+ };
1638
+ /** schema-double-field-descriptor */
1639
+ export type SchemaDoubleFieldDescriptor = SchemaFieldDescriptorBase & {
1640
+ /**
1641
+ * Default value.
1642
+ * @format double
1643
+ */
1644
+ default_value?: number;
1645
+ };
1646
+ /** schema-double-list-field-descriptor */
1647
+ export type SchemaDoubleListFieldDescriptor = SchemaFieldDescriptorBase & {
1648
+ /** Default value. */
1649
+ default_value?: number[];
1650
+ };
1651
+ /** schema-enum-field-descriptor */
1652
+ export type SchemaEnumFieldDescriptor = SchemaFieldDescriptorBase & {
1653
+ /** Allowed values for the field. */
1654
+ allowed_values: string[];
1655
+ /** Default value. */
1656
+ default_value?: string;
1657
+ };
1658
+ /** schema-enum-list-field-descriptor */
1659
+ export type SchemaEnumListFieldDescriptor = SchemaFieldDescriptorBase & {
1660
+ /** Allowed values for the field. */
1661
+ allowed_values: string[];
1662
+ /** Default value. */
1663
+ default_value?: string[];
1664
+ };
1665
+ /**
1666
+ * schema-field-descriptor
1667
+ * Set of field attributes.
1668
+ */
1669
+ export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor) & {
1670
+ field_type: SchemaFieldDescriptorFieldType;
1671
+ };
1672
+ /** schema-field-descriptor-array-type */
1673
+ export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor) & {
1674
+ base_type: SchemaFieldDescriptorArrayTypeBaseType;
1675
+ /**
1676
+ * The maximum array length.
1677
+ * @format int64
1678
+ */
1679
+ max_items?: number;
1680
+ /**
1681
+ * The minimum array length.
1682
+ * @format int64
1683
+ */
1684
+ min_items?: number;
1685
+ };
1686
+ export declare enum SchemaFieldDescriptorArrayTypeBaseType {
1687
+ Bool = "bool",
1688
+ Composite = "composite",
1689
+ Date = "date",
1690
+ Double = "double",
1691
+ Enum = "enum",
1692
+ Id = "id",
1693
+ Int = "int",
1694
+ RichText = "rich_text",
1695
+ Text = "text",
1696
+ Timestamp = "timestamp",
1697
+ Tokens = "tokens"
1698
+ }
1699
+ /** schema-field-descriptor-base */
1700
+ export interface SchemaFieldDescriptorBase {
1701
+ /** Description of the field. */
1702
+ description?: string;
1703
+ /** Whether this field is filterable, groupable and sortable. */
1704
+ is_filterable?: boolean;
1705
+ /**
1706
+ * Whether this field can hold Personally Identifiable Information
1707
+ * (PII).
1708
+ */
1709
+ is_pii?: boolean;
1710
+ /** Whether this field is required or not. */
1711
+ is_required?: boolean;
1712
+ /** The schema of MFZ specific fields. */
1713
+ mfz?: SchemaFieldMfzMetadata;
1714
+ /** Name of the field. */
1715
+ name: string;
1716
+ /** Type this field is from. */
1717
+ origin?: string;
1718
+ /** The schema of ui specific fields. */
1719
+ ui?: SchemaFieldUiMetadata;
1720
+ }
1721
+ export declare enum SchemaFieldDescriptorFieldType {
1722
+ Array = "array",
1723
+ Bool = "bool",
1724
+ Composite = "composite",
1725
+ Date = "date",
1726
+ Double = "double",
1727
+ Enum = "enum",
1728
+ Id = "id",
1729
+ Int = "int",
1730
+ RichText = "rich_text",
1731
+ Text = "text",
1732
+ Timestamp = "timestamp",
1733
+ Tokens = "tokens"
1734
+ }
1735
+ /**
1736
+ * schema-field-mfz-metadata
1737
+ * The schema of MFZ specific fields.
1738
+ */
1739
+ export type SchemaFieldMfzMetadata = object;
1740
+ /**
1741
+ * schema-field-ui-metadata
1742
+ * The schema of ui specific fields.
1743
+ */
1744
+ export interface SchemaFieldUiMetadata {
1745
+ /** Display name of the field. */
1746
+ display_name?: string;
1747
+ }
1748
+ /** schema-id-field-descriptor */
1749
+ export type SchemaIdFieldDescriptor = SchemaFieldDescriptorBase & {
1750
+ /** Default value. */
1751
+ default_value?: string;
1752
+ /** Object ID types. Required when field type is ID. */
1753
+ id_type?: string[];
1754
+ };
1755
+ /** schema-id-list-field-descriptor */
1756
+ export type SchemaIdListFieldDescriptor = SchemaFieldDescriptorBase & {
1757
+ /** Default value. */
1758
+ default_value?: string[];
1759
+ /** Object ID types. Required when field type is ID. */
1760
+ id_type?: string[];
1761
+ };
1762
+ /** schema-int-field-descriptor */
1763
+ export type SchemaIntFieldDescriptor = SchemaFieldDescriptorBase & {
1764
+ /**
1765
+ * Default value.
1766
+ * @format int64
1767
+ */
1768
+ default_value?: number;
1769
+ /**
1770
+ * The minimum value for the integer (exclusive).
1771
+ * @format int64
1772
+ */
1773
+ gt?: number;
1774
+ /**
1775
+ * The minimum value for the integer (inclusive).
1776
+ * @format int64
1777
+ */
1778
+ gte?: number;
1779
+ /**
1780
+ * The maximum value for the integer (exclusive).
1781
+ * @format int64
1782
+ */
1783
+ lt?: number;
1784
+ /**
1785
+ * The maximum value for the integer (inclusive).
1786
+ * @format int64
1787
+ */
1788
+ lte?: number;
1789
+ };
1790
+ /** schema-int-list-field-descriptor */
1791
+ export type SchemaIntListFieldDescriptor = SchemaFieldDescriptorBase & {
1792
+ /** Default value. */
1793
+ default_value?: number[];
1794
+ /**
1795
+ * The minimum value for the integer (exclusive).
1796
+ * @format int64
1797
+ */
1798
+ gt?: number;
1799
+ /**
1800
+ * The minimum value for the integer (inclusive).
1801
+ * @format int64
1802
+ */
1803
+ gte?: number;
1804
+ /**
1805
+ * The maximum value for the integer (exclusive).
1806
+ * @format int64
1807
+ */
1808
+ lt?: number;
1809
+ /**
1810
+ * The maximum value for the integer (inclusive).
1811
+ * @format int64
1812
+ */
1813
+ lte?: number;
1814
+ };
1815
+ /** schema-rich-text-field-descriptor */
1816
+ export type SchemaRichTextFieldDescriptor = SchemaFieldDescriptorBase & {
1817
+ /** The contained substring. */
1818
+ contains?: string;
1819
+ /** Default value. */
1820
+ default_value?: string;
1821
+ /**
1822
+ * The exact string length.
1823
+ * @format int64
1824
+ */
1825
+ eq_len?: number;
1826
+ /**
1827
+ * The maximum string length.
1828
+ * @format int64
1829
+ */
1830
+ max_len?: number;
1831
+ /**
1832
+ * The minimum string length.
1833
+ * @format int64
1834
+ */
1835
+ min_len?: number;
1836
+ /** The string pattern (regular expression). */
1837
+ pattern?: string;
1838
+ /** The string prefix. */
1839
+ prefix?: string;
1840
+ /** The string suffix. */
1841
+ suffix?: string;
1842
+ };
1843
+ /** schema-rich-text-list-field-descriptor */
1844
+ export type SchemaRichTextListFieldDescriptor = SchemaFieldDescriptorBase & {
1845
+ /** The contained substring. */
1846
+ contains?: string;
1847
+ /** Default value. */
1848
+ default_value?: string[];
1849
+ /**
1850
+ * The exact string length.
1851
+ * @format int64
1852
+ */
1853
+ eq_len?: number;
1854
+ /**
1855
+ * The maximum string length.
1856
+ * @format int64
1857
+ */
1858
+ max_len?: number;
1859
+ /**
1860
+ * The minimum string length.
1861
+ * @format int64
1862
+ */
1863
+ min_len?: number;
1864
+ /** The string pattern (regular expression). */
1865
+ pattern?: string;
1866
+ /** The string prefix. */
1867
+ prefix?: string;
1868
+ /** The string suffix. */
1869
+ suffix?: string;
1870
+ };
1871
+ /** schema-text-field-descriptor */
1872
+ export type SchemaTextFieldDescriptor = SchemaFieldDescriptorBase & {
1873
+ /** The contained substring. */
1874
+ contains?: string;
1875
+ /** Default value. */
1876
+ default_value?: string;
1877
+ /**
1878
+ * The exact string length.
1879
+ * @format int64
1880
+ */
1881
+ eq_len?: number;
1882
+ /**
1883
+ * The maximum string length.
1884
+ * @format int64
1885
+ */
1886
+ max_len?: number;
1887
+ /**
1888
+ * The minimum string length.
1889
+ * @format int64
1890
+ */
1891
+ min_len?: number;
1892
+ /** The string pattern (regular expression). */
1893
+ pattern?: string;
1894
+ /** The string prefix. */
1895
+ prefix?: string;
1896
+ /** The string suffix. */
1897
+ suffix?: string;
1898
+ };
1899
+ /** schema-text-list-field-descriptor */
1900
+ export type SchemaTextListFieldDescriptor = SchemaFieldDescriptorBase & {
1901
+ /** The contained substring. */
1902
+ contains?: string;
1903
+ /** Default value. */
1904
+ default_value?: string[];
1905
+ /**
1906
+ * The exact string length.
1907
+ * @format int64
1908
+ */
1909
+ eq_len?: number;
1910
+ /**
1911
+ * The maximum string length.
1912
+ * @format int64
1913
+ */
1914
+ max_len?: number;
1915
+ /**
1916
+ * The minimum string length.
1917
+ * @format int64
1918
+ */
1919
+ min_len?: number;
1920
+ /** The string pattern (regular expression). */
1921
+ pattern?: string;
1922
+ /** The string prefix. */
1923
+ prefix?: string;
1924
+ /** The string suffix. */
1925
+ suffix?: string;
1926
+ };
1927
+ /** schema-timestamp-field-descriptor */
1928
+ export type SchemaTimestampFieldDescriptor = SchemaFieldDescriptorBase & {
1929
+ /** Default value. */
1930
+ default_value?: string;
1931
+ };
1932
+ /** schema-timestamp-list-field-descriptor */
1933
+ export type SchemaTimestampListFieldDescriptor = SchemaFieldDescriptorBase & {
1934
+ /** Default value. */
1935
+ default_value?: string[];
1936
+ };
1937
+ /** schema-tokens-field-descriptor */
1938
+ export type SchemaTokensFieldDescriptor = SchemaFieldDescriptorBase & {
1939
+ /** The contained substring. */
1940
+ contains?: string;
1941
+ /** Default value. */
1942
+ default_value?: string;
1943
+ /**
1944
+ * The exact string length.
1945
+ * @format int64
1946
+ */
1947
+ eq_len?: number;
1948
+ /**
1949
+ * The maximum string length.
1950
+ * @format int64
1951
+ */
1952
+ max_len?: number;
1953
+ /**
1954
+ * The minimum string length.
1955
+ * @format int64
1956
+ */
1957
+ min_len?: number;
1958
+ /** The string pattern (regular expression). */
1959
+ pattern?: string;
1960
+ /** The string prefix. */
1961
+ prefix?: string;
1962
+ /** The string suffix. */
1963
+ suffix?: string;
1964
+ };
1965
+ /** schema-tokens-list-field-descriptor */
1966
+ export type SchemaTokensListFieldDescriptor = SchemaFieldDescriptorBase & {
1967
+ /** The contained substring. */
1968
+ contains?: string;
1969
+ /** Default value. */
1970
+ default_value?: string[];
1971
+ /**
1972
+ * The exact string length.
1973
+ * @format int64
1974
+ */
1975
+ eq_len?: number;
1976
+ /**
1977
+ * The maximum string length.
1978
+ * @format int64
1979
+ */
1980
+ max_len?: number;
1981
+ /**
1982
+ * The minimum string length.
1983
+ * @format int64
1984
+ */
1985
+ min_len?: number;
1986
+ /** The string pattern (regular expression). */
1987
+ pattern?: string;
1988
+ /** The string prefix. */
1989
+ prefix?: string;
1990
+ /** The string suffix. */
1991
+ suffix?: string;
1992
+ };
1993
+ /** set-org-schedule-fragment-summary */
1994
+ export interface SetOrgScheduleFragmentSummary {
1995
+ /** Organization schedule fragment ID. */
1996
+ id: string;
1997
+ }
1998
+ /** set-sla-policy */
1999
+ export interface SetSlaPolicy {
2000
+ /** Metrics to apply to the selected items. */
2001
+ metrics?: SetSupportMetricTarget[];
2002
+ /** Human-readable name. */
2003
+ name: string;
2004
+ selector: SetSlaSelector;
2005
+ }
2006
+ /** set-sla-selector */
2007
+ export interface SetSlaSelector {
2008
+ /** The item type for which the SLA policy applies. */
2009
+ applies_to: SlaSelectorAppliesTo;
2010
+ /**
2011
+ * Custom fields with their fully qualified names and associated with
2012
+ * their exact allowed values. The SLA policy applies to records where
2013
+ * all named custom fields have exactly the specified values. If the
2014
+ * value is null, the field must have null value or not be present.
2015
+ */
2016
+ custom_fields?: object;
2017
+ /**
2018
+ * The SLA policy applies to the tickets of these parts.
2019
+ * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
2020
+ */
2021
+ parts?: string[];
2022
+ /** The SLA policy applies to conversations with these priorities. */
2023
+ priority?: SlaSelectorPriority[];
2024
+ /** The SLA policy applies to tickets with these severities. */
2025
+ severity?: SlaSelectorSeverity[];
2026
+ /** The SLA policy applies to conversations with these sources. */
2027
+ source_channel?: string[];
2028
+ /**
2029
+ * The SLA policy applies to items with these tags.
2030
+ * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
2031
+ */
2032
+ tags?: string[];
2033
+ }
2034
+ /** set-support-metric-target */
2035
+ export interface SetSupportMetricTarget {
2036
+ /** The metric to apply. */
2037
+ metric: string;
2038
+ /**
2039
+ * The organization schedule controlling this metrics calculation.
2040
+ * Time based metrics don't consume time while their schedule is off.
2041
+ */
2042
+ org_schedule_id?: string;
2043
+ /**
2044
+ * The percentage of instances for which this metric's target must not
2045
+ * be breached, in order to avoid breaching the overall SLA policy.
2046
+ * @format double
2047
+ */
2048
+ performance?: number;
2049
+ /**
2050
+ * The target value to be achieved, for example the time in which to
2051
+ * do something, or the maximum allowed number of message pairs. The
2052
+ * units and interpretation of the value is controlled by the
2053
+ * properties of the referenced metric.
2054
+ * @format int32
2055
+ */
2056
+ target: number;
2057
+ /**
2058
+ * The threshold in the same units as target where the metric is
2059
+ * considered to be 'at risk'.
2060
+ * @format int32
2061
+ */
2062
+ warning_target?: number;
2063
+ }
2064
+ /** set-tag-with-value */
2065
+ export interface SetTagWithValue {
2066
+ /**
2067
+ * The ID of the tag.
2068
+ * @example "don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"
2069
+ */
2070
+ id: string;
2071
+ /**
2072
+ * The value for the object's association with the tag. If specified,
2073
+ * the value must be one that's specified in the tag's allowed values.
2074
+ */
2075
+ value?: string;
2076
+ }
2077
+ /** set-weekly-org-schedule */
2078
+ export interface SetWeeklyOrgSchedule {
2079
+ /** The 'on' intervals of the week. */
2080
+ intervals: CreateWeeklyOrgScheduleInterval[];
2081
+ /**
2082
+ * The name of the period during which the organization schedule
2083
+ * applies.
2084
+ */
2085
+ period_name: string;
2086
+ }
2087
+ /** sla */
2088
+ export type Sla = AtomBase & {
2089
+ /**
2090
+ * Describes the compensation to be provided in case of SLA breach. It is
2091
+ * not 'self-executing', it is the responsibility of the organization
2092
+ * providing the SLA to actually transfer the promised credit, resource or
2093
+ * other payment.
2094
+ */
2095
+ compensation?: SlaCompensation;
2096
+ /** Description of the purpose and capabilities of the SLA. */
2097
+ description?: string;
2098
+ /**
2099
+ * Specifies the frequency of when the contractually-meaningful evaluation
2100
+ * of the SLA happens. The organization for their own information might
2101
+ * evaluate the various metrics contained in the policy as often as we can
2102
+ * make it feasible for them, but only the evaluation at the end of the
2103
+ * evaluation period triggers a compensation and needs to be shared with
2104
+ * the customer.
2105
+ */
2106
+ evaluation_period?: SlaEvaluationPeriod;
2107
+ /** Human-readable name. */
2108
+ name: string;
2109
+ /**
2110
+ * The policies encompassed by this SLA, ordered in decreasing
2111
+ * priority.
2112
+ */
2113
+ policies?: SlaPolicy[];
2114
+ /**
2115
+ * Status determines how an item can be used. In 'draft' status an item
2116
+ * can be edited but can't be used. When 'published' the item can longer
2117
+ * be edited but can be used. 'Archived' is read-only.
2118
+ */
2119
+ status: SlaStatus;
2120
+ };
2121
+ /** sla-assign-result */
2122
+ export interface SlaAssignResult {
2123
+ error?: Error;
2124
+ rev_org: RevOrgSummary;
2125
+ }
2126
+ /**
2127
+ * sla-compensation
2128
+ * Describes the compensation to be provided in case of SLA breach. It is
2129
+ * not 'self-executing', it is the responsibility of the organization
2130
+ * providing the SLA to actually transfer the promised credit, resource or
2131
+ * other payment.
2132
+ */
2133
+ export type SlaCompensation = object;
2134
+ /**
2135
+ * Specifies the frequency of when the contractually-meaningful evaluation
2136
+ * of the SLA happens. The organization for their own information might
2137
+ * evaluate the various metrics contained in the policy as often as we can
2138
+ * make it feasible for them, but only the evaluation at the end of the
2139
+ * evaluation period triggers a compensation and needs to be shared with
2140
+ * the customer.
2141
+ */
2142
+ export declare enum SlaEvaluationPeriod {
2143
+ Monthly = "monthly",
2144
+ Quarterly = "quarterly",
2145
+ Weekly = "weekly",
2146
+ Yearly = "yearly"
2147
+ }
2148
+ /**
2149
+ * sla-policy
2150
+ * A policy that represents a promise to your revs.
2151
+ */
2152
+ export type SlaPolicy = object;
2153
+ /** The item type for which the SLA policy applies. */
2154
+ export declare enum SlaSelectorAppliesTo {
2155
+ Conversation = "conversation",
2156
+ Ticket = "ticket"
2157
+ }
2158
+ /** Th SLA policy applies to conversations with these priorities. */
2159
+ export declare enum SlaSelectorPriority {
2160
+ P0 = "p0",
2161
+ P1 = "p1",
2162
+ P2 = "p2"
2163
+ }
2164
+ /** The SLA policy applies to tickets with these severities. */
2165
+ export declare enum SlaSelectorSeverity {
2166
+ Blocker = "blocker",
2167
+ High = "high",
2168
+ Low = "low",
2169
+ Medium = "medium"
2170
+ }
2171
+ /**
2172
+ * Status determines how an item can be used. In 'draft' status an item
2173
+ * can be edited but can't be used. When 'published' the item can longer
2174
+ * be edited but can be used. 'Archived' is read-only.
2175
+ */
2176
+ export declare enum SlaStatus {
2177
+ Archived = "archived",
2178
+ Draft = "draft",
2179
+ Published = "published"
2180
+ }
2181
+ /** slas-assign-request */
2182
+ export interface SlasAssignRequest {
2183
+ /**
2184
+ * The SLA which would be assigned to the Rev organizations. If
2185
+ * omitted, the SLA of all the rev organizations referenced will be
2186
+ * unset.
2187
+ */
2188
+ id?: string;
2189
+ /**
2190
+ * The Rev organizations to apply the SLA to.
2191
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
2192
+ */
2193
+ rev_orgs: string[];
2194
+ }
2195
+ /** slas-assign-response */
2196
+ export interface SlasAssignResponse {
2197
+ /** The list of outcomes for each Rev organization. */
2198
+ results: SlaAssignResult[];
2199
+ }
2200
+ /** slas-create-request */
2201
+ export interface SlasCreateRequest {
2202
+ /** Description of the purpose and capabilities of the SLA. */
2203
+ description?: string;
2204
+ /**
2205
+ * Specifies the frequency of when the contractually-meaningful evaluation
2206
+ * of the SLA happens. The organization for their own information might
2207
+ * evaluate the various metrics contained in the policy as often as we can
2208
+ * make it feasible for them, but only the evaluation at the end of the
2209
+ * evaluation period triggers a compensation and needs to be shared with
2210
+ * the customer.
2211
+ */
2212
+ evaluation_period?: SlaEvaluationPeriod;
2213
+ /** Human-readable name. */
2214
+ name: string;
2215
+ /**
2216
+ * The policies encompassed by this SLA, ordered in decreasing
2217
+ * priority.
2218
+ */
2219
+ policies?: SetSlaPolicy[];
2220
+ }
2221
+ /** slas-create-response */
2222
+ export interface SlasCreateResponse {
2223
+ sla: Sla;
2224
+ }
2225
+ /** slas-get-response */
2226
+ export interface SlasGetResponse {
2227
+ sla: Sla;
2228
+ }
2229
+ /** slas-list-response */
2230
+ export interface SlasListResponse {
2231
+ /**
2232
+ * The cursor used to iterate subsequent results in accordance to the
2233
+ * sort order. If not set, then no later elements exist.
2234
+ */
2235
+ next_cursor?: string;
2236
+ /**
2237
+ * The cursor used to iterate preceding results in accordance to the
2238
+ * sort order. If not set, then no prior elements exist.
2239
+ */
2240
+ prev_cursor?: string;
2241
+ /** The list of SLAs. */
2242
+ slas: Sla[];
2243
+ }
2244
+ /** slas-transition-request */
2245
+ export interface SlasTransitionRequest {
2246
+ /** The updated SLA. */
2247
+ id: string;
2248
+ /**
2249
+ * Status determines how an item can be used. In 'draft' status an item
2250
+ * can be edited but can't be used. When 'published' the item can longer
2251
+ * be edited but can be used. 'Archived' is read-only.
2252
+ */
2253
+ status: SlaStatus;
2254
+ }
2255
+ /** slas-transition-response */
2256
+ export interface SlasTransitionResponse {
2257
+ sla: Sla;
2258
+ }
2259
+ /** slas-update-request */
2260
+ export interface SlasUpdateRequest {
2261
+ /** Description of the purpose and capabilities of the SLA. */
2262
+ description?: string;
2263
+ /**
2264
+ * Specifies the frequency of when the contractually-meaningful evaluation
2265
+ * of the SLA happens. The organization for their own information might
2266
+ * evaluate the various metrics contained in the policy as often as we can
2267
+ * make it feasible for them, but only the evaluation at the end of the
2268
+ * evaluation period triggers a compensation and needs to be shared with
2269
+ * the customer.
2270
+ */
2271
+ evaluation_period?: SlaEvaluationPeriod;
2272
+ /** The SLA's ID. */
2273
+ id: string;
2274
+ /** Human-readable name. */
2275
+ name?: string;
2276
+ /**
2277
+ * The policies encompassed by this SLA, ordered in decreasing
2278
+ * priority, the whole array will be overwritten by the contents of
2279
+ * this array.
2280
+ */
2281
+ policies?: SetSlaPolicy[];
2282
+ }
2283
+ /** slas-update-response */
2284
+ export interface SlasUpdateResponse {
2285
+ sla: Sla;
2286
+ }
2287
+ /**
2288
+ * stage
2289
+ * Describes the current stage of a work item.
2290
+ */
2291
+ export interface Stage {
2292
+ /** Current stage name of the work item. */
2293
+ name: string;
2294
+ }
2295
+ /**
2296
+ * stage-init
2297
+ * Sets an object's initial stage.
2298
+ */
2299
+ export interface StageInit {
2300
+ /** The name of the stage. */
2301
+ name?: string;
2302
+ }
2303
+ /**
2304
+ * stage-update
2305
+ * Updates an object's stage.
2306
+ */
2307
+ export interface StageUpdate {
2308
+ /** The updated name of the stage, otherwise unchanged if not set. */
2309
+ name?: string;
2310
+ }
2311
+ /**
2312
+ * stock-field-enum-override
2313
+ * Override for the allowed values of a stock field enum.
2314
+ */
2315
+ export type StockFieldEnumOverride = object;
2316
+ /** subtype */
2317
+ export interface Subtype {
2318
+ /** Display name of the subtype. */
2319
+ display_name?: string;
2320
+ /** DON of the custom type fragment this subtype belongs to. */
2321
+ fragment_id: string;
2322
+ /** Leaf type for the subtype. */
2323
+ leaf_type: string;
2324
+ /** Value of the subtype. */
2325
+ value: string;
2326
+ }
2327
+ /** subtypes-list-response */
2328
+ export interface SubtypesListResponse {
2329
+ /** List of subtypes. */
2330
+ subtypes: Subtype[];
2331
+ }
2332
+ /** sys-user */
2333
+ export type SysUser = UserBase;
2334
+ /** sys-user-summary */
2335
+ export type SysUserSummary = UserBaseSummary;
2336
+ /**
2337
+ * sys-users-list-response
2338
+ * The response to listing the system users.
2339
+ */
2340
+ export interface SysUsersListResponse {
2341
+ /**
2342
+ * The cursor used to iterate subsequent results in accordance to the
2343
+ * sort order. If not set, then no later elements exist.
2344
+ */
2345
+ next_cursor?: string;
2346
+ /**
2347
+ * The cursor used to iterate preceding results in accordance to the
2348
+ * sort order. If not set, then no prior elements exist.
2349
+ */
2350
+ prev_cursor?: string;
2351
+ /** The list of system users. */
2352
+ sys_users: SysUser[];
2353
+ }
2354
+ /**
2355
+ * sys-users-update-request
2356
+ * Request to update information of the system user.
2357
+ */
2358
+ export interface SysUsersUpdateRequest {
2359
+ /** Updated display name for the system user. */
2360
+ display_name?: string;
2361
+ /**
2362
+ * Artifact ID of the system user's new display picture.
2363
+ * @example "don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"
2364
+ */
2365
+ display_picture?: string | null;
2366
+ /** Updated full name for the system user. */
2367
+ full_name?: string;
2368
+ /** The ID of system user to update. */
2369
+ id: string;
2370
+ }
2371
+ /**
2372
+ * sys-users-update-response
2373
+ * Updated Sys user object.
2374
+ */
2375
+ export interface SysUsersUpdateResponse {
2376
+ sys_user: SysUser;
2377
+ }
2378
+ /** tag-summary */
2379
+ export type TagSummary = AtomBaseSummary & {
2380
+ /**
2381
+ * The name of the tag, which denotes the logical concept by which all
2382
+ * tagged objects will be associated. The name is guaranteed to be
2383
+ * unique.
2384
+ */
2385
+ name: string;
2386
+ };
2387
+ /** tag-with-value */
2388
+ export interface TagWithValue {
2389
+ tag: TagSummary;
2390
+ /** The value for the object's association with the tag. */
2391
+ value?: string;
2392
+ }
2393
+ /** task */
2394
+ export type Task = WorkBase;
2395
+ /** Priority of the work based upon impact and criticality. */
2396
+ export declare enum TaskPriority {
2397
+ P0 = "p0",
2398
+ P1 = "p1",
2399
+ P2 = "p2",
2400
+ P3 = "p3"
2401
+ }
2402
+ /** task-summary */
2403
+ export type TaskSummary = WorkBaseSummary;
2404
+ /** ticket */
2405
+ export type Ticket = WorkBase & {
2406
+ group?: GroupSummary;
2407
+ rev_org?: OrgSummary;
2408
+ /** Severity of the ticket. */
2409
+ severity?: TicketSeverity;
2410
+ };
2411
+ /** Severity of the ticket. */
2412
+ export declare enum TicketSeverity {
2413
+ Blocker = "blocker",
2414
+ High = "high",
2415
+ Low = "low",
2416
+ Medium = "medium"
2417
+ }
2418
+ /** ticket-summary */
2419
+ export type TicketSummary = WorkBaseSummary & {
2420
+ rev_org?: OrgSummary;
2421
+ /** Severity of the ticket. */
2422
+ severity?: TicketSeverity;
2423
+ };
2424
+ /** timeline-comment */
2425
+ export type TimelineComment = TimelineEntryBase & {
2426
+ /** The artifacts for the comment. */
2427
+ artifacts?: ArtifactSummary[];
2428
+ /**
2429
+ * The comment's body. If the comment has been deleted, then no body
2430
+ * will appear in the response.
2431
+ */
2432
+ body?: string;
2433
+ /** The type of the body to use for the comment. */
2434
+ body_type?: TimelineCommentBodyType;
2435
+ /** Snap Kit Body of the comment. */
2436
+ snap_kit_body?: TimelineSnapKitBody;
2437
+ };
2438
+ /** The type of the body to use for the comment. */
2439
+ export declare enum TimelineCommentBodyType {
2440
+ SnapKit = "snap_kit",
2441
+ Text = "text"
2442
+ }
2443
+ /** Describes collections of timeline entries. */
2444
+ export declare enum TimelineEntriesCollection {
2445
+ Discussions = "discussions",
2446
+ Events = "events"
2447
+ }
2448
+ /**
2449
+ * timeline-entries-create-request
2450
+ * The request to create a timeline entry for an object.
2451
+ */
2452
+ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineComment & {
2453
+ /**
2454
+ * The collection(s) that the entry belongs to, otherwise if not
2455
+ * provided, then the entry's default collection is used.
2456
+ */
2457
+ collections?: TimelineEntriesCollection[];
2458
+ /**
2459
+ * If set, then the entry is ephemeral and will be deleted after the
2460
+ * provided time. The minimum value should be at least a minute more
2461
+ * than the current timestamp.
2462
+ * @format date-time
2463
+ */
2464
+ expires_at?: string;
2465
+ /**
2466
+ * The ID of the object to create the timeline entry for.
2467
+ * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
2468
+ */
2469
+ object: string;
2470
+ /**
2471
+ * If the visibility of the entry is private, this specifies the users
2472
+ * that the entry is private to. Note the creator is always implicitly
2473
+ * included in this list.
2474
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
2475
+ */
2476
+ private_to?: string[];
2477
+ type: TimelineEntriesCreateRequestType;
2478
+ /**
2479
+ * The visibility of the entry. If 'private', then the entry is only
2480
+ * visible to the creator, 'internal' is visible with the Dev
2481
+ * organization, 'external' is visible to the Dev organzation and Rev
2482
+ * users, and 'public' is visible to all. If not set, then the default
2483
+ * visibility is 'external'.
2484
+ */
2485
+ visibility?: TimelineEntryVisibility;
2486
+ };
2487
+ /** timeline-entries-create-request-timeline-comment */
2488
+ export interface TimelineEntriesCreateRequestTimelineComment {
2489
+ /**
2490
+ * The IDs of the artifacts attached to the comment.
2491
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
2492
+ */
2493
+ artifacts?: string[];
2494
+ /** The comment's body. */
2495
+ body?: string;
2496
+ /** The type of the body to use for the comment. */
2497
+ body_type?: TimelineCommentBodyType;
2498
+ /** Snap Kit Body of the comment. */
2499
+ snap_kit_body?: TimelineSnapKitBody;
2500
+ }
2501
+ export declare enum TimelineEntriesCreateRequestType {
2502
+ TimelineComment = "timeline_comment"
2503
+ }
2504
+ /**
2505
+ * timeline-entries-create-response
2506
+ * The response to creating a timeline entry for an object.
2507
+ */
2508
+ export interface TimelineEntriesCreateResponse {
2509
+ timeline_entry: TimelineEntry;
2510
+ }
2511
+ /**
2512
+ * timeline-entries-list-response
2513
+ * The response to listing timeline entries for an object.
2514
+ */
2515
+ export interface TimelineEntriesListResponse {
2516
+ /**
2517
+ * The cursor used to iterate subsequent results in accordance to the
2518
+ * sort order. If not set, then no later elements exist.
2519
+ */
2520
+ next_cursor?: string;
2521
+ /**
2522
+ * The cursor used to iterate preceding results in accordance to the
2523
+ * sort order. If not set, then no prior elements exist.
2524
+ */
2525
+ prev_cursor?: string;
2526
+ /** The timeline entries for the object. */
2527
+ timeline_entries: TimelineEntry[];
2528
+ }
2529
+ /** timeline-entry */
2530
+ export type TimelineEntry = TimelineComment & {
2531
+ type: TimelineEntryType;
2532
+ };
2533
+ /** timeline-entry-base */
2534
+ export type TimelineEntryBase = AtomBase & {
2535
+ /** The object that the Timeline entry belongs to. */
2536
+ object: string;
2537
+ /** The type of object that the Timeline entry belongs to. */
2538
+ object_type?: TimelineEntryObjectType;
2539
+ };
2540
+ /** The type of object that the Timeline entry belongs to. */
2541
+ export declare enum TimelineEntryObjectType {
2542
+ Account = "account",
2543
+ Capability = "capability",
2544
+ Conversation = "conversation",
2545
+ Enhancement = "enhancement",
2546
+ Feature = "feature",
2547
+ Issue = "issue",
2548
+ Opportunity = "opportunity",
2549
+ Product = "product",
2550
+ RevOrg = "rev_org",
2551
+ RevUser = "rev_user",
2552
+ Task = "task",
2553
+ Ticket = "ticket",
2554
+ TimelineComment = "timeline_comment"
2555
+ }
2556
+ export declare enum TimelineEntryType {
2557
+ TimelineComment = "timeline_comment"
2558
+ }
2559
+ /**
2560
+ * The visibility of the entry. If 'private', then the entry is only
2561
+ * visible to the creator, 'internal' is visible with the Dev
2562
+ * organization, 'external' is visible to the Dev organzation and Rev
2563
+ * users, and 'public' is visible to all. If not set, then the default
2564
+ * visibility is 'external'.
2565
+ */
2566
+ export declare enum TimelineEntryVisibility {
2567
+ External = "external",
2568
+ Internal = "internal",
2569
+ Private = "private",
2570
+ Public = "public"
2571
+ }
2572
+ /**
2573
+ * timeline-snap-kit-body
2574
+ * Snap Kit Body of the comment.
2575
+ */
2576
+ export interface TimelineSnapKitBody {
2577
+ /** The JSON body of the SnapKit. */
2578
+ body?: object;
2579
+ /**
2580
+ * The name of an action defined in the SnapIn. The combination of
2581
+ * snap_in_id and snap_in_action_name uniquely identifies the
2582
+ * interaction object which is to be called when actions on a snapkit
2583
+ * element is taken.
2584
+ */
2585
+ snap_in_action_name?: string;
2586
+ /** ID of the snap-in which created the SnapKit. */
2587
+ snap_in_id?: string;
2588
+ }
2589
+ /**
2590
+ * unlink-rev-user-from-rev-org-request
2591
+ * A request to unlink a rev user from a rev org.
2592
+ */
2593
+ export interface UnlinkRevUserFromRevOrgRequest {
2594
+ /**
2595
+ * The don of the rev org to unlink the rev user from.
2596
+ * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
2597
+ */
2598
+ rev_org_don: string;
2599
+ /** The don of the rev user to unlink. */
2600
+ user_don: string;
2601
+ }
2602
+ /**
2603
+ * unlink-rev-user-from-rev-org-response
2604
+ * The response to unlink a rev user from a rev org.
2605
+ */
2606
+ export interface UnlinkRevUserFromRevOrgResponse {
2607
+ rev_user: RevUser;
2608
+ }
2609
+ /** user-base */
2610
+ export type UserBase = AtomBase & {
2611
+ /** The user's display name. The name is non-unique and mutable. */
2612
+ display_name?: string;
2613
+ display_picture?: ArtifactSummary;
2614
+ /** Email address of the user. */
2615
+ email?: string;
2616
+ /** Full name of the user. */
2617
+ full_name?: string;
2618
+ /** Phone numbers of the user. */
2619
+ phone_numbers?: string[];
2620
+ /** State of the user. */
2621
+ state?: UserState;
2622
+ };
2623
+ /** user-base-summary */
2624
+ export type UserBaseSummary = AtomBaseSummary & {
2625
+ /** The user's display name. The name is non-unique and mutable. */
2626
+ display_name?: string;
2627
+ display_picture?: ArtifactSummary;
2628
+ /** Email address of the user. */
2629
+ email?: string;
2630
+ /** Full name of the user. */
2631
+ full_name?: string;
2632
+ /** State of the user. */
2633
+ state?: UserState;
2634
+ };
2635
+ /** State of the user. */
2636
+ export declare enum UserState {
2637
+ Active = "active",
2638
+ Deactivated = "deactivated",
2639
+ Locked = "locked",
2640
+ Shadow = "shadow",
2641
+ Unassigned = "unassigned"
2642
+ }
2643
+ /** user-summary */
2644
+ export type UserSummary = (DevUserSummary | RevUserSummary | SysUserSummary) & {
2645
+ type: UserType;
2646
+ };
2647
+ export declare enum UserType {
2648
+ DevUser = "dev_user",
2649
+ RevUser = "rev_user",
2650
+ SysUser = "sys_user"
2651
+ }
2652
+ /**
2653
+ * weekly-org-schedule
2654
+ * The schedule for each week.
2655
+ */
2656
+ export type WeeklyOrgSchedule = object;
2657
+ /** work */
2658
+ export type Work = (Issue | Opportunity | Task | Ticket) & {
2659
+ type: WorkType;
2660
+ };
2661
+ /** work-base */
2662
+ export type WorkBase = AtomBase & {
2663
+ applies_to_part?: PartSummary;
2664
+ /** The artifacts attached to the work item. */
2665
+ artifacts?: ArtifactSummary[];
2666
+ /** Body of the work object. */
2667
+ body?: string;
2668
+ /** Custom fields. */
2669
+ custom_fields?: object;
2670
+ /**
2671
+ * Custom schema fragments.
2672
+ * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
2673
+ */
2674
+ custom_schema_fragments?: string[];
2675
+ /** The users that own the work. */
2676
+ owned_by: UserSummary[];
2677
+ /** Users that reported the work. */
2678
+ reported_by?: UserSummary[];
2679
+ /** Describes the current stage of a work item. */
2680
+ stage?: Stage;
2681
+ /**
2682
+ * Stock schema fragment.
2683
+ * @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
2684
+ */
2685
+ stock_schema_fragment?: string;
2686
+ /** Tags associated with the object. */
2687
+ tags?: TagWithValue[];
2688
+ /**
2689
+ * Timestamp when the work is expected to be complete.
2690
+ * @format date-time
2691
+ */
2692
+ target_close_date?: string;
2693
+ /** Title of the work object. */
2694
+ title: string;
2695
+ };
2696
+ /** work-base-summary */
2697
+ export type WorkBaseSummary = AtomBaseSummary & {
2698
+ /** Title of the work object. */
2699
+ title: string;
2700
+ };
2701
+ export declare enum WorkType {
2702
+ Issue = "issue",
2703
+ Opportunity = "opportunity",
2704
+ Task = "task",
2705
+ Ticket = "ticket"
2706
+ }
2707
+ /** works-create-request */
2708
+ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOpportunity | WorksCreateRequestTask | WorksCreateRequestTicket) & {
2709
+ /**
2710
+ * The [part](https://devrev.ai/docs/product/parts) that the work
2711
+ * applies to. Specifying a part is required when creating tickets and
2712
+ * issues.
2713
+ * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
2714
+ */
2715
+ applies_to_part: string;
2716
+ /**
2717
+ * The IDs of the artifacts to associate with the work item.
2718
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
2719
+ */
2720
+ artifacts?: string[];
2721
+ /** Body of the work object. */
2722
+ body?: string;
2723
+ /** Custom fields. */
2724
+ custom_fields?: object;
2725
+ /**
2726
+ * The custom schema fragments to use.
2727
+ * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
2728
+ */
2729
+ custom_schema_fragments?: string[];
2730
+ /**
2731
+ * The users that own the work.
2732
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
2733
+ */
2734
+ owned_by: string[];
2735
+ /**
2736
+ * The users that reported the work.
2737
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
2738
+ */
2739
+ reported_by?: string[];
2740
+ /** Sets an object's initial stage. */
2741
+ stage?: StageInit;
2742
+ /** Tags associated with the work item. */
2743
+ tags?: SetTagWithValue[];
2744
+ /**
2745
+ * Timestamp for when the work is expected to be complete.
2746
+ * @format date-time
2747
+ */
2748
+ target_close_date?: string;
2749
+ /** Title of the work object. */
2750
+ title: string;
2751
+ type: WorkType;
2752
+ };
2753
+ /** works-create-request-issue */
2754
+ export interface WorksCreateRequestIssue {
2755
+ /** Priority of the work based upon impact and criticality. */
2756
+ priority?: IssuePriority;
2757
+ /** The sprint that the issue belongs to. */
2758
+ sprint?: string;
2759
+ }
2760
+ /** works-create-request-opportunity */
2761
+ export interface WorksCreateRequestOpportunity {
2762
+ /**
2763
+ * The ID of the account that the opportunity is associated with.
2764
+ * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
2765
+ */
2766
+ account: string;
2767
+ /**
2768
+ * Total opportunity amount.
2769
+ * @format double
2770
+ */
2771
+ amount?: number;
2772
+ /** Contacts involved in the opportunity. */
2773
+ contacts?: string[];
2774
+ /**
2775
+ * Budget of the customer.
2776
+ * @format double
2777
+ */
2778
+ customer_budget?: number;
2779
+ /** Forecast category of the opportunity. */
2780
+ forecast_category?: OpportunityForecastCategory;
2781
+ /** Priority of the opportunity. */
2782
+ priority?: OpportunityPriority;
2783
+ /**
2784
+ * The probability of winning the deal, lies between 0.0 and 1.0.
2785
+ * @format double
2786
+ */
2787
+ probability?: number;
2788
+ }
2789
+ /** works-create-request-task */
2790
+ export interface WorksCreateRequestTask {
2791
+ /** Whether the task is embedded in the work. */
2792
+ embedded?: boolean;
2793
+ /** Priority of the work based upon impact and criticality. */
2794
+ priority?: TaskPriority;
2795
+ /**
2796
+ * Timestamp when the task was started.
2797
+ * @format date-time
2798
+ */
2799
+ start_date?: string;
2800
+ }
2801
+ /** works-create-request-ticket */
2802
+ export interface WorksCreateRequestTicket {
2803
+ /** The group that the ticket is associated with. */
2804
+ group?: string;
2805
+ /** Whether the ticket is spam. */
2806
+ is_spam?: boolean;
2807
+ /**
2808
+ * The Rev organization that the ticket is associated with.
2809
+ * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
2810
+ */
2811
+ rev_org?: string;
2812
+ /** Severity of the ticket. */
2813
+ severity?: TicketSeverity;
2814
+ /** The source channel of the ticket. */
2815
+ source_channel?: string;
2816
+ }
2817
+ /** works-create-response */
2818
+ export interface WorksCreateResponse {
2819
+ work: Work;
2820
+ }
2821
+ /** works-delete-request */
2822
+ export interface WorksDeleteRequest {
2823
+ /**
2824
+ * The work's ID.
2825
+ * @example "don:core:<partition>:devo/<dev-org-id>:<work-type>/<work-id>"
2826
+ */
2827
+ id: string;
2828
+ }
2829
+ /** works-delete-response */
2830
+ export type WorksDeleteResponse = object;
2831
+ /** works-export-response */
2832
+ export interface WorksExportResponse {
2833
+ /** The resulting collection of work items. */
2834
+ works: Work[];
2835
+ }
2836
+ /** works-get-response */
2837
+ export interface WorksGetResponse {
2838
+ work: Work;
2839
+ }
2840
+ /** works-list-response */
2841
+ export interface WorksListResponse {
2842
+ /**
2843
+ * The cursor used to iterate subsequent results in accordance to the
2844
+ * sort order. If not set, then no later elements exist.
2845
+ */
2846
+ next_cursor?: string;
2847
+ /**
2848
+ * The cursor used to iterate preceding results in accordance to the
2849
+ * sort order. If not set, then no prior elements exist.
2850
+ */
2851
+ prev_cursor?: string;
2852
+ /** The list of works. */
2853
+ works: Work[];
2854
+ }
2855
+ /** works-update-request */
2856
+ export type WorksUpdateRequest = (WorksUpdateRequestIssue | WorksUpdateRequestOpportunity | WorksUpdateRequestTask | WorksUpdateRequestTicket) & {
2857
+ /**
2858
+ * Updates the part that the work applies to.
2859
+ * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
2860
+ */
2861
+ applies_to_part?: string;
2862
+ artifacts?: WorksUpdateRequestArtifactIds;
2863
+ /** Updated body of the work object, or unchanged if not provided. */
2864
+ body?: string;
2865
+ /** Custom fields. */
2866
+ custom_fields?: object;
2867
+ /**
2868
+ * The custom schema fragments to use.
2869
+ * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
2870
+ */
2871
+ custom_schema_fragments?: string[];
2872
+ /**
2873
+ * The work's ID.
2874
+ * @example "don:core:<partition>:devo/<dev-org-id>:<work-type>/<work-id>"
2875
+ */
2876
+ id: string;
2877
+ owned_by?: WorksUpdateRequestOwnedBy;
2878
+ reported_by?: WorksUpdateRequestReportedBy;
2879
+ /** Updates an object's stage. */
2880
+ stage?: StageUpdate;
2881
+ tags?: WorksUpdateRequestTags;
2882
+ /**
2883
+ * Updates the timestamp for when the work is expected to be complete.
2884
+ * @format date-time
2885
+ */
2886
+ target_close_date?: string;
2887
+ /** Updated title of the work object, or unchanged if not provided. */
2888
+ title?: string;
2889
+ type: WorkType;
2890
+ };
2891
+ /** works-update-request-artifact-ids */
2892
+ export interface WorksUpdateRequestArtifactIds {
2893
+ /**
2894
+ * Sets the IDs to the provided artifact IDs.
2895
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
2896
+ */
2897
+ set?: string[];
2898
+ }
2899
+ /** works-update-request-issue */
2900
+ export interface WorksUpdateRequestIssue {
2901
+ /** Priority of the work based upon impact and criticality. */
2902
+ priority?: IssuePriority;
2903
+ /** Updates the sprint that the issue belongs to. */
2904
+ sprint?: string | null;
2905
+ }
2906
+ /** works-update-request-opportunity */
2907
+ export interface WorksUpdateRequestOpportunity {
2908
+ /**
2909
+ * Updates the account that the opportunity is associated with.
2910
+ * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
2911
+ */
2912
+ account?: string;
2913
+ /**
2914
+ * Updates the total opportunity amount.
2915
+ * @format double
2916
+ */
2917
+ amount?: number | null;
2918
+ contacts?: WorksUpdateRequestOpportunityContacts;
2919
+ /**
2920
+ * Updates the customer budget.
2921
+ * @format double
2922
+ */
2923
+ customer_budget?: number | null;
2924
+ /**
2925
+ * Updates the probability of winning the deal, lies between 0.0 and
2926
+ * 1.0.
2927
+ * @format double
2928
+ */
2929
+ probability?: number | null;
2930
+ }
2931
+ /** works-update-request-opportunity-contacts */
2932
+ export interface WorksUpdateRequestOpportunityContacts {
2933
+ /** Sets the contact IDs to the provided contact IDs. */
2934
+ set: string[];
2935
+ }
2936
+ /** works-update-request-owned-by */
2937
+ export interface WorksUpdateRequestOwnedBy {
2938
+ /**
2939
+ * Sets the owner IDs to the provided user IDs. This must not be
2940
+ * empty.
2941
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
2942
+ */
2943
+ set?: string[];
2944
+ }
2945
+ /** works-update-request-reported-by */
2946
+ export interface WorksUpdateRequestReportedBy {
2947
+ /**
2948
+ * Sets the users that reported the work to the provided user IDs.
2949
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
2950
+ */
2951
+ set?: string[];
2952
+ }
2953
+ /** works-update-request-tags */
2954
+ export interface WorksUpdateRequestTags {
2955
+ /** Sets the provided tags on the work item. */
2956
+ set?: SetTagWithValue[];
2957
+ }
2958
+ /** works-update-request-task */
2959
+ export interface WorksUpdateRequestTask {
2960
+ /** Whether the task is embedded in the work. */
2961
+ embedded?: boolean;
2962
+ /** Priority of the work based upon impact and criticality. */
2963
+ priority?: TaskPriority;
2964
+ /**
2965
+ * Timestamp when the task was started.
2966
+ * @format date-time
2967
+ */
2968
+ start_date?: string;
2969
+ }
2970
+ /** works-update-request-ticket */
2971
+ export interface WorksUpdateRequestTicket {
2972
+ /** The group that the ticket is associated with. */
2973
+ group?: string;
2974
+ /** Updates whether the ticket is spam. */
2975
+ is_spam?: boolean;
2976
+ /**
2977
+ * Updates the Rev organization that the ticket is associated with.
2978
+ * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
2979
+ */
2980
+ rev_org?: string | null;
2981
+ /** Severity of the ticket. */
2982
+ severity?: TicketSeverity;
2983
+ }
2984
+ /** works-update-response */
2985
+ export interface WorksUpdateResponse {
2986
+ work: Work;
2987
+ }
2988
+ import { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from 'axios';
2989
+ export type QueryParamsType = Record<string | number, any>;
2990
+ export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
2991
+ /** set parameter to `true` for call `securityWorker` for this request */
2992
+ secure?: boolean;
2993
+ /** request path */
2994
+ path: string;
2995
+ /** content type of request body */
2996
+ type?: ContentType;
2997
+ /** query params */
2998
+ query?: QueryParamsType;
2999
+ /** format of response (i.e. response.json() -> format: "json") */
3000
+ format?: ResponseType;
3001
+ /** request body */
3002
+ body?: unknown;
3003
+ }
3004
+ export type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>;
3005
+ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, 'data' | 'cancelToken'> {
3006
+ securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
3007
+ secure?: boolean;
3008
+ format?: ResponseType;
3009
+ }
3010
+ export declare enum ContentType {
3011
+ Json = "application/json",
3012
+ FormData = "multipart/form-data",
3013
+ UrlEncoded = "application/x-www-form-urlencoded",
3014
+ Text = "text/plain"
3015
+ }
3016
+ export declare class HttpClient<SecurityDataType = unknown> {
3017
+ instance: AxiosInstance;
3018
+ private securityData;
3019
+ private securityWorker?;
3020
+ private secure?;
3021
+ private format?;
3022
+ constructor({ securityWorker, secure, format, ...axiosConfig }?: ApiConfig<SecurityDataType>);
3023
+ setSecurityData: (data: SecurityDataType | null) => void;
3024
+ protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
3025
+ protected stringifyFormItem(formItem: unknown): string;
3026
+ protected createFormData(input: Record<string, unknown>): FormData;
3027
+ request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<AxiosResponse<T, any>>;
3028
+ }
3029
+ /**
3030
+ * @title DevRev Beta REST API
3031
+ * @version BETA
3032
+ * @baseUrl {protocol}://{hostname}
3033
+ *
3034
+ * DevRev's BETA REST API Specification.
3035
+ */
3036
+ export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
3037
+ /**
3038
+ * @description Creates an account, which is a record representing a customer or an organization.
3039
+ *
3040
+ * @tags accounts
3041
+ * @name AccountsCreate
3042
+ * @request POST:/accounts.create
3043
+ * @secure
3044
+ */
3045
+ accountsCreate: (data: AccountsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsCreateResponse, any>>;
3046
+ /**
3047
+ * @description Deletes an account.
3048
+ *
3049
+ * @tags accounts
3050
+ * @name AccountsDelete
3051
+ * @request POST:/accounts.delete
3052
+ * @secure
3053
+ */
3054
+ accountsDelete: (data: AccountsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
3055
+ /**
3056
+ * @description Exports a collection of accounts.
3057
+ *
3058
+ * @tags accounts
3059
+ * @name AccountsExport
3060
+ * @request GET:/accounts.export
3061
+ * @secure
3062
+ */
3063
+ accountsExport: (query?: {
3064
+ /** Filters for accounts created by the specified user(s). */
3065
+ created_by?: string[];
3066
+ /**
3067
+ * Filters for objects created after the provided timestamp (inclusive).
3068
+ * @format date-time
3069
+ */
3070
+ 'created_date.after'?: string;
3071
+ /**
3072
+ * Filters for objects created before the provided timestamp
3073
+ * (inclusive).
3074
+ * @format date-time
3075
+ */
3076
+ 'created_date.before'?: string;
3077
+ /** Array of references of accounts to be filtered. */
3078
+ external_refs?: string[];
3079
+ /**
3080
+ * The number of accounts to return. The default is '50'.
3081
+ * @format int32
3082
+ * @min 1
3083
+ * @max 500
3084
+ */
3085
+ first?: number;
3086
+ /**
3087
+ * Filters for objects created after the provided timestamp (inclusive).
3088
+ * @format date-time
3089
+ */
3090
+ 'modified_date.after'?: string;
3091
+ /**
3092
+ * Filters for objects created before the provided timestamp
3093
+ * (inclusive).
3094
+ * @format date-time
3095
+ */
3096
+ 'modified_date.before'?: string;
3097
+ /** Fields to sort the accounts by and the direction to sort them in. */
3098
+ sort_by?: string[];
3099
+ }, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
3100
+ /**
3101
+ * @description Retrieves an account's information.
3102
+ *
3103
+ * @tags accounts
3104
+ * @name AccountsGet
3105
+ * @request GET:/accounts.get
3106
+ * @secure
3107
+ */
3108
+ accountsGet: (query: {
3109
+ /**
3110
+ * The ID of the account to be retrieved.
3111
+ * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
3112
+ */
3113
+ id: string;
3114
+ }, params?: RequestParams) => Promise<AxiosResponse<AccountsGetResponse, any>>;
3115
+ /**
3116
+ * @description Gets a list of accounts.
3117
+ *
3118
+ * @tags accounts
3119
+ * @name AccountsList
3120
+ * @request GET:/accounts.list
3121
+ * @secure
3122
+ */
3123
+ accountsList: (query?: {
3124
+ /** Filters for accounts created by the specified user(s). */
3125
+ created_by?: string[];
3126
+ /**
3127
+ * Filters for objects created after the provided timestamp (inclusive).
3128
+ * @format date-time
3129
+ */
3130
+ 'created_date.after'?: string;
3131
+ /**
3132
+ * Filters for objects created before the provided timestamp
3133
+ * (inclusive).
3134
+ * @format date-time
3135
+ */
3136
+ 'created_date.before'?: string;
3137
+ /**
3138
+ * The cursor to resume iteration from. If not provided, then iteration
3139
+ * starts from the beginning.
3140
+ */
3141
+ cursor?: string;
3142
+ /** Array of references of accounts to be filtered. */
3143
+ external_refs?: string[];
3144
+ /**
3145
+ * The maximum number of accounts to return per page. The default is
3146
+ * '50'.
3147
+ * @format int32
3148
+ */
3149
+ limit?: number;
3150
+ /**
3151
+ * The iteration mode to use, otherwise if not set, then "after" is
3152
+ * used.
3153
+ */
3154
+ mode?: ListMode;
3155
+ /**
3156
+ * Filters for objects created after the provided timestamp (inclusive).
3157
+ * @format date-time
3158
+ */
3159
+ 'modified_date.after'?: string;
3160
+ /**
3161
+ * Filters for objects created before the provided timestamp
3162
+ * (inclusive).
3163
+ * @format date-time
3164
+ */
3165
+ 'modified_date.before'?: string;
3166
+ /** Fields to sort the accounts by and the direction to sort them in. */
3167
+ sort_by?: string[];
3168
+ }, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
3169
+ /**
3170
+ * @description Updates an account's information.
3171
+ *
3172
+ * @tags accounts
3173
+ * @name AccountsUpdate
3174
+ * @request POST:/accounts.update
3175
+ * @secure
3176
+ */
3177
+ accountsUpdate: (data: AccountsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsUpdateResponse, any>>;
3178
+ /**
3179
+ * @description Creates a conversation.
3180
+ *
3181
+ * @tags conversations
3182
+ * @name ConversationsCreate
3183
+ * @request POST:/conversations.create
3184
+ * @secure
3185
+ */
3186
+ conversationsCreate: (data: ConversationsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsCreateResponse, any>>;
3187
+ /**
3188
+ * @description Deletes the requested conversation.
3189
+ *
3190
+ * @tags conversations
3191
+ * @name ConversationsDelete
3192
+ * @request POST:/conversations.delete
3193
+ * @secure
3194
+ */
3195
+ conversationsDelete: (data: ConversationsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
3196
+ /**
3197
+ * @description Exports a collection of conversation items.
3198
+ *
3199
+ * @tags conversations
3200
+ * @name ConversationsExport
3201
+ * @request GET:/conversations.export
3202
+ * @secure
3203
+ */
3204
+ conversationsExport: (query?: {
3205
+ /**
3206
+ * Filters for conversations belonging to any of the provided parts.
3207
+ * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
3208
+ */
3209
+ applies_to_parts?: string[];
3210
+ /**
3211
+ * The number of conversation items to return. The default is '50', the
3212
+ * maximum is '5000'.
3213
+ * @format int32
3214
+ */
3215
+ first?: number;
3216
+ /** Filters for conversation that belong to the given groups. */
3217
+ group?: string[];
3218
+ /** Filters for conversations that are spam. */
3219
+ is_spam?: boolean;
3220
+ /**
3221
+ * Filters for conversations where these users are participants.
3222
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
3223
+ */
3224
+ members?: string[];
3225
+ /**
3226
+ * Filters for conversations owned by any of these users.
3227
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
3228
+ */
3229
+ owned_by?: string[];
3230
+ /**
3231
+ * Filters for conversations that are associated with any of the
3232
+ * provided Rev organizations.
3233
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
3234
+ */
3235
+ rev_org?: string[];
3236
+ /** Filters for conversations with any of the provided source channels. */
3237
+ source_channels?: string[];
3238
+ /** Filters for records in the provided stage(s). */
3239
+ 'stage.name'?: string[];
3240
+ /**
3241
+ * Filters for conversations with any of the provided tags.
3242
+ * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
3243
+ */
3244
+ tags?: string[];
3245
+ }, params?: RequestParams) => Promise<AxiosResponse<ConversationsExportResponse, any>>;
3246
+ /**
3247
+ * @description Gets the requested conversation's information.
3248
+ *
3249
+ * @tags conversations
3250
+ * @name ConversationsGet
3251
+ * @request GET:/conversations.get
3252
+ * @secure
3253
+ */
3254
+ conversationsGet: (query: {
3255
+ /** The requested conversation's ID. */
3256
+ id: string;
3257
+ }, params?: RequestParams) => Promise<AxiosResponse<ConversationsGetResponse, any>>;
3258
+ /**
3259
+ * @description Lists the available conversations.
3260
+ *
3261
+ * @tags conversations
3262
+ * @name ConversationsList
3263
+ * @request GET:/conversations.list
3264
+ * @secure
3265
+ */
3266
+ conversationsList: (query?: {
3267
+ /**
3268
+ * Filters for conversations belonging to any of the provided parts.
3269
+ * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
3270
+ */
3271
+ applies_to_parts?: string[];
3272
+ /**
3273
+ * The cursor to resume iteration from. If not provided, then iteration
3274
+ * starts from the beginning.
3275
+ */
3276
+ cursor?: string;
3277
+ /** Filters for conversation that belong to the given groups. */
3278
+ group?: string[];
3279
+ /** Filters for conversations that are spam. */
3280
+ is_spam?: boolean;
3281
+ /**
3282
+ * The maximum number of conversations to return. The default is '50'.
3283
+ * @format int32
3284
+ */
3285
+ limit?: number;
3286
+ /**
3287
+ * Filters for conversations where these users are participants.
3288
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
3289
+ */
3290
+ members?: string[];
3291
+ /**
3292
+ * The iteration mode to use, otherwise if not set, then "after" is
3293
+ * used.
3294
+ */
3295
+ mode?: ListMode;
3296
+ /**
3297
+ * Filters for conversations owned by any of these users.
3298
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
3299
+ */
3300
+ owned_by?: string[];
3301
+ /**
3302
+ * Filters for conversations that are associated with any of the
3303
+ * provided Rev organizations.
3304
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
3305
+ */
3306
+ rev_org?: string[];
3307
+ /** Filters for conversations with any of the provided source channels. */
3308
+ source_channels?: string[];
3309
+ /** Filters for records in the provided stage(s). */
3310
+ 'stage.name'?: string[];
3311
+ /**
3312
+ * Filters for conversations with any of the provided tags.
3313
+ * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
3314
+ */
3315
+ tags?: string[];
3316
+ }, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any>>;
3317
+ /**
3318
+ * @description Updates the requested conversation.
3319
+ *
3320
+ * @tags conversations
3321
+ * @name ConversationsUpdate
3322
+ * @request POST:/conversations.update
3323
+ * @secure
3324
+ */
3325
+ conversationsUpdate: (data: ConversationsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsUpdateResponse, any>>;
3326
+ /**
3327
+ * @description Counts the engagement records.
3328
+ *
3329
+ * @tags engagements
3330
+ * @name EngagementsCount
3331
+ * @request GET:/engagements.count
3332
+ * @secure
3333
+ */
3334
+ engagementsCount: (query?: {
3335
+ /** Filters for meetings with the provided external_refs. */
3336
+ external_ref?: string[];
3337
+ /**
3338
+ * Filters for engagement of the provided members.
3339
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
3340
+ */
3341
+ members?: string[];
3342
+ /**
3343
+ * Filters for engagements with the provided parent.
3344
+ * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
3345
+ */
3346
+ parent?: string[];
3347
+ /** Filters for engagement of the provided types. */
3348
+ type?: EngagementType[];
3349
+ }, params?: RequestParams) => Promise<AxiosResponse<EngagementsCountResponse, any>>;
3350
+ /**
3351
+ * @description Creates a new engagement record.
3352
+ *
3353
+ * @tags engagements
3354
+ * @name EngagementsCreate
3355
+ * @request POST:/engagements.create
3356
+ * @secure
3357
+ */
3358
+ engagementsCreate: (data: EngagementsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<EngagementsCreateResponse, any>>;
3359
+ /**
3360
+ * @description Deletes the engagement record.
3361
+ *
3362
+ * @tags engagements
3363
+ * @name EngagementsDelete
3364
+ * @request POST:/engagements.delete
3365
+ * @secure
3366
+ */
3367
+ engagementsDelete: (data: EngagementsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
3368
+ /**
3369
+ * @description Gets the engagement record.
3370
+ *
3371
+ * @tags engagements
3372
+ * @name EngagementsGet
3373
+ * @request GET:/engagements.get
3374
+ * @secure
3375
+ */
3376
+ engagementsGet: (query: {
3377
+ /** The engagement ID. */
3378
+ id: string;
3379
+ }, params?: RequestParams) => Promise<AxiosResponse<EngagementsGetResponse, any>>;
3380
+ /**
3381
+ * @description Lists the engagement records.
3382
+ *
3383
+ * @tags engagements
3384
+ * @name EngagementsList
3385
+ * @request GET:/engagements.list
3386
+ * @secure
3387
+ */
3388
+ engagementsList: (query?: {
3389
+ /**
3390
+ * The cursor to resume iteration from. If not provided, then iteration
3391
+ * starts from the beginning.
3392
+ */
3393
+ cursor?: string;
3394
+ /** Filters for meetings with the provided external_refs. */
3395
+ external_ref?: string[];
3396
+ /**
3397
+ * The maximum number of engagements to return.
3398
+ * @format int32
3399
+ */
3400
+ limit?: number;
3401
+ /**
3402
+ * Filters for engagement of the provided members.
3403
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
3404
+ */
3405
+ members?: string[];
3406
+ /**
3407
+ * The iteration mode to use, otherwise if not set, then "after" is
3408
+ * used.
3409
+ */
3410
+ mode?: ListMode;
3411
+ /**
3412
+ * Filters for engagements with the provided parent.
3413
+ * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
3414
+ */
3415
+ parent?: string[];
3416
+ /** Fields to sort the engagements by and the direction to sort them. */
3417
+ sort_by?: string[];
3418
+ /** Filters for engagement of the provided types. */
3419
+ type?: EngagementType[];
3420
+ }, params?: RequestParams) => Promise<AxiosResponse<EngagementsListResponse, any>>;
3421
+ /**
3422
+ * @description Updates the engagement record.
3423
+ *
3424
+ * @tags engagements
3425
+ * @name EngagementsUpdate
3426
+ * @request POST:/engagements.update
3427
+ * @secure
3428
+ */
3429
+ engagementsUpdate: (data: EngagementsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<EngagementsUpdateResponse, any>>;
3430
+ /**
3431
+ * @description Schedules an event to be published to the specified event source.
3432
+ *
3433
+ * @tags event-source
3434
+ * @name EventSourcesScheduleEvent
3435
+ * @request POST:/event-sources.schedule
3436
+ * @secure
3437
+ */
3438
+ eventSourcesScheduleEvent: (data: EventSourcesScheduleEventRequest, params?: RequestParams) => Promise<AxiosResponse<EventSourcesScheduleEventResponse, any>>;
3439
+ /**
3440
+ * @description Deletes an event scheduled for the specified event source.
3441
+ *
3442
+ * @tags event-source
3443
+ * @name EventSourcesDeleteScheduledEvent
3444
+ * @request POST:/event-sources.unschedule
3445
+ * @secure
3446
+ */
3447
+ eventSourcesDeleteScheduledEvent: (data: EventSourcesDeleteScheduledEventRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
3448
+ /**
3449
+ * @description Creates a link between two objects to indicate a relationship.
3450
+ *
3451
+ * @tags links
3452
+ * @name LinksCreate
3453
+ * @request POST:/links.create
3454
+ * @secure
3455
+ */
3456
+ linksCreate: (data: LinksCreateRequest, params?: RequestParams) => Promise<AxiosResponse<LinksCreateResponse, any>>;
3457
+ /**
3458
+ * @description Deletes a link.
3459
+ *
3460
+ * @tags links
3461
+ * @name LinksDelete
3462
+ * @request POST:/links.delete
3463
+ * @secure
3464
+ */
3465
+ linksDelete: (data: LinksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
3466
+ /**
3467
+ * @description Gets the requested link's information.
3468
+ *
3469
+ * @tags links
3470
+ * @name LinksGet
3471
+ * @request GET:/links.get
3472
+ * @secure
3473
+ */
3474
+ linksGet: (query: {
3475
+ /** The requested link's ID. */
3476
+ id: string;
3477
+ }, params?: RequestParams) => Promise<AxiosResponse<LinksGetResponse, any>>;
3478
+ /**
3479
+ * @description Lists the available links.
3480
+ *
3481
+ * @tags links
3482
+ * @name LinksList
3483
+ * @request GET:/links.list
3484
+ * @secure
3485
+ */
3486
+ linksList: (query: {
3487
+ /** The ID of the object to list the links for. */
3488
+ object: string;
3489
+ /**
3490
+ * The cursor to resume iteration from. If not provided, then iteration
3491
+ * starts from the beginning.
3492
+ */
3493
+ cursor?: string;
3494
+ /**
3495
+ * The direction of the links to list, otherwise if not present, then
3496
+ * links in both directions (source and target) are included.
3497
+ */
3498
+ direction?: LinksDirection;
3499
+ /**
3500
+ * The maximum number of links to return. If not set, then the default
3501
+ * is '50'.
3502
+ * @format int32
3503
+ */
3504
+ limit?: number;
3505
+ /**
3506
+ * The link type(s) to filter for, otherwise if not present, all link
3507
+ * types are included.
3508
+ */
3509
+ link_type?: LinkType[];
3510
+ /**
3511
+ * The iteration mode to use, otherwise if not set, then "after" is
3512
+ * used.
3513
+ */
3514
+ mode?: ListMode;
3515
+ /**
3516
+ * The link types to filter for, otherwise if not present, all link
3517
+ * types are included.
3518
+ * @deprecated
3519
+ */
3520
+ types?: LinkType[];
3521
+ }, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
3522
+ /**
3523
+ * @description Lists metric definitions matching a filter.
3524
+ *
3525
+ * @tags slas
3526
+ * @name MetricDefinitionsList
3527
+ * @request GET:/metric-definitions.list
3528
+ * @secure
3529
+ */
3530
+ metricDefinitionsList: (query?: {
3531
+ /** The type of objects the metric definition applies to. */
3532
+ applies_to_type?: MetricDefinitionAppliesTo[];
3533
+ /**
3534
+ * The cursor to resume iteration from. If not provided, then iteration
3535
+ * starts from the beginning.
3536
+ */
3537
+ cursor?: string;
3538
+ /**
3539
+ * The maximum number of records to return. The default is '50'.
3540
+ * @format int32
3541
+ */
3542
+ limit?: number;
3543
+ /**
3544
+ * The iteration mode to use, otherwise if not set, then "after" is
3545
+ * used.
3546
+ */
3547
+ mode?: ListMode;
3548
+ /** The type of metric definitions sought. */
3549
+ type?: MetricDefinitionMetricType[];
3550
+ }, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any>>;
3551
+ /**
3552
+ * @description Creates an organization schedule fragment.
3553
+ *
3554
+ * @tags schedules
3555
+ * @name OrgScheduleFragmentsCreate
3556
+ * @request POST:/org-schedule-fragments.create
3557
+ * @secure
3558
+ */
3559
+ orgScheduleFragmentsCreate: (data: OrgScheduleFragmentsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsCreateResponse, any>>;
3560
+ /**
3561
+ * @description Gets an organization schedule fragment.
3562
+ *
3563
+ * @tags schedules
3564
+ * @name OrgScheduleFragmentsGet
3565
+ * @request GET:/org-schedule-fragments.get
3566
+ * @secure
3567
+ */
3568
+ orgScheduleFragmentsGet: (query: {
3569
+ /** Organization schedule Fragment ID. */
3570
+ id: string;
3571
+ }, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsGetResponse, any>>;
3572
+ /**
3573
+ * @description Changes stage of an organization schedule fragment.
3574
+ *
3575
+ * @tags schedules
3576
+ * @name OrgScheduleFragmentsTransition
3577
+ * @request POST:/org-schedule-fragments.transition
3578
+ * @secure
3579
+ */
3580
+ orgScheduleFragmentsTransition: (data: OrgScheduleFragmentsTransitionRequest, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsTransitionResponse, any>>;
3581
+ /**
3582
+ * @description Creates an organization schedule with a default weekly organization schedule and a list of organization schedule fragments.
3583
+ *
3584
+ * @tags schedules
3585
+ * @name OrgSchedulesCreate
3586
+ * @request POST:/org-schedules.create
3587
+ * @secure
3588
+ */
3589
+ orgSchedulesCreate: (data: OrgSchedulesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesCreateResponse, any>>;
3590
+ /**
3591
+ * @description Gets an organization schedule.
3592
+ *
3593
+ * @tags schedules
3594
+ * @name OrgSchedulesGet
3595
+ * @request GET:/org-schedules.get
3596
+ * @secure
3597
+ */
3598
+ orgSchedulesGet: (query: {
3599
+ /** Organization schedule ID. */
3600
+ id: string;
3601
+ }, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesGetResponse, any>>;
3602
+ /**
3603
+ * @description Gets list of organization schedules.
3604
+ *
3605
+ * @tags schedules
3606
+ * @name OrgSchedulesList
3607
+ * @request GET:/org-schedules.list
3608
+ * @secure
3609
+ */
3610
+ orgSchedulesList: (query?: {
3611
+ /** Creator ID the filter matches. */
3612
+ created_by_id?: string[];
3613
+ /**
3614
+ * The cursor to resume iteration from. If not provided, then iteration
3615
+ * starts from the beginning.
3616
+ */
3617
+ cursor?: string;
3618
+ /**
3619
+ * Max number of organization schedules returned in a page. Default is
3620
+ * 50.
3621
+ * @format int32
3622
+ */
3623
+ limit?: number;
3624
+ /**
3625
+ * The iteration mode to use, otherwise if not set, then "after" is
3626
+ * used.
3627
+ */
3628
+ mode?: ListMode;
3629
+ /** The organization schedule statuses the filter matches. */
3630
+ status?: OrgScheduleStatus[];
3631
+ }, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesListResponse, any>>;
3632
+ /**
3633
+ * @description Sets next organization schedule fragment which must begin the day the last existing fragment ends.
3634
+ *
3635
+ * @tags schedules
3636
+ * @name OrgSchedulesSetFuture
3637
+ * @request POST:/org-schedules.set-future
3638
+ * @secure
3639
+ */
3640
+ orgSchedulesSetFuture: (data: OrgSchedulesSetFutureRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesSetFutureResponse, any>>;
3641
+ /**
3642
+ * @description Publishes or archives an organization schedule.
3643
+ *
3644
+ * @tags schedules
3645
+ * @name OrgSchedulesTransition
3646
+ * @request POST:/org-schedules.transition
3647
+ * @secure
3648
+ */
3649
+ orgSchedulesTransition: (data: OrgSchedulesTransitionRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesTransitionResponse, any>>;
3650
+ /**
3651
+ * @description Updates an organization schedule.
3652
+ *
3653
+ * @tags schedules
3654
+ * @name OrgSchedulesUpdate
3655
+ * @request POST:/org-schedules.update
3656
+ * @secure
3657
+ */
3658
+ orgSchedulesUpdate: (data: OrgSchedulesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesUpdateResponse, any>>;
3659
+ /**
3660
+ * @description Creates a Rev organization in the authenticated user's Dev organization.
3661
+ *
3662
+ * @tags rev-orgs
3663
+ * @name RevOrgsCreate
3664
+ * @request POST:/rev-orgs.create
3665
+ * @secure
3666
+ */
3667
+ revOrgsCreate: (data: RevOrgsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsCreateResponse, any>>;
3668
+ /**
3669
+ * @description Retrieves the Rev organization's information.
3670
+ *
3671
+ * @tags rev-orgs
3672
+ * @name RevOrgsGet
3673
+ * @request GET:/rev-orgs.get
3674
+ * @secure
3675
+ */
3676
+ revOrgsGet: (query: {
3677
+ /**
3678
+ * The ID of the required Rev organization.
3679
+ * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
3680
+ */
3681
+ id: string;
3682
+ }, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any>>;
3683
+ /**
3684
+ * @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
3685
+ *
3686
+ * @tags rev-orgs
3687
+ * @name RevOrgsList
3688
+ * @request GET:/rev-orgs.list
3689
+ * @secure
3690
+ */
3691
+ revOrgsList: (query?: {
3692
+ /** Filters by creator. */
3693
+ created_by?: string[];
3694
+ /**
3695
+ * Filters for objects created after the provided timestamp (inclusive).
3696
+ * @format date-time
3697
+ */
3698
+ 'created_date.after'?: string;
3699
+ /**
3700
+ * Filters for objects created before the provided timestamp
3701
+ * (inclusive).
3702
+ * @format date-time
3703
+ */
3704
+ 'created_date.before'?: string;
3705
+ /**
3706
+ * The cursor to resume iteration from. If not provided, then iteration
3707
+ * starts from the beginning.
3708
+ */
3709
+ cursor?: string;
3710
+ /**
3711
+ * Filters on custom fields. Input will be of the format
3712
+ * (custom_field_filter=field_name1:val1,val2,val3&custom_field_filter=field_name2:val1,val2).
3713
+ */
3714
+ custom_field_filter?: string[];
3715
+ /** List of external refs to filter Rev organizations for. */
3716
+ external_ref?: string[];
3717
+ /**
3718
+ * The maximum number of Rev organizations to be retrieved per page.
3719
+ * @format int32
3720
+ */
3721
+ limit?: number;
3722
+ /**
3723
+ * The iteration mode to use, otherwise if not set, then "after" is
3724
+ * used.
3725
+ */
3726
+ mode?: ListMode;
3727
+ /**
3728
+ * Filters for objects created after the provided timestamp (inclusive).
3729
+ * @format date-time
3730
+ */
3731
+ 'modified_date.after'?: string;
3732
+ /**
3733
+ * Filters for objects created before the provided timestamp
3734
+ * (inclusive).
3735
+ * @format date-time
3736
+ */
3737
+ 'modified_date.before'?: string;
3738
+ /**
3739
+ * Fields to sort the Rev organizations by and the direction to sort
3740
+ * them.
3741
+ */
3742
+ sort_by?: string[];
3743
+ }, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any>>;
3744
+ /**
3745
+ * @description Updates the Rev organization's information.
3746
+ *
3747
+ * @tags rev-orgs
3748
+ * @name RevOrgsUpdate
3749
+ * @request POST:/rev-orgs.update
3750
+ * @secure
3751
+ */
3752
+ revOrgsUpdate: (data: RevOrgsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsUpdateResponse, any>>;
3753
+ /**
3754
+ * @description Creates a Rev user for a Rev organization. Rev user can be a customer or a lead of an organization.
3755
+ *
3756
+ * @tags rev-users
3757
+ * @name RevUsersCreate
3758
+ * @request POST:/rev-users.create
3759
+ * @secure
3760
+ */
3761
+ revUsersCreate: (data: RevUsersCreateRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersCreateResponse, any>>;
3762
+ /**
3763
+ * @description Deletes a Rev user.
3764
+ *
3765
+ * @tags rev-users
3766
+ * @name RevUsersDelete
3767
+ * @request POST:/rev-users.delete
3768
+ * @secure
3769
+ */
3770
+ revUsersDelete: (data: RevUsersDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
3771
+ /**
3772
+ * @description Returns the Rev user of a Rev organization by its ID.
3773
+ *
3774
+ * @tags rev-users
3775
+ * @name RevUsersGet
3776
+ * @request GET:/rev-users.get
3777
+ * @secure
3778
+ */
3779
+ revUsersGet: (query: {
3780
+ /** The ID of Rev user to be retrieved. */
3781
+ id: string;
3782
+ }, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any>>;
3783
+ /**
3784
+ * @description Links a rev user to a rev org.
3785
+ *
3786
+ * @tags rev-users
3787
+ * @name LinkRevUserToRevOrg
3788
+ * @request POST:/rev-users.link
3789
+ * @secure
3790
+ */
3791
+ linkRevUserToRevOrg: (data: LinkRevUserToRevOrgRequest, params?: RequestParams) => Promise<AxiosResponse<LinkRevUserToRevOrgResponse, any>>;
3792
+ /**
3793
+ * @description Returns a list of all Rev Users belonging to the authenticated user's Dev Organization.
3794
+ *
3795
+ * @tags rev-users
3796
+ * @name RevUsersList
3797
+ * @request GET:/rev-users.list
3798
+ * @secure
3799
+ */
3800
+ revUsersList: (query?: {
3801
+ /** Filters for Rev users that were created by the specified user(s). */
3802
+ created_by?: string[];
3803
+ /**
3804
+ * Filters for objects created after the provided timestamp (inclusive).
3805
+ * @format date-time
3806
+ */
3807
+ 'created_date.after'?: string;
3808
+ /**
3809
+ * Filters for objects created before the provided timestamp
3810
+ * (inclusive).
3811
+ * @format date-time
3812
+ */
3813
+ 'created_date.before'?: string;
3814
+ /**
3815
+ * The cursor to resume iteration from. If not provided, then iteration
3816
+ * starts from the beginning.
3817
+ */
3818
+ cursor?: string;
3819
+ /** List of emails of Rev users to be filtered. */
3820
+ email?: string[];
3821
+ /** List of external refs to filter Rev users for. */
3822
+ external_ref?: string[];
3823
+ /**
3824
+ * The maximum number of Rev users to return. The default is '50'.
3825
+ * @format int32
3826
+ */
3827
+ limit?: number;
3828
+ /**
3829
+ * The iteration mode to use, otherwise if not set, then "after" is
3830
+ * used.
3831
+ */
3832
+ mode?: ListMode;
3833
+ /**
3834
+ * Filters for objects created after the provided timestamp (inclusive).
3835
+ * @format date-time
3836
+ */
3837
+ 'modified_date.after'?: string;
3838
+ /**
3839
+ * Filters for objects created before the provided timestamp
3840
+ * (inclusive).
3841
+ * @format date-time
3842
+ */
3843
+ 'modified_date.before'?: string;
3844
+ /** List of phone numbers to filter Rev users on. */
3845
+ phone_numbers?: string[];
3846
+ /**
3847
+ * List of IDs of Rev organizations to be filtered.
3848
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
3849
+ */
3850
+ rev_org?: string[];
3851
+ /** Fields to sort the Rev users by and the direction to sort them. */
3852
+ sort_by?: string[];
3853
+ }, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
3854
+ /**
3855
+ * @description Unlinks a rev user from a rev org.
3856
+ *
3857
+ * @tags rev-users
3858
+ * @name UnlinkRevUserFromRevOrg
3859
+ * @request POST:/rev-users.unlink
3860
+ * @secure
3861
+ */
3862
+ unlinkRevUserFromRevOrg: (data: UnlinkRevUserFromRevOrgRequest, params?: RequestParams) => Promise<AxiosResponse<UnlinkRevUserFromRevOrgResponse, any>>;
3863
+ /**
3864
+ * @description Updates a Rev user.
3865
+ *
3866
+ * @tags rev-users
3867
+ * @name RevUsersUpdate
3868
+ * @request POST:/rev-users.update
3869
+ * @secure
3870
+ */
3871
+ revUsersUpdate: (data: RevUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersUpdateResponse, any>>;
3872
+ /**
3873
+ * @description Gets the aggregated schema.
3874
+ *
3875
+ * @tags customization
3876
+ * @name AggregatedSchemaGet
3877
+ * @request GET:/schemas.aggregated.get
3878
+ * @secure
3879
+ */
3880
+ aggregatedSchemaGet: (query: {
3881
+ /** The list of custom schema fragment DONs which are to be aggregated. */
3882
+ custom_schema_fragment_ids: string[];
3883
+ /** The stock schema fragment which is to be aggregated. */
3884
+ stock_schema_fragment_id?: string;
3885
+ }, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any>>;
3886
+ /**
3887
+ * @description Gets a custom schema fragment.
3888
+ *
3889
+ * @tags customization
3890
+ * @name CustomSchemaFragmentsGet
3891
+ * @request GET:/schemas.custom.get
3892
+ * @secure
3893
+ */
3894
+ customSchemaFragmentsGet: (query: {
3895
+ /** The ID of the custom schema fragment. */
3896
+ id: string;
3897
+ }, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any>>;
3898
+ /**
3899
+ * @description Lists custom schema fragments.
3900
+ *
3901
+ * @tags customization
3902
+ * @name CustomSchemaFragmentsList
3903
+ * @request GET:/schemas.custom.list
3904
+ * @secure
3905
+ */
3906
+ customSchemaFragmentsList: (query?: {
3907
+ /** The list of app names. */
3908
+ app?: string[];
3909
+ /**
3910
+ * The cursor to resume iteration from, otherwise if not provided, then
3911
+ * iteration starts from the beginning.
3912
+ */
3913
+ cursor?: string;
3914
+ /** The list of leaf types. */
3915
+ leaf_type?: string[];
3916
+ /**
3917
+ * The maximum number of items.
3918
+ * @format int32
3919
+ */
3920
+ limit?: number;
3921
+ /** The list of fields to sort the items by and how to sort them. */
3922
+ sort_by?: string[];
3923
+ /** The list of subtypes. */
3924
+ subtype?: string[];
3925
+ /** Filters for custom schema fragment of the provided types. */
3926
+ types?: CustomSchemaFragmentType[];
3927
+ }, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any>>;
3928
+ /**
3929
+ * @description Creates or updates a custom schema fragment.
3930
+ *
3931
+ * @tags customization
3932
+ * @name CustomSchemaFragmentsSet
3933
+ * @request POST:/schemas.custom.set
3934
+ * @secure
3935
+ */
3936
+ customSchemaFragmentsSet: (data: CustomSchemaFragmentsSetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsSetResponse, any>>;
3937
+ /**
3938
+ * @description Lists subtypes.
3939
+ *
3940
+ * @tags customization
3941
+ * @name SubtypesList
3942
+ * @request GET:/schemas.subtypes.list
3943
+ * @secure
3944
+ */
3945
+ subtypesList: (query?: {
3946
+ /**
3947
+ * Leaf type for which subtypes are required.
3948
+ * @deprecated
3949
+ */
3950
+ leaf_type?: string;
3951
+ /** List of leaf types for which subtypes are required. */
3952
+ leaf_types?: string[];
3953
+ }, params?: RequestParams) => Promise<AxiosResponse<SubtypesListResponse, any>>;
3954
+ /**
3955
+ * @description Assigns the SLA to a set of Rev organizations.
3956
+ *
3957
+ * @tags slas
3958
+ * @name SlasAssign
3959
+ * @request POST:/slas.assign
3960
+ * @secure
3961
+ */
3962
+ slasAssign: (data: SlasAssignRequest, params?: RequestParams) => Promise<AxiosResponse<SlasAssignResponse, any>>;
3963
+ /**
3964
+ * @description Creates an SLA in draft status.
3965
+ *
3966
+ * @tags slas
3967
+ * @name SlasCreate
3968
+ * @request POST:/slas.create
3969
+ * @secure
3970
+ */
3971
+ slasCreate: (data: SlasCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SlasCreateResponse, any>>;
3972
+ /**
3973
+ * @description Gets an SLA.
3974
+ *
3975
+ * @tags slas
3976
+ * @name SlasGet
3977
+ * @request GET:/slas.get
3978
+ * @secure
3979
+ */
3980
+ slasGet: (query: {
3981
+ /** The ID of the SLA to get. */
3982
+ id: string;
3983
+ }, params?: RequestParams) => Promise<AxiosResponse<SlasGetResponse, any>>;
3984
+ /**
3985
+ * @description Lists SLAs matching a filter.
3986
+ *
3987
+ * @tags slas
3988
+ * @name SlasList
3989
+ * @request GET:/slas.list
3990
+ * @secure
3991
+ */
3992
+ slasList: (query?: {
3993
+ /**
3994
+ * The cursor to resume iteration from. If not provided, then iteration
3995
+ * starts from the beginning.
3996
+ */
3997
+ cursor?: string;
3998
+ /**
3999
+ * The maximum number of SLAs to return. The default is '50'.
4000
+ * @format int32
4001
+ */
4002
+ limit?: number;
4003
+ /**
4004
+ * The iteration mode to use, otherwise if not set, then "after" is
4005
+ * used.
4006
+ */
4007
+ mode?: ListMode;
4008
+ /** The SLA statuses the filter matches. */
4009
+ status?: SlaStatus[];
4010
+ }, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any>>;
4011
+ /**
4012
+ * @description Changes the status of an SLA.
4013
+ *
4014
+ * @tags slas
4015
+ * @name SlasTransition
4016
+ * @request POST:/slas.transition
4017
+ * @secure
4018
+ */
4019
+ slasTransition: (data: SlasTransitionRequest, params?: RequestParams) => Promise<AxiosResponse<SlasTransitionResponse, any>>;
4020
+ /**
4021
+ * @description Updates a draft SLA.
4022
+ *
4023
+ * @tags slas
4024
+ * @name SlasUpdate
4025
+ * @request POST:/slas.update
4026
+ * @secure
4027
+ */
4028
+ slasUpdate: (data: SlasUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SlasUpdateResponse, any>>;
4029
+ /**
4030
+ * @description Lists system users within your organization.
4031
+ *
4032
+ * @tags sys-users
4033
+ * @name SysUsersList
4034
+ * @request GET:/sys-users.list
4035
+ * @secure
4036
+ */
4037
+ sysUsersList: (query?: {
4038
+ /**
4039
+ * The cursor to resume iteration from. If not provided, then iteration
4040
+ * starts from the beginning.
4041
+ */
4042
+ cursor?: string;
4043
+ /**
4044
+ * The maximum number of system users to return. Value can range from
4045
+ * '1' to '100', with a default of '50'.
4046
+ * @format int32
4047
+ */
4048
+ limit?: number;
4049
+ /**
4050
+ * The iteration mode to use, otherwise if not set, then "after" is
4051
+ * used.
4052
+ */
4053
+ mode?: ListMode;
4054
+ /** Fields to sort the system users by and the direction to sort them. */
4055
+ sort_by?: string[];
4056
+ }, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any>>;
4057
+ /**
4058
+ * @description Updates the system user.
4059
+ *
4060
+ * @tags sys-users
4061
+ * @name SysUsersUpdate
4062
+ * @request POST:/sys-users.update
4063
+ * @secure
4064
+ */
4065
+ sysUsersUpdate: (data: SysUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SysUsersUpdateResponse, any>>;
4066
+ /**
4067
+ * @description Creates a new entry on an object's timeline.
4068
+ *
4069
+ * @tags timeline-entries
4070
+ * @name TimelineEntriesCreate
4071
+ * @request POST:/timeline-entries.create
4072
+ * @secure
4073
+ */
4074
+ timelineEntriesCreate: (data: TimelineEntriesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesCreateResponse, any>>;
4075
+ /**
4076
+ * @description Lists the timeline entries for an object.
4077
+ *
4078
+ * @tags timeline-entries
4079
+ * @name TimelineEntriesList
4080
+ * @request GET:/timeline-entries.list
4081
+ * @secure
4082
+ */
4083
+ timelineEntriesList: (query: {
4084
+ /**
4085
+ * The ID of the object to list timeline entries for.
4086
+ * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
4087
+ */
4088
+ object: string;
4089
+ /**
4090
+ * The collection(s) to list entries from, otherwise if not provided,
4091
+ * all entries are returned.
4092
+ */
4093
+ collections?: TimelineEntriesCollection[];
4094
+ /**
4095
+ * The cursor to resume iteration from. If not provided, then iteration
4096
+ * starts from the beginning.
4097
+ */
4098
+ cursor?: string;
4099
+ /**
4100
+ * The maximum number of entries to return. If not set, then this
4101
+ * defaults to `50`.
4102
+ * @format int32
4103
+ */
4104
+ limit?: number;
4105
+ /**
4106
+ * The iteration mode to use, otherwise if not set, then "after" is
4107
+ * used.
4108
+ */
4109
+ mode?: ListMode;
4110
+ /**
4111
+ * The visibility of the timeline entries to filter for. Note this is a
4112
+ * strict filter, such that only entries with the exact visibilities
4113
+ * specified will be returned.
4114
+ */
4115
+ visibility?: TimelineEntryVisibility[];
4116
+ }, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any>>;
4117
+ /**
4118
+ * @description Creates new work ([issue](https://devrev.ai/docs/product/build), [ticket](https://devrev.ai/docs/product/support)) item. [task](https://docs.devrev.ai/product/tasks) and opportunity work types are supported in the beta version.
4119
+ *
4120
+ * @tags works
4121
+ * @name WorksCreate
4122
+ * @request POST:/works.create
4123
+ * @secure
4124
+ */
4125
+ worksCreate: (data: WorksCreateRequest, params?: RequestParams) => Promise<AxiosResponse<WorksCreateResponse, any>>;
4126
+ /**
4127
+ * @description Deletes a work item.
4128
+ *
4129
+ * @tags works
4130
+ * @name WorksDelete
4131
+ * @request POST:/works.delete
4132
+ * @secure
4133
+ */
4134
+ worksDelete: (data: WorksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
4135
+ /**
4136
+ * @description Exports a collection of work items.
4137
+ *
4138
+ * @tags works
4139
+ * @name WorksExport
4140
+ * @request GET:/works.export
4141
+ * @secure
4142
+ */
4143
+ worksExport: (query?: {
4144
+ /**
4145
+ * Filters for work belonging to any of the provided parts.
4146
+ * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
4147
+ */
4148
+ applies_to_part?: string[];
4149
+ /**
4150
+ * Filters for work created by any of these users.
4151
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
4152
+ */
4153
+ created_by?: string[];
4154
+ /** Filters for custom fields. */
4155
+ custom_fields?: object;
4156
+ /**
4157
+ * The number of work items to return. The default is '50', the maximum
4158
+ * is '5000'.
4159
+ * @format int32
4160
+ */
4161
+ first?: number;
4162
+ /** Filters for issues with any of the provided priorities. */
4163
+ 'issue.priority'?: IssuePriority[];
4164
+ /**
4165
+ * Filters for issues with any of the provided Rev organizations.
4166
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
4167
+ */
4168
+ 'issue.rev_orgs'?: string[];
4169
+ /**
4170
+ * Filters for opportunities belonging to any of the provided accounts.
4171
+ * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
4172
+ */
4173
+ 'opportunity.account'?: string[];
4174
+ /** Filters for opportunities with any of the provided contacts. */
4175
+ 'opportunity.contacts'?: string[];
4176
+ /**
4177
+ * Filters for work owned by any of these users.
4178
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
4179
+ */
4180
+ owned_by?: string[];
4181
+ /** Filters for records in the provided stage(s). */
4182
+ 'stage.name'?: string[];
4183
+ /** Filters for tickets belonging to specific groups. */
4184
+ 'ticket.group'?: string[];
4185
+ /** Filters for tickets that are spam. */
4186
+ 'ticket.is_spam'?: boolean;
4187
+ /** Filters for tickets that need response. */
4188
+ 'ticket.needs_response'?: boolean;
4189
+ /**
4190
+ * Filters for tickets that are associated with any of the provided Rev
4191
+ * organizations.
4192
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
4193
+ */
4194
+ 'ticket.rev_org'?: string[];
4195
+ /** Filters for tickets with any of the provided severities. */
4196
+ 'ticket.severity'?: TicketSeverity[];
4197
+ /** Filters for tickets with any of the provided source channels. */
4198
+ 'ticket.source_channel'?: string[];
4199
+ /** Filters for work of the provided types. */
4200
+ type?: WorkType[];
4201
+ }, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any>>;
4202
+ /**
4203
+ * @description Gets a work item's information.
4204
+ *
4205
+ * @tags works
4206
+ * @name WorksGet
4207
+ * @request GET:/works.get
4208
+ * @secure
4209
+ */
4210
+ worksGet: (query: {
4211
+ /**
4212
+ * The work's ID.
4213
+ * @example "don:core:<partition>:devo/<dev-org-id>:<work-type>/<work-id>"
4214
+ */
4215
+ id: string;
4216
+ }, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any>>;
4217
+ /**
4218
+ * @description Lists a collection of work items.
4219
+ *
4220
+ * @tags works
4221
+ * @name WorksList
4222
+ * @request GET:/works.list
4223
+ * @secure
4224
+ */
4225
+ worksList: (query?: {
4226
+ /**
4227
+ * Filters for work belonging to any of the provided parts.
4228
+ * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
4229
+ */
4230
+ applies_to_part?: string[];
4231
+ /**
4232
+ * Filters for work created by any of these users.
4233
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
4234
+ */
4235
+ created_by?: string[];
4236
+ /**
4237
+ * The cursor to resume iteration from. If not provided, then iteration
4238
+ * starts from the beginning.
4239
+ */
4240
+ cursor?: string;
4241
+ /** Filters for custom fields. */
4242
+ custom_fields?: object;
4243
+ /** Filters for issues with any of the provided priorities. */
4244
+ 'issue.priority'?: IssuePriority[];
4245
+ /**
4246
+ * Filters for issues with any of the provided Rev organizations.
4247
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
4248
+ */
4249
+ 'issue.rev_orgs'?: string[];
4250
+ /**
4251
+ * The maximum number of works to return. The default is '50'.
4252
+ * @format int32
4253
+ */
4254
+ limit?: number;
4255
+ /**
4256
+ * The iteration mode to use, otherwise if not set, then "after" is
4257
+ * used.
4258
+ */
4259
+ mode?: ListMode;
4260
+ /**
4261
+ * Filters for opportunities belonging to any of the provided accounts.
4262
+ * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
4263
+ */
4264
+ 'opportunity.account'?: string[];
4265
+ /** Filters for opportunities with any of the provided contacts. */
4266
+ 'opportunity.contacts'?: string[];
4267
+ /**
4268
+ * Filters for work owned by any of these users.
4269
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
4270
+ */
4271
+ owned_by?: string[];
4272
+ /** Filters for records in the provided stage(s). */
4273
+ 'stage.name'?: string[];
4274
+ /** Filters for tickets belonging to specific groups. */
4275
+ 'ticket.group'?: string[];
4276
+ /** Filters for tickets that are spam. */
4277
+ 'ticket.is_spam'?: boolean;
4278
+ /** Filters for tickets that need response. */
4279
+ 'ticket.needs_response'?: boolean;
4280
+ /**
4281
+ * Filters for tickets that are associated with any of the provided Rev
4282
+ * organizations.
4283
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
4284
+ */
4285
+ 'ticket.rev_org'?: string[];
4286
+ /** Filters for tickets with any of the provided severities. */
4287
+ 'ticket.severity'?: TicketSeverity[];
4288
+ /** Filters for tickets with any of the provided source channels. */
4289
+ 'ticket.source_channel'?: string[];
4290
+ /** Filters for work of the provided types. */
4291
+ type?: WorkType[];
4292
+ }, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;
4293
+ /**
4294
+ * @description Updates a work item's information.
4295
+ *
4296
+ * @tags works
4297
+ * @name WorksUpdate
4298
+ * @request POST:/works.update
4299
+ * @secure
4300
+ */
4301
+ worksUpdate: (data: WorksUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<WorksUpdateResponse, any>>;
4302
+ }