@cubist-labs/cubesigner-sdk 0.4.254 → 0.4.260
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/package.json +1 -1
- package/dist/src/audit_log.d.ts +5 -5
- package/dist/src/client/api_client.d.ts +45 -3
- package/dist/src/client/api_client.d.ts.map +1 -1
- package/dist/src/client/api_client.js +70 -4
- package/dist/src/key.d.ts +5 -8
- package/dist/src/key.d.ts.map +1 -1
- package/dist/src/key.js +6 -2
- package/dist/src/org.d.ts +463 -25
- package/dist/src/org.d.ts.map +1 -1
- package/dist/src/org.js +66 -26
- package/dist/src/role.d.ts +41 -1
- package/dist/src/role.d.ts.map +1 -1
- package/dist/src/role.js +1 -1
- package/dist/src/schema.d.ts +941 -21
- package/dist/src/schema.d.ts.map +1 -1
- package/dist/src/schema.js +1 -1
- package/dist/src/schema_types.d.ts +7 -0
- package/dist/src/schema_types.d.ts.map +1 -1
- package/dist/src/schema_types.js +24 -3
- package/dist/src/scopes.d.ts.map +1 -1
- package/dist/src/scopes.js +12 -1
- package/package.json +1 -1
- package/src/client/api_client.ts +95 -4
- package/src/key.ts +8 -8
- package/src/org.ts +82 -28
- package/src/role.ts +47 -0
- package/src/schema.ts +1014 -20
- package/src/schema_types.ts +31 -2
- package/src/scopes.ts +11 -0
package/dist/src/schema.d.ts
CHANGED
|
@@ -880,6 +880,12 @@ export interface paths {
|
|
|
880
880
|
* but extends the output with an `id_token`.
|
|
881
881
|
*
|
|
882
882
|
* This `id_token` can then be used with any CubeSigner endpoint that requires an OIDC token.
|
|
883
|
+
* Callers must request *at least* scopes `tweet.read` and `users.read` during auth with twitter.
|
|
884
|
+
*
|
|
885
|
+
* By default, the id token does not contain a confirmed email;
|
|
886
|
+
* callers can request this field be populated by requesting the `users.email` scope
|
|
887
|
+
* and adding `fetch_email` as a URL parameter to this route.
|
|
888
|
+
*
|
|
883
889
|
*
|
|
884
890
|
* > [!IMPORTANT]
|
|
885
891
|
* > This endpoint will fail unless the org is configured to allow the issuer `https://shim.oauth2.cubist.dev/twitter` and client ID being used for Twitter.
|
|
@@ -943,6 +949,33 @@ export interface paths {
|
|
|
943
949
|
*/
|
|
944
950
|
patch: operations["siweComplete"];
|
|
945
951
|
};
|
|
952
|
+
"/v0/org/{org_id}/oidc/siws": {
|
|
953
|
+
/**
|
|
954
|
+
* Initiate login via Sign-in With Solana (SIWS).
|
|
955
|
+
* @description Initiate login via Sign-in With Solana (SIWS).
|
|
956
|
+
*
|
|
957
|
+
* This endpoint generates a challenge which can be answered (via the corresponding PATCH endpoint)
|
|
958
|
+
* to obtain an OIDC token. The OIDC token can then be exchanged for a user session via the standard
|
|
959
|
+
* OIDC auth route.
|
|
960
|
+
*
|
|
961
|
+
* > [!IMPORTANT]
|
|
962
|
+
* > For this endpoint to succeed, the org must be configured to:
|
|
963
|
+
* > Allow the issuer `https://shim.oauth2.cubist.dev/siws` with the Org ID as the client ID
|
|
964
|
+
*/
|
|
965
|
+
post: operations["siwsInit"];
|
|
966
|
+
/**
|
|
967
|
+
* Complete login via Sign-in With Solana (SIWS)
|
|
968
|
+
* @description Complete login via Sign-in With Solana (SIWS)
|
|
969
|
+
*
|
|
970
|
+
* If the challenge (issued by the corresponding POST endpoint) is answered correctly, this endpoint
|
|
971
|
+
* generates an OIDC token that can then be exchanged for a user session via the standard OIDC auth route.
|
|
972
|
+
*
|
|
973
|
+
* > [!IMPORTANT]
|
|
974
|
+
* > For this endpoint to succeed, the org must be configured to:
|
|
975
|
+
* > Allow the issuer `https://shim.oauth2.cubist.dev/siws` with the Org ID as the client ID
|
|
976
|
+
*/
|
|
977
|
+
patch: operations["siwsComplete"];
|
|
978
|
+
};
|
|
946
979
|
"/v0/org/{org_id}/oidc/telegram": {
|
|
947
980
|
/**
|
|
948
981
|
* Allows a user to authenticate with the telegram API using the tgWebAppData value
|
|
@@ -1306,6 +1339,13 @@ export interface paths {
|
|
|
1306
1339
|
*
|
|
1307
1340
|
* If a `role` query parameter is provided, **ALL** session for **THAT ROLE** are revoked
|
|
1308
1341
|
* (if the current user has permissions to revoke sessions for the role).
|
|
1342
|
+
*
|
|
1343
|
+
* If a `role_created_by` query parameter is provided, **ROLE** sessions created by **THAT USER**
|
|
1344
|
+
* are revoked (gated by the same permissions as revoking that user's own sessions: the current
|
|
1345
|
+
* user must be that user or an org owner). User sessions are not affected. Unless the current
|
|
1346
|
+
* user is an org owner, only sessions for roles the current user is **still a member of** are
|
|
1347
|
+
* revoked (so a user cannot revoke sessions for a role they have since been removed from); org
|
|
1348
|
+
* owners revoke across all roles.
|
|
1309
1349
|
*/
|
|
1310
1350
|
delete: operations["revokeSessions"];
|
|
1311
1351
|
};
|
|
@@ -1753,6 +1793,9 @@ export interface components {
|
|
|
1753
1793
|
{
|
|
1754
1794
|
BinanceDryRun: components["schemas"]["BinanceDryRunArgs"];
|
|
1755
1795
|
},
|
|
1796
|
+
{
|
|
1797
|
+
BybitDryRun: components["schemas"]["BybitDryRunArgs"];
|
|
1798
|
+
},
|
|
1756
1799
|
{
|
|
1757
1800
|
CoinbaseDryRun: components["schemas"]["CoinbaseDryRunArgs"];
|
|
1758
1801
|
},
|
|
@@ -1761,7 +1804,7 @@ export interface components {
|
|
|
1761
1804
|
}
|
|
1762
1805
|
]>;
|
|
1763
1806
|
/** @enum {string} */
|
|
1764
|
-
AcceptedValueCode: "SignDryRun" | "BinanceDryRun" | "CoinbaseDryRun" | "MfaRequired";
|
|
1807
|
+
AcceptedValueCode: "SignDryRun" | "BinanceDryRun" | "BybitDryRun" | "CoinbaseDryRun" | "MfaRequired";
|
|
1765
1808
|
/**
|
|
1766
1809
|
* @description Determines who controls the keys within an org
|
|
1767
1810
|
* @enum {string}
|
|
@@ -2774,7 +2817,7 @@ export interface components {
|
|
|
2774
2817
|
/** @enum {string} */
|
|
2775
2818
|
BadGatewayErrorCode: "Generic" | "CustomChainRpcError" | "EsploraApiError" | "SentryApiError" | "CallWebhookError" | "OAuthProviderError" | "OidcDisoveryFailed" | "OidcIssuerJwkEndpointUnavailable" | "SmtpServerUnavailable";
|
|
2776
2819
|
/** @enum {string} */
|
|
2777
|
-
BadRequestErrorCode: "GenericBadRequest" | "DisallowedAllowRuleReference" | "InvalidPaginationToken" | "InvalidEmail" | "InvalidEmailTemplate" | "QueryMetricsError" | "InvalidTelegramData" | "ValidationError" | "WebhookPolicyTimeoutOutOfBounds" | "WebhookPolicyDisallowedUrlScheme" | "WebhookPolicyDisallowedUrlHost" | "WebhookPolicyDisallowedHeaders" | "ReservedName" | "UserEmailNotConfigured" | "EmailPasswordNotFound" | "PasswordAuthNotAllowedByInvitation" | "OneTimeCodeExpired" | "InvalidBody" | "InvalidJwt" | "InvitationNoLongerValid" | "TokenRequestError" | "InvalidMfaReceipt" | "InvalidMfaPolicyCount" | "InvalidMfaPolicyNumAuthFactors" | "InvalidMfaPolicyNumAllowedApprovers" | "InvalidMfaPolicyGracePeriodTooLong" | "InvalidBabylonStakingPolicyParams" | "InvalidSuiTxReceiversEmptyAllowlist" | "InvalidBtcTxReceiversEmptyAllowlist" | "InvalidRequireRoleSessionAllowlist" | "InvalidCreateKeyCount" | "InvalidDiffieHellmanCount" | "OrgInviteExistingUser" | "OrgUserAlreadyExists" | "OrgNameTaken" | "KwkNotFoundInRegion" | "OrgIsNotOrgExport" | "RoleNameTaken" | "PolicyNameTaken" | "NameTaken" | "ContactNameInvalid" | "ContactAddressesInvalid" | "ContactLabelInvalid" | "ContactModified" | "PolicyNotFound" | "PolicyVersionNotFound" | "PolicyRuleDisallowedByType" | "PolicyTypeDisallowed" | "PolicyDuplicateError" | "PolicyStillAttached" | "PolicyModified" | "PolicyNotAttached" | "AddKeyToRoleCountTooHigh" | "InvalidKeyId" | "InvalidTimeLockAlreadyInThePast" | "InvalidRestrictedScopes" | "InvalidUpdate" | "InvalidMetadataLength" | "InvalidLength" | "InvalidKeyMaterialId" | "KeyNotFound" | "SiweChallengeNotFound" | "SiweInvalidRequest" | "UserExportDerivedKey" | "UserExportPublicKeyInvalid" | "NistP256PublicKeyInvalid" | "UnableToAccessSmtpRelay" | "UserExportInProgress" | "RoleNotFound" | "InvalidRoleNameOrId" | "InvalidMfaReceiptOrgIdMissing" | "InvalidMfaReceiptInvalidOrgId" | "MfaRequestNotFound" | "InvalidKeyType" | "InvalidPropertiesForKeyType" | "MismatchedKeyPropertiesPatch" | "MissingBinanceApiKey" | "MissingCoinbaseApiKey" | "BinanceKeyMasterMismatch" | "InvalidKeyMaterial" | "InvalidHexValue" | "InvalidBase32Value" | "InvalidBase58Value" | "InvalidBase64Value" | "InvalidSs58Value" | "InvalidForkVersionLength" | "InvalidEthAddress" | "InvalidStellarAddress" | "InvalidOrgNameOrId" | "InvalidUpdateOrgRequestDisallowedMfaType" | "InvalidUpdateOrgRequestEmptyAllowedMfaTypes" | "EmailOtpDelayTooShortForRegisterMfa" | "InvalidStakeDeposit" | "InvalidBlobSignRequest" | "InvalidDiffieHellmanRequest" | "InvalidSolanaSignRequest" | "InvalidEip712SignRequest" | "OnlySpecifyOne" | "NoOidcDataInProof" | "InvalidEvmSignRequest" | "InvalidEth2SignRequest" | "InvalidDeriveKeyRequest" | "InvalidStakingAmount" | "CustomStakingAmountNotAllowedForWrapperContract" | "InvalidUnstakeRequest" | "InvalidCreateUserRequest" | "UserAlreadyExists" | "IdpUserAlreadyExists" | "CognitoUserAlreadyOrgMember" | "UserNotFound" | "UserWithEmailNotFound" | "PolicyKeyMismatch" | "EmptyScopes" | "InvalidScopesForRoleSession" | "InvalidLifetime" | "NoSingleKeyForUser" | "InvalidOrgPolicyRule" | "SourceIpAllowlistEmpty" | "LimitWindowTooLong" | "Erc20ContractDisallowed" | "EmptyRuleError" | "OptionalListEmpty" | "MultipleExclusiveFieldsProvided" | "DuplicateFieldEntry" | "InvalidRange" | "InvalidOrgPolicyRepeatedRule" | "InvalidSuiTransaction" | "SuiSenderMismatch" | "AvaSignHashError" | "AvaSignError" | "BtcSegwitHashError" | "BtcTaprootHashError" | "BtcSignError" | "TaprootSignError" | "Eip712SignError" | "InvalidMemberRoleInUserAdd" | "InvalidMemberRoleInRecipientAdd" | "ThirdPartyUserAlreadyExists" | "OidcIdentityAlreadyExists" | "UserAlreadyHasIdentity" | "ThirdPartyUserNotFound" | "DeleteOidcUserError" | "DeleteUserError" | "SessionRoleMismatch" | "InvalidOidcToken" | "InvalidOidcIdentity" | "OidcIssuerUnsupported" | "OidcIssuerNotAllowed" | "OidcIssuerNoApplicableJwk" | "FidoKeyAlreadyRegistered" | "FidoKeySignCountTooLow" | "FidoVerificationFailed" | "FidoChallengeMfaMismatch" | "UnsupportedLegacyCognitoSession" | "InvalidIdentityProof" | "PaginationDataExpired" | "ExistingKeysViolateExclusiveKeyAccess" | "ExportDelayTooShort" | "ExportWindowTooLong" | "InvalidTotpFailureLimit" | "InvalidEip191SignRequest" | "CannotResendUserInvitation" | "InvalidNotificationEndpointCount" | "CannotDeletePendingSubscription" | "InvalidNotificationUrlProtocol" | "EmptyOneOfOrgEventFilter" | "EmptyAllExceptOrgEventFilter" | "InvalidTapNodeHash" | "InvalidOneTimeCode" | "MessageNotFound" | "MessageAlreadySigned" | "MessageRejected" | "MessageReplaced" | "InvalidMessageType" | "EmptyAddress" | "InvalidEth2SigningPolicySlotRange" | "InvalidEth2SigningPolicyEpochRange" | "InvalidEth2SigningPolicyTimestampRange" | "InvalidEth2SigningPolicyOverlappingRule" | "RpcUrlMissing" | "MmiChainIdMissing" | "EthersInvalidRpcUrl" | "EthersGetTransactionCountError" | "InvalidPassword" | "BabylonStakingFeePlusDustOverflow" | "BabylonStaking" | "BabylonStakingIncorrectKey" | "BabylonStakingSegwitNonDeposit" | "BabylonStakingRegistrationRequiresTaproot" | "PsbtSigning" | "TooManyResets" | "TooManyRequests" | "TooManyFailedLogins" | "BadBtcMessageSignP2shFlag" | "InvalidTendermintRequest" | "PolicyVersionMaxReached" | "PolicyVersionInvalid" | "PolicySecretLimitReached" | "PolicySecretTooLarge" | "InvalidImportKey" | "AlienOwnerInvalid" | "EmptyUpdateRequest" | "InvalidPolicyReference" | "PolicyEngineDisabled" | "InvalidWasmPolicy" | "InvalidPolicy" | "RedundantDerivationPath" | "ImportKeyMissing" | "InvalidAbiMethods" | "BabylonCovSign" | "InvalidPolicyLogsRequest" | "UserProfileMigrationMultipleEntries" | "UserProfileMigrationTooManyItems" | "InputTooShort" | "InvalidTweakLength" | "InvalidCustomChains" | "InvalidRpcRequest";
|
|
2820
|
+
BadRequestErrorCode: "GenericBadRequest" | "DisallowedAllowRuleReference" | "InvalidPaginationToken" | "InvalidEmail" | "InvalidEmailTemplate" | "QueryMetricsError" | "InvalidTelegramData" | "ValidationError" | "WebhookPolicyTimeoutOutOfBounds" | "WebhookPolicyDisallowedUrlScheme" | "WebhookPolicyDisallowedUrlHost" | "WebhookPolicyDisallowedHeaders" | "ReservedName" | "UserEmailNotConfigured" | "EmailPasswordNotFound" | "PasswordAuthNotAllowedByInvitation" | "OneTimeCodeExpired" | "InvalidBody" | "InvalidJwt" | "InvitationNoLongerValid" | "TokenRequestError" | "InvalidMfaReceipt" | "InvalidMfaPolicyCount" | "InvalidMfaPolicyNumAuthFactors" | "InvalidMfaPolicyNumAllowedApprovers" | "InvalidMfaPolicyGracePeriodTooLong" | "InvalidBabylonStakingPolicyParams" | "InvalidSuiTxReceiversEmptyAllowlist" | "InvalidBtcTxReceiversEmptyAllowlist" | "InvalidRequireRoleSessionAllowlist" | "InvalidCreateKeyCount" | "InvalidDiffieHellmanCount" | "OrgInviteExistingUser" | "OrgUserAlreadyExists" | "OrgNameTaken" | "KwkNotFoundInRegion" | "OrgIsNotOrgExport" | "RoleNameTaken" | "PolicyNameTaken" | "NameTaken" | "ContactNameInvalid" | "ContactAddressesInvalid" | "ContactLabelInvalid" | "ContactModified" | "PolicyNotFound" | "PolicyVersionNotFound" | "PolicyRuleDisallowedByType" | "PolicyTypeDisallowed" | "PolicyDuplicateError" | "PolicyStillAttached" | "PolicyModified" | "PolicyNotAttached" | "AddKeyToRoleCountTooHigh" | "InvalidKeyId" | "InvalidTimeLockAlreadyInThePast" | "InvalidRestrictedScopes" | "InvalidUpdate" | "InvalidMetadataLength" | "InvalidLength" | "InvalidKeyMaterialId" | "KeyNotFound" | "SiweChallengeNotFound" | "SiweInvalidRequest" | "SiwsChallengeNotFound" | "SiwsInvalidRequest" | "UserExportDerivedKey" | "UserExportPublicKeyInvalid" | "NistP256PublicKeyInvalid" | "UnableToAccessSmtpRelay" | "UserExportInProgress" | "RoleNotFound" | "InvalidRoleNameOrId" | "InvalidMfaReceiptOrgIdMissing" | "InvalidMfaReceiptInvalidOrgId" | "MfaRequestNotFound" | "InvalidKeyType" | "InvalidPropertiesForKeyType" | "MismatchedKeyPropertiesPatch" | "MissingBinanceApiKey" | "MissingBybitApiKey" | "MissingCoinbaseApiKey" | "BinanceKeyMasterMismatch" | "BybitAccountMismatch" | "InvalidKeyMaterial" | "InvalidHexValue" | "InvalidBase32Value" | "InvalidBase58Value" | "InvalidBase64Value" | "InvalidSs58Value" | "InvalidForkVersionLength" | "InvalidEthAddress" | "InvalidStellarAddress" | "InvalidOrgNameOrId" | "InvalidUpdateOrgRequestDisallowedMfaType" | "InvalidUpdateOrgRequestEmptyAllowedMfaTypes" | "EmailOtpDelayTooShortForRegisterMfa" | "InvalidStakeDeposit" | "InvalidBlobSignRequest" | "InvalidDiffieHellmanRequest" | "InvalidSolanaSignRequest" | "InvalidEip712SignRequest" | "OnlySpecifyOne" | "NoOidcDataInProof" | "InvalidEvmSignRequest" | "InvalidEth2SignRequest" | "InvalidDeriveKeyRequest" | "InvalidStakingAmount" | "CustomStakingAmountNotAllowedForWrapperContract" | "InvalidUnstakeRequest" | "InvalidCreateUserRequest" | "UserAlreadyExists" | "IdpUserAlreadyExists" | "CognitoUserAlreadyOrgMember" | "UserNotFound" | "UserWithEmailNotFound" | "PolicyKeyMismatch" | "EmptyScopes" | "InvalidScopesForRoleSession" | "InvalidLifetime" | "NoSingleKeyForUser" | "InvalidOrgPolicyRule" | "SourceIpAllowlistEmpty" | "LimitWindowTooLong" | "Erc20ContractDisallowed" | "EmptyRuleError" | "PolicyFieldValidationError" | "OptionalListEmpty" | "MultipleExclusiveFieldsProvided" | "DuplicateFieldEntry" | "InvalidRange" | "InvalidOrgPolicyRepeatedRule" | "InvalidSuiTransaction" | "SuiSenderMismatch" | "AvaSignHashError" | "AvaSignError" | "BtcSegwitHashError" | "BtcTaprootHashError" | "BtcSignError" | "TaprootSignError" | "Eip712SignError" | "InvalidMemberRoleInUserAdd" | "InvalidMemberRoleInRecipientAdd" | "ThirdPartyUserAlreadyExists" | "OidcIdentityAlreadyExists" | "UserAlreadyHasIdentity" | "ThirdPartyUserNotFound" | "DeleteOidcUserError" | "DeleteUserError" | "SessionRoleMismatch" | "InvalidOidcToken" | "InvalidOidcIdentity" | "OidcIssuerUnsupported" | "OidcIssuerNotAllowed" | "OidcIssuerNoApplicableJwk" | "FidoKeyAlreadyRegistered" | "FidoKeySignCountTooLow" | "FidoVerificationFailed" | "FidoChallengeMfaMismatch" | "UnsupportedLegacyCognitoSession" | "InvalidIdentityProof" | "PaginationDataExpired" | "ExistingKeysViolateExclusiveKeyAccess" | "ExportDelayTooShort" | "ExportWindowTooLong" | "InvalidTotpFailureLimit" | "InvalidEip191SignRequest" | "CannotResendUserInvitation" | "InvalidNotificationEndpointCount" | "CannotDeletePendingSubscription" | "InvalidNotificationUrlProtocol" | "EmptyOneOfOrgEventFilter" | "EmptyAllExceptOrgEventFilter" | "InvalidTapNodeHash" | "InvalidOneTimeCode" | "MessageNotFound" | "MessageAlreadySigned" | "MessageRejected" | "MessageReplaced" | "InvalidMessageType" | "EmptyAddress" | "InvalidEth2SigningPolicySlotRange" | "InvalidEth2SigningPolicyEpochRange" | "InvalidEth2SigningPolicyTimestampRange" | "InvalidEth2SigningPolicyOverlappingRule" | "RpcUrlMissing" | "MmiChainIdMissing" | "EthersInvalidRpcUrl" | "EthersGetTransactionCountError" | "InvalidPassword" | "BabylonStakingFeePlusDustOverflow" | "BabylonStaking" | "BabylonStakingIncorrectKey" | "BabylonStakingSegwitNonDeposit" | "BabylonStakingRegistrationRequiresTaproot" | "PsbtSigning" | "TooManyResets" | "TooManyRequests" | "TooManyFailedLogins" | "BadBtcMessageSignP2shFlag" | "InvalidTendermintRequest" | "PolicyVersionMaxReached" | "PolicyVersionInvalid" | "PolicySecretLimitReached" | "PolicySecretTooLarge" | "InvalidImportKey" | "AlienOwnerInvalid" | "EmptyUpdateRequest" | "InvalidPolicyReference" | "PolicyEngineDisabled" | "InvalidWasmPolicy" | "CelProgramTooLarge" | "InvalidPolicy" | "RedundantDerivationPath" | "ImportKeyMissing" | "InvalidAbiMethods" | "BabylonCovSign" | "InvalidPolicyLogsRequest" | "UserProfileMigrationMultipleEntries" | "UserProfileMigrationTooManyItems" | "InputTooShort" | "InvalidTweakLength" | "InvalidCustomChains" | "InvalidRpcRequest";
|
|
2778
2821
|
BillingArgs: {
|
|
2779
2822
|
billing_org: components["schemas"]["Id"];
|
|
2780
2823
|
event_type: components["schemas"]["BillingEvent"];
|
|
@@ -2791,7 +2834,7 @@ export interface components {
|
|
|
2791
2834
|
* @description Billing event types.
|
|
2792
2835
|
* @enum {string}
|
|
2793
2836
|
*/
|
|
2794
|
-
BillingEvent: "Mmi" | "MmiMessageGet" | "MmiMessageList" | "MmiMessageSign" | "MmiMessageReject" | "MmiMessageDelete" | "AboutMe" | "UserResetEmailInit" | "UserResetEmailComplete" | "UserDeleteTotp" | "UserResetTotpInit" | "UserResetTotpComplete" | "UserVerifyTotp" | "UserRegisterFidoInit" | "UserRegisterFidoComplete" | "UserDeleteFido" | "CreateProofOidc" | "CreateProofCubeSigner" | "VerifyProof" | "AddOidcIdentity" | "RemoveOidcIdentity" | "ListOidcIdentities" | "GetOrg" | "UpdateOrg" | "GetOrgExport" | "CreateOrg" | "ListKeys" | "AttestKey" | "GetKey" | "GetKeyByMaterialId" | "ListKeyRoles" | "UpdateKey" | "ListHistoricalKeyTx" | "Invite" | "CancelInvitation" | "ListInvitations" | "ListUsers" | "GetUser" | "GetUserByEmail" | "GetUserByOidc" | "UpdateMembership" | "ResetMemberMfa" | "CompleteResetMemberMfa" | "CreateRole" | "AttestRole" | "GetRole" | "ListTokenKeys" | "ListRoles" | "GetRoleKey" | "ListRoleKeys" | "ListRoleUsers" | "UpdateRole" | "DeleteRole" | "ConfigureEmail" | "GetEmailConfig" | "DeleteEmailConfig" | "ListHistoricalRoleTx" | "CreatePolicy" | "GetPolicy" | "ListPolicies" | "DeletePolicy" | "UpdatePolicy" | "InvokePolicy" | "GetPolicyLogs" | "UploadWasmPolicy" | "GetPolicySecrets" | "UpdatePolicySecrets" | "SetPolicySecret" | "DeletePolicySecret" | "CreatePolicyImportKey" | "GetPolicyBucket" | "ListPolicyBuckets" | "UpdatePolicyBucket" | "UserExportDelete" | "UserExportList" | "UserExportInit" | "UserExportComplete" | "AddUserToRole" | "RemoveUserFromRole" | "MfaApproveCs" | "MfaRejectCs" | "MfaGet" | "MfaList" | "AddKeysToRole" | "RemoveKeyFromRole" | "CreateToken" | "CreateSession" | "RevokeSession" | "RevokeCurrentSession" | "RevokeSessions" | "ListSessions" | "GetSession" | "SignerSessionRefresh" | "MfaApproveTotp" | "MfaRejectTotp" | "MfaFidoInit" | "MfaApproveFidoComplete" | "MfaRejectFidoComplete" | "MfaEmailInit" | "MfaEmailComplete" | "Cube3signerHeartbeat" | "CreateContact" | "GetContact" | "ListContacts" | "DeleteContact" | "UpdateContact" | "LookupContactsByAddress" | "QueryMetrics" | "QueryAuditLog" | "Counts" | "CreateKey" | "ImportKey" | "CreateKeyImportKey" | "DeriveKey" | "DeleteKey" | "AvaSign" | "AvaSerializedTxSign" | "BabylonRegistration" | "BabylonStaking" | "BabylonCovSign" | "BinanceSign" | "CoinbaseSign" | "BlobSign" | "BtcMessageSign" | "BtcSign" | "DiffieHellmanExchange" | "PsbtSign" | "PsbtLegacyInputSign" | "PsbtSegwitInputSign" | "PsbtTaprootInputSign" | "TaprootSign" | "Eip712Sign" | "Eip191Sign" | "Eth1Sign" | "Eth2Sign" | "SolanaSign" | "SuiSign" | "TendermintSign" | "Stake" | "Unstake" | "PasskeyAuthInit" | "PasskeyAuthComplete" | "OidcAuth" | "Oauth2Twitter" | "OAuth2TokenRefresh" | "EmailOtpAuth" | "SiweInit" | "SiweComplete" | "TelegramAuth" | "CreateOidcUser" | "DeleteOidcUser" | "DeleteUser" | "CreateEotsNonces" | "EotsSign" | "AuthMigrationIdentityAdd" | "AuthMigrationIdentityRemove" | "AuthMigrationUserUpdate" | "KeyCreated" | "KeyImported" | "InvitationAccept" | "IdpAuthenticate" | "IdpPasswordResetRequest" | "IdpPasswordResetConfirm" | "RpcApi" | "RpcCreateTransaction" | "RpcGetTransaction" | "RpcListTransactions" | "RpcRetryTransaction" | "RpcBinance" | "RpcCoinbase" | "CustomChainRpcCall" | "EsploraApiCall" | "SentryApiCall" | "SentryApiCallPublic" | "MmiJwkSet" | "AttestationJwkSet" | "UserOrgs" | "PublicOrgInfo" | "EmailMyOrgs";
|
|
2837
|
+
BillingEvent: "Mmi" | "MmiMessageGet" | "MmiMessageList" | "MmiMessageSign" | "MmiMessageReject" | "MmiMessageDelete" | "AboutMe" | "UserResetEmailInit" | "UserResetEmailComplete" | "UserDeleteTotp" | "UserResetTotpInit" | "UserResetTotpComplete" | "UserVerifyTotp" | "UserRegisterFidoInit" | "UserRegisterFidoComplete" | "UserDeleteFido" | "CreateProofOidc" | "CreateProofCubeSigner" | "VerifyProof" | "AddOidcIdentity" | "RemoveOidcIdentity" | "ListOidcIdentities" | "GetOrg" | "UpdateOrg" | "GetOrgExport" | "CreateOrg" | "ListKeys" | "AttestKey" | "GetKey" | "GetKeyByMaterialId" | "ListKeyRoles" | "UpdateKey" | "ListHistoricalKeyTx" | "Invite" | "CancelInvitation" | "ListInvitations" | "ListUsers" | "GetUser" | "GetUserByEmail" | "GetUserByOidc" | "UpdateMembership" | "ResetMemberMfa" | "CompleteResetMemberMfa" | "CreateRole" | "AttestRole" | "GetRole" | "ListTokenKeys" | "ListRoles" | "GetRoleKey" | "ListRoleKeys" | "ListRoleUsers" | "UpdateRole" | "DeleteRole" | "ConfigureEmail" | "GetEmailConfig" | "DeleteEmailConfig" | "ListHistoricalRoleTx" | "CreatePolicy" | "GetPolicy" | "ListPolicies" | "DeletePolicy" | "UpdatePolicy" | "InvokePolicy" | "GetPolicyLogs" | "UploadWasmPolicy" | "GetPolicySecrets" | "UpdatePolicySecrets" | "SetPolicySecret" | "DeletePolicySecret" | "CreatePolicyImportKey" | "GetPolicyBucket" | "ListPolicyBuckets" | "UpdatePolicyBucket" | "UserExportDelete" | "UserExportList" | "UserExportInit" | "UserExportComplete" | "AddUserToRole" | "RemoveUserFromRole" | "MfaApproveCs" | "MfaRejectCs" | "MfaGet" | "MfaList" | "AddKeysToRole" | "RemoveKeyFromRole" | "CreateToken" | "CreateSession" | "RevokeSession" | "RevokeCurrentSession" | "RevokeSessions" | "ListSessions" | "GetSession" | "SignerSessionRefresh" | "MfaApproveTotp" | "MfaRejectTotp" | "MfaFidoInit" | "MfaApproveFidoComplete" | "MfaRejectFidoComplete" | "MfaEmailInit" | "MfaEmailComplete" | "Cube3signerHeartbeat" | "CreateContact" | "GetContact" | "ListContacts" | "DeleteContact" | "UpdateContact" | "LookupContactsByAddress" | "QueryMetrics" | "QueryAuditLog" | "Counts" | "CreateKey" | "ImportKey" | "CreateKeyImportKey" | "DeriveKey" | "DeleteKey" | "AvaSign" | "AvaSerializedTxSign" | "BabylonRegistration" | "BabylonStaking" | "BabylonCovSign" | "BinanceSign" | "BybitSign" | "CoinbaseSign" | "BlobSign" | "BtcMessageSign" | "BtcSign" | "DiffieHellmanExchange" | "PsbtSign" | "PsbtLegacyInputSign" | "PsbtSegwitInputSign" | "PsbtTaprootInputSign" | "TaprootSign" | "Eip712Sign" | "Eip191Sign" | "Eth1Sign" | "Eth2Sign" | "SolanaSign" | "SuiSign" | "TendermintSign" | "Stake" | "Unstake" | "PasskeyAuthInit" | "PasskeyAuthComplete" | "OidcAuth" | "Oauth2Twitter" | "OAuth2TokenRefresh" | "EmailOtpAuth" | "SiweInit" | "SiweComplete" | "SiwsInit" | "SiwsComplete" | "TelegramAuth" | "CreateOidcUser" | "DeleteOidcUser" | "DeleteUser" | "CreateEotsNonces" | "EotsSign" | "AuthMigrationIdentityAdd" | "AuthMigrationIdentityRemove" | "AuthMigrationUserUpdate" | "KeyCreated" | "KeyImported" | "InvitationAccept" | "IdpAuthenticate" | "IdpPasswordResetRequest" | "IdpPasswordResetConfirm" | "RpcApi" | "RpcCreateTransaction" | "RpcGetTransaction" | "RpcListTransactions" | "RpcRetryTransaction" | "RpcCancelTransaction" | "RpcBinance" | "RpcBybit" | "RpcCoinbase" | "CustomChainRpcCall" | "EsploraApiCall" | "SentryApiCall" | "SentryApiCallPublic" | "MmiJwkSet" | "AttestationJwkSet" | "UserOrgs" | "PublicOrgInfo" | "EmailMyOrgs";
|
|
2795
2838
|
/** @description Parameters envelope for all Binance RPC methods. */
|
|
2796
2839
|
BinanceAccountInfoParams: components["schemas"]["AccountInfoRequest"] & {
|
|
2797
2840
|
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
@@ -2841,6 +2884,18 @@ export interface components {
|
|
|
2841
2884
|
recvWindow?: number | null;
|
|
2842
2885
|
};
|
|
2843
2886
|
/** @description Parameters envelope for all Binance RPC methods. */
|
|
2887
|
+
BinanceDepositHistoryParams: components["schemas"]["DepositHistoryRequest"] & {
|
|
2888
|
+
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
2889
|
+
keyId: components["schemas"]["Id"];
|
|
2890
|
+
/**
|
|
2891
|
+
* Format: float
|
|
2892
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
2893
|
+
* May only be specified in milliseconds, with up to three decimal places of precision.
|
|
2894
|
+
* If omitted, defaults to 10000. Must not be greater than 60000.
|
|
2895
|
+
*/
|
|
2896
|
+
recvWindow?: number | null;
|
|
2897
|
+
};
|
|
2898
|
+
/** @description Parameters envelope for all Binance RPC methods. */
|
|
2844
2899
|
BinanceDepositParams: components["schemas"]["DepositRequest"] & {
|
|
2845
2900
|
dryRun?: components["schemas"]["BinanceDryRunMode"] | null;
|
|
2846
2901
|
keyId: components["schemas"]["Id"];
|
|
@@ -2919,6 +2974,10 @@ export interface components {
|
|
|
2919
2974
|
/** @enum {string} */
|
|
2920
2975
|
method: "cs_binanceDeposit";
|
|
2921
2976
|
params: components["schemas"]["BinanceDepositParams"];
|
|
2977
|
+
} | {
|
|
2978
|
+
/** @enum {string} */
|
|
2979
|
+
method: "cs_binanceDepositHistory";
|
|
2980
|
+
params: components["schemas"]["BinanceDepositHistoryParams"];
|
|
2922
2981
|
} | {
|
|
2923
2982
|
/** @enum {string} */
|
|
2924
2983
|
method: "cs_binanceListSubAccounts";
|
|
@@ -3308,9 +3367,488 @@ export interface components {
|
|
|
3308
3367
|
metadata?: unknown;
|
|
3309
3368
|
owner: components["schemas"]["Id"];
|
|
3310
3369
|
};
|
|
3370
|
+
/**
|
|
3371
|
+
* @description Wire-format patch payload for [`KeyProperties::BybitApi`].
|
|
3372
|
+
*
|
|
3373
|
+
* Every field follows the same per-field PATCH semantics: a missing field
|
|
3374
|
+
* leaves the existing value alone, a JSON `null` clears it, and a value sets it.
|
|
3375
|
+
*/
|
|
3376
|
+
BybitApiPropertiesPatch: {
|
|
3377
|
+
/** @description The Bybit-issued API key string. Encrypted server-side before storage. */
|
|
3378
|
+
api_key?: string | null;
|
|
3379
|
+
/** @description Arbitrary label. Useful for storing the corresponding API key label on the Bybit side. */
|
|
3380
|
+
label?: string | null;
|
|
3381
|
+
};
|
|
3382
|
+
/** @description One entry in [`BybitQueryCoinsBalanceResponse::balance`]. */
|
|
3383
|
+
BybitCoinBalance: {
|
|
3384
|
+
/** @description Bonus / promotional balance, as a decimal string. */
|
|
3385
|
+
bonus?: string | null;
|
|
3386
|
+
/** @description Coin symbol, uppercase (e.g. `USDT`, `BTC`). */
|
|
3387
|
+
coin: string;
|
|
3388
|
+
/** @description Portion of `wallet_balance` that can be transferred out. */
|
|
3389
|
+
transferBalance: string;
|
|
3390
|
+
/** @description Total wallet balance for `coin`, as a decimal string. */
|
|
3391
|
+
walletBalance: string;
|
|
3392
|
+
};
|
|
3393
|
+
/** @description One entry in [`BybitQueryDepositAddressResponse::chains`]. */
|
|
3394
|
+
BybitDepositChain: {
|
|
3395
|
+
/** @description Deposit address on this chain. */
|
|
3396
|
+
addressDeposit: string;
|
|
3397
|
+
/** @description Single-deposit cap for this coin on this chain; `"-1"` means no limit. */
|
|
3398
|
+
batchReleaseLimit?: string | null;
|
|
3399
|
+
/** @description Short chain code (e.g. `ETH`, `TRX`). */
|
|
3400
|
+
chain: string;
|
|
3401
|
+
/** @description Human-readable chain name (e.g. `Ethereum (ERC20)`). */
|
|
3402
|
+
chainType?: string | null;
|
|
3403
|
+
/**
|
|
3404
|
+
* @description Token contract address on this chain. Bybit only returns the last 6
|
|
3405
|
+
* characters; empty for native coins.
|
|
3406
|
+
*/
|
|
3407
|
+
contractAddress?: string | null;
|
|
3408
|
+
/**
|
|
3409
|
+
* @description Memo / tag required for chains that use one (e.g. XRP, EOS). Empty for
|
|
3410
|
+
* chains that don't.
|
|
3411
|
+
*/
|
|
3412
|
+
tagDeposit?: string | null;
|
|
3413
|
+
};
|
|
3414
|
+
BybitDryRunArgs: {
|
|
3415
|
+
/** @description The Bybit API method that would have been used */
|
|
3416
|
+
method: string;
|
|
3417
|
+
/** @description The request body (for POST endpoints) or query string (for GET endpoints). */
|
|
3418
|
+
payload: string;
|
|
3419
|
+
/** @description The Bybit API url that would have been called */
|
|
3420
|
+
url: string;
|
|
3421
|
+
};
|
|
3422
|
+
/**
|
|
3423
|
+
* @description "Dry run" modes for Bybit requests.
|
|
3424
|
+
* @enum {string}
|
|
3425
|
+
*/
|
|
3426
|
+
BybitDryRunMode: "NO_SIGN" | "NO_SUBMIT";
|
|
3427
|
+
/**
|
|
3428
|
+
* @description Parameters envelope for all Bybit RPC variants whose payload schema is
|
|
3429
|
+
* derived from a `*Request` struct. (`BybitQueryUserParams` and
|
|
3430
|
+
* `BybitQuerySubMembersParams` have no per-variant payload and are defined
|
|
3431
|
+
* directly below.)
|
|
3432
|
+
*/
|
|
3433
|
+
BybitQueryCoinsBalanceParams: components["schemas"]["BybitQueryCoinsBalanceRequest"] & {
|
|
3434
|
+
dryRun?: components["schemas"]["BybitDryRunMode"] | null;
|
|
3435
|
+
keyId: components["schemas"]["Id"];
|
|
3436
|
+
/**
|
|
3437
|
+
* Format: int32
|
|
3438
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
3439
|
+
* Specified in milliseconds. If omitted, defaults to 10000.
|
|
3440
|
+
*/
|
|
3441
|
+
recvWindow?: number | null;
|
|
3442
|
+
};
|
|
3443
|
+
/** @description Parameters for `GET /v5/asset/transfer/query-account-coins-balance`. */
|
|
3444
|
+
BybitQueryCoinsBalanceRequest: {
|
|
3445
|
+
/**
|
|
3446
|
+
* @description Wallet type. Common values: `"FUND"`, `"UNIFIED"`, `"CONTRACT"`. Bybit
|
|
3447
|
+
* expects this verbatim; we don't constrain it on our side.
|
|
3448
|
+
*/
|
|
3449
|
+
accountType: string;
|
|
3450
|
+
/**
|
|
3451
|
+
* @description Optional list of coin symbols, comma-separated (e.g. `"BTC,USDT"`).
|
|
3452
|
+
* Bybit returns balances for all coins when omitted.
|
|
3453
|
+
*/
|
|
3454
|
+
coin?: string | null;
|
|
3455
|
+
/**
|
|
3456
|
+
* @description Optional sub-account UID. When supplied, the master key queries the
|
|
3457
|
+
* named sub-account's balance.
|
|
3458
|
+
*/
|
|
3459
|
+
memberId?: string | null;
|
|
3460
|
+
/**
|
|
3461
|
+
* @description Optional flag: `"0"` query without conversion to USD (default),
|
|
3462
|
+
* `"1"` include USD valuation. Bybit accepts this as a string.
|
|
3463
|
+
*/
|
|
3464
|
+
withBonus?: string | null;
|
|
3465
|
+
};
|
|
3466
|
+
/** @description Response of `GET /v5/asset/transfer/query-account-coins-balance`. */
|
|
3467
|
+
BybitQueryCoinsBalanceResponse: {
|
|
3468
|
+
/** @description Account type the balances belong to (e.g. `UNIFIED`, `FUND`, `CONTRACT`). */
|
|
3469
|
+
accountType: string;
|
|
3470
|
+
/** @description Per-coin balances. */
|
|
3471
|
+
balance: components["schemas"]["BybitCoinBalance"][];
|
|
3472
|
+
/** @description UID of the (sub-)account whose balance is being reported. */
|
|
3473
|
+
memberId?: string | null;
|
|
3474
|
+
};
|
|
3475
|
+
/**
|
|
3476
|
+
* @description Parameters envelope for all Bybit RPC variants whose payload schema is
|
|
3477
|
+
* derived from a `*Request` struct. (`BybitQueryUserParams` and
|
|
3478
|
+
* `BybitQuerySubMembersParams` have no per-variant payload and are defined
|
|
3479
|
+
* directly below.)
|
|
3480
|
+
*/
|
|
3481
|
+
BybitQueryDepositAddressParams: components["schemas"]["BybitQueryDepositAddressRequest"] & {
|
|
3482
|
+
dryRun?: components["schemas"]["BybitDryRunMode"] | null;
|
|
3483
|
+
keyId: components["schemas"]["Id"];
|
|
3484
|
+
/**
|
|
3485
|
+
* Format: int32
|
|
3486
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
3487
|
+
* Specified in milliseconds. If omitted, defaults to 10000.
|
|
3488
|
+
*/
|
|
3489
|
+
recvWindow?: number | null;
|
|
3490
|
+
};
|
|
3491
|
+
/** @description Parameters for `GET /v5/asset/deposit/query-address`. */
|
|
3492
|
+
BybitQueryDepositAddressRequest: {
|
|
3493
|
+
/**
|
|
3494
|
+
* @description Optional network identifier (e.g. `"ETH"`, `"TRX"`). When omitted,
|
|
3495
|
+
* Bybit returns the deposit address on every supported chain.
|
|
3496
|
+
*/
|
|
3497
|
+
chainType?: string | null;
|
|
3498
|
+
/** @description Coin symbol (e.g. `"BTC"`, `"USDT"`). */
|
|
3499
|
+
coin: string;
|
|
3500
|
+
};
|
|
3501
|
+
/** @description Response of `GET /v5/asset/deposit/query-address`. */
|
|
3502
|
+
BybitQueryDepositAddressResponse: {
|
|
3503
|
+
/** @description One deposit address per supported chain. */
|
|
3504
|
+
chains: components["schemas"]["BybitDepositChain"][];
|
|
3505
|
+
/** @description Coin symbol the deposit addresses are for (e.g. `USDT`). */
|
|
3506
|
+
coin: string;
|
|
3507
|
+
};
|
|
3508
|
+
/**
|
|
3509
|
+
* @description Parameters for [`BybitRpc::QuerySubMembers`].
|
|
3510
|
+
*
|
|
3511
|
+
* Bybit endpoint: `GET /v5/user/query-sub-members`. Takes no inputs beyond
|
|
3512
|
+
* the common envelope.
|
|
3513
|
+
*/
|
|
3514
|
+
BybitQuerySubMembersParams: {
|
|
3515
|
+
dryRun?: components["schemas"]["BybitDryRunMode"] | null;
|
|
3516
|
+
keyId: components["schemas"]["Id"];
|
|
3517
|
+
/**
|
|
3518
|
+
* Format: int32
|
|
3519
|
+
* @description Optional receive window in milliseconds. Defaults to 10000.
|
|
3520
|
+
*/
|
|
3521
|
+
recvWindow?: number | null;
|
|
3522
|
+
};
|
|
3523
|
+
/** @description Response of `GET /v5/user/query-sub-members`. */
|
|
3524
|
+
BybitQuerySubMembersResponse: {
|
|
3525
|
+
/** @description The sub-accounts under the calling master account. */
|
|
3526
|
+
subMembers: components["schemas"]["BybitSubMember"][];
|
|
3527
|
+
};
|
|
3528
|
+
/**
|
|
3529
|
+
* @description Parameters for [`BybitRpc::QueryUser`].
|
|
3530
|
+
*
|
|
3531
|
+
* Bybit endpoint: `GET /v5/user/query-api`. Takes no inputs beyond the common
|
|
3532
|
+
* `recvWindow` / `timestamp` envelope; defined directly (instead of through
|
|
3533
|
+
* the [`BybitParams`] generic alias) so utoipa emits a non-empty schema.
|
|
3534
|
+
*/
|
|
3535
|
+
BybitQueryUserParams: {
|
|
3536
|
+
dryRun?: components["schemas"]["BybitDryRunMode"] | null;
|
|
3537
|
+
keyId: components["schemas"]["Id"];
|
|
3538
|
+
/**
|
|
3539
|
+
* Format: int32
|
|
3540
|
+
* @description Optional receive window in milliseconds. Defaults to 10000.
|
|
3541
|
+
*/
|
|
3542
|
+
recvWindow?: number | null;
|
|
3543
|
+
};
|
|
3544
|
+
/** @description Response of `GET /v5/user/query-api`. */
|
|
3545
|
+
BybitQueryUserResponse: {
|
|
3546
|
+
/** @description Bybit account KYC level (`"0"` = none). */
|
|
3547
|
+
kycLevel?: string | null;
|
|
3548
|
+
/** @description Optional free-text label set on the API key. */
|
|
3549
|
+
note?: string | null;
|
|
3550
|
+
/**
|
|
3551
|
+
* @description Master account UID for sub-accounts, `"0"` if the calling key is a
|
|
3552
|
+
* master account.
|
|
3553
|
+
*/
|
|
3554
|
+
parentUid: string;
|
|
3555
|
+
/** @description API permissions assigned to the key. */
|
|
3556
|
+
permissions?: unknown;
|
|
3557
|
+
/**
|
|
3558
|
+
* Format: int64
|
|
3559
|
+
* @description Bybit-assigned account UID of the API key.
|
|
3560
|
+
*/
|
|
3561
|
+
userID: number;
|
|
3562
|
+
/** @description VIP level. */
|
|
3563
|
+
vipLevel?: string | null;
|
|
3564
|
+
[key: string]: unknown;
|
|
3565
|
+
};
|
|
3566
|
+
/**
|
|
3567
|
+
* @description Bybit-family RPC methods. Each variant authenticates as the
|
|
3568
|
+
* [`KeyType::HmacSha256`] key in its `params.key_id` (which must carry
|
|
3569
|
+
* [`KeyProperties::BybitApi`]).
|
|
3570
|
+
*/
|
|
3571
|
+
BybitRpc: {
|
|
3572
|
+
/** @enum {string} */
|
|
3573
|
+
method: "cs_bybitQueryUser";
|
|
3574
|
+
params: components["schemas"]["BybitQueryUserParams"];
|
|
3575
|
+
} | {
|
|
3576
|
+
/** @enum {string} */
|
|
3577
|
+
method: "cs_bybitQuerySubMembers";
|
|
3578
|
+
params: components["schemas"]["BybitQuerySubMembersParams"];
|
|
3579
|
+
} | {
|
|
3580
|
+
/** @enum {string} */
|
|
3581
|
+
method: "cs_bybitQueryCoinsBalance";
|
|
3582
|
+
params: components["schemas"]["BybitQueryCoinsBalanceParams"];
|
|
3583
|
+
} | {
|
|
3584
|
+
/** @enum {string} */
|
|
3585
|
+
method: "cs_bybitQueryDepositAddress";
|
|
3586
|
+
params: components["schemas"]["BybitQueryDepositAddressParams"];
|
|
3587
|
+
} | {
|
|
3588
|
+
/** @enum {string} */
|
|
3589
|
+
method: "cs_bybitUniversalTransfer";
|
|
3590
|
+
params: components["schemas"]["BybitUniversalTransferParams"];
|
|
3591
|
+
} | {
|
|
3592
|
+
/** @enum {string} */
|
|
3593
|
+
method: "cs_bybitWithdraw";
|
|
3594
|
+
params: components["schemas"]["BybitWithdrawParams"];
|
|
3595
|
+
} | {
|
|
3596
|
+
/** @enum {string} */
|
|
3597
|
+
method: "cs_bybitWithdrawals";
|
|
3598
|
+
params: components["schemas"]["BybitWithdrawalsParams"];
|
|
3599
|
+
};
|
|
3600
|
+
/** @description Response returned by the typed `bybit_sign` endpoint. */
|
|
3601
|
+
BybitSignResponse: {
|
|
3602
|
+
/** @description Optional policy evaluation tree. */
|
|
3603
|
+
policy_eval_tree?: unknown;
|
|
3604
|
+
} & {
|
|
3605
|
+
/**
|
|
3606
|
+
* @description The Bybit-bound payload (URL-encoded query for GET, JSON body for
|
|
3607
|
+
* POST). Submitted verbatim by the rpc-api lambda; the payload bytes are
|
|
3608
|
+
* also part of the signing input.
|
|
3609
|
+
*/
|
|
3610
|
+
payload: string;
|
|
3611
|
+
/**
|
|
3612
|
+
* Format: int32
|
|
3613
|
+
* @description Effective receive window in milliseconds.
|
|
3614
|
+
*/
|
|
3615
|
+
recv_window: number;
|
|
3616
|
+
/**
|
|
3617
|
+
* @description Hex-encoded HMAC-SHA256 signature of
|
|
3618
|
+
* `timestamp || apiKey || recvWindow || payload`. Goes into the
|
|
3619
|
+
* `X-BAPI-SIGN` header.
|
|
3620
|
+
*/
|
|
3621
|
+
signature_hex: string;
|
|
3622
|
+
/**
|
|
3623
|
+
* Format: int64
|
|
3624
|
+
* @description Signing timestamp (ms since epoch). Picked by the signer.
|
|
3625
|
+
*/
|
|
3626
|
+
timestamp_ms: number;
|
|
3627
|
+
};
|
|
3628
|
+
/** @description One entry in [`BybitQuerySubMembersResponse::sub_members`]. */
|
|
3629
|
+
BybitSubMember: {
|
|
3630
|
+
/**
|
|
3631
|
+
* Format: int32
|
|
3632
|
+
* @description Trading account configuration: `1` Classic, `3` UTA1.0, `4` UTA1.0 Pro,
|
|
3633
|
+
* `5` UTA2.0, `6` UTA2.0 Pro.
|
|
3634
|
+
*/
|
|
3635
|
+
accountMode?: number | null;
|
|
3636
|
+
/**
|
|
3637
|
+
* Format: int32
|
|
3638
|
+
* @description Sub-account category: `1` standard, `6` custodial.
|
|
3639
|
+
*/
|
|
3640
|
+
memberType?: number | null;
|
|
3641
|
+
/** @description Free-text remark associated with the sub-account. */
|
|
3642
|
+
remark?: string | null;
|
|
3643
|
+
/**
|
|
3644
|
+
* Format: int32
|
|
3645
|
+
* @description Account state: `1` active, `2` login-restricted, `4` frozen.
|
|
3646
|
+
*/
|
|
3647
|
+
status?: number | null;
|
|
3648
|
+
/** @description Sub-account UID. */
|
|
3649
|
+
uid: string;
|
|
3650
|
+
/** @description Display name of the sub-account. */
|
|
3651
|
+
username?: string | null;
|
|
3652
|
+
[key: string]: unknown;
|
|
3653
|
+
};
|
|
3654
|
+
/**
|
|
3655
|
+
* @description Parameters envelope for all Bybit RPC variants whose payload schema is
|
|
3656
|
+
* derived from a `*Request` struct. (`BybitQueryUserParams` and
|
|
3657
|
+
* `BybitQuerySubMembersParams` have no per-variant payload and are defined
|
|
3658
|
+
* directly below.)
|
|
3659
|
+
*/
|
|
3660
|
+
BybitUniversalTransferParams: components["schemas"]["BybitUniversalTransferRequest"] & {
|
|
3661
|
+
dryRun?: components["schemas"]["BybitDryRunMode"] | null;
|
|
3662
|
+
keyId: components["schemas"]["Id"];
|
|
3663
|
+
/**
|
|
3664
|
+
* Format: int32
|
|
3665
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
3666
|
+
* Specified in milliseconds. If omitted, defaults to 10000.
|
|
3667
|
+
*/
|
|
3668
|
+
recvWindow?: number | null;
|
|
3669
|
+
};
|
|
3670
|
+
/** @description Parameters for `POST /v5/asset/transfer/universal-transfer`. */
|
|
3671
|
+
BybitUniversalTransferRequest: {
|
|
3672
|
+
/** @description Amount as a decimal string (e.g. `"1.5"`). Sent verbatim. */
|
|
3673
|
+
amount: string;
|
|
3674
|
+
/** @description Coin symbol (e.g. `"USDT"`). */
|
|
3675
|
+
coin: string;
|
|
3676
|
+
/**
|
|
3677
|
+
* @description Source wallet type. Defaults to `"FUND"` if omitted; the signer
|
|
3678
|
+
* substitutes the default before signing so the signed and submitted
|
|
3679
|
+
* payloads match.
|
|
3680
|
+
*/
|
|
3681
|
+
fromAccountType?: string | null;
|
|
3682
|
+
/**
|
|
3683
|
+
* Format: int64
|
|
3684
|
+
* @description Source account UID. For "self", the manager substitutes the caller's
|
|
3685
|
+
* own UID before this struct reaches the signer.
|
|
3686
|
+
*/
|
|
3687
|
+
fromMemberId: number;
|
|
3688
|
+
/** @description Destination wallet type. Defaults to `"FUND"` if omitted. */
|
|
3689
|
+
toAccountType?: string | null;
|
|
3690
|
+
/**
|
|
3691
|
+
* Format: int64
|
|
3692
|
+
* @description Destination account UID.
|
|
3693
|
+
*/
|
|
3694
|
+
toMemberId: number;
|
|
3695
|
+
/**
|
|
3696
|
+
* @description Client-supplied transfer id (UUID). Bybit echoes it back as the
|
|
3697
|
+
* canonical reference for this transfer.
|
|
3698
|
+
*/
|
|
3699
|
+
transferId: string;
|
|
3700
|
+
};
|
|
3701
|
+
/** @description Response of `POST /v5/asset/transfer/universal-transfer`. */
|
|
3702
|
+
BybitUniversalTransferResponse: {
|
|
3703
|
+
/**
|
|
3704
|
+
* @description Transfer state: one of `SUCCESS`, `PENDING`, `FAILED`, or
|
|
3705
|
+
* `STATUS_UNKNOWN`.
|
|
3706
|
+
*/
|
|
3707
|
+
status?: string | null;
|
|
3708
|
+
/**
|
|
3709
|
+
* @description UUID Bybit assigned to the transfer; the caller-supplied `transferId`
|
|
3710
|
+
* echoed back.
|
|
3711
|
+
*/
|
|
3712
|
+
transferId: string;
|
|
3713
|
+
};
|
|
3714
|
+
/** @description One entry in [`BybitWithdrawalsResponse::rows`]. */
|
|
3715
|
+
BybitWithdrawEntry: {
|
|
3716
|
+
/** @description Withdrawal amount as a decimal string. */
|
|
3717
|
+
amount: string;
|
|
3718
|
+
/** @description Short chain code (e.g. `ETH`, `TRX`). */
|
|
3719
|
+
chain: string;
|
|
3720
|
+
/** @description Coin symbol, uppercase (e.g. `USDT`). */
|
|
3721
|
+
coin: string;
|
|
3722
|
+
/** @description Creation timestamp, in milliseconds since epoch (as a string). */
|
|
3723
|
+
createTime: string;
|
|
3724
|
+
/**
|
|
3725
|
+
* @description Withdrawal state, e.g. `success`, `pending`, `failed`, `cancelled`. See
|
|
3726
|
+
* the Bybit docs for the full set, which depends on `withdraw_type`.
|
|
3727
|
+
*/
|
|
3728
|
+
status: string;
|
|
3729
|
+
/** @description Memo / tag for chains that use one (e.g. XRP, EOS). */
|
|
3730
|
+
tag?: string | null;
|
|
3731
|
+
/** @description Destination: an on-chain address, or a Bybit UID for internal transfers. */
|
|
3732
|
+
toAddress: string;
|
|
3733
|
+
/**
|
|
3734
|
+
* @description On-chain transaction hash; empty for failed/cancelled withdrawals and
|
|
3735
|
+
* for in-flight on-chain withdrawals before broadcast.
|
|
3736
|
+
*/
|
|
3737
|
+
txId?: string | null;
|
|
3738
|
+
/** @description Timestamp of the most recent status change, in milliseconds since epoch. */
|
|
3739
|
+
updateTime: string;
|
|
3740
|
+
/** @description Network / processing fee charged for the withdrawal, as a decimal string. */
|
|
3741
|
+
withdrawFee: string;
|
|
3742
|
+
/** @description Bybit-assigned withdrawal id. */
|
|
3743
|
+
withdrawId: string;
|
|
3744
|
+
/**
|
|
3745
|
+
* Format: int32
|
|
3746
|
+
* @description Withdrawal classification: `0` on-chain, `1` off-chain (internal).
|
|
3747
|
+
*/
|
|
3748
|
+
withdrawType?: number | null;
|
|
3749
|
+
[key: string]: unknown;
|
|
3750
|
+
};
|
|
3751
|
+
/**
|
|
3752
|
+
* @description Parameters envelope for all Bybit RPC variants whose payload schema is
|
|
3753
|
+
* derived from a `*Request` struct. (`BybitQueryUserParams` and
|
|
3754
|
+
* `BybitQuerySubMembersParams` have no per-variant payload and are defined
|
|
3755
|
+
* directly below.)
|
|
3756
|
+
*/
|
|
3757
|
+
BybitWithdrawParams: components["schemas"]["BybitWithdrawRequest"] & {
|
|
3758
|
+
dryRun?: components["schemas"]["BybitDryRunMode"] | null;
|
|
3759
|
+
keyId: components["schemas"]["Id"];
|
|
3760
|
+
/**
|
|
3761
|
+
* Format: int32
|
|
3762
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
3763
|
+
* Specified in milliseconds. If omitted, defaults to 10000.
|
|
3764
|
+
*/
|
|
3765
|
+
recvWindow?: number | null;
|
|
3766
|
+
};
|
|
3767
|
+
/** @description Parameters for `POST /v5/asset/withdraw/create`. Master-only. */
|
|
3768
|
+
BybitWithdrawRequest: {
|
|
3769
|
+
/**
|
|
3770
|
+
* @description Source wallet (`"FUND"` or `"SPOT"`). Defaults to Bybit's account-level
|
|
3771
|
+
* default when omitted.
|
|
3772
|
+
*/
|
|
3773
|
+
accountType?: string | null;
|
|
3774
|
+
/** @description Destination address. Must already be in Bybit's address book. */
|
|
3775
|
+
address: string;
|
|
3776
|
+
/** @description Amount as a decimal string. Sent verbatim. */
|
|
3777
|
+
amount: string;
|
|
3778
|
+
/** @description Network identifier (e.g. `"ETH"`, `"TRX"`). Required by Bybit. */
|
|
3779
|
+
chain: string;
|
|
3780
|
+
/** @description Coin symbol (e.g. `"USDT"`, `"BTC"`). */
|
|
3781
|
+
coin: string;
|
|
3782
|
+
/**
|
|
3783
|
+
* Format: int32
|
|
3784
|
+
* @description Force-chain flag: `0` (default), `1`, or `2`. See Bybit docs.
|
|
3785
|
+
*/
|
|
3786
|
+
forceChain?: number | null;
|
|
3787
|
+
/** @description Client-supplied request id (UUID). Used by Bybit for idempotency. */
|
|
3788
|
+
requestId: string;
|
|
3789
|
+
/** @description Optional memo / tag (e.g. for XRP, XLM). */
|
|
3790
|
+
tag?: string | null;
|
|
3791
|
+
/**
|
|
3792
|
+
* Format: int64
|
|
3793
|
+
* @description Server-supplied timestamp (ms since epoch). Set by the signer just before
|
|
3794
|
+
* signing; clients leave this `None` (because the server will ignore it anyway).
|
|
3795
|
+
*/
|
|
3796
|
+
timestamp?: number | null;
|
|
3797
|
+
};
|
|
3798
|
+
/** @description Response of `POST /v5/asset/withdraw/create`. */
|
|
3799
|
+
BybitWithdrawResponse: {
|
|
3800
|
+
/** @description Bybit-assigned withdrawal id. */
|
|
3801
|
+
id: string;
|
|
3802
|
+
};
|
|
3803
|
+
/**
|
|
3804
|
+
* @description Parameters envelope for all Bybit RPC variants whose payload schema is
|
|
3805
|
+
* derived from a `*Request` struct. (`BybitQueryUserParams` and
|
|
3806
|
+
* `BybitQuerySubMembersParams` have no per-variant payload and are defined
|
|
3807
|
+
* directly below.)
|
|
3808
|
+
*/
|
|
3809
|
+
BybitWithdrawalsParams: components["schemas"]["BybitWithdrawalsRequest"] & {
|
|
3810
|
+
dryRun?: components["schemas"]["BybitDryRunMode"] | null;
|
|
3811
|
+
keyId: components["schemas"]["Id"];
|
|
3812
|
+
/**
|
|
3813
|
+
* Format: int32
|
|
3814
|
+
* @description Optional "receive window", i.e., for how long the request stays valid.
|
|
3815
|
+
* Specified in milliseconds. If omitted, defaults to 10000.
|
|
3816
|
+
*/
|
|
3817
|
+
recvWindow?: number | null;
|
|
3818
|
+
};
|
|
3819
|
+
/** @description Parameters for `GET /v5/asset/withdraw/query-record`. */
|
|
3820
|
+
BybitWithdrawalsRequest: {
|
|
3821
|
+
/** @description Filter by coin symbol. */
|
|
3822
|
+
coin?: string | null;
|
|
3823
|
+
/**
|
|
3824
|
+
* Format: int32
|
|
3825
|
+
* @description Page size.
|
|
3826
|
+
*/
|
|
3827
|
+
limit?: number | null;
|
|
3828
|
+
/**
|
|
3829
|
+
* @description Filter by Bybit-assigned withdrawal id (the `id` returned by
|
|
3830
|
+
* [`BybitRpc::Withdraw`]).
|
|
3831
|
+
*/
|
|
3832
|
+
withdrawID?: string | null;
|
|
3833
|
+
};
|
|
3834
|
+
/** @description Response of `GET /v5/asset/withdraw/query-record`. */
|
|
3835
|
+
BybitWithdrawalsResponse: {
|
|
3836
|
+
/**
|
|
3837
|
+
* @description Opaque cursor to pass back as `cursor` on the next request to fetch
|
|
3838
|
+
* the next page; absent on the last page.
|
|
3839
|
+
*/
|
|
3840
|
+
nextPageCursor?: string | null;
|
|
3841
|
+
/** @description Withdrawal records matching the query. */
|
|
3842
|
+
rows: components["schemas"]["BybitWithdrawEntry"][];
|
|
3843
|
+
};
|
|
3311
3844
|
CancelInvitationRequest: {
|
|
3312
3845
|
email: components["schemas"]["Email"];
|
|
3313
3846
|
};
|
|
3847
|
+
/** @description Parameters for the [`cs_cancelTransaction`](RpcMethod::CancelTransaction) method. */
|
|
3848
|
+
CancelTransactionRequest: {
|
|
3849
|
+
/** @description The transaction id. */
|
|
3850
|
+
id: string;
|
|
3851
|
+
};
|
|
3314
3852
|
/**
|
|
3315
3853
|
* @description Supported Canton environments.
|
|
3316
3854
|
* @enum {string}
|
|
@@ -3461,6 +3999,8 @@ export interface components {
|
|
|
3461
3999
|
withdrawFee?: string | null;
|
|
3462
4000
|
/** @description Step size for withdrawal amounts, as a decimal string. */
|
|
3463
4001
|
withdrawIntegerMultiple?: string | null;
|
|
4002
|
+
/** @description Minimum internal transfer amount */
|
|
4003
|
+
withdrawInternalMin?: string | null;
|
|
3464
4004
|
/** @description Maximum withdrawal amount, as a decimal string. */
|
|
3465
4005
|
withdrawMax?: string | null;
|
|
3466
4006
|
/** @description Minimum withdrawal amount, as a decimal string. */
|
|
@@ -4038,6 +4578,11 @@ export interface components {
|
|
|
4038
4578
|
method: "cs_retryTransaction";
|
|
4039
4579
|
params: components["schemas"]["RetryTransactionRequest"];
|
|
4040
4580
|
},
|
|
4581
|
+
{
|
|
4582
|
+
/** @enum {string} */
|
|
4583
|
+
method: "cs_cancelTransaction";
|
|
4584
|
+
params: components["schemas"]["CancelTransactionRequest"];
|
|
4585
|
+
},
|
|
4041
4586
|
{
|
|
4042
4587
|
/** @enum {string} */
|
|
4043
4588
|
method: "cs_getTransaction";
|
|
@@ -4081,6 +4626,121 @@ export interface components {
|
|
|
4081
4626
|
/** @description Custom EVM chains. */
|
|
4082
4627
|
evm: components["schemas"]["EvmCustomChain"][];
|
|
4083
4628
|
};
|
|
4629
|
+
/** @description One deposit entry in [`DepositHistoryResponse`]. */
|
|
4630
|
+
DepositHistoryEntry: {
|
|
4631
|
+
/** @description Destination address the deposit was sent to. */
|
|
4632
|
+
address: string;
|
|
4633
|
+
/**
|
|
4634
|
+
* @description Secondary address identifier (e.g. memo for XRP, tag for XLM). Empty
|
|
4635
|
+
* string when the asset does not use one.
|
|
4636
|
+
*/
|
|
4637
|
+
addressTag?: string | null;
|
|
4638
|
+
/** @description Deposit amount, as a decimal string. */
|
|
4639
|
+
amount: string;
|
|
4640
|
+
/** @description Asset symbol (e.g. `"USDT"`, `"BTC"`). */
|
|
4641
|
+
coin: string;
|
|
4642
|
+
/**
|
|
4643
|
+
* Format: int64
|
|
4644
|
+
* @description Represents deposit completion datetime, available for deposits after 6-Mar-2025.
|
|
4645
|
+
*/
|
|
4646
|
+
completeTime?: number | null;
|
|
4647
|
+
/** @description On-chain confirmation progress (e.g. `"1/1"`). */
|
|
4648
|
+
confirmTimes?: string | null;
|
|
4649
|
+
/** @description Binance-assigned deposit id. */
|
|
4650
|
+
id?: string | null;
|
|
4651
|
+
/**
|
|
4652
|
+
* Format: int64
|
|
4653
|
+
* @description Time the deposit record was created (ms since epoch).
|
|
4654
|
+
*/
|
|
4655
|
+
insertTime: number;
|
|
4656
|
+
/** @description Blockchain network identifier (e.g. `"BSC"`, `"ETH"`). */
|
|
4657
|
+
network: string;
|
|
4658
|
+
/** @description Returned when 'includeSource' in the request is set to true */
|
|
4659
|
+
sourceAddress?: string | null;
|
|
4660
|
+
/**
|
|
4661
|
+
* Format: int32
|
|
4662
|
+
* @description Deposit status. Binance values: `0` = pending, `6` = credited but
|
|
4663
|
+
* cannot withdraw, `7` = wrong deposit, `8` = waiting user confirm,
|
|
4664
|
+
* `1` = success. Left as `u8` for forward compatibility.
|
|
4665
|
+
*/
|
|
4666
|
+
status: number;
|
|
4667
|
+
/**
|
|
4668
|
+
* Format: int32
|
|
4669
|
+
* @description `0` = external transfer, `1` = internal (Binance↔Binance) transfer.
|
|
4670
|
+
*/
|
|
4671
|
+
transferType: number;
|
|
4672
|
+
/**
|
|
4673
|
+
* Format: int32
|
|
4674
|
+
* @description 0: travel rule not required OR info already provided and funds ready to use;
|
|
4675
|
+
* 1: travel rule required to provide deposit info
|
|
4676
|
+
*/
|
|
4677
|
+
travelRuleStatus: number;
|
|
4678
|
+
/** @description On-chain transaction hash of the deposit. */
|
|
4679
|
+
txId: string;
|
|
4680
|
+
/**
|
|
4681
|
+
* Format: int32
|
|
4682
|
+
* @description Confirmations after which the deposit is unlocked for trading.
|
|
4683
|
+
*/
|
|
4684
|
+
unlockConfirm?: number | null;
|
|
4685
|
+
/**
|
|
4686
|
+
* Format: int32
|
|
4687
|
+
* @description Destination wallet: `0` = spot wallet, `1` = funding wallet.
|
|
4688
|
+
*/
|
|
4689
|
+
walletType: number;
|
|
4690
|
+
};
|
|
4691
|
+
/**
|
|
4692
|
+
* @description Parameters for `GET /sapi/v1/capital/deposit/hisrec`.
|
|
4693
|
+
*
|
|
4694
|
+
* Returns the calling account's deposit history. All filters are optional;
|
|
4695
|
+
* if `start_time`/`end_time` are omitted, Binance returns the most recent 90
|
|
4696
|
+
* days. Use `tx_id` to look up a specific deposit by its on-chain
|
|
4697
|
+
* transaction hash, or `coin`/`status` to narrow the result set.
|
|
4698
|
+
*/
|
|
4699
|
+
DepositHistoryRequest: {
|
|
4700
|
+
/** @description Filter to a specific asset (e.g. `"USDT"`, `"BTC"`). */
|
|
4701
|
+
coin?: string | null;
|
|
4702
|
+
/**
|
|
4703
|
+
* Format: int64
|
|
4704
|
+
* @description Window end (ms since epoch, Binance default: present timestamp).
|
|
4705
|
+
*/
|
|
4706
|
+
endTime?: number | null;
|
|
4707
|
+
/**
|
|
4708
|
+
* @description If `true`, include the deposit's source address in each entry. Binance
|
|
4709
|
+
* defaults to `false`.
|
|
4710
|
+
*/
|
|
4711
|
+
includeSource?: boolean | null;
|
|
4712
|
+
/**
|
|
4713
|
+
* Format: int32
|
|
4714
|
+
* @description Page size (Binance default and max: 1000).
|
|
4715
|
+
*/
|
|
4716
|
+
limit?: number | null;
|
|
4717
|
+
/**
|
|
4718
|
+
* Format: int32
|
|
4719
|
+
* @description Pagination offset (Binance default: 0).
|
|
4720
|
+
*/
|
|
4721
|
+
offset?: number | null;
|
|
4722
|
+
/**
|
|
4723
|
+
* Format: int64
|
|
4724
|
+
* @description Window start (ms since epoch, Binance default: 90 days from current timestamp).
|
|
4725
|
+
*/
|
|
4726
|
+
startTime?: number | null;
|
|
4727
|
+
/**
|
|
4728
|
+
* Format: int32
|
|
4729
|
+
* @description Filter by deposit status. Binance values: `0` = pending, `6` = credited
|
|
4730
|
+
* but cannot withdraw, `7` = wrong deposit, `8` = waiting user confirm,
|
|
4731
|
+
* `1` = success, `2` = rejected. Left as `u8` for forward compatibility.
|
|
4732
|
+
*/
|
|
4733
|
+
status?: number | null;
|
|
4734
|
+
/** @description Look up a specific deposit by its on-chain transaction hash. */
|
|
4735
|
+
txId?: string | null;
|
|
4736
|
+
};
|
|
4737
|
+
/**
|
|
4738
|
+
* @description Response returned by `cs_binanceDepositHistory`.
|
|
4739
|
+
*
|
|
4740
|
+
* Binance returns a top-level JSON array; this newtype preserves that wire
|
|
4741
|
+
* format while giving the response a named type in the OpenAPI schema.
|
|
4742
|
+
*/
|
|
4743
|
+
DepositHistoryResponse: components["schemas"]["DepositHistoryEntry"][];
|
|
4084
4744
|
/**
|
|
4085
4745
|
* @description Parameters for `GET /sapi/v1/capital/deposit/address`.
|
|
4086
4746
|
*
|
|
@@ -4105,7 +4765,7 @@ export interface components {
|
|
|
4105
4765
|
DepositResponse: {
|
|
4106
4766
|
/** @description Deposit address. */
|
|
4107
4767
|
address: string;
|
|
4108
|
-
/** @description Asset symbol (echoes
|
|
4768
|
+
/** @description Asset symbol (echoes the request's `coin` field). */
|
|
4109
4769
|
coin: string;
|
|
4110
4770
|
/**
|
|
4111
4771
|
* @description Secondary address identifier required by some assets (e.g. memo for
|
|
@@ -4926,7 +5586,7 @@ export interface components {
|
|
|
4926
5586
|
* @description Explicitly named scopes for accessing CubeSigner APIs
|
|
4927
5587
|
* @enum {string}
|
|
4928
5588
|
*/
|
|
4929
|
-
ExplicitScope: "sign:*" | "sign:ava" | "sign:binance:*" | "sign:binance:subToMaster" | "sign:binance:subToSub" | "sign:binance:universalTransfer" | "sign:binance:subAccountAssets" | "sign:binance:accountInfo" | "sign:binance:subAccountTransferHistory" | "sign:binance:universalTransferHistory" | "sign:binance:withdraw" | "sign:binance:withdrawHistory" | "sign:binance:deposit" | "sign:binance:listSubAccounts" | "sign:binance:coinInfo" | "sign:coinbase:*" | "sign:coinbase:accounts:list" | "sign:coinbase:portfolios:list" | "sign:coinbase:funds:move" | "sign:blob" | "sign:diffieHellman" | "sign:btc:*" | "sign:btc:segwit" | "sign:btc:taproot" | "sign:btc:psbt:*" | "sign:btc:psbt:doge" | "sign:btc:psbt:legacy" | "sign:btc:psbt:segwit" | "sign:btc:psbt:taproot" | "sign:btc:psbt:ltcSegwit" | "sign:btc:message:*" | "sign:btc:message:segwit" | "sign:btc:message:legacy" | "sign:babylon:*" | "sign:babylon:eots:*" | "sign:babylon:eots:nonces" | "sign:babylon:eots:sign" | "sign:babylon:staking:*" | "sign:babylon:staking:deposit" | "sign:babylon:staking:unbond" | "sign:babylon:staking:withdraw" | "sign:babylon:staking:slash" | "sign:babylon:registration" | "sign:babylon:covenant" | "sign:evm:*" | "sign:evm:tx" | "sign:evm:eip191" | "sign:evm:eip712" | "sign:eth2:*" | "sign:eth2:validate" | "sign:eth2:stake" | "sign:eth2:unstake" | "sign:solana" | "sign:sui" | "sign:tendermint" | "sign:mmi" | "manage:*" | "manage:readonly" | "manage:email:*" | "manage:email:get" | "manage:email:update" | "manage:email:delete" | "manage:mfa:*" | "manage:mfa:readonly" | "manage:mfa:list" | "manage:mfa:vote:*" | "manage:mfa:vote:cs" | "manage:mfa:vote:email" | "manage:mfa:vote:fido" | "manage:mfa:vote:totp" | "manage:mfa:register:*" | "manage:mfa:register:fido" | "manage:mfa:register:totp" | "manage:mfa:register:email" | "manage:mfa:unregister:*" | "manage:mfa:unregister:fido" | "manage:mfa:unregister:totp" | "manage:mfa:verify:*" | "manage:mfa:verify:totp" | "manage:key:*" | "manage:key:readonly" | "manage:key:get" | "manage:key:attest" | "manage:key:listRoles" | "manage:key:list" | "manage:key:history:tx:list" | "manage:key:create" | "manage:key:import" | "manage:key:update:*" | "manage:key:update:owner" | "manage:key:update:policy" | "manage:key:update:enabled" | "manage:key:update:region" | "manage:key:update:metadata" | "manage:key:update:properties" | "manage:key:update:editPolicy" | "manage:key:delete" | "manage:policy:*" | "manage:policy:readonly" | "manage:policy:create" | "manage:policy:get" | "manage:policy:list" | "manage:policy:delete" | "manage:policy:update:*" | "manage:policy:update:owner" | "manage:policy:update:name" | "manage:policy:update:acl" | "manage:policy:update:editPolicy" | "manage:policy:update:metadata" | "manage:policy:update:rule" | "manage:policy:invoke" | "manage:policy:wasm:*" | "manage:policy:wasm:upload" | "manage:policy:secrets:*" | "manage:policy:secrets:get" | "manage:policy:secrets:update:*" | "manage:policy:secrets:update:values" | "manage:policy:secrets:update:acl" | "manage:policy:secrets:update:editPolicy" | "manage:policy:buckets:*" | "manage:policy:buckets:get" | "manage:policy:buckets:list" | "manage:policy:buckets:update:*" | "manage:policy:buckets:update:owner" | "manage:policy:buckets:update:acl" | "manage:policy:buckets:update:metadata" | "manage:contact:*" | "manage:contact:readonly" | "manage:contact:create" | "manage:contact:get" | "manage:contact:list" | "manage:contact:delete" | "manage:contact:update:*" | "manage:contact:update:name" | "manage:contact:update:addresses" | "manage:contact:update:owner" | "manage:contact:update:labels" | "manage:contact:update:metadata" | "manage:contact:update:editPolicy" | "manage:contact:lookup:*" | "manage:contact:lookup:address" | "manage:policy:createImportKey" | "manage:role:*" | "manage:role:readonly" | "manage:role:create" | "manage:role:delete" | "manage:role:get:*" | "manage:role:attest" | "manage:role:get:keys" | "manage:role:get:keys:list" | "manage:role:get:keys:get" | "manage:role:get:users" | "manage:role:list" | "manage:role:update:*" | "manage:role:update:enabled" | "manage:role:update:policy" | "manage:role:update:editPolicy" | "manage:role:update:actions" | "manage:role:update:key:*" | "manage:role:update:key:add" | "manage:role:update:key:remove" | "manage:role:update:user:*" | "manage:role:update:user:add" | "manage:role:update:user:remove" | "manage:role:history:tx:list" | "manage:identity:*" | "manage:identity:readonly" | "manage:identity:verify" | "manage:identity:add" | "manage:identity:remove" | "manage:identity:list" | "manage:org:*" | "manage:org:create" | "manage:org:metrics:query" | "manage:org:audit:query" | "manage:org:readonly" | "manage:org:addUser" | "manage:org:inviteUser" | "manage:org:inviteAlien" | "manage:org:invitation:list" | "manage:org:invitation:cancel" | "manage:org:updateMembership:*" | "manage:org:updateMembership:owner" | "manage:org:updateMembership:member" | "manage:org:updateMembership:alien" | "manage:org:listUsers" | "manage:org:user:get" | "manage:org:deleteUser:*" | "manage:org:deleteUser:owner" | "manage:org:deleteUser:member" | "manage:org:deleteUser:alien" | "manage:org:get" | "manage:org:update:*" | "manage:org:update:enabled" | "manage:org:update:policy" | "manage:org:update:signPolicy" | "manage:org:update:export" | "manage:org:update:totpFailureLimit" | "manage:org:update:notificationEndpoints" | "manage:org:update:defaultInviteKind" | "manage:org:update:idpConfiguration" | "manage:org:update:passkeyConfiguration" | "manage:org:update:emailPreferences" | "manage:org:update:historicalData" | "manage:org:update:requireScopeCeiling" | "manage:org:update:alienLoginRequirement" | "manage:org:update:memberLoginRequirement" | "manage:org:update:keyExportRequirement" | "manage:org:update:allowedMfaTypes" | "manage:org:update:policyEngineConf" | "manage:org:update:customChains" | "manage:org:update:extProps" | "manage:org:update:editPolicy" | "manage:org:user:resetMfa" | "manage:session:*" | "manage:session:readonly" | "manage:session:get" | "manage:session:list" | "manage:session:create" | "manage:session:extend" | "manage:session:revoke" | "manage:export:*" | "manage:export:readonly" | "manage:export:org:*" | "manage:export:org:get" | "manage:export:user:*" | "manage:export:user:delete" | "manage:export:user:list" | "manage:authMigration:*" | "manage:authMigration:identity:add" | "manage:authMigration:identity:remove" | "manage:authMigration:user:update" | "manage:mmi:*" | "manage:mmi:readonly" | "manage:mmi:get" | "manage:mmi:list" | "manage:mmi:reject" | "manage:mmi:delete" | "export:*" | "export:user:*" | "export:user:init" | "export:user:complete" | "mmi:*" | "orgAccess:*" | "orgAccess:child:*" | "rpc:*" | "rpc:createTransaction:*" | "rpc:createTransaction:evm" | "rpc:retryTransaction" | "rpc:getTransaction" | "rpc:listTransactions" | "rpc:binance" | "rpc:coinbase";
|
|
5589
|
+
ExplicitScope: "sign:*" | "sign:ava" | "sign:binance:*" | "sign:binance:subToMaster" | "sign:binance:subToSub" | "sign:binance:universalTransfer" | "sign:binance:subAccountAssets" | "sign:binance:accountInfo" | "sign:binance:subAccountTransferHistory" | "sign:binance:universalTransferHistory" | "sign:binance:withdraw" | "sign:binance:withdrawHistory" | "sign:binance:deposit" | "sign:binance:depositHistory" | "sign:binance:listSubAccounts" | "sign:binance:coinInfo" | "sign:bybit:*" | "sign:bybit:queryUser" | "sign:bybit:querySubMembers" | "sign:bybit:queryCoinsBalance" | "sign:bybit:queryDepositAddress" | "sign:bybit:universalTransfer" | "sign:bybit:withdraw" | "sign:bybit:withdrawals" | "sign:coinbase:*" | "sign:coinbase:accounts:list" | "sign:coinbase:portfolios:list" | "sign:coinbase:funds:move" | "sign:blob" | "sign:diffieHellman" | "sign:btc:*" | "sign:btc:segwit" | "sign:btc:taproot" | "sign:btc:psbt:*" | "sign:btc:psbt:doge" | "sign:btc:psbt:legacy" | "sign:btc:psbt:segwit" | "sign:btc:psbt:taproot" | "sign:btc:psbt:ltcSegwit" | "sign:btc:message:*" | "sign:btc:message:segwit" | "sign:btc:message:legacy" | "sign:babylon:*" | "sign:babylon:eots:*" | "sign:babylon:eots:nonces" | "sign:babylon:eots:sign" | "sign:babylon:staking:*" | "sign:babylon:staking:deposit" | "sign:babylon:staking:unbond" | "sign:babylon:staking:withdraw" | "sign:babylon:staking:slash" | "sign:babylon:registration" | "sign:babylon:covenant" | "sign:evm:*" | "sign:evm:tx" | "sign:evm:eip191" | "sign:evm:eip712" | "sign:eth2:*" | "sign:eth2:validate" | "sign:eth2:stake" | "sign:eth2:unstake" | "sign:solana" | "sign:sui" | "sign:tendermint" | "sign:mmi" | "manage:*" | "manage:readonly" | "manage:email:*" | "manage:email:get" | "manage:email:update" | "manage:email:delete" | "manage:mfa:*" | "manage:mfa:readonly" | "manage:mfa:list" | "manage:mfa:vote:*" | "manage:mfa:vote:cs" | "manage:mfa:vote:email" | "manage:mfa:vote:fido" | "manage:mfa:vote:totp" | "manage:mfa:register:*" | "manage:mfa:register:fido" | "manage:mfa:register:totp" | "manage:mfa:register:email" | "manage:mfa:unregister:*" | "manage:mfa:unregister:fido" | "manage:mfa:unregister:totp" | "manage:mfa:verify:*" | "manage:mfa:verify:totp" | "manage:key:*" | "manage:key:readonly" | "manage:key:get" | "manage:key:attest" | "manage:key:listRoles" | "manage:key:list" | "manage:key:history:tx:list" | "manage:key:create" | "manage:key:import" | "manage:key:update:*" | "manage:key:update:owner" | "manage:key:update:policy" | "manage:key:update:enabled" | "manage:key:update:region" | "manage:key:update:metadata" | "manage:key:update:properties" | "manage:key:update:editPolicy" | "manage:key:delete" | "manage:policy:*" | "manage:policy:readonly" | "manage:policy:create" | "manage:policy:get" | "manage:policy:list" | "manage:policy:delete" | "manage:policy:update:*" | "manage:policy:update:owner" | "manage:policy:update:name" | "manage:policy:update:acl" | "manage:policy:update:editPolicy" | "manage:policy:update:metadata" | "manage:policy:update:rule" | "manage:policy:invoke" | "manage:policy:wasm:*" | "manage:policy:wasm:upload" | "manage:policy:secrets:*" | "manage:policy:secrets:get" | "manage:policy:secrets:update:*" | "manage:policy:secrets:update:values" | "manage:policy:secrets:update:acl" | "manage:policy:secrets:update:editPolicy" | "manage:policy:buckets:*" | "manage:policy:buckets:get" | "manage:policy:buckets:list" | "manage:policy:buckets:update:*" | "manage:policy:buckets:update:owner" | "manage:policy:buckets:update:acl" | "manage:policy:buckets:update:metadata" | "manage:contact:*" | "manage:contact:readonly" | "manage:contact:create" | "manage:contact:get" | "manage:contact:list" | "manage:contact:delete" | "manage:contact:update:*" | "manage:contact:update:name" | "manage:contact:update:addresses" | "manage:contact:update:owner" | "manage:contact:update:labels" | "manage:contact:update:metadata" | "manage:contact:update:editPolicy" | "manage:contact:lookup:*" | "manage:contact:lookup:address" | "manage:policy:createImportKey" | "manage:role:*" | "manage:role:readonly" | "manage:role:create" | "manage:role:delete" | "manage:role:get:*" | "manage:role:attest" | "manage:role:get:keys" | "manage:role:get:keys:list" | "manage:role:get:keys:get" | "manage:role:get:users" | "manage:role:list" | "manage:role:update:*" | "manage:role:update:enabled" | "manage:role:update:policy" | "manage:role:update:editPolicy" | "manage:role:update:actions" | "manage:role:update:key:*" | "manage:role:update:key:add" | "manage:role:update:key:remove" | "manage:role:update:user:*" | "manage:role:update:user:add" | "manage:role:update:user:remove" | "manage:role:history:tx:list" | "manage:identity:*" | "manage:identity:readonly" | "manage:identity:verify" | "manage:identity:add" | "manage:identity:remove" | "manage:identity:list" | "manage:org:*" | "manage:org:create" | "manage:org:metrics:query" | "manage:org:audit:query" | "manage:org:readonly" | "manage:org:addUser" | "manage:org:inviteUser" | "manage:org:inviteAlien" | "manage:org:invitation:list" | "manage:org:invitation:cancel" | "manage:org:updateMembership:*" | "manage:org:updateMembership:owner" | "manage:org:updateMembership:member" | "manage:org:updateMembership:alien" | "manage:org:listUsers" | "manage:org:user:get" | "manage:org:deleteUser:*" | "manage:org:deleteUser:owner" | "manage:org:deleteUser:member" | "manage:org:deleteUser:alien" | "manage:org:get" | "manage:org:update:*" | "manage:org:update:enabled" | "manage:org:update:policy" | "manage:org:update:signPolicy" | "manage:org:update:export" | "manage:org:update:totpFailureLimit" | "manage:org:update:notificationEndpoints" | "manage:org:update:defaultInviteKind" | "manage:org:update:idpConfiguration" | "manage:org:update:passkeyConfiguration" | "manage:org:update:emailPreferences" | "manage:org:update:historicalData" | "manage:org:update:requireScopeCeiling" | "manage:org:update:alienLoginRequirement" | "manage:org:update:memberLoginRequirement" | "manage:org:update:keyExportRequirement" | "manage:org:update:allowedMfaTypes" | "manage:org:update:policyEngineConf" | "manage:org:update:customChains" | "manage:org:update:extProps" | "manage:org:update:editPolicy" | "manage:org:user:resetMfa" | "manage:session:*" | "manage:session:readonly" | "manage:session:get" | "manage:session:list" | "manage:session:create" | "manage:session:extend" | "manage:session:revoke" | "manage:export:*" | "manage:export:readonly" | "manage:export:org:*" | "manage:export:org:get" | "manage:export:user:*" | "manage:export:user:delete" | "manage:export:user:list" | "manage:authMigration:*" | "manage:authMigration:identity:add" | "manage:authMigration:identity:remove" | "manage:authMigration:user:update" | "manage:mmi:*" | "manage:mmi:readonly" | "manage:mmi:get" | "manage:mmi:list" | "manage:mmi:reject" | "manage:mmi:delete" | "export:*" | "export:user:*" | "export:user:init" | "export:user:complete" | "mmi:*" | "orgAccess:*" | "orgAccess:child:*" | "rpc:*" | "rpc:createTransaction:*" | "rpc:createTransaction:evm" | "rpc:retryTransaction" | "rpc:cancelTransaction" | "rpc:getTransaction" | "rpc:listTransactions" | "rpc:binance" | "rpc:bybit" | "rpc:coinbase";
|
|
4930
5590
|
/**
|
|
4931
5591
|
* @description This type specifies the interpretation of the `fee` field in Babylon
|
|
4932
5592
|
* staking requests. If `sats`, the field is intpreted as a fixed value
|
|
@@ -4982,7 +5642,7 @@ export interface components {
|
|
|
4982
5642
|
request_device_identifier?: boolean;
|
|
4983
5643
|
};
|
|
4984
5644
|
/** @enum {string} */
|
|
4985
|
-
ForbiddenErrorCode: "AlienKeyCreate" | "CannotAssumeIdentity" | "SentryDisallowed" | "PasskeyLoginDisabled" | "PasskeyNotRegistered" | "CannotCreateOrg" | "WrongMfaEmailOtpJwt" | "OrgFlagNotSet" | "FidoRequiredToRemoveTotp" | "OidcIdentityLimitReached" | "OidcScopeCeilingMissing" | "OidcIssuerNotAllowedForMemberRole" | "OidcNoMemberRolesAllowed" | "EmailOtpNotConfigured" | "MfaChallengeExpired" | "ChainIdNotAllowed" | "InvalidOrg" | "OrgIdMismatch" | "SessionForWrongOrg" | "SelfDelete" | "SelfDisable" | "InvalidOrgMembershipRoleChange" | "UserDisabled" | "OrgDisabled" | "OrgNotFound" | "OrgWithoutOwner" | "OrphanedUser" | "OidcUserNotFound" | "UserNotInOrg" | "UserNotOrgOwner" | "UserNotKeyOwner" | "InvalidRole" | "DisabledRole" | "KeyDisabled" | "KeyNotInRole" | "ContactNotInOrg" | "UserExportRequestNotInOrg" | "UserExportRequestInvalid" | "UserExportDisabled" | "UserNotOriginalKeyOwner" | "UserNotInRole" | "MustBeFullMember" | "SessionExpired" | "SessionChanged" | "SessionRevoked" | "ExpectedUserSession" | "SessionRoleChanged" | "ScopedNameNotFound" | "SessionInvalidEpochToken" | "SessionInvalidRefreshToken" | "SessionRefreshTokenExpired" | "InvalidAuthHeader" | "SessionNotFound" | "InvalidArn" | "SessionInvalidAuthToken" | "SessionAuthTokenExpired" | "SessionPossiblyStolenToken" | "MfaDisallowedIdentity" | "MfaDisallowedApprover" | "MfaTypeNotAllowed" | "MfaNotApprovedYet" | "MfaConfirmationCodeMismatch" | "MfaHttpRequestMismatch" | "MfaRemoveBelowMin" | "MfaOrgRequirementNotMet" | "MfaRegistrationDisallowed" | "TotpAlreadyConfigured" | "TotpConfigurationChanged" | "MfaTotpBadConfiguration" | "MfaTotpBadCode" | "MfaTotpRateLimit" | "ImproperSessionScope" | "FullSessionRequired" | "SessionWithoutAnyScopeUnder" | "UserRoleUnprivileged" | "MemberRoleForbidden" | "MfaNotConfigured" | "RemoveLastOidcIdentity" | "OperationNotAllowed" | "OrgExportRetrievalDisabled" | "ChangingKeyExportRequirementIsDisabled" | "AutoAddBlsKeyToProtectedRole" | "UserNotPolicyOwner" | "UserNotContactOwner" | "UserNotBucketOwner" | "LegacySessionCannotHaveScopeCeiling" | "RoleInParentOrgNotAllowed" | "RemoveKeyFromRoleUserNotAllowed" | "SiweChallengeExpired" | "SiweMessageNotValid" | "SiweMessageInvalidSignature" | "Acl";
|
|
5645
|
+
ForbiddenErrorCode: "AlienKeyCreate" | "CannotAssumeIdentity" | "SentryDisallowed" | "PasskeyLoginDisabled" | "PasskeyNotRegistered" | "CannotCreateOrg" | "WrongMfaEmailOtpJwt" | "OrgFlagNotSet" | "FidoRequiredToRemoveTotp" | "OidcIdentityLimitReached" | "OidcScopeCeilingMissing" | "OidcIssuerNotAllowedForMemberRole" | "OidcNoMemberRolesAllowed" | "EmailOtpNotConfigured" | "MfaChallengeExpired" | "ChainIdNotAllowed" | "InvalidOrg" | "OrgIdMismatch" | "SessionForWrongOrg" | "SelfDelete" | "SelfDisable" | "InvalidOrgMembershipRoleChange" | "UserDisabled" | "OrgDisabled" | "OrgNotFound" | "OrgWithoutOwner" | "OrphanedUser" | "OidcUserNotFound" | "UserNotInOrg" | "UserNotOrgOwner" | "UserNotKeyOwner" | "InvalidRole" | "DisabledRole" | "KeyDisabled" | "KeyNotInRole" | "ContactNotInOrg" | "UserExportRequestNotInOrg" | "UserExportRequestInvalid" | "UserExportDisabled" | "UserNotOriginalKeyOwner" | "UserNotInRole" | "MustBeFullMember" | "SessionExpired" | "SessionChanged" | "SessionRevoked" | "ExpectedUserSession" | "SessionRoleChanged" | "ScopedNameNotFound" | "SessionInvalidEpochToken" | "SessionInvalidRefreshToken" | "SessionRefreshTokenExpired" | "InvalidAuthHeader" | "SessionNotFound" | "InvalidArn" | "SessionInvalidAuthToken" | "SessionAuthTokenExpired" | "SessionPossiblyStolenToken" | "MfaDisallowedIdentity" | "MfaDisallowedApprover" | "MfaTypeNotAllowed" | "MfaNotApprovedYet" | "MfaConfirmationCodeMismatch" | "MfaHttpRequestMismatch" | "MfaRemoveBelowMin" | "MfaOrgRequirementNotMet" | "MfaRegistrationDisallowed" | "TotpAlreadyConfigured" | "TotpConfigurationChanged" | "MfaTotpBadConfiguration" | "MfaTotpBadCode" | "MfaTotpRateLimit" | "ImproperSessionScope" | "FullSessionRequired" | "SessionWithoutAnyScopeUnder" | "UserRoleUnprivileged" | "MemberRoleForbidden" | "MfaNotConfigured" | "RemoveLastOidcIdentity" | "OperationNotAllowed" | "OrgExportRetrievalDisabled" | "ChangingKeyExportRequirementIsDisabled" | "AutoAddBlsKeyToProtectedRole" | "UserNotPolicyOwner" | "UserNotContactOwner" | "UserNotBucketOwner" | "LegacySessionCannotHaveScopeCeiling" | "RoleInParentOrgNotAllowed" | "RemoveKeyFromRoleUserNotAllowed" | "SiweChallengeExpired" | "SiweMessageNotValid" | "SiweMessageInvalidSignature" | "SiwsChallengeExpired" | "SiwsMessageInvalid" | "Acl";
|
|
4986
5646
|
/**
|
|
4987
5647
|
* @description Specifies a fork of the `BeaconChain`, to prevent replay attacks.
|
|
4988
5648
|
* The schema of `Fork` is defined in the [Beacon chain
|
|
@@ -5400,7 +6060,7 @@ export interface components {
|
|
|
5400
6060
|
result?: Record<string, unknown> | null;
|
|
5401
6061
|
};
|
|
5402
6062
|
/** @description Valid `result` from the JSON-RPC API. */
|
|
5403
|
-
JsonRpcResult: components["schemas"]["TransactionInfo"] | components["schemas"]["ListTransactionsPaginatedResponse"] | components["schemas"]["SubAccountTransferResponse"] | components["schemas"]["UniversalTransferResponse"] | components["schemas"]["SubAccountAssetsResponse"] | components["schemas"]["AccountInfoResponse"] | components["schemas"]["SubAccountTransferHistoryResponse"] | components["schemas"]["UniversalTransferHistoryResponse"] | components["schemas"]["WithdrawResponse"] | components["schemas"]["WithdrawHistoryResponse"] | components["schemas"]["DepositResponse"] | components["schemas"]["ListSubAccountsResponse"] | components["schemas"]["CoinInfoResponse"] | components["schemas"]["CoinbaseListAccountsResponse"] | components["schemas"]["CoinbaseListPortfoliosResponse"] | components["schemas"]["CoinbaseMoveFundsResponse"];
|
|
6063
|
+
JsonRpcResult: components["schemas"]["TransactionInfo"] | components["schemas"]["ListTransactionsPaginatedResponse"] | components["schemas"]["SubAccountTransferResponse"] | components["schemas"]["UniversalTransferResponse"] | components["schemas"]["SubAccountAssetsResponse"] | components["schemas"]["AccountInfoResponse"] | components["schemas"]["SubAccountTransferHistoryResponse"] | components["schemas"]["UniversalTransferHistoryResponse"] | components["schemas"]["WithdrawResponse"] | components["schemas"]["WithdrawHistoryResponse"] | components["schemas"]["DepositResponse"] | components["schemas"]["DepositHistoryResponse"] | components["schemas"]["ListSubAccountsResponse"] | components["schemas"]["CoinInfoResponse"] | components["schemas"]["BybitQueryUserResponse"] | components["schemas"]["BybitQuerySubMembersResponse"] | components["schemas"]["BybitQueryCoinsBalanceResponse"] | components["schemas"]["BybitQueryDepositAddressResponse"] | components["schemas"]["BybitUniversalTransferResponse"] | components["schemas"]["BybitWithdrawResponse"] | components["schemas"]["BybitWithdrawalsResponse"] | components["schemas"]["CoinbaseListAccountsResponse"] | components["schemas"]["CoinbaseListPortfoliosResponse"] | components["schemas"]["CoinbaseMoveFundsResponse"];
|
|
5404
6064
|
JwkSetResponse: {
|
|
5405
6065
|
/** @description The keys included in this set */
|
|
5406
6066
|
keys: Record<string, never>[];
|
|
@@ -5547,10 +6207,14 @@ export interface components {
|
|
|
5547
6207
|
components["schemas"]["CoinbaseApiPropertiesPatch"] & {
|
|
5548
6208
|
/** @enum {string} */
|
|
5549
6209
|
kind: "CoinbaseApi";
|
|
6210
|
+
},
|
|
6211
|
+
components["schemas"]["BybitApiPropertiesPatch"] & {
|
|
6212
|
+
/** @enum {string} */
|
|
6213
|
+
kind: "BybitApi";
|
|
5550
6214
|
}
|
|
5551
6215
|
]>;
|
|
5552
6216
|
/** @enum {string} */
|
|
5553
|
-
KeyType: "SecpEthAddr" | "SecpBtc" | "SecpBtcTest" | "SecpBtcLegacy" | "SecpBtcLegacyTest" | "SecpAvaAddr" | "SecpAvaTestAddr" | "BlsPub" | "BlsInactive" | "BlsAvaIcm" | "Ed25519SolanaAddr" | "Ed25519SuiAddr" | "Ed25519AptosAddr" | "Ed25519CardanoAddrVk" | "Ed25519StellarAddr" | "Ed25519SubstrateAddr" | "Ed25519CantonAddr" | "Ed25519BinanceApi" | "Ed25519CoinbaseApi" | "Mnemonic" | "Stark" | "BabylonEots" | "BabylonCov" | "TaprootBtc" | "TaprootBtcTest" | "SecpCosmosAddr" | "P256CosmosAddr" | "P256OntologyAddr" | "P256Neo3Addr" | "Ed25519TendermintAddr" | "SecpTronAddr" | "Ed25519TonAddr" | "SecpDogeAddr" | "SecpDogeTestAddr" | "SecpKaspaAddr" | "SecpKaspaTestAddr" | "SchnorrKaspaAddr" | "SchnorrKaspaTestAddr" | "SecpLtc" | "SecpLtcTest" | "SecpXrpAddr" | "Ed25519XrpAddr" | "BabyJubjub";
|
|
6217
|
+
KeyType: "SecpEthAddr" | "SecpBtc" | "SecpBtcTest" | "SecpBtcLegacy" | "SecpBtcLegacyTest" | "SecpAvaAddr" | "SecpAvaTestAddr" | "BlsPub" | "BlsInactive" | "BlsAvaIcm" | "Ed25519SolanaAddr" | "Ed25519SuiAddr" | "Ed25519AptosAddr" | "Ed25519CardanoAddrVk" | "Ed25519StellarAddr" | "Ed25519SubstrateAddr" | "Ed25519CantonAddr" | "Ed25519BinanceApi" | "Ed25519CoinbaseApi" | "Mnemonic" | "Stark" | "BabylonEots" | "BabylonCov" | "TaprootBtc" | "TaprootBtcTest" | "SecpCosmosAddr" | "P256CosmosAddr" | "P256OntologyAddr" | "P256Neo3Addr" | "Ed25519TendermintAddr" | "SecpTronAddr" | "Ed25519TonAddr" | "SecpDogeAddr" | "SecpDogeTestAddr" | "SecpKaspaAddr" | "SecpKaspaTestAddr" | "SchnorrKaspaAddr" | "SchnorrKaspaTestAddr" | "SecpLtc" | "SecpLtcTest" | "SecpXrpAddr" | "Ed25519XrpAddr" | "BabyJubjub" | "HmacSha256";
|
|
5554
6218
|
KeyTypeAndDerivationPath: {
|
|
5555
6219
|
/**
|
|
5556
6220
|
* @description List of derivation paths for which to derive.
|
|
@@ -6023,7 +6687,7 @@ export interface components {
|
|
|
6023
6687
|
* @description All different kinds of sensitive operations
|
|
6024
6688
|
* @enum {string}
|
|
6025
6689
|
*/
|
|
6026
|
-
OperationKind: "AvaSign" | "AvaChainTxSign" | "BabylonCovSign" | "BabylonRegistration" | "BabylonStaking" | "
|
|
6690
|
+
OperationKind: "AvaSign" | "AvaChainTxSign" | "BabylonCovSign" | "BabylonRegistration" | "BabylonStaking" | "BinanceSubToMaster" | "BinanceSubToSub" | "BinanceUniversalTransfer" | "BinanceSubAccountAssets" | "BinanceAccountInfo" | "BinanceSubAccountTransferHistory" | "BinanceUniversalTransferHistory" | "BinanceWithdraw" | "BinanceWithdrawHistory" | "BinanceDeposit" | "BinanceDepositHistory" | "BinanceListSubAccounts" | "BinanceCoinInfo" | "BlobSign" | "BtcMessageSign" | "BtcSign" | "BybitQueryUser" | "BybitQuerySubMembers" | "BybitQueryCoinsBalance" | "BybitQueryDepositAddress" | "BybitUniversalTransfer" | "BybitWithdraw" | "BybitWithdrawals" | "CoinbaseListAccounts" | "CoinbaseListPortfolios" | "CoinbaseMoveFunds" | "DiffieHellman" | "PsbtSign" | "TaprootSign" | "Eip191Sign" | "Eip712Sign" | "EotsNonces" | "EotsSign" | "Eth1Sign" | "Eth2Sign" | "Eth2Stake" | "Eth2Unstake" | "SolanaSign" | "SuiSign" | "TendermintSign" | "RoleUpdate";
|
|
6027
6691
|
OrgAlertsPrefs: {
|
|
6028
6692
|
/** @description Recipient users for org-level alerts */
|
|
6029
6693
|
alert_recipients?: components["schemas"]["Id"][] | null;
|
|
@@ -6902,7 +7566,7 @@ export interface components {
|
|
|
6902
7566
|
};
|
|
6903
7567
|
PolicyErrorCode: components["schemas"]["PolicyErrorOwnCodes"] | components["schemas"]["EvmTxDepositErrorCode"];
|
|
6904
7568
|
/** @enum {string} */
|
|
6905
|
-
PolicyErrorOwnCodes: "Inapplicable" | "SuiTxReceiversDisallowedTransactionKind" | "SuiTxReceiversDisallowedTransferAddress" | "SuiTxReceiversDisallowedCommand" | "BtcTxDisallowedOutputs" | "BtcSignatureExceededValue" | "BtcValueOverflow" | "BtcSighashTypeDisallowed" | "EvmTxReceiverMismatch" | "EvmTxChainIdMismatch" | "EvmTxSenderMismatch" | "EvmTxExceededValue" | "EvmTxExceededGasCost" | "EvmTxGasCostUndefined" | "EvmDataDisallowed" | "Erc20DataInvalid" | "EvmContractAddressUndefined" | "EvmContractChainIdUndefined" | "EvmDataNotDefined" | "EvmDataInvalid" | "EvmContractNotInAllowlist" | "Erc20ExceededTransferLimit" | "Erc20ReceiverMismatch" | "Erc20ExceededApproveLimit" | "Erc20SpenderMismatch" | "EvmFunctionNotInAllowlist" | "EvmFunctionCallInvalid" | "EvmFunctionCallDisallowedArg" | "PolicyDisjunctionError" | "PolicyNegationError" | "Eth2ExceededMaxUnstake" | "Eth2ConcurrentUnstaking" | "NotInIpv4Allowlist" | "NotInOriginAllowlist" | "NotInOperationAllowlist" | "InvalidSourceIp" | "RawSigningNotAllowed" | "DiffieHellmanExchangeNotAllowed" | "Eip712SigningNotAllowed" | "OidcSourceNotAllowed" | "NoOidcAuthSourcesDefined" | "AddKeyToRoleDisallowed" | "KeysAlreadyInRole" | "KeyInMultipleRoles" | "KeyAccessError" | "RequireRoleSessionKeyAccessError" | "BtcMessageSigningNotAllowed" | "Eip191SigningNotAllowed" | "TaprootSigningDisallowed" | "SegwitSigningDisallowed" | "PsbtSigningDisallowed" | "BabylonStakingDisallowed" | "TimeLocked" | "BabylonStakingNetwork" | "BabylonStakingParamsVersion" | "BabylonStakingExplicitParams" | "BabylonStakingStakerPk" | "BabylonStakingFinalityProviderPk" | "BabylonStakingLockTime" | "BabylonStakingValue" | "BabylonStakingChangeAddress" | "BabylonStakingFee" | "BabylonStakingWithdrawalAddress" | "BabylonStakingBbnAddress" | "SolanaInstructionCountLow" | "SolanaInstructionCountHigh" | "SolanaNotInInstructionAllowlist" | "SolanaInstructionMismatch" | "WasmPoliciesDisabled" | "WasmPolicyDenied" | "WasmPolicyFailed" | "WebhookPoliciesDisabled" | "DeniedByWebhook";
|
|
7569
|
+
PolicyErrorOwnCodes: "Inapplicable" | "SuiTxReceiversDisallowedTransactionKind" | "SuiTxReceiversDisallowedTransferAddress" | "SuiTxReceiversDisallowedCommand" | "BtcTxDisallowedOutputs" | "BtcSignatureExceededValue" | "BtcValueOverflow" | "BtcSighashTypeDisallowed" | "EvmTxReceiverMismatch" | "EvmTxChainIdMismatch" | "EvmTxSenderMismatch" | "EvmTxExceededValue" | "EvmTxExceededGasCost" | "EvmTxGasCostUndefined" | "EvmDataDisallowed" | "Erc20DataInvalid" | "EvmContractAddressUndefined" | "EvmContractChainIdUndefined" | "EvmDataNotDefined" | "EvmDataInvalid" | "EvmContractNotInAllowlist" | "Erc20ExceededTransferLimit" | "Erc20ReceiverMismatch" | "Erc20ExceededApproveLimit" | "Erc20SpenderMismatch" | "EvmFunctionNotInAllowlist" | "EvmFunctionCallInvalid" | "EvmFunctionCallDisallowedArg" | "PolicyDisjunctionError" | "PolicyNegationError" | "Eth2ExceededMaxUnstake" | "Eth2ConcurrentUnstaking" | "NotInIpv4Allowlist" | "NotInOriginAllowlist" | "NotInOperationAllowlist" | "InvalidSourceIp" | "RawSigningNotAllowed" | "DiffieHellmanExchangeNotAllowed" | "Eip712SigningNotAllowed" | "OidcSourceNotAllowed" | "NoOidcAuthSourcesDefined" | "AddKeyToRoleDisallowed" | "KeysAlreadyInRole" | "KeyInMultipleRoles" | "KeyAccessError" | "RequireRoleSessionKeyAccessError" | "BtcMessageSigningNotAllowed" | "Eip191SigningNotAllowed" | "TaprootSigningDisallowed" | "SegwitSigningDisallowed" | "PsbtSigningDisallowed" | "BabylonStakingDisallowed" | "TimeLocked" | "CelPolicyDenied" | "BabylonStakingNetwork" | "BabylonStakingParamsVersion" | "BabylonStakingExplicitParams" | "BabylonStakingStakerPk" | "BabylonStakingFinalityProviderPk" | "BabylonStakingLockTime" | "BabylonStakingValue" | "BabylonStakingChangeAddress" | "BabylonStakingFee" | "BabylonStakingWithdrawalAddress" | "BabylonStakingBbnAddress" | "SolanaInstructionCountLow" | "SolanaInstructionCountHigh" | "SolanaNotInInstructionAllowlist" | "SolanaInstructionMismatch" | "WasmPoliciesDisabled" | "WasmPolicyDenied" | "WasmPolicyFailed" | "WebhookPoliciesDisabled" | "DeniedByWebhook" | "ExplicitlyDenied";
|
|
6906
7570
|
/** @description A struct containing all the information about a specific version of a policy. */
|
|
6907
7571
|
PolicyInfo: {
|
|
6908
7572
|
/** @description The access-control entries for the policy. */
|
|
@@ -7621,18 +8285,18 @@ export interface components {
|
|
|
7621
8285
|
};
|
|
7622
8286
|
RpcApiErrorCode: components["schemas"]["RpcApiErrorOwnCodes"] | components["schemas"]["SignerClientErrorCode"] | components["schemas"]["RpcEvmErrorCode"];
|
|
7623
8287
|
/** @enum {string} */
|
|
7624
|
-
RpcApiErrorOwnCodes: "MfaRequired" | "ConcurrentTransactionFailed";
|
|
8288
|
+
RpcApiErrorOwnCodes: "MfaRequired" | "ConcurrentTransactionFailed" | "InvalidTxStatus";
|
|
7625
8289
|
/** @enum {string} */
|
|
7626
|
-
RpcEvmErrorCode: "SubmissionFailed" | "FailedToReserveNonce" | "
|
|
8290
|
+
RpcEvmErrorCode: "SubmissionFailed" | "FailedToReserveNonce" | "MissingTxField" | "Signer";
|
|
7627
8291
|
/**
|
|
7628
8292
|
* @description The RPC API method and matching parameters.
|
|
7629
8293
|
*
|
|
7630
8294
|
* Top-level dispatch. Wire format is preserved by `#[serde(untagged)]`: each
|
|
7631
8295
|
* inbound request is matched against one of the internally-tagged inner enums
|
|
7632
8296
|
* ([`CsRpc`] for the core methods, [`BinanceRpc`] for the Binance family,
|
|
7633
|
-
* [`CoinbaseRpc`] for the Coinbase family).
|
|
8297
|
+
* [`BybitRpc`] for the Bybit family, [`CoinbaseRpc`] for the Coinbase family).
|
|
7634
8298
|
*/
|
|
7635
|
-
RpcMethod: components["schemas"]["CsRpc"] | components["schemas"]["BinanceRpc"] | components["schemas"]["CoinbaseRpc"];
|
|
8299
|
+
RpcMethod: components["schemas"]["CsRpc"] | components["schemas"]["BinanceRpc"] | components["schemas"]["BybitRpc"] | components["schemas"]["CoinbaseRpc"];
|
|
7636
8300
|
/** @description All scopes for accessing CubeSigner APIs */
|
|
7637
8301
|
Scope: components["schemas"]["ExplicitScope"] | string;
|
|
7638
8302
|
/** @description A set of scopes. */
|
|
@@ -7779,6 +8443,37 @@ export interface components {
|
|
|
7779
8443
|
/** @description Optional policy evaluation tree, if requested */
|
|
7780
8444
|
policy_eval_tree?: unknown;
|
|
7781
8445
|
};
|
|
8446
|
+
/**
|
|
8447
|
+
* @description The structured input to a Sign-In With Solana request (`SolanaSignInInput` in the spec).
|
|
8448
|
+
*
|
|
8449
|
+
* The relying party fills in `domain`/`address`/`uri`/... and the wallet renders it into the
|
|
8450
|
+
* human-readable message (see [SignInInput::to_message_text]) that it signs.
|
|
8451
|
+
*/
|
|
8452
|
+
SignInInput: {
|
|
8453
|
+
/** @description The base58-encoded Solana (ed25519) public key performing the sign-in. */
|
|
8454
|
+
address: string;
|
|
8455
|
+
chainId?: components["schemas"]["SolanaNetwork"] | null;
|
|
8456
|
+
/** @description The RFC 3986 authority that is requesting the sign-in. */
|
|
8457
|
+
domain: string;
|
|
8458
|
+
/** @description The ISO 8601 datetime string after which the signed message is no longer valid. */
|
|
8459
|
+
expirationTime?: string | null;
|
|
8460
|
+
/** @description The ISO 8601 datetime string of the time the message was issued. */
|
|
8461
|
+
issuedAt?: string | null;
|
|
8462
|
+
/** @description A randomized token used to prevent replay attacks; at least 8 alphanumeric characters. */
|
|
8463
|
+
nonce?: string | null;
|
|
8464
|
+
/** @description The ISO 8601 datetime string before which the signed message is not yet valid. */
|
|
8465
|
+
notBefore?: string | null;
|
|
8466
|
+
/** @description A system-specific identifier that may be used to uniquely refer to the sign-in request. */
|
|
8467
|
+
requestId?: string | null;
|
|
8468
|
+
/** @description A list of RFC 3986 URIs the user wishes to have resolved as part of the authentication. */
|
|
8469
|
+
resources?: string[] | null;
|
|
8470
|
+
/** @description A human-readable ASCII assertion that the user will sign; must not contain a newline. */
|
|
8471
|
+
statement?: string | null;
|
|
8472
|
+
/** @description An RFC 3986 URI referring to the resource that is the subject of the sign-in. */
|
|
8473
|
+
uri?: string | null;
|
|
8474
|
+
/** @description The version of the message (currently always `1`). */
|
|
8475
|
+
version?: string | null;
|
|
8476
|
+
};
|
|
7782
8477
|
SignResponse: {
|
|
7783
8478
|
/** @description Optional policy evaluation tree. */
|
|
7784
8479
|
policy_eval_tree?: unknown;
|
|
@@ -7857,6 +8552,56 @@ export interface components {
|
|
|
7857
8552
|
/** @description The message to sign following the EIP-191 standard. */
|
|
7858
8553
|
message: string;
|
|
7859
8554
|
};
|
|
8555
|
+
/** @description Answer to a Sign-in with Solana challenge. */
|
|
8556
|
+
SiwsCompleteRequest: {
|
|
8557
|
+
challenge_id: components["schemas"]["Id"];
|
|
8558
|
+
/** @description The base58-encoded ed25519 signature of `signed_message`. */
|
|
8559
|
+
signature: string;
|
|
8560
|
+
/** @description The base58-encoded UTF-8 bytes of the message that was signed (the rendered `SignInInput`). */
|
|
8561
|
+
signed_message: string;
|
|
8562
|
+
};
|
|
8563
|
+
/** @description Returned upon a successful SIWS authentication. */
|
|
8564
|
+
SiwsCompleteResponse: {
|
|
8565
|
+
/** @description The OIDC token corresponding to the user with the requested SIWS identity. */
|
|
8566
|
+
id_token: string;
|
|
8567
|
+
};
|
|
8568
|
+
/**
|
|
8569
|
+
* @description Initialize the request to sign in with Solana. The response will contain a structured
|
|
8570
|
+
* `SignInInput` that the client must render to text, sign, and submit via the corresponding PATCH
|
|
8571
|
+
* endpoint within 5 minutes.
|
|
8572
|
+
*/
|
|
8573
|
+
SiwsInitRequest: {
|
|
8574
|
+
/** @description The base58-encoded Solana (ed25519) public key performing the signing. */
|
|
8575
|
+
address: string;
|
|
8576
|
+
chain_id?: components["schemas"]["SolanaNetwork"] | null;
|
|
8577
|
+
/** @description The RFC 3986 authority that is requesting the signing. */
|
|
8578
|
+
domain: string;
|
|
8579
|
+
/** @description The ISO 8601 datetime string that, if present, indicates when the signed authentication message is no longer valid. */
|
|
8580
|
+
expiration_time?: string | null;
|
|
8581
|
+
/** @description The ISO 8601 datetime string that, if present, indicates when the signed authentication message will become valid. */
|
|
8582
|
+
not_before?: string | null;
|
|
8583
|
+
/** @description A system-specific identifier that may be used to uniquely refer to the sign-in request. */
|
|
8584
|
+
request_id?: string | null;
|
|
8585
|
+
/** @description A list of RFC 3986 URIs the user wishes to have resolved as part of authentication by the relying party. */
|
|
8586
|
+
resources?: string[];
|
|
8587
|
+
/** @description A human-readable ASCII assertion that the user will sign, and it must not contain '\n' (the byte 0x0a). */
|
|
8588
|
+
statement?: string | null;
|
|
8589
|
+
/** @description An RFC 3986 URI referring to the resource that is the subject of the signing (as in the subject of a claim). */
|
|
8590
|
+
uri?: string | null;
|
|
8591
|
+
};
|
|
8592
|
+
/**
|
|
8593
|
+
* @description A challenge returned in response to a Sign-In with Solana request.
|
|
8594
|
+
*
|
|
8595
|
+
* Contains a structured [SignInInput] that the client must render to its canonical text and sign
|
|
8596
|
+
* (ed25519) with the requested key in order to complete authentication.
|
|
8597
|
+
*
|
|
8598
|
+
* The client has until the message expires (but no more than 5 minutes) to complete the challenge.
|
|
8599
|
+
*/
|
|
8600
|
+
SiwsInitResponse: {
|
|
8601
|
+
/** @description The ID of the challenge (to include in the request when calling the PATCH ('complete') endpoint) */
|
|
8602
|
+
challenge_id: string;
|
|
8603
|
+
sign_in_input: components["schemas"]["SignInInput"];
|
|
8604
|
+
};
|
|
7860
8605
|
/** @description A Solana address and the cluster it is on. */
|
|
7861
8606
|
SolanaAddressInfo: {
|
|
7862
8607
|
/**
|
|
@@ -7871,6 +8616,11 @@ export interface components {
|
|
|
7871
8616
|
* @enum {string}
|
|
7872
8617
|
*/
|
|
7873
8618
|
SolanaCluster: "mainnet" | "devnet";
|
|
8619
|
+
/**
|
|
8620
|
+
* @description The Solana network a SIWS message is bound to (the `Chain ID` field).
|
|
8621
|
+
* @enum {string}
|
|
8622
|
+
*/
|
|
8623
|
+
SolanaNetwork: "mainnet" | "testnet" | "devnet" | "localnet" | "solana:mainnet" | "solana:testnet" | "solana:devnet" | "solana:localnet";
|
|
7874
8624
|
/**
|
|
7875
8625
|
* @description Solana signing request
|
|
7876
8626
|
* @example {
|
|
@@ -8645,8 +9395,8 @@ export interface components {
|
|
|
8645
9395
|
asset: string;
|
|
8646
9396
|
/**
|
|
8647
9397
|
* @description Optional client-supplied transfer id. If set, Binance echoes it back
|
|
8648
|
-
* on
|
|
8649
|
-
* as a filter on
|
|
9398
|
+
* as `client_tran_id` on the `UniversalTransferResponse` and lets it be
|
|
9399
|
+
* used as a filter on
|
|
8650
9400
|
* [`UniversalTransferHistoryRequest::client_tran_id`].
|
|
8651
9401
|
*/
|
|
8652
9402
|
clientTranId?: string | null;
|
|
@@ -9514,7 +10264,7 @@ export interface components {
|
|
|
9514
10264
|
endTime?: number | null;
|
|
9515
10265
|
/**
|
|
9516
10266
|
* @description Comma-separated list of Binance-assigned withdrawal ids (the `id`
|
|
9517
|
-
* field of
|
|
10267
|
+
* field of `WithdrawResponse`). Up to 45 ids per query, per Binance.
|
|
9518
10268
|
*/
|
|
9519
10269
|
idList?: string | null;
|
|
9520
10270
|
/**
|
|
@@ -9781,6 +10531,38 @@ export interface components {
|
|
|
9781
10531
|
};
|
|
9782
10532
|
};
|
|
9783
10533
|
};
|
|
10534
|
+
/** @description Response returned by the typed `bybit_sign` endpoint. */
|
|
10535
|
+
BybitSignResponse: {
|
|
10536
|
+
content: {
|
|
10537
|
+
"application/json": {
|
|
10538
|
+
/** @description Optional policy evaluation tree. */
|
|
10539
|
+
policy_eval_tree?: unknown;
|
|
10540
|
+
} & {
|
|
10541
|
+
/**
|
|
10542
|
+
* @description The Bybit-bound payload (URL-encoded query for GET, JSON body for
|
|
10543
|
+
* POST). Submitted verbatim by the rpc-api lambda; the payload bytes are
|
|
10544
|
+
* also part of the signing input.
|
|
10545
|
+
*/
|
|
10546
|
+
payload: string;
|
|
10547
|
+
/**
|
|
10548
|
+
* Format: int32
|
|
10549
|
+
* @description Effective receive window in milliseconds.
|
|
10550
|
+
*/
|
|
10551
|
+
recv_window: number;
|
|
10552
|
+
/**
|
|
10553
|
+
* @description Hex-encoded HMAC-SHA256 signature of
|
|
10554
|
+
* `timestamp || apiKey || recvWindow || payload`. Goes into the
|
|
10555
|
+
* `X-BAPI-SIGN` header.
|
|
10556
|
+
*/
|
|
10557
|
+
signature_hex: string;
|
|
10558
|
+
/**
|
|
10559
|
+
* Format: int64
|
|
10560
|
+
* @description Signing timestamp (ms since epoch). Picked by the signer.
|
|
10561
|
+
*/
|
|
10562
|
+
timestamp_ms: number;
|
|
10563
|
+
};
|
|
10564
|
+
};
|
|
10565
|
+
};
|
|
9784
10566
|
/** @description Response returned by the typed `coinbase_sign` endpoint. */
|
|
9785
10567
|
CoinbaseSignResponse: {
|
|
9786
10568
|
content: {
|
|
@@ -11103,6 +11885,32 @@ export interface components {
|
|
|
11103
11885
|
};
|
|
11104
11886
|
};
|
|
11105
11887
|
};
|
|
11888
|
+
/** @description Returned upon a successful SIWS authentication. */
|
|
11889
|
+
SiwsCompleteResponse: {
|
|
11890
|
+
content: {
|
|
11891
|
+
"application/json": {
|
|
11892
|
+
/** @description The OIDC token corresponding to the user with the requested SIWS identity. */
|
|
11893
|
+
id_token: string;
|
|
11894
|
+
};
|
|
11895
|
+
};
|
|
11896
|
+
};
|
|
11897
|
+
/**
|
|
11898
|
+
* @description A challenge returned in response to a Sign-In with Solana request.
|
|
11899
|
+
*
|
|
11900
|
+
* Contains a structured [SignInInput] that the client must render to its canonical text and sign
|
|
11901
|
+
* (ed25519) with the requested key in order to complete authentication.
|
|
11902
|
+
*
|
|
11903
|
+
* The client has until the message expires (but no more than 5 minutes) to complete the challenge.
|
|
11904
|
+
*/
|
|
11905
|
+
SiwsInitResponse: {
|
|
11906
|
+
content: {
|
|
11907
|
+
"application/json": {
|
|
11908
|
+
/** @description The ID of the challenge (to include in the request when calling the PATCH ('complete') endpoint) */
|
|
11909
|
+
challenge_id: string;
|
|
11910
|
+
sign_in_input: components["schemas"]["SignInInput"];
|
|
11911
|
+
};
|
|
11912
|
+
};
|
|
11913
|
+
};
|
|
11106
11914
|
StakeResponse: {
|
|
11107
11915
|
content: {
|
|
11108
11916
|
"application/json": ({
|
|
@@ -11593,6 +12401,11 @@ export interface operations {
|
|
|
11593
12401
|
};
|
|
11594
12402
|
responses: {
|
|
11595
12403
|
200: components["responses"]["UpdateOrgResponse"];
|
|
12404
|
+
202: {
|
|
12405
|
+
content: {
|
|
12406
|
+
"application/json": components["schemas"]["AcceptedResponse"];
|
|
12407
|
+
};
|
|
12408
|
+
};
|
|
11596
12409
|
default: {
|
|
11597
12410
|
content: {
|
|
11598
12411
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
@@ -14224,12 +15037,21 @@ export interface operations {
|
|
|
14224
15037
|
* but extends the output with an `id_token`.
|
|
14225
15038
|
*
|
|
14226
15039
|
* This `id_token` can then be used with any CubeSigner endpoint that requires an OIDC token.
|
|
15040
|
+
* Callers must request *at least* scopes `tweet.read` and `users.read` during auth with twitter.
|
|
15041
|
+
*
|
|
15042
|
+
* By default, the id token does not contain a confirmed email;
|
|
15043
|
+
* callers can request this field be populated by requesting the `users.email` scope
|
|
15044
|
+
* and adding `fetch_email` as a URL parameter to this route.
|
|
15045
|
+
*
|
|
14227
15046
|
*
|
|
14228
15047
|
* > [!IMPORTANT]
|
|
14229
15048
|
* > This endpoint will fail unless the org is configured to allow the issuer `https://shim.oauth2.cubist.dev/twitter` and client ID being used for Twitter.
|
|
14230
15049
|
*/
|
|
14231
15050
|
oauth2Twitter: {
|
|
14232
15051
|
parameters: {
|
|
15052
|
+
query?: {
|
|
15053
|
+
fetch_email?: boolean | null;
|
|
15054
|
+
};
|
|
14233
15055
|
path: {
|
|
14234
15056
|
/**
|
|
14235
15057
|
* @description Name or ID of the desired Org
|
|
@@ -14402,6 +15224,77 @@ export interface operations {
|
|
|
14402
15224
|
};
|
|
14403
15225
|
};
|
|
14404
15226
|
};
|
|
15227
|
+
/**
|
|
15228
|
+
* Initiate login via Sign-in With Solana (SIWS).
|
|
15229
|
+
* @description Initiate login via Sign-in With Solana (SIWS).
|
|
15230
|
+
*
|
|
15231
|
+
* This endpoint generates a challenge which can be answered (via the corresponding PATCH endpoint)
|
|
15232
|
+
* to obtain an OIDC token. The OIDC token can then be exchanged for a user session via the standard
|
|
15233
|
+
* OIDC auth route.
|
|
15234
|
+
*
|
|
15235
|
+
* > [!IMPORTANT]
|
|
15236
|
+
* > For this endpoint to succeed, the org must be configured to:
|
|
15237
|
+
* > Allow the issuer `https://shim.oauth2.cubist.dev/siws` with the Org ID as the client ID
|
|
15238
|
+
*/
|
|
15239
|
+
siwsInit: {
|
|
15240
|
+
parameters: {
|
|
15241
|
+
path: {
|
|
15242
|
+
/**
|
|
15243
|
+
* @description Name or ID of the desired Org
|
|
15244
|
+
* @example Org#124dfe3e-3bbd-487d-80c0-53c55e8ab87a
|
|
15245
|
+
*/
|
|
15246
|
+
org_id: string;
|
|
15247
|
+
};
|
|
15248
|
+
};
|
|
15249
|
+
requestBody: {
|
|
15250
|
+
content: {
|
|
15251
|
+
"application/json": components["schemas"]["SiwsInitRequest"];
|
|
15252
|
+
};
|
|
15253
|
+
};
|
|
15254
|
+
responses: {
|
|
15255
|
+
200: components["responses"]["SiwsInitResponse"];
|
|
15256
|
+
default: {
|
|
15257
|
+
content: {
|
|
15258
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
15259
|
+
};
|
|
15260
|
+
};
|
|
15261
|
+
};
|
|
15262
|
+
};
|
|
15263
|
+
/**
|
|
15264
|
+
* Complete login via Sign-in With Solana (SIWS)
|
|
15265
|
+
* @description Complete login via Sign-in With Solana (SIWS)
|
|
15266
|
+
*
|
|
15267
|
+
* If the challenge (issued by the corresponding POST endpoint) is answered correctly, this endpoint
|
|
15268
|
+
* generates an OIDC token that can then be exchanged for a user session via the standard OIDC auth route.
|
|
15269
|
+
*
|
|
15270
|
+
* > [!IMPORTANT]
|
|
15271
|
+
* > For this endpoint to succeed, the org must be configured to:
|
|
15272
|
+
* > Allow the issuer `https://shim.oauth2.cubist.dev/siws` with the Org ID as the client ID
|
|
15273
|
+
*/
|
|
15274
|
+
siwsComplete: {
|
|
15275
|
+
parameters: {
|
|
15276
|
+
path: {
|
|
15277
|
+
/**
|
|
15278
|
+
* @description Name or ID of the desired Org
|
|
15279
|
+
* @example Org#124dfe3e-3bbd-487d-80c0-53c55e8ab87a
|
|
15280
|
+
*/
|
|
15281
|
+
org_id: string;
|
|
15282
|
+
};
|
|
15283
|
+
};
|
|
15284
|
+
requestBody: {
|
|
15285
|
+
content: {
|
|
15286
|
+
"application/json": components["schemas"]["SiwsCompleteRequest"];
|
|
15287
|
+
};
|
|
15288
|
+
};
|
|
15289
|
+
responses: {
|
|
15290
|
+
200: components["responses"]["SiwsCompleteResponse"];
|
|
15291
|
+
default: {
|
|
15292
|
+
content: {
|
|
15293
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
15294
|
+
};
|
|
15295
|
+
};
|
|
15296
|
+
};
|
|
15297
|
+
};
|
|
14405
15298
|
/**
|
|
14406
15299
|
* Allows a user to authenticate with the telegram API using the tgWebAppData value
|
|
14407
15300
|
* @description Allows a user to authenticate with the telegram API using the tgWebAppData value
|
|
@@ -15746,16 +16639,23 @@ export interface operations {
|
|
|
15746
16639
|
"page.start"?: string | null;
|
|
15747
16640
|
/**
|
|
15748
16641
|
* @description If provided, the name or ID of a role to operate on.
|
|
15749
|
-
* Cannot be specified together with
|
|
16642
|
+
* Cannot be specified together with other selectors.
|
|
15750
16643
|
* @example my-role
|
|
15751
16644
|
*/
|
|
15752
16645
|
role?: string | null;
|
|
15753
16646
|
/**
|
|
15754
16647
|
* @description If provided, the ID of a user to operate on.
|
|
15755
|
-
* Cannot be specified together with
|
|
16648
|
+
* Cannot be specified together with other selectors.
|
|
15756
16649
|
* @example User#124dfe3e-3bbd-487d-80c0-53c55e8ab87a
|
|
15757
16650
|
*/
|
|
15758
16651
|
user?: string | null;
|
|
16652
|
+
/**
|
|
16653
|
+
* @description If provided, the ID of the user whose created role sessions to operate on.
|
|
16654
|
+
* Selects all *role* sessions created by that user (user sessions are not affected).
|
|
16655
|
+
* Cannot be specified together with other selectors.
|
|
16656
|
+
* @example User#124dfe3e-3bbd-487d-80c0-53c55e8ab87a
|
|
16657
|
+
*/
|
|
16658
|
+
role_created_by?: string | null;
|
|
15759
16659
|
};
|
|
15760
16660
|
path: {
|
|
15761
16661
|
/**
|
|
@@ -15818,22 +16718,36 @@ export interface operations {
|
|
|
15818
16718
|
*
|
|
15819
16719
|
* If a `role` query parameter is provided, **ALL** session for **THAT ROLE** are revoked
|
|
15820
16720
|
* (if the current user has permissions to revoke sessions for the role).
|
|
16721
|
+
*
|
|
16722
|
+
* If a `role_created_by` query parameter is provided, **ROLE** sessions created by **THAT USER**
|
|
16723
|
+
* are revoked (gated by the same permissions as revoking that user's own sessions: the current
|
|
16724
|
+
* user must be that user or an org owner). User sessions are not affected. Unless the current
|
|
16725
|
+
* user is an org owner, only sessions for roles the current user is **still a member of** are
|
|
16726
|
+
* revoked (so a user cannot revoke sessions for a role they have since been removed from); org
|
|
16727
|
+
* owners revoke across all roles.
|
|
15821
16728
|
*/
|
|
15822
16729
|
revokeSessions: {
|
|
15823
16730
|
parameters: {
|
|
15824
16731
|
query?: {
|
|
15825
16732
|
/**
|
|
15826
16733
|
* @description If provided, the name or ID of a role to operate on.
|
|
15827
|
-
* Cannot be specified together with
|
|
16734
|
+
* Cannot be specified together with other selectors.
|
|
15828
16735
|
* @example my-role
|
|
15829
16736
|
*/
|
|
15830
16737
|
role?: string | null;
|
|
15831
16738
|
/**
|
|
15832
16739
|
* @description If provided, the ID of a user to operate on.
|
|
15833
|
-
* Cannot be specified together with
|
|
16740
|
+
* Cannot be specified together with other selectors.
|
|
15834
16741
|
* @example User#124dfe3e-3bbd-487d-80c0-53c55e8ab87a
|
|
15835
16742
|
*/
|
|
15836
16743
|
user?: string | null;
|
|
16744
|
+
/**
|
|
16745
|
+
* @description If provided, the ID of the user whose created role sessions to operate on.
|
|
16746
|
+
* Selects all *role* sessions created by that user (user sessions are not affected).
|
|
16747
|
+
* Cannot be specified together with other selectors.
|
|
16748
|
+
* @example User#124dfe3e-3bbd-487d-80c0-53c55e8ab87a
|
|
16749
|
+
*/
|
|
16750
|
+
role_created_by?: string | null;
|
|
15837
16751
|
};
|
|
15838
16752
|
path: {
|
|
15839
16753
|
/**
|
|
@@ -16673,6 +17587,9 @@ export interface operations {
|
|
|
16673
17587
|
*/
|
|
16674
17588
|
deleteOidcUser: {
|
|
16675
17589
|
parameters: {
|
|
17590
|
+
query?: {
|
|
17591
|
+
revoke_role_sessions_they_created?: boolean | null;
|
|
17592
|
+
};
|
|
16676
17593
|
path: {
|
|
16677
17594
|
/**
|
|
16678
17595
|
* @description Name or ID of the desired Org
|
|
@@ -16814,6 +17731,9 @@ export interface operations {
|
|
|
16814
17731
|
*/
|
|
16815
17732
|
deleteUser: {
|
|
16816
17733
|
parameters: {
|
|
17734
|
+
query?: {
|
|
17735
|
+
revoke_role_sessions_they_created?: boolean | null;
|
|
17736
|
+
};
|
|
16817
17737
|
path: {
|
|
16818
17738
|
/**
|
|
16819
17739
|
* @description Name or ID of the desired Org
|