@zenglobal/api-client 1.0.0

package/dist/client/sdk.gen.d.ts

@@ -0,0 +1,1544 @@
+import type { Client, Options as Options2, TDataShape } from './client/index.js';
+import type { EmailValidationValidateEmailData, EmailValidationValidateEmailErrors, EmailValidationValidateEmailResponses, EventsProcessEventData, EventsProcessEventErrors, EventsProcessEventResponses, GatewayGetGatewayConfigData, GatewayGetGatewayConfigErrors, GatewayGetGatewayConfigResponses, InventoryBulkInventoryData, InventoryBulkInventoryErrors, InventoryBulkInventoryResponses, InventoryGetDepartmentItemsData, InventoryGetDepartmentItemsErrors, InventoryGetDepartmentItemsResponses, InventoryGetItemData, InventoryGetItemErrors, InventoryGetItemResponses, InventorySearchInventoryData, InventorySearchInventoryErrors, InventorySearchInventoryResponses, JackpotsListData, JackpotsListErrors, JackpotsListResponses, JackpotsListWinnersData, JackpotsListWinnersErrors, JackpotsListWinnersResponses, ListsCreateListData, ListsCreateListErrors, ListsCreateListResponses, ListsCreateListWithCardData, ListsCreateListWithCardErrors, ListsCreateListWithCardResponses, ListsDeleteListData, ListsDeleteListErrors, ListsDeleteListResponses, ListsGetAllListsData, ListsGetAllListsErrors, ListsGetAllListsResponses, ListsGetCardListsData, ListsGetCardListsErrors, ListsGetCardListsResponses, ListsRemoveCardFromListData, ListsRemoveCardFromListErrors, ListsRemoveCardFromListResponses, ListsUpdateListData, ListsUpdateListErrors, ListsUpdateListResponses, ListsUpdateListWithCardData, ListsUpdateListWithCardErrors, ListsUpdateListWithCardResponses, LoyaltyActivateCardData, LoyaltyActivateCardErrors, LoyaltyActivateCardResponses, LoyaltyCreateCardData, LoyaltyCreateCardErrors, LoyaltyCreateCardResponses, LoyaltyCreatePointsTransactionData, LoyaltyCreatePointsTransactionErrors, LoyaltyCreatePointsTransactionResponses, LoyaltyDeactivateCardData, LoyaltyDeactivateCardErrors, LoyaltyDeactivateCardResponses, LoyaltyGenerateShortCodeData, LoyaltyGenerateShortCodeErrors, LoyaltyGenerateShortCodeResponses, LoyaltyGetAllowedFunctionsData, LoyaltyGetAllowedFunctionsErrors, LoyaltyGetAllowedFunctionsResponses, LoyaltyGetCardData, LoyaltyGetCardErrors, LoyaltyGetCardImageData, LoyaltyGetCardImageErrors, LoyaltyGetCardImageResponses, LoyaltyGetCardRecoveryData, LoyaltyGetCardRecoveryErrors, LoyaltyGetCardRecoveryResponses, LoyaltyGetCardResponses, LoyaltyGetCardTypesData, LoyaltyGetCardTypesErrors, LoyaltyGetCardTypesResponses, LoyaltyGetCardWithOffersData, LoyaltyGetCardWithOffersErrors, LoyaltyGetCardWithOffersResponses, LoyaltyGetCoffeeCardStatsData, LoyaltyGetCoffeeCardStatsErrors, LoyaltyGetCoffeeCardStatsResponses, LoyaltyGetCompulsoryFieldsData, LoyaltyGetCompulsoryFieldsErrors, LoyaltyGetCompulsoryFieldsResponses, LoyaltyGetGroupsData, LoyaltyGetGroupsErrors, LoyaltyGetGroupsResponses, LoyaltyGetMemberGroupsData, LoyaltyGetMemberGroupsErrors, LoyaltyGetMemberGroupsResponses, LoyaltyGetSettingsData, LoyaltyGetSettingsErrors, LoyaltyGetSettingsResponses, LoyaltyGetSyncListByCommandData, LoyaltyGetSyncListByCommandErrors, LoyaltyGetSyncListByCommandResponses, LoyaltyGetSyncListData, LoyaltyGetSyncListErrors, LoyaltyGetSyncListResponses, LoyaltyGetWalletLinkData, LoyaltyGetWalletLinkErrors, LoyaltyGetWalletLinkResponses, LoyaltyRenewCardData, LoyaltyRenewCardErrors, LoyaltyRenewCardResponses, LoyaltySearchCardsData, LoyaltySearchCardsErrors, LoyaltySearchCardsResponses, LoyaltyUpdateAddressData, LoyaltyUpdateAddressErrors, LoyaltyUpdateAddressResponses, LoyaltyUpdateBillingAddressData, LoyaltyUpdateBillingAddressErrors, LoyaltyUpdateBillingAddressResponses, LoyaltyUpdateCardData, LoyaltyUpdateCardErrors, LoyaltyUpdateCardPinData, LoyaltyUpdateCardPinErrors, LoyaltyUpdateCardPinResponses, LoyaltyUpdateCardResponses, LoyaltyUpdateCardTokenData, LoyaltyUpdateCardTokenErrors, LoyaltyUpdateCardTokenResponses, LoyaltyUpdateExternalUserIdData, LoyaltyUpdateExternalUserIdErrors, LoyaltyUpdateExternalUserIdResponses, LoyaltyUpdateGroupsData, LoyaltyUpdateGroupsErrors, LoyaltyUpdateGroupsResponses, LoyaltyUpdateMemberGroupsData, LoyaltyUpdateMemberGroupsErrors, LoyaltyUpdateMemberGroupsResponses, LoyaltyUpdatePointsData, LoyaltyUpdatePointsErrors, LoyaltyUpdatePointsResponses, LoyaltyUpdateShippingAddressData, LoyaltyUpdateShippingAddressErrors, LoyaltyUpdateShippingAddressResponses, LoyaltyUpdateSyncListData, LoyaltyUpdateSyncListErrors, LoyaltyUpdateSyncListResponses, LoyaltyVerifyCardData, LoyaltyVerifyCardErrors, LoyaltyVerifyCardResponses, MembershipActivateMemberData, MembershipActivateMemberErrors, MembershipActivateMemberResponses, MembershipCancelMemberData, MembershipCancelMemberErrors, MembershipCancelMemberResponses, MembershipCreateMemberData, MembershipCreateMemberErrors, MembershipCreateMemberResponses, MembershipGetAllowedFunctionsData, MembershipGetAllowedFunctionsErrors, MembershipGetAllowedFunctionsResponses, MembershipGetMemberByCardData, MembershipGetMemberByCardErrors, MembershipGetMemberByCardResponses, MembershipGetMemberData, MembershipGetMemberErrors, MembershipGetMemberGroupsAltData, MembershipGetMemberGroupsAltErrors, MembershipGetMemberGroupsAltResponses, MembershipGetMemberGroupsData, MembershipGetMemberGroupsErrors, MembershipGetMemberGroupsResponses, MembershipGetMemberResponses, MembershipReplaceCreditCardData, MembershipReplaceCreditCardErrors, MembershipReplaceCreditCardResponses, MembershipSearchMembersData, MembershipSearchMembersErrors, MembershipSearchMembersResponses, MembershipSuspendMemberData, MembershipSuspendMemberErrors, MembershipSuspendMemberResponses, MembershipUpdateBillingAddressData, MembershipUpdateBillingAddressErrors, MembershipUpdateBillingAddressResponses, MembershipUpdateMemberAddressData, MembershipUpdateMemberAddressErrors, MembershipUpdateMemberAddressResponses, MembershipUpdateMemberByCardData, MembershipUpdateMemberByCardErrors, MembershipUpdateMemberByCardResponses, MembershipUpdateMemberData, MembershipUpdateMemberErrors, MembershipUpdateMemberResponses, MembershipUpdateMemberTokenData, MembershipUpdateMemberTokenErrors, MembershipUpdateMemberTokenResponses, MembershipUpdateShippingAddressData, MembershipUpdateShippingAddressErrors, MembershipUpdateShippingAddressResponses, OfferCreateData, OfferCreateErrors, OfferCreateResponses, OfferDeleteData, OfferDeleteErrors, OfferDeleteResponses, OfferGetCoffeeCardStatsData, OfferGetCoffeeCardStatsErrors, OfferGetCoffeeCardStatsResponses, OfferListData, OfferListErrors, OfferListResponses, OfferRedemptionsListData, OfferRedemptionsListErrors, OfferRedemptionsListResponses, OfferUpdateData, OfferUpdateErrors, OfferUpdateResponses, OrderCreateOrderData, OrderCreateOrderErrors, OrderCreateOrderResponses, OrderDeleteOrderData, OrderDeleteOrderErrors, OrderDeleteOrderResponses, OrderGetAllowedFunctionsData, OrderGetAllowedFunctionsErrors, OrderGetAllowedFunctionsResponses, OrderGetOrderData, OrderGetOrderErrors, OrderGetOrderResponses, OrderSearchOrdersData, OrderSearchOrdersErrors, OrderSearchOrdersResponses, PingPingData, PingPingErrors, PingPingResponses, SitesGetSitesData, SitesGetSitesErrors, SitesGetSitesResponses, SmsGetSentSmsListData, SmsGetSentSmsListErrors, SmsGetSentSmsListResponses, SmsGetSmsBalanceData, SmsGetSmsBalanceErrors, SmsGetSmsBalanceResponses, SmsGetSmsRepliesData, SmsGetSmsRepliesErrors, SmsGetSmsRepliesResponses, SmsGetSmsResponsesData, SmsGetSmsResponsesErrors, SmsGetSmsResponsesResponses, SmsSendSmsData, SmsSendSmsErrors, SmsSendSmsResponses, StripeGetStripeConfigData, StripeGetStripeConfigErrors, StripeGetStripeConfigResponses, TransactionCreateTransactionData, TransactionCreateTransactionErrors, TransactionCreateTransactionResponses, TransactionGetTransactionData, TransactionGetTransactionErrors, TransactionGetTransactionResponses, VersionGetVersionData, VersionGetVersionErrors, VersionGetVersionResponses, VoucherCreateVoucherData, VoucherCreateVoucherErrors, VoucherCreateVoucherResponses, VoucherDeleteVoucherData, VoucherDeleteVoucherErrors, VoucherDeleteVoucherResponses, VoucherEnquireVoucherData, VoucherEnquireVoucherErrors, VoucherEnquireVoucherResponses, VoucherGetVoucherImageData, VoucherGetVoucherImageErrors, VoucherGetVoucherImageResponses, VoucherGetVoucherTypeData, VoucherGetVoucherTypeErrors, VoucherGetVoucherTypeResponses, VoucherRechargeVoucherData, VoucherRechargeVoucherErrors, VoucherRechargeVoucherResponses, VoucherRedeemVoucherData, VoucherRedeemVoucherErrors, VoucherRedeemVoucherResponses, VoucherReleaseVoucherData, VoucherReleaseVoucherErrors, VoucherReleaseVoucherResponses, VoucherReserveVoucherData, VoucherReserveVoucherErrors, VoucherReserveVoucherResponses, VoucherSearchVouchersData, VoucherSearchVouchersErrors, VoucherSearchVouchersFlatData, VoucherSearchVouchersFlatErrors, VoucherSearchVouchersFlatResponses, VoucherSearchVouchersResponses } from './types.gen.js';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
+};
+/**
+ * Send SMS
+ *
+ * Send an SMS message.
+ *
+ * The request body must be wrapped in an `sms` key: `{"sms": {...}}`.
+ *
+ * **Required scope:** `SEND_SMS`
+ *
+ * **Error codes:**
+ * - `8` (Missing Data) - Body Missing
+ * - `45` (Invalid JSON) - Invalid JSON body
+ * - `51` (SMS Not Enabled) - SMS sending not enabled for this chain
+ * - `32` (Balance Zero) - No SMS units remaining
+ * - `33` (Length Exceeded) - Message exceeds maximum length
+ * - `7` (Invalid Mobile) - Mobile number invalid or wrong length
+ * - `23` (Missing Mobile) - Mobile number not provided
+ * - `50` (SMS Error) - SMS sending failed
+ */
+export declare const smsSendSms: <ThrowOnError extends boolean = false>(options: Options<SmsSendSmsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<SmsSendSmsResponses, SmsSendSmsErrors, ThrowOnError, "fields">;
+/**
+ * Get SMS Balance
+ *
+ * Get SMS balance and usage information for a site.
+ *
+ * Returns the remaining SMS balance, unit cost, and total units sent.
+ *
+ * **Required scope:** `READ_SMS`
+ *
+ * **Error codes:**
+ * - `8` (Missing Data) - Invalid Site
+ */
+export declare const smsGetSmsBalance: <ThrowOnError extends boolean = false>(options: Options<SmsGetSmsBalanceData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<SmsGetSmsBalanceResponses, SmsGetSmsBalanceErrors, ThrowOnError, "fields">;
+/**
+ * Get SMS Replies
+ *
+ * Get SMS replies for a site.
+ *
+ * **Note:** This endpoint is currently a stub and always returns an empty JSON object.
+ *
+ * **Required scope:** `READ_SMS`
+ *
+ * **Error codes:**
+ * - `4` (Not Found) - missing search string, missing from date
+ * - `8` (Missing Data) - Invalid Site
+ */
+export declare const smsGetSmsReplies: <ThrowOnError extends boolean = false>(options: Options<SmsGetSmsRepliesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<SmsGetSmsRepliesResponses, SmsGetSmsRepliesErrors, ThrowOnError, "fields">;
+/**
+ * Get SMS Responses
+ *
+ * Get SMS response list for a site.
+ *
+ * **Note:** This endpoint is currently a stub and always returns an empty JSON object.
+ * Both URL paths `/SMS/response/{site}` and `/SMS/reponse/{site}` (legacy typo) are accepted.
+ *
+ * **Required scope:** `READ_SMS`
+ *
+ * **Error codes:**
+ * - `4` (Not Found) - missing search string, missing from date, missing to date, missing mobile
+ * - `8` (Missing Data) - Invalid Site
+ */
+export declare const smsGetSmsResponses: <ThrowOnError extends boolean = false>(options: Options<SmsGetSmsResponsesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<SmsGetSmsResponsesResponses, SmsGetSmsResponsesErrors, ThrowOnError, "fields">;
+/**
+ * Get Sent SMS List
+ *
+ * Get list of SMS messages sent to a mobile number within a date range.
+ *
+ * Both `from` and `to` query parameters are required. The mobile number
+ * is passed as a path parameter. Numbers starting with '04' are automatically
+ * converted to international format (614...).
+ *
+ * **Required scope:** `READ_SMS`
+ *
+ * **Error codes:**
+ * - `4` (Not Found) - missing search string, missing from date, missing to date, missing mobile
+ */
+export declare const smsGetSentSmsList: <ThrowOnError extends boolean = false>(options: Options<SmsGetSentSmsListData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<SmsGetSentSmsListResponses, SmsGetSentSmsListErrors, ThrowOnError, "fields">;
+/**
+ * Process Event
+ *
+ * Receives and processes event webhooks. The request body must be valid JSON
+ * containing the required `name`, `id`, and `payload` fields.
+ *
+ * Currently supported event names:
+ * * `order/delivered` - Order delivery confirmation
+ * * `order/rejected` - Order rejection notification
+ *
+ * **Required scope:** `write:events`
+ *
+ * **Error codes:**
+ * * `1` (Invalid Access Key) - Missing or invalid API key, or missing `write:events` scope
+ * * `9` (Request Rejected) - Request payload does not contain required fields, unknown event type, or company is disabled
+ */
+export declare const eventsProcessEvent: <ThrowOnError extends boolean = false>(options: Options<EventsProcessEventData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<EventsProcessEventResponses, EventsProcessEventErrors, ThrowOnError, "fields">;
+/**
+ * Get Gateway Configuration
+ *
+ * Get payment gateway configurations for all providers.
+ *
+ * Returns configuration for Stripe, eWay, and PayPal gateways
+ * including API keys, currency settings, and sandbox status.
+ *
+ * Required scope: `read:gateway`
+ */
+export declare const gatewayGetGatewayConfig: <ThrowOnError extends boolean = false>(options?: Options<GatewayGetGatewayConfigData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<GatewayGetGatewayConfigResponses, GatewayGetGatewayConfigErrors, ThrowOnError, "fields">;
+/**
+ * Get Department Items
+ *
+ * Get all items in a specific department.
+ *
+ * Returns inventory items grouped by department. The response is returned
+ * directly via `prepareJson()` without `result`/`errormessage` wrapper fields.
+ *
+ * **Required scope:** `read:inventory`
+ *
+ * **Error codes:**
+ * - `4` (Not Found) - No items found in the department
+ * - `8` (Missing Data) - Invalid site
+ */
+export declare const inventoryGetDepartmentItems: <ThrowOnError extends boolean = false>(options: Options<InventoryGetDepartmentItemsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<InventoryGetDepartmentItemsResponses, InventoryGetDepartmentItemsErrors, ThrowOnError, "fields">;
+/**
+ * Get Item Details
+ *
+ * Get specific item details by item number.
+ *
+ * Performs an exact item number lookup and returns results grouped by department,
+ * using the same response structure as the search endpoint. The response is returned
+ * directly via `prepareJson()` without `result`/`errormessage` wrapper fields.
+ *
+ * **Required scope:** `read:inventory`
+ *
+ * **Error codes:**
+ * - `4` (Not Found) - Item not found
+ * - `8` (Missing Data) - Invalid site
+ */
+export declare const inventoryGetItem: <ThrowOnError extends boolean = false>(options: Options<InventoryGetItemData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<InventoryGetItemResponses, InventoryGetItemErrors, ThrowOnError, "fields">;
+/**
+ * Search Inventory
+ *
+ * Search inventory items by various criteria.
+ *
+ * The search value is taken from the raw query string (everything after the `?`),
+ * not from a named query parameter. For example:
+ * `GET /inventory/{siteCode}/search/description?Bombay Gin`
+ *
+ * The response groups results by department. The response is returned
+ * directly via `prepareJson()` without `result`/`errormessage` wrapper fields.
+ *
+ * **Required scope:** `read:inventory`
+ *
+ * **Available search commands:**
+ * - `number` - Search by item number (partial match)
+ * - `description` - Search by item description (case-insensitive partial match)
+ * - `supplier` - Search by product owner/supplier (partial match)
+ * - `colour` - Search by colour attribute (partial match)
+ * - `style` - Search by style attribute (partial match)
+ * - `size` - Search by size attribute (partial match)
+ * - `barcode` - Search by barcode (partial match)
+ *
+ * **Error codes:**
+ * - `4` (Not Found) - No items match the search
+ * - `8` (Missing Data) - Invalid site
+ * - `9` (Request Rejected) - Unknown search command
+ */
+export declare const inventorySearchInventory: <ThrowOnError extends boolean = false>(options: Options<InventorySearchInventoryData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<InventorySearchInventoryResponses, InventorySearchInventoryErrors, ThrowOnError, "fields">;
+/**
+ * Bulk update Inventory
+ *
+ * This endpoint is designed to bulk process a series of inventory changes for a given location.
+ *
+ * > info
+ * > All process will happen asynchronously and updates are processed in the order they arrive.
+ *
+ * **Required scope:** `write:inventory`
+ *
+ * Supports `Content-Encoding: gzip` for compressed request bodies.
+ *
+ * **Error codes:**
+ * - `0` (OK) - Bulk update submitted successfully
+ * - `8` (Missing Data) - Request body is empty
+ * - `9` (Request Rejected) - Failed to parse JSON or validation errors
+ */
+export declare const inventoryBulkInventory: <ThrowOnError extends boolean = false>(options: Options<InventoryBulkInventoryData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<InventoryBulkInventoryResponses, InventoryBulkInventoryErrors, ThrowOnError, "fields">;
+/**
+ * List Jackpots
+ *
+ * Returns active jackpots with optional date range filtering and pagination.
+ *
+ * **Required scope:** `read:jackpots`
+ *
+ * **Error codes:**
+ * * `1` (Invalid Access Key) - Missing or invalid API key, or missing `read:jackpots` scope
+ * * `3` (Invalid Function) - Request method is not GET
+ * * `9` (Request Rejected) - Company is disabled
+ */
+export declare const jackpotsList: <ThrowOnError extends boolean = false>(options?: Options<JackpotsListData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<JackpotsListResponses, JackpotsListErrors, ThrowOnError, "fields">;
+/**
+ * List Jackpot Winners
+ *
+ * Returns jackpot winners with optional date range and site filtering, with pagination.
+ *
+ * **Required scope:** `read:jackpots`
+ *
+ * **Error codes:**
+ * * `1` (Invalid Access Key) - Missing or invalid API key, or missing `read:jackpots` scope
+ * * `3` (Invalid Function) - Request method is not GET
+ * * `9` (Request Rejected) - Company is disabled
+ */
+export declare const jackpotsListWinners: <ThrowOnError extends boolean = false>(options?: Options<JackpotsListWinnersData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<JackpotsListWinnersResponses, JackpotsListWinnersErrors, ThrowOnError, "fields">;
+/**
+ * Delete List
+ *
+ * Delete an entire list definition.
+ *
+ * Deletes the list definition entirely. Requires the `allowdelete` flag to be set to true
+ * in the request body. The list must exist.
+ *
+ * **Required scope:** `delete:lists`
+ *
+ * **Error codes:**
+ * * `1` (Invalid Access Key) - Missing or invalid API key, or missing `delete:lists` scope
+ * * `8` (Missing Data) - Request body is empty
+ * * `9` (Request Rejected) - List does not exist, id not defined, id references a non-list profile, or allowdelete flag is missing
+ * * `11` (Database Error) - Failed to delete the list
+ * * `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const listsDeleteList: <ThrowOnError extends boolean = false>(options: Options<ListsDeleteListData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListsDeleteListResponses, ListsDeleteListErrors, ThrowOnError, "fields">;
+/**
+ * Get All Lists
+ *
+ * Get all list definitions for the chain.
+ *
+ * Returns all communication profile list definitions (PROFILEHEADER rows where ISLIST='T').
+ * Each list includes its id, description, enabled status, comments, and card count.
+ * The response `lists` object contains list definitions keyed by id, plus a `card` field
+ * set to an empty string.
+ *
+ * **Required scope:** `read:lists`
+ *
+ * **Error codes:**
+ * * `1` (Invalid Access Key) - Missing or invalid API key, or missing `read:lists` scope
+ */
+export declare const listsGetAllLists: <ThrowOnError extends boolean = false>(options?: Options<ListsGetAllListsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListsGetAllListsResponses, ListsGetAllListsErrors, ThrowOnError, "fields">;
+/**
+ * Create List
+ *
+ * Create a new list definition.
+ *
+ * Creates a new communication profile list. The request body must be wrapped
+ * in a `lists` key. If an `id` is provided and a list with that id already exists,
+ * returns a request rejected error.
+ *
+ * **Required scope:** `write:lists`
+ *
+ * **Error codes:**
+ * * `1` (Invalid Access Key) - Missing or invalid API key, or missing `write:lists` scope
+ * * `8` (Missing Data) - Request body is empty
+ * * `9` (Request Rejected) - List id already exists, or id references a non-list profile
+ * * `11` (Database Error) - Failed to create the list
+ * * `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const listsCreateList: <ThrowOnError extends boolean = false>(options: Options<ListsCreateListData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListsCreateListResponses, ListsCreateListErrors, ThrowOnError, "fields">;
+/**
+ * Update List
+ *
+ * Update an existing list definition.
+ *
+ * Updates the description, comments, and enabled status of an existing list.
+ * The list must already exist. The request body must be wrapped in a `lists` key.
+ *
+ * **Required scope:** `write:lists`
+ *
+ * **Error codes:**
+ * * `1` (Invalid Access Key) - Missing or invalid API key, or missing `write:lists` scope
+ * * `8` (Missing Data) - Request body is empty
+ * * `9` (Request Rejected) - List does not exist, id not defined, or id references a non-list profile
+ * * `11` (Database Error) - Failed to update the list
+ * * `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const listsUpdateList: <ThrowOnError extends boolean = false>(options: Options<ListsUpdateListData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListsUpdateListResponses, ListsUpdateListErrors, ThrowOnError, "fields">;
+/**
+ * Remove Card from List
+ *
+ * Remove a card from a list.
+ *
+ * Removes the specified card's membership from the list. The list must exist
+ * and the card must exist. Does not delete the list definition itself.
+ *
+ * **Required scope:** `delete:lists`
+ *
+ * **Error codes:**
+ * * `1` (Invalid Access Key) - Missing or invalid API key, or missing `delete:lists` scope
+ * * `4` (Not Found) - Card does not exist
+ * * `8` (Missing Data) - Request body is empty
+ * * `9` (Request Rejected) - List does not exist, id not defined, or id references a non-list profile
+ * * `11` (Database Error) - Failed to remove the card from the list
+ * * `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const listsRemoveCardFromList: <ThrowOnError extends boolean = false>(options: Options<ListsRemoveCardFromListData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListsRemoveCardFromListResponses, ListsRemoveCardFromListErrors, ThrowOnError, "fields">;
+/**
+ * Get Lists for Card
+ *
+ * Get list definitions that a specific card belongs to.
+ *
+ * Returns only the list definitions that the specified card is a member of.
+ * If the card does not exist, returns a not found error.
+ * The response `lists` object contains list definitions keyed by id, plus a `card` field
+ * with the queried card number.
+ *
+ * **Required scope:** `read:lists`
+ *
+ * **Error codes:**
+ * * `1` (Invalid Access Key) - Missing or invalid API key, or missing `read:lists` scope
+ * * `4` (Not Found) - Card does not exist
+ */
+export declare const listsGetCardLists: <ThrowOnError extends boolean = false>(options: Options<ListsGetCardListsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListsGetCardListsResponses, ListsGetCardListsErrors, ThrowOnError, "fields">;
+/**
+ * Create List and Add Card
+ *
+ * Create a list definition and add a card to it.
+ *
+ * Creates or references a list and adds the specified card to it.
+ * If `id` is set and references an existing list, the card is added to that list.
+ * If the card does not exist, returns a not found error.
+ *
+ * **Required scope:** `write:lists`
+ *
+ * **Error codes:**
+ * * `1` (Invalid Access Key) - Missing or invalid API key, or missing `write:lists` scope
+ * * `4` (Not Found) - Card does not exist
+ * * `8` (Missing Data) - Request body is empty
+ * * `9` (Request Rejected) - Id references a non-list profile
+ * * `11` (Database Error) - Failed to create the list or add card
+ * * `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const listsCreateListWithCard: <ThrowOnError extends boolean = false>(options: Options<ListsCreateListWithCardData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListsCreateListWithCardResponses, ListsCreateListWithCardErrors, ThrowOnError, "fields">;
+/**
+ * Update List with Card
+ *
+ * Update a list definition and update a card's association.
+ *
+ * Updates the list definition and associates the card with the list.
+ * If the card does not exist, returns a not found error.
+ *
+ * **Required scope:** `write:lists`
+ *
+ * **Error codes:**
+ * * `1` (Invalid Access Key) - Missing or invalid API key, or missing `write:lists` scope
+ * * `4` (Not Found) - Card does not exist
+ * * `8` (Missing Data) - Request body is empty
+ * * `9` (Request Rejected) - List does not exist, id not defined, or id references a non-list profile
+ * * `11` (Database Error) - Failed to update the list or card association
+ * * `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const listsUpdateListWithCard: <ThrowOnError extends boolean = false>(options: Options<ListsUpdateListWithCardData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListsUpdateListWithCardResponses, ListsUpdateListWithCardErrors, ThrowOnError, "fields">;
+/**
+ * Get Allowed Functions
+ *
+ * Get list of allowed loyalty functions for the current API key.
+ * Returns an object keyed by feature name, each mapping to an array of allowed HTTP methods.
+ *
+ * **Required scope:** `READ_LOYALTY`
+ */
+export declare const loyaltyGetAllowedFunctions: <ThrowOnError extends boolean = false>(options?: Options<LoyaltyGetAllowedFunctionsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyGetAllowedFunctionsResponses, LoyaltyGetAllowedFunctionsErrors, ThrowOnError, "fields">;
+/**
+ * Create Card
+ *
+ * Create a new loyalty card. If no card number is provided, one is auto-generated.
+ * At minimum, an email or mobile number must be provided (unless `ispos` is true).
+ * Additional fields may be required based on the company's compulsory field settings
+ * (retrievable via GET /v1/loyalty/compulsory).
+ */
+export declare const loyaltyCreateCard: <ThrowOnError extends boolean = false>(options: Options<LoyaltyCreateCardData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyCreateCardResponses, LoyaltyCreateCardErrors, ThrowOnError, "fields">;
+/**
+ * Get Card Details
+ *
+ * Get comprehensive loyalty card information.
+ * Supports short codes (6-character alphanumeric codes) in place of card numbers.
+ * Response is returned as raw JSON without result/errormessage wrapper.
+ *
+ * Use `includeoffers` sub-path with a site code to include available offers and
+ * recently redeemed offers in the response.
+ *
+ * Use `format=compact` query parameter to return only essential fields.
+ *
+ * **Required scope:** `READ_LOYALTY`
+ *
+ * **Error codes:**
+ * - `4` (Not Found) - Card not found or invalid card length
+ */
+export declare const loyaltyGetCard: <ThrowOnError extends boolean = false>(options: Options<LoyaltyGetCardData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyGetCardResponses, LoyaltyGetCardErrors, ThrowOnError, "fields">;
+/**
+ * Update Card
+ *
+ * Update an existing loyalty card's details. The card number is provided in the URL path.
+ * Fields may be required based on the company's compulsory field settings
+ * (retrievable via GET /v1/loyalty/compulsory).
+ * Checks for duplicate email and mobile against other cards.
+ *
+ * **Required scope:** `WRITE_LOYALTY`
+ */
+export declare const loyaltyUpdateCard: <ThrowOnError extends boolean = false>(options: Options<LoyaltyUpdateCardData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyUpdateCardResponses, LoyaltyUpdateCardErrors, ThrowOnError, "fields">;
+/**
+ * Activate Card
+ *
+ * Activate a loyalty card. Sets PURGED to false and CARDACTIVE to true.
+ * No request body required.
+ *
+ * **Required scope:** `WRITE_LOYALTY`
+ */
+export declare const loyaltyActivateCard: <ThrowOnError extends boolean = false>(options: Options<LoyaltyActivateCardData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyActivateCardResponses, LoyaltyActivateCardErrors, ThrowOnError, "fields">;
+/**
+ * Update Address
+ *
+ * Update billing and/or shipping address for a loyalty card in a single call.
+ * At least one of billing, shipping, or deliveryinstruction must be provided.
+ *
+ * **Required scope:** `WRITE_LOYALTY`
+ */
+export declare const loyaltyUpdateAddress: <ThrowOnError extends boolean = false>(options: Options<LoyaltyUpdateAddressData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyUpdateAddressResponses, LoyaltyUpdateAddressErrors, ThrowOnError, "fields">;
+/**
+ * Update Billing Address
+ *
+ * Update billing address for a loyalty card. Also updates the postcode on the loyalty record.
+ *
+ * **Required scope:** `WRITE_LOYALTY`
+ */
+export declare const loyaltyUpdateBillingAddress: <ThrowOnError extends boolean = false>(options: Options<LoyaltyUpdateBillingAddressData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyUpdateBillingAddressResponses, LoyaltyUpdateBillingAddressErrors, ThrowOnError, "fields">;
+/**
+ * Deactivate Card
+ *
+ * Deactivate a loyalty card. Sets PURGED to true and CARDACTIVE to false.
+ * No request body required.
+ *
+ * **Required scope:** `WRITE_LOYALTY`
+ */
+export declare const loyaltyDeactivateCard: <ThrowOnError extends boolean = false>(options: Options<LoyaltyDeactivateCardData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyDeactivateCardResponses, LoyaltyDeactivateCardErrors, ThrowOnError, "fields">;
+/**
+ * Update Groups
+ *
+ * Update loyalty groups assigned to a card. Groups are non-purchase loyalty groups.
+ * Use the optional `/delete` sub-path to remove groups instead of adding them.
+ *
+ * **Required scope:** `WRITE_LOYALTY`
+ */
+export declare const loyaltyUpdateGroups: <ThrowOnError extends boolean = false>(options: Options<LoyaltyUpdateGroupsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyUpdateGroupsResponses, LoyaltyUpdateGroupsErrors, ThrowOnError, "fields">;
+/**
+ * Update External User ID
+ *
+ * Update the external user ID and/or username for a loyalty card.
+ *
+ * **Required scope:** `WRITE_LOYALTY`
+ */
+export declare const loyaltyUpdateExternalUserId: <ThrowOnError extends boolean = false>(options: Options<LoyaltyUpdateExternalUserIdData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyUpdateExternalUserIdResponses, LoyaltyUpdateExternalUserIdErrors, ThrowOnError, "fields">;
+/**
+ * Get Card Details with Offers
+ *
+ * Get comprehensive loyalty card information with available offers.
+ * The site code determines which offers are available. Includes both
+ * available offers and recently redeemed offers in the response.
+ *
+ * **Required scope:** `READ_LOYALTY`
+ *
+ * **Error codes:**
+ * - `4` (Not Found) - Card not found or invalid card length
+ */
+export declare const loyaltyGetCardWithOffers: <ThrowOnError extends boolean = false>(options: Options<LoyaltyGetCardWithOffersData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyGetCardWithOffersResponses, LoyaltyGetCardWithOffersErrors, ThrowOnError, "fields">;
+/**
+ * Update Member Groups
+ *
+ * Update member (purchase) groups assigned to a card.
+ * Use the optional `/delete` sub-path to remove groups instead of adding them.
+ *
+ * **Required scope:** `WRITE_LOYALTY`
+ */
+export declare const loyaltyUpdateMemberGroups: <ThrowOnError extends boolean = false>(options: Options<LoyaltyUpdateMemberGroupsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyUpdateMemberGroupsResponses, LoyaltyUpdateMemberGroupsErrors, ThrowOnError, "fields">;
+/**
+ * Update Card PIN
+ *
+ * Update the PIN for a loyalty card.
+ *
+ * **Required scope:** `WRITE_LOYALTY`
+ */
+export declare const loyaltyUpdateCardPin: <ThrowOnError extends boolean = false>(options: Options<LoyaltyUpdateCardPinData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyUpdateCardPinResponses, LoyaltyUpdateCardPinErrors, ThrowOnError, "fields">;
+/**
+ * Update Points
+ *
+ * Award or redeem points on a loyalty card. Use positive points to award, negative to redeem.
+ * When redeeming (negative points), the amount represents the redemption value.
+ *
+ * **Required scope:** `WRITE_LOYALTY`
+ */
+export declare const loyaltyUpdatePoints: <ThrowOnError extends boolean = false>(options: Options<LoyaltyUpdatePointsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyUpdatePointsResponses, LoyaltyUpdatePointsErrors, ThrowOnError, "fields">;
+/**
+ * Renew Card
+ *
+ * Process card renewal with payment via Stripe. Extends the card expiry date
+ * based on the card type's configured renewal period (in years).
+ *
+ * **Required scope:** `WRITE_LOYALTY`
+ */
+export declare const loyaltyRenewCard: <ThrowOnError extends boolean = false>(options: Options<LoyaltyRenewCardData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyRenewCardResponses, LoyaltyRenewCardErrors, ThrowOnError, "fields">;
+/**
+ * Update Shipping Address
+ *
+ * Update shipping address for a loyalty card.
+ *
+ * **Required scope:** `WRITE_LOYALTY`
+ */
+export declare const loyaltyUpdateShippingAddress: <ThrowOnError extends boolean = false>(options: Options<LoyaltyUpdateShippingAddressData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyUpdateShippingAddressResponses, LoyaltyUpdateShippingAddressErrors, ThrowOnError, "fields">;
+/**
+ * Generate Short Code
+ *
+ * Generate a new short code for a loyalty card. The short code is generated server-side
+ * and returned along with the card's public ID and wallet link.
+ *
+ * **Required scope:** `WRITE_LOYALTY`
+ */
+export declare const loyaltyGenerateShortCode: <ThrowOnError extends boolean = false>(options: Options<LoyaltyGenerateShortCodeData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyGenerateShortCodeResponses, LoyaltyGenerateShortCodeErrors, ThrowOnError, "fields">;
+/**
+ * Update Card Token
+ *
+ * Update the push notification token for a loyalty card. Can also optionally
+ * update card type, external user ID, and username.
+ *
+ * **Required scope:** `WRITE_LOYALTY`
+ */
+export declare const loyaltyUpdateCardToken: <ThrowOnError extends boolean = false>(options: Options<LoyaltyUpdateCardTokenData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyUpdateCardTokenResponses, LoyaltyUpdateCardTokenErrors, ThrowOnError, "fields">;
+/**
+ * Get Card Types
+ *
+ * Get available loyalty card types.
+ * Response uses `cardTypes` key (camelCase). The `version` and `loyaltyVersion` fields
+ * are embedded as pseudo-elements inside the cardTypes array.
+ * Response is returned as raw JSON without result/errormessage wrapper.
+ *
+ * **Required scope:** `READ_LOYALTY`
+ */
+export declare const loyaltyGetCardTypes: <ThrowOnError extends boolean = false>(options?: Options<LoyaltyGetCardTypesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyGetCardTypesResponses, LoyaltyGetCardTypesErrors, ThrowOnError, "fields">;
+/**
+ * Get Coffee Card Stats
+ *
+ * Get coffee card statistics for offers.
+ * Returns progress towards coffee card offers (offers with a promotion group).
+ * Card number must be between 5 and 25 characters.
+ * Response is a raw JSON array (no wrapper object).
+ *
+ * **Required scope:** `READ_LOYALTY`
+ *
+ * **Error codes:**
+ * - `8` (Missing Data) - Invalid site or invalid card
+ * - `9` (Request Rejected) - Card number too short (< 5) or too long (> 25)
+ */
+export declare const loyaltyGetCoffeeCardStats: <ThrowOnError extends boolean = false>(options: Options<LoyaltyGetCoffeeCardStatsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyGetCoffeeCardStatsResponses, LoyaltyGetCoffeeCardStatsErrors, ThrowOnError, "fields">;
+/**
+ * Get Compulsory Fields
+ *
+ * Get compulsory field configuration.
+ * Response is returned as raw JSON without result/errormessage wrapper.
+ *
+ * **Required scope:** `READ_LOYALTY`
+ */
+export declare const loyaltyGetCompulsoryFields: <ThrowOnError extends boolean = false>(options?: Options<LoyaltyGetCompulsoryFieldsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyGetCompulsoryFieldsResponses, LoyaltyGetCompulsoryFieldsErrors, ThrowOnError, "fields">;
+/**
+ * Get Loyalty Groups
+ *
+ * Get available loyalty groups (non-purchase groups).
+ * Response uses `cardGroups` key. The `version` and `loyaltyVersion` fields
+ * are embedded as pseudo-elements inside the cardGroups array.
+ * Response is returned as raw JSON without result/errormessage wrapper.
+ *
+ * **Required scope:** `READ_LOYALTY`
+ *
+ * **Error codes:**
+ * - `4` (Not Found) - No groups found
+ */
+export declare const loyaltyGetGroups: <ThrowOnError extends boolean = false>(options?: Options<LoyaltyGetGroupsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyGetGroupsResponses, LoyaltyGetGroupsErrors, ThrowOnError, "fields">;
+/**
+ * Get Card Image
+ *
+ * Get loyalty card barcode image URL.
+ * Card number must be between 5 and 13 characters.
+ * Response is returned as raw JSON without result/errormessage wrapper.
+ *
+ * **Required scope:** `READ_LOYALTY`
+ */
+export declare const loyaltyGetCardImage: <ThrowOnError extends boolean = false>(options: Options<LoyaltyGetCardImageData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyGetCardImageResponses, LoyaltyGetCardImageErrors, ThrowOnError, "fields">;
+/**
+ * Get Member Groups
+ *
+ * Get available member groups (purchase groups).
+ * Response uses `membergroups` key. The `version` and `loyaltyVersion` fields
+ * are embedded as pseudo-elements inside the membergroups array.
+ * Response is returned as raw JSON without result/errormessage wrapper.
+ *
+ * **Required scope:** `READ_LOYALTY`
+ *
+ * **Error codes:**
+ * - `4` (Not Found) - No groups found
+ */
+export declare const loyaltyGetMemberGroups: <ThrowOnError extends boolean = false>(options?: Options<LoyaltyGetMemberGroupsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyGetMemberGroupsResponses, LoyaltyGetMemberGroupsErrors, ThrowOnError, "fields">;
+/**
+ * Calculate Points for Items
+ *
+ * Calculate points for a transaction with line items.
+ * Returns the calculated points for the given items and total.
+ * Body is wrapped in a `card` key.
+ *
+ * **Required scope:** `WRITE_LOYALTY`
+ */
+export declare const loyaltyCreatePointsTransaction: <ThrowOnError extends boolean = false>(options: Options<LoyaltyCreatePointsTransactionData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyCreatePointsTransactionResponses, LoyaltyCreatePointsTransactionErrors, ThrowOnError, "fields">;
+/**
+ * Recover Card PIN
+ *
+ * Trigger password/PIN recovery for a loyalty card. Sends a recovery email
+ * to the card's registered email address. If the card has no PIN set,
+ * a random one is generated first.
+ *
+ * **Required scope:** `READ_LOYALTY`
+ *
+ * **Error codes:**
+ * - `0` (OK) - Recovery email sent successfully
+ * - `4` (Not Found) - Card not found, invalid card length, no email on file, or email marked as bad
+ */
+export declare const loyaltyGetCardRecovery: <ThrowOnError extends boolean = false>(options: Options<LoyaltyGetCardRecoveryData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyGetCardRecoveryResponses, LoyaltyGetCardRecoveryErrors, ThrowOnError, "fields">;
+/**
+ * Search Cards
+ *
+ * Search for loyalty cards by various criteria.
+ * The search term can be passed either as a query string parameter or
+ * as the 4th path segment (e.g., `/search/mobile/0412345678`).
+ * Also supports short codes (6-character alphanumeric codes) as the search term,
+ * which are automatically detected regardless of command.
+ * Response is returned as raw JSON without result/errormessage wrapper.
+ *
+ * **Required scope:** `READ_LOYALTY`
+ *
+ * **Supported search commands:**
+ * - `card` - Search by card number (partial match)
+ * - `cardmatch` - Exact card number match
+ * - `customernumber` - Search by customer number (partial match)
+ * - `first` - Search by first name (partial match)
+ * - `last` - Search by last name (partial match)
+ * - `name` - Search by full name (supports "surname, firstname" or single term)
+ * - `email` - Search by email (partial match)
+ * - `emailmatch` - Exact email match
+ * - `username` - Exact username match
+ * - `mobile` - Search by mobile (partial match, leading 0 stripped)
+ * - `mobilematch` - Exact mobile match (converted to E.164 format)
+ * - `homephone` / `phone` - Search by home phone (partial match)
+ * - `workphone` / `work` - Search by work phone (partial match)
+ * - `gender` - Filter by gender (exact match)
+ * - `postcode` - Search by postcode (partial match)
+ * - `changed` - Cards changed since date (max 3 months back)
+ * - `home` / `homesite` - Filter by home site code (exact match)
+ * - `birthmonth` - Filter by birth month (1-12)
+ * - `age` - Filter by age
+ * - `occupation` - Search by occupation (partial match)
+ * - `soft1` through `soft10` - Search by custom soft fields (partial match)
+ * - `emailopt` - Filter by email opt-in flag (T/F)
+ * - `smsopt` - Filter by SMS opt-in flag (T/F)
+ * - `cardtype` - Filter by card type
+ * - `pointsgreater` - Cards with points balance >= value
+ * - `pointsless` - Cards with points balance <= value
+ * - `loyaltygroup` - Cards belonging to a loyalty group ID
+ *
+ * **Error codes:**
+ * - `4` (Not Found) - No results found, missing search term, or invalid command
+ */
+export declare const loyaltySearchCards: <ThrowOnError extends boolean = false>(options: Options<LoyaltySearchCardsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltySearchCardsResponses, LoyaltySearchCardsErrors, ThrowOnError, "fields">;
+/**
+ * Get Loyalty Settings
+ *
+ * Get loyalty system settings including card types and groups.
+ * Response is returned as raw JSON without result/errormessage wrapper.
+ *
+ * **Required scope:** `READ_LOYALTY`
+ */
+export declare const loyaltyGetSettings: <ThrowOnError extends boolean = false>(options?: Options<LoyaltyGetSettingsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyGetSettingsResponses, LoyaltyGetSettingsErrors, ThrowOnError, "fields">;
+/**
+ * Get Sync List
+ *
+ * Get loyalty sync list — returns email and card number pairs for active cards.
+ * Optionally filter by card type using the path parameter.
+ * Response uses `cards` key. The `version` and `loyaltyVersion` fields
+ * are embedded as pseudo-elements inside the cards array.
+ * Response is returned as raw JSON without result/errormessage wrapper.
+ *
+ * **Required scope:** `READ_LOYALTY`
+ *
+ * **Error codes:**
+ * - `4` (Not Found) - No cards found
+ */
+export declare const loyaltyGetSyncList: <ThrowOnError extends boolean = false>(options?: Options<LoyaltyGetSyncListData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyGetSyncListResponses, LoyaltyGetSyncListErrors, ThrowOnError, "fields">;
+/**
+ * Update Sync List
+ *
+ * Update sync list information.
+ *
+ * **Required scope:** `WRITE_LOYALTY`
+ */
+export declare const loyaltyUpdateSyncList: <ThrowOnError extends boolean = false>(options: Options<LoyaltyUpdateSyncListData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyUpdateSyncListResponses, LoyaltyUpdateSyncListErrors, ThrowOnError, "fields">;
+/**
+ * Get Sync List by Card Type
+ *
+ * Get loyalty sync list filtered by card type.
+ *
+ * **Required scope:** `READ_LOYALTY`
+ */
+export declare const loyaltyGetSyncListByCommand: <ThrowOnError extends boolean = false>(options: Options<LoyaltyGetSyncListByCommandData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyGetSyncListByCommandResponses, LoyaltyGetSyncListByCommandErrors, ThrowOnError, "fields">;
+/**
+ * Verify Card
+ *
+ * Verify a loyalty card against a PIN and retrieve full card details if verification succeeds.
+ * The card field can be a card number or an email address (if it contains `@`, lookup is by email).
+ * PIN is checked against the stored PIN first, then falls back to card number, mobile, or email
+ * based on company settings.
+ * Response is returned as raw JSON without result/errormessage wrapper.
+ *
+ * **Required scope:** `WRITE_LOYALTY`
+ */
+export declare const loyaltyVerifyCard: <ThrowOnError extends boolean = false>(options: Options<LoyaltyVerifyCardData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyVerifyCardResponses, LoyaltyVerifyCardErrors, ThrowOnError, "fields">;
+/**
+ * Get Wallet Link
+ *
+ * Get digital wallet link for a loyalty card
+ */
+export declare const loyaltyGetWalletLink: <ThrowOnError extends boolean = false>(options: Options<LoyaltyGetWalletLinkData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<LoyaltyGetWalletLinkResponses, LoyaltyGetWalletLinkErrors, ThrowOnError, "fields">;
+/**
+ * Create Member
+ *
+ * Create a new member.
+ * The request body must be wrapped in a `member` key: `{"member": {...}}`.
+ * Either email or mobile must be provided. If neither the member number nor
+ * email/mobile is provided, returns MISSING_DATA.
+ *
+ * Phone numbers can be provided either as flat fields (mobile, phone, phone1)
+ * or nested in a phones object ({phones: {mobile, home, work}}).
+ * If phones object is provided, phones.home -> phone, phones.work -> phone1.
+ *
+ * If `createcard` is true, a virtual loyalty card is created.
+ * If `billingtoken` or `billingcustomerid` is provided, auto-charge signup is triggered.
+ *
+ * **Required scope:** `WRITE_MEMBERSHIP`
+ *
+ * **Error codes:**
+ * - `0` (OK) - Member created successfully
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `6` (Invalid Email) - Email format validation failed
+ * - `7` (Invalid Mobile) - Mobile number too short or invalid format
+ * - `8` (Missing Data) - Body missing or both email and mobile missing
+ * - `11` (Database Error) - Failed to insert/update customer record
+ * - `18` (Card Exists) - Member number already exists
+ * - `45` (Invalid JSON) - Request body is not valid JSON
+ * - `47` (Member Exists Same Email) - A member with this email already exists
+ * - `48` (Member Exists Same Mobile) - A member with this mobile already exists
+ */
+export declare const membershipCreateMember: <ThrowOnError extends boolean = false>(options: Options<MembershipCreateMemberData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<MembershipCreateMemberResponses, MembershipCreateMemberErrors, ThrowOnError, "fields">;
+/**
+ * Get Allowed Functions
+ *
+ * Get list of allowed membership functions for the current API key.
+ * Returns an object keyed by feature name, each mapping to an array of allowed HTTP methods.
+ *
+ * **Required scope:** `READ_MEMBERSHIP`
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `3` (Invalid Function) - Invalid sub-function
+ */
+export declare const membershipGetAllowedFunctions: <ThrowOnError extends boolean = false>(options?: Options<MembershipGetAllowedFunctionsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<MembershipGetAllowedFunctionsResponses, MembershipGetAllowedFunctionsErrors, ThrowOnError, "fields">;
+/**
+ * Get Member by Card
+ *
+ * Get comprehensive member information by loyalty card number.
+ * Looks up the customernumber from CUSTLOY by card number, then returns the
+ * same full member detail as GET /membership/member/{memberNumber}.
+ *
+ * **Required scope:** `READ_MEMBERSHIP`
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Card not found or member not found
+ */
+export declare const membershipGetMemberByCard: <ThrowOnError extends boolean = false>(options: Options<MembershipGetMemberByCardData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<MembershipGetMemberByCardResponses, MembershipGetMemberByCardErrors, ThrowOnError, "fields">;
+/**
+ * Update Member by Card
+ *
+ * Update member information via card number.
+ * Route: PUT /membership/card/{cardNumber}
+ *
+ * Same as PUT /membership/member/{memberNumber} but looks up the member
+ * by loyalty card number first. When using the card path, CUSTLOY fields
+ * are also updated and group assignments can be managed.
+ *
+ * **Required scope:** `WRITE_MEMBERSHIP`
+ */
+export declare const membershipUpdateMemberByCard: <ThrowOnError extends boolean = false>(options: Options<MembershipUpdateMemberByCardData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<MembershipUpdateMemberByCardResponses, MembershipUpdateMemberByCardErrors, ThrowOnError, "fields">;
+/**
+ * Get Member Groups
+ *
+ * Get available membership groups (purchase groups).
+ * Returns groups from LOYALTYGROUP where PURCHASEGROUP = 'T'.
+ * Columns LINKEDCARD, LINKED_CUSTOMER_LOYALTY_ID, SHAREPER, VENUETOPAY, PURCHASEGROUP
+ * are removed. IMAGEURL is renamed to `url`. All keys are lowercased.
+ * The `version` and `loyaltyVersion` fields are embedded as pseudo-elements inside the groups array.
+ * Both `groups` and `membergroups` sub-function paths are supported and return the same data.
+ *
+ * **Required scope:** `READ_MEMBERSHIP`
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - No groups found
+ */
+export declare const membershipGetMemberGroups: <ThrowOnError extends boolean = false>(options?: Options<MembershipGetMemberGroupsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<MembershipGetMemberGroupsResponses, MembershipGetMemberGroupsErrors, ThrowOnError, "fields">;
+/**
+ * Get Member Details
+ *
+ * Get comprehensive member information by member number (customernumber).
+ * Returns full member details from the CUSTOMER table, plus associated loyalty cards
+ * from CUSTLOY, member groups from LOYCARDGROUP/LOYALTYGROUP, and customer orders
+ * from CUSTORDER. The response does NOT include result/errormessage wrapper fields.
+ *
+ * The `version` and `loyaltyVersion` fields are embedded inside the member object.
+ *
+ * The member/{id}/search/{type}/{from}/{to} sub-path allows filtering orders by
+ * date range or amount range.
+ *
+ * **Required scope:** `READ_MEMBERSHIP`
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Member not found, or card number invalid (length must be 1-25)
+ */
+export declare const membershipGetMember: <ThrowOnError extends boolean = false>(options: Options<MembershipGetMemberData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<MembershipGetMemberResponses, MembershipGetMemberErrors, ThrowOnError, "fields">;
+/**
+ * Update Member
+ *
+ * Update member information (general update).
+ * Route: PUT /membership/member/{memberNumber}
+ *
+ * The request body must be wrapped in a `member` key: `{"member": {...}}`.
+ * Updates the CUSTOMER record and optionally the CUSTLOY record (when using card sub-function).
+ *
+ * When using the `card` sub-function path, additional CUSTLOY fields are updated
+ * (email, dateofbirth, firstname, lastname, mobile, phone, postcode, gender)
+ * and group assignments can be managed.
+ *
+ * If `createcard` is true and no card exists, a virtual loyalty card is created.
+ * If `billingtoken` or `billingcustomerid` is provided, auto-charge signup is triggered.
+ *
+ * **Required scope:** `WRITE_MEMBERSHIP`
+ *
+ * **Error codes:**
+ * - `0` (OK) - Member updated successfully
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Member not found
+ * - `8` (Missing Data) - Body missing
+ * - `11` (Database Error) - Failed to update customer record
+ * - `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const membershipUpdateMember: <ThrowOnError extends boolean = false>(options: Options<MembershipUpdateMemberData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<MembershipUpdateMemberResponses, MembershipUpdateMemberErrors, ThrowOnError, "fields">;
+/**
+ * Activate Member
+ *
+ * Activate a member.
+ * Route: PUT /membership/member/{memberNumber}/activate
+ * Sets MEMBERSTATUS to 'A' (Active).
+ * No request body is required.
+ *
+ * **Required scope:** `WRITE_MEMBERSHIP`
+ *
+ * **Error codes:**
+ * - `0` (OK) - Member activated successfully
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Member not found
+ * - `11` (Database Error) - Failed to update status
+ */
+export declare const membershipActivateMember: <ThrowOnError extends boolean = false>(options: Options<MembershipActivateMemberData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<MembershipActivateMemberResponses, MembershipActivateMemberErrors, ThrowOnError, "fields">;
+/**
+ * Update Member Address
+ *
+ * Update member billing and/or shipping address.
+ * Route: PUT /membership/member/{memberNumber}/address
+ * Updates billing address, shipping address, and/or delivery instructions.
+ * At least one of billing, shipping, or deliveryinstruction must be provided.
+ *
+ * **Required scope:** `WRITE_MEMBERSHIP`
+ *
+ * **Error codes:**
+ * - `0` (OK) - Address updated successfully
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Member not found
+ * - `8` (Missing Data) - Body missing or no address data provided
+ * - `11` (Database Error) - Failed to update address
+ * - `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const membershipUpdateMemberAddress: <ThrowOnError extends boolean = false>(options: Options<MembershipUpdateMemberAddressData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<MembershipUpdateMemberAddressResponses, MembershipUpdateMemberAddressErrors, ThrowOnError, "fields">;
+/**
+ * Update Billing Address
+ *
+ * Update member billing address only.
+ * Route: PUT /membership/member/{memberNumber}/billingaddress
+ *
+ * **Required scope:** `WRITE_MEMBERSHIP`
+ *
+ * **Error codes:**
+ * - `0` (OK) - Billing address updated successfully
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Member not found
+ * - `8` (Missing Data) - Body missing or billing data not provided
+ * - `11` (Database Error) - Failed to update billing address
+ * - `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const membershipUpdateBillingAddress: <ThrowOnError extends boolean = false>(options: Options<MembershipUpdateBillingAddressData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<MembershipUpdateBillingAddressResponses, MembershipUpdateBillingAddressErrors, ThrowOnError, "fields">;
+/**
+ * Cancel Member
+ *
+ * Cancel a member.
+ * Route: PUT /membership/member/{memberNumber}/cancel
+ * Sets MEMBERSTATUS to 'C' (Cancelled).
+ * No request body is required.
+ *
+ * **Required scope:** `WRITE_MEMBERSHIP`
+ *
+ * **Error codes:**
+ * - `0` (OK) - Member cancelled successfully
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Member not found
+ * - `11` (Database Error) - Failed to update status
+ */
+export declare const membershipCancelMember: <ThrowOnError extends boolean = false>(options: Options<MembershipCancelMemberData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<MembershipCancelMemberResponses, MembershipCancelMemberErrors, ThrowOnError, "fields">;
+/**
+ * Replace Credit Card
+ *
+ * Replace member credit card token.
+ * Route: PUT /membership/member/{memberNumber}/replacecreditcard
+ * Updates the TOKEN field in the CUSTOMER table with the new card token.
+ *
+ * **Required scope:** `WRITE_MEMBERSHIP`
+ *
+ * **Error codes:**
+ * - `0` (OK) - Card token replaced successfully
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Member not found
+ * - `8` (Missing Data) - Body missing or cardtoken field empty
+ * - `11` (Database Error) - Failed to update token
+ * - `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const membershipReplaceCreditCard: <ThrowOnError extends boolean = false>(options: Options<MembershipReplaceCreditCardData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<MembershipReplaceCreditCardResponses, MembershipReplaceCreditCardErrors, ThrowOnError, "fields">;
+/**
+ * Update Shipping Address
+ *
+ * Update member shipping address only.
+ * Route: PUT /membership/member/{memberNumber}/shippingaddress
+ *
+ * **Required scope:** `WRITE_MEMBERSHIP`
+ *
+ * **Error codes:**
+ * - `0` (OK) - Shipping address updated successfully
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Member not found
+ * - `8` (Missing Data) - Body missing or shipping data not provided
+ * - `11` (Database Error) - Failed to update shipping address
+ * - `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const membershipUpdateShippingAddress: <ThrowOnError extends boolean = false>(options: Options<MembershipUpdateShippingAddressData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<MembershipUpdateShippingAddressResponses, MembershipUpdateShippingAddressErrors, ThrowOnError, "fields">;
+/**
+ * Suspend Member
+ *
+ * Suspend a member.
+ * Route: PUT /membership/member/{memberNumber}/suspend
+ * Sets MEMBERSTATUS to 'S' (Suspended).
+ * No request body is required.
+ *
+ * **Required scope:** `WRITE_MEMBERSHIP`
+ *
+ * **Error codes:**
+ * - `0` (OK) - Member suspended successfully
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Member not found
+ * - `11` (Database Error) - Failed to update status
+ */
+export declare const membershipSuspendMember: <ThrowOnError extends boolean = false>(options: Options<MembershipSuspendMemberData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<MembershipSuspendMemberResponses, MembershipSuspendMemberErrors, ThrowOnError, "fields">;
+/**
+ * Update Member Token
+ *
+ * Update member authentication token.
+ * Route: PUT /membership/member/{memberNumber}/token
+ * Updates the TOKEN field in the CUSTOMER table.
+ *
+ * **Required scope:** `WRITE_MEMBERSHIP`
+ *
+ * **Error codes:**
+ * - `0` (OK) - Token updated successfully
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Member not found
+ * - `8` (Missing Data) - Body missing
+ * - `11` (Database Error) - Failed to update token
+ * - `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const membershipUpdateMemberToken: <ThrowOnError extends boolean = false>(options: Options<MembershipUpdateMemberTokenData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<MembershipUpdateMemberTokenResponses, MembershipUpdateMemberTokenErrors, ThrowOnError, "fields">;
+/**
+ * Get Member Groups (alternate)
+ *
+ * Get available membership groups (alternate route).
+ * Same as GET /membership/groups.
+ *
+ * **Required scope:** `READ_MEMBERSHIP`
+ */
+export declare const membershipGetMemberGroupsAlt: <ThrowOnError extends boolean = false>(options?: Options<MembershipGetMemberGroupsAltData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<MembershipGetMemberGroupsAltResponses, MembershipGetMemberGroupsAltErrors, ThrowOnError, "fields">;
+/**
+ * Search Members
+ *
+ * Search for members by various criteria.
+ * Returns a simplified member record for each match (max 500 results).
+ * The response does NOT include result/errormessage wrapper fields.
+ * The `version` and `loyaltyVersion` fields are embedded as pseudo-elements inside the members array.
+ *
+ * Supported search commands:
+ * - `number` or `customer` - Search by card number (LIKE match)
+ * - `name` - Search by name (case-insensitive LIKE match)
+ * - `email` - Search by email (case-insensitive LIKE match)
+ * - `mobile` - Search by mobile number (LIKE match)
+ * - `phone` - Search by home or work phone (PHONE or PHONE1, LIKE match)
+ * - `gender` - Search by exact gender code
+ * - `postcode` - Search by billing or shipping postcode (case-insensitive LIKE match)
+ * - `changed` - Search by date changed (members changed since the given date, max 3 months back)
+ * - `birthmonth` - Search by birth month (1-12)
+ * - `age` - Search by age
+ *
+ * **Required scope:** `READ_MEMBERSHIP`
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Missing search command, missing query string, invalid command, or no results found
+ */
+export declare const membershipSearchMembers: <ThrowOnError extends boolean = false>(options: Options<MembershipSearchMembersData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<MembershipSearchMembersResponses, MembershipSearchMembersErrors, ThrowOnError, "fields">;
+/**
+ * Create an Offer
+ *
+ * Create a new offer in the system.
+ *
+ * Requires scope: `write:offers`
+ */
+export declare const offerCreate: <ThrowOnError extends boolean = false>(options: Options<OfferCreateData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<OfferCreateResponses, OfferCreateErrors, ThrowOnError, "fields">;
+/**
+ * List Offer Redemptions
+ *
+ * Get a list of offer redemptions with optional date range and limit filtering.
+ * Only the GET method is supported.
+ *
+ * Requires scope: `read:offers`
+ */
+export declare const offerRedemptionsList: <ThrowOnError extends boolean = false>(options?: Options<OfferRedemptionsListData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<OfferRedemptionsListResponses, OfferRedemptionsListErrors, ThrowOnError, "fields">;
+/**
+ * Get Offer Coffee Card Stats
+ *
+ * Returns coffee card statistics for a specific offer and loyalty card, showing progress towards offer completion
+ */
+export declare const offerGetCoffeeCardStats: <ThrowOnError extends boolean = false>(options: Options<OfferGetCoffeeCardStatsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<OfferGetCoffeeCardStatsResponses, OfferGetCoffeeCardStatsErrors, ThrowOnError, "fields">;
+/**
+ * List all Offers
+ *
+ * List all offers or filter by a loyalty card.
+ *
+ * Requires scope: `read:offers`
+ */
+export declare const offerList: <ThrowOnError extends boolean = false>(options: Options<OfferListData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<OfferListResponses, OfferListErrors, ThrowOnError, "fields">;
+/**
+ * Delete an Offer
+ *
+ * Delete an offer from the system.
+ *
+ * Requires scope: `delete:offers`
+ */
+export declare const offerDelete: <ThrowOnError extends boolean = false>(options: Options<OfferDeleteData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<OfferDeleteResponses, OfferDeleteErrors, ThrowOnError, "fields">;
+/**
+ * Update an Offer
+ *
+ * Update an existing offer in the system.
+ * You can send partial updates to this endpoint, provide only the data you wish to change.
+ *
+ * Requires scope: `write:offers`
+ */
+export declare const offerUpdate: <ThrowOnError extends boolean = false>(options: Options<OfferUpdateData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<OfferUpdateResponses, OfferUpdateErrors, ThrowOnError, "fields">;
+/**
+ * Delete Order
+ *
+ * Delete an order (soft delete - sets status to 'D').
+ *
+ * Marks the order as deleted by setting ORDERSTATUS to 'D'.
+ * The order record is not physically removed from the database.
+ *
+ * **Required scope:** `DELETE_ORDER`
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `8` (Missing Data) - Body missing
+ * - `9` (Request Rejected) - Order does not exist
+ * - `11` (Database Error) - Database error during deletion
+ * - `12` (Invalid Site) - Site not part of company
+ * - `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const orderDeleteOrder: <ThrowOnError extends boolean = false>(options: Options<OrderDeleteOrderData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<OrderDeleteOrderResponses, OrderDeleteOrderErrors, ThrowOnError, "fields">;
+/**
+ * Create Order
+ *
+ * Create a new order.
+ *
+ * Creates a new customer order with line items. Either `card` or `customer`
+ * (or both) must be provided. If both are provided, they must be linked to
+ * the same customer.
+ *
+ * If the order number is omitted, one will be auto-generated. If a delivery
+ * address is provided and shipping is enabled, the order may be automatically
+ * shipped to distribution.
+ *
+ * **Required scope:** `WRITE_ORDER`
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `8` (Missing Data) - Body missing, missing card/customer, no delivery address, no items
+ * - `9` (Request Rejected) - Order exists, card/customer not linked, item not found, customer not found
+ * - `11` (Database Error) - Database error during creation
+ * - `12` (Invalid Site) - Site not part of company
+ * - `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const orderCreateOrder: <ThrowOnError extends boolean = false>(options: Options<OrderCreateOrderData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<OrderCreateOrderResponses, OrderCreateOrderErrors, ThrowOnError, "fields">;
+/**
+ * Get Allowed Functions
+ *
+ * Get list of allowed order functions for the current API key.
+ *
+ * Returns a nested object with the API version and allowed HTTP methods
+ * for each feature (allowedFunctions, settings, search).
+ *
+ * **Required scope:** `READ_ORDER`
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ */
+export declare const orderGetAllowedFunctions: <ThrowOnError extends boolean = false>(options?: Options<OrderGetAllowedFunctionsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<OrderGetAllowedFunctionsResponses, OrderGetAllowedFunctionsErrors, ThrowOnError, "fields">;
+/**
+ * Search Orders
+ *
+ * Search for orders by various criteria.
+ *
+ * Returns up to 500 matching orders. The search is case-insensitive
+ * for text fields. Pass site as -1 to search across all sites.
+ *
+ * **Required scope:** `READ_ORDER`
+ *
+ * **Search commands (case-insensitive):**
+ * - `card` - Search by loyalty card number (partial match)
+ * - `customer` - Search by customer number (partial match)
+ * - `name` - Search by customer name (partial match)
+ * - `email` - Search by email address (partial match)
+ * - `emailmatch` - Search by exact email address
+ * - `status` - Search by order status code
+ * - `order` - Search by order number (partial match)
+ * - `mobile` - Search by mobile number (partial match)
+ * - `phone` / `homephone` - Search by home phone number (partial match)
+ * - `deposit` - Search by minimum deposit amount
+ * - `total` - Search by minimum order total
+ * - `work` / `workphone` - Search by work phone number (partial match)
+ * - `postcode` - Search by shipping postcode (partial match)
+ * - `changed` - Search by modified date (max 3 months back)
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Missing search criteria or no orders match
+ */
+export declare const orderSearchOrders: <ThrowOnError extends boolean = false>(options: Options<OrderSearchOrdersData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<OrderSearchOrdersResponses, OrderSearchOrdersErrors, ThrowOnError, "fields">;
+/**
+ * Get Order Details
+ *
+ * Get order details by order number and site.
+ *
+ * Returns full order details including customer information, delivery
+ * address, and all line items. Customer data is sourced from the
+ * CUSTOMER table and includes billing/shipping addresses.
+ *
+ * **Required scope:** `READ_ORDER`
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Order not found
+ */
+export declare const orderGetOrder: <ThrowOnError extends boolean = false>(options: Options<OrderGetOrderData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<OrderGetOrderResponses, OrderGetOrderErrors, ThrowOnError, "fields">;
+/**
+ * Ping
+ *
+ * Use this endpoint to verify your connection and credentials to the
+ * Zen server.
+ */
+export declare const pingPing: <ThrowOnError extends boolean = false>(options?: Options<PingPingData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<PingPingResponses, PingPingErrors, ThrowOnError, "fields">;
+/**
+ * Get Sites Information
+ *
+ * Get complete company and site information.
+ *
+ * Returns company details (from CHAIN, CHAININFO, CHAINDEFAULT, CHAINLOCALE tables)
+ * along with all sites and their locations. Only the GET method is supported.
+ *
+ * **Required scope:** `READ_SITES`
+ *
+ * **Error codes:**
+ * - `3` (Invalid Function) - Non-GET method used
+ * - `4` (Not Found) - Company or sites not found
+ */
+export declare const sitesGetSites: <ThrowOnError extends boolean = false>(options?: Options<SitesGetSitesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<SitesGetSitesResponses, SitesGetSitesErrors, ThrowOnError, "fields">;
+/**
+ * Get Stripe Configuration
+ *
+ * Get Stripe public key configuration.
+ *
+ * Returns the Stripe public key configured for the company.
+ *
+ * Required scope: `read:stripe`
+ */
+export declare const stripeGetStripeConfig: <ThrowOnError extends boolean = false>(options?: Options<StripeGetStripeConfigData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<StripeGetStripeConfigResponses, StripeGetStripeConfigErrors, ThrowOnError, "fields">;
+/**
+ * Get Transaction Details
+ *
+ * Get transaction details by site, location, terminal, journal and date.
+ *
+ * The response is returned directly via `prepareJson()` without `result`/`errormessage`
+ * wrapper fields. All integer values are converted to strings.
+ *
+ * When `format=event` is specified, returns a JournalCreatedEvent serialization
+ * instead of the standard transaction structure.
+ *
+ * The response conditionally includes:
+ * - `customer` - when a loyalty card was used or customer data is available from POS
+ * - `salesdiscount` - when a sales discount was applied
+ * - `offers` - when offers were redeemed
+ *
+ * **Required scope:** `read:transaction`
+ *
+ * **Error codes:**
+ * - `4` (Not Found) - Transaction basket not found
+ * - `8` (Missing Data) - Required query parameters missing, or invalid site, or journal not found (event format)
+ * - `12` (Invalid Site) - Site not part of company
+ */
+export declare const transactionGetTransaction: <ThrowOnError extends boolean = false>(options: Options<TransactionGetTransactionData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<TransactionGetTransactionResponses, TransactionGetTransactionErrors, ThrowOnError, "fields">;
+/**
+ * Create Transaction
+ *
+ * Create a new transaction record.
+ *
+ * Submit a transaction from the POS terminal. The request body must be wrapped
+ * in a `transaction` key. The payload shape varies depending on the scenario -
+ * see the examples for common use cases including basic sales, loyalty, vouchers,
+ * debtor charges, and refunds.
+ *
+ * **Required scope:** `write:transaction`
+ *
+ * **Error codes:**
+ * - `0` (OK) - Transaction submitted for processing
+ * - `8` (Missing Data) - Body missing, missing site/terminal/journal/date/time/operator/operatorname/operatorlogin, invalid serial number, date older than 180 days
+ * - `9` (Request Rejected) - Journal already exists, same transaction pending, voucher number missing, unable to save transaction
+ * - `12` (Invalid Site) - Site not part of company
+ * - `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const transactionCreateTransaction: <ThrowOnError extends boolean = false>(options: Options<TransactionCreateTransactionData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<TransactionCreateTransactionResponses, TransactionCreateTransactionErrors, ThrowOnError, "fields">;
+/**
+ * Validate Email Address
+ *
+ * Validates an email address by checking:
+ * 1. Email format validity
+ * 2. Domain has valid MX records
+ *
+ * Returns detailed validation results including overall validity status.
+ *
+ * **Error codes:**
+ * * `8` (Missing Data) - Request body is empty or `email` field is missing
+ * * `3` (Invalid Function) - Request method is not POST
+ */
+export declare const emailValidationValidateEmail: <ThrowOnError extends boolean = false>(options: Options<EmailValidationValidateEmailData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<EmailValidationValidateEmailResponses, EmailValidationValidateEmailErrors, ThrowOnError, "fields">;
+/**
+ * Get Version Information
+ *
+ * Get API version information and available function sections
+ */
+export declare const versionGetVersion: <ThrowOnError extends boolean = false>(options?: Options<VersionGetVersionData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<VersionGetVersionResponses, VersionGetVersionErrors, ThrowOnError, "fields">;
+/**
+ * Delete Voucher
+ *
+ * Delete (cancel) a voucher. Sets the voucher status to 'C' (Cancelled).
+ *
+ * Requires the voucher serial number, PIN (for verification when enabled),
+ * and site code. The voucher record is not physically removed.
+ *
+ * Request body must be wrapped in a `voucher` key: `{"voucher": {...}}`.
+ *
+ * **Required scope:** `DELETE_VOUCHER`
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Voucher not found
+ * - `8` (Missing Data) - Body missing, missing serial number, missing PIN, missing site, invalid site
+ * - `9` (Request Rejected) - Invalid PIN
+ * - `11` (Database Error) - Database error during deletion
+ * - `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const voucherDeleteVoucher: <ThrowOnError extends boolean = false>(options: Options<VoucherDeleteVoucherData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<VoucherDeleteVoucherResponses, VoucherDeleteVoucherErrors, ThrowOnError, "fields">;
+/**
+ * Get Voucher Type
+ *
+ * Get voucher type information.
+ *
+ * Returns all settings for the specified voucher type from the VOUCHERTYPE table.
+ * If the voucher type path segment is omitted, defaults to 'Gift'.
+ *
+ * **Required scope:** `READ_VOUCHER`
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Voucher type not found
+ */
+export declare const voucherGetVoucherType: <ThrowOnError extends boolean = false>(options: Options<VoucherGetVoucherTypeData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<VoucherGetVoucherTypeResponses, VoucherGetVoucherTypeErrors, ThrowOnError, "fields">;
+/**
+ * Create Voucher
+ *
+ * Create a new voucher. If the serial number is omitted and the company has
+ * lead characters configured, a serial number will be auto-generated.
+ *
+ * For web vouchers (`isWebVoucher: true`), payment charge information including
+ * a `processId` from the payment gateway is required. Duplicate processIds
+ * will be rejected.
+ *
+ * Request body must be wrapped in a `voucher` key: `{"voucher": {...}}`.
+ *
+ * **Required scope:** `WRITE_VOUCHER`
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `8` (Missing Data) - Body missing, missing amount, missing site, missing voucher number
+ * - `9` (Request Rejected) - Voucher exists, invalid amount, invalid terminal, duplicate payment, missing payment info
+ * - `11` (Database Error) - Database error during creation
+ * - `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const voucherCreateVoucher: <ThrowOnError extends boolean = false>(options: Options<VoucherCreateVoucherData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<VoucherCreateVoucherResponses, VoucherCreateVoucherErrors, ThrowOnError, "fields">;
+/**
+ * Enquire Voucher
+ *
+ * Enquire about a voucher's current status, balance, and transaction history.
+ * Returns detailed voucher information including up to 50 most recent transactions.
+ *
+ * PIN verification may be required depending on company settings. POS requests
+ * (`ispos: true`) bypass PIN checking. The `READ_VOUCHER_PINLESS` scope also
+ * bypasses PIN checking.
+ *
+ * Vouchers in Cancelled (C), Locked (L), or Written Off (W) status will be rejected
+ * (though for enquire, expiry is NOT checked unlike other operations).
+ *
+ * Request body must be wrapped in a `voucher` key: `{"voucher": {...}}`.
+ *
+ * **Required scope:** `WRITE_VOUCHER`
+ *
+ * **Voucher Status Codes:**
+ *
+ * | Code | Status |
+ * |------|--------|
+ * | A | Available |
+ * | S | Sold |
+ * | Z | Recharged |
+ * | R | Redeemed |
+ * | P | Part Redeemed |
+ * | G | Given Away |
+ * | C | Cancelled |
+ * | L | Locked |
+ * | H | Pending Sale |
+ * | r | Pending Full Redeem |
+ * | p | Pending Part Redeem |
+ * | I | Import |
+ * | W | Written Off |
+ * | E | Portal Edit |
+ */
+export declare const voucherEnquireVoucher: <ThrowOnError extends boolean = false>(options: Options<VoucherEnquireVoucherData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<VoucherEnquireVoucherResponses, VoucherEnquireVoucherErrors, ThrowOnError, "fields">;
+/**
+ * Get Voucher Image
+ *
+ * Get voucher barcode image URL.
+ *
+ * Returns a URL to the barcode image for the specified voucher serial number.
+ * If the image does not exist, it will be generated on demand.
+ * Serial number must be between 4 and 13 characters.
+ *
+ * **Required scope:** `READ_VOUCHER`
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `9` (Request Rejected) - Serial number length out of range (4-13 chars)
+ */
+export declare const voucherGetVoucherImage: <ThrowOnError extends boolean = false>(options: Options<VoucherGetVoucherImageData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<VoucherGetVoucherImageResponses, VoucherGetVoucherImageErrors, ThrowOnError, "fields">;
+/**
+ * Recharge Voucher
+ *
+ * Recharge (top up) an existing voucher with additional funds.
+ *
+ * For web vouchers (`isWebVoucher: true`), payment charge information including
+ * a `processId` from the payment gateway is required. Duplicate payments
+ * (same `processId`) will be rejected.
+ *
+ * Auto-recharge settings, payment option, and token are preserved from the
+ * existing voucher record and cannot be changed via this endpoint.
+ *
+ * Supports gift recharges (`isgift: true`) where the recharge notification
+ * is sent to a different recipient. Optional message fields can be included.
+ *
+ * PIN is not validated for recharge operations.
+ *
+ * Request body must be wrapped in a `voucher` key: `{"voucher": {...}}`.
+ *
+ * **Required scope:** `WRITE_VOUCHER`
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Voucher not found
+ * - `8` (Missing Data) - Missing amount, missing site, body missing
+ * - `9` (Request Rejected) - Invalid amount, voucher expired, invalid state, invalid terminal, duplicate payment, missing payment info
+ * - `11` (Database Error) - Database error during recharge
+ * - `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const voucherRechargeVoucher: <ThrowOnError extends boolean = false>(options: Options<VoucherRechargeVoucherData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<VoucherRechargeVoucherResponses, VoucherRechargeVoucherErrors, ThrowOnError, "fields">;
+/**
+ * Redeem Voucher
+ *
+ * Redeem an amount from a voucher. The redemption amount must not exceed the
+ * available balance. Expired, cancelled, locked, or written-off vouchers
+ * cannot be redeemed.
+ *
+ * For POS requests (`ispos: true`), `location` and `terminal` are required
+ * and a `reference` (site:terminal:journal) is included in the response.
+ *
+ * Request body must be wrapped in a `voucher` key: `{"voucher": {...}}`.
+ *
+ * **Required scope:** `WRITE_VOUCHER`
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Voucher not found
+ * - `8` (Missing Data) - Missing amount, missing site, invalid site, body missing
+ * - `9` (Request Rejected) - Invalid amount, insufficient balance, voucher expired, invalid state, invalid PIN, invalid terminal
+ * - `11` (Database Error) - Database error during redemption
+ * - `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const voucherRedeemVoucher: <ThrowOnError extends boolean = false>(options: Options<VoucherRedeemVoucherData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<VoucherRedeemVoucherResponses, VoucherRedeemVoucherErrors, ThrowOnError, "fields">;
+/**
+ * Release Voucher Reserve
+ *
+ * Release a previously reserved amount on a voucher, making the funds
+ * available again. The release amount must not exceed the currently
+ * reserved amount.
+ *
+ * Request body must be wrapped in a `voucher` key: `{"voucher": {...}}`.
+ *
+ * **Required scope:** `WRITE_VOUCHER`
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Voucher not found
+ * - `8` (Missing Data) - Missing amount, body missing
+ * - `9` (Request Rejected) - Invalid amount, release exceeds reserved, no current reserve, voucher expired, invalid state
+ * - `11` (Database Error) - Database error during release
+ * - `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const voucherReleaseVoucher: <ThrowOnError extends boolean = false>(options: Options<VoucherReleaseVoucherData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<VoucherReleaseVoucherResponses, VoucherReleaseVoucherErrors, ThrowOnError, "fields">;
+/**
+ * Reserve Voucher Amount
+ *
+ * Reserve an amount on a voucher, reducing its available balance without
+ * actually redeeming it. The reserved amount can later be redeemed or released.
+ *
+ * The reserve amount must not exceed the current available balance
+ * (value - used - pending).
+ *
+ * Request body must be wrapped in a `voucher` key: `{"voucher": {...}}`.
+ *
+ * **Required scope:** `WRITE_VOUCHER`
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Voucher not found
+ * - `8` (Missing Data) - Missing amount, body missing
+ * - `9` (Request Rejected) - Invalid amount, insufficient balance, voucher expired, invalid state, invalid PIN
+ * - `11` (Database Error) - Database error during reserve
+ * - `45` (Invalid JSON) - Request body is not valid JSON
+ */
+export declare const voucherReserveVoucher: <ThrowOnError extends boolean = false>(options: Options<VoucherReserveVoucherData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<VoucherReserveVoucherResponses, VoucherReserveVoucherErrors, ThrowOnError, "fields">;
+/**
+ * Search Vouchers
+ *
+ * Search for vouchers by various criteria.
+ *
+ * Returns up to 150 matching vouchers. The search value is passed as the
+ * raw query string (e.g., `/voucher/Gift/search/number?V12345`).
+ *
+ * For the non-flat endpoint, the response includes a `version` key inside
+ * the `vouchers` object alongside the numeric-indexed items.
+ *
+ * When searching for 'Gift' type, both 'Gift' and 'GiveAway' vouchers
+ * are included in results.
+ *
+ * **Required scope:** `READ_VOUCHER`
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Missing search criteria or no vouchers found
+ */
+export declare const voucherSearchVouchers: <ThrowOnError extends boolean = false>(options: Options<VoucherSearchVouchersData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<VoucherSearchVouchersResponses, VoucherSearchVouchersErrors, ThrowOnError, "fields">;
+/**
+ * Search Vouchers (Flat Format)
+ *
+ * Search for vouchers (flattened response format).
+ *
+ * Same as the regular search but without the `version` key in the response.
+ * Returns up to 150 matching vouchers.
+ *
+ * **Required scope:** `READ_VOUCHER`
+ *
+ * **Error codes:**
+ * - `1` (Invalid Access Key) - Invalid or missing API key/scope
+ * - `4` (Not Found) - Missing search criteria or no vouchers found
+ */
+export declare const voucherSearchVouchersFlat: <ThrowOnError extends boolean = false>(options: Options<VoucherSearchVouchersFlatData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<VoucherSearchVouchersFlatResponses, VoucherSearchVouchersFlatErrors, ThrowOnError, "fields">;
+//# sourceMappingURL=sdk.gen.d.ts.map