@teemill/platform 0.18.0 → 0.20.0

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.18.0
+ * The version of the OpenAPI document: 0.20.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -100,6 +100,31 @@ export interface AuthorizeStripe200Response {
      */
     'redirect_url': string;
 }
+/**
+ *
+ * @export
+ * @interface Client
+ */
+export interface Client {
+    /**
+     *
+     * @type {string}
+     * @memberof Client
+     */
+    'id'?: string;
+    /**
+     * API reference for the client
+     * @type {string}
+     * @memberof Client
+     */
+    'ref'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Client
+     */
+    'name'?: string;
+}
 /**
  * Order recipient contact information, used only for courier tracking/updates.
  * @export
@@ -225,6 +250,121 @@ export interface DeliveryEstimates {
      */
     'max'?: string;
 }
+/**
+ *
+ * @export
+ * @interface Enquiry
+ */
+export interface Enquiry {
+    /**
+     *
+     * @type {string}
+     * @memberof Enquiry
+     */
+    'id': string;
+    /**
+     * API reference for the enquiry
+     * @type {string}
+     * @memberof Enquiry
+     */
+    'ref': string;
+    /**
+     *
+     * @type {ListCustomerEnquiryLogs200ResponseLogsInnerCustomer}
+     * @memberof Enquiry
+     */
+    'customer': ListCustomerEnquiryLogs200ResponseLogsInnerCustomer;
+    /**
+     *
+     * @type {Client}
+     * @memberof Enquiry
+     */
+    'client': Client;
+    /**
+     *
+     * @type {string}
+     * @memberof Enquiry
+     */
+    'subject': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Enquiry
+     */
+    'body': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Enquiry
+     */
+    'createdAt': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Enquiry
+     */
+    'updatedAt': string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof Enquiry
+     */
+    'tags': Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof Enquiry
+     */
+    'status': EnquiryStatusEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Enquiry
+     */
+    'read': boolean;
+    /**
+     *
+     * @type {Array<EnquiryExtraInputsInner>}
+     * @memberof Enquiry
+     */
+    'extraInputs': Array<EnquiryExtraInputsInner> | null;
+}
+export declare const EnquiryStatusEnum: {
+    readonly New: "New";
+    readonly Archived: "Archived";
+    readonly Priority: "Priority";
+};
+export type EnquiryStatusEnum = typeof EnquiryStatusEnum[keyof typeof EnquiryStatusEnum];
+/**
+ *
+ * @export
+ * @interface EnquiryExtraInputsInner
+ */
+export interface EnquiryExtraInputsInner {
+    /**
+     *
+     * @type {string}
+     * @memberof EnquiryExtraInputsInner
+     */
+    'name': string;
+    /**
+     *
+     * @type {string}
+     * @memberof EnquiryExtraInputsInner
+     */
+    'type': string;
+    /**
+     *
+     * @type {EnquiryExtraInputsInnerValue}
+     * @memberof EnquiryExtraInputsInner
+     */
+    'value': EnquiryExtraInputsInnerValue;
+}
+/**
+ * @type EnquiryExtraInputsInnerValue
+ * @export
+ */
+export type EnquiryExtraInputsInnerValue = Array<string | null> | string;
 /**
  *
  * @export
@@ -406,6 +546,94 @@ export interface Image {
      */
     'sortOrder'?: number;
 }
