@gpt-platform/client 0.1.1

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/llms.txt ADDED
@@ -0,0 +1,981 @@
1
+ # @gpt-platform/client
2
+
3
+ > TypeScript SDK for GPT Core - document extraction, AI agents, and workspace management.
4
+ > Version: 1.1
5
+
6
+ ## Installation
7
+
8
+ ```bash
9
+ npm install @gpt-platform/client
10
+ ```
11
+
12
+ ## Setup
13
+
14
+ ```typescript
15
+ import { client } from '@gpt-platform/client';
16
+
17
+ client.setConfig({
18
+ baseUrl: 'https://api.example.com',
19
+ headers: {
20
+ Authorization: 'Bearer YOUR_TOKEN',
21
+ },
22
+ });
23
+ ```
24
+
25
+ ## Access log
26
+
27
+ - `getAccess-logs()` - List access logs
28
+ - `getAccess-logsById()` - Get access logs
29
+
30
+ ## Agent stats
31
+
32
+ - `getAgentsByIdStats()` - Get stats
33
+
34
+ ## Agent test result
35
+
36
+ - `postAgent-test-results()` - Create agent test results
37
+
38
+ ## Agent training stats
39
+
40
+ - `getAgentsByIdTraining-stats()` - Get training stats
41
+
42
+ ## Agent usage
43
+
44
+ - `getAgentsByIdUsage()` - Get usage
45
+ - `getAgentsUsage()` - List usage
46
+
47
+ ## Agent version comparison
48
+
49
+ - `postAgent-version-comparisons()` - Create agent version comparisons
50
+
51
+ ## Agent version revision
52
+
53
+ - `getAgent-version-revisions()` - List agent version revisions
54
+ - `getAgent-version-revisionsById()` - Get agent version revisions
55
+
56
+ ## AI Agents
57
+
58
+ - `getAgent-versions()` - List agent versions
59
+ - `getAgent-versionsById()` - Get agent versions
60
+ - `getAgent-versionsByIdMetrics()` - Get metrics
61
+ - `getAgent-versionsByIdRevisions()` - Get revisions
62
+ - `getAgents()` - List agents
63
+ - `getAgentsById()` - Get agents
64
+ - `getAgentsByIdSchema-versions()` - Get schema versions
65
+ - `getAgentsByIdTraining-examples()` - Get training examples
66
+ - `postAgent-versions()` - Create agent versions
67
+ - `postAgent-versionsByIdAdd-system-field()` - Create add system field
68
+ - `postAgent-versionsByIdRemove-system-field()` - Create remove system field
69
+ - `postAgent-versionsByIdSet-system-fields()` - Create set system fields
70
+ - `postAgents()` - Create agents
71
+ - `postAgentsByIdAnalyze-training()` - Create analyze training
72
+ - `postAgentsByIdClone()` - Create clone
73
+ - `postAgentsByIdExport()` - Create export
74
+ - `postAgentsByIdPublish-version()` - Create publish version
75
+ - `postAgentsByIdRestore-version()` - Create restore version
76
+ - `postAgentsByIdSchema-versions()` - Create schema versions
77
+ - `postAgentsByIdSchema-versionsByVersionIdActivate()` - Create activate
78
+ - `postAgentsByIdTeach()` - Create teach
79
+ - `postAgentsByIdTest()` - Create test
80
+ - `postAgentsByIdValidate()` - Create validate
81
+ - `postAgentsClone-for-workspace()` - Create clone for workspace
82
+ - `postAgentsImport()` - Create import
83
+ - `postAgentsPredict()` - Create predict
84
+ - `patchAgentsById()` - Update agents
85
+ - `patchAgentsByIdSchema-versionsByVersionId()` - Update schema versions
86
+ - `deleteAgent-versionsById()` - Delete agent versions
87
+ - `deleteAgentsById()` - Delete agents
88
+ - `deleteAgentsByIdTraining-examplesByExampleId()` - Delete training examples
89
+
90
+ ## AI Training
91
+
92
+ - `getTraining-examples()` - List training examples
93
+ - `getTraining-examplesById()` - Get training examples
94
+ - `getTraining-sessionsAgentsByAgentIdSessions()` - Get sessions
95
+ - `getTraining-sessionsById()` - Get training sessions
96
+ - `postTraining-examples()` - Create training examples
97
+ - `postTraining-examplesBulk()` - Create bulk
98
+ - `postTraining-examplesBulk-delete()` - Create bulk delete
99
+ - `postTraining-examplesSearch()` - Create search
100
+ - `patchTraining-examplesById()` - Update training examples
101
+ - `deleteTraining-examplesById()` - Delete training examples
102
+ - `deleteTraining-sessionsById()` - Delete training sessions
103
+
104
+ ## Analytics
105
+
106
+ - `getLlmAnalytics()` - List llm analytics
107
+ - `getLlmAnalyticsById()` - Get llm analytics
108
+ - `getLlmAnalyticsCosts()` - List costs
109
+ - `getLlmAnalyticsPlatform()` - List platform
110
+ - `getLlmAnalyticsSummary()` - List summary
111
+ - `getLlmAnalyticsUsage()` - List usage
112
+ - `getLlmAnalyticsWorkspace()` - List workspace
113
+ - `postLlmAnalytics()` - Create llm analytics
114
+
115
+ ## API Keys
116
+
117
+ - `getApi-keys()` - List api keys
118
+ - `getApi-keysActive()` - List active
119
+ - `getApi-keysById()` - Get api keys
120
+ - `getApi-keysStats()` - List stats
121
+ - `postApi-keys()` - Create api keys
122
+ - `patchApi-keysById()` - Update api keys
123
+ - `patchApi-keysByIdAllocate()` - Update allocate
124
+ - `patchApi-keysByIdReset-period()` - Update reset period
125
+ - `patchApi-keysByIdRevoke()` - Update revoke
126
+ - `patchApi-keysByIdRotate()` - Update rotate
127
+ - `patchApi-keysByIdSet-budget()` - Update set budget
128
+ - `deleteApi-keysById()` - Delete api keys
129
+
130
+ ## Applications
131
+
132
+ - `getApplications()` - List applications
133
+ - `getApplicationsBy-slugBySlug()` - Get by slug
134
+ - `getApplicationsById()` - Get applications
135
+ - `getApplicationsCurrent()` - List current
136
+ - `postApplications()` - Create applications
137
+ - `patchApplicationsById()` - Update applications
138
+ - `patchApplicationsByIdAllocate-credits()` - Update allocate credits
139
+ - `patchApplicationsByIdGrant-credits()` - Update grant credits
140
+ - `deleteApplicationsById()` - Delete applications
141
+
142
+ ## Audit chain entry
143
+
144
+ - `getAudit-chain-entries()` - List audit chain entries
145
+ - `getAudit-chain-entriesById()` - Get audit chain entries
146
+
147
+ ## Audit-log
148
+
149
+ - `getAudit-logs()` - List audit logs
150
+ - `getAudit-logsActivity()` - List activity
151
+
152
+ ## Billing
153
+
154
+ - `getCredit-packages()` - List credit packages
155
+ - `getCredit-packagesById()` - Get credit packages
156
+ - `getCredit-packagesSlugBySlug()` - Get slug
157
+ - `getPlans()` - List plans
158
+ - `getPlansById()` - Get plans
159
+ - `getPlansSlugBySlug()` - Get slug
160
+ - `getWallet()` - List wallet
161
+ - `getWalletPlanPreview()` - List preview
162
+ - `postPayments()` - Create payments
163
+ - `patchWalletAddons()` - Update addons
164
+ - `patchWalletAddonsByAddonSlugCancel()` - Update cancel
165
+ - `patchWalletAuto-top-up()` - Update auto top up
166
+ - `patchWalletCredits()` - Update credits
167
+ - `patchWalletPlan()` - Update plan
168
+
169
+ ## Breach incident
170
+
171
+ - `getBreach-incidents()` - List breach incidents
172
+ - `getBreach-incidentsById()` - Get breach incidents
173
+ - `postBreach-incidents()` - Create breach incidents
174
+ - `patchBreach-incidentsByIdStatus()` - Update status
175
+
176
+ ## Breach notification
177
+
178
+ - `getBreach-notifications()` - List breach notifications
179
+ - `getBreach-notificationsById()` - Get breach notifications
180
+
181
+ ## Bulk dismissal result
182
+
183
+ - `postWorkspacesByWorkspaceIdExtractionDocumentsDismiss-all-trained()` - Create dismiss all trained
184
+
185
+ ## Bulk reprocess result
186
+
187
+ - `postExtractionDocumentsBulk-reprocess()` - Create bulk reprocess
188
+
189
+ ## Catalog option type
190
+
191
+ - `getCatalogOption-typesApplicationByApplicationId()` - Get application
192
+ - `getCatalogOption-typesById()` - Get option types
193
+ - `postCatalogOption-types()` - Create option types
194
+ - `patchCatalogOption-typesById()` - Update option types
195
+ - `deleteCatalogOption-typesById()` - Delete option types
196
+
197
+ ## Catalog option value
198
+
199
+ - `getCatalogOption-valuesById()` - Get option values
200
+ - `getCatalogOption-valuesOption-typeByOptionTypeId()` - Get option type
201
+ - `postCatalogOption-values()` - Create option values
202
+ - `patchCatalogOption-valuesById()` - Update option values
203
+ - `deleteCatalogOption-valuesById()` - Delete option values
204
+
205
+ ## Catalog price list
206
+
207
+ - `getCatalogPrice-listsApplicationByApplicationId()` - Get application
208
+ - `getCatalogPrice-listsById()` - Get price lists
209
+ - `postCatalogPrice-lists()` - Create price lists
210
+ - `patchCatalogPrice-listsById()` - Update price lists
211
+ - `deleteCatalogPrice-listsById()` - Delete price lists
212
+
213
+ ## Catalog price list entry
214
+
215
+ - `getCatalogPrice-list-entriesPrice-listByPriceListId()` - Get price list
216
+ - `postCatalogPrice-list-entries()` - Create price list entries
217
+ - `patchCatalogPrice-list-entriesById()` - Update price list entries
218
+ - `deleteCatalogPrice-list-entriesById()` - Delete price list entries
219
+
220
+ ## Catalog product
221
+
222
+ - `getCatalogProductsById()` - Get products
223
+ - `getCatalogProductsWorkspaceByWorkspaceId()` - Get workspace
224
+ - `postCatalogProducts()` - Create products
225
+ - `patchCatalogProductsById()` - Update products
226
+ - `deleteCatalogProductsById()` - Delete products
227
+
228
+ ## Catalog product variant
229
+
230
+ - `getCatalogProduct-variantsById()` - Get product variants
231
+ - `getCatalogProduct-variantsProductByProductId()` - Get product
232
+ - `postCatalogProduct-variants()` - Create product variants
233
+ - `patchCatalogProduct-variantsById()` - Update product variants
234
+ - `deleteCatalogProduct-variantsById()` - Delete product variants
235
+
236
+ ## Catalog taxonomy
237
+
238
+ - `getCatalogTaxonomiesApplicationByApplicationId()` - Get application
239
+ - `getCatalogTaxonomiesById()` - Get taxonomies
240
+ - `postCatalogTaxonomies()` - Create taxonomies
241
+ - `patchCatalogTaxonomiesById()` - Update taxonomies
242
+ - `deleteCatalogTaxonomiesById()` - Delete taxonomies
243
+
244
+ ## Catalog taxonomy node
245
+
246
+ - `getCatalogTaxonomy-nodesById()` - Get taxonomy nodes
247
+ - `getCatalogTaxonomy-nodesTaxonomyByTaxonomyId()` - Get taxonomy
248
+ - `postCatalogTaxonomy-nodes()` - Create taxonomy nodes
249
+ - `patchCatalogTaxonomy-nodesById()` - Update taxonomy nodes
250
+ - `deleteCatalogTaxonomy-nodesById()` - Delete taxonomy nodes
251
+
252
+ ## Catalog view
253
+
254
+ - `getCatalogViewsById()` - Get views
255
+ - `getCatalogViewsWorkspaceByWorkspaceId()` - Get workspace
256
+ - `postCatalogViews()` - Create views
257
+ - `patchCatalogViewsById()` - Update views
258
+ - `deleteCatalogViewsById()` - Delete views
259
+
260
+ ## Config
261
+
262
+ - `getConfigs()` - List configs
263
+ - `postConfigs()` - Create configs
264
+ - `patchConfigsByKey()` - Update configs
265
+
266
+ ## Consent record
267
+
268
+ - `getConsent-records()` - List consent records
269
+ - `getConsent-recordsActive()` - List active
270
+ - `getConsent-recordsById()` - Get consent records
271
+ - `postConsent-records()` - Create consent records
272
+ - `patchConsent-recordsByIdWithdraw()` - Update withdraw
273
+
274
+ ## Conversations
275
+
276
+ - `getAiConversations()` - List conversations
277
+ - `getAiConversationsById()` - Get conversations
278
+ - `postAiConversations()` - Create conversations
279
+ - `patchAiConversationsById()` - Update conversations
280
+ - `deleteAiConversationsById()` - Delete conversations
281
+
282
+ ## Crawler job
283
+
284
+ - `getCrawlerJobs()` - List jobs
285
+ - `getCrawlerJobsById()` - Get jobs
286
+ - `postCrawlerJobs()` - Create jobs
287
+ - `patchCrawlerJobsByIdCancel()` - Update cancel
288
+ - `deleteCrawlerJobsById()` - Delete jobs
289
+
290
+ ## Crawler result
291
+
292
+ - `getCrawlerResults()` - List results
293
+ - `getCrawlerResultsById()` - Get results
294
+
295
+ ## Crawler schedule
296
+
297
+ - `getCrawlerSchedules()` - List schedules
298
+ - `getCrawlerSchedulesById()` - Get schedules
299
+ - `postCrawlerSchedules()` - Create schedules
300
+ - `patchCrawlerSchedulesById()` - Update schedules
301
+ - `patchCrawlerSchedulesByIdDisable()` - Update disable
302
+ - `patchCrawlerSchedulesByIdEnable()` - Update enable
303
+ - `patchCrawlerSchedulesByIdTrigger()` - Update trigger
304
+ - `deleteCrawlerSchedulesById()` - Delete schedules
305
+
306
+ ## Crm activity
307
+
308
+ - `getCrmActivitiesById()` - Get activities
309
+ - `getCrmActivitiesWorkspaceByWorkspaceId()` - Get workspace
310
+ - `postCrmActivities()` - Create activities
311
+ - `deleteCrmActivitiesById()` - Delete activities
312
+
313
+ ## Crm company
314
+
315
+ - `getCrmCompaniesById()` - Get companies
316
+ - `getCrmCompaniesWorkspaceByWorkspaceId()` - Get workspace
317
+ - `postCrmCompanies()` - Create companies
318
+ - `patchCrmCompaniesById()` - Update companies
319
+ - `deleteCrmCompaniesById()` - Delete companies
320
+
321
+ ## Crm contact
322
+
323
+ - `getCrmContactsById()` - Get contacts
324
+ - `getCrmContactsWorkspaceByWorkspaceId()` - Get workspace
325
+ - `postCrmContacts()` - Create contacts
326
+ - `patchCrmContactsById()` - Update contacts
327
+ - `deleteCrmContactsById()` - Delete contacts
328
+
329
+ ## Crm custom entity
330
+
331
+ - `getCrmCustom-entitiesById()` - Get custom entities
332
+ - `getCrmCustom-entitiesWorkspaceByWorkspaceId()` - Get workspace
333
+ - `postCrmCustom-entities()` - Create custom entities
334
+ - `patchCrmCustom-entitiesById()` - Update custom entities
335
+ - `deleteCrmCustom-entitiesById()` - Delete custom entities
336
+
337
+ ## Crm deal
338
+
339
+ - `getCrmDealsById()` - Get deals
340
+ - `getCrmDealsWorkspaceByWorkspaceId()` - Get workspace
341
+ - `postCrmDeals()` - Create deals
342
+ - `patchCrmDealsById()` - Update deals
343
+ - `deleteCrmDealsById()` - Delete deals
344
+
345
+ ## Crm pipeline
346
+
347
+ - `getCrmPipelinesById()` - Get pipelines
348
+ - `getCrmPipelinesWorkspaceByWorkspaceId()` - Get workspace
349
+ - `postCrmPipelines()` - Create pipelines
350
+ - `patchCrmPipelinesById()` - Update pipelines
351
+ - `deleteCrmPipelinesById()` - Delete pipelines
352
+
353
+ ## Crm pipeline stage
354
+
355
+ - `getCrmPipeline-stagesById()` - Get pipeline stages
356
+ - `postCrmPipeline-stages()` - Create pipeline stages
357
+ - `patchCrmPipeline-stagesById()` - Update pipeline stages
358
+ - `deleteCrmPipeline-stagesById()` - Delete pipeline stages
359
+
360
+ ## Crm relationship
361
+
362
+ - `getCrmRelationshipsById()` - Get relationships
363
+ - `getCrmRelationshipsWorkspaceByWorkspaceId()` - Get workspace
364
+ - `postCrmRelationships()` - Create relationships
365
+ - `deleteCrmRelationshipsById()` - Delete relationships
366
+
367
+ ## Crm relationship type
368
+
369
+ - `getCrmRelationship-types()` - List relationship types
370
+ - `getCrmRelationship-typesById()` - Get relationship types
371
+ - `postCrmRelationship-types()` - Create relationship types
372
+ - `patchCrmRelationship-typesById()` - Update relationship types
373
+ - `deleteCrmRelationship-typesById()` - Delete relationship types
374
+
375
+ ## Data protection impact assessment
376
+
377
+ - `getImpact-assessments()` - List impact assessments
378
+ - `getImpact-assessmentsById()` - Get impact assessments
379
+ - `postImpact-assessments()` - Create impact assessments
380
+ - `patchImpact-assessmentsById()` - Update impact assessments
381
+ - `patchImpact-assessmentsByIdApprove()` - Update approve
382
+
383
+ ## Data subject request
384
+
385
+ - `getData-subject-requests()` - List data subject requests
386
+ - `getData-subject-requestsById()` - Get data subject requests
387
+ - `postData-subject-requests()` - Create data subject requests
388
+ - `patchData-subject-requestsByIdStatus()` - Update status
389
+
390
+ ## Document chunk
391
+
392
+ - `getAiChunksDocumentByDocumentId()` - Get document
393
+ - `postAiChunksSearch()` - Create search
394
+
395
+ ## Document Extraction
396
+
397
+ - `getExtractionDocuments()` - List documents
398
+ - `getExtractionDocumentsById()` - Get documents
399
+ - `getExtractionDocumentsByIdStatus()` - Get status
400
+ - `getExtractionDocumentsByIdView()` - Get view
401
+ - `getExtractionDocumentsWorkspaceByWorkspaceId()` - Get workspace
402
+ - `getExtractionDocumentsWorkspaceByWorkspaceIdBy-statusByStatus()` - Get by status
403
+ - `getExtractionDocumentsWorkspaceByWorkspaceIdExcluded()` - Get excluded
404
+ - `getExtractionDocumentsWorkspaceByWorkspaceIdReview-queue()` - Get review queue
405
+ - `getExtractionDocumentsWorkspaceByWorkspaceIdTrained()` - Get trained
406
+ - `getExtractionDocumentsWorkspaceByWorkspaceIdTrashed()` - Get trashed
407
+ - `postExtractionDocumentsBegin-upload()` - Create begin upload
408
+ - `postExtractionDocumentsFind-or-begin-upload()` - Create find or begin upload
409
+ - `postExtractionDocumentsUpload()` - Create upload
410
+ - `patchExtractionDocumentsByIdCancel()` - Update cancel
411
+ - `patchExtractionDocumentsByIdDismiss()` - Update dismiss
412
+ - `patchExtractionDocumentsByIdDismiss-training()` - Update dismiss training
413
+ - `patchExtractionDocumentsByIdExclude()` - Update exclude
414
+ - `patchExtractionDocumentsByIdFinish-upload()` - Update finish upload
415
+ - `patchExtractionDocumentsByIdInclude()` - Update include
416
+ - `patchExtractionDocumentsByIdMark-trained()` - Update mark trained
417
+ - `patchExtractionDocumentsByIdReprocess()` - Update reprocess
418
+ - `patchExtractionDocumentsByIdRestore()` - Update restore
419
+ - `patchExtractionDocumentsByIdStatus()` - Update status
420
+ - `patchExtractionDocumentsByIdVerification()` - Update verification
421
+ - `deleteExtractionDocumentsById()` - Delete documents
422
+
423
+ ## Document stats
424
+
425
+ - `getDocumentsStats()` - List stats
426
+
427
+ ## Email template
428
+
429
+ - `getApplicationsByApplicationIdEmail-templates()` - Get email templates
430
+ - `getApplicationsByApplicationIdEmail-templatesBySlug()` - Get email templates
431
+ - `postApplicationsByApplicationIdEmail-templates()` - Create email templates
432
+ - `postApplicationsByApplicationIdEmail-templatesBySlugPreview()` - Create preview
433
+ - `postApplicationsByApplicationIdEmail-templatesBySlugTest()` - Create test
434
+ - `patchApplicationsByApplicationIdEmail-templatesBySlug()` - Update email templates
435
+ - `deleteApplicationsByApplicationIdEmail-templatesBySlug()` - Delete email templates
436
+
437
+ ## Email-marketing-campaign
438
+
439
+ - `getEmail-marketingCampaignsById()` - Get campaigns
440
+ - `getEmail-marketingCampaignsWorkspaceByWorkspaceId()` - Get workspace
441
+ - `postEmail-marketingCampaigns()` - Create campaigns
442
+ - `postEmail-marketingCampaignsByIdAnalyze()` - Create analyze
443
+ - `postEmail-marketingCampaignsByIdCreate-followup()` - Create create followup
444
+ - `postEmail-marketingCampaignsByIdExport()` - Create export
445
+ - `postEmail-marketingCampaignsByIdGenerate-emails()` - Create generate emails
446
+ - `postEmail-marketingCampaignsByIdImport-recipients()` - Create import recipients
447
+ - `postEmail-marketingCampaignsByIdOptimize-send-times()` - Create optimize send times
448
+ - `postEmail-marketingCampaignsByIdOptimize-subjects()` - Create optimize subjects
449
+ - `postEmail-marketingCampaignsByIdSend()` - Create send
450
+ - `patchEmail-marketingCampaignsById()` - Update campaigns
451
+ - `deleteEmail-marketingCampaignsById()` - Delete campaigns
452
+
453
+ ## Email-marketing-generated-email
454
+
455
+ - `getEmail-marketingGenerated-emailsById()` - Get generated emails
456
+ - `getEmail-marketingGenerated-emailsCampaignByCampaignId()` - Get campaign
457
+ - `patchEmail-marketingGenerated-emailsById()` - Update generated emails
458
+ - `patchEmail-marketingGenerated-emailsByIdApprove()` - Update approve
459
+ - `patchEmail-marketingGenerated-emailsByIdReject()` - Update reject
460
+ - `patchEmail-marketingGenerated-emailsByIdSchedule()` - Update schedule
461
+
462
+ ## Email-marketing-recipient
463
+
464
+ - `getEmail-marketingRecipientsById()` - Get recipients
465
+ - `getEmail-marketingRecipientsCampaignByCampaignId()` - Get campaign
466
+
467
+ ## Email-marketing-send-limit
468
+
469
+ - `getEmail-marketingSend-limitsById()` - Get send limits
470
+ - `getEmail-marketingSend-limitsWorkspaceByWorkspaceId()` - Get workspace
471
+
472
+ ## Email-marketing-sender-profile
473
+
474
+ - `getEmail-marketingSender-profilesById()` - Get sender profiles
475
+ - `getEmail-marketingSender-profilesWorkspaceByWorkspaceId()` - Get workspace
476
+ - `postEmail-marketingSender-profiles()` - Create sender profiles
477
+ - `patchEmail-marketingSender-profilesById()` - Update sender profiles
478
+ - `patchEmail-marketingSender-profilesByIdValidate-dns()` - Update validate dns
479
+ - `deleteEmail-marketingSender-profilesById()` - Delete sender profiles
480
+
481
+ ## Email-marketing-sequence
482
+
483
+ - `getEmail-marketingSequencesById()` - Get sequences
484
+ - `getEmail-marketingSequencesWorkspaceByWorkspaceId()` - Get workspace
485
+ - `postEmail-marketingSequences()` - Create sequences
486
+ - `patchEmail-marketingSequencesById()` - Update sequences
487
+ - `patchEmail-marketingSequencesByIdActivate()` - Update activate
488
+ - `patchEmail-marketingSequencesByIdComplete()` - Update complete
489
+ - `patchEmail-marketingSequencesByIdPause()` - Update pause
490
+ - `patchEmail-marketingSequencesByIdResume()` - Update resume
491
+ - `deleteEmail-marketingSequencesById()` - Delete sequences
492
+
493
+ ## Email-marketing-sequence-step
494
+
495
+ - `getEmail-marketingSequence-stepsById()` - Get sequence steps
496
+ - `getEmail-marketingSequence-stepsSequenceBySequenceId()` - Get sequence
497
+ - `postEmail-marketingSequence-steps()` - Create sequence steps
498
+ - `patchEmail-marketingSequence-stepsById()` - Update sequence steps
499
+ - `deleteEmail-marketingSequence-stepsById()` - Delete sequence steps
500
+
501
+ ## Email-marketing-template
502
+
503
+ - `getEmail-marketingTemplatesById()` - Get templates
504
+ - `getEmail-marketingTemplatesWorkspaceByWorkspaceId()` - Get workspace
505
+ - `postEmail-marketingTemplates()` - Create templates
506
+ - `patchEmail-marketingTemplatesById()` - Update templates
507
+ - `patchEmail-marketingTemplatesByIdArchive()` - Update archive
508
+ - `patchEmail-marketingTemplatesByIdRestore()` - Update restore
509
+ - `deleteEmail-marketingTemplatesById()` - Delete templates
510
+
511
+ ## Email-marketing-tracking-event
512
+
513
+ - `getEmail-marketingTracking-eventsById()` - Get tracking events
514
+ - `getEmail-marketingTracking-eventsCampaignByCampaignId()` - Get campaign
515
+
516
+ ## Embedding
517
+
518
+ - `postAiEmbed()` - Create embed
519
+
520
+ ## Extraction Batches
521
+
522
+ - `getExtractionBatchesById()` - Get batches
523
+ - `getExtractionBatchesByIdUpload-urls()` - Get upload urls
524
+ - `getExtractionBatchesWorkspaceByWorkspaceId()` - Get workspace
525
+ - `postExtractionBatches()` - Create batches
526
+ - `deleteExtractionBatchesById()` - Delete batches
527
+
528
+ ## Extraction export
529
+
530
+ - `getWorkspacesByWorkspaceIdExtractionExports()` - Get exports
531
+ - `getWorkspacesByWorkspaceIdExtractionExportsById()` - Get exports
532
+ - `postWorkspacesByWorkspaceIdExtractionExports()` - Create exports
533
+
534
+ ## Extraction Results
535
+
536
+ - `getExtractionResults()` - List results
537
+ - `getExtractionResultsById()` - Get results
538
+ - `getExtractionResultsDocumentByDocumentId()` - Get document
539
+ - `getExtractionResultsDocumentByDocumentIdHistory()` - Get history
540
+ - `getExtractionResultsWorkspaceByWorkspaceId()` - Get workspace
541
+ - `patchExtractionResultsById()` - Update results
542
+ - `patchExtractionResultsByIdRegenerate()` - Update regenerate
543
+ - `patchExtractionResultsByIdSave-corrections()` - Update save corrections
544
+ - `deleteExtractionResultsById()` - Delete results
545
+
546
+ ## Field mapping confirmation
547
+
548
+ - `postWorkspacesByWorkspaceIdExtractionByDocumentIdMapping()` - Create mapping
549
+
550
+ ## Field mapping result
551
+
552
+ - `getWorkspacesByWorkspaceIdExtractionByDocumentIdMapping()` - Get mapping
553
+
554
+ ## Field Templates
555
+
556
+ - `getField-templates()` - List field templates
557
+ - `getField-templatesById()` - Get field templates
558
+ - `postField-templates()` - Create field templates
559
+ - `deleteField-templatesById()` - Delete field templates
560
+
561
+ ## Invitations
562
+
563
+ - `getInvitations()` - List invitations
564
+ - `getInvitationsConsumeByToken()` - Get consume
565
+ - `getInvitationsMe()` - List me
566
+ - `postInvitations()` - Create invitations
567
+ - `postInvitationsAccept-by-token()` - Create accept by token
568
+ - `patchInvitationsByIdAccept()` - Update accept
569
+ - `patchInvitationsByIdAccept-by-user()` - Update accept by user
570
+ - `patchInvitationsByIdDecline()` - Update decline
571
+ - `patchInvitationsByIdResend()` - Update resend
572
+ - `patchInvitationsByIdRevoke()` - Update revoke
573
+
574
+ ## Invoice
575
+
576
+ - `getWalletInvoices()` - List invoices
577
+
578
+ ## Knowledge Graph
579
+
580
+ - `getAiGraphNodes()` - List nodes
581
+ - `getAiGraphNodesLabelByLabel()` - Get label
582
+ - `postAiGraphNodes()` - Create nodes
583
+ - `deleteAiGraphNodesById()` - Delete nodes
584
+
585
+ ## Legal acceptance
586
+
587
+ - `getLegal-acceptances()` - List legal acceptances
588
+ - `getLegal-acceptancesById()` - Get legal acceptances
589
+ - `getLegal-acceptancesLatest()` - List latest
590
+
591
+ ## Legal document
592
+
593
+ - `getLegal-documents()` - List legal documents
594
+ - `getLegal-documentsBy-locale()` - List by locale
595
+ - `getLegal-documentsById()` - Get legal documents
596
+ - `getLegal-documentsFor-application()` - List for application
597
+ - `postLegal-documents()` - Create legal documents
598
+ - `patchLegal-documentsById()` - Update legal documents
599
+ - `patchLegal-documentsByIdPublish()` - Update publish
600
+ - `patchLegal-documentsByIdUnpublish()` - Update unpublish
601
+ - `deleteLegal-documentsById()` - Delete legal documents
602
+
603
+ ## Messages
604
+
605
+ - `getAiMessages()` - List messages
606
+ - `getMessages()` - List messages
607
+ - `getMessagesById()` - Get messages
608
+ - `getMessagesSearch()` - List search
609
+ - `getMessagesSemantic-search()` - List semantic search
610
+ - `getThreadsByIdMessages()` - Get messages
611
+ - `postAiMessages()` - Create messages
612
+ - `postMessages()` - Create messages
613
+ - `patchMessagesById()` - Update messages
614
+ - `deleteAiMessagesById()` - Delete messages
615
+ - `deleteMessagesById()` - Delete messages
616
+
617
+ ## Notification log
618
+
619
+ - `getNotification-logs()` - List notification logs
620
+ - `getNotification-logsById()` - Get notification logs
621
+ - `getNotification-logsStats()` - List stats
622
+
623
+ ## Notification method
624
+
625
+ - `getNotification-methods()` - List notification methods
626
+ - `getNotification-methodsById()` - Get notification methods
627
+ - `postNotification-methods()` - Create notification methods
628
+ - `patchNotification-methodsById()` - Update notification methods
629
+ - `patchNotification-methodsByIdSend-verification()` - Update send verification
630
+ - `patchNotification-methodsByIdSet-primary()` - Update set primary
631
+ - `patchNotification-methodsByIdVerify()` - Update verify
632
+ - `deleteNotification-methodsById()` - Delete notification methods
633
+
634
+ ## Notification preference
635
+
636
+ - `getNotification-preferences()` - List notification preferences
637
+ - `getNotification-preferencesById()` - Get notification preferences
638
+ - `postNotification-preferences()` - Create notification preferences
639
+ - `patchNotification-preferencesById()` - Update notification preferences
640
+ - `deleteNotification-preferencesById()` - Delete notification preferences
641
+
642
+ ## Operation success
643
+
644
+ - `postDocumentsBulk-delete()` - Create bulk delete
645
+
646
+ ## Payment method
647
+
648
+ - `getPayment-methods()` - List payment methods
649
+ - `getPayment-methodsById()` - Get payment methods
650
+ - `postPayment-methods()` - Create payment methods
651
+ - `postPayment-methodsTokenize()` - Create tokenize
652
+ - `patchPayment-methodsById()` - Update payment methods
653
+ - `patchPayment-methodsByIdDefault()` - Update default
654
+ - `deletePayment-methodsById()` - Delete payment methods
655
+
656
+ ## Permission
657
+
658
+ - `getPermissions()` - List permissions
659
+ - `getPermissionsById()` - Get permissions
660
+ - `getPermissionsPresets()` - List presets
661
+
662
+ ## Permission meta
663
+
664
+ - `getPermissionsMeta()` - List meta
665
+
666
+ ## Permission preset
667
+
668
+ - `getPermissionsPresetsById()` - Get presets
669
+
670
+ ## Presigned url
671
+
672
+ - `postDocumentsPresigned-upload()` - Create presigned upload
673
+ - `postStorageSign-download()` - Create sign download
674
+ - `postStorageSign-upload()` - Create sign upload
675
+
676
+ ## Processing activity
677
+
678
+ - `getProcessing-activities()` - List processing activities
679
+ - `getProcessing-activitiesById()` - Get processing activities
680
+ - `postProcessing-activities()` - Create processing activities
681
+ - `deleteProcessing-activitiesById()` - Delete processing activities
682
+
683
+ ## Retention policy
684
+
685
+ - `getRetention-policies()` - List retention policies
686
+ - `getRetention-policiesById()` - Get retention policies
687
+ - `postRetention-policies()` - Create retention policies
688
+ - `patchRetention-policiesById()` - Update retention policies
689
+ - `deleteRetention-policiesById()` - Delete retention policies
690
+
691
+ ## Role
692
+
693
+ - `getRoles()` - List roles
694
+ - `postRoles()` - Create roles
695
+ - `patchRolesById()` - Update roles
696
+ - `deleteRolesById()` - Delete roles
697
+
698
+ ## Scan result
699
+
700
+ - `getScan-results()` - List scan results
701
+ - `getScan-resultsById()` - Get scan results
702
+
703
+ ## Scheduling booking
704
+
705
+ - `getSchedulingBookings()` - List bookings
706
+ - `getSchedulingBookingsById()` - Get bookings
707
+ - `postSchedulingBookings()` - Create bookings
708
+ - `patchSchedulingBookingsSchedulingBookingsByIdCancel()` - Update cancel
709
+ - `patchSchedulingBookingsSchedulingBookingsByIdConfirm()` - Update confirm
710
+ - `patchSchedulingBookingsSchedulingBookingsByIdReschedule()` - Update reschedule
711
+
712
+ ## Scheduling calendar sync
713
+
714
+ - `getSchedulingCalendar-syncs()` - List calendar syncs
715
+ - `getSchedulingCalendar-syncsById()` - Get calendar syncs
716
+ - `postSchedulingCalendar-syncs()` - Create calendar syncs
717
+ - `patchSchedulingCalendar-syncsSchedulingCalendar-syncsById()` - Update calendar syncs
718
+ - `patchSchedulingCalendar-syncsSchedulingCalendar-syncsByIdPause()` - Update pause
719
+ - `patchSchedulingCalendar-syncsSchedulingCalendar-syncsByIdResume()` - Update resume
720
+ - `deleteSchedulingCalendar-syncsSchedulingCalendar-syncsById()` - Delete calendar syncs
721
+
722
+ ## Scheduling event
723
+
724
+ - `getSchedulingEvents()` - List events
725
+ - `getSchedulingEventsById()` - Get events
726
+ - `postSchedulingEvents()` - Create events
727
+ - `patchSchedulingEventsById()` - Update events
728
+
729
+ ## Scheduling event type
730
+
731
+ - `getSchedulingEvent-types()` - List event types
732
+ - `getSchedulingEvent-typesById()` - Get event types
733
+ - `postSchedulingEvent-types()` - Create event types
734
+ - `patchSchedulingEvent-typesById()` - Update event types
735
+
736
+ ## Scheduling participant
737
+
738
+ - `getSchedulingParticipants()` - List participants
739
+ - `getSchedulingParticipantsById()` - Get participants
740
+ - `postSchedulingParticipants()` - Create participants
741
+ - `patchSchedulingParticipantsById()` - Update participants
742
+
743
+ ## Schema discovery
744
+
745
+ - `getExtractionSchema-discoveriesById()` - Get schema discoveries
746
+ - `postExtractionSchema-discoveries()` - Create schema discoveries
747
+ - `postExtractionSchema-discoveriesBootstrap()` - Create bootstrap
748
+
749
+ ## Search
750
+
751
+ - `getSearch()` - List search
752
+ - `getSearchHealth()` - List health
753
+ - `getSearchIndexes()` - List indexes
754
+ - `getSearchSaved()` - List saved
755
+ - `getSearchSemantic()` - List semantic
756
+ - `getSearchStats()` - List stats
757
+ - `getSearchStatus()` - List status
758
+ - `getSearchSuggest()` - List suggest
759
+ - `postAiSearch()` - Create search
760
+ - `postAiSearchAdvanced()` - Create advanced
761
+ - `postSearchBatch()` - Create batch
762
+ - `postSearchReindex()` - Create reindex
763
+ - `postSearchSaved()` - Create saved
764
+ - `postSearchSavedByIdRun()` - Create run
765
+ - `patchSearchSavedById()` - Update saved
766
+ - `deleteSearchSavedById()` - Delete saved
767
+
768
+ ## Search analytics
769
+
770
+ - `getSearchAnalytics()` - List analytics
771
+ - `getSearchAnalyticsSummary()` - List summary
772
+
773
+ ## Storage
774
+
775
+ - `getBuckets()` - List buckets
776
+ - `getBucketsAll()` - List all
777
+ - `getBucketsById()` - Get buckets
778
+ - `getBucketsByIdObjects()` - Get objects
779
+ - `getBucketsByIdStats()` - Get stats
780
+ - `getObjects()` - List objects
781
+ - `getObjectsById()` - Get objects
782
+ - `postBuckets()` - Create buckets
783
+ - `postObjectsBulk-destroy()` - Create bulk destroy
784
+ - `postObjectsCopy()` - Create copy
785
+ - `postObjectsMove()` - Create move
786
+ - `postObjectsRegister()` - Create register
787
+ - `patchBucketsById()` - Update buckets
788
+ - `deleteBucketsById()` - Delete buckets
789
+ - `deleteObjectsById()` - Delete objects
790
+
791
+ ## Tenant document stats
792
+
793
+ - `getTenantsByTenantIdDocumentStats()` - Get document stats
794
+
795
+ ## Tenant stats
796
+
797
+ - `getTenantsByTenantIdStats()` - Get stats
798
+
799
+ ## Tenant-membership
800
+
801
+ - `getTenant-memberships()` - List tenant memberships
802
+ - `postTenant-memberships()` - Create tenant memberships
803
+ - `patchTenant-membershipsByTenantIdByUserId()` - Update tenant memberships
804
+ - `deleteTenant-membershipsByTenantIdByUserId()` - Delete tenant memberships
805
+
806
+ ## Tenants
807
+
808
+ - `getTenants()` - List tenants
809
+ - `getTenantsById()` - Get tenants
810
+ - `postTenants()` - Create tenants
811
+ - `postTenantsByIdBuy-storage()` - Create buy storage
812
+ - `postTenantsByIdCredit()` - Create credit
813
+ - `postTenantsByIdRemove-storage()` - Create remove storage
814
+ - `postTenantsByIdSchedule-purge()` - Create schedule purge
815
+ - `postTenantsIsv()` - Create isv
816
+ - `patchTenantsById()` - Update tenants
817
+ - `deleteTenantsById()` - Delete tenants
818
+
819
+ ## Thread stats
820
+
821
+ - `getThreadsStats()` - List stats
822
+
823
+ ## Thread workspace stats
824
+
825
+ - `getThreadsWorkspace-stats()` - List workspace stats
826
+
827
+ ## Threads
828
+
829
+ - `getThreads()` - List threads
830
+ - `getThreadsById()` - Get threads
831
+ - `getThreadsSearch()` - List search
832
+ - `postThreads()` - Create threads
833
+ - `postThreadsActive()` - Create active
834
+ - `postThreadsByIdExport()` - Create export
835
+ - `postThreadsByIdFork()` - Create fork
836
+ - `postThreadsByIdMessages()` - Create messages
837
+ - `postThreadsByIdSummarize()` - Create summarize
838
+ - `patchThreadsById()` - Update threads
839
+ - `patchThreadsByIdArchive()` - Update archive
840
+ - `patchThreadsByIdUnarchive()` - Update unarchive
841
+ - `deleteThreadsById()` - Delete threads
842
+
843
+ ## Token
844
+
845
+ - `postTokens()` - Create tokens
846
+
847
+ ## Training analytics
848
+
849
+ - `getWorkspacesAnalytics-batch()` - List analytics batch
850
+ - `getWorkspacesByWorkspaceIdTrainingAnalytics()` - Get analytics
851
+
852
+ ## Transaction
853
+
854
+ - `getTransactions()` - List transactions
855
+ - `getTransactionsById()` - Get transactions
856
+
857
+ ## Users
858
+
859
+ - `getUser-profiles()` - List user profiles
860
+ - `getUser-profilesById()` - Get user profiles
861
+ - `getUser-profilesMe()` - List me
862
+ - `getUsers()` - List users
863
+ - `getUsersBy-email()` - List by email
864
+ - `getUsersById()` - Get users
865
+ - `getUsersMe()` - List me
866
+ - `getUsersMeActivity()` - List activity
867
+ - `getUsersMeDashboard()` - List dashboard
868
+ - `getUsersMeStats()` - List stats
869
+ - `getUsersMeTenants()` - List tenants
870
+ - `postUser-profiles()` - Create user profiles
871
+ - `postUsersAuthConfirm()` - Create confirm
872
+ - `postUsersAuthLogin()` - Create login
873
+ - `postUsersAuthMagic-linkLogin()` - Create login
874
+ - `postUsersAuthMagic-linkRequest()` - Create request
875
+ - `postUsersAuthRegister()` - Create register
876
+ - `postUsersAuthRegister-with-oidc()` - Create register with oidc
877
+ - `postUsersAuthResend-confirmation()` - Create resend confirmation
878
+ - `postUsersRegister-isv()` - Create register isv
879
+ - `patchUser-profilesById()` - Update user profiles
880
+ - `patchUser-profilesByIdAccept-tos()` - Update accept tos
881
+ - `patchUser-profilesByIdDismiss-announcement()` - Update dismiss announcement
882
+ - `patchUser-profilesByIdDismiss-welcome()` - Update dismiss welcome
883
+ - `patchUsersAuthPasswordChange()` - Update change
884
+ - `patchUsersAuthReset-password()` - Update reset password
885
+ - `patchUsersById()` - Update admin
886
+ - `patchUsersByIdConfirm-email()` - Update confirm email
887
+ - `patchUsersByIdEmail()` - Update email
888
+ - `patchUsersByIdReset-password()` - Update reset password
889
+ - `deleteUser-profilesById()` - Delete user profiles
890
+ - `deleteUsersById()` - Delete users
891
+
892
+ ## Voice session
893
+
894
+ - `getVoiceSessions()` - List sessions
895
+ - `getVoiceSessionsById()` - Get sessions
896
+ - `getVoiceSessionsMine()` - List mine
897
+ - `getVoiceSessionsWorkspaceByWorkspaceId()` - Get workspace
898
+
899
+ ## Watcher claim
900
+
901
+ - `getWatcherClaims()` - List claims
902
+ - `getWatcherClaimsById()` - Get claims
903
+ - `getWatcherClaimsHistory()` - List history
904
+ - `getWatcherClaimsStatus()` - List status
905
+ - `postWatcherClaims()` - Create claims
906
+ - `patchWatcherClaimsById()` - Update claims
907
+ - `patchWatcherClaimsByIdRelease()` - Update release
908
+ - `patchWatcherClaimsByIdRetry()` - Update retry
909
+
910
+ ## Watcher event
911
+
912
+ - `getWatcherEvents()` - List events
913
+ - `getWatcherEventsById()` - Get events
914
+ - `postWatcherEvents()` - Create events
915
+
916
+ ## Webhooks
917
+
918
+ - `getWebhook-configs()` - List webhook configs
919
+ - `getWebhook-configsById()` - Get webhook configs
920
+ - `getWebhook-configsByIdEvents()` - Get events
921
+ - `getWebhook-configsStats()` - List stats
922
+ - `getWebhook-deliveries()` - List webhook deliveries
923
+ - `getWebhook-deliveriesById()` - Get webhook deliveries
924
+ - `getWebhook-deliveriesStats()` - List stats
925
+ - `postWebhook-configs()` - Create webhook configs
926
+ - `postWebhook-configsBulk-disable()` - Create bulk disable
927
+ - `postWebhook-configsBulk-enable()` - Create bulk enable
928
+ - `postWebhook-configsByIdReplay()` - Create replay
929
+ - `postWebhook-configsByIdTest()` - Create test
930
+ - `postWebhook-deliveriesBulk-retry()` - Create bulk retry
931
+ - `postWebhook-deliveriesByIdRetry()` - Create retry
932
+ - `patchWebhook-configsById()` - Update webhook configs
933
+ - `patchWebhook-configsByIdRotate-secret()` - Update rotate secret
934
+ - `deleteWebhook-configsById()` - Delete webhook configs
935
+
936
+ ## Workspace document stats
937
+
938
+ - `getTenantsByTenantIdWorkspaceStats()` - Get workspace stats
939
+
940
+ ## Workspace-membership
941
+
942
+ - `getWorkspace-memberships()` - List workspace memberships
943
+ - `getWorkspace-membershipsInherited()` - List inherited
944
+ - `getWorkspacesByIdMembers()` - Get members
945
+ - `postWorkspace-memberships()` - Create workspace memberships
946
+ - `patchWorkspace-membershipsByWorkspaceIdByUserId()` - Update workspace memberships
947
+ - `deleteWorkspace-membershipsByWorkspaceIdByUserId()` - Delete workspace memberships
948
+
949
+ ## Workspaces
950
+
951
+ - `getWorkspaces()` - List workspaces
952
+ - `getWorkspacesById()` - Get workspaces
953
+ - `getWorkspacesMine()` - List mine
954
+ - `getWorkspacesShared()` - List shared
955
+ - `postWorkspaces()` - Create workspaces
956
+ - `patchWorkspacesById()` - Update workspaces
957
+ - `patchWorkspacesByIdAllocate()` - Update allocate
958
+ - `patchWorkspacesByIdPopulate-hashes()` - Update populate hashes
959
+ - `patchWorkspacesByIdStorage-settings()` - Update storage settings
960
+ - `deleteWorkspacesById()` - Delete workspaces
961
+
962
+ ## Error Handling
963
+
964
+ All functions return a Promise that resolves with `{ data, error, response }`.
965
+
966
+ ```typescript
967
+ const { data, error } = await getAgents();
968
+ if (error) {
969
+ console.error(error.status, error.detail);
970
+ } else {
971
+ console.log(data);
972
+ }
973
+ ```
974
+
975
+ ## Types
976
+
977
+ All types are exported:
978
+
979
+ ```typescript
980
+ import type { Agent, Workspace, Document } from '@gpt-platform/client';
981
+ ```