@teemill/platform 0.22.3 → 0.24.0

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.22.3
+ * The version of the OpenAPI document: 0.24.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -150,6 +150,19 @@ export interface Coupon {
      */
     'code': string;
 }
+/**
+ *
+ * @export
+ * @interface CreateChatChannel200Response
+ */
+export interface CreateChatChannel200Response {
+    /**
+     * Reference to the chat channel resource
+     * @type {string}
+     * @memberof CreateChatChannel200Response
+     */
+    'chatChannelRef': string;
+}
 /**
  *
  * @export
@@ -359,6 +372,12 @@ export interface Enquiry {
      * @memberof Enquiry
      */
     'extraInputs': Array<EnquiryExtraInputsInner> | null;
+    /**
+     * Reference to the chat channel resource
+     * @type {string}
+     * @memberof Enquiry
+     */
+    'chatChannelRef'?: string | null;
 }
 export declare const EnquiryStatusEnum: {
     readonly New: "New";
@@ -855,6 +874,12 @@ export interface Order {
      * @memberof Order
      */
     'paymentAttempts'?: Array<PaymentAttempt>;
+    /**
+     * The integration type of the order, e.g. \"website\" or \"shopify\"
+     * @type {string}
+     * @memberof Order
+     */
+    'integrationType'?: string;
 }
 /**
  *
@@ -2014,12 +2039,22 @@ export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeo
  * @export
  */
 export declare const EnquiriesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create a chat channel for a customer enquiry if it doesn\'t exist
+     * @summary Create chat channel
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} enquiryId The enquiry identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createChatChannel: (project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get a customer enquiry
      * @summary Get customer enquiry
      * @param {string} project Project unique identifier
      * @param {string} platformId The platform identifier
-     * @param {string} enquiryId
+     * @param {string} enquiryId The enquiry identifier
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -2043,7 +2078,7 @@ export declare const EnquiriesApiAxiosParamCreator: (configuration?: Configurati
      * @summary List customer enquiry Logs
      * @param {string} project Project unique identifier
      * @param {string} platformId The platform identifier
-     * @param {string} enquiryId
+     * @param {string} enquiryId The enquiry identifier
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -2054,12 +2089,22 @@ export declare const EnquiriesApiAxiosParamCreator: (configuration?: Configurati
  * @export
  */
 export declare const EnquiriesApiFp: (configuration?: Configuration) => {
+    /**
+     * Create a chat channel for a customer enquiry if it doesn\'t exist
+     * @summary Create chat channel
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} enquiryId The enquiry identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createChatChannel(project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateChatChannel200Response>>;
     /**
      * Get a customer enquiry
      * @summary Get customer enquiry
      * @param {string} project Project unique identifier
      * @param {string} platformId The platform identifier
-     * @param {string} enquiryId
+     * @param {string} enquiryId The enquiry identifier
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -2083,7 +2128,7 @@ export declare const EnquiriesApiFp: (configuration?: Configuration) => {
      * @summary List customer enquiry Logs
      * @param {string} project Project unique identifier
      * @param {string} platformId The platform identifier
-     * @param {string} enquiryId
+     * @param {string} enquiryId The enquiry identifier
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -2094,6 +2139,14 @@ export declare const EnquiriesApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const EnquiriesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create a chat channel for a customer enquiry if it doesn\'t exist
+     * @summary Create chat channel
+     * @param {EnquiriesApiCreateChatChannelRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createChatChannel(requestParameters: EnquiriesApiCreateChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateChatChannel200Response>;
     /**
      * Get a customer enquiry
      * @summary Get customer enquiry
@@ -2119,6 +2172,31 @@ export declare const EnquiriesApiFactory: (configuration?: Configuration, basePa
      */
     listCustomerEnquiryLogs(requestParameters: EnquiriesApiListCustomerEnquiryLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListCustomerEnquiryLogs200Response>;
 };
+/**
+ * Request parameters for createChatChannel operation in EnquiriesApi.
+ * @export
+ * @interface EnquiriesApiCreateChatChannelRequest
+ */
+export interface EnquiriesApiCreateChatChannelRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof EnquiriesApiCreateChatChannel
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof EnquiriesApiCreateChatChannel
+     */
+    readonly platformId: string;
+    /**
+     * The enquiry identifier
+     * @type {string}
+     * @memberof EnquiriesApiCreateChatChannel
+     */
+    readonly enquiryId: string;
+}
 /**
  * Request parameters for getCustomerEnquiry operation in EnquiriesApi.
  * @export
@@ -2138,7 +2216,7 @@ export interface EnquiriesApiGetCustomerEnquiryRequest {
      */
     readonly platformId: string;
     /**
-     *
+     * The enquiry identifier
      * @type {string}
      * @memberof EnquiriesApiGetCustomerEnquiry
      */
@@ -2212,7 +2290,7 @@ export interface EnquiriesApiListCustomerEnquiryLogsRequest {
      */
     readonly platformId: string;
     /**
-     *
+     * The enquiry identifier
      * @type {string}
      * @memberof EnquiriesApiListCustomerEnquiryLogs
      */
@@ -2225,6 +2303,15 @@ export interface EnquiriesApiListCustomerEnquiryLogsRequest {
  * @extends {BaseAPI}
  */
 export declare class EnquiriesApi extends BaseAPI {
+    /**
+     * Create a chat channel for a customer enquiry if it doesn\'t exist
+     * @summary Create chat channel
+     * @param {EnquiriesApiCreateChatChannelRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EnquiriesApi
+     */
+    createChatChannel(requestParameters: EnquiriesApiCreateChatChannelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateChatChannel200Response, any>>;
     /**
      * Get a customer enquiry
      * @summary Get customer enquiry
@@ -2290,6 +2377,16 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     getOrder: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get an order receipt for a platform by a given order ID.
+     * @summary Get order receipt
+     * @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}
+     */
+    getOrderReceipt: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * List available fulfillers for a given fulfillment
      * @summary List available fulfillers
@@ -2325,6 +2422,16 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     retryPlatformPayment: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
+     * @summary Send order receipt
+     * @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}
+     */
+    sendOrderReceipt: (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
@@ -2374,6 +2481,16 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getOrder(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
+    /**
+     * Get an order receipt for a platform by a given order ID.
+     * @summary Get order receipt
+     * @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}
+     */
+    getOrderReceipt(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
     /**
      * List available fulfillers for a given fulfillment
      * @summary List available fulfillers
@@ -2409,6 +2526,16 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     retryPlatformPayment(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
+    /**
+     * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
+     * @summary Send order receipt
+     * @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}
+     */
+    sendOrderReceipt(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Update a fulfillment that belongs to an order placed through the platform
      * @summary Update fulfillment
@@ -2450,6 +2577,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
+    /**
+     * Get an order receipt for a platform by a given order ID.
+     * @summary Get order receipt
+     * @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrderReceipt(requestParameters: OrdersApiGetOrderReceiptRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
     /**
      * List available fulfillers for a given fulfillment
      * @summary List available fulfillers
@@ -2474,6 +2609,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
+    /**
+     * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
+     * @summary Send order receipt
+     * @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sendOrderReceipt(requestParameters: OrdersApiSendOrderReceiptRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Update a fulfillment that belongs to an order placed through the platform
      * @summary Update fulfillment
@@ -2570,6 +2713,31 @@ export interface OrdersApiGetOrderRequest {
      */
     readonly orderId: string;
 }
+/**
+ * Request parameters for getOrderReceipt operation in OrdersApi.
+ * @export
+ * @interface OrdersApiGetOrderReceiptRequest
+ */
+export interface OrdersApiGetOrderReceiptRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof OrdersApiGetOrderReceipt
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof OrdersApiGetOrderReceipt
+     */
+    readonly platformId: string;
+    /**
+     * The order identifier
+     * @type {string}
+     * @memberof OrdersApiGetOrderReceipt
+     */
+    readonly orderId: string;
+}
 /**
  * Request parameters for listAvailableFulfillers operation in OrdersApi.
  * @export
@@ -2675,6 +2843,31 @@ export interface OrdersApiRetryPlatformPaymentRequest {
      */
     readonly orderId: string;
 }
+/**
+ * Request parameters for sendOrderReceipt operation in OrdersApi.
+ * @export
+ * @interface OrdersApiSendOrderReceiptRequest
+ */
+export interface OrdersApiSendOrderReceiptRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof OrdersApiSendOrderReceipt
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof OrdersApiSendOrderReceipt
+     */
+    readonly platformId: string;
+    /**
+     * The order identifier
+     * @type {string}
+     * @memberof OrdersApiSendOrderReceipt
+     */
+    readonly orderId: string;
+}
 /**
  * Request parameters for updateFulfillment operation in OrdersApi.
  * @export
@@ -2740,6 +2933,15 @@ export declare class OrdersApi extends BaseAPI {
      * @memberof OrdersApi
      */
     getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
+    /**
+     * Get an order receipt for a platform by a given order ID.
+     * @summary Get order receipt
+     * @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    getOrderReceipt(requestParameters: OrdersApiGetOrderReceiptRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
     /**
      * List available fulfillers for a given fulfillment
      * @summary List available fulfillers
@@ -2767,6 +2969,15 @@ export declare class OrdersApi extends BaseAPI {
      * @memberof OrdersApi
      */
     retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
+    /**
+     * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
+     * @summary Send order receipt
+     * @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    sendOrderReceipt(requestParameters: OrdersApiSendOrderReceiptRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * Update a fulfillment that belongs to an order placed through the platform
      * @summary Update fulfillment