@djangocfg/api 2.1.427 → 2.1.428
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -0
- package/dist/auth-server.cjs +248 -32
- package/dist/auth-server.cjs.map +1 -1
- package/dist/auth-server.mjs +248 -32
- package/dist/auth-server.mjs.map +1 -1
- package/dist/auth.cjs +271 -29
- package/dist/auth.cjs.map +1 -1
- package/dist/auth.mjs +271 -29
- package/dist/auth.mjs.map +1 -1
- package/dist/clients.cjs +222 -25
- package/dist/clients.cjs.map +1 -1
- package/dist/clients.d.cts +35 -28
- package/dist/clients.d.ts +35 -28
- package/dist/clients.mjs +222 -25
- package/dist/clients.mjs.map +1 -1
- package/dist/hooks.cjs +117 -4
- package/dist/hooks.cjs.map +1 -1
- package/dist/hooks.mjs +117 -4
- package/dist/hooks.mjs.map +1 -1
- package/dist/index.cjs +277 -26
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +98 -29
- package/dist/index.d.ts +98 -29
- package/dist/index.mjs +277 -26
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
- package/src/_api/generated/client/index.ts +1 -0
- package/src/_api/generated/client/utils.gen.ts +2 -2
- package/src/_api/generated/client.gen.ts +2 -2
- package/src/_api/generated/core/auth.gen.ts +7 -0
- package/src/_api/generated/core/params.gen.ts +10 -8
- package/src/_api/generated/core/pathSerializer.gen.ts +6 -6
- package/src/_api/generated/core/queryKeySerializer.gen.ts +1 -1
- package/src/_api/generated/core/utils.gen.ts +4 -4
- package/src/_api/generated/helpers/auth.ts +127 -1
- package/src/_api/generated/sdk.gen.ts +149 -53
- package/src/auth/context/AuthContext.tsx +8 -0
- package/src/auth/utils/env.ts +18 -0
- package/src/auth/utils/logger.ts +11 -4
- package/src/index.ts +12 -0
- package/src/log-control.ts +81 -0
package/dist/clients.d.cts
CHANGED
|
@@ -57,6 +57,13 @@ interface Auth {
|
|
|
57
57
|
* @default 'header'
|
|
58
58
|
*/
|
|
59
59
|
in?: 'header' | 'query' | 'cookie';
|
|
60
|
+
/**
|
|
61
|
+
* A unique identifier for the security scheme.
|
|
62
|
+
*
|
|
63
|
+
* Defined only when there are multiple security schemes whose `Auth`
|
|
64
|
+
* shape would otherwise be identical.
|
|
65
|
+
*/
|
|
66
|
+
key?: string;
|
|
60
67
|
/**
|
|
61
68
|
* Header or query parameter name.
|
|
62
69
|
*
|
|
@@ -1528,19 +1535,19 @@ declare class CfgAccountsApiKey {
|
|
|
1528
1535
|
*
|
|
1529
1536
|
* Retrieve the current user's API key (masked) and metadata.
|
|
1530
1537
|
*/
|
|
1531
|
-
static cfgAccountsApiKeyRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsApiKeyRetrieveData, ThrowOnError>): RequestResult<CfgAccountsApiKeyRetrieveResponses, CfgAccountsApiKeyRetrieveErrors, ThrowOnError
|
|
1538
|
+
static cfgAccountsApiKeyRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsApiKeyRetrieveData, ThrowOnError>): RequestResult<CfgAccountsApiKeyRetrieveResponses, CfgAccountsApiKeyRetrieveErrors, ThrowOnError>;
|
|
1532
1539
|
/**
|
|
1533
1540
|
* Regenerate API key
|
|
1534
1541
|
*
|
|
1535
1542
|
* Generate a new API key. The full key is returned only once.
|
|
1536
1543
|
*/
|
|
1537
|
-
static cfgAccountsApiKeyRegenerateCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsApiKeyRegenerateCreateData, ThrowOnError>): RequestResult<CfgAccountsApiKeyRegenerateCreateResponses, CfgAccountsApiKeyRegenerateCreateErrors, ThrowOnError
|
|
1544
|
+
static cfgAccountsApiKeyRegenerateCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsApiKeyRegenerateCreateData, ThrowOnError>): RequestResult<CfgAccountsApiKeyRegenerateCreateResponses, CfgAccountsApiKeyRegenerateCreateErrors, ThrowOnError>;
|
|
1538
1545
|
/**
|
|
1539
1546
|
* Test API key
|
|
1540
1547
|
*
|
|
1541
1548
|
* Test whether an API key is valid without consuming it.
|
|
1542
1549
|
*/
|
|
1543
|
-
static cfgAccountsApiKeyTestCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsApiKeyTestCreateData, ThrowOnError>): RequestResult<CfgAccountsApiKeyTestCreateResponses, unknown, ThrowOnError
|
|
1550
|
+
static cfgAccountsApiKeyTestCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsApiKeyTestCreateData, ThrowOnError>): RequestResult<CfgAccountsApiKeyTestCreateResponses, unknown, ThrowOnError>;
|
|
1544
1551
|
}
|
|
1545
1552
|
declare class CfgAccountsOauth {
|
|
1546
1553
|
/**
|
|
@@ -1548,37 +1555,37 @@ declare class CfgAccountsOauth {
|
|
|
1548
1555
|
*
|
|
1549
1556
|
* Get all OAuth connections for the current user.
|
|
1550
1557
|
*/
|
|
1551
|
-
static cfgAccountsOauthConnectionsList<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsOauthConnectionsListData, ThrowOnError>): RequestResult<CfgAccountsOauthConnectionsListResponses, unknown, ThrowOnError
|
|
1558
|
+
static cfgAccountsOauthConnectionsList<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsOauthConnectionsListData, ThrowOnError>): RequestResult<CfgAccountsOauthConnectionsListResponses, unknown, ThrowOnError>;
|
|
1552
1559
|
/**
|
|
1553
1560
|
* Disconnect OAuth provider
|
|
1554
1561
|
*
|
|
1555
1562
|
* Remove OAuth connection for the specified provider.
|
|
1556
1563
|
*/
|
|
1557
|
-
static cfgAccountsOauthDisconnectCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsOauthDisconnectCreateData, ThrowOnError>): RequestResult<CfgAccountsOauthDisconnectCreateResponses, CfgAccountsOauthDisconnectCreateErrors, ThrowOnError
|
|
1564
|
+
static cfgAccountsOauthDisconnectCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsOauthDisconnectCreateData, ThrowOnError>): RequestResult<CfgAccountsOauthDisconnectCreateResponses, CfgAccountsOauthDisconnectCreateErrors, ThrowOnError>;
|
|
1558
1565
|
/**
|
|
1559
1566
|
* Start GitHub OAuth
|
|
1560
1567
|
*
|
|
1561
1568
|
* Generate GitHub OAuth authorization URL. Redirect user to this URL to start authentication.
|
|
1562
1569
|
*/
|
|
1563
|
-
static cfgAccountsOauthGithubAuthorizeCreate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsOauthGithubAuthorizeCreateData, ThrowOnError>): RequestResult<CfgAccountsOauthGithubAuthorizeCreateResponses, CfgAccountsOauthGithubAuthorizeCreateErrors, ThrowOnError
|
|
1570
|
+
static cfgAccountsOauthGithubAuthorizeCreate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsOauthGithubAuthorizeCreateData, ThrowOnError>): RequestResult<CfgAccountsOauthGithubAuthorizeCreateResponses, CfgAccountsOauthGithubAuthorizeCreateErrors, ThrowOnError>;
|
|
1564
1571
|
/**
|
|
1565
1572
|
* Complete GitHub OAuth
|
|
1566
1573
|
*
|
|
1567
1574
|
* Exchange authorization code for JWT tokens. Call this after GitHub redirects back with code.
|
|
1568
1575
|
*/
|
|
1569
|
-
static cfgAccountsOauthGithubCallbackCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsOauthGithubCallbackCreateData, ThrowOnError>): RequestResult<CfgAccountsOauthGithubCallbackCreateResponses, CfgAccountsOauthGithubCallbackCreateErrors, ThrowOnError
|
|
1576
|
+
static cfgAccountsOauthGithubCallbackCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsOauthGithubCallbackCreateData, ThrowOnError>): RequestResult<CfgAccountsOauthGithubCallbackCreateResponses, CfgAccountsOauthGithubCallbackCreateErrors, ThrowOnError>;
|
|
1570
1577
|
/**
|
|
1571
1578
|
* List OAuth providers
|
|
1572
1579
|
*
|
|
1573
1580
|
* Get list of available OAuth providers for authentication.
|
|
1574
1581
|
*/
|
|
1575
|
-
static cfgAccountsOauthProvidersRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsOauthProvidersRetrieveData, ThrowOnError>): RequestResult<CfgAccountsOauthProvidersRetrieveResponses, unknown, ThrowOnError
|
|
1582
|
+
static cfgAccountsOauthProvidersRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsOauthProvidersRetrieveData, ThrowOnError>): RequestResult<CfgAccountsOauthProvidersRetrieveResponses, unknown, ThrowOnError>;
|
|
1576
1583
|
}
|
|
1577
1584
|
declare class CfgAccounts {
|
|
1578
1585
|
/**
|
|
1579
1586
|
* Request OTP code to email.
|
|
1580
1587
|
*/
|
|
1581
|
-
static cfgAccountsOtpRequestCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsOtpRequestCreateData, ThrowOnError>): RequestResult<CfgAccountsOtpRequestCreateResponses, CfgAccountsOtpRequestCreateErrors, ThrowOnError
|
|
1588
|
+
static cfgAccountsOtpRequestCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsOtpRequestCreateData, ThrowOnError>): RequestResult<CfgAccountsOtpRequestCreateResponses, CfgAccountsOtpRequestCreateErrors, ThrowOnError>;
|
|
1582
1589
|
/**
|
|
1583
1590
|
* Verify OTP code and return JWT tokens or 2FA session.
|
|
1584
1591
|
*
|
|
@@ -1589,7 +1596,7 @@ declare class CfgAccounts {
|
|
|
1589
1596
|
* If user has no 2FA:
|
|
1590
1597
|
* - Returns JWT tokens and user data directly
|
|
1591
1598
|
*/
|
|
1592
|
-
static cfgAccountsOtpVerifyCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsOtpVerifyCreateData, ThrowOnError>): RequestResult<CfgAccountsOtpVerifyCreateResponses, CfgAccountsOtpVerifyCreateErrors, ThrowOnError
|
|
1599
|
+
static cfgAccountsOtpVerifyCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsOtpVerifyCreateData, ThrowOnError>): RequestResult<CfgAccountsOtpVerifyCreateResponses, CfgAccountsOtpVerifyCreateErrors, ThrowOnError>;
|
|
1593
1600
|
}
|
|
1594
1601
|
declare class CfgAccountsProfile {
|
|
1595
1602
|
/**
|
|
@@ -1597,13 +1604,13 @@ declare class CfgAccountsProfile {
|
|
|
1597
1604
|
*
|
|
1598
1605
|
* Retrieve the current authenticated user's profile information.
|
|
1599
1606
|
*/
|
|
1600
|
-
static cfgAccountsProfileRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileRetrieveData, ThrowOnError>): RequestResult<CfgAccountsProfileRetrieveResponses, CfgAccountsProfileRetrieveErrors, ThrowOnError
|
|
1607
|
+
static cfgAccountsProfileRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileRetrieveData, ThrowOnError>): RequestResult<CfgAccountsProfileRetrieveResponses, CfgAccountsProfileRetrieveErrors, ThrowOnError>;
|
|
1601
1608
|
/**
|
|
1602
1609
|
* Upload user avatar
|
|
1603
1610
|
*
|
|
1604
1611
|
* Upload avatar image for the current authenticated user. Accepts multipart/form-data with 'avatar' field.
|
|
1605
1612
|
*/
|
|
1606
|
-
static cfgAccountsProfileAvatarCreate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileAvatarCreateData, ThrowOnError>): RequestResult<CfgAccountsProfileAvatarCreateResponses, CfgAccountsProfileAvatarCreateErrors, ThrowOnError
|
|
1613
|
+
static cfgAccountsProfileAvatarCreate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileAvatarCreateData, ThrowOnError>): RequestResult<CfgAccountsProfileAvatarCreateResponses, CfgAccountsProfileAvatarCreateErrors, ThrowOnError>;
|
|
1607
1614
|
/**
|
|
1608
1615
|
* Delete user account
|
|
1609
1616
|
*
|
|
@@ -1619,37 +1626,37 @@ declare class CfgAccountsProfile {
|
|
|
1619
1626
|
* The account can be restored by an administrator if needed.
|
|
1620
1627
|
*
|
|
1621
1628
|
*/
|
|
1622
|
-
static cfgAccountsProfileDeleteCreate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileDeleteCreateData, ThrowOnError>): RequestResult<CfgAccountsProfileDeleteCreateResponses, CfgAccountsProfileDeleteCreateErrors, ThrowOnError
|
|
1629
|
+
static cfgAccountsProfileDeleteCreate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileDeleteCreateData, ThrowOnError>): RequestResult<CfgAccountsProfileDeleteCreateResponses, CfgAccountsProfileDeleteCreateErrors, ThrowOnError>;
|
|
1623
1630
|
/**
|
|
1624
1631
|
* Partial update user profile
|
|
1625
1632
|
*
|
|
1626
1633
|
* Partially update the current authenticated user's profile information. Supports avatar upload.
|
|
1627
1634
|
*/
|
|
1628
|
-
static cfgAccountsProfilePartialPartialUpdate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfilePartialPartialUpdateData, ThrowOnError>): RequestResult<CfgAccountsProfilePartialPartialUpdateResponses, CfgAccountsProfilePartialPartialUpdateErrors, ThrowOnError
|
|
1635
|
+
static cfgAccountsProfilePartialPartialUpdate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfilePartialPartialUpdateData, ThrowOnError>): RequestResult<CfgAccountsProfilePartialPartialUpdateResponses, CfgAccountsProfilePartialPartialUpdateErrors, ThrowOnError>;
|
|
1629
1636
|
/**
|
|
1630
1637
|
* Partial update user profile
|
|
1631
1638
|
*
|
|
1632
1639
|
* Partially update the current authenticated user's profile information. Supports avatar upload.
|
|
1633
1640
|
*/
|
|
1634
|
-
static cfgAccountsProfilePartialUpdate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfilePartialUpdateData, ThrowOnError>): RequestResult<CfgAccountsProfilePartialUpdateResponses, CfgAccountsProfilePartialUpdateErrors, ThrowOnError
|
|
1641
|
+
static cfgAccountsProfilePartialUpdate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfilePartialUpdateData, ThrowOnError>): RequestResult<CfgAccountsProfilePartialUpdateResponses, CfgAccountsProfilePartialUpdateErrors, ThrowOnError>;
|
|
1635
1642
|
/**
|
|
1636
1643
|
* Update user profile
|
|
1637
1644
|
*
|
|
1638
1645
|
* Update the current authenticated user's profile information.
|
|
1639
1646
|
*/
|
|
1640
|
-
static cfgAccountsProfileUpdatePartialUpdate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileUpdatePartialUpdateData, ThrowOnError>): RequestResult<CfgAccountsProfileUpdatePartialUpdateResponses, CfgAccountsProfileUpdatePartialUpdateErrors, ThrowOnError
|
|
1647
|
+
static cfgAccountsProfileUpdatePartialUpdate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileUpdatePartialUpdateData, ThrowOnError>): RequestResult<CfgAccountsProfileUpdatePartialUpdateResponses, CfgAccountsProfileUpdatePartialUpdateErrors, ThrowOnError>;
|
|
1641
1648
|
/**
|
|
1642
1649
|
* Update user profile
|
|
1643
1650
|
*
|
|
1644
1651
|
* Update the current authenticated user's profile information.
|
|
1645
1652
|
*/
|
|
1646
|
-
static cfgAccountsProfileUpdateUpdate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileUpdateUpdateData, ThrowOnError>): RequestResult<CfgAccountsProfileUpdateUpdateResponses, CfgAccountsProfileUpdateUpdateErrors, ThrowOnError
|
|
1653
|
+
static cfgAccountsProfileUpdateUpdate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileUpdateUpdateData, ThrowOnError>): RequestResult<CfgAccountsProfileUpdateUpdateResponses, CfgAccountsProfileUpdateUpdateErrors, ThrowOnError>;
|
|
1647
1654
|
}
|
|
1648
1655
|
declare class CfgAccountsAuth {
|
|
1649
1656
|
/**
|
|
1650
1657
|
* Refresh JWT token.
|
|
1651
1658
|
*/
|
|
1652
|
-
static cfgAccountsTokenRefreshCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsTokenRefreshCreateData, ThrowOnError>): RequestResult<CfgAccountsTokenRefreshCreateResponses, unknown, ThrowOnError
|
|
1659
|
+
static cfgAccountsTokenRefreshCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsTokenRefreshCreateData, ThrowOnError>): RequestResult<CfgAccountsTokenRefreshCreateResponses, unknown, ThrowOnError>;
|
|
1653
1660
|
}
|
|
1654
1661
|
declare class CfgCentrifugo {
|
|
1655
1662
|
/**
|
|
@@ -1657,38 +1664,38 @@ declare class CfgCentrifugo {
|
|
|
1657
1664
|
*
|
|
1658
1665
|
* Generate JWT token for WebSocket connection to Centrifugo. Token includes user's allowed channels based on their permissions. Requires authentication.
|
|
1659
1666
|
*/
|
|
1660
|
-
static cfgCentrifugoAuthTokenRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgCentrifugoAuthTokenRetrieveData, ThrowOnError>): RequestResult<CfgCentrifugoAuthTokenRetrieveResponses, CfgCentrifugoAuthTokenRetrieveErrors, ThrowOnError
|
|
1667
|
+
static cfgCentrifugoAuthTokenRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgCentrifugoAuthTokenRetrieveData, ThrowOnError>): RequestResult<CfgCentrifugoAuthTokenRetrieveResponses, CfgCentrifugoAuthTokenRetrieveErrors, ThrowOnError>;
|
|
1661
1668
|
}
|
|
1662
1669
|
declare class CfgTotpBackupCodes {
|
|
1663
1670
|
/**
|
|
1664
1671
|
* Get backup codes status for user.
|
|
1665
1672
|
*/
|
|
1666
|
-
static cfgTotpBackupCodesRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgTotpBackupCodesRetrieveData, ThrowOnError>): RequestResult<CfgTotpBackupCodesRetrieveResponses, unknown, ThrowOnError
|
|
1673
|
+
static cfgTotpBackupCodesRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgTotpBackupCodesRetrieveData, ThrowOnError>): RequestResult<CfgTotpBackupCodesRetrieveResponses, unknown, ThrowOnError>;
|
|
1667
1674
|
/**
|
|
1668
1675
|
* Regenerate backup codes.
|
|
1669
1676
|
*
|
|
1670
1677
|
* Requires TOTP code for verification.
|
|
1671
1678
|
* Invalidates all existing codes.
|
|
1672
1679
|
*/
|
|
1673
|
-
static cfgTotpBackupCodesRegenerateCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpBackupCodesRegenerateCreateData, ThrowOnError>): RequestResult<CfgTotpBackupCodesRegenerateCreateResponses, CfgTotpBackupCodesRegenerateCreateErrors, ThrowOnError
|
|
1680
|
+
static cfgTotpBackupCodesRegenerateCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpBackupCodesRegenerateCreateData, ThrowOnError>): RequestResult<CfgTotpBackupCodesRegenerateCreateResponses, CfgTotpBackupCodesRegenerateCreateErrors, ThrowOnError>;
|
|
1674
1681
|
}
|
|
1675
1682
|
declare class CfgTotp {
|
|
1676
1683
|
/**
|
|
1677
1684
|
* List all TOTP devices for user.
|
|
1678
1685
|
*/
|
|
1679
|
-
static cfgTotpDevicesRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgTotpDevicesRetrieveData, ThrowOnError>): RequestResult<CfgTotpDevicesRetrieveResponses, unknown, ThrowOnError
|
|
1686
|
+
static cfgTotpDevicesRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgTotpDevicesRetrieveData, ThrowOnError>): RequestResult<CfgTotpDevicesRetrieveResponses, unknown, ThrowOnError>;
|
|
1680
1687
|
/**
|
|
1681
1688
|
* Delete a TOTP device.
|
|
1682
1689
|
*
|
|
1683
1690
|
* Requires verification code if removing the last/primary device.
|
|
1684
1691
|
*/
|
|
1685
|
-
static cfgTotpDevicesDestroy<ThrowOnError extends boolean = false>(options: Options<CfgTotpDevicesDestroyData, ThrowOnError>): RequestResult<CfgTotpDevicesDestroyResponses, unknown, ThrowOnError
|
|
1692
|
+
static cfgTotpDevicesDestroy<ThrowOnError extends boolean = false>(options: Options<CfgTotpDevicesDestroyData, ThrowOnError>): RequestResult<CfgTotpDevicesDestroyResponses, unknown, ThrowOnError>;
|
|
1686
1693
|
/**
|
|
1687
1694
|
* Completely disable 2FA for account.
|
|
1688
1695
|
*
|
|
1689
1696
|
* Requires verification code.
|
|
1690
1697
|
*/
|
|
1691
|
-
static cfgTotpDisableCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpDisableCreateData, ThrowOnError>): RequestResult<CfgTotpDisableCreateResponses, CfgTotpDisableCreateErrors, ThrowOnError
|
|
1698
|
+
static cfgTotpDisableCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpDisableCreateData, ThrowOnError>): RequestResult<CfgTotpDisableCreateResponses, CfgTotpDisableCreateErrors, ThrowOnError>;
|
|
1692
1699
|
}
|
|
1693
1700
|
declare class CfgTotpSetup {
|
|
1694
1701
|
/**
|
|
@@ -1696,13 +1703,13 @@ declare class CfgTotpSetup {
|
|
|
1696
1703
|
*
|
|
1697
1704
|
* Creates a new TOTP device and returns QR code for scanning.
|
|
1698
1705
|
*/
|
|
1699
|
-
static cfgTotpSetupCreate<ThrowOnError extends boolean = false>(options?: Options<CfgTotpSetupCreateData, ThrowOnError>): RequestResult<CfgTotpSetupCreateResponses, CfgTotpSetupCreateErrors, ThrowOnError
|
|
1706
|
+
static cfgTotpSetupCreate<ThrowOnError extends boolean = false>(options?: Options<CfgTotpSetupCreateData, ThrowOnError>): RequestResult<CfgTotpSetupCreateResponses, CfgTotpSetupCreateErrors, ThrowOnError>;
|
|
1700
1707
|
/**
|
|
1701
1708
|
* Confirm 2FA setup with first valid code.
|
|
1702
1709
|
*
|
|
1703
1710
|
* Activates the device and generates backup codes.
|
|
1704
1711
|
*/
|
|
1705
|
-
static cfgTotpSetupConfirmCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpSetupConfirmCreateData, ThrowOnError>): RequestResult<CfgTotpSetupConfirmCreateResponses, CfgTotpSetupConfirmCreateErrors, ThrowOnError
|
|
1712
|
+
static cfgTotpSetupConfirmCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpSetupConfirmCreateData, ThrowOnError>): RequestResult<CfgTotpSetupConfirmCreateResponses, CfgTotpSetupConfirmCreateErrors, ThrowOnError>;
|
|
1706
1713
|
}
|
|
1707
1714
|
declare class CfgTotpVerify {
|
|
1708
1715
|
/**
|
|
@@ -1710,13 +1717,13 @@ declare class CfgTotpVerify {
|
|
|
1710
1717
|
*
|
|
1711
1718
|
* Completes authentication and returns JWT tokens on success.
|
|
1712
1719
|
*/
|
|
1713
|
-
static cfgTotpVerifyCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpVerifyCreateData, ThrowOnError>): RequestResult<CfgTotpVerifyCreateResponses, CfgTotpVerifyCreateErrors, ThrowOnError
|
|
1720
|
+
static cfgTotpVerifyCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpVerifyCreateData, ThrowOnError>): RequestResult<CfgTotpVerifyCreateResponses, CfgTotpVerifyCreateErrors, ThrowOnError>;
|
|
1714
1721
|
/**
|
|
1715
1722
|
* Verify backup recovery code for 2FA session.
|
|
1716
1723
|
*
|
|
1717
1724
|
* Alternative verification method when TOTP device unavailable.
|
|
1718
1725
|
*/
|
|
1719
|
-
static cfgTotpVerifyBackupCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpVerifyBackupCreateData, ThrowOnError>): RequestResult<CfgTotpVerifyBackupCreateResponses, CfgTotpVerifyBackupCreateErrors, ThrowOnError
|
|
1726
|
+
static cfgTotpVerifyBackupCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpVerifyBackupCreateData, ThrowOnError>): RequestResult<CfgTotpVerifyBackupCreateResponses, CfgTotpVerifyBackupCreateErrors, ThrowOnError>;
|
|
1720
1727
|
}
|
|
1721
1728
|
|
|
1722
1729
|
interface APIOptions$2 {
|
package/dist/clients.d.ts
CHANGED
|
@@ -57,6 +57,13 @@ interface Auth {
|
|
|
57
57
|
* @default 'header'
|
|
58
58
|
*/
|
|
59
59
|
in?: 'header' | 'query' | 'cookie';
|
|
60
|
+
/**
|
|
61
|
+
* A unique identifier for the security scheme.
|
|
62
|
+
*
|
|
63
|
+
* Defined only when there are multiple security schemes whose `Auth`
|
|
64
|
+
* shape would otherwise be identical.
|
|
65
|
+
*/
|
|
66
|
+
key?: string;
|
|
60
67
|
/**
|
|
61
68
|
* Header or query parameter name.
|
|
62
69
|
*
|
|
@@ -1528,19 +1535,19 @@ declare class CfgAccountsApiKey {
|
|
|
1528
1535
|
*
|
|
1529
1536
|
* Retrieve the current user's API key (masked) and metadata.
|
|
1530
1537
|
*/
|
|
1531
|
-
static cfgAccountsApiKeyRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsApiKeyRetrieveData, ThrowOnError>): RequestResult<CfgAccountsApiKeyRetrieveResponses, CfgAccountsApiKeyRetrieveErrors, ThrowOnError
|
|
1538
|
+
static cfgAccountsApiKeyRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsApiKeyRetrieveData, ThrowOnError>): RequestResult<CfgAccountsApiKeyRetrieveResponses, CfgAccountsApiKeyRetrieveErrors, ThrowOnError>;
|
|
1532
1539
|
/**
|
|
1533
1540
|
* Regenerate API key
|
|
1534
1541
|
*
|
|
1535
1542
|
* Generate a new API key. The full key is returned only once.
|
|
1536
1543
|
*/
|
|
1537
|
-
static cfgAccountsApiKeyRegenerateCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsApiKeyRegenerateCreateData, ThrowOnError>): RequestResult<CfgAccountsApiKeyRegenerateCreateResponses, CfgAccountsApiKeyRegenerateCreateErrors, ThrowOnError
|
|
1544
|
+
static cfgAccountsApiKeyRegenerateCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsApiKeyRegenerateCreateData, ThrowOnError>): RequestResult<CfgAccountsApiKeyRegenerateCreateResponses, CfgAccountsApiKeyRegenerateCreateErrors, ThrowOnError>;
|
|
1538
1545
|
/**
|
|
1539
1546
|
* Test API key
|
|
1540
1547
|
*
|
|
1541
1548
|
* Test whether an API key is valid without consuming it.
|
|
1542
1549
|
*/
|
|
1543
|
-
static cfgAccountsApiKeyTestCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsApiKeyTestCreateData, ThrowOnError>): RequestResult<CfgAccountsApiKeyTestCreateResponses, unknown, ThrowOnError
|
|
1550
|
+
static cfgAccountsApiKeyTestCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsApiKeyTestCreateData, ThrowOnError>): RequestResult<CfgAccountsApiKeyTestCreateResponses, unknown, ThrowOnError>;
|
|
1544
1551
|
}
|
|
1545
1552
|
declare class CfgAccountsOauth {
|
|
1546
1553
|
/**
|
|
@@ -1548,37 +1555,37 @@ declare class CfgAccountsOauth {
|
|
|
1548
1555
|
*
|
|
1549
1556
|
* Get all OAuth connections for the current user.
|
|
1550
1557
|
*/
|
|
1551
|
-
static cfgAccountsOauthConnectionsList<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsOauthConnectionsListData, ThrowOnError>): RequestResult<CfgAccountsOauthConnectionsListResponses, unknown, ThrowOnError
|
|
1558
|
+
static cfgAccountsOauthConnectionsList<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsOauthConnectionsListData, ThrowOnError>): RequestResult<CfgAccountsOauthConnectionsListResponses, unknown, ThrowOnError>;
|
|
1552
1559
|
/**
|
|
1553
1560
|
* Disconnect OAuth provider
|
|
1554
1561
|
*
|
|
1555
1562
|
* Remove OAuth connection for the specified provider.
|
|
1556
1563
|
*/
|
|
1557
|
-
static cfgAccountsOauthDisconnectCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsOauthDisconnectCreateData, ThrowOnError>): RequestResult<CfgAccountsOauthDisconnectCreateResponses, CfgAccountsOauthDisconnectCreateErrors, ThrowOnError
|
|
1564
|
+
static cfgAccountsOauthDisconnectCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsOauthDisconnectCreateData, ThrowOnError>): RequestResult<CfgAccountsOauthDisconnectCreateResponses, CfgAccountsOauthDisconnectCreateErrors, ThrowOnError>;
|
|
1558
1565
|
/**
|
|
1559
1566
|
* Start GitHub OAuth
|
|
1560
1567
|
*
|
|
1561
1568
|
* Generate GitHub OAuth authorization URL. Redirect user to this URL to start authentication.
|
|
1562
1569
|
*/
|
|
1563
|
-
static cfgAccountsOauthGithubAuthorizeCreate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsOauthGithubAuthorizeCreateData, ThrowOnError>): RequestResult<CfgAccountsOauthGithubAuthorizeCreateResponses, CfgAccountsOauthGithubAuthorizeCreateErrors, ThrowOnError
|
|
1570
|
+
static cfgAccountsOauthGithubAuthorizeCreate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsOauthGithubAuthorizeCreateData, ThrowOnError>): RequestResult<CfgAccountsOauthGithubAuthorizeCreateResponses, CfgAccountsOauthGithubAuthorizeCreateErrors, ThrowOnError>;
|
|
1564
1571
|
/**
|
|
1565
1572
|
* Complete GitHub OAuth
|
|
1566
1573
|
*
|
|
1567
1574
|
* Exchange authorization code for JWT tokens. Call this after GitHub redirects back with code.
|
|
1568
1575
|
*/
|
|
1569
|
-
static cfgAccountsOauthGithubCallbackCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsOauthGithubCallbackCreateData, ThrowOnError>): RequestResult<CfgAccountsOauthGithubCallbackCreateResponses, CfgAccountsOauthGithubCallbackCreateErrors, ThrowOnError
|
|
1576
|
+
static cfgAccountsOauthGithubCallbackCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsOauthGithubCallbackCreateData, ThrowOnError>): RequestResult<CfgAccountsOauthGithubCallbackCreateResponses, CfgAccountsOauthGithubCallbackCreateErrors, ThrowOnError>;
|
|
1570
1577
|
/**
|
|
1571
1578
|
* List OAuth providers
|
|
1572
1579
|
*
|
|
1573
1580
|
* Get list of available OAuth providers for authentication.
|
|
1574
1581
|
*/
|
|
1575
|
-
static cfgAccountsOauthProvidersRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsOauthProvidersRetrieveData, ThrowOnError>): RequestResult<CfgAccountsOauthProvidersRetrieveResponses, unknown, ThrowOnError
|
|
1582
|
+
static cfgAccountsOauthProvidersRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsOauthProvidersRetrieveData, ThrowOnError>): RequestResult<CfgAccountsOauthProvidersRetrieveResponses, unknown, ThrowOnError>;
|
|
1576
1583
|
}
|
|
1577
1584
|
declare class CfgAccounts {
|
|
1578
1585
|
/**
|
|
1579
1586
|
* Request OTP code to email.
|
|
1580
1587
|
*/
|
|
1581
|
-
static cfgAccountsOtpRequestCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsOtpRequestCreateData, ThrowOnError>): RequestResult<CfgAccountsOtpRequestCreateResponses, CfgAccountsOtpRequestCreateErrors, ThrowOnError
|
|
1588
|
+
static cfgAccountsOtpRequestCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsOtpRequestCreateData, ThrowOnError>): RequestResult<CfgAccountsOtpRequestCreateResponses, CfgAccountsOtpRequestCreateErrors, ThrowOnError>;
|
|
1582
1589
|
/**
|
|
1583
1590
|
* Verify OTP code and return JWT tokens or 2FA session.
|
|
1584
1591
|
*
|
|
@@ -1589,7 +1596,7 @@ declare class CfgAccounts {
|
|
|
1589
1596
|
* If user has no 2FA:
|
|
1590
1597
|
* - Returns JWT tokens and user data directly
|
|
1591
1598
|
*/
|
|
1592
|
-
static cfgAccountsOtpVerifyCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsOtpVerifyCreateData, ThrowOnError>): RequestResult<CfgAccountsOtpVerifyCreateResponses, CfgAccountsOtpVerifyCreateErrors, ThrowOnError
|
|
1599
|
+
static cfgAccountsOtpVerifyCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsOtpVerifyCreateData, ThrowOnError>): RequestResult<CfgAccountsOtpVerifyCreateResponses, CfgAccountsOtpVerifyCreateErrors, ThrowOnError>;
|
|
1593
1600
|
}
|
|
1594
1601
|
declare class CfgAccountsProfile {
|
|
1595
1602
|
/**
|
|
@@ -1597,13 +1604,13 @@ declare class CfgAccountsProfile {
|
|
|
1597
1604
|
*
|
|
1598
1605
|
* Retrieve the current authenticated user's profile information.
|
|
1599
1606
|
*/
|
|
1600
|
-
static cfgAccountsProfileRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileRetrieveData, ThrowOnError>): RequestResult<CfgAccountsProfileRetrieveResponses, CfgAccountsProfileRetrieveErrors, ThrowOnError
|
|
1607
|
+
static cfgAccountsProfileRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileRetrieveData, ThrowOnError>): RequestResult<CfgAccountsProfileRetrieveResponses, CfgAccountsProfileRetrieveErrors, ThrowOnError>;
|
|
1601
1608
|
/**
|
|
1602
1609
|
* Upload user avatar
|
|
1603
1610
|
*
|
|
1604
1611
|
* Upload avatar image for the current authenticated user. Accepts multipart/form-data with 'avatar' field.
|
|
1605
1612
|
*/
|
|
1606
|
-
static cfgAccountsProfileAvatarCreate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileAvatarCreateData, ThrowOnError>): RequestResult<CfgAccountsProfileAvatarCreateResponses, CfgAccountsProfileAvatarCreateErrors, ThrowOnError
|
|
1613
|
+
static cfgAccountsProfileAvatarCreate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileAvatarCreateData, ThrowOnError>): RequestResult<CfgAccountsProfileAvatarCreateResponses, CfgAccountsProfileAvatarCreateErrors, ThrowOnError>;
|
|
1607
1614
|
/**
|
|
1608
1615
|
* Delete user account
|
|
1609
1616
|
*
|
|
@@ -1619,37 +1626,37 @@ declare class CfgAccountsProfile {
|
|
|
1619
1626
|
* The account can be restored by an administrator if needed.
|
|
1620
1627
|
*
|
|
1621
1628
|
*/
|
|
1622
|
-
static cfgAccountsProfileDeleteCreate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileDeleteCreateData, ThrowOnError>): RequestResult<CfgAccountsProfileDeleteCreateResponses, CfgAccountsProfileDeleteCreateErrors, ThrowOnError
|
|
1629
|
+
static cfgAccountsProfileDeleteCreate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileDeleteCreateData, ThrowOnError>): RequestResult<CfgAccountsProfileDeleteCreateResponses, CfgAccountsProfileDeleteCreateErrors, ThrowOnError>;
|
|
1623
1630
|
/**
|
|
1624
1631
|
* Partial update user profile
|
|
1625
1632
|
*
|
|
1626
1633
|
* Partially update the current authenticated user's profile information. Supports avatar upload.
|
|
1627
1634
|
*/
|
|
1628
|
-
static cfgAccountsProfilePartialPartialUpdate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfilePartialPartialUpdateData, ThrowOnError>): RequestResult<CfgAccountsProfilePartialPartialUpdateResponses, CfgAccountsProfilePartialPartialUpdateErrors, ThrowOnError
|
|
1635
|
+
static cfgAccountsProfilePartialPartialUpdate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfilePartialPartialUpdateData, ThrowOnError>): RequestResult<CfgAccountsProfilePartialPartialUpdateResponses, CfgAccountsProfilePartialPartialUpdateErrors, ThrowOnError>;
|
|
1629
1636
|
/**
|
|
1630
1637
|
* Partial update user profile
|
|
1631
1638
|
*
|
|
1632
1639
|
* Partially update the current authenticated user's profile information. Supports avatar upload.
|
|
1633
1640
|
*/
|
|
1634
|
-
static cfgAccountsProfilePartialUpdate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfilePartialUpdateData, ThrowOnError>): RequestResult<CfgAccountsProfilePartialUpdateResponses, CfgAccountsProfilePartialUpdateErrors, ThrowOnError
|
|
1641
|
+
static cfgAccountsProfilePartialUpdate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfilePartialUpdateData, ThrowOnError>): RequestResult<CfgAccountsProfilePartialUpdateResponses, CfgAccountsProfilePartialUpdateErrors, ThrowOnError>;
|
|
1635
1642
|
/**
|
|
1636
1643
|
* Update user profile
|
|
1637
1644
|
*
|
|
1638
1645
|
* Update the current authenticated user's profile information.
|
|
1639
1646
|
*/
|
|
1640
|
-
static cfgAccountsProfileUpdatePartialUpdate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileUpdatePartialUpdateData, ThrowOnError>): RequestResult<CfgAccountsProfileUpdatePartialUpdateResponses, CfgAccountsProfileUpdatePartialUpdateErrors, ThrowOnError
|
|
1647
|
+
static cfgAccountsProfileUpdatePartialUpdate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileUpdatePartialUpdateData, ThrowOnError>): RequestResult<CfgAccountsProfileUpdatePartialUpdateResponses, CfgAccountsProfileUpdatePartialUpdateErrors, ThrowOnError>;
|
|
1641
1648
|
/**
|
|
1642
1649
|
* Update user profile
|
|
1643
1650
|
*
|
|
1644
1651
|
* Update the current authenticated user's profile information.
|
|
1645
1652
|
*/
|
|
1646
|
-
static cfgAccountsProfileUpdateUpdate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileUpdateUpdateData, ThrowOnError>): RequestResult<CfgAccountsProfileUpdateUpdateResponses, CfgAccountsProfileUpdateUpdateErrors, ThrowOnError
|
|
1653
|
+
static cfgAccountsProfileUpdateUpdate<ThrowOnError extends boolean = false>(options?: Options<CfgAccountsProfileUpdateUpdateData, ThrowOnError>): RequestResult<CfgAccountsProfileUpdateUpdateResponses, CfgAccountsProfileUpdateUpdateErrors, ThrowOnError>;
|
|
1647
1654
|
}
|
|
1648
1655
|
declare class CfgAccountsAuth {
|
|
1649
1656
|
/**
|
|
1650
1657
|
* Refresh JWT token.
|
|
1651
1658
|
*/
|
|
1652
|
-
static cfgAccountsTokenRefreshCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsTokenRefreshCreateData, ThrowOnError>): RequestResult<CfgAccountsTokenRefreshCreateResponses, unknown, ThrowOnError
|
|
1659
|
+
static cfgAccountsTokenRefreshCreate<ThrowOnError extends boolean = false>(options: Options<CfgAccountsTokenRefreshCreateData, ThrowOnError>): RequestResult<CfgAccountsTokenRefreshCreateResponses, unknown, ThrowOnError>;
|
|
1653
1660
|
}
|
|
1654
1661
|
declare class CfgCentrifugo {
|
|
1655
1662
|
/**
|
|
@@ -1657,38 +1664,38 @@ declare class CfgCentrifugo {
|
|
|
1657
1664
|
*
|
|
1658
1665
|
* Generate JWT token for WebSocket connection to Centrifugo. Token includes user's allowed channels based on their permissions. Requires authentication.
|
|
1659
1666
|
*/
|
|
1660
|
-
static cfgCentrifugoAuthTokenRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgCentrifugoAuthTokenRetrieveData, ThrowOnError>): RequestResult<CfgCentrifugoAuthTokenRetrieveResponses, CfgCentrifugoAuthTokenRetrieveErrors, ThrowOnError
|
|
1667
|
+
static cfgCentrifugoAuthTokenRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgCentrifugoAuthTokenRetrieveData, ThrowOnError>): RequestResult<CfgCentrifugoAuthTokenRetrieveResponses, CfgCentrifugoAuthTokenRetrieveErrors, ThrowOnError>;
|
|
1661
1668
|
}
|
|
1662
1669
|
declare class CfgTotpBackupCodes {
|
|
1663
1670
|
/**
|
|
1664
1671
|
* Get backup codes status for user.
|
|
1665
1672
|
*/
|
|
1666
|
-
static cfgTotpBackupCodesRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgTotpBackupCodesRetrieveData, ThrowOnError>): RequestResult<CfgTotpBackupCodesRetrieveResponses, unknown, ThrowOnError
|
|
1673
|
+
static cfgTotpBackupCodesRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgTotpBackupCodesRetrieveData, ThrowOnError>): RequestResult<CfgTotpBackupCodesRetrieveResponses, unknown, ThrowOnError>;
|
|
1667
1674
|
/**
|
|
1668
1675
|
* Regenerate backup codes.
|
|
1669
1676
|
*
|
|
1670
1677
|
* Requires TOTP code for verification.
|
|
1671
1678
|
* Invalidates all existing codes.
|
|
1672
1679
|
*/
|
|
1673
|
-
static cfgTotpBackupCodesRegenerateCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpBackupCodesRegenerateCreateData, ThrowOnError>): RequestResult<CfgTotpBackupCodesRegenerateCreateResponses, CfgTotpBackupCodesRegenerateCreateErrors, ThrowOnError
|
|
1680
|
+
static cfgTotpBackupCodesRegenerateCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpBackupCodesRegenerateCreateData, ThrowOnError>): RequestResult<CfgTotpBackupCodesRegenerateCreateResponses, CfgTotpBackupCodesRegenerateCreateErrors, ThrowOnError>;
|
|
1674
1681
|
}
|
|
1675
1682
|
declare class CfgTotp {
|
|
1676
1683
|
/**
|
|
1677
1684
|
* List all TOTP devices for user.
|
|
1678
1685
|
*/
|
|
1679
|
-
static cfgTotpDevicesRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgTotpDevicesRetrieveData, ThrowOnError>): RequestResult<CfgTotpDevicesRetrieveResponses, unknown, ThrowOnError
|
|
1686
|
+
static cfgTotpDevicesRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgTotpDevicesRetrieveData, ThrowOnError>): RequestResult<CfgTotpDevicesRetrieveResponses, unknown, ThrowOnError>;
|
|
1680
1687
|
/**
|
|
1681
1688
|
* Delete a TOTP device.
|
|
1682
1689
|
*
|
|
1683
1690
|
* Requires verification code if removing the last/primary device.
|
|
1684
1691
|
*/
|
|
1685
|
-
static cfgTotpDevicesDestroy<ThrowOnError extends boolean = false>(options: Options<CfgTotpDevicesDestroyData, ThrowOnError>): RequestResult<CfgTotpDevicesDestroyResponses, unknown, ThrowOnError
|
|
1692
|
+
static cfgTotpDevicesDestroy<ThrowOnError extends boolean = false>(options: Options<CfgTotpDevicesDestroyData, ThrowOnError>): RequestResult<CfgTotpDevicesDestroyResponses, unknown, ThrowOnError>;
|
|
1686
1693
|
/**
|
|
1687
1694
|
* Completely disable 2FA for account.
|
|
1688
1695
|
*
|
|
1689
1696
|
* Requires verification code.
|
|
1690
1697
|
*/
|
|
1691
|
-
static cfgTotpDisableCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpDisableCreateData, ThrowOnError>): RequestResult<CfgTotpDisableCreateResponses, CfgTotpDisableCreateErrors, ThrowOnError
|
|
1698
|
+
static cfgTotpDisableCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpDisableCreateData, ThrowOnError>): RequestResult<CfgTotpDisableCreateResponses, CfgTotpDisableCreateErrors, ThrowOnError>;
|
|
1692
1699
|
}
|
|
1693
1700
|
declare class CfgTotpSetup {
|
|
1694
1701
|
/**
|
|
@@ -1696,13 +1703,13 @@ declare class CfgTotpSetup {
|
|
|
1696
1703
|
*
|
|
1697
1704
|
* Creates a new TOTP device and returns QR code for scanning.
|
|
1698
1705
|
*/
|
|
1699
|
-
static cfgTotpSetupCreate<ThrowOnError extends boolean = false>(options?: Options<CfgTotpSetupCreateData, ThrowOnError>): RequestResult<CfgTotpSetupCreateResponses, CfgTotpSetupCreateErrors, ThrowOnError
|
|
1706
|
+
static cfgTotpSetupCreate<ThrowOnError extends boolean = false>(options?: Options<CfgTotpSetupCreateData, ThrowOnError>): RequestResult<CfgTotpSetupCreateResponses, CfgTotpSetupCreateErrors, ThrowOnError>;
|
|
1700
1707
|
/**
|
|
1701
1708
|
* Confirm 2FA setup with first valid code.
|
|
1702
1709
|
*
|
|
1703
1710
|
* Activates the device and generates backup codes.
|
|
1704
1711
|
*/
|
|
1705
|
-
static cfgTotpSetupConfirmCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpSetupConfirmCreateData, ThrowOnError>): RequestResult<CfgTotpSetupConfirmCreateResponses, CfgTotpSetupConfirmCreateErrors, ThrowOnError
|
|
1712
|
+
static cfgTotpSetupConfirmCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpSetupConfirmCreateData, ThrowOnError>): RequestResult<CfgTotpSetupConfirmCreateResponses, CfgTotpSetupConfirmCreateErrors, ThrowOnError>;
|
|
1706
1713
|
}
|
|
1707
1714
|
declare class CfgTotpVerify {
|
|
1708
1715
|
/**
|
|
@@ -1710,13 +1717,13 @@ declare class CfgTotpVerify {
|
|
|
1710
1717
|
*
|
|
1711
1718
|
* Completes authentication and returns JWT tokens on success.
|
|
1712
1719
|
*/
|
|
1713
|
-
static cfgTotpVerifyCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpVerifyCreateData, ThrowOnError>): RequestResult<CfgTotpVerifyCreateResponses, CfgTotpVerifyCreateErrors, ThrowOnError
|
|
1720
|
+
static cfgTotpVerifyCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpVerifyCreateData, ThrowOnError>): RequestResult<CfgTotpVerifyCreateResponses, CfgTotpVerifyCreateErrors, ThrowOnError>;
|
|
1714
1721
|
/**
|
|
1715
1722
|
* Verify backup recovery code for 2FA session.
|
|
1716
1723
|
*
|
|
1717
1724
|
* Alternative verification method when TOTP device unavailable.
|
|
1718
1725
|
*/
|
|
1719
|
-
static cfgTotpVerifyBackupCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpVerifyBackupCreateData, ThrowOnError>): RequestResult<CfgTotpVerifyBackupCreateResponses, CfgTotpVerifyBackupCreateErrors, ThrowOnError
|
|
1726
|
+
static cfgTotpVerifyBackupCreate<ThrowOnError extends boolean = false>(options: Options<CfgTotpVerifyBackupCreateData, ThrowOnError>): RequestResult<CfgTotpVerifyBackupCreateResponses, CfgTotpVerifyBackupCreateErrors, ThrowOnError>;
|
|
1720
1727
|
}
|
|
1721
1728
|
|
|
1722
1729
|
interface APIOptions$2 {
|