@gpt-platform/admin 0.4.3 → 0.5.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 +63567 -42845
- package/dist/index.d.ts +63567 -42845
- package/dist/index.js +9120 -2975
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +9120 -2975
- package/dist/index.mjs.map +1 -1
- package/llms.txt +348 -60
- package/package.json +1 -1
package/llms.txt
CHANGED
|
@@ -62,6 +62,13 @@ client.setConfig({
|
|
|
62
62
|
- `getAgent-version-revisions()` - /agent-version-revisions operation on agent_version_revision resource
|
|
63
63
|
- `getAgent-version-revisionsById()` - /agent-version-revisions/:id operation on agent_version_revision resource
|
|
64
64
|
|
|
65
|
+
## Agent-execution
|
|
66
|
+
|
|
67
|
+
- `getAgent-executions()` - /agent-executions operation on agent-execution resource
|
|
68
|
+
- `getAgent-executionsById()` - /agent-executions/:id operation on agent-execution resource
|
|
69
|
+
- `patchAgent-executionsByIdCancel()` - /agent-executions/:id/cancel operation on agent-execution resource
|
|
70
|
+
- `patchAgent-executionsByIdResume()` - /agent-executions/:id/resume operation on agent-execution resource
|
|
71
|
+
|
|
65
72
|
## AI Agents
|
|
66
73
|
|
|
67
74
|
- `getAgent-versions()` - List AgentVersions, optionally filtered to a specific agent
|
|
@@ -89,6 +96,7 @@ client.setConfig({
|
|
|
89
96
|
- `postAgentsClone-for-workspace()` - Clone a system agent for workspace-specific customization
|
|
90
97
|
- `postAgentsImport()` - Import an agent from a JSON payload produced by `:export`
|
|
91
98
|
- `postAgentsPredict()` - Predicts the best agents for a given input
|
|
99
|
+
- `patchAgent-versionsById()` - Update an AgentVersion's prompt template, field descriptions, or changes summary
|
|
92
100
|
- `patchAgentsByIdSchema-versionsByVersionId()` - Update a schema version without creating a new version
|
|
93
101
|
- `deleteAgent-versionsById()` - Delete an AgentVersion
|
|
94
102
|
- `deleteAgentsByIdTraining-examplesByExampleId()` - Delete a training example belonging to this agent
|
|
@@ -104,27 +112,25 @@ client.setConfig({
|
|
|
104
112
|
|
|
105
113
|
- `getTraining-examples()` - List training examples with filtering support
|
|
106
114
|
- `getTraining-examplesById()` - Fetch a single TrainingExample by ID.
|
|
115
|
+
- `getTraining-sessions()` - /training-sessions operation on training_session resource
|
|
107
116
|
- `getTraining-sessionsAgentsByAgentIdSessions()` - /training-sessions/agents/:agent_id/sessions operation on training_session resource
|
|
108
117
|
- `getTraining-sessionsById()` - /training-sessions/:id operation on training_session resource
|
|
109
118
|
- `postTraining-examples()` - Create a single training example (golden example for few-shot learning)
|
|
110
119
|
- `postTraining-examplesBulk()` - Create multiple training examples in a single transaction using `Ash.bulk_create`
|
|
111
120
|
- `postTraining-examplesBulk-delete()` - Delete multiple training examples by ID in a single transaction
|
|
112
121
|
- `postTraining-examplesSearch()` - Public entry point for semantic similarity search over training examples
|
|
122
|
+
- `postTraining-sessions()` - /training-sessions operation on training_session resource
|
|
113
123
|
- `patchTraining-examplesById()` - Update an existing training example's input text, expected output JSON, notes,
|
|
114
124
|
correction reasons, or image reference
|
|
125
|
+
- `patchTraining-sessionsByIdRevert()` - /training-sessions/:id/revert operation on training_session resource
|
|
115
126
|
- `deleteTraining-examplesById()` - /training-examples/:id operation on training_example resource
|
|
116
127
|
- `deleteTraining-sessionsById()` - /training-sessions/:id operation on training_session resource
|
|
117
128
|
|
|
118
|
-
##
|
|
129
|
+
## Ai-message
|
|
119
130
|
|
|
120
|
-
- `
|
|
121
|
-
- `
|
|
122
|
-
- `
|
|
123
|
-
- `getLlmAnalyticsPlatform()` - Platform-wide analytics summary (platform admin only)
|
|
124
|
-
- `getLlmAnalyticsSummary()` - Aggregate LLM usage and cost statistics optionally filtered by a date range; returns a single summary record.
|
|
125
|
-
- `getLlmAnalyticsUsage()` - Return token usage summary analytics for the caller's tenant; useful for quota monitoring and capacity planning.
|
|
126
|
-
- `getLlmAnalyticsWorkspace()` - Fetch LLM analytics scoped to a single workspace; use for per-workspace usage dashboards and cost attribution.
|
|
127
|
-
- `postLlmAnalytics()` - Append a single LLM call analytics record (model, tokens, latency, cost); called by the billing/analytics pipeline after each LLM invocation
|
|
131
|
+
- `getAiMessages()` - /ai/messages operation on ai-message resource
|
|
132
|
+
- `postAiMessages()` - Append a new message turn (system, user, or assistant) to a Conversation
|
|
133
|
+
- `deleteAiMessagesById()` - /ai/messages/:id operation on ai-message resource
|
|
128
134
|
|
|
129
135
|
## API Keys
|
|
130
136
|
|
|
@@ -174,10 +180,6 @@ flags, workspace mode, and execution limits
|
|
|
174
180
|
|
|
175
181
|
## Billing
|
|
176
182
|
|
|
177
|
-
- `getCredit-packages()` - List all credit packages available for purchase in the calling application
|
|
178
|
-
- `getCredit-packagesById()` - Fetch a single credit package by its UUID
|
|
179
|
-
- `getCredit-packagesSlugBySlug()` - Look up a credit package by its unique slug within an application (e.g., "starter-100",
|
|
180
|
-
"pro-500")
|
|
181
183
|
- `getPlans()` - List all subscription plans and add-ons available in the system
|
|
182
184
|
- `getPlansById()` - Fetch a single plan by its UUID
|
|
183
185
|
- `getPlansSlugBySlug()` - Look up a plan by its unique slug within an application (e.g., "pro", "business", "free")
|
|
@@ -188,10 +190,8 @@ flags, workspace mode, and execution limits
|
|
|
188
190
|
- `getWalletStorage-breakdown()` - Get storage breakdown by workspace
|
|
189
191
|
- `getWalletUsage()` - Get daily credit usage history
|
|
190
192
|
- `getWalletUsage-breakdown()` - Get usage breakdown by workspace
|
|
191
|
-
- `postCredit-packages()` - Create a new credit package (purchasable top-up bundle) for an application
|
|
192
193
|
- `postPlans()` - Create a new subscription plan or add-on for an application
|
|
193
194
|
- `postSubscriptions()` - /subscriptions operation on subscription resource
|
|
194
|
-
- `patchCredit-packagesById()` - Update an existing credit package's name, price, or credit amount
|
|
195
195
|
- `patchPlansById()` - Update an existing plan's pricing, credit allocation, or storage limits
|
|
196
196
|
- `patchSubscriptionsById()` - /subscriptions/:id operation on subscription resource
|
|
197
197
|
- `patchSubscriptionsByIdCancel()` - Cancel a subscription
|
|
@@ -199,10 +199,17 @@ flags, workspace mode, and execution limits
|
|
|
199
199
|
- `patchWalletAddonsByAddonSlugCancel()` - Cancel an active add-on subscription on the wallet
|
|
200
200
|
- `patchWalletCredits()` - Purchase credits (Top-up)
|
|
201
201
|
- `patchWalletPlan()` - Change the main plan for the wallet
|
|
202
|
-
- `deleteCredit-packagesById()` - /credit-packages/:id operation on credit_package resource
|
|
203
202
|
- `deletePlansById()` - /plans/:id operation on plan resource
|
|
204
203
|
- `deleteSubscriptionsById()` - /subscriptions/:id operation on subscription resource
|
|
205
204
|
|
|
205
|
+
## Brand identity
|
|
206
|
+
|
|
207
|
+
- `getBrand-identities()` - /brand-identities operation on brand_identity resource
|
|
208
|
+
- `getBrand-identitiesById()` - /brand-identities/:id operation on brand_identity resource
|
|
209
|
+
- `postBrand-identities()` - /brand-identities operation on brand_identity resource
|
|
210
|
+
- `patchBrand-identitiesById()` - /brand-identities/:id operation on brand_identity resource
|
|
211
|
+
- `deleteBrand-identitiesById()` - /brand-identities/:id operation on brand_identity resource
|
|
212
|
+
|
|
206
213
|
## Breach incident
|
|
207
214
|
|
|
208
215
|
- `getBreach-incidents()` - /breach-incidents operation on breach_incident resource
|
|
@@ -362,6 +369,14 @@ flags, workspace mode, and execution limits
|
|
|
362
369
|
- `postCatalogView-rules()` - Add a filter rule to a catalog view; rules in the same group are AND'd, multiple groups are OR'd
|
|
363
370
|
- `deleteCatalogView-rulesById()` - Permanently delete a view rule; the view is re-evaluated without this rule on next resolution.
|
|
364
371
|
|
|
372
|
+
## Chunk entity link
|
|
373
|
+
|
|
374
|
+
- `getExtractionChunk-entity-links()` - /extraction/chunk-entity-links operation on chunk_entity_link resource
|
|
375
|
+
- `getExtractionChunk-entity-linksById()` - /extraction/chunk-entity-links/:id operation on chunk_entity_link resource
|
|
376
|
+
- `getExtractionChunk-entity-linksChunkByDocumentChunkId()` - /extraction/chunk-entity-links/chunk/:document_chunk_id operation on chunk_entity_link resource
|
|
377
|
+
- `getExtractionChunk-entity-linksDocumentByDocumentId()` - /extraction/chunk-entity-links/document/:document_id operation on chunk_entity_link resource
|
|
378
|
+
- `getExtractionChunk-entity-linksEntityByGraphNodeId()` - /extraction/chunk-entity-links/entity/:graph_node_id operation on chunk_entity_link resource
|
|
379
|
+
|
|
365
380
|
## Config
|
|
366
381
|
|
|
367
382
|
- `getConfigs()` - /configs operation on config resource
|
|
@@ -444,11 +459,22 @@ flags, workspace mode, and execution limits
|
|
|
444
459
|
- `getConnectorsCredentialsById()` - /connectors/credentials/:id operation on credential resource
|
|
445
460
|
- `postConnectorsCredentialsByIdRefresh()` - Refresh OAuth credential token.
|
|
446
461
|
|
|
462
|
+
## Credit-package
|
|
463
|
+
|
|
464
|
+
- `getCredit-packages()` - List all credit packages available for purchase in the calling application
|
|
465
|
+
- `getCredit-packagesById()` - Fetch a single credit package by its UUID
|
|
466
|
+
- `getCredit-packagesSlugBySlug()` - Look up a credit package by its unique slug within an application (e.g., "starter-100",
|
|
467
|
+
"pro-500")
|
|
468
|
+
- `postCredit-packages()` - Create a new credit package (purchasable top-up bundle) for an application
|
|
469
|
+
- `patchCredit-packagesById()` - Update an existing credit package's name, price, or credit amount
|
|
470
|
+
- `deleteCredit-packagesById()` - /credit-packages/:id operation on credit-package resource
|
|
471
|
+
|
|
447
472
|
## Crm activity
|
|
448
473
|
|
|
449
474
|
- `getCrmActivitiesById()` - Fetch a single active activity by ID; excludes soft-deleted records.
|
|
450
475
|
- `getCrmActivitiesWorkspaceByWorkspaceId()` - List active activities in a workspace with offset pagination
|
|
451
476
|
- `postCrmActivities()` - Log a CRM activity (call, email, meeting, note, etc.) linked to the workspace
|
|
477
|
+
- `patchCrmActivitiesById()` - Update an activity's subject, body, sentiment, or AI-generated fields
|
|
452
478
|
- `deleteCrmActivitiesById()` - Soft-delete an activity by setting deleted_at
|
|
453
479
|
|
|
454
480
|
## Crm channel capture config
|
|
@@ -501,6 +527,7 @@ attribute-level property filters
|
|
|
501
527
|
|
|
502
528
|
## Crm custom field definition
|
|
503
529
|
|
|
530
|
+
- `getIsvCrmField-definitionsById()` - /isv/crm/field-definitions/:id operation on crm_custom_field_definition resource
|
|
504
531
|
- `getIsvCrmField-definitionsEntity-typeByEntityType()` - List all custom field definitions for a given application and entity type
|
|
505
532
|
- `postIsvCrmField-definitions()` - Define a custom field for a core CRM entity type (contact, company, deal, activity)
|
|
506
533
|
- `patchIsvCrmField-definitionsById()` - Update display metadata and validation rules for an existing custom field
|
|
@@ -511,6 +538,7 @@ attribute-level property filters
|
|
|
511
538
|
- `getCrmExportsById()` - Fetch a single export job by ID
|
|
512
539
|
- `getCrmExportsWorkspaceByWorkspaceId()` - List all export jobs for a workspace, sorted newest first
|
|
513
540
|
- `postCrmExports()` - Enqueue an async CRM data export job
|
|
541
|
+
- `patchCrmExportsByIdRefresh-url()` - Regenerate the presigned download URL for a completed export job
|
|
514
542
|
|
|
515
543
|
## Crm deal
|
|
516
544
|
|
|
@@ -518,11 +546,13 @@ attribute-level property filters
|
|
|
518
546
|
- `getCrmDealsWorkspaceByWorkspaceId()` - List active deals in a workspace with offset pagination
|
|
519
547
|
- `postCrmDeals()` - Create a new CRM deal and place it in a pipeline stage
|
|
520
548
|
- `patchCrmDealsById()` - Update deal fields including status, AI scores, and pipeline assignment
|
|
549
|
+
- `patchCrmDealsByIdMove-stage()` - Move a deal to a different pipeline stage
|
|
521
550
|
- `deleteCrmDealsById()` - Soft-delete a deal by setting deleted_at
|
|
522
551
|
|
|
523
552
|
## Crm deal product
|
|
524
553
|
|
|
525
554
|
- `getCrmDeal-products()` - /crm/deal-products operation on crm_deal_product resource
|
|
555
|
+
- `getCrmDeal-productsById()` - /crm/deal-products/:id operation on crm_deal_product resource
|
|
526
556
|
- `postCrmDeal-products()` - Link a catalog product to a deal with quantity and negotiated unit price
|
|
527
557
|
- `deleteCrmDeal-productsById()` - /crm/deal-products/:id operation on crm_deal_product resource
|
|
528
558
|
|
|
@@ -537,6 +567,7 @@ attribute-level property filters
|
|
|
537
567
|
## Crm pipeline stage
|
|
538
568
|
|
|
539
569
|
- `getCrmPipeline-stagesById()` - /crm/pipeline-stages/:id operation on crm_pipeline_stage resource
|
|
570
|
+
- `getCrmPipeline-stagesPipelineByPipelineId()` - List all stages for a specific pipeline, ordered by position.
|
|
540
571
|
- `postCrmPipeline-stages()` - Add a stage to a pipeline with an explicit sort order, optional win probability, and forecast category
|
|
541
572
|
- `patchCrmPipeline-stagesById()` - Update a pipeline stage's name, order, probability, or closed flag
|
|
542
573
|
- `deleteCrmPipeline-stagesById()` - /crm/pipeline-stages/:id operation on crm_pipeline_stage resource
|
|
@@ -636,6 +667,23 @@ again
|
|
|
636
667
|
- `patchApplicationsByApplicationIdEmail-templatesBySlug()` - Update the display name, subject, body, branding color, or enabled state of an existing template
|
|
637
668
|
- `deleteApplicationsByApplicationIdEmail-templatesBySlug()` - /applications/:application_id/email-templates/:slug operation on email_template resource
|
|
638
669
|
|
|
670
|
+
## Email-inbound-address
|
|
671
|
+
|
|
672
|
+
- `getEmailInbound-addressesById()` - /email/inbound-addresses/:id operation on email-inbound-address resource
|
|
673
|
+
- `getEmailInbound-addressesWorkspaceByWorkspaceId()` - /email/inbound-addresses/workspace/:workspace_id operation on email-inbound-address resource
|
|
674
|
+
- `postEmailInbound-addresses()` - /email/inbound-addresses operation on email-inbound-address resource
|
|
675
|
+
- `patchEmailInbound-addressesById()` - /email/inbound-addresses/:id operation on email-inbound-address resource
|
|
676
|
+
- `patchEmailInbound-addressesByIdDisable()` - /email/inbound-addresses/:id/disable operation on email-inbound-address resource
|
|
677
|
+
- `patchEmailInbound-addressesByIdEnable()` - /email/inbound-addresses/:id/enable operation on email-inbound-address resource
|
|
678
|
+
- `patchEmailInbound-addressesByIdRotate-token()` - /email/inbound-addresses/:id/rotate-token operation on email-inbound-address resource
|
|
679
|
+
- `deleteEmailInbound-addressesById()` - /email/inbound-addresses/:id operation on email-inbound-address resource
|
|
680
|
+
|
|
681
|
+
## Email-inbound-email
|
|
682
|
+
|
|
683
|
+
- `getEmailInboundReceivedAddressByInboundAddressId()` - /email/inbound/received/address/:inbound_address_id operation on email-inbound-email resource
|
|
684
|
+
- `getEmailInboundReceivedById()` - /email/inbound/received/:id operation on email-inbound-email resource
|
|
685
|
+
- `getEmailInboundReceivedWorkspaceByWorkspaceId()` - /email/inbound/received/workspace/:workspace_id operation on email-inbound-email resource
|
|
686
|
+
|
|
639
687
|
## Email-inclusion
|
|
640
688
|
|
|
641
689
|
- `getEmailInclusionsById()` - /email/inclusions/:id operation on email-inclusion resource
|
|
@@ -747,6 +795,11 @@ again
|
|
|
747
795
|
|
|
748
796
|
- `postAiEmbed()` - Generate a 1024-dim vector embedding for the given text via the LlmTriage sidecar; validates workspace membership, estimates token cost, charges credits, and returns the embedding with usage stats.
|
|
749
797
|
|
|
798
|
+
## Extraction analysis
|
|
799
|
+
|
|
800
|
+
- `getExtractionAnalyses()` - /extraction/analyses operation on extraction_analysis resource
|
|
801
|
+
- `getExtractionAnalysesById()` - /extraction/analyses/:id operation on extraction_analysis resource
|
|
802
|
+
|
|
750
803
|
## Extraction Batches
|
|
751
804
|
|
|
752
805
|
- `getExtractionBatchesById()` - /extraction/batches/:id operation on extraction_batch resource
|
|
@@ -783,6 +836,21 @@ fields
|
|
|
783
836
|
- `patchExtraction-workflowsById()` - /extraction-workflows/:id operation on extraction_workflow resource
|
|
784
837
|
- `deleteExtraction-workflowsById()` - /extraction-workflows/:id operation on extraction_workflow resource
|
|
785
838
|
|
|
839
|
+
## Feature definition
|
|
840
|
+
|
|
841
|
+
- `getFeature-definitions()` - List all feature definitions
|
|
842
|
+
- `getFeature-definitionsBy-applicationByApplicationId()` - List feature definitions for a specific application.
|
|
843
|
+
- `getFeature-definitionsById()` - Fetch a single feature definition by ID.
|
|
844
|
+
- `postFeature-definitions()` - Create a new ISV-defined feature for an application
|
|
845
|
+
- `patchFeature-definitionsById()` - Update a feature definition's configuration.
|
|
846
|
+
- `deleteFeature-definitionsById()` - /feature-definitions/:id operation on feature_definition resource
|
|
847
|
+
|
|
848
|
+
## Feature-usage
|
|
849
|
+
|
|
850
|
+
- `getFeature-usages()` - List all feature usage records.
|
|
851
|
+
- `getFeature-usagesBy-tenantByTenantId()` - List feature usage records for a specific tenant.
|
|
852
|
+
- `getFeature-usagesById()` - Fetch a single feature usage record by ID.
|
|
853
|
+
|
|
786
854
|
## Field mapping confirmation
|
|
787
855
|
|
|
788
856
|
- `postWorkspacesByWorkspaceIdExtractionByDocumentIdMapping()` - /workspaces/:workspace_id/extraction/:document_id/mapping operation on field_mapping_confirmation resource
|
|
@@ -811,18 +879,18 @@ fields
|
|
|
811
879
|
- `patchInvitationsByIdResend()` - Resend an invitation email with a refreshed token and a new 7-day expiry
|
|
812
880
|
- `patchInvitationsByIdRevoke()` - Cancel a pending invitation by setting its status to :revoked
|
|
813
881
|
|
|
814
|
-
## Isv
|
|
882
|
+
## Isv-revenue
|
|
815
883
|
|
|
816
|
-
- `getIsv-revenue()` - /isv-revenue operation on
|
|
817
|
-
- `getIsv-revenueById()` - /isv-revenue/:id operation on
|
|
818
|
-
- `postIsv-revenue()` - /isv-revenue operation on
|
|
884
|
+
- `getIsv-revenue()` - /isv-revenue operation on isv-revenue resource
|
|
885
|
+
- `getIsv-revenueById()` - /isv-revenue/:id operation on isv-revenue resource
|
|
886
|
+
- `postIsv-revenue()` - /isv-revenue operation on isv-revenue resource
|
|
819
887
|
|
|
820
|
-
## Isv
|
|
888
|
+
## Isv-settlement
|
|
821
889
|
|
|
822
|
-
- `getIsv-settlements()` - /isv-settlements operation on
|
|
823
|
-
- `getIsv-settlementsById()` - /isv-settlements/:id operation on
|
|
824
|
-
- `postIsv-settlements()` - /isv-settlements operation on
|
|
825
|
-
- `patchIsv-settlementsById()` - /isv-settlements/:id operation on
|
|
890
|
+
- `getIsv-settlements()` - /isv-settlements operation on isv-settlement resource
|
|
891
|
+
- `getIsv-settlementsById()` - /isv-settlements/:id operation on isv-settlement resource
|
|
892
|
+
- `postIsv-settlements()` - /isv-settlements operation on isv-settlement resource
|
|
893
|
+
- `patchIsv-settlementsById()` - /isv-settlements/:id operation on isv-settlement resource
|
|
826
894
|
|
|
827
895
|
## Knowledge Graph
|
|
828
896
|
|
|
@@ -855,18 +923,26 @@ fields
|
|
|
855
923
|
- `patchLegal-documentsByIdUnpublish()` - Deactivate a legal document without deleting it
|
|
856
924
|
- `deleteLegal-documentsById()` - /legal-documents/:id operation on legal_document resource
|
|
857
925
|
|
|
926
|
+
## Llm-analytics
|
|
927
|
+
|
|
928
|
+
- `getLlm-analytics()` - List LLM analytics records sorted by created_at descending; scoped to the caller's tenant.
|
|
929
|
+
- `getLlm-analyticsById()` - /llm-analytics/:id operation on llm-analytics resource
|
|
930
|
+
- `getLlm-analyticsCosts()` - Retrieve cost-focused analytics records for the caller's tenant; use for billing reconciliation and cost analysis.
|
|
931
|
+
- `getLlm-analyticsPlatform()` - Platform-wide analytics summary (platform admin only)
|
|
932
|
+
- `getLlm-analyticsSummary()` - Aggregate LLM usage and cost statistics optionally filtered by a date range; returns a single summary record.
|
|
933
|
+
- `getLlm-analyticsUsage()` - Return token usage summary analytics for the caller's tenant; useful for quota monitoring and capacity planning.
|
|
934
|
+
- `getLlm-analyticsWorkspace()` - Fetch LLM analytics scoped to a single workspace; use for per-workspace usage dashboards and cost attribution.
|
|
935
|
+
- `postLlm-analytics()` - Append a single LLM call analytics record (model, tokens, latency, cost); called by the billing/analytics pipeline after each LLM invocation
|
|
936
|
+
|
|
858
937
|
## Messages
|
|
859
938
|
|
|
860
|
-
- `getAiMessages()` - /ai/messages operation on message resource
|
|
861
939
|
- `getMessages()` - /messages operation on message resource
|
|
862
940
|
- `getMessagesById()` - /messages/:id operation on message resource
|
|
863
941
|
- `getMessagesSearch()` - Full-text search messages by substring match on content within the actor's accessible threads
|
|
864
942
|
- `getMessagesSemantic-search()` - Vector similarity search across messages using a generated embedding of the query string
|
|
865
943
|
- `getThreadsByIdMessages()` - /threads/:id/messages operation on message resource
|
|
866
|
-
- `postAiMessages()` - Append a new message turn (system, user, or assistant) to a Conversation
|
|
867
944
|
- `postMessages()` - Add a new message turn to a thread
|
|
868
945
|
- `patchMessagesById()` - Edit a message's content, role, or metadata
|
|
869
|
-
- `deleteAiMessagesById()` - /ai/messages/:id operation on message resource
|
|
870
946
|
- `deleteMessagesById()` - /messages/:id operation on message resource
|
|
871
947
|
|
|
872
948
|
## Notification log
|
|
@@ -906,15 +982,15 @@ fields
|
|
|
906
982
|
|
|
907
983
|
- `postDocumentsBulk-delete()` - /documents/bulk-delete operation on operation_success resource
|
|
908
984
|
|
|
909
|
-
## Payment
|
|
985
|
+
## Payment-method
|
|
910
986
|
|
|
911
|
-
- `getPayment-methods()` - /payment-methods operation on
|
|
912
|
-
- `getPayment-methodsById()` - /payment-methods/:id operation on
|
|
987
|
+
- `getPayment-methods()` - /payment-methods operation on payment-method resource
|
|
988
|
+
- `getPayment-methodsById()` - /payment-methods/:id operation on payment-method resource
|
|
913
989
|
- `postPayment-methods()` - Save a pre-tokenized payment method for a customer
|
|
914
990
|
- `postPayment-methodsTokenize()` - Create a payment method via direct proxy tokenization (S2S)
|
|
915
991
|
- `patchPayment-methodsById()` - Update a saved payment method's nickname or default status
|
|
916
992
|
- `patchPayment-methodsByIdDefault()` - Set this payment method as default for the customer
|
|
917
|
-
- `deletePayment-methodsById()` - /payment-methods/:id operation on
|
|
993
|
+
- `deletePayment-methodsById()` - /payment-methods/:id operation on payment-method resource
|
|
918
994
|
|
|
919
995
|
## Permission
|
|
920
996
|
|
|
@@ -930,6 +1006,23 @@ fields
|
|
|
930
1006
|
|
|
931
1007
|
- `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.
|
|
932
1008
|
|
|
1009
|
+
## Plan-feature-allocation
|
|
1010
|
+
|
|
1011
|
+
- `getPlan-feature-allocations()` - List all plan feature allocations.
|
|
1012
|
+
- `getPlan-feature-allocationsBy-planByPlanId()` - List feature allocations for a specific plan.
|
|
1013
|
+
- `getPlan-feature-allocationsById()` - Fetch a single plan feature allocation by ID.
|
|
1014
|
+
- `postPlan-feature-allocations()` - Create a plan-level override for a feature definition
|
|
1015
|
+
- `patchPlan-feature-allocationsById()` - Update a plan feature allocation's overrides.
|
|
1016
|
+
- `deletePlan-feature-allocationsById()` - /plan-feature-allocations/:id operation on plan-feature-allocation resource
|
|
1017
|
+
|
|
1018
|
+
## Platform tone
|
|
1019
|
+
|
|
1020
|
+
- `getPlatform-tones()` - /platform-tones operation on platform_tone resource
|
|
1021
|
+
- `getPlatform-tonesById()` - /platform-tones/:id operation on platform_tone resource
|
|
1022
|
+
- `postPlatform-tones()` - /platform-tones operation on platform_tone resource
|
|
1023
|
+
- `patchPlatform-tonesById()` - /platform-tones/:id operation on platform_tone resource
|
|
1024
|
+
- `deletePlatform-tonesById()` - /platform-tones/:id operation on platform_tone resource
|
|
1025
|
+
|
|
933
1026
|
## Platform-pricing-config
|
|
934
1027
|
|
|
935
1028
|
- `getPlatform-pricing-configs()` - /platform-pricing-configs operation on platform-pricing-config resource
|
|
@@ -938,6 +1031,26 @@ fields
|
|
|
938
1031
|
- `patchPlatform-pricing-configsById()` - /platform-pricing-configs/:id operation on platform-pricing-config resource
|
|
939
1032
|
- `deletePlatform-pricing-configsById()` - /platform-pricing-configs/:id operation on platform-pricing-config resource
|
|
940
1033
|
|
|
1034
|
+
## Portal-change-request
|
|
1035
|
+
|
|
1036
|
+
- `getPortal-change-requests()` - /portal-change-requests operation on portal-change-request resource
|
|
1037
|
+
- `patchPortal-change-requestsByIdApprove()` - /portal-change-requests/:id/approve operation on portal-change-request resource
|
|
1038
|
+
- `patchPortal-change-requestsByIdReject()` - /portal-change-requests/:id/reject operation on portal-change-request resource
|
|
1039
|
+
|
|
1040
|
+
## Portal-invitation
|
|
1041
|
+
|
|
1042
|
+
- `getPortal-invitations()` - /portal-invitations operation on portal-invitation resource
|
|
1043
|
+
- `postPortal-invitations()` - /portal-invitations operation on portal-invitation resource
|
|
1044
|
+
- `deletePortal-invitationsById()` - /portal-invitations/:id operation on portal-invitation resource
|
|
1045
|
+
|
|
1046
|
+
## Post metric
|
|
1047
|
+
|
|
1048
|
+
- `getSocialMetricsAccountBySocialAccountId()` - /social/metrics/account/:social_account_id operation on post_metric resource
|
|
1049
|
+
- `getSocialMetricsById()` - /social/metrics/:id operation on post_metric resource
|
|
1050
|
+
- `getSocialMetricsCampaignBySocialCampaignId()` - /social/metrics/campaign/:social_campaign_id operation on post_metric resource
|
|
1051
|
+
- `getSocialMetricsPostBySocialPostId()` - /social/metrics/post/:social_post_id operation on post_metric resource
|
|
1052
|
+
- `getSocialMetricsPostBySocialPostIdLatest()` - /social/metrics/post/:social_post_id/latest operation on post_metric resource
|
|
1053
|
+
|
|
941
1054
|
## Post processing hook
|
|
942
1055
|
|
|
943
1056
|
- `getPost-processing-hooks()` - /post-processing-hooks operation on post_processing_hook resource
|
|
@@ -950,20 +1063,20 @@ fields
|
|
|
950
1063
|
|
|
951
1064
|
- `postDocumentsPresigned-upload()` - /documents/presigned-upload operation on presigned_url resource
|
|
952
1065
|
|
|
953
|
-
## Pricing
|
|
1066
|
+
## Pricing-rule
|
|
954
1067
|
|
|
955
|
-
- `getPricing-rules()` - /pricing-rules operation on
|
|
956
|
-
- `getPricing-rulesById()` - /pricing-rules/:id operation on
|
|
957
|
-
- `getPricing-rulesResolve()` - /pricing-rules/resolve operation on
|
|
958
|
-
- `postPricing-rules()` - /pricing-rules operation on
|
|
959
|
-
- `patchPricing-rulesById()` - /pricing-rules/:id operation on
|
|
1068
|
+
- `getPricing-rules()` - /pricing-rules operation on pricing-rule resource
|
|
1069
|
+
- `getPricing-rulesById()` - /pricing-rules/:id operation on pricing-rule resource
|
|
1070
|
+
- `getPricing-rulesResolve()` - /pricing-rules/resolve operation on pricing-rule resource
|
|
1071
|
+
- `postPricing-rules()` - /pricing-rules operation on pricing-rule resource
|
|
1072
|
+
- `patchPricing-rulesById()` - /pricing-rules/:id operation on pricing-rule resource
|
|
960
1073
|
|
|
961
|
-
## Pricing
|
|
1074
|
+
## Pricing-strategy
|
|
962
1075
|
|
|
963
|
-
- `getPricing-strategies()` - /pricing-strategies operation on
|
|
964
|
-
- `getPricing-strategiesById()` - /pricing-strategies/:id operation on
|
|
965
|
-
- `postPricing-strategies()` - /pricing-strategies operation on
|
|
966
|
-
- `patchPricing-strategiesById()` - /pricing-strategies/:id operation on
|
|
1076
|
+
- `getPricing-strategies()` - /pricing-strategies operation on pricing-strategy resource
|
|
1077
|
+
- `getPricing-strategiesById()` - /pricing-strategies/:id operation on pricing-strategy resource
|
|
1078
|
+
- `postPricing-strategies()` - /pricing-strategies operation on pricing-strategy resource
|
|
1079
|
+
- `patchPricing-strategiesById()` - /pricing-strategies/:id operation on pricing-strategy resource
|
|
967
1080
|
|
|
968
1081
|
## Processing activity
|
|
969
1082
|
|
|
@@ -998,32 +1111,39 @@ fields
|
|
|
998
1111
|
- `getSchedulingAvailability-rulesById()` - Fetch a single availability rule by ID
|
|
999
1112
|
- `postSchedulingAvailability-rules()` - Create an availability rule for a user or event type
|
|
1000
1113
|
- `patchSchedulingAvailability-rulesById()` - Update an availability rule's schedule, date overrides, or active period
|
|
1114
|
+
- `deleteSchedulingAvailability-rulesById()` - Hard-delete an availability rule
|
|
1001
1115
|
|
|
1002
1116
|
## Scheduling booking
|
|
1003
1117
|
|
|
1004
1118
|
- `getSchedulingBookings()` - List all bookings for a workspace
|
|
1005
1119
|
- `getSchedulingBookingsById()` - Fetch a single booking by ID
|
|
1006
1120
|
- `postSchedulingBookings()` - Create a booking for an external party claiming a time slot
|
|
1007
|
-
- `
|
|
1008
|
-
- `
|
|
1009
|
-
- `
|
|
1121
|
+
- `patchSchedulingBookingsByIdCancel()` - Cancel a booking, recording cancellation_reason and cancelled_by (:booker/:organizer/:system)
|
|
1122
|
+
- `patchSchedulingBookingsByIdConfirm()` - Approve a pending booking, setting status to :confirmed and confirmed_at timestamp
|
|
1123
|
+
- `patchSchedulingBookingsByIdMark-no-show()` - Mark a booking as :no_show when the booker did not attend
|
|
1124
|
+
- `patchSchedulingBookingsByIdReschedule()` - Reschedule a booking by moving its linked Event to new_start_time/new_end_time
|
|
1010
1125
|
|
|
1011
1126
|
## Scheduling calendar sync
|
|
1012
1127
|
|
|
1013
1128
|
- `getSchedulingCalendar-syncs()` - List all calendar sync configurations for a specific user
|
|
1014
1129
|
- `getSchedulingCalendar-syncsById()` - Fetch a single calendar sync configuration by ID
|
|
1015
1130
|
- `postSchedulingCalendar-syncs()` - Link a user's external calendar for bi-directional sync
|
|
1016
|
-
- `patchSchedulingCalendar-
|
|
1017
|
-
- `patchSchedulingCalendar-
|
|
1018
|
-
- `patchSchedulingCalendar-
|
|
1019
|
-
- `deleteSchedulingCalendar-
|
|
1131
|
+
- `patchSchedulingCalendar-syncsById()` - Update calendar sync settings: name, direction, poll interval, or custom metadata
|
|
1132
|
+
- `patchSchedulingCalendar-syncsByIdPause()` - Pause calendar sync by setting sync_status to :paused
|
|
1133
|
+
- `patchSchedulingCalendar-syncsByIdResume()` - Resume a paused or errored calendar sync
|
|
1134
|
+
- `deleteSchedulingCalendar-syncsById()` - Hard-delete a calendar sync configuration, stopping all future sync runs for this calendar
|
|
1020
1135
|
|
|
1021
1136
|
## Scheduling event
|
|
1022
1137
|
|
|
1023
1138
|
- `getSchedulingEvents()` - List all events in a workspace, newest first
|
|
1139
|
+
- `getSchedulingEventsByDateRange()` - List events in a workspace that overlap a given time window (start_time < end, end_time > start)
|
|
1024
1140
|
- `getSchedulingEventsById()` - Fetch a single event by ID
|
|
1141
|
+
- `getSchedulingEventsByParticipant()` - List events that include a specific participant by email, scoped to the workspace
|
|
1025
1142
|
- `postSchedulingEvents()` - Create a scheduled event occurrence
|
|
1026
1143
|
- `patchSchedulingEventsById()` - Update event metadata: title, description, timezone, location, notes, or custom metadata
|
|
1144
|
+
- `patchSchedulingEventsByIdCancel()` - Cancel an event, recording an optional cancellation_reason
|
|
1145
|
+
- `patchSchedulingEventsByIdComplete()` - Mark a confirmed event as completed
|
|
1146
|
+
- `patchSchedulingEventsByIdReschedule()` - Move an event to a new time slot
|
|
1027
1147
|
|
|
1028
1148
|
## Scheduling event type
|
|
1029
1149
|
|
|
@@ -1045,6 +1165,8 @@ fields
|
|
|
1045
1165
|
- `getSchedulingParticipantsById()` - Fetch a single participant by ID
|
|
1046
1166
|
- `postSchedulingParticipants()` - Add a participant to an event
|
|
1047
1167
|
- `patchSchedulingParticipantsById()` - Update participant metadata: name, phone, role, or custom metadata
|
|
1168
|
+
- `patchSchedulingParticipantsByIdRespond()` - Record a participant's RSVP: :accepted, :declined, or :tentative
|
|
1169
|
+
- `deleteSchedulingParticipantsById()` - Hard-delete a participant from an event
|
|
1048
1170
|
|
|
1049
1171
|
## Scheduling reminder
|
|
1050
1172
|
|
|
@@ -1093,6 +1215,54 @@ fields
|
|
|
1093
1215
|
- `getSettlementsById()` - /settlements/:id operation on settlement resource
|
|
1094
1216
|
- `postSettlements()` - /settlements operation on settlement resource
|
|
1095
1217
|
|
|
1218
|
+
## Shadow comparison
|
|
1219
|
+
|
|
1220
|
+
- `getExtractionShadow-comparisons()` - /extraction/shadow-comparisons operation on shadow_comparison resource
|
|
1221
|
+
- `getExtractionShadow-comparisonsAnalysis()` - Retrieve shadow comparison results for analysis
|
|
1222
|
+
- `getExtractionShadow-comparisonsById()` - /extraction/shadow-comparisons/:id operation on shadow_comparison resource
|
|
1223
|
+
- `postExtractionShadow-comparisons()` - /extraction/shadow-comparisons operation on shadow_comparison resource
|
|
1224
|
+
- `deleteExtractionShadow-comparisonsById()` - /extraction/shadow-comparisons/:id operation on shadow_comparison resource
|
|
1225
|
+
|
|
1226
|
+
## Social account
|
|
1227
|
+
|
|
1228
|
+
- `getSocialAccountsById()` - /social/accounts/:id operation on social_account resource
|
|
1229
|
+
- `getSocialAccountsPlatformByPlatform()` - /social/accounts/platform/:platform operation on social_account resource
|
|
1230
|
+
- `getSocialAccountsWorkspaceByWorkspaceId()` - /social/accounts/workspace/:workspace_id operation on social_account resource
|
|
1231
|
+
- `postSocialAccounts()` - /social/accounts operation on social_account resource
|
|
1232
|
+
- `patchSocialAccountsById()` - /social/accounts/:id operation on social_account resource
|
|
1233
|
+
- `patchSocialAccountsByIdDeactivate()` - /social/accounts/:id/deactivate operation on social_account resource
|
|
1234
|
+
- `patchSocialAccountsByIdDisable-posting()` - /social/accounts/:id/disable-posting operation on social_account resource
|
|
1235
|
+
- `patchSocialAccountsByIdEnable-posting()` - /social/accounts/:id/enable-posting operation on social_account resource
|
|
1236
|
+
- `deleteSocialAccountsById()` - /social/accounts/:id operation on social_account resource
|
|
1237
|
+
|
|
1238
|
+
## Social campaign
|
|
1239
|
+
|
|
1240
|
+
- `getSocialCampaigns()` - /social/campaigns operation on social_campaign resource
|
|
1241
|
+
- `getSocialCampaignsById()` - /social/campaigns/:id operation on social_campaign resource
|
|
1242
|
+
- `postSocialCampaigns()` - /social/campaigns operation on social_campaign resource
|
|
1243
|
+
- `postSocialCampaignsByIdAdapt-for-platforms()` - Adapt master copy for each target platform
|
|
1244
|
+
- `postSocialCampaignsByIdGenerate-master-copy()` - Generate master copy from content brief using AI
|
|
1245
|
+
- `patchSocialCampaignsById()` - /social/campaigns/:id operation on social_campaign resource
|
|
1246
|
+
- `patchSocialCampaignsByIdCancel()` - /social/campaigns/:id/cancel operation on social_campaign resource
|
|
1247
|
+
- `patchSocialCampaignsByIdSchedule()` - /social/campaigns/:id/schedule operation on social_campaign resource
|
|
1248
|
+
- `deleteSocialCampaignsById()` - /social/campaigns/:id operation on social_campaign resource
|
|
1249
|
+
|
|
1250
|
+
## Social post
|
|
1251
|
+
|
|
1252
|
+
- `getSocialPostsAccountBySocialAccountId()` - /social/posts/account/:social_account_id operation on social_post resource
|
|
1253
|
+
- `getSocialPostsById()` - /social/posts/:id operation on social_post resource
|
|
1254
|
+
- `getSocialPostsCampaignBySocialCampaignId()` - /social/posts/campaign/:social_campaign_id operation on social_post resource
|
|
1255
|
+
- `getSocialPostsScheduled()` - /social/posts/scheduled operation on social_post resource
|
|
1256
|
+
- `getSocialPostsWorkspaceByWorkspaceId()` - /social/posts/workspace/:workspace_id operation on social_post resource
|
|
1257
|
+
- `postSocialPosts()` - /social/posts operation on social_post resource
|
|
1258
|
+
- `patchSocialPostsById()` - /social/posts/:id operation on social_post resource
|
|
1259
|
+
- `patchSocialPostsByIdCancel()` - /social/posts/:id/cancel operation on social_post resource
|
|
1260
|
+
- `patchSocialPostsByIdPublish()` - /social/posts/:id/publish operation on social_post resource
|
|
1261
|
+
- `patchSocialPostsByIdRetry()` - /social/posts/:id/retry operation on social_post resource
|
|
1262
|
+
- `patchSocialPostsByIdSchedule()` - /social/posts/:id/schedule operation on social_post resource
|
|
1263
|
+
- `patchSocialPostsByIdSeo()` - /social/posts/:id/seo operation on social_post resource
|
|
1264
|
+
- `deleteSocialPostsById()` - /social/posts/:id operation on social_post resource
|
|
1265
|
+
|
|
1096
1266
|
## Storage
|
|
1097
1267
|
|
|
1098
1268
|
- `getBuckets()` - List or fetch buckets; excludes processing-type buckets by default
|
|
@@ -1106,16 +1276,124 @@ fields
|
|
|
1106
1276
|
## Storage file
|
|
1107
1277
|
|
|
1108
1278
|
- `getStorage-files()` - /storage-files operation on storage_file resource
|
|
1279
|
+
- `getStorage-filesBy-checksum()` - Fetch non-deleted files matching a given checksum
|
|
1109
1280
|
- `getStorage-filesById()` - /storage-files/:id operation on storage_file resource
|
|
1281
|
+
- `getStorage-filesChildren()` - List non-deleted files whose parent_id matches the given ID
|
|
1110
1282
|
- `postStorage-files()` - Create a StorageFile tracking record; use Storage.request_upload/5 via the facade for the full two-phase upload flow with presigned URLs.
|
|
1111
1283
|
- `patchStorage-filesById()` - Update file metadata, tags, visibility, key, namespace, or status
|
|
1284
|
+
- `patchStorage-filesByIdArchive()` - Archive an active file; soft-hides it from default views while preserving the S3 object
|
|
1285
|
+
- `patchStorage-filesByIdConfirm-upload()` - Transition a pending_upload file to active after the client has uploaded to the presigned URL; optionally stamps size_bytes and checksum.
|
|
1286
|
+
- `patchStorage-filesByIdRestore()` - Restore an archived file back to active status so it becomes accessible again.
|
|
1112
1287
|
- `patchStorage-filesByIdSoft-delete()` - Mark an active file as pending_deletion; the S3 object is deleted by PendingDeletionWorker after the grace period
|
|
1288
|
+
- `patchStorage-filesByIdTag()` - Replace the tags list on a file
|
|
1289
|
+
- `patchStorage-filesByIdUpdate-metadata()` - Merge new_metadata into the existing metadata map (shallow merge)
|
|
1113
1290
|
|
|
1114
1291
|
## Storage stats
|
|
1115
1292
|
|
|
1116
1293
|
- `getStorageStats()` - Get platform-wide storage statistics
|
|
1117
1294
|
- `getStorageStatsTenantByTenantId()` - Get storage stats for a specific tenant
|
|
1118
1295
|
|
|
1296
|
+
## Storage-recommendation
|
|
1297
|
+
|
|
1298
|
+
- `getStorage-recommendations()` - /storage-recommendations operation on storage-recommendation resource
|
|
1299
|
+
- `getStorage-recommendationsPending()` - /storage-recommendations/pending operation on storage-recommendation resource
|
|
1300
|
+
- `patchStorage-recommendationsByIdAccept()` - /storage-recommendations/:id/accept operation on storage-recommendation resource
|
|
1301
|
+
- `patchStorage-recommendationsByIdDismiss()` - /storage-recommendations/:id/dismiss operation on storage-recommendation resource
|
|
1302
|
+
|
|
1303
|
+
## Support ai config
|
|
1304
|
+
|
|
1305
|
+
- `getSupportAi-configsWorkspaceByWorkspaceId()` - Fetch the AI configuration for a specific workspace
|
|
1306
|
+
- `postSupportAi-configs()` - Create or update the AI configuration for a workspace (upsert — one config per workspace)
|
|
1307
|
+
|
|
1308
|
+
## Support canned response
|
|
1309
|
+
|
|
1310
|
+
- `getSupportCanned-responsesWorkspaceByWorkspaceId()` - List all canned responses for a workspace
|
|
1311
|
+
- `postSupportCanned-responses()` - Create a pre-written response template for agent use
|
|
1312
|
+
- `patchSupportCanned-responsesById()` - Update a canned response's content, category, or shortcut
|
|
1313
|
+
- `deleteSupportCanned-responsesById()` - /support/canned-responses/:id operation on support_canned_response resource
|
|
1314
|
+
|
|
1315
|
+
## Support channel capture config
|
|
1316
|
+
|
|
1317
|
+
- `getSupportChannel-capture-configsWorkspaceByWorkspaceId()` - Fetch the channel capture configuration for a workspace
|
|
1318
|
+
- `postSupportChannel-capture-configs()` - Create or update the channel capture configuration for a workspace (upsert — one config per workspace)
|
|
1319
|
+
|
|
1320
|
+
## Support queue
|
|
1321
|
+
|
|
1322
|
+
- `getSupportQueuesApplicationByApplicationId()` - List all queues for an application
|
|
1323
|
+
- `getSupportQueuesById()` - /support/queues/:id operation on support_queue resource
|
|
1324
|
+
- `postSupportQueues()` - Create an application-scoped support queue
|
|
1325
|
+
- `patchSupportQueuesById()` - Update queue settings including ai_mode, SLA policy, priority boost, and business hours
|
|
1326
|
+
- `deleteSupportQueuesById()` - /support/queues/:id operation on support_queue resource
|
|
1327
|
+
|
|
1328
|
+
## Support queue member
|
|
1329
|
+
|
|
1330
|
+
- `getSupportQueue-membersApplicationByApplicationId()` - List all queue members across all queues for an application
|
|
1331
|
+
- `getSupportQueue-membersQueueByQueueId()` - List all members of a specific queue including their role, capacity, and availability
|
|
1332
|
+
- `postSupportQueue-members()` - Add an agent to a support queue with a role and capacity
|
|
1333
|
+
- `patchSupportQueue-membersById()` - Update a queue member's role, ticket capacity, or availability status
|
|
1334
|
+
- `deleteSupportQueue-membersById()` - /support/queue-members/:id operation on support_queue_member resource
|
|
1335
|
+
|
|
1336
|
+
## Support routing rule
|
|
1337
|
+
|
|
1338
|
+
- `getSupportRouting-rulesApplicationByApplicationId()` - List all routing rules for an application, sorted by priority ascending (lower first)
|
|
1339
|
+
- `getSupportRouting-rulesById()` - /support/routing-rules/:id operation on support_routing_rule resource
|
|
1340
|
+
- `postSupportRouting-rules()` - Create a ticket routing rule for an application
|
|
1341
|
+
- `patchSupportRouting-rulesById()` - Update a routing rule's conditions, action, parameters, or priority order
|
|
1342
|
+
- `deleteSupportRouting-rulesById()` - /support/routing-rules/:id operation on support_routing_rule resource
|
|
1343
|
+
|
|
1344
|
+
## Support sla policy
|
|
1345
|
+
|
|
1346
|
+
- `getSupportSla-policiesApplicationByApplicationId()` - List all SLA policies for an application
|
|
1347
|
+
- `getSupportSla-policiesById()` - /support/sla-policies/:id operation on support_sla_policy resource
|
|
1348
|
+
- `postSupportSla-policies()` - Create an application-scoped SLA policy defining first_response and resolution targets in minutes
|
|
1349
|
+
- `patchSupportSla-policiesById()` - Update SLA policy targets or business hours setting
|
|
1350
|
+
- `deleteSupportSla-policiesById()` - /support/sla-policies/:id operation on support_sla_policy resource
|
|
1351
|
+
|
|
1352
|
+
## Support sync config
|
|
1353
|
+
|
|
1354
|
+
- `getSupportSync-configsWorkspaceByWorkspaceId()` - List all sync configurations for a workspace, one per connector instance
|
|
1355
|
+
- `postSupportSync-configs()` - Create a connector sync configuration for a workspace+connector pair
|
|
1356
|
+
- `patchSupportSync-configsById()` - Update sync configuration: toggle enabled, change direction, update status mapping, or adjust interval
|
|
1357
|
+
- `deleteSupportSync-configsById()` - /support/sync-configs/:id operation on support_sync_config resource
|
|
1358
|
+
|
|
1359
|
+
## Support tag
|
|
1360
|
+
|
|
1361
|
+
- `getSupportTagsWorkspaceByWorkspaceId()` - List all tags defined for a workspace
|
|
1362
|
+
- `postSupportTags()` - Create a workspace-scoped ticket tag
|
|
1363
|
+
- `deleteSupportTagsById()` - Hard-delete a tag
|
|
1364
|
+
|
|
1365
|
+
## Support ticket
|
|
1366
|
+
|
|
1367
|
+
- `getSupportTicketsById()` - Fetch a single active ticket by ID
|
|
1368
|
+
- `getSupportTicketsWorkspaceByWorkspaceId()` - List active tickets for a workspace, optionally filtered by status, priority, queue, or agent
|
|
1369
|
+
- `postSupportTickets()` - Create a support ticket
|
|
1370
|
+
- `patchSupportTicketsById()` - Update ticket fields including status (validated by ValidStatusTransition), queue assignment, SLA, and AI classification fields
|
|
1371
|
+
- `patchSupportTicketsByIdAssign()` - Assign a ticket to an agent, setting status to :open
|
|
1372
|
+
- `patchSupportTicketsByIdClose()` - Close a resolved ticket, ending the ticket lifecycle
|
|
1373
|
+
- `patchSupportTicketsByIdMerge()` - Close this ticket by merging it with another ticket
|
|
1374
|
+
- `patchSupportTicketsByIdReopen()` - Reopen a resolved or closed ticket, setting status back to :open
|
|
1375
|
+
- `patchSupportTicketsByIdResolve()` - Mark a ticket as resolved, recording resolved_at timestamp
|
|
1376
|
+
- `deleteSupportTicketsById()` - Soft-delete a ticket by setting deleted_at
|
|
1377
|
+
|
|
1378
|
+
## Support ticket attachment
|
|
1379
|
+
|
|
1380
|
+
- `getSupportTicket-attachmentsMessageByTicketMessageId()` - List all attachments for a specific ticket message
|
|
1381
|
+
- `postSupportTicket-attachments()` - Register a file attachment on a ticket message
|
|
1382
|
+
|
|
1383
|
+
## Support ticket message
|
|
1384
|
+
|
|
1385
|
+
- `getSupportTicket-messagesTicketByTicketId()` - List all messages on a ticket in chronological order
|
|
1386
|
+
- `postSupportTicket-messages()` - Add a message to a ticket thread
|
|
1387
|
+
|
|
1388
|
+
## Support ticket rating
|
|
1389
|
+
|
|
1390
|
+
- `postSupportTicket-ratings()` - Submit or update a CSAT rating (1-5) for a resolved ticket
|
|
1391
|
+
|
|
1392
|
+
## Sync-log
|
|
1393
|
+
|
|
1394
|
+
- `getConnectorsSync-logs()` - /connectors/sync-logs operation on sync-log resource
|
|
1395
|
+
- `getConnectorsSync-logsById()` - /connectors/sync-logs/:id operation on sync-log resource
|
|
1396
|
+
|
|
1119
1397
|
## System message
|
|
1120
1398
|
|
|
1121
1399
|
- `getSystem-messages()` - /system-messages operation on system_message resource
|
|
@@ -1130,14 +1408,6 @@ fields
|
|
|
1130
1408
|
|
|
1131
1409
|
- `getTenantsByTenantIdDocumentStats()` - /tenants/:tenant_id/document_stats operation on tenant_document_stats resource
|
|
1132
1410
|
|
|
1133
|
-
## Tenant pricing override
|
|
1134
|
-
|
|
1135
|
-
- `getTenant-pricing-overrides()` - /tenant-pricing-overrides operation on tenant_pricing_override resource
|
|
1136
|
-
- `getTenant-pricing-overridesById()` - /tenant-pricing-overrides/:id operation on tenant_pricing_override resource
|
|
1137
|
-
- `postTenant-pricing-overrides()` - /tenant-pricing-overrides operation on tenant_pricing_override resource
|
|
1138
|
-
- `patchTenant-pricing-overridesById()` - /tenant-pricing-overrides/:id operation on tenant_pricing_override resource
|
|
1139
|
-
- `deleteTenant-pricing-overridesById()` - /tenant-pricing-overrides/:id operation on tenant_pricing_override resource
|
|
1140
|
-
|
|
1141
1411
|
## Tenant stats
|
|
1142
1412
|
|
|
1143
1413
|
- `getTenantsByTenantIdStats()` - /tenants/:tenant_id/stats operation on tenant_stats resource
|
|
@@ -1145,10 +1415,19 @@ fields
|
|
|
1145
1415
|
## Tenant-membership
|
|
1146
1416
|
|
|
1147
1417
|
- `getTenant-memberships()` - /tenant-memberships operation on tenant-membership resource
|
|
1418
|
+
- `getTenant-membershipsByTenantIdByUserId()` - /tenant-memberships/:tenant_id/:user_id operation on tenant-membership resource
|
|
1148
1419
|
- `postTenant-memberships()` - /tenant-memberships operation on tenant-membership resource
|
|
1149
1420
|
- `patchTenant-membershipsByTenantIdByUserId()` - /tenant-memberships/:tenant_id/:user_id operation on tenant-membership resource
|
|
1150
1421
|
- `deleteTenant-membershipsByTenantIdByUserId()` - /tenant-memberships/:tenant_id/:user_id operation on tenant-membership resource
|
|
1151
1422
|
|
|
1423
|
+
## Tenant-pricing-override
|
|
1424
|
+
|
|
1425
|
+
- `getTenant-pricing-overrides()` - /tenant-pricing-overrides operation on tenant-pricing-override resource
|
|
1426
|
+
- `getTenant-pricing-overridesById()` - /tenant-pricing-overrides/:id operation on tenant-pricing-override resource
|
|
1427
|
+
- `postTenant-pricing-overrides()` - /tenant-pricing-overrides operation on tenant-pricing-override resource
|
|
1428
|
+
- `patchTenant-pricing-overridesById()` - /tenant-pricing-overrides/:id operation on tenant-pricing-override resource
|
|
1429
|
+
- `deleteTenant-pricing-overridesById()` - /tenant-pricing-overrides/:id operation on tenant-pricing-override resource
|
|
1430
|
+
|
|
1152
1431
|
## Tenants
|
|
1153
1432
|
|
|
1154
1433
|
- `getTenants()` - /tenants operation on tenant resource
|
|
@@ -1161,6 +1440,9 @@ fields
|
|
|
1161
1440
|
- `postTenantsPersonal()` - Create a personal tenant for an authenticated user who has none (e.g
|
|
1162
1441
|
- `patchTenantsById()` - Update general tenant settings: name, slug, kind, branding URLs, training price,
|
|
1163
1442
|
plan tier, vanity slug, and storage spending cap
|
|
1443
|
+
- `patchTenantsByIdAuto-top-up()` - Configure the auto top-up billing rule for this tenant
|
|
1444
|
+
- `patchTenantsByIdBranding()` - Owner-only action to update tenant branding
|
|
1445
|
+
- `patchTenantsByIdTransfer-ownership()` - Transfer org ownership to an existing admin member
|
|
1164
1446
|
- `deleteTenantsById()` - Permanently delete a tenant and all associated data
|
|
1165
1447
|
|
|
1166
1448
|
## Thread stats
|
|
@@ -1203,12 +1485,20 @@ plan tier, vanity slug, and storage spending cap
|
|
|
1203
1485
|
context
|
|
1204
1486
|
- `getTransactionsById()` - Fetch a single transaction by its UUID
|
|
1205
1487
|
- `postPayments()` - Process a payment (Auth + Capture)
|
|
1488
|
+
- `postTransactionsByIdVoid()` - Void a transaction
|
|
1206
1489
|
|
|
1207
1490
|
## Transfer
|
|
1208
1491
|
|
|
1209
1492
|
- `getTransfers()` - /transfers operation on transfer resource
|
|
1210
1493
|
- `getTransfersById()` - /transfers/:id operation on transfer resource
|
|
1211
1494
|
|
|
1495
|
+
## Usage-event
|
|
1496
|
+
|
|
1497
|
+
- `getUsage-events()` - List usage events for a tenant within a date range
|
|
1498
|
+
- `getUsage-eventsBy-user()` - List usage events for a specific user within a date range
|
|
1499
|
+
- `getUsage-eventsById()` - /usage-events/:id operation on usage-event resource
|
|
1500
|
+
- `getUsage-eventsSummary()` - List usage events for a tenant within a date range, intended for summary/dashboard views
|
|
1501
|
+
|
|
1212
1502
|
## Users
|
|
1213
1503
|
|
|
1214
1504
|
- `getUser-profiles()` - /user-profiles operation on user_profile resource
|
|
@@ -1228,11 +1518,9 @@ context
|
|
|
1228
1518
|
- `postUsersAuthMagic-linkLogin()` - /users/auth/magic-link/login operation on user resource
|
|
1229
1519
|
- `postUsersAuthMagic-linkRequest()` - /users/auth/magic-link/request operation on user resource
|
|
1230
1520
|
- `postUsersAuthRegister()` - Register a new user account with email and password
|
|
1231
|
-
- `postUsersAuthRegister-via-invitation()` - Register a new user via invitation — skips personal tenant creation
|
|
1232
1521
|
- `postUsersAuthRegister-with-oidc()` - Register or sign in a user via an OAuth/OIDC provider (Google, GitHub, Salesforce,
|
|
1233
1522
|
Microsoft)
|
|
1234
1523
|
- `postUsersAuthResend-confirmation()` - Resend confirmation email to an unconfirmed user
|
|
1235
|
-
- `postUsersAuthReset-passwordRequest()` - Public action for users to request a password reset email
|
|
1236
1524
|
- `postUsersRegister-isv()` - Platform Admin action to register a new ISV (User + Tenant + App)
|
|
1237
1525
|
- `patchUser-profilesById()` - Update the user's display profile fields: name, avatar, bio, social links, and
|
|
1238
1526
|
raw preferences map
|