@epcc-sdk/sdks-shopper 0.11.0 → 0.12.0

package/dist/client/zod.gen.mjs

@@ -1561,15 +1561,9 @@ const zResponsePageLinks = z.object({
   first: z.string().register(z.globalRegistry, {
     description: "Always the first page."
   }).optional(),
-  last: z.string().register(z.globalRegistry, {
-    description: "If there is only one page, it is `null`."
-  }).optional(),
-  next: z.string().register(z.globalRegistry, {
-    description: "If there is only one page, it is `null`."
-  }).optional(),
-  prev: z.string().register(z.globalRegistry, {
-    description: "if the user is on the first page, it is `null`."
-  }).optional()
+  last: z.string().nullish(),
+  next: z.string().nullish(),
+  prev: z.string().nullish()
 });
 const zResponsePaginationPage = z.object({
   current: z.int().register(z.globalRegistry, {
@@ -2972,6 +2966,51 @@ const zOrdersTransactionsCancelRequest = z.object({
     }).optional()
   }).optional()
 });
+const zTransactionNoteResponse = z.object({
+  type: z.literal("note").optional(),
+  id: z.string().optional(),
+  text: z.string().max(250).optional(),
+  relationships: z.object({
+    transaction: z.object({
+      data: z.object({
+        type: z.literal("transaction").optional(),
+        id: z.string().optional()
+      }).optional()
+    }).optional()
+  }).optional(),
+  meta: z.object({
+    timestamps: z.object({
+      created_at: z.iso.datetime().optional(),
+      updated_at: z.iso.datetime().optional()
+    }).optional(),
+    created_by: z.string().register(z.globalRegistry, {
+      description: "The ID of the Commerce Manager user who created the note. Empty when the note was not created by a user, for example with a client credentials token."
+    }).optional(),
+    updated_by: z.string().register(z.globalRegistry, {
+      description: "The ID of the Commerce Manager user who last edited the note. Empty when the last edit was not made by a user, for example with a client credentials token."
+    }).optional()
+  }).optional()
+});
+const zResponseMetaNotes = z.object({
+  page: zResponsePaginationPage.optional(),
+  results: zResponsePaginationResults.optional()
+});
+const zCreateTransactionNoteRequest = z.object({
+  data: z.object({
+    type: z.literal("note"),
+    text: z.string().min(1).max(250).register(z.globalRegistry, {
+      description: "The note's text content."
+    })
+  })
+});
+const zUpdateTransactionNoteRequest = z.object({
+  data: z.object({
+    type: z.literal("note"),
+    text: z.string().min(1).max(250).register(z.globalRegistry, {
+      description: "The note's new text content, replacing the existing text."
+    })
+  })
+});
 const zUpdateOrderShippingGroupRequest = z.object({
   data: z.object({
     type: z.literal("shipping_group").optional(),
@@ -10514,6 +10553,9 @@ const zGetCustomerOrdersQuery = z.object({
   }).optional(),
   filter: z.string().register(z.globalRegistry, {
     description: "For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering), but you must go to a specific endpoint documentation to understand the attributes and operators an endpoint supports.\n"
+  }).optional(),
+  sort: z.string().register(z.globalRegistry, {
+    description: "The attribute to sort results by, ascending. Prefix the attribute name with `-` to sort descending, for example `sort=-created_at`. Supported attributes are `status`, `payment`, `shipping`, `name`, `email`, `customer_id`, `shipping_postcode`, `billing_postcode`, `created_at`, `updated_at` and `currency`. The default sort is `-created_at`. Only one attribute can be specified, otherwise the default is applied."
   }).optional()
 });
 const zGetCustomerOrdersResponse = zOrderCollectionResponse;
@@ -10618,6 +10660,90 @@ const zCancelATransactionPath = z.object({
   })
 });
 const zCancelATransactionResponse = zTransactionEntityResponse;
