@nangohq/types 0.52.3 → 0.52.5

package/dist/api.endpoints.d.ts

@@ -15,9 +15,11 @@ import type { DeletePublicConnection, GetConnection, GetConnections, GetConnecti
 import type { GetMeta } from './meta/api';
 import type { PatchFlowDisable, PatchFlowEnable, PatchFlowFrequency, PostPreBuiltDeploy, PutUpgradePreBuiltFlow } from './flow/http.api';
 import type { PostPublicWebhook } from './webhooks/http.api';
-import type { PostEnvironment } from './environment/api';
+import type { PatchEnvironment, PostEnvironment } from './environment/api';
+import type { PatchWebhook } from './environment/api/webhook';
+import type { PostEnvironmentVariables } from './environment/variable/api';
 export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTbaAuthorization | PostPublicTableauAuthorization | PostPublicJwtAuthorization | PostPublicUnauthenticatedAuthorization | PostPublicApiKeyAuthorization | PostPublicBasicAuthorization | PostPublicAppStoreAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrationsLegacy | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration | PostConnectSessions | PostPublicConnectSessionsReconnect | GetPublicConnections | GetPublicConnection | GetConnectSession | DeleteConnectSession | PostDeployInternal | PostPublicBillAuthorization | DeletePublicConnection | PostPublicSignatureAuthorization | PostPublicTwoStepAuthorization | PostPublicWebhook;
-export type PrivateApiEndpoints = PostSignup | PostSignin | GetTeam | PutTeam | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PatchOnboarding | PostInternalConnectSessions | GetIntegrationFlows | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PostManagedSignup | PostPreBuiltDeploy | PostEnvironment;
+export type PrivateApiEndpoints = PostSignup | PostSignin | GetTeam | PutTeam | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PatchOnboarding | PostInternalConnectSessions | GetIntegrationFlows | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PostManagedSignup | PostPreBuiltDeploy | PostEnvironment | PatchEnvironment | PatchWebhook | PostEnvironmentVariables;
 export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
 /**
  * Automatically narrow endpoints type with Method + Path

package/dist/environment/api/index.d.ts

@@ -1,5 +1,10 @@
-import type { Endpoint } from '../../api';
-import type { DBEnvironment } from '../db';
+import type { Merge } from 'type-fest';
+import type { ApiTimestamps, Endpoint } from '../../api';
+import type { DBEnvironment, DBExternalWebhook } from '../db';
+export type ApiEnvironment = Omit<Merge<DBEnvironment, {
+    callback_url: string;
+} & ApiTimestamps>, 'secret_key_iv' | 'secret_key_tag' | 'secret_key_hashed' | 'pending_secret_key_iv' | 'pending_secret_key_tag' | 'pending_public_key'>;
+export type ApiWebhooks = Omit<DBExternalWebhook, 'id' | 'environment_id' | 'created_at' | 'updated_at'>;
 export type PostEnvironment = Endpoint<{
     Method: 'POST';
     Path: '/api/v1/environments';
@@ -10,3 +15,21 @@ export type PostEnvironment = Endpoint<{
         data: Pick<DBEnvironment, 'id' | 'name'>;
     };
 }>;
+export type PatchEnvironment = Endpoint<{
+    Method: 'PATCH';
+    Path: '/api/v1/environments';
+    Body: {
+        callback_url?: string | undefined;
+        hmac_key?: string | undefined;
+        hmac_enabled?: boolean | undefined;
+        slack_notifications?: boolean | undefined;
+        otlp_endpoint?: string | undefined;
+        otlp_headers?: {
+            name: string;
+            value: string;
+        }[] | undefined;
+    };
+    Success: {
+        data: ApiEnvironment;
+    };
+}>;

package/dist/environment/api/webhook.d.ts

@@ -1,46 +1,19 @@
 import type { Endpoint } from '../../api.js';
-export interface WebhookSettings {
-    alwaysSendWebhook: boolean;
-    sendAuthWebhook: boolean;
-    sendRefreshFailedWebhook: boolean;
-    sendSyncFailedWebhook: boolean;
-}
-export type UpdateWebhookSettings = Endpoint<{
+export type PatchWebhook = Endpoint<{
     Method: 'PATCH';
     Querystring: {
         env: string;
     };
-    Path: '/api/v1/environment/webhook/settings';
-    Body: WebhookSettings;
-    Success: WebhookSettings;
-}>;
-export type UpdatePrimaryUrl = Endpoint<{
-    Method: 'PATCH';
-    Querystring: {
-        env: string;
-    };
-    Path: '/api/v1/environment/webhook/url/primary-url';
-    Body: {
-        url: string;
-    };
-    Success: {
-        data: {
-            url: string;
-        };
-    };
-}>;
-export type UpdateSecondaryUrl = Endpoint<{
-    Method: 'PATCH';
-    Querystring: {
-        env: string;
-    };
-    Path: '/api/v1/environment/webhook/secondary-url';
+    Path: '/api/v1/environments/webhook';
     Body: {
-        url: string;
+        primary_url?: string | undefined;
+        secondary_url?: string | undefined;
+        on_sync_completion_always?: boolean | undefined;
+        on_auth_creation?: boolean | undefined;
+        on_auth_refresh_error?: boolean | undefined;
+        on_sync_error?: boolean | undefined;
     };
     Success: {
-        data: {
-            url: string;
-        };
+        success: boolean;
     };
 }>;

package/dist/environment/db.d.ts

@@ -1,11 +1,11 @@
 import type { Timestamps } from '../db';
 export interface DBEnvironmentVariable extends Timestamps {
-    id?: number;
+    id: number;
     name: string;
     value: string;
     environment_id: number;
-    value_iv?: string | null;
-    value_tag?: string | null;
+    value_iv: string | null;
+    value_tag: string | null;
 }
 export interface DBEnvironment extends Timestamps {
     id: number;
@@ -18,7 +18,13 @@ export interface DBEnvironment extends Timestamps {
     secret_key_tag?: string | null;
     secret_key_hashed?: string | null;
     callback_url: string | null;
+    /**
+     * @deprecated
+     */
     webhook_url: string | null;
+    /**
+     * @deprecated
+     */
     webhook_url_secondary: string | null;
     websockets_path: string | null;
     hmac_enabled: boolean;
@@ -33,17 +39,17 @@ export interface DBEnvironment extends Timestamps {
     pending_secret_key_tag?: string | null;
     pending_public_key?: string | null;
     slack_notifications: boolean;
-    webhook_receive_url?: string;
+    webhook_receive_url: string | null;
     otlp_settings: {
         endpoint: string;
         headers: Record<string, string>;
     } | null;
 }
-export interface ExternalWebhook extends Timestamps {
+export interface DBExternalWebhook extends Timestamps {
     id: number;
     environment_id: number;
-    primary_url: string;
-    secondary_url: string;
+    primary_url: string | null;
+    secondary_url: string | null;
     on_sync_completion_always: boolean;
     on_auth_creation: boolean;
     on_auth_refresh_error: boolean;

package/dist/environment/variable/api.d.ts

@@ -0,0 +1,16 @@
+import type { Endpoint } from '../../api';
+import type { DBEnvironmentVariable } from '../db';
+export type ApiEnvironmentVariable = Pick<DBEnvironmentVariable, 'name' | 'value'>;
+export type PostEnvironmentVariables = Endpoint<{
+    Method: 'POST';
+    Path: '/api/v1/environments/variables';
+    Body: {
+        variables: {
+            name: string;
+            value: string;
+        }[];
+    };
+    Success: {
+        success: boolean;
+    };
+}>;

package/dist/fleet/api.d.ts

@@ -1,10 +1,10 @@
 import type { Endpoint, ApiError } from '../api.js';
-import type { CommitHash, Deployment } from './index.js';
+import type { Deployment } from './index.js';
 export type PostRollout = Endpoint<{
     Method: 'POST';
     Path: '/fleet/:fleetId/rollout';
     Body: {
-        commitHash: CommitHash;
+        image: string;
     };
     Params: {
         fleetId: string;

package/dist/fleet/index.d.ts

@@ -4,6 +4,7 @@ export type CommitHash = string & {
 export interface Deployment {
     readonly id: number;
     readonly commitId: CommitHash;
+    readonly image: string;
     readonly createdAt: Date;
     readonly supersededAt: Date | null;
 }

package/dist/index.d.ts

@@ -48,6 +48,7 @@ export type * from './environment/api/index.js';
 export type * from './environment/api/webhook.js';
 export type * from './environment/api/otlp.js';
 export type * from './environment/variable/index.js';
+export type * from './environment/variable/api.js';
 export type * from './webhooks/api.js';
 export type * from './webhooks/http.api.js';
 export type * from './flow/http.api.js';
@@ -55,3 +56,4 @@ export type * from './utils.js';
 export type * from './web/env.js';
 export type * from './fleet/api.js';
 export type * from './fleet/index.js';
+export type * from './persist/api.js';

package/dist/persist/api.d.ts

@@ -0,0 +1,13 @@
+import type { MergingStrategy } from '../record/api.js';
+export interface PostRecordsSuccess {
+    nextMerging: MergingStrategy;
+}
+export interface PutRecordsSuccess {
+    nextMerging: MergingStrategy;
+}
+export interface DeleteRecordsSuccess {
+    nextMerging: MergingStrategy;
+}
+export interface GetCursorSuccess {
+    cursor?: string;
+}

package/dist/record/api.d.ts

@@ -11,3 +11,10 @@ export interface NangoRecord {
     id: string | number;
     _nango_metadata: RecordMetadata;
 }
+export type MergingStrategy = {
+    strategy: 'override';
+} | {
+    strategy: 'ignore_if_modified_after_cursor';
+    cursor?: string;
+};
+export type CursorOffset = 'first' | 'last';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nangohq/types",
-    "version": "0.52.3",
+    "version": "0.52.5",
     "description": "Types used in Nango applications",
     "type": "module",
     "typings": "dist/index.d.ts",