@wix/auto_sdk_benefit-programs_programs 1.0.44 → 1.0.46

package/build/internal/es/schemas.mjs

@@ -0,0 +1,861 @@
+// src/benefit-programs-v1-program-programs.schemas.ts
+import * as z from "zod";
+var ProvisionProgramRequest = z.object({
+  poolDefinitionLookupId: z.intersection(
+    z.object({}),
+    z.xor([
+      z.object({
+        poolDefinitionId: z.never().optional(),
+        programDefinitionId: z.never().optional()
+      }),
+      z.object({
+        programDefinitionId: z.never().optional(),
+        poolDefinitionId: z.string().describe("Pool definition ID.").regex(
+          /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+          "Must be a valid GUID"
+        )
+      }),
+      z.object({
+        poolDefinitionId: z.never().optional(),
+        programDefinitionId: z.string().describe("Program definition ID.").regex(
+          /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+          "Must be a valid GUID"
+        )
+      })
+    ])
+  ).describe(
+    "The program definition or pool definition to use to provision the program."
+  ),
+  options: z.object({
+    beneficiary: z.intersection(
+      z.object({}),
+      z.xor([
+        z.object({
+          anonymousVisitorId: z.never().optional(),
+          memberId: z.never().optional(),
+          wixUserId: z.never().optional()
+        }),
+        z.object({
+          memberId: z.never().optional(),
+          wixUserId: z.never().optional(),
+          anonymousVisitorId: z.string().describe(
+            "ID of a site visitor that hasn't logged in to the site."
+          ).regex(
+            /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+            "Must be a valid GUID"
+          )
+        }),
+        z.object({
+          anonymousVisitorId: z.never().optional(),
+          wixUserId: z.never().optional(),
+          memberId: z.string().describe("ID of a site member.").regex(
+            /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+            "Must be a valid GUID"
+          )
+        }),
+        z.object({
+          anonymousVisitorId: z.never().optional(),
+          memberId: z.never().optional(),
+          wixUserId: z.string().describe("ID of a Wix user.").regex(
+            /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+            "Must be a valid GUID"
+          )
+        })
+      ])
+    ).describe("Program beneficiary."),
+    programStatus: z.enum(["ACTIVE", "PAUSED"]).optional(),
+    namespace: z.string().describe(
+      "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
+    ).min(1).max(20),
+    displayName: z.string().describe(
+      "Program name.\n\nIf you're provisioning the program from a program definition, you may want to use the same name that was used for the program definition."
+    ).max(64).optional().nullable(),
+    externalProgramId: z.string().describe(
+      "ID for the program defined by you. You can use `externalId` to filter queries."
+    ).regex(
+      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+      "Must be a valid GUID"
+    )
+  })
+});
+var ProvisionProgramResponse = z.object({
+  jobId: z.string().describe(
+    "Job ID of the provisioning of the program. Retrieve job details using the [Async Job API](https://dev.wix.com/docs/rest/business-management/async-job/introduction)."
+  ).regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ).optional(),
+  program: z.object({
+    _id: z.string().describe("Program ID.").regex(
+      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+      "Must be a valid GUID"
+    ).optional().nullable(),
+    revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
+      "Revision number, which increments by 1 each time the program is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the program.\n\nIgnored when creating a program."
+    ).optional().nullable(),
+    _createdDate: z.date().describe("Date and time the program was created.").optional().nullable(),
+    _updatedDate: z.date().describe("Date and time the program was updated.").optional().nullable(),
+    programDefinitionId: z.string().describe("ID of the associated program definition.").regex(
+      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+      "Must be a valid GUID"
+    ).optional().nullable(),
+    status: z.enum([
+      "ACTIVE",
+      "PAUSED",
+      "ENDED",
+      "PROVISIONING",
+      "PAUSING",
+      "RESUMING",
+      "ENDING"
+    ]).describe("Program status.").optional(),
+    beneficiary: z.intersection(
+      z.object({}),
+      z.xor([
+        z.object({
+          anonymousVisitorId: z.never().optional(),
+          memberId: z.never().optional(),
+          wixUserId: z.never().optional()
+        }),
+        z.object({
+          memberId: z.never().optional(),
+          wixUserId: z.never().optional(),
+          anonymousVisitorId: z.string().describe(
+            "ID of a site visitor that hasn't logged in to the site."
+          ).regex(
+            /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+            "Must be a valid GUID"
+          )
+        }),
+        z.object({
+          anonymousVisitorId: z.never().optional(),
+          wixUserId: z.never().optional(),
+          memberId: z.string().describe("ID of a site member.").regex(
+            /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+            "Must be a valid GUID"
+          )
+        }),
+        z.object({
+          anonymousVisitorId: z.never().optional(),
+          memberId: z.never().optional(),
+          wixUserId: z.string().describe("ID of a Wix user.").regex(
+            /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+            "Must be a valid GUID"
+          )
+        })
+      ])
+    ).describe("Program beneficiary.").optional(),
+    displayName: z.string().describe(
+      "Program name.\n\nYou may want to use the same name that's used in the associated program definition, if it exists."
+    ).max(64).optional().nullable(),
+    namespace: z.string().describe(
+      "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
+    ).min(1).max(20).optional().nullable(),
+    extendedFields: z.object({
+      namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
+        "Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
+      ).optional()
+    }).describe(
+      "Custom field data for the program object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
+    ).optional(),
+    externalId: z.string().describe(
+      "ID for the program defined by you. You can use `externalId` to filter queries."
+    ).regex(
+      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+      "Must be a valid GUID"
+    ).optional().nullable(),
+    programDefinition: z.object({
+      _id: z.string().describe("Program definition ID.").regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      ).optional(),
+      externalId: z.string().describe("Program definition external ID.").regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      ).optional().nullable()
+    }).describe("Associated program definition information.").optional()
+  }).describe("Provisioned program.").optional()
+});
+var RenewProgramRequest = z.object({
+  programId: z.string().describe("ID of the program to renew.").regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ),
+  options: z.object({
+    idempotencyKey: z.string().describe(
+      "Idempotency key to ensure that the request is processed only once."
+    ).max(64)
+  })
+});
+var RenewProgramResponse = z.object({
+  jobId: z.string().describe(
+    "Job ID of the program renewal. Retrieve job details using the [Async Job API](https://dev.wix.com/docs/rest/business-management/async-job/introduction)."
+  ).regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ).optional()
+});
+var PauseProgramRequest = z.object({
+  programId: z.string().describe("ID of the program to pause.").regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ),
+  options: z.object({
+    idempotencyKey: z.string().describe(
+      "Idempotency key to ensure that the request is processed only once."
+    ).max(64)
+  })
+});
+var PauseProgramResponse = z.object({
+  jobId: z.string().describe(
+    "Job ID of the pausing of the program. Retrieve job details using the [Async Job API](https://dev.wix.com/docs/rest/business-management/async-job/introduction)."
+  ).regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ).optional()
+});
+var ResumeProgramRequest = z.object({
+  programId: z.string().describe("ID of program to resume.").regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ),
+  options: z.object({
+    idempotencyKey: z.string().describe(
+      "Idempotency key to ensure that the request is processed only once."
+    ).max(64)
+  })
+});
+var ResumeProgramResponse = z.object({
+  jobId: z.string().describe(
+    "Job ID of the resuming of the program. Retrieve job details using the [Async Job API](https://dev.wix.com/docs/rest/business-management/async-job/introduction)."
+  ).regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ).optional()
+});
+var EndProgramRequest = z.object({
+  programId: z.string().describe("ID of the program to end.").regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  )
+});
+var EndProgramResponse = z.object({
+  jobId: z.string().describe(
+    "Job ID of the ending of the program. Retrieve job details using the [Async Job API](https://dev.wix.com/docs/rest/business-management/async-job/introduction)."
+  ).regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ).optional()
+});
+var UpdateProgramRequest = z.object({
+  _id: z.string().describe("Program ID.").regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ),
+  program: z.object({
+    _id: z.string().describe("Program ID.").regex(
+      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+      "Must be a valid GUID"
+    ).optional().nullable(),
+    revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
+      "Revision number, which increments by 1 each time the program is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the program.\n\nIgnored when creating a program."
+    ),
+    _createdDate: z.date().describe("Date and time the program was created.").optional().nullable(),
+    _updatedDate: z.date().describe("Date and time the program was updated.").optional().nullable(),
+    programDefinitionId: z.string().describe("ID of the associated program definition.").regex(
+      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+      "Must be a valid GUID"
+    ).optional().nullable(),
+    status: z.enum([
+      "ACTIVE",
+      "PAUSED",
+      "ENDED",
+      "PROVISIONING",
+      "PAUSING",
+      "RESUMING",
+      "ENDING"
+    ]).optional(),
+    beneficiary: z.intersection(
+      z.object({}),
+      z.xor([
+        z.object({
+          anonymousVisitorId: z.never().optional(),
+          memberId: z.never().optional(),
+          wixUserId: z.never().optional()
+        }),
+        z.object({
+          memberId: z.never().optional(),
+          wixUserId: z.never().optional(),
+          anonymousVisitorId: z.string().describe(
+            "ID of a site visitor that hasn't logged in to the site."
+          ).regex(
+            /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+            "Must be a valid GUID"
+          )
+        }),
+        z.object({
+          anonymousVisitorId: z.never().optional(),
+          wixUserId: z.never().optional(),
+          memberId: z.string().describe("ID of a site member.").regex(
+            /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+            "Must be a valid GUID"
+          )
+        }),
+        z.object({
+          anonymousVisitorId: z.never().optional(),
+          memberId: z.never().optional(),
+          wixUserId: z.string().describe("ID of a Wix user.").regex(
+            /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+            "Must be a valid GUID"
+          )
+        })
+      ])
+    ).describe("Program beneficiary.").optional(),
+    displayName: z.string().describe(
+      "Program name.\n\nYou may want to use the same name that's used in the associated program definition, if it exists."
+    ).max(64).optional().nullable(),
+    namespace: z.string().describe(
+      "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
+    ).min(1).max(20).optional().nullable(),
+    extendedFields: z.object({
+      namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
+        "Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
+      ).optional()
+    }).describe(
+      "Custom field data for the program object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
+    ).optional(),
+    externalId: z.string().describe(
+      "ID for the program defined by you. You can use `externalId` to filter queries."
+    ).regex(
+      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+      "Must be a valid GUID"
+    ).optional().nullable(),
+    programDefinition: z.object({
+      _id: z.string().describe("Program definition ID.").regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      ).optional(),
+      externalId: z.string().describe("Program definition external ID.").regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      ).optional().nullable()
+    }).describe("Associated program definition information.").optional()
+  }).describe("Program to update.")
+});
+var UpdateProgramResponse = z.object({
+  _id: z.string().describe("Program ID.").regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ).optional().nullable(),
+  revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
+    "Revision number, which increments by 1 each time the program is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the program.\n\nIgnored when creating a program."
+  ).optional().nullable(),
+  _createdDate: z.date().describe("Date and time the program was created.").optional().nullable(),
+  _updatedDate: z.date().describe("Date and time the program was updated.").optional().nullable(),
+  programDefinitionId: z.string().describe("ID of the associated program definition.").regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ).optional().nullable(),
+  status: z.enum([
+    "ACTIVE",
+    "PAUSED",
+    "ENDED",
+    "PROVISIONING",
+    "PAUSING",
+    "RESUMING",
+    "ENDING"
+  ]).describe("Program status.").optional(),
+  beneficiary: z.intersection(
+    z.object({}),
+    z.xor([
+      z.object({
+        anonymousVisitorId: z.never().optional(),
+        memberId: z.never().optional(),
+        wixUserId: z.never().optional()
+      }),
+      z.object({
+        memberId: z.never().optional(),
+        wixUserId: z.never().optional(),
+        anonymousVisitorId: z.string().describe("ID of a site visitor that hasn't logged in to the site.").regex(
+          /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+          "Must be a valid GUID"
+        )
+      }),
+      z.object({
+        anonymousVisitorId: z.never().optional(),
+        wixUserId: z.never().optional(),
+        memberId: z.string().describe("ID of a site member.").regex(
+          /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+          "Must be a valid GUID"
+        )
+      }),
+      z.object({
+        anonymousVisitorId: z.never().optional(),
+        memberId: z.never().optional(),
+        wixUserId: z.string().describe("ID of a Wix user.").regex(
+          /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+          "Must be a valid GUID"
+        )
+      })
+    ])
+  ).describe("Program beneficiary.").optional(),
+  displayName: z.string().describe(
+    "Program name.\n\nYou may want to use the same name that's used in the associated program definition, if it exists."
+  ).max(64).optional().nullable(),
+  namespace: z.string().describe(
+    "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
+  ).min(1).max(20).optional().nullable(),
+  extendedFields: z.object({
+    namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
+      "Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
+    ).optional()
+  }).describe(
+    "Custom field data for the program object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
+  ).optional(),
+  externalId: z.string().describe(
+    "ID for the program defined by you. You can use `externalId` to filter queries."
+  ).regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ).optional().nullable(),
+  programDefinition: z.object({
+    _id: z.string().describe("Program definition ID.").regex(
+      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+      "Must be a valid GUID"
+    ).optional(),
+    externalId: z.string().describe("Program definition external ID.").regex(
+      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+      "Must be a valid GUID"
+    ).optional().nullable()
+  }).describe("Associated program definition information.").optional()
+});
+var GetProgramRequest = z.object({
+  programId: z.string().describe("ID of the program to retrieve.").regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  )
+});
+var GetProgramResponse = z.object({
+  _id: z.string().describe("Program ID.").regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ).optional().nullable(),
+  revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
+    "Revision number, which increments by 1 each time the program is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the program.\n\nIgnored when creating a program."
+  ).optional().nullable(),
+  _createdDate: z.date().describe("Date and time the program was created.").optional().nullable(),
+  _updatedDate: z.date().describe("Date and time the program was updated.").optional().nullable(),
+  programDefinitionId: z.string().describe("ID of the associated program definition.").regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ).optional().nullable(),
+  status: z.enum([
+    "ACTIVE",
+    "PAUSED",
+    "ENDED",
+    "PROVISIONING",
+    "PAUSING",
+    "RESUMING",
+    "ENDING"
+  ]).describe("Program status.").optional(),
+  beneficiary: z.intersection(
+    z.object({}),
+    z.xor([
+      z.object({
+        anonymousVisitorId: z.never().optional(),
+        memberId: z.never().optional(),
+        wixUserId: z.never().optional()
+      }),
+      z.object({
+        memberId: z.never().optional(),
+        wixUserId: z.never().optional(),
+        anonymousVisitorId: z.string().describe("ID of a site visitor that hasn't logged in to the site.").regex(
+          /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+          "Must be a valid GUID"
+        )
+      }),
+      z.object({
+        anonymousVisitorId: z.never().optional(),
+        wixUserId: z.never().optional(),
+        memberId: z.string().describe("ID of a site member.").regex(
+          /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+          "Must be a valid GUID"
+        )
+      }),
+      z.object({
+        anonymousVisitorId: z.never().optional(),
+        memberId: z.never().optional(),
+        wixUserId: z.string().describe("ID of a Wix user.").regex(
+          /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+          "Must be a valid GUID"
+        )
+      })
+    ])
+  ).describe("Program beneficiary.").optional(),
+  displayName: z.string().describe(
+    "Program name.\n\nYou may want to use the same name that's used in the associated program definition, if it exists."
+  ).max(64).optional().nullable(),
+  namespace: z.string().describe(
+    "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
+  ).min(1).max(20).optional().nullable(),
+  extendedFields: z.object({
+    namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
+      "Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
+    ).optional()
+  }).describe(
+    "Custom field data for the program object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
+  ).optional(),
+  externalId: z.string().describe(
+    "ID for the program defined by you. You can use `externalId` to filter queries."
+  ).regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ).optional().nullable(),
+  programDefinition: z.object({
+    _id: z.string().describe("Program definition ID.").regex(
+      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+      "Must be a valid GUID"
+    ).optional(),
+    externalId: z.string().describe("Program definition external ID.").regex(
+      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+      "Must be a valid GUID"
+    ).optional().nullable()
+  }).describe("Associated program definition information.").optional()
+});
+var QueryProgramsRequest = z.object({
+  query: z.object({
+    filter: z.object({
+      _id: z.object({
+        $eq: z.string(),
+        $exists: z.boolean(),
+        $gt: z.string(),
+        $gte: z.string(),
+        $hasAll: z.array(z.string()),
+        $hasSome: z.array(z.string()),
+        $in: z.array(z.string()),
+        $lt: z.string(),
+        $lte: z.string(),
+        $ne: z.string(),
+        $nin: z.array(z.string()),
+        $startsWith: z.string()
+      }).partial().strict().optional(),
+      namespace: z.object({
+        $eq: z.string(),
+        $exists: z.boolean(),
+        $gt: z.string(),
+        $gte: z.string(),
+        $hasAll: z.array(z.string()),
+        $hasSome: z.array(z.string()),
+        $in: z.array(z.string()),
+        $lt: z.string(),
+        $lte: z.string(),
+        $ne: z.string(),
+        $nin: z.array(z.string()),
+        $startsWith: z.string()
+      }).partial().strict().optional(),
+      externalId: z.object({
+        $eq: z.string(),
+        $exists: z.boolean(),
+        $gt: z.string(),
+        $gte: z.string(),
+        $hasAll: z.array(z.string()),
+        $hasSome: z.array(z.string()),
+        $in: z.array(z.string()),
+        $lt: z.string(),
+        $lte: z.string(),
+        $ne: z.string(),
+        $nin: z.array(z.string()),
+        $startsWith: z.string()
+      }).partial().strict().optional(),
+      programDefinitionId: z.object({
+        $eq: z.string(),
+        $exists: z.boolean(),
+        $gt: z.string(),
+        $gte: z.string(),
+        $hasAll: z.array(z.string()),
+        $hasSome: z.array(z.string()),
+        $in: z.array(z.string()),
+        $lt: z.string(),
+        $lte: z.string(),
+        $ne: z.string(),
+        $nin: z.array(z.string()),
+        $startsWith: z.string()
+      }).partial().strict().optional(),
+      status: z.object({
+        $eq: z.string(),
+        $exists: z.boolean(),
+        $gt: z.string(),
+        $gte: z.string(),
+        $hasAll: z.array(z.string()),
+        $hasSome: z.array(z.string()),
+        $in: z.array(z.string()),
+        $lt: z.string(),
+        $lte: z.string(),
+        $ne: z.string(),
+        $nin: z.array(z.string()),
+        $startsWith: z.string()
+      }).partial().strict().optional(),
+      _createdDate: z.object({
+        $eq: z.string(),
+        $exists: z.boolean(),
+        $gt: z.string(),
+        $gte: z.string(),
+        $hasAll: z.array(z.string()),
+        $hasSome: z.array(z.string()),
+        $in: z.array(z.string()),
+        $lt: z.string(),
+        $lte: z.string(),
+        $ne: z.string(),
+        $nin: z.array(z.string()),
+        $startsWith: z.string()
+      }).partial().strict().optional(),
+      $and: z.array(z.any()).optional(),
+      $or: z.array(z.any()).optional(),
+      $not: z.any().optional()
+    }).strict().optional(),
+    sort: z.array(
+      z.object({
+        fieldName: z.enum([
+          "_id",
+          "namespace",
+          "externalId",
+          "programDefinitionId",
+          "status",
+          "_createdDate"
+        ]).optional(),
+        order: z.enum(["ASC", "DESC"]).optional()
+      })
+    ).optional()
+  }).catchall(z.any()).describe("Filter, sort, and paging to apply to the query.")
+});
+var QueryProgramsResponse = z.object({
+  programs: z.array(
+    z.object({
+      _id: z.string().describe("Program ID.").regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      ).optional().nullable(),
+      revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
+        "Revision number, which increments by 1 each time the program is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the program.\n\nIgnored when creating a program."
+      ).optional().nullable(),
+      _createdDate: z.date().describe("Date and time the program was created.").optional().nullable(),
+      _updatedDate: z.date().describe("Date and time the program was updated.").optional().nullable(),
+      programDefinitionId: z.string().describe("ID of the associated program definition.").regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      ).optional().nullable(),
+      status: z.enum([
+        "ACTIVE",
+        "PAUSED",
+        "ENDED",
+        "PROVISIONING",
+        "PAUSING",
+        "RESUMING",
+        "ENDING"
+      ]).describe("Program status.").optional(),
+      beneficiary: z.intersection(
+        z.object({}),
+        z.xor([
+          z.object({
+            anonymousVisitorId: z.never().optional(),
+            memberId: z.never().optional(),
+            wixUserId: z.never().optional()
+          }),
+          z.object({
+            memberId: z.never().optional(),
+            wixUserId: z.never().optional(),
+            anonymousVisitorId: z.string().describe(
+              "ID of a site visitor that hasn't logged in to the site."
+            ).regex(
+              /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+              "Must be a valid GUID"
+            )
+          }),
+          z.object({
+            anonymousVisitorId: z.never().optional(),
+            wixUserId: z.never().optional(),
+            memberId: z.string().describe("ID of a site member.").regex(
+              /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+              "Must be a valid GUID"
+            )
+          }),
+          z.object({
+            anonymousVisitorId: z.never().optional(),
+            memberId: z.never().optional(),
+            wixUserId: z.string().describe("ID of a Wix user.").regex(
+              /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+              "Must be a valid GUID"
+            )
+          })
+        ])
+      ).describe("Program beneficiary.").optional(),
+      displayName: z.string().describe(
+        "Program name.\n\nYou may want to use the same name that's used in the associated program definition, if it exists."
+      ).max(64).optional().nullable(),
+      namespace: z.string().describe(
+        "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
+      ).min(1).max(20).optional().nullable(),
+      extendedFields: z.object({
+        namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
+          "Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
+        ).optional()
+      }).describe(
+        "Custom field data for the program object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
+      ).optional(),
+      externalId: z.string().describe(
+        "ID for the program defined by you. You can use `externalId` to filter queries."
+      ).regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      ).optional().nullable(),
+      programDefinition: z.object({
+        _id: z.string().describe("Program definition ID.").regex(
+          /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+          "Must be a valid GUID"
+        ).optional(),
+        externalId: z.string().describe("Program definition external ID.").regex(
+          /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+          "Must be a valid GUID"
+        ).optional().nullable()
+      }).describe("Associated program definition information.").optional()
+    })
+  ).optional(),
+  metadata: z.object({
+    count: z.number().int().describe("Number of items returned in the response.").optional().nullable(),
+    cursors: z.object({
+      next: z.string().describe(
+        "Cursor string pointing to the next page in the list of results."
+      ).max(16e3).optional().nullable(),
+      prev: z.string().describe(
+        "Cursor pointing to the previous page in the list of results."
+      ).max(16e3).optional().nullable()
+    }).describe(
+      "Cursor strings that point to the next page, previous page, or both."
+    ).optional(),
+    hasNext: z.boolean().describe(
+      "Whether there are more pages to retrieve following the current page.\n\n+ `true`: Another page of results can be retrieved.\n+ `false`: This is the last page."
+    ).optional().nullable()
+  }).describe("Metadata for the paginated results.").optional()
+});
+var GetProgramByExternalIdAndNamespaceRequest = z.object({
+  namespace: z.string().describe(
+    "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
+  ).min(1).max(20),
+  options: z.object({
+    externalId: z.string().describe("Program's external ID.").regex(
+      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+      "Must be a valid GUID"
+    )
+  })
+});
+var GetProgramByExternalIdAndNamespaceResponse = z.object({
+  program: z.object({
+    _id: z.string().describe("Program ID.").regex(
+      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+      "Must be a valid GUID"
+    ).optional().nullable(),
+    revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
+      "Revision number, which increments by 1 each time the program is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the program.\n\nIgnored when creating a program."
+    ).optional().nullable(),
+    _createdDate: z.date().describe("Date and time the program was created.").optional().nullable(),
+    _updatedDate: z.date().describe("Date and time the program was updated.").optional().nullable(),
+    programDefinitionId: z.string().describe("ID of the associated program definition.").regex(
+      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+      "Must be a valid GUID"
+    ).optional().nullable(),
+    status: z.enum([
+      "ACTIVE",
+      "PAUSED",
+      "ENDED",
+      "PROVISIONING",
+      "PAUSING",
+      "RESUMING",
+      "ENDING"
+    ]).describe("Program status.").optional(),
+    beneficiary: z.intersection(
+      z.object({}),
+      z.xor([
+        z.object({
+          anonymousVisitorId: z.never().optional(),
+          memberId: z.never().optional(),
+          wixUserId: z.never().optional()
+        }),
+        z.object({
+          memberId: z.never().optional(),
+          wixUserId: z.never().optional(),
+          anonymousVisitorId: z.string().describe(
+            "ID of a site visitor that hasn't logged in to the site."
+          ).regex(
+            /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+            "Must be a valid GUID"
+          )
+        }),
+        z.object({
+          anonymousVisitorId: z.never().optional(),
+          wixUserId: z.never().optional(),
+          memberId: z.string().describe("ID of a site member.").regex(
+            /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+            "Must be a valid GUID"
+          )
+        }),
+        z.object({
+          anonymousVisitorId: z.never().optional(),
+          memberId: z.never().optional(),
+          wixUserId: z.string().describe("ID of a Wix user.").regex(
+            /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+            "Must be a valid GUID"
+          )
+        })
+      ])
+    ).describe("Program beneficiary.").optional(),
+    displayName: z.string().describe(
+      "Program name.\n\nYou may want to use the same name that's used in the associated program definition, if it exists."
+    ).max(64).optional().nullable(),
+    namespace: z.string().describe(
+      "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
+    ).min(1).max(20).optional().nullable(),
+    extendedFields: z.object({
+      namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
+        "Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
+      ).optional()
+    }).describe(
+      "Custom field data for the program object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
+    ).optional(),
+    externalId: z.string().describe(
+      "ID for the program defined by you. You can use `externalId` to filter queries."
+    ).regex(
+      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+      "Must be a valid GUID"
+    ).optional().nullable(),
+    programDefinition: z.object({
+      _id: z.string().describe("Program definition ID.").regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      ).optional(),
+      externalId: z.string().describe("Program definition external ID.").regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      ).optional().nullable()
+    }).describe("Associated program definition information.").optional()
+  }).describe("Retrieved program.").optional()
+});
+export {
+  EndProgramRequest,
+  EndProgramResponse,
+  GetProgramByExternalIdAndNamespaceRequest,
+  GetProgramByExternalIdAndNamespaceResponse,
+  GetProgramRequest,
+  GetProgramResponse,
+  PauseProgramRequest,
+  PauseProgramResponse,
+  ProvisionProgramRequest,
+  ProvisionProgramResponse,
+  QueryProgramsRequest,
+  QueryProgramsResponse,
+  RenewProgramRequest,
+  RenewProgramResponse,
+  ResumeProgramRequest,
+  ResumeProgramResponse,
+  UpdateProgramRequest,
+  UpdateProgramResponse
+};
+//# sourceMappingURL=schemas.mjs.map