@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.mjs
CHANGED
|
@@ -1269,7 +1269,7 @@ function buildUserAgent(sdkVersion, appInfo) {
|
|
|
1269
1269
|
}
|
|
1270
1270
|
|
|
1271
1271
|
// src/version.ts
|
|
1272
|
-
var SDK_VERSION = "0.
|
|
1272
|
+
var SDK_VERSION = "0.8.0";
|
|
1273
1273
|
var DEFAULT_API_VERSION = "2026-03-11";
|
|
1274
1274
|
|
|
1275
1275
|
// src/base-client.ts
|
|
@@ -1655,6 +1655,16 @@ var getVoiceSessionsWorkspaceByWorkspaceId = (options) => (options.client ?? cli
|
|
|
1655
1655
|
url: "/voice/sessions/workspace/{workspace_id}",
|
|
1656
1656
|
...options
|
|
1657
1657
|
});
|
|
1658
|
+
var getSocialTrendingWatchesWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
1659
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
1660
|
+
url: "/social/trending/watches/workspace/{workspace_id}",
|
|
1661
|
+
...options
|
|
1662
|
+
});
|
|
1663
|
+
var getAgentDeploymentsById = (options) => (options.client ?? client).get({
|
|
1664
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
1665
|
+
url: "/agent-deployments/{id}",
|
|
1666
|
+
...options
|
|
1667
|
+
});
|
|
1658
1668
|
var getEmailOutboundEmailsWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
1659
1669
|
security: [{ scheme: "bearer", type: "http" }],
|
|
1660
1670
|
url: "/email/outbound-emails/workspace/{workspace_id}",
|
|
@@ -1687,6 +1697,11 @@ var postCatalogProductVariants = (options) => (options.client ?? client).post({
|
|
|
1687
1697
|
...options.headers
|
|
1688
1698
|
}
|
|
1689
1699
|
});
|
|
1700
|
+
var getComplianceRequirementCompletionsById = (options) => (options.client ?? client).get({
|
|
1701
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
1702
|
+
url: "/compliance-requirement-completions/{id}",
|
|
1703
|
+
...options
|
|
1704
|
+
});
|
|
1690
1705
|
var getSocialAccountsWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
1691
1706
|
security: [{ scheme: "bearer", type: "http" }],
|
|
1692
1707
|
url: "/social/accounts/workspace/{workspace_id}",
|
|
@@ -1711,6 +1726,20 @@ var getAgentVersionsById = (options) => (options.client ?? client).get({
|
|
|
1711
1726
|
url: "/agent-versions/{id}",
|
|
1712
1727
|
...options
|
|
1713
1728
|
});
|
|
1729
|
+
var getRiskAssessments = (options) => (options.client ?? client).get({
|
|
1730
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
1731
|
+
url: "/risk-assessments",
|
|
1732
|
+
...options
|
|
1733
|
+
});
|
|
1734
|
+
var postRiskAssessments = (options) => (options.client ?? client).post({
|
|
1735
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
1736
|
+
url: "/risk-assessments",
|
|
1737
|
+
...options,
|
|
1738
|
+
headers: {
|
|
1739
|
+
"Content-Type": "application/vnd.api+json",
|
|
1740
|
+
...options.headers
|
|
1741
|
+
}
|
|
1742
|
+
});
|
|
1714
1743
|
var postCatalogTaxonomyNodes = (options) => (options.client ?? client).post({
|
|
1715
1744
|
security: [{ scheme: "bearer", type: "http" }],
|
|
1716
1745
|
url: "/catalog/taxonomy-nodes",
|
|
@@ -1989,6 +2018,11 @@ var getDocumentsStats = (options) => (options.client ?? client).get({
|
|
|
1989
2018
|
url: "/documents/stats",
|
|
1990
2019
|
...options
|
|
1991
2020
|
});
|
|
2021
|
+
var getComplianceOfficerDesignationsById = (options) => (options.client ?? client).get({
|
|
2022
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2023
|
+
url: "/compliance-officer-designations/{id}",
|
|
2024
|
+
...options
|
|
2025
|
+
});
|
|
1992
2026
|
var patchExtractionDocumentsByIdDismiss = (options) => (options.client ?? client).patch({
|
|
1993
2027
|
security: [{ scheme: "bearer", type: "http" }],
|
|
1994
2028
|
url: "/extraction/documents/{id}/dismiss",
|
|
@@ -2008,6 +2042,20 @@ var getCrmExportsById = (options) => (options.client ?? client).get({
|
|
|
2008
2042
|
url: "/crm/exports/{id}",
|
|
2009
2043
|
...options
|
|
2010
2044
|
});
|
|
2045
|
+
var getBusinessAssociateAgreements = (options) => (options.client ?? client).get({
|
|
2046
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2047
|
+
url: "/business-associate-agreements",
|
|
2048
|
+
...options
|
|
2049
|
+
});
|
|
2050
|
+
var postBusinessAssociateAgreements = (options) => (options.client ?? client).post({
|
|
2051
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2052
|
+
url: "/business-associate-agreements",
|
|
2053
|
+
...options,
|
|
2054
|
+
headers: {
|
|
2055
|
+
"Content-Type": "application/vnd.api+json",
|
|
2056
|
+
...options.headers
|
|
2057
|
+
}
|
|
2058
|
+
});
|
|
2011
2059
|
var deleteClinicalPracticeResourcesById = (options) => (options.client ?? client).delete({
|
|
2012
2060
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2013
2061
|
url: "/clinical/practice-resources/{id}",
|
|
@@ -2055,6 +2103,15 @@ var patchCrmDealsById = (options) => (options.client ?? client).patch({
|
|
|
2055
2103
|
...options.headers
|
|
2056
2104
|
}
|
|
2057
2105
|
});
|
|
2106
|
+
var patchBreachNotificationArtifactsByIdSend = (options) => (options.client ?? client).patch({
|
|
2107
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2108
|
+
url: "/breach-notification-artifacts/{id}/send",
|
|
2109
|
+
...options,
|
|
2110
|
+
headers: {
|
|
2111
|
+
"Content-Type": "application/vnd.api+json",
|
|
2112
|
+
...options.headers
|
|
2113
|
+
}
|
|
2114
|
+
});
|
|
2058
2115
|
var getSupportTagsWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
2059
2116
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2060
2117
|
url: "/support/tags/workspace/{workspace_id}",
|
|
@@ -2113,20 +2170,6 @@ var postEmailMarketingCampaignsByIdAnalyze = (options) => (options.client ?? cli
|
|
|
2113
2170
|
...options.headers
|
|
2114
2171
|
}
|
|
2115
2172
|
});
|
|
2116
|
-
var postWebhookConfigsByIdTest = (options) => (options.client ?? client).post({
|
|
2117
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
2118
|
-
url: "/webhook-configs/{id}/test",
|
|
2119
|
-
...options,
|
|
2120
|
-
headers: {
|
|
2121
|
-
"Content-Type": "application/vnd.api+json",
|
|
2122
|
-
...options.headers
|
|
2123
|
-
}
|
|
2124
|
-
});
|
|
2125
|
-
var getLlmAnalyticsCosts = (options) => (options.client ?? client).get({
|
|
2126
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
2127
|
-
url: "/llm-analytics/costs",
|
|
2128
|
-
...options
|
|
2129
|
-
});
|
|
2130
2173
|
var patchUsersAuthPasswordChange = (options) => (options.client ?? client).patch({
|
|
2131
2174
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2132
2175
|
url: "/users/auth/password/change",
|
|
@@ -2196,6 +2239,15 @@ var postUsersAuthPasswordResetRequest = (options) => (options.client ?? client).
|
|
|
2196
2239
|
...options.headers
|
|
2197
2240
|
}
|
|
2198
2241
|
});
|
|
2242
|
+
var patchPolicyReviewSchedulesByIdMarkOverdue = (options) => (options.client ?? client).patch({
|
|
2243
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2244
|
+
url: "/policy-review-schedules/{id}/mark-overdue",
|
|
2245
|
+
...options,
|
|
2246
|
+
headers: {
|
|
2247
|
+
"Content-Type": "application/vnd.api+json",
|
|
2248
|
+
...options.headers
|
|
2249
|
+
}
|
|
2250
|
+
});
|
|
2199
2251
|
var getExtractionBatchesWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
2200
2252
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2201
2253
|
url: "/extraction/batches/workspace/{workspace_id}",
|
|
@@ -2252,15 +2304,6 @@ var postEmailOutboundEmailsComposeWithAi = (options) => (options.client ?? clien
|
|
|
2252
2304
|
...options.headers
|
|
2253
2305
|
}
|
|
2254
2306
|
});
|
|
2255
|
-
var postWebhookDeliveriesByIdRetry = (options) => (options.client ?? client).post({
|
|
2256
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
2257
|
-
url: "/webhook-deliveries/{id}/retry",
|
|
2258
|
-
...options,
|
|
2259
|
-
headers: {
|
|
2260
|
-
"Content-Type": "application/vnd.api+json",
|
|
2261
|
-
...options.headers
|
|
2262
|
-
}
|
|
2263
|
-
});
|
|
2264
2307
|
var patchSocialPostsByIdPublish = (options) => (options.client ?? client).patch({
|
|
2265
2308
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2266
2309
|
url: "/social/posts/{id}/publish",
|
|
@@ -2336,6 +2379,20 @@ var getUsersMeDashboard = (options) => (options.client ?? client).get({
|
|
|
2336
2379
|
url: "/users/me/dashboard",
|
|
2337
2380
|
...options
|
|
2338
2381
|
});
|
|
2382
|
+
var getBusinessAssociateAgreementsById = (options) => (options.client ?? client).get({
|
|
2383
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2384
|
+
url: "/business-associate-agreements/{id}",
|
|
2385
|
+
...options
|
|
2386
|
+
});
|
|
2387
|
+
var patchBusinessAssociateAgreementsById = (options) => (options.client ?? client).patch({
|
|
2388
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2389
|
+
url: "/business-associate-agreements/{id}",
|
|
2390
|
+
...options,
|
|
2391
|
+
headers: {
|
|
2392
|
+
"Content-Type": "application/vnd.api+json",
|
|
2393
|
+
...options.headers
|
|
2394
|
+
}
|
|
2395
|
+
});
|
|
2339
2396
|
var deleteRetentionPoliciesById = (options) => (options.client ?? client).delete({
|
|
2340
2397
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2341
2398
|
url: "/retention-policies/{id}",
|
|
@@ -2428,25 +2485,6 @@ var getMemoryDocumentSections = (options) => (options.client ?? client).get({
|
|
|
2428
2485
|
url: "/memory/document-sections",
|
|
2429
2486
|
...options
|
|
2430
2487
|
});
|
|
2431
|
-
var deleteWebhookConfigsById = (options) => (options.client ?? client).delete({
|
|
2432
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
2433
|
-
url: "/webhook-configs/{id}",
|
|
2434
|
-
...options
|
|
2435
|
-
});
|
|
2436
|
-
var getWebhookConfigsById = (options) => (options.client ?? client).get({
|
|
2437
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
2438
|
-
url: "/webhook-configs/{id}",
|
|
2439
|
-
...options
|
|
2440
|
-
});
|
|
2441
|
-
var patchWebhookConfigsById = (options) => (options.client ?? client).patch({
|
|
2442
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
2443
|
-
url: "/webhook-configs/{id}",
|
|
2444
|
-
...options,
|
|
2445
|
-
headers: {
|
|
2446
|
-
"Content-Type": "application/vnd.api+json",
|
|
2447
|
-
...options.headers
|
|
2448
|
-
}
|
|
2449
|
-
});
|
|
2450
2488
|
var postConnectorsCredentialsByIdRefresh = (options) => (options.client ?? client).post({
|
|
2451
2489
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2452
2490
|
url: "/connectors/credentials/{id}/refresh",
|
|
@@ -2475,6 +2513,15 @@ var postWorkspacesByWorkspaceIdExtractionDocumentsDismissAllTrained = (options)
|
|
|
2475
2513
|
...options.headers
|
|
2476
2514
|
}
|
|
2477
2515
|
});
|
|
2516
|
+
var patchAmendmentRequestsByIdDeny = (options) => (options.client ?? client).patch({
|
|
2517
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2518
|
+
url: "/amendment-requests/{id}/deny",
|
|
2519
|
+
...options,
|
|
2520
|
+
headers: {
|
|
2521
|
+
"Content-Type": "application/vnd.api+json",
|
|
2522
|
+
...options.headers
|
|
2523
|
+
}
|
|
2524
|
+
});
|
|
2478
2525
|
var getClinicalSessionsByIdSessionNotes = (options) => (options.client ?? client).get({
|
|
2479
2526
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2480
2527
|
url: "/clinical/sessions/{id}/session_notes",
|
|
@@ -2498,14 +2545,9 @@ var postEmailMarketingCampaigns = (options) => (options.client ?? client).post({
|
|
|
2498
2545
|
...options.headers
|
|
2499
2546
|
}
|
|
2500
2547
|
});
|
|
2501
|
-
var
|
|
2502
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
2503
|
-
url: "/configs",
|
|
2504
|
-
...options
|
|
2505
|
-
});
|
|
2506
|
-
var postConfigs = (options) => (options.client ?? client).post({
|
|
2548
|
+
var postSocialTrendingWatches = (options) => (options.client ?? client).post({
|
|
2507
2549
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2508
|
-
url: "/
|
|
2550
|
+
url: "/social/trending/watches",
|
|
2509
2551
|
...options,
|
|
2510
2552
|
headers: {
|
|
2511
2553
|
"Content-Type": "application/vnd.api+json",
|
|
@@ -2536,6 +2578,11 @@ var patchCrmCustomEntitiesById = (options) => (options.client ?? client).patch({
|
|
|
2536
2578
|
...options.headers
|
|
2537
2579
|
}
|
|
2538
2580
|
});
|
|
2581
|
+
var getAgentDeployments = (options) => (options.client ?? client).get({
|
|
2582
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2583
|
+
url: "/agent-deployments",
|
|
2584
|
+
...options
|
|
2585
|
+
});
|
|
2539
2586
|
var postAgentsByIdRestoreVersion = (options) => (options.client ?? client).post({
|
|
2540
2587
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2541
2588
|
url: "/agents/{id}/restore-version",
|
|
@@ -2545,6 +2592,20 @@ var postAgentsByIdRestoreVersion = (options) => (options.client ?? client).post(
|
|
|
2545
2592
|
...options.headers
|
|
2546
2593
|
}
|
|
2547
2594
|
});
|
|
2595
|
+
var getWorkspaceAgentConfigsById = (options) => (options.client ?? client).get({
|
|
2596
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2597
|
+
url: "/workspace-agent-configs/{id}",
|
|
2598
|
+
...options
|
|
2599
|
+
});
|
|
2600
|
+
var patchWorkspaceAgentConfigsById = (options) => (options.client ?? client).patch({
|
|
2601
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2602
|
+
url: "/workspace-agent-configs/{id}",
|
|
2603
|
+
...options,
|
|
2604
|
+
headers: {
|
|
2605
|
+
"Content-Type": "application/vnd.api+json",
|
|
2606
|
+
...options.headers
|
|
2607
|
+
}
|
|
2608
|
+
});
|
|
2548
2609
|
var patchWalletAutoTopUp = (options) => (options.client ?? client).patch({
|
|
2549
2610
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2550
2611
|
url: "/wallet/auto-top-up",
|
|
@@ -2642,6 +2703,34 @@ var postUsersAuthMagicLinkLogin = (options) => (options.client ?? client).post({
|
|
|
2642
2703
|
...options.headers
|
|
2643
2704
|
}
|
|
2644
2705
|
});
|
|
2706
|
+
var getDataTransferRecords = (options) => (options.client ?? client).get({
|
|
2707
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2708
|
+
url: "/data-transfer-records",
|
|
2709
|
+
...options
|
|
2710
|
+
});
|
|
2711
|
+
var postDataTransferRecords = (options) => (options.client ?? client).post({
|
|
2712
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2713
|
+
url: "/data-transfer-records",
|
|
2714
|
+
...options,
|
|
2715
|
+
headers: {
|
|
2716
|
+
"Content-Type": "application/vnd.api+json",
|
|
2717
|
+
...options.headers
|
|
2718
|
+
}
|
|
2719
|
+
});
|
|
2720
|
+
var getComplianceOfficerDesignations = (options) => (options.client ?? client).get({
|
|
2721
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2722
|
+
url: "/compliance-officer-designations",
|
|
2723
|
+
...options
|
|
2724
|
+
});
|
|
2725
|
+
var postComplianceOfficerDesignations = (options) => (options.client ?? client).post({
|
|
2726
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2727
|
+
url: "/compliance-officer-designations",
|
|
2728
|
+
...options,
|
|
2729
|
+
headers: {
|
|
2730
|
+
"Content-Type": "application/vnd.api+json",
|
|
2731
|
+
...options.headers
|
|
2732
|
+
}
|
|
2733
|
+
});
|
|
2645
2734
|
var patchSupportTicketsByIdMerge = (options) => (options.client ?? client).patch({
|
|
2646
2735
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2647
2736
|
url: "/support/tickets/{id}/merge",
|
|
@@ -2736,6 +2825,20 @@ var patchClinicalSessionsById = (options) => (options.client ?? client).patch({
|
|
|
2736
2825
|
...options.headers
|
|
2737
2826
|
}
|
|
2738
2827
|
});
|
|
2828
|
+
var getEphiAssetsById = (options) => (options.client ?? client).get({
|
|
2829
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2830
|
+
url: "/ephi-assets/{id}",
|
|
2831
|
+
...options
|
|
2832
|
+
});
|
|
2833
|
+
var patchEphiAssetsById = (options) => (options.client ?? client).patch({
|
|
2834
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2835
|
+
url: "/ephi-assets/{id}",
|
|
2836
|
+
...options,
|
|
2837
|
+
headers: {
|
|
2838
|
+
"Content-Type": "application/vnd.api+json",
|
|
2839
|
+
...options.headers
|
|
2840
|
+
}
|
|
2841
|
+
});
|
|
2739
2842
|
var getAgentsUsage = (options) => (options.client ?? client).get({
|
|
2740
2843
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2741
2844
|
url: "/agents/usage",
|
|
@@ -2778,6 +2881,11 @@ var patchSchedulingCalendarSyncsById = (options) => (options.client ?? client).p
|
|
|
2778
2881
|
...options.headers
|
|
2779
2882
|
}
|
|
2780
2883
|
});
|
|
2884
|
+
var getAmendmentRequestsById = (options) => (options.client ?? client).get({
|
|
2885
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2886
|
+
url: "/amendment-requests/{id}",
|
|
2887
|
+
...options
|
|
2888
|
+
});
|
|
2781
2889
|
var getEmailInboundReceivedAddressByInboundAddressId = (options) => (options.client ?? client).get({
|
|
2782
2890
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2783
2891
|
url: "/email/inbound/received/address/{inbound_address_id}",
|
|
@@ -2858,6 +2966,20 @@ var getEmailRecipientsEmailByOutboundEmailId = (options) => (options.client ?? c
|
|
|
2858
2966
|
url: "/email/recipients/email/{outbound_email_id}",
|
|
2859
2967
|
...options
|
|
2860
2968
|
});
|
|
2969
|
+
var getEphiDataFlowsById = (options) => (options.client ?? client).get({
|
|
2970
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2971
|
+
url: "/ephi-data-flows/{id}",
|
|
2972
|
+
...options
|
|
2973
|
+
});
|
|
2974
|
+
var patchEphiDataFlowsById = (options) => (options.client ?? client).patch({
|
|
2975
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
2976
|
+
url: "/ephi-data-flows/{id}",
|
|
2977
|
+
...options,
|
|
2978
|
+
headers: {
|
|
2979
|
+
"Content-Type": "application/vnd.api+json",
|
|
2980
|
+
...options.headers
|
|
2981
|
+
}
|
|
2982
|
+
});
|
|
2861
2983
|
var getMemorySectionDocuments = (options) => (options.client ?? client).get({
|
|
2862
2984
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2863
2985
|
url: "/memory/section-documents",
|
|
@@ -2881,6 +3003,15 @@ var patchSocialCampaignsByIdCancel = (options) => (options.client ?? client).pat
|
|
|
2881
3003
|
...options.headers
|
|
2882
3004
|
}
|
|
2883
3005
|
});
|
|
3006
|
+
var patchAmendmentRequestsByIdReview = (options) => (options.client ?? client).patch({
|
|
3007
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3008
|
+
url: "/amendment-requests/{id}/review",
|
|
3009
|
+
...options,
|
|
3010
|
+
headers: {
|
|
3011
|
+
"Content-Type": "application/vnd.api+json",
|
|
3012
|
+
...options.headers
|
|
3013
|
+
}
|
|
3014
|
+
});
|
|
2884
3015
|
var deleteClinicalPracticeToolsById = (options) => (options.client ?? client).delete({
|
|
2885
3016
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2886
3017
|
url: "/clinical/practice-tools/{id}",
|
|
@@ -2905,6 +3036,11 @@ var getFeatureUsagesById = (options) => (options.client ?? client).get({
|
|
|
2905
3036
|
url: "/feature-usages/{id}",
|
|
2906
3037
|
...options
|
|
2907
3038
|
});
|
|
3039
|
+
var getSocialTrendingHistoryWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
3040
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3041
|
+
url: "/social/trending/history/workspace/{workspace_id}",
|
|
3042
|
+
...options
|
|
3043
|
+
});
|
|
2908
3044
|
var patchSchedulingCalendarSyncsByIdPause = (options) => (options.client ?? client).patch({
|
|
2909
3045
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2910
3046
|
url: "/scheduling/calendar-syncs/{id}/pause",
|
|
@@ -2914,11 +3050,6 @@ var patchSchedulingCalendarSyncsByIdPause = (options) => (options.client ?? clie
|
|
|
2914
3050
|
...options.headers
|
|
2915
3051
|
}
|
|
2916
3052
|
});
|
|
2917
|
-
var getWebhookConfigsStats = (options) => (options.client ?? client).get({
|
|
2918
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
2919
|
-
url: "/webhook-configs/stats",
|
|
2920
|
-
...options
|
|
2921
|
-
});
|
|
2922
3053
|
var getEmailMarketingCampaignsWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
2923
3054
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2924
3055
|
url: "/email-marketing/campaigns/workspace/{workspace_id}",
|
|
@@ -2985,6 +3116,15 @@ var getSocialMetricsAccountBySocialAccountId = (options) => (options.client ?? c
|
|
|
2985
3116
|
url: "/social/metrics/account/{social_account_id}",
|
|
2986
3117
|
...options
|
|
2987
3118
|
});
|
|
3119
|
+
var patchRiskAssessmentsByIdStatus = (options) => (options.client ?? client).patch({
|
|
3120
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3121
|
+
url: "/risk-assessments/{id}/status",
|
|
3122
|
+
...options,
|
|
3123
|
+
headers: {
|
|
3124
|
+
"Content-Type": "application/vnd.api+json",
|
|
3125
|
+
...options.headers
|
|
3126
|
+
}
|
|
3127
|
+
});
|
|
2988
3128
|
var getPermissionsMeta = (options) => (options.client ?? client).get({
|
|
2989
3129
|
security: [{ scheme: "bearer", type: "http" }],
|
|
2990
3130
|
url: "/permissions/meta",
|
|
@@ -3043,6 +3183,15 @@ var getEmailRecipientsById = (options) => (options.client ?? client).get({
|
|
|
3043
3183
|
url: "/email/recipients/{id}",
|
|
3044
3184
|
...options
|
|
3045
3185
|
});
|
|
3186
|
+
var patchPolicyReviewSchedulesByIdCompleteReview = (options) => (options.client ?? client).patch({
|
|
3187
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3188
|
+
url: "/policy-review-schedules/{id}/complete-review",
|
|
3189
|
+
...options,
|
|
3190
|
+
headers: {
|
|
3191
|
+
"Content-Type": "application/vnd.api+json",
|
|
3192
|
+
...options.headers
|
|
3193
|
+
}
|
|
3194
|
+
});
|
|
3046
3195
|
var patchAgentsByIdSchemaVersionsByVersionId = (options) => (options.client ?? client).patch({
|
|
3047
3196
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3048
3197
|
url: "/agents/{id}/schema-versions/{version_id}",
|
|
@@ -3071,6 +3220,25 @@ var patchCatalogTaxonomiesById = (options) => (options.client ?? client).patch({
|
|
|
3071
3220
|
...options.headers
|
|
3072
3221
|
}
|
|
3073
3222
|
});
|
|
3223
|
+
var deleteSocialTrendingWatchesById = (options) => (options.client ?? client).delete({
|
|
3224
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3225
|
+
url: "/social/trending/watches/{id}",
|
|
3226
|
+
...options
|
|
3227
|
+
});
|
|
3228
|
+
var getSocialTrendingWatchesById = (options) => (options.client ?? client).get({
|
|
3229
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3230
|
+
url: "/social/trending/watches/{id}",
|
|
3231
|
+
...options
|
|
3232
|
+
});
|
|
3233
|
+
var patchSocialTrendingWatchesById = (options) => (options.client ?? client).patch({
|
|
3234
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3235
|
+
url: "/social/trending/watches/{id}",
|
|
3236
|
+
...options,
|
|
3237
|
+
headers: {
|
|
3238
|
+
"Content-Type": "application/vnd.api+json",
|
|
3239
|
+
...options.headers
|
|
3240
|
+
}
|
|
3241
|
+
});
|
|
3074
3242
|
var getSocialMetricsCampaignBySocialCampaignId = (options) => (options.client ?? client).get({
|
|
3075
3243
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3076
3244
|
url: "/social/metrics/campaign/{social_campaign_id}",
|
|
@@ -3193,6 +3361,15 @@ var postThreadsByIdMessages = (options) => (options.client ?? client).post({
|
|
|
3193
3361
|
...options.headers
|
|
3194
3362
|
}
|
|
3195
3363
|
});
|
|
3364
|
+
var patchBusinessAssociateAgreementsByIdTerminate = (options) => (options.client ?? client).patch({
|
|
3365
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3366
|
+
url: "/business-associate-agreements/{id}/terminate",
|
|
3367
|
+
...options,
|
|
3368
|
+
headers: {
|
|
3369
|
+
"Content-Type": "application/vnd.api+json",
|
|
3370
|
+
...options.headers
|
|
3371
|
+
}
|
|
3372
|
+
});
|
|
3196
3373
|
var postConnectorsByIdEdamamRecipesGet = (options) => (options.client ?? client).post({
|
|
3197
3374
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3198
3375
|
url: "/connectors/{id}/edamam/recipes/get",
|
|
@@ -3239,11 +3416,6 @@ var getCreditPackagesById = (options) => (options.client ?? client).get({
|
|
|
3239
3416
|
url: "/credit-packages/{id}",
|
|
3240
3417
|
...options
|
|
3241
3418
|
});
|
|
3242
|
-
var getWebhookDeliveries = (options) => (options.client ?? client).get({
|
|
3243
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
3244
|
-
url: "/webhook-deliveries",
|
|
3245
|
-
...options
|
|
3246
|
-
});
|
|
3247
3419
|
var getAgentVersions = (options) => (options.client ?? client).get({
|
|
3248
3420
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3249
3421
|
url: "/agent-versions",
|
|
@@ -3357,11 +3529,6 @@ var patchEmailInboundAddressesByIdRotateToken = (options) => (options.client ??
|
|
|
3357
3529
|
...options.headers
|
|
3358
3530
|
}
|
|
3359
3531
|
});
|
|
3360
|
-
var getLlmAnalyticsSummary = (options) => (options.client ?? client).get({
|
|
3361
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
3362
|
-
url: "/llm-analytics/summary",
|
|
3363
|
-
...options
|
|
3364
|
-
});
|
|
3365
3532
|
var deleteSchedulingParticipantsById = (options) => (options.client ?? client).delete({
|
|
3366
3533
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3367
3534
|
url: "/scheduling/participants/{id}",
|
|
@@ -3419,16 +3586,6 @@ var getSchedulingBookingsById = (options) => (options.client ?? client).get({
|
|
|
3419
3586
|
url: "/scheduling/bookings/{id}",
|
|
3420
3587
|
...options
|
|
3421
3588
|
});
|
|
3422
|
-
var getLlmAnalytics = (options) => (options.client ?? client).get({
|
|
3423
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
3424
|
-
url: "/llm-analytics",
|
|
3425
|
-
...options
|
|
3426
|
-
});
|
|
3427
|
-
var getWebhookDeliveriesById = (options) => (options.client ?? client).get({
|
|
3428
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
3429
|
-
url: "/webhook-deliveries/{id}",
|
|
3430
|
-
...options
|
|
3431
|
-
});
|
|
3432
3589
|
var patchVoiceSessionsByIdStop = (options) => (options.client ?? client).patch({
|
|
3433
3590
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3434
3591
|
url: "/voice/sessions/{id}/stop",
|
|
@@ -3475,11 +3632,6 @@ var postSchedulingParticipants = (options) => (options.client ?? client).post({
|
|
|
3475
3632
|
...options.headers
|
|
3476
3633
|
}
|
|
3477
3634
|
});
|
|
3478
|
-
var getWebhookDeliveriesStats = (options) => (options.client ?? client).get({
|
|
3479
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
3480
|
-
url: "/webhook-deliveries/stats",
|
|
3481
|
-
...options
|
|
3482
|
-
});
|
|
3483
3635
|
var getNotificationLogsById = (options) => (options.client ?? client).get({
|
|
3484
3636
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3485
3637
|
url: "/notification-logs/{id}",
|
|
@@ -3546,6 +3698,16 @@ var getCrawlerJobsById = (options) => (options.client ?? client).get({
|
|
|
3546
3698
|
url: "/crawler/jobs/{id}",
|
|
3547
3699
|
...options
|
|
3548
3700
|
});
|
|
3701
|
+
var deleteSocialTrendingHistoryById = (options) => (options.client ?? client).delete({
|
|
3702
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3703
|
+
url: "/social/trending/history/{id}",
|
|
3704
|
+
...options
|
|
3705
|
+
});
|
|
3706
|
+
var getSocialTrendingHistoryById = (options) => (options.client ?? client).get({
|
|
3707
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3708
|
+
url: "/social/trending/history/{id}",
|
|
3709
|
+
...options
|
|
3710
|
+
});
|
|
3549
3711
|
var getConsentRecordsById = (options) => (options.client ?? client).get({
|
|
3550
3712
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3551
3713
|
url: "/consent-records/{id}",
|
|
@@ -3605,6 +3767,20 @@ var getVoiceSessionsById = (options) => (options.client ?? client).get({
|
|
|
3605
3767
|
url: "/voice/sessions/{id}",
|
|
3606
3768
|
...options
|
|
3607
3769
|
});
|
|
3770
|
+
var getEphiAssets = (options) => (options.client ?? client).get({
|
|
3771
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3772
|
+
url: "/ephi-assets",
|
|
3773
|
+
...options
|
|
3774
|
+
});
|
|
3775
|
+
var postEphiAssets = (options) => (options.client ?? client).post({
|
|
3776
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
3777
|
+
url: "/ephi-assets",
|
|
3778
|
+
...options,
|
|
3779
|
+
headers: {
|
|
3780
|
+
"Content-Type": "application/vnd.api+json",
|
|
3781
|
+
...options.headers
|
|
3782
|
+
}
|
|
3783
|
+
});
|
|
3608
3784
|
var getVoiceSessions = (options) => (options.client ?? client).get({
|
|
3609
3785
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3610
3786
|
url: "/voice/sessions",
|
|
@@ -3868,6 +4044,15 @@ var postCrawlerJobs = (options) => (options.client ?? client).post({
|
|
|
3868
4044
|
...options.headers
|
|
3869
4045
|
}
|
|
3870
4046
|
});
|
|
4047
|
+
var patchWalletPaymentRetry = (options) => (options.client ?? client).patch({
|
|
4048
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4049
|
+
url: "/wallet/payment/retry",
|
|
4050
|
+
...options,
|
|
4051
|
+
headers: {
|
|
4052
|
+
"Content-Type": "application/vnd.api+json",
|
|
4053
|
+
...options.headers
|
|
4054
|
+
}
|
|
4055
|
+
});
|
|
3871
4056
|
var deleteCrmCompaniesById = (options) => (options.client ?? client).delete({
|
|
3872
4057
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3873
4058
|
url: "/crm/companies/{id}",
|
|
@@ -3901,6 +4086,11 @@ var patchVoiceSessionsByIdFinalize = (options) => (options.client ?? client).pat
|
|
|
3901
4086
|
...options.headers
|
|
3902
4087
|
}
|
|
3903
4088
|
});
|
|
4089
|
+
var getWalletFeatures = (options) => (options.client ?? client).get({
|
|
4090
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4091
|
+
url: "/wallet/features",
|
|
4092
|
+
...options
|
|
4093
|
+
});
|
|
3904
4094
|
var getRoles = (options) => (options.client ?? client).get({
|
|
3905
4095
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3906
4096
|
url: "/roles",
|
|
@@ -3915,6 +4105,20 @@ var postRoles = (options) => (options.client ?? client).post({
|
|
|
3915
4105
|
...options.headers
|
|
3916
4106
|
}
|
|
3917
4107
|
});
|
|
4108
|
+
var getComplianceRequirementCompletions = (options) => (options.client ?? client).get({
|
|
4109
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4110
|
+
url: "/compliance-requirement-completions",
|
|
4111
|
+
...options
|
|
4112
|
+
});
|
|
4113
|
+
var postComplianceRequirementCompletions = (options) => (options.client ?? client).post({
|
|
4114
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4115
|
+
url: "/compliance-requirement-completions",
|
|
4116
|
+
...options,
|
|
4117
|
+
headers: {
|
|
4118
|
+
"Content-Type": "application/vnd.api+json",
|
|
4119
|
+
...options.headers
|
|
4120
|
+
}
|
|
4121
|
+
});
|
|
3918
4122
|
var deleteProcessingActivitiesById = (options) => (options.client ?? client).delete({
|
|
3919
4123
|
security: [{ scheme: "bearer", type: "http" }],
|
|
3920
4124
|
url: "/processing-activities/{id}",
|
|
@@ -4209,16 +4413,7 @@ var postCrawlerSchedules = (options) => (options.client ?? client).post({
|
|
|
4209
4413
|
...options.headers
|
|
4210
4414
|
}
|
|
4211
4415
|
});
|
|
4212
|
-
var
|
|
4213
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
4214
|
-
url: "/webhook-configs/bulk-disable",
|
|
4215
|
-
...options,
|
|
4216
|
-
headers: {
|
|
4217
|
-
"Content-Type": "application/vnd.api+json",
|
|
4218
|
-
...options.headers
|
|
4219
|
-
}
|
|
4220
|
-
});
|
|
4221
|
-
var getEmailTrackingEventsWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
4416
|
+
var getEmailTrackingEventsWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
4222
4417
|
security: [{ scheme: "bearer", type: "http" }],
|
|
4223
4418
|
url: "/email/tracking-events/workspace/{workspace_id}",
|
|
4224
4419
|
...options
|
|
@@ -4261,6 +4456,15 @@ var postFieldTemplates = (options) => (options.client ?? client).post({
|
|
|
4261
4456
|
...options.headers
|
|
4262
4457
|
}
|
|
4263
4458
|
});
|
|
4459
|
+
var patchSocialTrendingWatchesByIdMarkTriggered = (options) => (options.client ?? client).patch({
|
|
4460
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4461
|
+
url: "/social/trending/watches/{id}/mark-triggered",
|
|
4462
|
+
...options,
|
|
4463
|
+
headers: {
|
|
4464
|
+
"Content-Type": "application/vnd.api+json",
|
|
4465
|
+
...options.headers
|
|
4466
|
+
}
|
|
4467
|
+
});
|
|
4264
4468
|
var postAgentsByIdSchemaVersionsByVersionIdActivate = (options) => (options.client ?? client).post({
|
|
4265
4469
|
security: [{ scheme: "bearer", type: "http" }],
|
|
4266
4470
|
url: "/agents/{id}/schema-versions/{version_id}/activate",
|
|
@@ -4397,11 +4601,6 @@ var postConnectorsFullscriptCheckPatient = (options) => (options.client ?? clien
|
|
|
4397
4601
|
...options.headers
|
|
4398
4602
|
}
|
|
4399
4603
|
});
|
|
4400
|
-
var getLlmAnalyticsWorkspace = (options) => (options.client ?? client).get({
|
|
4401
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
4402
|
-
url: "/llm-analytics/workspace",
|
|
4403
|
-
...options
|
|
4404
|
-
});
|
|
4405
4604
|
var getSchedulingEventTypes = (options) => (options.client ?? client).get({
|
|
4406
4605
|
security: [{ scheme: "bearer", type: "http" }],
|
|
4407
4606
|
url: "/scheduling/event-types",
|
|
@@ -4416,6 +4615,20 @@ var postSchedulingEventTypes = (options) => (options.client ?? client).post({
|
|
|
4416
4615
|
...options.headers
|
|
4417
4616
|
}
|
|
4418
4617
|
});
|
|
4618
|
+
var getAccessLogsById = (options) => (options.client ?? client).get({
|
|
4619
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4620
|
+
url: "/access-logs/{id}",
|
|
4621
|
+
...options
|
|
4622
|
+
});
|
|
4623
|
+
var postComplianceDocumentTemplatesClone = (options) => (options.client ?? client).post({
|
|
4624
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4625
|
+
url: "/compliance-document-templates/clone",
|
|
4626
|
+
...options,
|
|
4627
|
+
headers: {
|
|
4628
|
+
"Content-Type": "application/vnd.api+json",
|
|
4629
|
+
...options.headers
|
|
4630
|
+
}
|
|
4631
|
+
});
|
|
4419
4632
|
var deleteClinicalClientSupplementsById = (options) => (options.client ?? client).delete({
|
|
4420
4633
|
security: [{ scheme: "bearer", type: "http" }],
|
|
4421
4634
|
url: "/clinical/client-supplements/{id}",
|
|
@@ -4511,15 +4724,6 @@ var patchFeatureDefinitionsById = (options) => (options.client ?? client).patch(
|
|
|
4511
4724
|
...options.headers
|
|
4512
4725
|
}
|
|
4513
4726
|
});
|
|
4514
|
-
var patchWebhookConfigsByIdRotateSecret = (options) => (options.client ?? client).patch({
|
|
4515
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
4516
|
-
url: "/webhook-configs/{id}/rotate-secret",
|
|
4517
|
-
...options,
|
|
4518
|
-
headers: {
|
|
4519
|
-
"Content-Type": "application/vnd.api+json",
|
|
4520
|
-
...options.headers
|
|
4521
|
-
}
|
|
4522
|
-
});
|
|
4523
4727
|
var patchWalletAddons = (options) => (options.client ?? client).patch({
|
|
4524
4728
|
security: [{ scheme: "bearer", type: "http" }],
|
|
4525
4729
|
url: "/wallet/addons",
|
|
@@ -4585,6 +4789,26 @@ var postTrainingExamplesSearch = (options) => (options.client ?? client).post({
|
|
|
4585
4789
|
...options.headers
|
|
4586
4790
|
}
|
|
4587
4791
|
});
|
|
4792
|
+
var deleteCdeScopeReportsById = (options) => (options.client ?? client).delete({
|
|
4793
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4794
|
+
url: "/cde-scope-reports/{id}",
|
|
4795
|
+
...options
|
|
4796
|
+
});
|
|
4797
|
+
var getCdeScopeReportsById = (options) => (options.client ?? client).get({
|
|
4798
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4799
|
+
url: "/cde-scope-reports/{id}",
|
|
4800
|
+
...options
|
|
4801
|
+
});
|
|
4802
|
+
var deleteRiskAssessmentsById = (options) => (options.client ?? client).delete({
|
|
4803
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4804
|
+
url: "/risk-assessments/{id}",
|
|
4805
|
+
...options
|
|
4806
|
+
});
|
|
4807
|
+
var getRiskAssessmentsById = (options) => (options.client ?? client).get({
|
|
4808
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
4809
|
+
url: "/risk-assessments/{id}",
|
|
4810
|
+
...options
|
|
4811
|
+
});
|
|
4588
4812
|
var getUserProfiles = (options) => (options.client ?? client).get({
|
|
4589
4813
|
security: [{ scheme: "bearer", type: "http" }],
|
|
4590
4814
|
url: "/user-profiles",
|
|
@@ -4860,11 +5084,44 @@ var getSocialPostsCampaignBySocialCampaignId = (options) => (options.client ?? c
|
|
|
4860
5084
|
url: "/social/posts/campaign/{social_campaign_id}",
|
|
4861
5085
|
...options
|
|
4862
5086
|
});
|
|
5087
|
+
var deleteDataTransferRecordsById = (options) => (options.client ?? client).delete({
|
|
5088
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5089
|
+
url: "/data-transfer-records/{id}",
|
|
5090
|
+
...options
|
|
5091
|
+
});
|
|
5092
|
+
var getDataTransferRecordsById = (options) => (options.client ?? client).get({
|
|
5093
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5094
|
+
url: "/data-transfer-records/{id}",
|
|
5095
|
+
...options
|
|
5096
|
+
});
|
|
5097
|
+
var patchAmendmentRequestsByIdApply = (options) => (options.client ?? client).patch({
|
|
5098
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5099
|
+
url: "/amendment-requests/{id}/apply",
|
|
5100
|
+
...options,
|
|
5101
|
+
headers: {
|
|
5102
|
+
"Content-Type": "application/vnd.api+json",
|
|
5103
|
+
...options.headers
|
|
5104
|
+
}
|
|
5105
|
+
});
|
|
5106
|
+
var getSocialTrendingItemsSnapshotBySnapshotId = (options) => (options.client ?? client).get({
|
|
5107
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5108
|
+
url: "/social/trending/items/snapshot/{snapshot_id}",
|
|
5109
|
+
...options
|
|
5110
|
+
});
|
|
4863
5111
|
var getTransactions = (options) => (options.client ?? client).get({
|
|
4864
5112
|
security: [{ scheme: "bearer", type: "http" }],
|
|
4865
5113
|
url: "/transactions",
|
|
4866
5114
|
...options
|
|
4867
5115
|
});
|
|
5116
|
+
var postSocialTrendingHistory = (options) => (options.client ?? client).post({
|
|
5117
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5118
|
+
url: "/social/trending/history",
|
|
5119
|
+
...options,
|
|
5120
|
+
headers: {
|
|
5121
|
+
"Content-Type": "application/vnd.api+json",
|
|
5122
|
+
...options.headers
|
|
5123
|
+
}
|
|
5124
|
+
});
|
|
4868
5125
|
var getThreadsSearch = (options) => (options.client ?? client).get({
|
|
4869
5126
|
security: [{ scheme: "bearer", type: "http" }],
|
|
4870
5127
|
url: "/threads/search",
|
|
@@ -4948,24 +5205,6 @@ var patchCatalogProductsById = (options) => (options.client ?? client).patch({
|
|
|
4948
5205
|
...options.headers
|
|
4949
5206
|
}
|
|
4950
5207
|
});
|
|
4951
|
-
var postWebhookConfigsBulkEnable = (options) => (options.client ?? client).post({
|
|
4952
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
4953
|
-
url: "/webhook-configs/bulk-enable",
|
|
4954
|
-
...options,
|
|
4955
|
-
headers: {
|
|
4956
|
-
"Content-Type": "application/vnd.api+json",
|
|
4957
|
-
...options.headers
|
|
4958
|
-
}
|
|
4959
|
-
});
|
|
4960
|
-
var postWebhookConfigsByIdReplay = (options) => (options.client ?? client).post({
|
|
4961
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
4962
|
-
url: "/webhook-configs/{id}/replay",
|
|
4963
|
-
...options,
|
|
4964
|
-
headers: {
|
|
4965
|
-
"Content-Type": "application/vnd.api+json",
|
|
4966
|
-
...options.headers
|
|
4967
|
-
}
|
|
4968
|
-
});
|
|
4969
5208
|
var deleteCatalogProductVariantsById = (options) => (options.client ?? client).delete({
|
|
4970
5209
|
security: [{ scheme: "bearer", type: "http" }],
|
|
4971
5210
|
url: "/catalog/product-variants/{id}",
|
|
@@ -4994,6 +5233,20 @@ var patchBreachIncidentsByIdStatus = (options) => (options.client ?? client).pat
|
|
|
4994
5233
|
...options.headers
|
|
4995
5234
|
}
|
|
4996
5235
|
});
|
|
5236
|
+
var getBreachNotificationArtifactsById = (options) => (options.client ?? client).get({
|
|
5237
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5238
|
+
url: "/breach-notification-artifacts/{id}",
|
|
5239
|
+
...options
|
|
5240
|
+
});
|
|
5241
|
+
var patchBreachNotificationArtifactsById = (options) => (options.client ?? client).patch({
|
|
5242
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5243
|
+
url: "/breach-notification-artifacts/{id}",
|
|
5244
|
+
...options,
|
|
5245
|
+
headers: {
|
|
5246
|
+
"Content-Type": "application/vnd.api+json",
|
|
5247
|
+
...options.headers
|
|
5248
|
+
}
|
|
5249
|
+
});
|
|
4997
5250
|
var patchSupportTicketsByIdClose = (options) => (options.client ?? client).patch({
|
|
4998
5251
|
security: [{ scheme: "bearer", type: "http" }],
|
|
4999
5252
|
url: "/support/tickets/{id}/close",
|
|
@@ -5017,6 +5270,20 @@ var postClinicalClientGoals = (options) => (options.client ?? client).post({
|
|
|
5017
5270
|
...options.headers
|
|
5018
5271
|
}
|
|
5019
5272
|
});
|
|
5273
|
+
var getBreachNotificationArtifacts = (options) => (options.client ?? client).get({
|
|
5274
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5275
|
+
url: "/breach-notification-artifacts",
|
|
5276
|
+
...options
|
|
5277
|
+
});
|
|
5278
|
+
var postBreachNotificationArtifacts = (options) => (options.client ?? client).post({
|
|
5279
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5280
|
+
url: "/breach-notification-artifacts",
|
|
5281
|
+
...options,
|
|
5282
|
+
headers: {
|
|
5283
|
+
"Content-Type": "application/vnd.api+json",
|
|
5284
|
+
...options.headers
|
|
5285
|
+
}
|
|
5286
|
+
});
|
|
5020
5287
|
var getWalletSeats = (options) => (options.client ?? client).get({
|
|
5021
5288
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5022
5289
|
url: "/wallet/seats",
|
|
@@ -5050,15 +5317,6 @@ var patchEmailOutboundEmailsByIdCancelSchedule = (options) => (options.client ??
|
|
|
5050
5317
|
...options.headers
|
|
5051
5318
|
}
|
|
5052
5319
|
});
|
|
5053
|
-
var postWebhookDeliveriesBulkRetry = (options) => (options.client ?? client).post({
|
|
5054
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
5055
|
-
url: "/webhook-deliveries/bulk-retry",
|
|
5056
|
-
...options,
|
|
5057
|
-
headers: {
|
|
5058
|
-
"Content-Type": "application/vnd.api+json",
|
|
5059
|
-
...options.headers
|
|
5060
|
-
}
|
|
5061
|
-
});
|
|
5062
5320
|
var getLegalDocumentsByLocale = (options) => (options.client ?? client).get({
|
|
5063
5321
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5064
5322
|
url: "/legal-documents/by-locale",
|
|
@@ -5269,6 +5527,20 @@ var getScanResultsById = (options) => (options.client ?? client).get({
|
|
|
5269
5527
|
url: "/scan-results/{id}",
|
|
5270
5528
|
...options
|
|
5271
5529
|
});
|
|
5530
|
+
var getPolicyReviewSchedules = (options) => (options.client ?? client).get({
|
|
5531
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5532
|
+
url: "/policy-review-schedules",
|
|
5533
|
+
...options
|
|
5534
|
+
});
|
|
5535
|
+
var postPolicyReviewSchedules = (options) => (options.client ?? client).post({
|
|
5536
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5537
|
+
url: "/policy-review-schedules",
|
|
5538
|
+
...options,
|
|
5539
|
+
headers: {
|
|
5540
|
+
"Content-Type": "application/vnd.api+json",
|
|
5541
|
+
...options.headers
|
|
5542
|
+
}
|
|
5543
|
+
});
|
|
5272
5544
|
var getFeatureDefinitions = (options) => (options.client ?? client).get({
|
|
5273
5545
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5274
5546
|
url: "/feature-definitions",
|
|
@@ -5306,6 +5578,15 @@ var postClinicalClientSupplements = (options) => (options.client ?? client).post
|
|
|
5306
5578
|
...options.headers
|
|
5307
5579
|
}
|
|
5308
5580
|
});
|
|
5581
|
+
var patchAmendmentRequestsByIdApprove = (options) => (options.client ?? client).patch({
|
|
5582
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5583
|
+
url: "/amendment-requests/{id}/approve",
|
|
5584
|
+
...options,
|
|
5585
|
+
headers: {
|
|
5586
|
+
"Content-Type": "application/vnd.api+json",
|
|
5587
|
+
...options.headers
|
|
5588
|
+
}
|
|
5589
|
+
});
|
|
5309
5590
|
var postUsersAuthConfirm = (options) => (options.client ?? client).post({
|
|
5310
5591
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5311
5592
|
url: "/users/auth/confirm",
|
|
@@ -5366,6 +5647,15 @@ var patchConnectorsById = (options) => (options.client ?? client).patch({
|
|
|
5366
5647
|
...options.headers
|
|
5367
5648
|
}
|
|
5368
5649
|
});
|
|
5650
|
+
var patchWalletPlanCancel = (options) => (options.client ?? client).patch({
|
|
5651
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5652
|
+
url: "/wallet/plan/cancel",
|
|
5653
|
+
...options,
|
|
5654
|
+
headers: {
|
|
5655
|
+
"Content-Type": "application/vnd.api+json",
|
|
5656
|
+
...options.headers
|
|
5657
|
+
}
|
|
5658
|
+
});
|
|
5369
5659
|
var getTenantsByTenantIdDocumentStats = (options) => (options.client ?? client).get({
|
|
5370
5660
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5371
5661
|
url: "/tenants/{tenant_id}/document_stats",
|
|
@@ -5415,6 +5705,11 @@ var getFieldTemplatesById = (options) => (options.client ?? client).get({
|
|
|
5415
5705
|
url: "/field-templates/{id}",
|
|
5416
5706
|
...options
|
|
5417
5707
|
});
|
|
5708
|
+
var getPolicyReviewSchedulesById = (options) => (options.client ?? client).get({
|
|
5709
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5710
|
+
url: "/policy-review-schedules/{id}",
|
|
5711
|
+
...options
|
|
5712
|
+
});
|
|
5418
5713
|
var postTenantsOrg = (options) => (options.client ?? client).post({
|
|
5419
5714
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5420
5715
|
url: "/tenants/org",
|
|
@@ -5612,6 +5907,20 @@ var postCrmActivities = (options) => (options.client ?? client).post({
|
|
|
5612
5907
|
...options.headers
|
|
5613
5908
|
}
|
|
5614
5909
|
});
|
|
5910
|
+
var getCdeScopeReports = (options) => (options.client ?? client).get({
|
|
5911
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5912
|
+
url: "/cde-scope-reports",
|
|
5913
|
+
...options
|
|
5914
|
+
});
|
|
5915
|
+
var postCdeScopeReports = (options) => (options.client ?? client).post({
|
|
5916
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5917
|
+
url: "/cde-scope-reports",
|
|
5918
|
+
...options,
|
|
5919
|
+
headers: {
|
|
5920
|
+
"Content-Type": "application/vnd.api+json",
|
|
5921
|
+
...options.headers
|
|
5922
|
+
}
|
|
5923
|
+
});
|
|
5615
5924
|
var getSchedulingEvents = (options) => (options.client ?? client).get({
|
|
5616
5925
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5617
5926
|
url: "/scheduling/events",
|
|
@@ -5649,6 +5958,20 @@ var patchSchedulingEventTypesById = (options) => (options.client ?? client).patc
|
|
|
5649
5958
|
...options.headers
|
|
5650
5959
|
}
|
|
5651
5960
|
});
|
|
5961
|
+
var getEphiDataFlows = (options) => (options.client ?? client).get({
|
|
5962
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5963
|
+
url: "/ephi-data-flows",
|
|
5964
|
+
...options
|
|
5965
|
+
});
|
|
5966
|
+
var postEphiDataFlows = (options) => (options.client ?? client).post({
|
|
5967
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
5968
|
+
url: "/ephi-data-flows",
|
|
5969
|
+
...options,
|
|
5970
|
+
headers: {
|
|
5971
|
+
"Content-Type": "application/vnd.api+json",
|
|
5972
|
+
...options.headers
|
|
5973
|
+
}
|
|
5974
|
+
});
|
|
5652
5975
|
var patchSchedulingParticipantsByIdRespond = (options) => (options.client ?? client).patch({
|
|
5653
5976
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5654
5977
|
url: "/scheduling/participants/{id}/respond",
|
|
@@ -5676,6 +5999,20 @@ var patchStorageFilesByIdConfirmUpload = (options) => (options.client ?? client)
|
|
|
5676
5999
|
...options.headers
|
|
5677
6000
|
}
|
|
5678
6001
|
});
|
|
6002
|
+
var getComplianceRequirements = (options) => (options.client ?? client).get({
|
|
6003
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6004
|
+
url: "/compliance-requirements",
|
|
6005
|
+
...options
|
|
6006
|
+
});
|
|
6007
|
+
var postComplianceRequirements = (options) => (options.client ?? client).post({
|
|
6008
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6009
|
+
url: "/compliance-requirements",
|
|
6010
|
+
...options,
|
|
6011
|
+
headers: {
|
|
6012
|
+
"Content-Type": "application/vnd.api+json",
|
|
6013
|
+
...options.headers
|
|
6014
|
+
}
|
|
6015
|
+
});
|
|
5679
6016
|
var getExtractionDocuments = (options) => (options.client ?? client).get({
|
|
5680
6017
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5681
6018
|
url: "/extraction/documents",
|
|
@@ -5738,6 +6075,34 @@ var postConsentRecords = (options) => (options.client ?? client).post({
|
|
|
5738
6075
|
...options.headers
|
|
5739
6076
|
}
|
|
5740
6077
|
});
|
|
6078
|
+
var deleteComplianceRequirementsById = (options) => (options.client ?? client).delete({
|
|
6079
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6080
|
+
url: "/compliance-requirements/{id}",
|
|
6081
|
+
...options
|
|
6082
|
+
});
|
|
6083
|
+
var getComplianceRequirementsById = (options) => (options.client ?? client).get({
|
|
6084
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6085
|
+
url: "/compliance-requirements/{id}",
|
|
6086
|
+
...options
|
|
6087
|
+
});
|
|
6088
|
+
var patchComplianceRequirementsById = (options) => (options.client ?? client).patch({
|
|
6089
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6090
|
+
url: "/compliance-requirements/{id}",
|
|
6091
|
+
...options,
|
|
6092
|
+
headers: {
|
|
6093
|
+
"Content-Type": "application/vnd.api+json",
|
|
6094
|
+
...options.headers
|
|
6095
|
+
}
|
|
6096
|
+
});
|
|
6097
|
+
var patchPolicyReviewSchedulesByIdMarkDue = (options) => (options.client ?? client).patch({
|
|
6098
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6099
|
+
url: "/policy-review-schedules/{id}/mark-due",
|
|
6100
|
+
...options,
|
|
6101
|
+
headers: {
|
|
6102
|
+
"Content-Type": "application/vnd.api+json",
|
|
6103
|
+
...options.headers
|
|
6104
|
+
}
|
|
6105
|
+
});
|
|
5741
6106
|
var patchBrandIdentitiesByIdSetDefault = (options) => (options.client ?? client).patch({
|
|
5742
6107
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5743
6108
|
url: "/brand-identities/{id}/set-default",
|
|
@@ -5752,6 +6117,25 @@ var getBrandIdentitiesDefaultTenantByTenantId = (options) => (options.client ??
|
|
|
5752
6117
|
url: "/brand-identities/default/tenant/{tenant_id}",
|
|
5753
6118
|
...options
|
|
5754
6119
|
});
|
|
6120
|
+
var getAmendmentRequests = (options) => (options.client ?? client).get({
|
|
6121
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6122
|
+
url: "/amendment-requests",
|
|
6123
|
+
...options
|
|
6124
|
+
});
|
|
6125
|
+
var postAmendmentRequests = (options) => (options.client ?? client).post({
|
|
6126
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6127
|
+
url: "/amendment-requests",
|
|
6128
|
+
...options,
|
|
6129
|
+
headers: {
|
|
6130
|
+
"Content-Type": "application/vnd.api+json",
|
|
6131
|
+
...options.headers
|
|
6132
|
+
}
|
|
6133
|
+
});
|
|
6134
|
+
var getSocialTrendingItemsById = (options) => (options.client ?? client).get({
|
|
6135
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6136
|
+
url: "/social/trending/items/{id}",
|
|
6137
|
+
...options
|
|
6138
|
+
});
|
|
5755
6139
|
var postUsersAuthResendConfirmation = (options) => (options.client ?? client).post({
|
|
5756
6140
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5757
6141
|
url: "/users/auth/resend-confirmation",
|
|
@@ -5864,6 +6248,11 @@ var getWalletPlanPreview = (options) => (options.client ?? client).get({
|
|
|
5864
6248
|
url: "/wallet/plan/preview",
|
|
5865
6249
|
...options
|
|
5866
6250
|
});
|
|
6251
|
+
var getDisclosureLogsBySubject = (options) => (options.client ?? client).get({
|
|
6252
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6253
|
+
url: "/disclosure-logs/by-subject",
|
|
6254
|
+
...options
|
|
6255
|
+
});
|
|
5867
6256
|
var postAgentVersionsByIdSetSystemFields = (options) => (options.client ?? client).post({
|
|
5868
6257
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5869
6258
|
url: "/agent-versions/{id}/set-system-fields",
|
|
@@ -5882,15 +6271,6 @@ var postThreadsByIdSummarize = (options) => (options.client ?? client).post({
|
|
|
5882
6271
|
...options.headers
|
|
5883
6272
|
}
|
|
5884
6273
|
});
|
|
5885
|
-
var patchConfigsByKey = (options) => (options.client ?? client).patch({
|
|
5886
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
5887
|
-
url: "/configs/{key}",
|
|
5888
|
-
...options,
|
|
5889
|
-
headers: {
|
|
5890
|
-
"Content-Type": "application/vnd.api+json",
|
|
5891
|
-
...options.headers
|
|
5892
|
-
}
|
|
5893
|
-
});
|
|
5894
6274
|
var deleteLegalDocumentsById = (options) => (options.client ?? client).delete({
|
|
5895
6275
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5896
6276
|
url: "/legal-documents/{id}",
|
|
@@ -5915,6 +6295,20 @@ var getExtractionResults = (options) => (options.client ?? client).get({
|
|
|
5915
6295
|
url: "/extraction/results",
|
|
5916
6296
|
...options
|
|
5917
6297
|
});
|
|
6298
|
+
var getDisclosureLogs = (options) => (options.client ?? client).get({
|
|
6299
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6300
|
+
url: "/disclosure-logs",
|
|
6301
|
+
...options
|
|
6302
|
+
});
|
|
6303
|
+
var postDisclosureLogs = (options) => (options.client ?? client).post({
|
|
6304
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6305
|
+
url: "/disclosure-logs",
|
|
6306
|
+
...options,
|
|
6307
|
+
headers: {
|
|
6308
|
+
"Content-Type": "application/vnd.api+json",
|
|
6309
|
+
...options.headers
|
|
6310
|
+
}
|
|
6311
|
+
});
|
|
5918
6312
|
var postAgentsByIdClone = (options) => (options.client ?? client).post({
|
|
5919
6313
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5920
6314
|
url: "/agents/{id}/clone",
|
|
@@ -5947,6 +6341,11 @@ var postEmailInclusions = (options) => (options.client ?? client).post({
|
|
|
5947
6341
|
...options.headers
|
|
5948
6342
|
}
|
|
5949
6343
|
});
|
|
6344
|
+
var getAccessLogs = (options) => (options.client ?? client).get({
|
|
6345
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6346
|
+
url: "/access-logs",
|
|
6347
|
+
...options
|
|
6348
|
+
});
|
|
5950
6349
|
var getEmailInboundReceivedWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
5951
6350
|
security: [{ scheme: "bearer", type: "http" }],
|
|
5952
6351
|
url: "/email/inbound/received/workspace/{workspace_id}",
|
|
@@ -6051,34 +6450,29 @@ var deleteSupportTagsById = (options) => (options.client ?? client).delete({
|
|
|
6051
6450
|
url: "/support/tags/{id}",
|
|
6052
6451
|
...options
|
|
6053
6452
|
});
|
|
6054
|
-
var
|
|
6453
|
+
var patchComplianceOfficerDesignationsByIdRevoke = (options) => (options.client ?? client).patch({
|
|
6055
6454
|
security: [{ scheme: "bearer", type: "http" }],
|
|
6056
|
-
url: "/
|
|
6455
|
+
url: "/compliance-officer-designations/{id}/revoke",
|
|
6057
6456
|
...options,
|
|
6058
6457
|
headers: {
|
|
6059
6458
|
"Content-Type": "application/vnd.api+json",
|
|
6060
6459
|
...options.headers
|
|
6061
6460
|
}
|
|
6062
6461
|
});
|
|
6063
|
-
var
|
|
6064
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
6065
|
-
url: "/applications/by-slug/{slug}",
|
|
6066
|
-
...options
|
|
6067
|
-
});
|
|
6068
|
-
var getWebhookConfigs = (options) => (options.client ?? client).get({
|
|
6069
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
6070
|
-
url: "/webhook-configs",
|
|
6071
|
-
...options
|
|
6072
|
-
});
|
|
6073
|
-
var postWebhookConfigs = (options) => (options.client ?? client).post({
|
|
6462
|
+
var postExtractionDocumentsBulkReprocess = (options) => (options.client ?? client).post({
|
|
6074
6463
|
security: [{ scheme: "bearer", type: "http" }],
|
|
6075
|
-
url: "/
|
|
6464
|
+
url: "/extraction/documents/bulk-reprocess",
|
|
6076
6465
|
...options,
|
|
6077
6466
|
headers: {
|
|
6078
6467
|
"Content-Type": "application/vnd.api+json",
|
|
6079
6468
|
...options.headers
|
|
6080
6469
|
}
|
|
6081
6470
|
});
|
|
6471
|
+
var getApplicationsBySlugBySlug = (options) => (options.client ?? client).get({
|
|
6472
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6473
|
+
url: "/applications/by-slug/{slug}",
|
|
6474
|
+
...options
|
|
6475
|
+
});
|
|
6082
6476
|
var getWallet = (options) => (options.client ?? client).get({
|
|
6083
6477
|
security: [{ scheme: "bearer", type: "http" }],
|
|
6084
6478
|
url: "/wallet",
|
|
@@ -6103,6 +6497,20 @@ var patchCrawlerSchedulesById = (options) => (options.client ?? client).patch({
|
|
|
6103
6497
|
...options.headers
|
|
6104
6498
|
}
|
|
6105
6499
|
});
|
|
6500
|
+
var getComplianceDocumentTemplatesById = (options) => (options.client ?? client).get({
|
|
6501
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6502
|
+
url: "/compliance-document-templates/{id}",
|
|
6503
|
+
...options
|
|
6504
|
+
});
|
|
6505
|
+
var patchComplianceDocumentTemplatesById = (options) => (options.client ?? client).patch({
|
|
6506
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6507
|
+
url: "/compliance-document-templates/{id}",
|
|
6508
|
+
...options,
|
|
6509
|
+
headers: {
|
|
6510
|
+
"Content-Type": "application/vnd.api+json",
|
|
6511
|
+
...options.headers
|
|
6512
|
+
}
|
|
6513
|
+
});
|
|
6106
6514
|
var postCrmDeals = (options) => (options.client ?? client).post({
|
|
6107
6515
|
security: [{ scheme: "bearer", type: "http" }],
|
|
6108
6516
|
url: "/crm/deals",
|
|
@@ -6130,11 +6538,6 @@ var patchDataSubjectRequestsByIdStatus = (options) => (options.client ?? client)
|
|
|
6130
6538
|
...options.headers
|
|
6131
6539
|
}
|
|
6132
6540
|
});
|
|
6133
|
-
var getLlmAnalyticsUsage = (options) => (options.client ?? client).get({
|
|
6134
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
6135
|
-
url: "/llm-analytics/usage",
|
|
6136
|
-
...options
|
|
6137
|
-
});
|
|
6138
6541
|
var getCrmActivitiesWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
|
|
6139
6542
|
security: [{ scheme: "bearer", type: "http" }],
|
|
6140
6543
|
url: "/crm/activities/workspace/{workspace_id}",
|
|
@@ -6159,6 +6562,16 @@ var patchSocialCampaignsById = (options) => (options.client ?? client).patch({
|
|
|
6159
6562
|
...options.headers
|
|
6160
6563
|
}
|
|
6161
6564
|
});
|
|
6565
|
+
var getWorkspaceAgentConfigs = (options) => (options.client ?? client).get({
|
|
6566
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6567
|
+
url: "/workspace-agent-configs",
|
|
6568
|
+
...options
|
|
6569
|
+
});
|
|
6570
|
+
var getDisclosureLogsById = (options) => (options.client ?? client).get({
|
|
6571
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6572
|
+
url: "/disclosure-logs/{id}",
|
|
6573
|
+
...options
|
|
6574
|
+
});
|
|
6162
6575
|
var getAiGraphNodes = (options) => (options.client ?? client).get({
|
|
6163
6576
|
security: [{ scheme: "bearer", type: "http" }],
|
|
6164
6577
|
url: "/ai/graph/nodes",
|
|
@@ -6187,12 +6600,7 @@ var postAgents = (options) => (options.client ?? client).post({
|
|
|
6187
6600
|
...options.headers
|
|
6188
6601
|
}
|
|
6189
6602
|
});
|
|
6190
|
-
var
|
|
6191
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
6192
|
-
url: "/applications/{application_id}/email-templates/{slug}",
|
|
6193
|
-
...options
|
|
6194
|
-
});
|
|
6195
|
-
var postSupportTicketRatings = (options) => (options.client ?? client).post({
|
|
6603
|
+
var postSupportTicketRatings = (options) => (options.client ?? client).post({
|
|
6196
6604
|
security: [{ scheme: "bearer", type: "http" }],
|
|
6197
6605
|
url: "/support/ticket-ratings",
|
|
6198
6606
|
...options,
|
|
@@ -6229,6 +6637,29 @@ var postRetentionPolicies = (options) => (options.client ?? client).post({
|
|
|
6229
6637
|
...options.headers
|
|
6230
6638
|
}
|
|
6231
6639
|
});
|
|
6640
|
+
var patchBusinessAssociateAgreementsByIdSign = (options) => (options.client ?? client).patch({
|
|
6641
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6642
|
+
url: "/business-associate-agreements/{id}/sign",
|
|
6643
|
+
...options,
|
|
6644
|
+
headers: {
|
|
6645
|
+
"Content-Type": "application/vnd.api+json",
|
|
6646
|
+
...options.headers
|
|
6647
|
+
}
|
|
6648
|
+
});
|
|
6649
|
+
var getComplianceDocumentTemplates = (options) => (options.client ?? client).get({
|
|
6650
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6651
|
+
url: "/compliance-document-templates",
|
|
6652
|
+
...options
|
|
6653
|
+
});
|
|
6654
|
+
var postComplianceDocumentTemplates = (options) => (options.client ?? client).post({
|
|
6655
|
+
security: [{ scheme: "bearer", type: "http" }],
|
|
6656
|
+
url: "/compliance-document-templates",
|
|
6657
|
+
...options,
|
|
6658
|
+
headers: {
|
|
6659
|
+
"Content-Type": "application/vnd.api+json",
|
|
6660
|
+
...options.headers
|
|
6661
|
+
}
|
|
6662
|
+
});
|
|
6232
6663
|
var postConnectorsByIdSync = (options) => (options.client ?? client).post({
|
|
6233
6664
|
security: [{ scheme: "bearer", type: "http" }],
|
|
6234
6665
|
url: "/connectors/{id}/sync",
|
|
@@ -6963,8 +7394,8 @@ function createAgentsNamespace(rb) {
|
|
|
6963
7394
|
data: {
|
|
6964
7395
|
type: "agent",
|
|
6965
7396
|
attributes: {
|
|
6966
|
-
|
|
6967
|
-
|
|
7397
|
+
base_agent_id: agentId,
|
|
7398
|
+
workspace_id: targetWorkspaceId
|
|
6968
7399
|
}
|
|
6969
7400
|
}
|
|
6970
7401
|
}
|
|
@@ -8065,6 +8496,107 @@ function createAgentsNamespace(rb) {
|
|
|
8065
8496
|
options
|
|
8066
8497
|
);
|
|
8067
8498
|
}
|
|
8499
|
+
},
|
|
8500
|
+
// ── Agent Deployments (read-only on client API) ──────────────────
|
|
8501
|
+
/**
|
|
8502
|
+
* Read-only access to agent deployments for the current application.
|
|
8503
|
+
* Create/update/delete operations are available via the admin SDK.
|
|
8504
|
+
*/
|
|
8505
|
+
deployments: {
|
|
8506
|
+
/**
|
|
8507
|
+
* Lists all agent deployments for the current application.
|
|
8508
|
+
*
|
|
8509
|
+
* @param options - Optional request options (pagination, filters).
|
|
8510
|
+
* @returns A paginated list of agent deployments.
|
|
8511
|
+
*
|
|
8512
|
+
* @example
|
|
8513
|
+
* const deployments = await client.agents.deployments.list();
|
|
8514
|
+
*/
|
|
8515
|
+
list: async (options) => {
|
|
8516
|
+
return rb.execute(getAgentDeployments, {}, options);
|
|
8517
|
+
},
|
|
8518
|
+
/**
|
|
8519
|
+
* Retrieves a single agent deployment by ID.
|
|
8520
|
+
*
|
|
8521
|
+
* @param id - The UUID of the deployment.
|
|
8522
|
+
* @param options - Optional request options.
|
|
8523
|
+
* @returns The agent deployment.
|
|
8524
|
+
*
|
|
8525
|
+
* @example
|
|
8526
|
+
* const deployment = await client.agents.deployments.get('dep_01...');
|
|
8527
|
+
*/
|
|
8528
|
+
get: async (id, options) => {
|
|
8529
|
+
return rb.execute(
|
|
8530
|
+
getAgentDeploymentsById,
|
|
8531
|
+
{ path: { id } },
|
|
8532
|
+
options
|
|
8533
|
+
);
|
|
8534
|
+
}
|
|
8535
|
+
},
|
|
8536
|
+
// ── Workspace Agent Configs (read + update on client API) ────────
|
|
8537
|
+
/**
|
|
8538
|
+
* Workspace-level agent configuration overrides.
|
|
8539
|
+
* End users can read and update overrides; create/delete via admin SDK.
|
|
8540
|
+
*/
|
|
8541
|
+
workspaceConfigs: {
|
|
8542
|
+
/**
|
|
8543
|
+
* Lists all workspace agent configs.
|
|
8544
|
+
*
|
|
8545
|
+
* @param options - Optional request options (pagination, filters).
|
|
8546
|
+
* @returns A paginated list of workspace agent configs.
|
|
8547
|
+
*
|
|
8548
|
+
* @example
|
|
8549
|
+
* const configs = await client.agents.workspaceConfigs.list();
|
|
8550
|
+
*/
|
|
8551
|
+
list: async (options) => {
|
|
8552
|
+
return rb.execute(
|
|
8553
|
+
getWorkspaceAgentConfigs,
|
|
8554
|
+
{},
|
|
8555
|
+
options
|
|
8556
|
+
);
|
|
8557
|
+
},
|
|
8558
|
+
/**
|
|
8559
|
+
* Retrieves a single workspace agent config by ID.
|
|
8560
|
+
*
|
|
8561
|
+
* @param id - The UUID of the config.
|
|
8562
|
+
* @param options - Optional request options.
|
|
8563
|
+
* @returns The workspace agent config.
|
|
8564
|
+
*
|
|
8565
|
+
* @example
|
|
8566
|
+
* const config = await client.agents.workspaceConfigs.get('wac_01...');
|
|
8567
|
+
*/
|
|
8568
|
+
get: async (id, options) => {
|
|
8569
|
+
return rb.execute(
|
|
8570
|
+
getWorkspaceAgentConfigsById,
|
|
8571
|
+
{ path: { id } },
|
|
8572
|
+
options
|
|
8573
|
+
);
|
|
8574
|
+
},
|
|
8575
|
+
/**
|
|
8576
|
+
* Updates a workspace agent config's overrides.
|
|
8577
|
+
*
|
|
8578
|
+
* @param id - The UUID of the config.
|
|
8579
|
+
* @param attributes - Attributes to update (e.g. overrides).
|
|
8580
|
+
* @param options - Optional request options.
|
|
8581
|
+
* @returns The updated workspace agent config.
|
|
8582
|
+
*
|
|
8583
|
+
* @example
|
|
8584
|
+
* await client.agents.workspaceConfigs.update('wac_01...', {
|
|
8585
|
+
* overrides: { prompt_template: 'Custom prompt...' },
|
|
8586
|
+
* });
|
|
8587
|
+
*/
|
|
8588
|
+
update: async (id, attributes, options) => {
|
|
8589
|
+
return rb.execute(
|
|
8590
|
+
patchWorkspaceAgentConfigsById,
|
|
8591
|
+
{
|
|
8592
|
+
path: { id },
|
|
8593
|
+
body: {
|
|
8594
|
+
data: { type: "workspace-agent-config", id, attributes }
|
|
8595
|
+
}
|
|
8596
|
+
},
|
|
8597
|
+
options
|
|
8598
|
+
);
|
|
8599
|
+
}
|
|
8068
8600
|
}
|
|
8069
8601
|
};
|
|
8070
8602
|
}
|
|
@@ -8331,137 +8863,6 @@ function createAiNamespace(rb) {
|
|
|
8331
8863
|
);
|
|
8332
8864
|
}
|
|
8333
8865
|
},
|
|
8334
|
-
/**
|
|
8335
|
-
* Sub-namespace for querying LLM token usage, cost, and workspace analytics.
|
|
8336
|
-
*
|
|
8337
|
-
* Analytics data is aggregated from all LLM inference calls made by the
|
|
8338
|
-
* workspace, including agent executions, conversation messages, embedding
|
|
8339
|
-
* generation, and classification tasks. Use these methods for cost
|
|
8340
|
-
* attribution, budget monitoring, and observability dashboards.
|
|
8341
|
-
*
|
|
8342
|
-
* @example
|
|
8343
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
8344
|
-
* const costs = await client.ai.analytics.costs();
|
|
8345
|
-
* console.log(`Total spend this period: $${costs.total_usd}`);
|
|
8346
|
-
*/
|
|
8347
|
-
analytics: {
|
|
8348
|
-
/**
|
|
8349
|
-
* Lists raw LLM analytics records for the workspace.
|
|
8350
|
-
*
|
|
8351
|
-
* Returns individual inference records with per-call token counts, model
|
|
8352
|
-
* identifiers, latency, and cost. Useful for building custom aggregations
|
|
8353
|
-
* or exporting raw usage data for external billing systems.
|
|
8354
|
-
*
|
|
8355
|
-
* @param options - Optional request options.
|
|
8356
|
-
* @returns A promise that resolves to an array of `LlmAnalytics` records.
|
|
8357
|
-
*
|
|
8358
|
-
* @example
|
|
8359
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
8360
|
-
* const records = await client.ai.analytics.list();
|
|
8361
|
-
* console.log(`Inference calls retrieved: ${records.length}`);
|
|
8362
|
-
*/
|
|
8363
|
-
list: async (options) => {
|
|
8364
|
-
return rb.execute(getLlmAnalytics, {}, options);
|
|
8365
|
-
},
|
|
8366
|
-
/**
|
|
8367
|
-
* Returns a token cost breakdown grouped by model and time period.
|
|
8368
|
-
*
|
|
8369
|
-
* The response includes total spend in USD, prompt token counts, completion
|
|
8370
|
-
* token counts, and per-model breakdowns for all LLM calls made within the
|
|
8371
|
-
* queried window. Time range and granularity can be passed via request
|
|
8372
|
-
* options or query parameters.
|
|
8373
|
-
*
|
|
8374
|
-
* @param options - Optional request options. Pass `from`, `to` (ISO date
|
|
8375
|
-
* strings), and `granularity` (`'day'` | `'week'` | `'month'`) to
|
|
8376
|
-
* control the reporting window.
|
|
8377
|
-
* @returns A promise that resolves to a cost breakdown map, including
|
|
8378
|
-
* `total_usd`, `by_model` array, and time-series data points.
|
|
8379
|
-
*
|
|
8380
|
-
* @example
|
|
8381
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
8382
|
-
* const costs = await client.ai.analytics.costs();
|
|
8383
|
-
* console.log(`Total tokens: ${costs.total_tokens}`);
|
|
8384
|
-
* console.log(`Total cost: $${costs.total_usd}`);
|
|
8385
|
-
* for (const model of costs.by_model) {
|
|
8386
|
-
* console.log(` ${model.name}: $${model.usd} (${model.tokens} tokens)`);
|
|
8387
|
-
* }
|
|
8388
|
-
*/
|
|
8389
|
-
costs: async (options) => {
|
|
8390
|
-
return rb.execute(getLlmAnalyticsCosts, {}, options);
|
|
8391
|
-
},
|
|
8392
|
-
/**
|
|
8393
|
-
* Returns a high-level summary of LLM usage for the workspace.
|
|
8394
|
-
*
|
|
8395
|
-
* Provides pre-aggregated metrics including total requests, total tokens
|
|
8396
|
-
* (prompt + completion), average latency, error rate, and top models by
|
|
8397
|
-
* usage. Intended as the primary data source for observability dashboards
|
|
8398
|
-
* and usage overview pages.
|
|
8399
|
-
*
|
|
8400
|
-
* @param options - Optional request options. Pass date range parameters
|
|
8401
|
-
* to filter the summary window.
|
|
8402
|
-
* @returns A promise that resolves to a summary metrics object.
|
|
8403
|
-
*
|
|
8404
|
-
* @example
|
|
8405
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
8406
|
-
* const summary = await client.ai.analytics.summary();
|
|
8407
|
-
* console.log(`Total requests: ${summary.total_requests}`);
|
|
8408
|
-
* console.log(`Average latency: ${summary.avg_latency_ms}ms`);
|
|
8409
|
-
*/
|
|
8410
|
-
summary: async (options) => {
|
|
8411
|
-
return rb.execute(
|
|
8412
|
-
getLlmAnalyticsSummary,
|
|
8413
|
-
{},
|
|
8414
|
-
options
|
|
8415
|
-
);
|
|
8416
|
-
},
|
|
8417
|
-
/**
|
|
8418
|
-
* Returns raw, time-series LLM usage data points for the workspace.
|
|
8419
|
-
*
|
|
8420
|
-
* Unlike {@link summary} which returns pre-aggregated totals, this method
|
|
8421
|
-
* returns fine-grained data suitable for building custom charts and
|
|
8422
|
-
* time-series visualizations. Each data point includes a timestamp,
|
|
8423
|
-
* request count, token counts, and latency percentiles.
|
|
8424
|
-
*
|
|
8425
|
-
* @param options - Optional request options. Pass `from`, `to`, and
|
|
8426
|
-
* `granularity` to control the series resolution.
|
|
8427
|
-
* @returns A promise that resolves to an object containing a `data_points`
|
|
8428
|
-
* array and associated metadata.
|
|
8429
|
-
*
|
|
8430
|
-
* @example
|
|
8431
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
8432
|
-
* const usage = await client.ai.analytics.usage();
|
|
8433
|
-
* for (const point of usage.data_points) {
|
|
8434
|
-
* console.log(`${point.timestamp}: ${point.tokens} tokens, ${point.requests} requests`);
|
|
8435
|
-
* }
|
|
8436
|
-
*/
|
|
8437
|
-
usage: async (options) => {
|
|
8438
|
-
return rb.execute(getLlmAnalyticsUsage, {}, options);
|
|
8439
|
-
},
|
|
8440
|
-
/**
|
|
8441
|
-
* Returns workspace-scoped LLM metrics aggregated across all tenants and
|
|
8442
|
-
* agents within the workspace.
|
|
8443
|
-
*
|
|
8444
|
-
* Provides a holistic view of workspace-level inference activity, including
|
|
8445
|
-
* breakdowns by agent, user, and feature area. Useful for multi-tenant
|
|
8446
|
-
* platform operators who need to understand aggregate consumption patterns
|
|
8447
|
-
* across all workspace activity.
|
|
8448
|
-
*
|
|
8449
|
-
* @param options - Optional request options.
|
|
8450
|
-
* @returns A promise that resolves to a workspace metrics object.
|
|
8451
|
-
*
|
|
8452
|
-
* @example
|
|
8453
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
8454
|
-
* const metrics = await client.ai.analytics.workspace();
|
|
8455
|
-
* console.log(`Top agent by tokens: ${metrics.top_agents[0]?.name}`);
|
|
8456
|
-
*/
|
|
8457
|
-
workspace: async (options) => {
|
|
8458
|
-
return rb.execute(
|
|
8459
|
-
getLlmAnalyticsWorkspace,
|
|
8460
|
-
{},
|
|
8461
|
-
options
|
|
8462
|
-
);
|
|
8463
|
-
}
|
|
8464
|
-
},
|
|
8465
8866
|
/**
|
|
8466
8867
|
* Sub-namespace for managing knowledge graph nodes.
|
|
8467
8868
|
*
|
|
@@ -8790,6 +9191,77 @@ function createBillingNamespace(rb) {
|
|
|
8790
9191
|
{ path: { addon_slug: addonSlug }, body: {} },
|
|
8791
9192
|
options
|
|
8792
9193
|
);
|
|
9194
|
+
},
|
|
9195
|
+
/**
|
|
9196
|
+
* Cancel the current subscription plan.
|
|
9197
|
+
*
|
|
9198
|
+
* @param immediate - If true (default), cancel immediately. If false, cancel at end of billing period.
|
|
9199
|
+
* @param options - Request options
|
|
9200
|
+
* @returns Updated wallet with new subscription_status
|
|
9201
|
+
*
|
|
9202
|
+
* @example
|
|
9203
|
+
* ```typescript
|
|
9204
|
+
* // Cancel immediately
|
|
9205
|
+
* const wallet = await client.billing.wallet.cancelPlan();
|
|
9206
|
+
*
|
|
9207
|
+
* // Cancel at end of period
|
|
9208
|
+
* const wallet = await client.billing.wallet.cancelPlan(false);
|
|
9209
|
+
* ```
|
|
9210
|
+
*/
|
|
9211
|
+
cancelPlan: async (immediateOrOptions, options) => {
|
|
9212
|
+
let immediate;
|
|
9213
|
+
let reqOptions;
|
|
9214
|
+
if (typeof immediateOrOptions === "boolean") {
|
|
9215
|
+
immediate = immediateOrOptions;
|
|
9216
|
+
reqOptions = options;
|
|
9217
|
+
} else {
|
|
9218
|
+
immediate = true;
|
|
9219
|
+
reqOptions = immediateOrOptions;
|
|
9220
|
+
}
|
|
9221
|
+
const wallet = await rb.execute(getWallet, {}, reqOptions);
|
|
9222
|
+
const walletId = wallet.id;
|
|
9223
|
+
return rb.execute(
|
|
9224
|
+
patchWalletPlanCancel,
|
|
9225
|
+
{
|
|
9226
|
+
body: {
|
|
9227
|
+
data: {
|
|
9228
|
+
id: walletId,
|
|
9229
|
+
type: "wallet",
|
|
9230
|
+
attributes: { immediate }
|
|
9231
|
+
}
|
|
9232
|
+
}
|
|
9233
|
+
},
|
|
9234
|
+
reqOptions
|
|
9235
|
+
);
|
|
9236
|
+
},
|
|
9237
|
+
/**
|
|
9238
|
+
* Retry a failed subscription payment.
|
|
9239
|
+
*
|
|
9240
|
+
* Only works when the subscription is in `past_due` status. Uses the
|
|
9241
|
+
* default payment method on file. On success, restores the subscription
|
|
9242
|
+
* to `active` status and clears the dunning state.
|
|
9243
|
+
*
|
|
9244
|
+
* @param options - Request options
|
|
9245
|
+
* @returns Updated wallet with restored subscription status
|
|
9246
|
+
*
|
|
9247
|
+
* @example
|
|
9248
|
+
* ```typescript
|
|
9249
|
+
* const wallet = await client.billing.wallet.retryPayment();
|
|
9250
|
+
* console.log(wallet.attributes?.subscription_status); // "active"
|
|
9251
|
+
* ```
|
|
9252
|
+
*/
|
|
9253
|
+
retryPayment: async (options) => {
|
|
9254
|
+
const wallet = await rb.execute(getWallet, {}, options);
|
|
9255
|
+
const walletId = wallet.id;
|
|
9256
|
+
return rb.execute(
|
|
9257
|
+
patchWalletPaymentRetry,
|
|
9258
|
+
{
|
|
9259
|
+
body: {
|
|
9260
|
+
data: { id: walletId, type: "wallet", attributes: {} }
|
|
9261
|
+
}
|
|
9262
|
+
},
|
|
9263
|
+
options
|
|
9264
|
+
);
|
|
8793
9265
|
}
|
|
8794
9266
|
},
|
|
8795
9267
|
/**
|
|
@@ -9312,7 +9784,16 @@ function createBillingNamespace(rb) {
|
|
|
9312
9784
|
setDefault: async (id, options) => {
|
|
9313
9785
|
return rb.execute(
|
|
9314
9786
|
patchPaymentMethodsByIdDefault,
|
|
9315
|
-
{
|
|
9787
|
+
{
|
|
9788
|
+
path: { id },
|
|
9789
|
+
body: {
|
|
9790
|
+
data: {
|
|
9791
|
+
id,
|
|
9792
|
+
type: "payment-method",
|
|
9793
|
+
attributes: { is_default: true }
|
|
9794
|
+
}
|
|
9795
|
+
}
|
|
9796
|
+
},
|
|
9316
9797
|
options
|
|
9317
9798
|
);
|
|
9318
9799
|
}
|
|
@@ -9472,6 +9953,40 @@ function createBillingNamespace(rb) {
|
|
|
9472
9953
|
);
|
|
9473
9954
|
return result.data ?? result;
|
|
9474
9955
|
}
|
|
9956
|
+
},
|
|
9957
|
+
/**
|
|
9958
|
+
* Composite feature summary — definitions, allocations, and usage in one call.
|
|
9959
|
+
*
|
|
9960
|
+
* Eliminates the need to call featureDefinitions, planFeatureAllocations,
|
|
9961
|
+
* and featureUsages separately. Returns everything the frontend needs for
|
|
9962
|
+
* feature gating UI.
|
|
9963
|
+
*/
|
|
9964
|
+
featureSummary: {
|
|
9965
|
+
/**
|
|
9966
|
+
* Get all features with plan allocations and current usage for the tenant.
|
|
9967
|
+
*
|
|
9968
|
+
* Each item includes: key, name, enabled, metering_mode, limit,
|
|
9969
|
+
* used_this_cycle, remaining, credit_cost, activation_cost, activated.
|
|
9970
|
+
*
|
|
9971
|
+
* @param options - Request options
|
|
9972
|
+
* @returns Array of feature summaries with usage data
|
|
9973
|
+
*
|
|
9974
|
+
* @example
|
|
9975
|
+
* ```typescript
|
|
9976
|
+
* const features = await client.billing.featureSummary.list();
|
|
9977
|
+
* features.forEach(f => {
|
|
9978
|
+
* console.log(`${f.attributes?.key}: ${f.attributes?.used_this_cycle}/${f.attributes?.limit}`);
|
|
9979
|
+
* });
|
|
9980
|
+
* ```
|
|
9981
|
+
*/
|
|
9982
|
+
list: async (options) => {
|
|
9983
|
+
const result = await rb.execute(
|
|
9984
|
+
getWalletFeatures,
|
|
9985
|
+
{},
|
|
9986
|
+
options
|
|
9987
|
+
);
|
|
9988
|
+
return result.data ?? result;
|
|
9989
|
+
}
|
|
9475
9990
|
}
|
|
9476
9991
|
};
|
|
9477
9992
|
}
|
|
@@ -10397,7 +10912,7 @@ function createClinicalNamespace(rb) {
|
|
|
10397
10912
|
* Manage clinical notes (SOAP notes, progress notes, AI-generated summaries).
|
|
10398
10913
|
*
|
|
10399
10914
|
* Notes support a HITL (Human-In-The-Loop) approval workflow: AI-generated
|
|
10400
|
-
* notes start with `status: "
|
|
10915
|
+
* notes start with `status: "draft"` and must be approved or rejected
|
|
10401
10916
|
* by a clinician before they are finalized.
|
|
10402
10917
|
*/
|
|
10403
10918
|
notes: {
|
|
@@ -10424,7 +10939,7 @@ function createClinicalNamespace(rb) {
|
|
|
10424
10939
|
/**
|
|
10425
10940
|
* Create a new clinical note.
|
|
10426
10941
|
*
|
|
10427
|
-
* @param attributes - Note creation attributes. Must include `workspace_id
|
|
10942
|
+
* @param attributes - Note creation attributes. Must include `workspace_id` and `session_id`.
|
|
10428
10943
|
* @param options - Request options
|
|
10429
10944
|
* @returns Created {@link ClinicalNote} record
|
|
10430
10945
|
*/
|
|
@@ -10461,42 +10976,63 @@ function createClinicalNamespace(rb) {
|
|
|
10461
10976
|
* Approve a clinical note (HITL workflow).
|
|
10462
10977
|
*
|
|
10463
10978
|
* Marks the note as clinician-reviewed and approved, transitioning it
|
|
10464
|
-
* to `status: "approved"`. Only notes in `
|
|
10979
|
+
* to `status: "approved"`. Only notes in `draft` status can be approved.
|
|
10980
|
+
* Creates an immutable NoteVersion snapshot.
|
|
10465
10981
|
*
|
|
10466
10982
|
* @param id - Note UUID
|
|
10983
|
+
* @param reviewedById - UUID of the reviewer (required)
|
|
10467
10984
|
* @param options - Request options
|
|
10468
10985
|
* @returns Updated {@link ClinicalNote} record
|
|
10469
10986
|
*
|
|
10470
10987
|
* @example
|
|
10471
10988
|
* ```typescript
|
|
10472
|
-
* const approved = await client.clinical.notes.approve('note_abc');
|
|
10989
|
+
* const approved = await client.clinical.notes.approve('note_abc', 'user_xyz');
|
|
10473
10990
|
* console.log(approved.attributes.status); // 'approved'
|
|
10474
10991
|
* ```
|
|
10475
10992
|
*/
|
|
10476
|
-
approve: async (id, options) => rb.execute(
|
|
10993
|
+
approve: async (id, reviewedById, options) => rb.execute(
|
|
10477
10994
|
patchClinicalNotesByIdApprove,
|
|
10478
|
-
{
|
|
10995
|
+
{
|
|
10996
|
+
path: { id },
|
|
10997
|
+
body: {
|
|
10998
|
+
data: {
|
|
10999
|
+
type: "clinical-note",
|
|
11000
|
+
id,
|
|
11001
|
+
attributes: { reviewed_by_id: reviewedById }
|
|
11002
|
+
}
|
|
11003
|
+
}
|
|
11004
|
+
},
|
|
10479
11005
|
options
|
|
10480
11006
|
),
|
|
10481
11007
|
/**
|
|
10482
11008
|
* Reject a clinical note (HITL workflow).
|
|
10483
11009
|
*
|
|
10484
11010
|
* Marks the note as rejected, transitioning it to `status: "rejected"`.
|
|
10485
|
-
* Only notes in `
|
|
11011
|
+
* Only notes in `draft` status can be rejected.
|
|
10486
11012
|
*
|
|
10487
11013
|
* @param id - Note UUID
|
|
11014
|
+
* @param reviewedById - UUID of the reviewer (required)
|
|
10488
11015
|
* @param options - Request options
|
|
10489
11016
|
* @returns Updated {@link ClinicalNote} record
|
|
10490
11017
|
*
|
|
10491
11018
|
* @example
|
|
10492
11019
|
* ```typescript
|
|
10493
|
-
* const rejected = await client.clinical.notes.reject('note_abc');
|
|
11020
|
+
* const rejected = await client.clinical.notes.reject('note_abc', 'user_xyz');
|
|
10494
11021
|
* console.log(rejected.attributes.status); // 'rejected'
|
|
10495
11022
|
* ```
|
|
10496
11023
|
*/
|
|
10497
|
-
reject: async (id, options) => rb.execute(
|
|
11024
|
+
reject: async (id, reviewedById, options) => rb.execute(
|
|
10498
11025
|
patchClinicalNotesByIdReject,
|
|
10499
|
-
{
|
|
11026
|
+
{
|
|
11027
|
+
path: { id },
|
|
11028
|
+
body: {
|
|
11029
|
+
data: {
|
|
11030
|
+
type: "clinical-note",
|
|
11031
|
+
id,
|
|
11032
|
+
attributes: { reviewed_by_id: reviewedById }
|
|
11033
|
+
}
|
|
11034
|
+
}
|
|
11035
|
+
},
|
|
10500
11036
|
options
|
|
10501
11037
|
),
|
|
10502
11038
|
/**
|
|
@@ -10559,7 +11095,7 @@ function createClinicalNamespace(rb) {
|
|
|
10559
11095
|
* Record a new health metric entry.
|
|
10560
11096
|
*
|
|
10561
11097
|
* @param attributes - Metric creation attributes. Must include `workspace_id`, `patient_id`,
|
|
10562
|
-
*
|
|
11098
|
+
* and `metric_type`.
|
|
10563
11099
|
* @param options - Request options
|
|
10564
11100
|
* @returns Created {@link ClinicalHealthMetric} record
|
|
10565
11101
|
*
|
|
@@ -10568,9 +11104,9 @@ function createClinicalNamespace(rb) {
|
|
|
10568
11104
|
* const metric = await client.clinical.healthMetrics.create({
|
|
10569
11105
|
* workspace_id: 'ws_123',
|
|
10570
11106
|
* patient_id: 'pat_abc',
|
|
11107
|
+
* metric_type: 'weight_kg',
|
|
10571
11108
|
* metric_category: 'vitals',
|
|
10572
|
-
*
|
|
10573
|
-
* value: 82.5,
|
|
11109
|
+
* value_numeric: 82.5,
|
|
10574
11110
|
* unit: 'kg',
|
|
10575
11111
|
* });
|
|
10576
11112
|
* ```
|
|
@@ -10640,7 +11176,7 @@ function createClinicalNamespace(rb) {
|
|
|
10640
11176
|
/**
|
|
10641
11177
|
* Create a new meal plan.
|
|
10642
11178
|
*
|
|
10643
|
-
* @param attributes - Meal plan creation attributes. Must include `workspace_id
|
|
11179
|
+
* @param attributes - Meal plan creation attributes. Must include `workspace_id`.
|
|
10644
11180
|
* @param options - Request options
|
|
10645
11181
|
* @returns Created {@link ClinicalMealPlan} record
|
|
10646
11182
|
*/
|
|
@@ -10709,7 +11245,7 @@ function createClinicalNamespace(rb) {
|
|
|
10709
11245
|
/**
|
|
10710
11246
|
* Create a new client goal.
|
|
10711
11247
|
*
|
|
10712
|
-
* @param attributes - Goal creation attributes. Must include `workspace_id`, `patient_id`, and `title`.
|
|
11248
|
+
* @param attributes - Goal creation attributes. Must include `workspace_id`, `patient_id`, `goal_type`, and `title`.
|
|
10713
11249
|
* @param options - Request options
|
|
10714
11250
|
* @returns Created {@link ClinicalClientGoal} record
|
|
10715
11251
|
*/
|
|
@@ -10779,7 +11315,7 @@ function createClinicalNamespace(rb) {
|
|
|
10779
11315
|
* Create a new supplement prescription.
|
|
10780
11316
|
*
|
|
10781
11317
|
* @param attributes - Supplement creation attributes. Must include `workspace_id`,
|
|
10782
|
-
* `patient_id`, and `
|
|
11318
|
+
* `patient_id`, and `name`.
|
|
10783
11319
|
* @param options - Request options
|
|
10784
11320
|
* @returns Created {@link ClinicalClientSupplement} record
|
|
10785
11321
|
*/
|
|
@@ -10965,7 +11501,7 @@ function createClinicalNamespace(rb) {
|
|
|
10965
11501
|
*/
|
|
10966
11502
|
list: async (params, options) => rb.execute(
|
|
10967
11503
|
getClinicalPracticeTools,
|
|
10968
|
-
params
|
|
11504
|
+
{ ...params },
|
|
10969
11505
|
options
|
|
10970
11506
|
),
|
|
10971
11507
|
/**
|
|
@@ -11019,6 +11555,28 @@ function createClinicalNamespace(rb) {
|
|
|
11019
11555
|
deleteClinicalPracticeToolsById,
|
|
11020
11556
|
{ path: { id } },
|
|
11021
11557
|
options
|
|
11558
|
+
),
|
|
11559
|
+
/**
|
|
11560
|
+
* List distinct practice tool categories in a workspace.
|
|
11561
|
+
*
|
|
11562
|
+
* Returns unique `tool_type` values with their active tool counts,
|
|
11563
|
+
* sorted by count descending.
|
|
11564
|
+
*
|
|
11565
|
+
* @param params - Must include `workspace_id`
|
|
11566
|
+
* @param options - Request options
|
|
11567
|
+
* @returns Array of {@link PracticeToolCategory} records
|
|
11568
|
+
*
|
|
11569
|
+
* @example
|
|
11570
|
+
* ```typescript
|
|
11571
|
+
* const categories = await client.clinical.practiceTools.listCategories({
|
|
11572
|
+
* workspace_id: "..."
|
|
11573
|
+
* });
|
|
11574
|
+
* // [{ category: "app", tool_count: 5 }, { category: "wearable", tool_count: 3 }]
|
|
11575
|
+
* ```
|
|
11576
|
+
*/
|
|
11577
|
+
listCategories: async (params, options) => rb.rawGet(
|
|
11578
|
+
`/clinical/practice-tools/categories?workspace_id=${encodeURIComponent(params.workspace_id)}`,
|
|
11579
|
+
options
|
|
11022
11580
|
)
|
|
11023
11581
|
},
|
|
11024
11582
|
/**
|
|
@@ -12523,13 +13081,1728 @@ function createComplianceNamespace(rb) {
|
|
|
12523
13081
|
options
|
|
12524
13082
|
);
|
|
12525
13083
|
}
|
|
12526
|
-
}
|
|
12527
|
-
|
|
12528
|
-
|
|
12529
|
-
|
|
12530
|
-
|
|
12531
|
-
|
|
12532
|
-
|
|
13084
|
+
},
|
|
13085
|
+
/**
|
|
13086
|
+
* Get aggregated compliance posture for a workspace.
|
|
13087
|
+
*
|
|
13088
|
+
* Returns breach stats, DSR metrics, risk assessments, retention policies,
|
|
13089
|
+
* PII scan coverage, consent tracking, and regulatory framework readiness
|
|
13090
|
+
* in a single call.
|
|
13091
|
+
*
|
|
13092
|
+
* @param params - Must include `workspace_id`
|
|
13093
|
+
* @param options - Request options
|
|
13094
|
+
* @returns {@link CompliancePosture} snapshot
|
|
13095
|
+
*
|
|
13096
|
+
* @example
|
|
13097
|
+
* ```typescript
|
|
13098
|
+
* const posture = await client.compliance.getPosture({ workspace_id: "..." });
|
|
13099
|
+
* console.log(posture.open_breaches, posture.frameworks);
|
|
13100
|
+
* ```
|
|
13101
|
+
*/
|
|
13102
|
+
getPosture: async (params, options) => rb.rawGet(
|
|
13103
|
+
`/compliance/posture?workspace_id=${encodeURIComponent(params.workspace_id)}`,
|
|
13104
|
+
options
|
|
13105
|
+
),
|
|
13106
|
+
// ── New compliance sub-namespaces (Phase 5) ──────────────────────────
|
|
13107
|
+
/**
|
|
13108
|
+
* Risk Assessments — formal risk evaluation records.
|
|
13109
|
+
*
|
|
13110
|
+
* Track risk assessments for data processing activities, infrastructure,
|
|
13111
|
+
* and third-party integrations. Assessments can be created, reviewed via
|
|
13112
|
+
* status updates, and deleted when superseded.
|
|
13113
|
+
*/
|
|
13114
|
+
riskAssessments: {
|
|
13115
|
+
/**
|
|
13116
|
+
* List risk assessments with optional pagination.
|
|
13117
|
+
*
|
|
13118
|
+
* @param options - Optional page number, page size, and request options.
|
|
13119
|
+
* @returns A page of `RiskAssessment` records.
|
|
13120
|
+
*
|
|
13121
|
+
* @example
|
|
13122
|
+
* ```typescript
|
|
13123
|
+
* const assessments = await client.compliance.riskAssessments.list();
|
|
13124
|
+
* ```
|
|
13125
|
+
*/
|
|
13126
|
+
list: async (options) => {
|
|
13127
|
+
return rb.execute(
|
|
13128
|
+
getRiskAssessments,
|
|
13129
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
13130
|
+
options
|
|
13131
|
+
);
|
|
13132
|
+
},
|
|
13133
|
+
/**
|
|
13134
|
+
* Retrieve a single risk assessment by ID.
|
|
13135
|
+
*
|
|
13136
|
+
* @param id - The UUID of the risk assessment.
|
|
13137
|
+
* @param options - Optional request options.
|
|
13138
|
+
* @returns The matching `RiskAssessment`.
|
|
13139
|
+
*
|
|
13140
|
+
* @example
|
|
13141
|
+
* ```typescript
|
|
13142
|
+
* const assessment = await client.compliance.riskAssessments.get('ra-uuid');
|
|
13143
|
+
* ```
|
|
13144
|
+
*/
|
|
13145
|
+
get: async (id, options) => {
|
|
13146
|
+
return rb.execute(
|
|
13147
|
+
getRiskAssessmentsById,
|
|
13148
|
+
{ path: { id } },
|
|
13149
|
+
options
|
|
13150
|
+
);
|
|
13151
|
+
},
|
|
13152
|
+
/**
|
|
13153
|
+
* Create a new risk assessment.
|
|
13154
|
+
*
|
|
13155
|
+
* @param attributes - Risk assessment attributes.
|
|
13156
|
+
* @param options - Optional request options.
|
|
13157
|
+
* @returns The newly created `RiskAssessment`.
|
|
13158
|
+
*
|
|
13159
|
+
* @example
|
|
13160
|
+
* ```typescript
|
|
13161
|
+
* const assessment = await client.compliance.riskAssessments.create({
|
|
13162
|
+
* title: 'LLM Pipeline Risk Assessment',
|
|
13163
|
+
* risk_level: 'high',
|
|
13164
|
+
* });
|
|
13165
|
+
* ```
|
|
13166
|
+
*/
|
|
13167
|
+
create: async (attributes, options) => {
|
|
13168
|
+
return rb.execute(
|
|
13169
|
+
postRiskAssessments,
|
|
13170
|
+
{ body: { data: { type: "risk-assessment", attributes } } },
|
|
13171
|
+
options
|
|
13172
|
+
);
|
|
13173
|
+
},
|
|
13174
|
+
/**
|
|
13175
|
+
* Update the status of a risk assessment.
|
|
13176
|
+
*
|
|
13177
|
+
* @param id - The UUID of the risk assessment.
|
|
13178
|
+
* @param attributes - Attributes to update (e.g., `{ status: "mitigated" }`).
|
|
13179
|
+
* @param options - Optional request options.
|
|
13180
|
+
* @returns The updated `RiskAssessment`.
|
|
13181
|
+
*
|
|
13182
|
+
* @example
|
|
13183
|
+
* ```typescript
|
|
13184
|
+
* const assessment = await client.compliance.riskAssessments.updateStatus(
|
|
13185
|
+
* 'ra-uuid', { status: 'mitigated' },
|
|
13186
|
+
* );
|
|
13187
|
+
* ```
|
|
13188
|
+
*/
|
|
13189
|
+
updateStatus: async (id, attributes, options) => {
|
|
13190
|
+
return rb.execute(
|
|
13191
|
+
patchRiskAssessmentsByIdStatus,
|
|
13192
|
+
{
|
|
13193
|
+
path: { id },
|
|
13194
|
+
body: { data: { type: "risk-assessment", id, attributes } }
|
|
13195
|
+
},
|
|
13196
|
+
options
|
|
13197
|
+
);
|
|
13198
|
+
},
|
|
13199
|
+
/**
|
|
13200
|
+
* Delete a risk assessment.
|
|
13201
|
+
*
|
|
13202
|
+
* @param id - The UUID of the risk assessment to delete.
|
|
13203
|
+
* @param options - Optional request options.
|
|
13204
|
+
* @returns `true` on successful deletion.
|
|
13205
|
+
*
|
|
13206
|
+
* @example
|
|
13207
|
+
* ```typescript
|
|
13208
|
+
* await client.compliance.riskAssessments.delete('ra-uuid');
|
|
13209
|
+
* ```
|
|
13210
|
+
*/
|
|
13211
|
+
delete: async (id, options) => {
|
|
13212
|
+
return rb.executeDelete(
|
|
13213
|
+
deleteRiskAssessmentsById,
|
|
13214
|
+
{ path: { id } },
|
|
13215
|
+
options
|
|
13216
|
+
);
|
|
13217
|
+
}
|
|
13218
|
+
},
|
|
13219
|
+
/**
|
|
13220
|
+
* Data Transfer Records — cross-border and third-party data transfer tracking.
|
|
13221
|
+
*
|
|
13222
|
+
* GDPR Chapter V requires documentation of international data transfers.
|
|
13223
|
+
* Each record captures the transfer mechanism, recipient country, and
|
|
13224
|
+
* safeguards in place.
|
|
13225
|
+
*/
|
|
13226
|
+
dataTransferRecords: {
|
|
13227
|
+
/**
|
|
13228
|
+
* List data transfer records with optional pagination.
|
|
13229
|
+
*
|
|
13230
|
+
* @param options - Optional page number, page size, and request options.
|
|
13231
|
+
* @returns A page of `DataTransferRecord` records.
|
|
13232
|
+
*
|
|
13233
|
+
* @example
|
|
13234
|
+
* ```typescript
|
|
13235
|
+
* const transfers = await client.compliance.dataTransferRecords.list();
|
|
13236
|
+
* ```
|
|
13237
|
+
*/
|
|
13238
|
+
list: async (options) => {
|
|
13239
|
+
return rb.execute(
|
|
13240
|
+
getDataTransferRecords,
|
|
13241
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
13242
|
+
options
|
|
13243
|
+
);
|
|
13244
|
+
},
|
|
13245
|
+
/**
|
|
13246
|
+
* Retrieve a single data transfer record by ID.
|
|
13247
|
+
*
|
|
13248
|
+
* @param id - The UUID of the data transfer record.
|
|
13249
|
+
* @param options - Optional request options.
|
|
13250
|
+
* @returns The matching `DataTransferRecord`.
|
|
13251
|
+
*
|
|
13252
|
+
* @example
|
|
13253
|
+
* ```typescript
|
|
13254
|
+
* const transfer = await client.compliance.dataTransferRecords.get('dtr-uuid');
|
|
13255
|
+
* ```
|
|
13256
|
+
*/
|
|
13257
|
+
get: async (id, options) => {
|
|
13258
|
+
return rb.execute(
|
|
13259
|
+
getDataTransferRecordsById,
|
|
13260
|
+
{ path: { id } },
|
|
13261
|
+
options
|
|
13262
|
+
);
|
|
13263
|
+
},
|
|
13264
|
+
/**
|
|
13265
|
+
* Create a new data transfer record.
|
|
13266
|
+
*
|
|
13267
|
+
* @param attributes - Data transfer attributes (recipient, country, mechanism, etc.).
|
|
13268
|
+
* @param options - Optional request options.
|
|
13269
|
+
* @returns The newly created `DataTransferRecord`.
|
|
13270
|
+
*
|
|
13271
|
+
* @example
|
|
13272
|
+
* ```typescript
|
|
13273
|
+
* const transfer = await client.compliance.dataTransferRecords.create({
|
|
13274
|
+
* recipient: 'Cloud Provider EU',
|
|
13275
|
+
* destination_country: 'DE',
|
|
13276
|
+
* transfer_mechanism: 'standard_contractual_clauses',
|
|
13277
|
+
* });
|
|
13278
|
+
* ```
|
|
13279
|
+
*/
|
|
13280
|
+
create: async (attributes, options) => {
|
|
13281
|
+
return rb.execute(
|
|
13282
|
+
postDataTransferRecords,
|
|
13283
|
+
{ body: { data: { type: "data-transfer-record", attributes } } },
|
|
13284
|
+
options
|
|
13285
|
+
);
|
|
13286
|
+
},
|
|
13287
|
+
/**
|
|
13288
|
+
* Delete a data transfer record.
|
|
13289
|
+
*
|
|
13290
|
+
* @param id - The UUID of the data transfer record to delete.
|
|
13291
|
+
* @param options - Optional request options.
|
|
13292
|
+
* @returns `true` on successful deletion.
|
|
13293
|
+
*
|
|
13294
|
+
* @example
|
|
13295
|
+
* ```typescript
|
|
13296
|
+
* await client.compliance.dataTransferRecords.delete('dtr-uuid');
|
|
13297
|
+
* ```
|
|
13298
|
+
*/
|
|
13299
|
+
delete: async (id, options) => {
|
|
13300
|
+
return rb.executeDelete(
|
|
13301
|
+
deleteDataTransferRecordsById,
|
|
13302
|
+
{ path: { id } },
|
|
13303
|
+
options
|
|
13304
|
+
);
|
|
13305
|
+
}
|
|
13306
|
+
},
|
|
13307
|
+
/**
|
|
13308
|
+
* CDE Scope Reports — Cardholder Data Environment scope documentation.
|
|
13309
|
+
*
|
|
13310
|
+
* PCI DSS requires documenting the scope of systems that store, process,
|
|
13311
|
+
* or transmit cardholder data. Each report captures the CDE boundary
|
|
13312
|
+
* and connected systems.
|
|
13313
|
+
*/
|
|
13314
|
+
cdeScopeReports: {
|
|
13315
|
+
/**
|
|
13316
|
+
* List CDE scope reports with optional pagination.
|
|
13317
|
+
*
|
|
13318
|
+
* @param options - Optional page number, page size, and request options.
|
|
13319
|
+
* @returns A page of `CdeScopeReport` records.
|
|
13320
|
+
*
|
|
13321
|
+
* @example
|
|
13322
|
+
* ```typescript
|
|
13323
|
+
* const reports = await client.compliance.cdeScopeReports.list();
|
|
13324
|
+
* ```
|
|
13325
|
+
*/
|
|
13326
|
+
list: async (options) => {
|
|
13327
|
+
return rb.execute(
|
|
13328
|
+
getCdeScopeReports,
|
|
13329
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
13330
|
+
options
|
|
13331
|
+
);
|
|
13332
|
+
},
|
|
13333
|
+
/**
|
|
13334
|
+
* Retrieve a single CDE scope report by ID.
|
|
13335
|
+
*
|
|
13336
|
+
* @param id - The UUID of the CDE scope report.
|
|
13337
|
+
* @param options - Optional request options.
|
|
13338
|
+
* @returns The matching `CdeScopeReport`.
|
|
13339
|
+
*
|
|
13340
|
+
* @example
|
|
13341
|
+
* ```typescript
|
|
13342
|
+
* const report = await client.compliance.cdeScopeReports.get('csr-uuid');
|
|
13343
|
+
* ```
|
|
13344
|
+
*/
|
|
13345
|
+
get: async (id, options) => {
|
|
13346
|
+
return rb.execute(
|
|
13347
|
+
getCdeScopeReportsById,
|
|
13348
|
+
{ path: { id } },
|
|
13349
|
+
options
|
|
13350
|
+
);
|
|
13351
|
+
},
|
|
13352
|
+
/**
|
|
13353
|
+
* Create a new CDE scope report.
|
|
13354
|
+
*
|
|
13355
|
+
* @param attributes - CDE scope report attributes.
|
|
13356
|
+
* @param options - Optional request options.
|
|
13357
|
+
* @returns The newly created `CdeScopeReport`.
|
|
13358
|
+
*
|
|
13359
|
+
* @example
|
|
13360
|
+
* ```typescript
|
|
13361
|
+
* const report = await client.compliance.cdeScopeReports.create({
|
|
13362
|
+
* title: 'Q1 2026 CDE Scope',
|
|
13363
|
+
* systems_in_scope: ['payment-gateway', 'billing-db'],
|
|
13364
|
+
* });
|
|
13365
|
+
* ```
|
|
13366
|
+
*/
|
|
13367
|
+
create: async (attributes, options) => {
|
|
13368
|
+
return rb.execute(
|
|
13369
|
+
postCdeScopeReports,
|
|
13370
|
+
{ body: { data: { type: "cde-scope-report", attributes } } },
|
|
13371
|
+
options
|
|
13372
|
+
);
|
|
13373
|
+
},
|
|
13374
|
+
/**
|
|
13375
|
+
* Delete a CDE scope report.
|
|
13376
|
+
*
|
|
13377
|
+
* @param id - The UUID of the CDE scope report to delete.
|
|
13378
|
+
* @param options - Optional request options.
|
|
13379
|
+
* @returns `true` on successful deletion.
|
|
13380
|
+
*
|
|
13381
|
+
* @example
|
|
13382
|
+
* ```typescript
|
|
13383
|
+
* await client.compliance.cdeScopeReports.delete('csr-uuid');
|
|
13384
|
+
* ```
|
|
13385
|
+
*/
|
|
13386
|
+
delete: async (id, options) => {
|
|
13387
|
+
return rb.executeDelete(
|
|
13388
|
+
deleteCdeScopeReportsById,
|
|
13389
|
+
{ path: { id } },
|
|
13390
|
+
options
|
|
13391
|
+
);
|
|
13392
|
+
}
|
|
13393
|
+
},
|
|
13394
|
+
/**
|
|
13395
|
+
* Access Logs — read-only access audit trail.
|
|
13396
|
+
*
|
|
13397
|
+
* Records of who accessed what data and when. Generated automatically
|
|
13398
|
+
* by the platform. Access logs are immutable and cannot be created,
|
|
13399
|
+
* modified, or deleted via the API.
|
|
13400
|
+
*/
|
|
13401
|
+
accessLogs: {
|
|
13402
|
+
/**
|
|
13403
|
+
* List access logs with optional pagination.
|
|
13404
|
+
*
|
|
13405
|
+
* @param options - Optional page number, page size, and request options.
|
|
13406
|
+
* @returns A page of `AccessLog` records.
|
|
13407
|
+
*
|
|
13408
|
+
* @example
|
|
13409
|
+
* ```typescript
|
|
13410
|
+
* const logs = await client.compliance.accessLogs.list({ pageSize: 100 });
|
|
13411
|
+
* ```
|
|
13412
|
+
*/
|
|
13413
|
+
list: async (options) => {
|
|
13414
|
+
return rb.execute(
|
|
13415
|
+
getAccessLogs,
|
|
13416
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
13417
|
+
options
|
|
13418
|
+
);
|
|
13419
|
+
},
|
|
13420
|
+
/**
|
|
13421
|
+
* Retrieve a single access log entry by ID.
|
|
13422
|
+
*
|
|
13423
|
+
* @param id - The UUID of the access log entry.
|
|
13424
|
+
* @param options - Optional request options.
|
|
13425
|
+
* @returns The matching `AccessLog`.
|
|
13426
|
+
*
|
|
13427
|
+
* @example
|
|
13428
|
+
* ```typescript
|
|
13429
|
+
* const log = await client.compliance.accessLogs.get('al-uuid');
|
|
13430
|
+
* ```
|
|
13431
|
+
*/
|
|
13432
|
+
get: async (id, options) => {
|
|
13433
|
+
return rb.execute(
|
|
13434
|
+
getAccessLogsById,
|
|
13435
|
+
{ path: { id } },
|
|
13436
|
+
options
|
|
13437
|
+
);
|
|
13438
|
+
}
|
|
13439
|
+
},
|
|
13440
|
+
/**
|
|
13441
|
+
* Disclosure Logs — records of data disclosures to third parties.
|
|
13442
|
+
*
|
|
13443
|
+
* HIPAA and state privacy laws require tracking disclosures of protected
|
|
13444
|
+
* information. Each log entry records what was disclosed, to whom, and
|
|
13445
|
+
* the legal basis for the disclosure.
|
|
13446
|
+
*/
|
|
13447
|
+
disclosureLogs: {
|
|
13448
|
+
/**
|
|
13449
|
+
* List disclosure logs with optional pagination.
|
|
13450
|
+
*
|
|
13451
|
+
* @param options - Optional page number, page size, and request options.
|
|
13452
|
+
* @returns A page of `DisclosureLog` records.
|
|
13453
|
+
*
|
|
13454
|
+
* @example
|
|
13455
|
+
* ```typescript
|
|
13456
|
+
* const logs = await client.compliance.disclosureLogs.list();
|
|
13457
|
+
* ```
|
|
13458
|
+
*/
|
|
13459
|
+
list: async (options) => {
|
|
13460
|
+
return rb.execute(
|
|
13461
|
+
getDisclosureLogs,
|
|
13462
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
13463
|
+
options
|
|
13464
|
+
);
|
|
13465
|
+
},
|
|
13466
|
+
/**
|
|
13467
|
+
* Retrieve a single disclosure log by ID.
|
|
13468
|
+
*
|
|
13469
|
+
* @param id - The UUID of the disclosure log.
|
|
13470
|
+
* @param options - Optional request options.
|
|
13471
|
+
* @returns The matching `DisclosureLog`.
|
|
13472
|
+
*
|
|
13473
|
+
* @example
|
|
13474
|
+
* ```typescript
|
|
13475
|
+
* const log = await client.compliance.disclosureLogs.get('dl-uuid');
|
|
13476
|
+
* ```
|
|
13477
|
+
*/
|
|
13478
|
+
get: async (id, options) => {
|
|
13479
|
+
return rb.execute(
|
|
13480
|
+
getDisclosureLogsById,
|
|
13481
|
+
{ path: { id } },
|
|
13482
|
+
options
|
|
13483
|
+
);
|
|
13484
|
+
},
|
|
13485
|
+
/**
|
|
13486
|
+
* Create a new disclosure log entry.
|
|
13487
|
+
*
|
|
13488
|
+
* @param attributes - Disclosure details (recipient, purpose, data categories, etc.).
|
|
13489
|
+
* @param options - Optional request options.
|
|
13490
|
+
* @returns The newly created `DisclosureLog`.
|
|
13491
|
+
*
|
|
13492
|
+
* @example
|
|
13493
|
+
* ```typescript
|
|
13494
|
+
* const log = await client.compliance.disclosureLogs.create({
|
|
13495
|
+
* recipient: 'Insurance Provider',
|
|
13496
|
+
* purpose: 'claims_processing',
|
|
13497
|
+
* data_categories: ['health_data'],
|
|
13498
|
+
* });
|
|
13499
|
+
* ```
|
|
13500
|
+
*/
|
|
13501
|
+
create: async (attributes, options) => {
|
|
13502
|
+
return rb.execute(
|
|
13503
|
+
postDisclosureLogs,
|
|
13504
|
+
{ body: { data: { type: "disclosure-log", attributes } } },
|
|
13505
|
+
options
|
|
13506
|
+
);
|
|
13507
|
+
},
|
|
13508
|
+
/**
|
|
13509
|
+
* List disclosure logs filtered by data subject.
|
|
13510
|
+
*
|
|
13511
|
+
* Returns all disclosures related to a specific data subject,
|
|
13512
|
+
* useful for fulfilling HIPAA accounting-of-disclosures requests.
|
|
13513
|
+
*
|
|
13514
|
+
* @param options - Filter by subject type/ID, plus optional pagination and request options.
|
|
13515
|
+
* @returns An array of `DisclosureLog` records for the subject.
|
|
13516
|
+
*
|
|
13517
|
+
* @example
|
|
13518
|
+
* ```typescript
|
|
13519
|
+
* const logs = await client.compliance.disclosureLogs.listBySubject({
|
|
13520
|
+
* filter: { subject_type: { eq: 'patient' }, subject_id: { eq: 'subj-123' } },
|
|
13521
|
+
* });
|
|
13522
|
+
* ```
|
|
13523
|
+
*/
|
|
13524
|
+
listBySubject: async (options) => {
|
|
13525
|
+
return rb.execute(
|
|
13526
|
+
getDisclosureLogsBySubject,
|
|
13527
|
+
{
|
|
13528
|
+
...buildPageQuery(options?.page, options?.pageSize),
|
|
13529
|
+
query: { filter: options?.filter }
|
|
13530
|
+
},
|
|
13531
|
+
options
|
|
13532
|
+
);
|
|
13533
|
+
}
|
|
13534
|
+
},
|
|
13535
|
+
/**
|
|
13536
|
+
* Amendment Requests — requests to correct or amend records.
|
|
13537
|
+
*
|
|
13538
|
+
* HIPAA gives patients the right to request amendments to their health
|
|
13539
|
+
* records. Each request goes through a review workflow: create, review,
|
|
13540
|
+
* approve/deny, and apply.
|
|
13541
|
+
*/
|
|
13542
|
+
amendmentRequests: {
|
|
13543
|
+
/**
|
|
13544
|
+
* List amendment requests with optional pagination.
|
|
13545
|
+
*
|
|
13546
|
+
* @param options - Optional page number, page size, and request options.
|
|
13547
|
+
* @returns A page of `AmendmentRequest` records.
|
|
13548
|
+
*
|
|
13549
|
+
* @example
|
|
13550
|
+
* ```typescript
|
|
13551
|
+
* const requests = await client.compliance.amendmentRequests.list();
|
|
13552
|
+
* ```
|
|
13553
|
+
*/
|
|
13554
|
+
list: async (options) => {
|
|
13555
|
+
return rb.execute(
|
|
13556
|
+
getAmendmentRequests,
|
|
13557
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
13558
|
+
options
|
|
13559
|
+
);
|
|
13560
|
+
},
|
|
13561
|
+
/**
|
|
13562
|
+
* Retrieve a single amendment request by ID.
|
|
13563
|
+
*
|
|
13564
|
+
* @param id - The UUID of the amendment request.
|
|
13565
|
+
* @param options - Optional request options.
|
|
13566
|
+
* @returns The matching `AmendmentRequest`.
|
|
13567
|
+
*
|
|
13568
|
+
* @example
|
|
13569
|
+
* ```typescript
|
|
13570
|
+
* const request = await client.compliance.amendmentRequests.get('ar-uuid');
|
|
13571
|
+
* ```
|
|
13572
|
+
*/
|
|
13573
|
+
get: async (id, options) => {
|
|
13574
|
+
return rb.execute(
|
|
13575
|
+
getAmendmentRequestsById,
|
|
13576
|
+
{ path: { id } },
|
|
13577
|
+
options
|
|
13578
|
+
);
|
|
13579
|
+
},
|
|
13580
|
+
/**
|
|
13581
|
+
* Create a new amendment request.
|
|
13582
|
+
*
|
|
13583
|
+
* @param attributes - Amendment request details (record reference, requested changes, reason).
|
|
13584
|
+
* @param options - Optional request options.
|
|
13585
|
+
* @returns The newly created `AmendmentRequest`.
|
|
13586
|
+
*
|
|
13587
|
+
* @example
|
|
13588
|
+
* ```typescript
|
|
13589
|
+
* const request = await client.compliance.amendmentRequests.create({
|
|
13590
|
+
* record_id: 'patient-record-uuid',
|
|
13591
|
+
* requested_change: 'Correct diagnosis code from E11.9 to E10.9',
|
|
13592
|
+
* reason: 'Misclassification during initial intake.',
|
|
13593
|
+
* });
|
|
13594
|
+
* ```
|
|
13595
|
+
*/
|
|
13596
|
+
create: async (attributes, options) => {
|
|
13597
|
+
return rb.execute(
|
|
13598
|
+
postAmendmentRequests,
|
|
13599
|
+
{ body: { data: { type: "amendment-request", attributes } } },
|
|
13600
|
+
options
|
|
13601
|
+
);
|
|
13602
|
+
},
|
|
13603
|
+
/**
|
|
13604
|
+
* Mark an amendment request as under review.
|
|
13605
|
+
*
|
|
13606
|
+
* @param id - The UUID of the amendment request.
|
|
13607
|
+
* @param attributes - Optional review attributes.
|
|
13608
|
+
* @param options - Optional request options.
|
|
13609
|
+
* @returns The updated `AmendmentRequest`.
|
|
13610
|
+
*
|
|
13611
|
+
* @example
|
|
13612
|
+
* ```typescript
|
|
13613
|
+
* const request = await client.compliance.amendmentRequests.review('ar-uuid');
|
|
13614
|
+
* ```
|
|
13615
|
+
*/
|
|
13616
|
+
review: async (id, attributes, options) => {
|
|
13617
|
+
return rb.execute(
|
|
13618
|
+
patchAmendmentRequestsByIdReview,
|
|
13619
|
+
{
|
|
13620
|
+
path: { id },
|
|
13621
|
+
body: {
|
|
13622
|
+
data: {
|
|
13623
|
+
type: "amendment-request",
|
|
13624
|
+
id,
|
|
13625
|
+
attributes: attributes ?? {}
|
|
13626
|
+
}
|
|
13627
|
+
}
|
|
13628
|
+
},
|
|
13629
|
+
options
|
|
13630
|
+
);
|
|
13631
|
+
},
|
|
13632
|
+
/**
|
|
13633
|
+
* Approve an amendment request.
|
|
13634
|
+
*
|
|
13635
|
+
* @param id - The UUID of the amendment request.
|
|
13636
|
+
* @param attributes - Optional approval attributes.
|
|
13637
|
+
* @param options - Optional request options.
|
|
13638
|
+
* @returns The updated `AmendmentRequest` with approved status.
|
|
13639
|
+
*
|
|
13640
|
+
* @example
|
|
13641
|
+
* ```typescript
|
|
13642
|
+
* const request = await client.compliance.amendmentRequests.approve('ar-uuid');
|
|
13643
|
+
* ```
|
|
13644
|
+
*/
|
|
13645
|
+
approve: async (id, attributes, options) => {
|
|
13646
|
+
return rb.execute(
|
|
13647
|
+
patchAmendmentRequestsByIdApprove,
|
|
13648
|
+
{
|
|
13649
|
+
path: { id },
|
|
13650
|
+
body: {
|
|
13651
|
+
data: {
|
|
13652
|
+
type: "amendment-request",
|
|
13653
|
+
id,
|
|
13654
|
+
attributes: attributes ?? {}
|
|
13655
|
+
}
|
|
13656
|
+
}
|
|
13657
|
+
},
|
|
13658
|
+
options
|
|
13659
|
+
);
|
|
13660
|
+
},
|
|
13661
|
+
/**
|
|
13662
|
+
* Deny an amendment request.
|
|
13663
|
+
*
|
|
13664
|
+
* @param id - The UUID of the amendment request.
|
|
13665
|
+
* @param attributes - Optional denial reason attributes.
|
|
13666
|
+
* @param options - Optional request options.
|
|
13667
|
+
* @returns The updated `AmendmentRequest` with denied status.
|
|
13668
|
+
*
|
|
13669
|
+
* @example
|
|
13670
|
+
* ```typescript
|
|
13671
|
+
* const request = await client.compliance.amendmentRequests.deny('ar-uuid', {
|
|
13672
|
+
* denial_reason: 'Record is accurate as documented.',
|
|
13673
|
+
* });
|
|
13674
|
+
* ```
|
|
13675
|
+
*/
|
|
13676
|
+
deny: async (id, attributes, options) => {
|
|
13677
|
+
return rb.execute(
|
|
13678
|
+
patchAmendmentRequestsByIdDeny,
|
|
13679
|
+
{
|
|
13680
|
+
path: { id },
|
|
13681
|
+
body: {
|
|
13682
|
+
data: {
|
|
13683
|
+
type: "amendment-request",
|
|
13684
|
+
id,
|
|
13685
|
+
attributes: attributes ?? {}
|
|
13686
|
+
}
|
|
13687
|
+
}
|
|
13688
|
+
},
|
|
13689
|
+
options
|
|
13690
|
+
);
|
|
13691
|
+
},
|
|
13692
|
+
/**
|
|
13693
|
+
* Apply an approved amendment to the target record.
|
|
13694
|
+
*
|
|
13695
|
+
* @param id - The UUID of the amendment request.
|
|
13696
|
+
* @param attributes - Optional application attributes.
|
|
13697
|
+
* @param options - Optional request options.
|
|
13698
|
+
* @returns The updated `AmendmentRequest` with applied status.
|
|
13699
|
+
*
|
|
13700
|
+
* @example
|
|
13701
|
+
* ```typescript
|
|
13702
|
+
* const request = await client.compliance.amendmentRequests.apply('ar-uuid');
|
|
13703
|
+
* ```
|
|
13704
|
+
*/
|
|
13705
|
+
apply: async (id, attributes, options) => {
|
|
13706
|
+
return rb.execute(
|
|
13707
|
+
patchAmendmentRequestsByIdApply,
|
|
13708
|
+
{
|
|
13709
|
+
path: { id },
|
|
13710
|
+
body: {
|
|
13711
|
+
data: {
|
|
13712
|
+
type: "amendment-request",
|
|
13713
|
+
id,
|
|
13714
|
+
attributes: attributes ?? {}
|
|
13715
|
+
}
|
|
13716
|
+
}
|
|
13717
|
+
},
|
|
13718
|
+
options
|
|
13719
|
+
);
|
|
13720
|
+
}
|
|
13721
|
+
},
|
|
13722
|
+
/**
|
|
13723
|
+
* Compliance Document Templates — reusable templates for compliance documentation.
|
|
13724
|
+
*
|
|
13725
|
+
* Templates provide standardized starting points for policies, procedures,
|
|
13726
|
+
* and forms required by regulatory frameworks. Templates can be cloned
|
|
13727
|
+
* to create workspace-specific documents.
|
|
13728
|
+
*/
|
|
13729
|
+
complianceDocumentTemplates: {
|
|
13730
|
+
/**
|
|
13731
|
+
* List compliance document templates with optional pagination.
|
|
13732
|
+
*
|
|
13733
|
+
* @param options - Optional page number, page size, and request options.
|
|
13734
|
+
* @returns A page of `ComplianceDocumentTemplate` records.
|
|
13735
|
+
*
|
|
13736
|
+
* @example
|
|
13737
|
+
* ```typescript
|
|
13738
|
+
* const templates = await client.compliance.complianceDocumentTemplates.list();
|
|
13739
|
+
* ```
|
|
13740
|
+
*/
|
|
13741
|
+
list: async (options) => {
|
|
13742
|
+
return rb.execute(
|
|
13743
|
+
getComplianceDocumentTemplates,
|
|
13744
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
13745
|
+
options
|
|
13746
|
+
);
|
|
13747
|
+
},
|
|
13748
|
+
/**
|
|
13749
|
+
* Retrieve a single compliance document template by ID.
|
|
13750
|
+
*
|
|
13751
|
+
* @param id - The UUID of the template.
|
|
13752
|
+
* @param options - Optional request options.
|
|
13753
|
+
* @returns The matching `ComplianceDocumentTemplate`.
|
|
13754
|
+
*
|
|
13755
|
+
* @example
|
|
13756
|
+
* ```typescript
|
|
13757
|
+
* const template = await client.compliance.complianceDocumentTemplates.get('tpl-uuid');
|
|
13758
|
+
* ```
|
|
13759
|
+
*/
|
|
13760
|
+
get: async (id, options) => {
|
|
13761
|
+
return rb.execute(
|
|
13762
|
+
getComplianceDocumentTemplatesById,
|
|
13763
|
+
{ path: { id } },
|
|
13764
|
+
options
|
|
13765
|
+
);
|
|
13766
|
+
},
|
|
13767
|
+
/**
|
|
13768
|
+
* Create a new compliance document template.
|
|
13769
|
+
*
|
|
13770
|
+
* @param attributes - Template attributes (title, content, framework, etc.).
|
|
13771
|
+
* @param options - Optional request options.
|
|
13772
|
+
* @returns The newly created `ComplianceDocumentTemplate`.
|
|
13773
|
+
*
|
|
13774
|
+
* @example
|
|
13775
|
+
* ```typescript
|
|
13776
|
+
* const template = await client.compliance.complianceDocumentTemplates.create({
|
|
13777
|
+
* title: 'HIPAA Privacy Policy Template',
|
|
13778
|
+
* framework: 'hipaa',
|
|
13779
|
+
* content: '# Privacy Policy\n...',
|
|
13780
|
+
* });
|
|
13781
|
+
* ```
|
|
13782
|
+
*/
|
|
13783
|
+
create: async (attributes, options) => {
|
|
13784
|
+
return rb.execute(
|
|
13785
|
+
postComplianceDocumentTemplates,
|
|
13786
|
+
{
|
|
13787
|
+
body: {
|
|
13788
|
+
data: { type: "compliance-document-template", attributes }
|
|
13789
|
+
}
|
|
13790
|
+
},
|
|
13791
|
+
options
|
|
13792
|
+
);
|
|
13793
|
+
},
|
|
13794
|
+
/**
|
|
13795
|
+
* Update a compliance document template.
|
|
13796
|
+
*
|
|
13797
|
+
* @param id - The UUID of the template to update.
|
|
13798
|
+
* @param attributes - Attribute map of fields to change.
|
|
13799
|
+
* @param options - Optional request options.
|
|
13800
|
+
* @returns The updated `ComplianceDocumentTemplate`.
|
|
13801
|
+
*
|
|
13802
|
+
* @example
|
|
13803
|
+
* ```typescript
|
|
13804
|
+
* const template = await client.compliance.complianceDocumentTemplates.update(
|
|
13805
|
+
* 'tpl-uuid', { content: '# Updated Policy\n...' },
|
|
13806
|
+
* );
|
|
13807
|
+
* ```
|
|
13808
|
+
*/
|
|
13809
|
+
update: async (id, attributes, options) => {
|
|
13810
|
+
return rb.execute(
|
|
13811
|
+
patchComplianceDocumentTemplatesById,
|
|
13812
|
+
{
|
|
13813
|
+
path: { id },
|
|
13814
|
+
body: {
|
|
13815
|
+
data: {
|
|
13816
|
+
type: "compliance-document-template",
|
|
13817
|
+
id,
|
|
13818
|
+
attributes
|
|
13819
|
+
}
|
|
13820
|
+
}
|
|
13821
|
+
},
|
|
13822
|
+
options
|
|
13823
|
+
);
|
|
13824
|
+
},
|
|
13825
|
+
/**
|
|
13826
|
+
* Clone a compliance document template into a new document.
|
|
13827
|
+
*
|
|
13828
|
+
* Creates a copy of the template that can be customized independently.
|
|
13829
|
+
*
|
|
13830
|
+
* @param attributes - Clone attributes (e.g., target workspace or overrides).
|
|
13831
|
+
* @param options - Optional request options.
|
|
13832
|
+
* @returns The cloned `ComplianceDocumentTemplate`.
|
|
13833
|
+
*
|
|
13834
|
+
* @example
|
|
13835
|
+
* ```typescript
|
|
13836
|
+
* const cloned = await client.compliance.complianceDocumentTemplates.clone({
|
|
13837
|
+
* source_template_id: 'tpl-uuid',
|
|
13838
|
+
* title: 'Our HIPAA Privacy Policy',
|
|
13839
|
+
* });
|
|
13840
|
+
* ```
|
|
13841
|
+
*/
|
|
13842
|
+
clone: async (attributes, options) => {
|
|
13843
|
+
return rb.execute(
|
|
13844
|
+
postComplianceDocumentTemplatesClone,
|
|
13845
|
+
{
|
|
13846
|
+
body: {
|
|
13847
|
+
data: { type: "compliance-document-template", attributes }
|
|
13848
|
+
}
|
|
13849
|
+
},
|
|
13850
|
+
options
|
|
13851
|
+
);
|
|
13852
|
+
}
|
|
13853
|
+
},
|
|
13854
|
+
/**
|
|
13855
|
+
* Business Associate Agreements — HIPAA BAA lifecycle management.
|
|
13856
|
+
*
|
|
13857
|
+
* HIPAA requires covered entities to execute BAAs with business associates
|
|
13858
|
+
* who handle PHI. Track agreements through creation, signing, and
|
|
13859
|
+
* termination.
|
|
13860
|
+
*/
|
|
13861
|
+
businessAssociateAgreements: {
|
|
13862
|
+
/**
|
|
13863
|
+
* List business associate agreements with optional pagination.
|
|
13864
|
+
*
|
|
13865
|
+
* @param options - Optional page number, page size, and request options.
|
|
13866
|
+
* @returns A page of `BusinessAssociateAgreement` records.
|
|
13867
|
+
*
|
|
13868
|
+
* @example
|
|
13869
|
+
* ```typescript
|
|
13870
|
+
* const baas = await client.compliance.businessAssociateAgreements.list();
|
|
13871
|
+
* ```
|
|
13872
|
+
*/
|
|
13873
|
+
list: async (options) => {
|
|
13874
|
+
return rb.execute(
|
|
13875
|
+
getBusinessAssociateAgreements,
|
|
13876
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
13877
|
+
options
|
|
13878
|
+
);
|
|
13879
|
+
},
|
|
13880
|
+
/**
|
|
13881
|
+
* Retrieve a single BAA by ID.
|
|
13882
|
+
*
|
|
13883
|
+
* @param id - The UUID of the BAA.
|
|
13884
|
+
* @param options - Optional request options.
|
|
13885
|
+
* @returns The matching `BusinessAssociateAgreement`.
|
|
13886
|
+
*
|
|
13887
|
+
* @example
|
|
13888
|
+
* ```typescript
|
|
13889
|
+
* const baa = await client.compliance.businessAssociateAgreements.get('baa-uuid');
|
|
13890
|
+
* ```
|
|
13891
|
+
*/
|
|
13892
|
+
get: async (id, options) => {
|
|
13893
|
+
return rb.execute(
|
|
13894
|
+
getBusinessAssociateAgreementsById,
|
|
13895
|
+
{ path: { id } },
|
|
13896
|
+
options
|
|
13897
|
+
);
|
|
13898
|
+
},
|
|
13899
|
+
/**
|
|
13900
|
+
* Create a new business associate agreement.
|
|
13901
|
+
*
|
|
13902
|
+
* @param attributes - BAA attributes (associate name, terms, effective date, etc.).
|
|
13903
|
+
* @param options - Optional request options.
|
|
13904
|
+
* @returns The newly created `BusinessAssociateAgreement`.
|
|
13905
|
+
*
|
|
13906
|
+
* @example
|
|
13907
|
+
* ```typescript
|
|
13908
|
+
* const baa = await client.compliance.businessAssociateAgreements.create({
|
|
13909
|
+
* associate_name: 'Cloud Storage Inc.',
|
|
13910
|
+
* effective_date: '2026-01-01',
|
|
13911
|
+
* });
|
|
13912
|
+
* ```
|
|
13913
|
+
*/
|
|
13914
|
+
create: async (attributes, options) => {
|
|
13915
|
+
return rb.execute(
|
|
13916
|
+
postBusinessAssociateAgreements,
|
|
13917
|
+
{
|
|
13918
|
+
body: {
|
|
13919
|
+
data: { type: "business-associate-agreement", attributes }
|
|
13920
|
+
}
|
|
13921
|
+
},
|
|
13922
|
+
options
|
|
13923
|
+
);
|
|
13924
|
+
},
|
|
13925
|
+
/**
|
|
13926
|
+
* Update a business associate agreement.
|
|
13927
|
+
*
|
|
13928
|
+
* @param id - The UUID of the BAA to update.
|
|
13929
|
+
* @param attributes - Attribute map of fields to change.
|
|
13930
|
+
* @param options - Optional request options.
|
|
13931
|
+
* @returns The updated `BusinessAssociateAgreement`.
|
|
13932
|
+
*
|
|
13933
|
+
* @example
|
|
13934
|
+
* ```typescript
|
|
13935
|
+
* const baa = await client.compliance.businessAssociateAgreements.update(
|
|
13936
|
+
* 'baa-uuid', { terms: 'Updated terms...' },
|
|
13937
|
+
* );
|
|
13938
|
+
* ```
|
|
13939
|
+
*/
|
|
13940
|
+
update: async (id, attributes, options) => {
|
|
13941
|
+
return rb.execute(
|
|
13942
|
+
patchBusinessAssociateAgreementsById,
|
|
13943
|
+
{
|
|
13944
|
+
path: { id },
|
|
13945
|
+
body: {
|
|
13946
|
+
data: {
|
|
13947
|
+
type: "business-associate-agreement",
|
|
13948
|
+
id,
|
|
13949
|
+
attributes
|
|
13950
|
+
}
|
|
13951
|
+
}
|
|
13952
|
+
},
|
|
13953
|
+
options
|
|
13954
|
+
);
|
|
13955
|
+
},
|
|
13956
|
+
/**
|
|
13957
|
+
* Sign a business associate agreement.
|
|
13958
|
+
*
|
|
13959
|
+
* Records the signing event with timestamp and signer identity.
|
|
13960
|
+
*
|
|
13961
|
+
* @param id - The UUID of the BAA to sign.
|
|
13962
|
+
* @param attributes - Optional signing attributes.
|
|
13963
|
+
* @param options - Optional request options.
|
|
13964
|
+
* @returns The updated `BusinessAssociateAgreement` with signed status.
|
|
13965
|
+
*
|
|
13966
|
+
* @example
|
|
13967
|
+
* ```typescript
|
|
13968
|
+
* const baa = await client.compliance.businessAssociateAgreements.sign('baa-uuid');
|
|
13969
|
+
* ```
|
|
13970
|
+
*/
|
|
13971
|
+
sign: async (id, attributes, options) => {
|
|
13972
|
+
return rb.execute(
|
|
13973
|
+
patchBusinessAssociateAgreementsByIdSign,
|
|
13974
|
+
{
|
|
13975
|
+
path: { id },
|
|
13976
|
+
body: {
|
|
13977
|
+
data: {
|
|
13978
|
+
type: "business-associate-agreement",
|
|
13979
|
+
id,
|
|
13980
|
+
attributes: attributes ?? {}
|
|
13981
|
+
}
|
|
13982
|
+
}
|
|
13983
|
+
},
|
|
13984
|
+
options
|
|
13985
|
+
);
|
|
13986
|
+
},
|
|
13987
|
+
/**
|
|
13988
|
+
* Terminate a business associate agreement.
|
|
13989
|
+
*
|
|
13990
|
+
* Ends the BAA relationship. Records termination date and reason.
|
|
13991
|
+
*
|
|
13992
|
+
* @param id - The UUID of the BAA to terminate.
|
|
13993
|
+
* @param attributes - Optional termination attributes (reason, effective date).
|
|
13994
|
+
* @param options - Optional request options.
|
|
13995
|
+
* @returns The updated `BusinessAssociateAgreement` with terminated status.
|
|
13996
|
+
*
|
|
13997
|
+
* @example
|
|
13998
|
+
* ```typescript
|
|
13999
|
+
* const baa = await client.compliance.businessAssociateAgreements.terminate(
|
|
14000
|
+
* 'baa-uuid', { reason: 'Contract not renewed.' },
|
|
14001
|
+
* );
|
|
14002
|
+
* ```
|
|
14003
|
+
*/
|
|
14004
|
+
terminate: async (id, attributes, options) => {
|
|
14005
|
+
return rb.execute(
|
|
14006
|
+
patchBusinessAssociateAgreementsByIdTerminate,
|
|
14007
|
+
{
|
|
14008
|
+
path: { id },
|
|
14009
|
+
body: {
|
|
14010
|
+
data: {
|
|
14011
|
+
type: "business-associate-agreement",
|
|
14012
|
+
id,
|
|
14013
|
+
attributes: attributes ?? {}
|
|
14014
|
+
}
|
|
14015
|
+
}
|
|
14016
|
+
},
|
|
14017
|
+
options
|
|
14018
|
+
);
|
|
14019
|
+
}
|
|
14020
|
+
},
|
|
14021
|
+
/**
|
|
14022
|
+
* Policy Review Schedules — track periodic policy review cycles.
|
|
14023
|
+
*
|
|
14024
|
+
* Regulatory frameworks require periodic review of compliance policies.
|
|
14025
|
+
* Schedules track when reviews are due, overdue, or completed.
|
|
14026
|
+
*/
|
|
14027
|
+
policyReviewSchedules: {
|
|
14028
|
+
/**
|
|
14029
|
+
* List policy review schedules with optional pagination.
|
|
14030
|
+
*
|
|
14031
|
+
* @param options - Optional page number, page size, and request options.
|
|
14032
|
+
* @returns A page of `PolicyReviewSchedule` records.
|
|
14033
|
+
*
|
|
14034
|
+
* @example
|
|
14035
|
+
* ```typescript
|
|
14036
|
+
* const schedules = await client.compliance.policyReviewSchedules.list();
|
|
14037
|
+
* ```
|
|
14038
|
+
*/
|
|
14039
|
+
list: async (options) => {
|
|
14040
|
+
return rb.execute(
|
|
14041
|
+
getPolicyReviewSchedules,
|
|
14042
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
14043
|
+
options
|
|
14044
|
+
);
|
|
14045
|
+
},
|
|
14046
|
+
/**
|
|
14047
|
+
* Retrieve a single policy review schedule by ID.
|
|
14048
|
+
*
|
|
14049
|
+
* @param id - The UUID of the policy review schedule.
|
|
14050
|
+
* @param options - Optional request options.
|
|
14051
|
+
* @returns The matching `PolicyReviewSchedule`.
|
|
14052
|
+
*
|
|
14053
|
+
* @example
|
|
14054
|
+
* ```typescript
|
|
14055
|
+
* const schedule = await client.compliance.policyReviewSchedules.get('prs-uuid');
|
|
14056
|
+
* ```
|
|
14057
|
+
*/
|
|
14058
|
+
get: async (id, options) => {
|
|
14059
|
+
return rb.execute(
|
|
14060
|
+
getPolicyReviewSchedulesById,
|
|
14061
|
+
{ path: { id } },
|
|
14062
|
+
options
|
|
14063
|
+
);
|
|
14064
|
+
},
|
|
14065
|
+
/**
|
|
14066
|
+
* Create a new policy review schedule.
|
|
14067
|
+
*
|
|
14068
|
+
* @param attributes - Schedule attributes (policy reference, frequency, next review date).
|
|
14069
|
+
* @param options - Optional request options.
|
|
14070
|
+
* @returns The newly created `PolicyReviewSchedule`.
|
|
14071
|
+
*
|
|
14072
|
+
* @example
|
|
14073
|
+
* ```typescript
|
|
14074
|
+
* const schedule = await client.compliance.policyReviewSchedules.create({
|
|
14075
|
+
* policy_name: 'Data Retention Policy',
|
|
14076
|
+
* review_frequency_days: 365,
|
|
14077
|
+
* next_review_date: '2027-01-01',
|
|
14078
|
+
* });
|
|
14079
|
+
* ```
|
|
14080
|
+
*/
|
|
14081
|
+
create: async (attributes, options) => {
|
|
14082
|
+
return rb.execute(
|
|
14083
|
+
postPolicyReviewSchedules,
|
|
14084
|
+
{
|
|
14085
|
+
body: {
|
|
14086
|
+
data: { type: "policy-review-schedule", attributes }
|
|
14087
|
+
}
|
|
14088
|
+
},
|
|
14089
|
+
options
|
|
14090
|
+
);
|
|
14091
|
+
},
|
|
14092
|
+
/**
|
|
14093
|
+
* Mark a policy review as completed.
|
|
14094
|
+
*
|
|
14095
|
+
* @param id - The UUID of the policy review schedule.
|
|
14096
|
+
* @param attributes - Optional completion attributes (reviewer, notes).
|
|
14097
|
+
* @param options - Optional request options.
|
|
14098
|
+
* @returns The updated `PolicyReviewSchedule`.
|
|
14099
|
+
*
|
|
14100
|
+
* @example
|
|
14101
|
+
* ```typescript
|
|
14102
|
+
* const schedule = await client.compliance.policyReviewSchedules.completeReview(
|
|
14103
|
+
* 'prs-uuid', { reviewer: 'compliance-officer-uuid' },
|
|
14104
|
+
* );
|
|
14105
|
+
* ```
|
|
14106
|
+
*/
|
|
14107
|
+
completeReview: async (id, attributes, options) => {
|
|
14108
|
+
return rb.execute(
|
|
14109
|
+
patchPolicyReviewSchedulesByIdCompleteReview,
|
|
14110
|
+
{
|
|
14111
|
+
path: { id },
|
|
14112
|
+
body: {
|
|
14113
|
+
data: {
|
|
14114
|
+
type: "policy-review-schedule",
|
|
14115
|
+
id,
|
|
14116
|
+
attributes: attributes ?? {}
|
|
14117
|
+
}
|
|
14118
|
+
}
|
|
14119
|
+
},
|
|
14120
|
+
options
|
|
14121
|
+
);
|
|
14122
|
+
},
|
|
14123
|
+
/**
|
|
14124
|
+
* Mark a policy review schedule as due.
|
|
14125
|
+
*
|
|
14126
|
+
* @param id - The UUID of the policy review schedule.
|
|
14127
|
+
* @param attributes - Optional attributes.
|
|
14128
|
+
* @param options - Optional request options.
|
|
14129
|
+
* @returns The updated `PolicyReviewSchedule`.
|
|
14130
|
+
*
|
|
14131
|
+
* @example
|
|
14132
|
+
* ```typescript
|
|
14133
|
+
* const schedule = await client.compliance.policyReviewSchedules.markDue('prs-uuid');
|
|
14134
|
+
* ```
|
|
14135
|
+
*/
|
|
14136
|
+
markDue: async (id, attributes, options) => {
|
|
14137
|
+
return rb.execute(
|
|
14138
|
+
patchPolicyReviewSchedulesByIdMarkDue,
|
|
14139
|
+
{
|
|
14140
|
+
path: { id },
|
|
14141
|
+
body: {
|
|
14142
|
+
data: {
|
|
14143
|
+
type: "policy-review-schedule",
|
|
14144
|
+
id,
|
|
14145
|
+
attributes: attributes ?? {}
|
|
14146
|
+
}
|
|
14147
|
+
}
|
|
14148
|
+
},
|
|
14149
|
+
options
|
|
14150
|
+
);
|
|
14151
|
+
},
|
|
14152
|
+
/**
|
|
14153
|
+
* Mark a policy review schedule as overdue.
|
|
14154
|
+
*
|
|
14155
|
+
* @param id - The UUID of the policy review schedule.
|
|
14156
|
+
* @param attributes - Optional attributes.
|
|
14157
|
+
* @param options - Optional request options.
|
|
14158
|
+
* @returns The updated `PolicyReviewSchedule`.
|
|
14159
|
+
*
|
|
14160
|
+
* @example
|
|
14161
|
+
* ```typescript
|
|
14162
|
+
* const schedule = await client.compliance.policyReviewSchedules.markOverdue('prs-uuid');
|
|
14163
|
+
* ```
|
|
14164
|
+
*/
|
|
14165
|
+
markOverdue: async (id, attributes, options) => {
|
|
14166
|
+
return rb.execute(
|
|
14167
|
+
patchPolicyReviewSchedulesByIdMarkOverdue,
|
|
14168
|
+
{
|
|
14169
|
+
path: { id },
|
|
14170
|
+
body: {
|
|
14171
|
+
data: {
|
|
14172
|
+
type: "policy-review-schedule",
|
|
14173
|
+
id,
|
|
14174
|
+
attributes: attributes ?? {}
|
|
14175
|
+
}
|
|
14176
|
+
}
|
|
14177
|
+
},
|
|
14178
|
+
options
|
|
14179
|
+
);
|
|
14180
|
+
}
|
|
14181
|
+
},
|
|
14182
|
+
/**
|
|
14183
|
+
* Compliance Requirements — regulatory requirements tracking.
|
|
14184
|
+
*
|
|
14185
|
+
* Track individual requirements from regulatory frameworks (HIPAA, GDPR,
|
|
14186
|
+
* PCI DSS, SOC 2). Each requirement can be created, updated with
|
|
14187
|
+
* implementation status, and deleted when no longer applicable.
|
|
14188
|
+
*/
|
|
14189
|
+
complianceRequirements: {
|
|
14190
|
+
/**
|
|
14191
|
+
* List compliance requirements with optional pagination.
|
|
14192
|
+
*
|
|
14193
|
+
* @param options - Optional page number, page size, and request options.
|
|
14194
|
+
* @returns A page of `ComplianceRequirement` records.
|
|
14195
|
+
*
|
|
14196
|
+
* @example
|
|
14197
|
+
* ```typescript
|
|
14198
|
+
* const requirements = await client.compliance.complianceRequirements.list();
|
|
14199
|
+
* ```
|
|
14200
|
+
*/
|
|
14201
|
+
list: async (options) => {
|
|
14202
|
+
return rb.execute(
|
|
14203
|
+
getComplianceRequirements,
|
|
14204
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
14205
|
+
options
|
|
14206
|
+
);
|
|
14207
|
+
},
|
|
14208
|
+
/**
|
|
14209
|
+
* Retrieve a single compliance requirement by ID.
|
|
14210
|
+
*
|
|
14211
|
+
* @param id - The UUID of the compliance requirement.
|
|
14212
|
+
* @param options - Optional request options.
|
|
14213
|
+
* @returns The matching `ComplianceRequirement`.
|
|
14214
|
+
*
|
|
14215
|
+
* @example
|
|
14216
|
+
* ```typescript
|
|
14217
|
+
* const req = await client.compliance.complianceRequirements.get('cr-uuid');
|
|
14218
|
+
* ```
|
|
14219
|
+
*/
|
|
14220
|
+
get: async (id, options) => {
|
|
14221
|
+
return rb.execute(
|
|
14222
|
+
getComplianceRequirementsById,
|
|
14223
|
+
{ path: { id } },
|
|
14224
|
+
options
|
|
14225
|
+
);
|
|
14226
|
+
},
|
|
14227
|
+
/**
|
|
14228
|
+
* Create a new compliance requirement.
|
|
14229
|
+
*
|
|
14230
|
+
* @param attributes - Requirement attributes (framework, control ID, description, etc.).
|
|
14231
|
+
* @param options - Optional request options.
|
|
14232
|
+
* @returns The newly created `ComplianceRequirement`.
|
|
14233
|
+
*
|
|
14234
|
+
* @example
|
|
14235
|
+
* ```typescript
|
|
14236
|
+
* const req = await client.compliance.complianceRequirements.create({
|
|
14237
|
+
* framework: 'hipaa',
|
|
14238
|
+
* control_id: '164.312(a)(1)',
|
|
14239
|
+
* description: 'Access Control — Unique User Identification',
|
|
14240
|
+
* });
|
|
14241
|
+
* ```
|
|
14242
|
+
*/
|
|
14243
|
+
create: async (attributes, options) => {
|
|
14244
|
+
return rb.execute(
|
|
14245
|
+
postComplianceRequirements,
|
|
14246
|
+
{
|
|
14247
|
+
body: {
|
|
14248
|
+
data: { type: "compliance-requirement", attributes }
|
|
14249
|
+
}
|
|
14250
|
+
},
|
|
14251
|
+
options
|
|
14252
|
+
);
|
|
14253
|
+
},
|
|
14254
|
+
/**
|
|
14255
|
+
* Update a compliance requirement.
|
|
14256
|
+
*
|
|
14257
|
+
* @param id - The UUID of the compliance requirement to update.
|
|
14258
|
+
* @param attributes - Attribute map of fields to change.
|
|
14259
|
+
* @param options - Optional request options.
|
|
14260
|
+
* @returns The updated `ComplianceRequirement`.
|
|
14261
|
+
*
|
|
14262
|
+
* @example
|
|
14263
|
+
* ```typescript
|
|
14264
|
+
* const req = await client.compliance.complianceRequirements.update(
|
|
14265
|
+
* 'cr-uuid', { status: 'implemented' },
|
|
14266
|
+
* );
|
|
14267
|
+
* ```
|
|
14268
|
+
*/
|
|
14269
|
+
update: async (id, attributes, options) => {
|
|
14270
|
+
return rb.execute(
|
|
14271
|
+
patchComplianceRequirementsById,
|
|
14272
|
+
{
|
|
14273
|
+
path: { id },
|
|
14274
|
+
body: {
|
|
14275
|
+
data: { type: "compliance-requirement", id, attributes }
|
|
14276
|
+
}
|
|
14277
|
+
},
|
|
14278
|
+
options
|
|
14279
|
+
);
|
|
14280
|
+
},
|
|
14281
|
+
/**
|
|
14282
|
+
* Delete a compliance requirement.
|
|
14283
|
+
*
|
|
14284
|
+
* @param id - The UUID of the compliance requirement to delete.
|
|
14285
|
+
* @param options - Optional request options.
|
|
14286
|
+
* @returns `true` on successful deletion.
|
|
14287
|
+
*
|
|
14288
|
+
* @example
|
|
14289
|
+
* ```typescript
|
|
14290
|
+
* await client.compliance.complianceRequirements.delete('cr-uuid');
|
|
14291
|
+
* ```
|
|
14292
|
+
*/
|
|
14293
|
+
delete: async (id, options) => {
|
|
14294
|
+
return rb.executeDelete(
|
|
14295
|
+
deleteComplianceRequirementsById,
|
|
14296
|
+
{ path: { id } },
|
|
14297
|
+
options
|
|
14298
|
+
);
|
|
14299
|
+
}
|
|
14300
|
+
},
|
|
14301
|
+
/**
|
|
14302
|
+
* Compliance Requirement Completions — evidence of requirement fulfillment.
|
|
14303
|
+
*
|
|
14304
|
+
* Each completion record links a compliance requirement to the evidence
|
|
14305
|
+
* or action that satisfies it. Read-only once created — completions
|
|
14306
|
+
* serve as an immutable audit trail.
|
|
14307
|
+
*/
|
|
14308
|
+
complianceRequirementCompletions: {
|
|
14309
|
+
/**
|
|
14310
|
+
* List compliance requirement completions with optional pagination.
|
|
14311
|
+
*
|
|
14312
|
+
* @param options - Optional page number, page size, and request options.
|
|
14313
|
+
* @returns A page of `ComplianceRequirementCompletion` records.
|
|
14314
|
+
*
|
|
14315
|
+
* @example
|
|
14316
|
+
* ```typescript
|
|
14317
|
+
* const completions = await client.compliance.complianceRequirementCompletions.list();
|
|
14318
|
+
* ```
|
|
14319
|
+
*/
|
|
14320
|
+
list: async (options) => {
|
|
14321
|
+
return rb.execute(
|
|
14322
|
+
getComplianceRequirementCompletions,
|
|
14323
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
14324
|
+
options
|
|
14325
|
+
);
|
|
14326
|
+
},
|
|
14327
|
+
/**
|
|
14328
|
+
* Retrieve a single compliance requirement completion by ID.
|
|
14329
|
+
*
|
|
14330
|
+
* @param id - The UUID of the completion record.
|
|
14331
|
+
* @param options - Optional request options.
|
|
14332
|
+
* @returns The matching `ComplianceRequirementCompletion`.
|
|
14333
|
+
*
|
|
14334
|
+
* @example
|
|
14335
|
+
* ```typescript
|
|
14336
|
+
* const completion = await client.compliance.complianceRequirementCompletions.get('crc-uuid');
|
|
14337
|
+
* ```
|
|
14338
|
+
*/
|
|
14339
|
+
get: async (id, options) => {
|
|
14340
|
+
return rb.execute(
|
|
14341
|
+
getComplianceRequirementCompletionsById,
|
|
14342
|
+
{ path: { id } },
|
|
14343
|
+
options
|
|
14344
|
+
);
|
|
14345
|
+
},
|
|
14346
|
+
/**
|
|
14347
|
+
* Create a new compliance requirement completion record.
|
|
14348
|
+
*
|
|
14349
|
+
* @param attributes - Completion attributes (requirement ID, evidence, completed by, etc.).
|
|
14350
|
+
* @param options - Optional request options.
|
|
14351
|
+
* @returns The newly created `ComplianceRequirementCompletion`.
|
|
14352
|
+
*
|
|
14353
|
+
* @example
|
|
14354
|
+
* ```typescript
|
|
14355
|
+
* const completion = await client.compliance.complianceRequirementCompletions.create({
|
|
14356
|
+
* compliance_requirement_id: 'cr-uuid',
|
|
14357
|
+
* evidence: 'Access controls verified via penetration test report.',
|
|
14358
|
+
* });
|
|
14359
|
+
* ```
|
|
14360
|
+
*/
|
|
14361
|
+
create: async (attributes, options) => {
|
|
14362
|
+
return rb.execute(
|
|
14363
|
+
postComplianceRequirementCompletions,
|
|
14364
|
+
{
|
|
14365
|
+
body: {
|
|
14366
|
+
data: {
|
|
14367
|
+
type: "compliance-requirement-completion",
|
|
14368
|
+
attributes
|
|
14369
|
+
}
|
|
14370
|
+
}
|
|
14371
|
+
},
|
|
14372
|
+
options
|
|
14373
|
+
);
|
|
14374
|
+
}
|
|
14375
|
+
},
|
|
14376
|
+
/**
|
|
14377
|
+
* Compliance Officer Designations — track designated compliance officers.
|
|
14378
|
+
*
|
|
14379
|
+
* Regulatory frameworks require organizations to designate compliance
|
|
14380
|
+
* officers (e.g., HIPAA Privacy Officer, DPO under GDPR). Designations
|
|
14381
|
+
* can be created and revoked.
|
|
14382
|
+
*/
|
|
14383
|
+
complianceOfficerDesignations: {
|
|
14384
|
+
/**
|
|
14385
|
+
* List compliance officer designations with optional pagination.
|
|
14386
|
+
*
|
|
14387
|
+
* @param options - Optional page number, page size, and request options.
|
|
14388
|
+
* @returns A page of `ComplianceOfficerDesignation` records.
|
|
14389
|
+
*
|
|
14390
|
+
* @example
|
|
14391
|
+
* ```typescript
|
|
14392
|
+
* const designations = await client.compliance.complianceOfficerDesignations.list();
|
|
14393
|
+
* ```
|
|
14394
|
+
*/
|
|
14395
|
+
list: async (options) => {
|
|
14396
|
+
return rb.execute(
|
|
14397
|
+
getComplianceOfficerDesignations,
|
|
14398
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
14399
|
+
options
|
|
14400
|
+
);
|
|
14401
|
+
},
|
|
14402
|
+
/**
|
|
14403
|
+
* Retrieve a single compliance officer designation by ID.
|
|
14404
|
+
*
|
|
14405
|
+
* @param id - The UUID of the designation.
|
|
14406
|
+
* @param options - Optional request options.
|
|
14407
|
+
* @returns The matching `ComplianceOfficerDesignation`.
|
|
14408
|
+
*
|
|
14409
|
+
* @example
|
|
14410
|
+
* ```typescript
|
|
14411
|
+
* const designation = await client.compliance.complianceOfficerDesignations.get('cod-uuid');
|
|
14412
|
+
* ```
|
|
14413
|
+
*/
|
|
14414
|
+
get: async (id, options) => {
|
|
14415
|
+
return rb.execute(
|
|
14416
|
+
getComplianceOfficerDesignationsById,
|
|
14417
|
+
{ path: { id } },
|
|
14418
|
+
options
|
|
14419
|
+
);
|
|
14420
|
+
},
|
|
14421
|
+
/**
|
|
14422
|
+
* Create a new compliance officer designation.
|
|
14423
|
+
*
|
|
14424
|
+
* @param attributes - Designation attributes (user ID, role, framework, effective date).
|
|
14425
|
+
* @param options - Optional request options.
|
|
14426
|
+
* @returns The newly created `ComplianceOfficerDesignation`.
|
|
14427
|
+
*
|
|
14428
|
+
* @example
|
|
14429
|
+
* ```typescript
|
|
14430
|
+
* const designation = await client.compliance.complianceOfficerDesignations.create({
|
|
14431
|
+
* user_id: 'user-uuid',
|
|
14432
|
+
* role: 'privacy_officer',
|
|
14433
|
+
* framework: 'hipaa',
|
|
14434
|
+
* });
|
|
14435
|
+
* ```
|
|
14436
|
+
*/
|
|
14437
|
+
create: async (attributes, options) => {
|
|
14438
|
+
return rb.execute(
|
|
14439
|
+
postComplianceOfficerDesignations,
|
|
14440
|
+
{
|
|
14441
|
+
body: {
|
|
14442
|
+
data: { type: "compliance-officer-designation", attributes }
|
|
14443
|
+
}
|
|
14444
|
+
},
|
|
14445
|
+
options
|
|
14446
|
+
);
|
|
14447
|
+
},
|
|
14448
|
+
/**
|
|
14449
|
+
* Revoke a compliance officer designation.
|
|
14450
|
+
*
|
|
14451
|
+
* @param id - The UUID of the designation to revoke.
|
|
14452
|
+
* @param attributes - Optional revocation attributes (reason, effective date).
|
|
14453
|
+
* @param options - Optional request options.
|
|
14454
|
+
* @returns The updated `ComplianceOfficerDesignation` with revoked status.
|
|
14455
|
+
*
|
|
14456
|
+
* @example
|
|
14457
|
+
* ```typescript
|
|
14458
|
+
* const designation = await client.compliance.complianceOfficerDesignations.revoke(
|
|
14459
|
+
* 'cod-uuid', { reason: 'Role reassigned.' },
|
|
14460
|
+
* );
|
|
14461
|
+
* ```
|
|
14462
|
+
*/
|
|
14463
|
+
revoke: async (id, attributes, options) => {
|
|
14464
|
+
return rb.execute(
|
|
14465
|
+
patchComplianceOfficerDesignationsByIdRevoke,
|
|
14466
|
+
{
|
|
14467
|
+
path: { id },
|
|
14468
|
+
body: {
|
|
14469
|
+
data: {
|
|
14470
|
+
type: "compliance-officer-designation",
|
|
14471
|
+
id,
|
|
14472
|
+
attributes: attributes ?? {}
|
|
14473
|
+
}
|
|
14474
|
+
}
|
|
14475
|
+
},
|
|
14476
|
+
options
|
|
14477
|
+
);
|
|
14478
|
+
}
|
|
14479
|
+
},
|
|
14480
|
+
/**
|
|
14481
|
+
* ePHI Assets — electronic Protected Health Information asset inventory.
|
|
14482
|
+
*
|
|
14483
|
+
* HIPAA requires covered entities to maintain an inventory of systems
|
|
14484
|
+
* and locations where ePHI is created, received, maintained, or
|
|
14485
|
+
* transmitted. Each asset record documents one such system.
|
|
14486
|
+
*/
|
|
14487
|
+
ephiAssets: {
|
|
14488
|
+
/**
|
|
14489
|
+
* List ePHI assets with optional pagination.
|
|
14490
|
+
*
|
|
14491
|
+
* @param options - Optional page number, page size, and request options.
|
|
14492
|
+
* @returns A page of `EphiAsset` records.
|
|
14493
|
+
*
|
|
14494
|
+
* @example
|
|
14495
|
+
* ```typescript
|
|
14496
|
+
* const assets = await client.compliance.ephiAssets.list();
|
|
14497
|
+
* ```
|
|
14498
|
+
*/
|
|
14499
|
+
list: async (options) => {
|
|
14500
|
+
return rb.execute(
|
|
14501
|
+
getEphiAssets,
|
|
14502
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
14503
|
+
options
|
|
14504
|
+
);
|
|
14505
|
+
},
|
|
14506
|
+
/**
|
|
14507
|
+
* Retrieve a single ePHI asset by ID.
|
|
14508
|
+
*
|
|
14509
|
+
* @param id - The UUID of the ePHI asset.
|
|
14510
|
+
* @param options - Optional request options.
|
|
14511
|
+
* @returns The matching `EphiAsset`.
|
|
14512
|
+
*
|
|
14513
|
+
* @example
|
|
14514
|
+
* ```typescript
|
|
14515
|
+
* const asset = await client.compliance.ephiAssets.get('ea-uuid');
|
|
14516
|
+
* ```
|
|
14517
|
+
*/
|
|
14518
|
+
get: async (id, options) => {
|
|
14519
|
+
return rb.execute(
|
|
14520
|
+
getEphiAssetsById,
|
|
14521
|
+
{ path: { id } },
|
|
14522
|
+
options
|
|
14523
|
+
);
|
|
14524
|
+
},
|
|
14525
|
+
/**
|
|
14526
|
+
* Create a new ePHI asset record.
|
|
14527
|
+
*
|
|
14528
|
+
* @param attributes - Asset attributes (name, type, location, custodian, etc.).
|
|
14529
|
+
* @param options - Optional request options.
|
|
14530
|
+
* @returns The newly created `EphiAsset`.
|
|
14531
|
+
*
|
|
14532
|
+
* @example
|
|
14533
|
+
* ```typescript
|
|
14534
|
+
* const asset = await client.compliance.ephiAssets.create({
|
|
14535
|
+
* name: 'Patient Records Database',
|
|
14536
|
+
* asset_type: 'database',
|
|
14537
|
+
* location: 'us-east-1',
|
|
14538
|
+
* });
|
|
14539
|
+
* ```
|
|
14540
|
+
*/
|
|
14541
|
+
create: async (attributes, options) => {
|
|
14542
|
+
return rb.execute(
|
|
14543
|
+
postEphiAssets,
|
|
14544
|
+
{ body: { data: { type: "ephi-asset", attributes } } },
|
|
14545
|
+
options
|
|
14546
|
+
);
|
|
14547
|
+
},
|
|
14548
|
+
/**
|
|
14549
|
+
* Update an ePHI asset record.
|
|
14550
|
+
*
|
|
14551
|
+
* @param id - The UUID of the ePHI asset to update.
|
|
14552
|
+
* @param attributes - Attribute map of fields to change.
|
|
14553
|
+
* @param options - Optional request options.
|
|
14554
|
+
* @returns The updated `EphiAsset`.
|
|
14555
|
+
*
|
|
14556
|
+
* @example
|
|
14557
|
+
* ```typescript
|
|
14558
|
+
* const asset = await client.compliance.ephiAssets.update(
|
|
14559
|
+
* 'ea-uuid', { custodian: 'new-admin-uuid' },
|
|
14560
|
+
* );
|
|
14561
|
+
* ```
|
|
14562
|
+
*/
|
|
14563
|
+
update: async (id, attributes, options) => {
|
|
14564
|
+
return rb.execute(
|
|
14565
|
+
patchEphiAssetsById,
|
|
14566
|
+
{
|
|
14567
|
+
path: { id },
|
|
14568
|
+
body: { data: { type: "ephi-asset", id, attributes } }
|
|
14569
|
+
},
|
|
14570
|
+
options
|
|
14571
|
+
);
|
|
14572
|
+
}
|
|
14573
|
+
},
|
|
14574
|
+
/**
|
|
14575
|
+
* ePHI Data Flows — document how ePHI moves between systems.
|
|
14576
|
+
*
|
|
14577
|
+
* HIPAA requires understanding how ePHI flows between systems, people,
|
|
14578
|
+
* and organizations. Each data flow record documents one movement path,
|
|
14579
|
+
* including source, destination, and safeguards.
|
|
14580
|
+
*/
|
|
14581
|
+
ephiDataFlows: {
|
|
14582
|
+
/**
|
|
14583
|
+
* List ePHI data flows with optional pagination.
|
|
14584
|
+
*
|
|
14585
|
+
* @param options - Optional page number, page size, and request options.
|
|
14586
|
+
* @returns A page of `EphiDataFlow` records.
|
|
14587
|
+
*
|
|
14588
|
+
* @example
|
|
14589
|
+
* ```typescript
|
|
14590
|
+
* const flows = await client.compliance.ephiDataFlows.list();
|
|
14591
|
+
* ```
|
|
14592
|
+
*/
|
|
14593
|
+
list: async (options) => {
|
|
14594
|
+
return rb.execute(
|
|
14595
|
+
getEphiDataFlows,
|
|
14596
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
14597
|
+
options
|
|
14598
|
+
);
|
|
14599
|
+
},
|
|
14600
|
+
/**
|
|
14601
|
+
* Retrieve a single ePHI data flow by ID.
|
|
14602
|
+
*
|
|
14603
|
+
* @param id - The UUID of the ePHI data flow.
|
|
14604
|
+
* @param options - Optional request options.
|
|
14605
|
+
* @returns The matching `EphiDataFlow`.
|
|
14606
|
+
*
|
|
14607
|
+
* @example
|
|
14608
|
+
* ```typescript
|
|
14609
|
+
* const flow = await client.compliance.ephiDataFlows.get('edf-uuid');
|
|
14610
|
+
* ```
|
|
14611
|
+
*/
|
|
14612
|
+
get: async (id, options) => {
|
|
14613
|
+
return rb.execute(
|
|
14614
|
+
getEphiDataFlowsById,
|
|
14615
|
+
{ path: { id } },
|
|
14616
|
+
options
|
|
14617
|
+
);
|
|
14618
|
+
},
|
|
14619
|
+
/**
|
|
14620
|
+
* Create a new ePHI data flow record.
|
|
14621
|
+
*
|
|
14622
|
+
* @param attributes - Data flow attributes (source, destination, data types, encryption, etc.).
|
|
14623
|
+
* @param options - Optional request options.
|
|
14624
|
+
* @returns The newly created `EphiDataFlow`.
|
|
14625
|
+
*
|
|
14626
|
+
* @example
|
|
14627
|
+
* ```typescript
|
|
14628
|
+
* const flow = await client.compliance.ephiDataFlows.create({
|
|
14629
|
+
* source_asset_id: 'ea-source-uuid',
|
|
14630
|
+
* destination_asset_id: 'ea-dest-uuid',
|
|
14631
|
+
* data_types: ['patient_records'],
|
|
14632
|
+
* encryption: 'tls_1_3',
|
|
14633
|
+
* });
|
|
14634
|
+
* ```
|
|
14635
|
+
*/
|
|
14636
|
+
create: async (attributes, options) => {
|
|
14637
|
+
return rb.execute(
|
|
14638
|
+
postEphiDataFlows,
|
|
14639
|
+
{ body: { data: { type: "ephi-data-flow", attributes } } },
|
|
14640
|
+
options
|
|
14641
|
+
);
|
|
14642
|
+
},
|
|
14643
|
+
/**
|
|
14644
|
+
* Update an ePHI data flow record.
|
|
14645
|
+
*
|
|
14646
|
+
* @param id - The UUID of the ePHI data flow to update.
|
|
14647
|
+
* @param attributes - Attribute map of fields to change.
|
|
14648
|
+
* @param options - Optional request options.
|
|
14649
|
+
* @returns The updated `EphiDataFlow`.
|
|
14650
|
+
*
|
|
14651
|
+
* @example
|
|
14652
|
+
* ```typescript
|
|
14653
|
+
* const flow = await client.compliance.ephiDataFlows.update(
|
|
14654
|
+
* 'edf-uuid', { encryption: 'aes_256' },
|
|
14655
|
+
* );
|
|
14656
|
+
* ```
|
|
14657
|
+
*/
|
|
14658
|
+
update: async (id, attributes, options) => {
|
|
14659
|
+
return rb.execute(
|
|
14660
|
+
patchEphiDataFlowsById,
|
|
14661
|
+
{
|
|
14662
|
+
path: { id },
|
|
14663
|
+
body: { data: { type: "ephi-data-flow", id, attributes } }
|
|
14664
|
+
},
|
|
14665
|
+
options
|
|
14666
|
+
);
|
|
14667
|
+
}
|
|
14668
|
+
},
|
|
14669
|
+
/**
|
|
14670
|
+
* Breach Notification Artifacts — regulatory notification documents.
|
|
14671
|
+
*
|
|
14672
|
+
* When a breach requires notification to authorities or individuals,
|
|
14673
|
+
* artifacts capture the notification letters, forms, and evidence
|
|
14674
|
+
* packages. Artifacts can be drafted, updated, and sent.
|
|
14675
|
+
*/
|
|
14676
|
+
breachNotificationArtifacts: {
|
|
14677
|
+
/**
|
|
14678
|
+
* List breach notification artifacts with optional pagination.
|
|
14679
|
+
*
|
|
14680
|
+
* @param options - Optional page number, page size, and request options.
|
|
14681
|
+
* @returns A page of `BreachNotificationArtifact` records.
|
|
14682
|
+
*
|
|
14683
|
+
* @example
|
|
14684
|
+
* ```typescript
|
|
14685
|
+
* const artifacts = await client.compliance.breachNotificationArtifacts.list();
|
|
14686
|
+
* ```
|
|
14687
|
+
*/
|
|
14688
|
+
list: async (options) => {
|
|
14689
|
+
return rb.execute(
|
|
14690
|
+
getBreachNotificationArtifacts,
|
|
14691
|
+
buildPageQuery(options?.page, options?.pageSize),
|
|
14692
|
+
options
|
|
14693
|
+
);
|
|
14694
|
+
},
|
|
14695
|
+
/**
|
|
14696
|
+
* Retrieve a single breach notification artifact by ID.
|
|
14697
|
+
*
|
|
14698
|
+
* @param id - The UUID of the artifact.
|
|
14699
|
+
* @param options - Optional request options.
|
|
14700
|
+
* @returns The matching `BreachNotificationArtifact`.
|
|
14701
|
+
*
|
|
14702
|
+
* @example
|
|
14703
|
+
* ```typescript
|
|
14704
|
+
* const artifact = await client.compliance.breachNotificationArtifacts.get('bna-uuid');
|
|
14705
|
+
* ```
|
|
14706
|
+
*/
|
|
14707
|
+
get: async (id, options) => {
|
|
14708
|
+
return rb.execute(
|
|
14709
|
+
getBreachNotificationArtifactsById,
|
|
14710
|
+
{ path: { id } },
|
|
14711
|
+
options
|
|
14712
|
+
);
|
|
14713
|
+
},
|
|
14714
|
+
/**
|
|
14715
|
+
* Create a new breach notification artifact.
|
|
14716
|
+
*
|
|
14717
|
+
* @param attributes - Artifact attributes (breach ID, type, content, recipients).
|
|
14718
|
+
* @param options - Optional request options.
|
|
14719
|
+
* @returns The newly created `BreachNotificationArtifact`.
|
|
14720
|
+
*
|
|
14721
|
+
* @example
|
|
14722
|
+
* ```typescript
|
|
14723
|
+
* const artifact = await client.compliance.breachNotificationArtifacts.create({
|
|
14724
|
+
* breach_incident_id: 'bi-uuid',
|
|
14725
|
+
* artifact_type: 'notification_letter',
|
|
14726
|
+
* content: 'Dear affected individual...',
|
|
14727
|
+
* });
|
|
14728
|
+
* ```
|
|
14729
|
+
*/
|
|
14730
|
+
create: async (attributes, options) => {
|
|
14731
|
+
return rb.execute(
|
|
14732
|
+
postBreachNotificationArtifacts,
|
|
14733
|
+
{
|
|
14734
|
+
body: {
|
|
14735
|
+
data: { type: "breach-notification-artifact", attributes }
|
|
14736
|
+
}
|
|
14737
|
+
},
|
|
14738
|
+
options
|
|
14739
|
+
);
|
|
14740
|
+
},
|
|
14741
|
+
/**
|
|
14742
|
+
* Update a breach notification artifact.
|
|
14743
|
+
*
|
|
14744
|
+
* @param id - The UUID of the artifact to update.
|
|
14745
|
+
* @param attributes - Attribute map of fields to change.
|
|
14746
|
+
* @param options - Optional request options.
|
|
14747
|
+
* @returns The updated `BreachNotificationArtifact`.
|
|
14748
|
+
*
|
|
14749
|
+
* @example
|
|
14750
|
+
* ```typescript
|
|
14751
|
+
* const artifact = await client.compliance.breachNotificationArtifacts.update(
|
|
14752
|
+
* 'bna-uuid', { content: 'Revised notification...' },
|
|
14753
|
+
* );
|
|
14754
|
+
* ```
|
|
14755
|
+
*/
|
|
14756
|
+
update: async (id, attributes, options) => {
|
|
14757
|
+
return rb.execute(
|
|
14758
|
+
patchBreachNotificationArtifactsById,
|
|
14759
|
+
{
|
|
14760
|
+
path: { id },
|
|
14761
|
+
body: {
|
|
14762
|
+
data: { type: "breach-notification-artifact", id, attributes }
|
|
14763
|
+
}
|
|
14764
|
+
},
|
|
14765
|
+
options
|
|
14766
|
+
);
|
|
14767
|
+
},
|
|
14768
|
+
/**
|
|
14769
|
+
* Send a breach notification artifact to its recipients.
|
|
14770
|
+
*
|
|
14771
|
+
* Triggers delivery of the notification and records the send event.
|
|
14772
|
+
*
|
|
14773
|
+
* @param id - The UUID of the artifact to send.
|
|
14774
|
+
* @param attributes - Optional send attributes (delivery method, etc.).
|
|
14775
|
+
* @param options - Optional request options.
|
|
14776
|
+
* @returns The updated `BreachNotificationArtifact` with sent status.
|
|
14777
|
+
*
|
|
14778
|
+
* @example
|
|
14779
|
+
* ```typescript
|
|
14780
|
+
* const artifact = await client.compliance.breachNotificationArtifacts.send('bna-uuid');
|
|
14781
|
+
* ```
|
|
14782
|
+
*/
|
|
14783
|
+
send: async (id, attributes, options) => {
|
|
14784
|
+
return rb.execute(
|
|
14785
|
+
patchBreachNotificationArtifactsByIdSend,
|
|
14786
|
+
{
|
|
14787
|
+
path: { id },
|
|
14788
|
+
body: {
|
|
14789
|
+
data: {
|
|
14790
|
+
type: "breach-notification-artifact",
|
|
14791
|
+
id,
|
|
14792
|
+
attributes: attributes ?? {}
|
|
14793
|
+
}
|
|
14794
|
+
}
|
|
14795
|
+
},
|
|
14796
|
+
options
|
|
14797
|
+
);
|
|
14798
|
+
}
|
|
14799
|
+
}
|
|
14800
|
+
};
|
|
14801
|
+
}
|
|
14802
|
+
|
|
14803
|
+
// src/namespaces/communication.ts
|
|
14804
|
+
function createCommunicationNamespace(rb) {
|
|
14805
|
+
return {
|
|
12533
14806
|
/**
|
|
12534
14807
|
* Sub-namespace for notification operations.
|
|
12535
14808
|
*
|
|
@@ -17067,7 +19340,7 @@ function createEmailNamespace(rb) {
|
|
|
17067
19340
|
* trigger verification after publishing DNS records.
|
|
17068
19341
|
*
|
|
17069
19342
|
* @param attributes - Key/value map of profile attributes. Required:
|
|
17070
|
-
* `workspace_id`, `
|
|
19343
|
+
* `workspace_id`, `email`, `name`. Optional: `address`, `company`, `phone`, `signature`.
|
|
17071
19344
|
* @param options - Optional request-level overrides.
|
|
17072
19345
|
* @returns A promise that resolves to the newly created {@link EmailMarketingSenderProfile}.
|
|
17073
19346
|
*
|
|
@@ -17077,9 +19350,8 @@ function createEmailNamespace(rb) {
|
|
|
17077
19350
|
*
|
|
17078
19351
|
* const profile = await client.email.senderProfiles.create({
|
|
17079
19352
|
* workspace_id: 'ws_abc123',
|
|
17080
|
-
*
|
|
17081
|
-
*
|
|
17082
|
-
* reply_to_email: 'support@acme.com',
|
|
19353
|
+
* email: 'hello@acme.com',
|
|
19354
|
+
* name: 'Acme Team',
|
|
17083
19355
|
* });
|
|
17084
19356
|
* // Publish DNS records, then verify:
|
|
17085
19357
|
* await client.email.senderProfiles.validateDns(profile.id);
|
|
@@ -17096,12 +19368,12 @@ function createEmailNamespace(rb) {
|
|
|
17096
19368
|
* Update a sender profile's attributes.
|
|
17097
19369
|
*
|
|
17098
19370
|
* Only the fields present in `attributes` are changed (PATCH semantics).
|
|
17099
|
-
* After updating
|
|
19371
|
+
* After updating domain-related fields, re-verify DNS
|
|
17100
19372
|
* with `validateDns()` to confirm deliverability is not impacted.
|
|
17101
19373
|
*
|
|
17102
19374
|
* @param id - The unique identifier of the sender profile to update.
|
|
17103
19375
|
* @param attributes - Key/value map of attributes to change (e.g.
|
|
17104
|
-
* `
|
|
19376
|
+
* `name`, `company`, `signature`).
|
|
17105
19377
|
* @param options - Optional request-level overrides.
|
|
17106
19378
|
* @returns A promise that resolves to the updated {@link EmailMarketingSenderProfile}.
|
|
17107
19379
|
*
|
|
@@ -17110,7 +19382,7 @@ function createEmailNamespace(rb) {
|
|
|
17110
19382
|
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
17111
19383
|
*
|
|
17112
19384
|
* const profile = await client.email.senderProfiles.update('sp_abc123', {
|
|
17113
|
-
*
|
|
19385
|
+
* name: 'Acme Support',
|
|
17114
19386
|
* });
|
|
17115
19387
|
* ```
|
|
17116
19388
|
*/
|
|
@@ -17327,29 +19599,6 @@ function createEmailNamespace(rb) {
|
|
|
17327
19599
|
},
|
|
17328
19600
|
options
|
|
17329
19601
|
);
|
|
17330
|
-
},
|
|
17331
|
-
/**
|
|
17332
|
-
* Delete an unsubscribe record by ID.
|
|
17333
|
-
*
|
|
17334
|
-
* Removing an unsubscribe record allows the address to receive emails
|
|
17335
|
-
* again. Use with caution — only remove records when the contact has
|
|
17336
|
-
* explicitly re-subscribed via a compliant opt-in process.
|
|
17337
|
-
*
|
|
17338
|
-
* @param id - The unique identifier of the unsubscribe record to delete.
|
|
17339
|
-
* @param options - Optional request-level overrides.
|
|
17340
|
-
* @returns A promise that resolves to `true` on successful deletion.
|
|
17341
|
-
*/
|
|
17342
|
-
delete: async (id, options) => {
|
|
17343
|
-
return rb.executeDelete(
|
|
17344
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
17345
|
-
(opts) => opts.client.delete({
|
|
17346
|
-
security: [{ scheme: "bearer", type: "http" }],
|
|
17347
|
-
url: "/email/unsubscribers/{id}",
|
|
17348
|
-
...opts
|
|
17349
|
-
}),
|
|
17350
|
-
{ path: { id } },
|
|
17351
|
-
options
|
|
17352
|
-
);
|
|
17353
19602
|
}
|
|
17354
19603
|
},
|
|
17355
19604
|
/**
|
|
@@ -20384,52 +22633,7 @@ function createPlatformNamespace(rb) {
|
|
|
20384
22633
|
return rb.execute(
|
|
20385
22634
|
getApplications,
|
|
20386
22635
|
buildPageQuery(options?.page, options?.pageSize),
|
|
20387
|
-
options
|
|
20388
|
-
);
|
|
20389
|
-
},
|
|
20390
|
-
/**
|
|
20391
|
-
* List email templates for the current application (paginated).
|
|
20392
|
-
*
|
|
20393
|
-
* Returns email template records associated with the application's
|
|
20394
|
-
* communication configuration, scoped by the current actor.
|
|
20395
|
-
*
|
|
20396
|
-
* @param options - Optional page number, page size, and request options.
|
|
20397
|
-
* @returns A page of email template records (typed as `Application[]` by the generated SDK).
|
|
20398
|
-
*
|
|
20399
|
-
* @example
|
|
20400
|
-
* ```typescript
|
|
20401
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
20402
|
-
* const templates = await client.platform.applications.listEmailTemplates();
|
|
20403
|
-
* ```
|
|
20404
|
-
*/
|
|
20405
|
-
listEmailTemplates: async (options) => {
|
|
20406
|
-
return rb.execute(
|
|
20407
|
-
getApplicationsByApplicationIdEmailTemplatesBySlug,
|
|
20408
|
-
buildPageQuery(options?.page, options?.pageSize),
|
|
20409
|
-
options
|
|
20410
|
-
);
|
|
20411
|
-
},
|
|
20412
|
-
/**
|
|
20413
|
-
* List all email templates, auto-paginating through every page.
|
|
20414
|
-
*
|
|
20415
|
-
* @param options - Optional request options.
|
|
20416
|
-
* @returns All email template records as a flat array.
|
|
20417
|
-
*
|
|
20418
|
-
* @example
|
|
20419
|
-
* ```typescript
|
|
20420
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
20421
|
-
* const allTemplates = await client.platform.applications.listAllEmailTemplates();
|
|
20422
|
-
* ```
|
|
20423
|
-
*/
|
|
20424
|
-
listAllEmailTemplates: async (options) => {
|
|
20425
|
-
return paginateToArray(
|
|
20426
|
-
rb.createPaginatedFetcher(
|
|
20427
|
-
getApplicationsByApplicationIdEmailTemplatesBySlug,
|
|
20428
|
-
(page, pageSize) => ({
|
|
20429
|
-
query: { page: { number: page, size: pageSize } }
|
|
20430
|
-
}),
|
|
20431
|
-
options
|
|
20432
|
-
)
|
|
22636
|
+
options
|
|
20433
22637
|
);
|
|
20434
22638
|
},
|
|
20435
22639
|
/**
|
|
@@ -21161,92 +23365,6 @@ function createPlatformNamespace(rb) {
|
|
|
21161
23365
|
);
|
|
21162
23366
|
}
|
|
21163
23367
|
},
|
|
21164
|
-
/**
|
|
21165
|
-
* Configs — application-level configuration key-value entries.
|
|
21166
|
-
*
|
|
21167
|
-
* Config entries store application-level settings such as feature flags,
|
|
21168
|
-
* branding values, or integration parameters. Each entry has a string `key`
|
|
21169
|
-
* and a typed `value`. Updates are applied immediately and take effect on
|
|
21170
|
-
* the next request that reads the config.
|
|
21171
|
-
*/
|
|
21172
|
-
configs: {
|
|
21173
|
-
/**
|
|
21174
|
-
* List application configuration entries with optional pagination.
|
|
21175
|
-
*
|
|
21176
|
-
* @param options - Optional page number, page size, and request options.
|
|
21177
|
-
* @returns A page of `Config` entries.
|
|
21178
|
-
*
|
|
21179
|
-
* @example
|
|
21180
|
-
* ```typescript
|
|
21181
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
21182
|
-
* const configs = await client.platform.configs.list();
|
|
21183
|
-
* configs.forEach(c => console.log(c.attributes?.key, c.attributes?.value));
|
|
21184
|
-
* ```
|
|
21185
|
-
*/
|
|
21186
|
-
list: async (options) => {
|
|
21187
|
-
return rb.execute(
|
|
21188
|
-
getConfigs,
|
|
21189
|
-
buildPageQuery(options?.page, options?.pageSize),
|
|
21190
|
-
options
|
|
21191
|
-
);
|
|
21192
|
-
},
|
|
21193
|
-
/**
|
|
21194
|
-
* Create a new application configuration entry.
|
|
21195
|
-
*
|
|
21196
|
-
* Typical attributes: `key` (string identifier, e.g., `"max_upload_mb"`)
|
|
21197
|
-
* and `value` (the setting value, can be any JSON-serializable type).
|
|
21198
|
-
*
|
|
21199
|
-
* @param attributes - Config entry attributes. `key` and `value` are required.
|
|
21200
|
-
* @param options - Optional request options.
|
|
21201
|
-
* @returns The newly created `Config` entry.
|
|
21202
|
-
*
|
|
21203
|
-
* @example
|
|
21204
|
-
* ```typescript
|
|
21205
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
21206
|
-
* const config = await client.platform.configs.create({
|
|
21207
|
-
* key: 'max_upload_mb',
|
|
21208
|
-
* value: 100,
|
|
21209
|
-
* });
|
|
21210
|
-
* ```
|
|
21211
|
-
*/
|
|
21212
|
-
create: async (attributes, options) => {
|
|
21213
|
-
return rb.execute(
|
|
21214
|
-
postConfigs,
|
|
21215
|
-
{ body: { data: { type: "config", attributes } } },
|
|
21216
|
-
options
|
|
21217
|
-
);
|
|
21218
|
-
},
|
|
21219
|
-
/**
|
|
21220
|
-
* Update an application configuration entry by key.
|
|
21221
|
-
*
|
|
21222
|
-
* Performs an upsert-style update: if a config with the given `key` exists
|
|
21223
|
-
* it is updated; the `key` in the path must match the `key` attribute.
|
|
21224
|
-
*
|
|
21225
|
-
* @param key - The string key of the config entry to update.
|
|
21226
|
-
* @param attributes - Attribute map of fields to change, typically `{ value }`.
|
|
21227
|
-
* @param options - Optional request options.
|
|
21228
|
-
* @returns The updated `Config` entry.
|
|
21229
|
-
*
|
|
21230
|
-
* @example
|
|
21231
|
-
* ```typescript
|
|
21232
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
21233
|
-
* const config = await client.platform.configs.update('max_upload_mb', {
|
|
21234
|
-
* value: 250,
|
|
21235
|
-
* });
|
|
21236
|
-
* console.log(config.attributes?.value); // 250
|
|
21237
|
-
* ```
|
|
21238
|
-
*/
|
|
21239
|
-
update: async (key, attributes, options) => {
|
|
21240
|
-
return rb.execute(
|
|
21241
|
-
patchConfigsByKey,
|
|
21242
|
-
{
|
|
21243
|
-
path: { key },
|
|
21244
|
-
body: { data: { type: "config", id: key, attributes } }
|
|
21245
|
-
},
|
|
21246
|
-
options
|
|
21247
|
-
);
|
|
21248
|
-
}
|
|
21249
|
-
},
|
|
21250
23368
|
/**
|
|
21251
23369
|
* Roles — named permission bundles for workspace access control.
|
|
21252
23370
|
*
|
|
@@ -26595,608 +28713,231 @@ function createSocialNamespace(rb) {
|
|
|
26595
28713
|
/** Generate AI master copy from the campaign's content brief. */
|
|
26596
28714
|
generateMasterCopy: async (id, workspaceId, options) => {
|
|
26597
28715
|
return rb.execute(
|
|
26598
|
-
postSocialCampaignsByIdGenerateMasterCopy,
|
|
26599
|
-
{
|
|
26600
|
-
path: { id },
|
|
26601
|
-
body: {
|
|
26602
|
-
data: {
|
|
26603
|
-
type: "social_campaign",
|
|
26604
|
-
attributes: {
|
|
26605
|
-
campaign_id: id,
|
|
26606
|
-
workspace_id: workspaceId
|
|
26607
|
-
}
|
|
26608
|
-
}
|
|
26609
|
-
}
|
|
26610
|
-
},
|
|
26611
|
-
options
|
|
26612
|
-
);
|
|
26613
|
-
},
|
|
26614
|
-
/** Adapt master copy for target platforms and create SocialPost drafts. */
|
|
26615
|
-
adaptForPlatforms: async (id, workspaceId, socialAccountId, options) => {
|
|
26616
|
-
return rb.execute(
|
|
26617
|
-
postSocialCampaignsByIdAdaptForPlatforms,
|
|
26618
|
-
{
|
|
26619
|
-
path: { id },
|
|
26620
|
-
body: {
|
|
26621
|
-
data: {
|
|
26622
|
-
type: "social_campaign",
|
|
26623
|
-
attributes: {
|
|
26624
|
-
campaign_id: id,
|
|
26625
|
-
workspace_id: workspaceId,
|
|
26626
|
-
social_account_id: socialAccountId
|
|
26627
|
-
}
|
|
26628
|
-
}
|
|
26629
|
-
}
|
|
26630
|
-
},
|
|
26631
|
-
options
|
|
26632
|
-
);
|
|
26633
|
-
}
|
|
26634
|
-
}
|
|
26635
|
-
};
|
|
26636
|
-
}
|
|
26637
|
-
|
|
26638
|
-
// src/namespaces/models.ts
|
|
26639
|
-
function createModelsNamespace(rb) {
|
|
26640
|
-
return {
|
|
26641
|
-
/**
|
|
26642
|
-
* List available models with tier classification.
|
|
26643
|
-
*
|
|
26644
|
-
* @param options - Optional filters for tier and category.
|
|
26645
|
-
* @param reqOptions - Optional request options.
|
|
26646
|
-
* @returns Array of available models.
|
|
26647
|
-
*
|
|
26648
|
-
* @example
|
|
26649
|
-
* ```typescript
|
|
26650
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26651
|
-
*
|
|
26652
|
-
* // All models
|
|
26653
|
-
* const models = await client.models.list();
|
|
26654
|
-
*
|
|
26655
|
-
* // Filter by tier
|
|
26656
|
-
* const standard = await client.models.list({ tier: "standard" });
|
|
26657
|
-
*
|
|
26658
|
-
* // Filter by category
|
|
26659
|
-
* const reasoning = await client.models.list({ category: "reasoning" });
|
|
26660
|
-
* ```
|
|
26661
|
-
*/
|
|
26662
|
-
async list(options, reqOptions) {
|
|
26663
|
-
const params = new URLSearchParams();
|
|
26664
|
-
if (options?.tier) params.set("tier", options.tier);
|
|
26665
|
-
if (options?.category) params.set("category", options.category);
|
|
26666
|
-
const query = params.toString();
|
|
26667
|
-
const path = query ? `/models?${query}` : "/models";
|
|
26668
|
-
return rb.rawGet(path, reqOptions);
|
|
26669
|
-
},
|
|
26670
|
-
/**
|
|
26671
|
-
* Get a single model by ID.
|
|
26672
|
-
*
|
|
26673
|
-
* @param modelId - The model ID (e.g., "anthropic/claude-sonnet-4").
|
|
26674
|
-
* Do NOT URL-encode — model IDs contain literal slashes.
|
|
26675
|
-
* @param reqOptions - Optional request options.
|
|
26676
|
-
* @returns Model details with tier classification.
|
|
26677
|
-
*
|
|
26678
|
-
* @example
|
|
26679
|
-
* ```typescript
|
|
26680
|
-
* const model = await client.models.get("anthropic/claude-sonnet-4");
|
|
26681
|
-
* console.log(model.tier); // "high_performance"
|
|
26682
|
-
* ```
|
|
26683
|
-
*/
|
|
26684
|
-
async get(modelId, reqOptions) {
|
|
26685
|
-
return rb.rawGet(`/models/${modelId}`, reqOptions);
|
|
26686
|
-
}
|
|
26687
|
-
};
|
|
26688
|
-
}
|
|
26689
|
-
|
|
26690
|
-
// src/namespaces/webhooks-ns.ts
|
|
26691
|
-
function createWebhooksNamespace(rb) {
|
|
26692
|
-
return {
|
|
26693
|
-
/**
|
|
26694
|
-
* Sub-namespace for managing webhook configurations.
|
|
26695
|
-
*
|
|
26696
|
-
* A webhook configuration registers an HTTPS endpoint to receive platform
|
|
26697
|
-
* event notifications. Each config has a URL, a list of subscribed event
|
|
26698
|
-
* types, an enabled/disabled state, and an HMAC-SHA256 signing secret.
|
|
26699
|
-
* The secret is returned only at creation time and when rotated — store it
|
|
26700
|
-
* securely immediately after creation.
|
|
26701
|
-
*
|
|
26702
|
-
* @example
|
|
26703
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26704
|
-
* const configs = await client.webhooks.configs.listAll();
|
|
26705
|
-
* console.log(`Registered webhooks: ${configs.length}`);
|
|
26706
|
-
*/
|
|
26707
|
-
configs: {
|
|
26708
|
-
/**
|
|
26709
|
-
* Permanently deletes a webhook configuration by its ID.
|
|
26710
|
-
*
|
|
26711
|
-
* After deletion, the platform will stop sending events to the associated
|
|
26712
|
-
* endpoint. Any in-flight deliveries may still be attempted but new events
|
|
26713
|
-
* will not be queued. Delivery records for the deleted config are retained
|
|
26714
|
-
* for audit purposes.
|
|
26715
|
-
*
|
|
26716
|
-
* @param id - The UUID of the webhook config to delete.
|
|
26717
|
-
* @param options - Optional request options.
|
|
26718
|
-
* @returns A promise that resolves to `true` on successful deletion.
|
|
26719
|
-
*
|
|
26720
|
-
* @example
|
|
26721
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26722
|
-
* await client.webhooks.configs.delete('whc_01HXYZ...');
|
|
26723
|
-
*/
|
|
26724
|
-
delete: async (id, options) => {
|
|
26725
|
-
return rb.executeDelete(
|
|
26726
|
-
deleteWebhookConfigsById,
|
|
26727
|
-
{ path: { id } },
|
|
26728
|
-
options
|
|
26729
|
-
);
|
|
26730
|
-
},
|
|
26731
|
-
/**
|
|
26732
|
-
* Lists webhook configurations in the workspace with optional pagination
|
|
26733
|
-
* controls.
|
|
26734
|
-
*
|
|
26735
|
-
* Returns a single page of configs. Use {@link listAll} to fetch every
|
|
26736
|
-
* config across all pages automatically.
|
|
26737
|
-
*
|
|
26738
|
-
* @param options - Optional pagination and request options.
|
|
26739
|
-
* @param options.page - The page number to fetch (1-based). Defaults to 1.
|
|
26740
|
-
* @param options.pageSize - Number of configs per page.
|
|
26741
|
-
* @returns A promise that resolves to an array of `WebhookConfig` objects.
|
|
26742
|
-
*
|
|
26743
|
-
* @example
|
|
26744
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26745
|
-
* const page1 = await client.webhooks.configs.list({ pageSize: 10 });
|
|
26746
|
-
*/
|
|
26747
|
-
list: async (options) => {
|
|
26748
|
-
return rb.execute(
|
|
26749
|
-
getWebhookConfigs,
|
|
26750
|
-
buildPageQuery(options?.page, options?.pageSize),
|
|
26751
|
-
options
|
|
26752
|
-
);
|
|
26753
|
-
},
|
|
26754
|
-
/**
|
|
26755
|
-
* Fetches all webhook configurations in the workspace by transparently
|
|
26756
|
-
* paginating through every page until exhausted.
|
|
26757
|
-
*
|
|
26758
|
-
* @param options - Optional request options.
|
|
26759
|
-
* @returns A promise that resolves to a flat array of all `WebhookConfig` objects.
|
|
26760
|
-
*
|
|
26761
|
-
* @example
|
|
26762
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26763
|
-
* const allConfigs = await client.webhooks.configs.listAll();
|
|
26764
|
-
* const enabled = allConfigs.filter(c => c.attributes.enabled);
|
|
26765
|
-
*/
|
|
26766
|
-
listAll: async (options) => {
|
|
26767
|
-
return paginateToArray(
|
|
26768
|
-
rb.createPaginatedFetcher(
|
|
26769
|
-
getWebhookConfigs,
|
|
26770
|
-
(page, pageSize) => ({
|
|
26771
|
-
query: { page: { number: page, size: pageSize } }
|
|
26772
|
-
}),
|
|
26773
|
-
options
|
|
26774
|
-
)
|
|
26775
|
-
);
|
|
26776
|
-
},
|
|
26777
|
-
/**
|
|
26778
|
-
* Registers a new webhook endpoint configuration.
|
|
26779
|
-
*
|
|
26780
|
-
* The `url` must be a publicly reachable HTTPS endpoint. The `events`
|
|
26781
|
-
* array specifies which platform event types trigger deliveries. A new
|
|
26782
|
-
* HMAC-SHA256 signing secret is generated and returned in the response —
|
|
26783
|
-
* this is the only time the plaintext secret is available, so store it
|
|
26784
|
-
* securely immediately. Use the `Webhooks` class to verify signatures on
|
|
26785
|
-
* incoming payloads.
|
|
26786
|
-
*
|
|
26787
|
-
* @param attributes - Config attributes. Must include at least `url` (string)
|
|
26788
|
-
* and `events` (string[]). Optional fields include `description`,
|
|
26789
|
-
* `enabled` (default `true`), and `headers` (custom headers to send).
|
|
26790
|
-
* @param options - Optional request options.
|
|
26791
|
-
* @returns A promise that resolves to the newly created `WebhookConfig`
|
|
26792
|
-
* object, with `attributes.secret` populated (only available at creation).
|
|
26793
|
-
*
|
|
26794
|
-
* @example
|
|
26795
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26796
|
-
*
|
|
26797
|
-
* const config = await client.webhooks.configs.create({
|
|
26798
|
-
* url: 'https://my-app.example.com/webhooks/gpt',
|
|
26799
|
-
* events: ['agent.execution.completed', 'document.processed'],
|
|
26800
|
-
* description: 'Production event sink',
|
|
26801
|
-
* });
|
|
26802
|
-
*
|
|
26803
|
-
* // Store this immediately — it is never shown again
|
|
26804
|
-
* const secret = config.attributes.secret;
|
|
26805
|
-
* console.log(`Signing secret: ${secret}`);
|
|
26806
|
-
*/
|
|
26807
|
-
create: async (attributes, options) => {
|
|
26808
|
-
return rb.execute(
|
|
26809
|
-
postWebhookConfigs,
|
|
26810
|
-
{ body: { data: { type: "webhook_config", attributes } } },
|
|
26811
|
-
options
|
|
26812
|
-
);
|
|
26813
|
-
},
|
|
26814
|
-
/**
|
|
26815
|
-
* Updates one or more attributes of an existing webhook configuration.
|
|
26816
|
-
*
|
|
26817
|
-
* Only the fields present in `attributes` are changed (PATCH semantics).
|
|
26818
|
-
* To update the signing secret, use {@link rotateSecret} instead.
|
|
26819
|
-
*
|
|
26820
|
-
* @param id - The UUID of the webhook config to update.
|
|
26821
|
-
* @param attributes - A partial map of config attributes to update
|
|
26822
|
-
* (e.g. `{ url: 'https://new-url.example.com', events: ['agent.execution.completed'] }`).
|
|
26823
|
-
* @param options - Optional request options.
|
|
26824
|
-
* @returns A promise that resolves to the updated `WebhookConfig` object.
|
|
26825
|
-
*
|
|
26826
|
-
* @example
|
|
26827
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26828
|
-
*
|
|
26829
|
-
* const updated = await client.webhooks.configs.update('whc_01HXYZ...', {
|
|
26830
|
-
* events: ['agent.execution.completed', 'document.processed', 'thread.created'],
|
|
26831
|
-
* });
|
|
26832
|
-
*/
|
|
26833
|
-
update: async (id, attributes, options) => {
|
|
26834
|
-
return rb.execute(
|
|
26835
|
-
patchWebhookConfigsById,
|
|
26836
|
-
{
|
|
26837
|
-
path: { id },
|
|
26838
|
-
body: { data: { id, type: "webhook_config", attributes } }
|
|
26839
|
-
},
|
|
26840
|
-
options
|
|
26841
|
-
);
|
|
26842
|
-
},
|
|
26843
|
-
/**
|
|
26844
|
-
* Sends a test ping to the webhook endpoint to verify connectivity and
|
|
26845
|
-
* signature verification.
|
|
26846
|
-
*
|
|
26847
|
-
* The platform makes a live HTTP POST to the configured URL with a test
|
|
26848
|
-
* payload signed using the config's current secret. The response includes
|
|
26849
|
-
* the HTTP status code returned by the endpoint and whether the delivery
|
|
26850
|
-
* was considered successful. Use this to confirm your endpoint is correctly
|
|
26851
|
-
* receiving and validating signed payloads before relying on it for
|
|
26852
|
-
* production events.
|
|
26853
|
-
*
|
|
26854
|
-
* @param id - The UUID of the webhook config to test.
|
|
26855
|
-
* @param options - Optional request options.
|
|
26856
|
-
* @returns A promise that resolves to the `WebhookConfig` object annotated
|
|
26857
|
-
* with the test delivery result (status code, success flag, etc.).
|
|
26858
|
-
*
|
|
26859
|
-
* @example
|
|
26860
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26861
|
-
* const result = await client.webhooks.configs.test('whc_01HXYZ...');
|
|
26862
|
-
* console.log(`Test delivery status: ${result.attributes.last_test_status}`);
|
|
26863
|
-
*/
|
|
26864
|
-
test: async (id, options) => {
|
|
26865
|
-
return rb.execute(
|
|
26866
|
-
postWebhookConfigsByIdTest,
|
|
26867
|
-
{ path: { id }, body: {} },
|
|
26868
|
-
options
|
|
26869
|
-
);
|
|
26870
|
-
},
|
|
26871
|
-
/**
|
|
26872
|
-
* Enables all webhook configurations in the workspace in a single batch
|
|
26873
|
-
* operation.
|
|
26874
|
-
*
|
|
26875
|
-
* After calling this, all previously disabled configs will resume receiving
|
|
26876
|
-
* event deliveries. Useful for re-activating webhooks after maintenance or
|
|
26877
|
-
* a bulk-disable operation.
|
|
26878
|
-
*
|
|
26879
|
-
* @param options - Optional request options.
|
|
26880
|
-
* @returns A promise that resolves to the updated `WebhookConfig` state.
|
|
26881
|
-
*
|
|
26882
|
-
* @example
|
|
26883
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26884
|
-
* await client.webhooks.configs.bulkEnable();
|
|
26885
|
-
* console.log('All webhook configs re-enabled');
|
|
26886
|
-
*/
|
|
26887
|
-
bulkEnable: async (options) => {
|
|
26888
|
-
return rb.execute(
|
|
26889
|
-
postWebhookConfigsBulkEnable,
|
|
26890
|
-
{},
|
|
28716
|
+
postSocialCampaignsByIdGenerateMasterCopy,
|
|
28717
|
+
{
|
|
28718
|
+
path: { id },
|
|
28719
|
+
body: {
|
|
28720
|
+
data: {
|
|
28721
|
+
type: "social_campaign",
|
|
28722
|
+
attributes: {
|
|
28723
|
+
campaign_id: id,
|
|
28724
|
+
workspace_id: workspaceId
|
|
28725
|
+
}
|
|
28726
|
+
}
|
|
28727
|
+
}
|
|
28728
|
+
},
|
|
26891
28729
|
options
|
|
26892
28730
|
);
|
|
26893
28731
|
},
|
|
26894
|
-
/**
|
|
26895
|
-
|
|
26896
|
-
* operation.
|
|
26897
|
-
*
|
|
26898
|
-
* After calling this, no event deliveries will be sent to any registered
|
|
26899
|
-
* endpoint. Useful for temporarily pausing all webhooks during maintenance
|
|
26900
|
-
* windows or incident response without permanently deleting configs.
|
|
26901
|
-
* Re-enable with {@link bulkEnable}.
|
|
26902
|
-
*
|
|
26903
|
-
* @param options - Optional request options.
|
|
26904
|
-
* @returns A promise that resolves to the updated `WebhookConfig` state.
|
|
26905
|
-
*
|
|
26906
|
-
* @example
|
|
26907
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
26908
|
-
* await client.webhooks.configs.bulkDisable();
|
|
26909
|
-
* console.log('All webhook configs paused');
|
|
26910
|
-
*/
|
|
26911
|
-
bulkDisable: async (options) => {
|
|
28732
|
+
/** Adapt master copy for target platforms and create SocialPost drafts. */
|
|
28733
|
+
adaptForPlatforms: async (id, workspaceId, socialAccountId, options) => {
|
|
26912
28734
|
return rb.execute(
|
|
26913
|
-
|
|
26914
|
-
{
|
|
28735
|
+
postSocialCampaignsByIdAdaptForPlatforms,
|
|
28736
|
+
{
|
|
28737
|
+
path: { id },
|
|
28738
|
+
body: {
|
|
28739
|
+
data: {
|
|
28740
|
+
type: "social_campaign",
|
|
28741
|
+
attributes: {
|
|
28742
|
+
campaign_id: id,
|
|
28743
|
+
workspace_id: workspaceId,
|
|
28744
|
+
social_account_id: socialAccountId
|
|
28745
|
+
}
|
|
28746
|
+
}
|
|
28747
|
+
}
|
|
28748
|
+
},
|
|
26915
28749
|
options
|
|
26916
28750
|
);
|
|
26917
|
-
}
|
|
28751
|
+
}
|
|
28752
|
+
},
|
|
28753
|
+
/** Trending content discovery — snapshots, items, and watch alerts. */
|
|
28754
|
+
trending: {
|
|
26918
28755
|
/**
|
|
26919
|
-
*
|
|
26920
|
-
*
|
|
26921
|
-
*
|
|
26922
|
-
* Use this when an endpoint was down or misconfigured during a window of
|
|
26923
|
-
* events and you need to retroactively process those events. The replay
|
|
26924
|
-
* window and event filter can be provided via request options. Re-delivered
|
|
26925
|
-
* events include the original event payload and timestamp but carry a new
|
|
26926
|
-
* `X-Gpt-Replay: true` header so your handler can distinguish replayed
|
|
26927
|
-
* events from live ones.
|
|
26928
|
-
*
|
|
26929
|
-
* @param id - The UUID of the webhook config to replay events to.
|
|
26930
|
-
* @param options - Optional request options. Pass `from` and `to` date
|
|
26931
|
-
* parameters to control the replay window.
|
|
26932
|
-
* @returns A promise that resolves to the `WebhookConfig` object annotated
|
|
26933
|
-
* with replay job metadata.
|
|
26934
|
-
*
|
|
28756
|
+
* Get a trending snapshot by ID.
|
|
28757
|
+
* @param id - Snapshot UUID
|
|
28758
|
+
* @returns TrendingSnapshot with metadata (query, enrichment level, item count)
|
|
26935
28759
|
* @example
|
|
26936
|
-
*
|
|
26937
|
-
* const
|
|
26938
|
-
*
|
|
28760
|
+
* ```typescript
|
|
28761
|
+
* const snapshot = await client.social.trending.get('snap_abc');
|
|
28762
|
+
* ```
|
|
26939
28763
|
*/
|
|
26940
|
-
|
|
28764
|
+
get: async (id, options) => {
|
|
26941
28765
|
return rb.execute(
|
|
26942
|
-
|
|
26943
|
-
{ path: { id }
|
|
28766
|
+
getSocialTrendingHistoryById,
|
|
28767
|
+
{ path: { id } },
|
|
26944
28768
|
options
|
|
26945
28769
|
);
|
|
26946
28770
|
},
|
|
26947
28771
|
/**
|
|
26948
|
-
*
|
|
26949
|
-
*
|
|
26950
|
-
* @
|
|
26951
|
-
* @param options - Optional request options.
|
|
26952
|
-
* @returns A promise that resolves to the full `WebhookConfig` object.
|
|
26953
|
-
* Note: the signing secret is NOT returned here for security reasons —
|
|
26954
|
-
* it is only available at creation time or after a `rotateSecret` call.
|
|
26955
|
-
*
|
|
28772
|
+
* List trending snapshots for a workspace.
|
|
28773
|
+
* @param workspaceId - Workspace UUID
|
|
28774
|
+
* @returns Array of TrendingSnapshot records
|
|
26956
28775
|
* @example
|
|
26957
|
-
*
|
|
26958
|
-
* const
|
|
26959
|
-
*
|
|
26960
|
-
* console.log(`Enabled: ${config.attributes.enabled}`);
|
|
28776
|
+
* ```typescript
|
|
28777
|
+
* const snapshots = await client.social.trending.listByWorkspace('ws_abc');
|
|
28778
|
+
* ```
|
|
26961
28779
|
*/
|
|
26962
|
-
|
|
28780
|
+
listByWorkspace: async (workspaceId, options) => {
|
|
26963
28781
|
return rb.execute(
|
|
26964
|
-
|
|
26965
|
-
{ path: {
|
|
28782
|
+
getSocialTrendingHistoryWorkspaceByWorkspaceId,
|
|
28783
|
+
{ path: { workspace_id: workspaceId } },
|
|
26966
28784
|
options
|
|
26967
28785
|
);
|
|
26968
28786
|
},
|
|
26969
28787
|
/**
|
|
26970
|
-
*
|
|
26971
|
-
*
|
|
26972
|
-
*
|
|
26973
|
-
* The new secret is returned in the response and is the only time it will
|
|
26974
|
-
* be visible in plaintext — store it securely immediately. Any endpoints
|
|
26975
|
-
* still using the old secret will begin receiving signature verification
|
|
26976
|
-
* failures immediately after rotation. Update your endpoint's stored secret
|
|
26977
|
-
* before rotating to avoid downtime.
|
|
26978
|
-
*
|
|
26979
|
-
* @param id - The UUID of the webhook config whose secret to rotate.
|
|
26980
|
-
* @param options - Optional request options.
|
|
26981
|
-
* @returns A promise that resolves to the `WebhookConfig` object with the
|
|
26982
|
-
* new `attributes.secret` populated (only available in this response).
|
|
26983
|
-
*
|
|
28788
|
+
* Create a trending snapshot (trigger on-demand collection).
|
|
28789
|
+
* @param attributes - Snapshot attributes (workspace_id, enrichment_level, etc.)
|
|
28790
|
+
* @returns Created TrendingSnapshot
|
|
26984
28791
|
* @example
|
|
26985
|
-
*
|
|
26986
|
-
* const
|
|
26987
|
-
*
|
|
26988
|
-
*
|
|
26989
|
-
*
|
|
26990
|
-
*
|
|
28792
|
+
* ```typescript
|
|
28793
|
+
* const snapshot = await client.social.trending.create({
|
|
28794
|
+
* workspace_id: 'ws_abc',
|
|
28795
|
+
* enrichment_level: 'scored',
|
|
28796
|
+
* fetched_at: new Date().toISOString(),
|
|
28797
|
+
* });
|
|
28798
|
+
* ```
|
|
26991
28799
|
*/
|
|
26992
|
-
|
|
28800
|
+
create: async (attributes, options) => {
|
|
26993
28801
|
return rb.execute(
|
|
26994
|
-
|
|
26995
|
-
{
|
|
28802
|
+
postSocialTrendingHistory,
|
|
28803
|
+
{
|
|
28804
|
+
body: {
|
|
28805
|
+
data: { type: "trending-snapshot", attributes }
|
|
28806
|
+
}
|
|
28807
|
+
},
|
|
26996
28808
|
options
|
|
26997
28809
|
);
|
|
26998
28810
|
},
|
|
26999
|
-
/**
|
|
27000
|
-
|
|
27001
|
-
*
|
|
27002
|
-
* Provides counts of total, enabled, and disabled configs along with
|
|
27003
|
-
* the overall delivery success rate. Useful for monitoring webhook
|
|
27004
|
-
* health at a glance.
|
|
27005
|
-
*
|
|
27006
|
-
* @param options - Optional request options.
|
|
27007
|
-
* @returns An object containing webhook config statistics.
|
|
27008
|
-
*
|
|
27009
|
-
* @example
|
|
27010
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
27011
|
-
* const stats = await client.webhooks.configs.stats();
|
|
27012
|
-
* console.log(`Total: ${stats.total}, Enabled: ${stats.enabled}`);
|
|
27013
|
-
*/
|
|
27014
|
-
stats: async (options) => {
|
|
28811
|
+
/** Delete a trending snapshot by ID. */
|
|
28812
|
+
delete: async (id, options) => {
|
|
27015
28813
|
return rb.execute(
|
|
27016
|
-
|
|
27017
|
-
{},
|
|
28814
|
+
deleteSocialTrendingHistoryById,
|
|
28815
|
+
{ path: { id } },
|
|
27018
28816
|
options
|
|
27019
28817
|
);
|
|
28818
|
+
},
|
|
28819
|
+
/** Trending snapshot items — individual content pieces within a snapshot. */
|
|
28820
|
+
items: {
|
|
28821
|
+
/** Get a single trending item by ID. */
|
|
28822
|
+
get: async (id, options) => {
|
|
28823
|
+
return rb.execute(
|
|
28824
|
+
getSocialTrendingItemsById,
|
|
28825
|
+
{ path: { id } },
|
|
28826
|
+
options
|
|
28827
|
+
);
|
|
28828
|
+
},
|
|
28829
|
+
/**
|
|
28830
|
+
* List trending items for a snapshot.
|
|
28831
|
+
* @param snapshotId - Parent snapshot UUID
|
|
28832
|
+
* @returns Array of TrendingSnapshotItem records
|
|
28833
|
+
* @example
|
|
28834
|
+
* ```typescript
|
|
28835
|
+
* const items = await client.social.trending.items.listBySnapshot('snap_abc');
|
|
28836
|
+
* ```
|
|
28837
|
+
*/
|
|
28838
|
+
listBySnapshot: async (snapshotId, options) => {
|
|
28839
|
+
return rb.execute(
|
|
28840
|
+
getSocialTrendingItemsSnapshotBySnapshotId,
|
|
28841
|
+
{ path: { snapshot_id: snapshotId } },
|
|
28842
|
+
options
|
|
28843
|
+
);
|
|
28844
|
+
}
|
|
27020
28845
|
}
|
|
27021
28846
|
},
|
|
27022
|
-
/**
|
|
27023
|
-
|
|
27024
|
-
*
|
|
27025
|
-
* Returns the complete event catalog. Use this to discover which event
|
|
27026
|
-
* types exist, understand their payload shape, and validate the `events`
|
|
27027
|
-
* array when registering or updating webhook configs. The endpoint does
|
|
27028
|
-
* not require authentication.
|
|
27029
|
-
*
|
|
27030
|
-
* @param options - Optional request options.
|
|
27031
|
-
* @returns A promise that resolves to an array of event type descriptors,
|
|
27032
|
-
* each with `type` (the event name string), `description`, and
|
|
27033
|
-
* `data_object` (the resource type the payload describes).
|
|
27034
|
-
*
|
|
27035
|
-
* @example
|
|
27036
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
27037
|
-
* const types = await client.webhooks.listEventTypes();
|
|
27038
|
-
* console.log(types.map(t => t.type));
|
|
27039
|
-
* // ['agent.execution.completed', 'document.processed', ...]
|
|
27040
|
-
*/
|
|
27041
|
-
listEventTypes: async (options) => {
|
|
27042
|
-
return rb.rawGet("/webhook-event-types", options);
|
|
27043
|
-
},
|
|
27044
|
-
/**
|
|
27045
|
-
* Sub-namespace for inspecting and retrying webhook delivery records.
|
|
27046
|
-
*
|
|
27047
|
-
* Every time the platform attempts to deliver an event to a webhook endpoint,
|
|
27048
|
-
* a delivery record is created. The record captures the HTTP response status,
|
|
27049
|
-
* latency, request and response bodies, and whether the delivery succeeded.
|
|
27050
|
-
* Failed deliveries can be retried individually or in bulk.
|
|
27051
|
-
*
|
|
27052
|
-
* @example
|
|
27053
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
27054
|
-
*
|
|
27055
|
-
* // Find failed deliveries and retry them
|
|
27056
|
-
* const deliveries = await client.webhooks.deliveries.listAll();
|
|
27057
|
-
* const failed = deliveries.filter(d => !d.attributes.success);
|
|
27058
|
-
* console.log(`Failed deliveries: ${failed.length}`);
|
|
27059
|
-
* await client.webhooks.deliveries.bulkRetry();
|
|
27060
|
-
*/
|
|
27061
|
-
deliveries: {
|
|
28847
|
+
/** Trending watch alerts — monitor topics and get notified on matches. */
|
|
28848
|
+
watches: {
|
|
27062
28849
|
/**
|
|
27063
|
-
*
|
|
27064
|
-
*
|
|
27065
|
-
*
|
|
27066
|
-
* every record across all pages automatically.
|
|
27067
|
-
*
|
|
27068
|
-
* @param options - Optional pagination and request options.
|
|
27069
|
-
* @param options.page - The page number to fetch (1-based). Defaults to 1.
|
|
27070
|
-
* @param options.pageSize - Number of delivery records per page.
|
|
27071
|
-
* @returns A promise that resolves to an array of `WebhookDelivery` objects,
|
|
27072
|
-
* ordered most-recent-first.
|
|
27073
|
-
*
|
|
27074
|
-
* @example
|
|
27075
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
27076
|
-
* const recent = await client.webhooks.deliveries.list({ pageSize: 20 });
|
|
28850
|
+
* Get a trending watch by ID.
|
|
28851
|
+
* @param id - Watch UUID
|
|
28852
|
+
* @returns TrendingWatch with conditions and notification config
|
|
27077
28853
|
*/
|
|
27078
|
-
|
|
28854
|
+
get: async (id, options) => {
|
|
27079
28855
|
return rb.execute(
|
|
27080
|
-
|
|
27081
|
-
|
|
28856
|
+
getSocialTrendingWatchesById,
|
|
28857
|
+
{ path: { id } },
|
|
27082
28858
|
options
|
|
27083
28859
|
);
|
|
27084
28860
|
},
|
|
27085
28861
|
/**
|
|
27086
|
-
*
|
|
27087
|
-
*
|
|
27088
|
-
*
|
|
27089
|
-
* @param options - Optional request options.
|
|
27090
|
-
* @returns A promise that resolves to a flat array of all `WebhookDelivery`
|
|
27091
|
-
* objects across the workspace.
|
|
27092
|
-
*
|
|
28862
|
+
* List trending watches for a workspace.
|
|
28863
|
+
* @param workspaceId - Workspace UUID
|
|
28864
|
+
* @returns Array of TrendingWatch records
|
|
27093
28865
|
* @example
|
|
27094
|
-
*
|
|
27095
|
-
* const
|
|
27096
|
-
*
|
|
27097
|
-
* console.log(`Delivery success rate: ${(successRate * 100).toFixed(1)}%`);
|
|
28866
|
+
* ```typescript
|
|
28867
|
+
* const watches = await client.social.watches.listByWorkspace('ws_abc');
|
|
28868
|
+
* ```
|
|
27098
28869
|
*/
|
|
27099
|
-
|
|
27100
|
-
return
|
|
27101
|
-
|
|
27102
|
-
|
|
27103
|
-
|
|
27104
|
-
query: { page: { number: page, size: pageSize } }
|
|
27105
|
-
}),
|
|
27106
|
-
options
|
|
27107
|
-
)
|
|
28870
|
+
listByWorkspace: async (workspaceId, options) => {
|
|
28871
|
+
return rb.execute(
|
|
28872
|
+
getSocialTrendingWatchesWorkspaceByWorkspaceId,
|
|
28873
|
+
{ path: { workspace_id: workspaceId } },
|
|
28874
|
+
options
|
|
27108
28875
|
);
|
|
27109
28876
|
},
|
|
27110
28877
|
/**
|
|
27111
|
-
*
|
|
27112
|
-
*
|
|
27113
|
-
*
|
|
27114
|
-
* original event payload. The delivery record is updated with the result
|
|
27115
|
-
* of the retry attempt.
|
|
27116
|
-
*
|
|
27117
|
-
* @param id - The UUID of the webhook delivery record to retry.
|
|
27118
|
-
* @param options - Optional request options.
|
|
27119
|
-
* @returns A promise that resolves to the updated `WebhookDelivery` object
|
|
27120
|
-
* after the retry attempt.
|
|
27121
|
-
*
|
|
28878
|
+
* Create a new trending watch alert.
|
|
28879
|
+
* @param attributes - Watch attributes (name, query, conditions, notification_config)
|
|
28880
|
+
* @returns Created TrendingWatch
|
|
27122
28881
|
* @example
|
|
27123
|
-
*
|
|
27124
|
-
* const
|
|
27125
|
-
*
|
|
28882
|
+
* ```typescript
|
|
28883
|
+
* const watch = await client.social.watches.create({
|
|
28884
|
+
* workspace_id: 'ws_abc',
|
|
28885
|
+
* name: 'AI Industry News',
|
|
28886
|
+
* query: 'artificial intelligence',
|
|
28887
|
+
* conditions: { min_score: 0.7 },
|
|
28888
|
+
* notification_config: { channel: 'webhook', url: 'https://...' },
|
|
28889
|
+
* });
|
|
28890
|
+
* ```
|
|
27126
28891
|
*/
|
|
27127
|
-
|
|
28892
|
+
create: async (attributes, options) => {
|
|
27128
28893
|
return rb.execute(
|
|
27129
|
-
|
|
27130
|
-
{
|
|
28894
|
+
postSocialTrendingWatches,
|
|
28895
|
+
{
|
|
28896
|
+
body: {
|
|
28897
|
+
data: { type: "trending-watch", attributes }
|
|
28898
|
+
}
|
|
28899
|
+
},
|
|
27131
28900
|
options
|
|
27132
28901
|
);
|
|
27133
28902
|
},
|
|
27134
28903
|
/**
|
|
27135
|
-
*
|
|
27136
|
-
*
|
|
27137
|
-
*
|
|
27138
|
-
* The platform identifies all delivery records with a non-2xx response or
|
|
27139
|
-
* a connection error and re-attempts each one. This is useful after
|
|
27140
|
-
* recovering from an endpoint outage to ensure no events were permanently
|
|
27141
|
-
* lost. Re-attempt results are recorded in the individual delivery records.
|
|
27142
|
-
*
|
|
27143
|
-
* @param options - Optional request options.
|
|
27144
|
-
* @returns A promise that resolves to the batch retry result.
|
|
27145
|
-
*
|
|
27146
|
-
* @example
|
|
27147
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
27148
|
-
* await client.webhooks.deliveries.bulkRetry();
|
|
27149
|
-
* console.log('All failed deliveries queued for retry');
|
|
28904
|
+
* Update a trending watch.
|
|
28905
|
+
* @param id - Watch UUID
|
|
28906
|
+
* @param attributes - Fields to update (name, query, conditions, enabled, etc.)
|
|
27150
28907
|
*/
|
|
27151
|
-
|
|
28908
|
+
update: async (id, attributes, options) => {
|
|
27152
28909
|
return rb.execute(
|
|
27153
|
-
|
|
27154
|
-
{
|
|
28910
|
+
patchSocialTrendingWatchesById,
|
|
28911
|
+
{
|
|
28912
|
+
path: { id },
|
|
28913
|
+
body: {
|
|
28914
|
+
data: { type: "trending-watch", id, attributes }
|
|
28915
|
+
}
|
|
28916
|
+
},
|
|
27155
28917
|
options
|
|
27156
28918
|
);
|
|
27157
28919
|
},
|
|
27158
|
-
/**
|
|
27159
|
-
|
|
27160
|
-
*
|
|
27161
|
-
* The record includes the event type, payload snapshot, HTTP response
|
|
27162
|
-
* status, response body, latency, attempt count, and success flag.
|
|
27163
|
-
*
|
|
27164
|
-
* @param id - The UUID of the webhook delivery record to retrieve.
|
|
27165
|
-
* @param options - Optional request options.
|
|
27166
|
-
* @returns A promise that resolves to the full `WebhookDelivery` object.
|
|
27167
|
-
*
|
|
27168
|
-
* @example
|
|
27169
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
27170
|
-
* const delivery = await client.webhooks.deliveries.get('wdl_01HXYZ...');
|
|
27171
|
-
* console.log(`Event: ${delivery.attributes.event_type}`);
|
|
27172
|
-
* console.log(`Response status: ${delivery.attributes.response_status}`);
|
|
27173
|
-
* console.log(`Success: ${delivery.attributes.success}`);
|
|
27174
|
-
*/
|
|
27175
|
-
get: async (id, options) => {
|
|
28920
|
+
/** Delete a trending watch by ID. */
|
|
28921
|
+
delete: async (id, options) => {
|
|
27176
28922
|
return rb.execute(
|
|
27177
|
-
|
|
28923
|
+
deleteSocialTrendingWatchesById,
|
|
27178
28924
|
{ path: { id } },
|
|
27179
28925
|
options
|
|
27180
28926
|
);
|
|
27181
28927
|
},
|
|
27182
28928
|
/**
|
|
27183
|
-
*
|
|
27184
|
-
*
|
|
27185
|
-
* Provides total, delivered, failed, and retrying counts. Useful for
|
|
27186
|
-
* monitoring dashboards and health checks.
|
|
27187
|
-
*
|
|
27188
|
-
* @param options - Optional request options.
|
|
27189
|
-
* @returns An object with `total`, `delivered`, `failed`, and `retrying` counts.
|
|
27190
|
-
*
|
|
27191
|
-
* @example
|
|
27192
|
-
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
27193
|
-
* const stats = await client.webhooks.deliveries.stats();
|
|
27194
|
-
* console.log(`Failed deliveries: ${stats.failed}`);
|
|
28929
|
+
* Mark a watch as triggered (updates last_triggered_at).
|
|
28930
|
+
* @param id - Watch UUID
|
|
27195
28931
|
*/
|
|
27196
|
-
|
|
28932
|
+
markTriggered: async (id, options) => {
|
|
27197
28933
|
return rb.execute(
|
|
27198
|
-
|
|
27199
|
-
{
|
|
28934
|
+
patchSocialTrendingWatchesByIdMarkTriggered,
|
|
28935
|
+
{
|
|
28936
|
+
path: { id },
|
|
28937
|
+
body: {
|
|
28938
|
+
data: { type: "trending-watch", id, attributes: {} }
|
|
28939
|
+
}
|
|
28940
|
+
},
|
|
27200
28941
|
options
|
|
27201
28942
|
);
|
|
27202
28943
|
}
|
|
@@ -27204,6 +28945,58 @@ function createWebhooksNamespace(rb) {
|
|
|
27204
28945
|
};
|
|
27205
28946
|
}
|
|
27206
28947
|
|
|
28948
|
+
// src/namespaces/models.ts
|
|
28949
|
+
function createModelsNamespace(rb) {
|
|
28950
|
+
return {
|
|
28951
|
+
/**
|
|
28952
|
+
* List available models with tier classification.
|
|
28953
|
+
*
|
|
28954
|
+
* @param options - Optional filters for tier and category.
|
|
28955
|
+
* @param reqOptions - Optional request options.
|
|
28956
|
+
* @returns Array of available models.
|
|
28957
|
+
*
|
|
28958
|
+
* @example
|
|
28959
|
+
* ```typescript
|
|
28960
|
+
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
28961
|
+
*
|
|
28962
|
+
* // All models
|
|
28963
|
+
* const models = await client.models.list();
|
|
28964
|
+
*
|
|
28965
|
+
* // Filter by tier
|
|
28966
|
+
* const standard = await client.models.list({ tier: "standard" });
|
|
28967
|
+
*
|
|
28968
|
+
* // Filter by category
|
|
28969
|
+
* const reasoning = await client.models.list({ category: "reasoning" });
|
|
28970
|
+
* ```
|
|
28971
|
+
*/
|
|
28972
|
+
async list(options, reqOptions) {
|
|
28973
|
+
const params = new URLSearchParams();
|
|
28974
|
+
if (options?.tier) params.set("tier", options.tier);
|
|
28975
|
+
if (options?.category) params.set("category", options.category);
|
|
28976
|
+
const query = params.toString();
|
|
28977
|
+
const path = query ? `/models?${query}` : "/models";
|
|
28978
|
+
return rb.rawGet(path, reqOptions);
|
|
28979
|
+
},
|
|
28980
|
+
/**
|
|
28981
|
+
* Get a single model by ID.
|
|
28982
|
+
*
|
|
28983
|
+
* @param modelId - The model ID (e.g., "anthropic/claude-sonnet-4").
|
|
28984
|
+
* Do NOT URL-encode — model IDs contain literal slashes.
|
|
28985
|
+
* @param reqOptions - Optional request options.
|
|
28986
|
+
* @returns Model details with tier classification.
|
|
28987
|
+
*
|
|
28988
|
+
* @example
|
|
28989
|
+
* ```typescript
|
|
28990
|
+
* const model = await client.models.get("anthropic/claude-sonnet-4");
|
|
28991
|
+
* console.log(model.tier); // "high_performance"
|
|
28992
|
+
* ```
|
|
28993
|
+
*/
|
|
28994
|
+
async get(modelId, reqOptions) {
|
|
28995
|
+
return rb.rawGet(`/models/${modelId}`, reqOptions);
|
|
28996
|
+
}
|
|
28997
|
+
};
|
|
28998
|
+
}
|
|
28999
|
+
|
|
27207
29000
|
// src/namespaces/crm-clusters.ts
|
|
27208
29001
|
function createCrmClustersNamespace(rb) {
|
|
27209
29002
|
return {
|
|
@@ -28014,7 +29807,6 @@ var GptClient = class extends BaseClient {
|
|
|
28014
29807
|
this.voice = createVoiceNamespace(rb);
|
|
28015
29808
|
this.social = createSocialNamespace(rb);
|
|
28016
29809
|
this.watcher = createWatcherNamespace(rb);
|
|
28017
|
-
this.webhooks = createWebhooksNamespace(rb);
|
|
28018
29810
|
this.projects = createProjectsNamespace(rb);
|
|
28019
29811
|
this.models = createModelsNamespace(rb);
|
|
28020
29812
|
this.crmClusters = createCrmClustersNamespace(rb);
|