@teemill/platform 0.65.0 → 0.66.0

package/dist/esm/api.js

@@ -4,7 +4,7 @@
  * Platform
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.65.0
+ * The version of the OpenAPI document: 0.66.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -39,6 +39,12 @@ export const ApplicationPlacementEnum = {
     Front: 'front',
     Back: 'back',
 };
+export const ConciergeCandidateSourceTypeEnum = {
+    ContactForm: 'contact_form',
+    SignedUp: 'signed_up',
+    CustomOrder: 'custom_order',
+    QuoteForm: 'quote_form',
+};
 export const CreateOrderPaymentMethodTypeEnum = {
     Card: 'card',
     Bacs: 'bacs',
@@ -52,6 +58,16 @@ export const EnquiryStatusEnum = {
     Archived: 'Archived',
     Priority: 'Priority',
 };
+export const FulfillmentFrozenReasonsEnum = {
+    Moderation: 'moderation',
+    InternalScreenPrint: 'internal_screen_print',
+    Manual: 'manual',
+    CreditControl: 'credit_control',
+    BillingFailed: 'billing_failed',
+    PickfaceFlagged: 'pickface_flagged',
+    FlowFrozen: 'flow_frozen',
+    Fraud: 'fraud',
+};
 export const OrderStatus = {
     New: 'new',
     Paid: 'paid',
@@ -87,6 +103,284 @@ export const UpdateModerationItemRequestJudgementEnum = {
     Approved: 'approved',
     Denied: 'denied',
 };
+/**
+ * ConciergeCandidatesApi - axios parameter creator
+ */
+export const ConciergeCandidatesApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Get a concierge candidate by a given concierge candidate ID.
+         * @summary Get concierge candidate
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} conciergeCandidateId The concierge candidate identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConciergeCandidate: (project_1, platformId_1, conciergeCandidateId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, conciergeCandidateId_1, ...args_1], void 0, function* (project, platformId, conciergeCandidateId, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('getConciergeCandidate', 'project', project);
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('getConciergeCandidate', 'platformId', platformId);
+            // verify required parameter 'conciergeCandidateId' is not null or undefined
+            assertParamExists('getConciergeCandidate', 'conciergeCandidateId', conciergeCandidateId);
+            const localVarPath = `/v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId}`
+                .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
+                .replace(`{${"conciergeCandidateId"}}`, encodeURIComponent(String(conciergeCandidateId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication session-oauth required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
+            // authentication api-key required
+            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * List concierge candidates
+         * @summary List concierge candidates
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listConciergeCandidates: (project_1, platformId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, ...args_1], void 0, function* (project, platformId, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('listConciergeCandidates', 'project', project);
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('listConciergeCandidates', 'platformId', platformId);
+            const localVarPath = `/v1/platform/{platformId}/concierge-candidates`
+                .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication session-oauth required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
+            // authentication api-key required
+            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Update a concierge candidate by a given concierge candidate ID.
+         * @summary Update concierge candidate
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} conciergeCandidateId The concierge candidate identifier
+         * @param {UpdateConciergeCandidateRequest} updateConciergeCandidateRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateConciergeCandidate: (project_1, platformId_1, conciergeCandidateId_1, updateConciergeCandidateRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, conciergeCandidateId_1, updateConciergeCandidateRequest_1, ...args_1], void 0, function* (project, platformId, conciergeCandidateId, updateConciergeCandidateRequest, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('updateConciergeCandidate', 'project', project);
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('updateConciergeCandidate', 'platformId', platformId);
+            // verify required parameter 'conciergeCandidateId' is not null or undefined
+            assertParamExists('updateConciergeCandidate', 'conciergeCandidateId', conciergeCandidateId);
+            // verify required parameter 'updateConciergeCandidateRequest' is not null or undefined
+            assertParamExists('updateConciergeCandidate', 'updateConciergeCandidateRequest', updateConciergeCandidateRequest);
+            const localVarPath = `/v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId}`
+                .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
+                .replace(`{${"conciergeCandidateId"}}`, encodeURIComponent(String(conciergeCandidateId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication session-oauth required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
+            // authentication api-key required
+            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(updateConciergeCandidateRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * ConciergeCandidatesApi - functional programming interface
+ */
+export const ConciergeCandidatesApiFp = function (configuration) {
+    const localVarAxiosParamCreator = ConciergeCandidatesApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Get a concierge candidate by a given concierge candidate ID.
+         * @summary Get concierge candidate
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} conciergeCandidateId The concierge candidate identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConciergeCandidate(project, platformId, conciergeCandidateId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getConciergeCandidate(project, platformId, conciergeCandidateId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ConciergeCandidatesApi.getConciergeCandidate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * List concierge candidates
+         * @summary List concierge candidates
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listConciergeCandidates(project, platformId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listConciergeCandidates(project, platformId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ConciergeCandidatesApi.listConciergeCandidates']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Update a concierge candidate by a given concierge candidate ID.
+         * @summary Update concierge candidate
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} conciergeCandidateId The concierge candidate identifier
+         * @param {UpdateConciergeCandidateRequest} updateConciergeCandidateRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateConciergeCandidate(project, platformId, conciergeCandidateId, updateConciergeCandidateRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updateConciergeCandidate(project, platformId, conciergeCandidateId, updateConciergeCandidateRequest, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ConciergeCandidatesApi.updateConciergeCandidate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+/**
+ * ConciergeCandidatesApi - factory interface
+ */
+export const ConciergeCandidatesApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = ConciergeCandidatesApiFp(configuration);
+    return {
+        /**
+         * Get a concierge candidate by a given concierge candidate ID.
+         * @summary Get concierge candidate
+         * @param {ConciergeCandidatesApiGetConciergeCandidateRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConciergeCandidate(requestParameters, options) {
+            return localVarFp.getConciergeCandidate(requestParameters.project, requestParameters.platformId, requestParameters.conciergeCandidateId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * List concierge candidates
+         * @summary List concierge candidates
+         * @param {ConciergeCandidatesApiListConciergeCandidatesRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listConciergeCandidates(requestParameters, options) {
+            return localVarFp.listConciergeCandidates(requestParameters.project, requestParameters.platformId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Update a concierge candidate by a given concierge candidate ID.
+         * @summary Update concierge candidate
+         * @param {ConciergeCandidatesApiUpdateConciergeCandidateRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateConciergeCandidate(requestParameters, options) {
+            return localVarFp.updateConciergeCandidate(requestParameters.project, requestParameters.platformId, requestParameters.conciergeCandidateId, requestParameters.updateConciergeCandidateRequest, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * ConciergeCandidatesApi - object-oriented interface
+ */
+export class ConciergeCandidatesApi extends BaseAPI {
+    /**
+     * Get a concierge candidate by a given concierge candidate ID.
+     * @summary Get concierge candidate
+     * @param {ConciergeCandidatesApiGetConciergeCandidateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConciergeCandidate(requestParameters, options) {
+        return ConciergeCandidatesApiFp(this.configuration).getConciergeCandidate(requestParameters.project, requestParameters.platformId, requestParameters.conciergeCandidateId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * List concierge candidates
+     * @summary List concierge candidates
+     * @param {ConciergeCandidatesApiListConciergeCandidatesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listConciergeCandidates(requestParameters, options) {
+        return ConciergeCandidatesApiFp(this.configuration).listConciergeCandidates(requestParameters.project, requestParameters.platformId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Update a concierge candidate by a given concierge candidate ID.
+     * @summary Update concierge candidate
+     * @param {ConciergeCandidatesApiUpdateConciergeCandidateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateConciergeCandidate(requestParameters, options) {
+        return ConciergeCandidatesApiFp(this.configuration).updateConciergeCandidate(requestParameters.project, requestParameters.platformId, requestParameters.conciergeCandidateId, requestParameters.updateConciergeCandidateRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+}
 /**
  * CustomersApi - axios parameter creator
  */

package/dist/esm/base.d.ts

@@ -2,7 +2,7 @@
  * Platform
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.65.0
+ * The version of the OpenAPI document: 0.66.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/base.js

@@ -4,7 +4,7 @@
  * Platform
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.65.0
+ * The version of the OpenAPI document: 0.66.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.d.ts

@@ -2,7 +2,7 @@
  * Platform
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.65.0
+ * The version of the OpenAPI document: 0.66.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.js

@@ -4,7 +4,7 @@
  * Platform
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.65.0
+ * The version of the OpenAPI document: 0.66.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.d.ts

@@ -2,7 +2,7 @@
  * Platform
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.65.0
+ * The version of the OpenAPI document: 0.66.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.js

@@ -3,7 +3,7 @@
  * Platform
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.65.0
+ * The version of the OpenAPI document: 0.66.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.d.ts

@@ -2,7 +2,7 @@
  * Platform
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.65.0
+ * The version of the OpenAPI document: 0.66.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.js

@@ -4,7 +4,7 @@
  * Platform
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.65.0
+ * The version of the OpenAPI document: 0.66.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.d.ts

@@ -2,7 +2,7 @@
  * Platform
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.65.0
+ * The version of the OpenAPI document: 0.66.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.js

@@ -5,7 +5,7 @@
  * Platform
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.65.0
+ * The version of the OpenAPI document: 0.66.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/ConciergeCandidate.md

@@ -0,0 +1,39 @@
+# ConciergeCandidate
+
+A concierge candidate. This is a potentially high value person who has interacted with the platform in some way.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**firstName** | **string** | The first name of the concierge candidate | [default to undefined]
+**lastName** | **string** | The last name of the concierge candidate | [default to undefined]
+**email** | **string** | The email of the concierge candidate | [default to undefined]
+**source** | [**ConciergeCandidateSource**](ConciergeCandidateSource.md) |  | [default to undefined]
+**createdAt** | **string** | ISO 8601 Timestamp | [default to undefined]
+**dismissedAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
+**clientRef** | **string** | A reference to the project being ordered | [default to undefined]
+**originRef** | **string** | A reference to the origin of the concierge candidate. The structure of the origin ref can be inferred from the concierge candidate source. | [default to undefined]
+**assignedUserRef** | **string** | Reference to the user resource | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ConciergeCandidate } from '@teemill/platform';
+
+const instance: ConciergeCandidate = {
+    id,
+    firstName,
+    lastName,
+    email,
+    source,
+    createdAt,
+    dismissedAt,
+    clientRef,
+    originRef,
+    assignedUserRef,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ConciergeCandidateSource.md

@@ -0,0 +1,25 @@
+# ConciergeCandidateSource
+
+The source of the concierge candidate. This is the channel through which the concierge candidate interacted with the platform.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** | The type of the source | [default to undefined]
+**name** | **string** | The name of the source | [default to undefined]
+**description** | **string** | The description of the source | [default to undefined]
+
+## Example
+
+```typescript
+import { ConciergeCandidateSource } from '@teemill/platform';
+
+const instance: ConciergeCandidateSource = {
+    type,
+    name,
+    description,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)