@gpt-platform/client 0.7.3 → 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 +3074 -1666
- package/dist/index.d.ts +3074 -1666
- package/dist/index.js +2816 -1024
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +2816 -1024
- package/dist/index.mjs.map +1 -1
- package/llms.txt +123 -95
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -1333,7 +1333,7 @@ function buildUserAgent(sdkVersion, appInfo) {
|
|
|
1333
1333
|
}
|
|
1334
1334
|
|
|
1335
1335
|
// src/version.ts
|
|
1336
|
-
var SDK_VERSION = "0.
|
|
1336
|
+
var SDK_VERSION = "0.8.0";
|
|
1337
1337
|
var DEFAULT_API_VERSION = "2026-03-11";
|
|
1338
1338
|
|
|
1339
1339
|
// src/base-client.ts
|
|
@@ -1719,6 +1719,16 @@ var getVoiceSessionsWorkspaceByWorkspaceId = (options) => (options.client ?? cli
|
|
|
1719
1719
|
url: "/voice/sessions/workspace/{workspace_id}",
|
|
1720
1720
|
...options
|
|
1721
1721
|
});
|
|
1722
|
+
var getSocialTrendingWatchesWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
1723
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
1724
|
+
url: "/social/trending/watches/workspace/{workspace_id}",
|
|
1725
|
+
...options
|
|
1726
|
+
});
|
|
1727
|
+
var getAgentDeploymentsById = (options) => (options.client ?? client).get({
|
|
1728
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
1729
|
+
url: "/agent-deployments/{id}",
|
|
1730
|
+
...options
|
|
1731
|
+
});
|
|
1722
1732
|
var getEmailOutboundEmailsWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
1723
1733
|
security: [{ scheme: "bearer", type: "http" }],
|
|
1724
1734
|
url: "/email/outbound-emails/workspace/{workspace_id}",
|
|
@@ -1751,6 +1761,11 @@ var postCatalogProductVariants = (options) => (options.client ?? client).post({
|
|
|
1751
1761
|
...options.headers
|
|
1752
1762
|
}
|
|
1753
1763
|
});
|
|
1764
|
+
var getComplianceRequirementCompletionsById = (options) => (options.client ?? client).get({
|
|
1765
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
1766
|
+
url: "/compliance-requirement-completions/{id}",
|
|
1767
|
+
...options
|
|
1768
|
+
});
|
|
1754
1769
|
var getSocialAccountsWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
1755
1770
|
security: [{ scheme: "bearer", type: "http" }],
|
|
1756
1771
|
url: "/social/accounts/workspace/{workspace_id}",
|
|
@@ -1775,6 +1790,20 @@ var getAgentVersionsById = (options) => (options.client ?? client).get({
|
|
|
1775
1790
|
url: "/agent-versions/{id}",
|
|
1776
1791
|
...options
|
|
1777
1792
|
});
|
|
1793
|
+
var getRiskAssessments = (options) => (options.client ?? client).get({
|
|
1794
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
1795
|
+
url: "/risk-assessments",
|
|
1796
|
+
...options
|
|
1797
|
+
});
|
|
1798
|
+
var postRiskAssessments = (options) => (options.client ?? client).post({
|
|
1799
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
1800
|
+
url: "/risk-assessments",
|
|
1801
|
+
...options,
|
|
1802
|
+
headers: {
|
|
1803
|
+
"Content-Type": "application/vnd.api+json",
|
|
1804
|
+
...options.headers
|
|
1805
|
+
}
|
|
1806
|
+
});
|
|
1778
1807
|
var postCatalogTaxonomyNodes = (options) => (options.client ?? client).post({
|
|
1779
1808
|
security: [{ scheme: "bearer", type: "http" }],
|
|
1780
1809
|
url: "/catalog/taxonomy-nodes",
|
|
@@ -2053,6 +2082,11 @@ var getDocumentsStats = (options) => (options.client ?? client).get({
|
|
|
2053
2082
|
url: "/documents/stats",
|
|
2054
2083
|
...options
|
|
2055
2084
|
});
|
|
2085
|
+
var getComplianceOfficerDesignationsById = (options) => (options.client ?? client).get({
|
|
2086
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2087
|
+
url: "/compliance-officer-designations/{id}",
|
|
2088
|
+
...options
|
|
2089
|
+
});
|
|
2056
2090
|
var patchExtractionDocumentsByIdDismiss = (options) => (options.client ?? client).patch({
|
|
2057
2091
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2058
2092
|
url: "/extraction/documents/{id}/dismiss",
|
|
@@ -2072,6 +2106,20 @@ var getCrmExportsById = (options) => (options.client ?? client).get({
|
|
|
2072
2106
|
url: "/crm/exports/{id}",
|
|
2073
2107
|
...options
|
|
2074
2108
|
});
|
|
2109
|
+
var getBusinessAssociateAgreements = (options) => (options.client ?? client).get({
|
|
2110
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2111
|
+
url: "/business-associate-agreements",
|
|
2112
|
+
...options
|
|
2113
|
+
});
|
|
2114
|
+
var postBusinessAssociateAgreements = (options) => (options.client ?? client).post({
|
|
2115
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2116
|
+
url: "/business-associate-agreements",
|
|
2117
|
+
...options,
|
|
2118
|
+
headers: {
|
|
2119
|
+
"Content-Type": "application/vnd.api+json",
|
|
2120
|
+
...options.headers
|
|
2121
|
+
}
|
|
2122
|
+
});
|
|
2075
2123
|
var deleteClinicalPracticeResourcesById = (options) => (options.client ?? client).delete({
|
|
2076
2124
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2077
2125
|
url: "/clinical/practice-resources/{id}",
|
|
@@ -2119,6 +2167,15 @@ var patchCrmDealsById = (options) => (options.client ?? client).patch({
|
|
|
2119
2167
|
...options.headers
|
|
2120
2168
|
}
|
|
2121
2169
|
});
|
|
2170
|
+
var patchBreachNotificationArtifactsByIdSend = (options) => (options.client ?? client).patch({
|
|
2171
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2172
|
+
url: "/breach-notification-artifacts/{id}/send",
|
|
2173
|
+
...options,
|
|
2174
|
+
headers: {
|
|
2175
|
+
"Content-Type": "application/vnd.api+json",
|
|
2176
|
+
...options.headers
|
|
2177
|
+
}
|
|
2178
|
+
});
|
|
2122
2179
|
var getSupportTagsWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
2123
2180
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2124
2181
|
url: "/support/tags/workspace/{workspace_id}",
|
|
@@ -2177,20 +2234,6 @@ var postEmailMarketingCampaignsByIdAnalyze = (options) => (options.client ?? cli
|
|
|
2177
2234
|
...options.headers
|
|
2178
2235
|
}
|
|
2179
2236
|
});
|
|
2180
|
-
var postWebhookConfigsByIdTest = (options) => (options.client ?? client).post({
|
|
2181
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
2182
|
-
url: "/webhook-configs/{id}/test",
|
|
2183
|
-
...options,
|
|
2184
|
-
headers: {
|
|
2185
|
-
"Content-Type": "application/vnd.api+json",
|
|
2186
|
-
...options.headers
|
|
2187
|
-
}
|
|
2188
|
-
});
|
|
2189
|
-
var getLlmAnalyticsCosts = (options) => (options.client ?? client).get({
|
|
2190
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
2191
|
-
url: "/llm-analytics/costs",
|
|
2192
|
-
...options
|
|
2193
|
-
});
|
|
2194
2237
|
var patchUsersAuthPasswordChange = (options) => (options.client ?? client).patch({
|
|
2195
2238
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2196
2239
|
url: "/users/auth/password/change",
|
|
@@ -2260,6 +2303,15 @@ var postUsersAuthPasswordResetRequest = (options) => (options.client ?? client).
|
|
|
2260
2303
|
...options.headers
|
|
2261
2304
|
}
|
|
2262
2305
|
});
|
|
2306
|
+
var patchPolicyReviewSchedulesByIdMarkOverdue = (options) => (options.client ?? client).patch({
|
|
2307
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2308
|
+
url: "/policy-review-schedules/{id}/mark-overdue",
|
|
2309
|
+
...options,
|
|
2310
|
+
headers: {
|
|
2311
|
+
"Content-Type": "application/vnd.api+json",
|
|
2312
|
+
...options.headers
|
|
2313
|
+
}
|
|
2314
|
+
});
|
|
2263
2315
|
var getExtractionBatchesWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
2264
2316
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2265
2317
|
url: "/extraction/batches/workspace/{workspace_id}",
|
|
@@ -2316,15 +2368,6 @@ var postEmailOutboundEmailsComposeWithAi = (options) => (options.client ?? clien
|
|
|
2316
2368
|
...options.headers
|
|
2317
2369
|
}
|
|
2318
2370
|
});
|
|
2319
|
-
var postWebhookDeliveriesByIdRetry = (options) => (options.client ?? client).post({
|
|
2320
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
2321
|
-
url: "/webhook-deliveries/{id}/retry",
|
|
2322
|
-
...options,
|
|
2323
|
-
headers: {
|
|
2324
|
-
"Content-Type": "application/vnd.api+json",
|
|
2325
|
-
...options.headers
|
|
2326
|
-
}
|
|
2327
|
-
});
|
|
2328
2371
|
var patchSocialPostsByIdPublish = (options) => (options.client ?? client).patch({
|
|
2329
2372
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2330
2373
|
url: "/social/posts/{id}/publish",
|
|
@@ -2400,6 +2443,20 @@ var getUsersMeDashboard = (options) => (options.client ?? client).get({
|
|
|
2400
2443
|
url: "/users/me/dashboard",
|
|
2401
2444
|
...options
|
|
2402
2445
|
});
|
|
2446
|
+
var getBusinessAssociateAgreementsById = (options) => (options.client ?? client).get({
|
|
2447
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2448
|
+
url: "/business-associate-agreements/{id}",
|
|
2449
|
+
...options
|
|
2450
|
+
});
|
|
2451
|
+
var patchBusinessAssociateAgreementsById = (options) => (options.client ?? client).patch({
|
|
2452
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2453
|
+
url: "/business-associate-agreements/{id}",
|
|
2454
|
+
...options,
|
|
2455
|
+
headers: {
|
|
2456
|
+
"Content-Type": "application/vnd.api+json",
|
|
2457
|
+
...options.headers
|
|
2458
|
+
}
|
|
2459
|
+
});
|
|
2403
2460
|
var deleteRetentionPoliciesById = (options) => (options.client ?? client).delete({
|
|
2404
2461
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2405
2462
|
url: "/retention-policies/{id}",
|
|
@@ -2492,25 +2549,6 @@ var getMemoryDocumentSections = (options) => (options.client ?? client).get({
|
|
|
2492
2549
|
url: "/memory/document-sections",
|
|
2493
2550
|
...options
|
|
2494
2551
|
});
|
|
2495
|
-
var deleteWebhookConfigsById = (options) => (options.client ?? client).delete({
|
|
2496
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
2497
|
-
url: "/webhook-configs/{id}",
|
|
2498
|
-
...options
|
|
2499
|
-
});
|
|
2500
|
-
var getWebhookConfigsById = (options) => (options.client ?? client).get({
|
|
2501
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
2502
|
-
url: "/webhook-configs/{id}",
|
|
2503
|
-
...options
|
|
2504
|
-
});
|
|
2505
|
-
var patchWebhookConfigsById = (options) => (options.client ?? client).patch({
|
|
2506
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
2507
|
-
url: "/webhook-configs/{id}",
|
|
2508
|
-
...options,
|
|
2509
|
-
headers: {
|
|
2510
|
-
"Content-Type": "application/vnd.api+json",
|
|
2511
|
-
...options.headers
|
|
2512
|
-
}
|
|
2513
|
-
});
|
|
2514
2552
|
var postConnectorsCredentialsByIdRefresh = (options) => (options.client ?? client).post({
|
|
2515
2553
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2516
2554
|
url: "/connectors/credentials/{id}/refresh",
|
|
@@ -2539,6 +2577,15 @@ var postWorkspacesByWorkspaceIdExtractionDocumentsDismissAllTrained = (options)
|
|
|
2539
2577
|
...options.headers
|
|
2540
2578
|
}
|
|
2541
2579
|
});
|
|
2580
|
+
var patchAmendmentRequestsByIdDeny = (options) => (options.client ?? client).patch({
|
|
2581
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2582
|
+
url: "/amendment-requests/{id}/deny",
|
|
2583
|
+
...options,
|
|
2584
|
+
headers: {
|
|
2585
|
+
"Content-Type": "application/vnd.api+json",
|
|
2586
|
+
...options.headers
|
|
2587
|
+
}
|
|
2588
|
+
});
|
|
2542
2589
|
var getClinicalSessionsByIdSessionNotes = (options) => (options.client ?? client).get({
|
|
2543
2590
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2544
2591
|
url: "/clinical/sessions/{id}/session_notes",
|
|
@@ -2562,14 +2609,9 @@ var postEmailMarketingCampaigns = (options) => (options.client ?? client).post({
|
|
|
2562
2609
|
...options.headers
|
|
2563
2610
|
}
|
|
2564
2611
|
});
|
|
2565
|
-
var
|
|
2566
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
2567
|
-
url: "/configs",
|
|
2568
|
-
...options
|
|
2569
|
-
});
|
|
2570
|
-
var postConfigs = (options) => (options.client ?? client).post({
|
|
2612
|
+
var postSocialTrendingWatches = (options) => (options.client ?? client).post({
|
|
2571
2613
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2572
|
-
url: "/
|
|
2614
|
+
url: "/social/trending/watches",
|
|
2573
2615
|
...options,
|
|
2574
2616
|
headers: {
|
|
2575
2617
|
"Content-Type": "application/vnd.api+json",
|
|
@@ -2600,6 +2642,11 @@ var patchCrmCustomEntitiesById = (options) => (options.client ?? client).patch({
|
|
|
2600
2642
|
...options.headers
|
|
2601
2643
|
}
|
|
2602
2644
|
});
|
|
2645
|
+
var getAgentDeployments = (options) => (options.client ?? client).get({
|
|
2646
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2647
|
+
url: "/agent-deployments",
|
|
2648
|
+
...options
|
|
2649
|
+
});
|
|
2603
2650
|
var postAgentsByIdRestoreVersion = (options) => (options.client ?? client).post({
|
|
2604
2651
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2605
2652
|
url: "/agents/{id}/restore-version",
|
|
@@ -2609,6 +2656,20 @@ var postAgentsByIdRestoreVersion = (options) => (options.client ?? client).post(
|
|
|
2609
2656
|
...options.headers
|
|
2610
2657
|
}
|
|
2611
2658
|
});
|
|
2659
|
+
var getWorkspaceAgentConfigsById = (options) => (options.client ?? client).get({
|
|
2660
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2661
|
+
url: "/workspace-agent-configs/{id}",
|
|
2662
|
+
...options
|
|
2663
|
+
});
|
|
2664
|
+
var patchWorkspaceAgentConfigsById = (options) => (options.client ?? client).patch({
|
|
2665
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2666
|
+
url: "/workspace-agent-configs/{id}",
|
|
2667
|
+
...options,
|
|
2668
|
+
headers: {
|
|
2669
|
+
"Content-Type": "application/vnd.api+json",
|
|
2670
|
+
...options.headers
|
|
2671
|
+
}
|
|
2672
|
+
});
|
|
2612
2673
|
var patchWalletAutoTopUp = (options) => (options.client ?? client).patch({
|
|
2613
2674
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2614
2675
|
url: "/wallet/auto-top-up",
|
|
@@ -2706,6 +2767,34 @@ var postUsersAuthMagicLinkLogin = (options) => (options.client ?? client).post({
|
|
|
2706
2767
|
...options.headers
|
|
2707
2768
|
}
|
|
2708
2769
|
});
|
|
2770
|
+
var getDataTransferRecords = (options) => (options.client ?? client).get({
|
|
2771
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2772
|
+
url: "/data-transfer-records",
|
|
2773
|
+
...options
|
|
2774
|
+
});
|
|
2775
|
+
var postDataTransferRecords = (options) => (options.client ?? client).post({
|
|
2776
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2777
|
+
url: "/data-transfer-records",
|
|
2778
|
+
...options,
|
|
2779
|
+
headers: {
|
|
2780
|
+
"Content-Type": "application/vnd.api+json",
|
|
2781
|
+
...options.headers
|
|
2782
|
+
}
|
|
2783
|
+
});
|
|
2784
|
+
var getComplianceOfficerDesignations = (options) => (options.client ?? client).get({
|
|
2785
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2786
|
+
url: "/compliance-officer-designations",
|
|
2787
|
+
...options
|
|
2788
|
+
});
|
|
2789
|
+
var postComplianceOfficerDesignations = (options) => (options.client ?? client).post({
|
|
2790
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2791
|
+
url: "/compliance-officer-designations",
|
|
2792
|
+
...options,
|
|
2793
|
+
headers: {
|
|
2794
|
+
"Content-Type": "application/vnd.api+json",
|
|
2795
|
+
...options.headers
|
|
2796
|
+
}
|
|
2797
|
+
});
|
|
2709
2798
|
var patchSupportTicketsByIdMerge = (options) => (options.client ?? client).patch({
|
|
2710
2799
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2711
2800
|
url: "/support/tickets/{id}/merge",
|
|
@@ -2800,6 +2889,20 @@ var patchClinicalSessionsById = (options) => (options.client ?? client).patch({
|
|
|
2800
2889
|
...options.headers
|
|
2801
2890
|
}
|
|
2802
2891
|
});
|
|
2892
|
+
var getEphiAssetsById = (options) => (options.client ?? client).get({
|
|
2893
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2894
|
+
url: "/ephi-assets/{id}",
|
|
2895
|
+
...options
|
|
2896
|
+
});
|
|
2897
|
+
var patchEphiAssetsById = (options) => (options.client ?? client).patch({
|
|
2898
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2899
|
+
url: "/ephi-assets/{id}",
|
|
2900
|
+
...options,
|
|
2901
|
+
headers: {
|
|
2902
|
+
"Content-Type": "application/vnd.api+json",
|
|
2903
|
+
...options.headers
|
|
2904
|
+
}
|
|
2905
|
+
});
|
|
2803
2906
|
var getAgentsUsage = (options) => (options.client ?? client).get({
|
|
2804
2907
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2805
2908
|
url: "/agents/usage",
|
|
@@ -2842,6 +2945,11 @@ var patchSchedulingCalendarSyncsById = (options) => (options.client ?? client).p
|
|
|
2842
2945
|
...options.headers
|
|
2843
2946
|
}
|
|
2844
2947
|
});
|
|
2948
|
+
var getAmendmentRequestsById = (options) => (options.client ?? client).get({
|
|
2949
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2950
|
+
url: "/amendment-requests/{id}",
|
|
2951
|
+
...options
|
|
2952
|
+
});
|
|
2845
2953
|
var getEmailInboundReceivedAddressByInboundAddressId = (options) => (options.client ?? client).get({
|
|
2846
2954
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2847
2955
|
url: "/email/inbound/received/address/{inbound_address_id}",
|
|
@@ -2922,6 +3030,20 @@ var getEmailRecipientsEmailByOutboundEmailId = (options) => (options.client ?? c
|
|
|
2922
3030
|
url: "/email/recipients/email/{outbound_email_id}",
|
|
2923
3031
|
...options
|
|
2924
3032
|
});
|
|
3033
|
+
var getEphiDataFlowsById = (options) => (options.client ?? client).get({
|
|
3034
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3035
|
+
url: "/ephi-data-flows/{id}",
|
|
3036
|
+
...options
|
|
3037
|
+
});
|
|
3038
|
+
var patchEphiDataFlowsById = (options) => (options.client ?? client).patch({
|
|
3039
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3040
|
+
url: "/ephi-data-flows/{id}",
|
|
3041
|
+
...options,
|
|
3042
|
+
headers: {
|
|
3043
|
+
"Content-Type": "application/vnd.api+json",
|
|
3044
|
+
...options.headers
|
|
3045
|
+
}
|
|
3046
|
+
});
|
|
2925
3047
|
var getMemorySectionDocuments = (options) => (options.client ?? client).get({
|
|
2926
3048
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2927
3049
|
url: "/memory/section-documents",
|
|
@@ -2945,6 +3067,15 @@ var patchSocialCampaignsByIdCancel = (options) => (options.client ?? client).pat
|
|
|
2945
3067
|
...options.headers
|
|
2946
3068
|
}
|
|
2947
3069
|
});
|
|
3070
|
+
var patchAmendmentRequestsByIdReview = (options) => (options.client ?? client).patch({
|
|
3071
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3072
|
+
url: "/amendment-requests/{id}/review",
|
|
3073
|
+
...options,
|
|
3074
|
+
headers: {
|
|
3075
|
+
"Content-Type": "application/vnd.api+json",
|
|
3076
|
+
...options.headers
|
|
3077
|
+
}
|
|
3078
|
+
});
|
|
2948
3079
|
var deleteClinicalPracticeToolsById = (options) => (options.client ?? client).delete({
|
|
2949
3080
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2950
3081
|
url: "/clinical/practice-tools/{id}",
|
|
@@ -2969,6 +3100,11 @@ var getFeatureUsagesById = (options) => (options.client ?? client).get({
|
|
|
2969
3100
|
url: "/feature-usages/{id}",
|
|
2970
3101
|
...options
|
|
2971
3102
|
});
|
|
3103
|
+
var getSocialTrendingHistoryWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
3104
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3105
|
+
url: "/social/trending/history/workspace/{workspace_id}",
|
|
3106
|
+
...options
|
|
3107
|
+
});
|
|
2972
3108
|
var patchSchedulingCalendarSyncsByIdPause = (options) => (options.client ?? client).patch({
|
|
2973
3109
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2974
3110
|
url: "/scheduling/calendar-syncs/{id}/pause",
|
|
@@ -2978,11 +3114,6 @@ var patchSchedulingCalendarSyncsByIdPause = (options) => (options.client ?? clie
|
|
|
2978
3114
|
...options.headers
|
|
2979
3115
|
}
|
|
2980
3116
|
});
|
|
2981
|
-
var getWebhookConfigsStats = (options) => (options.client ?? client).get({
|
|
2982
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
2983
|
-
url: "/webhook-configs/stats",
|
|
2984
|
-
...options
|
|
2985
|
-
});
|
|
2986
3117
|
var getEmailMarketingCampaignsWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
2987
3118
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2988
3119
|
url: "/email-marketing/campaigns/workspace/{workspace_id}",
|
|
@@ -3049,6 +3180,15 @@ var getSocialMetricsAccountBySocialAccountId = (options) => (options.client ?? c
|
|
|
3049
3180
|
url: "/social/metrics/account/{social_account_id}",
|
|
3050
3181
|
...options
|
|
3051
3182
|
});
|
|
3183
|
+
var patchRiskAssessmentsByIdStatus = (options) => (options.client ?? client).patch({
|
|
3184
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3185
|
+
url: "/risk-assessments/{id}/status",
|
|
3186
|
+
...options,
|
|
3187
|
+
headers: {
|
|
3188
|
+
"Content-Type": "application/vnd.api+json",
|
|
3189
|
+
...options.headers
|
|
3190
|
+
}
|
|
3191
|
+
});
|
|
3052
3192
|
var getPermissionsMeta = (options) => (options.client ?? client).get({
|
|
3053
3193
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3054
3194
|
url: "/permissions/meta",
|
|
@@ -3107,6 +3247,15 @@ var getEmailRecipientsById = (options) => (options.client ?? client).get({
|
|
|
3107
3247
|
url: "/email/recipients/{id}",
|
|
3108
3248
|
...options
|
|
3109
3249
|
});
|
|
3250
|
+
var patchPolicyReviewSchedulesByIdCompleteReview = (options) => (options.client ?? client).patch({
|
|
3251
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3252
|
+
url: "/policy-review-schedules/{id}/complete-review",
|
|
3253
|
+
...options,
|
|
3254
|
+
headers: {
|
|
3255
|
+
"Content-Type": "application/vnd.api+json",
|
|
3256
|
+
...options.headers
|
|
3257
|
+
}
|
|
3258
|
+
});
|
|
3110
3259
|
var patchAgentsByIdSchemaVersionsByVersionId = (options) => (options.client ?? client).patch({
|
|
3111
3260
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3112
3261
|
url: "/agents/{id}/schema-versions/{version_id}",
|
|
@@ -3135,6 +3284,25 @@ var patchCatalogTaxonomiesById = (options) => (options.client ?? client).patch({
|
|
|
3135
3284
|
...options.headers
|
|
3136
3285
|
}
|
|
3137
3286
|
});
|
|
3287
|
+
var deleteSocialTrendingWatchesById = (options) => (options.client ?? client).delete({
|
|
3288
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3289
|
+
url: "/social/trending/watches/{id}",
|
|
3290
|
+
...options
|
|
3291
|
+
});
|
|
3292
|
+
var getSocialTrendingWatchesById = (options) => (options.client ?? client).get({
|
|
3293
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3294
|
+
url: "/social/trending/watches/{id}",
|
|
3295
|
+
...options
|
|
3296
|
+
});
|
|
3297
|
+
var patchSocialTrendingWatchesById = (options) => (options.client ?? client).patch({
|
|
3298
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3299
|
+
url: "/social/trending/watches/{id}",
|
|
3300
|
+
...options,
|
|
3301
|
+
headers: {
|
|
3302
|
+
"Content-Type": "application/vnd.api+json",
|
|
3303
|
+
...options.headers
|
|
3304
|
+
}
|
|
3305
|
+
});
|
|
3138
3306
|
var getSocialMetricsCampaignBySocialCampaignId = (options) => (options.client ?? client).get({
|
|
3139
3307
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3140
3308
|
url: "/social/metrics/campaign/{social_campaign_id}",
|
|
@@ -3257,6 +3425,15 @@ var postThreadsByIdMessages = (options) => (options.client ?? client).post({
|
|
|
3257
3425
|
...options.headers
|
|
3258
3426
|
}
|
|
3259
3427
|
});
|
|
3428
|
+
var patchBusinessAssociateAgreementsByIdTerminate = (options) => (options.client ?? client).patch({
|
|
3429
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3430
|
+
url: "/business-associate-agreements/{id}/terminate",
|
|
3431
|
+
...options,
|
|
3432
|
+
headers: {
|
|
3433
|
+
"Content-Type": "application/vnd.api+json",
|
|
3434
|
+
...options.headers
|
|
3435
|
+
}
|
|
3436
|
+
});
|
|
3260
3437
|
var postConnectorsByIdEdamamRecipesGet = (options) => (options.client ?? client).post({
|
|
3261
3438
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3262
3439
|
url: "/connectors/{id}/edamam/recipes/get",
|
|
@@ -3303,11 +3480,6 @@ var getCreditPackagesById = (options) => (options.client ?? client).get({
|
|
|
3303
3480
|
url: "/credit-packages/{id}",
|
|
3304
3481
|
...options
|
|
3305
3482
|
});
|
|
3306
|
-
var getWebhookDeliveries = (options) => (options.client ?? client).get({
|
|
3307
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
3308
|
-
url: "/webhook-deliveries",
|
|
3309
|
-
...options
|
|
3310
|
-
});
|
|
3311
3483
|
var getAgentVersions = (options) => (options.client ?? client).get({
|
|
3312
3484
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3313
3485
|
url: "/agent-versions",
|
|
@@ -3421,11 +3593,6 @@ var patchEmailInboundAddressesByIdRotateToken = (options) => (options.client ??
|
|
|
3421
3593
|
...options.headers
|
|
3422
3594
|
}
|
|
3423
3595
|
});
|
|
3424
|
-
var getLlmAnalyticsSummary = (options) => (options.client ?? client).get({
|
|
3425
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
3426
|
-
url: "/llm-analytics/summary",
|
|
3427
|
-
...options
|
|
3428
|
-
});
|
|
3429
3596
|
var deleteSchedulingParticipantsById = (options) => (options.client ?? client).delete({
|
|
3430
3597
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3431
3598
|
url: "/scheduling/participants/{id}",
|
|
@@ -3483,16 +3650,6 @@ var getSchedulingBookingsById = (options) => (options.client ?? client).get({
|
|
|
3483
3650
|
url: "/scheduling/bookings/{id}",
|
|
3484
3651
|
...options
|
|
3485
3652
|
});
|
|
3486
|
-
var getLlmAnalytics = (options) => (options.client ?? client).get({
|
|
3487
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
3488
|
-
url: "/llm-analytics",
|
|
3489
|
-
...options
|
|
3490
|
-
});
|
|
3491
|
-
var getWebhookDeliveriesById = (options) => (options.client ?? client).get({
|
|
3492
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
3493
|
-
url: "/webhook-deliveries/{id}",
|
|
3494
|
-
...options
|
|
3495
|
-
});
|
|
3496
3653
|
var patchVoiceSessionsByIdStop = (options) => (options.client ?? client).patch({
|
|
3497
3654
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3498
3655
|
url: "/voice/sessions/{id}/stop",
|
|
@@ -3539,11 +3696,6 @@ var postSchedulingParticipants = (options) => (options.client ?? client).post({
|
|
|
3539
3696
|
...options.headers
|
|
3540
3697
|
}
|
|
3541
3698
|
});
|
|
3542
|
-
var getWebhookDeliveriesStats = (options) => (options.client ?? client).get({
|
|
3543
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
3544
|
-
url: "/webhook-deliveries/stats",
|
|
3545
|
-
...options
|
|
3546
|
-
});
|
|
3547
3699
|
var getNotificationLogsById = (options) => (options.client ?? client).get({
|
|
3548
3700
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3549
3701
|
url: "/notification-logs/{id}",
|
|
@@ -3610,6 +3762,16 @@ var getCrawlerJobsById = (options) => (options.client ?? client).get({
|
|
|
3610
3762
|
url: "/crawler/jobs/{id}",
|
|
3611
3763
|
...options
|
|
3612
3764
|
});
|
|
3765
|
+
var deleteSocialTrendingHistoryById = (options) => (options.client ?? client).delete({
|
|
3766
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3767
|
+
url: "/social/trending/history/{id}",
|
|
3768
|
+
...options
|
|
3769
|
+
});
|
|
3770
|
+
var getSocialTrendingHistoryById = (options) => (options.client ?? client).get({
|
|
3771
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3772
|
+
url: "/social/trending/history/{id}",
|
|
3773
|
+
...options
|
|
3774
|
+
});
|
|
3613
3775
|
var getConsentRecordsById = (options) => (options.client ?? client).get({
|
|
3614
3776
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3615
3777
|
url: "/consent-records/{id}",
|
|
@@ -3669,6 +3831,20 @@ var getVoiceSessionsById = (options) => (options.client ?? client).get({
|
|
|
3669
3831
|
url: "/voice/sessions/{id}",
|
|
3670
3832
|
...options
|
|
3671
3833
|
});
|
|
3834
|
+
var getEphiAssets = (options) => (options.client ?? client).get({
|
|
3835
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3836
|
+
url: "/ephi-assets",
|
|
3837
|
+
...options
|
|
3838
|
+
});
|
|
3839
|
+
var postEphiAssets = (options) => (options.client ?? client).post({
|
|
3840
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3841
|
+
url: "/ephi-assets",
|
|
3842
|
+
...options,
|
|
3843
|
+
headers: {
|
|
3844
|
+
"Content-Type": "application/vnd.api+json",
|
|
3845
|
+
...options.headers
|
|
3846
|
+
}
|
|
3847
|
+
});
|
|
3672
3848
|
var getVoiceSessions = (options) => (options.client ?? client).get({
|
|
3673
3849
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3674
3850
|
url: "/voice/sessions",
|
|
@@ -3932,6 +4108,15 @@ var postCrawlerJobs = (options) => (options.client ?? client).post({
|
|
|
3932
4108
|
...options.headers
|
|
3933
4109
|
}
|
|
3934
4110
|
});
|
|
4111
|
+
var patchWalletPaymentRetry = (options) => (options.client ?? client).patch({
|
|
4112
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4113
|
+
url: "/wallet/payment/retry",
|
|
4114
|
+
...options,
|
|
4115
|
+
headers: {
|
|
4116
|
+
"Content-Type": "application/vnd.api+json",
|
|
4117
|
+
...options.headers
|
|
4118
|
+
}
|
|
4119
|
+
});
|
|
3935
4120
|
var deleteCrmCompaniesById = (options) => (options.client ?? client).delete({
|
|
3936
4121
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3937
4122
|
url: "/crm/companies/{id}",
|
|
@@ -3965,6 +4150,11 @@ var patchVoiceSessionsByIdFinalize = (options) => (options.client ?? client).pat
|
|
|
3965
4150
|
...options.headers
|
|
3966
4151
|
}
|
|
3967
4152
|
});
|
|
4153
|
+
var getWalletFeatures = (options) => (options.client ?? client).get({
|
|
4154
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4155
|
+
url: "/wallet/features",
|
|
4156
|
+
...options
|
|
4157
|
+
});
|
|
3968
4158
|
var getRoles = (options) => (options.client ?? client).get({
|
|
3969
4159
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3970
4160
|
url: "/roles",
|
|
@@ -3979,6 +4169,20 @@ var postRoles = (options) => (options.client ?? client).post({
|
|
|
3979
4169
|
...options.headers
|
|
3980
4170
|
}
|
|
3981
4171
|
});
|
|
4172
|
+
var getComplianceRequirementCompletions = (options) => (options.client ?? client).get({
|
|
4173
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4174
|
+
url: "/compliance-requirement-completions",
|
|
4175
|
+
...options
|
|
4176
|
+
});
|
|
4177
|
+
var postComplianceRequirementCompletions = (options) => (options.client ?? client).post({
|
|
4178
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4179
|
+
url: "/compliance-requirement-completions",
|
|
4180
|
+
...options,
|
|
4181
|
+
headers: {
|
|
4182
|
+
"Content-Type": "application/vnd.api+json",
|
|
4183
|
+
...options.headers
|
|
4184
|
+
}
|
|
4185
|
+
});
|
|
3982
4186
|
var deleteProcessingActivitiesById = (options) => (options.client ?? client).delete({
|
|
3983
4187
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3984
4188
|
url: "/processing-activities/{id}",
|
|
@@ -4273,16 +4477,7 @@ var postCrawlerSchedules = (options) => (options.client ?? client).post({
|
|
|
4273
4477
|
...options.headers
|
|
4274
4478
|
}
|
|
4275
4479
|
});
|
|
4276
|
-
var
|
|
4277
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
4278
|
-
url: "/webhook-configs/bulk-disable",
|
|
4279
|
-
...options,
|
|
4280
|
-
headers: {
|
|
4281
|
-
"Content-Type": "application/vnd.api+json",
|
|
4282
|
-
...options.headers
|
|
4283
|
-
}
|
|
4284
|
-
});
|
|
4285
|
-
var getEmailTrackingEventsWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
4480
|
+
var getEmailTrackingEventsWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
4286
4481
|
security: [{ scheme: "bearer", type: "http" }],
|
|
4287
4482
|
url: "/email/tracking-events/workspace/{workspace_id}",
|
|
4288
4483
|
...options
|
|
@@ -4325,6 +4520,15 @@ var postFieldTemplates = (options) => (options.client ?? client).post({
|
|
|
4325
4520
|
...options.headers
|
|
4326
4521
|
}
|
|
4327
4522
|
});
|
|
4523
|
+
var patchSocialTrendingWatchesByIdMarkTriggered = (options) => (options.client ?? client).patch({
|
|
4524
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4525
|
+
url: "/social/trending/watches/{id}/mark-triggered",
|
|
4526
|
+
...options,
|
|
4527
|
+
headers: {
|
|
4528
|
+
"Content-Type": "application/vnd.api+json",
|
|
4529
|
+
...options.headers
|
|
4530
|
+
}
|
|
4531
|
+
});
|
|
4328
4532
|
var postAgentsByIdSchemaVersionsByVersionIdActivate = (options) => (options.client ?? client).post({
|
|
4329
4533
|
security: [{ scheme: "bearer", type: "http" }],
|
|
4330
4534
|
url: "/agents/{id}/schema-versions/{version_id}/activate",
|
|
@@ -4461,11 +4665,6 @@ var postConnectorsFullscriptCheckPatient = (options) => (options.client ?? clien
|
|
|
4461
4665
|
...options.headers
|
|
4462
4666
|
}
|
|
4463
4667
|
});
|
|
4464
|
-
var getLlmAnalyticsWorkspace = (options) => (options.client ?? client).get({
|
|
4465
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
4466
|
-
url: "/llm-analytics/workspace",
|
|
4467
|
-
...options
|
|
4468
|
-
});
|
|
4469
4668
|
var getSchedulingEventTypes = (options) => (options.client ?? client).get({
|
|
4470
4669
|
security: [{ scheme: "bearer", type: "http" }],
|
|
4471
4670
|
url: "/scheduling/event-types",
|
|
@@ -4480,6 +4679,20 @@ var postSchedulingEventTypes = (options) => (options.client ?? client).post({
|
|
|
4480
4679
|
...options.headers
|
|
4481
4680
|
}
|
|
4482
4681
|
});
|
|
4682
|
+
var getAccessLogsById = (options) => (options.client ?? client).get({
|
|
4683
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4684
|
+
url: "/access-logs/{id}",
|
|
4685
|
+
...options
|
|
4686
|
+
});
|
|
4687
|
+
var postComplianceDocumentTemplatesClone = (options) => (options.client ?? client).post({
|
|
4688
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4689
|
+
url: "/compliance-document-templates/clone",
|
|
4690
|
+
...options,
|
|
4691
|
+
headers: {
|
|
4692
|
+
"Content-Type": "application/vnd.api+json",
|
|
4693
|
+
...options.headers
|
|
4694
|
+
}
|
|
4695
|
+
});
|
|
4483
4696
|
var deleteClinicalClientSupplementsById = (options) => (options.client ?? client).delete({
|
|
4484
4697
|
security: [{ scheme: "bearer", type: "http" }],
|
|
4485
4698
|
url: "/clinical/client-supplements/{id}",
|
|
@@ -4575,15 +4788,6 @@ var patchFeatureDefinitionsById = (options) => (options.client ?? client).patch(
|
|
|
4575
4788
|
...options.headers
|
|
4576
4789
|
}
|
|
4577
4790
|
});
|
|
4578
|
-
var patchWebhookConfigsByIdRotateSecret = (options) => (options.client ?? client).patch({
|
|
4579
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
4580
|
-
url: "/webhook-configs/{id}/rotate-secret",
|
|
4581
|
-
...options,
|
|
4582
|
-
headers: {
|
|
4583
|
-
"Content-Type": "application/vnd.api+json",
|
|
4584
|
-
...options.headers
|
|
4585
|
-
}
|
|
4586
|
-
});
|
|
4587
4791
|
var patchWalletAddons = (options) => (options.client ?? client).patch({
|
|
4588
4792
|
security: [{ scheme: "bearer", type: "http" }],
|
|
4589
4793
|
url: "/wallet/addons",
|
|
@@ -4649,6 +4853,26 @@ var postTrainingExamplesSearch = (options) => (options.client ?? client).post({
|
|
|
4649
4853
|
...options.headers
|
|
4650
4854
|
}
|
|
4651
4855
|
});
|
|
4856
|
+
var deleteCdeScopeReportsById = (options) => (options.client ?? client).delete({
|
|
4857
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4858
|
+
url: "/cde-scope-reports/{id}",
|
|
4859
|
+
...options
|
|
4860
|
+
});
|
|
4861
|
+
var getCdeScopeReportsById = (options) => (options.client ?? client).get({
|
|
4862
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4863
|
+
url: "/cde-scope-reports/{id}",
|
|
4864
|
+
...options
|
|
4865
|
+
});
|
|
4866
|
+
var deleteRiskAssessmentsById = (options) => (options.client ?? client).delete({
|
|
4867
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4868
|
+
url: "/risk-assessments/{id}",
|
|
4869
|
+
...options
|
|
4870
|
+
});
|
|
4871
|
+
var getRiskAssessmentsById = (options) => (options.client ?? client).get({
|
|
4872
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4873
|
+
url: "/risk-assessments/{id}",
|
|
4874
|
+
...options
|
|
4875
|
+
});
|
|
4652
4876
|
var getUserProfiles = (options) => (options.client ?? client).get({
|
|
4653
4877
|
security: [{ scheme: "bearer", type: "http" }],
|
|
4654
4878
|
url: "/user-profiles",
|
|
@@ -4924,11 +5148,44 @@ var getSocialPostsCampaignBySocialCampaignId = (options) => (options.client ?? c
|
|
|
4924
5148
|
url: "/social/posts/campaign/{social_campaign_id}",
|
|
4925
5149
|
...options
|
|
4926
5150
|
});
|
|
5151
|
+
var deleteDataTransferRecordsById = (options) => (options.client ?? client).delete({
|
|
5152
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5153
|
+
url: "/data-transfer-records/{id}",
|
|
5154
|
+
...options
|
|
5155
|
+
});
|
|
5156
|
+
var getDataTransferRecordsById = (options) => (options.client ?? client).get({
|
|
5157
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5158
|
+
url: "/data-transfer-records/{id}",
|
|
5159
|
+
...options
|
|
5160
|
+
});
|
|
5161
|
+
var patchAmendmentRequestsByIdApply = (options) => (options.client ?? client).patch({
|
|
5162
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5163
|
+
url: "/amendment-requests/{id}/apply",
|
|
5164
|
+
...options,
|
|
5165
|
+
headers: {
|
|
5166
|
+
"Content-Type": "application/vnd.api+json",
|
|
5167
|
+
...options.headers
|
|
5168
|
+
}
|
|
5169
|
+
});
|
|
5170
|
+
var getSocialTrendingItemsSnapshotBySnapshotId = (options) => (options.client ?? client).get({
|
|
5171
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5172
|
+
url: "/social/trending/items/snapshot/{snapshot_id}",
|
|
5173
|
+
...options
|
|
5174
|
+
});
|
|
4927
5175
|
var getTransactions = (options) => (options.client ?? client).get({
|
|
4928
5176
|
security: [{ scheme: "bearer", type: "http" }],
|
|
4929
5177
|
url: "/transactions",
|
|
4930
5178
|
...options
|
|
4931
5179
|
});
|
|
5180
|
+
var postSocialTrendingHistory = (options) => (options.client ?? client).post({
|
|
5181
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5182
|
+
url: "/social/trending/history",
|
|
5183
|
+
...options,
|
|
5184
|
+
headers: {
|
|
5185
|
+
"Content-Type": "application/vnd.api+json",
|
|
5186
|
+
...options.headers
|
|
5187
|
+
}
|
|
5188
|
+
});
|
|
4932
5189
|
var getThreadsSearch = (options) => (options.client ?? client).get({
|
|
4933
5190
|
security: [{ scheme: "bearer", type: "http" }],
|
|
4934
5191
|
url: "/threads/search",
|
|
@@ -5012,24 +5269,6 @@ var patchCatalogProductsById = (options) => (options.client ?? client).patch({
|
|
|
5012
5269
|
...options.headers
|
|
5013
5270
|
}
|
|
5014
5271
|
});
|
|
5015
|
-
var postWebhookConfigsBulkEnable = (options) => (options.client ?? client).post({
|
|
5016
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
5017
|
-
url: "/webhook-configs/bulk-enable",
|
|
5018
|
-
...options,
|
|
5019
|
-
headers: {
|
|
5020
|
-
"Content-Type": "application/vnd.api+json",
|
|
5021
|
-
...options.headers
|
|
5022
|
-
}
|
|
5023
|
-
});
|
|
5024
|
-
var postWebhookConfigsByIdReplay = (options) => (options.client ?? client).post({
|
|
5025
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
5026
|
-
url: "/webhook-configs/{id}/replay",
|
|
5027
|
-
...options,
|
|
5028
|
-
headers: {
|
|
5029
|
-
"Content-Type": "application/vnd.api+json",
|
|
5030
|
-
...options.headers
|
|
5031
|
-
}
|
|
5032
|
-
});
|
|
5033
5272
|
var deleteCatalogProductVariantsById = (options) => (options.client ?? client).delete({
|
|
5034
5273
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5035
5274
|
url: "/catalog/product-variants/{id}",
|
|
@@ -5058,6 +5297,20 @@ var patchBreachIncidentsByIdStatus = (options) => (options.client ?? client).pat
|
|
|
5058
5297
|
...options.headers
|
|
5059
5298
|
}
|
|
5060
5299
|
});
|
|
5300
|
+
var getBreachNotificationArtifactsById = (options) => (options.client ?? client).get({
|
|
5301
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5302
|
+
url: "/breach-notification-artifacts/{id}",
|
|
5303
|
+
...options
|
|
5304
|
+
});
|
|
5305
|
+
var patchBreachNotificationArtifactsById = (options) => (options.client ?? client).patch({
|
|
5306
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5307
|
+
url: "/breach-notification-artifacts/{id}",
|
|
5308
|
+
...options,
|
|
5309
|
+
headers: {
|
|
5310
|
+
"Content-Type": "application/vnd.api+json",
|
|
5311
|
+
...options.headers
|
|
5312
|
+
}
|
|
5313
|
+
});
|
|
5061
5314
|
var patchSupportTicketsByIdClose = (options) => (options.client ?? client).patch({
|
|
5062
5315
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5063
5316
|
url: "/support/tickets/{id}/close",
|
|
@@ -5081,6 +5334,20 @@ var postClinicalClientGoals = (options) => (options.client ?? client).post({
|
|
|
5081
5334
|
...options.headers
|
|
5082
5335
|
}
|
|
5083
5336
|
});
|
|
5337
|
+
var getBreachNotificationArtifacts = (options) => (options.client ?? client).get({
|
|
5338
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5339
|
+
url: "/breach-notification-artifacts",
|
|
5340
|
+
...options
|
|
5341
|
+
});
|
|
5342
|
+
var postBreachNotificationArtifacts = (options) => (options.client ?? client).post({
|
|
5343
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5344
|
+
url: "/breach-notification-artifacts",
|
|
5345
|
+
...options,
|
|
5346
|
+
headers: {
|
|
5347
|
+
"Content-Type": "application/vnd.api+json",
|
|
5348
|
+
...options.headers
|
|
5349
|
+
}
|
|
5350
|
+
});
|
|
5084
5351
|
var getWalletSeats = (options) => (options.client ?? client).get({
|
|
5085
5352
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5086
5353
|
url: "/wallet/seats",
|
|
@@ -5114,15 +5381,6 @@ var patchEmailOutboundEmailsByIdCancelSchedule = (options) => (options.client ??
|
|
|
5114
5381
|
...options.headers
|
|
5115
5382
|
}
|
|
5116
5383
|
});
|
|
5117
|
-
var postWebhookDeliveriesBulkRetry = (options) => (options.client ?? client).post({
|
|
5118
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
5119
|
-
url: "/webhook-deliveries/bulk-retry",
|
|
5120
|
-
...options,
|
|
5121
|
-
headers: {
|
|
5122
|
-
"Content-Type": "application/vnd.api+json",
|
|
5123
|
-
...options.headers
|
|
5124
|
-
}
|
|
5125
|
-
});
|
|
5126
5384
|
var getLegalDocumentsByLocale = (options) => (options.client ?? client).get({
|
|
5127
5385
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5128
5386
|
url: "/legal-documents/by-locale",
|
|
@@ -5333,6 +5591,20 @@ var getScanResultsById = (options) => (options.client ?? client).get({
|
|
|
5333
5591
|
url: "/scan-results/{id}",
|
|
5334
5592
|
...options
|
|
5335
5593
|
});
|
|
5594
|
+
var getPolicyReviewSchedules = (options) => (options.client ?? client).get({
|
|
5595
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5596
|
+
url: "/policy-review-schedules",
|
|
5597
|
+
...options
|
|
5598
|
+
});
|
|
5599
|
+
var postPolicyReviewSchedules = (options) => (options.client ?? client).post({
|
|
5600
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5601
|
+
url: "/policy-review-schedules",
|
|
5602
|
+
...options,
|
|
5603
|
+
headers: {
|
|
5604
|
+
"Content-Type": "application/vnd.api+json",
|
|
5605
|
+
...options.headers
|
|
5606
|
+
}
|
|
5607
|
+
});
|
|
5336
5608
|
var getFeatureDefinitions = (options) => (options.client ?? client).get({
|
|
5337
5609
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5338
5610
|
url: "/feature-definitions",
|
|
@@ -5370,6 +5642,15 @@ var postClinicalClientSupplements = (options) => (options.client ?? client).post
|
|
|
5370
5642
|
...options.headers
|
|
5371
5643
|
}
|
|
5372
5644
|
});
|
|
5645
|
+
var patchAmendmentRequestsByIdApprove = (options) => (options.client ?? client).patch({
|
|
5646
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5647
|
+
url: "/amendment-requests/{id}/approve",
|
|
5648
|
+
...options,
|
|
5649
|
+
headers: {
|
|
5650
|
+
"Content-Type": "application/vnd.api+json",
|
|
5651
|
+
...options.headers
|
|
5652
|
+
}
|
|
5653
|
+
});
|
|
5373
5654
|
var postUsersAuthConfirm = (options) => (options.client ?? client).post({
|
|
5374
5655
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5375
5656
|
url: "/users/auth/confirm",
|
|
@@ -5430,6 +5711,15 @@ var patchConnectorsById = (options) => (options.client ?? client).patch({
|
|
|
5430
5711
|
...options.headers
|
|
5431
5712
|
}
|
|
5432
5713
|
});
|
|
5714
|
+
var patchWalletPlanCancel = (options) => (options.client ?? client).patch({
|
|
5715
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5716
|
+
url: "/wallet/plan/cancel",
|
|
5717
|
+
...options,
|
|
5718
|
+
headers: {
|
|
5719
|
+
"Content-Type": "application/vnd.api+json",
|
|
5720
|
+
...options.headers
|
|
5721
|
+
}
|
|
5722
|
+
});
|
|
5433
5723
|
var getTenantsByTenantIdDocumentStats = (options) => (options.client ?? client).get({
|
|
5434
5724
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5435
5725
|
url: "/tenants/{tenant_id}/document_stats",
|
|
@@ -5479,6 +5769,11 @@ var getFieldTemplatesById = (options) => (options.client ?? client).get({
|
|
|
5479
5769
|
url: "/field-templates/{id}",
|
|
5480
5770
|
...options
|
|
5481
5771
|
});
|
|
5772
|
+
var getPolicyReviewSchedulesById = (options) => (options.client ?? client).get({
|
|
5773
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5774
|
+
url: "/policy-review-schedules/{id}",
|
|
5775
|
+
...options
|
|
5776
|
+
});
|
|
5482
5777
|
var postTenantsOrg = (options) => (options.client ?? client).post({
|
|
5483
5778
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5484
5779
|
url: "/tenants/org",
|
|
@@ -5676,6 +5971,20 @@ var postCrmActivities = (options) => (options.client ?? client).post({
|
|
|
5676
5971
|
...options.headers
|
|
5677
5972
|
}
|
|
5678
5973
|
});
|
|
5974
|
+
var getCdeScopeReports = (options) => (options.client ?? client).get({
|
|
5975
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5976
|
+
url: "/cde-scope-reports",
|
|
5977
|
+
...options
|
|
5978
|
+
});
|
|
5979
|
+
var postCdeScopeReports = (options) => (options.client ?? client).post({
|
|
5980
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5981
|
+
url: "/cde-scope-reports",
|
|
5982
|
+
...options,
|
|
5983
|
+
headers: {
|
|
5984
|
+
"Content-Type": "application/vnd.api+json",
|
|
5985
|
+
...options.headers
|
|
5986
|
+
}
|
|
5987
|
+
});
|
|
5679
5988
|
var getSchedulingEvents = (options) => (options.client ?? client).get({
|
|
5680
5989
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5681
5990
|
url: "/scheduling/events",
|
|
@@ -5713,6 +6022,20 @@ var patchSchedulingEventTypesById = (options) => (options.client ?? client).patc
|
|
|
5713
6022
|
...options.headers
|
|
5714
6023
|
}
|
|
5715
6024
|
});
|
|
6025
|
+
var getEphiDataFlows = (options) => (options.client ?? client).get({
|
|
6026
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6027
|
+
url: "/ephi-data-flows",
|
|
6028
|
+
...options
|
|
6029
|
+
});
|
|
6030
|
+
var postEphiDataFlows = (options) => (options.client ?? client).post({
|
|
6031
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6032
|
+
url: "/ephi-data-flows",
|
|
6033
|
+
...options,
|
|
6034
|
+
headers: {
|
|
6035
|
+
"Content-Type": "application/vnd.api+json",
|
|
6036
|
+
...options.headers
|
|
6037
|
+
}
|
|
6038
|
+
});
|
|
5716
6039
|
var patchSchedulingParticipantsByIdRespond = (options) => (options.client ?? client).patch({
|
|
5717
6040
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5718
6041
|
url: "/scheduling/participants/{id}/respond",
|
|
@@ -5740,6 +6063,20 @@ var patchStorageFilesByIdConfirmUpload = (options) => (options.client ?? client)
|
|
|
5740
6063
|
...options.headers
|
|
5741
6064
|
}
|
|
5742
6065
|
});
|
|
6066
|
+
var getComplianceRequirements = (options) => (options.client ?? client).get({
|
|
6067
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6068
|
+
url: "/compliance-requirements",
|
|
6069
|
+
...options
|
|
6070
|
+
});
|
|
6071
|
+
var postComplianceRequirements = (options) => (options.client ?? client).post({
|
|
6072
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6073
|
+
url: "/compliance-requirements",
|
|
6074
|
+
...options,
|
|
6075
|
+
headers: {
|
|
6076
|
+
"Content-Type": "application/vnd.api+json",
|
|
6077
|
+
...options.headers
|
|
6078
|
+
}
|
|
6079
|
+
});
|
|
5743
6080
|
var getExtractionDocuments = (options) => (options.client ?? client).get({
|
|
5744
6081
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5745
6082
|
url: "/extraction/documents",
|
|
@@ -5802,6 +6139,34 @@ var postConsentRecords = (options) => (options.client ?? client).post({
|
|
|
5802
6139
|
...options.headers
|
|
5803
6140
|
}
|
|
5804
6141
|
});
|
|
6142
|
+
var deleteComplianceRequirementsById = (options) => (options.client ?? client).delete({
|
|
6143
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6144
|
+
url: "/compliance-requirements/{id}",
|
|
6145
|
+
...options
|
|
6146
|
+
});
|
|
6147
|
+
var getComplianceRequirementsById = (options) => (options.client ?? client).get({
|
|
6148
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6149
|
+
url: "/compliance-requirements/{id}",
|
|
6150
|
+
...options
|
|
6151
|
+
});
|
|
6152
|
+
var patchComplianceRequirementsById = (options) => (options.client ?? client).patch({
|
|
6153
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6154
|
+
url: "/compliance-requirements/{id}",
|
|
6155
|
+
...options,
|
|
6156
|
+
headers: {
|
|
6157
|
+
"Content-Type": "application/vnd.api+json",
|
|
6158
|
+
...options.headers
|
|
6159
|
+
}
|
|
6160
|
+
});
|
|
6161
|
+
var patchPolicyReviewSchedulesByIdMarkDue = (options) => (options.client ?? client).patch({
|
|
6162
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6163
|
+
url: "/policy-review-schedules/{id}/mark-due",
|
|
6164
|
+
...options,
|
|
6165
|
+
headers: {
|
|
6166
|
+
"Content-Type": "application/vnd.api+json",
|
|
6167
|
+
...options.headers
|
|
6168
|
+
}
|
|
6169
|
+
});
|
|
5805
6170
|
var patchBrandIdentitiesByIdSetDefault = (options) => (options.client ?? client).patch({
|
|
5806
6171
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5807
6172
|
url: "/brand-identities/{id}/set-default",
|
|
@@ -5816,6 +6181,25 @@ var getBrandIdentitiesDefaultTenantByTenantId = (options) => (options.client ??
|
|
|
5816
6181
|
url: "/brand-identities/default/tenant/{tenant_id}",
|
|
5817
6182
|
...options
|
|
5818
6183
|
});
|
|
6184
|
+
var getAmendmentRequests = (options) => (options.client ?? client).get({
|
|
6185
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6186
|
+
url: "/amendment-requests",
|
|
6187
|
+
...options
|
|
6188
|
+
});
|
|
6189
|
+
var postAmendmentRequests = (options) => (options.client ?? client).post({
|
|
6190
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6191
|
+
url: "/amendment-requests",
|
|
6192
|
+
...options,
|
|
6193
|
+
headers: {
|
|
6194
|
+
"Content-Type": "application/vnd.api+json",
|
|
6195
|
+
...options.headers
|
|
6196
|
+
}
|
|
6197
|
+
});
|
|
6198
|
+
var getSocialTrendingItemsById = (options) => (options.client ?? client).get({
|
|
6199
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6200
|
+
url: "/social/trending/items/{id}",
|
|
6201
|
+
...options
|
|
6202
|
+
});
|
|
5819
6203
|
var postUsersAuthResendConfirmation = (options) => (options.client ?? client).post({
|
|
5820
6204
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5821
6205
|
url: "/users/auth/resend-confirmation",
|
|
@@ -5928,6 +6312,11 @@ var getWalletPlanPreview = (options) => (options.client ?? client).get({
|
|
|
5928
6312
|
url: "/wallet/plan/preview",
|
|
5929
6313
|
...options
|
|
5930
6314
|
});
|
|
6315
|
+
var getDisclosureLogsBySubject = (options) => (options.client ?? client).get({
|
|
6316
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6317
|
+
url: "/disclosure-logs/by-subject",
|
|
6318
|
+
...options
|
|
6319
|
+
});
|
|
5931
6320
|
var postAgentVersionsByIdSetSystemFields = (options) => (options.client ?? client).post({
|
|
5932
6321
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5933
6322
|
url: "/agent-versions/{id}/set-system-fields",
|
|
@@ -5946,15 +6335,6 @@ var postThreadsByIdSummarize = (options) => (options.client ?? client).post({
|
|
|
5946
6335
|
...options.headers
|
|
5947
6336
|
}
|
|
5948
6337
|
});
|
|
5949
|
-
var patchConfigsByKey = (options) => (options.client ?? client).patch({
|
|
5950
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
5951
|
-
url: "/configs/{key}",
|
|
5952
|
-
...options,
|
|
5953
|
-
headers: {
|
|
5954
|
-
"Content-Type": "application/vnd.api+json",
|
|
5955
|
-
...options.headers
|
|
5956
|
-
}
|
|
5957
|
-
});
|
|
5958
6338
|
var deleteLegalDocumentsById = (options) => (options.client ?? client).delete({
|
|
5959
6339
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5960
6340
|
url: "/legal-documents/{id}",
|
|
@@ -5979,6 +6359,20 @@ var getExtractionResults = (options) => (options.client ?? client).get({
|
|
|
5979
6359
|
url: "/extraction/results",
|
|
5980
6360
|
...options
|
|
5981
6361
|
});
|
|
6362
|
+
var getDisclosureLogs = (options) => (options.client ?? client).get({
|
|
6363
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6364
|
+
url: "/disclosure-logs",
|
|
6365
|
+
...options
|
|
6366
|
+
});
|
|
6367
|
+
var postDisclosureLogs = (options) => (options.client ?? client).post({
|
|
6368
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6369
|
+
url: "/disclosure-logs",
|
|
6370
|
+
...options,
|
|
6371
|
+
headers: {
|
|
6372
|
+
"Content-Type": "application/vnd.api+json",
|
|
6373
|
+
...options.headers
|
|
6374
|
+
}
|
|
6375
|
+
});
|
|
5982
6376
|
var postAgentsByIdClone = (options) => (options.client ?? client).post({
|
|
5983
6377
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5984
6378
|
url: "/agents/{id}/clone",
|
|
@@ -6011,6 +6405,11 @@ var postEmailInclusions = (options) => (options.client ?? client).post({
|
|
|
6011
6405
|
...options.headers
|
|
6012
6406
|
}
|
|
6013
6407
|
});
|
|
6408
|
+
var getAccessLogs = (options) => (options.client ?? client).get({
|
|
6409
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6410
|
+
url: "/access-logs",
|
|
6411
|
+
...options
|
|
6412
|
+
});
|
|
6014
6413
|
var getEmailInboundReceivedWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
6015
6414
|
security: [{ scheme: "bearer", type: "http" }],
|
|
6016
6415
|
url: "/email/inbound/received/workspace/{workspace_id}",
|
|
@@ -6115,34 +6514,29 @@ var deleteSupportTagsById = (options) => (options.client ?? client).delete({
|
|
|
6115
6514
|
url: "/support/tags/{id}",
|
|
6116
6515
|
...options
|
|
6117
6516
|
});
|
|
6118
|
-
var
|
|
6517
|
+
var patchComplianceOfficerDesignationsByIdRevoke = (options) => (options.client ?? client).patch({
|
|
6119
6518
|
security: [{ scheme: "bearer", type: "http" }],
|
|
6120
|
-
url: "/
|
|
6519
|
+
url: "/compliance-officer-designations/{id}/revoke",
|
|
6121
6520
|
...options,
|
|
6122
6521
|
headers: {
|
|
6123
6522
|
"Content-Type": "application/vnd.api+json",
|
|
6124
6523
|
...options.headers
|
|
6125
6524
|
}
|
|
6126
6525
|
});
|
|
6127
|
-
var
|
|
6128
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
6129
|
-
url: "/applications/by-slug/{slug}",
|
|
6130
|
-
...options
|
|
6131
|
-
});
|
|
6132
|
-
var getWebhookConfigs = (options) => (options.client ?? client).get({
|
|
6133
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
6134
|
-
url: "/webhook-configs",
|
|
6135
|
-
...options
|
|
6136
|
-
});
|
|
6137
|
-
var postWebhookConfigs = (options) => (options.client ?? client).post({
|
|
6526
|
+
var postExtractionDocumentsBulkReprocess = (options) => (options.client ?? client).post({
|
|
6138
6527
|
security: [{ scheme: "bearer", type: "http" }],
|
|
6139
|
-
url: "/
|
|
6528
|
+
url: "/extraction/documents/bulk-reprocess",
|
|
6140
6529
|
...options,
|
|
6141
6530
|
headers: {
|
|
6142
6531
|
"Content-Type": "application/vnd.api+json",
|
|
6143
6532
|
...options.headers
|
|
6144
6533
|
}
|
|
6145
6534
|
});
|
|
6535
|
+
var getApplicationsBySlugBySlug = (options) => (options.client ?? client).get({
|
|
6536
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6537
|
+
url: "/applications/by-slug/{slug}",
|
|
6538
|
+
...options
|
|
6539
|
+
});
|
|
6146
6540
|
var getWallet = (options) => (options.client ?? client).get({
|
|
6147
6541
|
security: [{ scheme: "bearer", type: "http" }],
|
|
6148
6542
|
url: "/wallet",
|
|
@@ -6167,6 +6561,20 @@ var patchCrawlerSchedulesById = (options) => (options.client ?? client).patch({
|
|
|
6167
6561
|
...options.headers
|
|
6168
6562
|
}
|
|
6169
6563
|
});
|
|
6564
|
+
var getComplianceDocumentTemplatesById = (options) => (options.client ?? client).get({
|
|
6565
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6566
|
+
url: "/compliance-document-templates/{id}",
|
|
6567
|
+
...options
|
|
6568
|
+
});
|
|
6569
|
+
var patchComplianceDocumentTemplatesById = (options) => (options.client ?? client).patch({
|
|
6570
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6571
|
+
url: "/compliance-document-templates/{id}",
|
|
6572
|
+
...options,
|
|
6573
|
+
headers: {
|
|
6574
|
+
"Content-Type": "application/vnd.api+json",
|
|
6575
|
+
...options.headers
|
|
6576
|
+
}
|
|
6577
|
+
});
|
|
6170
6578
|
var postCrmDeals = (options) => (options.client ?? client).post({
|
|
6171
6579
|
security: [{ scheme: "bearer", type: "http" }],
|
|
6172
6580
|
url: "/crm/deals",
|
|
@@ -6194,11 +6602,6 @@ var patchDataSubjectRequestsByIdStatus = (options) => (options.client ?? client)
|
|
|
6194
6602
|
...options.headers
|
|
6195
6603
|
}
|
|
6196
6604
|
});
|
|
6197
|
-
var getLlmAnalyticsUsage = (options) => (options.client ?? client).get({
|
|
6198
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
6199
|
-
url: "/llm-analytics/usage",
|
|
6200
|
-
...options
|
|
6201
|
-
});
|
|
6202
6605
|
var getCrmActivitiesWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
6203
6606
|
security: [{ scheme: "bearer", type: "http" }],
|
|
6204
6607
|
url: "/crm/activities/workspace/{workspace_id}",
|
|
@@ -6223,6 +6626,16 @@ var patchSocialCampaignsById = (options) => (options.client ?? client).patch({
|
|
|
6223
6626
|
...options.headers
|
|
6224
6627
|
}
|
|
6225
6628
|
});
|
|
6629
|
+
var getWorkspaceAgentConfigs = (options) => (options.client ?? client).get({
|
|
6630
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6631
|
+
url: "/workspace-agent-configs",
|
|
6632
|
+
...options
|
|
6633
|
+
});
|
|
6634
|
+
var getDisclosureLogsById = (options) => (options.client ?? client).get({
|
|
6635
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6636
|
+
url: "/disclosure-logs/{id}",
|
|
6637
|
+
...options
|
|
6638
|
+
});
|
|
6226
6639
|
var getAiGraphNodes = (options) => (options.client ?? client).get({
|
|
6227
6640
|
security: [{ scheme: "bearer", type: "http" }],
|
|
6228
6641
|
url: "/ai/graph/nodes",
|
|
@@ -6251,12 +6664,7 @@ var postAgents = (options) => (options.client ?? client).post({
|
|
|
6251
6664
|
...options.headers
|
|
6252
6665
|
}
|
|
6253
6666
|
});
|
|
6254
|
-
var
|
|
6255
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
6256
|
-
url: "/applications/{application_id}/email-templates/{slug}",
|
|
6257
|
-
...options
|
|
6258
|
-
});
|
|
6259
|
-
var postSupportTicketRatings = (options) => (options.client ?? client).post({
|
|
6667
|
+
var postSupportTicketRatings = (options) => (options.client ?? client).post({
|
|
6260
6668
|
security: [{ scheme: "bearer", type: "http" }],
|
|
6261
6669
|
url: "/support/ticket-ratings",
|
|
6262
6670
|
...options,
|
|
@@ -6293,6 +6701,29 @@ var postRetentionPolicies = (options) => (options.client ?? client).post({
|
|
|
6293
6701
|
...options.headers
|
|
6294
6702
|
}
|
|
6295
6703
|
});
|
|
6704
|
+
var patchBusinessAssociateAgreementsByIdSign = (options) => (options.client ?? client).patch({
|
|
6705
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6706
|
+
url: "/business-associate-agreements/{id}/sign",
|
|
6707
|
+
...options,
|
|
6708
|
+
headers: {
|
|
6709
|
+
"Content-Type": "application/vnd.api+json",
|
|
6710
|
+
...options.headers
|
|
6711
|
+
}
|
|
6712
|
+
});
|
|
6713
|
+
var getComplianceDocumentTemplates = (options) => (options.client ?? client).get({
|
|
6714
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6715
|
+
url: "/compliance-document-templates",
|
|
6716
|
+
...options
|
|
6717
|
+
});
|
|
6718
|
+
var postComplianceDocumentTemplates = (options) => (options.client ?? client).post({
|
|
6719
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6720
|
+
url: "/compliance-document-templates",
|
|
6721
|
+
...options,
|
|
6722
|
+
headers: {
|
|
6723
|
+
"Content-Type": "application/vnd.api+json",
|
|
6724
|
+
...options.headers
|
|
6725
|
+
}
|
|
6726
|
+
});
|
|
6296
6727
|
var postConnectorsByIdSync = (options) => (options.client ?? client).post({
|
|
6297
6728
|
security: [{ scheme: "bearer", type: "http" }],
|
|
6298
6729
|
url: "/connectors/{id}/sync",
|
|
@@ -7027,8 +7458,8 @@ function createAgentsNamespace(rb) {
|
|
|
7027
7458
|
data: {
|
|
7028
7459
|
type: "agent",
|
|
7029
7460
|
attributes: {
|
|
7030
|
-
|
|
7031
|
-
|
|
7461
|
+
base_agent_id: agentId,
|
|
7462
|
+
workspace_id: targetWorkspaceId
|
|
7032
7463
|
}
|
|
7033
7464
|
}
|
|
7034
7465
|
}
|
|
@@ -8129,6 +8560,107 @@ function createAgentsNamespace(rb) {
|
|
|
8129
8560
|
options
|
|
8130
8561
|
);
|
|
8131
8562
|
}
|
|
8563
|
+
},
|
|
8564
|
+
// ── Agent Deployments (read-only on client API) ──────────────────
|
|
8565
|
+
/**
|
|
8566
|
+
* Read-only access to agent deployments for the current application.
|
|
8567
|
+
* Create/update/delete operations are available via the admin SDK.
|
|
8568
|
+
*/
|
|
8569
|
+
deployments: {
|
|
8570
|
+
/**
|
|
8571
|
+
* Lists all agent deployments for the current application.
|
|
8572
|
+
*
|
|
8573
|
+
* @param options - Optional request options (pagination, filters).
|
|
8574
|
+
* @returns A paginated list of agent deployments.
|
|
8575
|
+
*
|
|
8576
|
+
* @example
|
|
8577
|
+
* const deployments = await client.agents.deployments.list();
|
|
8578
|
+
*/
|
|
8579
|
+
list: async (options) => {
|
|
8580
|
+
return rb.execute(getAgentDeployments, {}, options);
|
|
8581
|
+
},
|
|
8582
|
+
/**
|
|
8583
|
+
* Retrieves a single agent deployment by ID.
|
|
8584
|
+
*
|
|
8585
|
+
* @param id - The UUID of the deployment.
|
|
8586
|
+
* @param options - Optional request options.
|
|
8587
|
+
* @returns The agent deployment.
|
|
8588
|
+
*
|
|
8589
|
+
* @example
|
|
8590
|
+
* const deployment = await client.agents.deployments.get('dep_01...');
|
|
8591
|
+
*/
|
|
8592
|
+
get: async (id, options) => {
|
|
8593
|
+
return rb.execute(
|
|
8594
|
+
getAgentDeploymentsById,
|
|
8595
|
+
{ path: { id } },
|
|
8596
|
+
options
|
|
8597
|
+
);
|
|
8598
|
+
}
|
|
8599
|
+
},
|
|
8600
|
+
// ── Workspace Agent Configs (read + update on client API) ────────
|
|
8601
|
+
/**
|
|
8602
|
+
* Workspace-level agent configuration overrides.
|
|
8603
|
+
* End users can read and update overrides; create/delete via admin SDK.
|
|
8604
|
+
*/
|
|
8605
|
+
workspaceConfigs: {
|
|
8606
|
+
/**
|
|
8607
|
+
* Lists all workspace agent configs.
|
|
8608
|
+
*
|
|
8609
|
+
* @param options - Optional request options (pagination, filters).
|
|
8610
|
+
* @returns A paginated list of workspace agent configs.
|
|
8611
|
+
*
|
|
8612
|
+
* @example
|
|
8613
|
+
* const configs = await client.agents.workspaceConfigs.list();
|
|
8614
|
+
*/
|
|
8615
|
+
list: async (options) => {
|
|
8616
|
+
return rb.execute(
|
|
8617
|
+
getWorkspaceAgentConfigs,
|
|
8618
|
+
{},
|
|
8619
|
+
options
|
|
8620
|
+
);
|
|
8621
|
+
},
|
|
8622
|
+
/**
|
|
8623
|
+
* Retrieves a single workspace agent config by ID.
|
|
8624
|
+
*
|
|
8625
|
+
* @param id - The UUID of the config.
|
|
8626
|
+
* @param options - Optional request options.
|
|
8627
|
+
* @returns The workspace agent config.
|
|
8628
|
+
*
|
|
8629
|
+
* @example
|
|
8630
|
+
* const config = await client.agents.workspaceConfigs.get('wac_01...');
|
|
8631
|
+
*/
|
|
8632
|
+
get: async (id, options) => {
|
|
8633
|
+
return rb.execute(
|
|
8634
|
+
getWorkspaceAgentConfigsById,
|
|
8635
|
+
{ path: { id } },
|
|
8636
|
+
options
|
|
8637
|
+
);
|
|
8638
|
+
},
|
|
8639
|
+
/**
|
|
8640
|
+
* Updates a workspace agent config's overrides.
|
|
8641
|
+
*
|
|
8642
|
+
* @param id - The UUID of the config.
|
|
8643
|
+
* @param attributes - Attributes to update (e.g. overrides).
|
|
8644
|
+
* @param options - Optional request options.
|
|
8645
|
+
* @returns The updated workspace agent config.
|
|
8646
|
+
*
|
|
8647
|
+
* @example
|
|
8648
|
+
* await client.agents.workspaceConfigs.update('wac_01...', {
|
|
8649
|
+
* overrides: { prompt_template: 'Custom prompt...' },
|
|
8650
|
+
* });
|
|
8651
|
+
*/
|
|
8652
|
+
update: async (id, attributes, options) => {
|
|
8653
|
+
return rb.execute(
|
|
8654
|
+
patchWorkspaceAgentConfigsById,
|
|
8655
|
+
{
|
|
8656
|
+
path: { id },
|
|
8657
|
+
body: {
|
|
8658
|
+
data: { type: "workspace-agent-config", id, attributes }
|
|
8659
|
+
}
|
|
8660
|
+
},
|
|
8661
|
+
options
|
|
8662
|
+
);
|
|
8663
|
+
}
|
|
8132
8664
|
}
|
|
8133
8665
|
};
|
|
8134
8666
|
}
|
|
@@ -8395,137 +8927,6 @@ function createAiNamespace(rb) {
|
|
|
8395
8927
|
);
|
|
8396
8928
|
}
|
|
8397
8929
|
},
|
|
8398
|
-
/**
|
|
8399
|
-
* Sub-namespace for querying LLM token usage, cost, and workspace analytics.
|
|
8400
|
-
*
|
|
8401
|
-
* Analytics data is aggregated from all LLM inference calls made by the
|
|
8402
|
-
* workspace, including agent executions, conversation messages, embedding
|
|
8403
|
-
* generation, and classification tasks. Use these methods for cost
|
|
8404
|
-
* attribution, budget monitoring, and observability dashboards.
|
|
8405
|
-
*
|
|
8406
|
-
* @example
|
|
8407
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
8408
|
-
* const costs = await client.ai.analytics.costs();
|
|
8409
|
-
* console.log(`Total spend this period: $${costs.total_usd}`);
|
|
8410
|
-
*/
|
|
8411
|
-
analytics: {
|
|
8412
|
-
/**
|
|
8413
|
-
* Lists raw LLM analytics records for the workspace.
|
|
8414
|
-
*
|
|
8415
|
-
* Returns individual inference records with per-call token counts, model
|
|
8416
|
-
* identifiers, latency, and cost. Useful for building custom aggregations
|
|
8417
|
-
* or exporting raw usage data for external billing systems.
|
|
8418
|
-
*
|
|
8419
|
-
* @param options - Optional request options.
|
|
8420
|
-
* @returns A promise that resolves to an array of `LlmAnalytics` records.
|
|
8421
|
-
*
|
|
8422
|
-
* @example
|
|
8423
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
8424
|
-
* const records = await client.ai.analytics.list();
|
|
8425
|
-
* console.log(`Inference calls retrieved: ${records.length}`);
|
|
8426
|
-
*/
|
|
8427
|
-
list: async (options) => {
|
|
8428
|
-
return rb.execute(getLlmAnalytics, {}, options);
|
|
8429
|
-
},
|
|
8430
|
-
/**
|
|
8431
|
-
* Returns a token cost breakdown grouped by model and time period.
|
|
8432
|
-
*
|
|
8433
|
-
* The response includes total spend in USD, prompt token counts, completion
|
|
8434
|
-
* token counts, and per-model breakdowns for all LLM calls made within the
|
|
8435
|
-
* queried window. Time range and granularity can be passed via request
|
|
8436
|
-
* options or query parameters.
|
|
8437
|
-
*
|
|
8438
|
-
* @param options - Optional request options. Pass `from`, `to` (ISO date
|
|
8439
|
-
* strings), and `granularity` (`'day'` | `'week'` | `'month'`) to
|
|
8440
|
-
* control the reporting window.
|
|
8441
|
-
* @returns A promise that resolves to a cost breakdown map, including
|
|
8442
|
-
* `total_usd`, `by_model` array, and time-series data points.
|
|
8443
|
-
*
|
|
8444
|
-
* @example
|
|
8445
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
8446
|
-
* const costs = await client.ai.analytics.costs();
|
|
8447
|
-
* console.log(`Total tokens: ${costs.total_tokens}`);
|
|
8448
|
-
* console.log(`Total cost: $${costs.total_usd}`);
|
|
8449
|
-
* for (const model of costs.by_model) {
|
|
8450
|
-
* console.log(` ${model.name}: $${model.usd} (${model.tokens} tokens)`);
|
|
8451
|
-
* }
|
|
8452
|
-
*/
|
|
8453
|
-
costs: async (options) => {
|
|
8454
|
-
return rb.execute(getLlmAnalyticsCosts, {}, options);
|
|
8455
|
-
},
|
|
8456
|
-
/**
|
|
8457
|
-
* Returns a high-level summary of LLM usage for the workspace.
|
|
8458
|
-
*
|
|
8459
|
-
* Provides pre-aggregated metrics including total requests, total tokens
|
|
8460
|
-
* (prompt + completion), average latency, error rate, and top models by
|
|
8461
|
-
* usage. Intended as the primary data source for observability dashboards
|
|
8462
|
-
* and usage overview pages.
|
|
8463
|
-
*
|
|
8464
|
-
* @param options - Optional request options. Pass date range parameters
|
|
8465
|
-
* to filter the summary window.
|
|
8466
|
-
* @returns A promise that resolves to a summary metrics object.
|
|
8467
|
-
*
|
|
8468
|
-
* @example
|
|
8469
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
8470
|
-
* const summary = await client.ai.analytics.summary();
|
|
8471
|
-
* console.log(`Total requests: ${summary.total_requests}`);
|
|
8472
|
-
* console.log(`Average latency: ${summary.avg_latency_ms}ms`);
|
|
8473
|
-
*/
|
|
8474
|
-
summary: async (options) => {
|
|
8475
|
-
return rb.execute(
|
|
8476
|
-
getLlmAnalyticsSummary,
|
|
8477
|
-
{},
|
|
8478
|
-
options
|
|
8479
|
-
);
|
|
8480
|
-
},
|
|
8481
|
-
/**
|
|
8482
|
-
* Returns raw, time-series LLM usage data points for the workspace.
|
|
8483
|
-
*
|
|
8484
|
-
* Unlike {@link summary} which returns pre-aggregated totals, this method
|
|
8485
|
-
* returns fine-grained data suitable for building custom charts and
|
|
8486
|
-
* time-series visualizations. Each data point includes a timestamp,
|
|
8487
|
-
* request count, token counts, and latency percentiles.
|
|
8488
|
-
*
|
|
8489
|
-
* @param options - Optional request options. Pass `from`, `to`, and
|
|
8490
|
-
* `granularity` to control the series resolution.
|
|
8491
|
-
* @returns A promise that resolves to an object containing a `data_points`
|
|
8492
|
-
* array and associated metadata.
|
|
8493
|
-
*
|
|
8494
|
-
* @example
|
|
8495
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
8496
|
-
* const usage = await client.ai.analytics.usage();
|
|
8497
|
-
* for (const point of usage.data_points) {
|
|
8498
|
-
* console.log(`${point.timestamp}: ${point.tokens} tokens, ${point.requests} requests`);
|
|
8499
|
-
* }
|
|
8500
|
-
*/
|
|
8501
|
-
usage: async (options) => {
|
|
8502
|
-
return rb.execute(getLlmAnalyticsUsage, {}, options);
|
|
8503
|
-
},
|
|
8504
|
-
/**
|
|
8505
|
-
* Returns workspace-scoped LLM metrics aggregated across all tenants and
|
|
8506
|
-
* agents within the workspace.
|
|
8507
|
-
*
|
|
8508
|
-
* Provides a holistic view of workspace-level inference activity, including
|
|
8509
|
-
* breakdowns by agent, user, and feature area. Useful for multi-tenant
|
|
8510
|
-
* platform operators who need to understand aggregate consumption patterns
|
|
8511
|
-
* across all workspace activity.
|
|
8512
|
-
*
|
|
8513
|
-
* @param options - Optional request options.
|
|
8514
|
-
* @returns A promise that resolves to a workspace metrics object.
|
|
8515
|
-
*
|
|
8516
|
-
* @example
|
|
8517
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
8518
|
-
* const metrics = await client.ai.analytics.workspace();
|
|
8519
|
-
* console.log(`Top agent by tokens: ${metrics.top_agents[0]?.name}`);
|
|
8520
|
-
*/
|
|
8521
|
-
workspace: async (options) => {
|
|
8522
|
-
return rb.execute(
|
|
8523
|
-
getLlmAnalyticsWorkspace,
|
|
8524
|
-
{},
|
|
8525
|
-
options
|
|
8526
|
-
);
|
|
8527
|
-
}
|
|
8528
|
-
},
|
|
8529
8930
|
/**
|
|
8530
8931
|
* Sub-namespace for managing knowledge graph nodes.
|
|
8531
8932
|
*
|
|
@@ -8854,6 +9255,77 @@ function createBillingNamespace(rb) {
|
|
|
8854
9255
|
{ path: { addon_slug: addonSlug }, body: {} },
|
|
8855
9256
|
options
|
|
8856
9257
|
);
|
|
9258
|
+
},
|
|
9259
|
+
/**
|
|
9260
|
+
* Cancel the current subscription plan.
|
|
9261
|
+
*
|
|
9262
|
+
* @param immediate - If true (default), cancel immediately. If false, cancel at end of billing period.
|
|
9263
|
+
* @param options - Request options
|
|
9264
|
+
* @returns Updated wallet with new subscription_status
|
|
9265
|
+
*
|
|
9266
|
+
* @example
|
|
9267
|
+
* ```typescript
|
|
9268
|
+
* // Cancel immediately
|
|
9269
|
+
* const wallet = await client.billing.wallet.cancelPlan();
|
|
9270
|
+
*
|
|
9271
|
+
* // Cancel at end of period
|
|
9272
|
+
* const wallet = await client.billing.wallet.cancelPlan(false);
|
|
9273
|
+
* ```
|
|
9274
|
+
*/
|
|
9275
|
+
cancelPlan: async (immediateOrOptions, options) => {
|
|
9276
|
+
let immediate;
|
|
9277
|
+
let reqOptions;
|
|
9278
|
+
if (typeof immediateOrOptions === "boolean") {
|
|
9279
|
+
immediate = immediateOrOptions;
|
|
9280
|
+
reqOptions = options;
|
|
9281
|
+
} else {
|
|
9282
|
+
immediate = true;
|
|
9283
|
+
reqOptions = immediateOrOptions;
|
|
9284
|
+
}
|
|
9285
|
+
const wallet = await rb.execute(getWallet, {}, reqOptions);
|
|
9286
|
+
const walletId = wallet.id;
|
|
9287
|
+
return rb.execute(
|
|
9288
|
+
patchWalletPlanCancel,
|
|
9289
|
+
{
|
|
9290
|
+
body: {
|
|
9291
|
+
data: {
|
|
9292
|
+
id: walletId,
|
|
9293
|
+
type: "wallet",
|
|
9294
|
+
attributes: { immediate }
|
|
9295
|
+
}
|
|
9296
|
+
}
|
|
9297
|
+
},
|
|
9298
|
+
reqOptions
|
|
9299
|
+
);
|
|
9300
|
+
},
|
|
9301
|
+
/**
|
|
9302
|
+
* Retry a failed subscription payment.
|
|
9303
|
+
*
|
|
9304
|
+
* Only works when the subscription is in `past_due` status. Uses the
|
|
9305
|
+
* default payment method on file. On success, restores the subscription
|
|
9306
|
+
* to `active` status and clears the dunning state.
|
|
9307
|
+
*
|
|
9308
|
+
* @param options - Request options
|
|
9309
|
+
* @returns Updated wallet with restored subscription status
|
|
9310
|
+
*
|
|
9311
|
+
* @example
|
|
9312
|
+
* ```typescript
|
|
9313
|
+
* const wallet = await client.billing.wallet.retryPayment();
|
|
9314
|
+
* console.log(wallet.attributes?.subscription_status); // "active"
|
|
9315
|
+
* ```
|
|
9316
|
+
*/
|
|
9317
|
+
retryPayment: async (options) => {
|
|
9318
|
+
const wallet = await rb.execute(getWallet, {}, options);
|
|
9319
|
+
const walletId = wallet.id;
|
|
9320
|
+
return rb.execute(
|
|
9321
|
+
patchWalletPaymentRetry,
|
|
9322
|
+
{
|
|
9323
|
+
body: {
|
|
9324
|
+
data: { id: walletId, type: "wallet", attributes: {} }
|
|
9325
|
+
}
|
|
9326
|
+
},
|
|
9327
|
+
options
|
|
9328
|
+
);
|
|
8857
9329
|
}
|
|
8858
9330
|
},
|
|
8859
9331
|
/**
|
|
@@ -9376,7 +9848,16 @@ function createBillingNamespace(rb) {
|
|
|
9376
9848
|
setDefault: async (id, options) => {
|
|
9377
9849
|
return rb.execute(
|
|
9378
9850
|
patchPaymentMethodsByIdDefault,
|
|
9379
|
-
{
|
|
9851
|
+
{
|
|
9852
|
+
path: { id },
|
|
9853
|
+
body: {
|
|
9854
|
+
data: {
|
|
9855
|
+
id,
|
|
9856
|
+
type: "payment-method",
|
|
9857
|
+
attributes: { is_default: true }
|
|
9858
|
+
}
|
|
9859
|
+
}
|
|
9860
|
+
},
|
|
9380
9861
|
options
|
|
9381
9862
|
);
|
|
9382
9863
|
}
|
|
@@ -9536,6 +10017,40 @@ function createBillingNamespace(rb) {
|
|
|
9536
10017
|
);
|
|
9537
10018
|
return result.data ?? result;
|
|
9538
10019
|
}
|
|
10020
|
+
},
|
|
10021
|
+
/**
|
|
10022
|
+
* Composite feature summary — definitions, allocations, and usage in one call.
|
|
10023
|
+
*
|
|
10024
|
+
* Eliminates the need to call featureDefinitions, planFeatureAllocations,
|
|
10025
|
+
* and featureUsages separately. Returns everything the frontend needs for
|
|
10026
|
+
* feature gating UI.
|
|
10027
|
+
*/
|
|
10028
|
+
featureSummary: {
|
|
10029
|
+
/**
|
|
10030
|
+
* Get all features with plan allocations and current usage for the tenant.
|
|
10031
|
+
*
|
|
10032
|
+
* Each item includes: key, name, enabled, metering_mode, limit,
|
|
10033
|
+
* used_this_cycle, remaining, credit_cost, activation_cost, activated.
|
|
10034
|
+
*
|
|
10035
|
+
* @param options - Request options
|
|
10036
|
+
* @returns Array of feature summaries with usage data
|
|
10037
|
+
*
|
|
10038
|
+
* @example
|
|
10039
|
+
* ```typescript
|
|
10040
|
+
* const features = await client.billing.featureSummary.list();
|
|
10041
|
+
* features.forEach(f => {
|
|
10042
|
+
* console.log(`${f.attributes?.key}: ${f.attributes?.used_this_cycle}/${f.attributes?.limit}`);
|
|
10043
|
+
* });
|
|
10044
|
+
* ```
|
|
10045
|
+
*/
|
|
10046
|
+
list: async (options) => {
|
|
10047
|
+
const result = await rb.execute(
|
|
10048
|
+
getWalletFeatures,
|
|
10049
|
+
{},
|
|
10050
|
+
options
|
|
10051
|
+
);
|
|
10052
|
+
return result.data ?? result;
|
|
10053
|
+
}
|
|
9539
10054
|
}
|
|
9540
10055
|
};
|
|
9541
10056
|
}
|
|
@@ -10461,7 +10976,7 @@ function createClinicalNamespace(rb) {
|
|
|
10461
10976
|
* Manage clinical notes (SOAP notes, progress notes, AI-generated summaries).
|
|
10462
10977
|
*
|
|
10463
10978
|
* Notes support a HITL (Human-In-The-Loop) approval workflow: AI-generated
|
|
10464
|
-
* notes start with `status: "
|
|
10979
|
+
* notes start with `status: "draft"` and must be approved or rejected
|
|
10465
10980
|
* by a clinician before they are finalized.
|
|
10466
10981
|
*/
|
|
10467
10982
|
notes: {
|
|
@@ -10488,7 +11003,7 @@ function createClinicalNamespace(rb) {
|
|
|
10488
11003
|
/**
|
|
10489
11004
|
* Create a new clinical note.
|
|
10490
11005
|
*
|
|
10491
|
-
* @param attributes - Note creation attributes. Must include `workspace_id
|
|
11006
|
+
* @param attributes - Note creation attributes. Must include `workspace_id` and `session_id`.
|
|
10492
11007
|
* @param options - Request options
|
|
10493
11008
|
* @returns Created {@link ClinicalNote} record
|
|
10494
11009
|
*/
|
|
@@ -10525,42 +11040,63 @@ function createClinicalNamespace(rb) {
|
|
|
10525
11040
|
* Approve a clinical note (HITL workflow).
|
|
10526
11041
|
*
|
|
10527
11042
|
* Marks the note as clinician-reviewed and approved, transitioning it
|
|
10528
|
-
* to `status: "approved"`. Only notes in `
|
|
11043
|
+
* to `status: "approved"`. Only notes in `draft` status can be approved.
|
|
11044
|
+
* Creates an immutable NoteVersion snapshot.
|
|
10529
11045
|
*
|
|
10530
11046
|
* @param id - Note UUID
|
|
11047
|
+
* @param reviewedById - UUID of the reviewer (required)
|
|
10531
11048
|
* @param options - Request options
|
|
10532
11049
|
* @returns Updated {@link ClinicalNote} record
|
|
10533
11050
|
*
|
|
10534
11051
|
* @example
|
|
10535
11052
|
* ```typescript
|
|
10536
|
-
* const approved = await client.clinical.notes.approve('note_abc');
|
|
11053
|
+
* const approved = await client.clinical.notes.approve('note_abc', 'user_xyz');
|
|
10537
11054
|
* console.log(approved.attributes.status); // 'approved'
|
|
10538
11055
|
* ```
|
|
10539
11056
|
*/
|
|
10540
|
-
approve: async (id, options) => rb.execute(
|
|
11057
|
+
approve: async (id, reviewedById, options) => rb.execute(
|
|
10541
11058
|
patchClinicalNotesByIdApprove,
|
|
10542
|
-
{
|
|
11059
|
+
{
|
|
11060
|
+
path: { id },
|
|
11061
|
+
body: {
|
|
11062
|
+
data: {
|
|
11063
|
+
type: "clinical-note",
|
|
11064
|
+
id,
|
|
11065
|
+
attributes: { reviewed_by_id: reviewedById }
|
|
11066
|
+
}
|
|
11067
|
+
}
|
|
11068
|
+
},
|
|
10543
11069
|
options
|
|
10544
11070
|
),
|
|
10545
11071
|
/**
|
|
10546
11072
|
* Reject a clinical note (HITL workflow).
|
|
10547
11073
|
*
|
|
10548
11074
|
* Marks the note as rejected, transitioning it to `status: "rejected"`.
|
|
10549
|
-
* Only notes in `
|
|
11075
|
+
* Only notes in `draft` status can be rejected.
|
|
10550
11076
|
*
|
|
10551
11077
|
* @param id - Note UUID
|
|
11078
|
+
* @param reviewedById - UUID of the reviewer (required)
|
|
10552
11079
|
* @param options - Request options
|
|
10553
11080
|
* @returns Updated {@link ClinicalNote} record
|
|
10554
11081
|
*
|
|
10555
11082
|
* @example
|
|
10556
11083
|
* ```typescript
|
|
10557
|
-
* const rejected = await client.clinical.notes.reject('note_abc');
|
|
11084
|
+
* const rejected = await client.clinical.notes.reject('note_abc', 'user_xyz');
|
|
10558
11085
|
* console.log(rejected.attributes.status); // 'rejected'
|
|
10559
11086
|
* ```
|
|
10560
11087
|
*/
|
|
10561
|
-
reject: async (id, options) => rb.execute(
|
|
11088
|
+
reject: async (id, reviewedById, options) => rb.execute(
|
|
10562
11089
|
patchClinicalNotesByIdReject,
|
|
10563
|
-
{
|
|
11090
|
+
{
|
|
11091
|
+
path: { id },
|
|
11092
|
+
body: {
|
|
11093
|
+
data: {
|
|
11094
|
+
type: "clinical-note",
|
|
11095
|
+
id,
|
|
11096
|
+
attributes: { reviewed_by_id: reviewedById }
|
|
11097
|
+
}
|
|
11098
|
+
}
|
|
11099
|
+
},
|
|
10564
11100
|
options
|
|
10565
11101
|
),
|
|
10566
11102
|
/**
|
|
@@ -10623,7 +11159,7 @@ function createClinicalNamespace(rb) {
|
|
|
10623
11159
|
* Record a new health metric entry.
|
|
10624
11160
|
*
|
|
10625
11161
|
* @param attributes - Metric creation attributes. Must include `workspace_id`, `patient_id`,
|
|
10626
|
-
*
|
|
11162
|
+
* and `metric_type`.
|
|
10627
11163
|
* @param options - Request options
|
|
10628
11164
|
* @returns Created {@link ClinicalHealthMetric} record
|
|
10629
11165
|
*
|
|
@@ -10632,9 +11168,9 @@ function createClinicalNamespace(rb) {
|
|
|
10632
11168
|
* const metric = await client.clinical.healthMetrics.create({
|
|
10633
11169
|
* workspace_id: 'ws_123',
|
|
10634
11170
|
* patient_id: 'pat_abc',
|
|
11171
|
+
* metric_type: 'weight_kg',
|
|
10635
11172
|
* metric_category: 'vitals',
|
|
10636
|
-
*
|
|
10637
|
-
* value: 82.5,
|
|
11173
|
+
* value_numeric: 82.5,
|
|
10638
11174
|
* unit: 'kg',
|
|
10639
11175
|
* });
|
|
10640
11176
|
* ```
|
|
@@ -10704,7 +11240,7 @@ function createClinicalNamespace(rb) {
|
|
|
10704
11240
|
/**
|
|
10705
11241
|
* Create a new meal plan.
|
|
10706
11242
|
*
|
|
10707
|
-
* @param attributes - Meal plan creation attributes. Must include `workspace_id
|
|
11243
|
+
* @param attributes - Meal plan creation attributes. Must include `workspace_id`.
|
|
10708
11244
|
* @param options - Request options
|
|
10709
11245
|
* @returns Created {@link ClinicalMealPlan} record
|
|
10710
11246
|
*/
|
|
@@ -10773,7 +11309,7 @@ function createClinicalNamespace(rb) {
|
|
|
10773
11309
|
/**
|
|
10774
11310
|
* Create a new client goal.
|
|
10775
11311
|
*
|
|
10776
|
-
* @param attributes - Goal creation attributes. Must include `workspace_id`, `patient_id`, and `title`.
|
|
11312
|
+
* @param attributes - Goal creation attributes. Must include `workspace_id`, `patient_id`, `goal_type`, and `title`.
|
|
10777
11313
|
* @param options - Request options
|
|
10778
11314
|
* @returns Created {@link ClinicalClientGoal} record
|
|
10779
11315
|
*/
|
|
@@ -10843,7 +11379,7 @@ function createClinicalNamespace(rb) {
|
|
|
10843
11379
|
* Create a new supplement prescription.
|
|
10844
11380
|
*
|
|
10845
11381
|
* @param attributes - Supplement creation attributes. Must include `workspace_id`,
|
|
10846
|
-
* `patient_id`, and `
|
|
11382
|
+
* `patient_id`, and `name`.
|
|
10847
11383
|
* @param options - Request options
|
|
10848
11384
|
* @returns Created {@link ClinicalClientSupplement} record
|
|
10849
11385
|
*/
|
|
@@ -11029,7 +11565,7 @@ function createClinicalNamespace(rb) {
|
|
|
11029
11565
|
*/
|
|
11030
11566
|
list: async (params, options) => rb.execute(
|
|
11031
11567
|
getClinicalPracticeTools,
|
|
11032
|
-
params
|
|
11568
|
+
{ ...params },
|
|
11033
11569
|
options
|
|
11034
11570
|
),
|
|
11035
11571
|
/**
|
|
@@ -11083,6 +11619,28 @@ function createClinicalNamespace(rb) {
|
|
|
11083
11619
|
deleteClinicalPracticeToolsById,
|
|
11084
11620
|
{ path: { id } },
|
|
11085
11621
|
options
|
|
11622
|
+
),
|
|
11623
|
+
/**
|
|
11624
|
+
* List distinct practice tool categories in a workspace.
|
|
11625
|
+
*
|
|
11626
|
+
* Returns unique `tool_type` values with their active tool counts,
|
|
11627
|
+
* sorted by count descending.
|
|
11628
|
+
*
|
|
11629
|
+
* @param params - Must include `workspace_id`
|
|
11630
|
+
* @param options - Request options
|
|
11631
|
+
* @returns Array of {@link PracticeToolCategory} records
|
|
11632
|
+
*
|
|
11633
|
+
* @example
|
|
11634
|
+
* ```typescript
|
|
11635
|
+
* const categories = await client.clinical.practiceTools.listCategories({
|
|
11636
|
+
* workspace_id: "..."
|
|
11637
|
+
* });
|
|
11638
|
+
* // [{ category: "app", tool_count: 5 }, { category: "wearable", tool_count: 3 }]
|
|
11639
|
+
* ```
|
|
11640
|
+
*/
|
|
11641
|
+
listCategories: async (params, options) => rb.rawGet(
|
|
11642
|
+
`/clinical/practice-tools/categories?workspace_id=${encodeURIComponent(params.workspace_id)}`,
|
|
11643
|
+
options
|
|
11086
11644
|
)
|
|
11087
11645
|
},
|
|
11088
11646
|
/**
|
|
@@ -12587,13 +13145,1728 @@ function createComplianceNamespace(rb) {
|
|
|
12587
13145
|
options
|
|
12588
13146
|
);
|
|
12589
13147
|
}
|
|
12590
|
-
}
|
|
12591
|
-
|
|
12592
|
-
|
|
12593
|
-
|
|
12594
|
-
|
|
12595
|
-
|
|
12596
|
-
|
|
13148
|
+
},
|
|
13149
|
+
/**
|
|
13150
|
+
* Get aggregated compliance posture for a workspace.
|
|
13151
|
+
*
|
|
13152
|
+
* Returns breach stats, DSR metrics, risk assessments, retention policies,
|
|
13153
|
+
* PII scan coverage, consent tracking, and regulatory framework readiness
|
|
13154
|
+
* in a single call.
|
|
13155
|
+
*
|
|
13156
|
+
* @param params - Must include `workspace_id`
|
|
13157
|
+
* @param options - Request options
|
|
13158
|
+
* @returns {@link CompliancePosture} snapshot
|
|
13159
|
+
*
|
|
13160
|
+
* @example
|
|
13161
|
+
* ```typescript
|
|
13162
|
+
* const posture = await client.compliance.getPosture({ workspace_id: "..." });
|
|
13163
|
+
* console.log(posture.open_breaches, posture.frameworks);
|
|
13164
|
+
* ```
|
|
13165
|
+
*/
|
|
13166
|
+
getPosture: async (params, options) => rb.rawGet(
|
|
13167
|
+
`/compliance/posture?workspace_id=${encodeURIComponent(params.workspace_id)}`,
|
|
13168
|
+
options
|
|
13169
|
+
),
|
|
13170
|
+
// ── New compliance sub-namespaces (Phase 5) ──────────────────────────
|
|
13171
|
+
/**
|
|
13172
|
+
* Risk Assessments — formal risk evaluation records.
|
|
13173
|
+
*
|
|
13174
|
+
* Track risk assessments for data processing activities, infrastructure,
|
|
13175
|
+
* and third-party integrations. Assessments can be created, reviewed via
|
|
13176
|
+
* status updates, and deleted when superseded.
|
|
13177
|
+
*/
|
|
13178
|
+
riskAssessments: {
|
|
13179
|
+
/**
|
|
13180
|
+
* List risk assessments with optional pagination.
|
|
13181
|
+
*
|
|
13182
|
+
* @param options - Optional page number, page size, and request options.
|
|
13183
|
+
* @returns A page of `RiskAssessment` records.
|
|
13184
|
+
*
|
|
13185
|
+
* @example
|
|
13186
|
+
* ```typescript
|
|
13187
|
+
* const assessments = await client.compliance.riskAssessments.list();
|
|
13188
|
+
* ```
|
|
13189
|
+
*/
|
|
13190
|
+
list: async (options) => {
|
|
13191
|
+
return rb.execute(
|
|
13192
|
+
getRiskAssessments,
|
|
13193
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
13194
|
+
options
|
|
13195
|
+
);
|
|
13196
|
+
},
|
|
13197
|
+
/**
|
|
13198
|
+
* Retrieve a single risk assessment by ID.
|
|
13199
|
+
*
|
|
13200
|
+
* @param id - The UUID of the risk assessment.
|
|
13201
|
+
* @param options - Optional request options.
|
|
13202
|
+
* @returns The matching `RiskAssessment`.
|
|
13203
|
+
*
|
|
13204
|
+
* @example
|
|
13205
|
+
* ```typescript
|
|
13206
|
+
* const assessment = await client.compliance.riskAssessments.get('ra-uuid');
|
|
13207
|
+
* ```
|
|
13208
|
+
*/
|
|
13209
|
+
get: async (id, options) => {
|
|
13210
|
+
return rb.execute(
|
|
13211
|
+
getRiskAssessmentsById,
|
|
13212
|
+
{ path: { id } },
|
|
13213
|
+
options
|
|
13214
|
+
);
|
|
13215
|
+
},
|
|
13216
|
+
/**
|
|
13217
|
+
* Create a new risk assessment.
|
|
13218
|
+
*
|
|
13219
|
+
* @param attributes - Risk assessment attributes.
|
|
13220
|
+
* @param options - Optional request options.
|
|
13221
|
+
* @returns The newly created `RiskAssessment`.
|
|
13222
|
+
*
|
|
13223
|
+
* @example
|
|
13224
|
+
* ```typescript
|
|
13225
|
+
* const assessment = await client.compliance.riskAssessments.create({
|
|
13226
|
+
* title: 'LLM Pipeline Risk Assessment',
|
|
13227
|
+
* risk_level: 'high',
|
|
13228
|
+
* });
|
|
13229
|
+
* ```
|
|
13230
|
+
*/
|
|
13231
|
+
create: async (attributes, options) => {
|
|
13232
|
+
return rb.execute(
|
|
13233
|
+
postRiskAssessments,
|
|
13234
|
+
{ body: { data: { type: "risk-assessment", attributes } } },
|
|
13235
|
+
options
|
|
13236
|
+
);
|
|
13237
|
+
},
|
|
13238
|
+
/**
|
|
13239
|
+
* Update the status of a risk assessment.
|
|
13240
|
+
*
|
|
13241
|
+
* @param id - The UUID of the risk assessment.
|
|
13242
|
+
* @param attributes - Attributes to update (e.g., `{ status: "mitigated" }`).
|
|
13243
|
+
* @param options - Optional request options.
|
|
13244
|
+
* @returns The updated `RiskAssessment`.
|
|
13245
|
+
*
|
|
13246
|
+
* @example
|
|
13247
|
+
* ```typescript
|
|
13248
|
+
* const assessment = await client.compliance.riskAssessments.updateStatus(
|
|
13249
|
+
* 'ra-uuid', { status: 'mitigated' },
|
|
13250
|
+
* );
|
|
13251
|
+
* ```
|
|
13252
|
+
*/
|
|
13253
|
+
updateStatus: async (id, attributes, options) => {
|
|
13254
|
+
return rb.execute(
|
|
13255
|
+
patchRiskAssessmentsByIdStatus,
|
|
13256
|
+
{
|
|
13257
|
+
path: { id },
|
|
13258
|
+
body: { data: { type: "risk-assessment", id, attributes } }
|
|
13259
|
+
},
|
|
13260
|
+
options
|
|
13261
|
+
);
|
|
13262
|
+
},
|
|
13263
|
+
/**
|
|
13264
|
+
* Delete a risk assessment.
|
|
13265
|
+
*
|
|
13266
|
+
* @param id - The UUID of the risk assessment to delete.
|
|
13267
|
+
* @param options - Optional request options.
|
|
13268
|
+
* @returns `true` on successful deletion.
|
|
13269
|
+
*
|
|
13270
|
+
* @example
|
|
13271
|
+
* ```typescript
|
|
13272
|
+
* await client.compliance.riskAssessments.delete('ra-uuid');
|
|
13273
|
+
* ```
|
|
13274
|
+
*/
|
|
13275
|
+
delete: async (id, options) => {
|
|
13276
|
+
return rb.executeDelete(
|
|
13277
|
+
deleteRiskAssessmentsById,
|
|
13278
|
+
{ path: { id } },
|
|
13279
|
+
options
|
|
13280
|
+
);
|
|
13281
|
+
}
|
|
13282
|
+
},
|
|
13283
|
+
/**
|
|
13284
|
+
* Data Transfer Records — cross-border and third-party data transfer tracking.
|
|
13285
|
+
*
|
|
13286
|
+
* GDPR Chapter V requires documentation of international data transfers.
|
|
13287
|
+
* Each record captures the transfer mechanism, recipient country, and
|
|
13288
|
+
* safeguards in place.
|
|
13289
|
+
*/
|
|
13290
|
+
dataTransferRecords: {
|
|
13291
|
+
/**
|
|
13292
|
+
* List data transfer records with optional pagination.
|
|
13293
|
+
*
|
|
13294
|
+
* @param options - Optional page number, page size, and request options.
|
|
13295
|
+
* @returns A page of `DataTransferRecord` records.
|
|
13296
|
+
*
|
|
13297
|
+
* @example
|
|
13298
|
+
* ```typescript
|
|
13299
|
+
* const transfers = await client.compliance.dataTransferRecords.list();
|
|
13300
|
+
* ```
|
|
13301
|
+
*/
|
|
13302
|
+
list: async (options) => {
|
|
13303
|
+
return rb.execute(
|
|
13304
|
+
getDataTransferRecords,
|
|
13305
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
13306
|
+
options
|
|
13307
|
+
);
|
|
13308
|
+
},
|
|
13309
|
+
/**
|
|
13310
|
+
* Retrieve a single data transfer record by ID.
|
|
13311
|
+
*
|
|
13312
|
+
* @param id - The UUID of the data transfer record.
|
|
13313
|
+
* @param options - Optional request options.
|
|
13314
|
+
* @returns The matching `DataTransferRecord`.
|
|
13315
|
+
*
|
|
13316
|
+
* @example
|
|
13317
|
+
* ```typescript
|
|
13318
|
+
* const transfer = await client.compliance.dataTransferRecords.get('dtr-uuid');
|
|
13319
|
+
* ```
|
|
13320
|
+
*/
|
|
13321
|
+
get: async (id, options) => {
|
|
13322
|
+
return rb.execute(
|
|
13323
|
+
getDataTransferRecordsById,
|
|
13324
|
+
{ path: { id } },
|
|
13325
|
+
options
|
|
13326
|
+
);
|
|
13327
|
+
},
|
|
13328
|
+
/**
|
|
13329
|
+
* Create a new data transfer record.
|
|
13330
|
+
*
|
|
13331
|
+
* @param attributes - Data transfer attributes (recipient, country, mechanism, etc.).
|
|
13332
|
+
* @param options - Optional request options.
|
|
13333
|
+
* @returns The newly created `DataTransferRecord`.
|
|
13334
|
+
*
|
|
13335
|
+
* @example
|
|
13336
|
+
* ```typescript
|
|
13337
|
+
* const transfer = await client.compliance.dataTransferRecords.create({
|
|
13338
|
+
* recipient: 'Cloud Provider EU',
|
|
13339
|
+
* destination_country: 'DE',
|
|
13340
|
+
* transfer_mechanism: 'standard_contractual_clauses',
|
|
13341
|
+
* });
|
|
13342
|
+
* ```
|
|
13343
|
+
*/
|
|
13344
|
+
create: async (attributes, options) => {
|
|
13345
|
+
return rb.execute(
|
|
13346
|
+
postDataTransferRecords,
|
|
13347
|
+
{ body: { data: { type: "data-transfer-record", attributes } } },
|
|
13348
|
+
options
|
|
13349
|
+
);
|
|
13350
|
+
},
|
|
13351
|
+
/**
|
|
13352
|
+
* Delete a data transfer record.
|
|
13353
|
+
*
|
|
13354
|
+
* @param id - The UUID of the data transfer record to delete.
|
|
13355
|
+
* @param options - Optional request options.
|
|
13356
|
+
* @returns `true` on successful deletion.
|
|
13357
|
+
*
|
|
13358
|
+
* @example
|
|
13359
|
+
* ```typescript
|
|
13360
|
+
* await client.compliance.dataTransferRecords.delete('dtr-uuid');
|
|
13361
|
+
* ```
|
|
13362
|
+
*/
|
|
13363
|
+
delete: async (id, options) => {
|
|
13364
|
+
return rb.executeDelete(
|
|
13365
|
+
deleteDataTransferRecordsById,
|
|
13366
|
+
{ path: { id } },
|
|
13367
|
+
options
|
|
13368
|
+
);
|
|
13369
|
+
}
|
|
13370
|
+
},
|
|
13371
|
+
/**
|
|
13372
|
+
* CDE Scope Reports — Cardholder Data Environment scope documentation.
|
|
13373
|
+
*
|
|
13374
|
+
* PCI DSS requires documenting the scope of systems that store, process,
|
|
13375
|
+
* or transmit cardholder data. Each report captures the CDE boundary
|
|
13376
|
+
* and connected systems.
|
|
13377
|
+
*/
|
|
13378
|
+
cdeScopeReports: {
|
|
13379
|
+
/**
|
|
13380
|
+
* List CDE scope reports with optional pagination.
|
|
13381
|
+
*
|
|
13382
|
+
* @param options - Optional page number, page size, and request options.
|
|
13383
|
+
* @returns A page of `CdeScopeReport` records.
|
|
13384
|
+
*
|
|
13385
|
+
* @example
|
|
13386
|
+
* ```typescript
|
|
13387
|
+
* const reports = await client.compliance.cdeScopeReports.list();
|
|
13388
|
+
* ```
|
|
13389
|
+
*/
|
|
13390
|
+
list: async (options) => {
|
|
13391
|
+
return rb.execute(
|
|
13392
|
+
getCdeScopeReports,
|
|
13393
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
13394
|
+
options
|
|
13395
|
+
);
|
|
13396
|
+
},
|
|
13397
|
+
/**
|
|
13398
|
+
* Retrieve a single CDE scope report by ID.
|
|
13399
|
+
*
|
|
13400
|
+
* @param id - The UUID of the CDE scope report.
|
|
13401
|
+
* @param options - Optional request options.
|
|
13402
|
+
* @returns The matching `CdeScopeReport`.
|
|
13403
|
+
*
|
|
13404
|
+
* @example
|
|
13405
|
+
* ```typescript
|
|
13406
|
+
* const report = await client.compliance.cdeScopeReports.get('csr-uuid');
|
|
13407
|
+
* ```
|
|
13408
|
+
*/
|
|
13409
|
+
get: async (id, options) => {
|
|
13410
|
+
return rb.execute(
|
|
13411
|
+
getCdeScopeReportsById,
|
|
13412
|
+
{ path: { id } },
|
|
13413
|
+
options
|
|
13414
|
+
);
|
|
13415
|
+
},
|
|
13416
|
+
/**
|
|
13417
|
+
* Create a new CDE scope report.
|
|
13418
|
+
*
|
|
13419
|
+
* @param attributes - CDE scope report attributes.
|
|
13420
|
+
* @param options - Optional request options.
|
|
13421
|
+
* @returns The newly created `CdeScopeReport`.
|
|
13422
|
+
*
|
|
13423
|
+
* @example
|
|
13424
|
+
* ```typescript
|
|
13425
|
+
* const report = await client.compliance.cdeScopeReports.create({
|
|
13426
|
+
* title: 'Q1 2026 CDE Scope',
|
|
13427
|
+
* systems_in_scope: ['payment-gateway', 'billing-db'],
|
|
13428
|
+
* });
|
|
13429
|
+
* ```
|
|
13430
|
+
*/
|
|
13431
|
+
create: async (attributes, options) => {
|
|
13432
|
+
return rb.execute(
|
|
13433
|
+
postCdeScopeReports,
|
|
13434
|
+
{ body: { data: { type: "cde-scope-report", attributes } } },
|
|
13435
|
+
options
|
|
13436
|
+
);
|
|
13437
|
+
},
|
|
13438
|
+
/**
|
|
13439
|
+
* Delete a CDE scope report.
|
|
13440
|
+
*
|
|
13441
|
+
* @param id - The UUID of the CDE scope report to delete.
|
|
13442
|
+
* @param options - Optional request options.
|
|
13443
|
+
* @returns `true` on successful deletion.
|
|
13444
|
+
*
|
|
13445
|
+
* @example
|
|
13446
|
+
* ```typescript
|
|
13447
|
+
* await client.compliance.cdeScopeReports.delete('csr-uuid');
|
|
13448
|
+
* ```
|
|
13449
|
+
*/
|
|
13450
|
+
delete: async (id, options) => {
|
|
13451
|
+
return rb.executeDelete(
|
|
13452
|
+
deleteCdeScopeReportsById,
|
|
13453
|
+
{ path: { id } },
|
|
13454
|
+
options
|
|
13455
|
+
);
|
|
13456
|
+
}
|
|
13457
|
+
},
|
|
13458
|
+
/**
|
|
13459
|
+
* Access Logs — read-only access audit trail.
|
|
13460
|
+
*
|
|
13461
|
+
* Records of who accessed what data and when. Generated automatically
|
|
13462
|
+
* by the platform. Access logs are immutable and cannot be created,
|
|
13463
|
+
* modified, or deleted via the API.
|
|
13464
|
+
*/
|
|
13465
|
+
accessLogs: {
|
|
13466
|
+
/**
|
|
13467
|
+
* List access logs with optional pagination.
|
|
13468
|
+
*
|
|
13469
|
+
* @param options - Optional page number, page size, and request options.
|
|
13470
|
+
* @returns A page of `AccessLog` records.
|
|
13471
|
+
*
|
|
13472
|
+
* @example
|
|
13473
|
+
* ```typescript
|
|
13474
|
+
* const logs = await client.compliance.accessLogs.list({ pageSize: 100 });
|
|
13475
|
+
* ```
|
|
13476
|
+
*/
|
|
13477
|
+
list: async (options) => {
|
|
13478
|
+
return rb.execute(
|
|
13479
|
+
getAccessLogs,
|
|
13480
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
13481
|
+
options
|
|
13482
|
+
);
|
|
13483
|
+
},
|
|
13484
|
+
/**
|
|
13485
|
+
* Retrieve a single access log entry by ID.
|
|
13486
|
+
*
|
|
13487
|
+
* @param id - The UUID of the access log entry.
|
|
13488
|
+
* @param options - Optional request options.
|
|
13489
|
+
* @returns The matching `AccessLog`.
|
|
13490
|
+
*
|
|
13491
|
+
* @example
|
|
13492
|
+
* ```typescript
|
|
13493
|
+
* const log = await client.compliance.accessLogs.get('al-uuid');
|
|
13494
|
+
* ```
|
|
13495
|
+
*/
|
|
13496
|
+
get: async (id, options) => {
|
|
13497
|
+
return rb.execute(
|
|
13498
|
+
getAccessLogsById,
|
|
13499
|
+
{ path: { id } },
|
|
13500
|
+
options
|
|
13501
|
+
);
|
|
13502
|
+
}
|
|
13503
|
+
},
|
|
13504
|
+
/**
|
|
13505
|
+
* Disclosure Logs — records of data disclosures to third parties.
|
|
13506
|
+
*
|
|
13507
|
+
* HIPAA and state privacy laws require tracking disclosures of protected
|
|
13508
|
+
* information. Each log entry records what was disclosed, to whom, and
|
|
13509
|
+
* the legal basis for the disclosure.
|
|
13510
|
+
*/
|
|
13511
|
+
disclosureLogs: {
|
|
13512
|
+
/**
|
|
13513
|
+
* List disclosure logs with optional pagination.
|
|
13514
|
+
*
|
|
13515
|
+
* @param options - Optional page number, page size, and request options.
|
|
13516
|
+
* @returns A page of `DisclosureLog` records.
|
|
13517
|
+
*
|
|
13518
|
+
* @example
|
|
13519
|
+
* ```typescript
|
|
13520
|
+
* const logs = await client.compliance.disclosureLogs.list();
|
|
13521
|
+
* ```
|
|
13522
|
+
*/
|
|
13523
|
+
list: async (options) => {
|
|
13524
|
+
return rb.execute(
|
|
13525
|
+
getDisclosureLogs,
|
|
13526
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
13527
|
+
options
|
|
13528
|
+
);
|
|
13529
|
+
},
|
|
13530
|
+
/**
|
|
13531
|
+
* Retrieve a single disclosure log by ID.
|
|
13532
|
+
*
|
|
13533
|
+
* @param id - The UUID of the disclosure log.
|
|
13534
|
+
* @param options - Optional request options.
|
|
13535
|
+
* @returns The matching `DisclosureLog`.
|
|
13536
|
+
*
|
|
13537
|
+
* @example
|
|
13538
|
+
* ```typescript
|
|
13539
|
+
* const log = await client.compliance.disclosureLogs.get('dl-uuid');
|
|
13540
|
+
* ```
|
|
13541
|
+
*/
|
|
13542
|
+
get: async (id, options) => {
|
|
13543
|
+
return rb.execute(
|
|
13544
|
+
getDisclosureLogsById,
|
|
13545
|
+
{ path: { id } },
|
|
13546
|
+
options
|
|
13547
|
+
);
|
|
13548
|
+
},
|
|
13549
|
+
/**
|
|
13550
|
+
* Create a new disclosure log entry.
|
|
13551
|
+
*
|
|
13552
|
+
* @param attributes - Disclosure details (recipient, purpose, data categories, etc.).
|
|
13553
|
+
* @param options - Optional request options.
|
|
13554
|
+
* @returns The newly created `DisclosureLog`.
|
|
13555
|
+
*
|
|
13556
|
+
* @example
|
|
13557
|
+
* ```typescript
|
|
13558
|
+
* const log = await client.compliance.disclosureLogs.create({
|
|
13559
|
+
* recipient: 'Insurance Provider',
|
|
13560
|
+
* purpose: 'claims_processing',
|
|
13561
|
+
* data_categories: ['health_data'],
|
|
13562
|
+
* });
|
|
13563
|
+
* ```
|
|
13564
|
+
*/
|
|
13565
|
+
create: async (attributes, options) => {
|
|
13566
|
+
return rb.execute(
|
|
13567
|
+
postDisclosureLogs,
|
|
13568
|
+
{ body: { data: { type: "disclosure-log", attributes } } },
|
|
13569
|
+
options
|
|
13570
|
+
);
|
|
13571
|
+
},
|
|
13572
|
+
/**
|
|
13573
|
+
* List disclosure logs filtered by data subject.
|
|
13574
|
+
*
|
|
13575
|
+
* Returns all disclosures related to a specific data subject,
|
|
13576
|
+
* useful for fulfilling HIPAA accounting-of-disclosures requests.
|
|
13577
|
+
*
|
|
13578
|
+
* @param options - Filter by subject type/ID, plus optional pagination and request options.
|
|
13579
|
+
* @returns An array of `DisclosureLog` records for the subject.
|
|
13580
|
+
*
|
|
13581
|
+
* @example
|
|
13582
|
+
* ```typescript
|
|
13583
|
+
* const logs = await client.compliance.disclosureLogs.listBySubject({
|
|
13584
|
+
* filter: { subject_type: { eq: 'patient' }, subject_id: { eq: 'subj-123' } },
|
|
13585
|
+
* });
|
|
13586
|
+
* ```
|
|
13587
|
+
*/
|
|
13588
|
+
listBySubject: async (options) => {
|
|
13589
|
+
return rb.execute(
|
|
13590
|
+
getDisclosureLogsBySubject,
|
|
13591
|
+
{
|
|
13592
|
+
...buildPageQuery(options?.page, options?.pageSize),
|
|
13593
|
+
query: { filter: options?.filter }
|
|
13594
|
+
},
|
|
13595
|
+
options
|
|
13596
|
+
);
|
|
13597
|
+
}
|
|
13598
|
+
},
|
|
13599
|
+
/**
|
|
13600
|
+
* Amendment Requests — requests to correct or amend records.
|
|
13601
|
+
*
|
|
13602
|
+
* HIPAA gives patients the right to request amendments to their health
|
|
13603
|
+
* records. Each request goes through a review workflow: create, review,
|
|
13604
|
+
* approve/deny, and apply.
|
|
13605
|
+
*/
|
|
13606
|
+
amendmentRequests: {
|
|
13607
|
+
/**
|
|
13608
|
+
* List amendment requests with optional pagination.
|
|
13609
|
+
*
|
|
13610
|
+
* @param options - Optional page number, page size, and request options.
|
|
13611
|
+
* @returns A page of `AmendmentRequest` records.
|
|
13612
|
+
*
|
|
13613
|
+
* @example
|
|
13614
|
+
* ```typescript
|
|
13615
|
+
* const requests = await client.compliance.amendmentRequests.list();
|
|
13616
|
+
* ```
|
|
13617
|
+
*/
|
|
13618
|
+
list: async (options) => {
|
|
13619
|
+
return rb.execute(
|
|
13620
|
+
getAmendmentRequests,
|
|
13621
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
13622
|
+
options
|
|
13623
|
+
);
|
|
13624
|
+
},
|
|
13625
|
+
/**
|
|
13626
|
+
* Retrieve a single amendment request by ID.
|
|
13627
|
+
*
|
|
13628
|
+
* @param id - The UUID of the amendment request.
|
|
13629
|
+
* @param options - Optional request options.
|
|
13630
|
+
* @returns The matching `AmendmentRequest`.
|
|
13631
|
+
*
|
|
13632
|
+
* @example
|
|
13633
|
+
* ```typescript
|
|
13634
|
+
* const request = await client.compliance.amendmentRequests.get('ar-uuid');
|
|
13635
|
+
* ```
|
|
13636
|
+
*/
|
|
13637
|
+
get: async (id, options) => {
|
|
13638
|
+
return rb.execute(
|
|
13639
|
+
getAmendmentRequestsById,
|
|
13640
|
+
{ path: { id } },
|
|
13641
|
+
options
|
|
13642
|
+
);
|
|
13643
|
+
},
|
|
13644
|
+
/**
|
|
13645
|
+
* Create a new amendment request.
|
|
13646
|
+
*
|
|
13647
|
+
* @param attributes - Amendment request details (record reference, requested changes, reason).
|
|
13648
|
+
* @param options - Optional request options.
|
|
13649
|
+
* @returns The newly created `AmendmentRequest`.
|
|
13650
|
+
*
|
|
13651
|
+
* @example
|
|
13652
|
+
* ```typescript
|
|
13653
|
+
* const request = await client.compliance.amendmentRequests.create({
|
|
13654
|
+
* record_id: 'patient-record-uuid',
|
|
13655
|
+
* requested_change: 'Correct diagnosis code from E11.9 to E10.9',
|
|
13656
|
+
* reason: 'Misclassification during initial intake.',
|
|
13657
|
+
* });
|
|
13658
|
+
* ```
|
|
13659
|
+
*/
|
|
13660
|
+
create: async (attributes, options) => {
|
|
13661
|
+
return rb.execute(
|
|
13662
|
+
postAmendmentRequests,
|
|
13663
|
+
{ body: { data: { type: "amendment-request", attributes } } },
|
|
13664
|
+
options
|
|
13665
|
+
);
|
|
13666
|
+
},
|
|
13667
|
+
/**
|
|
13668
|
+
* Mark an amendment request as under review.
|
|
13669
|
+
*
|
|
13670
|
+
* @param id - The UUID of the amendment request.
|
|
13671
|
+
* @param attributes - Optional review attributes.
|
|
13672
|
+
* @param options - Optional request options.
|
|
13673
|
+
* @returns The updated `AmendmentRequest`.
|
|
13674
|
+
*
|
|
13675
|
+
* @example
|
|
13676
|
+
* ```typescript
|
|
13677
|
+
* const request = await client.compliance.amendmentRequests.review('ar-uuid');
|
|
13678
|
+
* ```
|
|
13679
|
+
*/
|
|
13680
|
+
review: async (id, attributes, options) => {
|
|
13681
|
+
return rb.execute(
|
|
13682
|
+
patchAmendmentRequestsByIdReview,
|
|
13683
|
+
{
|
|
13684
|
+
path: { id },
|
|
13685
|
+
body: {
|
|
13686
|
+
data: {
|
|
13687
|
+
type: "amendment-request",
|
|
13688
|
+
id,
|
|
13689
|
+
attributes: attributes ?? {}
|
|
13690
|
+
}
|
|
13691
|
+
}
|
|
13692
|
+
},
|
|
13693
|
+
options
|
|
13694
|
+
);
|
|
13695
|
+
},
|
|
13696
|
+
/**
|
|
13697
|
+
* Approve an amendment request.
|
|
13698
|
+
*
|
|
13699
|
+
* @param id - The UUID of the amendment request.
|
|
13700
|
+
* @param attributes - Optional approval attributes.
|
|
13701
|
+
* @param options - Optional request options.
|
|
13702
|
+
* @returns The updated `AmendmentRequest` with approved status.
|
|
13703
|
+
*
|
|
13704
|
+
* @example
|
|
13705
|
+
* ```typescript
|
|
13706
|
+
* const request = await client.compliance.amendmentRequests.approve('ar-uuid');
|
|
13707
|
+
* ```
|
|
13708
|
+
*/
|
|
13709
|
+
approve: async (id, attributes, options) => {
|
|
13710
|
+
return rb.execute(
|
|
13711
|
+
patchAmendmentRequestsByIdApprove,
|
|
13712
|
+
{
|
|
13713
|
+
path: { id },
|
|
13714
|
+
body: {
|
|
13715
|
+
data: {
|
|
13716
|
+
type: "amendment-request",
|
|
13717
|
+
id,
|
|
13718
|
+
attributes: attributes ?? {}
|
|
13719
|
+
}
|
|
13720
|
+
}
|
|
13721
|
+
},
|
|
13722
|
+
options
|
|
13723
|
+
);
|
|
13724
|
+
},
|
|
13725
|
+
/**
|
|
13726
|
+
* Deny an amendment request.
|
|
13727
|
+
*
|
|
13728
|
+
* @param id - The UUID of the amendment request.
|
|
13729
|
+
* @param attributes - Optional denial reason attributes.
|
|
13730
|
+
* @param options - Optional request options.
|
|
13731
|
+
* @returns The updated `AmendmentRequest` with denied status.
|
|
13732
|
+
*
|
|
13733
|
+
* @example
|
|
13734
|
+
* ```typescript
|
|
13735
|
+
* const request = await client.compliance.amendmentRequests.deny('ar-uuid', {
|
|
13736
|
+
* denial_reason: 'Record is accurate as documented.',
|
|
13737
|
+
* });
|
|
13738
|
+
* ```
|
|
13739
|
+
*/
|
|
13740
|
+
deny: async (id, attributes, options) => {
|
|
13741
|
+
return rb.execute(
|
|
13742
|
+
patchAmendmentRequestsByIdDeny,
|
|
13743
|
+
{
|
|
13744
|
+
path: { id },
|
|
13745
|
+
body: {
|
|
13746
|
+
data: {
|
|
13747
|
+
type: "amendment-request",
|
|
13748
|
+
id,
|
|
13749
|
+
attributes: attributes ?? {}
|
|
13750
|
+
}
|
|
13751
|
+
}
|
|
13752
|
+
},
|
|
13753
|
+
options
|
|
13754
|
+
);
|
|
13755
|
+
},
|
|
13756
|
+
/**
|
|
13757
|
+
* Apply an approved amendment to the target record.
|
|
13758
|
+
*
|
|
13759
|
+
* @param id - The UUID of the amendment request.
|
|
13760
|
+
* @param attributes - Optional application attributes.
|
|
13761
|
+
* @param options - Optional request options.
|
|
13762
|
+
* @returns The updated `AmendmentRequest` with applied status.
|
|
13763
|
+
*
|
|
13764
|
+
* @example
|
|
13765
|
+
* ```typescript
|
|
13766
|
+
* const request = await client.compliance.amendmentRequests.apply('ar-uuid');
|
|
13767
|
+
* ```
|
|
13768
|
+
*/
|
|
13769
|
+
apply: async (id, attributes, options) => {
|
|
13770
|
+
return rb.execute(
|
|
13771
|
+
patchAmendmentRequestsByIdApply,
|
|
13772
|
+
{
|
|
13773
|
+
path: { id },
|
|
13774
|
+
body: {
|
|
13775
|
+
data: {
|
|
13776
|
+
type: "amendment-request",
|
|
13777
|
+
id,
|
|
13778
|
+
attributes: attributes ?? {}
|
|
13779
|
+
}
|
|
13780
|
+
}
|
|
13781
|
+
},
|
|
13782
|
+
options
|
|
13783
|
+
);
|
|
13784
|
+
}
|
|
13785
|
+
},
|
|
13786
|
+
/**
|
|
13787
|
+
* Compliance Document Templates — reusable templates for compliance documentation.
|
|
13788
|
+
*
|
|
13789
|
+
* Templates provide standardized starting points for policies, procedures,
|
|
13790
|
+
* and forms required by regulatory frameworks. Templates can be cloned
|
|
13791
|
+
* to create workspace-specific documents.
|
|
13792
|
+
*/
|
|
13793
|
+
complianceDocumentTemplates: {
|
|
13794
|
+
/**
|
|
13795
|
+
* List compliance document templates with optional pagination.
|
|
13796
|
+
*
|
|
13797
|
+
* @param options - Optional page number, page size, and request options.
|
|
13798
|
+
* @returns A page of `ComplianceDocumentTemplate` records.
|
|
13799
|
+
*
|
|
13800
|
+
* @example
|
|
13801
|
+
* ```typescript
|
|
13802
|
+
* const templates = await client.compliance.complianceDocumentTemplates.list();
|
|
13803
|
+
* ```
|
|
13804
|
+
*/
|
|
13805
|
+
list: async (options) => {
|
|
13806
|
+
return rb.execute(
|
|
13807
|
+
getComplianceDocumentTemplates,
|
|
13808
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
13809
|
+
options
|
|
13810
|
+
);
|
|
13811
|
+
},
|
|
13812
|
+
/**
|
|
13813
|
+
* Retrieve a single compliance document template by ID.
|
|
13814
|
+
*
|
|
13815
|
+
* @param id - The UUID of the template.
|
|
13816
|
+
* @param options - Optional request options.
|
|
13817
|
+
* @returns The matching `ComplianceDocumentTemplate`.
|
|
13818
|
+
*
|
|
13819
|
+
* @example
|
|
13820
|
+
* ```typescript
|
|
13821
|
+
* const template = await client.compliance.complianceDocumentTemplates.get('tpl-uuid');
|
|
13822
|
+
* ```
|
|
13823
|
+
*/
|
|
13824
|
+
get: async (id, options) => {
|
|
13825
|
+
return rb.execute(
|
|
13826
|
+
getComplianceDocumentTemplatesById,
|
|
13827
|
+
{ path: { id } },
|
|
13828
|
+
options
|
|
13829
|
+
);
|
|
13830
|
+
},
|
|
13831
|
+
/**
|
|
13832
|
+
* Create a new compliance document template.
|
|
13833
|
+
*
|
|
13834
|
+
* @param attributes - Template attributes (title, content, framework, etc.).
|
|
13835
|
+
* @param options - Optional request options.
|
|
13836
|
+
* @returns The newly created `ComplianceDocumentTemplate`.
|
|
13837
|
+
*
|
|
13838
|
+
* @example
|
|
13839
|
+
* ```typescript
|
|
13840
|
+
* const template = await client.compliance.complianceDocumentTemplates.create({
|
|
13841
|
+
* title: 'HIPAA Privacy Policy Template',
|
|
13842
|
+
* framework: 'hipaa',
|
|
13843
|
+
* content: '# Privacy Policy\n...',
|
|
13844
|
+
* });
|
|
13845
|
+
* ```
|
|
13846
|
+
*/
|
|
13847
|
+
create: async (attributes, options) => {
|
|
13848
|
+
return rb.execute(
|
|
13849
|
+
postComplianceDocumentTemplates,
|
|
13850
|
+
{
|
|
13851
|
+
body: {
|
|
13852
|
+
data: { type: "compliance-document-template", attributes }
|
|
13853
|
+
}
|
|
13854
|
+
},
|
|
13855
|
+
options
|
|
13856
|
+
);
|
|
13857
|
+
},
|
|
13858
|
+
/**
|
|
13859
|
+
* Update a compliance document template.
|
|
13860
|
+
*
|
|
13861
|
+
* @param id - The UUID of the template to update.
|
|
13862
|
+
* @param attributes - Attribute map of fields to change.
|
|
13863
|
+
* @param options - Optional request options.
|
|
13864
|
+
* @returns The updated `ComplianceDocumentTemplate`.
|
|
13865
|
+
*
|
|
13866
|
+
* @example
|
|
13867
|
+
* ```typescript
|
|
13868
|
+
* const template = await client.compliance.complianceDocumentTemplates.update(
|
|
13869
|
+
* 'tpl-uuid', { content: '# Updated Policy\n...' },
|
|
13870
|
+
* );
|
|
13871
|
+
* ```
|
|
13872
|
+
*/
|
|
13873
|
+
update: async (id, attributes, options) => {
|
|
13874
|
+
return rb.execute(
|
|
13875
|
+
patchComplianceDocumentTemplatesById,
|
|
13876
|
+
{
|
|
13877
|
+
path: { id },
|
|
13878
|
+
body: {
|
|
13879
|
+
data: {
|
|
13880
|
+
type: "compliance-document-template",
|
|
13881
|
+
id,
|
|
13882
|
+
attributes
|
|
13883
|
+
}
|
|
13884
|
+
}
|
|
13885
|
+
},
|
|
13886
|
+
options
|
|
13887
|
+
);
|
|
13888
|
+
},
|
|
13889
|
+
/**
|
|
13890
|
+
* Clone a compliance document template into a new document.
|
|
13891
|
+
*
|
|
13892
|
+
* Creates a copy of the template that can be customized independently.
|
|
13893
|
+
*
|
|
13894
|
+
* @param attributes - Clone attributes (e.g., target workspace or overrides).
|
|
13895
|
+
* @param options - Optional request options.
|
|
13896
|
+
* @returns The cloned `ComplianceDocumentTemplate`.
|
|
13897
|
+
*
|
|
13898
|
+
* @example
|
|
13899
|
+
* ```typescript
|
|
13900
|
+
* const cloned = await client.compliance.complianceDocumentTemplates.clone({
|
|
13901
|
+
* source_template_id: 'tpl-uuid',
|
|
13902
|
+
* title: 'Our HIPAA Privacy Policy',
|
|
13903
|
+
* });
|
|
13904
|
+
* ```
|
|
13905
|
+
*/
|
|
13906
|
+
clone: async (attributes, options) => {
|
|
13907
|
+
return rb.execute(
|
|
13908
|
+
postComplianceDocumentTemplatesClone,
|
|
13909
|
+
{
|
|
13910
|
+
body: {
|
|
13911
|
+
data: { type: "compliance-document-template", attributes }
|
|
13912
|
+
}
|
|
13913
|
+
},
|
|
13914
|
+
options
|
|
13915
|
+
);
|
|
13916
|
+
}
|
|
13917
|
+
},
|
|
13918
|
+
/**
|
|
13919
|
+
* Business Associate Agreements — HIPAA BAA lifecycle management.
|
|
13920
|
+
*
|
|
13921
|
+
* HIPAA requires covered entities to execute BAAs with business associates
|
|
13922
|
+
* who handle PHI. Track agreements through creation, signing, and
|
|
13923
|
+
* termination.
|
|
13924
|
+
*/
|
|
13925
|
+
businessAssociateAgreements: {
|
|
13926
|
+
/**
|
|
13927
|
+
* List business associate agreements with optional pagination.
|
|
13928
|
+
*
|
|
13929
|
+
* @param options - Optional page number, page size, and request options.
|
|
13930
|
+
* @returns A page of `BusinessAssociateAgreement` records.
|
|
13931
|
+
*
|
|
13932
|
+
* @example
|
|
13933
|
+
* ```typescript
|
|
13934
|
+
* const baas = await client.compliance.businessAssociateAgreements.list();
|
|
13935
|
+
* ```
|
|
13936
|
+
*/
|
|
13937
|
+
list: async (options) => {
|
|
13938
|
+
return rb.execute(
|
|
13939
|
+
getBusinessAssociateAgreements,
|
|
13940
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
13941
|
+
options
|
|
13942
|
+
);
|
|
13943
|
+
},
|
|
13944
|
+
/**
|
|
13945
|
+
* Retrieve a single BAA by ID.
|
|
13946
|
+
*
|
|
13947
|
+
* @param id - The UUID of the BAA.
|
|
13948
|
+
* @param options - Optional request options.
|
|
13949
|
+
* @returns The matching `BusinessAssociateAgreement`.
|
|
13950
|
+
*
|
|
13951
|
+
* @example
|
|
13952
|
+
* ```typescript
|
|
13953
|
+
* const baa = await client.compliance.businessAssociateAgreements.get('baa-uuid');
|
|
13954
|
+
* ```
|
|
13955
|
+
*/
|
|
13956
|
+
get: async (id, options) => {
|
|
13957
|
+
return rb.execute(
|
|
13958
|
+
getBusinessAssociateAgreementsById,
|
|
13959
|
+
{ path: { id } },
|
|
13960
|
+
options
|
|
13961
|
+
);
|
|
13962
|
+
},
|
|
13963
|
+
/**
|
|
13964
|
+
* Create a new business associate agreement.
|
|
13965
|
+
*
|
|
13966
|
+
* @param attributes - BAA attributes (associate name, terms, effective date, etc.).
|
|
13967
|
+
* @param options - Optional request options.
|
|
13968
|
+
* @returns The newly created `BusinessAssociateAgreement`.
|
|
13969
|
+
*
|
|
13970
|
+
* @example
|
|
13971
|
+
* ```typescript
|
|
13972
|
+
* const baa = await client.compliance.businessAssociateAgreements.create({
|
|
13973
|
+
* associate_name: 'Cloud Storage Inc.',
|
|
13974
|
+
* effective_date: '2026-01-01',
|
|
13975
|
+
* });
|
|
13976
|
+
* ```
|
|
13977
|
+
*/
|
|
13978
|
+
create: async (attributes, options) => {
|
|
13979
|
+
return rb.execute(
|
|
13980
|
+
postBusinessAssociateAgreements,
|
|
13981
|
+
{
|
|
13982
|
+
body: {
|
|
13983
|
+
data: { type: "business-associate-agreement", attributes }
|
|
13984
|
+
}
|
|
13985
|
+
},
|
|
13986
|
+
options
|
|
13987
|
+
);
|
|
13988
|
+
},
|
|
13989
|
+
/**
|
|
13990
|
+
* Update a business associate agreement.
|
|
13991
|
+
*
|
|
13992
|
+
* @param id - The UUID of the BAA to update.
|
|
13993
|
+
* @param attributes - Attribute map of fields to change.
|
|
13994
|
+
* @param options - Optional request options.
|
|
13995
|
+
* @returns The updated `BusinessAssociateAgreement`.
|
|
13996
|
+
*
|
|
13997
|
+
* @example
|
|
13998
|
+
* ```typescript
|
|
13999
|
+
* const baa = await client.compliance.businessAssociateAgreements.update(
|
|
14000
|
+
* 'baa-uuid', { terms: 'Updated terms...' },
|
|
14001
|
+
* );
|
|
14002
|
+
* ```
|
|
14003
|
+
*/
|
|
14004
|
+
update: async (id, attributes, options) => {
|
|
14005
|
+
return rb.execute(
|
|
14006
|
+
patchBusinessAssociateAgreementsById,
|
|
14007
|
+
{
|
|
14008
|
+
path: { id },
|
|
14009
|
+
body: {
|
|
14010
|
+
data: {
|
|
14011
|
+
type: "business-associate-agreement",
|
|
14012
|
+
id,
|
|
14013
|
+
attributes
|
|
14014
|
+
}
|
|
14015
|
+
}
|
|
14016
|
+
},
|
|
14017
|
+
options
|
|
14018
|
+
);
|
|
14019
|
+
},
|
|
14020
|
+
/**
|
|
14021
|
+
* Sign a business associate agreement.
|
|
14022
|
+
*
|
|
14023
|
+
* Records the signing event with timestamp and signer identity.
|
|
14024
|
+
*
|
|
14025
|
+
* @param id - The UUID of the BAA to sign.
|
|
14026
|
+
* @param attributes - Optional signing attributes.
|
|
14027
|
+
* @param options - Optional request options.
|
|
14028
|
+
* @returns The updated `BusinessAssociateAgreement` with signed status.
|
|
14029
|
+
*
|
|
14030
|
+
* @example
|
|
14031
|
+
* ```typescript
|
|
14032
|
+
* const baa = await client.compliance.businessAssociateAgreements.sign('baa-uuid');
|
|
14033
|
+
* ```
|
|
14034
|
+
*/
|
|
14035
|
+
sign: async (id, attributes, options) => {
|
|
14036
|
+
return rb.execute(
|
|
14037
|
+
patchBusinessAssociateAgreementsByIdSign,
|
|
14038
|
+
{
|
|
14039
|
+
path: { id },
|
|
14040
|
+
body: {
|
|
14041
|
+
data: {
|
|
14042
|
+
type: "business-associate-agreement",
|
|
14043
|
+
id,
|
|
14044
|
+
attributes: attributes ?? {}
|
|
14045
|
+
}
|
|
14046
|
+
}
|
|
14047
|
+
},
|
|
14048
|
+
options
|
|
14049
|
+
);
|
|
14050
|
+
},
|
|
14051
|
+
/**
|
|
14052
|
+
* Terminate a business associate agreement.
|
|
14053
|
+
*
|
|
14054
|
+
* Ends the BAA relationship. Records termination date and reason.
|
|
14055
|
+
*
|
|
14056
|
+
* @param id - The UUID of the BAA to terminate.
|
|
14057
|
+
* @param attributes - Optional termination attributes (reason, effective date).
|
|
14058
|
+
* @param options - Optional request options.
|
|
14059
|
+
* @returns The updated `BusinessAssociateAgreement` with terminated status.
|
|
14060
|
+
*
|
|
14061
|
+
* @example
|
|
14062
|
+
* ```typescript
|
|
14063
|
+
* const baa = await client.compliance.businessAssociateAgreements.terminate(
|
|
14064
|
+
* 'baa-uuid', { reason: 'Contract not renewed.' },
|
|
14065
|
+
* );
|
|
14066
|
+
* ```
|
|
14067
|
+
*/
|
|
14068
|
+
terminate: async (id, attributes, options) => {
|
|
14069
|
+
return rb.execute(
|
|
14070
|
+
patchBusinessAssociateAgreementsByIdTerminate,
|
|
14071
|
+
{
|
|
14072
|
+
path: { id },
|
|
14073
|
+
body: {
|
|
14074
|
+
data: {
|
|
14075
|
+
type: "business-associate-agreement",
|
|
14076
|
+
id,
|
|
14077
|
+
attributes: attributes ?? {}
|
|
14078
|
+
}
|
|
14079
|
+
}
|
|
14080
|
+
},
|
|
14081
|
+
options
|
|
14082
|
+
);
|
|
14083
|
+
}
|
|
14084
|
+
},
|
|
14085
|
+
/**
|
|
14086
|
+
* Policy Review Schedules — track periodic policy review cycles.
|
|
14087
|
+
*
|
|
14088
|
+
* Regulatory frameworks require periodic review of compliance policies.
|
|
14089
|
+
* Schedules track when reviews are due, overdue, or completed.
|
|
14090
|
+
*/
|
|
14091
|
+
policyReviewSchedules: {
|
|
14092
|
+
/**
|
|
14093
|
+
* List policy review schedules with optional pagination.
|
|
14094
|
+
*
|
|
14095
|
+
* @param options - Optional page number, page size, and request options.
|
|
14096
|
+
* @returns A page of `PolicyReviewSchedule` records.
|
|
14097
|
+
*
|
|
14098
|
+
* @example
|
|
14099
|
+
* ```typescript
|
|
14100
|
+
* const schedules = await client.compliance.policyReviewSchedules.list();
|
|
14101
|
+
* ```
|
|
14102
|
+
*/
|
|
14103
|
+
list: async (options) => {
|
|
14104
|
+
return rb.execute(
|
|
14105
|
+
getPolicyReviewSchedules,
|
|
14106
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
14107
|
+
options
|
|
14108
|
+
);
|
|
14109
|
+
},
|
|
14110
|
+
/**
|
|
14111
|
+
* Retrieve a single policy review schedule by ID.
|
|
14112
|
+
*
|
|
14113
|
+
* @param id - The UUID of the policy review schedule.
|
|
14114
|
+
* @param options - Optional request options.
|
|
14115
|
+
* @returns The matching `PolicyReviewSchedule`.
|
|
14116
|
+
*
|
|
14117
|
+
* @example
|
|
14118
|
+
* ```typescript
|
|
14119
|
+
* const schedule = await client.compliance.policyReviewSchedules.get('prs-uuid');
|
|
14120
|
+
* ```
|
|
14121
|
+
*/
|
|
14122
|
+
get: async (id, options) => {
|
|
14123
|
+
return rb.execute(
|
|
14124
|
+
getPolicyReviewSchedulesById,
|
|
14125
|
+
{ path: { id } },
|
|
14126
|
+
options
|
|
14127
|
+
);
|
|
14128
|
+
},
|
|
14129
|
+
/**
|
|
14130
|
+
* Create a new policy review schedule.
|
|
14131
|
+
*
|
|
14132
|
+
* @param attributes - Schedule attributes (policy reference, frequency, next review date).
|
|
14133
|
+
* @param options - Optional request options.
|
|
14134
|
+
* @returns The newly created `PolicyReviewSchedule`.
|
|
14135
|
+
*
|
|
14136
|
+
* @example
|
|
14137
|
+
* ```typescript
|
|
14138
|
+
* const schedule = await client.compliance.policyReviewSchedules.create({
|
|
14139
|
+
* policy_name: 'Data Retention Policy',
|
|
14140
|
+
* review_frequency_days: 365,
|
|
14141
|
+
* next_review_date: '2027-01-01',
|
|
14142
|
+
* });
|
|
14143
|
+
* ```
|
|
14144
|
+
*/
|
|
14145
|
+
create: async (attributes, options) => {
|
|
14146
|
+
return rb.execute(
|
|
14147
|
+
postPolicyReviewSchedules,
|
|
14148
|
+
{
|
|
14149
|
+
body: {
|
|
14150
|
+
data: { type: "policy-review-schedule", attributes }
|
|
14151
|
+
}
|
|
14152
|
+
},
|
|
14153
|
+
options
|
|
14154
|
+
);
|
|
14155
|
+
},
|
|
14156
|
+
/**
|
|
14157
|
+
* Mark a policy review as completed.
|
|
14158
|
+
*
|
|
14159
|
+
* @param id - The UUID of the policy review schedule.
|
|
14160
|
+
* @param attributes - Optional completion attributes (reviewer, notes).
|
|
14161
|
+
* @param options - Optional request options.
|
|
14162
|
+
* @returns The updated `PolicyReviewSchedule`.
|
|
14163
|
+
*
|
|
14164
|
+
* @example
|
|
14165
|
+
* ```typescript
|
|
14166
|
+
* const schedule = await client.compliance.policyReviewSchedules.completeReview(
|
|
14167
|
+
* 'prs-uuid', { reviewer: 'compliance-officer-uuid' },
|
|
14168
|
+
* );
|
|
14169
|
+
* ```
|
|
14170
|
+
*/
|
|
14171
|
+
completeReview: async (id, attributes, options) => {
|
|
14172
|
+
return rb.execute(
|
|
14173
|
+
patchPolicyReviewSchedulesByIdCompleteReview,
|
|
14174
|
+
{
|
|
14175
|
+
path: { id },
|
|
14176
|
+
body: {
|
|
14177
|
+
data: {
|
|
14178
|
+
type: "policy-review-schedule",
|
|
14179
|
+
id,
|
|
14180
|
+
attributes: attributes ?? {}
|
|
14181
|
+
}
|
|
14182
|
+
}
|
|
14183
|
+
},
|
|
14184
|
+
options
|
|
14185
|
+
);
|
|
14186
|
+
},
|
|
14187
|
+
/**
|
|
14188
|
+
* Mark a policy review schedule as due.
|
|
14189
|
+
*
|
|
14190
|
+
* @param id - The UUID of the policy review schedule.
|
|
14191
|
+
* @param attributes - Optional attributes.
|
|
14192
|
+
* @param options - Optional request options.
|
|
14193
|
+
* @returns The updated `PolicyReviewSchedule`.
|
|
14194
|
+
*
|
|
14195
|
+
* @example
|
|
14196
|
+
* ```typescript
|
|
14197
|
+
* const schedule = await client.compliance.policyReviewSchedules.markDue('prs-uuid');
|
|
14198
|
+
* ```
|
|
14199
|
+
*/
|
|
14200
|
+
markDue: async (id, attributes, options) => {
|
|
14201
|
+
return rb.execute(
|
|
14202
|
+
patchPolicyReviewSchedulesByIdMarkDue,
|
|
14203
|
+
{
|
|
14204
|
+
path: { id },
|
|
14205
|
+
body: {
|
|
14206
|
+
data: {
|
|
14207
|
+
type: "policy-review-schedule",
|
|
14208
|
+
id,
|
|
14209
|
+
attributes: attributes ?? {}
|
|
14210
|
+
}
|
|
14211
|
+
}
|
|
14212
|
+
},
|
|
14213
|
+
options
|
|
14214
|
+
);
|
|
14215
|
+
},
|
|
14216
|
+
/**
|
|
14217
|
+
* Mark a policy review schedule as overdue.
|
|
14218
|
+
*
|
|
14219
|
+
* @param id - The UUID of the policy review schedule.
|
|
14220
|
+
* @param attributes - Optional attributes.
|
|
14221
|
+
* @param options - Optional request options.
|
|
14222
|
+
* @returns The updated `PolicyReviewSchedule`.
|
|
14223
|
+
*
|
|
14224
|
+
* @example
|
|
14225
|
+
* ```typescript
|
|
14226
|
+
* const schedule = await client.compliance.policyReviewSchedules.markOverdue('prs-uuid');
|
|
14227
|
+
* ```
|
|
14228
|
+
*/
|
|
14229
|
+
markOverdue: async (id, attributes, options) => {
|
|
14230
|
+
return rb.execute(
|
|
14231
|
+
patchPolicyReviewSchedulesByIdMarkOverdue,
|
|
14232
|
+
{
|
|
14233
|
+
path: { id },
|
|
14234
|
+
body: {
|
|
14235
|
+
data: {
|
|
14236
|
+
type: "policy-review-schedule",
|
|
14237
|
+
id,
|
|
14238
|
+
attributes: attributes ?? {}
|
|
14239
|
+
}
|
|
14240
|
+
}
|
|
14241
|
+
},
|
|
14242
|
+
options
|
|
14243
|
+
);
|
|
14244
|
+
}
|
|
14245
|
+
},
|
|
14246
|
+
/**
|
|
14247
|
+
* Compliance Requirements — regulatory requirements tracking.
|
|
14248
|
+
*
|
|
14249
|
+
* Track individual requirements from regulatory frameworks (HIPAA, GDPR,
|
|
14250
|
+
* PCI DSS, SOC 2). Each requirement can be created, updated with
|
|
14251
|
+
* implementation status, and deleted when no longer applicable.
|
|
14252
|
+
*/
|
|
14253
|
+
complianceRequirements: {
|
|
14254
|
+
/**
|
|
14255
|
+
* List compliance requirements with optional pagination.
|
|
14256
|
+
*
|
|
14257
|
+
* @param options - Optional page number, page size, and request options.
|
|
14258
|
+
* @returns A page of `ComplianceRequirement` records.
|
|
14259
|
+
*
|
|
14260
|
+
* @example
|
|
14261
|
+
* ```typescript
|
|
14262
|
+
* const requirements = await client.compliance.complianceRequirements.list();
|
|
14263
|
+
* ```
|
|
14264
|
+
*/
|
|
14265
|
+
list: async (options) => {
|
|
14266
|
+
return rb.execute(
|
|
14267
|
+
getComplianceRequirements,
|
|
14268
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
14269
|
+
options
|
|
14270
|
+
);
|
|
14271
|
+
},
|
|
14272
|
+
/**
|
|
14273
|
+
* Retrieve a single compliance requirement by ID.
|
|
14274
|
+
*
|
|
14275
|
+
* @param id - The UUID of the compliance requirement.
|
|
14276
|
+
* @param options - Optional request options.
|
|
14277
|
+
* @returns The matching `ComplianceRequirement`.
|
|
14278
|
+
*
|
|
14279
|
+
* @example
|
|
14280
|
+
* ```typescript
|
|
14281
|
+
* const req = await client.compliance.complianceRequirements.get('cr-uuid');
|
|
14282
|
+
* ```
|
|
14283
|
+
*/
|
|
14284
|
+
get: async (id, options) => {
|
|
14285
|
+
return rb.execute(
|
|
14286
|
+
getComplianceRequirementsById,
|
|
14287
|
+
{ path: { id } },
|
|
14288
|
+
options
|
|
14289
|
+
);
|
|
14290
|
+
},
|
|
14291
|
+
/**
|
|
14292
|
+
* Create a new compliance requirement.
|
|
14293
|
+
*
|
|
14294
|
+
* @param attributes - Requirement attributes (framework, control ID, description, etc.).
|
|
14295
|
+
* @param options - Optional request options.
|
|
14296
|
+
* @returns The newly created `ComplianceRequirement`.
|
|
14297
|
+
*
|
|
14298
|
+
* @example
|
|
14299
|
+
* ```typescript
|
|
14300
|
+
* const req = await client.compliance.complianceRequirements.create({
|
|
14301
|
+
* framework: 'hipaa',
|
|
14302
|
+
* control_id: '164.312(a)(1)',
|
|
14303
|
+
* description: 'Access Control — Unique User Identification',
|
|
14304
|
+
* });
|
|
14305
|
+
* ```
|
|
14306
|
+
*/
|
|
14307
|
+
create: async (attributes, options) => {
|
|
14308
|
+
return rb.execute(
|
|
14309
|
+
postComplianceRequirements,
|
|
14310
|
+
{
|
|
14311
|
+
body: {
|
|
14312
|
+
data: { type: "compliance-requirement", attributes }
|
|
14313
|
+
}
|
|
14314
|
+
},
|
|
14315
|
+
options
|
|
14316
|
+
);
|
|
14317
|
+
},
|
|
14318
|
+
/**
|
|
14319
|
+
* Update a compliance requirement.
|
|
14320
|
+
*
|
|
14321
|
+
* @param id - The UUID of the compliance requirement to update.
|
|
14322
|
+
* @param attributes - Attribute map of fields to change.
|
|
14323
|
+
* @param options - Optional request options.
|
|
14324
|
+
* @returns The updated `ComplianceRequirement`.
|
|
14325
|
+
*
|
|
14326
|
+
* @example
|
|
14327
|
+
* ```typescript
|
|
14328
|
+
* const req = await client.compliance.complianceRequirements.update(
|
|
14329
|
+
* 'cr-uuid', { status: 'implemented' },
|
|
14330
|
+
* );
|
|
14331
|
+
* ```
|
|
14332
|
+
*/
|
|
14333
|
+
update: async (id, attributes, options) => {
|
|
14334
|
+
return rb.execute(
|
|
14335
|
+
patchComplianceRequirementsById,
|
|
14336
|
+
{
|
|
14337
|
+
path: { id },
|
|
14338
|
+
body: {
|
|
14339
|
+
data: { type: "compliance-requirement", id, attributes }
|
|
14340
|
+
}
|
|
14341
|
+
},
|
|
14342
|
+
options
|
|
14343
|
+
);
|
|
14344
|
+
},
|
|
14345
|
+
/**
|
|
14346
|
+
* Delete a compliance requirement.
|
|
14347
|
+
*
|
|
14348
|
+
* @param id - The UUID of the compliance requirement to delete.
|
|
14349
|
+
* @param options - Optional request options.
|
|
14350
|
+
* @returns `true` on successful deletion.
|
|
14351
|
+
*
|
|
14352
|
+
* @example
|
|
14353
|
+
* ```typescript
|
|
14354
|
+
* await client.compliance.complianceRequirements.delete('cr-uuid');
|
|
14355
|
+
* ```
|
|
14356
|
+
*/
|
|
14357
|
+
delete: async (id, options) => {
|
|
14358
|
+
return rb.executeDelete(
|
|
14359
|
+
deleteComplianceRequirementsById,
|
|
14360
|
+
{ path: { id } },
|
|
14361
|
+
options
|
|
14362
|
+
);
|
|
14363
|
+
}
|
|
14364
|
+
},
|
|
14365
|
+
/**
|
|
14366
|
+
* Compliance Requirement Completions — evidence of requirement fulfillment.
|
|
14367
|
+
*
|
|
14368
|
+
* Each completion record links a compliance requirement to the evidence
|
|
14369
|
+
* or action that satisfies it. Read-only once created — completions
|
|
14370
|
+
* serve as an immutable audit trail.
|
|
14371
|
+
*/
|
|
14372
|
+
complianceRequirementCompletions: {
|
|
14373
|
+
/**
|
|
14374
|
+
* List compliance requirement completions with optional pagination.
|
|
14375
|
+
*
|
|
14376
|
+
* @param options - Optional page number, page size, and request options.
|
|
14377
|
+
* @returns A page of `ComplianceRequirementCompletion` records.
|
|
14378
|
+
*
|
|
14379
|
+
* @example
|
|
14380
|
+
* ```typescript
|
|
14381
|
+
* const completions = await client.compliance.complianceRequirementCompletions.list();
|
|
14382
|
+
* ```
|
|
14383
|
+
*/
|
|
14384
|
+
list: async (options) => {
|
|
14385
|
+
return rb.execute(
|
|
14386
|
+
getComplianceRequirementCompletions,
|
|
14387
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
14388
|
+
options
|
|
14389
|
+
);
|
|
14390
|
+
},
|
|
14391
|
+
/**
|
|
14392
|
+
* Retrieve a single compliance requirement completion by ID.
|
|
14393
|
+
*
|
|
14394
|
+
* @param id - The UUID of the completion record.
|
|
14395
|
+
* @param options - Optional request options.
|
|
14396
|
+
* @returns The matching `ComplianceRequirementCompletion`.
|
|
14397
|
+
*
|
|
14398
|
+
* @example
|
|
14399
|
+
* ```typescript
|
|
14400
|
+
* const completion = await client.compliance.complianceRequirementCompletions.get('crc-uuid');
|
|
14401
|
+
* ```
|
|
14402
|
+
*/
|
|
14403
|
+
get: async (id, options) => {
|
|
14404
|
+
return rb.execute(
|
|
14405
|
+
getComplianceRequirementCompletionsById,
|
|
14406
|
+
{ path: { id } },
|
|
14407
|
+
options
|
|
14408
|
+
);
|
|
14409
|
+
},
|
|
14410
|
+
/**
|
|
14411
|
+
* Create a new compliance requirement completion record.
|
|
14412
|
+
*
|
|
14413
|
+
* @param attributes - Completion attributes (requirement ID, evidence, completed by, etc.).
|
|
14414
|
+
* @param options - Optional request options.
|
|
14415
|
+
* @returns The newly created `ComplianceRequirementCompletion`.
|
|
14416
|
+
*
|
|
14417
|
+
* @example
|
|
14418
|
+
* ```typescript
|
|
14419
|
+
* const completion = await client.compliance.complianceRequirementCompletions.create({
|
|
14420
|
+
* compliance_requirement_id: 'cr-uuid',
|
|
14421
|
+
* evidence: 'Access controls verified via penetration test report.',
|
|
14422
|
+
* });
|
|
14423
|
+
* ```
|
|
14424
|
+
*/
|
|
14425
|
+
create: async (attributes, options) => {
|
|
14426
|
+
return rb.execute(
|
|
14427
|
+
postComplianceRequirementCompletions,
|
|
14428
|
+
{
|
|
14429
|
+
body: {
|
|
14430
|
+
data: {
|
|
14431
|
+
type: "compliance-requirement-completion",
|
|
14432
|
+
attributes
|
|
14433
|
+
}
|
|
14434
|
+
}
|
|
14435
|
+
},
|
|
14436
|
+
options
|
|
14437
|
+
);
|
|
14438
|
+
}
|
|
14439
|
+
},
|
|
14440
|
+
/**
|
|
14441
|
+
* Compliance Officer Designations — track designated compliance officers.
|
|
14442
|
+
*
|
|
14443
|
+
* Regulatory frameworks require organizations to designate compliance
|
|
14444
|
+
* officers (e.g., HIPAA Privacy Officer, DPO under GDPR). Designations
|
|
14445
|
+
* can be created and revoked.
|
|
14446
|
+
*/
|
|
14447
|
+
complianceOfficerDesignations: {
|
|
14448
|
+
/**
|
|
14449
|
+
* List compliance officer designations with optional pagination.
|
|
14450
|
+
*
|
|
14451
|
+
* @param options - Optional page number, page size, and request options.
|
|
14452
|
+
* @returns A page of `ComplianceOfficerDesignation` records.
|
|
14453
|
+
*
|
|
14454
|
+
* @example
|
|
14455
|
+
* ```typescript
|
|
14456
|
+
* const designations = await client.compliance.complianceOfficerDesignations.list();
|
|
14457
|
+
* ```
|
|
14458
|
+
*/
|
|
14459
|
+
list: async (options) => {
|
|
14460
|
+
return rb.execute(
|
|
14461
|
+
getComplianceOfficerDesignations,
|
|
14462
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
14463
|
+
options
|
|
14464
|
+
);
|
|
14465
|
+
},
|
|
14466
|
+
/**
|
|
14467
|
+
* Retrieve a single compliance officer designation by ID.
|
|
14468
|
+
*
|
|
14469
|
+
* @param id - The UUID of the designation.
|
|
14470
|
+
* @param options - Optional request options.
|
|
14471
|
+
* @returns The matching `ComplianceOfficerDesignation`.
|
|
14472
|
+
*
|
|
14473
|
+
* @example
|
|
14474
|
+
* ```typescript
|
|
14475
|
+
* const designation = await client.compliance.complianceOfficerDesignations.get('cod-uuid');
|
|
14476
|
+
* ```
|
|
14477
|
+
*/
|
|
14478
|
+
get: async (id, options) => {
|
|
14479
|
+
return rb.execute(
|
|
14480
|
+
getComplianceOfficerDesignationsById,
|
|
14481
|
+
{ path: { id } },
|
|
14482
|
+
options
|
|
14483
|
+
);
|
|
14484
|
+
},
|
|
14485
|
+
/**
|
|
14486
|
+
* Create a new compliance officer designation.
|
|
14487
|
+
*
|
|
14488
|
+
* @param attributes - Designation attributes (user ID, role, framework, effective date).
|
|
14489
|
+
* @param options - Optional request options.
|
|
14490
|
+
* @returns The newly created `ComplianceOfficerDesignation`.
|
|
14491
|
+
*
|
|
14492
|
+
* @example
|
|
14493
|
+
* ```typescript
|
|
14494
|
+
* const designation = await client.compliance.complianceOfficerDesignations.create({
|
|
14495
|
+
* user_id: 'user-uuid',
|
|
14496
|
+
* role: 'privacy_officer',
|
|
14497
|
+
* framework: 'hipaa',
|
|
14498
|
+
* });
|
|
14499
|
+
* ```
|
|
14500
|
+
*/
|
|
14501
|
+
create: async (attributes, options) => {
|
|
14502
|
+
return rb.execute(
|
|
14503
|
+
postComplianceOfficerDesignations,
|
|
14504
|
+
{
|
|
14505
|
+
body: {
|
|
14506
|
+
data: { type: "compliance-officer-designation", attributes }
|
|
14507
|
+
}
|
|
14508
|
+
},
|
|
14509
|
+
options
|
|
14510
|
+
);
|
|
14511
|
+
},
|
|
14512
|
+
/**
|
|
14513
|
+
* Revoke a compliance officer designation.
|
|
14514
|
+
*
|
|
14515
|
+
* @param id - The UUID of the designation to revoke.
|
|
14516
|
+
* @param attributes - Optional revocation attributes (reason, effective date).
|
|
14517
|
+
* @param options - Optional request options.
|
|
14518
|
+
* @returns The updated `ComplianceOfficerDesignation` with revoked status.
|
|
14519
|
+
*
|
|
14520
|
+
* @example
|
|
14521
|
+
* ```typescript
|
|
14522
|
+
* const designation = await client.compliance.complianceOfficerDesignations.revoke(
|
|
14523
|
+
* 'cod-uuid', { reason: 'Role reassigned.' },
|
|
14524
|
+
* );
|
|
14525
|
+
* ```
|
|
14526
|
+
*/
|
|
14527
|
+
revoke: async (id, attributes, options) => {
|
|
14528
|
+
return rb.execute(
|
|
14529
|
+
patchComplianceOfficerDesignationsByIdRevoke,
|
|
14530
|
+
{
|
|
14531
|
+
path: { id },
|
|
14532
|
+
body: {
|
|
14533
|
+
data: {
|
|
14534
|
+
type: "compliance-officer-designation",
|
|
14535
|
+
id,
|
|
14536
|
+
attributes: attributes ?? {}
|
|
14537
|
+
}
|
|
14538
|
+
}
|
|
14539
|
+
},
|
|
14540
|
+
options
|
|
14541
|
+
);
|
|
14542
|
+
}
|
|
14543
|
+
},
|
|
14544
|
+
/**
|
|
14545
|
+
* ePHI Assets — electronic Protected Health Information asset inventory.
|
|
14546
|
+
*
|
|
14547
|
+
* HIPAA requires covered entities to maintain an inventory of systems
|
|
14548
|
+
* and locations where ePHI is created, received, maintained, or
|
|
14549
|
+
* transmitted. Each asset record documents one such system.
|
|
14550
|
+
*/
|
|
14551
|
+
ephiAssets: {
|
|
14552
|
+
/**
|
|
14553
|
+
* List ePHI assets with optional pagination.
|
|
14554
|
+
*
|
|
14555
|
+
* @param options - Optional page number, page size, and request options.
|
|
14556
|
+
* @returns A page of `EphiAsset` records.
|
|
14557
|
+
*
|
|
14558
|
+
* @example
|
|
14559
|
+
* ```typescript
|
|
14560
|
+
* const assets = await client.compliance.ephiAssets.list();
|
|
14561
|
+
* ```
|
|
14562
|
+
*/
|
|
14563
|
+
list: async (options) => {
|
|
14564
|
+
return rb.execute(
|
|
14565
|
+
getEphiAssets,
|
|
14566
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
14567
|
+
options
|
|
14568
|
+
);
|
|
14569
|
+
},
|
|
14570
|
+
/**
|
|
14571
|
+
* Retrieve a single ePHI asset by ID.
|
|
14572
|
+
*
|
|
14573
|
+
* @param id - The UUID of the ePHI asset.
|
|
14574
|
+
* @param options - Optional request options.
|
|
14575
|
+
* @returns The matching `EphiAsset`.
|
|
14576
|
+
*
|
|
14577
|
+
* @example
|
|
14578
|
+
* ```typescript
|
|
14579
|
+
* const asset = await client.compliance.ephiAssets.get('ea-uuid');
|
|
14580
|
+
* ```
|
|
14581
|
+
*/
|
|
14582
|
+
get: async (id, options) => {
|
|
14583
|
+
return rb.execute(
|
|
14584
|
+
getEphiAssetsById,
|
|
14585
|
+
{ path: { id } },
|
|
14586
|
+
options
|
|
14587
|
+
);
|
|
14588
|
+
},
|
|
14589
|
+
/**
|
|
14590
|
+
* Create a new ePHI asset record.
|
|
14591
|
+
*
|
|
14592
|
+
* @param attributes - Asset attributes (name, type, location, custodian, etc.).
|
|
14593
|
+
* @param options - Optional request options.
|
|
14594
|
+
* @returns The newly created `EphiAsset`.
|
|
14595
|
+
*
|
|
14596
|
+
* @example
|
|
14597
|
+
* ```typescript
|
|
14598
|
+
* const asset = await client.compliance.ephiAssets.create({
|
|
14599
|
+
* name: 'Patient Records Database',
|
|
14600
|
+
* asset_type: 'database',
|
|
14601
|
+
* location: 'us-east-1',
|
|
14602
|
+
* });
|
|
14603
|
+
* ```
|
|
14604
|
+
*/
|
|
14605
|
+
create: async (attributes, options) => {
|
|
14606
|
+
return rb.execute(
|
|
14607
|
+
postEphiAssets,
|
|
14608
|
+
{ body: { data: { type: "ephi-asset", attributes } } },
|
|
14609
|
+
options
|
|
14610
|
+
);
|
|
14611
|
+
},
|
|
14612
|
+
/**
|
|
14613
|
+
* Update an ePHI asset record.
|
|
14614
|
+
*
|
|
14615
|
+
* @param id - The UUID of the ePHI asset to update.
|
|
14616
|
+
* @param attributes - Attribute map of fields to change.
|
|
14617
|
+
* @param options - Optional request options.
|
|
14618
|
+
* @returns The updated `EphiAsset`.
|
|
14619
|
+
*
|
|
14620
|
+
* @example
|
|
14621
|
+
* ```typescript
|
|
14622
|
+
* const asset = await client.compliance.ephiAssets.update(
|
|
14623
|
+
* 'ea-uuid', { custodian: 'new-admin-uuid' },
|
|
14624
|
+
* );
|
|
14625
|
+
* ```
|
|
14626
|
+
*/
|
|
14627
|
+
update: async (id, attributes, options) => {
|
|
14628
|
+
return rb.execute(
|
|
14629
|
+
patchEphiAssetsById,
|
|
14630
|
+
{
|
|
14631
|
+
path: { id },
|
|
14632
|
+
body: { data: { type: "ephi-asset", id, attributes } }
|
|
14633
|
+
},
|
|
14634
|
+
options
|
|
14635
|
+
);
|
|
14636
|
+
}
|
|
14637
|
+
},
|
|
14638
|
+
/**
|
|
14639
|
+
* ePHI Data Flows — document how ePHI moves between systems.
|
|
14640
|
+
*
|
|
14641
|
+
* HIPAA requires understanding how ePHI flows between systems, people,
|
|
14642
|
+
* and organizations. Each data flow record documents one movement path,
|
|
14643
|
+
* including source, destination, and safeguards.
|
|
14644
|
+
*/
|
|
14645
|
+
ephiDataFlows: {
|
|
14646
|
+
/**
|
|
14647
|
+
* List ePHI data flows with optional pagination.
|
|
14648
|
+
*
|
|
14649
|
+
* @param options - Optional page number, page size, and request options.
|
|
14650
|
+
* @returns A page of `EphiDataFlow` records.
|
|
14651
|
+
*
|
|
14652
|
+
* @example
|
|
14653
|
+
* ```typescript
|
|
14654
|
+
* const flows = await client.compliance.ephiDataFlows.list();
|
|
14655
|
+
* ```
|
|
14656
|
+
*/
|
|
14657
|
+
list: async (options) => {
|
|
14658
|
+
return rb.execute(
|
|
14659
|
+
getEphiDataFlows,
|
|
14660
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
14661
|
+
options
|
|
14662
|
+
);
|
|
14663
|
+
},
|
|
14664
|
+
/**
|
|
14665
|
+
* Retrieve a single ePHI data flow by ID.
|
|
14666
|
+
*
|
|
14667
|
+
* @param id - The UUID of the ePHI data flow.
|
|
14668
|
+
* @param options - Optional request options.
|
|
14669
|
+
* @returns The matching `EphiDataFlow`.
|
|
14670
|
+
*
|
|
14671
|
+
* @example
|
|
14672
|
+
* ```typescript
|
|
14673
|
+
* const flow = await client.compliance.ephiDataFlows.get('edf-uuid');
|
|
14674
|
+
* ```
|
|
14675
|
+
*/
|
|
14676
|
+
get: async (id, options) => {
|
|
14677
|
+
return rb.execute(
|
|
14678
|
+
getEphiDataFlowsById,
|
|
14679
|
+
{ path: { id } },
|
|
14680
|
+
options
|
|
14681
|
+
);
|
|
14682
|
+
},
|
|
14683
|
+
/**
|
|
14684
|
+
* Create a new ePHI data flow record.
|
|
14685
|
+
*
|
|
14686
|
+
* @param attributes - Data flow attributes (source, destination, data types, encryption, etc.).
|
|
14687
|
+
* @param options - Optional request options.
|
|
14688
|
+
* @returns The newly created `EphiDataFlow`.
|
|
14689
|
+
*
|
|
14690
|
+
* @example
|
|
14691
|
+
* ```typescript
|
|
14692
|
+
* const flow = await client.compliance.ephiDataFlows.create({
|
|
14693
|
+
* source_asset_id: 'ea-source-uuid',
|
|
14694
|
+
* destination_asset_id: 'ea-dest-uuid',
|
|
14695
|
+
* data_types: ['patient_records'],
|
|
14696
|
+
* encryption: 'tls_1_3',
|
|
14697
|
+
* });
|
|
14698
|
+
* ```
|
|
14699
|
+
*/
|
|
14700
|
+
create: async (attributes, options) => {
|
|
14701
|
+
return rb.execute(
|
|
14702
|
+
postEphiDataFlows,
|
|
14703
|
+
{ body: { data: { type: "ephi-data-flow", attributes } } },
|
|
14704
|
+
options
|
|
14705
|
+
);
|
|
14706
|
+
},
|
|
14707
|
+
/**
|
|
14708
|
+
* Update an ePHI data flow record.
|
|
14709
|
+
*
|
|
14710
|
+
* @param id - The UUID of the ePHI data flow to update.
|
|
14711
|
+
* @param attributes - Attribute map of fields to change.
|
|
14712
|
+
* @param options - Optional request options.
|
|
14713
|
+
* @returns The updated `EphiDataFlow`.
|
|
14714
|
+
*
|
|
14715
|
+
* @example
|
|
14716
|
+
* ```typescript
|
|
14717
|
+
* const flow = await client.compliance.ephiDataFlows.update(
|
|
14718
|
+
* 'edf-uuid', { encryption: 'aes_256' },
|
|
14719
|
+
* );
|
|
14720
|
+
* ```
|
|
14721
|
+
*/
|
|
14722
|
+
update: async (id, attributes, options) => {
|
|
14723
|
+
return rb.execute(
|
|
14724
|
+
patchEphiDataFlowsById,
|
|
14725
|
+
{
|
|
14726
|
+
path: { id },
|
|
14727
|
+
body: { data: { type: "ephi-data-flow", id, attributes } }
|
|
14728
|
+
},
|
|
14729
|
+
options
|
|
14730
|
+
);
|
|
14731
|
+
}
|
|
14732
|
+
},
|
|
14733
|
+
/**
|
|
14734
|
+
* Breach Notification Artifacts — regulatory notification documents.
|
|
14735
|
+
*
|
|
14736
|
+
* When a breach requires notification to authorities or individuals,
|
|
14737
|
+
* artifacts capture the notification letters, forms, and evidence
|
|
14738
|
+
* packages. Artifacts can be drafted, updated, and sent.
|
|
14739
|
+
*/
|
|
14740
|
+
breachNotificationArtifacts: {
|
|
14741
|
+
/**
|
|
14742
|
+
* List breach notification artifacts with optional pagination.
|
|
14743
|
+
*
|
|
14744
|
+
* @param options - Optional page number, page size, and request options.
|
|
14745
|
+
* @returns A page of `BreachNotificationArtifact` records.
|
|
14746
|
+
*
|
|
14747
|
+
* @example
|
|
14748
|
+
* ```typescript
|
|
14749
|
+
* const artifacts = await client.compliance.breachNotificationArtifacts.list();
|
|
14750
|
+
* ```
|
|
14751
|
+
*/
|
|
14752
|
+
list: async (options) => {
|
|
14753
|
+
return rb.execute(
|
|
14754
|
+
getBreachNotificationArtifacts,
|
|
14755
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
14756
|
+
options
|
|
14757
|
+
);
|
|
14758
|
+
},
|
|
14759
|
+
/**
|
|
14760
|
+
* Retrieve a single breach notification artifact by ID.
|
|
14761
|
+
*
|
|
14762
|
+
* @param id - The UUID of the artifact.
|
|
14763
|
+
* @param options - Optional request options.
|
|
14764
|
+
* @returns The matching `BreachNotificationArtifact`.
|
|
14765
|
+
*
|
|
14766
|
+
* @example
|
|
14767
|
+
* ```typescript
|
|
14768
|
+
* const artifact = await client.compliance.breachNotificationArtifacts.get('bna-uuid');
|
|
14769
|
+
* ```
|
|
14770
|
+
*/
|
|
14771
|
+
get: async (id, options) => {
|
|
14772
|
+
return rb.execute(
|
|
14773
|
+
getBreachNotificationArtifactsById,
|
|
14774
|
+
{ path: { id } },
|
|
14775
|
+
options
|
|
14776
|
+
);
|
|
14777
|
+
},
|
|
14778
|
+
/**
|
|
14779
|
+
* Create a new breach notification artifact.
|
|
14780
|
+
*
|
|
14781
|
+
* @param attributes - Artifact attributes (breach ID, type, content, recipients).
|
|
14782
|
+
* @param options - Optional request options.
|
|
14783
|
+
* @returns The newly created `BreachNotificationArtifact`.
|
|
14784
|
+
*
|
|
14785
|
+
* @example
|
|
14786
|
+
* ```typescript
|
|
14787
|
+
* const artifact = await client.compliance.breachNotificationArtifacts.create({
|
|
14788
|
+
* breach_incident_id: 'bi-uuid',
|
|
14789
|
+
* artifact_type: 'notification_letter',
|
|
14790
|
+
* content: 'Dear affected individual...',
|
|
14791
|
+
* });
|
|
14792
|
+
* ```
|
|
14793
|
+
*/
|
|
14794
|
+
create: async (attributes, options) => {
|
|
14795
|
+
return rb.execute(
|
|
14796
|
+
postBreachNotificationArtifacts,
|
|
14797
|
+
{
|
|
14798
|
+
body: {
|
|
14799
|
+
data: { type: "breach-notification-artifact", attributes }
|
|
14800
|
+
}
|
|
14801
|
+
},
|
|
14802
|
+
options
|
|
14803
|
+
);
|
|
14804
|
+
},
|
|
14805
|
+
/**
|
|
14806
|
+
* Update a breach notification artifact.
|
|
14807
|
+
*
|
|
14808
|
+
* @param id - The UUID of the artifact to update.
|
|
14809
|
+
* @param attributes - Attribute map of fields to change.
|
|
14810
|
+
* @param options - Optional request options.
|
|
14811
|
+
* @returns The updated `BreachNotificationArtifact`.
|
|
14812
|
+
*
|
|
14813
|
+
* @example
|
|
14814
|
+
* ```typescript
|
|
14815
|
+
* const artifact = await client.compliance.breachNotificationArtifacts.update(
|
|
14816
|
+
* 'bna-uuid', { content: 'Revised notification...' },
|
|
14817
|
+
* );
|
|
14818
|
+
* ```
|
|
14819
|
+
*/
|
|
14820
|
+
update: async (id, attributes, options) => {
|
|
14821
|
+
return rb.execute(
|
|
14822
|
+
patchBreachNotificationArtifactsById,
|
|
14823
|
+
{
|
|
14824
|
+
path: { id },
|
|
14825
|
+
body: {
|
|
14826
|
+
data: { type: "breach-notification-artifact", id, attributes }
|
|
14827
|
+
}
|
|
14828
|
+
},
|
|
14829
|
+
options
|
|
14830
|
+
);
|
|
14831
|
+
},
|
|
14832
|
+
/**
|
|
14833
|
+
* Send a breach notification artifact to its recipients.
|
|
14834
|
+
*
|
|
14835
|
+
* Triggers delivery of the notification and records the send event.
|
|
14836
|
+
*
|
|
14837
|
+
* @param id - The UUID of the artifact to send.
|
|
14838
|
+
* @param attributes - Optional send attributes (delivery method, etc.).
|
|
14839
|
+
* @param options - Optional request options.
|
|
14840
|
+
* @returns The updated `BreachNotificationArtifact` with sent status.
|
|
14841
|
+
*
|
|
14842
|
+
* @example
|
|
14843
|
+
* ```typescript
|
|
14844
|
+
* const artifact = await client.compliance.breachNotificationArtifacts.send('bna-uuid');
|
|
14845
|
+
* ```
|
|
14846
|
+
*/
|
|
14847
|
+
send: async (id, attributes, options) => {
|
|
14848
|
+
return rb.execute(
|
|
14849
|
+
patchBreachNotificationArtifactsByIdSend,
|
|
14850
|
+
{
|
|
14851
|
+
path: { id },
|
|
14852
|
+
body: {
|
|
14853
|
+
data: {
|
|
14854
|
+
type: "breach-notification-artifact",
|
|
14855
|
+
id,
|
|
14856
|
+
attributes: attributes ?? {}
|
|
14857
|
+
}
|
|
14858
|
+
}
|
|
14859
|
+
},
|
|
14860
|
+
options
|
|
14861
|
+
);
|
|
14862
|
+
}
|
|
14863
|
+
}
|
|
14864
|
+
};
|
|
14865
|
+
}
|
|
14866
|
+
|
|
14867
|
+
// src/namespaces/communication.ts
|
|
14868
|
+
function createCommunicationNamespace(rb) {
|
|
14869
|
+
return {
|
|
12597
14870
|
/**
|
|
12598
14871
|
* Sub-namespace for notification operations.
|
|
12599
14872
|
*
|
|
@@ -17131,7 +19404,7 @@ function createEmailNamespace(rb) {
|
|
|
17131
19404
|
* trigger verification after publishing DNS records.
|
|
17132
19405
|
*
|
|
17133
19406
|
* @param attributes - Key/value map of profile attributes. Required:
|
|
17134
|
-
* `workspace_id`, `
|
|
19407
|
+
* `workspace_id`, `email`, `name`. Optional: `address`, `company`, `phone`, `signature`.
|
|
17135
19408
|
* @param options - Optional request-level overrides.
|
|
17136
19409
|
* @returns A promise that resolves to the newly created {@link EmailMarketingSenderProfile}.
|
|
17137
19410
|
*
|
|
@@ -17141,9 +19414,8 @@ function createEmailNamespace(rb) {
|
|
|
17141
19414
|
*
|
|
17142
19415
|
* const profile = await client.email.senderProfiles.create({
|
|
17143
19416
|
* workspace_id: 'ws_abc123',
|
|
17144
|
-
*
|
|
17145
|
-
*
|
|
17146
|
-
* reply_to_email: 'support@acme.com',
|
|
19417
|
+
* email: 'hello@acme.com',
|
|
19418
|
+
* name: 'Acme Team',
|
|
17147
19419
|
* });
|
|
17148
19420
|
* // Publish DNS records, then verify:
|
|
17149
19421
|
* await client.email.senderProfiles.validateDns(profile.id);
|
|
@@ -17160,12 +19432,12 @@ function createEmailNamespace(rb) {
|
|
|
17160
19432
|
* Update a sender profile's attributes.
|
|
17161
19433
|
*
|
|
17162
19434
|
* Only the fields present in `attributes` are changed (PATCH semantics).
|
|
17163
|
-
* After updating
|
|
19435
|
+
* After updating domain-related fields, re-verify DNS
|
|
17164
19436
|
* with `validateDns()` to confirm deliverability is not impacted.
|
|
17165
19437
|
*
|
|
17166
19438
|
* @param id - The unique identifier of the sender profile to update.
|
|
17167
19439
|
* @param attributes - Key/value map of attributes to change (e.g.
|
|
17168
|
-
* `
|
|
19440
|
+
* `name`, `company`, `signature`).
|
|
17169
19441
|
* @param options - Optional request-level overrides.
|
|
17170
19442
|
* @returns A promise that resolves to the updated {@link EmailMarketingSenderProfile}.
|
|
17171
19443
|
*
|
|
@@ -17174,7 +19446,7 @@ function createEmailNamespace(rb) {
|
|
|
17174
19446
|
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
17175
19447
|
*
|
|
17176
19448
|
* const profile = await client.email.senderProfiles.update('sp_abc123', {
|
|
17177
|
-
*
|
|
19449
|
+
* name: 'Acme Support',
|
|
17178
19450
|
* });
|
|
17179
19451
|
* ```
|
|
17180
19452
|
*/
|
|
@@ -17391,29 +19663,6 @@ function createEmailNamespace(rb) {
|
|
|
17391
19663
|
},
|
|
17392
19664
|
options
|
|
17393
19665
|
);
|
|
17394
|
-
},
|
|
17395
|
-
/**
|
|
17396
|
-
* Delete an unsubscribe record by ID.
|
|
17397
|
-
*
|
|
17398
|
-
* Removing an unsubscribe record allows the address to receive emails
|
|
17399
|
-
* again. Use with caution — only remove records when the contact has
|
|
17400
|
-
* explicitly re-subscribed via a compliant opt-in process.
|
|
17401
|
-
*
|
|
17402
|
-
* @param id - The unique identifier of the unsubscribe record to delete.
|
|
17403
|
-
* @param options - Optional request-level overrides.
|
|
17404
|
-
* @returns A promise that resolves to `true` on successful deletion.
|
|
17405
|
-
*/
|
|
17406
|
-
delete: async (id, options) => {
|
|
17407
|
-
return rb.executeDelete(
|
|
17408
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
17409
|
-
(opts) => opts.client.delete({
|
|
17410
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
17411
|
-
url: "/email/unsubscribers/{id}",
|
|
17412
|
-
...opts
|
|
17413
|
-
}),
|
|
17414
|
-
{ path: { id } },
|
|
17415
|
-
options
|
|
17416
|
-
);
|
|
17417
19666
|
}
|
|
17418
19667
|
},
|
|
17419
19668
|
/**
|
|
@@ -20448,52 +22697,7 @@ function createPlatformNamespace(rb) {
|
|
|
20448
22697
|
return rb.execute(
|
|
20449
22698
|
getApplications,
|
|
20450
22699
|
buildPageQuery(options?.page, options?.pageSize),
|
|
20451
|
-
options
|
|
20452
|
-
);
|
|
20453
|
-
},
|
|
20454
|
-
/**
|
|
20455
|
-
* List email templates for the current application (paginated).
|
|
20456
|
-
*
|
|
20457
|
-
* Returns email template records associated with the application's
|
|
20458
|
-
* communication configuration, scoped by the current actor.
|
|
20459
|
-
*
|
|
20460
|
-
* @param options - Optional page number, page size, and request options.
|
|
20461
|
-
* @returns A page of email template records (typed as `Application[]` by the generated SDK).
|
|
20462
|
-
*
|
|
20463
|
-
* @example
|
|
20464
|
-
* ```typescript
|
|
20465
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
20466
|
-
* const templates = await client.platform.applications.listEmailTemplates();
|
|
20467
|
-
* ```
|
|
20468
|
-
*/
|
|
20469
|
-
listEmailTemplates: async (options) => {
|
|
20470
|
-
return rb.execute(
|
|
20471
|
-
getApplicationsByApplicationIdEmailTemplatesBySlug,
|
|
20472
|
-
buildPageQuery(options?.page, options?.pageSize),
|
|
20473
|
-
options
|
|
20474
|
-
);
|
|
20475
|
-
},
|
|
20476
|
-
/**
|
|
20477
|
-
* List all email templates, auto-paginating through every page.
|
|
20478
|
-
*
|
|
20479
|
-
* @param options - Optional request options.
|
|
20480
|
-
* @returns All email template records as a flat array.
|
|
20481
|
-
*
|
|
20482
|
-
* @example
|
|
20483
|
-
* ```typescript
|
|
20484
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
20485
|
-
* const allTemplates = await client.platform.applications.listAllEmailTemplates();
|
|
20486
|
-
* ```
|
|
20487
|
-
*/
|
|
20488
|
-
listAllEmailTemplates: async (options) => {
|
|
20489
|
-
return paginateToArray(
|
|
20490
|
-
rb.createPaginatedFetcher(
|
|
20491
|
-
getApplicationsByApplicationIdEmailTemplatesBySlug,
|
|
20492
|
-
(page, pageSize) => ({
|
|
20493
|
-
query: { page: { number: page, size: pageSize } }
|
|
20494
|
-
}),
|
|
20495
|
-
options
|
|
20496
|
-
)
|
|
22700
|
+
options
|
|
20497
22701
|
);
|
|
20498
22702
|
},
|
|
20499
22703
|
/**
|
|
@@ -21225,92 +23429,6 @@ function createPlatformNamespace(rb) {
|
|
|
21225
23429
|
);
|
|
21226
23430
|
}
|
|
21227
23431
|
},
|
|
21228
|
-
/**
|
|
21229
|
-
* Configs — application-level configuration key-value entries.
|
|
21230
|
-
*
|
|
21231
|
-
* Config entries store application-level settings such as feature flags,
|
|
21232
|
-
* branding values, or integration parameters. Each entry has a string `key`
|
|
21233
|
-
* and a typed `value`. Updates are applied immediately and take effect on
|
|
21234
|
-
* the next request that reads the config.
|
|
21235
|
-
*/
|
|
21236
|
-
configs: {
|
|
21237
|
-
/**
|
|
21238
|
-
* List application configuration entries with optional pagination.
|
|
21239
|
-
*
|
|
21240
|
-
* @param options - Optional page number, page size, and request options.
|
|
21241
|
-
* @returns A page of `Config` entries.
|
|
21242
|
-
*
|
|
21243
|
-
* @example
|
|
21244
|
-
* ```typescript
|
|
21245
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
21246
|
-
* const configs = await client.platform.configs.list();
|
|
21247
|
-
* configs.forEach(c => console.log(c.attributes?.key, c.attributes?.value));
|
|
21248
|
-
* ```
|
|
21249
|
-
*/
|
|
21250
|
-
list: async (options) => {
|
|
21251
|
-
return rb.execute(
|
|
21252
|
-
getConfigs,
|
|
21253
|
-
buildPageQuery(options?.page, options?.pageSize),
|
|
21254
|
-
options
|
|
21255
|
-
);
|
|
21256
|
-
},
|
|
21257
|
-
/**
|
|
21258
|
-
* Create a new application configuration entry.
|
|
21259
|
-
*
|
|
21260
|
-
* Typical attributes: `key` (string identifier, e.g., `"max_upload_mb"`)
|
|
21261
|
-
* and `value` (the setting value, can be any JSON-serializable type).
|
|
21262
|
-
*
|
|
21263
|
-
* @param attributes - Config entry attributes. `key` and `value` are required.
|
|
21264
|
-
* @param options - Optional request options.
|
|
21265
|
-
* @returns The newly created `Config` entry.
|
|
21266
|
-
*
|
|
21267
|
-
* @example
|
|
21268
|
-
* ```typescript
|
|
21269
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
21270
|
-
* const config = await client.platform.configs.create({
|
|
21271
|
-
* key: 'max_upload_mb',
|
|
21272
|
-
* value: 100,
|
|
21273
|
-
* });
|
|
21274
|
-
* ```
|
|
21275
|
-
*/
|
|
21276
|
-
create: async (attributes, options) => {
|
|
21277
|
-
return rb.execute(
|
|
21278
|
-
postConfigs,
|
|
21279
|
-
{ body: { data: { type: "config", attributes } } },
|
|
21280
|
-
options
|
|
21281
|
-
);
|
|
21282
|
-
},
|
|
21283
|
-
/**
|
|
21284
|
-
* Update an application configuration entry by key.
|
|
21285
|
-
*
|
|
21286
|
-
* Performs an upsert-style update: if a config with the given `key` exists
|
|
21287
|
-
* it is updated; the `key` in the path must match the `key` attribute.
|
|
21288
|
-
*
|
|
21289
|
-
* @param key - The string key of the config entry to update.
|
|
21290
|
-
* @param attributes - Attribute map of fields to change, typically `{ value }`.
|
|
21291
|
-
* @param options - Optional request options.
|
|
21292
|
-
* @returns The updated `Config` entry.
|
|
21293
|
-
*
|
|
21294
|
-
* @example
|
|
21295
|
-
* ```typescript
|
|
21296
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
21297
|
-
* const config = await client.platform.configs.update('max_upload_mb', {
|
|
21298
|
-
* value: 250,
|
|
21299
|
-
* });
|
|
21300
|
-
* console.log(config.attributes?.value); // 250
|
|
21301
|
-
* ```
|
|
21302
|
-
*/
|
|
21303
|
-
update: async (key, attributes, options) => {
|
|
21304
|
-
return rb.execute(
|
|
21305
|
-
patchConfigsByKey,
|
|
21306
|
-
{
|
|
21307
|
-
path: { key },
|
|
21308
|
-
body: { data: { type: "config", id: key, attributes } }
|
|
21309
|
-
},
|
|
21310
|
-
options
|
|
21311
|
-
);
|
|
21312
|
-
}
|
|
21313
|
-
},
|
|
21314
23432
|
/**
|
|
21315
23433
|
* Roles — named permission bundles for workspace access control.
|
|
21316
23434
|
*
|
|
@@ -26659,608 +28777,231 @@ function createSocialNamespace(rb) {
|
|
|
26659
28777
|
/** Generate AI master copy from the campaign's content brief. */
|
|
26660
28778
|
generateMasterCopy: async (id, workspaceId, options) => {
|
|
26661
28779
|
return rb.execute(
|
|
26662
|
-
postSocialCampaignsByIdGenerateMasterCopy,
|
|
26663
|
-
{
|
|
26664
|
-
path: { id },
|
|
26665
|
-
body: {
|
|
26666
|
-
data: {
|
|
26667
|
-
type: "social_campaign",
|
|
26668
|
-
attributes: {
|
|
26669
|
-
campaign_id: id,
|
|
26670
|
-
workspace_id: workspaceId
|
|
26671
|
-
}
|
|
26672
|
-
}
|
|
26673
|
-
}
|
|
26674
|
-
},
|
|
26675
|
-
options
|
|
26676
|
-
);
|
|
26677
|
-
},
|
|
26678
|
-
/** Adapt master copy for target platforms and create SocialPost drafts. */
|
|
26679
|
-
adaptForPlatforms: async (id, workspaceId, socialAccountId, options) => {
|
|
26680
|
-
return rb.execute(
|
|
26681
|
-
postSocialCampaignsByIdAdaptForPlatforms,
|
|
26682
|
-
{
|
|
26683
|
-
path: { id },
|
|
26684
|
-
body: {
|
|
26685
|
-
data: {
|
|
26686
|
-
type: "social_campaign",
|
|
26687
|
-
attributes: {
|
|
26688
|
-
campaign_id: id,
|
|
26689
|
-
workspace_id: workspaceId,
|
|
26690
|
-
social_account_id: socialAccountId
|
|
26691
|
-
}
|
|
26692
|
-
}
|
|
26693
|
-
}
|
|
26694
|
-
},
|
|
26695
|
-
options
|
|
26696
|
-
);
|
|
26697
|
-
}
|
|
26698
|
-
}
|
|
26699
|
-
};
|
|
26700
|
-
}
|
|
26701
|
-
|
|
26702
|
-
// src/namespaces/models.ts
|
|
26703
|
-
function createModelsNamespace(rb) {
|
|
26704
|
-
return {
|
|
26705
|
-
/**
|
|
26706
|
-
* List available models with tier classification.
|
|
26707
|
-
*
|
|
26708
|
-
* @param options - Optional filters for tier and category.
|
|
26709
|
-
* @param reqOptions - Optional request options.
|
|
26710
|
-
* @returns Array of available models.
|
|
26711
|
-
*
|
|
26712
|
-
* @example
|
|
26713
|
-
* ```typescript
|
|
26714
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26715
|
-
*
|
|
26716
|
-
* // All models
|
|
26717
|
-
* const models = await client.models.list();
|
|
26718
|
-
*
|
|
26719
|
-
* // Filter by tier
|
|
26720
|
-
* const standard = await client.models.list({ tier: "standard" });
|
|
26721
|
-
*
|
|
26722
|
-
* // Filter by category
|
|
26723
|
-
* const reasoning = await client.models.list({ category: "reasoning" });
|
|
26724
|
-
* ```
|
|
26725
|
-
*/
|
|
26726
|
-
async list(options, reqOptions) {
|
|
26727
|
-
const params = new URLSearchParams();
|
|
26728
|
-
if (options?.tier) params.set("tier", options.tier);
|
|
26729
|
-
if (options?.category) params.set("category", options.category);
|
|
26730
|
-
const query = params.toString();
|
|
26731
|
-
const path = query ? `/models?${query}` : "/models";
|
|
26732
|
-
return rb.rawGet(path, reqOptions);
|
|
26733
|
-
},
|
|
26734
|
-
/**
|
|
26735
|
-
* Get a single model by ID.
|
|
26736
|
-
*
|
|
26737
|
-
* @param modelId - The model ID (e.g., "anthropic/claude-sonnet-4").
|
|
26738
|
-
* Do NOT URL-encode — model IDs contain literal slashes.
|
|
26739
|
-
* @param reqOptions - Optional request options.
|
|
26740
|
-
* @returns Model details with tier classification.
|
|
26741
|
-
*
|
|
26742
|
-
* @example
|
|
26743
|
-
* ```typescript
|
|
26744
|
-
* const model = await client.models.get("anthropic/claude-sonnet-4");
|
|
26745
|
-
* console.log(model.tier); // "high_performance"
|
|
26746
|
-
* ```
|
|
26747
|
-
*/
|
|
26748
|
-
async get(modelId, reqOptions) {
|
|
26749
|
-
return rb.rawGet(`/models/${modelId}`, reqOptions);
|
|
26750
|
-
}
|
|
26751
|
-
};
|
|
26752
|
-
}
|
|
26753
|
-
|
|
26754
|
-
// src/namespaces/webhooks-ns.ts
|
|
26755
|
-
function createWebhooksNamespace(rb) {
|
|
26756
|
-
return {
|
|
26757
|
-
/**
|
|
26758
|
-
* Sub-namespace for managing webhook configurations.
|
|
26759
|
-
*
|
|
26760
|
-
* A webhook configuration registers an HTTPS endpoint to receive platform
|
|
26761
|
-
* event notifications. Each config has a URL, a list of subscribed event
|
|
26762
|
-
* types, an enabled/disabled state, and an HMAC-SHA256 signing secret.
|
|
26763
|
-
* The secret is returned only at creation time and when rotated — store it
|
|
26764
|
-
* securely immediately after creation.
|
|
26765
|
-
*
|
|
26766
|
-
* @example
|
|
26767
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26768
|
-
* const configs = await client.webhooks.configs.listAll();
|
|
26769
|
-
* console.log(`Registered webhooks: ${configs.length}`);
|
|
26770
|
-
*/
|
|
26771
|
-
configs: {
|
|
26772
|
-
/**
|
|
26773
|
-
* Permanently deletes a webhook configuration by its ID.
|
|
26774
|
-
*
|
|
26775
|
-
* After deletion, the platform will stop sending events to the associated
|
|
26776
|
-
* endpoint. Any in-flight deliveries may still be attempted but new events
|
|
26777
|
-
* will not be queued. Delivery records for the deleted config are retained
|
|
26778
|
-
* for audit purposes.
|
|
26779
|
-
*
|
|
26780
|
-
* @param id - The UUID of the webhook config to delete.
|
|
26781
|
-
* @param options - Optional request options.
|
|
26782
|
-
* @returns A promise that resolves to `true` on successful deletion.
|
|
26783
|
-
*
|
|
26784
|
-
* @example
|
|
26785
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26786
|
-
* await client.webhooks.configs.delete('whc_01HXYZ...');
|
|
26787
|
-
*/
|
|
26788
|
-
delete: async (id, options) => {
|
|
26789
|
-
return rb.executeDelete(
|
|
26790
|
-
deleteWebhookConfigsById,
|
|
26791
|
-
{ path: { id } },
|
|
26792
|
-
options
|
|
26793
|
-
);
|
|
26794
|
-
},
|
|
26795
|
-
/**
|
|
26796
|
-
* Lists webhook configurations in the workspace with optional pagination
|
|
26797
|
-
* controls.
|
|
26798
|
-
*
|
|
26799
|
-
* Returns a single page of configs. Use {@link listAll} to fetch every
|
|
26800
|
-
* config across all pages automatically.
|
|
26801
|
-
*
|
|
26802
|
-
* @param options - Optional pagination and request options.
|
|
26803
|
-
* @param options.page - The page number to fetch (1-based). Defaults to 1.
|
|
26804
|
-
* @param options.pageSize - Number of configs per page.
|
|
26805
|
-
* @returns A promise that resolves to an array of `WebhookConfig` objects.
|
|
26806
|
-
*
|
|
26807
|
-
* @example
|
|
26808
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26809
|
-
* const page1 = await client.webhooks.configs.list({ pageSize: 10 });
|
|
26810
|
-
*/
|
|
26811
|
-
list: async (options) => {
|
|
26812
|
-
return rb.execute(
|
|
26813
|
-
getWebhookConfigs,
|
|
26814
|
-
buildPageQuery(options?.page, options?.pageSize),
|
|
26815
|
-
options
|
|
26816
|
-
);
|
|
26817
|
-
},
|
|
26818
|
-
/**
|
|
26819
|
-
* Fetches all webhook configurations in the workspace by transparently
|
|
26820
|
-
* paginating through every page until exhausted.
|
|
26821
|
-
*
|
|
26822
|
-
* @param options - Optional request options.
|
|
26823
|
-
* @returns A promise that resolves to a flat array of all `WebhookConfig` objects.
|
|
26824
|
-
*
|
|
26825
|
-
* @example
|
|
26826
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26827
|
-
* const allConfigs = await client.webhooks.configs.listAll();
|
|
26828
|
-
* const enabled = allConfigs.filter(c => c.attributes.enabled);
|
|
26829
|
-
*/
|
|
26830
|
-
listAll: async (options) => {
|
|
26831
|
-
return paginateToArray(
|
|
26832
|
-
rb.createPaginatedFetcher(
|
|
26833
|
-
getWebhookConfigs,
|
|
26834
|
-
(page, pageSize) => ({
|
|
26835
|
-
query: { page: { number: page, size: pageSize } }
|
|
26836
|
-
}),
|
|
26837
|
-
options
|
|
26838
|
-
)
|
|
26839
|
-
);
|
|
26840
|
-
},
|
|
26841
|
-
/**
|
|
26842
|
-
* Registers a new webhook endpoint configuration.
|
|
26843
|
-
*
|
|
26844
|
-
* The `url` must be a publicly reachable HTTPS endpoint. The `events`
|
|
26845
|
-
* array specifies which platform event types trigger deliveries. A new
|
|
26846
|
-
* HMAC-SHA256 signing secret is generated and returned in the response —
|
|
26847
|
-
* this is the only time the plaintext secret is available, so store it
|
|
26848
|
-
* securely immediately. Use the `Webhooks` class to verify signatures on
|
|
26849
|
-
* incoming payloads.
|
|
26850
|
-
*
|
|
26851
|
-
* @param attributes - Config attributes. Must include at least `url` (string)
|
|
26852
|
-
* and `events` (string[]). Optional fields include `description`,
|
|
26853
|
-
* `enabled` (default `true`), and `headers` (custom headers to send).
|
|
26854
|
-
* @param options - Optional request options.
|
|
26855
|
-
* @returns A promise that resolves to the newly created `WebhookConfig`
|
|
26856
|
-
* object, with `attributes.secret` populated (only available at creation).
|
|
26857
|
-
*
|
|
26858
|
-
* @example
|
|
26859
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26860
|
-
*
|
|
26861
|
-
* const config = await client.webhooks.configs.create({
|
|
26862
|
-
* url: 'https://my-app.example.com/webhooks/gpt',
|
|
26863
|
-
* events: ['agent.execution.completed', 'document.processed'],
|
|
26864
|
-
* description: 'Production event sink',
|
|
26865
|
-
* });
|
|
26866
|
-
*
|
|
26867
|
-
* // Store this immediately — it is never shown again
|
|
26868
|
-
* const secret = config.attributes.secret;
|
|
26869
|
-
* console.log(`Signing secret: ${secret}`);
|
|
26870
|
-
*/
|
|
26871
|
-
create: async (attributes, options) => {
|
|
26872
|
-
return rb.execute(
|
|
26873
|
-
postWebhookConfigs,
|
|
26874
|
-
{ body: { data: { type: "webhook_config", attributes } } },
|
|
26875
|
-
options
|
|
26876
|
-
);
|
|
26877
|
-
},
|
|
26878
|
-
/**
|
|
26879
|
-
* Updates one or more attributes of an existing webhook configuration.
|
|
26880
|
-
*
|
|
26881
|
-
* Only the fields present in `attributes` are changed (PATCH semantics).
|
|
26882
|
-
* To update the signing secret, use {@link rotateSecret} instead.
|
|
26883
|
-
*
|
|
26884
|
-
* @param id - The UUID of the webhook config to update.
|
|
26885
|
-
* @param attributes - A partial map of config attributes to update
|
|
26886
|
-
* (e.g. `{ url: 'https://new-url.example.com', events: ['agent.execution.completed'] }`).
|
|
26887
|
-
* @param options - Optional request options.
|
|
26888
|
-
* @returns A promise that resolves to the updated `WebhookConfig` object.
|
|
26889
|
-
*
|
|
26890
|
-
* @example
|
|
26891
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26892
|
-
*
|
|
26893
|
-
* const updated = await client.webhooks.configs.update('whc_01HXYZ...', {
|
|
26894
|
-
* events: ['agent.execution.completed', 'document.processed', 'thread.created'],
|
|
26895
|
-
* });
|
|
26896
|
-
*/
|
|
26897
|
-
update: async (id, attributes, options) => {
|
|
26898
|
-
return rb.execute(
|
|
26899
|
-
patchWebhookConfigsById,
|
|
26900
|
-
{
|
|
26901
|
-
path: { id },
|
|
26902
|
-
body: { data: { id, type: "webhook_config", attributes } }
|
|
26903
|
-
},
|
|
26904
|
-
options
|
|
26905
|
-
);
|
|
26906
|
-
},
|
|
26907
|
-
/**
|
|
26908
|
-
* Sends a test ping to the webhook endpoint to verify connectivity and
|
|
26909
|
-
* signature verification.
|
|
26910
|
-
*
|
|
26911
|
-
* The platform makes a live HTTP POST to the configured URL with a test
|
|
26912
|
-
* payload signed using the config's current secret. The response includes
|
|
26913
|
-
* the HTTP status code returned by the endpoint and whether the delivery
|
|
26914
|
-
* was considered successful. Use this to confirm your endpoint is correctly
|
|
26915
|
-
* receiving and validating signed payloads before relying on it for
|
|
26916
|
-
* production events.
|
|
26917
|
-
*
|
|
26918
|
-
* @param id - The UUID of the webhook config to test.
|
|
26919
|
-
* @param options - Optional request options.
|
|
26920
|
-
* @returns A promise that resolves to the `WebhookConfig` object annotated
|
|
26921
|
-
* with the test delivery result (status code, success flag, etc.).
|
|
26922
|
-
*
|
|
26923
|
-
* @example
|
|
26924
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26925
|
-
* const result = await client.webhooks.configs.test('whc_01HXYZ...');
|
|
26926
|
-
* console.log(`Test delivery status: ${result.attributes.last_test_status}`);
|
|
26927
|
-
*/
|
|
26928
|
-
test: async (id, options) => {
|
|
26929
|
-
return rb.execute(
|
|
26930
|
-
postWebhookConfigsByIdTest,
|
|
26931
|
-
{ path: { id }, body: {} },
|
|
26932
|
-
options
|
|
26933
|
-
);
|
|
26934
|
-
},
|
|
26935
|
-
/**
|
|
26936
|
-
* Enables all webhook configurations in the workspace in a single batch
|
|
26937
|
-
* operation.
|
|
26938
|
-
*
|
|
26939
|
-
* After calling this, all previously disabled configs will resume receiving
|
|
26940
|
-
* event deliveries. Useful for re-activating webhooks after maintenance or
|
|
26941
|
-
* a bulk-disable operation.
|
|
26942
|
-
*
|
|
26943
|
-
* @param options - Optional request options.
|
|
26944
|
-
* @returns A promise that resolves to the updated `WebhookConfig` state.
|
|
26945
|
-
*
|
|
26946
|
-
* @example
|
|
26947
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26948
|
-
* await client.webhooks.configs.bulkEnable();
|
|
26949
|
-
* console.log('All webhook configs re-enabled');
|
|
26950
|
-
*/
|
|
26951
|
-
bulkEnable: async (options) => {
|
|
26952
|
-
return rb.execute(
|
|
26953
|
-
postWebhookConfigsBulkEnable,
|
|
26954
|
-
{},
|
|
28780
|
+
postSocialCampaignsByIdGenerateMasterCopy,
|
|
28781
|
+
{
|
|
28782
|
+
path: { id },
|
|
28783
|
+
body: {
|
|
28784
|
+
data: {
|
|
28785
|
+
type: "social_campaign",
|
|
28786
|
+
attributes: {
|
|
28787
|
+
campaign_id: id,
|
|
28788
|
+
workspace_id: workspaceId
|
|
28789
|
+
}
|
|
28790
|
+
}
|
|
28791
|
+
}
|
|
28792
|
+
},
|
|
26955
28793
|
options
|
|
26956
28794
|
);
|
|
26957
28795
|
},
|
|
26958
|
-
/**
|
|
26959
|
-
|
|
26960
|
-
* operation.
|
|
26961
|
-
*
|
|
26962
|
-
* After calling this, no event deliveries will be sent to any registered
|
|
26963
|
-
* endpoint. Useful for temporarily pausing all webhooks during maintenance
|
|
26964
|
-
* windows or incident response without permanently deleting configs.
|
|
26965
|
-
* Re-enable with {@link bulkEnable}.
|
|
26966
|
-
*
|
|
26967
|
-
* @param options - Optional request options.
|
|
26968
|
-
* @returns A promise that resolves to the updated `WebhookConfig` state.
|
|
26969
|
-
*
|
|
26970
|
-
* @example
|
|
26971
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26972
|
-
* await client.webhooks.configs.bulkDisable();
|
|
26973
|
-
* console.log('All webhook configs paused');
|
|
26974
|
-
*/
|
|
26975
|
-
bulkDisable: async (options) => {
|
|
28796
|
+
/** Adapt master copy for target platforms and create SocialPost drafts. */
|
|
28797
|
+
adaptForPlatforms: async (id, workspaceId, socialAccountId, options) => {
|
|
26976
28798
|
return rb.execute(
|
|
26977
|
-
|
|
26978
|
-
{
|
|
28799
|
+
postSocialCampaignsByIdAdaptForPlatforms,
|
|
28800
|
+
{
|
|
28801
|
+
path: { id },
|
|
28802
|
+
body: {
|
|
28803
|
+
data: {
|
|
28804
|
+
type: "social_campaign",
|
|
28805
|
+
attributes: {
|
|
28806
|
+
campaign_id: id,
|
|
28807
|
+
workspace_id: workspaceId,
|
|
28808
|
+
social_account_id: socialAccountId
|
|
28809
|
+
}
|
|
28810
|
+
}
|
|
28811
|
+
}
|
|
28812
|
+
},
|
|
26979
28813
|
options
|
|
26980
28814
|
);
|
|
26981
|
-
}
|
|
28815
|
+
}
|
|
28816
|
+
},
|
|
28817
|
+
/** Trending content discovery — snapshots, items, and watch alerts. */
|
|
28818
|
+
trending: {
|
|
26982
28819
|
/**
|
|
26983
|
-
*
|
|
26984
|
-
*
|
|
26985
|
-
*
|
|
26986
|
-
* Use this when an endpoint was down or misconfigured during a window of
|
|
26987
|
-
* events and you need to retroactively process those events. The replay
|
|
26988
|
-
* window and event filter can be provided via request options. Re-delivered
|
|
26989
|
-
* events include the original event payload and timestamp but carry a new
|
|
26990
|
-
* `X-Gpt-Replay: true` header so your handler can distinguish replayed
|
|
26991
|
-
* events from live ones.
|
|
26992
|
-
*
|
|
26993
|
-
* @param id - The UUID of the webhook config to replay events to.
|
|
26994
|
-
* @param options - Optional request options. Pass `from` and `to` date
|
|
26995
|
-
* parameters to control the replay window.
|
|
26996
|
-
* @returns A promise that resolves to the `WebhookConfig` object annotated
|
|
26997
|
-
* with replay job metadata.
|
|
26998
|
-
*
|
|
28820
|
+
* Get a trending snapshot by ID.
|
|
28821
|
+
* @param id - Snapshot UUID
|
|
28822
|
+
* @returns TrendingSnapshot with metadata (query, enrichment level, item count)
|
|
26999
28823
|
* @example
|
|
27000
|
-
*
|
|
27001
|
-
* const
|
|
27002
|
-
*
|
|
28824
|
+
* ```typescript
|
|
28825
|
+
* const snapshot = await client.social.trending.get('snap_abc');
|
|
28826
|
+
* ```
|
|
27003
28827
|
*/
|
|
27004
|
-
|
|
28828
|
+
get: async (id, options) => {
|
|
27005
28829
|
return rb.execute(
|
|
27006
|
-
|
|
27007
|
-
{ path: { id }
|
|
28830
|
+
getSocialTrendingHistoryById,
|
|
28831
|
+
{ path: { id } },
|
|
27008
28832
|
options
|
|
27009
28833
|
);
|
|
27010
28834
|
},
|
|
27011
28835
|
/**
|
|
27012
|
-
*
|
|
27013
|
-
*
|
|
27014
|
-
* @
|
|
27015
|
-
* @param options - Optional request options.
|
|
27016
|
-
* @returns A promise that resolves to the full `WebhookConfig` object.
|
|
27017
|
-
* Note: the signing secret is NOT returned here for security reasons —
|
|
27018
|
-
* it is only available at creation time or after a `rotateSecret` call.
|
|
27019
|
-
*
|
|
28836
|
+
* List trending snapshots for a workspace.
|
|
28837
|
+
* @param workspaceId - Workspace UUID
|
|
28838
|
+
* @returns Array of TrendingSnapshot records
|
|
27020
28839
|
* @example
|
|
27021
|
-
*
|
|
27022
|
-
* const
|
|
27023
|
-
*
|
|
27024
|
-
* console.log(`Enabled: ${config.attributes.enabled}`);
|
|
28840
|
+
* ```typescript
|
|
28841
|
+
* const snapshots = await client.social.trending.listByWorkspace('ws_abc');
|
|
28842
|
+
* ```
|
|
27025
28843
|
*/
|
|
27026
|
-
|
|
28844
|
+
listByWorkspace: async (workspaceId, options) => {
|
|
27027
28845
|
return rb.execute(
|
|
27028
|
-
|
|
27029
|
-
{ path: {
|
|
28846
|
+
getSocialTrendingHistoryWorkspaceByWorkspaceId,
|
|
28847
|
+
{ path: { workspace_id: workspaceId } },
|
|
27030
28848
|
options
|
|
27031
28849
|
);
|
|
27032
28850
|
},
|
|
27033
28851
|
/**
|
|
27034
|
-
*
|
|
27035
|
-
*
|
|
27036
|
-
*
|
|
27037
|
-
* The new secret is returned in the response and is the only time it will
|
|
27038
|
-
* be visible in plaintext — store it securely immediately. Any endpoints
|
|
27039
|
-
* still using the old secret will begin receiving signature verification
|
|
27040
|
-
* failures immediately after rotation. Update your endpoint's stored secret
|
|
27041
|
-
* before rotating to avoid downtime.
|
|
27042
|
-
*
|
|
27043
|
-
* @param id - The UUID of the webhook config whose secret to rotate.
|
|
27044
|
-
* @param options - Optional request options.
|
|
27045
|
-
* @returns A promise that resolves to the `WebhookConfig` object with the
|
|
27046
|
-
* new `attributes.secret` populated (only available in this response).
|
|
27047
|
-
*
|
|
28852
|
+
* Create a trending snapshot (trigger on-demand collection).
|
|
28853
|
+
* @param attributes - Snapshot attributes (workspace_id, enrichment_level, etc.)
|
|
28854
|
+
* @returns Created TrendingSnapshot
|
|
27048
28855
|
* @example
|
|
27049
|
-
*
|
|
27050
|
-
* const
|
|
27051
|
-
*
|
|
27052
|
-
*
|
|
27053
|
-
*
|
|
27054
|
-
*
|
|
28856
|
+
* ```typescript
|
|
28857
|
+
* const snapshot = await client.social.trending.create({
|
|
28858
|
+
* workspace_id: 'ws_abc',
|
|
28859
|
+
* enrichment_level: 'scored',
|
|
28860
|
+
* fetched_at: new Date().toISOString(),
|
|
28861
|
+
* });
|
|
28862
|
+
* ```
|
|
27055
28863
|
*/
|
|
27056
|
-
|
|
28864
|
+
create: async (attributes, options) => {
|
|
27057
28865
|
return rb.execute(
|
|
27058
|
-
|
|
27059
|
-
{
|
|
28866
|
+
postSocialTrendingHistory,
|
|
28867
|
+
{
|
|
28868
|
+
body: {
|
|
28869
|
+
data: { type: "trending-snapshot", attributes }
|
|
28870
|
+
}
|
|
28871
|
+
},
|
|
27060
28872
|
options
|
|
27061
28873
|
);
|
|
27062
28874
|
},
|
|
27063
|
-
/**
|
|
27064
|
-
|
|
27065
|
-
*
|
|
27066
|
-
* Provides counts of total, enabled, and disabled configs along with
|
|
27067
|
-
* the overall delivery success rate. Useful for monitoring webhook
|
|
27068
|
-
* health at a glance.
|
|
27069
|
-
*
|
|
27070
|
-
* @param options - Optional request options.
|
|
27071
|
-
* @returns An object containing webhook config statistics.
|
|
27072
|
-
*
|
|
27073
|
-
* @example
|
|
27074
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
27075
|
-
* const stats = await client.webhooks.configs.stats();
|
|
27076
|
-
* console.log(`Total: ${stats.total}, Enabled: ${stats.enabled}`);
|
|
27077
|
-
*/
|
|
27078
|
-
stats: async (options) => {
|
|
28875
|
+
/** Delete a trending snapshot by ID. */
|
|
28876
|
+
delete: async (id, options) => {
|
|
27079
28877
|
return rb.execute(
|
|
27080
|
-
|
|
27081
|
-
{},
|
|
28878
|
+
deleteSocialTrendingHistoryById,
|
|
28879
|
+
{ path: { id } },
|
|
27082
28880
|
options
|
|
27083
28881
|
);
|
|
28882
|
+
},
|
|
28883
|
+
/** Trending snapshot items — individual content pieces within a snapshot. */
|
|
28884
|
+
items: {
|
|
28885
|
+
/** Get a single trending item by ID. */
|
|
28886
|
+
get: async (id, options) => {
|
|
28887
|
+
return rb.execute(
|
|
28888
|
+
getSocialTrendingItemsById,
|
|
28889
|
+
{ path: { id } },
|
|
28890
|
+
options
|
|
28891
|
+
);
|
|
28892
|
+
},
|
|
28893
|
+
/**
|
|
28894
|
+
* List trending items for a snapshot.
|
|
28895
|
+
* @param snapshotId - Parent snapshot UUID
|
|
28896
|
+
* @returns Array of TrendingSnapshotItem records
|
|
28897
|
+
* @example
|
|
28898
|
+
* ```typescript
|
|
28899
|
+
* const items = await client.social.trending.items.listBySnapshot('snap_abc');
|
|
28900
|
+
* ```
|
|
28901
|
+
*/
|
|
28902
|
+
listBySnapshot: async (snapshotId, options) => {
|
|
28903
|
+
return rb.execute(
|
|
28904
|
+
getSocialTrendingItemsSnapshotBySnapshotId,
|
|
28905
|
+
{ path: { snapshot_id: snapshotId } },
|
|
28906
|
+
options
|
|
28907
|
+
);
|
|
28908
|
+
}
|
|
27084
28909
|
}
|
|
27085
28910
|
},
|
|
27086
|
-
/**
|
|
27087
|
-
|
|
27088
|
-
*
|
|
27089
|
-
* Returns the complete event catalog. Use this to discover which event
|
|
27090
|
-
* types exist, understand their payload shape, and validate the `events`
|
|
27091
|
-
* array when registering or updating webhook configs. The endpoint does
|
|
27092
|
-
* not require authentication.
|
|
27093
|
-
*
|
|
27094
|
-
* @param options - Optional request options.
|
|
27095
|
-
* @returns A promise that resolves to an array of event type descriptors,
|
|
27096
|
-
* each with `type` (the event name string), `description`, and
|
|
27097
|
-
* `data_object` (the resource type the payload describes).
|
|
27098
|
-
*
|
|
27099
|
-
* @example
|
|
27100
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
27101
|
-
* const types = await client.webhooks.listEventTypes();
|
|
27102
|
-
* console.log(types.map(t => t.type));
|
|
27103
|
-
* // ['agent.execution.completed', 'document.processed', ...]
|
|
27104
|
-
*/
|
|
27105
|
-
listEventTypes: async (options) => {
|
|
27106
|
-
return rb.rawGet("/webhook-event-types", options);
|
|
27107
|
-
},
|
|
27108
|
-
/**
|
|
27109
|
-
* Sub-namespace for inspecting and retrying webhook delivery records.
|
|
27110
|
-
*
|
|
27111
|
-
* Every time the platform attempts to deliver an event to a webhook endpoint,
|
|
27112
|
-
* a delivery record is created. The record captures the HTTP response status,
|
|
27113
|
-
* latency, request and response bodies, and whether the delivery succeeded.
|
|
27114
|
-
* Failed deliveries can be retried individually or in bulk.
|
|
27115
|
-
*
|
|
27116
|
-
* @example
|
|
27117
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
27118
|
-
*
|
|
27119
|
-
* // Find failed deliveries and retry them
|
|
27120
|
-
* const deliveries = await client.webhooks.deliveries.listAll();
|
|
27121
|
-
* const failed = deliveries.filter(d => !d.attributes.success);
|
|
27122
|
-
* console.log(`Failed deliveries: ${failed.length}`);
|
|
27123
|
-
* await client.webhooks.deliveries.bulkRetry();
|
|
27124
|
-
*/
|
|
27125
|
-
deliveries: {
|
|
28911
|
+
/** Trending watch alerts — monitor topics and get notified on matches. */
|
|
28912
|
+
watches: {
|
|
27126
28913
|
/**
|
|
27127
|
-
*
|
|
27128
|
-
*
|
|
27129
|
-
*
|
|
27130
|
-
* every record across all pages automatically.
|
|
27131
|
-
*
|
|
27132
|
-
* @param options - Optional pagination and request options.
|
|
27133
|
-
* @param options.page - The page number to fetch (1-based). Defaults to 1.
|
|
27134
|
-
* @param options.pageSize - Number of delivery records per page.
|
|
27135
|
-
* @returns A promise that resolves to an array of `WebhookDelivery` objects,
|
|
27136
|
-
* ordered most-recent-first.
|
|
27137
|
-
*
|
|
27138
|
-
* @example
|
|
27139
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
27140
|
-
* const recent = await client.webhooks.deliveries.list({ pageSize: 20 });
|
|
28914
|
+
* Get a trending watch by ID.
|
|
28915
|
+
* @param id - Watch UUID
|
|
28916
|
+
* @returns TrendingWatch with conditions and notification config
|
|
27141
28917
|
*/
|
|
27142
|
-
|
|
28918
|
+
get: async (id, options) => {
|
|
27143
28919
|
return rb.execute(
|
|
27144
|
-
|
|
27145
|
-
|
|
28920
|
+
getSocialTrendingWatchesById,
|
|
28921
|
+
{ path: { id } },
|
|
27146
28922
|
options
|
|
27147
28923
|
);
|
|
27148
28924
|
},
|
|
27149
28925
|
/**
|
|
27150
|
-
*
|
|
27151
|
-
*
|
|
27152
|
-
*
|
|
27153
|
-
* @param options - Optional request options.
|
|
27154
|
-
* @returns A promise that resolves to a flat array of all `WebhookDelivery`
|
|
27155
|
-
* objects across the workspace.
|
|
27156
|
-
*
|
|
28926
|
+
* List trending watches for a workspace.
|
|
28927
|
+
* @param workspaceId - Workspace UUID
|
|
28928
|
+
* @returns Array of TrendingWatch records
|
|
27157
28929
|
* @example
|
|
27158
|
-
*
|
|
27159
|
-
* const
|
|
27160
|
-
*
|
|
27161
|
-
* console.log(`Delivery success rate: ${(successRate * 100).toFixed(1)}%`);
|
|
28930
|
+
* ```typescript
|
|
28931
|
+
* const watches = await client.social.watches.listByWorkspace('ws_abc');
|
|
28932
|
+
* ```
|
|
27162
28933
|
*/
|
|
27163
|
-
|
|
27164
|
-
return
|
|
27165
|
-
|
|
27166
|
-
|
|
27167
|
-
|
|
27168
|
-
query: { page: { number: page, size: pageSize } }
|
|
27169
|
-
}),
|
|
27170
|
-
options
|
|
27171
|
-
)
|
|
28934
|
+
listByWorkspace: async (workspaceId, options) => {
|
|
28935
|
+
return rb.execute(
|
|
28936
|
+
getSocialTrendingWatchesWorkspaceByWorkspaceId,
|
|
28937
|
+
{ path: { workspace_id: workspaceId } },
|
|
28938
|
+
options
|
|
27172
28939
|
);
|
|
27173
28940
|
},
|
|
27174
28941
|
/**
|
|
27175
|
-
*
|
|
27176
|
-
*
|
|
27177
|
-
*
|
|
27178
|
-
* original event payload. The delivery record is updated with the result
|
|
27179
|
-
* of the retry attempt.
|
|
27180
|
-
*
|
|
27181
|
-
* @param id - The UUID of the webhook delivery record to retry.
|
|
27182
|
-
* @param options - Optional request options.
|
|
27183
|
-
* @returns A promise that resolves to the updated `WebhookDelivery` object
|
|
27184
|
-
* after the retry attempt.
|
|
27185
|
-
*
|
|
28942
|
+
* Create a new trending watch alert.
|
|
28943
|
+
* @param attributes - Watch attributes (name, query, conditions, notification_config)
|
|
28944
|
+
* @returns Created TrendingWatch
|
|
27186
28945
|
* @example
|
|
27187
|
-
*
|
|
27188
|
-
* const
|
|
27189
|
-
*
|
|
28946
|
+
* ```typescript
|
|
28947
|
+
* const watch = await client.social.watches.create({
|
|
28948
|
+
* workspace_id: 'ws_abc',
|
|
28949
|
+
* name: 'AI Industry News',
|
|
28950
|
+
* query: 'artificial intelligence',
|
|
28951
|
+
* conditions: { min_score: 0.7 },
|
|
28952
|
+
* notification_config: { channel: 'webhook', url: 'https://...' },
|
|
28953
|
+
* });
|
|
28954
|
+
* ```
|
|
27190
28955
|
*/
|
|
27191
|
-
|
|
28956
|
+
create: async (attributes, options) => {
|
|
27192
28957
|
return rb.execute(
|
|
27193
|
-
|
|
27194
|
-
{
|
|
28958
|
+
postSocialTrendingWatches,
|
|
28959
|
+
{
|
|
28960
|
+
body: {
|
|
28961
|
+
data: { type: "trending-watch", attributes }
|
|
28962
|
+
}
|
|
28963
|
+
},
|
|
27195
28964
|
options
|
|
27196
28965
|
);
|
|
27197
28966
|
},
|
|
27198
28967
|
/**
|
|
27199
|
-
*
|
|
27200
|
-
*
|
|
27201
|
-
*
|
|
27202
|
-
* The platform identifies all delivery records with a non-2xx response or
|
|
27203
|
-
* a connection error and re-attempts each one. This is useful after
|
|
27204
|
-
* recovering from an endpoint outage to ensure no events were permanently
|
|
27205
|
-
* lost. Re-attempt results are recorded in the individual delivery records.
|
|
27206
|
-
*
|
|
27207
|
-
* @param options - Optional request options.
|
|
27208
|
-
* @returns A promise that resolves to the batch retry result.
|
|
27209
|
-
*
|
|
27210
|
-
* @example
|
|
27211
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
27212
|
-
* await client.webhooks.deliveries.bulkRetry();
|
|
27213
|
-
* console.log('All failed deliveries queued for retry');
|
|
28968
|
+
* Update a trending watch.
|
|
28969
|
+
* @param id - Watch UUID
|
|
28970
|
+
* @param attributes - Fields to update (name, query, conditions, enabled, etc.)
|
|
27214
28971
|
*/
|
|
27215
|
-
|
|
28972
|
+
update: async (id, attributes, options) => {
|
|
27216
28973
|
return rb.execute(
|
|
27217
|
-
|
|
27218
|
-
{
|
|
28974
|
+
patchSocialTrendingWatchesById,
|
|
28975
|
+
{
|
|
28976
|
+
path: { id },
|
|
28977
|
+
body: {
|
|
28978
|
+
data: { type: "trending-watch", id, attributes }
|
|
28979
|
+
}
|
|
28980
|
+
},
|
|
27219
28981
|
options
|
|
27220
28982
|
);
|
|
27221
28983
|
},
|
|
27222
|
-
/**
|
|
27223
|
-
|
|
27224
|
-
*
|
|
27225
|
-
* The record includes the event type, payload snapshot, HTTP response
|
|
27226
|
-
* status, response body, latency, attempt count, and success flag.
|
|
27227
|
-
*
|
|
27228
|
-
* @param id - The UUID of the webhook delivery record to retrieve.
|
|
27229
|
-
* @param options - Optional request options.
|
|
27230
|
-
* @returns A promise that resolves to the full `WebhookDelivery` object.
|
|
27231
|
-
*
|
|
27232
|
-
* @example
|
|
27233
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
27234
|
-
* const delivery = await client.webhooks.deliveries.get('wdl_01HXYZ...');
|
|
27235
|
-
* console.log(`Event: ${delivery.attributes.event_type}`);
|
|
27236
|
-
* console.log(`Response status: ${delivery.attributes.response_status}`);
|
|
27237
|
-
* console.log(`Success: ${delivery.attributes.success}`);
|
|
27238
|
-
*/
|
|
27239
|
-
get: async (id, options) => {
|
|
28984
|
+
/** Delete a trending watch by ID. */
|
|
28985
|
+
delete: async (id, options) => {
|
|
27240
28986
|
return rb.execute(
|
|
27241
|
-
|
|
28987
|
+
deleteSocialTrendingWatchesById,
|
|
27242
28988
|
{ path: { id } },
|
|
27243
28989
|
options
|
|
27244
28990
|
);
|
|
27245
28991
|
},
|
|
27246
28992
|
/**
|
|
27247
|
-
*
|
|
27248
|
-
*
|
|
27249
|
-
* Provides total, delivered, failed, and retrying counts. Useful for
|
|
27250
|
-
* monitoring dashboards and health checks.
|
|
27251
|
-
*
|
|
27252
|
-
* @param options - Optional request options.
|
|
27253
|
-
* @returns An object with `total`, `delivered`, `failed`, and `retrying` counts.
|
|
27254
|
-
*
|
|
27255
|
-
* @example
|
|
27256
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
27257
|
-
* const stats = await client.webhooks.deliveries.stats();
|
|
27258
|
-
* console.log(`Failed deliveries: ${stats.failed}`);
|
|
28993
|
+
* Mark a watch as triggered (updates last_triggered_at).
|
|
28994
|
+
* @param id - Watch UUID
|
|
27259
28995
|
*/
|
|
27260
|
-
|
|
28996
|
+
markTriggered: async (id, options) => {
|
|
27261
28997
|
return rb.execute(
|
|
27262
|
-
|
|
27263
|
-
{
|
|
28998
|
+
patchSocialTrendingWatchesByIdMarkTriggered,
|
|
28999
|
+
{
|
|
29000
|
+
path: { id },
|
|
29001
|
+
body: {
|
|
29002
|
+
data: { type: "trending-watch", id, attributes: {} }
|
|
29003
|
+
}
|
|
29004
|
+
},
|
|
27264
29005
|
options
|
|
27265
29006
|
);
|
|
27266
29007
|
}
|
|
@@ -27268,6 +29009,58 @@ function createWebhooksNamespace(rb) {
|
|
|
27268
29009
|
};
|
|
27269
29010
|
}
|
|
27270
29011
|
|
|
29012
|
+
// src/namespaces/models.ts
|
|
29013
|
+
function createModelsNamespace(rb) {
|
|
29014
|
+
return {
|
|
29015
|
+
/**
|
|
29016
|
+
* List available models with tier classification.
|
|
29017
|
+
*
|
|
29018
|
+
* @param options - Optional filters for tier and category.
|
|
29019
|
+
* @param reqOptions - Optional request options.
|
|
29020
|
+
* @returns Array of available models.
|
|
29021
|
+
*
|
|
29022
|
+
* @example
|
|
29023
|
+
* ```typescript
|
|
29024
|
+
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
29025
|
+
*
|
|
29026
|
+
* // All models
|
|
29027
|
+
* const models = await client.models.list();
|
|
29028
|
+
*
|
|
29029
|
+
* // Filter by tier
|
|
29030
|
+
* const standard = await client.models.list({ tier: "standard" });
|
|
29031
|
+
*
|
|
29032
|
+
* // Filter by category
|
|
29033
|
+
* const reasoning = await client.models.list({ category: "reasoning" });
|
|
29034
|
+
* ```
|
|
29035
|
+
*/
|
|
29036
|
+
async list(options, reqOptions) {
|
|
29037
|
+
const params = new URLSearchParams();
|
|
29038
|
+
if (options?.tier) params.set("tier", options.tier);
|
|
29039
|
+
if (options?.category) params.set("category", options.category);
|
|
29040
|
+
const query = params.toString();
|
|
29041
|
+
const path = query ? `/models?${query}` : "/models";
|
|
29042
|
+
return rb.rawGet(path, reqOptions);
|
|
29043
|
+
},
|
|
29044
|
+
/**
|
|
29045
|
+
* Get a single model by ID.
|
|
29046
|
+
*
|
|
29047
|
+
* @param modelId - The model ID (e.g., "anthropic/claude-sonnet-4").
|
|
29048
|
+
* Do NOT URL-encode — model IDs contain literal slashes.
|
|
29049
|
+
* @param reqOptions - Optional request options.
|
|
29050
|
+
* @returns Model details with tier classification.
|
|
29051
|
+
*
|
|
29052
|
+
* @example
|
|
29053
|
+
* ```typescript
|
|
29054
|
+
* const model = await client.models.get("anthropic/claude-sonnet-4");
|
|
29055
|
+
* console.log(model.tier); // "high_performance"
|
|
29056
|
+
* ```
|
|
29057
|
+
*/
|
|
29058
|
+
async get(modelId, reqOptions) {
|
|
29059
|
+
return rb.rawGet(`/models/${modelId}`, reqOptions);
|
|
29060
|
+
}
|
|
29061
|
+
};
|
|
29062
|
+
}
|
|
29063
|
+
|
|
27271
29064
|
// src/namespaces/crm-clusters.ts
|
|
27272
29065
|
function createCrmClustersNamespace(rb) {
|
|
27273
29066
|
return {
|
|
@@ -28078,7 +29871,6 @@ var GptClient = class extends BaseClient {
|
|
|
28078
29871
|
this.voice = createVoiceNamespace(rb);
|
|
28079
29872
|
this.social = createSocialNamespace(rb);
|
|
28080
29873
|
this.watcher = createWatcherNamespace(rb);
|
|
28081
|
-
this.webhooks = createWebhooksNamespace(rb);
|
|
28082
29874
|
this.projects = createProjectsNamespace(rb);
|
|
28083
29875
|
this.models = createModelsNamespace(rb);
|
|
28084
29876
|
this.crmClusters = createCrmClustersNamespace(rb);
|