@teemill/platform 0.65.0 → 0.66.0

package/dist/base.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/dist/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/common.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/dist/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/configuration.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/api.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).
@@ -163,6 +163,72 @@ export interface Client {
     'ref'?: string;
     'name'?: string;
 }
+/**
+ * A concierge candidate. This is a potentially high value person who has interacted with the platform in some way.
+ */
+export interface ConciergeCandidate {
+    /**
+     * Unique object identifier
+     */
+    'id': string;
+    /**
+     * The first name of the concierge candidate
+     */
+    'firstName': string;
+    /**
+     * The last name of the concierge candidate
+     */
+    'lastName': string;
+    /**
+     * The email of the concierge candidate
+     */
+    'email': string;
+    'source': ConciergeCandidateSource;
+    /**
+     * ISO 8601 Timestamp
+     */
+    'createdAt': string;
+    /**
+     * ISO 8601 Timestamp
+     */
+    'dismissedAt'?: string;
+    /**
+     * A reference to the project being ordered
+     */
+    'clientRef': string;
+    /**
+     * A reference to the origin of the concierge candidate. The structure of the origin ref can be inferred from the concierge candidate source.
+     */
+    'originRef': string;
+    /**
+     * Reference to the user resource
+     */
+    'assignedUserRef'?: string;
+}
+/**
+ * The source of the concierge candidate. This is the channel through which the concierge candidate interacted with the platform.
+ */
+export interface ConciergeCandidateSource {
+    /**
+     * The type of the source
+     */
+    'type': ConciergeCandidateSourceTypeEnum;
+    /**
+     * The name of the source
+     */
+    'name': string;
+    /**
+     * The description of the source
+     */
+    'description': string;
+}
+export declare const ConciergeCandidateSourceTypeEnum: {
+    readonly ContactForm: "contact_form";
+    readonly SignedUp: "signed_up";
+    readonly CustomOrder: "custom_order";
+    readonly QuoteForm: "quote_form";
+};
+export type ConciergeCandidateSourceTypeEnum = typeof ConciergeCandidateSourceTypeEnum[keyof typeof ConciergeCandidateSourceTypeEnum];
 export interface ConfirmOrderFulfillment {
     /**
      * Unique object identifier
@@ -527,10 +593,21 @@ export interface Fulfillment {
      */
     'frozen'?: boolean;
     /**
-     * List of reason codes why this fulfillment is frozen.
+     * List of reason codes why this fulfillment is frozen. - `moderation` - Held for content moderation review. - `internal_screen_print` - Awaiting internal screen print processing. - `manual` - Manually frozen by a user. - `credit_control` - Client is under credit control. - `billing_failed` - Payment for this order failed. - `pickface_flagged` - Flagged on the pickface for review. - `flow_frozen` - Frozen by internal production flow handling. - `fraud` - Frozen due to fraud checks.
      */
-    'frozenReasons'?: Array<string>;
+    'frozenReasons'?: Array<FulfillmentFrozenReasonsEnum>;
 }
+export declare const FulfillmentFrozenReasonsEnum: {
+    readonly Moderation: "moderation";
+    readonly InternalScreenPrint: "internal_screen_print";
+    readonly Manual: "manual";
+    readonly CreditControl: "credit_control";
+    readonly BillingFailed: "billing_failed";
+    readonly PickfaceFlagged: "pickface_flagged";
+    readonly FlowFrozen: "flow_frozen";
+    readonly Fraud: "fraud";
+};
+export type FulfillmentFrozenReasonsEnum = typeof FulfillmentFrozenReasonsEnum[keyof typeof FulfillmentFrozenReasonsEnum];
 export interface FulfillmentItem {
     /**
      * Unique fulfillment item id
@@ -560,6 +637,10 @@ export interface Image {
     'alt'?: string;
     'sortOrder'?: number;
 }
+export interface ListConciergeCandidates200Response {
+    'candidates': Array<ConciergeCandidate>;
+    'nextPageToken': number | null;
+}
 export interface ListCustomerEnquiries200Response {
     'enquiries'?: Array<Enquiry>;
     'nextPageToken'?: number | null;
@@ -1115,6 +1196,16 @@ export interface Terms {
     'createdAt': string;
     'updatedAt': string;
 }
+export interface UpdateConciergeCandidateRequest {
+    /**
+     * Whether the concierge candidate has been dismissed or not.
+     */
+    'dismiss'?: boolean;
+    /**
+     * Reference to the user resource
+     */
+    'assignedUserRef'?: string | null;
+}
 export interface UpdateCustomerEnquiryRequest {
     /**
      * The unique id of the user who owns the enquiry
@@ -1198,6 +1289,182 @@ export interface Variant {
      */
     'warehouseVariantRef': string | null;
 }
