@typewoo/sdk 3.7.6 → 4.0.0-alpha.0

package/dist/lib/types/analytics/customers.types.d.ts

@@ -23,54 +23,64 @@ export declare const AnalyticsCustomerSchema: z.ZodObject<{
     city: z.ZodString;
     state: z.ZodString;
     postcode: z.ZodString;
-    date_registered: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    date_registered_gmt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    date_last_active: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    date_last_active_gmt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    date_last_order: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    date_registered: z.ZodOptional<z.ZodString>;
+    date_registered_gmt: z.ZodOptional<z.ZodString>;
+    date_last_active: z.ZodOptional<z.ZodString>;
+    date_last_active_gmt: z.ZodOptional<z.ZodString>;
     orders_count: z.ZodNumber;
     total_spend: z.ZodNumber;
     avg_order_value: z.ZodNumber;
     email: z.ZodOptional<z.ZodString>;
-    _links: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
-        href: z.ZodString;
-    }, z.core.$strip>>>>;
-}, z.core.$strip>;
+}, z.core.$loose>;
 export type AnalyticsCustomer = z.infer<typeof AnalyticsCustomerSchema>;
 /**
  * Query parameters for customers stats endpoint
  */
 export declare const AnalyticsCustomersStatsQueryParamsSchema: z.ZodObject<{
-    before: z.ZodOptional<z.ZodString>;
-    after: z.ZodOptional<z.ZodString>;
-    interval: z.ZodOptional<z.ZodEnum<{
-        hour: "hour";
-        day: "day";
-        week: "week";
-        month: "month";
-        quarter: "quarter";
-        year: "year";
-    }>>;
-    page: z.ZodOptional<z.ZodNumber>;
-    per_page: z.ZodOptional<z.ZodNumber>;
-    orderby: z.ZodOptional<z.ZodString>;
-    order: z.ZodOptional<z.ZodEnum<{
-        asc: "asc";
-        desc: "desc";
-    }>>;
-    force_cache_refresh: z.ZodOptional<z.ZodBoolean>;
-    fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    match: z.ZodOptional<z.ZodEnum<{
+    match: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
         any: "any";
         all: "all";
-    }>>;
+    }>>>;
     search: z.ZodOptional<z.ZodString>;
-    searchby: z.ZodOptional<z.ZodEnum<{
+    searchby: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+        all: "all";
         name: "name";
         username: "username";
         email: "email";
-    }>>;
+    }>>>;
     customers: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    customers_exclude: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    name_includes: z.ZodOptional<z.ZodString>;
