@robosystems/client 0.2.25 → 0.2.27
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/README.md +7 -6
- package/bin/{create-feature → create-feature.sh} +11 -1
- package/client/client.gen.js +118 -34
- package/client/client.gen.ts +125 -38
- package/client/index.d.ts +2 -1
- package/client/index.js +3 -1
- package/client/index.ts +1 -1
- package/client/types.gen.d.ts +11 -16
- package/client/types.gen.js +0 -1
- package/client/types.gen.ts +44 -64
- package/client/utils.gen.d.ts +8 -20
- package/client/utils.gen.js +44 -112
- package/client/utils.gen.ts +57 -181
- package/client.gen.d.ts +3 -3
- package/client.gen.js +1 -3
- package/client.gen.ts +4 -6
- package/core/auth.gen.ts +1 -2
- package/core/bodySerializer.gen.d.ts +12 -4
- package/core/bodySerializer.gen.js +1 -1
- package/core/bodySerializer.gen.ts +17 -25
- package/core/params.gen.d.ts +10 -0
- package/core/params.gen.js +17 -5
- package/core/params.gen.ts +37 -21
- package/core/pathSerializer.gen.js +3 -11
- package/core/pathSerializer.gen.ts +4 -14
- package/core/queryKeySerializer.gen.d.ts +18 -0
- package/core/queryKeySerializer.gen.js +98 -0
- package/core/queryKeySerializer.gen.ts +117 -0
- package/core/serverSentEvents.gen.d.ts +71 -0
- package/core/serverSentEvents.gen.js +137 -0
- package/core/serverSentEvents.gen.ts +243 -0
- package/core/types.gen.d.ts +12 -12
- package/core/types.gen.js +0 -1
- package/core/types.gen.ts +21 -38
- package/core/utils.gen.d.ts +19 -0
- package/core/utils.gen.js +93 -0
- package/core/utils.gen.ts +140 -0
- package/extensions/QueryClient.js +23 -2
- package/extensions/QueryClient.test.ts +2 -1
- package/extensions/QueryClient.ts +27 -2
- package/index.ts +3 -2
- package/package.json +9 -7
- package/sdk/client/client.gen.js +118 -34
- package/sdk/client/client.gen.ts +125 -38
- package/sdk/client/index.d.ts +2 -1
- package/sdk/client/index.js +3 -1
- package/sdk/client/index.ts +1 -1
- package/sdk/client/types.gen.d.ts +11 -16
- package/sdk/client/types.gen.js +0 -1
- package/sdk/client/types.gen.ts +44 -64
- package/sdk/client/utils.gen.d.ts +8 -20
- package/sdk/client/utils.gen.js +44 -112
- package/sdk/client/utils.gen.ts +57 -181
- package/sdk/client.gen.d.ts +3 -3
- package/sdk/client.gen.js +1 -3
- package/sdk/client.gen.ts +4 -6
- package/sdk/core/auth.gen.ts +1 -2
- package/sdk/core/bodySerializer.gen.d.ts +12 -4
- package/sdk/core/bodySerializer.gen.js +1 -1
- package/sdk/core/bodySerializer.gen.ts +17 -25
- package/sdk/core/params.gen.d.ts +10 -0
- package/sdk/core/params.gen.js +17 -5
- package/sdk/core/params.gen.ts +37 -21
- package/sdk/core/pathSerializer.gen.js +3 -11
- package/sdk/core/pathSerializer.gen.ts +4 -14
- package/sdk/core/queryKeySerializer.gen.d.ts +18 -0
- package/sdk/core/queryKeySerializer.gen.js +98 -0
- package/sdk/core/queryKeySerializer.gen.ts +117 -0
- package/sdk/core/serverSentEvents.gen.d.ts +71 -0
- package/sdk/core/serverSentEvents.gen.js +137 -0
- package/sdk/core/serverSentEvents.gen.ts +243 -0
- package/sdk/core/types.gen.d.ts +12 -12
- package/sdk/core/types.gen.js +0 -1
- package/sdk/core/types.gen.ts +21 -38
- package/sdk/core/utils.gen.d.ts +19 -0
- package/sdk/core/utils.gen.js +93 -0
- package/sdk/core/utils.gen.ts +140 -0
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +114 -17
- package/sdk/index.ts +3 -2
- package/sdk/sdk.gen.d.ts +112 -3
- package/sdk/sdk.gen.js +778 -1736
- package/sdk/sdk.gen.ts +782 -1740
- package/sdk/types.gen.d.ts +851 -5
- package/sdk/types.gen.ts +852 -6
- package/sdk-extensions/QueryClient.js +23 -2
- package/sdk-extensions/QueryClient.test.ts +2 -1
- package/sdk-extensions/QueryClient.ts +27 -2
- package/sdk.gen.d.ts +112 -3
- package/sdk.gen.js +778 -1736
- package/sdk.gen.ts +782 -1740
- package/types.gen.d.ts +851 -5
- package/types.gen.ts +852 -6
package/sdk/sdk.gen.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
2
|
|
|
3
|
-
import type { Options as
|
|
4
|
-
import
|
|
5
|
-
import {
|
|
3
|
+
import type { Client, Options as Options2, TDataShape } from './client';
|
|
4
|
+
import { client } from './client.gen';
|
|
5
|
+
import type { AutoSelectAgentData, AutoSelectAgentErrors, AutoSelectAgentResponses, BatchProcessQueriesData, BatchProcessQueriesErrors, BatchProcessQueriesResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CheckCreditBalanceData, CheckCreditBalanceErrors, CheckCreditBalanceResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, CheckStorageLimitsData, CheckStorageLimitsErrors, CheckStorageLimitsResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreateLinkTokenData, CreateLinkTokenErrors, CreateLinkTokenResponses, CreateOrgData, CreateOrgErrors, CreateOrgResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateSubgraphData, CreateSubgraphErrors, CreateSubgraphResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, CreateViewData, CreateViewErrors, CreateViewResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, DeleteSubgraphData, DeleteSubgraphErrors, DeleteSubgraphResponses, ExchangeLinkTokenData, ExchangeLinkTokenErrors, ExchangeLinkTokenResponses, ExecuteCypherQueryData, ExecuteCypherQueryErrors, ExecuteCypherQueryResponses, ExecuteSpecificAgentData, ExecuteSpecificAgentErrors, ExecuteSpecificAgentResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAgentMetadataData, GetAgentMetadataErrors, GetAgentMetadataResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetConnectionData, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsErrors, GetConnectionOptionsResponses, GetConnectionResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserResponses, GetDatabaseHealthData, GetDatabaseHealthErrors, GetDatabaseHealthResponses, GetDatabaseInfoData, GetDatabaseInfoErrors, GetDatabaseInfoResponses, GetFileData, GetFileErrors, GetFileResponses, GetGraphLimitsData, GetGraphLimitsErrors, GetGraphLimitsResponses, GetGraphMetricsData, GetGraphMetricsErrors, GetGraphMetricsResponses, GetGraphSchemaData, GetGraphSchemaErrors, GetGraphSchemaResponses, GetGraphsData, GetGraphsErrors, GetGraphsResponses, GetGraphSubscriptionData, GetGraphSubscriptionErrors, GetGraphSubscriptionResponses, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsErrors, GetGraphUsageAnalyticsResponses, GetMaterializationStatusData, GetMaterializationStatusErrors, GetMaterializationStatusResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasswordPolicyData, GetPasswordPolicyResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetStorageUsageData, GetStorageUsageErrors, GetStorageUsageResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, GetSubgraphQuotaData, GetSubgraphQuotaErrors, GetSubgraphQuotaResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, InviteOrgMemberData, InviteOrgMemberErrors, InviteOrgMemberResponses, ListAgentsData, ListAgentsErrors, ListAgentsResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListMcpToolsData, ListMcpToolsErrors, ListMcpToolsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysResponses, ListUserOrgsData, ListUserOrgsResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserResponses, MaterializeGraphData, MaterializeGraphErrors, MaterializeGraphResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, QueryTablesData, QueryTablesErrors, QueryTablesResponses, RecommendAgentData, RecommendAgentErrors, RecommendAgentResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RestoreBackupData, RestoreBackupErrors, RestoreBackupResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, SaveViewData, SaveViewErrors, SaveViewResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, UpdateFileData, UpdateFileErrors, UpdateFileResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, UpgradeSubscriptionData, UpgradeSubscriptionErrors, UpgradeSubscriptionResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses } from './types.gen';
|
|
6
6
|
|
|
7
|
-
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> =
|
|
7
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
8
8
|
/**
|
|
9
9
|
* You can provide a client instance returned by `createClient()` instead of
|
|
10
10
|
* individual options. This might be also useful if you want to implement a
|
|
@@ -20,642 +20,419 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
20
20
|
|
|
21
21
|
/**
|
|
22
22
|
* Register New User
|
|
23
|
+
*
|
|
23
24
|
* Register a new user account with email and password.
|
|
24
25
|
*
|
|
25
26
|
* **Organization Creation**: RoboSystems is an org-centric platform. When you register, a personal organization is automatically created for you. All resources (graphs, subscriptions, billing) belong to organizations, not individual users. You can later upgrade your personal org to a team or enterprise organization.
|
|
26
27
|
*
|
|
27
28
|
* **Security Controls**: CAPTCHA and email verification are disabled in development for API testing, but required in production.
|
|
28
29
|
*/
|
|
29
|
-
export const registerUser = <ThrowOnError extends boolean = false>(options: Options<RegisterUserData, ThrowOnError>) => {
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
});
|
|
38
|
-
};
|
|
30
|
+
export const registerUser = <ThrowOnError extends boolean = false>(options: Options<RegisterUserData, ThrowOnError>) => (options.client ?? client).post<RegisterUserResponses, RegisterUserErrors, ThrowOnError>({
|
|
31
|
+
url: '/v1/auth/register',
|
|
32
|
+
...options,
|
|
33
|
+
headers: {
|
|
34
|
+
'Content-Type': 'application/json',
|
|
35
|
+
...options.headers
|
|
36
|
+
}
|
|
37
|
+
});
|
|
39
38
|
|
|
40
39
|
/**
|
|
41
40
|
* User Login
|
|
41
|
+
*
|
|
42
42
|
* Authenticate user with email and password.
|
|
43
43
|
*/
|
|
44
|
-
export const loginUser = <ThrowOnError extends boolean = false>(options: Options<LoginUserData, ThrowOnError>) => {
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
});
|
|
53
|
-
};
|
|
44
|
+
export const loginUser = <ThrowOnError extends boolean = false>(options: Options<LoginUserData, ThrowOnError>) => (options.client ?? client).post<LoginUserResponses, LoginUserErrors, ThrowOnError>({
|
|
45
|
+
url: '/v1/auth/login',
|
|
46
|
+
...options,
|
|
47
|
+
headers: {
|
|
48
|
+
'Content-Type': 'application/json',
|
|
49
|
+
...options.headers
|
|
50
|
+
}
|
|
51
|
+
});
|
|
54
52
|
|
|
55
53
|
/**
|
|
56
54
|
* User Logout
|
|
55
|
+
*
|
|
57
56
|
* Logout user and invalidate session.
|
|
58
57
|
*/
|
|
59
|
-
export const logoutUser = <ThrowOnError extends boolean = false>(options?: Options<LogoutUserData, ThrowOnError>) => {
|
|
60
|
-
return (options?.client ?? _heyApiClient).post<LogoutUserResponses, unknown, ThrowOnError>({
|
|
61
|
-
url: '/v1/auth/logout',
|
|
62
|
-
...options
|
|
63
|
-
});
|
|
64
|
-
};
|
|
58
|
+
export const logoutUser = <ThrowOnError extends boolean = false>(options?: Options<LogoutUserData, ThrowOnError>) => (options?.client ?? client).post<LogoutUserResponses, unknown, ThrowOnError>({ url: '/v1/auth/logout', ...options });
|
|
65
59
|
|
|
66
60
|
/**
|
|
67
61
|
* Get Current User
|
|
62
|
+
*
|
|
68
63
|
* Get the currently authenticated user.
|
|
69
64
|
*/
|
|
70
|
-
export const getCurrentAuthUser = <ThrowOnError extends boolean = false>(options?: Options<GetCurrentAuthUserData, ThrowOnError>) => {
|
|
71
|
-
return (options?.client ?? _heyApiClient).get<GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, ThrowOnError>({
|
|
72
|
-
url: '/v1/auth/me',
|
|
73
|
-
...options
|
|
74
|
-
});
|
|
75
|
-
};
|
|
65
|
+
export const getCurrentAuthUser = <ThrowOnError extends boolean = false>(options?: Options<GetCurrentAuthUserData, ThrowOnError>) => (options?.client ?? client).get<GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, ThrowOnError>({ url: '/v1/auth/me', ...options });
|
|
76
66
|
|
|
77
67
|
/**
|
|
78
68
|
* Refresh Session
|
|
69
|
+
*
|
|
79
70
|
* Refresh authentication session with a new JWT token.
|
|
80
71
|
*/
|
|
81
|
-
export const refreshAuthSession = <ThrowOnError extends boolean = false>(options?: Options<RefreshAuthSessionData, ThrowOnError>) => {
|
|
82
|
-
return (options?.client ?? _heyApiClient).post<RefreshAuthSessionResponses, RefreshAuthSessionErrors, ThrowOnError>({
|
|
83
|
-
url: '/v1/auth/refresh',
|
|
84
|
-
...options
|
|
85
|
-
});
|
|
86
|
-
};
|
|
72
|
+
export const refreshAuthSession = <ThrowOnError extends boolean = false>(options?: Options<RefreshAuthSessionData, ThrowOnError>) => (options?.client ?? client).post<RefreshAuthSessionResponses, RefreshAuthSessionErrors, ThrowOnError>({ url: '/v1/auth/refresh', ...options });
|
|
87
73
|
|
|
88
74
|
/**
|
|
89
75
|
* Resend Email Verification
|
|
76
|
+
*
|
|
90
77
|
* Resend verification email to the authenticated user. Rate limited to 3 per hour.
|
|
91
78
|
*/
|
|
92
|
-
export const resendVerificationEmail = <ThrowOnError extends boolean = false>(options?: Options<ResendVerificationEmailData, ThrowOnError>) => {
|
|
93
|
-
return (options?.client ?? _heyApiClient).post<ResendVerificationEmailResponses, ResendVerificationEmailErrors, ThrowOnError>({
|
|
94
|
-
url: '/v1/auth/email/resend',
|
|
95
|
-
...options
|
|
96
|
-
});
|
|
97
|
-
};
|
|
79
|
+
export const resendVerificationEmail = <ThrowOnError extends boolean = false>(options?: Options<ResendVerificationEmailData, ThrowOnError>) => (options?.client ?? client).post<ResendVerificationEmailResponses, ResendVerificationEmailErrors, ThrowOnError>({ url: '/v1/auth/email/resend', ...options });
|
|
98
80
|
|
|
99
81
|
/**
|
|
100
82
|
* Verify Email
|
|
83
|
+
*
|
|
101
84
|
* Verify email address with token from email link. Returns JWT for auto-login.
|
|
102
85
|
*/
|
|
103
|
-
export const verifyEmail = <ThrowOnError extends boolean = false>(options: Options<VerifyEmailData, ThrowOnError>) => {
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
});
|
|
112
|
-
};
|
|
86
|
+
export const verifyEmail = <ThrowOnError extends boolean = false>(options: Options<VerifyEmailData, ThrowOnError>) => (options.client ?? client).post<VerifyEmailResponses, VerifyEmailErrors, ThrowOnError>({
|
|
87
|
+
url: '/v1/auth/email/verify',
|
|
88
|
+
...options,
|
|
89
|
+
headers: {
|
|
90
|
+
'Content-Type': 'application/json',
|
|
91
|
+
...options.headers
|
|
92
|
+
}
|
|
93
|
+
});
|
|
113
94
|
|
|
114
95
|
/**
|
|
115
96
|
* Get Password Policy
|
|
97
|
+
*
|
|
116
98
|
* Get current password policy requirements for frontend validation
|
|
117
99
|
*/
|
|
118
|
-
export const getPasswordPolicy = <ThrowOnError extends boolean = false>(options?: Options<GetPasswordPolicyData, ThrowOnError>) => {
|
|
119
|
-
return (options?.client ?? _heyApiClient).get<GetPasswordPolicyResponses, unknown, ThrowOnError>({
|
|
120
|
-
url: '/v1/auth/password/policy',
|
|
121
|
-
...options
|
|
122
|
-
});
|
|
123
|
-
};
|
|
100
|
+
export const getPasswordPolicy = <ThrowOnError extends boolean = false>(options?: Options<GetPasswordPolicyData, ThrowOnError>) => (options?.client ?? client).get<GetPasswordPolicyResponses, unknown, ThrowOnError>({ url: '/v1/auth/password/policy', ...options });
|
|
124
101
|
|
|
125
102
|
/**
|
|
126
103
|
* Check Password Strength
|
|
104
|
+
*
|
|
127
105
|
* Check password strength and get validation feedback
|
|
128
106
|
*/
|
|
129
|
-
export const checkPasswordStrength = <ThrowOnError extends boolean = false>(options: Options<CheckPasswordStrengthData, ThrowOnError>) => {
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
});
|
|
138
|
-
};
|
|
107
|
+
export const checkPasswordStrength = <ThrowOnError extends boolean = false>(options: Options<CheckPasswordStrengthData, ThrowOnError>) => (options.client ?? client).post<CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ThrowOnError>({
|
|
108
|
+
url: '/v1/auth/password/check',
|
|
109
|
+
...options,
|
|
110
|
+
headers: {
|
|
111
|
+
'Content-Type': 'application/json',
|
|
112
|
+
...options.headers
|
|
113
|
+
}
|
|
114
|
+
});
|
|
139
115
|
|
|
140
116
|
/**
|
|
141
117
|
* Forgot Password
|
|
118
|
+
*
|
|
142
119
|
* Request password reset email. Always returns success to prevent email enumeration.
|
|
143
120
|
*/
|
|
144
|
-
export const forgotPassword = <ThrowOnError extends boolean = false>(options: Options<ForgotPasswordData, ThrowOnError>) => {
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
});
|
|
153
|
-
};
|
|
121
|
+
export const forgotPassword = <ThrowOnError extends boolean = false>(options: Options<ForgotPasswordData, ThrowOnError>) => (options.client ?? client).post<ForgotPasswordResponses, ForgotPasswordErrors, ThrowOnError>({
|
|
122
|
+
url: '/v1/auth/password/forgot',
|
|
123
|
+
...options,
|
|
124
|
+
headers: {
|
|
125
|
+
'Content-Type': 'application/json',
|
|
126
|
+
...options.headers
|
|
127
|
+
}
|
|
128
|
+
});
|
|
154
129
|
|
|
155
130
|
/**
|
|
156
131
|
* Validate Reset Token
|
|
132
|
+
*
|
|
157
133
|
* Check if a password reset token is valid without consuming it.
|
|
158
134
|
*/
|
|
159
|
-
export const validateResetToken = <ThrowOnError extends boolean = false>(options: Options<ValidateResetTokenData, ThrowOnError>) => {
|
|
160
|
-
return (options.client ?? _heyApiClient).get<ValidateResetTokenResponses, ValidateResetTokenErrors, ThrowOnError>({
|
|
161
|
-
url: '/v1/auth/password/reset/validate',
|
|
162
|
-
...options
|
|
163
|
-
});
|
|
164
|
-
};
|
|
135
|
+
export const validateResetToken = <ThrowOnError extends boolean = false>(options: Options<ValidateResetTokenData, ThrowOnError>) => (options.client ?? client).get<ValidateResetTokenResponses, ValidateResetTokenErrors, ThrowOnError>({ url: '/v1/auth/password/reset/validate', ...options });
|
|
165
136
|
|
|
166
137
|
/**
|
|
167
138
|
* Reset Password
|
|
139
|
+
*
|
|
168
140
|
* Reset password with token from email. Returns JWT for auto-login.
|
|
169
141
|
*/
|
|
170
|
-
export const resetPassword = <ThrowOnError extends boolean = false>(options: Options<ResetPasswordData, ThrowOnError>) => {
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
});
|
|
179
|
-
};
|
|
142
|
+
export const resetPassword = <ThrowOnError extends boolean = false>(options: Options<ResetPasswordData, ThrowOnError>) => (options.client ?? client).post<ResetPasswordResponses, ResetPasswordErrors, ThrowOnError>({
|
|
143
|
+
url: '/v1/auth/password/reset',
|
|
144
|
+
...options,
|
|
145
|
+
headers: {
|
|
146
|
+
'Content-Type': 'application/json',
|
|
147
|
+
...options.headers
|
|
148
|
+
}
|
|
149
|
+
});
|
|
180
150
|
|
|
181
151
|
/**
|
|
182
152
|
* Generate SSO Token
|
|
153
|
+
*
|
|
183
154
|
* Generate a temporary SSO token for cross-app authentication.
|
|
184
155
|
*/
|
|
185
|
-
export const generateSsoToken = <ThrowOnError extends boolean = false>(options?: Options<GenerateSsoTokenData, ThrowOnError>) => {
|
|
186
|
-
return (options?.client ?? _heyApiClient).post<GenerateSsoTokenResponses, GenerateSsoTokenErrors, ThrowOnError>({
|
|
187
|
-
url: '/v1/auth/sso-token',
|
|
188
|
-
...options
|
|
189
|
-
});
|
|
190
|
-
};
|
|
156
|
+
export const generateSsoToken = <ThrowOnError extends boolean = false>(options?: Options<GenerateSsoTokenData, ThrowOnError>) => (options?.client ?? client).post<GenerateSsoTokenResponses, GenerateSsoTokenErrors, ThrowOnError>({ url: '/v1/auth/sso-token', ...options });
|
|
191
157
|
|
|
192
158
|
/**
|
|
193
159
|
* SSO Token Exchange
|
|
160
|
+
*
|
|
194
161
|
* Exchange SSO token for secure session handoff to target application.
|
|
195
162
|
*/
|
|
196
|
-
export const ssoTokenExchange = <ThrowOnError extends boolean = false>(options: Options<SsoTokenExchangeData, ThrowOnError>) => {
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
});
|
|
205
|
-
};
|
|
163
|
+
export const ssoTokenExchange = <ThrowOnError extends boolean = false>(options: Options<SsoTokenExchangeData, ThrowOnError>) => (options.client ?? client).post<SsoTokenExchangeResponses, SsoTokenExchangeErrors, ThrowOnError>({
|
|
164
|
+
url: '/v1/auth/sso-exchange',
|
|
165
|
+
...options,
|
|
166
|
+
headers: {
|
|
167
|
+
'Content-Type': 'application/json',
|
|
168
|
+
...options.headers
|
|
169
|
+
}
|
|
170
|
+
});
|
|
206
171
|
|
|
207
172
|
/**
|
|
208
173
|
* Complete SSO Authentication
|
|
174
|
+
*
|
|
209
175
|
* Complete SSO authentication using session ID from secure handoff.
|
|
210
176
|
*/
|
|
211
|
-
export const completeSsoAuth = <ThrowOnError extends boolean = false>(options: Options<CompleteSsoAuthData, ThrowOnError>) => {
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
});
|
|
220
|
-
};
|
|
177
|
+
export const completeSsoAuth = <ThrowOnError extends boolean = false>(options: Options<CompleteSsoAuthData, ThrowOnError>) => (options.client ?? client).post<CompleteSsoAuthResponses, CompleteSsoAuthErrors, ThrowOnError>({
|
|
178
|
+
url: '/v1/auth/sso-complete',
|
|
179
|
+
...options,
|
|
180
|
+
headers: {
|
|
181
|
+
'Content-Type': 'application/json',
|
|
182
|
+
...options.headers
|
|
183
|
+
}
|
|
184
|
+
});
|
|
221
185
|
|
|
222
186
|
/**
|
|
223
187
|
* Get CAPTCHA Configuration
|
|
188
|
+
*
|
|
224
189
|
* Get CAPTCHA configuration including site key and whether CAPTCHA is required.
|
|
225
190
|
*/
|
|
226
|
-
export const getCaptchaConfig = <ThrowOnError extends boolean = false>(options?: Options<GetCaptchaConfigData, ThrowOnError>) => {
|
|
227
|
-
return (options?.client ?? _heyApiClient).get<GetCaptchaConfigResponses, unknown, ThrowOnError>({
|
|
228
|
-
url: '/v1/auth/captcha/config',
|
|
229
|
-
...options
|
|
230
|
-
});
|
|
231
|
-
};
|
|
191
|
+
export const getCaptchaConfig = <ThrowOnError extends boolean = false>(options?: Options<GetCaptchaConfigData, ThrowOnError>) => (options?.client ?? client).get<GetCaptchaConfigResponses, unknown, ThrowOnError>({ url: '/v1/auth/captcha/config', ...options });
|
|
232
192
|
|
|
233
193
|
/**
|
|
234
194
|
* Health Check
|
|
195
|
+
*
|
|
235
196
|
* Service health check endpoint for monitoring and load balancers
|
|
236
197
|
*/
|
|
237
|
-
export const getServiceStatus = <ThrowOnError extends boolean = false>(options?: Options<GetServiceStatusData, ThrowOnError>) => {
|
|
238
|
-
return (options?.client ?? _heyApiClient).get<GetServiceStatusResponses, unknown, ThrowOnError>({
|
|
239
|
-
url: '/v1/status',
|
|
240
|
-
...options
|
|
241
|
-
});
|
|
242
|
-
};
|
|
198
|
+
export const getServiceStatus = <ThrowOnError extends boolean = false>(options?: Options<GetServiceStatusData, ThrowOnError>) => (options?.client ?? client).get<GetServiceStatusResponses, unknown, ThrowOnError>({ url: '/v1/status', ...options });
|
|
243
199
|
|
|
244
200
|
/**
|
|
245
201
|
* Get Current User
|
|
202
|
+
*
|
|
246
203
|
* Returns information about the currently authenticated user.
|
|
247
204
|
*/
|
|
248
|
-
export const getCurrentUser = <ThrowOnError extends boolean = false>(options?: Options<GetCurrentUserData, ThrowOnError>) => {
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
type: 'apiKey'
|
|
254
|
-
},
|
|
255
|
-
{
|
|
256
|
-
scheme: 'bearer',
|
|
257
|
-
type: 'http'
|
|
258
|
-
}
|
|
259
|
-
],
|
|
260
|
-
url: '/v1/user',
|
|
261
|
-
...options
|
|
262
|
-
});
|
|
263
|
-
};
|
|
205
|
+
export const getCurrentUser = <ThrowOnError extends boolean = false>(options?: Options<GetCurrentUserData, ThrowOnError>) => (options?.client ?? client).get<GetCurrentUserResponses, unknown, ThrowOnError>({
|
|
206
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
207
|
+
url: '/v1/user',
|
|
208
|
+
...options
|
|
209
|
+
});
|
|
264
210
|
|
|
265
211
|
/**
|
|
266
212
|
* Update User Profile
|
|
213
|
+
*
|
|
267
214
|
* Update the current user's profile information.
|
|
268
215
|
*/
|
|
269
|
-
export const updateUser = <ThrowOnError extends boolean = false>(options: Options<UpdateUserData, ThrowOnError>) => {
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
type: 'http'
|
|
279
|
-
}
|
|
280
|
-
],
|
|
281
|
-
url: '/v1/user',
|
|
282
|
-
...options,
|
|
283
|
-
headers: {
|
|
284
|
-
'Content-Type': 'application/json',
|
|
285
|
-
...options.headers
|
|
286
|
-
}
|
|
287
|
-
});
|
|
288
|
-
};
|
|
216
|
+
export const updateUser = <ThrowOnError extends boolean = false>(options: Options<UpdateUserData, ThrowOnError>) => (options.client ?? client).put<UpdateUserResponses, UpdateUserErrors, ThrowOnError>({
|
|
217
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
218
|
+
url: '/v1/user',
|
|
219
|
+
...options,
|
|
220
|
+
headers: {
|
|
221
|
+
'Content-Type': 'application/json',
|
|
222
|
+
...options.headers
|
|
223
|
+
}
|
|
224
|
+
});
|
|
289
225
|
|
|
290
226
|
/**
|
|
291
227
|
* Update Password
|
|
228
|
+
*
|
|
292
229
|
* Update the current user's password.
|
|
293
230
|
*/
|
|
294
|
-
export const updateUserPassword = <ThrowOnError extends boolean = false>(options: Options<UpdateUserPasswordData, ThrowOnError>) => {
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
type: 'http'
|
|
304
|
-
}
|
|
305
|
-
],
|
|
306
|
-
url: '/v1/user/password',
|
|
307
|
-
...options,
|
|
308
|
-
headers: {
|
|
309
|
-
'Content-Type': 'application/json',
|
|
310
|
-
...options.headers
|
|
311
|
-
}
|
|
312
|
-
});
|
|
313
|
-
};
|
|
231
|
+
export const updateUserPassword = <ThrowOnError extends boolean = false>(options: Options<UpdateUserPasswordData, ThrowOnError>) => (options.client ?? client).put<UpdateUserPasswordResponses, UpdateUserPasswordErrors, ThrowOnError>({
|
|
232
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
233
|
+
url: '/v1/user/password',
|
|
234
|
+
...options,
|
|
235
|
+
headers: {
|
|
236
|
+
'Content-Type': 'application/json',
|
|
237
|
+
...options.headers
|
|
238
|
+
}
|
|
239
|
+
});
|
|
314
240
|
|
|
315
241
|
/**
|
|
316
242
|
* List API Keys
|
|
243
|
+
*
|
|
317
244
|
* Get all API keys for the current user.
|
|
318
245
|
*/
|
|
319
|
-
export const listUserApiKeys = <ThrowOnError extends boolean = false>(options?: Options<ListUserApiKeysData, ThrowOnError>) => {
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
type: 'apiKey'
|
|
325
|
-
},
|
|
326
|
-
{
|
|
327
|
-
scheme: 'bearer',
|
|
328
|
-
type: 'http'
|
|
329
|
-
}
|
|
330
|
-
],
|
|
331
|
-
url: '/v1/user/api-keys',
|
|
332
|
-
...options
|
|
333
|
-
});
|
|
334
|
-
};
|
|
246
|
+
export const listUserApiKeys = <ThrowOnError extends boolean = false>(options?: Options<ListUserApiKeysData, ThrowOnError>) => (options?.client ?? client).get<ListUserApiKeysResponses, unknown, ThrowOnError>({
|
|
247
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
248
|
+
url: '/v1/user/api-keys',
|
|
249
|
+
...options
|
|
250
|
+
});
|
|
335
251
|
|
|
336
252
|
/**
|
|
337
253
|
* Create API Key
|
|
254
|
+
*
|
|
338
255
|
* Create a new API key for the current user.
|
|
339
256
|
*/
|
|
340
|
-
export const createUserApiKey = <ThrowOnError extends boolean = false>(options: Options<CreateUserApiKeyData, ThrowOnError>) => {
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
type: 'http'
|
|
350
|
-
}
|
|
351
|
-
],
|
|
352
|
-
url: '/v1/user/api-keys',
|
|
353
|
-
...options,
|
|
354
|
-
headers: {
|
|
355
|
-
'Content-Type': 'application/json',
|
|
356
|
-
...options.headers
|
|
357
|
-
}
|
|
358
|
-
});
|
|
359
|
-
};
|
|
257
|
+
export const createUserApiKey = <ThrowOnError extends boolean = false>(options: Options<CreateUserApiKeyData, ThrowOnError>) => (options.client ?? client).post<CreateUserApiKeyResponses, CreateUserApiKeyErrors, ThrowOnError>({
|
|
258
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
259
|
+
url: '/v1/user/api-keys',
|
|
260
|
+
...options,
|
|
261
|
+
headers: {
|
|
262
|
+
'Content-Type': 'application/json',
|
|
263
|
+
...options.headers
|
|
264
|
+
}
|
|
265
|
+
});
|
|
360
266
|
|
|
361
267
|
/**
|
|
362
268
|
* Revoke API Key
|
|
269
|
+
*
|
|
363
270
|
* Revoke (deactivate) an API key.
|
|
364
271
|
*/
|
|
365
|
-
export const revokeUserApiKey = <ThrowOnError extends boolean = false>(options: Options<RevokeUserApiKeyData, ThrowOnError>) => {
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
type: 'apiKey'
|
|
371
|
-
},
|
|
372
|
-
{
|
|
373
|
-
scheme: 'bearer',
|
|
374
|
-
type: 'http'
|
|
375
|
-
}
|
|
376
|
-
],
|
|
377
|
-
url: '/v1/user/api-keys/{api_key_id}',
|
|
378
|
-
...options
|
|
379
|
-
});
|
|
380
|
-
};
|
|
272
|
+
export const revokeUserApiKey = <ThrowOnError extends boolean = false>(options: Options<RevokeUserApiKeyData, ThrowOnError>) => (options.client ?? client).delete<RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, ThrowOnError>({
|
|
273
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
274
|
+
url: '/v1/user/api-keys/{api_key_id}',
|
|
275
|
+
...options
|
|
276
|
+
});
|
|
381
277
|
|
|
382
278
|
/**
|
|
383
279
|
* Update API Key
|
|
280
|
+
*
|
|
384
281
|
* Update an API key's name or description.
|
|
385
282
|
*/
|
|
386
|
-
export const updateUserApiKey = <ThrowOnError extends boolean = false>(options: Options<UpdateUserApiKeyData, ThrowOnError>) => {
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
type: 'http'
|
|
396
|
-
}
|
|
397
|
-
],
|
|
398
|
-
url: '/v1/user/api-keys/{api_key_id}',
|
|
399
|
-
...options,
|
|
400
|
-
headers: {
|
|
401
|
-
'Content-Type': 'application/json',
|
|
402
|
-
...options.headers
|
|
403
|
-
}
|
|
404
|
-
});
|
|
405
|
-
};
|
|
283
|
+
export const updateUserApiKey = <ThrowOnError extends boolean = false>(options: Options<UpdateUserApiKeyData, ThrowOnError>) => (options.client ?? client).put<UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, ThrowOnError>({
|
|
284
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
285
|
+
url: '/v1/user/api-keys/{api_key_id}',
|
|
286
|
+
...options,
|
|
287
|
+
headers: {
|
|
288
|
+
'Content-Type': 'application/json',
|
|
289
|
+
...options.headers
|
|
290
|
+
}
|
|
291
|
+
});
|
|
406
292
|
|
|
407
293
|
/**
|
|
408
294
|
* List User's Organizations
|
|
295
|
+
*
|
|
409
296
|
* Get all organizations the current user belongs to, with their role in each.
|
|
410
297
|
*/
|
|
411
|
-
export const listUserOrgs = <ThrowOnError extends boolean = false>(options?: Options<ListUserOrgsData, ThrowOnError>) => {
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
type: 'apiKey'
|
|
417
|
-
},
|
|
418
|
-
{
|
|
419
|
-
scheme: 'bearer',
|
|
420
|
-
type: 'http'
|
|
421
|
-
}
|
|
422
|
-
],
|
|
423
|
-
url: '/v1/orgs',
|
|
424
|
-
...options
|
|
425
|
-
});
|
|
426
|
-
};
|
|
298
|
+
export const listUserOrgs = <ThrowOnError extends boolean = false>(options?: Options<ListUserOrgsData, ThrowOnError>) => (options?.client ?? client).get<ListUserOrgsResponses, unknown, ThrowOnError>({
|
|
299
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
300
|
+
url: '/v1/orgs',
|
|
301
|
+
...options
|
|
302
|
+
});
|
|
427
303
|
|
|
428
304
|
/**
|
|
429
305
|
* Create Organization
|
|
306
|
+
*
|
|
430
307
|
* Create a new organization. The creating user becomes the owner.
|
|
431
308
|
*/
|
|
432
|
-
export const createOrg = <ThrowOnError extends boolean = false>(options: Options<CreateOrgData, ThrowOnError>) => {
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
type: 'http'
|
|
442
|
-
}
|
|
443
|
-
],
|
|
444
|
-
url: '/v1/orgs',
|
|
445
|
-
...options,
|
|
446
|
-
headers: {
|
|
447
|
-
'Content-Type': 'application/json',
|
|
448
|
-
...options.headers
|
|
449
|
-
}
|
|
450
|
-
});
|
|
451
|
-
};
|
|
309
|
+
export const createOrg = <ThrowOnError extends boolean = false>(options: Options<CreateOrgData, ThrowOnError>) => (options.client ?? client).post<CreateOrgResponses, CreateOrgErrors, ThrowOnError>({
|
|
310
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
311
|
+
url: '/v1/orgs',
|
|
312
|
+
...options,
|
|
313
|
+
headers: {
|
|
314
|
+
'Content-Type': 'application/json',
|
|
315
|
+
...options.headers
|
|
316
|
+
}
|
|
317
|
+
});
|
|
452
318
|
|
|
453
319
|
/**
|
|
454
320
|
* Get Organization
|
|
321
|
+
*
|
|
455
322
|
* Get detailed information about an organization.
|
|
456
323
|
*/
|
|
457
|
-
export const getOrg = <ThrowOnError extends boolean = false>(options: Options<GetOrgData, ThrowOnError>) => {
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
type: 'apiKey'
|
|
463
|
-
},
|
|
464
|
-
{
|
|
465
|
-
scheme: 'bearer',
|
|
466
|
-
type: 'http'
|
|
467
|
-
}
|
|
468
|
-
],
|
|
469
|
-
url: '/v1/orgs/{org_id}',
|
|
470
|
-
...options
|
|
471
|
-
});
|
|
472
|
-
};
|
|
324
|
+
export const getOrg = <ThrowOnError extends boolean = false>(options: Options<GetOrgData, ThrowOnError>) => (options.client ?? client).get<GetOrgResponses, GetOrgErrors, ThrowOnError>({
|
|
325
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
326
|
+
url: '/v1/orgs/{org_id}',
|
|
327
|
+
...options
|
|
328
|
+
});
|
|
473
329
|
|
|
474
330
|
/**
|
|
475
331
|
* Update Organization
|
|
332
|
+
*
|
|
476
333
|
* Update organization information. Requires admin or owner role.
|
|
477
334
|
*/
|
|
478
|
-
export const updateOrg = <ThrowOnError extends boolean = false>(options: Options<UpdateOrgData, ThrowOnError>) => {
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
type: 'http'
|
|
488
|
-
}
|
|
489
|
-
],
|
|
490
|
-
url: '/v1/orgs/{org_id}',
|
|
491
|
-
...options,
|
|
492
|
-
headers: {
|
|
493
|
-
'Content-Type': 'application/json',
|
|
494
|
-
...options.headers
|
|
495
|
-
}
|
|
496
|
-
});
|
|
497
|
-
};
|
|
335
|
+
export const updateOrg = <ThrowOnError extends boolean = false>(options: Options<UpdateOrgData, ThrowOnError>) => (options.client ?? client).put<UpdateOrgResponses, UpdateOrgErrors, ThrowOnError>({
|
|
336
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
337
|
+
url: '/v1/orgs/{org_id}',
|
|
338
|
+
...options,
|
|
339
|
+
headers: {
|
|
340
|
+
'Content-Type': 'application/json',
|
|
341
|
+
...options.headers
|
|
342
|
+
}
|
|
343
|
+
});
|
|
498
344
|
|
|
499
345
|
/**
|
|
500
346
|
* List Organization Graphs
|
|
347
|
+
*
|
|
501
348
|
* Get all graphs belonging to an organization.
|
|
502
349
|
*/
|
|
503
|
-
export const listOrgGraphs = <ThrowOnError extends boolean = false>(options: Options<ListOrgGraphsData, ThrowOnError>) => {
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
type: 'apiKey'
|
|
509
|
-
},
|
|
510
|
-
{
|
|
511
|
-
scheme: 'bearer',
|
|
512
|
-
type: 'http'
|
|
513
|
-
}
|
|
514
|
-
],
|
|
515
|
-
url: '/v1/orgs/{org_id}/graphs',
|
|
516
|
-
...options
|
|
517
|
-
});
|
|
518
|
-
};
|
|
350
|
+
export const listOrgGraphs = <ThrowOnError extends boolean = false>(options: Options<ListOrgGraphsData, ThrowOnError>) => (options.client ?? client).get<ListOrgGraphsResponses, ListOrgGraphsErrors, ThrowOnError>({
|
|
351
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
352
|
+
url: '/v1/orgs/{org_id}/graphs',
|
|
353
|
+
...options
|
|
354
|
+
});
|
|
519
355
|
|
|
520
356
|
/**
|
|
521
357
|
* List Organization Members
|
|
358
|
+
*
|
|
522
359
|
* Get all members of an organization with their roles.
|
|
523
360
|
*/
|
|
524
|
-
export const listOrgMembers = <ThrowOnError extends boolean = false>(options: Options<ListOrgMembersData, ThrowOnError>) => {
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
type: 'apiKey'
|
|
530
|
-
},
|
|
531
|
-
{
|
|
532
|
-
scheme: 'bearer',
|
|
533
|
-
type: 'http'
|
|
534
|
-
}
|
|
535
|
-
],
|
|
536
|
-
url: '/v1/orgs/{org_id}/members',
|
|
537
|
-
...options
|
|
538
|
-
});
|
|
539
|
-
};
|
|
361
|
+
export const listOrgMembers = <ThrowOnError extends boolean = false>(options: Options<ListOrgMembersData, ThrowOnError>) => (options.client ?? client).get<ListOrgMembersResponses, ListOrgMembersErrors, ThrowOnError>({
|
|
362
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
363
|
+
url: '/v1/orgs/{org_id}/members',
|
|
364
|
+
...options
|
|
365
|
+
});
|
|
540
366
|
|
|
541
367
|
/**
|
|
542
368
|
* Invite Member
|
|
369
|
+
*
|
|
543
370
|
* Invite a user to join the organization. Requires admin or owner role.
|
|
544
371
|
*
|
|
545
372
|
* **⚠️ FEATURE NOT READY**: This endpoint is disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false).
|
|
546
373
|
* Returns 501 NOT IMPLEMENTED when disabled. See endpoint implementation for TODO list before enabling.
|
|
547
374
|
*/
|
|
548
|
-
export const inviteOrgMember = <ThrowOnError extends boolean = false>(options: Options<InviteOrgMemberData, ThrowOnError>) => {
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
type: 'http'
|
|
558
|
-
}
|
|
559
|
-
],
|
|
560
|
-
url: '/v1/orgs/{org_id}/members',
|
|
561
|
-
...options,
|
|
562
|
-
headers: {
|
|
563
|
-
'Content-Type': 'application/json',
|
|
564
|
-
...options.headers
|
|
565
|
-
}
|
|
566
|
-
});
|
|
567
|
-
};
|
|
375
|
+
export const inviteOrgMember = <ThrowOnError extends boolean = false>(options: Options<InviteOrgMemberData, ThrowOnError>) => (options.client ?? client).post<InviteOrgMemberResponses, InviteOrgMemberErrors, ThrowOnError>({
|
|
376
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
377
|
+
url: '/v1/orgs/{org_id}/members',
|
|
378
|
+
...options,
|
|
379
|
+
headers: {
|
|
380
|
+
'Content-Type': 'application/json',
|
|
381
|
+
...options.headers
|
|
382
|
+
}
|
|
383
|
+
});
|
|
568
384
|
|
|
569
385
|
/**
|
|
570
386
|
* Remove Member
|
|
387
|
+
*
|
|
571
388
|
* Remove a member from the organization. Requires admin or owner role.
|
|
572
389
|
*/
|
|
573
|
-
export const removeOrgMember = <ThrowOnError extends boolean = false>(options: Options<RemoveOrgMemberData, ThrowOnError>) => {
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
type: 'apiKey'
|
|
579
|
-
},
|
|
580
|
-
{
|
|
581
|
-
scheme: 'bearer',
|
|
582
|
-
type: 'http'
|
|
583
|
-
}
|
|
584
|
-
],
|
|
585
|
-
url: '/v1/orgs/{org_id}/members/{user_id}',
|
|
586
|
-
...options
|
|
587
|
-
});
|
|
588
|
-
};
|
|
390
|
+
export const removeOrgMember = <ThrowOnError extends boolean = false>(options: Options<RemoveOrgMemberData, ThrowOnError>) => (options.client ?? client).delete<RemoveOrgMemberResponses, RemoveOrgMemberErrors, ThrowOnError>({
|
|
391
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
392
|
+
url: '/v1/orgs/{org_id}/members/{user_id}',
|
|
393
|
+
...options
|
|
394
|
+
});
|
|
589
395
|
|
|
590
396
|
/**
|
|
591
397
|
* Update Member Role
|
|
398
|
+
*
|
|
592
399
|
* Update a member's role in the organization. Requires admin or owner role.
|
|
593
400
|
*/
|
|
594
|
-
export const updateOrgMemberRole = <ThrowOnError extends boolean = false>(options: Options<UpdateOrgMemberRoleData, ThrowOnError>) => {
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
type: 'http'
|
|
604
|
-
}
|
|
605
|
-
],
|
|
606
|
-
url: '/v1/orgs/{org_id}/members/{user_id}',
|
|
607
|
-
...options,
|
|
608
|
-
headers: {
|
|
609
|
-
'Content-Type': 'application/json',
|
|
610
|
-
...options.headers
|
|
611
|
-
}
|
|
612
|
-
});
|
|
613
|
-
};
|
|
401
|
+
export const updateOrgMemberRole = <ThrowOnError extends boolean = false>(options: Options<UpdateOrgMemberRoleData, ThrowOnError>) => (options.client ?? client).put<UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, ThrowOnError>({
|
|
402
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
403
|
+
url: '/v1/orgs/{org_id}/members/{user_id}',
|
|
404
|
+
...options,
|
|
405
|
+
headers: {
|
|
406
|
+
'Content-Type': 'application/json',
|
|
407
|
+
...options.headers
|
|
408
|
+
}
|
|
409
|
+
});
|
|
614
410
|
|
|
615
411
|
/**
|
|
616
412
|
* Get Organization Limits
|
|
413
|
+
*
|
|
617
414
|
* Get the current limits and quotas for an organization.
|
|
618
415
|
*/
|
|
619
|
-
export const getOrgLimits = <ThrowOnError extends boolean = false>(options: Options<GetOrgLimitsData, ThrowOnError>) => {
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
type: 'apiKey'
|
|
625
|
-
},
|
|
626
|
-
{
|
|
627
|
-
scheme: 'bearer',
|
|
628
|
-
type: 'http'
|
|
629
|
-
}
|
|
630
|
-
],
|
|
631
|
-
url: '/v1/orgs/{org_id}/limits',
|
|
632
|
-
...options
|
|
633
|
-
});
|
|
634
|
-
};
|
|
416
|
+
export const getOrgLimits = <ThrowOnError extends boolean = false>(options: Options<GetOrgLimitsData, ThrowOnError>) => (options.client ?? client).get<GetOrgLimitsResponses, GetOrgLimitsErrors, ThrowOnError>({
|
|
417
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
418
|
+
url: '/v1/orgs/{org_id}/limits',
|
|
419
|
+
...options
|
|
420
|
+
});
|
|
635
421
|
|
|
636
422
|
/**
|
|
637
423
|
* Get Organization Usage
|
|
424
|
+
*
|
|
638
425
|
* Get detailed usage statistics for an organization aggregated across all graphs.
|
|
639
426
|
*/
|
|
640
|
-
export const getOrgUsage = <ThrowOnError extends boolean = false>(options: Options<GetOrgUsageData, ThrowOnError>) => {
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
type: 'apiKey'
|
|
646
|
-
},
|
|
647
|
-
{
|
|
648
|
-
scheme: 'bearer',
|
|
649
|
-
type: 'http'
|
|
650
|
-
}
|
|
651
|
-
],
|
|
652
|
-
url: '/v1/orgs/{org_id}/usage',
|
|
653
|
-
...options
|
|
654
|
-
});
|
|
655
|
-
};
|
|
427
|
+
export const getOrgUsage = <ThrowOnError extends boolean = false>(options: Options<GetOrgUsageData, ThrowOnError>) => (options.client ?? client).get<GetOrgUsageResponses, GetOrgUsageErrors, ThrowOnError>({
|
|
428
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
429
|
+
url: '/v1/orgs/{org_id}/usage',
|
|
430
|
+
...options
|
|
431
|
+
});
|
|
656
432
|
|
|
657
433
|
/**
|
|
658
434
|
* List Connections
|
|
435
|
+
*
|
|
659
436
|
* List all data connections in the graph.
|
|
660
437
|
*
|
|
661
438
|
* Returns active and inactive connections with their current status.
|
|
@@ -671,25 +448,15 @@ export const getOrgUsage = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
671
448
|
*
|
|
672
449
|
* No credits are consumed for listing connections.
|
|
673
450
|
*/
|
|
674
|
-
export const listConnections = <ThrowOnError extends boolean = false>(options: Options<ListConnectionsData, ThrowOnError>) => {
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
type: 'apiKey'
|
|
680
|
-
},
|
|
681
|
-
{
|
|
682
|
-
scheme: 'bearer',
|
|
683
|
-
type: 'http'
|
|
684
|
-
}
|
|
685
|
-
],
|
|
686
|
-
url: '/v1/graphs/{graph_id}/connections',
|
|
687
|
-
...options
|
|
688
|
-
});
|
|
689
|
-
};
|
|
451
|
+
export const listConnections = <ThrowOnError extends boolean = false>(options: Options<ListConnectionsData, ThrowOnError>) => (options.client ?? client).get<ListConnectionsResponses, ListConnectionsErrors, ThrowOnError>({
|
|
452
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
453
|
+
url: '/v1/graphs/{graph_id}/connections',
|
|
454
|
+
...options
|
|
455
|
+
});
|
|
690
456
|
|
|
691
457
|
/**
|
|
692
458
|
* Create Connection
|
|
459
|
+
*
|
|
693
460
|
* Create a new data connection for external system integration.
|
|
694
461
|
*
|
|
695
462
|
* This endpoint initiates connections to external data sources:
|
|
@@ -712,29 +479,19 @@ export const listConnections = <ThrowOnError extends boolean = false>(options: O
|
|
|
712
479
|
* Note:
|
|
713
480
|
* This operation is included - no credit consumption required.
|
|
714
481
|
*/
|
|
715
|
-
export const createConnection = <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => {
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
type: 'http'
|
|
725
|
-
}
|
|
726
|
-
],
|
|
727
|
-
url: '/v1/graphs/{graph_id}/connections',
|
|
728
|
-
...options,
|
|
729
|
-
headers: {
|
|
730
|
-
'Content-Type': 'application/json',
|
|
731
|
-
...options.headers
|
|
732
|
-
}
|
|
733
|
-
});
|
|
734
|
-
};
|
|
482
|
+
export const createConnection = <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => (options.client ?? client).post<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError>({
|
|
483
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
484
|
+
url: '/v1/graphs/{graph_id}/connections',
|
|
485
|
+
...options,
|
|
486
|
+
headers: {
|
|
487
|
+
'Content-Type': 'application/json',
|
|
488
|
+
...options.headers
|
|
489
|
+
}
|
|
490
|
+
});
|
|
735
491
|
|
|
736
492
|
/**
|
|
737
493
|
* List Connection Options
|
|
494
|
+
*
|
|
738
495
|
* Get metadata about all available data connection providers.
|
|
739
496
|
*
|
|
740
497
|
* This endpoint returns comprehensive information about each supported provider:
|
|
@@ -756,25 +513,15 @@ export const createConnection = <ThrowOnError extends boolean = false>(options:
|
|
|
756
513
|
*
|
|
757
514
|
* No credits are consumed for viewing connection options.
|
|
758
515
|
*/
|
|
759
|
-
export const getConnectionOptions = <ThrowOnError extends boolean = false>(options: Options<GetConnectionOptionsData, ThrowOnError>) => {
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
type: 'apiKey'
|
|
765
|
-
},
|
|
766
|
-
{
|
|
767
|
-
scheme: 'bearer',
|
|
768
|
-
type: 'http'
|
|
769
|
-
}
|
|
770
|
-
],
|
|
771
|
-
url: '/v1/graphs/{graph_id}/connections/options',
|
|
772
|
-
...options
|
|
773
|
-
});
|
|
774
|
-
};
|
|
516
|
+
export const getConnectionOptions = <ThrowOnError extends boolean = false>(options: Options<GetConnectionOptionsData, ThrowOnError>) => (options.client ?? client).get<GetConnectionOptionsResponses, GetConnectionOptionsErrors, ThrowOnError>({
|
|
517
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
518
|
+
url: '/v1/graphs/{graph_id}/connections/options',
|
|
519
|
+
...options
|
|
520
|
+
});
|
|
775
521
|
|
|
776
522
|
/**
|
|
777
523
|
* Exchange Link Token
|
|
524
|
+
*
|
|
778
525
|
* Exchange a public token for permanent access credentials.
|
|
779
526
|
*
|
|
780
527
|
* This completes the embedded authentication flow after user authorization.
|
|
@@ -795,29 +542,19 @@ export const getConnectionOptions = <ThrowOnError extends boolean = false>(optio
|
|
|
795
542
|
*
|
|
796
543
|
* No credits are consumed for token exchange.
|
|
797
544
|
*/
|
|
798
|
-
export const exchangeLinkToken = <ThrowOnError extends boolean = false>(options: Options<ExchangeLinkTokenData, ThrowOnError>) => {
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
type: 'http'
|
|
808
|
-
}
|
|
809
|
-
],
|
|
810
|
-
url: '/v1/graphs/{graph_id}/connections/link/exchange',
|
|
811
|
-
...options,
|
|
812
|
-
headers: {
|
|
813
|
-
'Content-Type': 'application/json',
|
|
814
|
-
...options.headers
|
|
815
|
-
}
|
|
816
|
-
});
|
|
817
|
-
};
|
|
545
|
+
export const exchangeLinkToken = <ThrowOnError extends boolean = false>(options: Options<ExchangeLinkTokenData, ThrowOnError>) => (options.client ?? client).post<ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, ThrowOnError>({
|
|
546
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
547
|
+
url: '/v1/graphs/{graph_id}/connections/link/exchange',
|
|
548
|
+
...options,
|
|
549
|
+
headers: {
|
|
550
|
+
'Content-Type': 'application/json',
|
|
551
|
+
...options.headers
|
|
552
|
+
}
|
|
553
|
+
});
|
|
818
554
|
|
|
819
555
|
/**
|
|
820
556
|
* Create Link Token
|
|
557
|
+
*
|
|
821
558
|
* Create a link token for embedded authentication providers.
|
|
822
559
|
*
|
|
823
560
|
* This endpoint generates a temporary token used to initialize embedded authentication UI.
|
|
@@ -833,57 +570,37 @@ export const exchangeLinkToken = <ThrowOnError extends boolean = false>(options:
|
|
|
833
570
|
*
|
|
834
571
|
* No credits are consumed for creating link tokens.
|
|
835
572
|
*/
|
|
836
|
-
export const createLinkToken = <ThrowOnError extends boolean = false>(options: Options<CreateLinkTokenData, ThrowOnError>) => {
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
type: 'http'
|
|
846
|
-
}
|
|
847
|
-
],
|
|
848
|
-
url: '/v1/graphs/{graph_id}/connections/link/token',
|
|
849
|
-
...options,
|
|
850
|
-
headers: {
|
|
851
|
-
'Content-Type': 'application/json',
|
|
852
|
-
...options.headers
|
|
853
|
-
}
|
|
854
|
-
});
|
|
855
|
-
};
|
|
573
|
+
export const createLinkToken = <ThrowOnError extends boolean = false>(options: Options<CreateLinkTokenData, ThrowOnError>) => (options.client ?? client).post<CreateLinkTokenResponses, CreateLinkTokenErrors, ThrowOnError>({
|
|
574
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
575
|
+
url: '/v1/graphs/{graph_id}/connections/link/token',
|
|
576
|
+
...options,
|
|
577
|
+
headers: {
|
|
578
|
+
'Content-Type': 'application/json',
|
|
579
|
+
...options.headers
|
|
580
|
+
}
|
|
581
|
+
});
|
|
856
582
|
|
|
857
583
|
/**
|
|
858
584
|
* Init Oauth
|
|
585
|
+
*
|
|
859
586
|
* Initialize OAuth flow for a connection.
|
|
860
587
|
*
|
|
861
588
|
* This generates an authorization URL that the frontend should redirect the user to.
|
|
862
589
|
* Currently supports: QuickBooks
|
|
863
590
|
*/
|
|
864
|
-
export const initOAuth = <ThrowOnError extends boolean = false>(options: Options<InitOAuthData, ThrowOnError>) => {
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
type: 'http'
|
|
874
|
-
}
|
|
875
|
-
],
|
|
876
|
-
url: '/v1/graphs/{graph_id}/connections/oauth/init',
|
|
877
|
-
...options,
|
|
878
|
-
headers: {
|
|
879
|
-
'Content-Type': 'application/json',
|
|
880
|
-
...options.headers
|
|
881
|
-
}
|
|
882
|
-
});
|
|
883
|
-
};
|
|
591
|
+
export const initOAuth = <ThrowOnError extends boolean = false>(options: Options<InitOAuthData, ThrowOnError>) => (options.client ?? client).post<InitOAuthResponses, InitOAuthErrors, ThrowOnError>({
|
|
592
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
593
|
+
url: '/v1/graphs/{graph_id}/connections/oauth/init',
|
|
594
|
+
...options,
|
|
595
|
+
headers: {
|
|
596
|
+
'Content-Type': 'application/json',
|
|
597
|
+
...options.headers
|
|
598
|
+
}
|
|
599
|
+
});
|
|
884
600
|
|
|
885
601
|
/**
|
|
886
602
|
* OAuth Callback
|
|
603
|
+
*
|
|
887
604
|
* Handle OAuth callback from provider after user authorization.
|
|
888
605
|
*
|
|
889
606
|
* This endpoint completes the OAuth flow:
|
|
@@ -904,29 +621,19 @@ export const initOAuth = <ThrowOnError extends boolean = false>(options: Options
|
|
|
904
621
|
*
|
|
905
622
|
* No credits are consumed for OAuth callbacks.
|
|
906
623
|
*/
|
|
907
|
-
export const oauthCallback = <ThrowOnError extends boolean = false>(options: Options<OauthCallbackData, ThrowOnError>) => {
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
type: 'http'
|
|
917
|
-
}
|
|
918
|
-
],
|
|
919
|
-
url: '/v1/graphs/{graph_id}/connections/oauth/callback/{provider}',
|
|
920
|
-
...options,
|
|
921
|
-
headers: {
|
|
922
|
-
'Content-Type': 'application/json',
|
|
923
|
-
...options.headers
|
|
924
|
-
}
|
|
925
|
-
});
|
|
926
|
-
};
|
|
624
|
+
export const oauthCallback = <ThrowOnError extends boolean = false>(options: Options<OauthCallbackData, ThrowOnError>) => (options.client ?? client).post<OauthCallbackResponses, OauthCallbackErrors, ThrowOnError>({
|
|
625
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
626
|
+
url: '/v1/graphs/{graph_id}/connections/oauth/callback/{provider}',
|
|
627
|
+
...options,
|
|
628
|
+
headers: {
|
|
629
|
+
'Content-Type': 'application/json',
|
|
630
|
+
...options.headers
|
|
631
|
+
}
|
|
632
|
+
});
|
|
927
633
|
|
|
928
634
|
/**
|
|
929
635
|
* Delete Connection
|
|
636
|
+
*
|
|
930
637
|
* Delete a data connection and clean up related resources.
|
|
931
638
|
*
|
|
932
639
|
* This operation:
|
|
@@ -940,25 +647,15 @@ export const oauthCallback = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
940
647
|
*
|
|
941
648
|
* Only users with admin role can delete connections.
|
|
942
649
|
*/
|
|
943
|
-
export const deleteConnection = <ThrowOnError extends boolean = false>(options: Options<DeleteConnectionData, ThrowOnError>) => {
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
type: 'apiKey'
|
|
949
|
-
},
|
|
950
|
-
{
|
|
951
|
-
scheme: 'bearer',
|
|
952
|
-
type: 'http'
|
|
953
|
-
}
|
|
954
|
-
],
|
|
955
|
-
url: '/v1/graphs/{graph_id}/connections/{connection_id}',
|
|
956
|
-
...options
|
|
957
|
-
});
|
|
958
|
-
};
|
|
650
|
+
export const deleteConnection = <ThrowOnError extends boolean = false>(options: Options<DeleteConnectionData, ThrowOnError>) => (options.client ?? client).delete<DeleteConnectionResponses, DeleteConnectionErrors, ThrowOnError>({
|
|
651
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
652
|
+
url: '/v1/graphs/{graph_id}/connections/{connection_id}',
|
|
653
|
+
...options
|
|
654
|
+
});
|
|
959
655
|
|
|
960
656
|
/**
|
|
961
657
|
* Get Connection
|
|
658
|
+
*
|
|
962
659
|
* Get detailed information about a specific connection.
|
|
963
660
|
*
|
|
964
661
|
* Returns comprehensive connection details including:
|
|
@@ -970,25 +667,15 @@ export const deleteConnection = <ThrowOnError extends boolean = false>(options:
|
|
|
970
667
|
*
|
|
971
668
|
* No credits are consumed for viewing connection details.
|
|
972
669
|
*/
|
|
973
|
-
export const getConnection = <ThrowOnError extends boolean = false>(options: Options<GetConnectionData, ThrowOnError>) => {
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
type: 'apiKey'
|
|
979
|
-
},
|
|
980
|
-
{
|
|
981
|
-
scheme: 'bearer',
|
|
982
|
-
type: 'http'
|
|
983
|
-
}
|
|
984
|
-
],
|
|
985
|
-
url: '/v1/graphs/{graph_id}/connections/{connection_id}',
|
|
986
|
-
...options
|
|
987
|
-
});
|
|
988
|
-
};
|
|
670
|
+
export const getConnection = <ThrowOnError extends boolean = false>(options: Options<GetConnectionData, ThrowOnError>) => (options.client ?? client).get<GetConnectionResponses, GetConnectionErrors, ThrowOnError>({
|
|
671
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
672
|
+
url: '/v1/graphs/{graph_id}/connections/{connection_id}',
|
|
673
|
+
...options
|
|
674
|
+
});
|
|
989
675
|
|
|
990
676
|
/**
|
|
991
677
|
* Sync Connection
|
|
678
|
+
*
|
|
992
679
|
* Trigger a data synchronization for the connection.
|
|
993
680
|
*
|
|
994
681
|
* Initiates data sync based on provider type:
|
|
@@ -1014,29 +701,19 @@ export const getConnection = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
1014
701
|
*
|
|
1015
702
|
* Returns a task ID for monitoring sync progress.
|
|
1016
703
|
*/
|
|
1017
|
-
export const syncConnection = <ThrowOnError extends boolean = false>(options: Options<SyncConnectionData, ThrowOnError>) => {
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
type: 'http'
|
|
1027
|
-
}
|
|
1028
|
-
],
|
|
1029
|
-
url: '/v1/graphs/{graph_id}/connections/{connection_id}/sync',
|
|
1030
|
-
...options,
|
|
1031
|
-
headers: {
|
|
1032
|
-
'Content-Type': 'application/json',
|
|
1033
|
-
...options.headers
|
|
1034
|
-
}
|
|
1035
|
-
});
|
|
1036
|
-
};
|
|
704
|
+
export const syncConnection = <ThrowOnError extends boolean = false>(options: Options<SyncConnectionData, ThrowOnError>) => (options.client ?? client).post<SyncConnectionResponses, SyncConnectionErrors, ThrowOnError>({
|
|
705
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
706
|
+
url: '/v1/graphs/{graph_id}/connections/{connection_id}/sync',
|
|
707
|
+
...options,
|
|
708
|
+
headers: {
|
|
709
|
+
'Content-Type': 'application/json',
|
|
710
|
+
...options.headers
|
|
711
|
+
}
|
|
712
|
+
});
|
|
1037
713
|
|
|
1038
714
|
/**
|
|
1039
715
|
* List available agents
|
|
716
|
+
*
|
|
1040
717
|
* Get a comprehensive list of all available agents with their metadata.
|
|
1041
718
|
*
|
|
1042
719
|
* **Returns:**
|
|
@@ -1047,25 +724,15 @@ export const syncConnection = <ThrowOnError extends boolean = false>(options: Op
|
|
|
1047
724
|
*
|
|
1048
725
|
* Use the optional `capability` filter to find agents with specific capabilities.
|
|
1049
726
|
*/
|
|
1050
|
-
export const listAgents = <ThrowOnError extends boolean = false>(options: Options<ListAgentsData, ThrowOnError>) => {
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
type: 'apiKey'
|
|
1056
|
-
},
|
|
1057
|
-
{
|
|
1058
|
-
scheme: 'bearer',
|
|
1059
|
-
type: 'http'
|
|
1060
|
-
}
|
|
1061
|
-
],
|
|
1062
|
-
url: '/v1/graphs/{graph_id}/agent',
|
|
1063
|
-
...options
|
|
1064
|
-
});
|
|
1065
|
-
};
|
|
727
|
+
export const listAgents = <ThrowOnError extends boolean = false>(options: Options<ListAgentsData, ThrowOnError>) => (options.client ?? client).get<ListAgentsResponses, ListAgentsErrors, ThrowOnError>({
|
|
728
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
729
|
+
url: '/v1/graphs/{graph_id}/agent',
|
|
730
|
+
...options
|
|
731
|
+
});
|
|
1066
732
|
|
|
1067
733
|
/**
|
|
1068
734
|
* Auto-select agent for query
|
|
735
|
+
*
|
|
1069
736
|
* Automatically select the best agent for your query with intelligent execution strategy.
|
|
1070
737
|
*
|
|
1071
738
|
* **Agent Selection Process:**
|
|
@@ -1125,29 +792,19 @@ export const listAgents = <ThrowOnError extends boolean = false>(options: Option
|
|
|
1125
792
|
*
|
|
1126
793
|
* See request/response examples in the "Examples" dropdown below.
|
|
1127
794
|
*/
|
|
1128
|
-
export const autoSelectAgent = <ThrowOnError extends boolean = false>(options: Options<AutoSelectAgentData, ThrowOnError>) => {
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
type: 'http'
|
|
1138
|
-
}
|
|
1139
|
-
],
|
|
1140
|
-
url: '/v1/graphs/{graph_id}/agent',
|
|
1141
|
-
...options,
|
|
1142
|
-
headers: {
|
|
1143
|
-
'Content-Type': 'application/json',
|
|
1144
|
-
...options.headers
|
|
1145
|
-
}
|
|
1146
|
-
});
|
|
1147
|
-
};
|
|
795
|
+
export const autoSelectAgent = <ThrowOnError extends boolean = false>(options: Options<AutoSelectAgentData, ThrowOnError>) => (options.client ?? client).post<AutoSelectAgentResponses, AutoSelectAgentErrors, ThrowOnError>({
|
|
796
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
797
|
+
url: '/v1/graphs/{graph_id}/agent',
|
|
798
|
+
...options,
|
|
799
|
+
headers: {
|
|
800
|
+
'Content-Type': 'application/json',
|
|
801
|
+
...options.headers
|
|
802
|
+
}
|
|
803
|
+
});
|
|
1148
804
|
|
|
1149
805
|
/**
|
|
1150
806
|
* Get agent metadata
|
|
807
|
+
*
|
|
1151
808
|
* Get comprehensive metadata for a specific agent type.
|
|
1152
809
|
*
|
|
1153
810
|
* **Returns:**
|
|
@@ -1160,25 +817,15 @@ export const autoSelectAgent = <ThrowOnError extends boolean = false>(options: O
|
|
|
1160
817
|
*
|
|
1161
818
|
* Use this to understand agent capabilities before execution.
|
|
1162
819
|
*/
|
|
1163
|
-
export const getAgentMetadata = <ThrowOnError extends boolean = false>(options: Options<GetAgentMetadataData, ThrowOnError>) => {
|
|
1164
|
-
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
type: 'apiKey'
|
|
1169
|
-
},
|
|
1170
|
-
{
|
|
1171
|
-
scheme: 'bearer',
|
|
1172
|
-
type: 'http'
|
|
1173
|
-
}
|
|
1174
|
-
],
|
|
1175
|
-
url: '/v1/graphs/{graph_id}/agent/{agent_type}',
|
|
1176
|
-
...options
|
|
1177
|
-
});
|
|
1178
|
-
};
|
|
820
|
+
export const getAgentMetadata = <ThrowOnError extends boolean = false>(options: Options<GetAgentMetadataData, ThrowOnError>) => (options.client ?? client).get<GetAgentMetadataResponses, GetAgentMetadataErrors, ThrowOnError>({
|
|
821
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
822
|
+
url: '/v1/graphs/{graph_id}/agent/{agent_type}',
|
|
823
|
+
...options
|
|
824
|
+
});
|
|
1179
825
|
|
|
1180
826
|
/**
|
|
1181
827
|
* Execute specific agent
|
|
828
|
+
*
|
|
1182
829
|
* Execute a specific agent type directly with intelligent execution strategy.
|
|
1183
830
|
*
|
|
1184
831
|
* Available agents:
|
|
@@ -1196,29 +843,19 @@ export const getAgentMetadata = <ThrowOnError extends boolean = false>(options:
|
|
|
1196
843
|
*
|
|
1197
844
|
* Use this endpoint when you know which agent you want to use.
|
|
1198
845
|
*/
|
|
1199
|
-
export const executeSpecificAgent = <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificAgentData, ThrowOnError>) => {
|
|
1200
|
-
|
|
1201
|
-
|
|
1202
|
-
|
|
1203
|
-
|
|
1204
|
-
|
|
1205
|
-
|
|
1206
|
-
|
|
1207
|
-
|
|
1208
|
-
type: 'http'
|
|
1209
|
-
}
|
|
1210
|
-
],
|
|
1211
|
-
url: '/v1/graphs/{graph_id}/agent/{agent_type}',
|
|
1212
|
-
...options,
|
|
1213
|
-
headers: {
|
|
1214
|
-
'Content-Type': 'application/json',
|
|
1215
|
-
...options.headers
|
|
1216
|
-
}
|
|
1217
|
-
});
|
|
1218
|
-
};
|
|
846
|
+
export const executeSpecificAgent = <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificAgentData, ThrowOnError>) => (options.client ?? client).post<ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, ThrowOnError>({
|
|
847
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
848
|
+
url: '/v1/graphs/{graph_id}/agent/{agent_type}',
|
|
849
|
+
...options,
|
|
850
|
+
headers: {
|
|
851
|
+
'Content-Type': 'application/json',
|
|
852
|
+
...options.headers
|
|
853
|
+
}
|
|
854
|
+
});
|
|
1219
855
|
|
|
1220
856
|
/**
|
|
1221
857
|
* Batch process multiple queries
|
|
858
|
+
*
|
|
1222
859
|
* Process multiple queries either sequentially or in parallel.
|
|
1223
860
|
*
|
|
1224
861
|
* **Features:**
|
|
@@ -1234,29 +871,19 @@ export const executeSpecificAgent = <ThrowOnError extends boolean = false>(optio
|
|
|
1234
871
|
*
|
|
1235
872
|
* Returns individual results for each query with execution metrics.
|
|
1236
873
|
*/
|
|
1237
|
-
export const batchProcessQueries = <ThrowOnError extends boolean = false>(options: Options<BatchProcessQueriesData, ThrowOnError>) => {
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
|
|
1246
|
-
type: 'http'
|
|
1247
|
-
}
|
|
1248
|
-
],
|
|
1249
|
-
url: '/v1/graphs/{graph_id}/agent/batch',
|
|
1250
|
-
...options,
|
|
1251
|
-
headers: {
|
|
1252
|
-
'Content-Type': 'application/json',
|
|
1253
|
-
...options.headers
|
|
1254
|
-
}
|
|
1255
|
-
});
|
|
1256
|
-
};
|
|
874
|
+
export const batchProcessQueries = <ThrowOnError extends boolean = false>(options: Options<BatchProcessQueriesData, ThrowOnError>) => (options.client ?? client).post<BatchProcessQueriesResponses, BatchProcessQueriesErrors, ThrowOnError>({
|
|
875
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
876
|
+
url: '/v1/graphs/{graph_id}/agent/batch',
|
|
877
|
+
...options,
|
|
878
|
+
headers: {
|
|
879
|
+
'Content-Type': 'application/json',
|
|
880
|
+
...options.headers
|
|
881
|
+
}
|
|
882
|
+
});
|
|
1257
883
|
|
|
1258
884
|
/**
|
|
1259
885
|
* Get agent recommendations
|
|
886
|
+
*
|
|
1260
887
|
* Get intelligent agent recommendations for a specific query.
|
|
1261
888
|
*
|
|
1262
889
|
* **How it works:**
|
|
@@ -1272,29 +899,19 @@ export const batchProcessQueries = <ThrowOnError extends boolean = false>(option
|
|
|
1272
899
|
*
|
|
1273
900
|
* Returns top agents ranked by confidence with explanations.
|
|
1274
901
|
*/
|
|
1275
|
-
export const recommendAgent = <ThrowOnError extends boolean = false>(options: Options<RecommendAgentData, ThrowOnError>) => {
|
|
1276
|
-
|
|
1277
|
-
|
|
1278
|
-
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
type: 'http'
|
|
1285
|
-
}
|
|
1286
|
-
],
|
|
1287
|
-
url: '/v1/graphs/{graph_id}/agent/recommend',
|
|
1288
|
-
...options,
|
|
1289
|
-
headers: {
|
|
1290
|
-
'Content-Type': 'application/json',
|
|
1291
|
-
...options.headers
|
|
1292
|
-
}
|
|
1293
|
-
});
|
|
1294
|
-
};
|
|
902
|
+
export const recommendAgent = <ThrowOnError extends boolean = false>(options: Options<RecommendAgentData, ThrowOnError>) => (options.client ?? client).post<RecommendAgentResponses, RecommendAgentErrors, ThrowOnError>({
|
|
903
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
904
|
+
url: '/v1/graphs/{graph_id}/agent/recommend',
|
|
905
|
+
...options,
|
|
906
|
+
headers: {
|
|
907
|
+
'Content-Type': 'application/json',
|
|
908
|
+
...options.headers
|
|
909
|
+
}
|
|
910
|
+
});
|
|
1295
911
|
|
|
1296
912
|
/**
|
|
1297
913
|
* List MCP Tools
|
|
914
|
+
*
|
|
1298
915
|
* Get available Model Context Protocol tools for graph analysis.
|
|
1299
916
|
*
|
|
1300
917
|
* This endpoint returns a comprehensive list of MCP tools optimized for AI agents:
|
|
@@ -1317,25 +934,15 @@ export const recommendAgent = <ThrowOnError extends boolean = false>(options: Op
|
|
|
1317
934
|
* **Note:**
|
|
1318
935
|
* MCP tool listing is included - no credit consumption required.
|
|
1319
936
|
*/
|
|
1320
|
-
export const listMcpTools = <ThrowOnError extends boolean = false>(options: Options<ListMcpToolsData, ThrowOnError>) => {
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
type: 'apiKey'
|
|
1326
|
-
},
|
|
1327
|
-
{
|
|
1328
|
-
scheme: 'bearer',
|
|
1329
|
-
type: 'http'
|
|
1330
|
-
}
|
|
1331
|
-
],
|
|
1332
|
-
url: '/v1/graphs/{graph_id}/mcp/tools',
|
|
1333
|
-
...options
|
|
1334
|
-
});
|
|
1335
|
-
};
|
|
937
|
+
export const listMcpTools = <ThrowOnError extends boolean = false>(options: Options<ListMcpToolsData, ThrowOnError>) => (options.client ?? client).get<ListMcpToolsResponses, ListMcpToolsErrors, ThrowOnError>({
|
|
938
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
939
|
+
url: '/v1/graphs/{graph_id}/mcp/tools',
|
|
940
|
+
...options
|
|
941
|
+
});
|
|
1336
942
|
|
|
1337
943
|
/**
|
|
1338
944
|
* Execute MCP Tool
|
|
945
|
+
*
|
|
1339
946
|
* Execute an MCP tool with intelligent response optimization.
|
|
1340
947
|
*
|
|
1341
948
|
* This endpoint automatically selects the best execution strategy based on:
|
|
@@ -1381,50 +988,30 @@ export const listMcpTools = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
1381
988
|
* Only AI operations that invoke Claude or other LLM APIs consume credits,
|
|
1382
989
|
* which happens at the AI agent layer, not the MCP tool layer.
|
|
1383
990
|
*/
|
|
1384
|
-
export const callMcpTool = <ThrowOnError extends boolean = false>(options: Options<CallMcpToolData, ThrowOnError>) => {
|
|
1385
|
-
|
|
1386
|
-
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
type: 'http'
|
|
1394
|
-
}
|
|
1395
|
-
],
|
|
1396
|
-
url: '/v1/graphs/{graph_id}/mcp/call-tool',
|
|
1397
|
-
...options,
|
|
1398
|
-
headers: {
|
|
1399
|
-
'Content-Type': 'application/json',
|
|
1400
|
-
...options.headers
|
|
1401
|
-
}
|
|
1402
|
-
});
|
|
1403
|
-
};
|
|
991
|
+
export const callMcpTool = <ThrowOnError extends boolean = false>(options: Options<CallMcpToolData, ThrowOnError>) => (options.client ?? client).post<CallMcpToolResponses, CallMcpToolErrors, ThrowOnError>({
|
|
992
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
993
|
+
url: '/v1/graphs/{graph_id}/mcp/call-tool',
|
|
994
|
+
...options,
|
|
995
|
+
headers: {
|
|
996
|
+
'Content-Type': 'application/json',
|
|
997
|
+
...options.headers
|
|
998
|
+
}
|
|
999
|
+
});
|
|
1404
1000
|
|
|
1405
1001
|
/**
|
|
1406
1002
|
* List graph database backups
|
|
1003
|
+
*
|
|
1407
1004
|
* List all backups for the specified graph database
|
|
1408
1005
|
*/
|
|
1409
|
-
export const listBackups = <ThrowOnError extends boolean = false>(options: Options<ListBackupsData, ThrowOnError>) => {
|
|
1410
|
-
|
|
1411
|
-
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
type: 'apiKey'
|
|
1415
|
-
},
|
|
1416
|
-
{
|
|
1417
|
-
scheme: 'bearer',
|
|
1418
|
-
type: 'http'
|
|
1419
|
-
}
|
|
1420
|
-
],
|
|
1421
|
-
url: '/v1/graphs/{graph_id}/backups',
|
|
1422
|
-
...options
|
|
1423
|
-
});
|
|
1424
|
-
};
|
|
1006
|
+
export const listBackups = <ThrowOnError extends boolean = false>(options: Options<ListBackupsData, ThrowOnError>) => (options.client ?? client).get<ListBackupsResponses, ListBackupsErrors, ThrowOnError>({
|
|
1007
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1008
|
+
url: '/v1/graphs/{graph_id}/backups',
|
|
1009
|
+
...options
|
|
1010
|
+
});
|
|
1425
1011
|
|
|
1426
1012
|
/**
|
|
1427
1013
|
* Create Backup
|
|
1014
|
+
*
|
|
1428
1015
|
* Create a backup of the graph database.
|
|
1429
1016
|
*
|
|
1430
1017
|
* Creates a complete backup of the graph database (.lbug file) with:
|
|
@@ -1486,50 +1073,30 @@ export const listBackups = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
1486
1073
|
*
|
|
1487
1074
|
* Returns operation details for SSE monitoring.
|
|
1488
1075
|
*/
|
|
1489
|
-
export const createBackup = <ThrowOnError extends boolean = false>(options: Options<CreateBackupData, ThrowOnError>) => {
|
|
1490
|
-
|
|
1491
|
-
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
|
|
1496
|
-
|
|
1497
|
-
|
|
1498
|
-
type: 'http'
|
|
1499
|
-
}
|
|
1500
|
-
],
|
|
1501
|
-
url: '/v1/graphs/{graph_id}/backups',
|
|
1502
|
-
...options,
|
|
1503
|
-
headers: {
|
|
1504
|
-
'Content-Type': 'application/json',
|
|
1505
|
-
...options.headers
|
|
1506
|
-
}
|
|
1507
|
-
});
|
|
1508
|
-
};
|
|
1076
|
+
export const createBackup = <ThrowOnError extends boolean = false>(options: Options<CreateBackupData, ThrowOnError>) => (options.client ?? client).post<CreateBackupResponses, CreateBackupErrors, ThrowOnError>({
|
|
1077
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1078
|
+
url: '/v1/graphs/{graph_id}/backups',
|
|
1079
|
+
...options,
|
|
1080
|
+
headers: {
|
|
1081
|
+
'Content-Type': 'application/json',
|
|
1082
|
+
...options.headers
|
|
1083
|
+
}
|
|
1084
|
+
});
|
|
1509
1085
|
|
|
1510
1086
|
/**
|
|
1511
1087
|
* Get temporary download URL for backup
|
|
1088
|
+
*
|
|
1512
1089
|
* Generate a temporary download URL for a backup (unencrypted, compressed .lbug files only)
|
|
1513
1090
|
*/
|
|
1514
|
-
export const getBackupDownloadUrl = <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) => {
|
|
1515
|
-
|
|
1516
|
-
|
|
1517
|
-
|
|
1518
|
-
|
|
1519
|
-
type: 'apiKey'
|
|
1520
|
-
},
|
|
1521
|
-
{
|
|
1522
|
-
scheme: 'bearer',
|
|
1523
|
-
type: 'http'
|
|
1524
|
-
}
|
|
1525
|
-
],
|
|
1526
|
-
url: '/v1/graphs/{graph_id}/backups/{backup_id}/download',
|
|
1527
|
-
...options
|
|
1528
|
-
});
|
|
1529
|
-
};
|
|
1091
|
+
export const getBackupDownloadUrl = <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) => (options.client ?? client).get<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError>({
|
|
1092
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1093
|
+
url: '/v1/graphs/{graph_id}/backups/{backup_id}/download',
|
|
1094
|
+
...options
|
|
1095
|
+
});
|
|
1530
1096
|
|
|
1531
1097
|
/**
|
|
1532
1098
|
* Restore Encrypted Backup
|
|
1099
|
+
*
|
|
1533
1100
|
* Restore a graph database from an encrypted backup.
|
|
1534
1101
|
*
|
|
1535
1102
|
* Restores a complete graph database from an encrypted backup:
|
|
@@ -1596,50 +1163,30 @@ export const getBackupDownloadUrl = <ThrowOnError extends boolean = false>(optio
|
|
|
1596
1163
|
*
|
|
1597
1164
|
* Returns operation details for SSE monitoring.
|
|
1598
1165
|
*/
|
|
1599
|
-
export const restoreBackup = <ThrowOnError extends boolean = false>(options: Options<RestoreBackupData, ThrowOnError>) => {
|
|
1600
|
-
|
|
1601
|
-
|
|
1602
|
-
|
|
1603
|
-
|
|
1604
|
-
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
type: 'http'
|
|
1609
|
-
}
|
|
1610
|
-
],
|
|
1611
|
-
url: '/v1/graphs/{graph_id}/backups/{backup_id}/restore',
|
|
1612
|
-
...options,
|
|
1613
|
-
headers: {
|
|
1614
|
-
'Content-Type': 'application/json',
|
|
1615
|
-
...options.headers
|
|
1616
|
-
}
|
|
1617
|
-
});
|
|
1618
|
-
};
|
|
1166
|
+
export const restoreBackup = <ThrowOnError extends boolean = false>(options: Options<RestoreBackupData, ThrowOnError>) => (options.client ?? client).post<RestoreBackupResponses, RestoreBackupErrors, ThrowOnError>({
|
|
1167
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1168
|
+
url: '/v1/graphs/{graph_id}/backups/{backup_id}/restore',
|
|
1169
|
+
...options,
|
|
1170
|
+
headers: {
|
|
1171
|
+
'Content-Type': 'application/json',
|
|
1172
|
+
...options.headers
|
|
1173
|
+
}
|
|
1174
|
+
});
|
|
1619
1175
|
|
|
1620
1176
|
/**
|
|
1621
1177
|
* Get backup statistics
|
|
1178
|
+
*
|
|
1622
1179
|
* Get comprehensive backup statistics for the specified graph database
|
|
1623
1180
|
*/
|
|
1624
|
-
export const getBackupStats = <ThrowOnError extends boolean = false>(options: Options<GetBackupStatsData, ThrowOnError>) => {
|
|
1625
|
-
|
|
1626
|
-
|
|
1627
|
-
|
|
1628
|
-
|
|
1629
|
-
type: 'apiKey'
|
|
1630
|
-
},
|
|
1631
|
-
{
|
|
1632
|
-
scheme: 'bearer',
|
|
1633
|
-
type: 'http'
|
|
1634
|
-
}
|
|
1635
|
-
],
|
|
1636
|
-
url: '/v1/graphs/{graph_id}/backups/stats',
|
|
1637
|
-
...options
|
|
1638
|
-
});
|
|
1639
|
-
};
|
|
1181
|
+
export const getBackupStats = <ThrowOnError extends boolean = false>(options: Options<GetBackupStatsData, ThrowOnError>) => (options.client ?? client).get<GetBackupStatsResponses, GetBackupStatsErrors, ThrowOnError>({
|
|
1182
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1183
|
+
url: '/v1/graphs/{graph_id}/backups/stats',
|
|
1184
|
+
...options
|
|
1185
|
+
});
|
|
1640
1186
|
|
|
1641
1187
|
/**
|
|
1642
1188
|
* Get Graph Metrics
|
|
1189
|
+
*
|
|
1643
1190
|
* Get comprehensive metrics for the graph database.
|
|
1644
1191
|
*
|
|
1645
1192
|
* Provides detailed analytics including:
|
|
@@ -1658,25 +1205,15 @@ export const getBackupStats = <ThrowOnError extends boolean = false>(options: Op
|
|
|
1658
1205
|
* Note:
|
|
1659
1206
|
* This operation is included - no credit consumption required.
|
|
1660
1207
|
*/
|
|
1661
|
-
export const getGraphMetrics = <ThrowOnError extends boolean = false>(options: Options<GetGraphMetricsData, ThrowOnError>) => {
|
|
1662
|
-
|
|
1663
|
-
|
|
1664
|
-
|
|
1665
|
-
|
|
1666
|
-
type: 'apiKey'
|
|
1667
|
-
},
|
|
1668
|
-
{
|
|
1669
|
-
scheme: 'bearer',
|
|
1670
|
-
type: 'http'
|
|
1671
|
-
}
|
|
1672
|
-
],
|
|
1673
|
-
url: '/v1/graphs/{graph_id}/analytics',
|
|
1674
|
-
...options
|
|
1675
|
-
});
|
|
1676
|
-
};
|
|
1208
|
+
export const getGraphMetrics = <ThrowOnError extends boolean = false>(options: Options<GetGraphMetricsData, ThrowOnError>) => (options.client ?? client).get<GetGraphMetricsResponses, GetGraphMetricsErrors, ThrowOnError>({
|
|
1209
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1210
|
+
url: '/v1/graphs/{graph_id}/analytics',
|
|
1211
|
+
...options
|
|
1212
|
+
});
|
|
1677
1213
|
|
|
1678
1214
|
/**
|
|
1679
1215
|
* Get Graph Usage Analytics
|
|
1216
|
+
*
|
|
1680
1217
|
* Get comprehensive usage analytics tracked by the GraphUsage model.
|
|
1681
1218
|
*
|
|
1682
1219
|
* Provides temporal usage patterns including:
|
|
@@ -1707,25 +1244,15 @@ export const getGraphMetrics = <ThrowOnError extends boolean = false>(options: O
|
|
|
1707
1244
|
* Note:
|
|
1708
1245
|
* This operation is included - no credit consumption required.
|
|
1709
1246
|
*/
|
|
1710
|
-
export const getGraphUsageAnalytics = <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageAnalyticsData, ThrowOnError>) => {
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
|
|
1714
|
-
|
|
1715
|
-
type: 'apiKey'
|
|
1716
|
-
},
|
|
1717
|
-
{
|
|
1718
|
-
scheme: 'bearer',
|
|
1719
|
-
type: 'http'
|
|
1720
|
-
}
|
|
1721
|
-
],
|
|
1722
|
-
url: '/v1/graphs/{graph_id}/analytics/usage',
|
|
1723
|
-
...options
|
|
1724
|
-
});
|
|
1725
|
-
};
|
|
1247
|
+
export const getGraphUsageAnalytics = <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageAnalyticsData, ThrowOnError>) => (options.client ?? client).get<GetGraphUsageAnalyticsResponses, GetGraphUsageAnalyticsErrors, ThrowOnError>({
|
|
1248
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1249
|
+
url: '/v1/graphs/{graph_id}/analytics/usage',
|
|
1250
|
+
...options
|
|
1251
|
+
});
|
|
1726
1252
|
|
|
1727
1253
|
/**
|
|
1728
1254
|
* Execute Cypher Query
|
|
1255
|
+
*
|
|
1729
1256
|
* Execute a Cypher query with intelligent response optimization.
|
|
1730
1257
|
*
|
|
1731
1258
|
* **IMPORTANT: Write operations depend on graph type:**
|
|
@@ -1795,29 +1322,19 @@ export const getGraphUsageAnalytics = <ThrowOnError extends boolean = false>(opt
|
|
|
1795
1322
|
* Query operations are included - no credit consumption required.
|
|
1796
1323
|
* Queue position is based on subscription tier for priority.
|
|
1797
1324
|
*/
|
|
1798
|
-
export const executeCypherQuery = <ThrowOnError extends boolean = false>(options: Options<ExecuteCypherQueryData, ThrowOnError>) => {
|
|
1799
|
-
|
|
1800
|
-
|
|
1801
|
-
|
|
1802
|
-
|
|
1803
|
-
|
|
1804
|
-
|
|
1805
|
-
|
|
1806
|
-
|
|
1807
|
-
type: 'http'
|
|
1808
|
-
}
|
|
1809
|
-
],
|
|
1810
|
-
url: '/v1/graphs/{graph_id}/query',
|
|
1811
|
-
...options,
|
|
1812
|
-
headers: {
|
|
1813
|
-
'Content-Type': 'application/json',
|
|
1814
|
-
...options.headers
|
|
1815
|
-
}
|
|
1816
|
-
});
|
|
1817
|
-
};
|
|
1325
|
+
export const executeCypherQuery = <ThrowOnError extends boolean = false>(options: Options<ExecuteCypherQueryData, ThrowOnError>) => (options.client ?? client).post<ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, ThrowOnError>({
|
|
1326
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1327
|
+
url: '/v1/graphs/{graph_id}/query',
|
|
1328
|
+
...options,
|
|
1329
|
+
headers: {
|
|
1330
|
+
'Content-Type': 'application/json',
|
|
1331
|
+
...options.headers
|
|
1332
|
+
}
|
|
1333
|
+
});
|
|
1818
1334
|
|
|
1819
1335
|
/**
|
|
1820
1336
|
* Get Runtime Graph Schema
|
|
1337
|
+
*
|
|
1821
1338
|
* Get runtime schema information for the specified graph database.
|
|
1822
1339
|
*
|
|
1823
1340
|
* ## What This Returns
|
|
@@ -1863,25 +1380,15 @@ export const executeCypherQuery = <ThrowOnError extends boolean = false>(options
|
|
|
1863
1380
|
*
|
|
1864
1381
|
* This operation is included - no credit consumption required.
|
|
1865
1382
|
*/
|
|
1866
|
-
export const getGraphSchema = <ThrowOnError extends boolean = false>(options: Options<GetGraphSchemaData, ThrowOnError>) => {
|
|
1867
|
-
|
|
1868
|
-
|
|
1869
|
-
|
|
1870
|
-
|
|
1871
|
-
type: 'apiKey'
|
|
1872
|
-
},
|
|
1873
|
-
{
|
|
1874
|
-
scheme: 'bearer',
|
|
1875
|
-
type: 'http'
|
|
1876
|
-
}
|
|
1877
|
-
],
|
|
1878
|
-
url: '/v1/graphs/{graph_id}/schema',
|
|
1879
|
-
...options
|
|
1880
|
-
});
|
|
1881
|
-
};
|
|
1383
|
+
export const getGraphSchema = <ThrowOnError extends boolean = false>(options: Options<GetGraphSchemaData, ThrowOnError>) => (options.client ?? client).get<GetGraphSchemaResponses, GetGraphSchemaErrors, ThrowOnError>({
|
|
1384
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1385
|
+
url: '/v1/graphs/{graph_id}/schema',
|
|
1386
|
+
...options
|
|
1387
|
+
});
|
|
1882
1388
|
|
|
1883
1389
|
/**
|
|
1884
1390
|
* Export Declared Graph Schema
|
|
1391
|
+
*
|
|
1885
1392
|
* Export the declared schema definition of an existing graph.
|
|
1886
1393
|
*
|
|
1887
1394
|
* ## What This Returns
|
|
@@ -1930,25 +1437,15 @@ export const getGraphSchema = <ThrowOnError extends boolean = false>(options: Op
|
|
|
1930
1437
|
*
|
|
1931
1438
|
* This operation is included - no credit consumption required.
|
|
1932
1439
|
*/
|
|
1933
|
-
export const exportGraphSchema = <ThrowOnError extends boolean = false>(options: Options<ExportGraphSchemaData, ThrowOnError>) => {
|
|
1934
|
-
|
|
1935
|
-
|
|
1936
|
-
|
|
1937
|
-
|
|
1938
|
-
type: 'apiKey'
|
|
1939
|
-
},
|
|
1940
|
-
{
|
|
1941
|
-
scheme: 'bearer',
|
|
1942
|
-
type: 'http'
|
|
1943
|
-
}
|
|
1944
|
-
],
|
|
1945
|
-
url: '/v1/graphs/{graph_id}/schema/export',
|
|
1946
|
-
...options
|
|
1947
|
-
});
|
|
1948
|
-
};
|
|
1440
|
+
export const exportGraphSchema = <ThrowOnError extends boolean = false>(options: Options<ExportGraphSchemaData, ThrowOnError>) => (options.client ?? client).get<ExportGraphSchemaResponses, ExportGraphSchemaErrors, ThrowOnError>({
|
|
1441
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1442
|
+
url: '/v1/graphs/{graph_id}/schema/export',
|
|
1443
|
+
...options
|
|
1444
|
+
});
|
|
1949
1445
|
|
|
1950
1446
|
/**
|
|
1951
1447
|
* Validate Schema
|
|
1448
|
+
*
|
|
1952
1449
|
* Validate a custom schema definition before deployment.
|
|
1953
1450
|
*
|
|
1954
1451
|
* This endpoint performs comprehensive validation including:
|
|
@@ -1979,29 +1476,19 @@ export const exportGraphSchema = <ThrowOnError extends boolean = false>(options:
|
|
|
1979
1476
|
*
|
|
1980
1477
|
* This operation is included - no credit consumption required.
|
|
1981
1478
|
*/
|
|
1982
|
-
export const validateSchema = <ThrowOnError extends boolean = false>(options: Options<ValidateSchemaData, ThrowOnError>) => {
|
|
1983
|
-
|
|
1984
|
-
|
|
1985
|
-
|
|
1986
|
-
|
|
1987
|
-
|
|
1988
|
-
|
|
1989
|
-
|
|
1990
|
-
|
|
1991
|
-
type: 'http'
|
|
1992
|
-
}
|
|
1993
|
-
],
|
|
1994
|
-
url: '/v1/graphs/{graph_id}/schema/validate',
|
|
1995
|
-
...options,
|
|
1996
|
-
headers: {
|
|
1997
|
-
'Content-Type': 'application/json',
|
|
1998
|
-
...options.headers
|
|
1999
|
-
}
|
|
2000
|
-
});
|
|
2001
|
-
};
|
|
1479
|
+
export const validateSchema = <ThrowOnError extends boolean = false>(options: Options<ValidateSchemaData, ThrowOnError>) => (options.client ?? client).post<ValidateSchemaResponses, ValidateSchemaErrors, ThrowOnError>({
|
|
1480
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1481
|
+
url: '/v1/graphs/{graph_id}/schema/validate',
|
|
1482
|
+
...options,
|
|
1483
|
+
headers: {
|
|
1484
|
+
'Content-Type': 'application/json',
|
|
1485
|
+
...options.headers
|
|
1486
|
+
}
|
|
1487
|
+
});
|
|
2002
1488
|
|
|
2003
1489
|
/**
|
|
2004
1490
|
* Get Credit Summary
|
|
1491
|
+
*
|
|
2005
1492
|
* Retrieve comprehensive credit usage summary for the specified graph.
|
|
2006
1493
|
*
|
|
2007
1494
|
* This endpoint provides:
|
|
@@ -2012,25 +1499,15 @@ export const validateSchema = <ThrowOnError extends boolean = false>(options: Op
|
|
|
2012
1499
|
*
|
|
2013
1500
|
* No credits are consumed for checking credit status.
|
|
2014
1501
|
*/
|
|
2015
|
-
export const getCreditSummary = <ThrowOnError extends boolean = false>(options: Options<GetCreditSummaryData, ThrowOnError>) => {
|
|
2016
|
-
|
|
2017
|
-
|
|
2018
|
-
|
|
2019
|
-
|
|
2020
|
-
type: 'apiKey'
|
|
2021
|
-
},
|
|
2022
|
-
{
|
|
2023
|
-
scheme: 'bearer',
|
|
2024
|
-
type: 'http'
|
|
2025
|
-
}
|
|
2026
|
-
],
|
|
2027
|
-
url: '/v1/graphs/{graph_id}/credits/summary',
|
|
2028
|
-
...options
|
|
2029
|
-
});
|
|
2030
|
-
};
|
|
1502
|
+
export const getCreditSummary = <ThrowOnError extends boolean = false>(options: Options<GetCreditSummaryData, ThrowOnError>) => (options.client ?? client).get<GetCreditSummaryResponses, GetCreditSummaryErrors, ThrowOnError>({
|
|
1503
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1504
|
+
url: '/v1/graphs/{graph_id}/credits/summary',
|
|
1505
|
+
...options
|
|
1506
|
+
});
|
|
2031
1507
|
|
|
2032
1508
|
/**
|
|
2033
1509
|
* List Credit Transactions
|
|
1510
|
+
*
|
|
2034
1511
|
* Retrieve detailed credit transaction history for the specified graph.
|
|
2035
1512
|
*
|
|
2036
1513
|
* This enhanced endpoint provides:
|
|
@@ -2047,25 +1524,15 @@ export const getCreditSummary = <ThrowOnError extends boolean = false>(options:
|
|
|
2047
1524
|
*
|
|
2048
1525
|
* No credits are consumed for viewing transaction history.
|
|
2049
1526
|
*/
|
|
2050
|
-
export const listCreditTransactions = <ThrowOnError extends boolean = false>(options: Options<ListCreditTransactionsData, ThrowOnError>) => {
|
|
2051
|
-
|
|
2052
|
-
|
|
2053
|
-
|
|
2054
|
-
|
|
2055
|
-
type: 'apiKey'
|
|
2056
|
-
},
|
|
2057
|
-
{
|
|
2058
|
-
scheme: 'bearer',
|
|
2059
|
-
type: 'http'
|
|
2060
|
-
}
|
|
2061
|
-
],
|
|
2062
|
-
url: '/v1/graphs/{graph_id}/credits/transactions',
|
|
2063
|
-
...options
|
|
2064
|
-
});
|
|
2065
|
-
};
|
|
1527
|
+
export const listCreditTransactions = <ThrowOnError extends boolean = false>(options: Options<ListCreditTransactionsData, ThrowOnError>) => (options.client ?? client).get<ListCreditTransactionsResponses, ListCreditTransactionsErrors, ThrowOnError>({
|
|
1528
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1529
|
+
url: '/v1/graphs/{graph_id}/credits/transactions',
|
|
1530
|
+
...options
|
|
1531
|
+
});
|
|
2066
1532
|
|
|
2067
1533
|
/**
|
|
2068
1534
|
* Check Credit Balance
|
|
1535
|
+
*
|
|
2069
1536
|
* Check if the graph has sufficient credits for a planned operation.
|
|
2070
1537
|
*
|
|
2071
1538
|
* This endpoint allows you to verify credit availability before performing
|
|
@@ -2078,25 +1545,15 @@ export const listCreditTransactions = <ThrowOnError extends boolean = false>(opt
|
|
|
2078
1545
|
*
|
|
2079
1546
|
* No credits are consumed for checking availability.
|
|
2080
1547
|
*/
|
|
2081
|
-
export const checkCreditBalance = <ThrowOnError extends boolean = false>(options: Options<CheckCreditBalanceData, ThrowOnError>) => {
|
|
2082
|
-
|
|
2083
|
-
|
|
2084
|
-
|
|
2085
|
-
|
|
2086
|
-
type: 'apiKey'
|
|
2087
|
-
},
|
|
2088
|
-
{
|
|
2089
|
-
scheme: 'bearer',
|
|
2090
|
-
type: 'http'
|
|
2091
|
-
}
|
|
2092
|
-
],
|
|
2093
|
-
url: '/v1/graphs/{graph_id}/credits/balance/check',
|
|
2094
|
-
...options
|
|
2095
|
-
});
|
|
2096
|
-
};
|
|
1548
|
+
export const checkCreditBalance = <ThrowOnError extends boolean = false>(options: Options<CheckCreditBalanceData, ThrowOnError>) => (options.client ?? client).get<CheckCreditBalanceResponses, CheckCreditBalanceErrors, ThrowOnError>({
|
|
1549
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1550
|
+
url: '/v1/graphs/{graph_id}/credits/balance/check',
|
|
1551
|
+
...options
|
|
1552
|
+
});
|
|
2097
1553
|
|
|
2098
1554
|
/**
|
|
2099
1555
|
* Get Storage Usage
|
|
1556
|
+
*
|
|
2100
1557
|
* Get storage usage history for a graph.
|
|
2101
1558
|
*
|
|
2102
1559
|
* Returns detailed storage usage information including:
|
|
@@ -2108,25 +1565,15 @@ export const checkCreditBalance = <ThrowOnError extends boolean = false>(options
|
|
|
2108
1565
|
* This endpoint helps users understand their storage patterns
|
|
2109
1566
|
* and associated credit costs.
|
|
2110
1567
|
*/
|
|
2111
|
-
export const getStorageUsage = <ThrowOnError extends boolean = false>(options: Options<GetStorageUsageData, ThrowOnError>) => {
|
|
2112
|
-
|
|
2113
|
-
|
|
2114
|
-
|
|
2115
|
-
|
|
2116
|
-
type: 'apiKey'
|
|
2117
|
-
},
|
|
2118
|
-
{
|
|
2119
|
-
scheme: 'bearer',
|
|
2120
|
-
type: 'http'
|
|
2121
|
-
}
|
|
2122
|
-
],
|
|
2123
|
-
url: '/v1/graphs/{graph_id}/credits/storage/usage',
|
|
2124
|
-
...options
|
|
2125
|
-
});
|
|
2126
|
-
};
|
|
1568
|
+
export const getStorageUsage = <ThrowOnError extends boolean = false>(options: Options<GetStorageUsageData, ThrowOnError>) => (options.client ?? client).get<GetStorageUsageResponses, GetStorageUsageErrors, ThrowOnError>({
|
|
1569
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1570
|
+
url: '/v1/graphs/{graph_id}/credits/storage/usage',
|
|
1571
|
+
...options
|
|
1572
|
+
});
|
|
2127
1573
|
|
|
2128
1574
|
/**
|
|
2129
1575
|
* Check Storage Limits
|
|
1576
|
+
*
|
|
2130
1577
|
* Check storage limits and usage for a graph.
|
|
2131
1578
|
*
|
|
2132
1579
|
* Returns comprehensive storage limit information including:
|
|
@@ -2138,25 +1585,15 @@ export const getStorageUsage = <ThrowOnError extends boolean = false>(options: O
|
|
|
2138
1585
|
* This endpoint helps users monitor storage usage and plan for potential
|
|
2139
1586
|
* limit increases. No credits are consumed for checking storage limits.
|
|
2140
1587
|
*/
|
|
2141
|
-
export const checkStorageLimits = <ThrowOnError extends boolean = false>(options: Options<CheckStorageLimitsData, ThrowOnError>) => {
|
|
2142
|
-
|
|
2143
|
-
|
|
2144
|
-
|
|
2145
|
-
|
|
2146
|
-
type: 'apiKey'
|
|
2147
|
-
},
|
|
2148
|
-
{
|
|
2149
|
-
scheme: 'bearer',
|
|
2150
|
-
type: 'http'
|
|
2151
|
-
}
|
|
2152
|
-
],
|
|
2153
|
-
url: '/v1/graphs/{graph_id}/credits/storage/limits',
|
|
2154
|
-
...options
|
|
2155
|
-
});
|
|
2156
|
-
};
|
|
1588
|
+
export const checkStorageLimits = <ThrowOnError extends boolean = false>(options: Options<CheckStorageLimitsData, ThrowOnError>) => (options.client ?? client).get<CheckStorageLimitsResponses, CheckStorageLimitsErrors, ThrowOnError>({
|
|
1589
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1590
|
+
url: '/v1/graphs/{graph_id}/credits/storage/limits',
|
|
1591
|
+
...options
|
|
1592
|
+
});
|
|
2157
1593
|
|
|
2158
1594
|
/**
|
|
2159
1595
|
* Database Health Check
|
|
1596
|
+
*
|
|
2160
1597
|
* Get comprehensive health information for the graph database.
|
|
2161
1598
|
*
|
|
2162
1599
|
* Returns detailed health metrics including:
|
|
@@ -2182,25 +1619,15 @@ export const checkStorageLimits = <ThrowOnError extends boolean = false>(options
|
|
|
2182
1619
|
*
|
|
2183
1620
|
* This endpoint provides essential monitoring data for operational visibility.
|
|
2184
1621
|
*/
|
|
2185
|
-
export const getDatabaseHealth = <ThrowOnError extends boolean = false>(options: Options<GetDatabaseHealthData, ThrowOnError>) => {
|
|
2186
|
-
|
|
2187
|
-
|
|
2188
|
-
|
|
2189
|
-
|
|
2190
|
-
type: 'apiKey'
|
|
2191
|
-
},
|
|
2192
|
-
{
|
|
2193
|
-
scheme: 'bearer',
|
|
2194
|
-
type: 'http'
|
|
2195
|
-
}
|
|
2196
|
-
],
|
|
2197
|
-
url: '/v1/graphs/{graph_id}/health',
|
|
2198
|
-
...options
|
|
2199
|
-
});
|
|
2200
|
-
};
|
|
1622
|
+
export const getDatabaseHealth = <ThrowOnError extends boolean = false>(options: Options<GetDatabaseHealthData, ThrowOnError>) => (options.client ?? client).get<GetDatabaseHealthResponses, GetDatabaseHealthErrors, ThrowOnError>({
|
|
1623
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1624
|
+
url: '/v1/graphs/{graph_id}/health',
|
|
1625
|
+
...options
|
|
1626
|
+
});
|
|
2201
1627
|
|
|
2202
1628
|
/**
|
|
2203
1629
|
* Database Information
|
|
1630
|
+
*
|
|
2204
1631
|
* Get comprehensive database information and statistics.
|
|
2205
1632
|
*
|
|
2206
1633
|
* Returns detailed database metrics including:
|
|
@@ -2227,25 +1654,15 @@ export const getDatabaseHealth = <ThrowOnError extends boolean = false>(options:
|
|
|
2227
1654
|
*
|
|
2228
1655
|
* This endpoint provides essential database information for capacity planning and monitoring.
|
|
2229
1656
|
*/
|
|
2230
|
-
export const getDatabaseInfo = <ThrowOnError extends boolean = false>(options: Options<GetDatabaseInfoData, ThrowOnError>) => {
|
|
2231
|
-
|
|
2232
|
-
|
|
2233
|
-
|
|
2234
|
-
|
|
2235
|
-
type: 'apiKey'
|
|
2236
|
-
},
|
|
2237
|
-
{
|
|
2238
|
-
scheme: 'bearer',
|
|
2239
|
-
type: 'http'
|
|
2240
|
-
}
|
|
2241
|
-
],
|
|
2242
|
-
url: '/v1/graphs/{graph_id}/info',
|
|
2243
|
-
...options
|
|
2244
|
-
});
|
|
2245
|
-
};
|
|
1657
|
+
export const getDatabaseInfo = <ThrowOnError extends boolean = false>(options: Options<GetDatabaseInfoData, ThrowOnError>) => (options.client ?? client).get<GetDatabaseInfoResponses, GetDatabaseInfoErrors, ThrowOnError>({
|
|
1658
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1659
|
+
url: '/v1/graphs/{graph_id}/info',
|
|
1660
|
+
...options
|
|
1661
|
+
});
|
|
2246
1662
|
|
|
2247
1663
|
/**
|
|
2248
1664
|
* Get Graph Operational Limits
|
|
1665
|
+
*
|
|
2249
1666
|
* Get comprehensive operational limits for the graph database.
|
|
2250
1667
|
*
|
|
2251
1668
|
* Returns all operational limits that apply to this graph including:
|
|
@@ -2260,25 +1677,15 @@ export const getDatabaseInfo = <ThrowOnError extends boolean = false>(options: O
|
|
|
2260
1677
|
*
|
|
2261
1678
|
* **Note**: Limits vary based on subscription tier (ladybug-standard, ladybug-large, ladybug-xlarge).
|
|
2262
1679
|
*/
|
|
2263
|
-
export const getGraphLimits = <ThrowOnError extends boolean = false>(options: Options<GetGraphLimitsData, ThrowOnError>) => {
|
|
2264
|
-
|
|
2265
|
-
|
|
2266
|
-
|
|
2267
|
-
|
|
2268
|
-
type: 'apiKey'
|
|
2269
|
-
},
|
|
2270
|
-
{
|
|
2271
|
-
scheme: 'bearer',
|
|
2272
|
-
type: 'http'
|
|
2273
|
-
}
|
|
2274
|
-
],
|
|
2275
|
-
url: '/v1/graphs/{graph_id}/limits',
|
|
2276
|
-
...options
|
|
2277
|
-
});
|
|
2278
|
-
};
|
|
1680
|
+
export const getGraphLimits = <ThrowOnError extends boolean = false>(options: Options<GetGraphLimitsData, ThrowOnError>) => (options.client ?? client).get<GetGraphLimitsResponses, GetGraphLimitsErrors, ThrowOnError>({
|
|
1681
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1682
|
+
url: '/v1/graphs/{graph_id}/limits',
|
|
1683
|
+
...options
|
|
1684
|
+
});
|
|
2279
1685
|
|
|
2280
1686
|
/**
|
|
2281
1687
|
* List Subgraphs
|
|
1688
|
+
*
|
|
2282
1689
|
* List all subgraphs for a parent graph.
|
|
2283
1690
|
*
|
|
2284
1691
|
* **Requirements:**
|
|
@@ -2290,25 +1697,15 @@ export const getGraphLimits = <ThrowOnError extends boolean = false>(options: Op
|
|
|
2290
1697
|
* - List of all subgraphs for the parent graph
|
|
2291
1698
|
* - Each subgraph includes its ID, name, description, type, status, and creation date
|
|
2292
1699
|
*/
|
|
2293
|
-
export const listSubgraphs = <ThrowOnError extends boolean = false>(options: Options<ListSubgraphsData, ThrowOnError>) => {
|
|
2294
|
-
|
|
2295
|
-
|
|
2296
|
-
|
|
2297
|
-
|
|
2298
|
-
type: 'apiKey'
|
|
2299
|
-
},
|
|
2300
|
-
{
|
|
2301
|
-
scheme: 'bearer',
|
|
2302
|
-
type: 'http'
|
|
2303
|
-
}
|
|
2304
|
-
],
|
|
2305
|
-
url: '/v1/graphs/{graph_id}/subgraphs',
|
|
2306
|
-
...options
|
|
2307
|
-
});
|
|
2308
|
-
};
|
|
1700
|
+
export const listSubgraphs = <ThrowOnError extends boolean = false>(options: Options<ListSubgraphsData, ThrowOnError>) => (options.client ?? client).get<ListSubgraphsResponses, ListSubgraphsErrors, ThrowOnError>({
|
|
1701
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1702
|
+
url: '/v1/graphs/{graph_id}/subgraphs',
|
|
1703
|
+
...options
|
|
1704
|
+
});
|
|
2309
1705
|
|
|
2310
1706
|
/**
|
|
2311
1707
|
* Create Subgraph
|
|
1708
|
+
*
|
|
2312
1709
|
* Create a new subgraph within a parent graph, with optional data forking.
|
|
2313
1710
|
*
|
|
2314
1711
|
* **Requirements:**
|
|
@@ -2337,29 +1734,19 @@ export const listSubgraphs = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
2337
1734
|
* - Subgraph ID can be used in all standard `/v1/graphs/{graph_id}*` endpoints
|
|
2338
1735
|
* - Permissions inherited from parent graph
|
|
2339
1736
|
*/
|
|
2340
|
-
export const createSubgraph = <ThrowOnError extends boolean = false>(options: Options<CreateSubgraphData, ThrowOnError>) => {
|
|
2341
|
-
|
|
2342
|
-
|
|
2343
|
-
|
|
2344
|
-
|
|
2345
|
-
|
|
2346
|
-
|
|
2347
|
-
|
|
2348
|
-
|
|
2349
|
-
type: 'http'
|
|
2350
|
-
}
|
|
2351
|
-
],
|
|
2352
|
-
url: '/v1/graphs/{graph_id}/subgraphs',
|
|
2353
|
-
...options,
|
|
2354
|
-
headers: {
|
|
2355
|
-
'Content-Type': 'application/json',
|
|
2356
|
-
...options.headers
|
|
2357
|
-
}
|
|
2358
|
-
});
|
|
2359
|
-
};
|
|
1737
|
+
export const createSubgraph = <ThrowOnError extends boolean = false>(options: Options<CreateSubgraphData, ThrowOnError>) => (options.client ?? client).post<CreateSubgraphResponses, CreateSubgraphErrors, ThrowOnError>({
|
|
1738
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1739
|
+
url: '/v1/graphs/{graph_id}/subgraphs',
|
|
1740
|
+
...options,
|
|
1741
|
+
headers: {
|
|
1742
|
+
'Content-Type': 'application/json',
|
|
1743
|
+
...options.headers
|
|
1744
|
+
}
|
|
1745
|
+
});
|
|
2360
1746
|
|
|
2361
1747
|
/**
|
|
2362
1748
|
* Delete Subgraph
|
|
1749
|
+
*
|
|
2363
1750
|
* Delete a subgraph database.
|
|
2364
1751
|
*
|
|
2365
1752
|
* **Requirements:**
|
|
@@ -2385,29 +1772,19 @@ export const createSubgraph = <ThrowOnError extends boolean = false>(options: Op
|
|
|
2385
1772
|
* - Deletion does not affect parent graph's credit pool or permissions
|
|
2386
1773
|
* - Backup creation consumes credits from parent graph's allocation
|
|
2387
1774
|
*/
|
|
2388
|
-
export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Options<DeleteSubgraphData, ThrowOnError>) => {
|
|
2389
|
-
|
|
2390
|
-
|
|
2391
|
-
|
|
2392
|
-
|
|
2393
|
-
|
|
2394
|
-
|
|
2395
|
-
|
|
2396
|
-
|
|
2397
|
-
type: 'http'
|
|
2398
|
-
}
|
|
2399
|
-
],
|
|
2400
|
-
url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}',
|
|
2401
|
-
...options,
|
|
2402
|
-
headers: {
|
|
2403
|
-
'Content-Type': 'application/json',
|
|
2404
|
-
...options.headers
|
|
2405
|
-
}
|
|
2406
|
-
});
|
|
2407
|
-
};
|
|
1775
|
+
export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Options<DeleteSubgraphData, ThrowOnError>) => (options.client ?? client).delete<DeleteSubgraphResponses, DeleteSubgraphErrors, ThrowOnError>({
|
|
1776
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1777
|
+
url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}',
|
|
1778
|
+
...options,
|
|
1779
|
+
headers: {
|
|
1780
|
+
'Content-Type': 'application/json',
|
|
1781
|
+
...options.headers
|
|
1782
|
+
}
|
|
1783
|
+
});
|
|
2408
1784
|
|
|
2409
1785
|
/**
|
|
2410
1786
|
* Get Subgraph Details
|
|
1787
|
+
*
|
|
2411
1788
|
* Get detailed information about a specific subgraph.
|
|
2412
1789
|
*
|
|
2413
1790
|
* **Requirements:**
|
|
@@ -2433,25 +1810,15 @@ export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Op
|
|
|
2433
1810
|
* Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID.
|
|
2434
1811
|
* The full ID is returned in the response (e.g., 'kg0123456789abcdef_dev').
|
|
2435
1812
|
*/
|
|
2436
|
-
export const getSubgraphInfo = <ThrowOnError extends boolean = false>(options: Options<GetSubgraphInfoData, ThrowOnError>) => {
|
|
2437
|
-
|
|
2438
|
-
|
|
2439
|
-
|
|
2440
|
-
|
|
2441
|
-
type: 'apiKey'
|
|
2442
|
-
},
|
|
2443
|
-
{
|
|
2444
|
-
scheme: 'bearer',
|
|
2445
|
-
type: 'http'
|
|
2446
|
-
}
|
|
2447
|
-
],
|
|
2448
|
-
url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}/info',
|
|
2449
|
-
...options
|
|
2450
|
-
});
|
|
2451
|
-
};
|
|
1813
|
+
export const getSubgraphInfo = <ThrowOnError extends boolean = false>(options: Options<GetSubgraphInfoData, ThrowOnError>) => (options.client ?? client).get<GetSubgraphInfoResponses, GetSubgraphInfoErrors, ThrowOnError>({
|
|
1814
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1815
|
+
url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}/info',
|
|
1816
|
+
...options
|
|
1817
|
+
});
|
|
2452
1818
|
|
|
2453
1819
|
/**
|
|
2454
1820
|
* Get Subgraph Quota
|
|
1821
|
+
*
|
|
2455
1822
|
* Get subgraph quota and usage information for a parent graph.
|
|
2456
1823
|
*
|
|
2457
1824
|
* **Shows:**
|
|
@@ -2470,25 +1837,15 @@ export const getSubgraphInfo = <ThrowOnError extends boolean = false>(options: O
|
|
|
2470
1837
|
* Provides aggregate size metrics when available.
|
|
2471
1838
|
* Individual subgraph sizes shown in list endpoint.
|
|
2472
1839
|
*/
|
|
2473
|
-
export const getSubgraphQuota = <ThrowOnError extends boolean = false>(options: Options<GetSubgraphQuotaData, ThrowOnError>) => {
|
|
2474
|
-
|
|
2475
|
-
|
|
2476
|
-
|
|
2477
|
-
|
|
2478
|
-
type: 'apiKey'
|
|
2479
|
-
},
|
|
2480
|
-
{
|
|
2481
|
-
scheme: 'bearer',
|
|
2482
|
-
type: 'http'
|
|
2483
|
-
}
|
|
2484
|
-
],
|
|
2485
|
-
url: '/v1/graphs/{graph_id}/subgraphs/quota',
|
|
2486
|
-
...options
|
|
2487
|
-
});
|
|
2488
|
-
};
|
|
1840
|
+
export const getSubgraphQuota = <ThrowOnError extends boolean = false>(options: Options<GetSubgraphQuotaData, ThrowOnError>) => (options.client ?? client).get<GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, ThrowOnError>({
|
|
1841
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1842
|
+
url: '/v1/graphs/{graph_id}/subgraphs/quota',
|
|
1843
|
+
...options
|
|
1844
|
+
});
|
|
2489
1845
|
|
|
2490
1846
|
/**
|
|
2491
1847
|
* Get Subscription
|
|
1848
|
+
*
|
|
2492
1849
|
* Get subscription details for a graph or shared repository.
|
|
2493
1850
|
*
|
|
2494
1851
|
* For user graphs (kg*): Returns the graph's subscription (owned by graph creator)
|
|
@@ -2496,25 +1853,15 @@ export const getSubgraphQuota = <ThrowOnError extends boolean = false>(options:
|
|
|
2496
1853
|
*
|
|
2497
1854
|
* This unified endpoint automatically detects the resource type and returns the appropriate subscription.
|
|
2498
1855
|
*/
|
|
2499
|
-
export const getGraphSubscription = <ThrowOnError extends boolean = false>(options: Options<GetGraphSubscriptionData, ThrowOnError>) => {
|
|
2500
|
-
|
|
2501
|
-
|
|
2502
|
-
|
|
2503
|
-
|
|
2504
|
-
type: 'apiKey'
|
|
2505
|
-
},
|
|
2506
|
-
{
|
|
2507
|
-
scheme: 'bearer',
|
|
2508
|
-
type: 'http'
|
|
2509
|
-
}
|
|
2510
|
-
],
|
|
2511
|
-
url: '/v1/graphs/{graph_id}/subscriptions',
|
|
2512
|
-
...options
|
|
2513
|
-
});
|
|
2514
|
-
};
|
|
1856
|
+
export const getGraphSubscription = <ThrowOnError extends boolean = false>(options: Options<GetGraphSubscriptionData, ThrowOnError>) => (options.client ?? client).get<GetGraphSubscriptionResponses, GetGraphSubscriptionErrors, ThrowOnError>({
|
|
1857
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1858
|
+
url: '/v1/graphs/{graph_id}/subscriptions',
|
|
1859
|
+
...options
|
|
1860
|
+
});
|
|
2515
1861
|
|
|
2516
1862
|
/**
|
|
2517
1863
|
* Create Repository Subscription
|
|
1864
|
+
*
|
|
2518
1865
|
* Create a new subscription to a shared repository.
|
|
2519
1866
|
*
|
|
2520
1867
|
* This endpoint is ONLY for shared repositories (sec, industry, economic).
|
|
@@ -2522,57 +1869,37 @@ export const getGraphSubscription = <ThrowOnError extends boolean = false>(optio
|
|
|
2522
1869
|
*
|
|
2523
1870
|
* The subscription will be created in ACTIVE status immediately and credits will be allocated.
|
|
2524
1871
|
*/
|
|
2525
|
-
export const createRepositorySubscription = <ThrowOnError extends boolean = false>(options: Options<CreateRepositorySubscriptionData, ThrowOnError>) => {
|
|
2526
|
-
|
|
2527
|
-
|
|
2528
|
-
|
|
2529
|
-
|
|
2530
|
-
|
|
2531
|
-
|
|
2532
|
-
|
|
2533
|
-
|
|
2534
|
-
type: 'http'
|
|
2535
|
-
}
|
|
2536
|
-
],
|
|
2537
|
-
url: '/v1/graphs/{graph_id}/subscriptions',
|
|
2538
|
-
...options,
|
|
2539
|
-
headers: {
|
|
2540
|
-
'Content-Type': 'application/json',
|
|
2541
|
-
...options.headers
|
|
2542
|
-
}
|
|
2543
|
-
});
|
|
2544
|
-
};
|
|
1872
|
+
export const createRepositorySubscription = <ThrowOnError extends boolean = false>(options: Options<CreateRepositorySubscriptionData, ThrowOnError>) => (options.client ?? client).post<CreateRepositorySubscriptionResponses, CreateRepositorySubscriptionErrors, ThrowOnError>({
|
|
1873
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1874
|
+
url: '/v1/graphs/{graph_id}/subscriptions',
|
|
1875
|
+
...options,
|
|
1876
|
+
headers: {
|
|
1877
|
+
'Content-Type': 'application/json',
|
|
1878
|
+
...options.headers
|
|
1879
|
+
}
|
|
1880
|
+
});
|
|
2545
1881
|
|
|
2546
1882
|
/**
|
|
2547
1883
|
* Upgrade Subscription
|
|
1884
|
+
*
|
|
2548
1885
|
* Upgrade a subscription to a different plan.
|
|
2549
1886
|
*
|
|
2550
1887
|
* Works for both user graphs and shared repositories.
|
|
2551
1888
|
* The subscription will be immediately updated to the new plan and pricing.
|
|
2552
1889
|
*/
|
|
2553
|
-
export const upgradeSubscription = <ThrowOnError extends boolean = false>(options: Options<UpgradeSubscriptionData, ThrowOnError>) => {
|
|
2554
|
-
|
|
2555
|
-
|
|
2556
|
-
|
|
2557
|
-
|
|
2558
|
-
|
|
2559
|
-
|
|
2560
|
-
|
|
2561
|
-
|
|
2562
|
-
type: 'http'
|
|
2563
|
-
}
|
|
2564
|
-
],
|
|
2565
|
-
url: '/v1/graphs/{graph_id}/subscriptions/upgrade',
|
|
2566
|
-
...options,
|
|
2567
|
-
headers: {
|
|
2568
|
-
'Content-Type': 'application/json',
|
|
2569
|
-
...options.headers
|
|
2570
|
-
}
|
|
2571
|
-
});
|
|
2572
|
-
};
|
|
1890
|
+
export const upgradeSubscription = <ThrowOnError extends boolean = false>(options: Options<UpgradeSubscriptionData, ThrowOnError>) => (options.client ?? client).put<UpgradeSubscriptionResponses, UpgradeSubscriptionErrors, ThrowOnError>({
|
|
1891
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1892
|
+
url: '/v1/graphs/{graph_id}/subscriptions/upgrade',
|
|
1893
|
+
...options,
|
|
1894
|
+
headers: {
|
|
1895
|
+
'Content-Type': 'application/json',
|
|
1896
|
+
...options.headers
|
|
1897
|
+
}
|
|
1898
|
+
});
|
|
2573
1899
|
|
|
2574
1900
|
/**
|
|
2575
1901
|
* List Staging Tables
|
|
1902
|
+
*
|
|
2576
1903
|
* List all DuckDB staging tables with comprehensive metrics and status.
|
|
2577
1904
|
*
|
|
2578
1905
|
* Get a complete inventory of all staging tables for a graph, including
|
|
@@ -2608,25 +1935,15 @@ export const upgradeSubscription = <ThrowOnError extends boolean = false>(option
|
|
|
2608
1935
|
* - Empty tables (file_count=0) are skipped during ingestion
|
|
2609
1936
|
* - Table queries are included - no credit consumption
|
|
2610
1937
|
*/
|
|
2611
|
-
export const listTables = <ThrowOnError extends boolean = false>(options: Options<ListTablesData, ThrowOnError>) => {
|
|
2612
|
-
|
|
2613
|
-
|
|
2614
|
-
|
|
2615
|
-
|
|
2616
|
-
type: 'apiKey'
|
|
2617
|
-
},
|
|
2618
|
-
{
|
|
2619
|
-
scheme: 'bearer',
|
|
2620
|
-
type: 'http'
|
|
2621
|
-
}
|
|
2622
|
-
],
|
|
2623
|
-
url: '/v1/graphs/{graph_id}/tables',
|
|
2624
|
-
...options
|
|
2625
|
-
});
|
|
2626
|
-
};
|
|
1938
|
+
export const listTables = <ThrowOnError extends boolean = false>(options: Options<ListTablesData, ThrowOnError>) => (options.client ?? client).get<ListTablesResponses, ListTablesErrors, ThrowOnError>({
|
|
1939
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1940
|
+
url: '/v1/graphs/{graph_id}/tables',
|
|
1941
|
+
...options
|
|
1942
|
+
});
|
|
2627
1943
|
|
|
2628
1944
|
/**
|
|
2629
1945
|
* Query Staging Tables with SQL
|
|
1946
|
+
*
|
|
2630
1947
|
* Execute SQL queries on DuckDB staging tables for data inspection and validation.
|
|
2631
1948
|
*
|
|
2632
1949
|
* Query raw staging data directly with SQL before ingestion into the graph database.
|
|
@@ -2684,29 +2001,19 @@ export const listTables = <ThrowOnError extends boolean = false>(options: Option
|
|
|
2684
2001
|
* **Note:**
|
|
2685
2002
|
* Staging table queries are included - no credit consumption
|
|
2686
2003
|
*/
|
|
2687
|
-
export const queryTables = <ThrowOnError extends boolean = false>(options: Options<QueryTablesData, ThrowOnError>) => {
|
|
2688
|
-
|
|
2689
|
-
|
|
2690
|
-
|
|
2691
|
-
|
|
2692
|
-
|
|
2693
|
-
|
|
2694
|
-
|
|
2695
|
-
|
|
2696
|
-
type: 'http'
|
|
2697
|
-
}
|
|
2698
|
-
],
|
|
2699
|
-
url: '/v1/graphs/{graph_id}/tables/query',
|
|
2700
|
-
...options,
|
|
2701
|
-
headers: {
|
|
2702
|
-
'Content-Type': 'application/json',
|
|
2703
|
-
...options.headers
|
|
2704
|
-
}
|
|
2705
|
-
});
|
|
2706
|
-
};
|
|
2004
|
+
export const queryTables = <ThrowOnError extends boolean = false>(options: Options<QueryTablesData, ThrowOnError>) => (options.client ?? client).post<QueryTablesResponses, QueryTablesErrors, ThrowOnError>({
|
|
2005
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2006
|
+
url: '/v1/graphs/{graph_id}/tables/query',
|
|
2007
|
+
...options,
|
|
2008
|
+
headers: {
|
|
2009
|
+
'Content-Type': 'application/json',
|
|
2010
|
+
...options.headers
|
|
2011
|
+
}
|
|
2012
|
+
});
|
|
2707
2013
|
|
|
2708
2014
|
/**
|
|
2709
2015
|
* Create View
|
|
2016
|
+
*
|
|
2710
2017
|
* Generate financial report view from data source (dual-mode support).
|
|
2711
2018
|
*
|
|
2712
2019
|
* **Mode 1: Transaction Aggregation (generate_from_transactions)**
|
|
@@ -2724,29 +2031,19 @@ export const queryTables = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
2724
2031
|
* - Generate pivot table presentation
|
|
2725
2032
|
* - Return consistent response format
|
|
2726
2033
|
*/
|
|
2727
|
-
export const createView = <ThrowOnError extends boolean = false>(options: Options<CreateViewData, ThrowOnError>) => {
|
|
2728
|
-
|
|
2729
|
-
|
|
2730
|
-
|
|
2731
|
-
|
|
2732
|
-
|
|
2733
|
-
|
|
2734
|
-
|
|
2735
|
-
|
|
2736
|
-
type: 'http'
|
|
2737
|
-
}
|
|
2738
|
-
],
|
|
2739
|
-
url: '/v1/graphs/{graph_id}/views',
|
|
2740
|
-
...options,
|
|
2741
|
-
headers: {
|
|
2742
|
-
'Content-Type': 'application/json',
|
|
2743
|
-
...options.headers
|
|
2744
|
-
}
|
|
2745
|
-
});
|
|
2746
|
-
};
|
|
2034
|
+
export const createView = <ThrowOnError extends boolean = false>(options: Options<CreateViewData, ThrowOnError>) => (options.client ?? client).post<CreateViewResponses, CreateViewErrors, ThrowOnError>({
|
|
2035
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2036
|
+
url: '/v1/graphs/{graph_id}/views',
|
|
2037
|
+
...options,
|
|
2038
|
+
headers: {
|
|
2039
|
+
'Content-Type': 'application/json',
|
|
2040
|
+
...options.headers
|
|
2041
|
+
}
|
|
2042
|
+
});
|
|
2747
2043
|
|
|
2748
2044
|
/**
|
|
2749
2045
|
* Save View
|
|
2046
|
+
*
|
|
2750
2047
|
* Save or update view as materialized report in the graph.
|
|
2751
2048
|
*
|
|
2752
2049
|
* Converts computed view results into persistent Report, Fact, and Structure nodes.
|
|
@@ -2777,29 +2074,19 @@ export const createView = <ThrowOnError extends boolean = false>(options: Option
|
|
|
2777
2074
|
* - parquet_export_prefix: Filename prefix for future exports
|
|
2778
2075
|
* - All created facts and structures
|
|
2779
2076
|
*/
|
|
2780
|
-
export const saveView = <ThrowOnError extends boolean = false>(options: Options<SaveViewData, ThrowOnError>) => {
|
|
2781
|
-
|
|
2782
|
-
|
|
2783
|
-
|
|
2784
|
-
|
|
2785
|
-
|
|
2786
|
-
|
|
2787
|
-
|
|
2788
|
-
|
|
2789
|
-
type: 'http'
|
|
2790
|
-
}
|
|
2791
|
-
],
|
|
2792
|
-
url: '/v1/graphs/{graph_id}/views/save',
|
|
2793
|
-
...options,
|
|
2794
|
-
headers: {
|
|
2795
|
-
'Content-Type': 'application/json',
|
|
2796
|
-
...options.headers
|
|
2797
|
-
}
|
|
2798
|
-
});
|
|
2799
|
-
};
|
|
2077
|
+
export const saveView = <ThrowOnError extends boolean = false>(options: Options<SaveViewData, ThrowOnError>) => (options.client ?? client).post<SaveViewResponses, SaveViewErrors, ThrowOnError>({
|
|
2078
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2079
|
+
url: '/v1/graphs/{graph_id}/views/save',
|
|
2080
|
+
...options,
|
|
2081
|
+
headers: {
|
|
2082
|
+
'Content-Type': 'application/json',
|
|
2083
|
+
...options.headers
|
|
2084
|
+
}
|
|
2085
|
+
});
|
|
2800
2086
|
|
|
2801
2087
|
/**
|
|
2802
2088
|
* Get Materialization Status
|
|
2089
|
+
*
|
|
2803
2090
|
* Get current materialization status for the graph.
|
|
2804
2091
|
*
|
|
2805
2092
|
* Shows whether the graph is stale (DuckDB has changes not yet in graph database),
|
|
@@ -2825,25 +2112,15 @@ export const saveView = <ThrowOnError extends boolean = false>(options: Options<
|
|
|
2825
2112
|
* - Materialization clears staleness
|
|
2826
2113
|
* - Status retrieval is included - no credit consumption
|
|
2827
2114
|
*/
|
|
2828
|
-
export const getMaterializationStatus = <ThrowOnError extends boolean = false>(options: Options<GetMaterializationStatusData, ThrowOnError>) => {
|
|
2829
|
-
|
|
2830
|
-
|
|
2831
|
-
|
|
2832
|
-
|
|
2833
|
-
type: 'apiKey'
|
|
2834
|
-
},
|
|
2835
|
-
{
|
|
2836
|
-
scheme: 'bearer',
|
|
2837
|
-
type: 'http'
|
|
2838
|
-
}
|
|
2839
|
-
],
|
|
2840
|
-
url: '/v1/graphs/{graph_id}/materialize/status',
|
|
2841
|
-
...options
|
|
2842
|
-
});
|
|
2843
|
-
};
|
|
2115
|
+
export const getMaterializationStatus = <ThrowOnError extends boolean = false>(options: Options<GetMaterializationStatusData, ThrowOnError>) => (options.client ?? client).get<GetMaterializationStatusResponses, GetMaterializationStatusErrors, ThrowOnError>({
|
|
2116
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2117
|
+
url: '/v1/graphs/{graph_id}/materialize/status',
|
|
2118
|
+
...options
|
|
2119
|
+
});
|
|
2844
2120
|
|
|
2845
2121
|
/**
|
|
2846
2122
|
* Materialize Graph from DuckDB
|
|
2123
|
+
*
|
|
2847
2124
|
* Rebuild entire graph from DuckDB staging tables (materialized view pattern).
|
|
2848
2125
|
*
|
|
2849
2126
|
* This endpoint rebuilds the complete graph database from the current state of DuckDB
|
|
@@ -2896,29 +2173,19 @@ export const getMaterializationStatus = <ThrowOnError extends boolean = false>(o
|
|
|
2896
2173
|
* **Credits:**
|
|
2897
2174
|
* Materialization is included - no credit consumption
|
|
2898
2175
|
*/
|
|
2899
|
-
export const materializeGraph = <ThrowOnError extends boolean = false>(options: Options<MaterializeGraphData, ThrowOnError>) => {
|
|
2900
|
-
|
|
2901
|
-
|
|
2902
|
-
|
|
2903
|
-
|
|
2904
|
-
|
|
2905
|
-
|
|
2906
|
-
|
|
2907
|
-
|
|
2908
|
-
type: 'http'
|
|
2909
|
-
}
|
|
2910
|
-
],
|
|
2911
|
-
url: '/v1/graphs/{graph_id}/materialize',
|
|
2912
|
-
...options,
|
|
2913
|
-
headers: {
|
|
2914
|
-
'Content-Type': 'application/json',
|
|
2915
|
-
...options.headers
|
|
2916
|
-
}
|
|
2917
|
-
});
|
|
2918
|
-
};
|
|
2176
|
+
export const materializeGraph = <ThrowOnError extends boolean = false>(options: Options<MaterializeGraphData, ThrowOnError>) => (options.client ?? client).post<MaterializeGraphResponses, MaterializeGraphErrors, ThrowOnError>({
|
|
2177
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2178
|
+
url: '/v1/graphs/{graph_id}/materialize',
|
|
2179
|
+
...options,
|
|
2180
|
+
headers: {
|
|
2181
|
+
'Content-Type': 'application/json',
|
|
2182
|
+
...options.headers
|
|
2183
|
+
}
|
|
2184
|
+
});
|
|
2919
2185
|
|
|
2920
2186
|
/**
|
|
2921
2187
|
* List Files in Graph
|
|
2188
|
+
*
|
|
2922
2189
|
* List all files in the graph with optional filtering.
|
|
2923
2190
|
*
|
|
2924
2191
|
* Get a complete inventory of files across all tables or filtered by table name,
|
|
@@ -2951,25 +2218,15 @@ export const materializeGraph = <ThrowOnError extends boolean = false>(options:
|
|
|
2951
2218
|
* - Use table_name parameter to filter by table
|
|
2952
2219
|
* - File listing is included - no credit consumption
|
|
2953
2220
|
*/
|
|
2954
|
-
export const listFiles = <ThrowOnError extends boolean = false>(options: Options<ListFilesData, ThrowOnError>) => {
|
|
2955
|
-
|
|
2956
|
-
|
|
2957
|
-
|
|
2958
|
-
|
|
2959
|
-
type: 'apiKey'
|
|
2960
|
-
},
|
|
2961
|
-
{
|
|
2962
|
-
scheme: 'bearer',
|
|
2963
|
-
type: 'http'
|
|
2964
|
-
}
|
|
2965
|
-
],
|
|
2966
|
-
url: '/v1/graphs/{graph_id}/files',
|
|
2967
|
-
...options
|
|
2968
|
-
});
|
|
2969
|
-
};
|
|
2221
|
+
export const listFiles = <ThrowOnError extends boolean = false>(options: Options<ListFilesData, ThrowOnError>) => (options.client ?? client).get<ListFilesResponses, ListFilesErrors, ThrowOnError>({
|
|
2222
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2223
|
+
url: '/v1/graphs/{graph_id}/files',
|
|
2224
|
+
...options
|
|
2225
|
+
});
|
|
2970
2226
|
|
|
2971
2227
|
/**
|
|
2972
2228
|
* Create File Upload
|
|
2229
|
+
*
|
|
2973
2230
|
* Generate presigned S3 URL for file upload.
|
|
2974
2231
|
*
|
|
2975
2232
|
* Initiate file upload by generating a secure, time-limited presigned S3 URL.
|
|
@@ -2998,29 +2255,19 @@ export const listFiles = <ThrowOnError extends boolean = false>(options: Options
|
|
|
2998
2255
|
* - Files are graph-scoped, independent resources
|
|
2999
2256
|
* - Upload URL generation is included - no credit consumption
|
|
3000
2257
|
*/
|
|
3001
|
-
export const createFileUpload = <ThrowOnError extends boolean = false>(options: Options<CreateFileUploadData, ThrowOnError>) => {
|
|
3002
|
-
|
|
3003
|
-
|
|
3004
|
-
|
|
3005
|
-
|
|
3006
|
-
|
|
3007
|
-
|
|
3008
|
-
|
|
3009
|
-
|
|
3010
|
-
type: 'http'
|
|
3011
|
-
}
|
|
3012
|
-
],
|
|
3013
|
-
url: '/v1/graphs/{graph_id}/files',
|
|
3014
|
-
...options,
|
|
3015
|
-
headers: {
|
|
3016
|
-
'Content-Type': 'application/json',
|
|
3017
|
-
...options.headers
|
|
3018
|
-
}
|
|
3019
|
-
});
|
|
3020
|
-
};
|
|
2258
|
+
export const createFileUpload = <ThrowOnError extends boolean = false>(options: Options<CreateFileUploadData, ThrowOnError>) => (options.client ?? client).post<CreateFileUploadResponses, CreateFileUploadErrors, ThrowOnError>({
|
|
2259
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2260
|
+
url: '/v1/graphs/{graph_id}/files',
|
|
2261
|
+
...options,
|
|
2262
|
+
headers: {
|
|
2263
|
+
'Content-Type': 'application/json',
|
|
2264
|
+
...options.headers
|
|
2265
|
+
}
|
|
2266
|
+
});
|
|
3021
2267
|
|
|
3022
2268
|
/**
|
|
3023
2269
|
* Delete File
|
|
2270
|
+
*
|
|
3024
2271
|
* Delete file from all layers.
|
|
3025
2272
|
*
|
|
3026
2273
|
* Remove file from S3, database tracking, and optionally from DuckDB and graph.
|
|
@@ -3057,25 +2304,15 @@ export const createFileUpload = <ThrowOnError extends boolean = false>(options:
|
|
|
3057
2304
|
* - Graph rebuild recommended after cascade deletion
|
|
3058
2305
|
* - File deletion is included - no credit consumption
|
|
3059
2306
|
*/
|
|
3060
|
-
export const deleteFile = <ThrowOnError extends boolean = false>(options: Options<DeleteFileData, ThrowOnError>) => {
|
|
3061
|
-
|
|
3062
|
-
|
|
3063
|
-
|
|
3064
|
-
|
|
3065
|
-
type: 'apiKey'
|
|
3066
|
-
},
|
|
3067
|
-
{
|
|
3068
|
-
scheme: 'bearer',
|
|
3069
|
-
type: 'http'
|
|
3070
|
-
}
|
|
3071
|
-
],
|
|
3072
|
-
url: '/v1/graphs/{graph_id}/files/{file_id}',
|
|
3073
|
-
...options
|
|
3074
|
-
});
|
|
3075
|
-
};
|
|
2307
|
+
export const deleteFile = <ThrowOnError extends boolean = false>(options: Options<DeleteFileData, ThrowOnError>) => (options.client ?? client).delete<DeleteFileResponses, DeleteFileErrors, ThrowOnError>({
|
|
2308
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2309
|
+
url: '/v1/graphs/{graph_id}/files/{file_id}',
|
|
2310
|
+
...options
|
|
2311
|
+
});
|
|
3076
2312
|
|
|
3077
2313
|
/**
|
|
3078
2314
|
* Get File Information
|
|
2315
|
+
*
|
|
3079
2316
|
* Get detailed information about a specific file.
|
|
3080
2317
|
*
|
|
3081
2318
|
* Retrieve comprehensive metadata for a single file by file_id, independent of
|
|
@@ -3112,25 +2349,15 @@ export const deleteFile = <ThrowOnError extends boolean = false>(options: Option
|
|
|
3112
2349
|
* **Note:**
|
|
3113
2350
|
* File info retrieval is included - no credit consumption
|
|
3114
2351
|
*/
|
|
3115
|
-
export const getFile = <ThrowOnError extends boolean = false>(options: Options<GetFileData, ThrowOnError>) => {
|
|
3116
|
-
|
|
3117
|
-
|
|
3118
|
-
|
|
3119
|
-
|
|
3120
|
-
type: 'apiKey'
|
|
3121
|
-
},
|
|
3122
|
-
{
|
|
3123
|
-
scheme: 'bearer',
|
|
3124
|
-
type: 'http'
|
|
3125
|
-
}
|
|
3126
|
-
],
|
|
3127
|
-
url: '/v1/graphs/{graph_id}/files/{file_id}',
|
|
3128
|
-
...options
|
|
3129
|
-
});
|
|
3130
|
-
};
|
|
2352
|
+
export const getFile = <ThrowOnError extends boolean = false>(options: Options<GetFileData, ThrowOnError>) => (options.client ?? client).get<GetFileResponses, GetFileErrors, ThrowOnError>({
|
|
2353
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2354
|
+
url: '/v1/graphs/{graph_id}/files/{file_id}',
|
|
2355
|
+
...options
|
|
2356
|
+
});
|
|
3131
2357
|
|
|
3132
2358
|
/**
|
|
3133
2359
|
* Update File Status
|
|
2360
|
+
*
|
|
3134
2361
|
* Update file status and trigger processing.
|
|
3135
2362
|
*
|
|
3136
2363
|
* Update file status after upload completion. Setting status='uploaded' triggers
|
|
@@ -3158,29 +2385,19 @@ export const getFile = <ThrowOnError extends boolean = false>(options: Options<G
|
|
|
3158
2385
|
* - DuckDB staging happens asynchronously
|
|
3159
2386
|
* - Graph ingestion is optional (ingest_to_graph flag)
|
|
3160
2387
|
*/
|
|
3161
|
-
export const updateFile = <ThrowOnError extends boolean = false>(options: Options<UpdateFileData, ThrowOnError>) => {
|
|
3162
|
-
|
|
3163
|
-
|
|
3164
|
-
|
|
3165
|
-
|
|
3166
|
-
|
|
3167
|
-
|
|
3168
|
-
|
|
3169
|
-
|
|
3170
|
-
type: 'http'
|
|
3171
|
-
}
|
|
3172
|
-
],
|
|
3173
|
-
url: '/v1/graphs/{graph_id}/files/{file_id}',
|
|
3174
|
-
...options,
|
|
3175
|
-
headers: {
|
|
3176
|
-
'Content-Type': 'application/json',
|
|
3177
|
-
...options.headers
|
|
3178
|
-
}
|
|
3179
|
-
});
|
|
3180
|
-
};
|
|
2388
|
+
export const updateFile = <ThrowOnError extends boolean = false>(options: Options<UpdateFileData, ThrowOnError>) => (options.client ?? client).patch<UpdateFileResponses, UpdateFileErrors, ThrowOnError>({
|
|
2389
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2390
|
+
url: '/v1/graphs/{graph_id}/files/{file_id}',
|
|
2391
|
+
...options,
|
|
2392
|
+
headers: {
|
|
2393
|
+
'Content-Type': 'application/json',
|
|
2394
|
+
...options.headers
|
|
2395
|
+
}
|
|
2396
|
+
});
|
|
3181
2397
|
|
|
3182
2398
|
/**
|
|
3183
2399
|
* Get User Graphs and Repositories
|
|
2400
|
+
*
|
|
3184
2401
|
* List all graph databases and shared repositories accessible to the current user.
|
|
3185
2402
|
*
|
|
3186
2403
|
* Returns a unified list of both user-created graphs and shared repositories (like SEC data)
|
|
@@ -3223,25 +2440,15 @@ export const updateFile = <ThrowOnError extends boolean = false>(options: Option
|
|
|
3223
2440
|
* **Note:**
|
|
3224
2441
|
* Graph listing is included - no credit consumption required.
|
|
3225
2442
|
*/
|
|
3226
|
-
export const getGraphs = <ThrowOnError extends boolean = false>(options?: Options<GetGraphsData, ThrowOnError>) => {
|
|
3227
|
-
|
|
3228
|
-
|
|
3229
|
-
|
|
3230
|
-
|
|
3231
|
-
type: 'apiKey'
|
|
3232
|
-
},
|
|
3233
|
-
{
|
|
3234
|
-
scheme: 'bearer',
|
|
3235
|
-
type: 'http'
|
|
3236
|
-
}
|
|
3237
|
-
],
|
|
3238
|
-
url: '/v1/graphs',
|
|
3239
|
-
...options
|
|
3240
|
-
});
|
|
3241
|
-
};
|
|
2443
|
+
export const getGraphs = <ThrowOnError extends boolean = false>(options?: Options<GetGraphsData, ThrowOnError>) => (options?.client ?? client).get<GetGraphsResponses, GetGraphsErrors, ThrowOnError>({
|
|
2444
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2445
|
+
url: '/v1/graphs',
|
|
2446
|
+
...options
|
|
2447
|
+
});
|
|
3242
2448
|
|
|
3243
2449
|
/**
|
|
3244
2450
|
* Create New Graph Database
|
|
2451
|
+
*
|
|
3245
2452
|
* Create a new graph database with specified schema and optionally an initial entity.
|
|
3246
2453
|
*
|
|
3247
2454
|
* This endpoint starts an asynchronous graph creation operation and returns
|
|
@@ -3309,29 +2516,19 @@ export const getGraphs = <ThrowOnError extends boolean = false>(options?: Option
|
|
|
3309
2516
|
* - `_links.stream`: SSE endpoint for real-time updates
|
|
3310
2517
|
* - `_links.status`: Point-in-time status check endpoint
|
|
3311
2518
|
*/
|
|
3312
|
-
export const createGraph = <ThrowOnError extends boolean = false>(options: Options<CreateGraphData, ThrowOnError>) => {
|
|
3313
|
-
|
|
3314
|
-
|
|
3315
|
-
|
|
3316
|
-
|
|
3317
|
-
|
|
3318
|
-
|
|
3319
|
-
|
|
3320
|
-
|
|
3321
|
-
type: 'http'
|
|
3322
|
-
}
|
|
3323
|
-
],
|
|
3324
|
-
url: '/v1/graphs',
|
|
3325
|
-
...options,
|
|
3326
|
-
headers: {
|
|
3327
|
-
'Content-Type': 'application/json',
|
|
3328
|
-
...options.headers
|
|
3329
|
-
}
|
|
3330
|
-
});
|
|
3331
|
-
};
|
|
2519
|
+
export const createGraph = <ThrowOnError extends boolean = false>(options: Options<CreateGraphData, ThrowOnError>) => (options.client ?? client).post<CreateGraphResponses, CreateGraphErrors, ThrowOnError>({
|
|
2520
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2521
|
+
url: '/v1/graphs',
|
|
2522
|
+
...options,
|
|
2523
|
+
headers: {
|
|
2524
|
+
'Content-Type': 'application/json',
|
|
2525
|
+
...options.headers
|
|
2526
|
+
}
|
|
2527
|
+
});
|
|
3332
2528
|
|
|
3333
2529
|
/**
|
|
3334
2530
|
* Get Available Schema Extensions
|
|
2531
|
+
*
|
|
3335
2532
|
* List all available schema extensions for graph creation.
|
|
3336
2533
|
*
|
|
3337
2534
|
* Schema extensions provide pre-built industry-specific data models that extend
|
|
@@ -3361,25 +2558,15 @@ export const createGraph = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
3361
2558
|
* **Note:**
|
|
3362
2559
|
* Extension listing is included - no credit consumption required.
|
|
3363
2560
|
*/
|
|
3364
|
-
export const getAvailableExtensions = <ThrowOnError extends boolean = false>(options?: Options<GetAvailableExtensionsData, ThrowOnError>) => {
|
|
3365
|
-
|
|
3366
|
-
|
|
3367
|
-
|
|
3368
|
-
|
|
3369
|
-
type: 'apiKey'
|
|
3370
|
-
},
|
|
3371
|
-
{
|
|
3372
|
-
scheme: 'bearer',
|
|
3373
|
-
type: 'http'
|
|
3374
|
-
}
|
|
3375
|
-
],
|
|
3376
|
-
url: '/v1/graphs/extensions',
|
|
3377
|
-
...options
|
|
3378
|
-
});
|
|
3379
|
-
};
|
|
2561
|
+
export const getAvailableExtensions = <ThrowOnError extends boolean = false>(options?: Options<GetAvailableExtensionsData, ThrowOnError>) => (options?.client ?? client).get<GetAvailableExtensionsResponses, GetAvailableExtensionsErrors, ThrowOnError>({
|
|
2562
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2563
|
+
url: '/v1/graphs/extensions',
|
|
2564
|
+
...options
|
|
2565
|
+
});
|
|
3380
2566
|
|
|
3381
2567
|
/**
|
|
3382
2568
|
* Get Available Graph Tiers
|
|
2569
|
+
*
|
|
3383
2570
|
* List all available graph database tier configurations.
|
|
3384
2571
|
*
|
|
3385
2572
|
* This endpoint provides comprehensive technical specifications for each available
|
|
@@ -3408,25 +2595,15 @@ export const getAvailableExtensions = <ThrowOnError extends boolean = false>(opt
|
|
|
3408
2595
|
* **Note:**
|
|
3409
2596
|
* Tier listing is included - no credit consumption required.
|
|
3410
2597
|
*/
|
|
3411
|
-
export const getAvailableGraphTiers = <ThrowOnError extends boolean = false>(options?: Options<GetAvailableGraphTiersData, ThrowOnError>) => {
|
|
3412
|
-
|
|
3413
|
-
|
|
3414
|
-
|
|
3415
|
-
|
|
3416
|
-
type: 'apiKey'
|
|
3417
|
-
},
|
|
3418
|
-
{
|
|
3419
|
-
scheme: 'bearer',
|
|
3420
|
-
type: 'http'
|
|
3421
|
-
}
|
|
3422
|
-
],
|
|
3423
|
-
url: '/v1/graphs/tiers',
|
|
3424
|
-
...options
|
|
3425
|
-
});
|
|
3426
|
-
};
|
|
2598
|
+
export const getAvailableGraphTiers = <ThrowOnError extends boolean = false>(options?: Options<GetAvailableGraphTiersData, ThrowOnError>) => (options?.client ?? client).get<GetAvailableGraphTiersResponses, GetAvailableGraphTiersErrors, ThrowOnError>({
|
|
2599
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2600
|
+
url: '/v1/graphs/tiers',
|
|
2601
|
+
...options
|
|
2602
|
+
});
|
|
3427
2603
|
|
|
3428
2604
|
/**
|
|
3429
2605
|
* Select Graph
|
|
2606
|
+
*
|
|
3430
2607
|
* Select a specific graph as the active workspace for the user.
|
|
3431
2608
|
*
|
|
3432
2609
|
* The selected graph becomes the default context for operations in client applications
|
|
@@ -3457,25 +2634,15 @@ export const getAvailableGraphTiers = <ThrowOnError extends boolean = false>(opt
|
|
|
3457
2634
|
* **Note:**
|
|
3458
2635
|
* Graph selection is included - no credit consumption required.
|
|
3459
2636
|
*/
|
|
3460
|
-
export const selectGraph = <ThrowOnError extends boolean = false>(options: Options<SelectGraphData, ThrowOnError>) => {
|
|
3461
|
-
|
|
3462
|
-
|
|
3463
|
-
|
|
3464
|
-
|
|
3465
|
-
type: 'apiKey'
|
|
3466
|
-
},
|
|
3467
|
-
{
|
|
3468
|
-
scheme: 'bearer',
|
|
3469
|
-
type: 'http'
|
|
3470
|
-
}
|
|
3471
|
-
],
|
|
3472
|
-
url: '/v1/graphs/{graph_id}/select',
|
|
3473
|
-
...options
|
|
3474
|
-
});
|
|
3475
|
-
};
|
|
2637
|
+
export const selectGraph = <ThrowOnError extends boolean = false>(options: Options<SelectGraphData, ThrowOnError>) => (options.client ?? client).post<SelectGraphResponses, SelectGraphErrors, ThrowOnError>({
|
|
2638
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2639
|
+
url: '/v1/graphs/{graph_id}/select',
|
|
2640
|
+
...options
|
|
2641
|
+
});
|
|
3476
2642
|
|
|
3477
2643
|
/**
|
|
3478
2644
|
* Get Service Offerings
|
|
2645
|
+
*
|
|
3479
2646
|
* Get comprehensive information about all subscription offerings.
|
|
3480
2647
|
*
|
|
3481
2648
|
* This endpoint provides complete information about both graph database subscriptions
|
|
@@ -3499,15 +2666,11 @@ export const selectGraph = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
3499
2666
|
*
|
|
3500
2667
|
* No authentication required - this is public service information.
|
|
3501
2668
|
*/
|
|
3502
|
-
export const getServiceOfferings = <ThrowOnError extends boolean = false>(options?: Options<GetServiceOfferingsData, ThrowOnError>) => {
|
|
3503
|
-
return (options?.client ?? _heyApiClient).get<GetServiceOfferingsResponses, GetServiceOfferingsErrors, ThrowOnError>({
|
|
3504
|
-
url: '/v1/offering',
|
|
3505
|
-
...options
|
|
3506
|
-
});
|
|
3507
|
-
};
|
|
2669
|
+
export const getServiceOfferings = <ThrowOnError extends boolean = false>(options?: Options<GetServiceOfferingsData, ThrowOnError>) => (options?.client ?? client).get<GetServiceOfferingsResponses, GetServiceOfferingsErrors, ThrowOnError>({ url: '/v1/offering', ...options });
|
|
3508
2670
|
|
|
3509
2671
|
/**
|
|
3510
2672
|
* Stream Operation Events
|
|
2673
|
+
*
|
|
3511
2674
|
* Stream real-time events for an operation using Server-Sent Events (SSE).
|
|
3512
2675
|
*
|
|
3513
2676
|
* This endpoint provides real-time monitoring for all non-immediate operations including:
|
|
@@ -3556,25 +2719,15 @@ export const getServiceOfferings = <ThrowOnError extends boolean = false>(option
|
|
|
3556
2719
|
*
|
|
3557
2720
|
* **No credits are consumed for SSE connections.**
|
|
3558
2721
|
*/
|
|
3559
|
-
export const streamOperationEvents = <ThrowOnError extends boolean = false>(options: Options<StreamOperationEventsData, ThrowOnError>) => {
|
|
3560
|
-
|
|
3561
|
-
|
|
3562
|
-
|
|
3563
|
-
|
|
3564
|
-
type: 'apiKey'
|
|
3565
|
-
},
|
|
3566
|
-
{
|
|
3567
|
-
scheme: 'bearer',
|
|
3568
|
-
type: 'http'
|
|
3569
|
-
}
|
|
3570
|
-
],
|
|
3571
|
-
url: '/v1/operations/{operation_id}/stream',
|
|
3572
|
-
...options
|
|
3573
|
-
});
|
|
3574
|
-
};
|
|
2722
|
+
export const streamOperationEvents = <ThrowOnError extends boolean = false>(options: Options<StreamOperationEventsData, ThrowOnError>) => (options.client ?? client).get<StreamOperationEventsResponses, StreamOperationEventsErrors, ThrowOnError>({
|
|
2723
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2724
|
+
url: '/v1/operations/{operation_id}/stream',
|
|
2725
|
+
...options
|
|
2726
|
+
});
|
|
3575
2727
|
|
|
3576
2728
|
/**
|
|
3577
2729
|
* Get Operation Status
|
|
2730
|
+
*
|
|
3578
2731
|
* Get current status and metadata for an operation.
|
|
3579
2732
|
*
|
|
3580
2733
|
* Returns detailed information including:
|
|
@@ -3589,25 +2742,15 @@ export const streamOperationEvents = <ThrowOnError extends boolean = false>(opti
|
|
|
3589
2742
|
*
|
|
3590
2743
|
* **No credits are consumed for status checks.**
|
|
3591
2744
|
*/
|
|
3592
|
-
export const getOperationStatus = <ThrowOnError extends boolean = false>(options: Options<GetOperationStatusData, ThrowOnError>) => {
|
|
3593
|
-
|
|
3594
|
-
|
|
3595
|
-
|
|
3596
|
-
|
|
3597
|
-
type: 'apiKey'
|
|
3598
|
-
},
|
|
3599
|
-
{
|
|
3600
|
-
scheme: 'bearer',
|
|
3601
|
-
type: 'http'
|
|
3602
|
-
}
|
|
3603
|
-
],
|
|
3604
|
-
url: '/v1/operations/{operation_id}/status',
|
|
3605
|
-
...options
|
|
3606
|
-
});
|
|
3607
|
-
};
|
|
2745
|
+
export const getOperationStatus = <ThrowOnError extends boolean = false>(options: Options<GetOperationStatusData, ThrowOnError>) => (options.client ?? client).get<GetOperationStatusResponses, GetOperationStatusErrors, ThrowOnError>({
|
|
2746
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2747
|
+
url: '/v1/operations/{operation_id}/status',
|
|
2748
|
+
...options
|
|
2749
|
+
});
|
|
3608
2750
|
|
|
3609
2751
|
/**
|
|
3610
2752
|
* Cancel Operation
|
|
2753
|
+
*
|
|
3611
2754
|
* Cancel a pending or running operation.
|
|
3612
2755
|
*
|
|
3613
2756
|
* Cancels the specified operation if it's still in progress. Once cancelled,
|
|
@@ -3618,25 +2761,15 @@ export const getOperationStatus = <ThrowOnError extends boolean = false>(options
|
|
|
3618
2761
|
*
|
|
3619
2762
|
* **No credits are consumed for cancellation requests.**
|
|
3620
2763
|
*/
|
|
3621
|
-
export const cancelOperation = <ThrowOnError extends boolean = false>(options: Options<CancelOperationData, ThrowOnError>) => {
|
|
3622
|
-
|
|
3623
|
-
|
|
3624
|
-
|
|
3625
|
-
|
|
3626
|
-
type: 'apiKey'
|
|
3627
|
-
},
|
|
3628
|
-
{
|
|
3629
|
-
scheme: 'bearer',
|
|
3630
|
-
type: 'http'
|
|
3631
|
-
}
|
|
3632
|
-
],
|
|
3633
|
-
url: '/v1/operations/{operation_id}',
|
|
3634
|
-
...options
|
|
3635
|
-
});
|
|
3636
|
-
};
|
|
2764
|
+
export const cancelOperation = <ThrowOnError extends boolean = false>(options: Options<CancelOperationData, ThrowOnError>) => (options.client ?? client).delete<CancelOperationResponses, CancelOperationErrors, ThrowOnError>({
|
|
2765
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2766
|
+
url: '/v1/operations/{operation_id}',
|
|
2767
|
+
...options
|
|
2768
|
+
});
|
|
3637
2769
|
|
|
3638
2770
|
/**
|
|
3639
2771
|
* Get Organization Customer Info
|
|
2772
|
+
*
|
|
3640
2773
|
* Get billing customer information for an organization including payment methods on file.
|
|
3641
2774
|
*
|
|
3642
2775
|
* Returns customer details, payment methods, and whether invoice billing is enabled.
|
|
@@ -3645,25 +2778,15 @@ export const cancelOperation = <ThrowOnError extends boolean = false>(options: O
|
|
|
3645
2778
|
* - User must be a member of the organization
|
|
3646
2779
|
* - Sensitive payment details are only visible to owners
|
|
3647
2780
|
*/
|
|
3648
|
-
export const getOrgBillingCustomer = <ThrowOnError extends boolean = false>(options: Options<GetOrgBillingCustomerData, ThrowOnError>) => {
|
|
3649
|
-
|
|
3650
|
-
|
|
3651
|
-
|
|
3652
|
-
|
|
3653
|
-
type: 'apiKey'
|
|
3654
|
-
},
|
|
3655
|
-
{
|
|
3656
|
-
scheme: 'bearer',
|
|
3657
|
-
type: 'http'
|
|
3658
|
-
}
|
|
3659
|
-
],
|
|
3660
|
-
url: '/v1/billing/customer/{org_id}',
|
|
3661
|
-
...options
|
|
3662
|
-
});
|
|
3663
|
-
};
|
|
2781
|
+
export const getOrgBillingCustomer = <ThrowOnError extends boolean = false>(options: Options<GetOrgBillingCustomerData, ThrowOnError>) => (options.client ?? client).get<GetOrgBillingCustomerResponses, GetOrgBillingCustomerErrors, ThrowOnError>({
|
|
2782
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2783
|
+
url: '/v1/billing/customer/{org_id}',
|
|
2784
|
+
...options
|
|
2785
|
+
});
|
|
3664
2786
|
|
|
3665
2787
|
/**
|
|
3666
2788
|
* Create Customer Portal Session
|
|
2789
|
+
*
|
|
3667
2790
|
* Create a Stripe Customer Portal session for managing payment methods.
|
|
3668
2791
|
*
|
|
3669
2792
|
* The portal allows users to:
|
|
@@ -3678,25 +2801,15 @@ export const getOrgBillingCustomer = <ThrowOnError extends boolean = false>(opti
|
|
|
3678
2801
|
* - User must be an OWNER of the organization
|
|
3679
2802
|
* - Organization must have a Stripe customer ID (i.e., has gone through checkout at least once)
|
|
3680
2803
|
*/
|
|
3681
|
-
export const createPortalSession = <ThrowOnError extends boolean = false>(options: Options<CreatePortalSessionData, ThrowOnError>) => {
|
|
3682
|
-
|
|
3683
|
-
|
|
3684
|
-
|
|
3685
|
-
|
|
3686
|
-
type: 'apiKey'
|
|
3687
|
-
},
|
|
3688
|
-
{
|
|
3689
|
-
scheme: 'bearer',
|
|
3690
|
-
type: 'http'
|
|
3691
|
-
}
|
|
3692
|
-
],
|
|
3693
|
-
url: '/v1/billing/customer/{org_id}/portal',
|
|
3694
|
-
...options
|
|
3695
|
-
});
|
|
3696
|
-
};
|
|
2804
|
+
export const createPortalSession = <ThrowOnError extends boolean = false>(options: Options<CreatePortalSessionData, ThrowOnError>) => (options.client ?? client).post<CreatePortalSessionResponses, CreatePortalSessionErrors, ThrowOnError>({
|
|
2805
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2806
|
+
url: '/v1/billing/customer/{org_id}/portal',
|
|
2807
|
+
...options
|
|
2808
|
+
});
|
|
3697
2809
|
|
|
3698
2810
|
/**
|
|
3699
2811
|
* List Organization Subscriptions
|
|
2812
|
+
*
|
|
3700
2813
|
* List all active and past subscriptions for an organization.
|
|
3701
2814
|
*
|
|
3702
2815
|
* Includes both graph and repository subscriptions with their status, pricing, and billing information.
|
|
@@ -3704,49 +2817,29 @@ export const createPortalSession = <ThrowOnError extends boolean = false>(option
|
|
|
3704
2817
|
* **Requirements:**
|
|
3705
2818
|
* - User must be a member of the organization
|
|
3706
2819
|
*/
|
|
3707
|
-
export const listOrgSubscriptions = <ThrowOnError extends boolean = false>(options: Options<ListOrgSubscriptionsData, ThrowOnError>) => {
|
|
3708
|
-
|
|
3709
|
-
|
|
3710
|
-
|
|
3711
|
-
|
|
3712
|
-
type: 'apiKey'
|
|
3713
|
-
},
|
|
3714
|
-
{
|
|
3715
|
-
scheme: 'bearer',
|
|
3716
|
-
type: 'http'
|
|
3717
|
-
}
|
|
3718
|
-
],
|
|
3719
|
-
url: '/v1/billing/subscriptions/{org_id}',
|
|
3720
|
-
...options
|
|
3721
|
-
});
|
|
3722
|
-
};
|
|
2820
|
+
export const listOrgSubscriptions = <ThrowOnError extends boolean = false>(options: Options<ListOrgSubscriptionsData, ThrowOnError>) => (options.client ?? client).get<ListOrgSubscriptionsResponses, ListOrgSubscriptionsErrors, ThrowOnError>({
|
|
2821
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2822
|
+
url: '/v1/billing/subscriptions/{org_id}',
|
|
2823
|
+
...options
|
|
2824
|
+
});
|
|
3723
2825
|
|
|
3724
2826
|
/**
|
|
3725
2827
|
* Get Organization Subscription Details
|
|
2828
|
+
*
|
|
3726
2829
|
* Get detailed information about a specific subscription.
|
|
3727
2830
|
*
|
|
3728
2831
|
* **Requirements:**
|
|
3729
2832
|
* - User must be a member of the organization
|
|
3730
2833
|
*/
|
|
3731
|
-
export const getOrgSubscription = <ThrowOnError extends boolean = false>(options: Options<GetOrgSubscriptionData, ThrowOnError>) => {
|
|
3732
|
-
|
|
3733
|
-
|
|
3734
|
-
|
|
3735
|
-
|
|
3736
|
-
type: 'apiKey'
|
|
3737
|
-
},
|
|
3738
|
-
{
|
|
3739
|
-
scheme: 'bearer',
|
|
3740
|
-
type: 'http'
|
|
3741
|
-
}
|
|
3742
|
-
],
|
|
3743
|
-
url: '/v1/billing/subscriptions/{org_id}/subscription/{subscription_id}',
|
|
3744
|
-
...options
|
|
3745
|
-
});
|
|
3746
|
-
};
|
|
2834
|
+
export const getOrgSubscription = <ThrowOnError extends boolean = false>(options: Options<GetOrgSubscriptionData, ThrowOnError>) => (options.client ?? client).get<GetOrgSubscriptionResponses, GetOrgSubscriptionErrors, ThrowOnError>({
|
|
2835
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2836
|
+
url: '/v1/billing/subscriptions/{org_id}/subscription/{subscription_id}',
|
|
2837
|
+
...options
|
|
2838
|
+
});
|
|
3747
2839
|
|
|
3748
2840
|
/**
|
|
3749
2841
|
* Cancel Organization Subscription
|
|
2842
|
+
*
|
|
3750
2843
|
* Cancel an organization subscription.
|
|
3751
2844
|
*
|
|
3752
2845
|
* The subscription will remain active until the end of the current billing period.
|
|
@@ -3754,25 +2847,15 @@ export const getOrgSubscription = <ThrowOnError extends boolean = false>(options
|
|
|
3754
2847
|
* **Requirements:**
|
|
3755
2848
|
* - User must be an OWNER of the organization
|
|
3756
2849
|
*/
|
|
3757
|
-
export const cancelOrgSubscription = <ThrowOnError extends boolean = false>(options: Options<CancelOrgSubscriptionData, ThrowOnError>) => {
|
|
3758
|
-
|
|
3759
|
-
|
|
3760
|
-
|
|
3761
|
-
|
|
3762
|
-
type: 'apiKey'
|
|
3763
|
-
},
|
|
3764
|
-
{
|
|
3765
|
-
scheme: 'bearer',
|
|
3766
|
-
type: 'http'
|
|
3767
|
-
}
|
|
3768
|
-
],
|
|
3769
|
-
url: '/v1/billing/subscriptions/{org_id}/subscription/{subscription_id}/cancel',
|
|
3770
|
-
...options
|
|
3771
|
-
});
|
|
3772
|
-
};
|
|
2850
|
+
export const cancelOrgSubscription = <ThrowOnError extends boolean = false>(options: Options<CancelOrgSubscriptionData, ThrowOnError>) => (options.client ?? client).post<CancelOrgSubscriptionResponses, CancelOrgSubscriptionErrors, ThrowOnError>({
|
|
2851
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2852
|
+
url: '/v1/billing/subscriptions/{org_id}/subscription/{subscription_id}/cancel',
|
|
2853
|
+
...options
|
|
2854
|
+
});
|
|
3773
2855
|
|
|
3774
2856
|
/**
|
|
3775
2857
|
* List Organization Invoices
|
|
2858
|
+
*
|
|
3776
2859
|
* List payment history and invoices for an organization.
|
|
3777
2860
|
*
|
|
3778
2861
|
* Returns past invoices with payment status, amounts, and line items.
|
|
@@ -3781,25 +2864,15 @@ export const cancelOrgSubscription = <ThrowOnError extends boolean = false>(opti
|
|
|
3781
2864
|
* - User must be a member of the organization
|
|
3782
2865
|
* - Full invoice details are only visible to owners and admins
|
|
3783
2866
|
*/
|
|
3784
|
-
export const listOrgInvoices = <ThrowOnError extends boolean = false>(options: Options<ListOrgInvoicesData, ThrowOnError>) => {
|
|
3785
|
-
|
|
3786
|
-
|
|
3787
|
-
|
|
3788
|
-
|
|
3789
|
-
type: 'apiKey'
|
|
3790
|
-
},
|
|
3791
|
-
{
|
|
3792
|
-
scheme: 'bearer',
|
|
3793
|
-
type: 'http'
|
|
3794
|
-
}
|
|
3795
|
-
],
|
|
3796
|
-
url: '/v1/billing/invoices/{org_id}',
|
|
3797
|
-
...options
|
|
3798
|
-
});
|
|
3799
|
-
};
|
|
2867
|
+
export const listOrgInvoices = <ThrowOnError extends boolean = false>(options: Options<ListOrgInvoicesData, ThrowOnError>) => (options.client ?? client).get<ListOrgInvoicesResponses, ListOrgInvoicesErrors, ThrowOnError>({
|
|
2868
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2869
|
+
url: '/v1/billing/invoices/{org_id}',
|
|
2870
|
+
...options
|
|
2871
|
+
});
|
|
3800
2872
|
|
|
3801
2873
|
/**
|
|
3802
2874
|
* Get Organization Upcoming Invoice
|
|
2875
|
+
*
|
|
3803
2876
|
* Get preview of the next invoice for an organization.
|
|
3804
2877
|
*
|
|
3805
2878
|
* Returns estimated charges for the next billing period.
|
|
@@ -3808,25 +2881,15 @@ export const listOrgInvoices = <ThrowOnError extends boolean = false>(options: O
|
|
|
3808
2881
|
* - User must be a member of the organization
|
|
3809
2882
|
* - Full invoice details are only visible to owners and admins
|
|
3810
2883
|
*/
|
|
3811
|
-
export const getOrgUpcomingInvoice = <ThrowOnError extends boolean = false>(options: Options<GetOrgUpcomingInvoiceData, ThrowOnError>) => {
|
|
3812
|
-
|
|
3813
|
-
|
|
3814
|
-
|
|
3815
|
-
|
|
3816
|
-
type: 'apiKey'
|
|
3817
|
-
},
|
|
3818
|
-
{
|
|
3819
|
-
scheme: 'bearer',
|
|
3820
|
-
type: 'http'
|
|
3821
|
-
}
|
|
3822
|
-
],
|
|
3823
|
-
url: '/v1/billing/invoices/{org_id}/upcoming',
|
|
3824
|
-
...options
|
|
3825
|
-
});
|
|
3826
|
-
};
|
|
2884
|
+
export const getOrgUpcomingInvoice = <ThrowOnError extends boolean = false>(options: Options<GetOrgUpcomingInvoiceData, ThrowOnError>) => (options.client ?? client).get<GetOrgUpcomingInvoiceResponses, GetOrgUpcomingInvoiceErrors, ThrowOnError>({
|
|
2885
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2886
|
+
url: '/v1/billing/invoices/{org_id}/upcoming',
|
|
2887
|
+
...options
|
|
2888
|
+
});
|
|
3827
2889
|
|
|
3828
2890
|
/**
|
|
3829
2891
|
* Create Payment Checkout Session
|
|
2892
|
+
*
|
|
3830
2893
|
* Create a Stripe checkout session for collecting payment method.
|
|
3831
2894
|
*
|
|
3832
2895
|
* This endpoint is used when an organization owner needs to add a payment method before
|
|
@@ -3845,29 +2908,19 @@ export const getOrgUpcomingInvoice = <ThrowOnError extends boolean = false>(opti
|
|
|
3845
2908
|
* - User must be an OWNER of their organization
|
|
3846
2909
|
* - Enterprise customers (with invoice_billing_enabled) should not call this endpoint.
|
|
3847
2910
|
*/
|
|
3848
|
-
export const createCheckoutSession = <ThrowOnError extends boolean = false>(options: Options<CreateCheckoutSessionData, ThrowOnError>) => {
|
|
3849
|
-
|
|
3850
|
-
|
|
3851
|
-
|
|
3852
|
-
|
|
3853
|
-
|
|
3854
|
-
|
|
3855
|
-
|
|
3856
|
-
|
|
3857
|
-
type: 'http'
|
|
3858
|
-
}
|
|
3859
|
-
],
|
|
3860
|
-
url: '/v1/billing/checkout',
|
|
3861
|
-
...options,
|
|
3862
|
-
headers: {
|
|
3863
|
-
'Content-Type': 'application/json',
|
|
3864
|
-
...options.headers
|
|
3865
|
-
}
|
|
3866
|
-
});
|
|
3867
|
-
};
|
|
2911
|
+
export const createCheckoutSession = <ThrowOnError extends boolean = false>(options: Options<CreateCheckoutSessionData, ThrowOnError>) => (options.client ?? client).post<CreateCheckoutSessionResponses, CreateCheckoutSessionErrors, ThrowOnError>({
|
|
2912
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2913
|
+
url: '/v1/billing/checkout',
|
|
2914
|
+
...options,
|
|
2915
|
+
headers: {
|
|
2916
|
+
'Content-Type': 'application/json',
|
|
2917
|
+
...options.headers
|
|
2918
|
+
}
|
|
2919
|
+
});
|
|
3868
2920
|
|
|
3869
2921
|
/**
|
|
3870
2922
|
* Get Checkout Session Status
|
|
2923
|
+
*
|
|
3871
2924
|
* Poll the status of a checkout session.
|
|
3872
2925
|
*
|
|
3873
2926
|
* Frontend should poll this endpoint after user returns from Stripe Checkout
|
|
@@ -3883,19 +2936,8 @@ export const createCheckoutSession = <ThrowOnError extends boolean = false>(opti
|
|
|
3883
2936
|
* - For graphs: `resource_id` will be the graph_id, and `operation_id` can be used to monitor SSE progress
|
|
3884
2937
|
* - For repositories: `resource_id` will be the repository name and access is immediately available
|
|
3885
2938
|
*/
|
|
3886
|
-
export const getCheckoutStatus = <ThrowOnError extends boolean = false>(options: Options<GetCheckoutStatusData, ThrowOnError>) => {
|
|
3887
|
-
|
|
3888
|
-
|
|
3889
|
-
|
|
3890
|
-
|
|
3891
|
-
type: 'apiKey'
|
|
3892
|
-
},
|
|
3893
|
-
{
|
|
3894
|
-
scheme: 'bearer',
|
|
3895
|
-
type: 'http'
|
|
3896
|
-
}
|
|
3897
|
-
],
|
|
3898
|
-
url: '/v1/billing/checkout/{session_id}/status',
|
|
3899
|
-
...options
|
|
3900
|
-
});
|
|
3901
|
-
};
|
|
2939
|
+
export const getCheckoutStatus = <ThrowOnError extends boolean = false>(options: Options<GetCheckoutStatusData, ThrowOnError>) => (options.client ?? client).get<GetCheckoutStatusResponses, GetCheckoutStatusErrors, ThrowOnError>({
|
|
2940
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2941
|
+
url: '/v1/billing/checkout/{session_id}/status',
|
|
2942
|
+
...options
|
|
2943
|
+
});
|