@wix/automations 1.0.48 → 1.0.50

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. */
@@ -2571,6 +2571,64 @@ interface CopyAutomationResponse$1 {
2571
2571
  /** Automation copy. */
2572
2572
  automation?: Automation$1;
2573
2573
  }
2574
+ interface CreateDraftAutomationRequest$1 {
2575
+ /** Draft automation to be created. */
2576
+ automation?: Automation$1;
2577
+ }
2578
+ interface CreateDraftAutomationResponse$1 {
2579
+ /** The created draft automation. */
2580
+ automation?: Automation$1;
2581
+ }
2582
+ interface GetOrCreateDraftAutomationRequest$1 {
2583
+ /** Original automation id */
2584
+ originalAutomationId: string;
2585
+ }
2586
+ interface GetOrCreateDraftAutomationResponse$1 {
2587
+ /** Draft automation. */
2588
+ automation?: Automation$1;
2589
+ }
2590
+ interface UpdateDraftAutomationRequest$1 {
2591
+ /** Automation to be updated, may be partial. */
2592
+ automation: Automation$1;
2593
+ }
2594
+ interface UpdateDraftAutomationResponse$1 {
2595
+ /** Updated draft automation. */
2596
+ automation?: Automation$1;
2597
+ }
2598
+ interface QueryAutomationsWithDraftsRequest$1 {
2599
+ /** WQL expression. */
2600
+ query?: CursorQuery$1;
2601
+ }
2602
+ interface QueryAutomationsWithDraftsResponse$1 {
2603
+ /** List of automations. */
2604
+ automations?: Automation$1[];
2605
+ /** Paging metadata */
2606
+ pagingMetadata?: CursorPagingMetadata$1;
2607
+ /**
2608
+ * map of existing automationIds and their relevant drafts' automationIds
2609
+ * if include_draft_data: false was passed, the map will be empty
2610
+ * The key is the automationId of the original automation, and the value a list of related draft automationIds
2611
+ */
2612
+ originalAutomationIdToDrafts?: Record<string, DraftsInfo$1>;
2613
+ }
2614
+ interface DraftsInfo$1 {
2615
+ /** list of drafts of an existing Automation */
2616
+ draftAutomationIds?: string[];
2617
+ }
2618
+ interface DeleteDraftAutomationRequest$1 {
2619
+ /** Id of the draft automation to delete. */
2620
+ automationId: string;
2621
+ }
2622
+ interface DeleteDraftAutomationResponse$1 {
2623
+ }
2624
+ interface PublishDraftAutomationRequest$1 {
2625
+ /** Id of the draft automation to publish. */
2626
+ automationId: string;
2627
+ }
2628
+ interface PublishDraftAutomationResponse$1 {
2629
+ /** Updated automation after publishing the draft */
2630
+ automation?: Automation$1;
2631
+ }
2574
2632
  interface ValidateAutomationRequest$1 {
2575
2633
  /** Automation to validate. */
2576
2634
  automation: Automation$1;
@@ -2737,6 +2795,16 @@ interface AutomationConfigurationError$1 {
2737
2795
  declare enum AutomationErrorType$1 {
2738
2796
  UNKNOWN_AUTOMATION_ERROR_TYPE = "UNKNOWN_AUTOMATION_ERROR_TYPE"
2739
2797
  }
2798
+ interface GetAutomationActionSchemaRequest$1 {
2799
+ /** Automation ID */
2800
+ automationId: string;
2801
+ /** Action ID */
2802
+ actionId: string;
2803
+ }
2804
+ interface GetAutomationActionSchemaResponse$1 {
2805
+ /** The accumulated payload schema for an action. */
2806
+ schema?: Record<string, any> | null;
2807
+ }
2740
2808
  interface GetActionsQuotaInfoRequest$1 {
2741
2809
  }
2742
2810
  interface GetActionsQuotaInfoResponse$1 {
@@ -2795,7 +2863,7 @@ interface Quota$1 {
2795
2863
  * Quota renewal date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
2796
2864
  * For example, 10 July 2020 at 15:00 is written as `2020-07-10 15:00:00.000`.
2797
2865
  */
2798
- renewalDate?: Date;
2866
+ renewalDate?: Date | null;
2799
2867
  /** The user's current quota usage. */
2800
2868
  currentUsage?: string;
2801
2869
  /** Quota limit data. */
@@ -2917,6 +2985,21 @@ interface QueryAutomationsResponseNonNullableFields$1 {
2917
2985
  interface CopyAutomationResponseNonNullableFields$1 {
2918
2986
  automation?: AutomationNonNullableFields$1;
2919
2987
  }
2988
+ interface CreateDraftAutomationResponseNonNullableFields$1 {
2989
+ automation?: AutomationNonNullableFields$1;
2990
+ }
2991
+ interface GetOrCreateDraftAutomationResponseNonNullableFields$1 {
2992
+ automation?: AutomationNonNullableFields$1;
2993
+ }
2994
+ interface UpdateDraftAutomationResponseNonNullableFields$1 {
2995
+ automation?: AutomationNonNullableFields$1;
2996
+ }
2997
+ interface QueryAutomationsWithDraftsResponseNonNullableFields$1 {
2998
+ automations: AutomationNonNullableFields$1[];
2999
+ }
3000
+ interface PublishDraftAutomationResponseNonNullableFields$1 {
3001
+ automation?: AutomationNonNullableFields$1;
3002
+ }
2920
3003
  interface TriggerConfigurationErrorNonNullableFields$1 {
2921
3004
  errorType: TriggerErrorType$1;
2922
3005
  }
@@ -3026,7 +3109,7 @@ interface Automation extends AutomationOriginInfoOneOf {
3026
3109
  * Date and time the automation was created.
3027
3110
  * @readonly
3028
3111
  */
3029
- _createdDate?: Date;
3112
+ _createdDate?: Date | null;
3030
3113
  /**
3031
3114
  * The entity that last updated the automation.
3032
3115
  * @readonly
@@ -3036,7 +3119,7 @@ interface Automation extends AutomationOriginInfoOneOf {
3036
3119
  * Date and time the automation was last updated.
3037
3120
  * @readonly
3038
3121
  */
3039
- _updatedDate?: Date;
3122
+ _updatedDate?: Date | null;
3040
3123
  /** Automation name that is displayed on the user's site. */
3041
3124
  name?: string;
3042
3125
  /** Automation description. */
@@ -3492,6 +3575,64 @@ interface CopyAutomationResponse {
3492
3575
  /** Automation copy. */
3493
3576
  automation?: Automation;
3494
3577
  }
3578
+ interface CreateDraftAutomationRequest {
3579
+ /** Draft automation to be created. */
3580
+ automation?: Automation;
3581
+ }
3582
+ interface CreateDraftAutomationResponse {
3583
+ /** The created draft automation. */
3584
+ automation?: Automation;
3585
+ }
3586
+ interface GetOrCreateDraftAutomationRequest {
3587
+ /** Original automation id */
3588
+ originalAutomationId: string;
3589
+ }
3590
+ interface GetOrCreateDraftAutomationResponse {
3591
+ /** Draft automation. */
3592
+ automation?: Automation;
3593
+ }
3594
+ interface UpdateDraftAutomationRequest {
3595
+ /** Automation to be updated, may be partial. */
3596
+ automation: Automation;
3597
+ }
3598
+ interface UpdateDraftAutomationResponse {
3599
+ /** Updated draft automation. */
3600
+ automation?: Automation;
3601
+ }
3602
+ interface QueryAutomationsWithDraftsRequest {
3603
+ /** WQL expression. */
3604
+ query?: CursorQuery;
3605
+ }
3606
+ interface QueryAutomationsWithDraftsResponse {
3607
+ /** List of automations. */
3608
+ automations?: Automation[];
3609
+ /** Paging metadata */
3610
+ pagingMetadata?: CursorPagingMetadata;
3611
+ /**
3612
+ * map of existing automationIds and their relevant drafts' automationIds
3613
+ * if include_draft_data: false was passed, the map will be empty
3614
+ * The key is the automationId of the original automation, and the value a list of related draft automationIds
3615
+ */
3616
+ originalAutomationIdToDrafts?: Record<string, DraftsInfo>;
3617
+ }
3618
+ interface DraftsInfo {
3619
+ /** list of drafts of an existing Automation */
3620
+ draftAutomationIds?: string[];
3621
+ }
3622
+ interface DeleteDraftAutomationRequest {
3623
+ /** Id of the draft automation to delete. */
3624
+ automationId: string;
3625
+ }
3626
+ interface DeleteDraftAutomationResponse {
3627
+ }
3628
+ interface PublishDraftAutomationRequest {
3629
+ /** Id of the draft automation to publish. */
3630
+ automationId: string;
3631
+ }
3632
+ interface PublishDraftAutomationResponse {
3633
+ /** Updated automation after publishing the draft */
3634
+ automation?: Automation;
3635
+ }
3495
3636
  interface ValidateAutomationRequest {
3496
3637
  /** Automation to validate. */
3497
3638
  automation: Automation;
@@ -3658,6 +3799,16 @@ interface AutomationConfigurationError {
3658
3799
  declare enum AutomationErrorType {
3659
3800
  UNKNOWN_AUTOMATION_ERROR_TYPE = "UNKNOWN_AUTOMATION_ERROR_TYPE"
3660
3801
  }
3802
+ interface GetAutomationActionSchemaRequest {
3803
+ /** Automation ID */
3804
+ automationId: string;
3805
+ /** Action ID */
3806
+ actionId: string;
3807
+ }
3808
+ interface GetAutomationActionSchemaResponse {
3809
+ /** The accumulated payload schema for an action. */
3810
+ schema?: Record<string, any> | null;
3811
+ }
3661
3812
  interface GetActionsQuotaInfoRequest {
3662
3813
  }
3663
3814
  interface GetActionsQuotaInfoResponse {
@@ -3716,7 +3867,7 @@ interface Quota {
3716
3867
  * Quota renewal date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
3717
3868
  * For example, 10 July 2020 at 15:00 is written as `2020-07-10 15:00:00.000`.
3718
3869
  */
3719
- renewalDate?: Date;
3870
+ renewalDate?: Date | null;
3720
3871
  /** The user's current quota usage. */
3721
3872
  currentUsage?: string;
3722
3873
  /** Quota limit data. */
@@ -3838,6 +3989,21 @@ interface QueryAutomationsResponseNonNullableFields {
3838
3989
  interface CopyAutomationResponseNonNullableFields {
3839
3990
  automation?: AutomationNonNullableFields;
3840
3991
  }
3992
+ interface CreateDraftAutomationResponseNonNullableFields {
3993
+ automation?: AutomationNonNullableFields;
3994
+ }
3995
+ interface GetOrCreateDraftAutomationResponseNonNullableFields {
3996
+ automation?: AutomationNonNullableFields;
3997
+ }
3998
+ interface UpdateDraftAutomationResponseNonNullableFields {
3999
+ automation?: AutomationNonNullableFields;
4000
+ }
4001
+ interface QueryAutomationsWithDraftsResponseNonNullableFields {
4002
+ automations: AutomationNonNullableFields[];
4003
+ }
4004
+ interface PublishDraftAutomationResponseNonNullableFields {
4005
+ automation?: AutomationNonNullableFields;
4006
+ }
3841
4007
  interface TriggerConfigurationErrorNonNullableFields {
3842
4008
  errorType: TriggerErrorType;
3843
4009
  }
@@ -3944,21 +4110,46 @@ declare function queryAutomations(): __PublicMethodMetaInfo<'POST', {}, QueryAut
3944
4110
  declare function copyAutomation(): __PublicMethodMetaInfo<'POST', {
3945
4111
  automationId: string;
3946
4112
  }, CopyAutomationRequest, CopyAutomationRequest$1, CopyAutomationResponse & CopyAutomationResponseNonNullableFields, CopyAutomationResponse$1 & CopyAutomationResponseNonNullableFields$1>;
4113
+ declare function createDraftAutomation(): __PublicMethodMetaInfo<'POST', {}, CreateDraftAutomationRequest, CreateDraftAutomationRequest$1, CreateDraftAutomationResponse & CreateDraftAutomationResponseNonNullableFields, CreateDraftAutomationResponse$1 & CreateDraftAutomationResponseNonNullableFields$1>;
4114
+ declare function getOrCreateDraftAutomation(): __PublicMethodMetaInfo<'POST', {
4115
+ originalAutomationId: string;
4116
+ }, GetOrCreateDraftAutomationRequest, GetOrCreateDraftAutomationRequest$1, GetOrCreateDraftAutomationResponse & GetOrCreateDraftAutomationResponseNonNullableFields, GetOrCreateDraftAutomationResponse$1 & GetOrCreateDraftAutomationResponseNonNullableFields$1>;
4117
+ declare function updateDraftAutomation(): __PublicMethodMetaInfo<'PATCH', {
4118
+ automationId: string;
4119
+ }, UpdateDraftAutomationRequest, UpdateDraftAutomationRequest$1, UpdateDraftAutomationResponse & UpdateDraftAutomationResponseNonNullableFields, UpdateDraftAutomationResponse$1 & UpdateDraftAutomationResponseNonNullableFields$1>;
4120
+ declare function queryAutomationsWithDrafts(): __PublicMethodMetaInfo<'POST', {}, QueryAutomationsWithDraftsRequest, QueryAutomationsWithDraftsRequest$1, QueryAutomationsWithDraftsResponse & QueryAutomationsWithDraftsResponseNonNullableFields, QueryAutomationsWithDraftsResponse$1 & QueryAutomationsWithDraftsResponseNonNullableFields$1>;
4121
+ declare function deleteDraftAutomation(): __PublicMethodMetaInfo<'DELETE', {
4122
+ automationId: string;
4123
+ }, DeleteDraftAutomationRequest, DeleteDraftAutomationRequest$1, DeleteDraftAutomationResponse, DeleteDraftAutomationResponse$1>;
4124
+ declare function publishDraftAutomation(): __PublicMethodMetaInfo<'POST', {
4125
+ automationId: string;
4126
+ }, PublishDraftAutomationRequest, PublishDraftAutomationRequest$1, PublishDraftAutomationResponse & PublishDraftAutomationResponseNonNullableFields, PublishDraftAutomationResponse$1 & PublishDraftAutomationResponseNonNullableFields$1>;
3947
4127
  declare function validateAutomation(): __PublicMethodMetaInfo<'POST', {}, ValidateAutomationRequest, ValidateAutomationRequest$1, ValidateAutomationResponse & ValidateAutomationResponseNonNullableFields, ValidateAutomationResponse$1 & ValidateAutomationResponseNonNullableFields$1>;
4128
+ declare function getAutomationActionSchema(): __PublicMethodMetaInfo<'GET', {
4129
+ automationId: string;
4130
+ actionId: string;
4131
+ }, GetAutomationActionSchemaRequest, GetAutomationActionSchemaRequest$1, GetAutomationActionSchemaResponse, GetAutomationActionSchemaResponse$1>;
3948
4132
  declare function getActionsQuotaInfo(): __PublicMethodMetaInfo<'GET', {}, GetActionsQuotaInfoRequest, GetActionsQuotaInfoRequest$1, GetActionsQuotaInfoResponse & GetActionsQuotaInfoResponseNonNullableFields, GetActionsQuotaInfoResponse$1 & GetActionsQuotaInfoResponseNonNullableFields$1>;
3949
4133
 
3950
4134
  type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
3951
4135
  declare const meta_bulkDeleteAutomations: typeof bulkDeleteAutomations;
3952
4136
  declare const meta_copyAutomation: typeof copyAutomation;
3953
4137
  declare const meta_createAutomation: typeof createAutomation;
4138
+ declare const meta_createDraftAutomation: typeof createDraftAutomation;
3954
4139
  declare const meta_deleteAutomation: typeof deleteAutomation;
4140
+ declare const meta_deleteDraftAutomation: typeof deleteDraftAutomation;
3955
4141
  declare const meta_getActionsQuotaInfo: typeof getActionsQuotaInfo;
3956
4142
  declare const meta_getAutomation: typeof getAutomation;
4143
+ declare const meta_getAutomationActionSchema: typeof getAutomationActionSchema;
4144
+ declare const meta_getOrCreateDraftAutomation: typeof getOrCreateDraftAutomation;
4145
+ declare const meta_publishDraftAutomation: typeof publishDraftAutomation;
3957
4146
  declare const meta_queryAutomations: typeof queryAutomations;
4147
+ declare const meta_queryAutomationsWithDrafts: typeof queryAutomationsWithDrafts;
3958
4148
  declare const meta_updateAutomation: typeof updateAutomation;
4149
+ declare const meta_updateDraftAutomation: typeof updateDraftAutomation;
3959
4150
  declare const meta_validateAutomation: typeof validateAutomation;
3960
4151
  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 };
4152
+ export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_bulkDeleteAutomations as bulkDeleteAutomations, meta_copyAutomation as copyAutomation, meta_createAutomation as createAutomation, meta_createDraftAutomation as createDraftAutomation, meta_deleteAutomation as deleteAutomation, meta_deleteDraftAutomation as deleteDraftAutomation, 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_updateAutomation as updateAutomation, meta_updateDraftAutomation as updateDraftAutomation, meta_validateAutomation as validateAutomation };
3962
4153
  }
3963
4154
 
3964
4155
  export { meta$1 as activations, meta$2 as automationsService, meta as automationsServiceV2 };