@wix/automations 1.0.47 → 1.0.49

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.
@@ -34,12 +34,12 @@ interface Automation$3 {
34
34
  * Created date
35
35
  * @readonly
36
36
  */
37
- createdDate?: Date;
37
+ createdDate?: Date | null;
38
38
  /**
39
39
  * Updated date
40
40
  * @readonly
41
41
  */
42
- updatedDate?: Date;
42
+ updatedDate?: Date | null;
43
43
  /**
44
44
  * ESB Configuration ID
45
45
  * @readonly
@@ -510,8 +510,8 @@ interface ActivationReport$1 {
510
510
  activationId?: string;
511
511
  requestId?: string;
512
512
  status?: ActivationStatus$1;
513
- creationDate?: Date;
514
- updateDate?: Date;
513
+ creationDate?: Date | null;
514
+ updateDate?: Date | null;
515
515
  /** will be populated when status = FAILED */
516
516
  error?: string | null;
517
517
  }
@@ -593,7 +593,7 @@ interface Quota$3 {
593
593
  * Quota renewal date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
594
594
  * For example, 10 July 2020 at 15:00 is written as `2020-07-10 15:00:00.000`.
595
595
  */
596
- renewalDate?: Date;
596
+ renewalDate?: Date | null;
597
597
  /** The user's current quota usage. */
598
598
  currentUsage?: string;
599
599
  /** Quota limit data. */
@@ -834,12 +834,12 @@ interface Automation$2 {
834
834
  * Created date
835
835
  * @readonly
836
836
  */
837
- _createdDate?: Date;
837
+ _createdDate?: Date | null;
838
838
  /**
839
839
  * Updated date
840
840
  * @readonly
841
841
  */
842
- _updatedDate?: Date;
842
+ _updatedDate?: Date | null;
843
843
  /**
844
844
  * ESB Configuration ID
845
845
  * @readonly
@@ -1310,8 +1310,8 @@ interface ActivationReport {
1310
1310
  activationId?: string;
1311
1311
  requestId?: string;
1312
1312
  status?: ActivationStatus;
1313
- creationDate?: Date;
1314
- updateDate?: Date;
1313
+ creationDate?: Date | null;
1314
+ updateDate?: Date | null;
1315
1315
  /** will be populated when status = FAILED */
1316
1316
  error?: string | null;
1317
1317
  }
@@ -1393,7 +1393,7 @@ interface Quota$2 {
1393
1393
  * Quota renewal date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
1394
1394
  * For example, 10 July 2020 at 15:00 is written as `2020-07-10 15:00:00.000`.
1395
1395
  */
1396
- renewalDate?: Date;
1396
+ renewalDate?: Date | null;
1397
1397
  /** The user's current quota usage. */
1398
1398
  currentUsage?: string;
1399
1399
  /** Quota limit data. */
@@ -2105,7 +2105,7 @@ interface Automation$1 extends AutomationOriginInfoOneOf$1 {
2105
2105
  * Date and time the automation was created.
2106
2106
  * @readonly
2107
2107
  */
2108
- createdDate?: Date;
2108
+ createdDate?: Date | null;
2109
2109
  /**
2110
2110
  * The entity that last updated the automation.
2111
2111
  * @readonly
@@ -2115,7 +2115,7 @@ interface Automation$1 extends AutomationOriginInfoOneOf$1 {
2115
2115
  * Date and time the automation was last updated.
2116
2116
  * @readonly
2117
2117
  */
2118
- updatedDate?: Date;
2118
+ updatedDate?: Date | null;
2119
2119
  /** Automation name that is displayed on the user's site. */
2120
2120
  name?: string;
2121
2121
  /** Automation description. */
@@ -2488,6 +2488,141 @@ interface BulkActionMetadata$1 {
2488
2488
  /** Number of failures without details because detailed failure threshold was exceeded. */
2489
2489
  undetailedFailures?: number;
2490
2490
  }
2491
+ interface CreatePreinstalledAutomationRequest$1 {
2492
+ /** Preinstalled automation to be created. */
2493
+ automation: Automation$1;
2494
+ /** Optional - hide the created automation behind a spec */
2495
+ specInfo?: PreinstalledAutomationSpecInfo$1;
2496
+ /**
2497
+ * Optional - the information about the original site automation that was used to create this preinstalled automation
2498
+ * Usually an existing automation in a site is used to create the preinstalled automation, this is the relevant information.
2499
+ */
2500
+ originAutomationInfo?: OriginAutomationInfo$1;
2501
+ }
2502
+ interface PreinstalledAutomationSpecInfo$1 {
2503
+ /** Spec to conduct on for the automation */
2504
+ spec?: string;
2505
+ /**
2506
+ * Value the spec should return in order to affect the user with the operation
2507
+ * e.g. creation - show the users the automation, update - show the users the updated automation, deletion - not show the users the automation
2508
+ */
2509
+ variantValue?: string | null;
2510
+ /**
2511
+ * Version from which the experiment should decide whether to expose it to users when !conduct(spec).contains(variant_value)
2512
+ * For example, if 50 is set, version 49 and below (including 49) will not expose the preinstalled automation to the user.
2513
+ */
2514
+ experimentVersion?: number;
2515
+ }
2516
+ interface OriginAutomationInfo$1 {
2517
+ /** The original automation id */
2518
+ siteAutomationId?: string;
2519
+ /** The original automation meta site id */
2520
+ metaSiteId?: string;
2521
+ }
2522
+ interface CreatePreinstalledAutomationResponse$1 {
2523
+ /** The created preinstalled automation. */
2524
+ automation?: Automation$1;
2525
+ }
2526
+ interface UpdatePreinstalledAutomationRequest$1 {
2527
+ /** Preinstalled automation to update. */
2528
+ automation: Automation$1;
2529
+ /** Optional - hide the updated automation behind a spec */
2530
+ specInfo?: PreinstalledAutomationSpecInfo$1;
2531
+ }
2532
+ interface UpdatePreinstalledAutomationResponse$1 {
2533
+ /** Updated preinstalled automation. */
2534
+ automation?: Automation$1;
2535
+ }
2536
+ interface DeletePreinstalledAutomationRequest$1 {
2537
+ /** Preinstalled Component Id */
2538
+ componentId: string;
2539
+ /**
2540
+ * Optional - makes the deletion operation gradual
2541
+ * The automation will not return if the variant returns for the site
2542
+ */
2543
+ specInfo?: PreinstalledAutomationSpecInfo$1;
2544
+ }
2545
+ interface DeletePreinstalledAutomationResponse$1 {
2546
+ }
2547
+ interface QueryPreinstalledAutomationsForAppRequest$1 {
2548
+ /** WQL expression. */
2549
+ query?: CommonCursorQuery$1;
2550
+ }
2551
+ interface CommonCursorQuery$1 extends CommonCursorQueryPagingMethodOneOf$1 {
2552
+ /**
2553
+ * Cursor paging options.
2554
+ *
2555
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
2556
+ */
2557
+ cursorPaging?: CommonCursorPaging$1;
2558
+ /**
2559
+ * Filter object.
2560
+ *
2561
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
2562
+ */
2563
+ filter?: Record<string, any> | null;
2564
+ /**
2565
+ * Sort object.
2566
+ *
2567
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
2568
+ */
2569
+ sort?: CommonSorting$1[];
2570
+ }
2571
+ /** @oneof */
2572
+ interface CommonCursorQueryPagingMethodOneOf$1 {
2573
+ /**
2574
+ * Cursor paging options.
2575
+ *
2576
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
2577
+ */
2578
+ cursorPaging?: CommonCursorPaging$1;
2579
+ }
2580
+ interface CommonSorting$1 {
2581
+ /** Name of the field to sort by. */
2582
+ fieldName?: string;
2583
+ /** Sort order. */
2584
+ order?: CommonSortOrder$1;
2585
+ }
2586
+ declare enum CommonSortOrder$1 {
2587
+ ASC = "ASC",
2588
+ DESC = "DESC"
2589
+ }
2590
+ interface CommonCursorPaging$1 {
2591
+ /** Maximum number of items to return in the results. */
2592
+ limit?: number | null;
2593
+ /**
2594
+ * Pointer to the next or previous page in the list of results.
2595
+ *
2596
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
2597
+ * Not relevant for the first request.
2598
+ */
2599
+ cursor?: string | null;
2600
+ }
2601
+ interface QueryPreinstalledAutomationsForAppResponse$1 {
2602
+ /** List of automations. */
2603
+ automations?: Automation$1[];
2604
+ /** Paging metadata. */
2605
+ pagingMetadata?: CommonCursorPagingMetadata$1;
2606
+ }
2607
+ interface CommonCursorPagingMetadata$1 {
2608
+ /** Number of items returned in current page. */
2609
+ count?: number | null;
2610
+ /** Cursor strings that point to the next page, previous page, or both. */
2611
+ cursors?: CommonCursors$1;
2612
+ /**
2613
+ * Whether there are more pages to retrieve following the current page.
2614
+ *
2615
+ * + `true`: Another page of results can be retrieved.
2616
+ * + `false`: This is the last page.
2617
+ */
2618
+ hasNext?: boolean | null;
2619
+ }
2620
+ interface CommonCursors$1 {
2621
+ /** Cursor string pointing to the next page in the list of results. */
2622
+ next?: string | null;
2623
+ /** Cursor pointing to the previous page in the list of results. */
2624
+ prev?: string | null;
2625
+ }
2491
2626
  interface QueryAutomationsRequest$1 {
2492
2627
  /** WQL expression. */
2493
2628
  query?: CursorQuery$1;
@@ -2571,6 +2706,64 @@ interface CopyAutomationResponse$1 {
2571
2706
  /** Automation copy. */
2572
2707
  automation?: Automation$1;
2573
2708
  }
2709
+ interface CreateDraftAutomationRequest$1 {
2710
+ /** Draft automation to be created. */
2711
+ automation?: Automation$1;
2712
+ }
2713
+ interface CreateDraftAutomationResponse$1 {
2714
+ /** The created draft automation. */
2715
+ automation?: Automation$1;
2716
+ }
2717
+ interface GetOrCreateDraftAutomationRequest$1 {
2718
+ /** Original automation id */
2719
+ originalAutomationId: string;
2720
+ }
2721
+ interface GetOrCreateDraftAutomationResponse$1 {
2722
+ /** Draft automation. */
2723
+ automation?: Automation$1;
2724
+ }
2725
+ interface UpdateDraftAutomationRequest$1 {
2726
+ /** Automation to be updated, may be partial. */
2727
+ automation: Automation$1;
2728
+ }
2729
+ interface UpdateDraftAutomationResponse$1 {
2730
+ /** Updated draft automation. */
2731
+ automation?: Automation$1;
2732
+ }
2733
+ interface QueryAutomationsWithDraftsRequest$1 {
2734
+ /** WQL expression. */
2735
+ query?: CursorQuery$1;
2736
+ }
2737
+ interface QueryAutomationsWithDraftsResponse$1 {
2738
+ /** List of automations. */
2739
+ automations?: Automation$1[];
2740
+ /** Paging metadata */
2741
+ pagingMetadata?: CursorPagingMetadata$1;
2742
+ /**
2743
+ * map of existing automationIds and their relevant drafts' automationIds
2744
+ * if include_draft_data: false was passed, the map will be empty
2745
+ * The key is the automationId of the original automation, and the value a list of related draft automationIds
2746
+ */
2747
+ originalAutomationIdToDrafts?: Record<string, DraftsInfo$1>;
2748
+ }
2749
+ interface DraftsInfo$1 {
2750
+ /** list of drafts of an existing Automation */
2751
+ draftAutomationIds?: string[];
2752
+ }
2753
+ interface DeleteDraftAutomationRequest$1 {
2754
+ /** Id of the draft automation to delete. */
2755
+ automationId: string;
2756
+ }
2757
+ interface DeleteDraftAutomationResponse$1 {
2758
+ }
2759
+ interface PublishDraftAutomationRequest$1 {
2760
+ /** Id of the draft automation to publish. */
2761
+ automationId: string;
2762
+ }
2763
+ interface PublishDraftAutomationResponse$1 {
2764
+ /** Updated automation after publishing the draft */
2765
+ automation?: Automation$1;
2766
+ }
2574
2767
  interface ValidateAutomationRequest$1 {
2575
2768
  /** Automation to validate. */
2576
2769
  automation: Automation$1;
@@ -2737,6 +2930,16 @@ interface AutomationConfigurationError$1 {
2737
2930
  declare enum AutomationErrorType$1 {
2738
2931
  UNKNOWN_AUTOMATION_ERROR_TYPE = "UNKNOWN_AUTOMATION_ERROR_TYPE"
2739
2932
  }
2933
+ interface GetAutomationActionSchemaRequest$1 {
2934
+ /** Automation ID */
2935
+ automationId: string;
2936
+ /** Action ID */
2937
+ actionId: string;
2938
+ }
2939
+ interface GetAutomationActionSchemaResponse$1 {
2940
+ /** The accumulated payload schema for an action. */
2941
+ schema?: Record<string, any> | null;
2942
+ }
2740
2943
  interface GetActionsQuotaInfoRequest$1 {
2741
2944
  }
2742
2945
  interface GetActionsQuotaInfoResponse$1 {
@@ -2795,7 +2998,7 @@ interface Quota$1 {
2795
2998
  * Quota renewal date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
2796
2999
  * For example, 10 July 2020 at 15:00 is written as `2020-07-10 15:00:00.000`.
2797
3000
  */
2798
- renewalDate?: Date;
3001
+ renewalDate?: Date | null;
2799
3002
  /** The user's current quota usage. */
2800
3003
  currentUsage?: string;
2801
3004
  /** Quota limit data. */
@@ -2911,12 +3114,36 @@ interface BulkDeleteAutomationsResponseNonNullableFields$1 {
2911
3114
  results: BulkDeleteResultNonNullableFields$1[];
2912
3115
  bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
2913
3116
  }
3117
+ interface CreatePreinstalledAutomationResponseNonNullableFields$1 {
3118
+ automation?: AutomationNonNullableFields$1;
3119
+ }
3120
+ interface UpdatePreinstalledAutomationResponseNonNullableFields$1 {
3121
+ automation?: AutomationNonNullableFields$1;
3122
+ }
3123
+ interface QueryPreinstalledAutomationsForAppResponseNonNullableFields$1 {
3124
+ automations: AutomationNonNullableFields$1[];
3125
+ }
2914
3126
  interface QueryAutomationsResponseNonNullableFields$1 {
2915
3127
  automations: AutomationNonNullableFields$1[];
2916
3128
  }
2917
3129
  interface CopyAutomationResponseNonNullableFields$1 {
2918
3130
  automation?: AutomationNonNullableFields$1;
2919
3131
  }
3132
+ interface CreateDraftAutomationResponseNonNullableFields$1 {
3133
+ automation?: AutomationNonNullableFields$1;
3134
+ }
3135
+ interface GetOrCreateDraftAutomationResponseNonNullableFields$1 {
3136
+ automation?: AutomationNonNullableFields$1;
3137
+ }
3138
+ interface UpdateDraftAutomationResponseNonNullableFields$1 {
3139
+ automation?: AutomationNonNullableFields$1;
3140
+ }
3141
+ interface QueryAutomationsWithDraftsResponseNonNullableFields$1 {
3142
+ automations: AutomationNonNullableFields$1[];
3143
+ }
3144
+ interface PublishDraftAutomationResponseNonNullableFields$1 {
3145
+ automation?: AutomationNonNullableFields$1;
3146
+ }
2920
3147
  interface TriggerConfigurationErrorNonNullableFields$1 {
2921
3148
  errorType: TriggerErrorType$1;
2922
3149
  }
@@ -3026,7 +3253,7 @@ interface Automation extends AutomationOriginInfoOneOf {
3026
3253
  * Date and time the automation was created.
3027
3254
  * @readonly
3028
3255
  */
3029
- _createdDate?: Date;
3256
+ _createdDate?: Date | null;
3030
3257
  /**
3031
3258
  * The entity that last updated the automation.
3032
3259
  * @readonly
@@ -3036,7 +3263,7 @@ interface Automation extends AutomationOriginInfoOneOf {
3036
3263
  * Date and time the automation was last updated.
3037
3264
  * @readonly
3038
3265
  */
3039
- _updatedDate?: Date;
3266
+ _updatedDate?: Date | null;
3040
3267
  /** Automation name that is displayed on the user's site. */
3041
3268
  name?: string;
3042
3269
  /** Automation description. */
@@ -3409,6 +3636,141 @@ interface BulkActionMetadata {
3409
3636
  /** Number of failures without details because detailed failure threshold was exceeded. */
3410
3637
  undetailedFailures?: number;
3411
3638
  }
3639
+ interface CreatePreinstalledAutomationRequest {
3640
+ /** Preinstalled automation to be created. */
3641
+ automation: Automation;
3642
+ /** Optional - hide the created automation behind a spec */
3643
+ specInfo?: PreinstalledAutomationSpecInfo;
3644
+ /**
3645
+ * Optional - the information about the original site automation that was used to create this preinstalled automation
3646
+ * Usually an existing automation in a site is used to create the preinstalled automation, this is the relevant information.
3647
+ */
3648
+ originAutomationInfo?: OriginAutomationInfo;
3649
+ }
3650
+ interface PreinstalledAutomationSpecInfo {
3651
+ /** Spec to conduct on for the automation */
3652
+ spec?: string;
3653
+ /**
3654
+ * Value the spec should return in order to affect the user with the operation
3655
+ * e.g. creation - show the users the automation, update - show the users the updated automation, deletion - not show the users the automation
3656
+ */
3657
+ variantValue?: string | null;
3658
+ /**
3659
+ * Version from which the experiment should decide whether to expose it to users when !conduct(spec).contains(variant_value)
3660
+ * For example, if 50 is set, version 49 and below (including 49) will not expose the preinstalled automation to the user.
3661
+ */
3662
+ experimentVersion?: number;
3663
+ }
3664
+ interface OriginAutomationInfo {
3665
+ /** The original automation id */
3666
+ siteAutomationId?: string;
3667
+ /** The original automation meta site id */
3668
+ metaSiteId?: string;
3669
+ }
3670
+ interface CreatePreinstalledAutomationResponse {
3671
+ /** The created preinstalled automation. */
3672
+ automation?: Automation;
3673
+ }
3674
+ interface UpdatePreinstalledAutomationRequest {
3675
+ /** Preinstalled automation to update. */
3676
+ automation: Automation;
3677
+ /** Optional - hide the updated automation behind a spec */
3678
+ specInfo?: PreinstalledAutomationSpecInfo;
3679
+ }
3680
+ interface UpdatePreinstalledAutomationResponse {
3681
+ /** Updated preinstalled automation. */
3682
+ automation?: Automation;
3683
+ }
3684
+ interface DeletePreinstalledAutomationRequest {
3685
+ /** Preinstalled Component Id */
3686
+ componentId: string;
3687
+ /**
3688
+ * Optional - makes the deletion operation gradual
3689
+ * The automation will not return if the variant returns for the site
3690
+ */
3691
+ specInfo?: PreinstalledAutomationSpecInfo;
3692
+ }
3693
+ interface DeletePreinstalledAutomationResponse {
3694
+ }
3695
+ interface QueryPreinstalledAutomationsForAppRequest {
3696
+ /** WQL expression. */
3697
+ query?: CommonCursorQuery;
3698
+ }
3699
+ interface CommonCursorQuery extends CommonCursorQueryPagingMethodOneOf {
3700
+ /**
3701
+ * Cursor paging options.
3702
+ *
3703
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
3704
+ */
3705
+ cursorPaging?: CommonCursorPaging;
3706
+ /**
3707
+ * Filter object.
3708
+ *
3709
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
3710
+ */
3711
+ filter?: Record<string, any> | null;
3712
+ /**
3713
+ * Sort object.
3714
+ *
3715
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
3716
+ */
3717
+ sort?: CommonSorting[];
3718
+ }
3719
+ /** @oneof */
3720
+ interface CommonCursorQueryPagingMethodOneOf {
3721
+ /**
3722
+ * Cursor paging options.
3723
+ *
3724
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
3725
+ */
3726
+ cursorPaging?: CommonCursorPaging;
3727
+ }
3728
+ interface CommonSorting {
3729
+ /** Name of the field to sort by. */
3730
+ fieldName?: string;
3731
+ /** Sort order. */
3732
+ order?: CommonSortOrder;
3733
+ }
3734
+ declare enum CommonSortOrder {
3735
+ ASC = "ASC",
3736
+ DESC = "DESC"
3737
+ }
3738
+ interface CommonCursorPaging {
3739
+ /** Maximum number of items to return in the results. */
3740
+ limit?: number | null;
3741
+ /**
3742
+ * Pointer to the next or previous page in the list of results.
3743
+ *
3744
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
3745
+ * Not relevant for the first request.
3746
+ */
3747
+ cursor?: string | null;
3748
+ }
3749
+ interface QueryPreinstalledAutomationsForAppResponse {
3750
+ /** List of automations. */
3751
+ automations?: Automation[];
3752
+ /** Paging metadata. */
3753
+ pagingMetadata?: CommonCursorPagingMetadata;
3754
+ }
3755
+ interface CommonCursorPagingMetadata {
3756
+ /** Number of items returned in current page. */
3757
+ count?: number | null;
3758
+ /** Cursor strings that point to the next page, previous page, or both. */
3759
+ cursors?: CommonCursors;
3760
+ /**
3761
+ * Whether there are more pages to retrieve following the current page.
3762
+ *
3763
+ * + `true`: Another page of results can be retrieved.
3764
+ * + `false`: This is the last page.
3765
+ */
3766
+ hasNext?: boolean | null;
3767
+ }
3768
+ interface CommonCursors {
3769
+ /** Cursor string pointing to the next page in the list of results. */
3770
+ next?: string | null;
3771
+ /** Cursor pointing to the previous page in the list of results. */
3772
+ prev?: string | null;
3773
+ }
3412
3774
  interface QueryAutomationsRequest {
3413
3775
  /** WQL expression. */
3414
3776
  query?: CursorQuery;
@@ -3492,6 +3854,64 @@ interface CopyAutomationResponse {
3492
3854
  /** Automation copy. */
3493
3855
  automation?: Automation;
3494
3856
  }
3857
+ interface CreateDraftAutomationRequest {
3858
+ /** Draft automation to be created. */
3859
+ automation?: Automation;
3860
+ }
3861
+ interface CreateDraftAutomationResponse {
3862
+ /** The created draft automation. */
3863
+ automation?: Automation;
3864
+ }
3865
+ interface GetOrCreateDraftAutomationRequest {
3866
+ /** Original automation id */
3867
+ originalAutomationId: string;
3868
+ }
3869
+ interface GetOrCreateDraftAutomationResponse {
3870
+ /** Draft automation. */
3871
+ automation?: Automation;
3872
+ }
3873
+ interface UpdateDraftAutomationRequest {
3874
+ /** Automation to be updated, may be partial. */
3875
+ automation: Automation;
3876
+ }
3877
+ interface UpdateDraftAutomationResponse {
3878
+ /** Updated draft automation. */
3879
+ automation?: Automation;
3880
+ }
3881
+ interface QueryAutomationsWithDraftsRequest {
3882
+ /** WQL expression. */
3883
+ query?: CursorQuery;
3884
+ }
3885
+ interface QueryAutomationsWithDraftsResponse {
3886
+ /** List of automations. */
3887
+ automations?: Automation[];
3888
+ /** Paging metadata */
3889
+ pagingMetadata?: CursorPagingMetadata;
3890
+ /**
3891
+ * map of existing automationIds and their relevant drafts' automationIds
3892
+ * if include_draft_data: false was passed, the map will be empty
3893
+ * The key is the automationId of the original automation, and the value a list of related draft automationIds
3894
+ */
3895
+ originalAutomationIdToDrafts?: Record<string, DraftsInfo>;
3896
+ }
3897
+ interface DraftsInfo {
3898
+ /** list of drafts of an existing Automation */
3899
+ draftAutomationIds?: string[];
3900
+ }
3901
+ interface DeleteDraftAutomationRequest {
3902
+ /** Id of the draft automation to delete. */
3903
+ automationId: string;
3904
+ }
3905
+ interface DeleteDraftAutomationResponse {
3906
+ }
3907
+ interface PublishDraftAutomationRequest {
3908
+ /** Id of the draft automation to publish. */
3909
+ automationId: string;
3910
+ }
3911
+ interface PublishDraftAutomationResponse {
3912
+ /** Updated automation after publishing the draft */
3913
+ automation?: Automation;
3914
+ }
3495
3915
  interface ValidateAutomationRequest {
3496
3916
  /** Automation to validate. */
3497
3917
  automation: Automation;
@@ -3658,6 +4078,16 @@ interface AutomationConfigurationError {
3658
4078
  declare enum AutomationErrorType {
3659
4079
  UNKNOWN_AUTOMATION_ERROR_TYPE = "UNKNOWN_AUTOMATION_ERROR_TYPE"
3660
4080
  }
4081
+ interface GetAutomationActionSchemaRequest {
4082
+ /** Automation ID */
4083
+ automationId: string;
4084
+ /** Action ID */
4085
+ actionId: string;
4086
+ }
4087
+ interface GetAutomationActionSchemaResponse {
4088
+ /** The accumulated payload schema for an action. */
4089
+ schema?: Record<string, any> | null;
4090
+ }
3661
4091
  interface GetActionsQuotaInfoRequest {
3662
4092
  }
3663
4093
  interface GetActionsQuotaInfoResponse {
@@ -3716,7 +4146,7 @@ interface Quota {
3716
4146
  * Quota renewal date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
3717
4147
  * For example, 10 July 2020 at 15:00 is written as `2020-07-10 15:00:00.000`.
3718
4148
  */
3719
- renewalDate?: Date;
4149
+ renewalDate?: Date | null;
3720
4150
  /** The user's current quota usage. */
3721
4151
  currentUsage?: string;
3722
4152
  /** Quota limit data. */
@@ -3832,12 +4262,36 @@ interface BulkDeleteAutomationsResponseNonNullableFields {
3832
4262
  results: BulkDeleteResultNonNullableFields[];
3833
4263
  bulkActionMetadata?: BulkActionMetadataNonNullableFields;
3834
4264
  }
4265
+ interface CreatePreinstalledAutomationResponseNonNullableFields {
4266
+ automation?: AutomationNonNullableFields;
4267
+ }
4268
+ interface UpdatePreinstalledAutomationResponseNonNullableFields {
4269
+ automation?: AutomationNonNullableFields;
4270
+ }
4271
+ interface QueryPreinstalledAutomationsForAppResponseNonNullableFields {
4272
+ automations: AutomationNonNullableFields[];
4273
+ }
3835
4274
  interface QueryAutomationsResponseNonNullableFields {
3836
4275
  automations: AutomationNonNullableFields[];
3837
4276
  }
3838
4277
  interface CopyAutomationResponseNonNullableFields {
3839
4278
  automation?: AutomationNonNullableFields;
3840
4279
  }
4280
+ interface CreateDraftAutomationResponseNonNullableFields {
4281
+ automation?: AutomationNonNullableFields;
4282
+ }
4283
+ interface GetOrCreateDraftAutomationResponseNonNullableFields {
4284
+ automation?: AutomationNonNullableFields;
4285
+ }
4286
+ interface UpdateDraftAutomationResponseNonNullableFields {
4287
+ automation?: AutomationNonNullableFields;
4288
+ }
4289
+ interface QueryAutomationsWithDraftsResponseNonNullableFields {
4290
+ automations: AutomationNonNullableFields[];
4291
+ }
4292
+ interface PublishDraftAutomationResponseNonNullableFields {
4293
+ automation?: AutomationNonNullableFields;
4294
+ }
3841
4295
  interface TriggerConfigurationErrorNonNullableFields {
3842
4296
  errorType: TriggerErrorType;
3843
4297
  }
@@ -3940,25 +4394,60 @@ declare function deleteAutomation(): __PublicMethodMetaInfo<'DELETE', {
3940
4394
  automationId: string;
3941
4395
  }, DeleteAutomationRequest, DeleteAutomationRequest$1, DeleteAutomationResponse, DeleteAutomationResponse$1>;
3942
4396
  declare function bulkDeleteAutomations(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteAutomationsRequest, BulkDeleteAutomationsRequest$1, BulkDeleteAutomationsResponse & BulkDeleteAutomationsResponseNonNullableFields, BulkDeleteAutomationsResponse$1 & BulkDeleteAutomationsResponseNonNullableFields$1>;
4397
+ declare function createPreinstalledAutomation(): __PublicMethodMetaInfo<'POST', {}, CreatePreinstalledAutomationRequest, CreatePreinstalledAutomationRequest$1, CreatePreinstalledAutomationResponse & CreatePreinstalledAutomationResponseNonNullableFields, CreatePreinstalledAutomationResponse$1 & CreatePreinstalledAutomationResponseNonNullableFields$1>;
4398
+ declare function updatePreinstalledAutomation(): __PublicMethodMetaInfo<'PATCH', {}, UpdatePreinstalledAutomationRequest, UpdatePreinstalledAutomationRequest$1, UpdatePreinstalledAutomationResponse & UpdatePreinstalledAutomationResponseNonNullableFields, UpdatePreinstalledAutomationResponse$1 & UpdatePreinstalledAutomationResponseNonNullableFields$1>;
4399
+ declare function deletePreinstalledAutomation(): __PublicMethodMetaInfo<'DELETE', {
4400
+ componentId: string;
4401
+ }, DeletePreinstalledAutomationRequest, DeletePreinstalledAutomationRequest$1, DeletePreinstalledAutomationResponse, DeletePreinstalledAutomationResponse$1>;
4402
+ declare function queryPreinstalledAutomationsForApp(): __PublicMethodMetaInfo<'POST', {}, QueryPreinstalledAutomationsForAppRequest, QueryPreinstalledAutomationsForAppRequest$1, QueryPreinstalledAutomationsForAppResponse & QueryPreinstalledAutomationsForAppResponseNonNullableFields, QueryPreinstalledAutomationsForAppResponse$1 & QueryPreinstalledAutomationsForAppResponseNonNullableFields$1>;
3943
4403
  declare function queryAutomations(): __PublicMethodMetaInfo<'POST', {}, QueryAutomationsRequest, QueryAutomationsRequest$1, QueryAutomationsResponse & QueryAutomationsResponseNonNullableFields, QueryAutomationsResponse$1 & QueryAutomationsResponseNonNullableFields$1>;
3944
4404
  declare function copyAutomation(): __PublicMethodMetaInfo<'POST', {
3945
4405
  automationId: string;
3946
4406
  }, CopyAutomationRequest, CopyAutomationRequest$1, CopyAutomationResponse & CopyAutomationResponseNonNullableFields, CopyAutomationResponse$1 & CopyAutomationResponseNonNullableFields$1>;
4407
+ declare function createDraftAutomation(): __PublicMethodMetaInfo<'POST', {}, CreateDraftAutomationRequest, CreateDraftAutomationRequest$1, CreateDraftAutomationResponse & CreateDraftAutomationResponseNonNullableFields, CreateDraftAutomationResponse$1 & CreateDraftAutomationResponseNonNullableFields$1>;
4408
+ declare function getOrCreateDraftAutomation(): __PublicMethodMetaInfo<'POST', {
4409
+ originalAutomationId: string;
4410
+ }, GetOrCreateDraftAutomationRequest, GetOrCreateDraftAutomationRequest$1, GetOrCreateDraftAutomationResponse & GetOrCreateDraftAutomationResponseNonNullableFields, GetOrCreateDraftAutomationResponse$1 & GetOrCreateDraftAutomationResponseNonNullableFields$1>;
4411
+ declare function updateDraftAutomation(): __PublicMethodMetaInfo<'PATCH', {
4412
+ automationId: string;
4413
+ }, UpdateDraftAutomationRequest, UpdateDraftAutomationRequest$1, UpdateDraftAutomationResponse & UpdateDraftAutomationResponseNonNullableFields, UpdateDraftAutomationResponse$1 & UpdateDraftAutomationResponseNonNullableFields$1>;
4414
+ declare function queryAutomationsWithDrafts(): __PublicMethodMetaInfo<'POST', {}, QueryAutomationsWithDraftsRequest, QueryAutomationsWithDraftsRequest$1, QueryAutomationsWithDraftsResponse & QueryAutomationsWithDraftsResponseNonNullableFields, QueryAutomationsWithDraftsResponse$1 & QueryAutomationsWithDraftsResponseNonNullableFields$1>;
4415
+ declare function deleteDraftAutomation(): __PublicMethodMetaInfo<'DELETE', {
4416
+ automationId: string;
4417
+ }, DeleteDraftAutomationRequest, DeleteDraftAutomationRequest$1, DeleteDraftAutomationResponse, DeleteDraftAutomationResponse$1>;
4418
+ declare function publishDraftAutomation(): __PublicMethodMetaInfo<'POST', {
4419
+ automationId: string;
4420
+ }, PublishDraftAutomationRequest, PublishDraftAutomationRequest$1, PublishDraftAutomationResponse & PublishDraftAutomationResponseNonNullableFields, PublishDraftAutomationResponse$1 & PublishDraftAutomationResponseNonNullableFields$1>;
3947
4421
  declare function validateAutomation(): __PublicMethodMetaInfo<'POST', {}, ValidateAutomationRequest, ValidateAutomationRequest$1, ValidateAutomationResponse & ValidateAutomationResponseNonNullableFields, ValidateAutomationResponse$1 & ValidateAutomationResponseNonNullableFields$1>;
4422
+ declare function getAutomationActionSchema(): __PublicMethodMetaInfo<'GET', {
4423
+ automationId: string;
4424
+ actionId: string;
4425
+ }, GetAutomationActionSchemaRequest, GetAutomationActionSchemaRequest$1, GetAutomationActionSchemaResponse, GetAutomationActionSchemaResponse$1>;
3948
4426
  declare function getActionsQuotaInfo(): __PublicMethodMetaInfo<'GET', {}, GetActionsQuotaInfoRequest, GetActionsQuotaInfoRequest$1, GetActionsQuotaInfoResponse & GetActionsQuotaInfoResponseNonNullableFields, GetActionsQuotaInfoResponse$1 & GetActionsQuotaInfoResponseNonNullableFields$1>;
3949
4427
 
3950
4428
  type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
3951
4429
  declare const meta_bulkDeleteAutomations: typeof bulkDeleteAutomations;
3952
4430
  declare const meta_copyAutomation: typeof copyAutomation;
3953
4431
  declare const meta_createAutomation: typeof createAutomation;
4432
+ declare const meta_createDraftAutomation: typeof createDraftAutomation;
4433
+ declare const meta_createPreinstalledAutomation: typeof createPreinstalledAutomation;
3954
4434
  declare const meta_deleteAutomation: typeof deleteAutomation;
4435
+ declare const meta_deleteDraftAutomation: typeof deleteDraftAutomation;
4436
+ declare const meta_deletePreinstalledAutomation: typeof deletePreinstalledAutomation;
3955
4437
  declare const meta_getActionsQuotaInfo: typeof getActionsQuotaInfo;
3956
4438
  declare const meta_getAutomation: typeof getAutomation;
4439
+ declare const meta_getAutomationActionSchema: typeof getAutomationActionSchema;
4440
+ declare const meta_getOrCreateDraftAutomation: typeof getOrCreateDraftAutomation;
4441
+ declare const meta_publishDraftAutomation: typeof publishDraftAutomation;
3957
4442
  declare const meta_queryAutomations: typeof queryAutomations;
4443
+ declare const meta_queryAutomationsWithDrafts: typeof queryAutomationsWithDrafts;
4444
+ declare const meta_queryPreinstalledAutomationsForApp: typeof queryPreinstalledAutomationsForApp;
3958
4445
  declare const meta_updateAutomation: typeof updateAutomation;
4446
+ declare const meta_updateDraftAutomation: typeof updateDraftAutomation;
4447
+ declare const meta_updatePreinstalledAutomation: typeof updatePreinstalledAutomation;
3959
4448
  declare const meta_validateAutomation: typeof validateAutomation;
3960
4449
  declare namespace meta {
3961
- export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_bulkDeleteAutomations as bulkDeleteAutomations, meta_copyAutomation as copyAutomation, meta_createAutomation as createAutomation, meta_deleteAutomation as deleteAutomation, meta_getActionsQuotaInfo as getActionsQuotaInfo, meta_getAutomation as getAutomation, meta_queryAutomations as queryAutomations, meta_updateAutomation as updateAutomation, meta_validateAutomation as validateAutomation };
4450
+ export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_bulkDeleteAutomations as bulkDeleteAutomations, meta_copyAutomation as copyAutomation, meta_createAutomation as createAutomation, meta_createDraftAutomation as createDraftAutomation, meta_createPreinstalledAutomation as createPreinstalledAutomation, meta_deleteAutomation as deleteAutomation, meta_deleteDraftAutomation as deleteDraftAutomation, meta_deletePreinstalledAutomation as deletePreinstalledAutomation, meta_getActionsQuotaInfo as getActionsQuotaInfo, meta_getAutomation as getAutomation, meta_getAutomationActionSchema as getAutomationActionSchema, meta_getOrCreateDraftAutomation as getOrCreateDraftAutomation, meta_publishDraftAutomation as publishDraftAutomation, meta_queryAutomations as queryAutomations, meta_queryAutomationsWithDrafts as queryAutomationsWithDrafts, meta_queryPreinstalledAutomationsForApp as queryPreinstalledAutomationsForApp, meta_updateAutomation as updateAutomation, meta_updateDraftAutomation as updateDraftAutomation, meta_updatePreinstalledAutomation as updatePreinstalledAutomation, meta_validateAutomation as validateAutomation };
3962
4451
  }
3963
4452
 
3964
4453
  export { meta$1 as activations, meta$2 as automationsService, meta as automationsServiceV2 };