@teemill/platform 0.32.0 → 0.33.0

package/docs/Pixel.md

@@ -0,0 +1,26 @@
+# Pixel
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**sourceProjects** | **Array<string>** |  | [default to undefined]
+**filters** | [**CreatePixelRequestFilters**](CreatePixelRequestFilters.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Pixel } from '@teemill/platform';
+
+const instance: Pixel = {
+    id,
+    name,
+    sourceProjects,
+    filters,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PixelsApi.md

@@ -0,0 +1,341 @@
+# PixelsApi
+
+All URIs are relative to *https://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createPixel**](#createpixel) | **POST** /v1/platform/{platformId}/pixels | Create a pixel|
+|[**deletePixel**](#deletepixel) | **DELETE** /v1/platform/{platformId}/pixels/{pixelId} | Delete a pixel|
+|[**getPixel**](#getpixel) | **GET** /v1/platform/{platformId}/pixels/{pixelId} | Get pixel|
+|[**listPixels**](#listpixels) | **GET** /v1/platform/{platformId}/pixels | List pixels|
+|[**updatePixel**](#updatepixel) | **PUT** /v1/platform/{platformId}/pixels/{pixelId} | Update a pixel|
+
+# **createPixel**
+> Pixel createPixel()
+
+
+### Example
+
+```typescript
+import {
+    PixelsApi,
+    Configuration,
+    CreatePixelRequest
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new PixelsApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let pageToken: number; //Page reference token (optional) (default to 1)
+let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
+let search: string; //Search term to filter results (optional) (default to undefined)
+let createPixelRequest: CreatePixelRequest; // (optional)
+
+const { status, data } = await apiInstance.createPixel(
+    project,
+    platformId,
+    pageToken,
+    pageSize,
+    search,
+    createPixelRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createPixelRequest** | **CreatePixelRequest**|  | |
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
+| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
+| **search** | [**string**] | Search term to filter results | (optional) defaults to undefined|
+
+
+### Return type
+
+**Pixel**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Pixel response |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deletePixel**
+> deletePixel()
+
+Delete a pixel
+
+### Example
+
+```typescript
+import {
+    PixelsApi,
+    Configuration
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new PixelsApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let pixelId: string; //The pixel identifier (default to undefined)
+
+const { status, data } = await apiInstance.deletePixel(
+    project,
+    platformId,
+    pixelId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **pixelId** | [**string**] | The pixel identifier | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Deleted successfully |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getPixel**
+> Pixel getPixel()
+
+Get a pixel for a platform by a given pixel ID.
+
+### Example
+
+```typescript
+import {
+    PixelsApi,
+    Configuration
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new PixelsApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let pixelId: string; //The pixel identifier (default to undefined)
+
+const { status, data } = await apiInstance.getPixel(
+    project,
+    platformId,
+    pixelId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **pixelId** | [**string**] | The pixel identifier | defaults to undefined|
+
+
+### Return type
+
+**Pixel**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Pixel response |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listPixels**
+> PixelsResponse listPixels()
+
+List pixels for a platform
+
+### Example
+
+```typescript
+import {
+    PixelsApi,
+    Configuration
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new PixelsApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let pageToken: number; //Page reference token (optional) (default to 1)
+let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
+let search: string; //Search term to filter results (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listPixels(
+    project,
+    platformId,
+    pageToken,
+    pageSize,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
+| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
+| **search** | [**string**] | Search term to filter results | (optional) defaults to undefined|
+
+
+### Return type
+
+**PixelsResponse**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Pixels response |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **updatePixel**
+> Pixel updatePixel()
+
+Update a pixel
+
+### Example
+
+```typescript
+import {
+    PixelsApi,
+    Configuration,
+    CreatePixelRequest
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new PixelsApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let pixelId: string; //The pixel identifier (default to undefined)
+let createPixelRequest: CreatePixelRequest; // (optional)
+
+const { status, data } = await apiInstance.updatePixel(
+    project,
+    platformId,
+    pixelId,
+    createPixelRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createPixelRequest** | **CreatePixelRequest**|  | |
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **pixelId** | [**string**] | The pixel identifier | defaults to undefined|
+
+
+### Return type
+
+**Pixel**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Pixel response |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/PixelsResponse.md

@@ -0,0 +1,22 @@
+# PixelsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pixels** | [**Array<Pixel>**](Pixel.md) |  | [default to undefined]
+**nextPageToken** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PixelsResponse } from '@teemill/platform';
+
+const instance: PixelsResponse = {
+    pixels,
+    nextPageToken,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/index.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.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/platform",
-  "version": "0.32.0",
+  "version": "0.33.0",
   "description": "OpenAPI client for @teemill/platform",
   "author": "OpenAPI-Generator Contributors",
   "repository": {