+/**
+ *
+ * @export
+ * @interface ListCustomerEnquiries200Response
+ */
+export interface ListCustomerEnquiries200Response {
+    /**
+     *
+     * @type {Array<Enquiry>}
+     * @memberof ListCustomerEnquiries200Response
+     */
+    'enquiries'?: Array<Enquiry>;
+    /**
+     *
+     * @type {number}
+     * @memberof ListCustomerEnquiries200Response
+     */
+    'nextPageToken'?: number | null;
+}
+/**
+ *
+ * @export
+ * @interface ListCustomerEnquiryLogs200Response
+ */
+export interface ListCustomerEnquiryLogs200Response {
+    /**
+     *
+     * @type {Array<ListCustomerEnquiryLogs200ResponseLogsInner>}
+     * @memberof ListCustomerEnquiryLogs200Response
+     */
+    'logs': Array<ListCustomerEnquiryLogs200ResponseLogsInner>;
+}
+/**
+ *
+ * @export
+ * @interface ListCustomerEnquiryLogs200ResponseLogsInner
+ */
+export interface ListCustomerEnquiryLogs200ResponseLogsInner {
+    /**
+     *
+     * @type {ListCustomerEnquiryLogs200ResponseLogsInnerCustomer}
+     * @memberof ListCustomerEnquiryLogs200ResponseLogsInner
+     */
+    'customer': ListCustomerEnquiryLogs200ResponseLogsInnerCustomer;
+    /**
+     *
+     * @type {string}
+     * @memberof ListCustomerEnquiryLogs200ResponseLogsInner
+     */
+    'createdAt': string;
+}
+/**
+ *
+ * @export
+ * @interface ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
+ */
+export interface ListCustomerEnquiryLogs200ResponseLogsInnerCustomer {
+    /**
+     *
+     * @type {string}
+     * @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
+     */
+    'id'?: string;
+    /**
+     * API reference for the customer
+     * @type {string}
+     * @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
+     */
+    'ref'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
+     */
+    'firstName'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
+     */
+    'lastName'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
+     */
+    'email'?: string;
+}
 /**
  *
  * @export
@@ -1644,6 +1872,250 @@ export declare const ListCustomersSortByEnum: {
     readonly LastPurchased2: "-lastPurchased";
 };
 export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeof ListCustomersSortByEnum];
+/**
+ * EnquiriesApi - axios parameter creator
+ * @export
+ */
+export declare const EnquiriesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Get a customer enquiry
+     * @summary Get customer enquiry
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} enquiryId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCustomerEnquiry: (project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List customer enquiries
+     * @summary List customer enquiries
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @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 {string} [search] Search term to filter based on enquiry title, content, customer name and customer email.
+     * @param {string} [start] Start of date range to filter by
+     * @param {string} [end] End of date range to filter by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomerEnquiries: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Lists all customer enquiry Logs
+     * @summary List customer enquiry Logs
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} enquiryId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomerEnquiryLogs: (project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * EnquiriesApi - functional programming interface
+ * @export
+ */
+export declare const EnquiriesApiFp: (configuration?: Configuration) => {
+    /**
+     * Get a customer enquiry
+     * @summary Get customer enquiry
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} enquiryId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCustomerEnquiry(project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Enquiry>>;
+    /**
+     * List customer enquiries
+     * @summary List customer enquiries
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @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 {string} [search] Search term to filter based on enquiry title, content, customer name and customer email.
+     * @param {string} [start] Start of date range to filter by
+     * @param {string} [end] End of date range to filter by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomerEnquiries(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomerEnquiries200Response>>;
+    /**
+     * Lists all customer enquiry Logs
+     * @summary List customer enquiry Logs
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} enquiryId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomerEnquiryLogs(project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomerEnquiryLogs200Response>>;
+};
+/**
+ * EnquiriesApi - factory interface
+ * @export
+ */
+export declare const EnquiriesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Get a customer enquiry
+     * @summary Get customer enquiry
+     * @param {EnquiriesApiGetCustomerEnquiryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCustomerEnquiry(requestParameters: EnquiriesApiGetCustomerEnquiryRequest, options?: RawAxiosRequestConfig): AxiosPromise<Enquiry>;
+    /**
+     * List customer enquiries
+     * @summary List customer enquiries
+     * @param {EnquiriesApiListCustomerEnquiriesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomerEnquiries(requestParameters: EnquiriesApiListCustomerEnquiriesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListCustomerEnquiries200Response>;
+    /**
+     * Lists all customer enquiry Logs
+     * @summary List customer enquiry Logs
+     * @param {EnquiriesApiListCustomerEnquiryLogsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomerEnquiryLogs(requestParameters: EnquiriesApiListCustomerEnquiryLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListCustomerEnquiryLogs200Response>;
+};
+/**
+ * Request parameters for getCustomerEnquiry operation in EnquiriesApi.
+ * @export
+ * @interface EnquiriesApiGetCustomerEnquiryRequest
+ */
+export interface EnquiriesApiGetCustomerEnquiryRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof EnquiriesApiGetCustomerEnquiry
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof EnquiriesApiGetCustomerEnquiry
+     */
+    readonly platformId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EnquiriesApiGetCustomerEnquiry
+     */
+    readonly enquiryId: string;
+}
+/**
+ * Request parameters for listCustomerEnquiries operation in EnquiriesApi.
+ * @export
+ * @interface EnquiriesApiListCustomerEnquiriesRequest
+ */
+export interface EnquiriesApiListCustomerEnquiriesRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof EnquiriesApiListCustomerEnquiries
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof EnquiriesApiListCustomerEnquiries
+     */
+    readonly platformId: string;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof EnquiriesApiListCustomerEnquiries
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof EnquiriesApiListCustomerEnquiries
+     */
+    readonly pageSize?: number;
+    /**
+     * Search term to filter based on enquiry title, content, customer name and customer email.
+     * @type {string}
+     * @memberof EnquiriesApiListCustomerEnquiries
+     */
+    readonly search?: string;
+    /**
+     * Start of date range to filter by
+     * @type {string}
+     * @memberof EnquiriesApiListCustomerEnquiries
+     */
+    readonly start?: string;
+    /**
+     * End of date range to filter by
+     * @type {string}
+     * @memberof EnquiriesApiListCustomerEnquiries
+     */
+    readonly end?: string;
+}
+/**
+ * Request parameters for listCustomerEnquiryLogs operation in EnquiriesApi.
+ * @export
+ * @interface EnquiriesApiListCustomerEnquiryLogsRequest
+ */
+export interface EnquiriesApiListCustomerEnquiryLogsRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof EnquiriesApiListCustomerEnquiryLogs
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof EnquiriesApiListCustomerEnquiryLogs
+     */
+    readonly platformId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EnquiriesApiListCustomerEnquiryLogs
+     */
+    readonly enquiryId: string;
+}
+/**
+ * EnquiriesApi - object-oriented interface
+ * @export
+ * @class EnquiriesApi
+ * @extends {BaseAPI}
+ */
+export declare class EnquiriesApi extends BaseAPI {
+    /**
+     * Get a customer enquiry
+     * @summary Get customer enquiry
+     * @param {EnquiriesApiGetCustomerEnquiryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EnquiriesApi
+     */
+    getCustomerEnquiry(requestParameters: EnquiriesApiGetCustomerEnquiryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Enquiry, any>>;
+    /**
+     * List customer enquiries
+     * @summary List customer enquiries
+     * @param {EnquiriesApiListCustomerEnquiriesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EnquiriesApi
+     */
+    listCustomerEnquiries(requestParameters: EnquiriesApiListCustomerEnquiriesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCustomerEnquiries200Response, any>>;
+    /**
+     * Lists all customer enquiry Logs
+     * @summary List customer enquiry Logs
+     * @param {EnquiriesApiListCustomerEnquiryLogsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EnquiriesApi
+     */
+    listCustomerEnquiryLogs(requestParameters: EnquiriesApiListCustomerEnquiryLogsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCustomerEnquiryLogs200Response, any>>;
+}
 /**
  * OrdersApi - axios parameter creator
  * @export
@@ -1706,6 +2178,16 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     listOrders: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retries failed platform payment, so fulfillment can proceed.
+     * @summary Retry
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} orderId The order identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retryPlatformPayment: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update a fulfillment that belongs to an order placed through the platform
      * @summary Update fulfillment
@@ -1780,6 +2262,16 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, dateFilterType?: ListOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
+    /**
+     * Retries failed platform payment, so fulfillment can proceed.
+     * @summary Retry
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} orderId The order identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retryPlatformPayment(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
     /**
      * Update a fulfillment that belongs to an order placed through the platform
      * @summary Update fulfillment
@@ -1837,6 +2329,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse>;
+    /**
+     * Retries failed platform payment, so fulfillment can proceed.
+     * @summary Retry
+     * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
     /**
      * Update a fulfillment that belongs to an order placed through the platform
      * @summary Update fulfillment
@@ -2013,6 +2513,31 @@ export interface OrdersApiListOrdersRequest {
      */
     readonly dateFilterType?: ListOrdersDateFilterTypeEnum;
 }
+/**
+ * Request parameters for retryPlatformPayment operation in OrdersApi.
+ * @export
+ * @interface OrdersApiRetryPlatformPaymentRequest
+ */
+export interface OrdersApiRetryPlatformPaymentRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof OrdersApiRetryPlatformPayment
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof OrdersApiRetryPlatformPayment
+     */
+    readonly platformId: string;
+    /**
+     * The order identifier
+     * @type {string}
+     * @memberof OrdersApiRetryPlatformPayment
+     */
+    readonly orderId: string;
+}
 /**
  * Request parameters for updateFulfillment operation in OrdersApi.
  * @export
@@ -2096,6 +2621,15 @@ export declare class OrdersApi extends BaseAPI {
      * @memberof OrdersApi
      */
     listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any>>;
+    /**
+     * Retries failed platform payment, so fulfillment can proceed.
+     * @summary Retry
+     * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
     /**
      * Update a fulfillment that belongs to an order placed through the platform
      * @summary Update fulfillment