@teemill/platform 0.65.2 → 0.67.0

package/configuration.ts

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

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Platform
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.65.2
+ * The version of the OpenAPI document: 0.67.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -163,6 +163,76 @@ 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
+     */
+    'approvedAt': string | null;
+    /**
+     * ISO 8601 Timestamp
+     */
+    'completedAt': string | null;
+    /**
+     * 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 task resource
+     */
+    'taskRef'?: string | null;
+}
+/**
+ * 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
@@ -571,6 +641,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;
@@ -1209,6 +1283,250 @@ export interface Variant {
      */
     'warehouseVariantRef': string | null;
 }
+/**
+ * ConciergeCandidatesApi - axios parameter creator
+ */
+export declare const ConciergeCandidatesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Approve a concierge candidate by a given concierge candidate ID. This will create a task that cann be assigned to a user.
+     * @summary Approve 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}
+     */
+    approveConciergeCandidate: (project: string, platformId: string, conciergeCandidateId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete a concierge candidate by a given concierge candidate ID.
+     * @summary Delete 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}
+     */
+    deleteConciergeCandidate: (project: string, platformId: string, conciergeCandidateId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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 {string} [search] Search term to filter results
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listConciergeCandidates: (project: string, platformId: string, search?: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ConciergeCandidatesApi - functional programming interface
+ */
+export declare const ConciergeCandidatesApiFp: (configuration?: Configuration) => {
+    /**
+     * Approve a concierge candidate by a given concierge candidate ID. This will create a task that cann be assigned to a user.
+     * @summary Approve 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}
+     */
+    approveConciergeCandidate(project: string, platformId: string, conciergeCandidateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConciergeCandidate>>;
+    /**
+     * Delete a concierge candidate by a given concierge candidate ID.
+     * @summary Delete 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}
+     */
+    deleteConciergeCandidate(project: string, platformId: string, conciergeCandidateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * 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 {string} [search] Search term to filter results
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listConciergeCandidates(project: string, platformId: string, search?: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListConciergeCandidates200Response>>;
+};
+/**
+ * ConciergeCandidatesApi - factory interface
+ */
+export declare const ConciergeCandidatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Approve a concierge candidate by a given concierge candidate ID. This will create a task that cann be assigned to a user.
+     * @summary Approve concierge candidate
+     * @param {ConciergeCandidatesApiApproveConciergeCandidateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    approveConciergeCandidate(requestParameters: ConciergeCandidatesApiApproveConciergeCandidateRequest, options?: RawAxiosRequestConfig): AxiosPromise<ConciergeCandidate>;
+    /**
+     * Delete a concierge candidate by a given concierge candidate ID.
+     * @summary Delete concierge candidate
+     * @param {ConciergeCandidatesApiDeleteConciergeCandidateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteConciergeCandidate(requestParameters: ConciergeCandidatesApiDeleteConciergeCandidateRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * 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>;
+};
+/**
+ * Request parameters for approveConciergeCandidate operation in ConciergeCandidatesApi.
+ */
+export interface ConciergeCandidatesApiApproveConciergeCandidateRequest {
+    /**
+     * Project unique identifier
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     */
+    readonly platformId: string;
+    /**
+     * The concierge candidate identifier
+     */
+    readonly conciergeCandidateId: string;
+}
+/**
+ * Request parameters for deleteConciergeCandidate operation in ConciergeCandidatesApi.
+ */
+export interface ConciergeCandidatesApiDeleteConciergeCandidateRequest {
+    /**
+     * Project unique identifier
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     */
+    readonly platformId: string;
+    /**
+     * The concierge candidate identifier
+     */
+    readonly conciergeCandidateId: string;
+}
+/**
+ * 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;
+    /**
+     * Search term to filter results
+     */
+    readonly search?: string;
+    /**
+     * Page reference token
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     */
+    readonly pageSize?: number;
+}
+/**
+ * ConciergeCandidatesApi - object-oriented interface
+ */
+export declare class ConciergeCandidatesApi extends BaseAPI {
+    /**
+     * Approve a concierge candidate by a given concierge candidate ID. This will create a task that cann be assigned to a user.
+     * @summary Approve concierge candidate
+     * @param {ConciergeCandidatesApiApproveConciergeCandidateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    approveConciergeCandidate(requestParameters: ConciergeCandidatesApiApproveConciergeCandidateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ConciergeCandidate, any, {}>>;
+    /**
+     * Delete a concierge candidate by a given concierge candidate ID.
+     * @summary Delete concierge candidate
+     * @param {ConciergeCandidatesApiDeleteConciergeCandidateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteConciergeCandidate(requestParameters: ConciergeCandidatesApiDeleteConciergeCandidateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * 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, {}>>;
+}
 /**
  * CustomersApi - axios parameter creator
  */