@utdk/figma 0.37.0-20260408.5-dev.646adf4
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/LICENSE +373 -0
- package/README.md +47 -0
- package/docs/activity-logs.md +46 -0
- package/docs/comment-reactions.md +114 -0
- package/docs/comments.md +114 -0
- package/docs/component-sets.md +114 -0
- package/docs/components.md +114 -0
- package/docs/dev-resources.md +148 -0
- package/docs/files.md +216 -0
- package/docs/library-analytics.md +216 -0
- package/docs/oembed.md +46 -0
- package/docs/payments.md +46 -0
- package/docs/projects.md +80 -0
- package/docs/styles.md +114 -0
- package/docs/users.md +45 -0
- package/docs/variables.md +114 -0
- package/docs/webhooks.md +250 -0
- package/index.ts +22 -0
- package/metadata.ts +917 -0
- package/openapi.json +13812 -0
- package/package.json +34 -0
- package/types.ts +284 -0
package/docs/comments.md
ADDED
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# Comments
|
|
2
|
+
|
|
3
|
+
Use these operations through the generated client (not direct HTTP calls).
|
|
4
|
+
|
|
5
|
+
Import path: `@utdk/figma`
|
|
6
|
+
|
|
7
|
+
## Operations
|
|
8
|
+
|
|
9
|
+
### `figma.getComments`
|
|
10
|
+
|
|
11
|
+
- **HTTP**: `GET /v1/files/{file_key}/comments`
|
|
12
|
+
- **What it does**: Get comments in a file
|
|
13
|
+
- **OpenAPI operationId**: `getComments`
|
|
14
|
+
- **Path params**: `file_key`
|
|
15
|
+
- **Query params**: `as_md`
|
|
16
|
+
- **Response codes**: `200`, `403`, `404`, `429`, `500`
|
|
17
|
+
- **Transport options**: None
|
|
18
|
+
- **Source**: [OpenAPI reference](https://www.figma.com/developers/api)
|
|
19
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
20
|
+
|
|
21
|
+
**Inputs**
|
|
22
|
+
|
|
23
|
+
- Client input type: `{ file_key: string; as_md?: boolean }`
|
|
24
|
+
- Client transport options: None
|
|
25
|
+
|
|
26
|
+
**Outputs**
|
|
27
|
+
|
|
28
|
+
- Client return type: `{ comments: ({ id: string; client_meta: { x: number; y: number } | { node_id: string; node_offset: { x: number; y: number } } | { x: number; y: number; region_height: number; region_width: number; comment_pin_corner?: "...`
|
|
29
|
+
- OpenAPI response codes: `200`, `403`, `404`, `429`, `500`
|
|
30
|
+
|
|
31
|
+
```ts
|
|
32
|
+
import figma from "@utdk/figma";
|
|
33
|
+
|
|
34
|
+
type GetCommentsInput = Parameters<typeof figma.getComments> extends [infer T, ...unknown[]] ? T : undefined;
|
|
35
|
+
type GetCommentsOutput = Awaited<ReturnType<typeof figma.getComments>>;
|
|
36
|
+
|
|
37
|
+
const input: GetCommentsInput = {} as { file_key: string; as_md?: boolean };
|
|
38
|
+
const result: GetCommentsOutput = await figma.getComments(input);
|
|
39
|
+
|
|
40
|
+
// Result shape (from schema): { comments: ({ id: string; client_meta: { x: number; y: number } | { node_id: string; node_offset: { x: number; y: number } } | { x: number; y: number; region_height: number; region_width: number; comment_pin_corner?: "...
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### `figma.postComment`
|
|
44
|
+
|
|
45
|
+
- **HTTP**: `POST /v1/files/{file_key}/comments`
|
|
46
|
+
- **What it does**: Add a comment to a file
|
|
47
|
+
- **OpenAPI operationId**: `postComment`
|
|
48
|
+
- **Path params**: `file_key`
|
|
49
|
+
- **Query params**: None
|
|
50
|
+
- **Response codes**: `200`, `400`, `403`, `404`, `429`, `500`
|
|
51
|
+
- **Transport options**: None
|
|
52
|
+
- **Source**: [OpenAPI reference](https://www.figma.com/developers/api)
|
|
53
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
54
|
+
|
|
55
|
+
**Inputs**
|
|
56
|
+
|
|
57
|
+
- Client input type: `{ message: string; comment_id?: string; client_meta?: { x: number; y: number } | { node_id: string; node_offset: { x: number; y: number } } | { x: number; y: number; region_height: number; region_width: number; comment_pin_corner?: "top-left" | "top-right" | "bottom-left" | "bottom-right" } | { node_id: string; node_offset: { x: number; y: number }; region_height: number; region_width: number; comment_pin_corner?: "top-left" | "top-right" | "bottom-left" | "bottom-right" }; file_key: string }`
|
|
58
|
+
- Client transport options: None
|
|
59
|
+
|
|
60
|
+
**Outputs**
|
|
61
|
+
|
|
62
|
+
- Client return type: `{ id: string; client_meta: { x: number; y: number } | { node_id: string; node_offset: { x: number; y: number } } | { x: number; y: number; region_height: number; region_width: number; comment_pin_corner?: "top-left" | "...`
|
|
63
|
+
- OpenAPI response codes: `200`, `400`, `403`, `404`, `429`, `500`
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
import figma from "@utdk/figma";
|
|
67
|
+
|
|
68
|
+
type PostCommentInput = Parameters<typeof figma.postComment> extends [infer T, ...unknown[]] ? T : undefined;
|
|
69
|
+
type PostCommentOutput = Awaited<ReturnType<typeof figma.postComment>>;
|
|
70
|
+
|
|
71
|
+
const input: PostCommentInput = {} as { message: string; comment_id?: string; client_meta?: { x: number; y: number } | { node_id: string; node_offset: { x: number; y: number } } | { x: number; y: number; region_height: number; region_width: number; comment_pin_corner?: "top-left" | "top-right" | "bottom-left" | "bottom-right" } | { node_id: string; node_offset: { x: number; y: number }; region_height: number; region_width: number; comment_pin_corner?: "top-left" | "top-right" | "bottom-left" | "bottom-right" }; file_key: string };
|
|
72
|
+
const result: PostCommentOutput = await figma.postComment(input);
|
|
73
|
+
|
|
74
|
+
// Result shape (from schema): { id: string; client_meta: { x: number; y: number } | { node_id: string; node_offset: { x: number; y: number } } | { x: number; y: number; region_height: number; region_width: number; comment_pin_corner?: "top-left" | "...
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### `figma.deleteComment`
|
|
78
|
+
|
|
79
|
+
- **HTTP**: `DELETE /v1/files/{file_key}/comments/{comment_id}`
|
|
80
|
+
- **What it does**: Delete a comment
|
|
81
|
+
- **OpenAPI operationId**: `deleteComment`
|
|
82
|
+
- **Path params**: `file_key`, `comment_id`
|
|
83
|
+
- **Query params**: None
|
|
84
|
+
- **Response codes**: `200`, `403`, `404`, `429`, `500`
|
|
85
|
+
- **Transport options**: None
|
|
86
|
+
- **Source**: [OpenAPI reference](https://www.figma.com/developers/api)
|
|
87
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
88
|
+
|
|
89
|
+
**Inputs**
|
|
90
|
+
|
|
91
|
+
- Client input type: `{ file_key: string; comment_id: string }`
|
|
92
|
+
- Client transport options: None
|
|
93
|
+
|
|
94
|
+
**Outputs**
|
|
95
|
+
|
|
96
|
+
- Client return type: `{ status: 200; error: false }`
|
|
97
|
+
- OpenAPI response codes: `200`, `403`, `404`, `429`, `500`
|
|
98
|
+
|
|
99
|
+
```ts
|
|
100
|
+
import figma from "@utdk/figma";
|
|
101
|
+
|
|
102
|
+
type DeleteCommentInput = Parameters<typeof figma.deleteComment> extends [infer T, ...unknown[]] ? T : undefined;
|
|
103
|
+
type DeleteCommentOutput = Awaited<ReturnType<typeof figma.deleteComment>>;
|
|
104
|
+
|
|
105
|
+
const input: DeleteCommentInput = {} as { file_key: string; comment_id: string };
|
|
106
|
+
const result: DeleteCommentOutput = await figma.deleteComment(input);
|
|
107
|
+
|
|
108
|
+
// Result shape (from schema): { status: 200; error: false }
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
<!-- prompt-hash:
|
|
113
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
114
|
+
-->
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# Component Sets
|
|
2
|
+
|
|
3
|
+
Use these operations through the generated client (not direct HTTP calls).
|
|
4
|
+
|
|
5
|
+
Import path: `@utdk/figma`
|
|
6
|
+
|
|
7
|
+
## Operations
|
|
8
|
+
|
|
9
|
+
### `figma.getComponentSet`
|
|
10
|
+
|
|
11
|
+
- **HTTP**: `GET /v1/component_sets/{key}`
|
|
12
|
+
- **What it does**: Get component set
|
|
13
|
+
- **OpenAPI operationId**: `getComponentSet`
|
|
14
|
+
- **Path params**: `key`
|
|
15
|
+
- **Query params**: None
|
|
16
|
+
- **Response codes**: `200`, `400`, `403`, `404`, `429`, `500`
|
|
17
|
+
- **Transport options**: None
|
|
18
|
+
- **Source**: [OpenAPI reference](https://www.figma.com/developers/api)
|
|
19
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
20
|
+
|
|
21
|
+
**Inputs**
|
|
22
|
+
|
|
23
|
+
- Client input type: `{ key: string }`
|
|
24
|
+
- Client transport options: None
|
|
25
|
+
|
|
26
|
+
**Outputs**
|
|
27
|
+
|
|
28
|
+
- Client return type: `{ status: 200; error: false; meta: { key: string; file_key: string; node_id: string; thumbnail_url?: string; name: string; description: string; created_at: string; updated_at: string; user: { id: string; handle: string;...`
|
|
29
|
+
- OpenAPI response codes: `200`, `400`, `403`, `404`, `429`, `500`
|
|
30
|
+
|
|
31
|
+
```ts
|
|
32
|
+
import figma from "@utdk/figma";
|
|
33
|
+
|
|
34
|
+
type GetComponentSetInput = Parameters<typeof figma.getComponentSet> extends [infer T, ...unknown[]] ? T : undefined;
|
|
35
|
+
type GetComponentSetOutput = Awaited<ReturnType<typeof figma.getComponentSet>>;
|
|
36
|
+
|
|
37
|
+
const input: GetComponentSetInput = {} as { key: string };
|
|
38
|
+
const result: GetComponentSetOutput = await figma.getComponentSet(input);
|
|
39
|
+
|
|
40
|
+
// Result shape (from schema): { status: 200; error: false; meta: { key: string; file_key: string; node_id: string; thumbnail_url?: string; name: string; description: string; created_at: string; updated_at: string; user: { id: string; handle: string;...
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### `figma.getFileComponentSets`
|
|
44
|
+
|
|
45
|
+
- **HTTP**: `GET /v1/files/{file_key}/component_sets`
|
|
46
|
+
- **What it does**: Get file component sets
|
|
47
|
+
- **OpenAPI operationId**: `getFileComponentSets`
|
|
48
|
+
- **Path params**: `file_key`
|
|
49
|
+
- **Query params**: None
|
|
50
|
+
- **Response codes**: `200`, `400`, `403`, `404`, `429`, `500`
|
|
51
|
+
- **Transport options**: None
|
|
52
|
+
- **Source**: [OpenAPI reference](https://www.figma.com/developers/api)
|
|
53
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
54
|
+
|
|
55
|
+
**Inputs**
|
|
56
|
+
|
|
57
|
+
- Client input type: `{ file_key: string }`
|
|
58
|
+
- Client transport options: None
|
|
59
|
+
|
|
60
|
+
**Outputs**
|
|
61
|
+
|
|
62
|
+
- Client return type: `{ status: 200; error: false; meta: { component_sets: ({ key: string; file_key: string; node_id: string; thumbnail_url?: string; name: string; description: string; created_at: string; updated_at: string; user: { id: stri...`
|
|
63
|
+
- OpenAPI response codes: `200`, `400`, `403`, `404`, `429`, `500`
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
import figma from "@utdk/figma";
|
|
67
|
+
|
|
68
|
+
type GetFileComponentSetsInput = Parameters<typeof figma.getFileComponentSets> extends [infer T, ...unknown[]] ? T : undefined;
|
|
69
|
+
type GetFileComponentSetsOutput = Awaited<ReturnType<typeof figma.getFileComponentSets>>;
|
|
70
|
+
|
|
71
|
+
const input: GetFileComponentSetsInput = {} as { file_key: string };
|
|
72
|
+
const result: GetFileComponentSetsOutput = await figma.getFileComponentSets(input);
|
|
73
|
+
|
|
74
|
+
// Result shape (from schema): { status: 200; error: false; meta: { component_sets: ({ key: string; file_key: string; node_id: string; thumbnail_url?: string; name: string; description: string; created_at: string; updated_at: string; user: { id: stri...
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### `figma.getTeamComponentSets`
|
|
78
|
+
|
|
79
|
+
- **HTTP**: `GET /v1/teams/{team_id}/component_sets`
|
|
80
|
+
- **What it does**: Get team component sets
|
|
81
|
+
- **OpenAPI operationId**: `getTeamComponentSets`
|
|
82
|
+
- **Path params**: `team_id`
|
|
83
|
+
- **Query params**: `page_size`, `after`, `before`
|
|
84
|
+
- **Response codes**: `200`, `400`, `403`, `404`, `429`, `500`
|
|
85
|
+
- **Transport options**: None
|
|
86
|
+
- **Source**: [OpenAPI reference](https://www.figma.com/developers/api)
|
|
87
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
88
|
+
|
|
89
|
+
**Inputs**
|
|
90
|
+
|
|
91
|
+
- Client input type: `{ team_id: string; page_size?: number; after?: number; before?: number }`
|
|
92
|
+
- Client transport options: None
|
|
93
|
+
|
|
94
|
+
**Outputs**
|
|
95
|
+
|
|
96
|
+
- Client return type: `{ status: 200; error: false; meta: { component_sets: ({ key: string; file_key: string; node_id: string; thumbnail_url?: string; name: string; description: string; created_at: string; updated_at: string; user: { id: stri...`
|
|
97
|
+
- OpenAPI response codes: `200`, `400`, `403`, `404`, `429`, `500`
|
|
98
|
+
|
|
99
|
+
```ts
|
|
100
|
+
import figma from "@utdk/figma";
|
|
101
|
+
|
|
102
|
+
type GetTeamComponentSetsInput = Parameters<typeof figma.getTeamComponentSets> extends [infer T, ...unknown[]] ? T : undefined;
|
|
103
|
+
type GetTeamComponentSetsOutput = Awaited<ReturnType<typeof figma.getTeamComponentSets>>;
|
|
104
|
+
|
|
105
|
+
const input: GetTeamComponentSetsInput = {} as { team_id: string; page_size?: number; after?: number; before?: number };
|
|
106
|
+
const result: GetTeamComponentSetsOutput = await figma.getTeamComponentSets(input);
|
|
107
|
+
|
|
108
|
+
// Result shape (from schema): { status: 200; error: false; meta: { component_sets: ({ key: string; file_key: string; node_id: string; thumbnail_url?: string; name: string; description: string; created_at: string; updated_at: string; user: { id: stri...
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
<!-- prompt-hash:
|
|
113
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
114
|
+
-->
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# Components
|
|
2
|
+
|
|
3
|
+
Use these operations through the generated client (not direct HTTP calls).
|
|
4
|
+
|
|
5
|
+
Import path: `@utdk/figma`
|
|
6
|
+
|
|
7
|
+
## Operations
|
|
8
|
+
|
|
9
|
+
### `figma.getComponent`
|
|
10
|
+
|
|
11
|
+
- **HTTP**: `GET /v1/components/{key}`
|
|
12
|
+
- **What it does**: Get component
|
|
13
|
+
- **OpenAPI operationId**: `getComponent`
|
|
14
|
+
- **Path params**: `key`
|
|
15
|
+
- **Query params**: None
|
|
16
|
+
- **Response codes**: `200`, `400`, `403`, `404`, `429`, `500`
|
|
17
|
+
- **Transport options**: None
|
|
18
|
+
- **Source**: [OpenAPI reference](https://www.figma.com/developers/api)
|
|
19
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
20
|
+
|
|
21
|
+
**Inputs**
|
|
22
|
+
|
|
23
|
+
- Client input type: `{ key: string }`
|
|
24
|
+
- Client transport options: None
|
|
25
|
+
|
|
26
|
+
**Outputs**
|
|
27
|
+
|
|
28
|
+
- Client return type: `{ status: 200; error: false; meta: { key: string; file_key: string; node_id: string; thumbnail_url?: string; name: string; description: string; created_at: string; updated_at: string; user: { id: string; handle: string;...`
|
|
29
|
+
- OpenAPI response codes: `200`, `400`, `403`, `404`, `429`, `500`
|
|
30
|
+
|
|
31
|
+
```ts
|
|
32
|
+
import figma from "@utdk/figma";
|
|
33
|
+
|
|
34
|
+
type GetComponentInput = Parameters<typeof figma.getComponent> extends [infer T, ...unknown[]] ? T : undefined;
|
|
35
|
+
type GetComponentOutput = Awaited<ReturnType<typeof figma.getComponent>>;
|
|
36
|
+
|
|
37
|
+
const input: GetComponentInput = {} as { key: string };
|
|
38
|
+
const result: GetComponentOutput = await figma.getComponent(input);
|
|
39
|
+
|
|
40
|
+
// Result shape (from schema): { status: 200; error: false; meta: { key: string; file_key: string; node_id: string; thumbnail_url?: string; name: string; description: string; created_at: string; updated_at: string; user: { id: string; handle: string;...
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### `figma.getFileComponents`
|
|
44
|
+
|
|
45
|
+
- **HTTP**: `GET /v1/files/{file_key}/components`
|
|
46
|
+
- **What it does**: Get file components
|
|
47
|
+
- **OpenAPI operationId**: `getFileComponents`
|
|
48
|
+
- **Path params**: `file_key`
|
|
49
|
+
- **Query params**: None
|
|
50
|
+
- **Response codes**: `200`, `400`, `403`, `404`, `429`, `500`
|
|
51
|
+
- **Transport options**: None
|
|
52
|
+
- **Source**: [OpenAPI reference](https://www.figma.com/developers/api)
|
|
53
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
54
|
+
|
|
55
|
+
**Inputs**
|
|
56
|
+
|
|
57
|
+
- Client input type: `{ file_key: string }`
|
|
58
|
+
- Client transport options: None
|
|
59
|
+
|
|
60
|
+
**Outputs**
|
|
61
|
+
|
|
62
|
+
- Client return type: `{ status: 200; error: false; meta: { components: ({ key: string; file_key: string; node_id: string; thumbnail_url?: string; name: string; description: string; created_at: string; updated_at: string; user: { id: string; ...`
|
|
63
|
+
- OpenAPI response codes: `200`, `400`, `403`, `404`, `429`, `500`
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
import figma from "@utdk/figma";
|
|
67
|
+
|
|
68
|
+
type GetFileComponentsInput = Parameters<typeof figma.getFileComponents> extends [infer T, ...unknown[]] ? T : undefined;
|
|
69
|
+
type GetFileComponentsOutput = Awaited<ReturnType<typeof figma.getFileComponents>>;
|
|
70
|
+
|
|
71
|
+
const input: GetFileComponentsInput = {} as { file_key: string };
|
|
72
|
+
const result: GetFileComponentsOutput = await figma.getFileComponents(input);
|
|
73
|
+
|
|
74
|
+
// Result shape (from schema): { status: 200; error: false; meta: { components: ({ key: string; file_key: string; node_id: string; thumbnail_url?: string; name: string; description: string; created_at: string; updated_at: string; user: { id: string; ...
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### `figma.getTeamComponents`
|
|
78
|
+
|
|
79
|
+
- **HTTP**: `GET /v1/teams/{team_id}/components`
|
|
80
|
+
- **What it does**: Get team components
|
|
81
|
+
- **OpenAPI operationId**: `getTeamComponents`
|
|
82
|
+
- **Path params**: `team_id`
|
|
83
|
+
- **Query params**: `page_size`, `after`, `before`
|
|
84
|
+
- **Response codes**: `200`, `400`, `403`, `404`, `429`, `500`
|
|
85
|
+
- **Transport options**: None
|
|
86
|
+
- **Source**: [OpenAPI reference](https://www.figma.com/developers/api)
|
|
87
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
88
|
+
|
|
89
|
+
**Inputs**
|
|
90
|
+
|
|
91
|
+
- Client input type: `{ team_id: string; page_size?: number; after?: number; before?: number }`
|
|
92
|
+
- Client transport options: None
|
|
93
|
+
|
|
94
|
+
**Outputs**
|
|
95
|
+
|
|
96
|
+
- Client return type: `{ status: 200; error: false; meta: { components: ({ key: string; file_key: string; node_id: string; thumbnail_url?: string; name: string; description: string; created_at: string; updated_at: string; user: { id: string; ...`
|
|
97
|
+
- OpenAPI response codes: `200`, `400`, `403`, `404`, `429`, `500`
|
|
98
|
+
|
|
99
|
+
```ts
|
|
100
|
+
import figma from "@utdk/figma";
|
|
101
|
+
|
|
102
|
+
type GetTeamComponentsInput = Parameters<typeof figma.getTeamComponents> extends [infer T, ...unknown[]] ? T : undefined;
|
|
103
|
+
type GetTeamComponentsOutput = Awaited<ReturnType<typeof figma.getTeamComponents>>;
|
|
104
|
+
|
|
105
|
+
const input: GetTeamComponentsInput = {} as { team_id: string; page_size?: number; after?: number; before?: number };
|
|
106
|
+
const result: GetTeamComponentsOutput = await figma.getTeamComponents(input);
|
|
107
|
+
|
|
108
|
+
// Result shape (from schema): { status: 200; error: false; meta: { components: ({ key: string; file_key: string; node_id: string; thumbnail_url?: string; name: string; description: string; created_at: string; updated_at: string; user: { id: string; ...
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
<!-- prompt-hash:
|
|
113
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
114
|
+
-->
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
# Dev Resources
|
|
2
|
+
|
|
3
|
+
Use these operations through the generated client (not direct HTTP calls).
|
|
4
|
+
|
|
5
|
+
Import path: `@utdk/figma`
|
|
6
|
+
|
|
7
|
+
## Operations
|
|
8
|
+
|
|
9
|
+
### `figma.postDevResources`
|
|
10
|
+
|
|
11
|
+
- **HTTP**: `POST /v1/dev_resources`
|
|
12
|
+
- **What it does**: Create dev resources
|
|
13
|
+
- **OpenAPI operationId**: `postDevResources`
|
|
14
|
+
- **Path params**: None
|
|
15
|
+
- **Query params**: None
|
|
16
|
+
- **Response codes**: `200`, `400`, `401`, `403`, `429`, `500`
|
|
17
|
+
- **Transport options**: None
|
|
18
|
+
- **Source**: [OpenAPI reference](https://www.figma.com/developers/api)
|
|
19
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
20
|
+
|
|
21
|
+
**Inputs**
|
|
22
|
+
|
|
23
|
+
- Client input type: `{ dev_resources: ({ name: string; url: string; file_key: string; node_id: string })[] }`
|
|
24
|
+
- Client transport options: None
|
|
25
|
+
|
|
26
|
+
**Outputs**
|
|
27
|
+
|
|
28
|
+
- Client return type: `{ links_created: ({ id: string; name: string; url: string; file_key: string; node_id: string })[]; errors?: ({ file_key?: string | null; node_id?: string | null; error: string })[] }`
|
|
29
|
+
- OpenAPI response codes: `200`, `400`, `401`, `403`, `429`, `500`
|
|
30
|
+
|
|
31
|
+
```ts
|
|
32
|
+
import figma from "@utdk/figma";
|
|
33
|
+
|
|
34
|
+
type PostDevResourcesInput = Parameters<typeof figma.postDevResources> extends [infer T, ...unknown[]] ? T : undefined;
|
|
35
|
+
type PostDevResourcesOutput = Awaited<ReturnType<typeof figma.postDevResources>>;
|
|
36
|
+
|
|
37
|
+
const input: PostDevResourcesInput = {} as { dev_resources: ({ name: string; url: string; file_key: string; node_id: string })[] };
|
|
38
|
+
const result: PostDevResourcesOutput = await figma.postDevResources(input);
|
|
39
|
+
|
|
40
|
+
// Result shape (from schema): { links_created: ({ id: string; name: string; url: string; file_key: string; node_id: string })[]; errors?: ({ file_key?: string | null; node_id?: string | null; error: string })[] }
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### `figma.putDevResources`
|
|
44
|
+
|
|
45
|
+
- **HTTP**: `PUT /v1/dev_resources`
|
|
46
|
+
- **What it does**: Update dev resources
|
|
47
|
+
- **OpenAPI operationId**: `putDevResources`
|
|
48
|
+
- **Path params**: None
|
|
49
|
+
- **Query params**: None
|
|
50
|
+
- **Response codes**: `200`, `400`, `401`, `403`, `429`, `500`
|
|
51
|
+
- **Transport options**: None
|
|
52
|
+
- **Source**: [OpenAPI reference](https://www.figma.com/developers/api)
|
|
53
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
54
|
+
|
|
55
|
+
**Inputs**
|
|
56
|
+
|
|
57
|
+
- Client input type: `{ dev_resources: ({ id: string; name?: string; url?: string })[] }`
|
|
58
|
+
- Client transport options: None
|
|
59
|
+
|
|
60
|
+
**Outputs**
|
|
61
|
+
|
|
62
|
+
- Client return type: `{ links_updated?: ({ id: string; name: string; url: string; file_key: string; node_id: string })[]; errors?: ({ id?: string; error: string })[] }`
|
|
63
|
+
- OpenAPI response codes: `200`, `400`, `401`, `403`, `429`, `500`
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
import figma from "@utdk/figma";
|
|
67
|
+
|
|
68
|
+
type PutDevResourcesInput = Parameters<typeof figma.putDevResources> extends [infer T, ...unknown[]] ? T : undefined;
|
|
69
|
+
type PutDevResourcesOutput = Awaited<ReturnType<typeof figma.putDevResources>>;
|
|
70
|
+
|
|
71
|
+
const input: PutDevResourcesInput = {} as { dev_resources: ({ id: string; name?: string; url?: string })[] };
|
|
72
|
+
const result: PutDevResourcesOutput = await figma.putDevResources(input);
|
|
73
|
+
|
|
74
|
+
// Result shape (from schema): { links_updated?: ({ id: string; name: string; url: string; file_key: string; node_id: string })[]; errors?: ({ id?: string; error: string })[] }
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### `figma.getDevResources`
|
|
78
|
+
|
|
79
|
+
- **HTTP**: `GET /v1/files/{file_key}/dev_resources`
|
|
80
|
+
- **What it does**: Get dev resources
|
|
81
|
+
- **OpenAPI operationId**: `getDevResources`
|
|
82
|
+
- **Path params**: `file_key`
|
|
83
|
+
- **Query params**: `node_ids`
|
|
84
|
+
- **Response codes**: `200`, `400`, `401`, `403`, `404`, `429`, `500`
|
|
85
|
+
- **Transport options**: None
|
|
86
|
+
- **Source**: [OpenAPI reference](https://www.figma.com/developers/api)
|
|
87
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
88
|
+
|
|
89
|
+
**Inputs**
|
|
90
|
+
|
|
91
|
+
- Client input type: `{ file_key: string; node_ids?: string }`
|
|
92
|
+
- Client transport options: None
|
|
93
|
+
|
|
94
|
+
**Outputs**
|
|
95
|
+
|
|
96
|
+
- Client return type: `{ dev_resources: ({ id: string; name: string; url: string; file_key: string; node_id: string })[] }`
|
|
97
|
+
- OpenAPI response codes: `200`, `400`, `401`, `403`, `404`, `429`, `500`
|
|
98
|
+
|
|
99
|
+
```ts
|
|
100
|
+
import figma from "@utdk/figma";
|
|
101
|
+
|
|
102
|
+
type GetDevResourcesInput = Parameters<typeof figma.getDevResources> extends [infer T, ...unknown[]] ? T : undefined;
|
|
103
|
+
type GetDevResourcesOutput = Awaited<ReturnType<typeof figma.getDevResources>>;
|
|
104
|
+
|
|
105
|
+
const input: GetDevResourcesInput = {} as { file_key: string; node_ids?: string };
|
|
106
|
+
const result: GetDevResourcesOutput = await figma.getDevResources(input);
|
|
107
|
+
|
|
108
|
+
// Result shape (from schema): { dev_resources: ({ id: string; name: string; url: string; file_key: string; node_id: string })[] }
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### `figma.deleteDevResource`
|
|
112
|
+
|
|
113
|
+
- **HTTP**: `DELETE /v1/files/{file_key}/dev_resources/{dev_resource_id}`
|
|
114
|
+
- **What it does**: Delete dev resource
|
|
115
|
+
- **OpenAPI operationId**: `deleteDevResource`
|
|
116
|
+
- **Path params**: `file_key`, `dev_resource_id`
|
|
117
|
+
- **Query params**: None
|
|
118
|
+
- **Response codes**: `200`, `401`, `403`, `404`, `429`, `500`
|
|
119
|
+
- **Transport options**: None
|
|
120
|
+
- **Source**: [OpenAPI reference](https://www.figma.com/developers/api)
|
|
121
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
122
|
+
|
|
123
|
+
**Inputs**
|
|
124
|
+
|
|
125
|
+
- Client input type: `{ file_key: string; dev_resource_id: string }`
|
|
126
|
+
- Client transport options: None
|
|
127
|
+
|
|
128
|
+
**Outputs**
|
|
129
|
+
|
|
130
|
+
- Client return type: `unknown`
|
|
131
|
+
- OpenAPI response codes: `200`, `401`, `403`, `404`, `429`, `500`
|
|
132
|
+
|
|
133
|
+
```ts
|
|
134
|
+
import figma from "@utdk/figma";
|
|
135
|
+
|
|
136
|
+
type DeleteDevResourceInput = Parameters<typeof figma.deleteDevResource> extends [infer T, ...unknown[]] ? T : undefined;
|
|
137
|
+
type DeleteDevResourceOutput = Awaited<ReturnType<typeof figma.deleteDevResource>>;
|
|
138
|
+
|
|
139
|
+
const input: DeleteDevResourceInput = {} as { file_key: string; dev_resource_id: string };
|
|
140
|
+
const result: DeleteDevResourceOutput = await figma.deleteDevResource(input);
|
|
141
|
+
|
|
142
|
+
// Result shape (from schema): unknown
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
<!-- prompt-hash:
|
|
147
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
148
|
+
-->
|