@wix/auto_sdk_online-programs_sections 1.0.14 → 1.0.16

package/build/es/schemas.mjs

@@ -1,6 +1,6 @@
 // src/online-programs-v3-section-sections.schemas.ts
 import * as z from "zod";
-var CreateSectionRequest = z.object({
+var CreateSectionRequest = /* @__PURE__ */ z.object({
   section: z.object({
     _id: z.string().describe("Section 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}$/,
@@ -55,7 +55,7 @@ var CreateSectionRequest = z.object({
     fields: z.array(z.enum(["TOTAL_STEPS"])).max(1).optional()
   }).optional()
 });
-var CreateSectionResponse = z.object({
+var CreateSectionResponse = /* @__PURE__ */ z.object({
   _id: z.string().describe("Section 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"
@@ -102,7 +102,7 @@ var CreateSectionResponse = z.object({
     ).optional()
   }).describe("Custom field data for the section.").optional()
 });
-var BulkCreateSectionRequest = z.object({
+var BulkCreateSectionsRequest = /* @__PURE__ */ z.object({
   sections: z.array(
     z.object({
       _id: z.string().describe("Section ID.").regex(
@@ -159,7 +159,7 @@ var BulkCreateSectionRequest = z.object({
     fields: z.array(z.enum(["TOTAL_STEPS"])).max(1).optional()
   }).optional()
 });
-var BulkCreateSectionResponse = z.object({
+var BulkCreateSectionsResponse = /* @__PURE__ */ z.object({
   results: z.array(
     z.object({
       itemMetadata: z.object({
@@ -239,7 +239,144 @@ var BulkCreateSectionResponse = z.object({
     ).optional()
   }).describe("Summary of the bulk create operation.").optional()
 });
-var GetSectionRequest = z.object({
+var BulkCreateSectionRequest = /* @__PURE__ */ z.object({
+  sections: z.array(
+    z.object({
+      _id: z.string().describe("Section 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 section is updated. To prevent conflicting changes, the current `revision` must be passed when updating or publishing the section."
+      ).optional().nullable(),
+      _createdDate: z.date().describe("Date and time the section was created.").optional().nullable(),
+      _updatedDate: z.date().describe("Date and time the section was last updated.").optional().nullable(),
+      programId: z.string().describe(
+        "Program ID of the parent program. Provide it when creating a section. After creation, this value can't be changed."
+      ).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(),
+      description: z.intersection(
+        z.object({
+          title: z.string().max(500).optional(),
+          details: z.string().max(1e7).optional().nullable()
+        }),
+        z.xor([
+          z.object({
+            image: z.never().optional(),
+            video: z.never().optional()
+          }),
+          z.object({ video: z.never().optional(), image: z.string() }),
+          z.object({ image: z.never().optional(), video: z.string() })
+        ])
+      ).describe(
+        "Section title and deprecated backward-compatibility content fields."
+      ).optional(),
+      state: z.enum(["DRAFT", "PUBLISHED"]).optional(),
+      oldTotalSteps: z.number().int().describe("Legacy total number of steps in the section.").optional(),
+      totalSteps: z.number().int().describe("Total number of steps in the section.").optional().nullable(),
+      trialSection: z.boolean().describe(
+        "Whether participants can access the section as trial content before purchasing the parent program."
+      ).optional(),
+      ordering: z.number().describe(
+        "Position rank used to order sections within a program. To reorder sections, call Move Section."
+      ).optional(),
+      delayInDays: z.number().int().describe(
+        "Number of days after the parent program starts before the section becomes available. Use `0` to make the section available immediately."
+      ).min(0).max(5e3).optional(),
+      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 section.").optional()
+    })
+  ).min(1).max(100),
+  options: z.object({
+    fields: z.array(z.enum(["TOTAL_STEPS"])).max(1).optional()
+  }).optional()
+});
+var BulkCreateSectionResponse = /* @__PURE__ */ z.object({
+  results: z.array(
+    z.object({
+      itemMetadata: z.object({
+        _id: z.string().describe(
+          "Item ID. Should always be available, unless it's impossible (for example, when failing to create an item)."
+        ).optional().nullable(),
+        originalIndex: z.number().int().describe(
+          "Index of the item within the request array. Allows for correlation between request and response items."
+        ).optional(),
+        success: z.boolean().describe(
+          "Whether the requested action was successful for this item. When `false`, the `error` field is populated."
+        ).optional(),
+        error: z.object({
+          code: z.string().describe("Error code.").optional(),
+          description: z.string().describe("Description of the error.").optional(),
+          data: z.record(z.string(), z.any()).describe("Data related to the error.").optional().nullable()
+        }).describe("Details about the error in case of failure.").optional()
+      }).describe("Metadata for the bulk operation result.").optional(),
+      item: z.object({
+        _id: z.string().describe("Section 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 section is updated. To prevent conflicting changes, the current `revision` must be passed when updating or publishing the section."
+        ).optional().nullable(),
+        _createdDate: z.date().describe("Date and time the section was created.").optional().nullable(),
+        _updatedDate: z.date().describe("Date and time the section was last updated.").optional().nullable(),
+        programId: z.string().describe(
+          "Program ID of the parent program. Provide it when creating a section. After creation, this value can't be changed."
+        ).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(),
+        description: z.intersection(
+          z.object({
+            title: z.string().max(500).optional(),
+            details: z.string().max(1e7).optional().nullable()
+          }),
+          z.xor([
+            z.object({
+              image: z.never().optional(),
+              video: z.never().optional()
+            }),
+            z.object({ video: z.never().optional(), image: z.string() }),
+            z.object({ image: z.never().optional(), video: z.string() })
+          ])
+        ).describe(
+          "Section title and deprecated backward-compatibility content fields."
+        ).optional(),
+        state: z.enum(["DRAFT", "PUBLISHED"]).describe("Publication state of the section.").optional(),
+        oldTotalSteps: z.number().int().describe("Legacy total number of steps in the section.").optional(),
+        totalSteps: z.number().int().describe("Total number of steps in the section.").optional().nullable(),
+        trialSection: z.boolean().describe(
+          "Whether participants can access the section as trial content before purchasing the parent program."
+        ).optional(),
+        ordering: z.number().describe(
+          "Position rank used to order sections within a program. To reorder sections, call Move Section."
+        ).optional(),
+        delayInDays: z.number().int().describe(
+          "Number of days after the parent program starts before the section becomes available. Use `0` to make the section available immediately."
+        ).min(0).max(5e3).optional(),
+        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 section.").optional()
+      }).describe("Created section.").optional(),
+      action: z.enum(["UNKNOWN_ACTION_TYPE", "INSERT", "UPDATE", "DELETE"]).describe("Action associated with the bulk result.").optional()
+    })
+  ).optional(),
+  bulkActionMetadata: z.object({
+    totalSuccesses: z.number().int().describe("Number of items that were successfully processed.").optional(),
+    totalFailures: z.number().int().describe("Number of items that couldn't be processed.").optional(),
+    undetailedFailures: z.number().int().describe(
+      "Number of failures without details because detailed failure threshold was exceeded."
+    ).optional()
+  }).describe("Summary of the bulk create operation.").optional()
+});
+var GetSectionRequest = /* @__PURE__ */ z.object({
   sectionId: z.string().describe("ID of the Section 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"
@@ -249,7 +386,7 @@ var GetSectionRequest = z.object({
     fields: z.array(z.enum(["TOTAL_STEPS"])).max(1).optional()
   }).optional()
 });
-var GetSectionResponse = z.object({
+var GetSectionResponse = /* @__PURE__ */ z.object({
   _id: z.string().describe("Section 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"
@@ -296,7 +433,7 @@ var GetSectionResponse = z.object({
     ).optional()
   }).describe("Custom field data for the section.").optional()
 });
-var UpdateSectionRequest = z.object({
+var UpdateSectionRequest = /* @__PURE__ */ z.object({
   _id: z.string().describe("Section 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"
@@ -357,7 +494,7 @@ var UpdateSectionRequest = z.object({
     fields: z.array(z.enum(["TOTAL_STEPS"])).max(1).optional()
   }).optional()
 });
-var UpdateSectionResponse = z.object({
+var UpdateSectionResponse = /* @__PURE__ */ z.object({
   _id: z.string().describe("Section 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"
@@ -404,14 +541,14 @@ var UpdateSectionResponse = z.object({
     ).optional()
   }).describe("Custom field data for the section.").optional()
 });
-var DeleteSectionRequest = z.object({
+var DeleteSectionRequest = /* @__PURE__ */ z.object({
   sectionId: z.string().describe("ID of the section to delete.").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 DeleteSectionResponse = z.object({});
-var QuerySectionsRequest = z.object({
+var DeleteSectionResponse = /* @__PURE__ */ z.object({});
+var QuerySectionsRequest = /* @__PURE__ */ z.object({
   query: z.intersection(
     z.object({
       filter: z.record(z.string(), z.any()).describe(
@@ -420,7 +557,13 @@ var QuerySectionsRequest = z.object({
       sort: z.array(
         z.object({
           fieldName: z.string().describe("Name of the field to sort by.").max(512).optional(),
-          order: z.enum(["ASC", "DESC"]).optional()
+          order: z.enum(["ASC", "DESC"]).optional(),
+          origin: z.object({
+            latitude: z.number().describe("Address latitude.").optional().nullable(),
+            longitude: z.number().describe("Address longitude.").optional().nullable()
+          }).describe(
+            "Origin point for geo-distance sorting on a GEO field\nresults are ordered by distance from this point (ASC = nearest first, DESC = farthest first)."
+          ).optional()
         })
       ).max(5).optional()
     }),
@@ -446,7 +589,7 @@ var QuerySectionsRequest = z.object({
     fields: z.array(z.enum(["TOTAL_STEPS"])).max(1).optional()
   }).optional()
 });
-var QuerySectionsResponse = z.object({
+var QuerySectionsResponse = /* @__PURE__ */ z.object({
   sections: z.array(
     z.object({
       _id: z.string().describe("Section ID.").regex(
@@ -516,7 +659,7 @@ var QuerySectionsResponse = z.object({
     ).optional().nullable()
   }).describe("Paging metadata.").optional()
 });
-var ListSectionsRequest = z.object({
+var ListSectionsRequest = /* @__PURE__ */ z.object({
   programId: z.string().describe("Program ID to list sections for.").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"
@@ -526,7 +669,7 @@ var ListSectionsRequest = z.object({
     fields: z.array(z.enum(["TOTAL_STEPS"])).max(1).optional()
   }).optional()
 });
-var ListSectionsResponse = z.object({
+var ListSectionsResponse = /* @__PURE__ */ z.object({
   sections: z.array(
     z.object({
       _id: z.string().describe("Section ID.").regex(
@@ -580,7 +723,7 @@ var ListSectionsResponse = z.object({
     })
   ).max(1e3).optional()
 });
-var CloneSectionRequest = z.object({
+var CloneSectionRequest = /* @__PURE__ */ z.object({
   sectionId: z.string().describe("ID of the section to clone.").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"
@@ -589,7 +732,7 @@ var CloneSectionRequest = z.object({
     fields: z.array(z.enum(["TOTAL_STEPS"])).max(1).optional()
   }).optional()
 });
-var CloneSectionResponse = z.object({
+var CloneSectionResponse = /* @__PURE__ */ z.object({
   section: z.object({
     _id: z.string().describe("Section 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}$/,
@@ -641,7 +784,7 @@ var CloneSectionResponse = z.object({
     }).describe("Custom field data for the section.").optional()
   }).describe("Cloned section.").optional()
 });
-var MoveSectionRequest = z.object({
+var MoveSectionRequest = /* @__PURE__ */ z.object({
   options: z.object({
     sectionId: z.string().describe("ID of the section to move.").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}$/,
@@ -657,7 +800,7 @@ var MoveSectionRequest = z.object({
     fields: z.array(z.enum(["TOTAL_STEPS"])).max(1).optional()
   }).optional()
 });
-var MoveSectionResponse = z.object({
+var MoveSectionResponse = /* @__PURE__ */ z.object({
   section: z.object({
     _id: z.string().describe("Section 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}$/,
@@ -709,7 +852,7 @@ var MoveSectionResponse = z.object({
     }).describe("Custom field data for the section.").optional()
   }).describe("Moved section.").optional()
 });
-var PublishSectionRequest = z.object({
+var PublishSectionRequest = /* @__PURE__ */ z.object({
   options: z.object({
     sectionId: z.string().describe("ID of the section to publish.").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}$/,
@@ -719,7 +862,7 @@ var PublishSectionRequest = z.object({
     fields: z.array(z.enum(["TOTAL_STEPS"])).max(1).optional()
   }).optional()
 });
-var PublishSectionResponse = z.object({
+var PublishSectionResponse = /* @__PURE__ */ z.object({
   section: z.object({
     _id: z.string().describe("Section 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}$/,
@@ -774,6 +917,8 @@ var PublishSectionResponse = z.object({
 export {
   BulkCreateSectionRequest,
   BulkCreateSectionResponse,
+  BulkCreateSectionsRequest,
+  BulkCreateSectionsResponse,
   CloneSectionRequest,
   CloneSectionResponse,
   CreateSectionRequest,