@wix/auto_sdk_automations_automations-v-2 1.0.43 → 1.0.45

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.
@@ -2557,59 +2557,59 @@ interface AutomationsQueryBuilder {
2557
2557
  * @param value - Value to compare against.
2558
2558
  * @documentationMaturity preview
2559
2559
  */
2560
- eq: (propertyName: 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived', value: any) => AutomationsQueryBuilder;
2560
+ eq: (propertyName: 'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived', value: any) => AutomationsQueryBuilder;
2561
2561
  /** @param propertyName - Property whose value is compared with `value`.
2562
2562
  * @param value - Value to compare against.
2563
2563
  * @documentationMaturity preview
2564
2564
  */
2565
- ne: (propertyName: 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived', value: any) => AutomationsQueryBuilder;
2565
+ ne: (propertyName: 'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived', value: any) => AutomationsQueryBuilder;
2566
2566
  /** @param propertyName - Property whose value is compared with `value`.
2567
2567
  * @param value - Value to compare against.
2568
2568
  * @documentationMaturity preview
2569
2569
  */
2570
- ge: (propertyName: 'name' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey', value: any) => AutomationsQueryBuilder;
2570
+ ge: (propertyName: 'createdBy.appId' | 'name' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey', value: any) => AutomationsQueryBuilder;
2571
2571
  /** @param propertyName - Property whose value is compared with `value`.
2572
2572
  * @param value - Value to compare against.
2573
2573
  * @documentationMaturity preview
2574
2574
  */
2575
- gt: (propertyName: 'name' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey', value: any) => AutomationsQueryBuilder;
2575
+ gt: (propertyName: 'createdBy.appId' | 'name' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey', value: any) => AutomationsQueryBuilder;
2576
2576
  /** @param propertyName - Property whose value is compared with `value`.
2577
2577
  * @param value - Value to compare against.
2578
2578
  * @documentationMaturity preview
2579
2579
  */
2580
- le: (propertyName: 'name' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey', value: any) => AutomationsQueryBuilder;
2580
+ le: (propertyName: 'createdBy.appId' | 'name' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey', value: any) => AutomationsQueryBuilder;
2581
2581
  /** @param propertyName - Property whose value is compared with `value`.
2582
2582
  * @param value - Value to compare against.
2583
2583
  * @documentationMaturity preview
2584
2584
  */
2585
- lt: (propertyName: 'name' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey', value: any) => AutomationsQueryBuilder;
2585
+ lt: (propertyName: 'createdBy.appId' | 'name' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey', value: any) => AutomationsQueryBuilder;
2586
2586
  /** @param propertyName - Property whose value is compared with `string`.
2587
2587
  * @param string - String to compare against. Case-insensitive.
2588
2588
  * @documentationMaturity preview
2589
2589
  */
2590
- startsWith: (propertyName: 'name' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey', value: string) => AutomationsQueryBuilder;
2590
+ startsWith: (propertyName: 'createdBy.appId' | 'name' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey', value: string) => AutomationsQueryBuilder;
2591
2591
  /** @param propertyName - Property whose value is compared with `values`.
2592
2592
  * @param values - List of values to compare against.
2593
2593
  * @documentationMaturity preview
2594
2594
  */
2595
- hasSome: (propertyName: 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived', value: any[]) => AutomationsQueryBuilder;
2595
+ hasSome: (propertyName: 'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived', value: any[]) => AutomationsQueryBuilder;
2596
2596
  /** @param propertyName - Property whose value is compared with `values`.
2597
2597
  * @param values - List of values to compare against.
2598
2598
  * @documentationMaturity preview
2599
2599
  */
2600
2600
  hasAll: (propertyName: 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds', value: any[]) => AutomationsQueryBuilder;
2601
2601
  /** @documentationMaturity preview */
2602
- in: (propertyName: 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived', value: any) => AutomationsQueryBuilder;
2602
+ in: (propertyName: 'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived', value: any) => AutomationsQueryBuilder;
2603
2603
  /** @documentationMaturity preview */
2604
- exists: (propertyName: 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived', value: boolean) => AutomationsQueryBuilder;
2604
+ exists: (propertyName: 'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived', value: boolean) => AutomationsQueryBuilder;
2605
2605
  /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
2606
2606
  * @documentationMaturity preview
2607
2607
  */
2608
- ascending: (...propertyNames: Array<'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filters' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived'>) => AutomationsQueryBuilder;
2608
+ ascending: (...propertyNames: Array<'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filters' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived'>) => AutomationsQueryBuilder;
2609
2609
  /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
2610
2610
  * @documentationMaturity preview
2611
2611
  */
2612
- descending: (...propertyNames: Array<'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filters' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived'>) => AutomationsQueryBuilder;
2612
+ descending: (...propertyNames: Array<'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filters' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived'>) => AutomationsQueryBuilder;
2613
2613
  /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
2614
2614
  * @documentationMaturity preview
2615
2615
  */
@@ -174,6 +174,9 @@ function createAutomation(payload) {
174
174
  method: "POST",
175
175
  methodFqn: "wix.automations.v2.AutomationsService.CreateAutomation",
176
176
  packageName: PACKAGE_NAME,
177
+ migrationOptions: {
178
+ optInTransformResponse: true
179
+ },
177
180
  url: resolveWixAutomationsV2AutomationsServiceUrl({
178
181
  protoPath: "/v2/automations",
179
182
  data: serializedData,
@@ -203,6 +206,9 @@ function getAutomation(payload) {
203
206
  method: "GET",
204
207
  methodFqn: "wix.automations.v2.AutomationsService.GetAutomation",
205
208
  packageName: PACKAGE_NAME,
209
+ migrationOptions: {
210
+ optInTransformResponse: true
211
+ },
206
212
  url: resolveWixAutomationsV2AutomationsServiceUrl({
207
213
  protoPath: "/v2/automations/{automationId}",
208
214
  data: payload,
@@ -247,6 +253,9 @@ function updateAutomation(payload) {
247
253
  method: "PATCH",
248
254
  methodFqn: "wix.automations.v2.AutomationsService.UpdateAutomation",
249
255
  packageName: PACKAGE_NAME,
256
+ migrationOptions: {
257
+ optInTransformResponse: true
258
+ },
250
259
  url: resolveWixAutomationsV2AutomationsServiceUrl({
251
260
  protoPath: "/v2/automations/{automation.id}",
252
261
  data: serializedData,
@@ -276,6 +285,9 @@ function deleteAutomation(payload) {
276
285
  method: "DELETE",
277
286
  methodFqn: "wix.automations.v2.AutomationsService.DeleteAutomation",
278
287
  packageName: PACKAGE_NAME,
288
+ migrationOptions: {
289
+ optInTransformResponse: true
290
+ },
279
291
  url: resolveWixAutomationsV2AutomationsServiceUrl({
280
292
  protoPath: "/v2/automations/{automationId}",
281
293
  data: payload,
@@ -294,6 +306,9 @@ function bulkDeleteAutomations(payload) {
294
306
  method: "POST",
295
307
  methodFqn: "wix.automations.v2.AutomationsService.BulkDeleteAutomations",
296
308
  packageName: PACKAGE_NAME,
309
+ migrationOptions: {
310
+ optInTransformResponse: true
311
+ },
297
312
  url: resolveWixAutomationsV2AutomationsServiceUrl({
298
313
  protoPath: "/v2/bulk/automations/delete",
299
314
  data: payload,
@@ -323,6 +338,9 @@ function generatePreinstalledAutomation(payload) {
323
338
  method: "POST",
324
339
  methodFqn: "wix.automations.v2.AutomationsService.GeneratePreinstalledAutomation",
325
340
  packageName: PACKAGE_NAME,
341
+ migrationOptions: {
342
+ optInTransformResponse: true
343
+ },
326
344
  url: resolveWixAutomationsV2AutomationsServiceUrl({
327
345
  protoPath: "/v2/preinstalled-automation/generate",
328
346
  data: serializedData,
@@ -352,6 +370,9 @@ function queryAutomations(payload) {
352
370
  method: "POST",
353
371
  methodFqn: "wix.automations.v2.AutomationsService.QueryAutomations",
354
372
  packageName: PACKAGE_NAME,
373
+ migrationOptions: {
374
+ optInTransformResponse: true
375
+ },
355
376
  url: resolveWixAutomationsV2AutomationsServiceUrl({
356
377
  protoPath: "/v2/automations/query",
357
378
  data: payload,
@@ -381,6 +402,9 @@ function getAggregatedUsageInfo(payload) {
381
402
  method: "GET",
382
403
  methodFqn: "wix.automations.v2.AutomationsService.GetAggregatedUsageInfo",
383
404
  packageName: PACKAGE_NAME,
405
+ migrationOptions: {
406
+ optInTransformResponse: true
407
+ },
384
408
  url: resolveWixAutomationsV2AutomationsServiceUrl({
385
409
  protoPath: "/v2/automations/usage",
386
410
  data: payload,
@@ -410,6 +434,9 @@ function copyAutomation(payload) {
410
434
  method: "POST",
411
435
  methodFqn: "wix.automations.v2.AutomationsService.CopyAutomation",
412
436
  packageName: PACKAGE_NAME,
437
+ migrationOptions: {
438
+ optInTransformResponse: true
439
+ },
413
440
  url: resolveWixAutomationsV2AutomationsServiceUrl({
414
441
  protoPath: "/v2/automations/{automationId}/copy",
415
442
  data: serializedData,
@@ -450,6 +477,9 @@ function createDraftAutomation(payload) {
450
477
  method: "POST",
451
478
  methodFqn: "wix.automations.v2.AutomationsService.CreateDraftAutomation",
452
479
  packageName: PACKAGE_NAME,
480
+ migrationOptions: {
481
+ optInTransformResponse: true
482
+ },
453
483
  url: resolveWixAutomationsV2AutomationsServiceUrl({
454
484
  protoPath: "/v2/automations/drafts",
455
485
  data: serializedData,
@@ -479,6 +509,9 @@ function getOrCreateDraftAutomation(payload) {
479
509
  method: "POST",
480
510
  methodFqn: "wix.automations.v2.AutomationsService.GetOrCreateDraftAutomation",
481
511
  packageName: PACKAGE_NAME,
512
+ migrationOptions: {
513
+ optInTransformResponse: true
514
+ },
482
515
  url: resolveWixAutomationsV2AutomationsServiceUrl({
483
516
  protoPath: "/v2/automations/drafts/get-or-create/original-automation-id/{originalAutomationId}",
484
517
  data: payload,
@@ -523,6 +556,9 @@ function updateDraftAutomation(payload) {
523
556
  method: "PATCH",
524
557
  methodFqn: "wix.automations.v2.AutomationsService.UpdateDraftAutomation",
525
558
  packageName: PACKAGE_NAME,
559
+ migrationOptions: {
560
+ optInTransformResponse: true
561
+ },
526
562
  url: resolveWixAutomationsV2AutomationsServiceUrl({
527
563
  protoPath: "/v2/automations/drafts/{automation.id}",
528
564
  data: serializedData,
@@ -552,6 +588,9 @@ function queryAutomationsWithDrafts(payload) {
552
588
  method: "POST",
553
589
  methodFqn: "wix.automations.v2.AutomationsService.QueryAutomationsWithDrafts",
554
590
  packageName: PACKAGE_NAME,
591
+ migrationOptions: {
592
+ optInTransformResponse: true
593
+ },
555
594
  url: resolveWixAutomationsV2AutomationsServiceUrl({
556
595
  protoPath: "/v2/automations/query-with-drafts",
557
596
  data: payload,
@@ -581,6 +620,9 @@ function bulkCountAutomationsWithDrafts(payload) {
581
620
  method: "POST",
582
621
  methodFqn: "wix.automations.v2.AutomationsService.BulkCountAutomationsWithDrafts",
583
622
  packageName: PACKAGE_NAME,
623
+ migrationOptions: {
624
+ optInTransformResponse: true
625
+ },
584
626
  url: resolveWixAutomationsV2AutomationsServiceUrl({
585
627
  protoPath: "/v2/automations/bulk-count-with-drafts",
586
628
  data: payload,
@@ -599,6 +641,9 @@ function deleteDraftAutomation(payload) {
599
641
  method: "DELETE",
600
642
  methodFqn: "wix.automations.v2.AutomationsService.DeleteDraftAutomation",
601
643
  packageName: PACKAGE_NAME,
644
+ migrationOptions: {
645
+ optInTransformResponse: true
646
+ },
602
647
  url: resolveWixAutomationsV2AutomationsServiceUrl({
603
648
  protoPath: "/v2/automations/drafts/{automationId}",
604
649
  data: payload,
@@ -617,6 +662,9 @@ function publishDraftAutomation(payload) {
617
662
  method: "POST",
618
663
  methodFqn: "wix.automations.v2.AutomationsService.PublishDraftAutomation",
619
664
  packageName: PACKAGE_NAME,
665
+ migrationOptions: {
666
+ optInTransformResponse: true
667
+ },
620
668
  url: resolveWixAutomationsV2AutomationsServiceUrl({
621
669
  protoPath: "/v2/automations/drafts/{automationId}/publish",
622
670
  data: payload,
@@ -657,6 +705,9 @@ function validateAutomation(payload) {
657
705
  method: "POST",
658
706
  methodFqn: "wix.automations.v2.AutomationsService.ValidateAutomation",
659
707
  packageName: PACKAGE_NAME,
708
+ migrationOptions: {
709
+ optInTransformResponse: true
710
+ },
660
711
  url: resolveWixAutomationsV2AutomationsServiceUrl({
661
712
  protoPath: "/v2/automations/validate",
662
713
  data: serializedData,
@@ -675,6 +726,9 @@ function validateAutomationById(payload) {
675
726
  method: "POST",
676
727
  methodFqn: "wix.automations.v2.AutomationsService.ValidateAutomationById",
677
728
  packageName: PACKAGE_NAME,
729
+ migrationOptions: {
730
+ optInTransformResponse: true
731
+ },
678
732
  url: resolveWixAutomationsV2AutomationsServiceUrl({
679
733
  protoPath: "/v2/automations/{automationId}/validate",
680
734
  data: payload,
@@ -693,6 +747,9 @@ function getAutomationRevision(payload) {
693
747
  method: "GET",
694
748
  methodFqn: "wix.automations.v2.AutomationRevisionsService.GetAutomationRevision",
695
749
  packageName: PACKAGE_NAME,
750
+ migrationOptions: {
751
+ optInTransformResponse: true
752
+ },
696
753
  url: resolveWixAutomationsV2AutomationRevisionsServiceUrl({
697
754
  protoPath: "/v1/automation-revisions/{automationId}",
698
755
  data: payload,