import { Client } from '../client'; import type { Models } from '../models'; import { AddressType } from '../enums/address-type'; import { ContactRole } from '../enums/contact-role'; import { ContactStatus } from '../enums/contact-status'; import { OrganizationStatus } from '../enums/organization-status'; export declare class Customers { client: Client; constructor(client: Client); /** * * @param {string} params.contactId - Filter to one owning contact. * @param {string} params.organizationId - Filter to one organization. * @param {number} params.limit - Page size (default 50, max 200). * @param {number} params.offset - Row offset for pagination (default 0). * @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. * @throws {RevenexxException} * @returns {Promise<{}>} */ customersAddressesList(params?: { contactId?: string; organizationId?: string; limit?: number; offset?: number; order?: string; }): Promise<{}>; /** * * @param {string} contactId - Filter to one owning contact. * @param {string} organizationId - Filter to one organization. * @param {number} limit - Page size (default 50, max 200). * @param {number} offset - Row offset for pagination (default 0). * @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. * @throws {RevenexxException} * @returns {Promise<{}>} * @deprecated Use the object parameter style method for a better developer experience. */ customersAddressesList(contactId?: string, organizationId?: string, limit?: number, offset?: number, order?: string): Promise<{}>; /** * * @param {string} params.city - * @param {string} params.country - ISO 3166-1 alpha-2 code. * @param {string} params.street - * @param {string} params.zip - * @param {string} params.company - * @param {string} params.contactId - Owning contact (personal address). * @param {boolean} params.isDefault - The default address of its owner and type. * @param {string} params.name - Recipient name. * @param {string} params.organizationId - Owning organization (company address). * @param {string} params.phone - * @param {string} params.region - * @param {string} params.street2 - * @param {AddressType} params.type - Default 'shipping'. * @throws {RevenexxException} * @returns {Promise} */ customersAddressesCreate(params: { city: string; country: string; street: string; zip: string; company?: string; contactId?: string; isDefault?: boolean; name?: string; organizationId?: string; phone?: string; region?: string; street2?: string; type?: AddressType; }): Promise; /** * * @param {string} city - * @param {string} country - ISO 3166-1 alpha-2 code. * @param {string} street - * @param {string} zip - * @param {string} company - * @param {string} contactId - Owning contact (personal address). * @param {boolean} isDefault - The default address of its owner and type. * @param {string} name - Recipient name. * @param {string} organizationId - Owning organization (company address). * @param {string} phone - * @param {string} region - * @param {string} street2 - * @param {AddressType} type - Default 'shipping'. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ customersAddressesCreate(city: string, country: string, street: string, zip: string, company?: string, contactId?: string, isDefault?: boolean, name?: string, organizationId?: string, phone?: string, region?: string, street2?: string, type?: AddressType): Promise; /** * * @param {string} params.id - * @throws {RevenexxException} * @returns {Promise<{}>} */ customersAddressesDelete(params: { id: string; }): Promise<{}>; /** * * @param {string} id - * @throws {RevenexxException} * @returns {Promise<{}>} * @deprecated Use the object parameter style method for a better developer experience. */ customersAddressesDelete(id: string): Promise<{}>; /** * * @param {string} params.id - * @throws {RevenexxException} * @returns {Promise} */ customersAddressesGet(params: { id: string; }): Promise; /** * * @param {string} id - * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ customersAddressesGet(id: string): Promise; /** * * @param {string} params.id - * @param {string} params.city - * @param {string} params.company - * @param {string} params.contactId - Owning contact (personal address). * @param {string} params.country - ISO 3166-1 alpha-2 code. * @param {boolean} params.isDefault - The default address of its owner and type. * @param {string} params.name - Recipient name. * @param {string} params.organizationId - Owning organization (company address). * @param {string} params.phone - * @param {string} params.region - * @param {string} params.street - * @param {string} params.street2 - * @param {AddressType} params.type - Default 'shipping'. * @param {string} params.zip - * @throws {RevenexxException} * @returns {Promise} */ customersAddressesUpdate(params: { id: string; city?: string; company?: string; contactId?: string; country?: string; isDefault?: boolean; name?: string; organizationId?: string; phone?: string; region?: string; street?: string; street2?: string; type?: AddressType; zip?: string; }): Promise; /** * * @param {string} id - * @param {string} city - * @param {string} company - * @param {string} contactId - Owning contact (personal address). * @param {string} country - ISO 3166-1 alpha-2 code. * @param {boolean} isDefault - The default address of its owner and type. * @param {string} name - Recipient name. * @param {string} organizationId - Owning organization (company address). * @param {string} phone - * @param {string} region - * @param {string} street - * @param {string} street2 - * @param {AddressType} type - Default 'shipping'. * @param {string} zip - * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ customersAddressesUpdate(id: string, city?: string, company?: string, contactId?: string, country?: string, isDefault?: boolean, name?: string, organizationId?: string, phone?: string, region?: string, street?: string, street2?: string, type?: AddressType, zip?: string): Promise; /** * * @param {string} params.email - * @param {string} params.password - * @throws {RevenexxException} * @returns {Promise} */ customersAuthLogin(params: { email: string; password: string; }): Promise; /** * * @param {string} email - * @param {string} password - * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ customersAuthLogin(email: string, password: string): Promise; /** * * @param {string} params.sessionId - * @param {string} params.userId - * @throws {RevenexxException} * @returns {Promise<{}>} */ customersAuthLogout(params: { sessionId: string; userId: string; }): Promise<{}>; /** * * @param {string} sessionId - * @param {string} userId - * @throws {RevenexxException} * @returns {Promise<{}>} * @deprecated Use the object parameter style method for a better developer experience. */ customersAuthLogout(sessionId: string, userId: string): Promise<{}>; /** * * @param {string} params.userId - * @param {string} params.sessionId - Optional session to verify — answers 401 when the session is expired or revoked. * @throws {RevenexxException} * @returns {Promise} */ customersAuthMe(params: { userId: string; sessionId?: string; }): Promise; /** * * @param {string} userId - * @param {string} sessionId - Optional session to verify — answers 401 when the session is expired or revoked. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ customersAuthMe(userId: string, sessionId?: string): Promise; /** * * @param {string} params.email - * @param {string} params.url - Redirect URL carrying userId + secret. * @throws {RevenexxException} * @returns {Promise<{}>} */ customersAuthRecovery(params: { email: string; url: string; }): Promise<{}>; /** * * @param {string} email - * @param {string} url - Redirect URL carrying userId + secret. * @throws {RevenexxException} * @returns {Promise<{}>} * @deprecated Use the object parameter style method for a better developer experience. */ customersAuthRecovery(email: string, url: string): Promise<{}>; /** * * @param {string} params.password - * @param {string} params.secret - * @param {string} params.userId - * @throws {RevenexxException} * @returns {Promise<{}>} */ customersAuthRecoveryConfirm(params: { password: string; secret: string; userId: string; }): Promise<{}>; /** * * @param {string} password - * @param {string} secret - * @param {string} userId - * @throws {RevenexxException} * @returns {Promise<{}>} * @deprecated Use the object parameter style method for a better developer experience. */ customersAuthRecoveryConfirm(password: string, secret: string, userId: string): Promise<{}>; /** * * @param {string} params.email - * @param {string} params.password - * @param {string} params.firstName - * @param {string} params.lastName - * @param {string} params.locale - BCP 47, e.g. de-DE * @param {string} params.organizationId - Join an existing organization. * @param {string} params.organizationName - Found a new organization; the contact becomes its admin. * @throws {RevenexxException} * @returns {Promise} */ customersAuthRegister(params: { email: string; password: string; firstName?: string; lastName?: string; locale?: string; organizationId?: string; organizationName?: string; }): Promise; /** * * @param {string} email - * @param {string} password - * @param {string} firstName - * @param {string} lastName - * @param {string} locale - BCP 47, e.g. de-DE * @param {string} organizationId - Join an existing organization. * @param {string} organizationName - Found a new organization; the contact becomes its admin. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ customersAuthRegister(email: string, password: string, firstName?: string, lastName?: string, locale?: string, organizationId?: string, organizationName?: string): Promise; /** * * @param {string} params.organizationId - Filter to one organization. * @param {string} params.role - Filter by role (buyer | approver | admin | requester). * @param {string} params.status - Filter by status (invited | active | blocked). * @param {string} params.email - Filter by exact email. * @param {number} params.limit - Page size (default 50, max 200). * @param {number} params.offset - Row offset for pagination (default 0). * @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. * @throws {RevenexxException} * @returns {Promise<{}>} */ customersContactsList(params?: { organizationId?: string; role?: string; status?: string; email?: string; limit?: number; offset?: number; order?: string; }): Promise<{}>; /** * * @param {string} organizationId - Filter to one organization. * @param {string} role - Filter by role (buyer | approver | admin | requester). * @param {string} status - Filter by status (invited | active | blocked). * @param {string} email - Filter by exact email. * @param {number} limit - Page size (default 50, max 200). * @param {number} offset - Row offset for pagination (default 0). * @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. * @throws {RevenexxException} * @returns {Promise<{}>} * @deprecated Use the object parameter style method for a better developer experience. */ customersContactsList(organizationId?: string, role?: string, status?: string, email?: string, limit?: number, offset?: number, order?: string): Promise<{}>; /** * * @param {string} params.email - * @param {string} params.firstName - * @param {boolean} params.isPrimary - The primary contact of its organization. * @param {string} params.lastName - * @param {string} params.locale - BCP 47, e.g. de-DE * @param {string} params.organizationId - Owning organization — membership is mirrored to the platform team. * @param {string} params.phone - * @param {ContactRole} params.role - Default 'buyer' — also the team role on the platform mirror. * @param {ContactStatus} params.status - Default 'invited' on create. * @throws {RevenexxException} * @returns {Promise} */ customersContactsCreate(params: { email: string; firstName?: string; isPrimary?: boolean; lastName?: string; locale?: string; organizationId?: string; phone?: string; role?: ContactRole; status?: ContactStatus; }): Promise; /** * * @param {string} email - * @param {string} firstName - * @param {boolean} isPrimary - The primary contact of its organization. * @param {string} lastName - * @param {string} locale - BCP 47, e.g. de-DE * @param {string} organizationId - Owning organization — membership is mirrored to the platform team. * @param {string} phone - * @param {ContactRole} role - Default 'buyer' — also the team role on the platform mirror. * @param {ContactStatus} status - Default 'invited' on create. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ customersContactsCreate(email: string, firstName?: string, isPrimary?: boolean, lastName?: string, locale?: string, organizationId?: string, phone?: string, role?: ContactRole, status?: ContactStatus): Promise; /** * * @param {string} params.id - * @throws {RevenexxException} * @returns {Promise<{}>} */ customersContactsDelete(params: { id: string; }): Promise<{}>; /** * * @param {string} id - * @throws {RevenexxException} * @returns {Promise<{}>} * @deprecated Use the object parameter style method for a better developer experience. */ customersContactsDelete(id: string): Promise<{}>; /** * * @param {string} params.id - * @throws {RevenexxException} * @returns {Promise} */ customersContactsGet(params: { id: string; }): Promise; /** * * @param {string} id - * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ customersContactsGet(id: string): Promise; /** * * @param {string} params.id - * @param {string} params.email - * @param {string} params.firstName - * @param {boolean} params.isPrimary - The primary contact of its organization. * @param {string} params.lastName - * @param {string} params.locale - BCP 47, e.g. de-DE * @param {string} params.organizationId - Owning organization — membership is mirrored to the platform team. * @param {string} params.phone - * @param {ContactRole} params.role - Default 'buyer' — also the team role on the platform mirror. * @param {ContactStatus} params.status - Default 'invited' on create. * @throws {RevenexxException} * @returns {Promise} */ customersContactsUpdate(params: { id: string; email?: string; firstName?: string; isPrimary?: boolean; lastName?: string; locale?: string; organizationId?: string; phone?: string; role?: ContactRole; status?: ContactStatus; }): Promise; /** * * @param {string} id - * @param {string} email - * @param {string} firstName - * @param {boolean} isPrimary - The primary contact of its organization. * @param {string} lastName - * @param {string} locale - BCP 47, e.g. de-DE * @param {string} organizationId - Owning organization — membership is mirrored to the platform team. * @param {string} phone - * @param {ContactRole} role - Default 'buyer' — also the team role on the platform mirror. * @param {ContactStatus} status - Default 'invited' on create. * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ customersContactsUpdate(id: string, email?: string, firstName?: string, isPrimary?: boolean, lastName?: string, locale?: string, organizationId?: string, phone?: string, role?: ContactRole, status?: ContactStatus): Promise; /** * * @param {number} params.limit - Page size (default 50, max 200). * @param {number} params.offset - Row offset for pagination (default 0). * @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. * @throws {RevenexxException} * @returns {Promise<{}>} */ customersOrganizationsList(params?: { limit?: number; offset?: number; order?: string; }): Promise<{}>; /** * * @param {number} limit - Page size (default 50, max 200). * @param {number} offset - Row offset for pagination (default 0). * @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. * @throws {RevenexxException} * @returns {Promise<{}>} * @deprecated Use the object parameter style method for a better developer experience. */ customersOrganizationsList(limit?: number, offset?: number, order?: string): Promise<{}>; /** * * @param {string} params.name - Company name — mirrored to the platform team. * @param {object} params.settings - Free-form organization settings. * @param {OrganizationStatus} params.status - Default 'active'. * @param {string} params.vatId - * @throws {RevenexxException} * @returns {Promise} */ customersOrganizationsCreate(params: { name: string; settings?: object; status?: OrganizationStatus; vatId?: string; }): Promise; /** * * @param {string} name - Company name — mirrored to the platform team. * @param {object} settings - Free-form organization settings. * @param {OrganizationStatus} status - Default 'active'. * @param {string} vatId - * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ customersOrganizationsCreate(name: string, settings?: object, status?: OrganizationStatus, vatId?: string): Promise; /** * * @param {string} params.id - * @throws {RevenexxException} * @returns {Promise<{}>} */ customersOrganizationsDelete(params: { id: string; }): Promise<{}>; /** * * @param {string} id - * @throws {RevenexxException} * @returns {Promise<{}>} * @deprecated Use the object parameter style method for a better developer experience. */ customersOrganizationsDelete(id: string): Promise<{}>; /** * * @param {string} params.id - * @throws {RevenexxException} * @returns {Promise} */ customersOrganizationsGet(params: { id: string; }): Promise; /** * * @param {string} id - * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ customersOrganizationsGet(id: string): Promise; /** * * @param {string} params.id - * @param {string} params.name - Company name — mirrored to the platform team. * @param {object} params.settings - Free-form organization settings. * @param {OrganizationStatus} params.status - Default 'active'. * @param {string} params.vatId - * @throws {RevenexxException} * @returns {Promise} */ customersOrganizationsUpdate(params: { id: string; name?: string; settings?: object; status?: OrganizationStatus; vatId?: string; }): Promise; /** * * @param {string} id - * @param {string} name - Company name — mirrored to the platform team. * @param {object} settings - Free-form organization settings. * @param {OrganizationStatus} status - Default 'active'. * @param {string} vatId - * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ customersOrganizationsUpdate(id: string, name?: string, settings?: object, status?: OrganizationStatus, vatId?: string): Promise; }