@zapier/zapier-sdk 0.119.5 → 0.120.0

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.
@@ -1,4 +1,4 @@
1
- import { taxonomy, DEFAULT_PAGE_SIZE, apiPluginRef, workflowIdResolver, extractErrorDetail, ZapierApiError, durableRunIdResolver, ZapierConflictError, workflowVersionIdResolver, workflowDraftIdResolver, workflowRunIdResolver, workflowDraftRevisionResolver, isZapierNotFoundError, ZapierTimeoutError, zapierSdkPlugin, SDK_VERSION, ZapierValidationError, sleep, zapierCoreOptions, SDK_OPTIONS_ID } from './chunk-YZMIF24O.mjs';
1
+ import { taxonomy, DEFAULT_PAGE_SIZE, apiPluginRef, workflowIdResolver, extractErrorDetail, ZapierApiError, durableRunIdResolver, ZapierConflictError, workflowVersionIdResolver, workflowDraftIdResolver, workflowRunIdResolver, workflowDraftRevisionResolver, isZapierNotFoundError, ZapierTimeoutError, zapierSdkPlugin, SDK_VERSION, ZapierValidationError, sleep, zapierCoreOptions, SDK_OPTIONS_ID } from './chunk-ZSALKPF6.mjs';
2
2
  import { defineMethod, openEnum, defineResolver, definePlugin, createSdk, CORE_OPTIONS_ID } from '@zapier/kitcore';
3
3
  import { z } from 'zod';
4
4
 
