@flashstart/client 0.2.1 → 8.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/src/generated/authentication/sdk.gen.d.ts +12 -4
- package/dist/src/generated/authentication/sdk.gen.js +16 -4
- package/dist/src/generated/integration/index.d.ts +1 -1
- package/dist/src/generated/integration/sdk.gen.d.ts +5 -1
- package/dist/src/generated/integration/sdk.gen.js +10 -0
- package/dist/src/generated/integration/types.gen.d.ts +56 -2
- package/package.json +4 -4
|
@@ -32,11 +32,15 @@ export declare class AuthenticationSdk extends HeyApiClient {
|
|
|
32
32
|
key?: string;
|
|
33
33
|
});
|
|
34
34
|
/**
|
|
35
|
-
* Log in
|
|
35
|
+
* Log in (Private / Internal)
|
|
36
|
+
*
|
|
37
|
+
* Internal system route for FlashStart frontend authentication. Not intended for direct external customer usage — external customers must use API keys (x-api-key) with public API endpoints.
|
|
36
38
|
*/
|
|
37
39
|
login<ThrowOnError extends boolean = false>(options: Options<LoginData, ThrowOnError>): RequestResult<LoginResponses, LoginErrors, ThrowOnError>;
|
|
38
40
|
/**
|
|
39
|
-
* Refresh tokens
|
|
41
|
+
* Refresh tokens (Private / Internal)
|
|
42
|
+
*
|
|
43
|
+
* Internal system route for FlashStart frontend authentication. Not intended for direct external customer usage — external customers must use API keys (x-api-key) with public API endpoints.
|
|
40
44
|
*/
|
|
41
45
|
refreshToken<ThrowOnError extends boolean = false>(options: Options<RefreshTokenData, ThrowOnError>): RequestResult<RefreshTokenResponses, RefreshTokenErrors, ThrowOnError>;
|
|
42
46
|
/**
|
|
@@ -52,11 +56,15 @@ export declare class AuthenticationSdk extends HeyApiClient {
|
|
|
52
56
|
*/
|
|
53
57
|
resetPassword<ThrowOnError extends boolean = false>(options: Options<ResetPasswordData, ThrowOnError>): RequestResult<ResetPasswordResponses, ResetPasswordErrors, ThrowOnError>;
|
|
54
58
|
/**
|
|
55
|
-
* Log in with one-time token
|
|
59
|
+
* Log in with one-time token (Private / Internal)
|
|
60
|
+
*
|
|
61
|
+
* Internal system route for FlashStart frontend authentication. Not intended for direct external customer usage — external customers must use API keys (x-api-key) with public API endpoints.
|
|
56
62
|
*/
|
|
57
63
|
loginWithOneTimeToken<ThrowOnError extends boolean = false>(options: Options<LoginWithOneTimeTokenData, ThrowOnError>): RequestResult<LoginWithOneTimeTokenResponses, LoginWithOneTimeTokenErrors, ThrowOnError>;
|
|
58
64
|
/**
|
|
59
|
-
* Log out
|
|
65
|
+
* Log out (Private / Internal)
|
|
66
|
+
*
|
|
67
|
+
* Internal system route for FlashStart frontend authentication. Not intended for direct external customer usage — external customers must use API keys (x-api-key) with public API endpoints.
|
|
60
68
|
*/
|
|
61
69
|
logout<ThrowOnError extends boolean = false>(options: Options<LogoutData, ThrowOnError>): RequestResult<LogoutResponses, LogoutErrors, ThrowOnError>;
|
|
62
70
|
/**
|
|
@@ -27,10 +27,13 @@ export class AuthenticationSdk extends HeyApiClient {
|
|
|
27
27
|
AuthenticationSdk.__registry.set(this, args?.key);
|
|
28
28
|
}
|
|
29
29
|
/**
|
|
30
|
-
* Log in
|
|
30
|
+
* Log in (Private / Internal)
|
|
31
|
+
*
|
|
32
|
+
* Internal system route for FlashStart frontend authentication. Not intended for direct external customer usage — external customers must use API keys (x-api-key) with public API endpoints.
|
|
31
33
|
*/
|
|
32
34
|
login(options) {
|
|
33
35
|
return (options.client ?? this.client).post({
|
|
36
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
34
37
|
url: '/v1/login',
|
|
35
38
|
...options,
|
|
36
39
|
headers: {
|
|
@@ -40,10 +43,13 @@ export class AuthenticationSdk extends HeyApiClient {
|
|
|
40
43
|
});
|
|
41
44
|
}
|
|
42
45
|
/**
|
|
43
|
-
* Refresh tokens
|
|
46
|
+
* Refresh tokens (Private / Internal)
|
|
47
|
+
*
|
|
48
|
+
* Internal system route for FlashStart frontend authentication. Not intended for direct external customer usage — external customers must use API keys (x-api-key) with public API endpoints.
|
|
44
49
|
*/
|
|
45
50
|
refreshToken(options) {
|
|
46
51
|
return (options.client ?? this.client).post({
|
|
52
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
47
53
|
url: '/v1/refresh',
|
|
48
54
|
...options,
|
|
49
55
|
headers: {
|
|
@@ -91,10 +97,13 @@ export class AuthenticationSdk extends HeyApiClient {
|
|
|
91
97
|
});
|
|
92
98
|
}
|
|
93
99
|
/**
|
|
94
|
-
* Log in with one-time token
|
|
100
|
+
* Log in with one-time token (Private / Internal)
|
|
101
|
+
*
|
|
102
|
+
* Internal system route for FlashStart frontend authentication. Not intended for direct external customer usage — external customers must use API keys (x-api-key) with public API endpoints.
|
|
95
103
|
*/
|
|
96
104
|
loginWithOneTimeToken(options) {
|
|
97
105
|
return (options.client ?? this.client).post({
|
|
106
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
98
107
|
url: '/v1/one-time-token/login',
|
|
99
108
|
...options,
|
|
100
109
|
headers: {
|
|
@@ -104,10 +113,13 @@ export class AuthenticationSdk extends HeyApiClient {
|
|
|
104
113
|
});
|
|
105
114
|
}
|
|
106
115
|
/**
|
|
107
|
-
* Log out
|
|
116
|
+
* Log out (Private / Internal)
|
|
117
|
+
*
|
|
118
|
+
* Internal system route for FlashStart frontend authentication. Not intended for direct external customer usage — external customers must use API keys (x-api-key) with public API endpoints.
|
|
108
119
|
*/
|
|
109
120
|
logout(options) {
|
|
110
121
|
return (options.client ?? this.client).post({
|
|
122
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
111
123
|
url: '/v1/logout',
|
|
112
124
|
...options,
|
|
113
125
|
headers: {
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export { IntegrationSdk, type Options } from './sdk.gen.js';
|
|
2
|
-
export type { AssociateCloudBoxDnsRouteData, AssociateCloudBoxDnsRouteError, AssociateCloudBoxDnsRouteErrors, AssociateCloudBoxDnsRouteResponse, AssociateCloudBoxDnsRouteResponses, AssociateDeviceToRuleData, AssociateDeviceToRuleError, AssociateDeviceToRuleErrors, AssociateDeviceToRuleResponse, AssociateDeviceToRuleResponses, AssociateEndPointDnsRouteData, AssociateEndPointDnsRouteError, AssociateEndPointDnsRouteErrors, AssociateEndPointDnsRouteResponse, AssociateEndPointDnsRouteResponses, AssociateRouterNetworkPolicyData, AssociateRouterNetworkPolicyError, AssociateRouterNetworkPolicyErrors, AssociateRouterNetworkPolicyResponse, AssociateRouterNetworkPolicyResponses, ClientOptions, CreateCloudBoxDnsRouteData, CreateCloudBoxDnsRouteError, CreateCloudBoxDnsRouteErrors, CreateCloudBoxDnsRouteResponse, CreateCloudBoxDnsRouteResponses, CreateDeviceData, CreateDeviceError, CreateDeviceErrors, CreateDeviceResponse, CreateDeviceResponses, CreateEndPointDnsRouteData, CreateEndPointDnsRouteError, CreateEndPointDnsRouteErrors, CreateEndPointDnsRouteResponse, CreateEndPointDnsRouteResponses, CreateRouterData, CreateRouterError, CreateRouterErrors, CreateRouterResponse, CreateRouterResponses, CreateRuleData, CreateRuleError, CreateRuleErrors, CreateRuleResponse, CreateRuleResponses, DeleteCloudBoxDnsRouteData, DeleteCloudBoxDnsRouteError, DeleteCloudBoxDnsRouteErrors, DeleteCloudBoxDnsRouteResponse, DeleteCloudBoxDnsRouteResponses, DeleteDeviceData, DeleteDeviceError, DeleteDeviceErrors, DeleteDeviceResponse, DeleteDeviceResponses, DeleteDnsRouteData, DeleteDnsRouteError, DeleteDnsRouteErrors, DeleteDnsRouteResponse, DeleteDnsRouteResponses, DeleteEndpointData, DeleteEndPointDnsRouteData, DeleteEndPointDnsRouteError, DeleteEndPointDnsRouteErrors, DeleteEndPointDnsRouteResponse, DeleteEndPointDnsRouteResponses, DeleteEndpointError, DeleteEndpointErrors, DeleteEndpointResponse, DeleteEndpointResponses, DeleteRouterData, DeleteRouterError, DeleteRouterErrors, DeleteRouterResponse, DeleteRouterResponses, DeleteRuleData, DeleteRuleError, DeleteRuleErrors, DeleteRuleResponse, DeleteRuleResponses, DisassociateCloudBoxDnsRouteData, DisassociateCloudBoxDnsRouteError, DisassociateCloudBoxDnsRouteErrors, DisassociateCloudBoxDnsRouteResponse, DisassociateCloudBoxDnsRouteResponses, DisassociateEndPointDnsRouteData, DisassociateEndPointDnsRouteError, DisassociateEndPointDnsRouteErrors, DisassociateEndPointDnsRouteResponse, DisassociateEndPointDnsRouteResponses, DissociateDeviceFromRuleData, DissociateDeviceFromRuleError, DissociateDeviceFromRuleErrors, DissociateDeviceFromRuleResponse, DissociateDeviceFromRuleResponses, DissociateRouterNetworkPolicyData, DissociateRouterNetworkPolicyError, DissociateRouterNetworkPolicyErrors, DissociateRouterNetworkPolicyResponse, DissociateRouterNetworkPolicyResponses, FlashStartErrorBody, GetCloudBoxDnsRoutesData, GetCloudBoxDnsRoutesError, GetCloudBoxDnsRoutesErrors, GetCloudBoxDnsRoutesResponse, GetCloudBoxDnsRoutesResponses, GetDeviceCredentialsData, GetDeviceCredentialsError, GetDeviceCredentialsErrors, GetDeviceCredentialsResponse, GetDeviceCredentialsResponses, GetDeviceData, GetDeviceError, GetDeviceErrors, GetDeviceResponse, GetDeviceResponses, GetDevicesData, GetDevicesError, GetDevicesErrors, GetDevicesResponse, GetDevicesResponses, GetEndpointByIdData, GetEndpointByIdError, GetEndpointByIdErrors, GetEndpointByIdResponse, GetEndpointByIdResponses, GetEndPointDnsRoutesData, GetEndPointDnsRoutesError, GetEndPointDnsRoutesErrors, GetEndPointDnsRoutesResponse, GetEndPointDnsRoutesResponses, GetEndpointPoliciesData, GetEndpointPoliciesError, GetEndpointPoliciesErrors, GetEndpointPoliciesResponse, GetEndpointPoliciesResponses, GetEndpointPolicyByIdData, GetEndpointPolicyByIdError, GetEndpointPolicyByIdErrors, GetEndpointPolicyByIdResponse, GetEndpointPolicyByIdResponses, GetEndpointsData, GetEndpointsError, GetEndpointsErrors, GetEndpointsResponse, GetEndpointsResponses, GetPhysicalDevicesData, GetPhysicalDevicesError, GetPhysicalDevicesErrors, GetPhysicalDevicesResponse, GetPhysicalDevicesResponses, GetRouterData, GetRouterError, GetRouterErrors, GetRouterNetworksData, GetRouterNetworksError, GetRouterNetworksErrors, GetRouterNetworksResponse, GetRouterNetworksResponses, GetRouterPoliciesData, GetRouterPoliciesError, GetRouterPoliciesErrors, GetRouterPoliciesResponse, GetRouterPoliciesResponses, GetRouterResponse, GetRouterResponses, GetRoutersData, GetRoutersError, GetRoutersErrors, GetRoutersResponse, GetRoutersResponses, GetRulesData, GetRulesError, GetRulesErrors, GetRulesResponse, GetRulesResponses, MissingCredentialsErrorBody, UpdateDeviceCatchAllData, UpdateDeviceCatchAllError, UpdateDeviceCatchAllErrors, UpdateDeviceCatchAllResponse, UpdateDeviceCatchAllResponses, UpdateDeviceCredentialsData, UpdateDeviceCredentialsError, UpdateDeviceCredentialsErrors, UpdateDeviceCredentialsResponse, UpdateDeviceCredentialsResponses, UpdateDeviceData, UpdateDeviceError, UpdateDeviceErrors, UpdateDeviceResponse, UpdateDeviceResponses, UpdateDynamicInternalRouterNetworkData, UpdateDynamicInternalRouterNetworkError, UpdateDynamicInternalRouterNetworkErrors, UpdateDynamicInternalRouterNetworkResponse, UpdateDynamicInternalRouterNetworkResponses, UpdateEncryptedRouterNetworkData, UpdateEncryptedRouterNetworkError, UpdateEncryptedRouterNetworkErrors, UpdateEncryptedRouterNetworkResponse, UpdateEncryptedRouterNetworkResponses, UpdateEndpointData, UpdateEndpointError, UpdateEndpointErrors, UpdateEndpointPolicyData, UpdateEndpointPolicyError, UpdateEndpointPolicyErrors, UpdateEndpointPolicyResponse, UpdateEndpointPolicyResponses, UpdateEndpointResponse, UpdateEndpointResponses, UpdateRouterData, UpdateRouterError, UpdateRouterErrors, UpdateRouterResponse, UpdateRouterResponses } from './types.gen.js';
|
|
2
|
+
export type { AssociateCloudBoxDnsRouteData, AssociateCloudBoxDnsRouteError, AssociateCloudBoxDnsRouteErrors, AssociateCloudBoxDnsRouteResponse, AssociateCloudBoxDnsRouteResponses, AssociateDeviceToRuleData, AssociateDeviceToRuleError, AssociateDeviceToRuleErrors, AssociateDeviceToRuleResponse, AssociateDeviceToRuleResponses, AssociateEndPointDnsRouteData, AssociateEndPointDnsRouteError, AssociateEndPointDnsRouteErrors, AssociateEndPointDnsRouteResponse, AssociateEndPointDnsRouteResponses, AssociateRouterNetworkPolicyData, AssociateRouterNetworkPolicyError, AssociateRouterNetworkPolicyErrors, AssociateRouterNetworkPolicyResponse, AssociateRouterNetworkPolicyResponses, ClientOptions, CreateCloudBoxDnsRouteData, CreateCloudBoxDnsRouteError, CreateCloudBoxDnsRouteErrors, CreateCloudBoxDnsRouteResponse, CreateCloudBoxDnsRouteResponses, CreateDeviceData, CreateDeviceError, CreateDeviceErrors, CreateDeviceResponse, CreateDeviceResponses, CreateEndPointDnsRouteData, CreateEndPointDnsRouteError, CreateEndPointDnsRouteErrors, CreateEndPointDnsRouteResponse, CreateEndPointDnsRouteResponses, CreateRouterData, CreateRouterError, CreateRouterErrors, CreateRouterResponse, CreateRouterResponses, CreateRuleData, CreateRuleError, CreateRuleErrors, CreateRuleResponse, CreateRuleResponses, DeleteCloudBoxDnsRouteData, DeleteCloudBoxDnsRouteError, DeleteCloudBoxDnsRouteErrors, DeleteCloudBoxDnsRouteResponse, DeleteCloudBoxDnsRouteResponses, DeleteDeviceData, DeleteDeviceError, DeleteDeviceErrors, DeleteDeviceResponse, DeleteDeviceResponses, DeleteDnsRouteData, DeleteDnsRouteError, DeleteDnsRouteErrors, DeleteDnsRouteResponse, DeleteDnsRouteResponses, DeleteEndpointData, DeleteEndPointDnsRouteData, DeleteEndPointDnsRouteError, DeleteEndPointDnsRouteErrors, DeleteEndPointDnsRouteResponse, DeleteEndPointDnsRouteResponses, DeleteEndpointError, DeleteEndpointErrors, DeleteEndpointResponse, DeleteEndpointResponses, DeleteRouterData, DeleteRouterError, DeleteRouterErrors, DeleteRouterResponse, DeleteRouterResponses, DeleteRuleData, DeleteRuleError, DeleteRuleErrors, DeleteRuleResponse, DeleteRuleResponses, DisassociateCloudBoxDnsRouteData, DisassociateCloudBoxDnsRouteError, DisassociateCloudBoxDnsRouteErrors, DisassociateCloudBoxDnsRouteResponse, DisassociateCloudBoxDnsRouteResponses, DisassociateEndPointDnsRouteData, DisassociateEndPointDnsRouteError, DisassociateEndPointDnsRouteErrors, DisassociateEndPointDnsRouteResponse, DisassociateEndPointDnsRouteResponses, DissociateDeviceFromRuleData, DissociateDeviceFromRuleError, DissociateDeviceFromRuleErrors, DissociateDeviceFromRuleResponse, DissociateDeviceFromRuleResponses, DissociateRouterNetworkPolicyData, DissociateRouterNetworkPolicyError, DissociateRouterNetworkPolicyErrors, DissociateRouterNetworkPolicyResponse, DissociateRouterNetworkPolicyResponses, FlashStartErrorBody, GetCloudBoxDnsRoutesData, GetCloudBoxDnsRoutesError, GetCloudBoxDnsRoutesErrors, GetCloudBoxDnsRoutesResponse, GetCloudBoxDnsRoutesResponses, GetDeviceCredentialsData, GetDeviceCredentialsError, GetDeviceCredentialsErrors, GetDeviceCredentialsResponse, GetDeviceCredentialsResponses, GetDeviceData, GetDeviceError, GetDeviceErrors, GetDeviceResponse, GetDeviceResponses, GetDevicesData, GetDevicesError, GetDevicesErrors, GetDevicesResponse, GetDevicesResponses, GetEndpointByIdData, GetEndpointByIdError, GetEndpointByIdErrors, GetEndpointByIdResponse, GetEndpointByIdResponses, GetEndPointDnsRoutesData, GetEndPointDnsRoutesError, GetEndPointDnsRoutesErrors, GetEndPointDnsRoutesResponse, GetEndPointDnsRoutesResponses, GetEndpointPoliciesData, GetEndpointPoliciesError, GetEndpointPoliciesErrors, GetEndpointPoliciesResponse, GetEndpointPoliciesResponses, GetEndpointPolicyByIdData, GetEndpointPolicyByIdError, GetEndpointPolicyByIdErrors, GetEndpointPolicyByIdResponse, GetEndpointPolicyByIdResponses, GetEndpointsData, GetEndpointsError, GetEndpointsErrors, GetEndpointsResponse, GetEndpointsResponses, GetPhysicalDevicesData, GetPhysicalDevicesError, GetPhysicalDevicesErrors, GetPhysicalDevicesResponse, GetPhysicalDevicesResponses, GetRouterConfigurationScriptParametersData, GetRouterConfigurationScriptParametersError, GetRouterConfigurationScriptParametersErrors, GetRouterConfigurationScriptParametersResponse, GetRouterConfigurationScriptParametersResponses, GetRouterData, GetRouterError, GetRouterErrors, GetRouterNetworksData, GetRouterNetworksError, GetRouterNetworksErrors, GetRouterNetworksResponse, GetRouterNetworksResponses, GetRouterPoliciesData, GetRouterPoliciesError, GetRouterPoliciesErrors, GetRouterPoliciesResponse, GetRouterPoliciesResponses, GetRouterResponse, GetRouterResponses, GetRoutersData, GetRoutersError, GetRoutersErrors, GetRoutersResponse, GetRoutersResponses, GetRulesData, GetRulesError, GetRulesErrors, GetRulesResponse, GetRulesResponses, MissingCredentialsErrorBody, UpdateDeviceCatchAllData, UpdateDeviceCatchAllError, UpdateDeviceCatchAllErrors, UpdateDeviceCatchAllResponse, UpdateDeviceCatchAllResponses, UpdateDeviceCredentialsData, UpdateDeviceCredentialsError, UpdateDeviceCredentialsErrors, UpdateDeviceCredentialsResponse, UpdateDeviceCredentialsResponses, UpdateDeviceData, UpdateDeviceError, UpdateDeviceErrors, UpdateDeviceResponse, UpdateDeviceResponses, UpdateDynamicInternalRouterNetworkData, UpdateDynamicInternalRouterNetworkError, UpdateDynamicInternalRouterNetworkErrors, UpdateDynamicInternalRouterNetworkResponse, UpdateDynamicInternalRouterNetworkResponses, UpdateEncryptedRouterNetworkData, UpdateEncryptedRouterNetworkError, UpdateEncryptedRouterNetworkErrors, UpdateEncryptedRouterNetworkResponse, UpdateEncryptedRouterNetworkResponses, UpdateEndpointData, UpdateEndpointError, UpdateEndpointErrors, UpdateEndpointPolicyData, UpdateEndpointPolicyError, UpdateEndpointPolicyErrors, UpdateEndpointPolicyResponse, UpdateEndpointPolicyResponses, UpdateEndpointResponse, UpdateEndpointResponses, UpdateRouterData, UpdateRouterError, UpdateRouterErrors, UpdateRouterResponse, UpdateRouterResponses } from './types.gen.js';
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client/index.js';
|
|
2
|
-
import type { AssociateCloudBoxDnsRouteData, AssociateCloudBoxDnsRouteErrors, AssociateCloudBoxDnsRouteResponses, AssociateDeviceToRuleData, AssociateDeviceToRuleErrors, AssociateDeviceToRuleResponses, AssociateEndPointDnsRouteData, AssociateEndPointDnsRouteErrors, AssociateEndPointDnsRouteResponses, AssociateRouterNetworkPolicyData, AssociateRouterNetworkPolicyErrors, AssociateRouterNetworkPolicyResponses, CreateCloudBoxDnsRouteData, CreateCloudBoxDnsRouteErrors, CreateCloudBoxDnsRouteResponses, CreateDeviceData, CreateDeviceErrors, CreateDeviceResponses, CreateEndPointDnsRouteData, CreateEndPointDnsRouteErrors, CreateEndPointDnsRouteResponses, CreateRouterData, CreateRouterErrors, CreateRouterResponses, CreateRuleData, CreateRuleErrors, CreateRuleResponses, DeleteCloudBoxDnsRouteData, DeleteCloudBoxDnsRouteErrors, DeleteCloudBoxDnsRouteResponses, DeleteDeviceData, DeleteDeviceErrors, DeleteDeviceResponses, DeleteDnsRouteData, DeleteDnsRouteErrors, DeleteDnsRouteResponses, DeleteEndpointData, DeleteEndPointDnsRouteData, DeleteEndPointDnsRouteErrors, DeleteEndPointDnsRouteResponses, DeleteEndpointErrors, DeleteEndpointResponses, DeleteRouterData, DeleteRouterErrors, DeleteRouterResponses, DeleteRuleData, DeleteRuleErrors, DeleteRuleResponses, DisassociateCloudBoxDnsRouteData, DisassociateCloudBoxDnsRouteErrors, DisassociateCloudBoxDnsRouteResponses, DisassociateEndPointDnsRouteData, DisassociateEndPointDnsRouteErrors, DisassociateEndPointDnsRouteResponses, DissociateDeviceFromRuleData, DissociateDeviceFromRuleErrors, DissociateDeviceFromRuleResponses, DissociateRouterNetworkPolicyData, DissociateRouterNetworkPolicyErrors, DissociateRouterNetworkPolicyResponses, GetCloudBoxDnsRoutesData, GetCloudBoxDnsRoutesErrors, GetCloudBoxDnsRoutesResponses, GetDeviceCredentialsData, GetDeviceCredentialsErrors, GetDeviceCredentialsResponses, GetDeviceData, GetDeviceErrors, GetDeviceResponses, GetDevicesData, GetDevicesErrors, GetDevicesResponses, GetEndpointByIdData, GetEndpointByIdErrors, GetEndpointByIdResponses, GetEndPointDnsRoutesData, GetEndPointDnsRoutesErrors, GetEndPointDnsRoutesResponses, GetEndpointPoliciesData, GetEndpointPoliciesErrors, GetEndpointPoliciesResponses, GetEndpointPolicyByIdData, GetEndpointPolicyByIdErrors, GetEndpointPolicyByIdResponses, GetEndpointsData, GetEndpointsErrors, GetEndpointsResponses, GetPhysicalDevicesData, GetPhysicalDevicesErrors, GetPhysicalDevicesResponses, GetRouterData, GetRouterErrors, GetRouterNetworksData, GetRouterNetworksErrors, GetRouterNetworksResponses, GetRouterPoliciesData, GetRouterPoliciesErrors, GetRouterPoliciesResponses, GetRouterResponses, GetRoutersData, GetRoutersErrors, GetRoutersResponses, GetRulesData, GetRulesErrors, GetRulesResponses, UpdateDeviceCatchAllData, UpdateDeviceCatchAllErrors, UpdateDeviceCatchAllResponses, UpdateDeviceCredentialsData, UpdateDeviceCredentialsErrors, UpdateDeviceCredentialsResponses, UpdateDeviceData, UpdateDeviceErrors, UpdateDeviceResponses, UpdateDynamicInternalRouterNetworkData, UpdateDynamicInternalRouterNetworkErrors, UpdateDynamicInternalRouterNetworkResponses, UpdateEncryptedRouterNetworkData, UpdateEncryptedRouterNetworkErrors, UpdateEncryptedRouterNetworkResponses, UpdateEndpointData, UpdateEndpointErrors, UpdateEndpointPolicyData, UpdateEndpointPolicyErrors, UpdateEndpointPolicyResponses, UpdateEndpointResponses, UpdateRouterData, UpdateRouterErrors, UpdateRouterResponses } from './types.gen.js';
|
|
2
|
+
import type { AssociateCloudBoxDnsRouteData, AssociateCloudBoxDnsRouteErrors, AssociateCloudBoxDnsRouteResponses, AssociateDeviceToRuleData, AssociateDeviceToRuleErrors, AssociateDeviceToRuleResponses, AssociateEndPointDnsRouteData, AssociateEndPointDnsRouteErrors, AssociateEndPointDnsRouteResponses, AssociateRouterNetworkPolicyData, AssociateRouterNetworkPolicyErrors, AssociateRouterNetworkPolicyResponses, CreateCloudBoxDnsRouteData, CreateCloudBoxDnsRouteErrors, CreateCloudBoxDnsRouteResponses, CreateDeviceData, CreateDeviceErrors, CreateDeviceResponses, CreateEndPointDnsRouteData, CreateEndPointDnsRouteErrors, CreateEndPointDnsRouteResponses, CreateRouterData, CreateRouterErrors, CreateRouterResponses, CreateRuleData, CreateRuleErrors, CreateRuleResponses, DeleteCloudBoxDnsRouteData, DeleteCloudBoxDnsRouteErrors, DeleteCloudBoxDnsRouteResponses, DeleteDeviceData, DeleteDeviceErrors, DeleteDeviceResponses, DeleteDnsRouteData, DeleteDnsRouteErrors, DeleteDnsRouteResponses, DeleteEndpointData, DeleteEndPointDnsRouteData, DeleteEndPointDnsRouteErrors, DeleteEndPointDnsRouteResponses, DeleteEndpointErrors, DeleteEndpointResponses, DeleteRouterData, DeleteRouterErrors, DeleteRouterResponses, DeleteRuleData, DeleteRuleErrors, DeleteRuleResponses, DisassociateCloudBoxDnsRouteData, DisassociateCloudBoxDnsRouteErrors, DisassociateCloudBoxDnsRouteResponses, DisassociateEndPointDnsRouteData, DisassociateEndPointDnsRouteErrors, DisassociateEndPointDnsRouteResponses, DissociateDeviceFromRuleData, DissociateDeviceFromRuleErrors, DissociateDeviceFromRuleResponses, DissociateRouterNetworkPolicyData, DissociateRouterNetworkPolicyErrors, DissociateRouterNetworkPolicyResponses, GetCloudBoxDnsRoutesData, GetCloudBoxDnsRoutesErrors, GetCloudBoxDnsRoutesResponses, GetDeviceCredentialsData, GetDeviceCredentialsErrors, GetDeviceCredentialsResponses, GetDeviceData, GetDeviceErrors, GetDeviceResponses, GetDevicesData, GetDevicesErrors, GetDevicesResponses, GetEndpointByIdData, GetEndpointByIdErrors, GetEndpointByIdResponses, GetEndPointDnsRoutesData, GetEndPointDnsRoutesErrors, GetEndPointDnsRoutesResponses, GetEndpointPoliciesData, GetEndpointPoliciesErrors, GetEndpointPoliciesResponses, GetEndpointPolicyByIdData, GetEndpointPolicyByIdErrors, GetEndpointPolicyByIdResponses, GetEndpointsData, GetEndpointsErrors, GetEndpointsResponses, GetPhysicalDevicesData, GetPhysicalDevicesErrors, GetPhysicalDevicesResponses, GetRouterConfigurationScriptParametersData, GetRouterConfigurationScriptParametersErrors, GetRouterConfigurationScriptParametersResponses, GetRouterData, GetRouterErrors, GetRouterNetworksData, GetRouterNetworksErrors, GetRouterNetworksResponses, GetRouterPoliciesData, GetRouterPoliciesErrors, GetRouterPoliciesResponses, GetRouterResponses, GetRoutersData, GetRoutersErrors, GetRoutersResponses, GetRulesData, GetRulesErrors, GetRulesResponses, UpdateDeviceCatchAllData, UpdateDeviceCatchAllErrors, UpdateDeviceCatchAllResponses, UpdateDeviceCredentialsData, UpdateDeviceCredentialsErrors, UpdateDeviceCredentialsResponses, UpdateDeviceData, UpdateDeviceErrors, UpdateDeviceResponses, UpdateDynamicInternalRouterNetworkData, UpdateDynamicInternalRouterNetworkErrors, UpdateDynamicInternalRouterNetworkResponses, UpdateEncryptedRouterNetworkData, UpdateEncryptedRouterNetworkErrors, UpdateEncryptedRouterNetworkResponses, UpdateEndpointData, UpdateEndpointErrors, UpdateEndpointPolicyData, UpdateEndpointPolicyErrors, UpdateEndpointPolicyResponses, UpdateEndpointResponses, UpdateRouterData, UpdateRouterErrors, UpdateRouterResponses } from './types.gen.js';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -175,6 +175,10 @@ export declare class IntegrationSdk extends HeyApiClient {
|
|
|
175
175
|
* Dissociate a policy from a router network
|
|
176
176
|
*/
|
|
177
177
|
dissociateRouterNetworkPolicy<ThrowOnError extends boolean = false>(options: Options<DissociateRouterNetworkPolicyData, ThrowOnError>): RequestResult<DissociateRouterNetworkPolicyResponses, DissociateRouterNetworkPolicyErrors, ThrowOnError>;
|
|
178
|
+
/**
|
|
179
|
+
* Get router configuration script parameters
|
|
180
|
+
*/
|
|
181
|
+
getRouterConfigurationScriptParameters<ThrowOnError extends boolean = false>(options: Options<GetRouterConfigurationScriptParametersData, ThrowOnError>): RequestResult<GetRouterConfigurationScriptParametersResponses, GetRouterConfigurationScriptParametersErrors, ThrowOnError>;
|
|
178
182
|
/**
|
|
179
183
|
* Get all endpoint policies for an organization
|
|
180
184
|
*/
|
|
@@ -446,6 +446,16 @@ export class IntegrationSdk extends HeyApiClient {
|
|
|
446
446
|
...options
|
|
447
447
|
});
|
|
448
448
|
}
|
|
449
|
+
/**
|
|
450
|
+
* Get router configuration script parameters
|
|
451
|
+
*/
|
|
452
|
+
getRouterConfigurationScriptParameters(options) {
|
|
453
|
+
return (options.client ?? this.client).get({
|
|
454
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
455
|
+
url: '/v1/routers/{routerId}/configuration-script',
|
|
456
|
+
...options
|
|
457
|
+
});
|
|
458
|
+
}
|
|
449
459
|
/**
|
|
450
460
|
* Get all endpoint policies for an organization
|
|
451
461
|
*/
|
|
@@ -1415,7 +1415,7 @@ export type GetPhysicalDevicesResponses = {
|
|
|
1415
1415
|
name: string;
|
|
1416
1416
|
code: string;
|
|
1417
1417
|
brand: string;
|
|
1418
|
-
features: Array<'ddns' | '
|
|
1418
|
+
features: Array<'ddns' | 'doh' | 'dot' | 'multi_wan' | 'configuration_script' | 'auth_check'>;
|
|
1419
1419
|
}>;
|
|
1420
1420
|
};
|
|
1421
1421
|
export type GetPhysicalDevicesResponse = GetPhysicalDevicesResponses[keyof GetPhysicalDevicesResponses];
|
|
@@ -1514,7 +1514,7 @@ export type CreateRouterData = {
|
|
|
1514
1514
|
password: string;
|
|
1515
1515
|
multiWan?: number;
|
|
1516
1516
|
} | {
|
|
1517
|
-
type: 'doh';
|
|
1517
|
+
type: 'doh' | 'dot';
|
|
1518
1518
|
policyId: string;
|
|
1519
1519
|
};
|
|
1520
1520
|
note?: string;
|
|
@@ -2210,6 +2210,60 @@ export type DissociateRouterNetworkPolicyResponses = {
|
|
|
2210
2210
|
};
|
|
2211
2211
|
};
|
|
2212
2212
|
export type DissociateRouterNetworkPolicyResponse = DissociateRouterNetworkPolicyResponses[keyof DissociateRouterNetworkPolicyResponses];
|
|
2213
|
+
export type GetRouterConfigurationScriptParametersData = {
|
|
2214
|
+
body?: never;
|
|
2215
|
+
path: {
|
|
2216
|
+
routerId: string;
|
|
2217
|
+
};
|
|
2218
|
+
query?: never;
|
|
2219
|
+
url: '/v1/routers/{routerId}/configuration-script';
|
|
2220
|
+
};
|
|
2221
|
+
export type GetRouterConfigurationScriptParametersErrors = {
|
|
2222
|
+
/**
|
|
2223
|
+
* Unauthorized
|
|
2224
|
+
*/
|
|
2225
|
+
401: MissingCredentialsErrorBody | FlashStartErrorBody;
|
|
2226
|
+
/**
|
|
2227
|
+
* Forbidden
|
|
2228
|
+
*/
|
|
2229
|
+
403: FlashStartErrorBody;
|
|
2230
|
+
/**
|
|
2231
|
+
* Not found
|
|
2232
|
+
*/
|
|
2233
|
+
404: FlashStartErrorBody;
|
|
2234
|
+
/**
|
|
2235
|
+
* Invalid request
|
|
2236
|
+
*/
|
|
2237
|
+
422: FlashStartErrorBody;
|
|
2238
|
+
/**
|
|
2239
|
+
* Internal server error
|
|
2240
|
+
*/
|
|
2241
|
+
500: FlashStartErrorBody;
|
|
2242
|
+
};
|
|
2243
|
+
export type GetRouterConfigurationScriptParametersError = GetRouterConfigurationScriptParametersErrors[keyof GetRouterConfigurationScriptParametersErrors];
|
|
2244
|
+
export type GetRouterConfigurationScriptParametersResponses = {
|
|
2245
|
+
/**
|
|
2246
|
+
* Router configuration script parameters
|
|
2247
|
+
*/
|
|
2248
|
+
200: {
|
|
2249
|
+
routerCode: 'mikrotik';
|
|
2250
|
+
networkType: 'DYNAMIC_INTERNAL';
|
|
2251
|
+
ddnsCredentials: Array<{
|
|
2252
|
+
username: string;
|
|
2253
|
+
password: string;
|
|
2254
|
+
}>;
|
|
2255
|
+
policyConnections: Array<{
|
|
2256
|
+
policyName: string;
|
|
2257
|
+
dnsAddress: string;
|
|
2258
|
+
}>;
|
|
2259
|
+
} | {
|
|
2260
|
+
routerCode: 'mikrotik';
|
|
2261
|
+
networkType: 'STATIC_ENCRYPTED';
|
|
2262
|
+
tag: string;
|
|
2263
|
+
policyName: string;
|
|
2264
|
+
};
|
|
2265
|
+
};
|
|
2266
|
+
export type GetRouterConfigurationScriptParametersResponse = GetRouterConfigurationScriptParametersResponses[keyof GetRouterConfigurationScriptParametersResponses];
|
|
2213
2267
|
export type GetEndpointPoliciesData = {
|
|
2214
2268
|
body?: never;
|
|
2215
2269
|
path?: never;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flashstart/client",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "8.10.0",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"engines": {
|
|
@@ -23,9 +23,9 @@
|
|
|
23
23
|
},
|
|
24
24
|
"devDependencies": {
|
|
25
25
|
"@hey-api/openapi-ts": "0.99.0",
|
|
26
|
-
"tsx": "4.23.
|
|
27
|
-
"typescript": "6.0.
|
|
28
|
-
"@repo/typescript-config": "8.
|
|
26
|
+
"tsx": "4.23.12",
|
|
27
|
+
"typescript": "6.0.3",
|
|
28
|
+
"@repo/typescript-config": "8.10.0"
|
|
29
29
|
},
|
|
30
30
|
"scripts": {
|
|
31
31
|
"build": "pnpm generate && tsc",
|