+    name_excludes: z.ZodOptional<z.ZodString>;
+    username_includes: z.ZodOptional<z.ZodString>;
+    username_excludes: z.ZodOptional<z.ZodString>;
+    email_includes: z.ZodOptional<z.ZodString>;
+    email_excludes: z.ZodOptional<z.ZodString>;
+    country_includes: z.ZodOptional<z.ZodString>;
+    country_excludes: z.ZodOptional<z.ZodString>;
+    registered_before: z.ZodOptional<z.ZodString>;
+    registered_after: z.ZodOptional<z.ZodString>;
+    registered_between: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    last_active_before: z.ZodOptional<z.ZodString>;
+    last_active_after: z.ZodOptional<z.ZodString>;
+    last_active_between: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    last_order_before: z.ZodOptional<z.ZodString>;
+    last_order_after: z.ZodOptional<z.ZodString>;
+    orders_count_min: z.ZodOptional<z.ZodNumber>;
+    orders_count_max: z.ZodOptional<z.ZodNumber>;
+    orders_count_between: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    total_spend_min: z.ZodOptional<z.ZodNumber>;
+    total_spend_max: z.ZodOptional<z.ZodNumber>;
+    total_spend_between: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    avg_order_value_min: z.ZodOptional<z.ZodNumber>;
+    avg_order_value_max: z.ZodOptional<z.ZodNumber>;
+    avg_order_value_between: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    force_cache_refresh: z.ZodOptional<z.ZodBoolean>;
+    context: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+        edit: "edit";
+        view: "view";
+    }>>>;
 }, z.core.$strip>;
 export type AnalyticsCustomersStatsQueryParams = z.infer<typeof AnalyticsCustomersStatsQueryParamsSchema>;
 /**
@@ -79,29 +89,88 @@ export type AnalyticsCustomersStatsQueryParams = z.infer<typeof AnalyticsCustome
 export declare const AnalyticsCustomersListQueryParamsSchema: z.ZodObject<{
     before: z.ZodOptional<z.ZodString>;
     after: z.ZodOptional<z.ZodString>;
-    page: z.ZodOptional<z.ZodNumber>;
-    per_page: z.ZodOptional<z.ZodNumber>;
-    orderby: z.ZodOptional<z.ZodString>;
-    order: z.ZodOptional<z.ZodEnum<{
+    page: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+    per_page: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+    order: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
         asc: "asc";
         desc: "desc";
-    }>>;
-    extended_info: z.ZodOptional<z.ZodBoolean>;
+    }>>>;
     force_cache_refresh: z.ZodOptional<z.ZodBoolean>;
-    match: z.ZodOptional<z.ZodEnum<{
+    match: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
         any: "any";
         all: "all";
-    }>>;
+    }>>>;
     search: z.ZodOptional<z.ZodString>;
-    searchby: z.ZodOptional<z.ZodEnum<{
+    searchby: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+        all: "all";
         name: "name";
         username: "username";
         email: "email";
-    }>>;
+    }>>>;
     customers: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
-    name: z.ZodOptional<z.ZodString>;
-    email: z.ZodOptional<z.ZodString>;
-    country: z.ZodOptional<z.ZodString>;
+    orderby: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+        orders_count: "orders_count";
+        avg_order_value: "avg_order_value";
+        name: "name";
+        username: "username";
+        first_name: "first_name";
+        last_name: "last_name";
+        country: "country";
+        city: "city";
+        state: "state";
+        postcode: "postcode";
+        date_registered: "date_registered";
+        date_last_active: "date_last_active";
+        total_spend: "total_spend";
+        email: "email";
+        location: "location";
+    }>>>;
+    context: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+        edit: "edit";
+        view: "view";
+    }>>>;
+    customers_exclude: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    filter_empty: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        name: "name";
+        country: "country";
+        city: "city";
+        state: "state";
+        postcode: "postcode";
+        email: "email";
+    }>>>;
+    last_active_after: z.ZodOptional<z.ZodString>;
+    last_active_before: z.ZodOptional<z.ZodString>;
+    last_active_between: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    last_order_after: z.ZodOptional<z.ZodString>;
+    last_order_before: z.ZodOptional<z.ZodString>;
+    location_excludes: z.ZodOptional<z.ZodString>;
+    location_includes: z.ZodOptional<z.ZodString>;
+    name_includes: z.ZodOptional<z.ZodString>;
+    name_excludes: z.ZodOptional<z.ZodString>;
+    email_includes: z.ZodOptional<z.ZodString>;
+    email_excludes: z.ZodOptional<z.ZodString>;
+    country_includes: z.ZodOptional<z.ZodString>;
+    country_excludes: z.ZodOptional<z.ZodString>;
+    orders_count_between: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    orders_count_max: z.ZodOptional<z.ZodNumber>;
+    orders_count_min: z.ZodOptional<z.ZodNumber>;
+    registered_after: z.ZodOptional<z.ZodString>;
+    registered_before: z.ZodOptional<z.ZodString>;
+    registered_between: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    total_spend_between: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    total_spend_max: z.ZodOptional<z.ZodNumber>;
+    total_spend_min: z.ZodOptional<z.ZodNumber>;
+    avg_order_value_between: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    avg_order_value_max: z.ZodOptional<z.ZodNumber>;
+    avg_order_value_min: z.ZodOptional<z.ZodNumber>;
+    user_type: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+        all: "all";
+        guest: "guest";
+        registered: "registered";
+    }>>>;
+    username_excludes: z.ZodOptional<z.ZodString>;
+    username_includes: z.ZodOptional<z.ZodString>;
+    users: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
 }, z.core.$strip>;
 export type AnalyticsCustomersListQueryParams = z.infer<typeof AnalyticsCustomersListQueryParamsSchema>;
 //# sourceMappingURL=customers.types.d.ts.map

package/dist/lib/types/analytics/customers.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"customers.types.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/analytics/customers.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAOxB;;GAEG;AACH,eAAO,MAAM,4BAA4B;;;;;iBAKvC,CAAC;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAC1C,OAAO,4BAA4B,CACpC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;iBAqBlC,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,wCAAwC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAMjD,CAAC;AACL,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,wCAAwC,CAChD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uCAAuC;;;;;;;;;;;;;;;;;;;;;;;;;;iBAShD,CAAC;AACL,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,uCAAuC,CAC/C,CAAC"}
+{"version":3,"file":"customers.types.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/analytics/customers.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AA8FxB;;GAEG;AACH,eAAO,MAAM,4BAA4B;;;;;iBAKvC,CAAC;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAC1C,OAAO,4BAA4B,CACpC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;iBAmBlC,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,wCAAwC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAkLnD,CAAC;AACH,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,wCAAwC,CAChD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uCAAuC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAyNhD,CAAC;AACL,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,uCAAuC,CAC/C,CAAC"}

package/dist/lib/types/analytics/customers.types.js

@@ -1,5 +1,81 @@
 import { z } from 'zod';
-import { AnalyticsStatsQueryParamsSchema, AnalyticsListQueryParamsSchema, AnalyticsLinksSchema, } from './common.types.js';
+const AnalyticsIntervalEnum = z.enum([
+    'hour',
+    'day',
+    'week',
+    'month',
+    'quarter',
+    'year',
+]);
+const AnalyticsStatsQueryParamsSchema = z.object({
+    before: z
+        .string()
+        .optional()
+        .describe('Limit response to resources published before a given ISO8601 compliant date.'),
+    after: z
+        .string()
+        .optional()
+        .describe('Limit response to resources published after a given ISO8601 compliant date.'),
+    interval: AnalyticsIntervalEnum.optional().describe('Time interval to use for buckets in the returned data.'),
+    page: z.number().optional().describe('Current page of the collection.'),
+    per_page: z
+        .number()
+        .optional()
+        .describe('Maximum number of items to be returned in result set.'),
+    orderby: z
+        .string()
+        .optional()
+        .describe('Sort collection by object attribute.'),
+    order: z
+        .enum(['asc', 'desc'])
+        .optional()
+        .describe('Order sort attribute ascending or descending.'),
+    force_cache_refresh: z
+        .boolean()
+        .optional()
+        .describe('Force retrieval of fresh data instead of from the cache.'),
+    fields: z
+        .array(z.string())
+        .optional()
+        .describe('Limit stats fields to the specified items.'),
+});
+const AnalyticsListQueryParamsSchema = z.object({
+    before: z
+        .string()
+        .optional()
+        .describe('Limit response to resources published before a given ISO8601 compliant date.'),
+    after: z
+        .string()
+        .optional()
+        .describe('Limit response to resources published after a given ISO8601 compliant date.'),
+    page: z
+        .number()
+        .default(1)
+        .optional()
+        .describe('Current page of the collection.'),
+    per_page: z
+        .number()
+        .default(10)
+        .optional()
+        .describe('Maximum number of items to be returned in result set.'),
+    orderby: z
+        .string()
+        .optional()
+        .describe('Sort collection by object attribute.'),
+    order: z
+        .enum(['asc', 'desc'])
+        .default('desc')
+        .optional()
+        .describe('Order sort attribute ascending or descending.'),
+    extended_info: z
+        .boolean()
+        .optional()
+        .describe('Add additional piece of info about each category to the report.'),
+    force_cache_refresh: z
+        .boolean()
+        .optional()
+        .describe('Force retrieval of fresh data instead of from the cache.'),
+});
 /**
  * Customer stats totals/subtotals shape
  */
