@epcc-sdk/sdks-shopper 0.10.1 → 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, {
@@ -2387,6 +2381,9 @@ const zShippingGroupResponse = z.object({
   }).optional(),
   address: zShippingAddress.optional(),
   delivery_estimate: zDeliveryEstimate.optional(),
+  anonymized: z.boolean().register(z.globalRegistry, {
+    description: "Specifies if the shipping group is anonymized. A shipping group is anonymized together with its order, which redacts the shipping group's address and tracking reference."
+  }).optional(),
   created_at: z.iso.datetime().optional(),
   updated_at: z.iso.datetime().optional(),
   relationships: z.object({
@@ -2680,14 +2677,11 @@ const zResponseMetaOrders = z.object({
 });
 const zOrdersAddressData = z.object({
   type: z.string().register(z.globalRegistry, {
-    description: 'The type of the resource. You must use "order".'
+    description: "The type of the resource. You must use `order`."
   }),
   order_number: z.string().register(z.globalRegistry, {
     description: "Specifies a user-managed, optional field used as an alternative to the existing order_id. If provided, the order-number will be sent to Authorize.net instead of the order_id, and will appear as the invoice number in Authorize.net transactions."
   }).optional(),
-  external_ref: z.string().register(z.globalRegistry, {
-    description: "Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system."
-  }).optional(),
   shipping_address: z.object({
     first_name: z.string().register(z.globalRegistry, {
       description: "Specifies the first name of the address holder."
@@ -2731,33 +2725,34 @@ const zOrdersAddressData = z.object({
   })
 });
 const zOrdersCancelData = z.object({
-  status: z.string().register(z.globalRegistry, {
-    description: "The status of the order. You can only update the status to `cancelled`."
-  }),
   type: z.string().register(z.globalRegistry, {
-    description: "The type of the resource. You must use order."
+    description: "The type of the resource. You must use `order`."
   }),
-  external_ref: z.string().register(z.globalRegistry, {
-    description: "Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system."
-  }).optional()
+  status: z.string().register(z.globalRegistry, {
+    description: "The status of the order. You can only update the status to `cancelled`."
+  })
 });
 const zOrdersFulfilledData = z.object({
-  shipping: z.string().register(z.globalRegistry, {
-    description: "The shipping status of the order. You can only update the shipping status to `fulfilled`."
-  }),
   type: z.string().register(z.globalRegistry, {
-    description: "The type of the resource. You must use order."
+    description: "The type of the resource. You must use `order`."
   }),
-  external_ref: z.string().register(z.globalRegistry, {
-    description: "Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system."
-  }).optional()
+  shipping: z.string().register(z.globalRegistry, {
+    description: "The shipping status of the order. You can only update the shipping status to `fulfilled`."
+  })
 });
 const zOrdersUpdateRequest = z.object({
-  data: z.union([zOrdersAddressData, zOrdersCancelData, zOrdersFulfilledData]).optional()
+  data: z.intersection(
+    z.union([zOrdersAddressData, zOrdersCancelData, zOrdersFulfilledData]),
+    z.object({
+      external_ref: z.string().register(z.globalRegistry, {
+        description: "Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system."
+      }).optional()
+    })
+  ).optional()
 });
 const zOrdersAnonymizeData = z.object({
-  order_ids: z.array(z.string()).register(z.globalRegistry, {
-    description: "The unique identifiers of the orders to be anonymized. You can anonymize multiple orders at the same time."
+  order_ids: z.array(z.string()).min(1).max(25).register(z.globalRegistry, {
+    description: "The unique identifiers of the orders to be anonymized. You can anonymize up to 25 orders in one request; split larger sets across requests."
   }).optional()
 });
 const zOrdersAnonymizeRequest = z.object({
@@ -2971,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(),
@@ -3212,6 +3252,52 @@ const zCartItemResponse = z.object({
   }).readonly().optional(),
   custom_attributes: zCustomAttributes.readonly().optional()
 });
+const zCartItemListResponse = z.object({
+  data: z.array(zCartItemResponse),
+  included: z.object({
+    custom_discounts: z.array(zCustomDiscountResponse).optional(),
+    promotions: z.array(
+      z.object({
+        automatic: z.boolean().optional(),
+        description: z.string().optional(),
+        end: z.iso.datetime().optional(),
+        id: z.uuid().optional(),
+        name: z.string().optional(),
+        promotion_type: z.string().optional(),
+        promotion_source: z.string().register(z.globalRegistry, {
+          description: "The source of the promotion"
+        }).optional(),
+        start: z.iso.datetime().optional(),
+        type: z.literal("promotion").optional()
+      })
+    ).optional(),
+    tax_items: z.array(zTaxItemResponse).register(z.globalRegistry, {
+      description: "Array of tax items included in the response."
+    }).optional()
+  }).register(z.globalRegistry, {
+    description: "Related objects that are included in the response."
+  }).optional(),
+  meta: z.object({
+    display_price: z.object({
+      with_tax: zFormattedPriceData.optional(),
+      without_tax: zFormattedPriceData.optional(),
+      tax: zFormattedPriceData.optional(),
+      discount: zFormattedPriceData.optional(),
+      without_discount: zFormattedPriceData.optional(),
+      shipping: zFormattedPriceData.optional(),
+      shipping_discount: zFormattedPriceData.optional(),
+      authorized: zFormattedPriceData.optional(),
+      balance_owing: zFormattedPriceData.optional(),
+      paid: zFormattedPriceData.optional()
+    }).optional(),
+    timestamps: zCartTimestamps.optional()
+  }).register(z.globalRegistry, {
+    description: "Additional meta information about the cart items collection."
+  }).optional(),
+  errors: z.array(zResponseErrorItem).register(z.globalRegistry, {
+    description: "Array of error objects, if any errors occurred."
+  }).optional()
+});
 const zCartItemCollectionResponse = z.object({
   data: z.array(zCartItemResponse),
   included: z.object({
@@ -7897,6 +7983,52 @@ const zTaxItemResponseWritable = z.object({
     description: "The tax amount in the smallest currency unit."
   }).optional()
 });
+const zCartItemListResponseWritable = z.object({
+  data: z.array(zCartItemResponseWritable),
+  included: z.object({
+    custom_discounts: z.array(zCustomDiscountResponse).optional(),
+    promotions: z.array(
+      z.object({
+        automatic: z.boolean().optional(),
+        description: z.string().optional(),
+        end: z.iso.datetime().optional(),
+        id: z.uuid().optional(),
+        name: z.string().optional(),
+        promotion_type: z.string().optional(),
+        promotion_source: z.string().register(z.globalRegistry, {
+          description: "The source of the promotion"
+        }).optional(),
+        start: z.iso.datetime().optional(),
+        type: z.literal("promotion").optional()
+      })
+    ).optional(),
+    tax_items: z.array(zTaxItemResponseWritable).register(z.globalRegistry, {
+      description: "Array of tax items included in the response."
+    }).optional()
+  }).register(z.globalRegistry, {
+    description: "Related objects that are included in the response."
+  }).optional(),
+  meta: z.object({
+    display_price: z.object({
+      with_tax: zFormattedPriceData.optional(),
+      without_tax: zFormattedPriceData.optional(),
+      tax: zFormattedPriceData.optional(),
+      discount: zFormattedPriceData.optional(),
+      without_discount: zFormattedPriceData.optional(),
+      shipping: zFormattedPriceData.optional(),
+      shipping_discount: zFormattedPriceData.optional(),
+      authorized: zFormattedPriceData.optional(),
+      balance_owing: zFormattedPriceData.optional(),
+      paid: zFormattedPriceData.optional()
+    }).optional(),
+    timestamps: zCartTimestamps.optional()
+  }).register(z.globalRegistry, {
+    description: "Additional meta information about the cart items collection."
+  }).optional(),
+  errors: z.array(zResponseErrorItem).register(z.globalRegistry, {
+    description: "Array of error objects, if any errors occurred."
+  }).optional()
+});
 const zCartItemCollectionResponseWritable = z.object({
   data: z.array(zCartItemResponseWritable),
   included: z.object({
@@ -10421,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;
@@ -10525,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"
@@ -12051,6 +12270,8 @@ export {
   zCartItemCollectionResponse,
   zCartItemCollectionResponseWritable,
   zCartItemFormattedPriceData,
+  zCartItemListResponse,
+  zCartItemListResponseWritable,
   zCartItemObject,
   zCartItemObjectData,
   zCartItemObjectRequest,
@@ -12175,6 +12396,10 @@ export {
   zCreateSubscriptionStatePath,
   zCreateSubscriptionStateResponse,
   zCreateSynonymSetRequest,
+  zCreateTransactionNoteBody,
+  zCreateTransactionNotePath,
+  zCreateTransactionNoteRequest,
+  zCreateTransactionNoteResponse,
   zCurrencies,
   zCurrency,
   zCurrencyIdentifier,
@@ -12241,6 +12466,8 @@ export {
   zDeleteRuleByIdResponse,
   zDeleteTaxItemFromCartItemComponentPath,
   zDeleteTaxItemFromCartItemComponentResponse,
+  zDeleteTransactionNotePath,
+  zDeleteTransactionNoteResponse,
   zDeleteV2AccountAddressPath,
   zDeleteV2AccountAddressResponse,
   zDeliveryEstimate,
@@ -12499,6 +12726,11 @@ export {
   zGetSubscriptionResponse,
   zGetSubscriptionStatePath,
   zGetSubscriptionStateResponse,
+  zGetTransactionNotePath,
+  zGetTransactionNoteResponse,
+  zGetTransactionNotesPath,
+  zGetTransactionNotesQuery,
+  zGetTransactionNotesResponse,
   zGetV2AccountAddressPath,
   zGetV2AccountAddressResponse,
   zGetV2AccountAddressesPath,
@@ -12919,6 +13151,7 @@ export {
   zResponseErrorResponse,
   zResponseMetaCarts,
   zResponseMetaCurrency,
+  zResponseMetaNotes,
   zResponseMetaOrders,
   zResponsePageLinks,
   zResponsePaginationPage,
@@ -13139,6 +13372,7 @@ export {
   zTransactionEntityResponseWritable,
   zTransactionListResponse,
   zTransactionListResponseWritable,
+  zTransactionNoteResponse,
   zTransactionResponse,
   zTransactionResponseAttributes,
   zTransactionResponseWritable,
@@ -13191,6 +13425,10 @@ export {
   zUpdateTaxItemFromCartItemComponentBody,
   zUpdateTaxItemFromCartItemComponentPath,
   zUpdateTaxItemFromCartItemComponentResponse,
+  zUpdateTransactionNoteBody,
+  zUpdateTransactionNotePath,
+  zUpdateTransactionNoteRequest,
+  zUpdateTransactionNoteResponse,
   zUserAuthenticationInfo,
   zUserAuthenticationInfoResponse,
   zUserAuthenticationInfoUpdateInput,