@teemill/projects 1.36.0 → 1.38.0

package/docs/Bookmark.md

@@ -0,0 +1,36 @@
+# Bookmark
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**title** | **string** |  | [default to undefined]
+**data** | [**BookmarkData**](BookmarkData.md) |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**color** | **string** |  | [default to undefined]
+**icon** | [**NullableIcon**](NullableIcon.md) |  | [default to undefined]
+**tabId** | **string** |  | [default to undefined]
+**sortOrder** | **number** |  | [default to undefined]
+**tabSortOrder** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Bookmark } from '@teemill/projects';
+
+const instance: Bookmark = {
+    id,
+    title,
+    data,
+    description,
+    color,
+    icon,
+    tabId,
+    sortOrder,
+    tabSortOrder,
+};
+```
+
+[[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/BookmarkData.md

@@ -0,0 +1,22 @@
+# BookmarkData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** |  | [default to undefined]
+**route** | [**BookmarkRouteRoute**](BookmarkRouteRoute.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BookmarkData } from '@teemill/projects';
+
+const instance: BookmarkData = {
+    url,
+    route,
+};
+```
+
+[[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/BookmarkRoute.md

@@ -0,0 +1,20 @@
+# BookmarkRoute
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**route** | [**BookmarkRouteRoute**](BookmarkRouteRoute.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BookmarkRoute } from '@teemill/projects';
+
+const instance: BookmarkRoute = {
+    route,
+};
+```
+
+[[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/BookmarkRouteRoute.md

@@ -0,0 +1,24 @@
+# BookmarkRouteRoute
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**params** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
+**query** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BookmarkRouteRoute } from '@teemill/projects';
+
+const instance: BookmarkRouteRoute = {
+    name,
+    params,
+    query,
+};
+```
+
+[[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/BookmarkTab.md

@@ -0,0 +1,24 @@
+# BookmarkTab
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**sortOrder** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BookmarkTab } from '@teemill/projects';
+
+const instance: BookmarkTab = {
+    id,
+    name,
+    sortOrder,
+};
+```
+
+[[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/BookmarkTabs.md

@@ -0,0 +1,20 @@
+# BookmarkTabs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tabs** | [**Array<BookmarkTab>**](BookmarkTab.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BookmarkTabs } from '@teemill/projects';
+
+const instance: BookmarkTabs = {
+    tabs,
+};
+```
+
+[[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/BookmarkUrl.md

@@ -0,0 +1,20 @@
+# BookmarkUrl
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BookmarkUrl } from '@teemill/projects';
+
+const instance: BookmarkUrl = {
+    url,
+};
+```
+
+[[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/Bookmarks.md

@@ -0,0 +1,20 @@
+# Bookmarks
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bookmarks** | [**Array<Bookmark>**](Bookmark.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Bookmarks } from '@teemill/projects';
+
+const instance: Bookmarks = {
+    bookmarks,
+};
+```
+
+[[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/CreateBookmarkRequest.md

@@ -0,0 +1,30 @@
+# CreateBookmarkRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** |  | [optional] [default to undefined]
+**data** | [**BookmarkData**](BookmarkData.md) |  | [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**color** | **string** |  | [optional] [default to undefined]
+**icon** | **string** | The icon name of the bookmark | [optional] [default to undefined]
+**tabId** | **string** | The ID of the tab the bookmark belongs to | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateBookmarkRequest } from '@teemill/projects';
+
+const instance: CreateBookmarkRequest = {
+    title,
+    data,
+    description,
+    color,
+    icon,
+    tabId,
+};
+```
+
+[[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/CreateInviteRequest.md

@@ -0,0 +1,22 @@
+# CreateInviteRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** |  | [default to undefined]
+**role** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateInviteRequest } from '@teemill/projects';
+
+const instance: CreateInviteRequest = {
+    email,
+    role,
+};
+```
+
+[[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/CreateProjectRequest.md

@@ -0,0 +1,26 @@
+# CreateProjectRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**template** | [**TemplateCode**](TemplateCode.md) |  | [optional] [default to undefined]
+**config** | **object** |  | [optional] [default to undefined]
+**platformId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateProjectRequest } from '@teemill/projects';
+
+const instance: CreateProjectRequest = {
+    name,
+    template,
+    config,
+    platformId,
+};
+```
+
+[[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/CreateTaskRequest.md

@@ -0,0 +1,22 @@
+# CreateTaskRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **string** |  | [default to undefined]
+**status** | [**TaskStatus**](TaskStatus.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateTaskRequest } from '@teemill/projects';
+
+const instance: CreateTaskRequest = {
+    content,
+    status,
+};
+```
+
+[[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/ExportTasks202Response.md

@@ -0,0 +1,20 @@
+# ExportTasks202Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message describing the export status | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ExportTasks202Response } from '@teemill/projects';
+
+const instance: ExportTasks202Response = {
+    message,
+};
+```
+
+[[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/Icon.md

@@ -0,0 +1,24 @@
+# Icon
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**prefix** | **string** |  | [default to undefined]
+**iconName** | **string** |  | [default to undefined]
+**icon** | **Array<any>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Icon } from '@teemill/projects';
+
+const instance: Icon = {
+    prefix,
+    iconName,
+    icon,
+};
+```
+
+[[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/InstallTemplateRequest.md

@@ -0,0 +1,20 @@
+# InstallTemplateRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**config** | **object** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InstallTemplateRequest } from '@teemill/projects';
+
+const instance: InstallTemplateRequest = {
+    config,
+};
+```
+
+[[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/Integration.md

@@ -0,0 +1,26 @@
+# Integration
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [readonly] [default to undefined]
+**code** | **string** |  | [default to undefined]
+**config** | **object** |  | [default to undefined]
+**setupAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Integration } from '@teemill/projects';
+
+const instance: Integration = {
+    id,
+    code,
+    config,
+    setupAt,
+};
+```
+
+[[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/IntegrationsResponse.md

@@ -0,0 +1,20 @@
+# IntegrationsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**integrations** | [**Array<Integration>**](Integration.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { IntegrationsResponse } from '@teemill/projects';
+
+const instance: IntegrationsResponse = {
+    integrations,
+};
+```
+
+[[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/LegacyProjectLogo.md

@@ -0,0 +1,22 @@
+# LegacyProjectLogo
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** |  | [default to undefined]
+**backgroundColor** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { LegacyProjectLogo } from '@teemill/projects';
+
+const instance: LegacyProjectLogo = {
+    url,
+    backgroundColor,
+};
+```
+
+[[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/ListTasksResponse.md

@@ -0,0 +1,20 @@
+# ListTasksResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tasks** | [**Array<TaskSummary>**](TaskSummary.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ListTasksResponse } from '@teemill/projects';
+
+const instance: ListTasksResponse = {
+    tasks,
+};
+```
+
+[[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/NullableIcon.md

@@ -0,0 +1,24 @@
+# NullableIcon
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**prefix** | **string** |  | [default to undefined]
+**iconName** | **string** |  | [default to undefined]
+**icon** | **Array<any>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { NullableIcon } from '@teemill/projects';
+
+const instance: NullableIcon = {
+    prefix,
+    iconName,
+    icon,
+};
+```
+
+[[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/Project.md

@@ -0,0 +1,36 @@
+# Project
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**logo** | [**LegacyProjectLogo**](LegacyProjectLogo.md) |  | [default to undefined]
+**logos** | [**Array<ProjectLogo>**](ProjectLogo.md) |  | [default to undefined]
+**manager** | [**ProjectManager**](ProjectManager.md) |  | [optional] [default to undefined]
+**platform** | [**ProjectPlatform**](ProjectPlatform.md) |  | [optional] [default to undefined]
+**integrations** | **Array<string>** |  | [optional] [default to undefined]
+**currency** | [**ProjectCurrency**](ProjectCurrency.md) |  | [optional] [default to undefined]
+**publicKey** | **string** | The public API key for the project which can be used to access basic information about the project such as the store url | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Project } from '@teemill/projects';
+
+const instance: Project = {
+    id,
+    name,
+    logo,
+    logos,
+    manager,
+    platform,
+    integrations,
+    currency,
+    publicKey,
+};
+```
+
+[[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/ProjectCurrency.md

@@ -0,0 +1,22 @@
+# ProjectCurrency
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [default to undefined]
+**symbol** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ProjectCurrency } from '@teemill/projects';
+
+const instance: ProjectCurrency = {
+    code,
+    symbol,
+};
+```
+
+[[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/ProjectInvite.md

@@ -0,0 +1,30 @@
+# ProjectInvite
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**inviteeEmail** | **string** |  | [default to undefined]
+**inviteeRole** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**expiresAt** | **string** |  | [default to undefined]
+**inviter** | [**ProjectUser**](ProjectUser.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ProjectInvite } from '@teemill/projects';
+
+const instance: ProjectInvite = {
+    id,
+    inviteeEmail,
+    inviteeRole,
+    createdAt,
+    expiresAt,
+    inviter,
+};
+```
+
+[[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/ProjectInvites.md

@@ -0,0 +1,22 @@
+# ProjectInvites
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**invites** | [**Array<ProjectInvite>**](ProjectInvite.md) |  | [default to undefined]
+**nextPageToken** | **number** | The token referencing the next page number | [default to undefined]
+
+## Example
+
+```typescript
+import { ProjectInvites } from '@teemill/projects';
+
+const instance: ProjectInvites = {
+    invites,
+    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/docs/ProjectLogo.md

@@ -0,0 +1,22 @@
+# ProjectLogo
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** |  | [default to undefined]
+**meta** | **{ [key: string]: string; }** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ProjectLogo } from '@teemill/projects';
+
+const instance: ProjectLogo = {
+    url,
+    meta,
+};
+```
+
+[[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/ProjectManager.md

@@ -0,0 +1,24 @@
+# ProjectManager
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**logos** | [**Array<ProjectLogo>**](ProjectLogo.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ProjectManager } from '@teemill/projects';
+
+const instance: ProjectManager = {
+    id,
+    name,
+    logos,
+};
+```
+
+[[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/ProjectPlatform.md

@@ -0,0 +1,22 @@
+# ProjectPlatform
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProjectPlatform } from '@teemill/projects';
+
+const instance: ProjectPlatform = {
+    id,
+    name,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)