@teemill/platform 0.32.0 → 0.33.1

package/base.ts

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

package/common.ts

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

package/configuration.ts

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

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.32.0
+ * The version of the OpenAPI document: 0.33.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -111,12 +111,37 @@ export interface AmendOrderRequestAmendmentsInner {
      * @memberof AmendOrderRequestAmendmentsInner
      */
     'newVariantRef'?: string;
+    /**
+     *
+     * @type {AmendOrderRequestAmendmentsInnerReason}
+     * @memberof AmendOrderRequestAmendmentsInner
+     */
+    'reason': AmendOrderRequestAmendmentsInnerReason;
 }
 export declare const AmendOrderRequestAmendmentsInnerActionEnum: {
     readonly Refund: "refund";
     readonly Exchange: "exchange";
 };
 export type AmendOrderRequestAmendmentsInnerActionEnum = typeof AmendOrderRequestAmendmentsInnerActionEnum[keyof typeof AmendOrderRequestAmendmentsInnerActionEnum];
+/**
+ *
+ * @export
+ * @interface AmendOrderRequestAmendmentsInnerReason
+ */
+export interface AmendOrderRequestAmendmentsInnerReason {
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof AmendOrderRequestAmendmentsInnerReason
+     */
+    'reasonRef': string;
+    /**
+     * Additional comments as to why the item is being returned or exchanged.
+     * @type {string}
+     * @memberof AmendOrderRequestAmendmentsInnerReason
+     */
+    'additionalComments'?: string | null;
+}
 /**
  *
  * @export
@@ -418,6 +443,56 @@ export interface CreateOrderContactInformation {
      */
     'phone'?: string | null;
 }
+/**
+ *
+ * @export
+ * @interface CreatePixelRequest
+ */
+export interface CreatePixelRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CreatePixelRequest
+     */
+    'name': string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof CreatePixelRequest
+     */
+    'sourceProjects': Array<string>;
+    /**
+     *
+     * @type {CreatePixelRequestFilters}
+     * @memberof CreatePixelRequest
+     */
+    'filters': CreatePixelRequestFilters;
+}
+/**
+ *
+ * @export
+ * @interface CreatePixelRequestFilters
+ */
+export interface CreatePixelRequestFilters {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof CreatePixelRequestFilters
+     */
+    'projects': Array<string> | null;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof CreatePixelRequestFilters
+     */
+    'demographics': Array<string> | null;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof CreatePixelRequestFilters
+     */
+    'tags': Array<string> | null;
+}
 /**
  * @type CreateReview201Response
  * @export
@@ -1593,6 +1668,56 @@ export declare const PaymentAttemptStatusEnum: {
     readonly Cancelled: "cancelled";
 };
 export type PaymentAttemptStatusEnum = typeof PaymentAttemptStatusEnum[keyof typeof PaymentAttemptStatusEnum];
+/**
+ *
+ * @export
+ * @interface Pixel
+ */
+export interface Pixel {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof Pixel
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Pixel
+     */
+    'name': string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof Pixel
+     */
+    'sourceProjects': Array<string>;
+    /**
+     *
+     * @type {CreatePixelRequestFilters}
+     * @memberof Pixel
+     */
+    'filters': CreatePixelRequestFilters;
+}
+/**
+ *
+ * @export
+ * @interface PixelsResponse
+ */
+export interface PixelsResponse {
+    /**
+     *
+     * @type {Array<Pixel>}
+     * @memberof PixelsResponse
+     */
+    'pixels': Array<Pixel>;
+    /**
+     *
+     * @type {number}
+     * @memberof PixelsResponse
+     */
+    'nextPageToken'?: number | null;
+}
 /**
  *
  * @export
@@ -1727,10 +1852,71 @@ export interface Project {
 export interface ReturnOrderRequest {
     /**
      *
-     * @type {Array<AmendOrderRequestAmendmentsInner>}
+     * @type {Array<ReturnOrderRequestReturnsInner>}
      * @memberof ReturnOrderRequest
      */
