notte-sdk 1.9.5 → 1.9.6

package/dist/index.d.mts

@@ -391,11 +391,11 @@ type ActionSpace = {
     /**
      * Actions
      */
-    readonly actions: Array<FormFillAction | GotoAction | GotoNewTabAction | CloseTabAction | SwitchTabAction | GoBackAction | GoForwardAction | ReloadAction | WaitAction | PressKeyAction | ScrollUpAction | ScrollDownAction | CaptchaSolveAction | HelpAction | CompletionAction | ScrapeAction | EmailReadAction | EmailVerificationReadAction | SmsReadAction | EvaluateJsAction | ClickActionOutput | FillActionOutput | MultiFactorFillActionOutput | FallbackFillActionOutput | CheckActionOutput | SelectDropdownOptionActionOutput | UploadFileActionOutput | DownloadFileActionOutput>;
+    readonly actions: Array<FormFillAction | GotoAction | GotoNewTabAction | CloseTabAction | SwitchTabAction | GoBackAction | GoForwardAction | ReloadAction | WaitAction | PressKeyAction | ScrollUpAction$1 | ScrollDownAction$1 | CaptchaSolveAction | HelpAction | CompletionAction | ScrapeAction | EmailReadAction | EmailVerificationReadAction | SmsReadAction | EvaluateJsAction | ClickActionOutput | FillActionOutput | MultiFactorFillActionOutput | FallbackFillActionOutput | CheckActionOutput | SelectDropdownOptionActionOutput | UploadFileActionOutput | DownloadFileActionOutput>;
     /**
      * Browser Actions
      */
-    readonly browser_actions: Array<FormFillAction | GotoAction | GotoNewTabAction | CloseTabAction | SwitchTabAction | GoBackAction | GoForwardAction | ReloadAction | WaitAction | PressKeyAction | ScrollUpAction | ScrollDownAction | CaptchaSolveAction | HelpAction | CompletionAction | ScrapeAction | EmailReadAction | EmailVerificationReadAction | SmsReadAction | EvaluateJsAction>;
+    readonly browser_actions: Array<FormFillAction | GotoAction | GotoNewTabAction | CloseTabAction | SwitchTabAction | GoBackAction | GoForwardAction | ReloadAction | WaitAction | PressKeyAction | ScrollUpAction$1 | ScrollDownAction$1 | CaptchaSolveAction | HelpAction | CompletionAction | ScrapeAction | EmailReadAction | EmailVerificationReadAction | SmsReadAction | EvaluateJsAction>;
     /**
      * Markdown
      */
@@ -697,9 +697,9 @@ type ApiExecutionResponse = {
         type: 'press_key';
     } & PressKeyAction) | ({
         type: 'scroll_up';
-    } & ScrollUpAction) | ({
+    } & ScrollUpAction$1) | ({
         type: 'scroll_down';
-    } & ScrollDownAction) | ({
+    } & ScrollDownAction$1) | ({
         type: 'captcha_solve';
     } & CaptchaSolveAction) | ({
         type: 'help';
@@ -4647,9 +4647,9 @@ type RunFunctionRequest = {
     /**
      * Variables
      *
-     * The variables to run the workflow with
+     * The variables to run the function with
      */
-    variables: {
+    variables?: {
         [key: string]: unknown;
     };
     /**
@@ -4664,6 +4664,10 @@ type RunFunctionRequest = {
      * Whether to stream logs, or only return final response
      */
     stream?: boolean;
+    /**
+     * Callback Url
+     */
+    callback_url?: string | null;
 };
 /**
  * RunPayloadReference
@@ -5046,7 +5050,7 @@ type Screenshot = {
 /**
  * ScrollDownAction
  */
-type ScrollDownAction = {
+type ScrollDownAction$1 = {
     /**
      * Type
      */
@@ -5063,11 +5067,17 @@ type ScrollDownAction = {
      * Amount
      */
     amount?: number | null;
+    /**
+     * Selector
+     *
+     * Optional selector for the scroll container, including iframe paths.
+     */
+    selector?: string | null;
 };
 /**
  * ScrollUpAction
  */
-type ScrollUpAction = {
+type ScrollUpAction$1 = {
     /**
      * Type
      */
@@ -5084,6 +5094,12 @@ type ScrollUpAction = {
      * Amount
      */
     amount?: number | null;
+    /**
+     * Selector
+     *
+     * Optional selector for the scroll container, including iframe paths.
+     */
+    selector?: string | null;
 };
 /**
  * SearchRequest
@@ -5710,6 +5726,10 @@ type TailnetProxy = {
      * Oauth Client Secret
      */
     oauth_client_secret?: string | null;
+    /**
+     * Exit Node
+     */
+    exit_node?: string | null;
 };
 /**
  * UpdateFunctionRunResponse
@@ -6114,9 +6134,9 @@ type ApiExecutionResponseWritable = {
         type: 'press_key';
     } & PressKeyAction) | ({
         type: 'scroll_up';
-    } & ScrollUpAction) | ({
+    } & ScrollUpAction$1) | ({
         type: 'scroll_down';
-    } & ScrollDownAction) | ({
+    } & ScrollDownAction$1) | ({
         type: 'captcha_solve';
     } & CaptchaSolveAction) | ({
         type: 'help';
@@ -7855,12 +7875,7 @@ type SessionDebugInfoData = {
          */
         session_id: string;
     };
-    query?: {
-        /**
-         * Update Metadata
-         */
-        update_metadata?: boolean;
-    };
+    query?: never;
     url: '/sessions/{session_id}/debug';
 };
 type SessionDebugInfoErrors = {
@@ -8022,9 +8037,9 @@ type PageExecuteData = {
         type: 'press_key';
     } & PressKeyAction) | ({
         type: 'scroll_up';
-    } & ScrollUpAction) | ({
+    } & ScrollUpAction$1) | ({
         type: 'scroll_down';
-    } & ScrollDownAction) | ({
+    } & ScrollDownAction$1) | ({
         type: 'captcha_solve';
     } & CaptchaSolveAction) | ({
         type: 'help';
@@ -8090,10 +8105,6 @@ type PageExecuteData = {
          * Target Generation
          */
         target_generation?: number | null;
-        /**
-         * Update Metadata
-         */
-        update_metadata?: boolean;
     };
     url: '/sessions/{session_id}/page/execute';
 };
@@ -12128,8 +12139,24 @@ interface ResourceRequestOptions {
     signal?: AbortSignal;
 }
 
+/** Scroll down on the page or in a selected container. */
+type ScrollDownAction = ScrollDownAction$1 & {
+    /** Optional selector for the scroll container, including iframe paths. */
+    selector?: string | null;
+};
+/** Scroll up on the page or in a selected container. */
+type ScrollUpAction = ScrollUpAction$1 & {
+    /** Optional selector for the scroll container, including iframe paths. */
+    selector?: string | null;
+};
 /** Discriminated union of every action `session.execute()` accepts. */
-type ExecuteAction = PageExecuteData['body'];
+type ExecuteAction = Exclude<PageExecuteData['body'], {
+    type: 'scroll_up' | 'scroll_down';
+}> | ({
+    type: 'scroll_up';
+} & ScrollUpAction) | ({
+    type: 'scroll_down';
+} & ScrollDownAction);
 /** The `type` discriminator of an `ExecuteAction`. */
 type ActionType = ExecuteAction['type'];
 /** The union member whose `type` is `T`. */
@@ -12169,10 +12196,16 @@ declare const actions: {
     } & PressKeyAction;
     readonly scrollUp: (input?: ActionInput<"scroll_up"> | undefined) => {
         type: "scroll_up";
-    } & ScrollUpAction;
+    } & ScrollUpAction$1 & {
+        /** Optional selector for the scroll container, including iframe paths. */
+        selector?: string | null;
+    };
     readonly scrollDown: (input?: ActionInput<"scroll_down"> | undefined) => {
         type: "scroll_down";
-    } & ScrollDownAction;
+    } & ScrollDownAction$1 & {
+        /** Optional selector for the scroll container, including iframe paths. */
+        selector?: string | null;
+    };
     readonly captchaSolve: (input?: ActionInput<"captcha_solve"> | undefined) => {
         type: "captcha_solve";
     } & CaptchaSolveAction;
@@ -13771,10 +13804,10 @@ declare class NotteClient {
         createPayment: (sessionId: CreatePaymentData["path"]["session_id"], body: CreatePaymentData["body"], query: CreatePaymentData["query"], requestOptions: ResourceRequestOptions & {
             headers: Omit<NonNullable<CreatePaymentData["headers"]>, "x-notte-api-key">;
         }) => Promise<PaymentResponse>;
-        debugInfo: (sessionId: SessionDebugInfoData["path"]["session_id"], query?: SessionDebugInfoData["query"], requestOptions?: ResourceRequestOptions & {
+        debugInfo: (sessionId: SessionDebugInfoData["path"]["session_id"], requestOptions?: ResourceRequestOptions & {
             headers?: Omit<NonNullable<SessionDebugInfoData["headers"]>, "x-notte-api-key">;
         }) => Promise<SessionDebugResponse>;
-        deleteSessionFile: (sessionId: DeleteSessionFileData["path"]["session_id"], fileId: DeleteSessionFileData["path"]["file_id"], requestOptions?: ResourceRequestOptions & {
+        deleteSessionFile: (sessionId: DeleteSessionFileData["path"]["session_id"], fileId: DeleteSessionFileData["path"] /** API key. Defaults to `NOTTE_API_KEY`. Optional only for relative proxy base URLs. */["file_id"], requestOptions?: ResourceRequestOptions & {
             headers?: Omit<NonNullable<DeleteSessionFileData["headers"]>, "x-notte-api-key">;
         }) => Promise<void>;
         downloadSessionFile: (sessionId: DownloadSessionFileData["path"]["session_id"], fileId: DownloadSessionFileData["path"]["file_id"], requestOptions?: ResourceRequestOptions & {
@@ -13823,19 +13856,7 @@ declare class NotteClient {
             headers?: Omit<NonNullable<SessionStatusData["headers"]>, "x-notte-api-key">;
         }) => Promise<SessionResponse>;
         stop: (sessionId: SessionStopData["path"]["session_id"], query?: SessionStopData["query"], requestOptions?: ResourceRequestOptions & {
-            headers
-            /**
-             * Map the raw value the generated client rejects with into a `NotteError`.
-             * HTTP failures become `NotteAPIError` (or `NotteAPIExecutionError` when the
-             * API flags them), timeouts become `NotteTimeoutError`, anything else is
-             * returned untouched.
-             */
-            ? /**
-             * Map the raw value the generated client rejects with into a `NotteError`.
-             * HTTP failures become `NotteAPIError` (or `NotteAPIExecutionError` when the
-             * API flags them), timeouts become `NotteTimeoutError`, anything else is
-             * returned untouched.
-             */: Omit<NonNullable<SessionStopData["headers"]>, "x-notte-api-key">;
+            headers?: Omit<NonNullable<SessionStopData["headers"]>, "x-notte-api-key">;
         }) => Promise<SessionResponse>;
         uploadSessionFile: (sessionId: UploadSessionFileData["path"]["session_id"], body: UploadSessionFileData["body"], requestOptions?: ResourceRequestOptions & {
             headers?: Omit<NonNullable<UploadSessionFileData["headers"]>, "x-notte-api-key">;

package/dist/index.d.ts

@@ -391,11 +391,11 @@ type ActionSpace = {
     /**
      * Actions
      */
-    readonly actions: Array<FormFillAction | GotoAction | GotoNewTabAction | CloseTabAction | SwitchTabAction | GoBackAction | GoForwardAction | ReloadAction | WaitAction | PressKeyAction | ScrollUpAction | ScrollDownAction | CaptchaSolveAction | HelpAction | CompletionAction | ScrapeAction | EmailReadAction | EmailVerificationReadAction | SmsReadAction | EvaluateJsAction | ClickActionOutput | FillActionOutput | MultiFactorFillActionOutput | FallbackFillActionOutput | CheckActionOutput | SelectDropdownOptionActionOutput | UploadFileActionOutput | DownloadFileActionOutput>;
+    readonly actions: Array<FormFillAction | GotoAction | GotoNewTabAction | CloseTabAction | SwitchTabAction | GoBackAction | GoForwardAction | ReloadAction | WaitAction | PressKeyAction | ScrollUpAction$1 | ScrollDownAction$1 | CaptchaSolveAction | HelpAction | CompletionAction | ScrapeAction | EmailReadAction | EmailVerificationReadAction | SmsReadAction | EvaluateJsAction | ClickActionOutput | FillActionOutput | MultiFactorFillActionOutput | FallbackFillActionOutput | CheckActionOutput | SelectDropdownOptionActionOutput | UploadFileActionOutput | DownloadFileActionOutput>;
     /**
      * Browser Actions
      */
-    readonly browser_actions: Array<FormFillAction | GotoAction | GotoNewTabAction | CloseTabAction | SwitchTabAction | GoBackAction | GoForwardAction | ReloadAction | WaitAction | PressKeyAction | ScrollUpAction | ScrollDownAction | CaptchaSolveAction | HelpAction | CompletionAction | ScrapeAction | EmailReadAction | EmailVerificationReadAction | SmsReadAction | EvaluateJsAction>;
+    readonly browser_actions: Array<FormFillAction | GotoAction | GotoNewTabAction | CloseTabAction | SwitchTabAction | GoBackAction | GoForwardAction | ReloadAction | WaitAction | PressKeyAction | ScrollUpAction$1 | ScrollDownAction$1 | CaptchaSolveAction | HelpAction | CompletionAction | ScrapeAction | EmailReadAction | EmailVerificationReadAction | SmsReadAction | EvaluateJsAction>;
     /**
      * Markdown
      */
@@ -697,9 +697,9 @@ type ApiExecutionResponse = {
         type: 'press_key';
     } & PressKeyAction) | ({
         type: 'scroll_up';
-    } & ScrollUpAction) | ({
+    } & ScrollUpAction$1) | ({
         type: 'scroll_down';
-    } & ScrollDownAction) | ({
+    } & ScrollDownAction$1) | ({
         type: 'captcha_solve';
     } & CaptchaSolveAction) | ({
         type: 'help';
@@ -4647,9 +4647,9 @@ type RunFunctionRequest = {
     /**
      * Variables
      *
-     * The variables to run the workflow with
+     * The variables to run the function with
      */
-    variables: {
+    variables?: {
         [key: string]: unknown;
     };
     /**
@@ -4664,6 +4664,10 @@ type RunFunctionRequest = {
      * Whether to stream logs, or only return final response
      */
     stream?: boolean;
+    /**
+     * Callback Url
+     */
+    callback_url?: string | null;
 };
 /**
  * RunPayloadReference
@@ -5046,7 +5050,7 @@ type Screenshot = {
 /**
  * ScrollDownAction
  */
-type ScrollDownAction = {
+type ScrollDownAction$1 = {
     /**
      * Type
      */
@@ -5063,11 +5067,17 @@ type ScrollDownAction = {
      * Amount
      */
     amount?: number | null;
+    /**
+     * Selector
+     *
+     * Optional selector for the scroll container, including iframe paths.
+     */
+    selector?: string | null;
 };
 /**
  * ScrollUpAction
  */
-type ScrollUpAction = {
+type ScrollUpAction$1 = {
     /**
      * Type
      */
@@ -5084,6 +5094,12 @@ type ScrollUpAction = {
      * Amount
      */
     amount?: number | null;
+    /**
+     * Selector
+     *
+     * Optional selector for the scroll container, including iframe paths.
+     */
+    selector?: string | null;
 };
 /**
  * SearchRequest
@@ -5710,6 +5726,10 @@ type TailnetProxy = {
      * Oauth Client Secret
      */
     oauth_client_secret?: string | null;
+    /**
+     * Exit Node
+     */
+    exit_node?: string | null;
 };
 /**
  * UpdateFunctionRunResponse
@@ -6114,9 +6134,9 @@ type ApiExecutionResponseWritable = {
         type: 'press_key';
     } & PressKeyAction) | ({
         type: 'scroll_up';
-    } & ScrollUpAction) | ({
+    } & ScrollUpAction$1) | ({
         type: 'scroll_down';
-    } & ScrollDownAction) | ({
+    } & ScrollDownAction$1) | ({
         type: 'captcha_solve';
     } & CaptchaSolveAction) | ({
         type: 'help';
@@ -7855,12 +7875,7 @@ type SessionDebugInfoData = {
          */
         session_id: string;
     };
-    query?: {
-        /**
-         * Update Metadata
-         */
-        update_metadata?: boolean;
-    };
+    query?: never;
     url: '/sessions/{session_id}/debug';
 };
 type SessionDebugInfoErrors = {
@@ -8022,9 +8037,9 @@ type PageExecuteData = {
         type: 'press_key';
     } & PressKeyAction) | ({
         type: 'scroll_up';
-    } & ScrollUpAction) | ({
+    } & ScrollUpAction$1) | ({
         type: 'scroll_down';
-    } & ScrollDownAction) | ({
+    } & ScrollDownAction$1) | ({
         type: 'captcha_solve';
     } & CaptchaSolveAction) | ({
         type: 'help';
@@ -8090,10 +8105,6 @@ type PageExecuteData = {
          * Target Generation
          */
         target_generation?: number | null;
-        /**
-         * Update Metadata
-         */
-        update_metadata?: boolean;
     };
     url: '/sessions/{session_id}/page/execute';
 };
@@ -12128,8 +12139,24 @@ interface ResourceRequestOptions {
     signal?: AbortSignal;
 }
 
+/** Scroll down on the page or in a selected container. */
+type ScrollDownAction = ScrollDownAction$1 & {
+    /** Optional selector for the scroll container, including iframe paths. */
+    selector?: string | null;
+};
+/** Scroll up on the page or in a selected container. */
+type ScrollUpAction = ScrollUpAction$1 & {
+    /** Optional selector for the scroll container, including iframe paths. */
+    selector?: string | null;
+};
 /** Discriminated union of every action `session.execute()` accepts. */
-type ExecuteAction = PageExecuteData['body'];
+type ExecuteAction = Exclude<PageExecuteData['body'], {
+    type: 'scroll_up' | 'scroll_down';
+}> | ({
+    type: 'scroll_up';
+} & ScrollUpAction) | ({
+    type: 'scroll_down';
+} & ScrollDownAction);
 /** The `type` discriminator of an `ExecuteAction`. */
 type ActionType = ExecuteAction['type'];
 /** The union member whose `type` is `T`. */
@@ -12169,10 +12196,16 @@ declare const actions: {
     } & PressKeyAction;
     readonly scrollUp: (input?: ActionInput<"scroll_up"> | undefined) => {
         type: "scroll_up";
-    } & ScrollUpAction;
+    } & ScrollUpAction$1 & {
+        /** Optional selector for the scroll container, including iframe paths. */
+        selector?: string | null;
+    };
     readonly scrollDown: (input?: ActionInput<"scroll_down"> | undefined) => {
         type: "scroll_down";
-    } & ScrollDownAction;
+    } & ScrollDownAction$1 & {
+        /** Optional selector for the scroll container, including iframe paths. */
+        selector?: string | null;
+    };
     readonly captchaSolve: (input?: ActionInput<"captcha_solve"> | undefined) => {
         type: "captcha_solve";
     } & CaptchaSolveAction;
@@ -13771,10 +13804,10 @@ declare class NotteClient {
         createPayment: (sessionId: CreatePaymentData["path"]["session_id"], body: CreatePaymentData["body"], query: CreatePaymentData["query"], requestOptions: ResourceRequestOptions & {
             headers: Omit<NonNullable<CreatePaymentData["headers"]>, "x-notte-api-key">;
         }) => Promise<PaymentResponse>;
-        debugInfo: (sessionId: SessionDebugInfoData["path"]["session_id"], query?: SessionDebugInfoData["query"], requestOptions?: ResourceRequestOptions & {
+        debugInfo: (sessionId: SessionDebugInfoData["path"]["session_id"], requestOptions?: ResourceRequestOptions & {
             headers?: Omit<NonNullable<SessionDebugInfoData["headers"]>, "x-notte-api-key">;
         }) => Promise<SessionDebugResponse>;
-        deleteSessionFile: (sessionId: DeleteSessionFileData["path"]["session_id"], fileId: DeleteSessionFileData["path"]["file_id"], requestOptions?: ResourceRequestOptions & {
+        deleteSessionFile: (sessionId: DeleteSessionFileData["path"]["session_id"], fileId: DeleteSessionFileData["path"] /** API key. Defaults to `NOTTE_API_KEY`. Optional only for relative proxy base URLs. */["file_id"], requestOptions?: ResourceRequestOptions & {
             headers?: Omit<NonNullable<DeleteSessionFileData["headers"]>, "x-notte-api-key">;
         }) => Promise<void>;
         downloadSessionFile: (sessionId: DownloadSessionFileData["path"]["session_id"], fileId: DownloadSessionFileData["path"]["file_id"], requestOptions?: ResourceRequestOptions & {
@@ -13823,19 +13856,7 @@ declare class NotteClient {
             headers?: Omit<NonNullable<SessionStatusData["headers"]>, "x-notte-api-key">;
         }) => Promise<SessionResponse>;
         stop: (sessionId: SessionStopData["path"]["session_id"], query?: SessionStopData["query"], requestOptions?: ResourceRequestOptions & {
-            headers
-            /**
-             * Map the raw value the generated client rejects with into a `NotteError`.
-             * HTTP failures become `NotteAPIError` (or `NotteAPIExecutionError` when the
-             * API flags them), timeouts become `NotteTimeoutError`, anything else is
-             * returned untouched.
-             */
-            ? /**
-             * Map the raw value the generated client rejects with into a `NotteError`.
-             * HTTP failures become `NotteAPIError` (or `NotteAPIExecutionError` when the
-             * API flags them), timeouts become `NotteTimeoutError`, anything else is
-             * returned untouched.
-             */: Omit<NonNullable<SessionStopData["headers"]>, "x-notte-api-key">;
+            headers?: Omit<NonNullable<SessionStopData["headers"]>, "x-notte-api-key">;
         }) => Promise<SessionResponse>;
         uploadSessionFile: (sessionId: UploadSessionFileData["path"]["session_id"], body: UploadSessionFileData["body"], requestOptions?: ResourceRequestOptions & {
             headers?: Omit<NonNullable<UploadSessionFileData["headers"]>, "x-notte-api-key">;

package/dist/index.js

@@ -197,7 +197,7 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // src/version.ts
-var SDK_VERSION = true ? "1.9.5" : "dev";
+var SDK_VERSION = true ? "1.9.6" : "dev";
 var SDK_PACKAGE_NAME = true ? "notte-sdk" : "notte-sdk";
 
 // src/version-check.ts
@@ -2047,8 +2047,8 @@ function createResources(client2, getApiKey) {
         return response.data;
       },
       /** sessionDebugInfo: /sessions/{session_id}/debug. Returns the API response body. */
-      debugInfo: async (sessionId, query = void 0, requestOptions = {}) => {
-        const response = await sessionDebugInfo({ client: client2, throwOnError: true, signal: requestOptions.signal, headers: { ...requestOptions.headers }, path: { "session_id": sessionId }, query });
+      debugInfo: async (sessionId, requestOptions = {}) => {
+        const response = await sessionDebugInfo({ client: client2, throwOnError: true, signal: requestOptions.signal, headers: { ...requestOptions.headers }, path: { "session_id": sessionId } });
         return response.data;
       },
       /** deleteSessionFile: /sessions/{session_id}/files/{file_id}. Returns the API response body. */