@composio/client 0.1.0-alpha.10 → 0.1.0-alpha.12
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/CHANGELOG.md +36 -0
- package/README.md +7 -7
- package/client.d.mts +6 -6
- package/client.d.mts.map +1 -1
- package/client.d.ts +6 -6
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/auth-configs.d.mts +168 -29
- package/resources/auth-configs.d.mts.map +1 -1
- package/resources/auth-configs.d.ts +168 -29
- package/resources/auth-configs.d.ts.map +1 -1
- package/resources/auth-configs.js +50 -4
- package/resources/auth-configs.js.map +1 -1
- package/resources/auth-configs.mjs +50 -4
- package/resources/auth-configs.mjs.map +1 -1
- package/resources/connected-accounts.d.mts +80 -17
- package/resources/connected-accounts.d.mts.map +1 -1
- package/resources/connected-accounts.d.ts +80 -17
- package/resources/connected-accounts.d.ts.map +1 -1
- package/resources/connected-accounts.js +56 -4
- package/resources/connected-accounts.js.map +1 -1
- package/resources/connected-accounts.mjs +56 -4
- package/resources/connected-accounts.mjs.map +1 -1
- package/resources/files.d.mts +72 -23
- package/resources/files.d.mts.map +1 -1
- package/resources/files.d.ts +72 -23
- package/resources/files.d.ts.map +1 -1
- package/resources/files.js +20 -2
- package/resources/files.js.map +1 -1
- package/resources/files.mjs +20 -2
- package/resources/files.mjs.map +1 -1
- package/resources/index.d.mts +3 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +3 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/mcp/custom.d.mts +87 -0
- package/resources/mcp/custom.d.mts.map +1 -0
- package/resources/mcp/custom.d.ts +87 -0
- package/resources/mcp/custom.d.ts.map +1 -0
- package/resources/mcp/custom.js +26 -0
- package/resources/mcp/custom.js.map +1 -0
- package/resources/mcp/custom.mjs +22 -0
- package/resources/mcp/custom.mjs.map +1 -0
- package/resources/mcp/index.d.mts +2 -2
- package/resources/mcp/index.d.mts.map +1 -1
- package/resources/mcp/index.d.ts +2 -2
- package/resources/mcp/index.d.ts.map +1 -1
- package/resources/mcp/index.js +3 -3
- package/resources/mcp/index.js.map +1 -1
- package/resources/mcp/index.mjs +1 -1
- package/resources/mcp/index.mjs.map +1 -1
- package/resources/mcp/mcp.d.mts +322 -217
- package/resources/mcp/mcp.d.mts.map +1 -1
- package/resources/mcp/mcp.d.ts +322 -217
- package/resources/mcp/mcp.d.ts.map +1 -1
- package/resources/mcp/mcp.js +72 -25
- package/resources/mcp/mcp.js.map +1 -1
- package/resources/mcp/mcp.mjs +72 -25
- package/resources/mcp/mcp.mjs.map +1 -1
- package/resources/migration.d.mts +11 -2
- package/resources/migration.d.mts.map +1 -1
- package/resources/migration.d.ts +11 -2
- package/resources/migration.d.ts.map +1 -1
- package/resources/migration.js +3 -1
- package/resources/migration.js.map +1 -1
- package/resources/migration.mjs +3 -1
- package/resources/migration.mjs.map +1 -1
- package/resources/org/api-key.d.mts +23 -2
- package/resources/org/api-key.d.mts.map +1 -1
- package/resources/org/api-key.d.ts +23 -2
- package/resources/org/api-key.d.ts.map +1 -1
- package/resources/org/api-key.js +15 -2
- package/resources/org/api-key.js.map +1 -1
- package/resources/org/api-key.mjs +15 -2
- package/resources/org/api-key.mjs.map +1 -1
- package/resources/org/project/api-keys.d.mts +114 -22
- package/resources/org/project/api-keys.d.mts.map +1 -1
- package/resources/org/project/api-keys.d.ts +114 -22
- package/resources/org/project/api-keys.d.ts.map +1 -1
- package/resources/org/project/api-keys.js +57 -0
- package/resources/org/project/api-keys.js.map +1 -1
- package/resources/org/project/api-keys.mjs +57 -0
- package/resources/org/project/api-keys.mjs.map +1 -1
- package/resources/org/project/project.d.mts +176 -4
- package/resources/org/project/project.d.mts.map +1 -1
- package/resources/org/project/project.d.ts +176 -4
- package/resources/org/project/project.d.ts.map +1 -1
- package/resources/org/project/project.js +46 -3
- package/resources/org/project/project.js.map +1 -1
- package/resources/org/project/project.mjs +46 -3
- package/resources/org/project/project.mjs.map +1 -1
- package/resources/org/project/trigger.d.mts +101 -1
- package/resources/org/project/trigger.d.mts.map +1 -1
- package/resources/org/project/trigger.d.ts +101 -1
- package/resources/org/project/trigger.d.ts.map +1 -1
- package/resources/org/project/trigger.js +21 -0
- package/resources/org/project/trigger.js.map +1 -1
- package/resources/org/project/trigger.mjs +21 -0
- package/resources/org/project/trigger.mjs.map +1 -1
- package/resources/org/project/webhook.d.mts +86 -15
- package/resources/org/project/webhook.d.mts.map +1 -1
- package/resources/org/project/webhook.d.ts +86 -15
- package/resources/org/project/webhook.d.ts.map +1 -1
- package/resources/org/project/webhook.js +49 -2
- package/resources/org/project/webhook.js.map +1 -1
- package/resources/org/project/webhook.mjs +49 -2
- package/resources/org/project/webhook.mjs.map +1 -1
- package/resources/team-members.d.mts +7 -7
- package/resources/team-members.d.mts.map +1 -1
- package/resources/team-members.d.ts +7 -7
- package/resources/team-members.d.ts.map +1 -1
- package/resources/toolkits.d.mts +195 -7
- package/resources/toolkits.d.mts.map +1 -1
- package/resources/toolkits.d.ts +195 -7
- package/resources/toolkits.d.ts.map +1 -1
- package/resources/toolkits.js +14 -6
- package/resources/toolkits.js.map +1 -1
- package/resources/toolkits.mjs +14 -6
- package/resources/toolkits.mjs.map +1 -1
- package/resources/tools.d.mts +211 -44
- package/resources/tools.d.mts.map +1 -1
- package/resources/tools.d.ts +211 -44
- package/resources/tools.d.ts.map +1 -1
- package/resources/tools.js +62 -9
- package/resources/tools.js.map +1 -1
- package/resources/tools.mjs +62 -9
- package/resources/tools.mjs.map +1 -1
- package/resources/trigger-instances/index.d.mts +1 -1
- package/resources/trigger-instances/index.d.mts.map +1 -1
- package/resources/trigger-instances/index.d.ts +1 -1
- package/resources/trigger-instances/index.d.ts.map +1 -1
- package/resources/trigger-instances/trigger-instances.d.mts +86 -19
- package/resources/trigger-instances/trigger-instances.d.mts.map +1 -1
- package/resources/trigger-instances/trigger-instances.d.ts +86 -19
- package/resources/trigger-instances/trigger-instances.d.ts.map +1 -1
- package/resources/trigger-instances/trigger-instances.js +6 -6
- package/resources/trigger-instances/trigger-instances.js.map +1 -1
- package/resources/trigger-instances/trigger-instances.mjs +6 -6
- package/resources/trigger-instances/trigger-instances.mjs.map +1 -1
- package/resources/triggers-types.d.mts +96 -2
- package/resources/triggers-types.d.mts.map +1 -1
- package/resources/triggers-types.d.ts +96 -2
- package/resources/triggers-types.d.ts.map +1 -1
- package/resources/triggers-types.js +23 -1
- package/resources/triggers-types.js.map +1 -1
- package/resources/triggers-types.mjs +23 -1
- package/resources/triggers-types.mjs.map +1 -1
- package/src/client.ts +6 -6
- package/src/resources/auth-configs.ts +169 -29
- package/src/resources/connected-accounts.ts +80 -17
- package/src/resources/files.ts +75 -23
- package/src/resources/index.ts +3 -3
- package/src/resources/mcp/custom.ts +103 -0
- package/src/resources/mcp/index.ts +2 -3
- package/src/resources/mcp/mcp.ts +342 -256
- package/src/resources/migration.ts +11 -2
- package/src/resources/org/api-key.ts +23 -2
- package/src/resources/org/project/api-keys.ts +117 -22
- package/src/resources/org/project/project.ts +176 -4
- package/src/resources/org/project/trigger.ts +101 -1
- package/src/resources/org/project/webhook.ts +86 -15
- package/src/resources/team-members.ts +7 -7
- package/src/resources/toolkits.ts +200 -7
- package/src/resources/tools.ts +213 -46
- package/src/resources/trigger-instances/index.ts +1 -1
- package/src/resources/trigger-instances/trigger-instances.ts +106 -25
- package/src/resources/triggers-types.ts +96 -2
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/mcp/command.d.mts +0 -37
- package/resources/mcp/command.d.mts.map +0 -1
- package/resources/mcp/command.d.ts +0 -37
- package/resources/mcp/command.d.ts.map +0 -1
- package/resources/mcp/command.js +0 -15
- package/resources/mcp/command.js.map +0 -1
- package/resources/mcp/command.mjs +0 -11
- package/resources/mcp/command.mjs.map +0 -1
- package/src/resources/mcp/command.ts +0 -50
|
@@ -12,75 +12,247 @@ export declare class Project extends APIResource {
|
|
|
12
12
|
webhook: WebhookAPI.Webhook;
|
|
13
13
|
trigger: TriggerAPI.Trigger;
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* Creates a new project within the authenticated user's organization using the
|
|
16
|
+
* specified name. Projects are isolated environments within your organization,
|
|
17
|
+
* each with their own API keys, webhook configurations, and resources. Use this
|
|
18
|
+
* endpoint to create additional projects for different environments (e.g.,
|
|
19
|
+
* development, staging, production) or for separate applications.
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```ts
|
|
23
|
+
* const project = await client.org.project.create({
|
|
24
|
+
* name: 'my-production-api',
|
|
25
|
+
* });
|
|
26
|
+
* ```
|
|
16
27
|
*/
|
|
17
28
|
create(body: ProjectCreateParams, options?: RequestOptions): APIPromise<ProjectCreateResponse>;
|
|
18
29
|
/**
|
|
19
|
-
*
|
|
30
|
+
* Retrieves detailed information about a specific project using its unique
|
|
31
|
+
* identifier. This endpoint provides complete project configuration including
|
|
32
|
+
* webhook URLs, creation and update timestamps, and webhook secrets. Use this
|
|
33
|
+
* endpoint to inspect project settings or verify project configuration.
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```ts
|
|
37
|
+
* const project = await client.org.project.retrieve(
|
|
38
|
+
* 'proj_abc123xyz456',
|
|
39
|
+
* );
|
|
40
|
+
* ```
|
|
20
41
|
*/
|
|
21
42
|
retrieve(projectID: string, options?: RequestOptions): APIPromise<ProjectRetrieveResponse>;
|
|
22
43
|
/**
|
|
23
|
-
*
|
|
44
|
+
* Retrieves all projects belonging to the authenticated user's organization.
|
|
45
|
+
* Projects are returned in descending order of creation date (newest first). This
|
|
46
|
+
* endpoint is useful for displaying project selection in dashboards or for
|
|
47
|
+
* integrations that need to list all available projects.
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* const projects = await client.org.project.list();
|
|
52
|
+
* ```
|
|
24
53
|
*/
|
|
25
54
|
list(options?: RequestOptions): APIPromise<ProjectListResponse>;
|
|
55
|
+
/**
|
|
56
|
+
* Soft-deletes a project within the organization by its unique identifier. When a
|
|
57
|
+
* project is deleted, it is marked as deleted but not immediately removed from the
|
|
58
|
+
* database. This operation affects all resources associated with the project
|
|
59
|
+
* including API keys, webhook configurations, and connected services. This action
|
|
60
|
+
* cannot be undone through the API.
|
|
61
|
+
*
|
|
62
|
+
* @example
|
|
63
|
+
* ```ts
|
|
64
|
+
* const project = await client.org.project.delete(
|
|
65
|
+
* 'proj_abc123xyz456',
|
|
66
|
+
* );
|
|
67
|
+
* ```
|
|
68
|
+
*/
|
|
26
69
|
delete(projectID: string, options?: RequestOptions): APIPromise<ProjectDeleteResponse>;
|
|
27
70
|
}
|
|
28
71
|
export interface ProjectCreateResponse {
|
|
72
|
+
/**
|
|
73
|
+
* Unique identifier for the project
|
|
74
|
+
*/
|
|
29
75
|
id: string;
|
|
76
|
+
/**
|
|
77
|
+
* ISO timestamp when the project was created
|
|
78
|
+
*/
|
|
30
79
|
created_at: string;
|
|
80
|
+
/**
|
|
81
|
+
* Whether this project has been soft-deleted
|
|
82
|
+
*/
|
|
31
83
|
deleted: boolean;
|
|
84
|
+
/**
|
|
85
|
+
* Email address associated with the project
|
|
86
|
+
*/
|
|
32
87
|
email: string;
|
|
88
|
+
/**
|
|
89
|
+
* URL where event webhook notifications will be sent (can be null)
|
|
90
|
+
*/
|
|
33
91
|
event_webhook_url: string | null;
|
|
92
|
+
/**
|
|
93
|
+
* Name of the project
|
|
94
|
+
*/
|
|
34
95
|
name: string;
|
|
96
|
+
/**
|
|
97
|
+
* Identifier of the organization that owns this project
|
|
98
|
+
*/
|
|
35
99
|
org_id: string;
|
|
100
|
+
/**
|
|
101
|
+
* ISO timestamp when the project was last updated
|
|
102
|
+
*/
|
|
36
103
|
updated_at: string;
|
|
104
|
+
/**
|
|
105
|
+
* Secret key used to sign webhook payloads for verification
|
|
106
|
+
*/
|
|
37
107
|
webhook_secret: string | null;
|
|
108
|
+
/**
|
|
109
|
+
* URL where webhook events will be sent (can be null)
|
|
110
|
+
*/
|
|
38
111
|
webhook_url: string | null;
|
|
112
|
+
/**
|
|
113
|
+
* Indicates if the webhook configuration is using the new format
|
|
114
|
+
*/
|
|
39
115
|
is_new_webhook?: boolean;
|
|
116
|
+
/**
|
|
117
|
+
* ISO timestamp when the project last subscribed to updates
|
|
118
|
+
*/
|
|
40
119
|
last_subscribed_at?: string | null;
|
|
120
|
+
/**
|
|
121
|
+
* Whether triggers are enabled for this project
|
|
122
|
+
*/
|
|
41
123
|
triggers_enabled?: boolean;
|
|
42
124
|
}
|
|
43
125
|
export interface ProjectRetrieveResponse {
|
|
126
|
+
/**
|
|
127
|
+
* Unique identifier for the project
|
|
128
|
+
*/
|
|
44
129
|
id: string;
|
|
130
|
+
/**
|
|
131
|
+
* ISO timestamp when the project was created
|
|
132
|
+
*/
|
|
45
133
|
created_at: string;
|
|
134
|
+
/**
|
|
135
|
+
* Whether this project has been soft-deleted
|
|
136
|
+
*/
|
|
46
137
|
deleted: boolean;
|
|
138
|
+
/**
|
|
139
|
+
* Email address associated with the project
|
|
140
|
+
*/
|
|
47
141
|
email: string;
|
|
142
|
+
/**
|
|
143
|
+
* URL where event webhook notifications will be sent (can be null)
|
|
144
|
+
*/
|
|
48
145
|
event_webhook_url: string | null;
|
|
146
|
+
/**
|
|
147
|
+
* Name of the project
|
|
148
|
+
*/
|
|
49
149
|
name: string;
|
|
150
|
+
/**
|
|
151
|
+
* Identifier of the organization that owns this project
|
|
152
|
+
*/
|
|
50
153
|
org_id: string;
|
|
154
|
+
/**
|
|
155
|
+
* ISO timestamp when the project was last updated
|
|
156
|
+
*/
|
|
51
157
|
updated_at: string;
|
|
158
|
+
/**
|
|
159
|
+
* Secret key used to sign webhook payloads for verification
|
|
160
|
+
*/
|
|
52
161
|
webhook_secret: string | null;
|
|
162
|
+
/**
|
|
163
|
+
* URL where webhook events will be sent (can be null)
|
|
164
|
+
*/
|
|
53
165
|
webhook_url: string | null;
|
|
166
|
+
/**
|
|
167
|
+
* Indicates if the webhook configuration is using the new format
|
|
168
|
+
*/
|
|
54
169
|
is_new_webhook?: boolean;
|
|
170
|
+
/**
|
|
171
|
+
* ISO timestamp when the project last subscribed to updates
|
|
172
|
+
*/
|
|
55
173
|
last_subscribed_at?: string | null;
|
|
174
|
+
/**
|
|
175
|
+
* Whether triggers are enabled for this project
|
|
176
|
+
*/
|
|
56
177
|
triggers_enabled?: boolean;
|
|
57
178
|
}
|
|
179
|
+
/**
|
|
180
|
+
* Response containing a list of projects
|
|
181
|
+
*/
|
|
58
182
|
export interface ProjectListResponse {
|
|
183
|
+
/**
|
|
184
|
+
* Array of projects belonging to the organization
|
|
185
|
+
*/
|
|
59
186
|
data: Array<ProjectListResponse.Data>;
|
|
60
187
|
}
|
|
61
188
|
export declare namespace ProjectListResponse {
|
|
62
189
|
interface Data {
|
|
190
|
+
/**
|
|
191
|
+
* Unique identifier for the project
|
|
192
|
+
*/
|
|
63
193
|
id: string;
|
|
194
|
+
/**
|
|
195
|
+
* ISO timestamp when the project was created
|
|
196
|
+
*/
|
|
64
197
|
created_at: string;
|
|
198
|
+
/**
|
|
199
|
+
* Whether this project has been soft-deleted
|
|
200
|
+
*/
|
|
65
201
|
deleted: boolean;
|
|
202
|
+
/**
|
|
203
|
+
* Email address associated with the project
|
|
204
|
+
*/
|
|
66
205
|
email: string;
|
|
206
|
+
/**
|
|
207
|
+
* URL where event webhook notifications will be sent (can be null)
|
|
208
|
+
*/
|
|
67
209
|
event_webhook_url: string | null;
|
|
210
|
+
/**
|
|
211
|
+
* Name of the project
|
|
212
|
+
*/
|
|
68
213
|
name: string;
|
|
214
|
+
/**
|
|
215
|
+
* Identifier of the organization that owns this project
|
|
216
|
+
*/
|
|
69
217
|
org_id: string;
|
|
218
|
+
/**
|
|
219
|
+
* ISO timestamp when the project was last updated
|
|
220
|
+
*/
|
|
70
221
|
updated_at: string;
|
|
222
|
+
/**
|
|
223
|
+
* Secret key used to sign webhook payloads for verification
|
|
224
|
+
*/
|
|
71
225
|
webhook_secret: string | null;
|
|
226
|
+
/**
|
|
227
|
+
* URL where webhook events will be sent (can be null)
|
|
228
|
+
*/
|
|
72
229
|
webhook_url: string | null;
|
|
230
|
+
/**
|
|
231
|
+
* Indicates if the webhook configuration is using the new format
|
|
232
|
+
*/
|
|
73
233
|
is_new_webhook?: boolean;
|
|
234
|
+
/**
|
|
235
|
+
* ISO timestamp when the project last subscribed to updates
|
|
236
|
+
*/
|
|
74
237
|
last_subscribed_at?: string | null;
|
|
238
|
+
/**
|
|
239
|
+
* Whether triggers are enabled for this project
|
|
240
|
+
*/
|
|
75
241
|
triggers_enabled?: boolean;
|
|
76
242
|
}
|
|
77
243
|
}
|
|
244
|
+
/**
|
|
245
|
+
* Response indicating the result of a project deletion operation
|
|
246
|
+
*/
|
|
78
247
|
export interface ProjectDeleteResponse {
|
|
248
|
+
/**
|
|
249
|
+
* Status of the delete operation
|
|
250
|
+
*/
|
|
79
251
|
status: string;
|
|
80
252
|
}
|
|
81
253
|
export interface ProjectCreateParams {
|
|
82
254
|
/**
|
|
83
|
-
*
|
|
255
|
+
* A unique name for your project that follows the required format rules
|
|
84
256
|
*/
|
|
85
257
|
name: string;
|
|
86
258
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"project.d.mts","sourceRoot":"","sources":["../../../src/resources/org/project/project.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EACL,0BAA0B,EAC1B,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,OAAO,EACR;OACM,KAAK,UAAU;OACf,EAAE,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE;OAC5E,KAAK,UAAU;OACf,EACL,OAAO,EACP,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,EACtB,qBAAqB,EACrB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACtB;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE
|
|
1
|
+
{"version":3,"file":"project.d.mts","sourceRoot":"","sources":["../../../src/resources/org/project/project.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EACL,0BAA0B,EAC1B,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,OAAO,EACR;OACM,KAAK,UAAU;OACf,EAAE,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE;OAC5E,KAAK,UAAU;OACf,EACL,OAAO,EACP,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,EACtB,qBAAqB,EACrB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACtB;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAI1F;;;;;;;;;;OAUG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI/D;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGvF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;CACvC;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,cAAc,CAAC,EAAE,OAAO,CAAC;QAEzB;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAMD,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -12,75 +12,247 @@ export declare class Project extends APIResource {
|
|
|
12
12
|
webhook: WebhookAPI.Webhook;
|
|
13
13
|
trigger: TriggerAPI.Trigger;
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* Creates a new project within the authenticated user's organization using the
|
|
16
|
+
* specified name. Projects are isolated environments within your organization,
|
|
17
|
+
* each with their own API keys, webhook configurations, and resources. Use this
|
|
18
|
+
* endpoint to create additional projects for different environments (e.g.,
|
|
19
|
+
* development, staging, production) or for separate applications.
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```ts
|
|
23
|
+
* const project = await client.org.project.create({
|
|
24
|
+
* name: 'my-production-api',
|
|
25
|
+
* });
|
|
26
|
+
* ```
|
|
16
27
|
*/
|
|
17
28
|
create(body: ProjectCreateParams, options?: RequestOptions): APIPromise<ProjectCreateResponse>;
|
|
18
29
|
/**
|
|
19
|
-
*
|
|
30
|
+
* Retrieves detailed information about a specific project using its unique
|
|
31
|
+
* identifier. This endpoint provides complete project configuration including
|
|
32
|
+
* webhook URLs, creation and update timestamps, and webhook secrets. Use this
|
|
33
|
+
* endpoint to inspect project settings or verify project configuration.
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```ts
|
|
37
|
+
* const project = await client.org.project.retrieve(
|
|
38
|
+
* 'proj_abc123xyz456',
|
|
39
|
+
* );
|
|
40
|
+
* ```
|
|
20
41
|
*/
|
|
21
42
|
retrieve(projectID: string, options?: RequestOptions): APIPromise<ProjectRetrieveResponse>;
|
|
22
43
|
/**
|
|
23
|
-
*
|
|
44
|
+
* Retrieves all projects belonging to the authenticated user's organization.
|
|
45
|
+
* Projects are returned in descending order of creation date (newest first). This
|
|
46
|
+
* endpoint is useful for displaying project selection in dashboards or for
|
|
47
|
+
* integrations that need to list all available projects.
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* const projects = await client.org.project.list();
|
|
52
|
+
* ```
|
|
24
53
|
*/
|
|
25
54
|
list(options?: RequestOptions): APIPromise<ProjectListResponse>;
|
|
55
|
+
/**
|
|
56
|
+
* Soft-deletes a project within the organization by its unique identifier. When a
|
|
57
|
+
* project is deleted, it is marked as deleted but not immediately removed from the
|
|
58
|
+
* database. This operation affects all resources associated with the project
|
|
59
|
+
* including API keys, webhook configurations, and connected services. This action
|
|
60
|
+
* cannot be undone through the API.
|
|
61
|
+
*
|
|
62
|
+
* @example
|
|
63
|
+
* ```ts
|
|
64
|
+
* const project = await client.org.project.delete(
|
|
65
|
+
* 'proj_abc123xyz456',
|
|
66
|
+
* );
|
|
67
|
+
* ```
|
|
68
|
+
*/
|
|
26
69
|
delete(projectID: string, options?: RequestOptions): APIPromise<ProjectDeleteResponse>;
|
|
27
70
|
}
|
|
28
71
|
export interface ProjectCreateResponse {
|
|
72
|
+
/**
|
|
73
|
+
* Unique identifier for the project
|
|
74
|
+
*/
|
|
29
75
|
id: string;
|
|
76
|
+
/**
|
|
77
|
+
* ISO timestamp when the project was created
|
|
78
|
+
*/
|
|
30
79
|
created_at: string;
|
|
80
|
+
/**
|
|
81
|
+
* Whether this project has been soft-deleted
|
|
82
|
+
*/
|
|
31
83
|
deleted: boolean;
|
|
84
|
+
/**
|
|
85
|
+
* Email address associated with the project
|
|
86
|
+
*/
|
|
32
87
|
email: string;
|
|
88
|
+
/**
|
|
89
|
+
* URL where event webhook notifications will be sent (can be null)
|
|
90
|
+
*/
|
|
33
91
|
event_webhook_url: string | null;
|
|
92
|
+
/**
|
|
93
|
+
* Name of the project
|
|
94
|
+
*/
|
|
34
95
|
name: string;
|
|
96
|
+
/**
|
|
97
|
+
* Identifier of the organization that owns this project
|
|
98
|
+
*/
|
|
35
99
|
org_id: string;
|
|
100
|
+
/**
|
|
101
|
+
* ISO timestamp when the project was last updated
|
|
102
|
+
*/
|
|
36
103
|
updated_at: string;
|
|
104
|
+
/**
|
|
105
|
+
* Secret key used to sign webhook payloads for verification
|
|
106
|
+
*/
|
|
37
107
|
webhook_secret: string | null;
|
|
108
|
+
/**
|
|
109
|
+
* URL where webhook events will be sent (can be null)
|
|
110
|
+
*/
|
|
38
111
|
webhook_url: string | null;
|
|
112
|
+
/**
|
|
113
|
+
* Indicates if the webhook configuration is using the new format
|
|
114
|
+
*/
|
|
39
115
|
is_new_webhook?: boolean;
|
|
116
|
+
/**
|
|
117
|
+
* ISO timestamp when the project last subscribed to updates
|
|
118
|
+
*/
|
|
40
119
|
last_subscribed_at?: string | null;
|
|
120
|
+
/**
|
|
121
|
+
* Whether triggers are enabled for this project
|
|
122
|
+
*/
|
|
41
123
|
triggers_enabled?: boolean;
|
|
42
124
|
}
|
|
43
125
|
export interface ProjectRetrieveResponse {
|
|
126
|
+
/**
|
|
127
|
+
* Unique identifier for the project
|
|
128
|
+
*/
|
|
44
129
|
id: string;
|
|
130
|
+
/**
|
|
131
|
+
* ISO timestamp when the project was created
|
|
132
|
+
*/
|
|
45
133
|
created_at: string;
|
|
134
|
+
/**
|
|
135
|
+
* Whether this project has been soft-deleted
|
|
136
|
+
*/
|
|
46
137
|
deleted: boolean;
|
|
138
|
+
/**
|
|
139
|
+
* Email address associated with the project
|
|
140
|
+
*/
|
|
47
141
|
email: string;
|
|
142
|
+
/**
|
|
143
|
+
* URL where event webhook notifications will be sent (can be null)
|
|
144
|
+
*/
|
|
48
145
|
event_webhook_url: string | null;
|
|
146
|
+
/**
|
|
147
|
+
* Name of the project
|
|
148
|
+
*/
|
|
49
149
|
name: string;
|
|
150
|
+
/**
|
|
151
|
+
* Identifier of the organization that owns this project
|
|
152
|
+
*/
|
|
50
153
|
org_id: string;
|
|
154
|
+
/**
|
|
155
|
+
* ISO timestamp when the project was last updated
|
|
156
|
+
*/
|
|
51
157
|
updated_at: string;
|
|
158
|
+
/**
|
|
159
|
+
* Secret key used to sign webhook payloads for verification
|
|
160
|
+
*/
|
|
52
161
|
webhook_secret: string | null;
|
|
162
|
+
/**
|
|
163
|
+
* URL where webhook events will be sent (can be null)
|
|
164
|
+
*/
|
|
53
165
|
webhook_url: string | null;
|
|
166
|
+
/**
|
|
167
|
+
* Indicates if the webhook configuration is using the new format
|
|
168
|
+
*/
|
|
54
169
|
is_new_webhook?: boolean;
|
|
170
|
+
/**
|
|
171
|
+
* ISO timestamp when the project last subscribed to updates
|
|
172
|
+
*/
|
|
55
173
|
last_subscribed_at?: string | null;
|
|
174
|
+
/**
|
|
175
|
+
* Whether triggers are enabled for this project
|
|
176
|
+
*/
|
|
56
177
|
triggers_enabled?: boolean;
|
|
57
178
|
}
|
|
179
|
+
/**
|
|
180
|
+
* Response containing a list of projects
|
|
181
|
+
*/
|
|
58
182
|
export interface ProjectListResponse {
|
|
183
|
+
/**
|
|
184
|
+
* Array of projects belonging to the organization
|
|
185
|
+
*/
|
|
59
186
|
data: Array<ProjectListResponse.Data>;
|
|
60
187
|
}
|
|
61
188
|
export declare namespace ProjectListResponse {
|
|
62
189
|
interface Data {
|
|
190
|
+
/**
|
|
191
|
+
* Unique identifier for the project
|
|
192
|
+
*/
|
|
63
193
|
id: string;
|
|
194
|
+
/**
|
|
195
|
+
* ISO timestamp when the project was created
|
|
196
|
+
*/
|
|
64
197
|
created_at: string;
|
|
198
|
+
/**
|
|
199
|
+
* Whether this project has been soft-deleted
|
|
200
|
+
*/
|
|
65
201
|
deleted: boolean;
|
|
202
|
+
/**
|
|
203
|
+
* Email address associated with the project
|
|
204
|
+
*/
|
|
66
205
|
email: string;
|
|
206
|
+
/**
|
|
207
|
+
* URL where event webhook notifications will be sent (can be null)
|
|
208
|
+
*/
|
|
67
209
|
event_webhook_url: string | null;
|
|
210
|
+
/**
|
|
211
|
+
* Name of the project
|
|
212
|
+
*/
|
|
68
213
|
name: string;
|
|
214
|
+
/**
|
|
215
|
+
* Identifier of the organization that owns this project
|
|
216
|
+
*/
|
|
69
217
|
org_id: string;
|
|
218
|
+
/**
|
|
219
|
+
* ISO timestamp when the project was last updated
|
|
220
|
+
*/
|
|
70
221
|
updated_at: string;
|
|
222
|
+
/**
|
|
223
|
+
* Secret key used to sign webhook payloads for verification
|
|
224
|
+
*/
|
|
71
225
|
webhook_secret: string | null;
|
|
226
|
+
/**
|
|
227
|
+
* URL where webhook events will be sent (can be null)
|
|
228
|
+
*/
|
|
72
229
|
webhook_url: string | null;
|
|
230
|
+
/**
|
|
231
|
+
* Indicates if the webhook configuration is using the new format
|
|
232
|
+
*/
|
|
73
233
|
is_new_webhook?: boolean;
|
|
234
|
+
/**
|
|
235
|
+
* ISO timestamp when the project last subscribed to updates
|
|
236
|
+
*/
|
|
74
237
|
last_subscribed_at?: string | null;
|
|
238
|
+
/**
|
|
239
|
+
* Whether triggers are enabled for this project
|
|
240
|
+
*/
|
|
75
241
|
triggers_enabled?: boolean;
|
|
76
242
|
}
|
|
77
243
|
}
|
|
244
|
+
/**
|
|
245
|
+
* Response indicating the result of a project deletion operation
|
|
246
|
+
*/
|
|
78
247
|
export interface ProjectDeleteResponse {
|
|
248
|
+
/**
|
|
249
|
+
* Status of the delete operation
|
|
250
|
+
*/
|
|
79
251
|
status: string;
|
|
80
252
|
}
|
|
81
253
|
export interface ProjectCreateParams {
|
|
82
254
|
/**
|
|
83
|
-
*
|
|
255
|
+
* A unique name for your project that follows the required format rules
|
|
84
256
|
*/
|
|
85
257
|
name: string;
|
|
86
258
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"project.d.ts","sourceRoot":"","sources":["../../../src/resources/org/project/project.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EACL,0BAA0B,EAC1B,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,OAAO,EACR;OACM,KAAK,UAAU;OACf,EAAE,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE;OAC5E,KAAK,UAAU;OACf,EACL,OAAO,EACP,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,EACtB,qBAAqB,EACrB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACtB;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE
|
|
1
|
+
{"version":3,"file":"project.d.ts","sourceRoot":"","sources":["../../../src/resources/org/project/project.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EACL,0BAA0B,EAC1B,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,OAAO,EACR;OACM,KAAK,UAAU;OACf,EAAE,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE;OAC5E,KAAK,UAAU;OACf,EACL,OAAO,EACP,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,EACtB,qBAAqB,EACrB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACtB;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAI1F;;;;;;;;;;OAUG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI/D;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGvF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;CACvC;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,cAAc,CAAC,EAAE,OAAO,CAAC;QAEzB;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAMD,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -19,23 +19,66 @@ class Project extends resource_1.APIResource {
|
|
|
19
19
|
this.trigger = new TriggerAPI.Trigger(this._client);
|
|
20
20
|
}
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
22
|
+
* Creates a new project within the authenticated user's organization using the
|
|
23
|
+
* specified name. Projects are isolated environments within your organization,
|
|
24
|
+
* each with their own API keys, webhook configurations, and resources. Use this
|
|
25
|
+
* endpoint to create additional projects for different environments (e.g.,
|
|
26
|
+
* development, staging, production) or for separate applications.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```ts
|
|
30
|
+
* const project = await client.org.project.create({
|
|
31
|
+
* name: 'my-production-api',
|
|
32
|
+
* });
|
|
33
|
+
* ```
|
|
23
34
|
*/
|
|
24
35
|
create(body, options) {
|
|
25
36
|
return this._client.post('/api/v3/org/project/new', { body, ...options });
|
|
26
37
|
}
|
|
27
38
|
/**
|
|
28
|
-
*
|
|
39
|
+
* Retrieves detailed information about a specific project using its unique
|
|
40
|
+
* identifier. This endpoint provides complete project configuration including
|
|
41
|
+
* webhook URLs, creation and update timestamps, and webhook secrets. Use this
|
|
42
|
+
* endpoint to inspect project settings or verify project configuration.
|
|
43
|
+
*
|
|
44
|
+
* @example
|
|
45
|
+
* ```ts
|
|
46
|
+
* const project = await client.org.project.retrieve(
|
|
47
|
+
* 'proj_abc123xyz456',
|
|
48
|
+
* );
|
|
49
|
+
* ```
|
|
29
50
|
*/
|
|
30
51
|
retrieve(projectID, options) {
|
|
31
52
|
return this._client.get((0, path_1.path) `/api/v3/org/project/${projectID}`, options);
|
|
32
53
|
}
|
|
33
54
|
/**
|
|
34
|
-
*
|
|
55
|
+
* Retrieves all projects belonging to the authenticated user's organization.
|
|
56
|
+
* Projects are returned in descending order of creation date (newest first). This
|
|
57
|
+
* endpoint is useful for displaying project selection in dashboards or for
|
|
58
|
+
* integrations that need to list all available projects.
|
|
59
|
+
*
|
|
60
|
+
* @example
|
|
61
|
+
* ```ts
|
|
62
|
+
* const projects = await client.org.project.list();
|
|
63
|
+
* ```
|
|
35
64
|
*/
|
|
36
65
|
list(options) {
|
|
37
66
|
return this._client.get('/api/v3/org/project/list', options);
|
|
38
67
|
}
|
|
68
|
+
/**
|
|
69
|
+
* Soft-deletes a project within the organization by its unique identifier. When a
|
|
70
|
+
* project is deleted, it is marked as deleted but not immediately removed from the
|
|
71
|
+
* database. This operation affects all resources associated with the project
|
|
72
|
+
* including API keys, webhook configurations, and connected services. This action
|
|
73
|
+
* cannot be undone through the API.
|
|
74
|
+
*
|
|
75
|
+
* @example
|
|
76
|
+
* ```ts
|
|
77
|
+
* const project = await client.org.project.delete(
|
|
78
|
+
* 'proj_abc123xyz456',
|
|
79
|
+
* );
|
|
80
|
+
* ```
|
|
81
|
+
*/
|
|
39
82
|
delete(projectID, options) {
|
|
40
83
|
return this._client.delete((0, path_1.path) `/api/v3/org/project/delete/${projectID}`, options);
|
|
41
84
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"project.js","sourceRoot":"","sources":["../../../src/resources/org/project/project.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AACrD,kEAAyC;AACzC,4CAQoB;AACpB,iEAAwC;AACxC,0CAAqG;AACrG,iEAAwC;AACxC,0CASmB;AAGnB,0DAAoD;AAEpD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"project.js","sourceRoot":"","sources":["../../../src/resources/org/project/project.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AACrD,kEAAyC;AACzC,4CAQoB;AACpB,iEAAwC;AACxC,0CAAqG;AACrG,iEAAwC;AACxC,0CASmB;AAGnB,0DAAoD;AAEpD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAqErE,CAAC;IAnEC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,uBAAuB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,SAAiB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,8BAA8B,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;CACF;AAxED,0BAwEC;AAwOD,OAAO,CAAC,OAAO,GAAG,kBAAO,CAAC;AAC1B,OAAO,CAAC,OAAO,GAAG,iBAAO,CAAC;AAC1B,OAAO,CAAC,OAAO,GAAG,iBAAO,CAAC"}
|