@djust-b2b/djust-front-sdk 1.12.0 → 1.14.0

package/lib/services/customer-account/index.d.ts

@@ -1,77 +1,1835 @@
-import { CreateCustomerAccountAddressParameters, CreateCustomerAccountAddressResponse, CreateCustomerAccountOrganisationParameters, CreateCustomerAccountOrganisationResponse, CreateCustomerAccountParameters, CreateCustomerAccountResponse, CreateCustomerAccountUsersParameters, DeleteCustomerAccountAddressParameters, DeleteCustomerAccountOrganisationAddressParameters, GetCustomerAccountAddressesParameters, GetCustomerAccountAddressesResponse, GetCustomerAccountOrdersParameters, GetCustomerAccountOrdersResponse, GetCustomerAccountOrganisationAddressesParameters, GetCustomerAccountOrganisationAddressesResponse, GetCustomerAccountOrganisationOrdersParameters, GetCustomerAccountOrganisationOrdersResponse, GetCustomerAccountOrganisationResponse, GetCustomerAccountOrganisationUsersParameters, GetCustomerAccountOrganisationUsersResponse, GetCustomerAccountResponse, GetCustomerAccountUsersParameters, GetCustomerAccountUsersResponse, UpdateCustomerAccountAddressParameters, UpdateCustomerAccountAddressResponse, UpdateCustomerAccountOrganisationAddressParameters, UpdateCustomerAccountOrganisationAddressResponse, UpdateCustomerAccountOrganisationParameters, UpdateCustomerAccountOrganisationResponse, UpdateCustomerAccountOrganisationUserParameters, UpdateCustomerAccountOrganisationUserResponse, UpdateCustomerAccountParameters, UpdateCustomerAccountResponse } from "./definitions";
+import { CreateCustomerAccountAddressParameters, CreateCustomerAccountAddressResponse, CreateCustomerAccountOrganisationParameters, CreateCustomerAccountOrganisationResponse, CreateCustomerAccountParameters, CreateCustomerAccountResponse, DeleteCustomerAccountAddressParameters, DeleteCustomerAccountOrganisationAddressParameters, GetCustomerAccountAddressesParameters, GetCustomerAccountAddressesResponse, GetCustomerAccountOrdersParameters, GetCustomerAccountOrdersResponse, GetCustomerAccountOrganisationAddressesParameters, GetCustomerAccountOrganisationAddressesResponse, GetCustomerAccountOrganisationOrdersParameters, GetCustomerAccountOrganisationOrdersResponse, GetCustomerAccountOrganisationResponse, GetCustomerAccountOrganisationUsersParameters, GetCustomerAccountOrganisationUsersResponse, GetCustomerAccountResponse, GetCustomerAccountUsersParameters, GetCustomerAccountUsersResponse, UpdateCustomerAccountAddressParameters, UpdateCustomerAccountAddressResponse, UpdateCustomerAccountOrganisationAddressParameters, UpdateCustomerAccountOrganisationAddressResponse, UpdateCustomerAccountOrganisationParameters, UpdateCustomerAccountOrganisationResponse, UpdateCustomerAccountOrganisationUserParameters, UpdateCustomerAccountOrganisationUserResponse, UpdateCustomerAccountParameters, UpdateCustomerAccountResponse } from "./definitions";
 /**
- * Retrieve a customer account
+ * ## Get customer accounts details
+ * ### APICODE(ACCOUNT-501)
+ *
+ * @returns {Promise<GetCustomerAccountsResponse>} - The response with the customer account details
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await getCustomerAccount();
+ * ```
+ * ### output
+ * ```json
+ * {
+ * "accountManager": "string",
+ *  "addresses": [
+ *     {
+ *       "additionalAddress": "string",
+ *       "address": "string",
+ *       "billing": true,
+ *       "city": "string",
+ *       "company": "string",
+ *       "country": "string",
+ *       "externalId": "string",
+ *       "fullName": "string",
+ *       "id": "string",
+ *       "label": "string",
+ *       "phone": "string",
+ *       "shipping": true,
+ *       "state": "string",
+ *       "zipcode": "string"
+ *     }
+ *   ],
+ *   "businessRegistrationNumber": "string",
+ *   "companyRegistrationName": "string",
+ *   "customFieldValues": [
+ *     {
+ *       "customField": {
+ *         "externalId": "string",
+ *         "id": "string",
+ *         "name": {
+ *           "additionalProp1": "string",
+ *           "additionalProp2": "string",
+ *           "additionalProp3": "string"
+ *         },
+ *         "type": "LONG_TEXT"
+ *       },
+ *       "value": {}
+ *     }
+ *   ],
+ *   "customerTags": [
+ *     {
+ *       "id": "string",
+ *       "name": "string"
+ *     }
+ *   ],
+ *   "externalId": "string",
+ *   "id": "string",
+ *   "mainContacts": [
+ *     {
+ *       "civility": "MR",
+ *       "email": "string",
+ *       "firstName": "string",
+ *       "id": "string",
+ *       "lastName": "string",
+ *       "status": "ACTIVE"
+ *     }
+ *   ],
+ *   "name": "string",
+ *   "paymentType": "ON_ACCEPTANCE",
+ *   "status": "ACTIVE",
+ *   "vatNumber": "string",
+ *   "website": "string"
+ * }
+ *
  */
 export declare function getCustomerAccount(): Promise<GetCustomerAccountResponse>;
 /**
- * Create a customer account
+ * ## Create a customer account
+ * ### API CODE (ACCOUNT-100)
+ * @param {CreateCustomerAccountParameters} params - The parameters for creating a customer account, including:
+ * #### createAddressRequests - `object[]` | <strong style={{ color: 'red' }}>required</strong>
+ * #### createCustomerUserRequest - `object` | <strong style={{ color: 'red' }}>required</strong>
+ * #### createObjectCustomerAccountRequest - `object` | <strong style={{ color: 'red' }}>required</strong>
+ * #### customFieldValues - `object[]` | <strong style={{ color: 'red' }}>required</strong>
+ * #### customerTagList - `string[]` | <strong style={{ color: 'red' }}>required</strong>
+ * #### fromFO - `boolean` | <strong style={{ color: 'red' }}>required</strong>
+ * #### legalUser - `object[]` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * @return {Promise<CreateCustomerAccountResponse>} - The response with the customer account details
+ *
+ * @example
+ * #### input
+ * ```typescript
+ *  const response = await createCustomerAccount({
+ *    createAddressRequests: [
+ *      {
+ *        additionalAddress: "string",
+ *        address: "string",
+ *        billing: true,
+ *        city: "string",
+ *        company: "string",
+ *        country: "string",
+ *        externalId: "string",
+ *        fullName: "string",
+ *        id: "string",
+ *        label: "string",
+ *        phone: "string",
+ *        shipping: true,
+ *        state: "string",
+ *        zipcode: "string"
+ *      }
+ *    ],
+ *    createCustomerUserRequest: {
+ *      civility: "MR",
+ *      email: "string",
+ *      customFieldValues: [
+ *        {
+ *          customFieldId: 'string',
+ *          customFieldValue: 'string'
+ *        }
+ *      ],
+ *      externalId: string;
+ *      firstName: string;
+ *      groups: string[];
+ *      lastName: string;
+ *      mainOrganisationsId: string;
+ *      mainSubOrganisationsId: string;
+ *      organisationsIds: ['id1', 'id2'];
+ *      password: string;
+ *      phone: string;
+ *      subOrganisationsIds: ['id1', 'id2'];
+ *    },
+ *    createObjectCustomerAccountRequest: {
+ *      accountManager: "string",
+ *      businessRegistrationNumber: "string",
+ *      companyRegistrationName: "string",
+ *      externalId: "string",
+ *      name: "string",
+ *      vatNumber: "string",
+ *      website: "string"
+ *    },
+ *    customFieldValues: [
+ *      {
+ *        customFieldId: string,
+ *        customFieldValue: string
+ *      }
+ *    ],
+ *    customerTagList: ['stribg 1', 'string 2'],
+ *    fromFO: true,
+ *    legalUser: {
+ *      birthday: "2024-12-11T09:46:27.656Z",
+ *      countryOfResidence: "FR",
+ *      email: "string",
+ *      firstName: "string",
+ *      id: "string",
+ *      lastName: "string",
+ *      nationality: "FR"
+ *    },
+ *  });
+ * ```
+ * #### output
+ * Response - <strong style={{ color: 'green' }}>201</strong> - Created
+ * ```json
+ * {
+ *   "accountManager": "string",
+ *   "addresses": [
+ *     {
+ *       "additionalAddress": "string",
+ *       "address": "string",
+ *       "billing": true,
+ *       "city": "string",
+ *       "company": "string",
+ *       "country": "string",
+ *       "externalId": "string",
+ *       "fullName": "string",
+ *       "id": "string",
+ *       "label": "string",
+ *       "phone": "string",
+ *       "shipping": true,
+ *       "state": "string",
+ *       "zipcode": "string"
+ *     }
+ *   ],
+ *   "businessRegistrationNumber": "string",
+ *   "companyRegistrationName": "string",
+ *   "customFieldValues": [
+ *     {
+ *       "customField": {
+ *         "externalId": "string",
+ *         "id": "string",
+ *         "name": {
+ *           "additionalProp1": "string",
+ *           "additionalProp2": "string",
+ *           "additionalProp3": "string"
+ *         },
+ *         "type": "LONG_TEXT"
+ *       },
+ *       "value": {}
+ *     }
+ *   ],
+ *   "customerTags": [
+ *     {
+ *       "id": "string",
+ *       "name": "string"
+ *     }
+ *   ],
+ *   "externalId": "string",
+ *   "id": "string",
+ *   "mainContacts": [
+ *     {
+ *       "civility": "MR",
+ *       "email": "string",
+ *       "firstName": "string",
+ *       "id": "string",
+ *       "lastName": "string",
+ *       "status": "ACTIVE"
+ *     }
+ *   ],
+ *   "name": "string",
+ *   "paymentType": "ON_ACCEPTANCE",
+ *   "status": "ACTIVE",
+ *   "vatNumber": "string",
+ *   "website": "string"
+ * }
  */
 export declare function createCustomerAccount({ createAddressRequests, createCustomerUserRequest, createObjectCustomerAccountRequest, customFieldValues, customerTagList, fromFO, legalUser, }: CreateCustomerAccountParameters): Promise<CreateCustomerAccountResponse>;
 /**
- * Update a customer account
+ * ## Update a customer account
+ * ### API CODE (ACCOUNT-201)
+ *
+ * @param {UpdateCustomerAccountParameters} params - The parameters for updating a customer account, including:
+ * #### accountManager - `string`
+ * #### businessRegistrationNumber - `string`
+ * #### companyRegistrationName - `string`
+ * #### customFieldValues - `object[]`
+ * #### customerTagList - `string[]`
+ * #### legalUser - `object[]`
+ * #### name - `string`
+ * #### vatNumber - `string`
+ * #### website - `string`
+ *
+ * @return {Promise<UpdateCustomerAccountResponse>} - The response with the updated customer account details
+ *
+ * @example
+ * #### input
+ * ```typescript
+ *  const response = await updateCustomerAccount({
+ *    accountManager: "string",
+ *    businessRegistrationNumber: "string",
+ *    companyRegistrationName: "string",
+ *    customFieldValues: [
+ *      {
+ *        customFieldId: 'string',
+ *        customFieldValue: 'string'
+ *      }
+ *    ],
+ *    customerTagList: ['stribg 1', 'string 2'],
+ *    legalUser: {
+ *      birthday: "2024-12-11T09:46:27.656Z",
+ *      countryOfResidence: "FR",
+ *      email: "string",
+ *      firstName: "string",
+ *      id: "string",
+ *      lastName: "string",
+ *      nationality: "FR"
+ *    },
+ *    name: "string",
+ *    vatNumber: "string",
+ *    website: "string"
+ *  });
+ * ```
+ * #### output
+ * Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * ```json
+ * {
+ *   "accountManager": "string",
+ *   "addresses": [
+ *     {
+ *       "additionalAddress": "string",
+ *       "address": "string",
+ *       "billing": true,
+ *       "city": "string",
+ *       "company": "string",
+ *       "country": "string",
+ *       "externalId": "string",
+ *       "fullName": "string",
+ *       "id": "string",
+ *       "label": "string",
+ *       "phone": "string",
+ *       "shipping": true,
+ *       "state": "string",
+ *       "zipcode": "string"
+ *     }
+ *   ],
+ *   "businessRegistrationNumber": "string",
+ *   "companyRegistrationName": "string",
+ *   "customFieldValues": [
+ *     {
+ *       "customField": {
+ *         "externalId": "string",
+ *         "id": "string",
+ *         "name": {
+ *           "additionalProp1": "string",
+ *           "additionalProp2": "string",
+ *           "additionalProp3": "string"
+ *         },
+ *         "type": "LONG_TEXT"
+ *       },
+ *       "value": {}
+ *     }
+ *   ],
+ *   "customerTags": [
+ *     {
+ *       "id": "string",
+ *       "name": "string"
+ *     }
+ *   ],
+ *   "externalId": "string",
+ *   "id": "string",
+ *   "mainContacts": [
+ *     {
+ *       "civility": "MR",
+ *       "email": "string",
+ *       "firstName": "string",
+ *       "id": "string",
+ *       "lastName": "string",
+ *       "status": "ACTIVE"
+ *     }
+ *   ],
+ *   "name": "string",
+ *   "paymentType": "ON_ACCEPTANCE",
+ *   "status": "ACTIVE",
+ *   "vatNumber": "string",
+ *   "website": "string"
+ * }
+ * ```
  */
 export declare function updateCustomerAccount({ accountManager, businessRegistrationNumber, companyRegistrationName, customFieldValues, customerTagList, legalUser, name, vatNumber, website, }: UpdateCustomerAccountParameters): Promise<UpdateCustomerAccountResponse>;
 /**
- * Get a customer account's addresses
+ * ## Get a customer account's addresses
+ * ### APICODE(ACCOUNT-500)
+ *
+ * @param {GetCustomerAccountAddressesParameters} params - The parameters for the function
+ * #### shipping - `boolean`
+ * #### billing - `boolean`
+ *
+ * @returns {Promise<GetCustomerAccountAddressesResponse>} - The response with the customer account addresses
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await getCustomerAccountAddresses({ shipping: true, billing: true });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * ```json
+ *  [
+ *     {
+ *       "additionalAddress": "string",
+ *       "address": "string",
+ *       "billing": true,
+ *       "city": "string",
+ *       "company": "string",
+ *       "country": "string",
+ *       "externalId": "string",
+ *       "fullName": "string",
+ *       "id": "string",
+ *       "label": "string",
+ *       "phone": "string",
+ *       "shipping": true,
+ *       "state": "string",
+ *       "zipcode": "string"
+ *     }
+ *   ]
+ * ```
  */
 export declare function getCustomerAccountAddresses({ shipping, billing, }: GetCustomerAccountAddressesParameters): Promise<GetCustomerAccountAddressesResponse>;
 /**
- * Create an address for a customer account
+ * ## Create an address for a customer account
+ * ### APICODE(ADDRESS-100)
+ * @param {CreateCustomerAccountAddressParameters} params - The parameters for the function
+ * #### additionalAddress - `string`
+ * #### address - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### billing - `boolean`
+ * #### city - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### company - `string`
+ * #### country - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### externalId - `string`
+ * #### fullName - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### label - `string`
+ * #### phone - `string`
+ * #### shipping - `boolean`
+ * #### state - `string`
+ * #### zipcode - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * @returns {Promise<CreateCustomerAccountAddressResponse>} - The response with the customer account address
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await createCustomerAccountAddress({
+ *   additionalAddress: "string",
+ *   address: "string",
+ *   billing: true,
+ *   city: "string",
+ *   company: "string",
+ *   country: "string",
+ *   externalId: "string",
+ *   fullName: "string",
+ *   label: "string",
+ *   phone: "string",
+ *   shipping: true,
+ *   state: "string",
+ *   zipcode: "string"
+ * });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * ```json
+ * {
+ *   "additionalAddress": "string",
+ *   "address": "string",
+ *   "billing": true,
+ *   "city": "string",
+ *   "company": "string",
+ *   "country": "string",
+ *   "externalId": "string",
+ *   "fullName": "string",
+ *   "id": "string",
+ *   "label": "string",
+ *   "phone": "string",
+ *   "shipping": true,
+ *   "state": "string",
+ *   "zipcode": "string"
+ * }
+ * ```
  */
 export declare function createCustomerAccountAddress({ additionalAddress, address, billing, city, company, country, externalId, fullName, label, phone, shipping, state, zipcode, }: CreateCustomerAccountAddressParameters): Promise<CreateCustomerAccountAddressResponse>;
 /**
- * Delete an address from a customer account
+ *
+ * ## Delete an address from a customer account
+ * ### APICODE(ADDRESS-300)
+ * @param {DeleteCustomerAccountAddressParameters} params - The parameters for the function
+ * #### addressId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * @returns {Promise<void>} - The response with the customer account address
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await deleteCustomerAccountAddress({ addressId: "string" });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>204</strong> - No Content
+ * ```json
+ *
+ * ```
  */
 export declare function deleteCustomerAccountAddress({ addressId, }: DeleteCustomerAccountAddressParameters): Promise<void>;
 /**
- * Update an address for a customer account
+ * ## Update an address for a customer account
+ * ### APICODE(ADDRESS-200)
+ * @param {UpdateCustomerAccountAddressParameters} params - The parameters for the function
+ * #### addressId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### additionalAddress - `string`
+ * #### address - `string`
+ * #### billing - `boolean`
+ * #### city - `string`
+ * #### company - `string`
+ * #### country - `string`
+ * #### fullName - `string`
+ * #### label - `string`
+ * #### phone - `string`
+ * #### shipping - `boolean`
+ * #### state - `string`
+ * #### zipcode - `string`
+ *
+ * @returns {Promise<UpdateCustomerAccountAddressResponse>} - The response with the customer account address
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await updateCustomerAccountAddress({
+ *   addressId: "string",
+ *   additionalAddress: "string",
+ *   address: "string",
+ *   billing: true,
+ *   city: "string",
+ *   company: "string",
+ *   country: "string",
+ *   fullName: "string",
+ *   label: "string",
+ *   phone: "string",
+ *   shipping: true,
+ *   state: "string",
+ *   zipcode: "string"
+ * });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * ```json
+ * {
+ *   "additionalAddress": "string",
+ *   "address": "string",
+ *   "billing": true,
+ *   "city": "string",
+ *   "company": "string",
+ *   "country": "string",
+ *   "externalId": "string",
+ *   "fullName": "string",
+ *   "id": "string",
+ *   "label": "string",
+ *   "phone": "string",
+ *   "shipping": true,
+ *   "state": "string",
+ *   "zipcode": "string"
+ * }
+ * ```
  */
 export declare function updateCustomerAccountAddress({ addressId, additionalAddress, address, billing, city, company, country, fullName, label, phone, shipping, state, zipcode, }: UpdateCustomerAccountAddressParameters): Promise<UpdateCustomerAccountAddressResponse>;
 /**
- * Get a customer account's orders
+ * ## Get a customer account's orders
+ * APICODE(ORDER-550)
+ * @param {GetCustomerAccountOrdersParameters} params - The parameters for the function
+ * #### pageable - `object` | <strong style={{ color: 'red' }}>required</strong>
+ * #### locale - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * @returns {Promise<GetCustomerAccountOrdersResponse>} - The response with the customer account orders
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await getCustomerAccountOrders({ pageable: { page: 1, size: 10 }, locale: "string" });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * ```json
+ * {
+ *   "content": [
+ *     {
+ *       "billingAddressSnapshot": {
+ *         "additionalAddress": "string",
+ *         "address": "string",
+ *         "city": "string",
+ *         "company": "string",
+ *         "country": "string",
+ *         "externalId": "string",
+ *         "fullName": "string",
+ *         "id": "string",
+ *         "label": "string",
+ *         "phone": "string",
+ *         "state": "string",
+ *         "zipcode": "string"
+ *       },
+ *       "channel": "DESKTOP",
+ *       "createdAt": "2024-12-11T10:28:21.123Z",
+ *       "customFieldValues": [
+ *         {
+ *           "customField": {
+ *             "externalId": "string",
+ *             "externalSource": "MIRAKL",
+ *             "faceted": true,
+ *             "id": "string",
+ *             "indexable": true,
+ *             "mandatory": true,
+ *             "name": {
+ *               "additionalProp1": "string",
+ *               "additionalProp2": "string",
+ *               "additionalProp3": "string"
+ *             },
+ *             "role": "PRODUCT_TAX_RATE",
+ *             "sealedTarget": "string",
+ *             "searchable": true,
+ *             "sortable": true,
+ *             "status": "ACTIVE"
+ *           },
+ *           "value": {}
+ *         }
+ *       ],
+ *       "customerUserSnapshot": {
+ *         "accountExternalId": "string",
+ *         "accountId": "string",
+ *         "accountName": "string",
+ *         "accountTvaNumber": "string",
+ *         "civility": "MR",
+ *         "email": "string",
+ *         "externalId": "string",
+ *         "firstName": "string",
+ *         "id": "string",
+ *         "lastName": "string",
+ *         "phone": "string"
+ *       },
+ *       "exportStatus": "EXPORTED",
+ *       "externalId": "string",
+ *       "externalSource": "MIRAKL",
+ *       "fulfillmentMessage": "string",
+ *       "id": "string",
+ *       "incidentDeclared": true,
+ *       "initialPrice": {
+ *         "priceWithTax": 0,
+ *         "priceWithoutTax": 0,
+ *         "shippingPriceWithTax": 0,
+ *         "shippingPriceWithoutTax": 0,
+ *         "totalPriceWithTax": 0,
+ *         "totalPriceWithoutTax": 0
+ *       },
+ *       "leadTimeToShip": 0,
+ *       "lines": [
+ *         {
+ *           "confirmedQuantity": 0,
+ *           "customFieldValues": [
+ *             {
+ *               "customField": {
+ *                 "externalId": "string",
+ *                 "externalSource": "MIRAKL",
+ *                 "faceted": true,
+ *                 "id": "string",
+ *                 "indexable": true,
+ *                 "mandatory": true,
+ *                 "name": {
+ *                   "additionalProp1": "string",
+ *                   "additionalProp2": "string",
+ *                   "additionalProp3": "string"
+ *                 },
+ *                 "role": "PRODUCT_TAX_RATE",
+ *                 "sealedTarget": "string",
+ *                 "searchable": true,
+ *                 "sortable": true,
+ *                 "status": "ACTIVE"
+ *               },
+ *               "value": {}
+ *             }
+ *           ],
+ *           "externalId": "string",
+ *           "externalSource": "MIRAKL",
+ *           "id": "string",
+ *           "incidentDeclared": true,
+ *           "offerInventorySnapshotDto": {
+ *             "currency": "USD",
+ *             "customFieldValueSnapshots": [
+ *               {
+ *                 "customFieldSnapshotDto": {
+ *                   "externalId": "string",
+ *                   "externalSource": "string",
+ *                   "mandatory": true,
+ *                   "names": {
+ *                     "additionalProp1": "string",
+ *                     "additionalProp2": "string",
+ *                     "additionalProp3": "string"
+ *                   },
+ *                   "role": "string",
+ *                   "sealedTarget": "string",
+ *                   "status": "string",
+ *                   "type": "string"
+ *                 },
+ *                 "value": "string"
+ *               }
+ *             ],
+ *             "externalSource": "MIRAKL",
+ *             "offerInventoryExternalId": "string",
+ *             "packingType": "BOX",
+ *             "productTaxCode": "string",
+ *             "productTaxRate": 0,
+ *             "quantityPerItem": 0,
+ *             "shippingTaxCode": "string",
+ *             "shippingTaxRate": 0
+ *           },
+ *           "offerPriceSnapshotDto": {
+ *             "confirmedProductPriceWithoutTaxes": 0,
+ *             "itemPerPack": 0,
+ *             "offerPriceExternalId": "string",
+ *             "offerPriceType": "PUBLIC",
+ *             "offerPriceTypeValue": "string",
+ *             "productPriceWithTaxes": 0,
+ *             "productPriceWithoutTaxes": 0,
+ *             "productTaxAmount": 0,
+ *             "shippingPriceWithTaxes": 0,
+ *             "shippingPriceWithoutTaxes": 0,
+ *             "shippingTaxAmount": 0,
+ *             "totalPriceWithTaxes": 0,
+ *             "totalPriceWithoutTaxes": 0,
+ *             "totalProductPriceWithTaxes": 0,
+ *             "totalProductPriceWithoutTaxes": 0,
+ *             "totalProductTaxAmount": 0,
+ *             "totalTaxAmount": 0
+ *           },
+ *           "orderLogisticLinePriceDto": {
+ *             "confirmedPrice": 0,
+ *             "currency": "USD",
+ *             "externalOfferId": "string",
+ *             "externalSource": "MIRAKL",
+ *             "itemPerPack": 0,
+ *             "itemPriceWithoutTaxes": 0,
+ *             "packingType": "BOX",
+ *             "priceWithTaxes": 0,
+ *             "quantityPerItem": 0,
+ *             "shippingPriceWithTaxes": 0,
+ *             "shippingPriceWithoutTaxes": 0,
+ *             "shippingTaxAmount": 0,
+ *             "taxAmount": 0,
+ *             "taxInformation": {
+ *               "productTaxAmount": 0,
+ *               "productTaxCode": "string",
+ *               "productTaxRate": 0,
+ *               "shippingTaxAmount": 0,
+ *               "shippingTaxCode": "string",
+ *               "shippingTaxRate": 0
+ *             },
+ *             "taxRate": 0,
+ *             "totalItemPrice": 0,
+ *             "totalItemPriceWithTaxes": 0,
+ *             "totalItemTaxAmount": 0,
+ *             "totalPriceWithTaxes": 0,
+ *             "totalPriceWithoutTaxes": 0,
+ *             "totalTaxes": 0,
+ *             "type": "PUBLIC",
+ *             "typeValue": "string"
+ *           },
+ *           "orderLogisticLineProductDto": {
+ *             "brand": "string",
+ *             "classificationCategory": "string",
+ *             "defaultLanguage": "EN",
+ *             "description": "string",
+ *             "externalId": "string",
+ *             "externalSource": "MIRAKL",
+ *             "name": "string",
+ *             "productAttributeValues": [
+ *               {
+ *                 "attributeExternalId": "string",
+ *                 "attributeExternalSource": "string",
+ *                 "attributeId": "string",
+ *                 "attributeName": {
+ *                   "additionalProp1": "string",
+ *                   "additionalProp2": "string",
+ *                   "additionalProp3": "string"
+ *                 },
+ *                 "attributeType": "string",
+ *                 "attributeValue": "string",
+ *                 "id": "string"
+ *               }
+ *             ],
+ *             "productUnit": "string",
+ *             "sku": "string",
+ *             "tags": [
+ *               "string"
+ *             ]
+ *           },
+ *           "orderLogisticLineProductVariantDto": {
+ *             "attributeValues": [
+ *               {
+ *                 "attributeExternalId": "string",
+ *                 "attributeExternalSource": "string",
+ *                 "attributeId": "string",
+ *                 "attributeName": {
+ *                   "additionalProp1": "string",
+ *                   "additionalProp2": "string",
+ *                   "additionalProp3": "string"
+ *                 },
+ *                 "attributeType": "string",
+ *                 "attributeValue": "string",
+ *                 "id": "string"
+ *               }
+ *             ],
+ *             "description": "string",
+ *             "ean": "string",
+ *             "externalId": "string",
+ *             "externalSource": "MIRAKL",
+ *             "mainImageUrl": "string",
+ *             "mpn": "string",
+ *             "name": "string",
+ *             "productMediaInfoDTOS": [
+ *               {
+ *                 "isMain": true,
+ *                 "urls": [
+ *                   {
+ *                     "formatType": "string",
+ *                     "heightInPx": 0,
+ *                     "sizeType": "string",
+ *                     "url": "string",
+ *                     "widthInPx": 0
+ *                   }
+ *                 ]
+ *               }
+ *             ],
+ *             "sku": "string"
+ *           },
+ *           "paymentStatus": "WAITING_REFUND",
+ *           "quantity": 0,
+ *           "quoteLineExternalId": "string",
+ *           "status": "CANCELED"
+ *         }
+ *       ],
+ *       "orderCommercialId": "string",
+ *       "orderCommercialReference": "string",
+ *       "orderLogisticPrices": {
+ *         "currency": "USD",
+ *         "totalPriceWithTax": 0,
+ *         "totalPriceWithoutTax": 0,
+ *         "totalProductTaxAmount": 0,
+ *         "totalProductWithTax": 0,
+ *         "totalProductWithoutTax": 0,
+ *         "totalShippingFeesWithTax": 0,
+ *         "totalShippingFeesWithoutTax": 0,
+ *         "totalShippingTaxAmount": 0,
+ *         "totalTaxAmount": 0
+ *       },
+ *       "orderOrigin": "CART",
+ *       "partiallyDeclinedBySupplier": true,
+ *       "paymentOption": "BANK_WIRE",
+ *       "paymentStatus": "AUTHORIZED",
+ *       "reference": "string",
+ *       "shippingAddressSnapshot": {
+ *         "additionalAddress": "string",
+ *         "address": "string",
+ *         "city": "string",
+ *         "company": "string",
+ *         "country": "string",
+ *         "externalId": "string",
+ *         "fullName": "string",
+ *         "id": "string",
+ *         "label": "string",
+ *         "phone": "string",
+ *         "state": "string",
+ *         "zipcode": "string"
+ *       },
+ *       "shippingTrackingUrl": "string",
+ *       "shippingType": "string",
+ *       "status": "CREATING",
+ *       "supplierSnapshot": {
+ *         "description": "string",
+ *         "externalId": "string",
+ *         "id": "string",
+ *         "name": "string",
+ *         "paymentDueDate": {
+ *           "paymentDueDateDelay": 0,
+ *           "paymentDueDateMode": "SIMPLE"
+ *         },
+ *         "returnPolicy": "string",
+ *         "totalOffers": 0,
+ *         "totalOrders": 0
+ *       },
+ *       "updatedAt": "2024-12-11T10:28:21.124Z",
+ *       "validatedAt": "2024-12-11T10:28:21.124Z"
+ *     }
+ *   ],
+ *   "empty": true,
+ *   "first": true,
+ *   "last": true,
+ *   "number": 0,
+ *   "numberOfElements": 0,
+ *   "pageable": {
+ *     "offset": 0,
+ *     "pageNumber": 0,
+ *     "pageSize": 0,
+ *     "paged": true,
+ *     "sort": [
+ *       {
+ *         "ascending": true,
+ *         "descending": true,
+ *         "direction": "ASC",
+ *         "ignoreCase": true,
+ *         "nullHandling": "NATIVE",
+ *         "property": "string"
+ *       }
+ *     ],
+ *     "unpaged": true
+ *   },
+ *   "size": 0,
+ *   "sort": [
+ *     {
+ *       "ascending": true,
+ *       "descending": true,
+ *       "direction": "ASC",
+ *       "ignoreCase": true,
+ *       "nullHandling": "NATIVE",
+ *       "property": "string"
+ *     }
+ *   ],
+ *   "totalElements": 0,
+ *   "totalPages": 0
+ * }
+ * ```
  */
 export declare function getCustomerAccountOrders({ pageable, locale, }: GetCustomerAccountOrdersParameters): Promise<GetCustomerAccountOrdersResponse>;
 /**
- * Get a customer account's users
+ * ## Get a customer account's users
+ * ### APICODE(ACCOUNT-502)
+ * @param {GetCustomerAccountUsersParameters} params - The parameters for the function
+ * #### pageable - `object` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * @returns {Promise<GetCustomerAccountUsersResponse>} - The response with the customer account users
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await getCustomerAccountUsers({ pageable: { page: 1, size: 10 }, locale: "string" });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>200</strong>
+ * ```json
+ * {
+ *   "content": [
+ *      {
+ *        "civility": "MR",
+ *        "createdAt": "2024-12-11T10:28:21.123Z",
+ *        "customFieldValues": [
+ *          {
+ *            "customField": {
+ *              "externalId": "string",
+ *              "externalSource": "MIRAKL",
+ *              "faceted": true,
+ *              "id": "string",
+ *              "indexable": true,
+ *              "mandatory": true,
+ *              "name": {
+ *                "additionalProp1": "string",
+ *                "additionalProp2": "string",
+ *                "additionalProp3": "string"
+ *              },
+ *              "role": "PRODUCT_TAX_RATE",
+ *              "sealedTarget": "string",
+ *              "searchable": true,
+ *              "sortable": true,
+ *              "status": "ACTIVE"
+ *            },
+ *            "value": {}
+ *          }
+ *        ],
+ *        "email": "string",
+ *        "externalId": "string",
+ *        "firstName": "string",
+ *        "groups": [
+ *          "string"
+ *        ],
+ *        "id": "string",
+ *        "lastName": "string",
+ *        "mainOrganisationsId": "string",
+ *        "organisations": [
+ *          {
+ *            "id": "string",
+ *            "name": "string"
+ *          }
+ *        ],
+ *        "phone": "string",
+ *        "status": "ACTIVE",
+ *        "updatedAt": "2024-12-11T10:28:21.124Z"
+ *      }
+ *   ],
+ *   "empty": true,
+ *   "first": true,
+ *   "last": true,
+ *   "number": 0,
+ *   "numberOfElements": 0,
+ *   "pageable": {
+ *     "offset": 0,
+ *     "pageNumber": 0,
+ *     "pageSize": 0,
+ *     "paged": true,
+ *     "sort": [
+ *       {
+ *         "ascending": true,
+ *         "descending": true,
+ *         "direction": "ASC",
+ *         "ignoreCase": true,
+ *         "nullHandling": "NATIVE",
+ *         "property": "string"
+ *       }
+ *     ],
+ *     "unpaged": true
+ *   },
+ *   "size": 0,
+ *   "sort": [
+ *     {
+ *       "ascending": true,
+ *       "descending": true,
+ *       "direction": "ASC",
+ *       "ignoreCase": true,
+ *       "nullHandling": "NATIVE",
+ *       "property": "string"
+ *     }
+ *   ],
+ *   "totalElements": 0,
+ *   "totalPages": 0
+ * }
+ * ```
  */
 export declare function getCustomerAccountUsers({ pageable, }: GetCustomerAccountUsersParameters): Promise<GetCustomerAccountUsersResponse>;
 /**
- * Create a customer account's user
- */
-export declare function createCustomerAccountUser({ accountId, civility, firstName, lastName, email, password, groups, }: CreateCustomerAccountUsersParameters): Promise<void>;
-/**
- * Create a customer account's organisation
+ * ## Create a customer account's organisation
+ * ### APICODE(ACCOUNT-101)
+ * @param {CreateCustomerAccountOrganisationParameters} params - The parameters for the function
+ * #### externalId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### name - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### parentId - `string`
+ *
+ * @returns {Promise<CreateCustomerAccountOrganisationResponse>} - The response with the customer account organisation
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await createCustomerAccountOrganisation({
+ *   externalId: "string",
+ *   name: "string",
+ *   parentId: "string"
+ * });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * ```json
+ *   {
+ *     "accountId": "string",
+ *     "addresses": [
+ *       {
+ *         "additionalAddress": "string",
+ *         "address": "string",
+ *         "billing": true,
+ *         "city": "string",
+ *         "company": "string",
+ *         "country": "string",
+ *         "externalId": "string",
+ *         "fullName": "string",
+ *         "id": "string",
+ *         "label": "string",
+ *         "phone": "string",
+ *         "shipping": true,
+ *         "state": "string",
+ *         "zipcode": "string"
+ *       }
+ *     ],
+ *     children: ["string"],
+ *     customFieldValues: [
+ *       {
+ *         customField: {
+ *           externalId: "string",
+ *           externalSource: "string",
+ *           id: "string",
+ *           mandatory: true,
+ *           name: {
+ *             additionalProp1: "string",
+ *             additionalProp2: "string",
+ *             additionalProp3: "string"
+ *           },
+ *           role: "string",
+ *           sealedTarget: "string",
+ *           status: "string",
+ *           type: "string"
+ *         },
+ *         value: {}
+ *       }
+ *     ],
+ *     id: "string",
+ *     mainOrganisation: true
+ *     name: "string",
+ *     status: "ACTIVE",
+ *   }
+ * ```
  */
 export declare function createCustomerAccountOrganisation({ externalId, name, parentId, }: CreateCustomerAccountOrganisationParameters): Promise<CreateCustomerAccountOrganisationResponse>;
 /**
- * Update a customer account's organisation
+ * ## Update a customer account's organisation
+ * ### APICODE(ACCOUNT-202)
+ * @param {UpdateCustomerAccountOrganisationParameters} params - The parameters for the function
+ * #### organisationId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### name - `string`
+ * #### parentId - `string`
+ * #### status - `string`
+ *
+ * @returns {Promise<UpdateCustomerAccountOrganisationResponse>} - The response with the updated customer account organisation
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await updateCustomerAccountOrganisation({
+ *   organisationId: "string",
+ *   name: "string",
+ *   parentId: "string",
+ *   status: "ACTIVE"
+ * });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * ```json
+ * {
+ *   "accountId": "string",
+ *   "addresses": [
+ *     {
+ *       "additionalAddress": "string",
+ *       "address": "string",
+ *       "billing": true,
+ *       "city": "string",
+ *       "company": "string",
+ *       "country": "string",
+ *       "externalId": "string",
+ *       "fullName": "string",
+ *       "id": "string",
+ *       "label": "string",
+ *       "phone": "string",
+ *       "shipping": true,
+ *       "state": "string",
+ *       "zipcode": "string"
+ *     }
+ *   ],
+ *   "children": ["string"],
+ *   "customFieldValues": [
+ *     {
+ *       "customField": {
+ *         "externalId": "string",
+ *         "externalSource": "string",
+ *         "id": "string",
+ *         "mandatory": true,
+ *         "name": {
+ *           "additionalProp1": "string",
+ *           "additionalProp2": "string",
+ *           "additionalProp3": "string"
+ *         },
+ *         "role": "string",
+ *         "sealedTarget": "string",
+ *         "status": "string",
+ *         "type": "string"
+ *       },
+ *       "value": {}
+ *     }
+ *   ],
+ *   "id": "string",
+ *   "mainOrganisation": true,
+ *   "name": "string",
+ *   "status": "ACTIVE"
+ * }
+ * ```
  */
 export declare function updateCustomerAccountOrganisation({ organisationId, name, parentId, status, }: UpdateCustomerAccountOrganisationParameters): Promise<UpdateCustomerAccountOrganisationResponse>;
 /**
- * Get organisations from customer account
+ * @deprecated
+ * ## Get organisations from customer account
+ * ### APICODE(ACCOUNT-503)
+ * @returns {Promise<GetCustomerAccountOrganisationResponse>} - The response with the customer account organisations
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await getCustomerAccountOrganisations();
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * ```json
+ * {
+ *   "content": [
+ *     {
+ *       "accountId": "string",
+ *       "addresses": [
+ *         {
+ *           "additionalAddress": "string",
+ *           "address": "string",
+ *           "billing": true,
+ *           "city": "string",
+ *           "company": "string",
+ *           "country": "string",
+ *           "externalId": "string",
+ *           "fullName": "string",
+ *           "id": "string",
+ *           "label": "string",
+ *           "phone": "string",
+ *           "shipping": true,
+ *           "state": "string",
+ *           "zipcode": "string"
+ *         }
+ *       ],
+ *       "children": ["string"],
+ *       "customFieldValues": [
+ *         {
+ *           "customField": {
+ *             "externalId": "string",
+ *             "externalSource": "string",
+ *             "id": "string",
+ *             "mandatory": true,
+ *             "name": {
+ *               "additionalProp1": "string",
+ *               "additionalProp2": "string",
+ *               "additionalProp3": "string"
+ *             },
+ *             "role": "string",
+ *             "sealedTarget": "string",
+ *             "status": "string",
+ *             "type": "string"
+ *           },
+ *           "value": {}
+ *         }
+ *       ],
+ *       "id": "string",
+ *       "mainOrganisation": true,
+ *       "name": "string",
+ *       "status": "ACTIVE"
+ *     }
+ *   ],
+ *   "empty": true,
+ *   "first": true,
+ *   "last": true,
+ *   "number": 0,
+ *   "numberOfElements": 0,
+ *   "pageable": {
+ *     "offset": 0,
+ *     "pageNumber": 0,
+ *     "pageSize": 0,
+ *     "paged": true,
+ *     "sort": [
+ *       {
+ *         "ascending": true,
+ *         "descending": true,
+ *         "direction": "ASC",
+ *         "ignoreCase": true,
+ *         "nullHandling": "NATIVE",
+ *         "property": "string"
+ *       }
+ *     ],
+ *     "unpaged": true
+ *   },
+ *   "size": 0,
+ *   "sort": [
+ *     {
+ *       "ascending": true,
+ *       "descending": true,
+ *       "direction": "ASC",
+ *       "ignoreCase": true,
+ *       "nullHandling": "NATIVE",
+ *       "property": "string"
+ *     }
+ *   ],
+ *   "totalElements": 0,
+ *   "totalPages": 0
+ * }
+ * ```
  */
 export declare function getCustomerAccountOrganisations(): Promise<GetCustomerAccountOrganisationResponse>;
 /**
- * Get addresses from a customer account organisation
+ * ## Get addresses from a customer account organisation
+ * ### APICODE(ACCOUNT-505)
+ * @param {GetCustomerAccountOrganisationAddressesParameters} params - The parameters for the function
+ * #### organisationId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * @returns {Promise<GetCustomerAccountOrganisationAddressesResponse>} - The response with the customer account organisation addresses
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await getCustomerAccountOrganisationAddresses({ organisationId: "string" });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * ```json
+ *  [
+ *     {
+ *       "additionalAddress": "string",
+ *       "address": "string",
+ *       "billing": true,
+ *       "city": "string",
+ *       "company": "string",
+ *       "country": "string",
+ *       "externalId": "string",
+ *       "fullName": "string",
+ *       "id": "string",
+ *       "label": "string",
+ *       "phone": "string",
+ *       "shipping": true,
+ *       "state": "string",
+ *       "zipcode": "string"
+ *     }
+ *   ]
+ * ```
  */
 export declare function getCustomerAccountOrganisationAddresses({ organisationId, }: GetCustomerAccountOrganisationAddressesParameters): Promise<GetCustomerAccountOrganisationAddressesResponse>;
 /**
- * Delete an address from a customer account organisation
+ * ## Delete an address from a customer account organisation
+ * ### APICODE(ADDRESS-301)
+ * @param {DeleteCustomerAccountOrganisationAddressParameters} params - The parameters for the function
+ * #### organisationId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### addressId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * @returns {Promise<void>} - The response with the customer account organisation address
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await deleteCustomerAccountOrganisationAddress({ organisationId: "string", addressId: "string" });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>204</strong> - No Content
+ * ```json
+ *
+ * ```
  */
 export declare function deleteCustomerAccountOrganisationAddress({ organisationId, addressId, }: DeleteCustomerAccountOrganisationAddressParameters): Promise<void>;
 /**
- * Update an address from a customer account organisation
+ * ## Update an address from a customer account organisation
+ * ### APICODE(ADDRESS-201)
+ * @param {UpdateCustomerAccountOrganisationAddressParameters} params - The parameters for the function
+ * #### organisationId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### addressId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### additionalAddress - `string`
+ * #### address - `string`
+ * #### billing - `boolean`
+ * #### city - `string`
+ * #### company - `string`
+ * #### country - `string`
+ * #### fullName - `string`
+ * #### label - `string`
+ * #### phone - `string`
+ * #### shipping - `boolean`
+ * #### state - `string`
+ * #### zipcode - `string`
+ *
+ * @returns {Promise<UpdateCustomerAccountOrganisationAddressResponse>} - The response with the customer account organisation address
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await updateCustomerAccountOrganisationAddress({
+ *   organisationId: "string",
+ *   addressId: "string",
+ *   additionalAddress: "string",
+ *   address: "string",
+ *   billing: true,
+ *   city: "string",
+ *   company: "string",
+ *   country: "string",
+ *   fullName: "string",
+ *   label: "string",
+ *   phone: "string",
+ *   shipping: true,
+ *   state: "string",
+ *   zipcode: "string"
+ * });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * ```json
+ * {
+ *   "additionalAddress": "string",
+ *   "address": "string",
+ *   "billing": true,
+ *   "city": "string",
+ *   "company": "string",
+ *   "country": "string",
+ *   "externalId": "string",
+ *   "fullName": "string",
+ *   "id": "string",
+ *   "label": "string",
+ *   "phone": "string",
+ *   "shipping": true,
+ *   "state": "string",
+ *   "zipcode": "string"
+ * }
+ * ```
  */
 export declare function updateCustomerAccountOrganisationAddress({ organisationId, addressId, additionalAddress, address, billing, city, company, country, fullName, label, phone, shipping, state, zipcode, }: UpdateCustomerAccountOrganisationAddressParameters): Promise<UpdateCustomerAccountOrganisationAddressResponse>;
 /**
- * Get orders from a customer account organisation
+ * ##Get orders from a customer account organisation
+ * ### APICODE(ORDER-555)
+ * @param {GetCustomerAccountOrganisationOrdersParameters} params - The parameters for the function
+ * #### organisationId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### pageable - `object` | <strong style={{ color: 'red' }}>required</strong>
+ * #### locale - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * @returns {Promise<GetCustomerAccountOrganisationOrdersResponse>} - The response with the customer account organisation orders
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await getCustomerAccountOrganisationOrders({ organisationId: "string", pageable: { page: 1, size: 10 }, locale: "string" });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * ```json
+ * {
+ *   "content": [
+ *     {
+ *       "billingAddressSnapshot": {
+ *         "additionalAddress": "string",
+ *         "address": "string",
+ *         "city": "string",
+ *         "company": "string",
+ *         "country": "string",
+ *         "externalId": "string",
+ *         "fullName": "string",
+ *         "id": "string",
+ *         "label": "string",
+ *         "phone": "string",
+ *         "state": "string",
+ *         "zipcode": "string"
+ *       },
+ *       "channel": "DESKTOP",
+ *       "createdAt": "2024-12-11T10:28:21.123Z",
+ *       "customFieldValues": [
+ *         {
+ *           "customField": {
+ *             "externalId": "string",
+ *             "externalSource": "MIRAKL",
+ *             "faceted": true,
+ *             "id": "string",
+ *             "indexable": true,
+ *             "mandatory": true,
+ *             "name": {
+ *               "additionalProp1": "string",
+ *               "additionalProp2": "string",
+ *               "additionalProp3": "string"
+ *             },
+ *             "role": "PRODUCT_TAX_RATE",
+ *             "sealedTarget": "string",
+ *             "searchable": true,
+ *             "sortable": true,
+ *             "status": "ACTIVE"
+ *           },
+ *           "value": {}
+ *         }
+ *       ],
+ *       "customerUserSnapshot": {
+ *         "accountExternalId": "string",
+ *         "accountId": "string",
+ *         "accountName": "string",
+ *         "accountTvaNumber": "string",
+ *         "civility": "MR",
+ *         "email": "string",
+ *         "externalId": "string",
+ *         "firstName": "string",
+ *         "id": "string",
+ *         "lastName": "string",
+ *         "phone": "string"
+ *       },
+ *       "exportStatus": "EXPORTED",
+ *       "externalId": "string",
+ *       "externalSource": "MIRAKL",
+ *       "fulfillmentMessage": "string",
+ *       "id": "string",
+ *       "incidentDeclared": true,
+ *       "initialPrice": {
+ *         "priceWithTax": 0,
+ *         "priceWithoutTax": 0,
+ *         "shippingPriceWithTax": 0,
+ *         "shippingPriceWithoutTax": 0,
+ *         "totalPriceWithTax": 0,
+ *         "totalPriceWithoutTax": 0
+ *       },
+ *       "leadTimeToShip": 0,
+ *       "lines": [
+ *         {
+ *           "confirmedQuantity": 0,
+ *           "customFieldValues": [
+ *             {
+ *               "customField": {
+ *                 "externalId": "string",
+ *                 "externalSource": "MIRAKL",
+ *                 "faceted": true,
+ *                 "id": "string",
+ *                 "indexable": true,
+ *                 "mandatory": true,
+ *                 "name": {
+ *                   "additionalProp1": "string",
+ *                   "additionalProp2": "string",
+ *                   "additionalProp3": "string"
+ *                 },
+ *                 "role": "PRODUCT_TAX_RATE",
+ *                 "sealedTarget": "string",
+ *                 "searchable": true,
+ *                 "sortable": true,
+ *                 "status": "ACTIVE"
+ *               },
+ *               "value": {}
+ *             }
+ *           ],
+ *           "externalId": "string",
+ *           "externalSource": "MIRAKL",
+ *           "id": "string",
+ *           "incidentDeclared": true,
+ *           "offerInventorySnapshotDto": {
+ *             "currency": "USD",
+ *             "customFieldValueSnapshots": [
+ *               {
+ *                 "customFieldSnapshotDto": {
+ *                   "externalId": "string",
+ *                   "externalSource": "string",
+ *                   "mandatory": true,
+ *                   "names": {
+ *                     "additionalProp1": "string",
+ *                     "additionalProp2": "string",
+ *                     "additionalProp3": "string"
+ *                   },
+ *                   "role": "string",
+ *                   "sealedTarget": "string",
+ *                   "status": "string",
+ *                   "type": "string"
+ *                 },
+ *                 "value": "string"
+ *               }
+ *             ],
+ *             "externalSource": "MIRAKL",
+ *             "offerInventoryExternalId": "string",
+ *             "packingType": "BOX",
+ *             "productTaxCode": "string",
+ *             "productTaxRate": 0,
+ *             "quantityPerItem": 0,
+ *             "shippingTaxCode": "string",
+ *             "shippingTaxRate": 0
+ *           },
+ *           "offerPriceSnapshotDto": {
+ *             "confirmedProductPriceWithoutTaxes": 0,
+ *             "itemPerPack": 0,
+ *             "offerPriceExternalId": "string",
+ *             "offerPriceType": "PUBLIC",
+ *             "offerPriceTypeValue": "string",
+ *             "productPriceWithTaxes": 0,
+ *             "productPriceWithoutTaxes": 0,
+ *             "productTaxAmount": 0,
+ *             "shippingPriceWithTaxes": 0,
+ *             "shippingPriceWithoutTaxes": 0,
+ *             "shippingTaxAmount": 0,
+ *             "totalPriceWithTaxes": 0,
+ *             "totalPriceWithoutTaxes": 0,
+ *             "totalProductPriceWithTaxes": 0,
+ *             "totalProductPriceWithoutTaxes": 0,
+ *             "totalProductTaxAmount": 0,
+ *             "totalTaxAmount": 0
+ *           },
+ *           "orderLogisticLinePriceDto": {
+ *             "confirmedPrice": 0,
+ *             "currency": "USD",
+ *             "externalOfferId": "string",
+ *             "externalSource": "MIRAKL",
+ *             "itemPerPack": 0,
+ *             "itemPriceWithoutTaxes": 0,
+ *             "packingType": "BOX",
+ *             "priceWithTaxes": 0,
+ *             "quantityPerItem": 0,
+ *             "shippingPriceWithTaxes": 0,
+ *             "shippingPriceWithoutTaxes": 0,
+ *             "shippingTaxAmount": 0,
+ *             "taxAmount": 0,
+ *             "taxInformation": {
+ *               "productTaxAmount": 0,
+ *               "productTaxCode": "string",
+ *               "productTaxRate": 0,
+ *               "shippingTaxAmount": 0,
+ *               "shippingTaxCode": "string",
+ *               "shippingTaxRate": 0
+ *             },
+ *             "taxRate": 0,
+ *             "totalItemPrice": 0,
+ *             "totalItemPriceWithTaxes": 0,
+ *             "totalItemTaxAmount": 0,
+ *             "totalPriceWithTaxes": 0,
+ *             "totalPriceWithoutTaxes": 0,
+ *             "totalTaxes": 0,
+ *             "type": "PUBLIC",
+ *             "typeValue": "string"
+ *           },
+ *           "orderLogisticLineProductDto": {
+ *             "brand": "string",
+ *             "classificationCategory": "string",
+ *             "defaultLanguage": "EN",
+ *             "description": "string",
+ *             "externalId": "string",
+ *             "externalSource": "MIRAKL",
+ *             "name": "string",
+ *             "productAttributeValues": [
+ *               {
+ *                 "attributeExternalId": "string",
+ *                 "attributeExternalSource": "string",
+ *                 "attributeId": "string",
+ *                 "attributeName": {
+ *                   "additionalProp1": "string",
+ *                   "additionalProp2": "string",
+ *                   "additionalProp3": "string"
+ *                 },
+ *                 "attributeType": "string",
+ *                 "attributeValue": "string",
+ *                 "id": "string"
+ *               }
+ *             ],
+ *             "productUnit": "string",
+ *             "sku": "string",
+ *             "tags": [
+ *               "string"
+ *             ]
+ *           },
+ *           "orderLogisticLineProductVariantDto": {
+ *             "attributeValues": [
+ *               {
+ *                 "attributeExternalId": "string",
+ *                 "attributeExternalSource": "string",
+ *                 "attributeId": "string",
+ *                 "attributeName": {
+ *                   "additionalProp1": "string",
+ *                   "additionalProp2": "string",
+ *                   "additionalProp3": "string"
+ *                 },
+ *                 "attributeType": "string",
+ *                 "attributeValue": "string",
+ *                 "id": "string"
+ *               }
+ *             ],
+ *             "description": "string",
+ *             "ean": "string",
+ *             "externalId": "string",
+ *             "externalSource": "MIRAKL",
+ *             "mainImageUrl": "string",
+ *             "mpn": "string",
+ *             "name": "string",
+ *             "productMediaInfoDTOS": [
+ *               {
+ *                 "isMain": true,
+ *                 "urls": [
+ *                   {
+ *                     "formatType": "string",
+ *                     "heightInPx": 0,
+ *                     "sizeType": "string",
+ *                     "url": "string",
+ *                     "widthInPx": 0
+ *                   }
+ *                 ]
+ *               }
+ *             ],
+ *             "sku": "string"
+ *           },
+ *           "paymentStatus": "WAITING_REFUND",
+ *           "quantity": 0,
+ *           "quoteLineExternalId": "string",
+ *           "status": "CANCELED"
+ *         }
+ *       ],
+ *       "orderCommercialId": "string",
+ *       "orderCommercialReference": "string",
+ *       "orderLogisticPrices": {
+ *         "currency": "USD",
+ *         "totalPriceWithTax": 0,
+ *         "totalPriceWithoutTax": 0,
+ *         "totalProductTaxAmount": 0,
+ *         "totalProductWithTax": 0,
+ *         "totalProductWithoutTax": 0,
+ *         "totalShippingFeesWithTax": 0,
+ *         "totalShippingFeesWithoutTax": 0,
+ *         "totalShippingTaxAmount": 0,
+ *         "totalTaxAmount": 0
+ *       },
+ *       "orderOrigin": "CART",
+ *       "partiallyDeclinedBySupplier": true,
+ *       "paymentOption": "BANK_WIRE",
+ *       "paymentStatus": "AUTHORIZED",
+ *       "reference": "string",
+ *       "shippingAddressSnapshot": {
+ *         "additionalAddress": "string",
+ *         "address": "string",
+ *         "city": "string",
+ *         "company": "string",
+ *         "country": "string",
+ *         "externalId": "string",
+ *         "fullName": "string",
+ *         "id": "string",
+ *         "label": "string",
+ *         "phone": "string",
+ *         "state": "string",
+ *         "zipcode": "string"
+ *       },
+ *       "shippingTrackingUrl": "string",
+ *       "shippingType": "string",
+ *       "status": "CREATING",
+ *       "supplierSnapshot": {
+ *         "description": "string",
+ *         "externalId": "string",
+ *         "id": "string",
+ *         "name": "string",
+ *         "paymentDueDate": {
+ *           "paymentDueDateDelay": 0,
+ *           "paymentDueDateMode": "SIMPLE"
+ *         },
+ *         "returnPolicy": "string",
+ *         "totalOffers": 0,
+ *         "totalOrders": 0
+ *       },
+ *       "updatedAt": "2024-12-11T10:28:21.124Z",
+ *       "validatedAt": "2024-12-11T10:28:21.124Z"
+ *     }
+ *   ],
+ *   "empty": true,
+ *   "first": true,
+ *   "last": true,
+ *   "number": 0,
+ *   "numberOfElements": 0,
+ *   "pageable": {
+ *     "offset": 0,
+ *     "pageNumber": 0,
+ *     "pageSize": 0,
+ *     "paged": true,
+ *     "sort": [
+ *       {
+ *         "ascending": true,
+ *         "descending": true,
+ *         "direction": "ASC",
+ *         "ignoreCase": true,
+ *         "nullHandling": "NATIVE",
+ *         "property": "string"
+ *       }
+ *     ],
+ *     "unpaged": true
+ *   },
+ *   "size": 0,
+ *   "sort": [
+ *     {
+ *       "ascending": true,
+ *       "descending": true,
+ *       "direction": "ASC",
+ *       "ignoreCase": true,
+ *       "nullHandling": "NATIVE",
+ *       "property": "string"
+ *     }
+ *   ],
+ *   "totalElements": 0,
+ *   "totalPages": 0
+ * }
+ * ```
  */
 export declare function getCustomerAccountOrganisationOrders({ organisationId, pageable, locale, }: GetCustomerAccountOrganisationOrdersParameters): Promise<GetCustomerAccountOrganisationOrdersResponse>;
 /**
- * Get users from a customer account organisation
+ * ## Get users from a customer account organisation
+ * ### APICODE(ACCOUNT-504)
+ * @param {GetCustomerAccountOrganisationUsersParameters} params - The parameters for the function
+ * #### organisationId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### pageable - `object` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * @returns {Promise<GetCustomerAccountOrganisationUsersResponse>} - The response with the customer account organisation users
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await getCustomerAccountOrganisationUsers({ organisationId: "string", pageable: { page: 1, size: 10 }, locale: "string" });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * ```json
+ * {
+ *   "content": [
+ *     {
+ *       "civility": "MR",
+ *       "createdAt": "2024-12-11T10:28:21.123Z",
+ *       "firstName": "string",
+ *       "groups": [
+ *         "string"
+ *       ],
+ *       "id": "string",
+ *       "lastName": "string",
+ *       "phone": "string",
+ *       "status": "ACTIVE",
+ *     }
+ *   ],
+ *   "empty": true,
+ *   "first": true,
+ *   "last": true,
+ *   "number": 0,
+ *   "numberOfElements": 0,
+ *   "pageable": {
+ *     "offset": 0,
+ *     "pageNumber": 0,
+ *     "pageSize": 0,
+ *     "paged": true,
+ *     "sort": [
+ *       {
+ *         "ascending": true,
+ *         "descending": true,
+ *         "direction": "ASC",
+ *         "ignoreCase": true,
+ *         "nullHandling": "NATIVE",
+ *         "property": "string"
+ *       }
+ *     ],
+ *     "unpaged": true
+ *   },
+ *   "size": 0,
+ *   "sort": [
+ *     {
+ *       "ascending": true,
+ *       "descending": true,
+ *       "direction": "ASC",
+ *       "ignoreCase": true,
+ *       "nullHandling": "NATIVE",
+ *       "property": "string"
+ *     }
+ *   ],
+ *   "totalElements": 0,
+ *   "totalPages": 0
+ * }
+ * ```
  */
 export declare function getCustomerAccountOrganisationUsers({ organisationId, pageable, }: GetCustomerAccountOrganisationUsersParameters): Promise<GetCustomerAccountOrganisationUsersResponse>;
 /**
- * Update a customer account organisation user
+ * ## Update a customer account organisation user
+ * ### APICODE(ACCOUNT-202)
+ * @param {UpdateCustomerAccountOrganisationUserParameters} params - The parameters for the function
+ * #### organisationId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### customerUserId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### civility - `string`
+ * #### customFieldValues - `object[]`
+ * #### firstName - `string`
+ * #### lastName - `string`
+ * #### phone - `string`
+ *
+ * @returns {Promise<UpdateCustomerAccountOrganisationUserResponse>} - The response with the updated customer account organisation user
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await updateCustomerAccountOrganisationUser({
+ *   organisationId: "string",
+ *   customerUserId: "string",
+ *   civility: "MR",
+ *   customFieldValues: [
+ *     {
+ *       customFieldId: "string",
+ *       customFieldValue: "string"
+ *     }
+ *   ],
+ *   firstName: "string",
+ *   lastName: "string",
+ *   phone: "string"
+ * });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * ```json
+ * {
+ *     createdAt: "2024-12-11T10:28:21.123Z",
+ *     id: "string",
+ *     updatedAt: "2024-12-11T10:28:21.123Z"
+ * }
+ * ```
  */
 export declare function updateCustomerAccountOrganisationUser({ organisationId, customerUserId, civility, customFieldValues, firstName, lastName, phone, }: UpdateCustomerAccountOrganisationUserParameters): Promise<UpdateCustomerAccountOrganisationUserResponse>;