@revenexx/sdk 0.0.2 → 0.0.5

package/types/services/customers.d.ts

@@ -1,5 +1,9 @@
 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);
@@ -11,10 +15,57 @@ export declare class Customers {
     customersAddressesList(): 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<Models.Address>}
      */
-    customersAddressesCreate(): Promise<Models.Address>;
+    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<Models.Address>;
+    /**
+     *
+     * @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<Models.Address>}
+     * @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<Models.Address>;
     /**
      *
      * @param {string} params.id -
@@ -52,56 +103,194 @@ export declare class Customers {
     /**
      *
      * @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<Models.Address>}
      */
     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<Models.Address>;
     /**
      *
      * @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<Models.Address>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    customersAddressesUpdate(id: string): Promise<Models.Address>;
+    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<Models.Address>;
     /**
      *
+     * @param {string} params.email -
+     * @param {string} params.password -
      * @throws {RevenexxException}
      * @returns {Promise<Models.AuthLoginResponse>}
      */
-    customersAuthLogin(): Promise<Models.AuthLoginResponse>;
+    customersAuthLogin(params: {
+        email: string;
+        password: string;
+    }): Promise<Models.AuthLoginResponse>;
+    /**
+     *
+     * @param {string} email -
+     * @param {string} password -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.AuthLoginResponse>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    customersAuthLogin(email: string, password: string): Promise<Models.AuthLoginResponse>;
+    /**
+     *
+     * @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(): Promise<{}>;
+    customersAuthLogout(sessionId: string, userId: string): Promise<{}>;
     /**
      *
+     * @param {string} params.userId -
      * @throws {RevenexxException}
      * @returns {Promise<Models.AuthMeResponse>}
      */
-    customersAuthMe(): Promise<Models.AuthMeResponse>;
+    customersAuthMe(params: {
+        userId: string;
+    }): Promise<Models.AuthMeResponse>;
+    /**
+     *
+     * @param {string} userId -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.AuthMeResponse>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    customersAuthMe(userId: string): Promise<Models.AuthMeResponse>;
+    /**
+     *
+     * @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(): Promise<{}>;
+    customersAuthRecovery(email: string, url: string): Promise<{}>;
     /**
      *
+     * @param {string} params.password -
+     * @param {string} params.secret -
+     * @param {string} params.userId -
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
-    customersAuthRecoveryConfirm(): 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<Models.AuthRegisterResponse>}
+     */
+    customersAuthRegister(params: {
+        email: string;
+        password: string;
+        firstName?: string;
+        lastName?: string;
+        locale?: string;
+        organizationId?: string;
+        organizationName?: string;
+    }): Promise<Models.AuthRegisterResponse>;
     /**
      *
+     * @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<Models.AuthRegisterResponse>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
-    customersAuthRegister(): Promise<Models.AuthRegisterResponse>;
+    customersAuthRegister(email: string, password: string, firstName?: string, lastName?: string, locale?: string, organizationId?: string, organizationName?: string): Promise<Models.AuthRegisterResponse>;
     /**
      *
      * @throws {RevenexxException}
@@ -110,10 +299,45 @@ export declare class Customers {
     customersContactsList(): 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<Models.Contact>}
+     */
+    customersContactsCreate(params: {
+        email: string;
+        firstName?: string;
+        isPrimary?: boolean;
+        lastName?: string;
+        locale?: string;
+        organizationId?: string;
+        phone?: string;
+        role?: ContactRole;
+        status?: ContactStatus;
+    }): Promise<Models.Contact>;
+    /**
+     *
+     * @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<Models.Contact>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
-    customersContactsCreate(): Promise<Models.Contact>;
+    customersContactsCreate(email: string, firstName?: string, isPrimary?: boolean, lastName?: string, locale?: string, organizationId?: string, phone?: string, role?: ContactRole, status?: ContactStatus): Promise<Models.Contact>;
     /**
      *
      * @param {string} params.id -
@@ -151,20 +375,47 @@ export declare class Customers {
     /**
      *
      * @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<Models.Contact>}
      */
     customersContactsUpdate(params: {
         id: string;
+        email?: string;
+        firstName?: string;
+        isPrimary?: boolean;
+        lastName?: string;
+        locale?: string;
+        organizationId?: string;
+        phone?: string;
+        role?: ContactRole;
+        status?: ContactStatus;
     }): Promise<Models.Contact>;
     /**
      *
      * @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<Models.Contact>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    customersContactsUpdate(id: string): Promise<Models.Contact>;
+    customersContactsUpdate(id: string, email?: string, firstName?: string, isPrimary?: boolean, lastName?: string, locale?: string, organizationId?: string, phone?: string, role?: ContactRole, status?: ContactStatus): Promise<Models.Contact>;
     /**
      *
      * @throws {RevenexxException}
@@ -173,10 +424,30 @@ export declare class Customers {
     customersOrganizationsList(): 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<Models.Organization>}
      */
-    customersOrganizationsCreate(): Promise<Models.Organization>;
+    customersOrganizationsCreate(params: {
+        name: string;
+        settings?: object;
+        status?: OrganizationStatus;
+        vatId?: string;
+    }): Promise<Models.Organization>;
+    /**
+     *
+     * @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<Models.Organization>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    customersOrganizationsCreate(name: string, settings?: object, status?: OrganizationStatus, vatId?: string): Promise<Models.Organization>;
     /**
      *
      * @param {string} params.id -
@@ -214,18 +485,30 @@ export declare class Customers {
     /**
      *
      * @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<Models.Organization>}
      */
     customersOrganizationsUpdate(params: {
         id: string;
+        name?: string;
+        settings?: object;
+        status?: OrganizationStatus;
+        vatId?: string;
     }): Promise<Models.Organization>;
     /**
      *
      * @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<Models.Organization>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    customersOrganizationsUpdate(id: string): Promise<Models.Organization>;
+    customersOrganizationsUpdate(id: string, name?: string, settings?: object, status?: OrganizationStatus, vatId?: string): Promise<Models.Organization>;
 }