+const zGetTransactionNotesPath = z.object({
+  orderID: z.string().register(z.globalRegistry, {
+    description: "The ID of the order"
+  }),
+  transactionID: z.string().register(z.globalRegistry, {
+    description: "The ID of the transaction"
+  })
+});
+const zGetTransactionNotesQuery = z.object({
+  "page[limit]": z.int().gte(1).lte(100).register(z.globalRegistry, {
+    description: "The maximum number of records per page."
+  }).optional(),
+  "page[offset]": z.int().gte(0).lte(1e4).register(z.globalRegistry, {
+    description: "The number of records to offset the results by."
+  }).optional().default(0)
+});
+const zGetTransactionNotesResponse = z.object({
+  data: z.array(zTransactionNoteResponse).optional(),
+  links: zResponsePageLinks.optional(),
+  meta: zResponseMetaNotes.optional()
+}).register(z.globalRegistry, {
+  description: "A list of transaction notes"
+});
+const zCreateTransactionNoteBody = zCreateTransactionNoteRequest;
+const zCreateTransactionNotePath = z.object({
+  orderID: z.string().register(z.globalRegistry, {
+    description: "The ID of the order"
+  }),
+  transactionID: z.string().register(z.globalRegistry, {
+    description: "The ID of the transaction"
+  })
+});
+const zCreateTransactionNoteResponse = z.object({
+  data: zTransactionNoteResponse.optional()
+}).register(z.globalRegistry, {
+  description: "Note created"
+});
+const zDeleteTransactionNotePath = z.object({
+  orderID: z.string().register(z.globalRegistry, {
+    description: "The ID of the order"
+  }),
+  transactionID: z.string().register(z.globalRegistry, {
+    description: "The ID of the transaction"
+  }),
+  noteID: z.string().register(z.globalRegistry, {
+    description: "The ID of the note to delete"
+  })
+});
+const zDeleteTransactionNoteResponse = z.void().register(z.globalRegistry, {
+  description: "Successfully deleted the note"
+});
+const zGetTransactionNotePath = z.object({
+  orderID: z.string().register(z.globalRegistry, {
+    description: "The ID of the order"
+  }),
+  transactionID: z.string().register(z.globalRegistry, {
+    description: "The ID of the transaction"
+  }),
+  noteID: z.string().register(z.globalRegistry, {
+    description: "The ID of the note"
+  })
+});
+const zGetTransactionNoteResponse = z.object({
+  data: zTransactionNoteResponse.optional()
+}).register(z.globalRegistry, {
+  description: "Transaction note details"
+});
+const zUpdateTransactionNoteBody = zUpdateTransactionNoteRequest;
+const zUpdateTransactionNotePath = z.object({
+  orderID: z.string().register(z.globalRegistry, {
+    description: "The ID of the order"
+  }),
+  transactionID: z.string().register(z.globalRegistry, {
+    description: "The ID of the transaction"
+  }),
+  noteID: z.string().register(z.globalRegistry, {
+    description: "The ID of the note"
+  })
+});
+const zUpdateTransactionNoteResponse = z.object({
+  data: zTransactionNoteResponse.optional()
+}).register(z.globalRegistry, {
+  description: "Note updated successfully"
+});
 const zGetOrderShippingGroupsPath = z.object({
   orderID: z.string().register(z.globalRegistry, {
     description: "The ID of the order"
@@ -12270,6 +12396,10 @@ export {
   zCreateSubscriptionStatePath,
   zCreateSubscriptionStateResponse,
   zCreateSynonymSetRequest,
+  zCreateTransactionNoteBody,
+  zCreateTransactionNotePath,
+  zCreateTransactionNoteRequest,
+  zCreateTransactionNoteResponse,
   zCurrencies,
   zCurrency,
   zCurrencyIdentifier,
@@ -12336,6 +12466,8 @@ export {
   zDeleteRuleByIdResponse,
   zDeleteTaxItemFromCartItemComponentPath,
   zDeleteTaxItemFromCartItemComponentResponse,
+  zDeleteTransactionNotePath,
+  zDeleteTransactionNoteResponse,
   zDeleteV2AccountAddressPath,
   zDeleteV2AccountAddressResponse,
   zDeliveryEstimate,
@@ -12594,6 +12726,11 @@ export {
   zGetSubscriptionResponse,
   zGetSubscriptionStatePath,
   zGetSubscriptionStateResponse,
+  zGetTransactionNotePath,
+  zGetTransactionNoteResponse,
+  zGetTransactionNotesPath,
+  zGetTransactionNotesQuery,
+  zGetTransactionNotesResponse,
   zGetV2AccountAddressPath,
   zGetV2AccountAddressResponse,
   zGetV2AccountAddressesPath,
@@ -13014,6 +13151,7 @@ export {
   zResponseErrorResponse,
   zResponseMetaCarts,
   zResponseMetaCurrency,
+  zResponseMetaNotes,
   zResponseMetaOrders,
   zResponsePageLinks,
   zResponsePaginationPage,
@@ -13234,6 +13372,7 @@ export {
   zTransactionEntityResponseWritable,
   zTransactionListResponse,
   zTransactionListResponseWritable,
+  zTransactionNoteResponse,
   zTransactionResponse,
   zTransactionResponseAttributes,
   zTransactionResponseWritable,
@@ -13286,6 +13425,10 @@ export {
   zUpdateTaxItemFromCartItemComponentBody,
   zUpdateTaxItemFromCartItemComponentPath,
   zUpdateTaxItemFromCartItemComponentResponse,
+  zUpdateTransactionNoteBody,
+  zUpdateTransactionNotePath,
+  zUpdateTransactionNoteRequest,
+  zUpdateTransactionNoteResponse,
   zUserAuthenticationInfo,
   zUserAuthenticationInfoResponse,
   zUserAuthenticationInfoUpdateInput,