-    'returns': Array<AmendOrderRequestAmendmentsInner>;
+    'returns': Array<ReturnOrderRequestReturnsInner>;
+}
+/**
+ *
+ * @export
+ * @interface ReturnOrderRequestReturnsInner
+ */
+export interface ReturnOrderRequestReturnsInner {
+    /**
+     * Unique order item identifier
+     * @type {string}
+     * @memberof ReturnOrderRequestReturnsInner
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReturnOrderRequestReturnsInner
+     */
+    'action': ReturnOrderRequestReturnsInnerActionEnum;
+    /**
+     * The quantity of the item to refund or exchange. This must be less than or equal to the quantity of the item in the order.
+     * @type {number}
+     * @memberof ReturnOrderRequestReturnsInner
+     */
+    'quantity': number;
+    /**
+     * A reference to the variant being ordered
+     * @type {string}
+     * @memberof ReturnOrderRequestReturnsInner
+     */
+    'newVariantRef'?: string;
+    /**
+     *
+     * @type {ReturnOrderRequestReturnsInnerReason}
+     * @memberof ReturnOrderRequestReturnsInner
+     */
+    'reason': ReturnOrderRequestReturnsInnerReason;
+}
+export declare const ReturnOrderRequestReturnsInnerActionEnum: {
+    readonly Refund: "refund";
+    readonly Exchange: "exchange";
+};
+export type ReturnOrderRequestReturnsInnerActionEnum = typeof ReturnOrderRequestReturnsInnerActionEnum[keyof typeof ReturnOrderRequestReturnsInnerActionEnum];
+/**
+ *
+ * @export
+ * @interface ReturnOrderRequestReturnsInnerReason
+ */
+export interface ReturnOrderRequestReturnsInnerReason {
+    /**
+     * A reference to the reason for the return or exchange.
+     * @type {string}
+     * @memberof ReturnOrderRequestReturnsInnerReason
+     */
+    'reasonRef': string;
+    /**
+     * Additional comments as to why the item is being returned or exchanged.
+     * @type {string}
+     * @memberof ReturnOrderRequestReturnsInnerReason
+     */
+    'additionalComments'?: string | null;
 }
 /**
  *
@@ -4367,6 +4553,390 @@ export declare class PaymentApi extends BaseAPI {
      */
     getStripePaymentAccount(requestParameters: PaymentApiGetStripePaymentAccountRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentAccount, any>>;
 }