@@ -282,8 +282,12 @@ var WorkflowItemSchema = z.object({
282
282
  disabled_reason: WorkflowDisabledReasonSchema.nullable().optional().describe(
283
283
  "Why the workflow is off, when system-disabled. Null when not system-disabled."
284
284
  ),
285
- is_private: z.boolean().describe(
286
- "Whether the workflow is private to the creating user. False means account-visible."
285
+ // No `.meta({ deprecated: true })`: that flag drops a field from the
286
+ // generated README, and the API still returns this one, so it stays
287
+ // documented while deprecated.
288
+ /** @deprecated May be removed from the API in a future release. No replacement; do not rely on this value. */
289
+ is_private: z.boolean().nullish().describe(
290
+ "Whether the workflow is private to the creating user. False means account-visible. Deprecated: may be removed from the API in a future release. There is no replacement field; do not rely on it. An absent or null value means unknown, not false."
287
291
  ),
288
292
  created_by_user_id: z.string().nullable().describe("User ID of the workflow creator (null in legacy data)"),
289
293
  current_version_id: z.string().nullable().describe(
@@ -383,8 +387,12 @@ var GetWorkflowResponseSchema = z.object({
383
387
  disabled_reason: WorkflowDisabledReasonSchema.nullable().optional().describe(
384
388
  "Why the workflow is off, when system-disabled. Null when not system-disabled. Independent of per-trigger claim status: an enabled workflow can still have a failed trigger."
385
389
  ),
386
- is_private: z.boolean().describe(
387
- "Whether the workflow is private to the creating user. False means account-visible."
390
+ // No `.meta({ deprecated: true })`: that flag drops a field from the
391
+ // generated README, and the API still returns this one, so it stays
392
+ // documented while deprecated.
393
+ /** @deprecated May be removed from the API in a future release. No replacement; do not rely on this value. */
394
+ is_private: z.boolean().nullish().describe(
395
+ "Whether the workflow is private to the creating user. False means account-visible. Deprecated: may be removed from the API in a future release. There is no replacement field; do not rely on it. An absent or null value means unknown, not false."
388
396
  ),
389
397
  created_by_user_id: z.string().nullable().describe("User ID of the workflow creator (null in legacy data)"),
390
398
  current_version: WorkflowVersionSchema2.optional().describe(
@@ -444,8 +452,12 @@ var CreateWorkflowResponseSchema = z.object({
444
452
  enabled: z.boolean().describe(
445
453
  "Whether the workflow currently accepts triggers. Always false on a new workflow until enabled."
446
454
  ),
447
- is_private: z.boolean().describe(
448
- "Whether the workflow is private to the creating user. False means account-visible."
455
+ // No `.meta({ deprecated: true })`: that flag drops a field from the
456
+ // generated README, and the API still returns this one, so it stays
457
+ // documented while deprecated.
458
+ /** @deprecated May be removed from the API in a future release. No replacement; do not rely on this value. */
459
+ is_private: z.boolean().nullish().describe(
460
+ "Whether the workflow is private to the creating user. False means account-visible. Deprecated: may be removed from the API in a future release. There is no replacement field; do not rely on it. An absent or null value means unknown, not false."
449
461
  ),
450
462
  created_by_user_id: z.string().nullable().describe("User ID of the workflow creator (null in legacy data)"),
451
463
  created_at: z.string().describe("When the workflow was created (ISO-8601)"),
@@ -525,8 +537,12 @@ var ImportedWorkflowSchema = z.object({
525
537
  "Whether the workflow accepts triggers. An import always lands disabled."
526
538
  ),
527
539
  disabled_reason: WorkflowDisabledReasonSchema.nullable().optional().describe("Why the workflow is off, when system-disabled."),
528
- is_private: z.boolean().describe(
529
- "Whether the workflow is private to the creating user. False means account-visible."
540
+ // No `.meta({ deprecated: true })`: that flag drops a field from the
541
+ // generated README, and the API still returns this one, so it stays
542
+ // documented while deprecated.
543
+ /** @deprecated May be removed from the API in a future release. No replacement; do not rely on this value. */
544
+ is_private: z.boolean().nullish().describe(
545
+ "Whether the workflow is private to the creating user. False means account-visible. Deprecated: may be removed from the API in a future release. There is no replacement field; do not rely on it. An absent or null value means unknown, not false."
530
546
  ),
531
547
  source_zap_id: z.string().nullable().optional().describe("The Zap this workflow was imported from."),
532
548
  created_by_user_id: z.string(),
@@ -611,8 +627,12 @@ var UpdateWorkflowResponseSchema = z.object({
611
627
  trigger_url: WorkflowTriggerUrlSchema,
612
628
  editor_url: WorkflowEditorUrlSchema,
613
629
  enabled: z.boolean().describe("Whether the workflow currently accepts triggers"),
614
- is_private: z.boolean().describe(
615
- "Whether the workflow is private to the creating user. False means account-visible."
630
+ // No `.meta({ deprecated: true })`: that flag drops a field from the
631
+ // generated README, and the API still returns this one, so it stays
632
+ // documented while deprecated.
633
+ /** @deprecated May be removed from the API in a future release. No replacement; do not rely on this value. */
634
+ is_private: z.boolean().nullish().describe(
635
+ "Whether the workflow is private to the creating user. False means account-visible. Deprecated: may be removed from the API in a future release. There is no replacement field; do not rely on it. An absent or null value means unknown, not false."
616
636
  ),
617
637
  created_by_user_id: z.string().nullable().describe("User ID of the workflow creator (null in legacy data)"),
618
638
  created_at: z.string().describe("When the workflow was created (ISO-8601)"),
@@ -775,8 +795,12 @@ var RunItemSchema = z.object({
775
795
  execution_id: z.string().nullable().describe(
776
796
  "Linked execution ID. Null until the run leaves the `initialized` state."
777
797
  ),
778
- is_private: z.boolean().describe(
779
- "When true, the run is visible only to the creating user; otherwise visible across the account."
798
+ // No `.meta({ deprecated: true })`: that flag drops a field from the
799
+ // generated README, and the API still returns this one, so it stays
800
+ // documented while deprecated.
801
+ /** @deprecated May be removed from the API in a future release. No replacement; do not rely on this value. */
802
+ is_private: z.boolean().nullish().describe(
803
+ "When true, the run is visible only to the creating user; when false, it is visible across the account. Deprecated: may be removed from the API in a future release. There is no replacement field; do not rely on it. An absent or null value means unknown, not false."
780
804
  ),
781
805
  created_at: z.string().describe("When the run was created (ISO-8601)"),
782
806
  updated_at: z.string().describe("When the run was last updated (ISO-8601)")
@@ -918,8 +942,12 @@ var GetDurableRunResponseSchema = z.object({
918
942
  execution: ExecutionSummarySchema.nullable().describe(
919
943
  "Linked execution, including the operations journal. Null while the run is still in `initialized` state."
920
944
  ),
921
- is_private: z.boolean().describe(
922
- "When true, the run is visible only to the creating user; otherwise visible across the account."
945
+ // No `.meta({ deprecated: true })`: that flag drops a field from the
946
+ // generated README, and the API still returns this one, so it stays
947
+ // documented while deprecated.
948
+ /** @deprecated May be removed from the API in a future release. No replacement; do not rely on this value. */
949
+ is_private: z.boolean().nullish().describe(
950
+ "When true, the run is visible only to the creating user; when false, it is visible across the account. Deprecated: may be removed from the API in a future release. There is no replacement field; do not rely on it. An absent or null value means unknown, not false."
923
951
  ),
924
952
  created_at: z.string().describe("When the run was created (ISO-8601)"),
925
953
  updated_at: z.string().describe("When the run was last updated (ISO-8601)")
@@ -1001,8 +1029,12 @@ var RunDurableResponseSchema = z.object({
1001
1029
  status: z.literal("initialized").describe(
1002
1030
  "Always `initialized` on creation. Poll via getDurableRun to observe the run advancing to `started` / `finished` / `failed` / `cancelled`."
1003
1031
  ),
1004
- is_private: z.boolean().describe(
1005
- "When true, the run is visible only to the creating user; otherwise visible across the account."
1032
+ // No `.meta({ deprecated: true })`: that flag drops a field from the
1033
+ // generated README, and the API still returns this one, so it stays
1034
+ // documented while deprecated.
1035
+ /** @deprecated May be removed from the API in a future release. No replacement; do not rely on this value. */
1036
+ is_private: z.boolean().nullish().describe(
1037
+ "When true, the run is visible only to the creating user; when false, it is visible across the account. Deprecated: may be removed from the API in a future release. There is no replacement field; do not rely on it. An absent or null value means unknown, not false."
1006
1038
  ),
1007
1039
  created_at: z.string().describe("When the run was created (ISO-8601)")
1008
1040
  });