import { BaseFilterable, OperatorMap } from "../../dal"; import { FindParams } from "../common"; export interface BaseCustomerGroup { id: string; name: string | null; customers: BaseCustomer[]; metadata: Record | null; created_at: string; updated_at: string; } export interface BaseCustomerAddress { /** * The address's ID. */ id: string; /** * The address's name. */ address_name: string | null; /** * Whether the address is used by default for shipping. */ is_default_shipping: boolean; /** * Whether the address is used by default for billing. */ is_default_billing: boolean; /** * The ID of the customer this address belongs to. */ customer_id: string; /** * The address's company. */ company: string | null; /** * The address's first name. */ first_name: string | null; /** * The address's last name. */ last_name: string | null; /** * The address's first line. */ address_1: string | null; /** * The address's second line. */ address_2: string | null; /** * The address's city. */ city: string | null; /** * The address's country code. * * @example * us */ country_code: string | null; /** * The address's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province. */ province: string | null; /** * The address's postal code. */ postal_code: string | null; /** * The address's phone number. */ phone: string | null; /** * Key-value pairs of custom data. */ metadata: Record | null; /** * The date the address was created. */ created_at: string; /** * The date the address was updated. */ updated_at: string; } export interface BaseCustomer { /** * The customer's ID. */ id: string; /** * The customer's email. */ email: string; /** * The ID of the customer's default billing address. */ default_billing_address_id: string | null; /** * The ID of the customer's default shipping address. */ default_shipping_address_id: string | null; /** * The customer's company name. */ company_name: string | null; /** * The customer's first name. */ first_name: string | null; /** * The customer's last name. */ last_name: string | null; /** * The customer's addresses */ addresses: BaseCustomerAddress[]; /** * The customer's phone. */ phone?: string | null; /** * Key-value pairs of custom data. */ metadata?: Record; /** * The ID of the user that created the customer. */ created_by?: string | null; /** * The date the customer was deleted. */ deleted_at?: Date | string | null; /** * The date the customer was created. */ created_at?: Date | string; /** * The date the customer was updated. */ updated_at?: Date | string; } export interface CustomerGroupInCustomerFilters { /** * Filter by customer group ID(s). */ id: string[] | string; /** * Filter by name(s). */ name: string[] | string; /** * Apply filters on the group's creation date. */ created_at: OperatorMap; /** * Apply filters on the group's update date. */ updated_at: OperatorMap; /** * Apply filters on the group's deletion date. */ deleted_at: OperatorMap; } export interface BaseCustomerFilters extends FindParams, BaseFilterable { /** * Query or keywords to apply on the customer's searchable fields. */ q?: string; /** * Filter by customer ID(s). */ id?: string[] | string | OperatorMap; /** * Filter by email(s). */ email?: string[] | string | OperatorMap; /** * Filter by company name(s). */ company_name?: string[] | string | OperatorMap; /** * Filter by first name(s). */ first_name?: string[] | string | OperatorMap; /** * Filter by last name(s). */ last_name?: string[] | string | OperatorMap; /** * Filter by user ID(s) to retrieve the customers they created. */ created_by?: string[] | string | OperatorMap; /** * Apply filters on the customer's creation date. */ created_at?: OperatorMap; /** * Apply filters on the customer's update date. */ updated_at?: OperatorMap; /** * Apply filters on the customer's deletion date. */ deleted_at?: OperatorMap; } export interface BaseCustomerAddressFilters extends BaseFilterable { /** * A query or keyword to search the address's searchable fields. */ q?: string; /** * Filter by company name(s). */ company?: string[] | string; /** * Filter by cities. */ city?: string[] | string; /** * Filter by country code(s). */ country_code?: string[] | string; /** * Filter by lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code(s). */ province?: string[] | string; /** * Filter by postal code(s). */ postal_code?: string[] | string; } export interface BaseCreateCustomer { /** * The customer's email. */ email: string; /** * The customer's company name. */ company_name?: string; /** * The customer's first name. */ first_name?: string; /** * The customer's last name. */ last_name?: string; /** * The customer's phone number. */ phone?: string; /** * Key-value pairs of custom data. */ metadata?: Record; } export interface BaseUpdateCustomer { /** * The customer's company name. */ company_name?: string; /** * The customer's first name. */ first_name?: string; /** * The customer's last name. */ last_name?: string; /** * The customer's phone number. */ phone?: string; /** * Key-value pairs of custom data. */ metadata?: Record; } export interface BaseCreateCustomerAddress { /** * The address's first name. */ first_name?: string; /** * The address's last name. */ last_name?: string; /** * The address's phone. */ phone?: string; /** * The address's company. */ company?: string; /** * The address's first line. */ address_1?: string; /** * The address's second line. */ address_2?: string; /** * The address's city. */ city?: string; /** * The address's country code. * * @example * us */ country_code?: string; /** * The address's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province. */ province?: string; /** * The address's postal code. */ postal_code?: string; /** * Key-value pairs of custom data. */ metadata?: Record; /** * The address's name. */ address_name?: string; /** * Whether the address is used by default for shipping. */ is_default_shipping?: boolean; /** * Whether the address is used by default for billing. */ is_default_billing?: boolean; } export interface BaseUpdateCustomerAddress { /** * The address's first name. */ first_name?: string; /** * The address's last name. */ last_name?: string; /** * The address's phone. */ phone?: string; /** * The address's company. */ company?: string; /** * The address's first line. */ address_1?: string; /** * The address's second line. */ address_2?: string; /** * The address's city. */ city?: string; /** * The address's country code. * * @example * us */ country_code?: string; /** * The address's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province. */ province?: string; /** * The address's postal code. */ postal_code?: string; /** * Key-value pairs of custom data. */ metadata?: Record | null; /** * The address's name. */ address_name?: string; /** * Whether the address is used by default for shipping. */ is_default_shipping?: boolean; /** * Whether the address is used by default for billing. */ is_default_billing?: boolean; } //# sourceMappingURL=common.d.ts.map