@gpt-platform/client 0.7.2 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +3823 -1669
- package/dist/index.d.ts +3823 -1669
- package/dist/index.js +4641 -2001
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +4641 -2001
- package/dist/index.mjs.map +1 -1
- package/llms.txt +141 -96
- 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,27 +193,35 @@ 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
|
|
|
191
202
|
- `getBrand-identities()` - /brand-identities operation on brand_identity resource
|
|
203
|
+
- `getBrand-identitiesBy-tenantByTenantId()` - /brand-identities/by-tenant/:tenant_id operation on brand_identity resource
|
|
204
|
+
- `getBrand-identitiesBy-workspaceByWorkspaceId()` - /brand-identities/by-workspace/:workspace_id operation on brand_identity resource
|
|
192
205
|
- `getBrand-identitiesById()` - /brand-identities/:id operation on brand_identity resource
|
|
206
|
+
- `getBrand-identitiesDefaultTenantByTenantId()` - /brand-identities/default/tenant/:tenant_id operation on brand_identity resource
|
|
207
|
+
- `getBrand-identitiesDefaultWorkspaceByWorkspaceId()` - /brand-identities/default/workspace/:workspace_id operation on brand_identity resource
|
|
193
208
|
- `postBrand-identities()` - /brand-identities operation on brand_identity resource
|
|
194
209
|
- `patchBrand-identitiesById()` - /brand-identities/:id operation on brand_identity resource
|
|
210
|
+
- `patchBrand-identitiesByIdSet-default()` - /brand-identities/:id/set-default operation on brand_identity resource
|
|
211
|
+
- `patchBrand-identitiesByIdUnset-default()` - /brand-identities/:id/unset-default operation on brand_identity resource
|
|
195
212
|
- `deleteBrand-identitiesById()` - /brand-identities/:id operation on brand_identity resource
|
|
196
213
|
|
|
197
|
-
## Breach
|
|
214
|
+
## Breach-incident
|
|
198
215
|
|
|
199
|
-
- `getBreach-incidents()` - /breach-incidents operation on
|
|
200
|
-
- `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
|
|
201
218
|
- `postBreach-incidents()` - Report a new data breach or security incident
|
|
202
219
|
- `patchBreach-incidentsByIdStatus()` - Advance a breach incident through its lifecycle (identified → investigating → notifying → resolved / false_positive) and record officer notification and remediation notes.
|
|
203
220
|
|
|
204
|
-
## Breach
|
|
221
|
+
## Breach-notification
|
|
205
222
|
|
|
206
|
-
- `getBreach-notifications()` - /breach-notifications operation on
|
|
207
|
-
- `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
|
|
208
225
|
|
|
209
226
|
## Breach-notification-artifact
|
|
210
227
|
|
|
@@ -318,6 +335,13 @@ flags, workspace mode, and execution limits
|
|
|
318
335
|
- `patchCatalogViewsById()` - Update view metadata, filtering rules, or pricing association
|
|
319
336
|
- `deleteCatalogViewsById()` - Permanently delete a catalog view and its rules and overrides
|
|
320
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
|
+
|
|
321
345
|
## Clinical-client-goal
|
|
322
346
|
|
|
323
347
|
- `getClinicalClient-goals()` - /clinical/client-goals operation on clinical-client-goal resource
|
|
@@ -410,6 +434,10 @@ flags, workspace mode, and execution limits
|
|
|
410
434
|
- `patchClinicalPractice-toolsById()` - /clinical/practice-tools/:id operation on clinical-practice-tool resource
|
|
411
435
|
- `deleteClinicalPractice-toolsById()` - /clinical/practice-tools/:id operation on clinical-practice-tool resource
|
|
412
436
|
|
|
437
|
+
## Clinical-practice-tool-category
|
|
438
|
+
|
|
439
|
+
- `getClinicalPractice-toolsCategories()` - /clinical/practice-tools/categories operation on clinical-practice-tool-category resource
|
|
440
|
+
|
|
413
441
|
## Clinical-session
|
|
414
442
|
|
|
415
443
|
- `getClinicalSessions()` - /clinical/sessions operation on clinical-session resource
|
|
@@ -431,8 +459,8 @@ flags, workspace mode, and execution limits
|
|
|
431
459
|
- `getCompliance-document-templates()` - /compliance-document-templates operation on compliance-document-template resource
|
|
432
460
|
- `getCompliance-document-templatesById()` - /compliance-document-templates/:id operation on compliance-document-template resource
|
|
433
461
|
- `postCompliance-document-templates()` - /compliance-document-templates operation on compliance-document-template resource
|
|
462
|
+
- `postCompliance-document-templatesClone()` - Clone a platform template for an application
|
|
434
463
|
- `patchCompliance-document-templatesById()` - /compliance-document-templates/:id operation on compliance-document-template resource
|
|
435
|
-
- `patchCompliance-document-templatesByIdClone()` - Clone a platform template for an application
|
|
436
464
|
|
|
437
465
|
## Compliance-officer-designation
|
|
438
466
|
|
|
@@ -441,6 +469,10 @@ flags, workspace mode, and execution limits
|
|
|
441
469
|
- `postCompliance-officer-designations()` - /compliance-officer-designations operation on compliance-officer-designation resource
|
|
442
470
|
- `patchCompliance-officer-designationsByIdRevoke()` - /compliance-officer-designations/:id/revoke operation on compliance-officer-designation resource
|
|
443
471
|
|
|
472
|
+
## Compliance-posture
|
|
473
|
+
|
|
474
|
+
- `getCompliancePosture()` - /compliance/posture operation on compliance-posture resource
|
|
475
|
+
|
|
444
476
|
## Compliance-requirement
|
|
445
477
|
|
|
446
478
|
- `getCompliance-requirements()` - /compliance-requirements operation on compliance-requirement resource
|
|
@@ -455,12 +487,6 @@ flags, workspace mode, and execution limits
|
|
|
455
487
|
- `getCompliance-requirement-completionsById()` - /compliance-requirement-completions/:id operation on compliance-requirement-completion resource
|
|
456
488
|
- `postCompliance-requirement-completions()` - /compliance-requirement-completions operation on compliance-requirement-completion resource
|
|
457
489
|
|
|
458
|
-
## Config
|
|
459
|
-
|
|
460
|
-
- `getConfigs()` - /configs operation on config resource
|
|
461
|
-
- `postConfigs()` - Create or upsert a platform config entry by key; if the key already exists its value, description, and sensitivity flag are updated
|
|
462
|
-
- `patchConfigsByKey()` - Update the value, description, or sensitivity flag for an existing config entry; automatically invalidates the FetchConfig cache for the key
|
|
463
|
-
|
|
464
490
|
## Connector instance
|
|
465
491
|
|
|
466
492
|
- `getConnectors()` - /connectors operation on connector_instance resource
|
|
@@ -478,11 +504,11 @@ flags, workspace mode, and execution limits
|
|
|
478
504
|
- `patchConnectorsById()` - Update a connector instance's name, configuration, sync interval, health status, or metadata
|
|
479
505
|
- `deleteConnectorsById()` - /connectors/:id operation on connector_instance resource
|
|
480
506
|
|
|
481
|
-
## Consent
|
|
507
|
+
## Consent-record
|
|
482
508
|
|
|
483
|
-
- `getConsent-records()` - /consent-records operation on
|
|
509
|
+
- `getConsent-records()` - /consent-records operation on consent-record resource
|
|
484
510
|
- `getConsent-recordsActive()` - List all currently granted (non-withdrawn) consents for a given user
|
|
485
|
-
- `getConsent-recordsById()` - /consent-records/:id operation on
|
|
511
|
+
- `getConsent-recordsById()` - /consent-records/:id operation on consent-record resource
|
|
486
512
|
- `postConsent-records()` - Record a new consent grant for a specific processing purpose (AI document processing, analytics, marketing, or third-party sharing)
|
|
487
513
|
- `patchConsent-recordsByIdWithdraw()` - Revoke an existing consent grant
|
|
488
514
|
|
|
@@ -621,14 +647,6 @@ attribute-level property filters
|
|
|
621
647
|
- `patchCrmRelationship-typesById()` - Update a relationship type's display name, allowed entity types, or properties schema
|
|
622
648
|
- `deleteCrmRelationship-typesById()` - /crm/relationship-types/:id operation on crm_relationship_type resource
|
|
623
649
|
|
|
624
|
-
## Data protection impact assessment
|
|
625
|
-
|
|
626
|
-
- `getImpact-assessments()` - /impact-assessments operation on data_protection_impact_assessment resource
|
|
627
|
-
- `getImpact-assessmentsById()` - /impact-assessments/:id operation on data_protection_impact_assessment resource
|
|
628
|
-
- `postImpact-assessments()` - Open a new GDPR Article 35 Data Protection Impact Assessment for a high-risk processing activity
|
|
629
|
-
- `patchImpact-assessmentsById()` - Update the DPIA's title, description, risk level, findings, or mitigations while it is in draft or in_review status
|
|
630
|
-
- `patchImpact-assessmentsByIdApprove()` - Approve a completed DPIA by recording the approver's name and setting `approved_at` to the current timestamp
|
|
631
|
-
|
|
632
650
|
## Data store record
|
|
633
651
|
|
|
634
652
|
- `getDataStoreRecords()` - /data_store/records operation on data_store_record resource
|
|
@@ -639,13 +657,28 @@ attribute-level property filters
|
|
|
639
657
|
- `patchDataStoreRecordsById()` - /data_store/records/:id operation on data_store_record resource
|
|
640
658
|
- `deleteDataStoreRecordsById()` - /data_store/records/:id operation on data_store_record resource
|
|
641
659
|
|
|
642
|
-
## Data
|
|
660
|
+
## Data-protection-impact-assessment
|
|
661
|
+
|
|
662
|
+
- `getImpact-assessments()` - /impact-assessments operation on data-protection-impact-assessment resource
|
|
663
|
+
- `getImpact-assessmentsById()` - /impact-assessments/:id operation on data-protection-impact-assessment resource
|
|
664
|
+
- `postImpact-assessments()` - Open a new GDPR Article 35 Data Protection Impact Assessment for a high-risk processing activity
|
|
665
|
+
- `patchImpact-assessmentsById()` - Update the DPIA's title, description, risk level, findings, or mitigations while it is in draft or in_review status
|
|
666
|
+
- `patchImpact-assessmentsByIdApprove()` - Approve a completed DPIA by recording the approver's name and setting `approved_at` to the current timestamp
|
|
643
667
|
|
|
644
|
-
|
|
645
|
-
|
|
668
|
+
## Data-subject-request
|
|
669
|
+
|
|
670
|
+
- `getData-subject-requests()` - /data-subject-requests operation on data-subject-request resource
|
|
671
|
+
- `getData-subject-requestsById()` - /data-subject-requests/:id operation on data-subject-request resource
|
|
646
672
|
- `postData-subject-requests()` - Open a new GDPR/CCPA data subject request (access, erasure, portability, rectification, or restriction)
|
|
647
673
|
- `patchData-subject-requestsByIdStatus()` - Advance a data subject request through its lifecycle (pending → in_progress → completed / rejected / expired) and record notes or a completion timestamp.
|
|
648
674
|
|
|
675
|
+
## Data-transfer-record
|
|
676
|
+
|
|
677
|
+
- `getData-transfer-records()` - /data-transfer-records operation on data-transfer-record resource
|
|
678
|
+
- `getData-transfer-recordsById()` - /data-transfer-records/:id operation on data-transfer-record resource
|
|
679
|
+
- `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.
|
|
680
|
+
- `deleteData-transfer-recordsById()` - /data-transfer-records/:id operation on data-transfer-record resource
|
|
681
|
+
|
|
649
682
|
## Disclosure-log
|
|
650
683
|
|
|
651
684
|
- `getDisclosure-logs()` - /disclosure-logs operation on disclosure-log resource
|
|
@@ -699,16 +732,6 @@ again
|
|
|
699
732
|
- `getMemoryDocument-sections()` - /memory/document-sections operation on document-section resource
|
|
700
733
|
- `getMemoryDocument-sectionsById()` - /memory/document-sections/:id operation on document-section resource
|
|
701
734
|
|
|
702
|
-
## Email template
|
|
703
|
-
|
|
704
|
-
- `getApplicationsByApplicationIdEmail-templates()` - List all email templates for the application, including both system and custom templates
|
|
705
|
-
- `getApplicationsByApplicationIdEmail-templatesBySlug()` - Fetch a single email template by its slug within the given application
|
|
706
|
-
- `postApplicationsByApplicationIdEmail-templates()` - Create a new custom email template for the application
|
|
707
|
-
- `postApplicationsByApplicationIdEmail-templatesBySlugPreview()` - Preview email template with sample data
|
|
708
|
-
- `postApplicationsByApplicationIdEmail-templatesBySlugTest()` - Send a test email using this template
|
|
709
|
-
- `patchApplicationsByApplicationIdEmail-templatesBySlug()` - Update the display name, subject, body, branding color, or enabled state of an existing template
|
|
710
|
-
- `deleteApplicationsByApplicationIdEmail-templatesBySlug()` - /applications/:application_id/email-templates/:slug operation on email_template resource
|
|
711
|
-
|
|
712
735
|
## Email-inbound-address
|
|
713
736
|
|
|
714
737
|
- `getEmailInbound-addressesById()` - /email/inbound-addresses/:id operation on email-inbound-address resource
|
|
@@ -875,14 +898,18 @@ fields
|
|
|
875
898
|
- `patchExtractionResultsByIdSave-corrections()` - Apply human corrections to extracted field values
|
|
876
899
|
- `deleteExtractionResultsById()` - Delete an ExtractionResult record
|
|
877
900
|
|
|
878
|
-
## Feature
|
|
901
|
+
## Feature-definition
|
|
879
902
|
|
|
880
903
|
- `getFeature-definitions()` - List all feature definitions
|
|
881
904
|
- `getFeature-definitionsBy-applicationByApplicationId()` - List feature definitions for a specific application.
|
|
882
905
|
- `getFeature-definitionsById()` - Fetch a single feature definition by ID.
|
|
883
906
|
- `postFeature-definitions()` - Create a new ISV-defined feature for an application
|
|
884
907
|
- `patchFeature-definitionsById()` - Update a feature definition's configuration.
|
|
885
|
-
- `deleteFeature-definitionsById()` - /feature-definitions/:id operation on
|
|
908
|
+
- `deleteFeature-definitionsById()` - /feature-definitions/:id operation on feature-definition resource
|
|
909
|
+
|
|
910
|
+
## Feature-summary
|
|
911
|
+
|
|
912
|
+
- `getWalletFeatures()` - Get all features with their plan allocations and current usage
|
|
886
913
|
|
|
887
914
|
## Feature-usage
|
|
888
915
|
|
|
@@ -929,34 +956,23 @@ fields
|
|
|
929
956
|
- `postAiGraphNodes()` - Create an Entity vertex in the knowledge graph; tenant_id is always forced from the actor and cannot be supplied by the caller
|
|
930
957
|
- `deleteAiGraphNodesById()` - /ai/graph/nodes/:id operation on graph_node resource
|
|
931
958
|
|
|
932
|
-
## Legal
|
|
959
|
+
## Legal-acceptance
|
|
933
960
|
|
|
934
|
-
- `getLegal-acceptances()` - /legal-acceptances operation on
|
|
935
|
-
- `getLegal-acceptancesById()` - /legal-acceptances/:id operation on
|
|
961
|
+
- `getLegal-acceptances()` - /legal-acceptances operation on legal-acceptance resource
|
|
962
|
+
- `getLegal-acceptancesById()` - /legal-acceptances/:id operation on legal-acceptance resource
|
|
936
963
|
- `getLegal-acceptancesLatest()` - Fetch the most recent acceptance record for a given user and document type
|
|
937
964
|
|
|
938
|
-
## Legal
|
|
965
|
+
## Legal-document
|
|
939
966
|
|
|
940
|
-
- `getLegal-documents()` - /legal-documents operation on
|
|
967
|
+
- `getLegal-documents()` - /legal-documents operation on legal-document resource
|
|
941
968
|
- `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.
|
|
942
|
-
- `getLegal-documentsById()` - /legal-documents/:id operation on
|
|
969
|
+
- `getLegal-documentsById()` - /legal-documents/:id operation on legal-document resource
|
|
943
970
|
- `getLegal-documentsFor-application()` - List legal documents scoped to the current application context, including platform-level documents (null application_id) and application-specific overrides
|
|
944
971
|
- `postLegal-documents()` - Create a new versioned legal document (Terms of Service, Privacy Policy, BAA, DPA, or SCC)
|
|
945
972
|
- `patchLegal-documentsById()` - Edit draft document content, locale, region, or scheduling fields
|
|
946
973
|
- `patchLegal-documentsByIdPublish()` - Make a legal document live
|
|
947
974
|
- `patchLegal-documentsByIdUnpublish()` - Deactivate a legal document without deleting it
|
|
948
|
-
- `deleteLegal-documentsById()` - /legal-documents/:id operation on
|
|
949
|
-
|
|
950
|
-
## Llm-analytics
|
|
951
|
-
|
|
952
|
-
- `getLlm-analytics()` - List LLM analytics records sorted by created_at descending; scoped to the caller's tenant.
|
|
953
|
-
- `getLlm-analyticsById()` - /llm-analytics/:id operation on llm-analytics resource
|
|
954
|
-
- `getLlm-analyticsCosts()` - Retrieve cost-focused analytics records for the caller's tenant; use for billing reconciliation and cost analysis.
|
|
955
|
-
- `getLlm-analyticsPlatform()` - Platform-wide analytics summary (platform admin only)
|
|
956
|
-
- `getLlm-analyticsSummary()` - Aggregate LLM usage and cost statistics optionally filtered by a date range; returns a single summary record.
|
|
957
|
-
- `getLlm-analyticsUsage()` - Return token usage summary analytics for the caller's tenant; useful for quota monitoring and capacity planning.
|
|
958
|
-
- `getLlm-analyticsWorkspace()` - Fetch LLM analytics scoped to a single workspace; use for per-workspace usage dashboards and cost attribution.
|
|
959
|
-
- `postLlm-analytics()` - Append a single LLM call analytics record (model, tokens, latency, cost); called by the billing/analytics pipeline after each LLM invocation
|
|
975
|
+
- `deleteLegal-documentsById()` - /legal-documents/:id operation on legal-document resource
|
|
960
976
|
|
|
961
977
|
## Messages
|
|
962
978
|
|
|
@@ -1022,9 +1038,16 @@ fields
|
|
|
1022
1038
|
- `getPermissionsPresets()` - List all permission presets (pre-defined role bundles) from the PermissionRegistry, optionally filtered by context and app
|
|
1023
1039
|
- `getPermissionsPresetsById()` - Fetch a single permission preset by its composite ID (e.g., 'workspace:org:admin'); returns the preset with its full permission list or a not-found error.
|
|
1024
1040
|
|
|
1041
|
+
## Plan-feature-allocation
|
|
1042
|
+
|
|
1043
|
+
- `getPlan-feature-allocations()` - List all plan feature allocations for the current application.
|
|
1044
|
+
- `getPlan-feature-allocationsBy-planByPlanId()` - List feature allocations for a specific plan.
|
|
1045
|
+
- `getPlan-feature-allocationsById()` - Fetch a single plan feature allocation by ID.
|
|
1046
|
+
|
|
1025
1047
|
## Platform tone
|
|
1026
1048
|
|
|
1027
1049
|
- `getPlatform-tones()` - /platform-tones operation on platform_tone resource
|
|
1050
|
+
- `getPlatform-tonesBy-brandByBrandIdentityId()` - /platform-tones/by-brand/:brand_identity_id operation on platform_tone resource
|
|
1028
1051
|
- `getPlatform-tonesById()` - /platform-tones/:id operation on platform_tone resource
|
|
1029
1052
|
- `postPlatform-tones()` - /platform-tones operation on platform_tone resource
|
|
1030
1053
|
- `patchPlatform-tonesById()` - /platform-tones/:id operation on platform_tone resource
|
|
@@ -1051,20 +1074,28 @@ fields
|
|
|
1051
1074
|
|
|
1052
1075
|
- `postDocumentsPresigned-upload()` - /documents/presigned-upload operation on presigned_url resource
|
|
1053
1076
|
|
|
1054
|
-
## Processing
|
|
1077
|
+
## Processing-activity
|
|
1055
1078
|
|
|
1056
|
-
- `getProcessing-activities()` - /processing-activities operation on
|
|
1057
|
-
- `getProcessing-activitiesById()` - /processing-activities/:id operation on
|
|
1079
|
+
- `getProcessing-activities()` - /processing-activities operation on processing-activity resource
|
|
1080
|
+
- `getProcessing-activitiesById()` - /processing-activities/:id operation on processing-activity resource
|
|
1058
1081
|
- `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.
|
|
1059
|
-
- `deleteProcessing-activitiesById()` - /processing-activities/:id operation on
|
|
1082
|
+
- `deleteProcessing-activitiesById()` - /processing-activities/:id operation on processing-activity resource
|
|
1060
1083
|
|
|
1061
|
-
## Retention
|
|
1084
|
+
## Retention-policy
|
|
1062
1085
|
|
|
1063
|
-
- `getRetention-policies()` - /retention-policies operation on
|
|
1064
|
-
- `getRetention-policiesById()` - /retention-policies/:id operation on
|
|
1086
|
+
- `getRetention-policies()` - /retention-policies operation on retention-policy resource
|
|
1087
|
+
- `getRetention-policiesById()` - /retention-policies/:id operation on retention-policy resource
|
|
1065
1088
|
- `postRetention-policies()` - Define a data retention rule for a specific data category in a workspace
|
|
1066
1089
|
- `patchRetention-policiesById()` - Modify the retention period, expiry action, or enabled state of an existing policy
|
|
1067
|
-
- `deleteRetention-policiesById()` - /retention-policies/:id operation on
|
|
1090
|
+
- `deleteRetention-policiesById()` - /retention-policies/:id operation on retention-policy resource
|
|
1091
|
+
|
|
1092
|
+
## Risk-assessment
|
|
1093
|
+
|
|
1094
|
+
- `getRisk-assessments()` - /risk-assessments operation on risk-assessment resource
|
|
1095
|
+
- `getRisk-assessmentsById()` - /risk-assessments/:id operation on risk-assessment resource
|
|
1096
|
+
- `postRisk-assessments()` - Record a new compliance risk assessment (security, privacy, operational, or compliance type) for a workspace
|
|
1097
|
+
- `patchRisk-assessmentsByIdStatus()` - Advance a risk assessment through its lifecycle (draft → in_review → approved → expired) and record the reviewer and approval timestamp.
|
|
1098
|
+
- `deleteRisk-assessmentsById()` - /risk-assessments/:id operation on risk-assessment resource
|
|
1068
1099
|
|
|
1069
1100
|
## Role
|
|
1070
1101
|
|
|
@@ -1074,10 +1105,10 @@ fields
|
|
|
1074
1105
|
- `patchRolesById()` - Update a role's name, description, or permission list; does NOT retroactively update existing AccessGrants
|
|
1075
1106
|
- `deleteRolesById()` - Delete a role; emits a RoleDeleted audit event
|
|
1076
1107
|
|
|
1077
|
-
## Scan
|
|
1108
|
+
## Scan-result
|
|
1078
1109
|
|
|
1079
|
-
- `getScan-results()` - /scan-results operation on
|
|
1080
|
-
- `getScan-resultsById()` - /scan-results/:id operation on
|
|
1110
|
+
- `getScan-results()` - /scan-results operation on scan-result resource
|
|
1111
|
+
- `getScan-resultsById()` - /scan-results/:id operation on scan-result resource
|
|
1081
1112
|
|
|
1082
1113
|
## Scheduling booking
|
|
1083
1114
|
|
|
@@ -1291,7 +1322,11 @@ fields
|
|
|
1291
1322
|
plan tier, vanity slug, and storage spending cap
|
|
1292
1323
|
- `patchTenantsByIdAuto-top-up()` - Configure the auto top-up billing rule for this tenant
|
|
1293
1324
|
- `patchTenantsByIdBranding()` - Owner-only action to update tenant branding
|
|
1325
|
+
- `patchTenantsByIdCancel()` - Permanently cancel a tenant.
|
|
1326
|
+
- `patchTenantsByIdConvert-to-org()` - Convert a personal tenant to an organization
|
|
1327
|
+
- `patchTenantsByIdSuspend()` - Suspend a tenant, preventing billing charges and access.
|
|
1294
1328
|
- `patchTenantsByIdTransfer-ownership()` - Transfer org ownership to an existing admin member
|
|
1329
|
+
- `patchTenantsByIdUnsuspend()` - Restore a suspended tenant to active status.
|
|
1295
1330
|
- `deleteTenantsById()` - Permanently delete a tenant and all associated data
|
|
1296
1331
|
|
|
1297
1332
|
## Thread stats
|
|
@@ -1333,6 +1368,28 @@ plan tier, vanity slug, and storage spending cap
|
|
|
1333
1368
|
- `getTransactions()` - Read user's transactions
|
|
1334
1369
|
- `getTransactionsById()` - Read user's transactions
|
|
1335
1370
|
|
|
1371
|
+
## Trending-snapshot
|
|
1372
|
+
|
|
1373
|
+
- `getSocialTrendingHistoryById()` - /social/trending/history/:id operation on trending-snapshot resource
|
|
1374
|
+
- `getSocialTrendingHistoryRange()` - /social/trending/history/range operation on trending-snapshot resource
|
|
1375
|
+
- `getSocialTrendingHistoryWorkspaceByWorkspaceId()` - /social/trending/history/workspace/:workspace_id operation on trending-snapshot resource
|
|
1376
|
+
- `postSocialTrendingHistory()` - /social/trending/history operation on trending-snapshot resource
|
|
1377
|
+
- `deleteSocialTrendingHistoryById()` - /social/trending/history/:id operation on trending-snapshot resource
|
|
1378
|
+
|
|
1379
|
+
## Trending-snapshot-item
|
|
1380
|
+
|
|
1381
|
+
- `getSocialTrendingItemsById()` - /social/trending/items/:id operation on trending-snapshot-item resource
|
|
1382
|
+
- `getSocialTrendingItemsSnapshotBySnapshotId()` - /social/trending/items/snapshot/:snapshot_id operation on trending-snapshot-item resource
|
|
1383
|
+
|
|
1384
|
+
## Trending-watch
|
|
1385
|
+
|
|
1386
|
+
- `getSocialTrendingWatchesById()` - /social/trending/watches/:id operation on trending-watch resource
|
|
1387
|
+
- `getSocialTrendingWatchesWorkspaceByWorkspaceId()` - /social/trending/watches/workspace/:workspace_id operation on trending-watch resource
|
|
1388
|
+
- `postSocialTrendingWatches()` - /social/trending/watches operation on trending-watch resource
|
|
1389
|
+
- `patchSocialTrendingWatchesById()` - /social/trending/watches/:id operation on trending-watch resource
|
|
1390
|
+
- `patchSocialTrendingWatchesByIdMark-triggered()` - /social/trending/watches/:id/mark-triggered operation on trending-watch resource
|
|
1391
|
+
- `deleteSocialTrendingWatchesById()` - /social/trending/watches/:id operation on trending-watch resource
|
|
1392
|
+
|
|
1336
1393
|
## Users
|
|
1337
1394
|
|
|
1338
1395
|
- `getUser-profiles()` - /user-profiles operation on user_profile resource
|
|
@@ -1415,30 +1472,18 @@ raw preferences map
|
|
|
1415
1472
|
- `getWatcherEventsById()` - Fetch a single ingestion event by ID; use the :list action to query events by workspace, type, machine, or time range.
|
|
1416
1473
|
- `postWatcherEvents()` - Create multiple events in batch
|
|
1417
1474
|
|
|
1418
|
-
## Webhooks
|
|
1419
|
-
|
|
1420
|
-
- `getWebhook-configs()` - /webhook-configs operation on webhook_config resource
|
|
1421
|
-
- `getWebhook-configsById()` - /webhook-configs/:id operation on webhook_config resource
|
|
1422
|
-
- `getWebhook-configsByIdEvents()` - List available events that can be subscribed to
|
|
1423
|
-
- `getWebhook-configsStats()` - Get webhook configuration statistics
|
|
1424
|
-
- `getWebhook-deliveries()` - /webhook-deliveries operation on webhook_delivery resource
|
|
1425
|
-
- `getWebhook-deliveriesById()` - /webhook-deliveries/:id operation on webhook_delivery resource
|
|
1426
|
-
- `getWebhook-deliveriesStats()` - Return aggregate delivery counts by status (total, delivered, failed, retrying)
|
|
1427
|
-
- `postWebhook-configs()` - Register a new webhook endpoint to receive platform events
|
|
1428
|
-
- `postWebhook-configsBulk-disable()` - Disable multiple webhook configs by ID in a single call
|
|
1429
|
-
- `postWebhook-configsBulk-enable()` - Enable multiple webhook configs by ID in a single call
|
|
1430
|
-
- `postWebhook-configsByIdReplay()` - Replay historical events to this webhook
|
|
1431
|
-
- `postWebhook-configsByIdTest()` - Send a realistic sample payload to the webhook URL to verify connectivity and signature verification
|
|
1432
|
-
- `postWebhook-deliveriesBulk-retry()` - Set multiple delivery records to `:retrying` status in bulk
|
|
1433
|
-
- `postWebhook-deliveriesByIdRetry()` - Re-enqueue a failed or pending delivery for immediate re-dispatch
|
|
1434
|
-
- `patchWebhook-configsById()` - Update webhook endpoint settings such as URL, subscribed events, and enabled state
|
|
1435
|
-
- `patchWebhook-configsByIdRotate-secret()` - Generate a new `whsec_`-prefixed HMAC secret for this webhook, invalidating the previous secret immediately
|
|
1436
|
-
- `deleteWebhook-configsById()` - /webhook-configs/:id operation on webhook_config resource
|
|
1437
|
-
|
|
1438
1475
|
## Workspace document stats
|
|
1439
1476
|
|
|
1440
1477
|
- `getTenantsByTenantIdWorkspaceStats()` - /tenants/:tenant_id/workspace_stats operation on workspace_document_stats resource
|
|
1441
1478
|
|
|
1479
|
+
## Workspace-agent-config
|
|
1480
|
+
|
|
1481
|
+
- `getWorkspace-agent-configs()` - /workspace-agent-configs operation on workspace-agent-config resource
|
|
1482
|
+
- `getWorkspace-agent-configsById()` - /workspace-agent-configs/:id operation on workspace-agent-config resource
|
|
1483
|
+
- `postWorkspace-agent-configs()` - /workspace-agent-configs operation on workspace-agent-config resource
|
|
1484
|
+
- `patchWorkspace-agent-configsById()` - /workspace-agent-configs/:id operation on workspace-agent-config resource
|
|
1485
|
+
- `deleteWorkspace-agent-configsById()` - /workspace-agent-configs/:id operation on workspace-agent-config resource
|
|
1486
|
+
|
|
1442
1487
|
## Workspaces
|
|
1443
1488
|
|
|
1444
1489
|
- `getWorkspaces()` - List workspaces visible to the actor
|
package/package.json
CHANGED