@devrev/typescript-sdk 1.1.42 → 1.1.44

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.
@@ -1306,6 +1306,10 @@ export declare enum AssociatedToType {
1306
1306
  Account = "account",
1307
1307
  RevOrg = "rev_org"
1308
1308
  }
1309
+ /** atom */
1310
+ export type Atom = (Account | AppFragment | Capability | Conversation | CustomTypeFragment | DevUser | Engagement | Enhancement | Feature | Incident | Issue | Meeting | Opportunity | Product | RevOrg | RevUser | ServiceAccount | SysUser | Tag | Task | TenantFragment | Ticket | TimelineChangeEvent | TimelineComment | UserPreferences | Webhook) & {
1311
+ type: AtomType;
1312
+ };
1309
1313
  /** atom-base */
1310
1314
  export interface AtomBase {
1311
1315
  created_by?: UserSummary;
@@ -1366,6 +1370,15 @@ export declare enum AtomType {
1366
1370
  UserPreferences = "user_preferences",
1367
1371
  Webhook = "webhook"
1368
1372
  }
1373
+ /** atoms-get-request */
1374
+ export interface AtomsGetRequest {
1375
+ /** The ID of the object to get. */
1376
+ id: string;
1377
+ }
1378
+ /** atoms-get-response */
1379
+ export interface AtomsGetResponse {
1380
+ atom: Atom;
1381
+ }
1369
1382
  /**
1370
1383
  * auth-connection
1371
1384
  * Connection object that specifies the configuration for an
@@ -1447,7 +1460,9 @@ export interface AuthConnectionOptionsOkta {
1447
1460
  */
1448
1461
  export interface AuthConnectionOptionsSaml {
1449
1462
  /**
1450
- * Connection name for the SAML authentication connection.
1463
+ * Connection name for the SAML authentication connection. Must match
1464
+ * the `connection` query parameter specified in the sign on URL
1465
+ * during SAML configuration in your identity provider.
1451
1466
  * @minLength 1
1452
1467
  * @maxLength 128
1453
1468
  */
@@ -2541,6 +2556,13 @@ export interface ContentTemplateListResponse {
2541
2556
  export type ContentTemplateType = string;
2542
2557
  /** conversation */
2543
2558
  export type Conversation = AtomBase & {
2559
+ /** Custom fields. */
2560
+ custom_fields?: object;
2561
+ /**
2562
+ * Custom schema fragments.
2563
+ * @example ["don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"]
2564
+ */
2565
+ custom_schema_fragments?: string[];
2544
2566
  /** Description of the conversation object. */
2545
2567
  description?: string;
2546
2568
  group?: GroupSummary;
@@ -2557,6 +2579,13 @@ export type Conversation = AtomBase & {
2557
2579
  sla_tracker?: SlaTrackerSummary;
2558
2580
  /** Describes the current stage of a work item. */
2559
2581
  stage?: LegacyStage;
2582
+ /**
2583
+ * Stock schema fragment.
2584
+ * @example "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
2585
+ */
2586
+ stock_schema_fragment?: string;
2587
+ /** Subtype corresponding to the custom type fragment. */
2588
+ subtype?: string;
2560
2589
  /** Tags associated with the object. */
2561
2590
  tags?: TagWithValue[];
2562
2591
  /** Title of the conversation object. */
@@ -2693,6 +2722,7 @@ export interface ConversationsExportRequest {
2693
2722
  * @example ["DEVU-12345"]
2694
2723
  */
2695
2724
  members?: string[];
2725
+ modified_date?: DateTimeFilter;
2696
2726
  /**
2697
2727
  * Filters for conversations owned by any of these users.
2698
2728
  * @example ["DEVU-12345"]
@@ -2794,6 +2824,7 @@ export interface ConversationsListRequest {
2794
2824
  * always be returned in the specified sort-by order.
2795
2825
  */
2796
2826
  mode?: ListMode;
2827
+ modified_date?: DateTimeFilter;
2797
2828
  /**
2798
2829
  * Filters for conversations owned by any of these users.
2799
2830
  * @example ["DEVU-12345"]
@@ -2876,6 +2907,7 @@ export interface ConversationsUpdateRequest {
2876
2907
  id: string;
2877
2908
  /** Whether the conversation is spam. */
2878
2909
  is_spam?: boolean;
2910
+ members?: ConversationsUpdateRequestMembers;
2879
2911
  metadata?: ConversationsUpdateRequestMetadata;
2880
2912
  owned_by?: ConversationsUpdateRequestOwnedBy;
2881
2913
  /** Updates an object's stage. */
@@ -2895,6 +2927,14 @@ export interface ConversationsUpdateRequestAppliesToParts {
2895
2927
  */
2896
2928
  set?: string[];
2897
2929
  }
2930
+ /** conversations-update-request-members */
2931
+ export interface ConversationsUpdateRequestMembers {
2932
+ /**
2933
+ * Sets the member IDs to the provided user IDs.
2934
+ * @example ["DEVU-12345"]
2935
+ */
2936
+ set?: string[];
2937
+ }
2898
2938
  /** conversations-update-request-metadata */
2899
2939
  export interface ConversationsUpdateRequestMetadata {
2900
2940
  url_context?: string;
@@ -3087,6 +3127,22 @@ export interface CreateStage {
3087
3127
  /** DON of the stage. */
3088
3128
  stage: string;
3089
3129
  }
3130
+ /** create-stage-node */
3131
+ export interface CreateStageNode {
3132
+ /** Whether this stage is deprecated. */
3133
+ is_deprecated?: boolean;
3134
+ /** Whether this is the start stage. */
3135
+ is_start?: boolean;
3136
+ /** The ID of the stage. */
3137
+ stage_id: string;
3138
+ /** List of transitions from this stage. */
3139
+ transitions?: CreateStageTransition[];
3140
+ }
3141
+ /** create-stage-transition */
3142
+ export interface CreateStageTransition {
3143
+ /** The ID of the target stage. */
3144
+ target_stage_id: string;
3145
+ }
3090
3146
  /**
3091
3147
  * create-tag-with-value
3092
3148
  * Create object for tag_summary.
@@ -3956,7 +4012,9 @@ export interface DevOrgAuthConnectionsCreateRequestOktaOptions {
3956
4012
  */
3957
4013
  export interface DevOrgAuthConnectionsCreateRequestSamlOptions {
3958
4014
  /**
3959
- * Connection name for the SAML authentication connection.
4015
+ * Connection name for the SAML authentication connection. Must match
4016
+ * the `connection` query parameter specified in the sign on URL
4017
+ * during SAML configuration in your identity provider.
3960
4018
  * @minLength 1
3961
4019
  * @maxLength 128
3962
4020
  */
@@ -5290,10 +5348,12 @@ export interface EventConversationCreated {
5290
5348
  export interface EventConversationDeleted {
5291
5349
  /** The ID of the conversation that was deleted. */
5292
5350
  id: string;
5351
+ old_conversation?: Conversation;
5293
5352
  }
5294
5353
  /** event-conversation-updated */
5295
5354
  export interface EventConversationUpdated {
5296
5355
  conversation: Conversation;
5356
+ old_conversation?: Conversation;
5297
5357
  }
5298
5358
  /** event-dev-user-created */
5299
5359
  export interface EventDevUserCreated {
@@ -5431,6 +5491,7 @@ export interface EventSlaTrackerDeleted {
5431
5491
  }
5432
5492
  /** event-sla-tracker-updated */
5433
5493
  export interface EventSlaTrackerUpdated {
5494
+ old_sla_tracker?: SlaTracker;
5434
5495
  sla_tracker: SlaTracker;
5435
5496
  }
5436
5497
  /** event-source */
@@ -6401,6 +6462,8 @@ export interface IncidentsGroupRequest {
6401
6462
  * iteration starts from the beginning.
6402
6463
  */
6403
6464
  cursor?: string;
6465
+ /** Filters for custom fields. */
6466
+ custom_fields?: object;
6404
6467
  /** The field to group the incidents by. */
6405
6468
  group_by: string;
6406
6469
  /** Provides ways to specify date ranges on objects. */
@@ -6498,6 +6561,8 @@ export interface IncidentsListRequest {
6498
6561
  * iteration starts from the beginning.
6499
6562
  */
6500
6563
  cursor?: string;
6564
+ /** Filters for custom fields. */
6565
+ custom_fields?: object;
6501
6566
  /** Provides ways to specify date ranges on objects. */
6502
6567
  identified_date?: DateFilter;
6503
6568
  /**
@@ -9476,6 +9541,8 @@ export type SchemaEnumFieldDescriptor = SchemaFieldDescriptorBase & {
9476
9541
  allowed_values: string[];
9477
9542
  /** Default value. */
9478
9543
  default_value?: string;
9544
+ /** Translations for allowed_values field. */
9545
+ translated_values?: Record<string, string>;
9479
9546
  };
9480
9547
  /** schema-enum-list-field-descriptor */
9481
9548
  export type SchemaEnumListFieldDescriptor = SchemaFieldDescriptorBase & {
@@ -9483,6 +9550,8 @@ export type SchemaEnumListFieldDescriptor = SchemaFieldDescriptorBase & {
9483
9550
  allowed_values: string[];
9484
9551
  /** Default value. */
9485
9552
  default_value?: string[];
9553
+ /** Translations for allowed_values field. */
9554
+ translated_values?: Record<string, string>;
9486
9555
  };
9487
9556
  /**
9488
9557
  * schema-field-create-view-ui-metadata
@@ -10805,6 +10874,8 @@ export interface SnapInsResourcesResponse {
10805
10874
  export interface SnapInsResourcesResponseKeyringData {
10806
10875
  /** The ID of the keyring. */
10807
10876
  id: string;
10877
+ /** Whether the keyring token is expired. */
10878
+ is_expired: boolean;
10808
10879
  /** The secret value of the keyring. This must be handled with caution. */
10809
10880
  secret: string;
10810
10881
  }
@@ -10873,8 +10944,108 @@ export interface Stage {
10873
10944
  stage?: CustomStageSummary;
10874
10945
  state?: CustomStateSummary;
10875
10946
  }
10947
+ /** stage-diagram */
10948
+ export type StageDiagram = AtomBase & {
10949
+ /** True if this diagram corresponds to a custom leaf type. */
10950
+ is_custom_leaf_type?: boolean;
10951
+ /** True if this diagram is the default for the leaf type. */
10952
+ is_default?: boolean;
10953
+ /** The leaf type this stage diagram applies to. */
10954
+ leaf_type?: string;
10955
+ /** The human readable name of the diagram. */
10956
+ name?: string;
10957
+ /** Stage node. */
10958
+ stages: StageNode[];
10959
+ };
10876
10960
  /** stage-diagram-summary */
10877
- export type StageDiagramSummary = AtomBaseSummary;
10961
+ export type StageDiagramSummary = AtomBaseSummary & {
10962
+ /** The human readable name of the diagram. */
10963
+ name?: string;
10964
+ };
10965
+ /** stage-diagrams-create-request */
10966
+ export interface StageDiagramsCreateRequest {
10967
+ /** Whether the leaf type corresponds to a custom object. */
10968
+ is_custom_leaf_type?: boolean;
10969
+ /** Whether this is a default stage diagram. */
10970
+ is_default?: boolean;
10971
+ /** The leaf type this stage diagram applies to. */
10972
+ leaf_type: string;
10973
+ /**
10974
+ * The name of the stage diagram. Stage diagram is used for defining
10975
+ * stage transitions.
10976
+ */
10977
+ name: string;
10978
+ /** List of stages in the diagram. */
10979
+ stages: CreateStageNode[];
10980
+ }
10981
+ /** stage-diagrams-create-response */
10982
+ export interface StageDiagramsCreateResponse {
10983
+ stage_diagram: StageDiagram;
10984
+ }
10985
+ /** stage-diagrams-get-request */
10986
+ export interface StageDiagramsGetRequest {
10987
+ /** The ID of the stage diagram to get. */
10988
+ id?: string;
10989
+ /**
10990
+ * Whether the leaf type corresponds to a custom object. Specify this
10991
+ * along with leaf_type to get the default custom object stage
10992
+ * diagram.
10993
+ */
10994
+ is_custom_leaf_type?: boolean;
10995
+ /**
10996
+ * The leaf type. Should be specified to retrieve the default stage
10997
+ * diagram for the leaf type. If not provided, then id is used.
10998
+ */
10999
+ leaf_type?: string;
11000
+ }
11001
+ /** stage-diagrams-get-response */
11002
+ export interface StageDiagramsGetResponse {
11003
+ stage_diagram: StageDiagram;
11004
+ }
11005
+ /** stage-diagrams-list-request */
11006
+ export interface StageDiagramsListRequest {
11007
+ /**
11008
+ * The cursor to resume iteration from, otherwise if not provided,
11009
+ * then iteration starts from the beginning.
11010
+ */
11011
+ cursor?: string;
11012
+ /** Whether only custom object stage diagrams should be filtered. */
11013
+ is_custom_leaf_type?: boolean;
11014
+ /** The list of leaf types. */
11015
+ leaf_type?: string[];
11016
+ /**
11017
+ * The maximum number of items.
11018
+ * @format int32
11019
+ */
11020
+ limit?: number;
11021
+ /** The list of stage diagram names. */
11022
+ name?: string[];
11023
+ /** The list of fields to sort the items by and how to sort them. */
11024
+ sort_by?: string[];
11025
+ }
11026
+ /** stage-diagrams-list-response */
11027
+ export interface StageDiagramsListResponse {
11028
+ /**
11029
+ * The cursor to resume iteration from, otherwise if not provided,
11030
+ * then iteration starts from the beginning.
11031
+ */
11032
+ cursor?: string;
11033
+ /** The stage diagram. */
11034
+ result: StageDiagram[];
11035
+ }
11036
+ /** stage-diagrams-update-request */
11037
+ export interface StageDiagramsUpdateRequest {
11038
+ /** The ID of the stage diagram to update. */
11039
+ id: string;
11040
+ /** The updated name of the stage diagram. */
11041
+ name?: string;
11042
+ /** List of stages in the stage diagram. */
11043
+ stages?: UpdateStageNode[];
11044
+ }
11045
+ /** stage-diagrams-update-response */
11046
+ export interface StageDiagramsUpdateResponse {
11047
+ stage_diagram: StageDiagram;
11048
+ }
10878
11049
  /**
10879
11050
  * stage-filter
10880
11051
  * The filter for stages.
@@ -10896,6 +11067,19 @@ export interface StageInit {
10896
11067
  /** The name of the stage. */
10897
11068
  name?: string;
10898
11069
  }
11070
+ /**
11071
+ * stage-node
11072
+ * Diagram stage.
11073
+ */
11074
+ export interface StageNode {
11075
+ /** True if this stage has been deprecated. */
11076
+ is_deprecated?: boolean;
11077
+ /** True if this stage is the starting stage of the stage diagram. */
11078
+ is_start?: boolean;
11079
+ stage?: CustomStageSummary;
11080
+ /** The list of stages that can be reached. */
11081
+ transitions?: StageTransition[];
11082
+ }
10899
11083
  /**
10900
11084
  * stage-summary
10901
11085
  * Describes the current stage of a object.
@@ -10903,6 +11087,13 @@ export interface StageInit {
10903
11087
  export interface StageSummary {
10904
11088
  stage?: CustomStageSummary;
10905
11089
  }
11090
+ /**
11091
+ * stage-transition
11092
+ * Stage transition.
11093
+ */
11094
+ export interface StageTransition {
11095
+ target_stage?: CustomStageSummary;
11096
+ }
10906
11097
  /**
10907
11098
  * stage-update
10908
11099
  * Updates an object's stage.
@@ -12928,6 +13119,22 @@ export interface UpdateStage {
12928
13119
  /** DON of the stage. */
12929
13120
  stage?: string;
12930
13121
  }
13122
+ /** update-stage-node */
13123
+ export interface UpdateStageNode {
13124
+ /** Whether this stage is deprecated. */
13125
+ is_deprecated?: boolean;
13126
+ /** Whether this is the start stage. */
13127
+ is_start?: boolean;
13128
+ /** The ID of the stage. */
13129
+ stage_id: string;
13130
+ /** List of transitions from this stage. */
13131
+ transitions?: UpdateStageTransition[];
13132
+ }
13133
+ /** update-stage-transition */
13134
+ export interface UpdateStageTransition {
13135
+ /** The ID of the target stage. */
13136
+ target_stage_id: string;
13137
+ }
12931
13138
  /**
12932
13139
  * update-tag-with-value
12933
13140
  * Update object for TagWithValue.
@@ -13592,7 +13799,11 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
13592
13799
  * @example "2023-01-01T12:00:00.000Z"
13593
13800
  */
13594
13801
  target_close_date?: string;
13595
- /** Title of the work object. */
13802
+ /**
13803
+ * Title of the work object.
13804
+ * @minLength 1
13805
+ * @maxLength 256
13806
+ */
13596
13807
  title: string;
13597
13808
  };
13598
13809
  /** works-create-request-issue */
@@ -13982,7 +14193,11 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
13982
14193
  * @example "2023-01-01T12:00:00.000Z"
13983
14194
  */
13984
14195
  target_close_date?: string | null;
13985
- /** Updated title of the work object, or unchanged if not provided. */
14196
+ /**
14197
+ * Updated title of the work object, or unchanged if not provided.
14198
+ * @minLength 1
14199
+ * @maxLength 256
14200
+ */
13986
14201
  title?: string;
13987
14202
  };
13988
14203
  /** works-update-request-artifacts */
@@ -14798,6 +15013,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
14798
15013
  * @secure
14799
15014
  */
14800
15015
  artifactsVersionsPrepare: (data: ArtifactsVersionsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsVersionsPrepareResponse, any>>;
15016
+ /**
15017
+ * @description Gets the specified object.
15018
+ *
15019
+ * @tags atoms
15020
+ * @name AtomsGet
15021
+ * @summary Get Atom
15022
+ * @request GET:/atoms.get
15023
+ * @secure
15024
+ */
15025
+ atomsGet: (query: {
15026
+ /** The ID of the object to get. */
15027
+ id: string;
15028
+ }, params?: RequestParams) => Promise<AxiosResponse<AtomsGetResponse, any>>;
15029
+ /**
15030
+ * @description Gets the specified object.
15031
+ *
15032
+ * @tags atoms
15033
+ * @name AtomsGetPost
15034
+ * @summary Get Atom (POST)
15035
+ * @request POST:/atoms.get
15036
+ * @secure
15037
+ */
15038
+ atomsGetPost: (data: AtomsGetRequest, params?: RequestParams) => Promise<AxiosResponse<AtomsGetResponse, any>>;
14801
15039
  /**
14802
15040
  * @description Retrieves audit logs.
14803
15041
  *
@@ -15246,6 +15484,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
15246
15484
  * @example ["DEVU-12345"]
15247
15485
  */
15248
15486
  members?: string[];
15487
+ /**
15488
+ * Filters for objects created after the provided timestamp (inclusive).
15489
+ * @format date-time
15490
+ * @example "2023-01-01T12:00:00.000Z"
15491
+ */
15492
+ 'modified_date.after'?: string;
15493
+ /**
15494
+ * Filters for objects created before the provided timestamp
15495
+ * (inclusive).
15496
+ * @format date-time
15497
+ * @example "2023-01-01T12:00:00.000Z"
15498
+ */
15499
+ 'modified_date.before'?: string;
15249
15500
  /**
15250
15501
  * Filters for conversations owned by any of these users.
15251
15502
  * @example ["DEVU-12345"]
@@ -15370,6 +15621,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
15370
15621
  * used.
15371
15622
  */
15372
15623
  mode?: ListMode;
15624
+ /**
15625
+ * Filters for objects created after the provided timestamp (inclusive).
15626
+ * @format date-time
15627
+ * @example "2023-01-01T12:00:00.000Z"
15628
+ */
15629
+ 'modified_date.after'?: string;
15630
+ /**
15631
+ * Filters for objects created before the provided timestamp
15632
+ * (inclusive).
15633
+ * @format date-time
15634
+ * @example "2023-01-01T12:00:00.000Z"
15635
+ */
15636
+ 'modified_date.before'?: string;
15373
15637
  /**
15374
15638
  * Filters for conversations owned by any of these users.
15375
15639
  * @example ["DEVU-12345"]
@@ -16320,6 +16584,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
16320
16584
  * starts from the beginning.
16321
16585
  */
16322
16586
  cursor?: string;
16587
+ /** Filters for custom fields. */
16588
+ custom_fields?: object;
16323
16589
  /**
16324
16590
  * The maximum number of groups to return. If not set, then the default
16325
16591
  * is '10'.
@@ -16401,6 +16667,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
16401
16667
  * starts from the beginning.
16402
16668
  */
16403
16669
  cursor?: string;
16670
+ /** Filters for custom fields. */
16671
+ custom_fields?: object;
16404
16672
  /**
16405
16673
  * The maximum number of items.
16406
16674
  * @format int32
@@ -18531,6 +18799,98 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
18531
18799
  * @secure
18532
18800
  */
18533
18801
  snapWidgetsCreate: (data: SnapWidgetsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SnapWidgetsCreateResponse, any>>;
18802
+ /**
18803
+ * @description Creates a stage diagram.
18804
+ *
18805
+ * @tags customization
18806
+ * @name StageDiagramsCreate
18807
+ * @summary Create Stage Diagram
18808
+ * @request POST:/stage-diagrams.create
18809
+ * @secure
18810
+ */
18811
+ stageDiagramsCreate: (data: StageDiagramsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsCreateResponse, any>>;
18812
+ /**
18813
+ * @description Gets a stage diagram.
18814
+ *
18815
+ * @tags customization
18816
+ * @name StageDiagramsGet
18817
+ * @summary Get Stage Diagram
18818
+ * @request GET:/stage-diagrams.get
18819
+ * @secure
18820
+ */
18821
+ stageDiagramsGet: (query?: {
18822
+ /** The ID of the stage diagram to get. */
18823
+ id?: string;
18824
+ /**
18825
+ * Whether the leaf type corresponds to a custom object. Specify this
18826
+ * along with leaf_type to get the default custom object stage diagram.
18827
+ */
18828
+ is_custom_leaf_type?: boolean;
18829
+ /**
18830
+ * The leaf type. Should be specified to retrieve the default stage
18831
+ * diagram for the leaf type. If not provided, then id is used.
18832
+ */
18833
+ leaf_type?: string;
18834
+ }, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsGetResponse, any>>;
18835
+ /**
18836
+ * @description Gets a stage diagram.
18837
+ *
18838
+ * @tags customization
18839
+ * @name StageDiagramsGetPost
18840
+ * @summary Get Stage Diagram (POST)
18841
+ * @request POST:/stage-diagrams.get
18842
+ * @secure
18843
+ */
18844
+ stageDiagramsGetPost: (data: StageDiagramsGetRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsGetResponse, any>>;
18845
+ /**
18846
+ * @description Lists stage diagrams.
18847
+ *
18848
+ * @tags customization
18849
+ * @name StageDiagramsList
18850
+ * @summary List Stage Diagrams
18851
+ * @request GET:/stage-diagrams.list
18852
+ * @secure
18853
+ */
18854
+ stageDiagramsList: (query?: {
18855
+ /**
18856
+ * The cursor to resume iteration from, otherwise if not provided, then
18857
+ * iteration starts from the beginning.
18858
+ */
18859
+ cursor?: string;
18860
+ /** Whether only custom object stage diagrams should be filtered. */
18861
+ is_custom_leaf_type?: boolean;
18862
+ /** The list of leaf types. */
18863
+ leaf_type?: string[];
18864
+ /**
18865
+ * The maximum number of items.
18866
+ * @format int32
18867
+ */
18868
+ limit?: number;
18869
+ /** The list of stage diagram names. */
18870
+ name?: string[];
18871
+ /** The list of fields to sort the items by and how to sort them. */
18872
+ sort_by?: string[];
18873
+ }, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsListResponse, any>>;
18874
+ /**
18875
+ * @description Lists stage diagrams.
18876
+ *
18877
+ * @tags customization
18878
+ * @name StageDiagramsListPost
18879
+ * @summary List Stage Diagrams (POST)
18880
+ * @request POST:/stage-diagrams.list
18881
+ * @secure
18882
+ */
18883
+ stageDiagramsListPost: (data: StageDiagramsListRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsListResponse, any>>;
18884
+ /**
18885
+ * @description Updates a stage diagram.
18886
+ *
18887
+ * @tags customization
18888
+ * @name StageDiagramsUpdate
18889
+ * @summary Update Stage Diagram
18890
+ * @request POST:/stage-diagrams.update
18891
+ * @secure
18892
+ */
18893
+ stageDiagramsUpdate: (data: StageDiagramsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsUpdateResponse, any>>;
18534
18894
  /**
18535
18895
  * @description Creates a custom stage.
18536
18896
  *
@@ -1670,6 +1670,26 @@ class Api extends HttpClient {
1670
1670
  * @secure
1671
1671
  */
1672
1672
  this.artifactsVersionsPrepare = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.versions.prepare`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1673
+ /**
1674
+ * @description Gets the specified object.
1675
+ *
1676
+ * @tags atoms
1677
+ * @name AtomsGet
1678
+ * @summary Get Atom
1679
+ * @request GET:/atoms.get
1680
+ * @secure
1681
+ */
1682
+ this.atomsGet = (query, params = {}) => this.request(Object.assign({ path: `/atoms.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
1683
+ /**
1684
+ * @description Gets the specified object.
1685
+ *
1686
+ * @tags atoms
1687
+ * @name AtomsGetPost
1688
+ * @summary Get Atom (POST)
1689
+ * @request POST:/atoms.get
1690
+ * @secure
1691
+ */
1692
+ this.atomsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/atoms.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1673
1693
  /**
1674
1694
  * @description Retrieves audit logs.
1675
1695
  *
@@ -4019,6 +4039,66 @@ class Api extends HttpClient {
4019
4039
  * @secure
4020
4040
  */
4021
4041
  this.snapWidgetsCreate = (data, params = {}) => this.request(Object.assign({ path: `/snap-widgets.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4042
+ /**
4043
+ * @description Creates a stage diagram.
4044
+ *
4045
+ * @tags customization
4046
+ * @name StageDiagramsCreate
4047
+ * @summary Create Stage Diagram
4048
+ * @request POST:/stage-diagrams.create
4049
+ * @secure
4050
+ */
4051
+ this.stageDiagramsCreate = (data, params = {}) => this.request(Object.assign({ path: `/stage-diagrams.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4052
+ /**
4053
+ * @description Gets a stage diagram.
4054
+ *
4055
+ * @tags customization
4056
+ * @name StageDiagramsGet
4057
+ * @summary Get Stage Diagram
4058
+ * @request GET:/stage-diagrams.get
4059
+ * @secure
4060
+ */
4061
+ this.stageDiagramsGet = (query, params = {}) => this.request(Object.assign({ path: `/stage-diagrams.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4062
+ /**
4063
+ * @description Gets a stage diagram.
4064
+ *
4065
+ * @tags customization
4066
+ * @name StageDiagramsGetPost
4067
+ * @summary Get Stage Diagram (POST)
4068
+ * @request POST:/stage-diagrams.get
4069
+ * @secure
4070
+ */
4071
+ this.stageDiagramsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/stage-diagrams.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4072
+ /**
4073
+ * @description Lists stage diagrams.
4074
+ *
4075
+ * @tags customization
4076
+ * @name StageDiagramsList
4077
+ * @summary List Stage Diagrams
4078
+ * @request GET:/stage-diagrams.list
4079
+ * @secure
4080
+ */
4081
+ this.stageDiagramsList = (query, params = {}) => this.request(Object.assign({ path: `/stage-diagrams.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4082
+ /**
4083
+ * @description Lists stage diagrams.
4084
+ *
4085
+ * @tags customization
4086
+ * @name StageDiagramsListPost
4087
+ * @summary List Stage Diagrams (POST)
4088
+ * @request POST:/stage-diagrams.list
4089
+ * @secure
4090
+ */
4091
+ this.stageDiagramsListPost = (data, params = {}) => this.request(Object.assign({ path: `/stage-diagrams.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4092
+ /**
4093
+ * @description Updates a stage diagram.
4094
+ *
4095
+ * @tags customization
4096
+ * @name StageDiagramsUpdate
4097
+ * @summary Update Stage Diagram
4098
+ * @request POST:/stage-diagrams.update
4099
+ * @secure
4100
+ */
4101
+ this.stageDiagramsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/stage-diagrams.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4022
4102
  /**
4023
4103
  * @description Creates a custom stage.
4024
4104
  *
@@ -503,6 +503,10 @@ export interface ArtifactsPrepareResponseFormData {
503
503
  /** Value corresponding to the key. */
504
504
  value: string;
505
505
  }
506
+ /** atom */
507
+ export type Atom = (Capability | Conversation | DevUser | Enhancement | Feature | Issue | Product | RevOrg | RevUser | SysUser | Tag | Ticket | TimelineComment | Webhook) & {
508
+ type: AtomType;
509
+ };
506
510
  /** atom-base */
507
511
  export interface AtomBase {
508
512
  created_by?: UserSummary;
@@ -531,6 +535,31 @@ export interface AtomBaseSummary {
531
535
  /** Globally unique object ID. */
532
536
  id: string;
533
537
  }
538
+ export declare enum AtomType {
539
+ Capability = "capability",
540
+ Conversation = "conversation",
541
+ DevUser = "dev_user",
542
+ Enhancement = "enhancement",
543
+ Feature = "feature",
544
+ Issue = "issue",
545
+ Product = "product",
546
+ RevOrg = "rev_org",
547
+ RevUser = "rev_user",
548
+ SysUser = "sys_user",
549
+ Tag = "tag",
550
+ Ticket = "ticket",
551
+ TimelineComment = "timeline_comment",
552
+ Webhook = "webhook"
553
+ }
554
+ /** atoms-get-request */
555
+ export interface AtomsGetRequest {
556
+ /** The ID of the object to get. */
557
+ id: string;
558
+ }
559
+ /** atoms-get-response */
560
+ export interface AtomsGetResponse {
561
+ atom: Atom;
562
+ }
534
563
  /**
535
564
  * auth-connection
536
565
  * Connection object that specifies the configuration for an
@@ -612,7 +641,9 @@ export interface AuthConnectionOptionsOkta {
612
641
  */
613
642
  export interface AuthConnectionOptionsSaml {
614
643
  /**
615
- * Connection name for the SAML authentication connection.
644
+ * Connection name for the SAML authentication connection. Must match
645
+ * the `connection` query parameter specified in the sign on URL
646
+ * during SAML configuration in your identity provider.
616
647
  * @minLength 1
617
648
  * @maxLength 128
618
649
  */
@@ -1152,7 +1183,9 @@ export interface DevOrgAuthConnectionsCreateRequestOktaOptions {
1152
1183
  */
1153
1184
  export interface DevOrgAuthConnectionsCreateRequestSamlOptions {
1154
1185
  /**
1155
- * Connection name for the SAML authentication connection.
1186
+ * Connection name for the SAML authentication connection. Must match
1187
+ * the `connection` query parameter specified in the sign on URL
1188
+ * during SAML configuration in your identity provider.
1156
1189
  * @minLength 1
1157
1190
  * @maxLength 128
1158
1191
  */
@@ -1789,10 +1822,12 @@ export interface EventConversationCreated {
1789
1822
  export interface EventConversationDeleted {
1790
1823
  /** The ID of the conversation that was deleted. */
1791
1824
  id: string;
1825
+ old_conversation?: Conversation;
1792
1826
  }
1793
1827
  /** event-conversation-updated */
1794
1828
  export interface EventConversationUpdated {
1795
1829
  conversation: Conversation;
1830
+ old_conversation?: Conversation;
1796
1831
  }
1797
1832
  /** event-dev-user-created */
1798
1833
  export interface EventDevUserCreated {
@@ -1930,6 +1965,7 @@ export interface EventSlaTrackerDeleted {
1930
1965
  }
1931
1966
  /** event-sla-tracker-updated */
1932
1967
  export interface EventSlaTrackerUpdated {
1968
+ old_sla_tracker?: SlaTracker;
1933
1969
  sla_tracker: SlaTracker;
1934
1970
  }
1935
1971
  /** event-survey-created */
@@ -2948,6 +2984,8 @@ export type SchemaEnumFieldDescriptor = SchemaFieldDescriptorBase & {
2948
2984
  allowed_values: string[];
2949
2985
  /** Default value. */
2950
2986
  default_value?: string;
2987
+ /** Translations for allowed_values field. */
2988
+ translated_values?: Record<string, string>;
2951
2989
  };
2952
2990
  /** schema-enum-list-field-descriptor */
2953
2991
  export type SchemaEnumListFieldDescriptor = SchemaFieldDescriptorBase & {
@@ -2955,6 +2993,8 @@ export type SchemaEnumListFieldDescriptor = SchemaFieldDescriptorBase & {
2955
2993
  allowed_values: string[];
2956
2994
  /** Default value. */
2957
2995
  default_value?: string[];
2996
+ /** Translations for allowed_values field. */
2997
+ translated_values?: Record<string, string>;
2958
2998
  };
2959
2999
  /**
2960
3000
  * schema-field-descriptor
@@ -4057,6 +4097,8 @@ export declare enum SyncRunMode {
4057
4097
  SyncFromDevrev = "sync_from_devrev",
4058
4098
  SyncToDevrev = "sync_to_devrev"
4059
4099
  }
4100
+ /** sys-user */
4101
+ export type SysUser = UserBase;
4060
4102
  /** sys-user-summary */
4061
4103
  export type SysUserSummary = UserBaseSummary;
4062
4104
  /** tag */
@@ -5052,7 +5094,11 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestTi
5052
5094
  * @example "2023-01-01T12:00:00.000Z"
5053
5095
  */
5054
5096
  target_close_date?: string;
5055
- /** Title of the work object. */
5097
+ /**
5098
+ * Title of the work object.
5099
+ * @minLength 1
5100
+ * @maxLength 256
5101
+ */
5056
5102
  title: string;
5057
5103
  };
5058
5104
  /** works-create-request-issue */
@@ -5344,7 +5390,11 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
5344
5390
  * @example "2023-01-01T12:00:00.000Z"
5345
5391
  */
5346
5392
  target_close_date?: string | null;
5347
- /** Updated title of the work object, or unchanged if not provided. */
5393
+ /**
5394
+ * Updated title of the work object, or unchanged if not provided.
5395
+ * @minLength 1
5396
+ * @maxLength 256
5397
+ */
5348
5398
  title?: string;
5349
5399
  };
5350
5400
  /** works-update-request-artifacts */
@@ -5812,6 +5862,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5812
5862
  * @secure
5813
5863
  */
5814
5864
  artifactsPrepare: (data: ArtifactsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsPrepareResponse, any>>;
5865
+ /**
5866
+ * @description Gets the specified object.
5867
+ *
5868
+ * @tags atoms
5869
+ * @name AtomsGet
5870
+ * @summary Get Atom
5871
+ * @request GET:/atoms.get
5872
+ * @secure
5873
+ */
5874
+ atomsGet: (query: {
5875
+ /** The ID of the object to get. */
5876
+ id: string;
5877
+ }, params?: RequestParams) => Promise<AxiosResponse<AtomsGetResponse, any>>;
5878
+ /**
5879
+ * @description Gets the specified object.
5880
+ *
5881
+ * @tags atoms
5882
+ * @name AtomsGetPost
5883
+ * @summary Get Atom (POST)
5884
+ * @request POST:/atoms.get
5885
+ * @secure
5886
+ */
5887
+ atomsGetPost: (data: AtomsGetRequest, params?: RequestParams) => Promise<AxiosResponse<AtomsGetResponse, any>>;
5815
5888
  /**
5816
5889
  * @description Creates a JWT corresponding to the requested token type for the authenticated user.
5817
5890
  *
@@ -33,8 +33,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
33
33
  return (mod && mod.__esModule) ? mod : { "default": mod };
34
34
  };
35
35
  Object.defineProperty(exports, "__esModule", { value: true });
36
- exports.SyncRunMode = exports.SyncProgressState = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SlasFilterAppliesToOperatorType = exports.SlaType = exports.SlaTrackerAppliesToType = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SlaAppliesTo = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgEnvironment = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.ListMode = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.EventFetchedResult = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = void 0;
37
- exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.UserType = exports.UserState = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TicketChannels = void 0;
36
+ exports.SyncProgressState = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SlasFilterAppliesToOperatorType = exports.SlaType = exports.SlaTrackerAppliesToType = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SlaAppliesTo = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgEnvironment = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.ListMode = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.EventFetchedResult = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = exports.AtomType = void 0;
37
+ exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.UserType = exports.UserState = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TicketChannels = exports.SyncRunMode = void 0;
38
+ var AtomType;
39
+ (function (AtomType) {
40
+ AtomType["Capability"] = "capability";
41
+ AtomType["Conversation"] = "conversation";
42
+ AtomType["DevUser"] = "dev_user";
43
+ AtomType["Enhancement"] = "enhancement";
44
+ AtomType["Feature"] = "feature";
45
+ AtomType["Issue"] = "issue";
46
+ AtomType["Product"] = "product";
47
+ AtomType["RevOrg"] = "rev_org";
48
+ AtomType["RevUser"] = "rev_user";
49
+ AtomType["SysUser"] = "sys_user";
50
+ AtomType["Tag"] = "tag";
51
+ AtomType["Ticket"] = "ticket";
52
+ AtomType["TimelineComment"] = "timeline_comment";
53
+ AtomType["Webhook"] = "webhook";
54
+ })(AtomType = exports.AtomType || (exports.AtomType = {}));
38
55
  var AuthConnectionToggle;
39
56
  (function (AuthConnectionToggle) {
40
57
  AuthConnectionToggle["Disable"] = "disable";
@@ -898,6 +915,26 @@ class Api extends HttpClient {
898
915
  * @secure
899
916
  */
900
917
  this.artifactsPrepare = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.prepare`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
918
+ /**
919
+ * @description Gets the specified object.
920
+ *
921
+ * @tags atoms
922
+ * @name AtomsGet
923
+ * @summary Get Atom
924
+ * @request GET:/atoms.get
925
+ * @secure
926
+ */
927
+ this.atomsGet = (query, params = {}) => this.request(Object.assign({ path: `/atoms.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
928
+ /**
929
+ * @description Gets the specified object.
930
+ *
931
+ * @tags atoms
932
+ * @name AtomsGetPost
933
+ * @summary Get Atom (POST)
934
+ * @request POST:/atoms.get
935
+ * @secure
936
+ */
937
+ this.atomsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/atoms.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
901
938
  /**
902
939
  * @description Creates a JWT corresponding to the requested token type for the authenticated user.
903
940
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@devrev/typescript-sdk",
3
- "version": "1.1.42",
3
+ "version": "1.1.44",
4
4
  "description": "## SDK Generation",
5
5
  "main": "./dist/index.js",
6
6
  "scripts": {