@nangohq/types 0.42.11 → 0.42.13
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/api.endpoints.d.ts
CHANGED
|
@@ -7,11 +7,11 @@ import type { DeleteTeamUser, GetTeam, PutTeam } from './team/api';
|
|
|
7
7
|
import type { PostForgotPassword, PutResetPassword, PostSignin, PostSignup } from './account/api';
|
|
8
8
|
import type { DeleteInvite, PostInvite } from './invitations/api';
|
|
9
9
|
import type { GetUser, PatchUser } from './user/api';
|
|
10
|
-
import type {
|
|
10
|
+
import type { DeletePublicIntegration, GetPublicIntegration, GetPublicListIntegrations, GetPublicListIntegrationsLegacy } from './integration/api';
|
|
11
11
|
import type { PostPublicTableauAuthorization, PostPublicTbaAuthorization, PostPublicUnauthenticatedAuthorization } from './auth/http.api';
|
|
12
12
|
import type { GetPublicProvider, GetPublicProviders } from './providers/api';
|
|
13
|
-
export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTbaAuthorization | PostPublicTableauAuthorization | PostPublicUnauthenticatedAuthorization | GetPublicProviders | GetPublicProvider;
|
|
14
|
-
export type PrivateApiEndpoints = PostSignup | PostSignin | GetTeam | PutTeam | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | GetOnboardingStatus
|
|
13
|
+
export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTbaAuthorization | PostPublicTableauAuthorization | PostPublicUnauthenticatedAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrationsLegacy | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration;
|
|
14
|
+
export type PrivateApiEndpoints = PostSignup | PostSignin | GetTeam | PutTeam | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | GetOnboardingStatus;
|
|
15
15
|
export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
|
|
16
16
|
/**
|
|
17
17
|
* Automatically narrow endpoints type with Method + Path
|
package/dist/auth/http.api.d.ts
CHANGED
|
@@ -8,7 +8,7 @@ export type PostPublicTbaAuthorization = Endpoint<{
|
|
|
8
8
|
oauth_client_secret_override?: string | undefined;
|
|
9
9
|
};
|
|
10
10
|
Querystring: {
|
|
11
|
-
connection_id
|
|
11
|
+
connection_id?: string | undefined;
|
|
12
12
|
public_key: string;
|
|
13
13
|
params?: Record<string, any> | undefined;
|
|
14
14
|
hmac?: string | undefined;
|
|
@@ -31,7 +31,7 @@ export type PostPublicTableauAuthorization = Endpoint<{
|
|
|
31
31
|
content_url?: string | undefined;
|
|
32
32
|
};
|
|
33
33
|
Querystring: {
|
|
34
|
-
connection_id
|
|
34
|
+
connection_id?: string | undefined;
|
|
35
35
|
public_key: string;
|
|
36
36
|
params?: Record<string, any> | undefined;
|
|
37
37
|
hmac?: string | undefined;
|
|
@@ -49,7 +49,7 @@ export type PostPublicTableauAuthorization = Endpoint<{
|
|
|
49
49
|
export type PostPublicUnauthenticatedAuthorization = Endpoint<{
|
|
50
50
|
Method: 'POST';
|
|
51
51
|
Querystring: {
|
|
52
|
-
connection_id
|
|
52
|
+
connection_id?: string | undefined;
|
|
53
53
|
hmac?: string | undefined;
|
|
54
54
|
};
|
|
55
55
|
Params: {
|
package/dist/index.d.ts
CHANGED
|
@@ -6,6 +6,7 @@ export type * from './onboarding/api.js';
|
|
|
6
6
|
export type * from './record/api.js';
|
|
7
7
|
export type * from './logs/api.js';
|
|
8
8
|
export type * from './logs/messages.js';
|
|
9
|
+
export type * from './keystore/index.js';
|
|
9
10
|
export type * from './account/api.js';
|
|
10
11
|
export type * from './user/api.js';
|
|
11
12
|
export type * from './user/db.js';
|
|
@@ -7,17 +7,40 @@ import type { NangoModel, NangoSyncEndpoint, ScriptTypeLiteral } from '../nangoY
|
|
|
7
7
|
import type { LegacySyncModelSchema, NangoConfigMetadata } from '../deploy/incomingFlow';
|
|
8
8
|
import type { JSONSchema7 } from 'json-schema';
|
|
9
9
|
import type { SyncType } from '../scripts/syncs/api';
|
|
10
|
-
export type
|
|
10
|
+
export type ApiPublicIntegration = Merge<Pick<IntegrationConfig, 'created_at' | 'updated_at' | 'unique_key' | 'provider'>, ApiTimestamps> & {
|
|
11
|
+
logo: string;
|
|
12
|
+
} & ApiPublicIntegrationInclude;
|
|
13
|
+
export interface ApiPublicIntegrationInclude {
|
|
14
|
+
webhook_url?: string | null;
|
|
15
|
+
}
|
|
16
|
+
export type GetPublicListIntegrationsLegacy = Endpoint<{
|
|
11
17
|
Method: 'GET';
|
|
12
18
|
Path: '/config';
|
|
13
19
|
Success: {
|
|
14
|
-
configs:
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
20
|
+
configs: ApiPublicIntegration[];
|
|
21
|
+
};
|
|
22
|
+
}>;
|
|
23
|
+
export type GetPublicListIntegrations = Endpoint<{
|
|
24
|
+
Method: 'GET';
|
|
25
|
+
Path: '/integrations';
|
|
26
|
+
Success: {
|
|
27
|
+
data: ApiPublicIntegration[];
|
|
28
|
+
};
|
|
29
|
+
}>;
|
|
30
|
+
export type GetPublicIntegration = Endpoint<{
|
|
31
|
+
Method: 'GET';
|
|
32
|
+
Path: '/integrations/:uniqueKey';
|
|
33
|
+
Params: {
|
|
34
|
+
uniqueKey: string;
|
|
35
|
+
};
|
|
36
|
+
Querystring: {
|
|
37
|
+
include?: 'webhook'[] | undefined;
|
|
38
|
+
};
|
|
39
|
+
Success: {
|
|
40
|
+
data: ApiPublicIntegration;
|
|
18
41
|
};
|
|
19
42
|
}>;
|
|
20
|
-
export type
|
|
43
|
+
export type DeletePublicIntegration = Endpoint<{
|
|
21
44
|
Method: 'DELETE';
|
|
22
45
|
Path: '/config/:providerConfigKey';
|
|
23
46
|
Params: {
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
export type EntityType = 'session' | 'connection' | 'environment';
|
|
3
|
+
export interface PrivateKey {
|
|
4
|
+
readonly id: number;
|
|
5
|
+
readonly displayName: string;
|
|
6
|
+
readonly environmentId: number;
|
|
7
|
+
readonly accountId: number;
|
|
8
|
+
readonly encrypted: Buffer | null;
|
|
9
|
+
readonly hash: string;
|
|
10
|
+
readonly createdAt: Date;
|
|
11
|
+
readonly expiresAt: Date | null;
|
|
12
|
+
readonly lastAccessAt: Date | null;
|
|
13
|
+
readonly entityType: EntityType;
|
|
14
|
+
readonly entityId: number;
|
|
15
|
+
}
|
|
@@ -19,6 +19,7 @@ export interface ProviderAlias {
|
|
|
19
19
|
};
|
|
20
20
|
}
|
|
21
21
|
export interface BaseProvider {
|
|
22
|
+
display_name: string;
|
|
22
23
|
auth_mode: AuthModeType;
|
|
23
24
|
proxy?: {
|
|
24
25
|
base_url: string;
|
|
@@ -47,7 +48,7 @@ export interface BaseProvider {
|
|
|
47
48
|
authorization_url_replacements?: Record<string, string>;
|
|
48
49
|
redirect_uri_metadata?: string[];
|
|
49
50
|
token_response_metadata?: string[];
|
|
50
|
-
docs
|
|
51
|
+
docs: string;
|
|
51
52
|
token_expiration_buffer?: number;
|
|
52
53
|
webhook_routing_script?: string;
|
|
53
54
|
webhook_user_defined_secret?: boolean;
|
package/dist/web/env.d.ts
CHANGED