@robosystems/client 0.2.10 → 0.2.11
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/package.json +1 -1
- package/sdk/sdk.gen.d.ts +149 -60
- package/sdk/sdk.gen.js +372 -106
- package/sdk/sdk.gen.ts +361 -96
- package/sdk/types.gen.d.ts +760 -173
- package/sdk/types.gen.ts +829 -174
- package/sdk.gen.d.ts +149 -60
- package/sdk.gen.js +372 -106
- package/sdk.gen.ts +361 -96
- package/types.gen.d.ts +760 -173
- package/types.gen.ts +829 -174
package/package.json
CHANGED
package/sdk/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Options as ClientOptions, TDataShape, Client } from './client';
|
|
2
|
-
import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshAuthSessionData, RefreshAuthSessionResponses, RefreshAuthSessionErrors, ResendVerificationEmailData, ResendVerificationEmailResponses, ResendVerificationEmailErrors, VerifyEmailData, VerifyEmailResponses, VerifyEmailErrors, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ForgotPasswordData, ForgotPasswordResponses, ForgotPasswordErrors, ValidateResetTokenData, ValidateResetTokenResponses, ValidateResetTokenErrors, ResetPasswordData, ResetPasswordResponses, ResetPasswordErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, UpdateUserData, UpdateUserResponses, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors,
|
|
2
|
+
import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshAuthSessionData, RefreshAuthSessionResponses, RefreshAuthSessionErrors, ResendVerificationEmailData, ResendVerificationEmailResponses, ResendVerificationEmailErrors, VerifyEmailData, VerifyEmailResponses, VerifyEmailErrors, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ForgotPasswordData, ForgotPasswordResponses, ForgotPasswordErrors, ValidateResetTokenData, ValidateResetTokenResponses, ValidateResetTokenErrors, ResetPasswordData, ResetPasswordResponses, ResetPasswordErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, UpdateUserData, UpdateUserResponses, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, ListUserOrgsData, ListUserOrgsResponses, CreateOrgData, CreateOrgResponses, CreateOrgErrors, GetOrgData, GetOrgResponses, GetOrgErrors, UpdateOrgData, UpdateOrgResponses, UpdateOrgErrors, ListOrgGraphsData, ListOrgGraphsResponses, ListOrgGraphsErrors, ListOrgMembersData, ListOrgMembersResponses, ListOrgMembersErrors, InviteOrgMemberData, InviteOrgMemberResponses, InviteOrgMemberErrors, RemoveOrgMemberData, RemoveOrgMemberResponses, RemoveOrgMemberErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, GetOrgLimitsData, GetOrgLimitsResponses, GetOrgLimitsErrors, GetOrgUsageData, GetOrgUsageResponses, GetOrgUsageErrors, ListConnectionsData, ListConnectionsResponses, ListConnectionsErrors, CreateConnectionData, CreateConnectionResponses, CreateConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsResponses, GetConnectionOptionsErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, AutoSelectAgentData, AutoSelectAgentResponses, AutoSelectAgentErrors, ExecuteSpecificAgentData, ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, BatchProcessQueriesData, BatchProcessQueriesResponses, BatchProcessQueriesErrors, ListAgentsData, ListAgentsResponses, ListAgentsErrors, GetAgentMetadataData, GetAgentMetadataResponses, GetAgentMetadataErrors, RecommendAgentData, RecommendAgentResponses, RecommendAgentErrors, ListMcpToolsData, ListMcpToolsResponses, ListMcpToolsErrors, CallMcpToolData, CallMcpToolResponses, CallMcpToolErrors, ListBackupsData, ListBackupsResponses, ListBackupsErrors, CreateBackupData, CreateBackupResponses, CreateBackupErrors, GetBackupDownloadUrlData, GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, RestoreBackupData, RestoreBackupResponses, RestoreBackupErrors, GetBackupStatsData, GetBackupStatsResponses, GetBackupStatsErrors, GetGraphMetricsData, GetGraphMetricsResponses, GetGraphMetricsErrors, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsResponses, GetGraphUsageAnalyticsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaData, GetGraphSchemaResponses, GetGraphSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, GetCreditSummaryData, GetCreditSummaryResponses, GetCreditSummaryErrors, ListCreditTransactionsData, ListCreditTransactionsResponses, ListCreditTransactionsErrors, CheckCreditBalanceData, CheckCreditBalanceResponses, CheckCreditBalanceErrors, GetStorageUsageData, GetStorageUsageResponses, GetStorageUsageErrors, CheckStorageLimitsData, CheckStorageLimitsResponses, CheckStorageLimitsErrors, GetDatabaseHealthData, GetDatabaseHealthResponses, GetDatabaseHealthErrors, GetDatabaseInfoData, GetDatabaseInfoResponses, GetDatabaseInfoErrors, GetGraphLimitsData, GetGraphLimitsResponses, GetGraphLimitsErrors, ListSubgraphsData, ListSubgraphsResponses, ListSubgraphsErrors, CreateSubgraphData, CreateSubgraphResponses, CreateSubgraphErrors, DeleteSubgraphData, DeleteSubgraphResponses, DeleteSubgraphErrors, GetSubgraphInfoData, GetSubgraphInfoResponses, GetSubgraphInfoErrors, GetSubgraphQuotaData, GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, CancelSubscriptionData, CancelSubscriptionResponses, CancelSubscriptionErrors, GetGraphSubscriptionData, GetGraphSubscriptionResponses, GetGraphSubscriptionErrors, CreateRepositorySubscriptionData, CreateRepositorySubscriptionResponses, CreateRepositorySubscriptionErrors, UpgradeSubscriptionData, UpgradeSubscriptionResponses, UpgradeSubscriptionErrors, ListTablesData, ListTablesResponses, ListTablesErrors, ListTableFilesData, ListTableFilesResponses, ListTableFilesErrors, GetUploadUrlData, GetUploadUrlResponses, GetUploadUrlErrors, DeleteFileData, DeleteFileResponses, DeleteFileErrors, GetFileInfoData, GetFileInfoResponses, GetFileInfoErrors, UpdateFileStatusData, UpdateFileStatusResponses, UpdateFileStatusErrors, IngestTablesData, IngestTablesResponses, IngestTablesErrors, QueryTablesData, QueryTablesResponses, QueryTablesErrors, GetGraphsData, GetGraphsResponses, GetGraphsErrors, CreateGraphData, CreateGraphResponses, CreateGraphErrors, GetAvailableExtensionsData, GetAvailableExtensionsResponses, GetAvailableExtensionsErrors, GetAvailableGraphTiersData, GetAvailableGraphTiersResponses, GetAvailableGraphTiersErrors, SelectGraphData, SelectGraphResponses, SelectGraphErrors, GetServiceOfferingsData, GetServiceOfferingsResponses, GetServiceOfferingsErrors, StreamOperationEventsData, StreamOperationEventsResponses, StreamOperationEventsErrors, GetOperationStatusData, GetOperationStatusResponses, GetOperationStatusErrors, CancelOperationData, CancelOperationResponses, CancelOperationErrors, GetOrgBillingCustomerData, GetOrgBillingCustomerResponses, GetOrgBillingCustomerErrors, UpdateOrgPaymentMethodData, UpdateOrgPaymentMethodResponses, UpdateOrgPaymentMethodErrors, ListOrgSubscriptionsData, ListOrgSubscriptionsResponses, ListOrgSubscriptionsErrors, GetOrgSubscriptionData, GetOrgSubscriptionResponses, GetOrgSubscriptionErrors, CancelOrgSubscriptionData, CancelOrgSubscriptionResponses, CancelOrgSubscriptionErrors, ListOrgInvoicesData, ListOrgInvoicesResponses, ListOrgInvoicesErrors, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceResponses, GetOrgUpcomingInvoiceErrors, CreateCheckoutSessionData, CreateCheckoutSessionResponses, CreateCheckoutSessionErrors, GetCheckoutStatusData, GetCheckoutStatusResponses, GetCheckoutStatusErrors } from './types.gen';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -15,7 +15,11 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
15
15
|
};
|
|
16
16
|
/**
|
|
17
17
|
* Register New User
|
|
18
|
-
* Register a new user account with email and password.
|
|
18
|
+
* Register a new user account with email and password.
|
|
19
|
+
*
|
|
20
|
+
* **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.
|
|
21
|
+
*
|
|
22
|
+
* **Security Controls**: CAPTCHA and email verification are disabled in development for API testing, but required in production.
|
|
19
23
|
*/
|
|
20
24
|
export declare const registerUser: <ThrowOnError extends boolean = false>(options: Options<RegisterUserData, ThrowOnError>) => import("./client").RequestResult<RegisterUserResponses, RegisterUserErrors, ThrowOnError, "fields">;
|
|
21
25
|
/**
|
|
@@ -134,10 +138,63 @@ export declare const revokeUserApiKey: <ThrowOnError extends boolean = false>(op
|
|
|
134
138
|
*/
|
|
135
139
|
export declare const updateUserApiKey: <ThrowOnError extends boolean = false>(options: Options<UpdateUserApiKeyData, ThrowOnError>) => import("./client").RequestResult<UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, ThrowOnError, "fields">;
|
|
136
140
|
/**
|
|
137
|
-
*
|
|
138
|
-
*
|
|
141
|
+
* List User's Organizations
|
|
142
|
+
* Get all organizations the current user belongs to, with their role in each.
|
|
143
|
+
*/
|
|
144
|
+
export declare const listUserOrgs: <ThrowOnError extends boolean = false>(options?: Options<ListUserOrgsData, ThrowOnError>) => import("./client").RequestResult<ListUserOrgsResponses, unknown, ThrowOnError, "fields">;
|
|
145
|
+
/**
|
|
146
|
+
* Create Organization
|
|
147
|
+
* Create a new organization. The creating user becomes the owner.
|
|
148
|
+
*/
|
|
149
|
+
export declare const createOrg: <ThrowOnError extends boolean = false>(options: Options<CreateOrgData, ThrowOnError>) => import("./client").RequestResult<CreateOrgResponses, CreateOrgErrors, ThrowOnError, "fields">;
|
|
150
|
+
/**
|
|
151
|
+
* Get Organization
|
|
152
|
+
* Get detailed information about an organization.
|
|
153
|
+
*/
|
|
154
|
+
export declare const getOrg: <ThrowOnError extends boolean = false>(options: Options<GetOrgData, ThrowOnError>) => import("./client").RequestResult<GetOrgResponses, GetOrgErrors, ThrowOnError, "fields">;
|
|
155
|
+
/**
|
|
156
|
+
* Update Organization
|
|
157
|
+
* Update organization information. Requires admin or owner role.
|
|
158
|
+
*/
|
|
159
|
+
export declare const updateOrg: <ThrowOnError extends boolean = false>(options: Options<UpdateOrgData, ThrowOnError>) => import("./client").RequestResult<UpdateOrgResponses, UpdateOrgErrors, ThrowOnError, "fields">;
|
|
160
|
+
/**
|
|
161
|
+
* List Organization Graphs
|
|
162
|
+
* Get all graphs belonging to an organization.
|
|
163
|
+
*/
|
|
164
|
+
export declare const listOrgGraphs: <ThrowOnError extends boolean = false>(options: Options<ListOrgGraphsData, ThrowOnError>) => import("./client").RequestResult<ListOrgGraphsResponses, ListOrgGraphsErrors, ThrowOnError, "fields">;
|
|
165
|
+
/**
|
|
166
|
+
* List Organization Members
|
|
167
|
+
* Get all members of an organization with their roles.
|
|
139
168
|
*/
|
|
140
|
-
export declare const
|
|
169
|
+
export declare const listOrgMembers: <ThrowOnError extends boolean = false>(options: Options<ListOrgMembersData, ThrowOnError>) => import("./client").RequestResult<ListOrgMembersResponses, ListOrgMembersErrors, ThrowOnError, "fields">;
|
|
170
|
+
/**
|
|
171
|
+
* Invite Member
|
|
172
|
+
* Invite a user to join the organization. Requires admin or owner role.
|
|
173
|
+
*
|
|
174
|
+
* **⚠️ FEATURE NOT READY**: This endpoint is disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false).
|
|
175
|
+
* Returns 501 NOT IMPLEMENTED when disabled. See endpoint implementation for TODO list before enabling.
|
|
176
|
+
*/
|
|
177
|
+
export declare const inviteOrgMember: <ThrowOnError extends boolean = false>(options: Options<InviteOrgMemberData, ThrowOnError>) => import("./client").RequestResult<InviteOrgMemberResponses, InviteOrgMemberErrors, ThrowOnError, "fields">;
|
|
178
|
+
/**
|
|
179
|
+
* Remove Member
|
|
180
|
+
* Remove a member from the organization. Requires admin or owner role.
|
|
181
|
+
*/
|
|
182
|
+
export declare const removeOrgMember: <ThrowOnError extends boolean = false>(options: Options<RemoveOrgMemberData, ThrowOnError>) => import("./client").RequestResult<RemoveOrgMemberResponses, RemoveOrgMemberErrors, ThrowOnError, "fields">;
|
|
183
|
+
/**
|
|
184
|
+
* Update Member Role
|
|
185
|
+
* Update a member's role in the organization. Requires admin or owner role.
|
|
186
|
+
*/
|
|
187
|
+
export declare const updateOrgMemberRole: <ThrowOnError extends boolean = false>(options: Options<UpdateOrgMemberRoleData, ThrowOnError>) => import("./client").RequestResult<UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, ThrowOnError, "fields">;
|
|
188
|
+
/**
|
|
189
|
+
* Get Organization Limits
|
|
190
|
+
* Get the current limits and quotas for an organization.
|
|
191
|
+
*/
|
|
192
|
+
export declare const getOrgLimits: <ThrowOnError extends boolean = false>(options: Options<GetOrgLimitsData, ThrowOnError>) => import("./client").RequestResult<GetOrgLimitsResponses, GetOrgLimitsErrors, ThrowOnError, "fields">;
|
|
193
|
+
/**
|
|
194
|
+
* Get Organization Usage
|
|
195
|
+
* Get detailed usage statistics for an organization aggregated across all graphs.
|
|
196
|
+
*/
|
|
197
|
+
export declare const getOrgUsage: <ThrowOnError extends boolean = false>(options: Options<GetOrgUsageData, ThrowOnError>) => import("./client").RequestResult<GetOrgUsageResponses, GetOrgUsageErrors, ThrowOnError, "fields">;
|
|
141
198
|
/**
|
|
142
199
|
* List Connections
|
|
143
200
|
* List all data connections in the graph.
|
|
@@ -687,7 +744,7 @@ export declare const getBackupStats: <ThrowOnError extends boolean = false>(opti
|
|
|
687
744
|
export declare const getGraphMetrics: <ThrowOnError extends boolean = false>(options: Options<GetGraphMetricsData, ThrowOnError>) => import("./client").RequestResult<GetGraphMetricsResponses, GetGraphMetricsErrors, ThrowOnError, "fields">;
|
|
688
745
|
/**
|
|
689
746
|
* Get Graph Usage Analytics
|
|
690
|
-
* Get comprehensive usage analytics tracked by the
|
|
747
|
+
* Get comprehensive usage analytics tracked by the GraphUsage model.
|
|
691
748
|
*
|
|
692
749
|
* Provides temporal usage patterns including:
|
|
693
750
|
* - **Storage Analytics**: GB-hours for billing, breakdown by type (files, tables, graphs, subgraphs)
|
|
@@ -1706,9 +1763,15 @@ export declare const selectGraph: <ThrowOnError extends boolean = false>(options
|
|
|
1706
1763
|
* and shared repository subscriptions. This is the primary endpoint for frontend
|
|
1707
1764
|
* applications to display subscription options.
|
|
1708
1765
|
*
|
|
1766
|
+
* **Pricing Model:**
|
|
1767
|
+
* - Graph subscriptions are **per-graph** with infrastructure-based pricing
|
|
1768
|
+
* - Each graph you create has its own monthly subscription
|
|
1769
|
+
* - Organizations can have multiple graphs with different infrastructure tiers
|
|
1770
|
+
* - Credits are allocated per-graph, not shared across organization
|
|
1771
|
+
*
|
|
1709
1772
|
* Includes:
|
|
1710
|
-
* - Graph
|
|
1711
|
-
* - Shared repository subscriptions (SEC, industry, economic data)
|
|
1773
|
+
* - Graph infrastructure tiers (kuzu-standard, kuzu-large, kuzu-xlarge) - per-graph pricing
|
|
1774
|
+
* - Shared repository subscriptions (SEC, industry, economic data) - org-level
|
|
1712
1775
|
* - Operation costs and credit information
|
|
1713
1776
|
* - Features and capabilities for each tier
|
|
1714
1777
|
* - Enabled/disabled status for repositories
|
|
@@ -1799,23 +1862,96 @@ export declare const getOperationStatus: <ThrowOnError extends boolean = false>(
|
|
|
1799
1862
|
* **No credits are consumed for cancellation requests.**
|
|
1800
1863
|
*/
|
|
1801
1864
|
export declare const cancelOperation: <ThrowOnError extends boolean = false>(options: Options<CancelOperationData, ThrowOnError>) => import("./client").RequestResult<CancelOperationResponses, CancelOperationErrors, ThrowOnError, "fields">;
|
|
1865
|
+
/**
|
|
1866
|
+
* Get Organization Customer Info
|
|
1867
|
+
* Get billing customer information for an organization including payment methods on file.
|
|
1868
|
+
*
|
|
1869
|
+
* Returns customer details, payment methods, and whether invoice billing is enabled.
|
|
1870
|
+
*
|
|
1871
|
+
* **Requirements:**
|
|
1872
|
+
* - User must be a member of the organization
|
|
1873
|
+
* - Sensitive payment details are only visible to owners
|
|
1874
|
+
*/
|
|
1875
|
+
export declare const getOrgBillingCustomer: <ThrowOnError extends boolean = false>(options: Options<GetOrgBillingCustomerData, ThrowOnError>) => import("./client").RequestResult<GetOrgBillingCustomerResponses, GetOrgBillingCustomerErrors, ThrowOnError, "fields">;
|
|
1876
|
+
/**
|
|
1877
|
+
* Update Organization Default Payment Method
|
|
1878
|
+
* Update the default payment method for the organization.
|
|
1879
|
+
*
|
|
1880
|
+
* This changes which payment method will be used for future subscription charges.
|
|
1881
|
+
*
|
|
1882
|
+
* **Requirements:**
|
|
1883
|
+
* - User must be an OWNER of the organization
|
|
1884
|
+
*/
|
|
1885
|
+
export declare const updateOrgPaymentMethod: <ThrowOnError extends boolean = false>(options: Options<UpdateOrgPaymentMethodData, ThrowOnError>) => import("./client").RequestResult<UpdateOrgPaymentMethodResponses, UpdateOrgPaymentMethodErrors, ThrowOnError, "fields">;
|
|
1886
|
+
/**
|
|
1887
|
+
* List Organization Subscriptions
|
|
1888
|
+
* List all active and past subscriptions for an organization.
|
|
1889
|
+
*
|
|
1890
|
+
* Includes both graph and repository subscriptions with their status, pricing, and billing information.
|
|
1891
|
+
*
|
|
1892
|
+
* **Requirements:**
|
|
1893
|
+
* - User must be a member of the organization
|
|
1894
|
+
*/
|
|
1895
|
+
export declare const listOrgSubscriptions: <ThrowOnError extends boolean = false>(options: Options<ListOrgSubscriptionsData, ThrowOnError>) => import("./client").RequestResult<ListOrgSubscriptionsResponses, ListOrgSubscriptionsErrors, ThrowOnError, "fields">;
|
|
1896
|
+
/**
|
|
1897
|
+
* Get Organization Subscription Details
|
|
1898
|
+
* Get detailed information about a specific subscription.
|
|
1899
|
+
*
|
|
1900
|
+
* **Requirements:**
|
|
1901
|
+
* - User must be a member of the organization
|
|
1902
|
+
*/
|
|
1903
|
+
export declare const getOrgSubscription: <ThrowOnError extends boolean = false>(options: Options<GetOrgSubscriptionData, ThrowOnError>) => import("./client").RequestResult<GetOrgSubscriptionResponses, GetOrgSubscriptionErrors, ThrowOnError, "fields">;
|
|
1904
|
+
/**
|
|
1905
|
+
* Cancel Organization Subscription
|
|
1906
|
+
* Cancel an organization subscription.
|
|
1907
|
+
*
|
|
1908
|
+
* The subscription will remain active until the end of the current billing period.
|
|
1909
|
+
*
|
|
1910
|
+
* **Requirements:**
|
|
1911
|
+
* - User must be an OWNER of the organization
|
|
1912
|
+
*/
|
|
1913
|
+
export declare const cancelOrgSubscription: <ThrowOnError extends boolean = false>(options: Options<CancelOrgSubscriptionData, ThrowOnError>) => import("./client").RequestResult<CancelOrgSubscriptionResponses, CancelOrgSubscriptionErrors, ThrowOnError, "fields">;
|
|
1914
|
+
/**
|
|
1915
|
+
* List Organization Invoices
|
|
1916
|
+
* List payment history and invoices for an organization.
|
|
1917
|
+
*
|
|
1918
|
+
* Returns past invoices with payment status, amounts, and line items.
|
|
1919
|
+
*
|
|
1920
|
+
* **Requirements:**
|
|
1921
|
+
* - User must be a member of the organization
|
|
1922
|
+
* - Full invoice details are only visible to owners and admins
|
|
1923
|
+
*/
|
|
1924
|
+
export declare const listOrgInvoices: <ThrowOnError extends boolean = false>(options: Options<ListOrgInvoicesData, ThrowOnError>) => import("./client").RequestResult<ListOrgInvoicesResponses, ListOrgInvoicesErrors, ThrowOnError, "fields">;
|
|
1925
|
+
/**
|
|
1926
|
+
* Get Organization Upcoming Invoice
|
|
1927
|
+
* Get preview of the next invoice for an organization.
|
|
1928
|
+
*
|
|
1929
|
+
* Returns estimated charges for the next billing period.
|
|
1930
|
+
*
|
|
1931
|
+
* **Requirements:**
|
|
1932
|
+
* - User must be a member of the organization
|
|
1933
|
+
* - Full invoice details are only visible to owners and admins
|
|
1934
|
+
*/
|
|
1935
|
+
export declare const getOrgUpcomingInvoice: <ThrowOnError extends boolean = false>(options: Options<GetOrgUpcomingInvoiceData, ThrowOnError>) => import("./client").RequestResult<GetOrgUpcomingInvoiceResponses, GetOrgUpcomingInvoiceErrors, ThrowOnError, "fields">;
|
|
1802
1936
|
/**
|
|
1803
1937
|
* Create Payment Checkout Session
|
|
1804
1938
|
* Create a Stripe checkout session for collecting payment method.
|
|
1805
1939
|
*
|
|
1806
|
-
* This endpoint is used when
|
|
1940
|
+
* This endpoint is used when an organization owner needs to add a payment method before
|
|
1807
1941
|
* provisioning resources. It creates a pending subscription and redirects
|
|
1808
|
-
*
|
|
1942
|
+
* to Stripe Checkout to collect payment details.
|
|
1809
1943
|
*
|
|
1810
1944
|
* **Flow:**
|
|
1811
|
-
* 1.
|
|
1945
|
+
* 1. Owner tries to create a graph but org has no payment method
|
|
1812
1946
|
* 2. Frontend calls this endpoint with graph configuration
|
|
1813
|
-
* 3. Backend creates a subscription in PENDING_PAYMENT status
|
|
1947
|
+
* 3. Backend creates a subscription in PENDING_PAYMENT status for the user's org
|
|
1814
1948
|
* 4. Returns Stripe Checkout URL
|
|
1815
1949
|
* 5. User completes payment on Stripe
|
|
1816
1950
|
* 6. Webhook activates subscription and provisions resource
|
|
1817
1951
|
*
|
|
1818
|
-
* **
|
|
1952
|
+
* **Requirements:**
|
|
1953
|
+
* - User must be an OWNER of their organization
|
|
1954
|
+
* - Enterprise customers (with invoice_billing_enabled) should not call this endpoint.
|
|
1819
1955
|
*/
|
|
1820
1956
|
export declare const createCheckoutSession: <ThrowOnError extends boolean = false>(options: Options<CreateCheckoutSessionData, ThrowOnError>) => import("./client").RequestResult<CreateCheckoutSessionResponses, CreateCheckoutSessionErrors, ThrowOnError, "fields">;
|
|
1821
1957
|
/**
|
|
@@ -1836,50 +1972,3 @@ export declare const createCheckoutSession: <ThrowOnError extends boolean = fals
|
|
|
1836
1972
|
* - For repositories: `resource_id` will be the repository name and access is immediately available
|
|
1837
1973
|
*/
|
|
1838
1974
|
export declare const getCheckoutStatus: <ThrowOnError extends boolean = false>(options: Options<GetCheckoutStatusData, ThrowOnError>) => import("./client").RequestResult<GetCheckoutStatusResponses, GetCheckoutStatusErrors, ThrowOnError, "fields">;
|
|
1839
|
-
/**
|
|
1840
|
-
* Get Customer Info
|
|
1841
|
-
* Get billing customer information including payment methods on file.
|
|
1842
|
-
*
|
|
1843
|
-
* Returns customer details, payment methods, and whether invoice billing is enabled.
|
|
1844
|
-
*/
|
|
1845
|
-
export declare const getBillingCustomer: <ThrowOnError extends boolean = false>(options?: Options<GetBillingCustomerData, ThrowOnError>) => import("./client").RequestResult<GetBillingCustomerResponses, unknown, ThrowOnError, "fields">;
|
|
1846
|
-
/**
|
|
1847
|
-
* Update Default Payment Method
|
|
1848
|
-
* Update the default payment method for the customer.
|
|
1849
|
-
*
|
|
1850
|
-
* This changes which payment method will be used for future subscription charges.
|
|
1851
|
-
*/
|
|
1852
|
-
export declare const updatePaymentMethod: <ThrowOnError extends boolean = false>(options: Options<UpdatePaymentMethodData, ThrowOnError>) => import("./client").RequestResult<UpdatePaymentMethodResponses, UpdatePaymentMethodErrors, ThrowOnError, "fields">;
|
|
1853
|
-
/**
|
|
1854
|
-
* List Invoices
|
|
1855
|
-
* List payment history and invoices.
|
|
1856
|
-
*
|
|
1857
|
-
* Returns past invoices with payment status, amounts, and line items.
|
|
1858
|
-
*/
|
|
1859
|
-
export declare const listInvoices: <ThrowOnError extends boolean = false>(options?: Options<ListInvoicesData, ThrowOnError>) => import("./client").RequestResult<ListInvoicesResponses, ListInvoicesErrors, ThrowOnError, "fields">;
|
|
1860
|
-
/**
|
|
1861
|
-
* Get Upcoming Invoice
|
|
1862
|
-
* Get preview of the next invoice.
|
|
1863
|
-
*
|
|
1864
|
-
* Returns estimated charges for the next billing period.
|
|
1865
|
-
*/
|
|
1866
|
-
export declare const getUpcomingInvoice: <ThrowOnError extends boolean = false>(options?: Options<GetUpcomingInvoiceData, ThrowOnError>) => import("./client").RequestResult<GetUpcomingInvoiceResponses, unknown, ThrowOnError, "fields">;
|
|
1867
|
-
/**
|
|
1868
|
-
* List All Subscriptions
|
|
1869
|
-
* List all active and past subscriptions for the user.
|
|
1870
|
-
*
|
|
1871
|
-
* Includes both graph and repository subscriptions with their status, pricing, and billing information.
|
|
1872
|
-
*/
|
|
1873
|
-
export declare const listSubscriptions: <ThrowOnError extends boolean = false>(options?: Options<ListSubscriptionsData, ThrowOnError>) => import("./client").RequestResult<ListSubscriptionsResponses, unknown, ThrowOnError, "fields">;
|
|
1874
|
-
/**
|
|
1875
|
-
* Get Subscription Details
|
|
1876
|
-
* Get detailed information about a specific subscription.
|
|
1877
|
-
*/
|
|
1878
|
-
export declare const getSubscription: <ThrowOnError extends boolean = false>(options: Options<GetSubscriptionData, ThrowOnError>) => import("./client").RequestResult<GetSubscriptionResponses, GetSubscriptionErrors, ThrowOnError, "fields">;
|
|
1879
|
-
/**
|
|
1880
|
-
* Cancel Subscription
|
|
1881
|
-
* Cancel a subscription.
|
|
1882
|
-
*
|
|
1883
|
-
* The subscription will remain active until the end of the current billing period.
|
|
1884
|
-
*/
|
|
1885
|
-
export declare const cancelSubscription2: <ThrowOnError extends boolean = false>(options: Options<CancelSubscription2Data, ThrowOnError>) => import("./client").RequestResult<CancelSubscription2Responses, CancelSubscription2Errors, ThrowOnError, "fields">;
|