@gpt-platform/client 0.7.3 → 0.8.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/dist/index.d.mts +3499 -1545
- package/dist/index.d.ts +3499 -1545
- package/dist/index.js +3128 -1123
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +3128 -1123
- package/dist/index.mjs.map +1 -1
- package/llms.txt +154 -95
- package/package.json +1 -1
package/llms.txt
CHANGED
|
@@ -22,11 +22,6 @@ client.setConfig({
|
|
|
22
22
|
});
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
## Access log
|
|
26
|
-
|
|
27
|
-
- `getAccess-logs()` - /access-logs operation on access_log resource
|
|
28
|
-
- `getAccess-logsById()` - /access-logs/:id operation on access_log resource
|
|
29
|
-
|
|
30
25
|
## Access-grant
|
|
31
26
|
|
|
32
27
|
- `getAccess-grants()` - /access-grants operation on access-grant resource
|
|
@@ -35,6 +30,11 @@ client.setConfig({
|
|
|
35
30
|
- `patchAccess-grantsById()` - /access-grants/:id operation on access-grant resource
|
|
36
31
|
- `deleteAccess-grantsById()` - /access-grants/:id operation on access-grant resource
|
|
37
32
|
|
|
33
|
+
## Access-log
|
|
34
|
+
|
|
35
|
+
- `getAccess-logs()` - /access-logs operation on access-log resource
|
|
36
|
+
- `getAccess-logsById()` - /access-logs/:id operation on access-log resource
|
|
37
|
+
|
|
38
38
|
## Agent stats
|
|
39
39
|
|
|
40
40
|
- `getAgentsByIdStats()` - /agents/:id/stats operation on agent_stats resource
|
|
@@ -61,6 +61,15 @@ client.setConfig({
|
|
|
61
61
|
- `getAgent-version-revisions()` - /agent-version-revisions operation on agent_version_revision resource
|
|
62
62
|
- `getAgent-version-revisionsById()` - /agent-version-revisions/:id operation on agent_version_revision resource
|
|
63
63
|
|
|
64
|
+
## Agent-deployment
|
|
65
|
+
|
|
66
|
+
- `getAgent-deployments()` - /agent-deployments operation on agent-deployment resource
|
|
67
|
+
- `getAgent-deploymentsById()` - /agent-deployments/:id operation on agent-deployment resource
|
|
68
|
+
- `postAgent-deployments()` - /agent-deployments operation on agent-deployment resource
|
|
69
|
+
- `patchAgent-deploymentsById()` - /agent-deployments/:id operation on agent-deployment resource
|
|
70
|
+
- `patchAgent-deploymentsByIdAccept-update()` - Accept an available version update
|
|
71
|
+
- `deleteAgent-deploymentsById()` - /agent-deployments/:id operation on agent-deployment resource
|
|
72
|
+
|
|
64
73
|
## AI Agents
|
|
65
74
|
|
|
66
75
|
- `getAgent-versions()` - List AgentVersions, optionally filtered to a specific agent
|
|
@@ -160,10 +169,10 @@ flags, workspace mode, and execution limits
|
|
|
160
169
|
- `patchApplicationsByIdGrant-credits()` - Allocates promotional credits to a specific tenant on behalf of the application
|
|
161
170
|
- `deleteApplicationsById()` - Permanently delete an application and all associated data
|
|
162
171
|
|
|
163
|
-
## Audit
|
|
172
|
+
## Audit-chain-entry
|
|
164
173
|
|
|
165
|
-
- `getAudit-chain-entries()` - /audit-chain-entries operation on
|
|
166
|
-
- `getAudit-chain-entriesById()` - /audit-chain-entries/:id operation on
|
|
174
|
+
- `getAudit-chain-entries()` - /audit-chain-entries operation on audit-chain-entry resource
|
|
175
|
+
- `getAudit-chain-entriesById()` - /audit-chain-entries/:id operation on audit-chain-entry resource
|
|
167
176
|
|
|
168
177
|
## Audit-log
|
|
169
178
|
|
|
@@ -184,7 +193,9 @@ flags, workspace mode, and execution limits
|
|
|
184
193
|
- `patchWalletAddonsByAddonSlugCancel()` - Cancel an add-on for the wallet
|
|
185
194
|
- `patchWalletAuto-top-up()` - Update auto-top-up settings
|
|
186
195
|
- `patchWalletCredits()` - Purchase credits (Top-up)
|
|
196
|
+
- `patchWalletPaymentRetry()` - Retry a failed subscription payment
|
|
187
197
|
- `patchWalletPlan()` - Change the main plan for the wallet
|
|
198
|
+
- `patchWalletPlanCancel()` - Cancel the current subscription plan
|
|
188
199
|
|
|
189
200
|
## Brand identity
|
|
190
201
|
|
|
@@ -200,17 +211,17 @@ flags, workspace mode, and execution limits
|
|
|
200
211
|
- `patchBrand-identitiesByIdUnset-default()` - /brand-identities/:id/unset-default operation on brand_identity resource
|
|
201
212
|
- `deleteBrand-identitiesById()` - /brand-identities/:id operation on brand_identity resource
|
|
202
213
|
|
|
203
|
-
## Breach
|
|
214
|
+
## Breach-incident
|
|
204
215
|
|
|
205
|
-
- `getBreach-incidents()` - /breach-incidents operation on
|
|
206
|
-
- `getBreach-incidentsById()` - /breach-incidents/:id operation on
|
|
216
|
+
- `getBreach-incidents()` - /breach-incidents operation on breach-incident resource
|
|
217
|
+
- `getBreach-incidentsById()` - /breach-incidents/:id operation on breach-incident resource
|
|
207
218
|
- `postBreach-incidents()` - Report a new data breach or security incident
|
|
208
219
|
- `patchBreach-incidentsByIdStatus()` - Advance a breach incident through its lifecycle (identified → investigating → notifying → resolved / false_positive) and record officer notification and remediation notes.
|
|
209
220
|
|
|
210
|
-
## Breach
|
|
221
|
+
## Breach-notification
|
|
211
222
|
|
|
212
|
-
- `getBreach-notifications()` - /breach-notifications operation on
|
|
213
|
-
- `getBreach-notificationsById()` - /breach-notifications/:id operation on
|
|
223
|
+
- `getBreach-notifications()` - /breach-notifications operation on breach-notification resource
|
|
224
|
+
- `getBreach-notificationsById()` - /breach-notifications/:id operation on breach-notification resource
|
|
214
225
|
|
|
215
226
|
## Breach-notification-artifact
|
|
216
227
|
|
|
@@ -324,6 +335,13 @@ flags, workspace mode, and execution limits
|
|
|
324
335
|
- `patchCatalogViewsById()` - Update view metadata, filtering rules, or pricing association
|
|
325
336
|
- `deleteCatalogViewsById()` - Permanently delete a catalog view and its rules and overrides
|
|
326
337
|
|
|
338
|
+
## Cde-scope-report
|
|
339
|
+
|
|
340
|
+
- `getCde-scope-reports()` - /cde-scope-reports operation on cde-scope-report resource
|
|
341
|
+
- `getCde-scope-reportsById()` - /cde-scope-reports/:id operation on cde-scope-report resource
|
|
342
|
+
- `postCde-scope-reports()` - Generate a PCI-DSS Cardholder Data Environment scope report for a workspace, classifying it as in-scope, out-of-scope, or connected based on ScanResult data
|
|
343
|
+
- `deleteCde-scope-reportsById()` - /cde-scope-reports/:id operation on cde-scope-report resource
|
|
344
|
+
|
|
327
345
|
## Clinical-client-goal
|
|
328
346
|
|
|
329
347
|
- `getClinicalClient-goals()` - /clinical/client-goals operation on clinical-client-goal resource
|
|
@@ -358,6 +376,26 @@ flags, workspace mode, and execution limits
|
|
|
358
376
|
- `postClinicalDeliveries()` - /clinical/deliveries operation on clinical-delivery resource
|
|
359
377
|
- `patchClinicalDeliveriesById()` - /clinical/deliveries/:id operation on clinical-delivery resource
|
|
360
378
|
|
|
379
|
+
## Clinical-goal-template
|
|
380
|
+
|
|
381
|
+
- `getClinicalGoal-templates()` - /clinical/goal-templates operation on clinical-goal-template resource
|
|
382
|
+
- `getClinicalGoal-templatesById()` - /clinical/goal-templates/:id operation on clinical-goal-template resource
|
|
383
|
+
- `getClinicalGoal-templatesCatalog()` - /clinical/goal-templates/catalog operation on clinical-goal-template resource
|
|
384
|
+
- `getClinicalGoal-templatesCatalogById()` - /clinical/goal-templates/catalog/:id operation on clinical-goal-template resource
|
|
385
|
+
- `getClinicalGoal-templatesMine()` - /clinical/goal-templates/mine operation on clinical-goal-template resource
|
|
386
|
+
- `postClinicalGoal-templates()` - /clinical/goal-templates operation on clinical-goal-template resource
|
|
387
|
+
- `postClinicalGoal-templatesCatalog()` - /clinical/goal-templates/catalog operation on clinical-goal-template resource
|
|
388
|
+
- `postClinicalGoal-templatesFrom-existing()` - /clinical/goal-templates/from-existing operation on clinical-goal-template resource
|
|
389
|
+
- `patchClinicalGoal-templatesById()` - /clinical/goal-templates/:id operation on clinical-goal-template resource
|
|
390
|
+
- `patchClinicalGoal-templatesCatalogById()` - /clinical/goal-templates/catalog/:id operation on clinical-goal-template resource
|
|
391
|
+
- `deleteClinicalGoal-templatesById()` - /clinical/goal-templates/:id operation on clinical-goal-template resource
|
|
392
|
+
- `deleteClinicalGoal-templatesCatalogById()` - /clinical/goal-templates/catalog/:id operation on clinical-goal-template resource
|
|
393
|
+
|
|
394
|
+
## Clinical-goal-template-category
|
|
395
|
+
|
|
396
|
+
- `getClinicalGoal-templatesCategories()` - /clinical/goal-templates/categories operation on clinical-goal-template-category resource
|
|
397
|
+
- `getClinicalGoal-templatesCategoriesCatalog()` - /clinical/goal-templates/categories/catalog operation on clinical-goal-template-category resource
|
|
398
|
+
|
|
361
399
|
## Clinical-health-metric
|
|
362
400
|
|
|
363
401
|
- `getClinicalHealth-metrics()` - /clinical/health-metrics operation on clinical-health-metric resource
|
|
@@ -404,17 +442,32 @@ flags, workspace mode, and execution limits
|
|
|
404
442
|
|
|
405
443
|
- `getClinicalPractice-resources()` - /clinical/practice-resources operation on clinical-practice-resource resource
|
|
406
444
|
- `getClinicalPractice-resourcesById()` - /clinical/practice-resources/:id operation on clinical-practice-resource resource
|
|
445
|
+
- `getClinicalPractice-resourcesCatalog()` - /clinical/practice-resources/catalog operation on clinical-practice-resource resource
|
|
446
|
+
- `getClinicalPractice-resourcesCatalogById()` - /clinical/practice-resources/catalog/:id operation on clinical-practice-resource resource
|
|
407
447
|
- `postClinicalPractice-resources()` - /clinical/practice-resources operation on clinical-practice-resource resource
|
|
448
|
+
- `postClinicalPractice-resourcesCatalog()` - /clinical/practice-resources/catalog operation on clinical-practice-resource resource
|
|
408
449
|
- `patchClinicalPractice-resourcesById()` - /clinical/practice-resources/:id operation on clinical-practice-resource resource
|
|
450
|
+
- `patchClinicalPractice-resourcesCatalogById()` - /clinical/practice-resources/catalog/:id operation on clinical-practice-resource resource
|
|
409
451
|
- `deleteClinicalPractice-resourcesById()` - /clinical/practice-resources/:id operation on clinical-practice-resource resource
|
|
452
|
+
- `deleteClinicalPractice-resourcesCatalogById()` - /clinical/practice-resources/catalog/:id operation on clinical-practice-resource resource
|
|
410
453
|
|
|
411
454
|
## Clinical-practice-tool
|
|
412
455
|
|
|
413
456
|
- `getClinicalPractice-tools()` - /clinical/practice-tools operation on clinical-practice-tool resource
|
|
414
457
|
- `getClinicalPractice-toolsById()` - /clinical/practice-tools/:id operation on clinical-practice-tool resource
|
|
458
|
+
- `getClinicalPractice-toolsCatalog()` - /clinical/practice-tools/catalog operation on clinical-practice-tool resource
|
|
459
|
+
- `getClinicalPractice-toolsCatalogById()` - /clinical/practice-tools/catalog/:id operation on clinical-practice-tool resource
|
|
415
460
|
- `postClinicalPractice-tools()` - /clinical/practice-tools operation on clinical-practice-tool resource
|
|
461
|
+
- `postClinicalPractice-toolsCatalog()` - /clinical/practice-tools/catalog operation on clinical-practice-tool resource
|
|
416
462
|
- `patchClinicalPractice-toolsById()` - /clinical/practice-tools/:id operation on clinical-practice-tool resource
|
|
463
|
+
- `patchClinicalPractice-toolsCatalogById()` - /clinical/practice-tools/catalog/:id operation on clinical-practice-tool resource
|
|
417
464
|
- `deleteClinicalPractice-toolsById()` - /clinical/practice-tools/:id operation on clinical-practice-tool resource
|
|
465
|
+
- `deleteClinicalPractice-toolsCatalogById()` - /clinical/practice-tools/catalog/:id operation on clinical-practice-tool resource
|
|
466
|
+
|
|
467
|
+
## Clinical-practice-tool-category
|
|
468
|
+
|
|
469
|
+
- `getClinicalPractice-toolsCategories()` - /clinical/practice-tools/categories operation on clinical-practice-tool-category resource
|
|
470
|
+
- `getClinicalPractice-toolsCategoriesCatalog()` - /clinical/practice-tools/categories/catalog operation on clinical-practice-tool-category resource
|
|
418
471
|
|
|
419
472
|
## Clinical-session
|
|
420
473
|
|
|
@@ -447,6 +500,10 @@ flags, workspace mode, and execution limits
|
|
|
447
500
|
- `postCompliance-officer-designations()` - /compliance-officer-designations operation on compliance-officer-designation resource
|
|
448
501
|
- `patchCompliance-officer-designationsByIdRevoke()` - /compliance-officer-designations/:id/revoke operation on compliance-officer-designation resource
|
|
449
502
|
|
|
503
|
+
## Compliance-posture
|
|
504
|
+
|
|
505
|
+
- `getCompliancePosture()` - /compliance/posture operation on compliance-posture resource
|
|
506
|
+
|
|
450
507
|
## Compliance-requirement
|
|
451
508
|
|
|
452
509
|
- `getCompliance-requirements()` - /compliance-requirements operation on compliance-requirement resource
|
|
@@ -461,12 +518,6 @@ flags, workspace mode, and execution limits
|
|
|
461
518
|
- `getCompliance-requirement-completionsById()` - /compliance-requirement-completions/:id operation on compliance-requirement-completion resource
|
|
462
519
|
- `postCompliance-requirement-completions()` - /compliance-requirement-completions operation on compliance-requirement-completion resource
|
|
463
520
|
|
|
464
|
-
## Config
|
|
465
|
-
|
|
466
|
-
- `getConfigs()` - /configs operation on config resource
|
|
467
|
-
- `postConfigs()` - Create or upsert a platform config entry by key; if the key already exists its value, description, and sensitivity flag are updated
|
|
468
|
-
- `patchConfigsByKey()` - Update the value, description, or sensitivity flag for an existing config entry; automatically invalidates the FetchConfig cache for the key
|
|
469
|
-
|
|
470
521
|
## Connector instance
|
|
471
522
|
|
|
472
523
|
- `getConnectors()` - /connectors operation on connector_instance resource
|
|
@@ -484,11 +535,11 @@ flags, workspace mode, and execution limits
|
|
|
484
535
|
- `patchConnectorsById()` - Update a connector instance's name, configuration, sync interval, health status, or metadata
|
|
485
536
|
- `deleteConnectorsById()` - /connectors/:id operation on connector_instance resource
|
|
486
537
|
|
|
487
|
-
## Consent
|
|
538
|
+
## Consent-record
|
|
488
539
|
|
|
489
|
-
- `getConsent-records()` - /consent-records operation on
|
|
540
|
+
- `getConsent-records()` - /consent-records operation on consent-record resource
|
|
490
541
|
- `getConsent-recordsActive()` - List all currently granted (non-withdrawn) consents for a given user
|
|
491
|
-
- `getConsent-recordsById()` - /consent-records/:id operation on
|
|
542
|
+
- `getConsent-recordsById()` - /consent-records/:id operation on consent-record resource
|
|
492
543
|
- `postConsent-records()` - Record a new consent grant for a specific processing purpose (AI document processing, analytics, marketing, or third-party sharing)
|
|
493
544
|
- `patchConsent-recordsByIdWithdraw()` - Revoke an existing consent grant
|
|
494
545
|
|
|
@@ -627,14 +678,6 @@ attribute-level property filters
|
|
|
627
678
|
- `patchCrmRelationship-typesById()` - Update a relationship type's display name, allowed entity types, or properties schema
|
|
628
679
|
- `deleteCrmRelationship-typesById()` - /crm/relationship-types/:id operation on crm_relationship_type resource
|
|
629
680
|
|
|
630
|
-
## Data protection impact assessment
|
|
631
|
-
|
|
632
|
-
- `getImpact-assessments()` - /impact-assessments operation on data_protection_impact_assessment resource
|
|
633
|
-
- `getImpact-assessmentsById()` - /impact-assessments/:id operation on data_protection_impact_assessment resource
|
|
634
|
-
- `postImpact-assessments()` - Open a new GDPR Article 35 Data Protection Impact Assessment for a high-risk processing activity
|
|
635
|
-
- `patchImpact-assessmentsById()` - Update the DPIA's title, description, risk level, findings, or mitigations while it is in draft or in_review status
|
|
636
|
-
- `patchImpact-assessmentsByIdApprove()` - Approve a completed DPIA by recording the approver's name and setting `approved_at` to the current timestamp
|
|
637
|
-
|
|
638
681
|
## Data store record
|
|
639
682
|
|
|
640
683
|
- `getDataStoreRecords()` - /data_store/records operation on data_store_record resource
|
|
@@ -645,13 +688,28 @@ attribute-level property filters
|
|
|
645
688
|
- `patchDataStoreRecordsById()` - /data_store/records/:id operation on data_store_record resource
|
|
646
689
|
- `deleteDataStoreRecordsById()` - /data_store/records/:id operation on data_store_record resource
|
|
647
690
|
|
|
648
|
-
## Data
|
|
691
|
+
## Data-protection-impact-assessment
|
|
649
692
|
|
|
650
|
-
- `
|
|
651
|
-
- `
|
|
693
|
+
- `getImpact-assessments()` - /impact-assessments operation on data-protection-impact-assessment resource
|
|
694
|
+
- `getImpact-assessmentsById()` - /impact-assessments/:id operation on data-protection-impact-assessment resource
|
|
695
|
+
- `postImpact-assessments()` - Open a new GDPR Article 35 Data Protection Impact Assessment for a high-risk processing activity
|
|
696
|
+
- `patchImpact-assessmentsById()` - Update the DPIA's title, description, risk level, findings, or mitigations while it is in draft or in_review status
|
|
697
|
+
- `patchImpact-assessmentsByIdApprove()` - Approve a completed DPIA by recording the approver's name and setting `approved_at` to the current timestamp
|
|
698
|
+
|
|
699
|
+
## Data-subject-request
|
|
700
|
+
|
|
701
|
+
- `getData-subject-requests()` - /data-subject-requests operation on data-subject-request resource
|
|
702
|
+
- `getData-subject-requestsById()` - /data-subject-requests/:id operation on data-subject-request resource
|
|
652
703
|
- `postData-subject-requests()` - Open a new GDPR/CCPA data subject request (access, erasure, portability, rectification, or restriction)
|
|
653
704
|
- `patchData-subject-requestsByIdStatus()` - Advance a data subject request through its lifecycle (pending → in_progress → completed / rejected / expired) and record notes or a completion timestamp.
|
|
654
705
|
|
|
706
|
+
## Data-transfer-record
|
|
707
|
+
|
|
708
|
+
- `getData-transfer-records()` - /data-transfer-records operation on data-transfer-record resource
|
|
709
|
+
- `getData-transfer-recordsById()` - /data-transfer-records/:id operation on data-transfer-record resource
|
|
710
|
+
- `postData-transfer-records()` - Log a cross-border personal data transfer per GDPR Chapter V, specifying the source and destination ISO country codes, the legal transfer mechanism (SCC, BCR, adequacy decision, derogation, or consent), and the data categories involved.
|
|
711
|
+
- `deleteData-transfer-recordsById()` - /data-transfer-records/:id operation on data-transfer-record resource
|
|
712
|
+
|
|
655
713
|
## Disclosure-log
|
|
656
714
|
|
|
657
715
|
- `getDisclosure-logs()` - /disclosure-logs operation on disclosure-log resource
|
|
@@ -705,16 +763,6 @@ again
|
|
|
705
763
|
- `getMemoryDocument-sections()` - /memory/document-sections operation on document-section resource
|
|
706
764
|
- `getMemoryDocument-sectionsById()` - /memory/document-sections/:id operation on document-section resource
|
|
707
765
|
|
|
708
|
-
## Email template
|
|
709
|
-
|
|
710
|
-
- `getApplicationsByApplicationIdEmail-templates()` - List all email templates for the application, including both system and custom templates
|
|
711
|
-
- `getApplicationsByApplicationIdEmail-templatesBySlug()` - Fetch a single email template by its slug within the given application
|
|
712
|
-
- `postApplicationsByApplicationIdEmail-templates()` - Create a new custom email template for the application
|
|
713
|
-
- `postApplicationsByApplicationIdEmail-templatesBySlugPreview()` - Preview email template with sample data
|
|
714
|
-
- `postApplicationsByApplicationIdEmail-templatesBySlugTest()` - Send a test email using this template
|
|
715
|
-
- `patchApplicationsByApplicationIdEmail-templatesBySlug()` - Update the display name, subject, body, branding color, or enabled state of an existing template
|
|
716
|
-
- `deleteApplicationsByApplicationIdEmail-templatesBySlug()` - /applications/:application_id/email-templates/:slug operation on email_template resource
|
|
717
|
-
|
|
718
766
|
## Email-inbound-address
|
|
719
767
|
|
|
720
768
|
- `getEmailInbound-addressesById()` - /email/inbound-addresses/:id operation on email-inbound-address resource
|
|
@@ -881,14 +929,18 @@ fields
|
|
|
881
929
|
- `patchExtractionResultsByIdSave-corrections()` - Apply human corrections to extracted field values
|
|
882
930
|
- `deleteExtractionResultsById()` - Delete an ExtractionResult record
|
|
883
931
|
|
|
884
|
-
## Feature
|
|
932
|
+
## Feature-definition
|
|
885
933
|
|
|
886
934
|
- `getFeature-definitions()` - List all feature definitions
|
|
887
935
|
- `getFeature-definitionsBy-applicationByApplicationId()` - List feature definitions for a specific application.
|
|
888
936
|
- `getFeature-definitionsById()` - Fetch a single feature definition by ID.
|
|
889
937
|
- `postFeature-definitions()` - Create a new ISV-defined feature for an application
|
|
890
938
|
- `patchFeature-definitionsById()` - Update a feature definition's configuration.
|
|
891
|
-
- `deleteFeature-definitionsById()` - /feature-definitions/:id operation on
|
|
939
|
+
- `deleteFeature-definitionsById()` - /feature-definitions/:id operation on feature-definition resource
|
|
940
|
+
|
|
941
|
+
## Feature-summary
|
|
942
|
+
|
|
943
|
+
- `getWalletFeatures()` - Get all features with their plan allocations and current usage
|
|
892
944
|
|
|
893
945
|
## Feature-usage
|
|
894
946
|
|
|
@@ -935,34 +987,23 @@ fields
|
|
|
935
987
|
- `postAiGraphNodes()` - Create an Entity vertex in the knowledge graph; tenant_id is always forced from the actor and cannot be supplied by the caller
|
|
936
988
|
- `deleteAiGraphNodesById()` - /ai/graph/nodes/:id operation on graph_node resource
|
|
937
989
|
|
|
938
|
-
## Legal
|
|
990
|
+
## Legal-acceptance
|
|
939
991
|
|
|
940
|
-
- `getLegal-acceptances()` - /legal-acceptances operation on
|
|
941
|
-
- `getLegal-acceptancesById()` - /legal-acceptances/:id operation on
|
|
992
|
+
- `getLegal-acceptances()` - /legal-acceptances operation on legal-acceptance resource
|
|
993
|
+
- `getLegal-acceptancesById()` - /legal-acceptances/:id operation on legal-acceptance resource
|
|
942
994
|
- `getLegal-acceptancesLatest()` - Fetch the most recent acceptance record for a given user and document type
|
|
943
995
|
|
|
944
|
-
## Legal
|
|
996
|
+
## Legal-document
|
|
945
997
|
|
|
946
|
-
- `getLegal-documents()` - /legal-documents operation on
|
|
998
|
+
- `getLegal-documents()` - /legal-documents operation on legal-document resource
|
|
947
999
|
- `getLegal-documentsBy-locale()` - Fetch active legal documents filtered by locale and optional region, used to display the appropriate ToS or Privacy Policy to a user based on their location.
|
|
948
|
-
- `getLegal-documentsById()` - /legal-documents/:id operation on
|
|
1000
|
+
- `getLegal-documentsById()` - /legal-documents/:id operation on legal-document resource
|
|
949
1001
|
- `getLegal-documentsFor-application()` - List legal documents scoped to the current application context, including platform-level documents (null application_id) and application-specific overrides
|
|
950
1002
|
- `postLegal-documents()` - Create a new versioned legal document (Terms of Service, Privacy Policy, BAA, DPA, or SCC)
|
|
951
1003
|
- `patchLegal-documentsById()` - Edit draft document content, locale, region, or scheduling fields
|
|
952
1004
|
- `patchLegal-documentsByIdPublish()` - Make a legal document live
|
|
953
1005
|
- `patchLegal-documentsByIdUnpublish()` - Deactivate a legal document without deleting it
|
|
954
|
-
- `deleteLegal-documentsById()` - /legal-documents/:id operation on
|
|
955
|
-
|
|
956
|
-
## Llm-analytics
|
|
957
|
-
|
|
958
|
-
- `getLlm-analytics()` - List LLM analytics records sorted by created_at descending; scoped to the caller's tenant.
|
|
959
|
-
- `getLlm-analyticsById()` - /llm-analytics/:id operation on llm-analytics resource
|
|
960
|
-
- `getLlm-analyticsCosts()` - Retrieve cost-focused analytics records for the caller's tenant; use for billing reconciliation and cost analysis.
|
|
961
|
-
- `getLlm-analyticsPlatform()` - Platform-wide analytics summary (platform admin only)
|
|
962
|
-
- `getLlm-analyticsSummary()` - Aggregate LLM usage and cost statistics optionally filtered by a date range; returns a single summary record.
|
|
963
|
-
- `getLlm-analyticsUsage()` - Return token usage summary analytics for the caller's tenant; useful for quota monitoring and capacity planning.
|
|
964
|
-
- `getLlm-analyticsWorkspace()` - Fetch LLM analytics scoped to a single workspace; use for per-workspace usage dashboards and cost attribution.
|
|
965
|
-
- `postLlm-analytics()` - Append a single LLM call analytics record (model, tokens, latency, cost); called by the billing/analytics pipeline after each LLM invocation
|
|
1006
|
+
- `deleteLegal-documentsById()` - /legal-documents/:id operation on legal-document resource
|
|
966
1007
|
|
|
967
1008
|
## Messages
|
|
968
1009
|
|
|
@@ -1064,20 +1105,28 @@ fields
|
|
|
1064
1105
|
|
|
1065
1106
|
- `postDocumentsPresigned-upload()` - /documents/presigned-upload operation on presigned_url resource
|
|
1066
1107
|
|
|
1067
|
-
## Processing
|
|
1108
|
+
## Processing-activity
|
|
1068
1109
|
|
|
1069
|
-
- `getProcessing-activities()` - /processing-activities operation on
|
|
1070
|
-
- `getProcessing-activitiesById()` - /processing-activities/:id operation on
|
|
1110
|
+
- `getProcessing-activities()` - /processing-activities operation on processing-activity resource
|
|
1111
|
+
- `getProcessing-activitiesById()` - /processing-activities/:id operation on processing-activity resource
|
|
1071
1112
|
- `postProcessing-activities()` - Add a new GDPR Article 30 Record of Processing Activities (ROPA) entry, documenting a processing purpose, the categories of personal data processed, data subjects, recipients, and legal basis for the workspace.
|
|
1072
|
-
- `deleteProcessing-activitiesById()` - /processing-activities/:id operation on
|
|
1113
|
+
- `deleteProcessing-activitiesById()` - /processing-activities/:id operation on processing-activity resource
|
|
1073
1114
|
|
|
1074
|
-
## Retention
|
|
1115
|
+
## Retention-policy
|
|
1075
1116
|
|
|
1076
|
-
- `getRetention-policies()` - /retention-policies operation on
|
|
1077
|
-
- `getRetention-policiesById()` - /retention-policies/:id operation on
|
|
1117
|
+
- `getRetention-policies()` - /retention-policies operation on retention-policy resource
|
|
1118
|
+
- `getRetention-policiesById()` - /retention-policies/:id operation on retention-policy resource
|
|
1078
1119
|
- `postRetention-policies()` - Define a data retention rule for a specific data category in a workspace
|
|
1079
1120
|
- `patchRetention-policiesById()` - Modify the retention period, expiry action, or enabled state of an existing policy
|
|
1080
|
-
- `deleteRetention-policiesById()` - /retention-policies/:id operation on
|
|
1121
|
+
- `deleteRetention-policiesById()` - /retention-policies/:id operation on retention-policy resource
|
|
1122
|
+
|
|
1123
|
+
## Risk-assessment
|
|
1124
|
+
|
|
1125
|
+
- `getRisk-assessments()` - /risk-assessments operation on risk-assessment resource
|
|
1126
|
+
- `getRisk-assessmentsById()` - /risk-assessments/:id operation on risk-assessment resource
|
|
1127
|
+
- `postRisk-assessments()` - Record a new compliance risk assessment (security, privacy, operational, or compliance type) for a workspace
|
|
1128
|
+
- `patchRisk-assessmentsByIdStatus()` - Advance a risk assessment through its lifecycle (draft → in_review → approved → expired) and record the reviewer and approval timestamp.
|
|
1129
|
+
- `deleteRisk-assessmentsById()` - /risk-assessments/:id operation on risk-assessment resource
|
|
1081
1130
|
|
|
1082
1131
|
## Role
|
|
1083
1132
|
|
|
@@ -1087,10 +1136,10 @@ fields
|
|
|
1087
1136
|
- `patchRolesById()` - Update a role's name, description, or permission list; does NOT retroactively update existing AccessGrants
|
|
1088
1137
|
- `deleteRolesById()` - Delete a role; emits a RoleDeleted audit event
|
|
1089
1138
|
|
|
1090
|
-
## Scan
|
|
1139
|
+
## Scan-result
|
|
1091
1140
|
|
|
1092
|
-
- `getScan-results()` - /scan-results operation on
|
|
1093
|
-
- `getScan-resultsById()` - /scan-results/:id operation on
|
|
1141
|
+
- `getScan-results()` - /scan-results operation on scan-result resource
|
|
1142
|
+
- `getScan-resultsById()` - /scan-results/:id operation on scan-result resource
|
|
1094
1143
|
|
|
1095
1144
|
## Scheduling booking
|
|
1096
1145
|
|
|
@@ -1350,6 +1399,28 @@ plan tier, vanity slug, and storage spending cap
|
|
|
1350
1399
|
- `getTransactions()` - Read user's transactions
|
|
1351
1400
|
- `getTransactionsById()` - Read user's transactions
|
|
1352
1401
|
|
|
1402
|
+
## Trending-snapshot
|
|
1403
|
+
|
|
1404
|
+
- `getSocialTrendingHistoryById()` - /social/trending/history/:id operation on trending-snapshot resource
|
|
1405
|
+
- `getSocialTrendingHistoryRange()` - /social/trending/history/range operation on trending-snapshot resource
|
|
1406
|
+
- `getSocialTrendingHistoryWorkspaceByWorkspaceId()` - /social/trending/history/workspace/:workspace_id operation on trending-snapshot resource
|
|
1407
|
+
- `postSocialTrendingHistory()` - /social/trending/history operation on trending-snapshot resource
|
|
1408
|
+
- `deleteSocialTrendingHistoryById()` - /social/trending/history/:id operation on trending-snapshot resource
|
|
1409
|
+
|
|
1410
|
+
## Trending-snapshot-item
|
|
1411
|
+
|
|
1412
|
+
- `getSocialTrendingItemsById()` - /social/trending/items/:id operation on trending-snapshot-item resource
|
|
1413
|
+
- `getSocialTrendingItemsSnapshotBySnapshotId()` - /social/trending/items/snapshot/:snapshot_id operation on trending-snapshot-item resource
|
|
1414
|
+
|
|
1415
|
+
## Trending-watch
|
|
1416
|
+
|
|
1417
|
+
- `getSocialTrendingWatchesById()` - /social/trending/watches/:id operation on trending-watch resource
|
|
1418
|
+
- `getSocialTrendingWatchesWorkspaceByWorkspaceId()` - /social/trending/watches/workspace/:workspace_id operation on trending-watch resource
|
|
1419
|
+
- `postSocialTrendingWatches()` - /social/trending/watches operation on trending-watch resource
|
|
1420
|
+
- `patchSocialTrendingWatchesById()` - /social/trending/watches/:id operation on trending-watch resource
|
|
1421
|
+
- `patchSocialTrendingWatchesByIdMark-triggered()` - /social/trending/watches/:id/mark-triggered operation on trending-watch resource
|
|
1422
|
+
- `deleteSocialTrendingWatchesById()` - /social/trending/watches/:id operation on trending-watch resource
|
|
1423
|
+
|
|
1353
1424
|
## Users
|
|
1354
1425
|
|
|
1355
1426
|
- `getUser-profiles()` - /user-profiles operation on user_profile resource
|
|
@@ -1432,30 +1503,18 @@ raw preferences map
|
|
|
1432
1503
|
- `getWatcherEventsById()` - Fetch a single ingestion event by ID; use the :list action to query events by workspace, type, machine, or time range.
|
|
1433
1504
|
- `postWatcherEvents()` - Create multiple events in batch
|
|
1434
1505
|
|
|
1435
|
-
## Webhooks
|
|
1436
|
-
|
|
1437
|
-
- `getWebhook-configs()` - /webhook-configs operation on webhook_config resource
|
|
1438
|
-
- `getWebhook-configsById()` - /webhook-configs/:id operation on webhook_config resource
|
|
1439
|
-
- `getWebhook-configsByIdEvents()` - List available events that can be subscribed to
|
|
1440
|
-
- `getWebhook-configsStats()` - Get webhook configuration statistics
|
|
1441
|
-
- `getWebhook-deliveries()` - /webhook-deliveries operation on webhook_delivery resource
|
|
1442
|
-
- `getWebhook-deliveriesById()` - /webhook-deliveries/:id operation on webhook_delivery resource
|
|
1443
|
-
- `getWebhook-deliveriesStats()` - Return aggregate delivery counts by status (total, delivered, failed, retrying)
|
|
1444
|
-
- `postWebhook-configs()` - Register a new webhook endpoint to receive platform events
|
|
1445
|
-
- `postWebhook-configsBulk-disable()` - Disable multiple webhook configs by ID in a single call
|
|
1446
|
-
- `postWebhook-configsBulk-enable()` - Enable multiple webhook configs by ID in a single call
|
|
1447
|
-
- `postWebhook-configsByIdReplay()` - Replay historical events to this webhook
|
|
1448
|
-
- `postWebhook-configsByIdTest()` - Send a realistic sample payload to the webhook URL to verify connectivity and signature verification
|
|
1449
|
-
- `postWebhook-deliveriesBulk-retry()` - Set multiple delivery records to `:retrying` status in bulk
|
|
1450
|
-
- `postWebhook-deliveriesByIdRetry()` - Re-enqueue a failed or pending delivery for immediate re-dispatch
|
|
1451
|
-
- `patchWebhook-configsById()` - Update webhook endpoint settings such as URL, subscribed events, and enabled state
|
|
1452
|
-
- `patchWebhook-configsByIdRotate-secret()` - Generate a new `whsec_`-prefixed HMAC secret for this webhook, invalidating the previous secret immediately
|
|
1453
|
-
- `deleteWebhook-configsById()` - /webhook-configs/:id operation on webhook_config resource
|
|
1454
|
-
|
|
1455
1506
|
## Workspace document stats
|
|
1456
1507
|
|
|
1457
1508
|
- `getTenantsByTenantIdWorkspaceStats()` - /tenants/:tenant_id/workspace_stats operation on workspace_document_stats resource
|
|
1458
1509
|
|
|
1510
|
+
## Workspace-agent-config
|
|
1511
|
+
|
|
1512
|
+
- `getWorkspace-agent-configs()` - /workspace-agent-configs operation on workspace-agent-config resource
|
|
1513
|
+
- `getWorkspace-agent-configsById()` - /workspace-agent-configs/:id operation on workspace-agent-config resource
|
|
1514
|
+
- `postWorkspace-agent-configs()` - /workspace-agent-configs operation on workspace-agent-config resource
|
|
1515
|
+
- `patchWorkspace-agent-configsById()` - /workspace-agent-configs/:id operation on workspace-agent-config resource
|
|
1516
|
+
- `deleteWorkspace-agent-configsById()` - /workspace-agent-configs/:id operation on workspace-agent-config resource
|
|
1517
|
+
|
|
1459
1518
|
## Workspaces
|
|
1460
1519
|
|
|
1461
1520
|
- `getWorkspaces()` - List workspaces visible to the actor
|
package/package.json
CHANGED