+/**
+ * ConciergeCandidatesApi - axios parameter creator
+ */
+export declare const ConciergeCandidatesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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: string, platformId: string, conciergeCandidateId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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: string, platformId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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: string, platformId: string, conciergeCandidateId: string, updateConciergeCandidateRequest: UpdateConciergeCandidateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ConciergeCandidatesApi - functional programming interface
+ */
+export declare const ConciergeCandidatesApiFp: (configuration?: Configuration) => {
+    /**
+     * 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: string, platformId: string, conciergeCandidateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConciergeCandidate>>;
+    /**
+     * 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: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListConciergeCandidates200Response>>;
+    /**
+     * 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: string, platformId: string, conciergeCandidateId: string, updateConciergeCandidateRequest: UpdateConciergeCandidateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConciergeCandidate>>;
+};
+/**
+ * ConciergeCandidatesApi - factory interface
+ */
+export declare const ConciergeCandidatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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: ConciergeCandidatesApiGetConciergeCandidateRequest, options?: RawAxiosRequestConfig): AxiosPromise<ConciergeCandidate>;
+    /**
+     * List concierge candidates
+     * @summary List concierge candidates
+     * @param {ConciergeCandidatesApiListConciergeCandidatesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listConciergeCandidates(requestParameters: ConciergeCandidatesApiListConciergeCandidatesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListConciergeCandidates200Response>;
+    /**
+     * 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: ConciergeCandidatesApiUpdateConciergeCandidateRequest, options?: RawAxiosRequestConfig): AxiosPromise<ConciergeCandidate>;
+};
+/**
+ * Request parameters for getConciergeCandidate operation in ConciergeCandidatesApi.
+ */
+export interface ConciergeCandidatesApiGetConciergeCandidateRequest {
+    /**
+     * Project unique identifier
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     */
+    readonly platformId: string;
+    /**
+     * The concierge candidate identifier
+     */
+    readonly conciergeCandidateId: string;
+}
+/**
+ * Request parameters for listConciergeCandidates operation in ConciergeCandidatesApi.
+ */
+export interface ConciergeCandidatesApiListConciergeCandidatesRequest {
+    /**
+     * Project unique identifier
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     */
+    readonly platformId: string;
+}
+/**
+ * Request parameters for updateConciergeCandidate operation in ConciergeCandidatesApi.
+ */
+export interface ConciergeCandidatesApiUpdateConciergeCandidateRequest {
+    /**
+     * Project unique identifier
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     */
+    readonly platformId: string;
+    /**
+     * The concierge candidate identifier
+     */
+    readonly conciergeCandidateId: string;
+    readonly updateConciergeCandidateRequest: UpdateConciergeCandidateRequest;
+}
+/**
+ * ConciergeCandidatesApi - object-oriented interface
+ */
+export declare 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: ConciergeCandidatesApiGetConciergeCandidateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ConciergeCandidate, any, {}>>;
+    /**
+     * List concierge candidates
+     * @summary List concierge candidates
+     * @param {ConciergeCandidatesApiListConciergeCandidatesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listConciergeCandidates(requestParameters: ConciergeCandidatesApiListConciergeCandidatesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListConciergeCandidates200Response, any, {}>>;
+    /**
+     * 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: ConciergeCandidatesApiUpdateConciergeCandidateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ConciergeCandidate, any, {}>>;
+}
 /**
  * CustomersApi - axios parameter creator
  */