+/**
+ * PixelsApi - axios parameter creator
+ * @export
+ */
+export declare const PixelsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Create a pixel
+     * @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 results
+     * @param {CreatePixelRequest} [createPixelRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPixel: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, createPixelRequest?: CreatePixelRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete a pixel
+     * @summary Delete a pixel
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} pixelId The pixel identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePixel: (project: string, platformId: string, pixelId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a pixel for a platform by a given pixel ID.
+     * @summary Get pixel
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} pixelId The pixel identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPixel: (project: string, platformId: string, pixelId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List pixels for a platform
+     * @summary List pixels
+     * @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 results
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPixels: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update a pixel
+     * @summary Update a pixel
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} pixelId The pixel identifier
+     * @param {CreatePixelRequest} [createPixelRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePixel: (project: string, platformId: string, pixelId: string, createPixelRequest?: CreatePixelRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PixelsApi - functional programming interface
+ * @export
+ */
+export declare const PixelsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Create a pixel
+     * @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 results
+     * @param {CreatePixelRequest} [createPixelRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPixel(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, createPixelRequest?: CreatePixelRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pixel>>;
+    /**
+     * Delete a pixel
+     * @summary Delete a pixel
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} pixelId The pixel identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePixel(project: string, platformId: string, pixelId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Get a pixel for a platform by a given pixel ID.
+     * @summary Get pixel
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} pixelId The pixel identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPixel(project: string, platformId: string, pixelId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pixel>>;
+    /**
+     * List pixels for a platform
+     * @summary List pixels
+     * @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 results
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPixels(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PixelsResponse>>;
+    /**
+     * Update a pixel
+     * @summary Update a pixel
+     * @param {string} project Project unique identifier
+     * @param {string} platformId The platform identifier
+     * @param {string} pixelId The pixel identifier
+     * @param {CreatePixelRequest} [createPixelRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePixel(project: string, platformId: string, pixelId: string, createPixelRequest?: CreatePixelRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pixel>>;
+};
+/**
+ * PixelsApi - factory interface
+ * @export
+ */
+export declare const PixelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Create a pixel
+     * @param {PixelsApiCreatePixelRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPixel(requestParameters: PixelsApiCreatePixelRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pixel>;
+    /**
+     * Delete a pixel
+     * @summary Delete a pixel
+     * @param {PixelsApiDeletePixelRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePixel(requestParameters: PixelsApiDeletePixelRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Get a pixel for a platform by a given pixel ID.
+     * @summary Get pixel
+     * @param {PixelsApiGetPixelRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPixel(requestParameters: PixelsApiGetPixelRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pixel>;
+    /**
+     * List pixels for a platform
+     * @summary List pixels
+     * @param {PixelsApiListPixelsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPixels(requestParameters: PixelsApiListPixelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PixelsResponse>;
+    /**
+     * Update a pixel
+     * @summary Update a pixel
+     * @param {PixelsApiUpdatePixelRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePixel(requestParameters: PixelsApiUpdatePixelRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pixel>;
+};
+/**
+ * Request parameters for createPixel operation in PixelsApi.
+ * @export
+ * @interface PixelsApiCreatePixelRequest
+ */
+export interface PixelsApiCreatePixelRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof PixelsApiCreatePixel
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof PixelsApiCreatePixel
+     */
+    readonly platformId: string;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof PixelsApiCreatePixel
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof PixelsApiCreatePixel
+     */
+    readonly pageSize?: number;
+    /**
+     * Search term to filter results
+     * @type {string}
+     * @memberof PixelsApiCreatePixel
+     */
+    readonly search?: string;
+    /**
+     *
+     * @type {CreatePixelRequest}
+     * @memberof PixelsApiCreatePixel
+     */
+    readonly createPixelRequest?: CreatePixelRequest;
+}
+/**
+ * Request parameters for deletePixel operation in PixelsApi.
+ * @export
+ * @interface PixelsApiDeletePixelRequest
+ */
+export interface PixelsApiDeletePixelRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof PixelsApiDeletePixel
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof PixelsApiDeletePixel
+     */
+    readonly platformId: string;
+    /**
+     * The pixel identifier
+     * @type {string}
+     * @memberof PixelsApiDeletePixel
+     */
+    readonly pixelId: string;
+}
+/**
+ * Request parameters for getPixel operation in PixelsApi.
+ * @export
+ * @interface PixelsApiGetPixelRequest
+ */
+export interface PixelsApiGetPixelRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof PixelsApiGetPixel
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof PixelsApiGetPixel
+     */
+    readonly platformId: string;
+    /**
+     * The pixel identifier
+     * @type {string}
+     * @memberof PixelsApiGetPixel
+     */
+    readonly pixelId: string;
+}
+/**
+ * Request parameters for listPixels operation in PixelsApi.
+ * @export
+ * @interface PixelsApiListPixelsRequest
+ */
+export interface PixelsApiListPixelsRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof PixelsApiListPixels
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof PixelsApiListPixels
+     */
+    readonly platformId: string;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof PixelsApiListPixels
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof PixelsApiListPixels
+     */
+    readonly pageSize?: number;
+    /**
+     * Search term to filter results
+     * @type {string}
+     * @memberof PixelsApiListPixels
+     */
+    readonly search?: string;
+}
+/**
+ * Request parameters for updatePixel operation in PixelsApi.
+ * @export
+ * @interface PixelsApiUpdatePixelRequest
+ */
+export interface PixelsApiUpdatePixelRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof PixelsApiUpdatePixel
+     */
+    readonly project: string;
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof PixelsApiUpdatePixel
+     */
+    readonly platformId: string;
+    /**
+     * The pixel identifier
+     * @type {string}
+     * @memberof PixelsApiUpdatePixel
+     */
+    readonly pixelId: string;
+    /**
+     *
+     * @type {CreatePixelRequest}
+     * @memberof PixelsApiUpdatePixel
+     */
+    readonly createPixelRequest?: CreatePixelRequest;
+}
+/**
+ * PixelsApi - object-oriented interface
+ * @export
+ * @class PixelsApi
+ * @extends {BaseAPI}
+ */
+export declare class PixelsApi extends BaseAPI {
+    /**
+     *
+     * @summary Create a pixel
+     * @param {PixelsApiCreatePixelRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PixelsApi
+     */
+    createPixel(requestParameters: PixelsApiCreatePixelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pixel, any>>;
+    /**
+     * Delete a pixel
+     * @summary Delete a pixel
+     * @param {PixelsApiDeletePixelRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PixelsApi
+     */
+    deletePixel(requestParameters: PixelsApiDeletePixelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Get a pixel for a platform by a given pixel ID.
+     * @summary Get pixel
+     * @param {PixelsApiGetPixelRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PixelsApi
+     */
+    getPixel(requestParameters: PixelsApiGetPixelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pixel, any>>;
+    /**
+     * List pixels for a platform
+     * @summary List pixels
+     * @param {PixelsApiListPixelsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PixelsApi
+     */
+    listPixels(requestParameters: PixelsApiListPixelsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PixelsResponse, any>>;
+    /**
+     * Update a pixel
+     * @summary Update a pixel
+     * @param {PixelsApiUpdatePixelRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PixelsApi
+     */
+    updatePixel(requestParameters: PixelsApiUpdatePixelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pixel, any>>;
+}
 /**
  * PlatformApi - axios parameter creator
  * @export