@teemill/projects 1.37.0 → 1.38.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +115 -2
- package/api.ts +25 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +25 -1
- package/dist/api.js +1 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +25 -1
- package/dist/esm/api.js +1 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/ApiError.md +22 -0
- package/docs/Auth.md +24 -0
- package/docs/AuthResponse.md +20 -0
- package/docs/Bookmark.md +36 -0
- package/docs/BookmarkData.md +22 -0
- package/docs/BookmarkRoute.md +20 -0
- package/docs/BookmarkRouteRoute.md +24 -0
- package/docs/BookmarkTab.md +24 -0
- package/docs/BookmarkTabs.md +20 -0
- package/docs/BookmarkUrl.md +20 -0
- package/docs/Bookmarks.md +20 -0
- package/docs/CreateBookmarkRequest.md +30 -0
- package/docs/CreateInviteRequest.md +22 -0
- package/docs/CreateProjectRequest.md +26 -0
- package/docs/CreateTaskRequest.md +22 -0
- package/docs/ExportTasks202Response.md +20 -0
- package/docs/Icon.md +24 -0
- package/docs/InstallTemplateRequest.md +20 -0
- package/docs/Integration.md +26 -0
- package/docs/IntegrationsResponse.md +20 -0
- package/docs/LegacyProjectLogo.md +22 -0
- package/docs/ListTasksResponse.md +20 -0
- package/docs/NullableIcon.md +24 -0
- package/docs/Project.md +36 -0
- package/docs/ProjectCurrency.md +22 -0
- package/docs/ProjectInvite.md +30 -0
- package/docs/ProjectInvites.md +22 -0
- package/docs/ProjectLogo.md +22 -0
- package/docs/ProjectManager.md +24 -0
- package/docs/ProjectPlatform.md +22 -0
- package/docs/ProjectUser.md +34 -0
- package/docs/ProjectUserAvatar.md +20 -0
- package/docs/ProjectUsers.md +22 -0
- package/docs/ProjectsApi.md +2023 -0
- package/docs/ProjectsResponse.md +20 -0
- package/docs/Task.md +40 -0
- package/docs/TaskStatus.md +14 -0
- package/docs/TaskSummary.md +34 -0
- package/docs/Template.md +28 -0
- package/docs/TemplateCode.md +16 -0
- package/docs/TemplatesResponse.md +20 -0
- package/docs/UpdateBookmarkRequest.md +34 -0
- package/docs/UpdateBookmarkTabsRequest.md +20 -0
- package/docs/UpdateBookmarkTabsRequestTabsInner.md +24 -0
- package/docs/UpdateIntegrationRequest.md +20 -0
- package/docs/UpdateProjectRequest.md +22 -0
- package/docs/UpdateTaskRequest.md +32 -0
- package/index.ts +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ProjectsResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**projects** | [**Array<Project>**](Project.md) | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { ProjectsResponse } from '@teemill/projects';
|
|
14
|
+
|
|
15
|
+
const instance: ProjectsResponse = {
|
|
16
|
+
projects,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[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/Task.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Task
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**content** | **string** | | [default to undefined]
|
|
10
|
+
**status** | [**TaskStatus**](TaskStatus.md) | | [default to undefined]
|
|
11
|
+
**sortOrder** | **number** | The position of the task in its status group | [default to undefined]
|
|
12
|
+
**chatChannel** | **string** | The code of the chat channel associated with the task | [default to undefined]
|
|
13
|
+
**owner** | **string** | The unique id of the user who owns the task | [default to undefined]
|
|
14
|
+
**notificationRecipients** | **Array<string>** | The unique ids of the users who will receive notifications for the task | [default to undefined]
|
|
15
|
+
**estimatedHours** | **number** | The estimated hours to complete the task | [default to undefined]
|
|
16
|
+
**workProgress** | **number** | The completion percentage of the task | [default to undefined]
|
|
17
|
+
**createdUser** | **string** | The unique id of the user who created the task | [default to undefined]
|
|
18
|
+
**createdAt** | **string** | | [default to undefined]
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { Task } from '@teemill/projects';
|
|
24
|
+
|
|
25
|
+
const instance: Task = {
|
|
26
|
+
id,
|
|
27
|
+
content,
|
|
28
|
+
status,
|
|
29
|
+
sortOrder,
|
|
30
|
+
chatChannel,
|
|
31
|
+
owner,
|
|
32
|
+
notificationRecipients,
|
|
33
|
+
estimatedHours,
|
|
34
|
+
workProgress,
|
|
35
|
+
createdUser,
|
|
36
|
+
createdAt,
|
|
37
|
+
};
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# TaskStatus
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Nice` (value: `'nice'`)
|
|
7
|
+
|
|
8
|
+
* `Need` (value: `'need'`)
|
|
9
|
+
|
|
10
|
+
* `Doing` (value: `'doing'`)
|
|
11
|
+
|
|
12
|
+
* `Done` (value: `'done'`)
|
|
13
|
+
|
|
14
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# TaskSummary
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**content** | **string** | | [default to undefined]
|
|
10
|
+
**status** | [**TaskStatus**](TaskStatus.md) | | [default to undefined]
|
|
11
|
+
**sortOrder** | **number** | The position of the task in its status group | [default to undefined]
|
|
12
|
+
**owner** | **string** | The unique id of the user who owns the task | [default to undefined]
|
|
13
|
+
**estimatedHours** | **number** | The estimated hours to complete the task | [default to undefined]
|
|
14
|
+
**workProgress** | **number** | The completion percentage of the task | [default to undefined]
|
|
15
|
+
**createdAt** | **string** | | [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { TaskSummary } from '@teemill/projects';
|
|
21
|
+
|
|
22
|
+
const instance: TaskSummary = {
|
|
23
|
+
id,
|
|
24
|
+
content,
|
|
25
|
+
status,
|
|
26
|
+
sortOrder,
|
|
27
|
+
owner,
|
|
28
|
+
estimatedHours,
|
|
29
|
+
workProgress,
|
|
30
|
+
createdAt,
|
|
31
|
+
};
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[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/Template.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Template
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | | [default to undefined]
|
|
9
|
+
**description** | **string** | | [default to undefined]
|
|
10
|
+
**code** | [**TemplateCode**](TemplateCode.md) | | [default to undefined]
|
|
11
|
+
**highlighted** | **boolean** | | [default to undefined]
|
|
12
|
+
**icon** | [**Icon**](Icon.md) | | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { Template } from '@teemill/projects';
|
|
18
|
+
|
|
19
|
+
const instance: Template = {
|
|
20
|
+
name,
|
|
21
|
+
description,
|
|
22
|
+
code,
|
|
23
|
+
highlighted,
|
|
24
|
+
icon,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# TemplateCode
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Shop` (value: `'shop'`)
|
|
7
|
+
|
|
8
|
+
* `ShopHeadless` (value: `'shop-headless'`)
|
|
9
|
+
|
|
10
|
+
* `ShopCommercial` (value: `'shop-commercial'`)
|
|
11
|
+
|
|
12
|
+
* `Factory` (value: `'factory'`)
|
|
13
|
+
|
|
14
|
+
* `Shopify` (value: `'shopify'`)
|
|
15
|
+
|
|
16
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TemplatesResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**templates** | [**Array<Template>**](Template.md) | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { TemplatesResponse } from '@teemill/projects';
|
|
14
|
+
|
|
15
|
+
const instance: TemplatesResponse = {
|
|
16
|
+
templates,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# UpdateBookmarkRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**title** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**data** | [**BookmarkData**](BookmarkData.md) | | [optional] [default to undefined]
|
|
10
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**color** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**icon** | **string** | The icon name of the bookmark | [optional] [default to undefined]
|
|
13
|
+
**tabId** | **string** | The ID of the tab the bookmark belongs to | [optional] [default to undefined]
|
|
14
|
+
**sortOrder** | **number** | The sort order of the bookmark in all tab | [optional] [default to undefined]
|
|
15
|
+
**tabSortOrder** | **number** | The sort order of the bookmark in the custom or favourite tab | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { UpdateBookmarkRequest } from '@teemill/projects';
|
|
21
|
+
|
|
22
|
+
const instance: UpdateBookmarkRequest = {
|
|
23
|
+
title,
|
|
24
|
+
data,
|
|
25
|
+
description,
|
|
26
|
+
color,
|
|
27
|
+
icon,
|
|
28
|
+
tabId,
|
|
29
|
+
sortOrder,
|
|
30
|
+
tabSortOrder,
|
|
31
|
+
};
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpdateBookmarkTabsRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**tabs** | [**Array<UpdateBookmarkTabsRequestTabsInner>**](UpdateBookmarkTabsRequestTabsInner.md) | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { UpdateBookmarkTabsRequest } from '@teemill/projects';
|
|
14
|
+
|
|
15
|
+
const instance: UpdateBookmarkTabsRequest = {
|
|
16
|
+
tabs,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UpdateBookmarkTabsRequestTabsInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**name** | **string** | | [default to undefined]
|
|
10
|
+
**sortOrder** | **number** | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { UpdateBookmarkTabsRequestTabsInner } from '@teemill/projects';
|
|
16
|
+
|
|
17
|
+
const instance: UpdateBookmarkTabsRequestTabsInner = {
|
|
18
|
+
id,
|
|
19
|
+
name,
|
|
20
|
+
sortOrder,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpdateIntegrationRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**config** | **object** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { UpdateIntegrationRequest } from '@teemill/projects';
|
|
14
|
+
|
|
15
|
+
const instance: UpdateIntegrationRequest = {
|
|
16
|
+
config,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UpdateProjectRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**logos** | [**Array<ProjectLogo>**](ProjectLogo.md) | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { UpdateProjectRequest } from '@teemill/projects';
|
|
15
|
+
|
|
16
|
+
const instance: UpdateProjectRequest = {
|
|
17
|
+
name,
|
|
18
|
+
logos,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# UpdateTaskRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**content** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**status** | [**TaskStatus**](TaskStatus.md) | | [optional] [default to undefined]
|
|
10
|
+
**sortOrder** | **number** | The position of the task in its status group | [optional] [default to undefined]
|
|
11
|
+
**owner** | **string** | The unique id of the user who owns the task | [optional] [default to undefined]
|
|
12
|
+
**notificationRecipients** | **Array<string>** | The unique ids of the users who will receive notifications for the task | [optional] [default to undefined]
|
|
13
|
+
**estimatedHours** | **number** | The estimated hours to complete the task | [optional] [default to undefined]
|
|
14
|
+
**workProgress** | **number** | The completion percentage of the task | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { UpdateTaskRequest } from '@teemill/projects';
|
|
20
|
+
|
|
21
|
+
const instance: UpdateTaskRequest = {
|
|
22
|
+
content,
|
|
23
|
+
status,
|
|
24
|
+
sortOrder,
|
|
25
|
+
owner,
|
|
26
|
+
notificationRecipients,
|
|
27
|
+
estimatedHours,
|
|
28
|
+
workProgress,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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
CHANGED