@@ -12,47 +88,338 @@ export const AnalyticsCustomerStatsSchema = z.object({
 /**
  * Single customer row from the customers detail endpoint
  */
-export const AnalyticsCustomerSchema = z.object({
-    id: z.number(),
-    user_id: z.number(),
-    name: z.string(),
-    username: z.string(),
-    first_name: z.string().optional(),
-    last_name: z.string().optional(),
-    country: z.string(),
-    city: z.string(),
-    state: z.string(),
-    postcode: z.string(),
-    date_registered: z.string().nullable().optional(),
-    date_registered_gmt: z.string().nullable().optional(),
-    date_last_active: z.string().nullable().optional(),
-    date_last_active_gmt: z.string().nullable().optional(),
-    date_last_order: z.string().nullable().optional(),
-    orders_count: z.number(),
-    total_spend: z.number(),
-    avg_order_value: z.number(),
-    email: z.string().optional(),
-    _links: AnalyticsLinksSchema.optional(),
+export const AnalyticsCustomerSchema = z.looseObject({
+    id: z.number().describe('Customer ID.'),
+    user_id: z.number().describe('User ID.'),
+    name: z.string().describe('Name.'),
+    username: z.string().describe('Username.'),
+    first_name: z.string().optional().describe('First name.'),
+    last_name: z.string().optional().describe('Last name.'),
+    country: z.string().describe('Country / Region.'),
+    city: z.string().describe('City.'),
+    state: z.string().describe('Region.'),
+    postcode: z.string().describe('Postal code.'),
+    date_registered: z.string().optional().describe('Date registered.'),
+    date_registered_gmt: z.string().optional().describe('Date registered GMT.'),
+    date_last_active: z.string().optional().describe('Date last active.'),
+    date_last_active_gmt: z.string().optional().describe('Date last active GMT.'),
+    orders_count: z.number().describe('Order count.'),
+    total_spend: z.number().describe('Total spend.'),
+    avg_order_value: z.number().describe('Avg order value.'),
+    email: z.string().optional().describe('Email address.'),
 });
 /**
  * Query parameters for customers stats endpoint
  */
-export const AnalyticsCustomersStatsQueryParamsSchema = AnalyticsStatsQueryParamsSchema.extend({
-    match: z.enum(['all', 'any']).optional(),
-    search: z.string().optional(),
-    searchby: z.enum(['name', 'username', 'email']).optional(),
-    customers: z.array(z.number()).optional(),
+export const AnalyticsCustomersStatsQueryParamsSchema = z.object({
+    match: z
+        .enum(['all', 'any'])
+        .default('all')
+        .optional()
+        .describe('Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories'),
+    search: z
+        .string()
+        .optional()
+        .describe('Limit response to objects with a customer field containing the search term. Searches the field provided by `searchby`.'),
+    searchby: z
+        .enum(['all', 'email', 'name', 'username'])
+        .default('name')
+        .optional()
+        .describe('Limit results with `search` and `searchby` to specific fields containing the search term.'),
+    customers: z
+        .array(z.number())
+        .optional()
+        .describe('Limit result to items with specified customer ids.'),
+    customers_exclude: z
+        .array(z.number())
+        .optional()
+        .describe('Limit result to exclude items with specified customer ids.'),
+    name_includes: z
+        .string()
+        .optional()
+        .describe('Limit response to objects with specific names.'),
+    name_excludes: z
+        .string()
+        .optional()
+        .describe('Limit response to objects excluding specific names.'),
+    username_includes: z
+        .string()
+        .optional()
+        .describe('Limit response to objects with specific usernames.'),
+    username_excludes: z
+        .string()
+        .optional()
+        .describe('Limit response to objects excluding specific usernames.'),
+    email_includes: z
+        .string()
+        .optional()
+        .describe('Limit response to objects including emails.'),
+    email_excludes: z
+        .string()
+        .optional()
+        .describe('Limit response to objects excluding emails.'),
+    country_includes: z
+        .string()
+        .optional()
+        .describe('Limit response to objects with specific countries.'),
+    country_excludes: z
+        .string()
+        .optional()
+        .describe('Limit response to objects excluding specific countries.'),
+    registered_before: z
+        .string()
+        .optional()
+        .describe('Limit response to objects registered before (or at) a given ISO8601 compliant datetime.'),
+    registered_after: z
+        .string()
+        .optional()
+        .describe('Limit response to objects registered after (or at) a given ISO8601 compliant datetime.'),
+    registered_between: z
+        .array(z.string())
+        .optional()
+        .describe('Limit response to objects last active between two given ISO8601 compliant datetime.'),
+    last_active_before: z
+        .string()
+        .optional()
+        .describe('Limit response to objects last active before (or at) a given ISO8601 compliant datetime.'),
+    last_active_after: z
+        .string()
+        .optional()
+        .describe('Limit response to objects last active after (or at) a given ISO8601 compliant datetime.'),
+    last_active_between: z
+        .array(z.string())
+        .optional()
+        .describe('Limit response to objects last active between two given ISO8601 compliant datetime.'),
+    last_order_before: z
+        .string()
+        .optional()
+        .describe('Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.'),
+    last_order_after: z
+        .string()
+        .optional()
+        .describe('Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.'),
+    orders_count_min: z
+        .number()
+        .optional()
+        .describe('Limit response to objects with an order count greater than or equal to given integer.'),
+    orders_count_max: z
+        .number()
+        .optional()
+        .describe('Limit response to objects with an order count less than or equal to given integer.'),
+    orders_count_between: z
+        .array(z.number())
+        .optional()
+        .describe('Limit response to objects with an order count between two given integers.'),
+    total_spend_min: z
+        .number()
+        .optional()
+        .describe('Limit response to objects with a total order spend greater than or equal to given number.'),
+    total_spend_max: z
+        .number()
+        .optional()
+        .describe('Limit response to objects with a total order spend less than or equal to given number.'),
+    total_spend_between: z
+        .array(z.number())
+        .optional()
+        .describe('Limit response to objects with a total order spend between two given numbers.'),
+    avg_order_value_min: z
+        .number()
+        .optional()
+        .describe('Limit response to objects with an average order spend greater than or equal to given number.'),
+    avg_order_value_max: z
+        .number()
+        .optional()
+        .describe('Limit response to objects with an average order spend less than or equal to given number.'),
+    avg_order_value_between: z
+        .array(z.number())
+        .optional()
+        .describe('Limit response to objects with an average order spend between two given numbers.'),
+    fields: z
+        .array(z.string())
+        .optional()
+        .describe('Limit stats fields to the specified items.'),
+    force_cache_refresh: z
+        .boolean()
+        .optional()
+        .describe('Force retrieval of fresh data instead of from the cache.'),
+    context: z
+        .enum(['edit', 'view'])
+        .default('view')
+        .optional()
+        .describe('Scope under which the request is made; determines fields present in response.'),
 });
 /**
  * Query parameters for customers list (detail) endpoint
  */
-export const AnalyticsCustomersListQueryParamsSchema = AnalyticsListQueryParamsSchema.extend({
-    match: z.enum(['all', 'any']).optional(),
-    search: z.string().optional(),
-    searchby: z.enum(['name', 'username', 'email']).optional(),
-    customers: z.array(z.number()).optional(),
-    name: z.string().optional(),
-    email: z.string().optional(),
-    country: z.string().optional(),
+export const AnalyticsCustomersListQueryParamsSchema = AnalyticsListQueryParamsSchema.omit({ extended_info: true }).extend({
+    match: z
+        .enum(['all', 'any'])
+        .default('all')
+        .optional()
+        .describe('Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories'),
+    search: z
+        .string()
+        .optional()
+        .describe('Limit response to objects with a customer field containing the search term. Searches the field provided by `searchby`.'),
+    searchby: z
+        .enum(['all', 'email', 'name', 'username'])
+        .default('name')
+        .optional()
+        .describe('Limit results with `search` and `searchby` to specific fields containing the search term.'),
+    customers: z
+        .array(z.number())
+        .optional()
+        .describe('Limit result to items with specified customer ids.'),
+    orderby: z
+        .enum([
+        'avg_order_value',
+        'city',
+        'country',
+        'date_last_active',
+        'date_registered',
+        'email',
+        'first_name',
+        'last_name',
+        'location',
+        'name',
+        'orders_count',
+        'postcode',
+        'state',
+        'total_spend',
+        'username',
+    ])
+        .default('date_registered')
+        .optional()
+        .describe('Sort collection by object attribute.'),
+    context: z
+        .enum(['edit', 'view'])
+        .default('view')
+        .optional()
+        .describe('Scope under which the request is made; determines fields present in response.'),
+    customers_exclude: z
+        .array(z.number())
+        .optional()
+        .describe('Limit result to exclude items with specified customer ids.'),
+    filter_empty: z
+        .array(z.enum(['city', 'country', 'email', 'name', 'postcode', 'state']))
+        .optional()
+        .describe('Filter out results where any of the passed fields are empty'),
+    last_active_after: z
+        .string()
+        .optional()
+        .describe('Limit response to objects last active after (or at) a given ISO8601 compliant datetime.'),
+    last_active_before: z
+        .string()
+        .optional()
+        .describe('Limit response to objects last active before (or at) a given ISO8601 compliant datetime.'),
+    last_active_between: z
+        .array(z.string())
+        .optional()
+        .describe('Limit response to objects last active between two given ISO8601 compliant datetime.'),
+    last_order_after: z
+        .string()
+        .optional()
+        .describe('Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.'),
+    last_order_before: z
+        .string()
+        .optional()
+        .describe('Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.'),
+    location_excludes: z
+        .string()
+        .optional()
+        .describe('Excludes customers by location (state, country). Provide a comma-separated list of locations. Each location can be a country code (e.g. GB) or combination of country and state (e.g. US:CA).'),
+    location_includes: z
+        .string()
+        .optional()
+        .describe('Includes customers by location (state, country). Provide a comma-separated list of locations. Each location can be a country code (e.g. GB) or combination of country and state (e.g. US:CA).'),
+    name_includes: z
+        .string()
+        .optional()
+        .describe('Limit response to objects with specific names.'),
+    name_excludes: z
+        .string()
+        .optional()
+        .describe('Limit response to objects excluding specific names.'),
+    email_includes: z
+        .string()
+        .optional()
+        .describe('Limit response to objects including emails.'),
+    email_excludes: z
+        .string()
+        .optional()
+        .describe('Limit response to objects excluding emails.'),
+    country_includes: z
+        .string()
+        .optional()
+        .describe('Limit response to objects with specific countries.'),
+    country_excludes: z
+        .string()
+        .optional()
+        .describe('Limit response to objects excluding specific countries.'),
+    orders_count_between: z
+        .array(z.number())
+        .optional()
+        .describe('Limit response to objects with an order count between two given integers.'),
+    orders_count_max: z
+        .number()
+        .optional()
+        .describe('Limit response to objects with an order count less than or equal to given integer.'),
+    orders_count_min: z
+        .number()
+        .optional()
+        .describe('Limit response to objects with an order count greater than or equal to given integer.'),
+    registered_after: z
+        .string()
+        .optional()
+        .describe('Limit response to objects registered after (or at) a given ISO8601 compliant datetime.'),
+    registered_before: z
+        .string()
+        .optional()
+        .describe('Limit response to objects registered before (or at) a given ISO8601 compliant datetime.'),
+    registered_between: z
+        .array(z.string())
+        .optional()
+        .describe('Limit response to objects last active between two given ISO8601 compliant datetime.'),
+    total_spend_between: z
+        .array(z.number())
+        .optional()
+        .describe('Limit response to objects with a total order spend between two given numbers.'),
+    total_spend_max: z
+        .number()
+        .optional()
+        .describe('Limit response to objects with a total order spend less than or equal to given number.'),
+    total_spend_min: z
+        .number()
+        .optional()
+        .describe('Limit response to objects with a total order spend greater than or equal to given number.'),
+    avg_order_value_between: z
+        .array(z.number())
+        .optional()
+        .describe('Limit response to objects with an average order spend between two given numbers.'),
+    avg_order_value_max: z
+        .number()
+        .optional()
+        .describe('Limit response to objects with an average order spend less than or equal to given number.'),
+    avg_order_value_min: z
+        .number()
+        .optional()
+        .describe('Limit response to objects with an average order spend greater than or equal to given number.'),
+    user_type: z
+        .enum(['all', 'guest', 'registered'])
+        .default('all')
+        .optional()
+        .describe('Limit result to items with specified user type.'),
+    username_excludes: z
+        .string()
+        .optional()
+        .describe('Limit response to objects excluding specific usernames.'),
+    username_includes: z
+        .string()
+        .optional()
+        .describe('Limit response to objects with specific usernames.'),
+    users: z
+        .array(z.number())
+        .optional()
+        .describe('Limit result to items with specified user ids.'),
 });
 //# sourceMappingURL=customers.types.js.map