@nimble-way/nimble-js 0.5.1

package/src/resources/shared.ts

@@ -0,0 +1,816 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+/**
+ * Continuously scroll to load dynamic content
+ */
+export interface AutoScrollAction {
+  auto_scroll: boolean | number | string | AutoScrollAction.UnionMember3;
+}
+
+export namespace AutoScrollAction {
+  export interface UnionMember3 {
+    /**
+     * CSS selector or array of alternative selectors. Use an array when you have
+     * multiple possible selectors for the same element.
+     */
+    click_selector?: string | Array<string>;
+
+    /**
+     * CSS selector or array of alternative selectors. Use an array when you have
+     * multiple possible selectors for the same element.
+     */
+    container?: string | Array<string>;
+
+    /**
+     * Duration value that accepts various formats. Supports: number (ms), string
+     * ("1000"), or string with unit ("2s", "500ms", "2m", "1h")
+     */
+    delay_after_scroll?: number | string;
+
+    /**
+     * Duration value that accepts various formats. Supports: number (ms), string
+     * ("1000"), or string with unit ("2s", "500ms", "2m", "1h")
+     */
+    idle_timeout?: number | string;
+
+    /**
+     * CSS selector or array of alternative selectors. Use an array when you have
+     * multiple possible selectors for the same element.
+     */
+    loading_selector?: string | Array<string>;
+
+    /**
+     * Duration value that accepts various formats. Supports: number (ms), string
+     * ("1000"), or string with unit ("2s", "500ms", "2m", "1h")
+     */
+    max_duration?: number | string;
+
+    /**
+     * CSS selector or array of alternative selectors. Use an array when you have
+     * multiple possible selectors for the same element.
+     */
+    pause_on_selector?: string | Array<string>;
+
+    /**
+     * Whether this action is required. If true, pipeline stops on failure. Accepts
+     * boolean or string "true"/"false". Default: true.
+     */
+    required?: 'true' | 'false' | boolean;
+
+    /**
+     * Whether to skip this action. Accepts boolean or string "true"/"false". Default:
+     * false.
+     */
+    skip?: 'true' | 'false' | boolean;
+
+    step_size?: number;
+  }
+}
+
+/**
+ * Click on an element by selector
+ */
+export interface ClickAction {
+  click: string | Array<string> | ClickAction.UnionMember2;
+}
+
+export namespace ClickAction {
+  export interface UnionMember2 {
+    /**
+     * CSS selector or array of alternative selectors. Use an array when you have
+     * multiple possible selectors for the same element.
+     */
+    selector: string | Array<string>;
+
+    count?: number;
+
+    /**
+     * Duration value that accepts various formats. Supports: number (ms), string
+     * ("1000"), or string with unit ("2s", "500ms", "2m", "1h")
+     */
+    delay?: number | string;
+
+    offset_x?: number;
+
+    offset_y?: number;
+
+    /**
+     * Whether this action is required. If true, pipeline stops on failure. Accepts
+     * boolean or string "true"/"false". Default: true.
+     */
+    required?: 'true' | 'false' | boolean;
+
+    scroll?: boolean;
+
+    /**
+     * Whether to skip this action. Accepts boolean or string "true"/"false". Default:
+     * false.
+     */
+    skip?: 'true' | 'false' | boolean;
+
+    steps?: number;
+
+    strategy?: 'linear' | 'ghost-cursor' | 'windmouse';
+
+    /**
+     * Timeout in milliseconds. Set to 0 for infinite timeout (no timeout). Default:
+     * 15000ms.
+     */
+    timeout?: number;
+
+    visible?: boolean;
+  }
+}
+
+/**
+ * Execute JavaScript code in page context
+ */
+export interface EvalAction {
+  eval: string | EvalAction.UnionMember1;
+}
+
+export namespace EvalAction {
+  export interface UnionMember1 {
+    code: string;
+
+    /**
+     * Whether this action is required. If true, pipeline stops on failure. Accepts
+     * boolean or string "true"/"false". Default: true.
+     */
+    required?: 'true' | 'false' | boolean;
+
+    /**
+     * Whether to skip this action. Accepts boolean or string "true"/"false". Default:
+     * false.
+     */
+    skip?: 'true' | 'false' | boolean;
+
+    /**
+     * Timeout in milliseconds. Set to 0 for infinite timeout (no timeout). Default:
+     * 15000ms.
+     */
+    timeout?: number;
+  }
+}
+
+/**
+ * Make an HTTP request in browser context
+ */
+export interface FetchAction {
+  fetch: string | FetchAction.UnionMember1;
+}
+
+export namespace FetchAction {
+  export interface UnionMember1 {
+    url: string;
+
+    body?: string;
+
+    headers?: { [key: string]: string };
+
+    method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
+
+    /**
+     * Whether this action is required. If true, pipeline stops on failure. Accepts
+     * boolean or string "true"/"false". Default: true.
+     */
+    required?: 'true' | 'false' | boolean;
+
+    /**
+     * Whether to skip this action. Accepts boolean or string "true"/"false". Default:
+     * false.
+     */
+    skip?: 'true' | 'false' | boolean;
+
+    /**
+     * Timeout in milliseconds. Set to 0 for infinite timeout (no timeout). Default:
+     * 15000ms.
+     */
+    timeout?: number;
+  }
+}
+
+/**
+ * Fill text into an input field
+ */
+export interface FillAction {
+  /**
+   * Fill options with mode-specific fields. Use "type" mode for behavioral typing
+   * simulation, or "paste" mode for instant paste.
+   */
+  fill: FillAction.Type | FillAction.Paste;
+}
+
+export namespace FillAction {
+  export interface Type {
+    /**
+     * CSS selector or array of alternative selectors. Use an array when you have
+     * multiple possible selectors for the same element.
+     */
+    selector: string | Array<string>;
+
+    value: string;
+
+    click_on_element?: boolean;
+
+    /**
+     * Duration value that accepts various formats. Supports: number (ms), string
+     * ("1000"), or string with unit ("2s", "500ms", "2m", "1h")
+     */
+    delay?: number | string;
+
+    mode?: 'type';
+
+    mouse_movement_strategy?: 'linear' | 'ghost-cursor' | 'windmouse';
+
+    /**
+     * Whether this action is required. If true, pipeline stops on failure. Accepts
+     * boolean or string "true"/"false". Default: true.
+     */
+    required?: 'true' | 'false' | boolean;
+
+    scroll?: boolean;
+
+    /**
+     * Whether to skip this action. Accepts boolean or string "true"/"false". Default:
+     * false.
+     */
+    skip?: 'true' | 'false' | boolean;
+
+    /**
+     * Timeout in milliseconds. Set to 0 for infinite timeout (no timeout). Default:
+     * 15000ms.
+     */
+    timeout?: number;
+
+    /**
+     * Duration value that accepts various formats. Supports: number (ms), string
+     * ("1000"), or string with unit ("2s", "500ms", "2m", "1h")
+     */
+    typing_interval?: number | string;
+
+    typing_strategy?: 'simple' | 'distribution';
+
+    visible?: boolean;
+  }
+
+  export interface Paste {
+    mode: 'paste';
+
+    /**
+     * CSS selector or array of alternative selectors. Use an array when you have
+     * multiple possible selectors for the same element.
+     */
+    selector: string | Array<string>;
+
+    value: string;
+
+    click_on_element?: boolean;
+
+    /**
+     * Duration value that accepts various formats. Supports: number (ms), string
+     * ("1000"), or string with unit ("2s", "500ms", "2m", "1h")
+     */
+    delay?: number | string;
+
+    /**
+     * Whether this action is required. If true, pipeline stops on failure. Accepts
+     * boolean or string "true"/"false". Default: true.
+     */
+    required?: 'true' | 'false' | boolean;
+
+    scroll?: boolean;
+
+    /**
+     * Whether to skip this action. Accepts boolean or string "true"/"false". Default:
+     * false.
+     */
+    skip?: 'true' | 'false' | boolean;
+
+    /**
+     * Timeout in milliseconds. Set to 0 for infinite timeout (no timeout). Default:
+     * 15000ms.
+     */
+    timeout?: number;
+
+    visible?: boolean;
+  }
+}
+
+/**
+ * Retrieve browser cookies
+ */
+export interface GetCookiesAction {
+  get_cookies: boolean | GetCookiesAction.UnionMember1;
+}
+
+export namespace GetCookiesAction {
+  export interface UnionMember1 {
+    /**
+     * Whether this action is required. If true, pipeline stops on failure. Accepts
+     * boolean or string "true"/"false". Default: true.
+     */
+    required?: 'true' | 'false' | boolean;
+
+    /**
+     * Whether to skip this action. Accepts boolean or string "true"/"false". Default:
+     * false.
+     */
+    skip?: 'true' | 'false' | boolean;
+
+    [k: string]: unknown;
+  }
+}
+
+/**
+ * Navigate to a URL
+ */
+export interface GotoAction {
+  goto: string | GotoAction.UnionMember1;
+}
+
+export namespace GotoAction {
+  export interface UnionMember1 {
+    url: string;
+
+    referer?: string;
+
+    /**
+     * Whether this action is required. If true, pipeline stops on failure. Accepts
+     * boolean or string "true"/"false". Default: true.
+     */
+    required?: 'true' | 'false' | boolean;
+
+    /**
+     * Whether to skip this action. Accepts boolean or string "true"/"false". Default:
+     * false.
+     */
+    skip?: 'true' | 'false' | boolean;
+
+    /**
+     * Timeout in milliseconds. Set to 0 for infinite timeout (no timeout). Default:
+     * 15000ms.
+     */
+    timeout?: number;
+
+    wait_until?: 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2';
+  }
+}
+
+/**
+ * Press a keyboard key
+ */
+export interface PressAction {
+  press: string | PressAction.UnionMember1;
+}
+
+export namespace PressAction {
+  export interface UnionMember1 {
+    key:
+      | '0'
+      | '1'
+      | '2'
+      | '3'
+      | '4'
+      | '5'
+      | '6'
+      | '7'
+      | '8'
+      | '9'
+      | 'Power'
+      | 'Eject'
+      | 'Abort'
+      | 'Help'
+      | 'Backspace'
+      | 'Tab'
+      | 'Numpad5'
+      | 'NumpadEnter'
+      | 'Enter'
+      | '\r'
+      | '\n'
+      | 'ShiftLeft'
+      | 'ShiftRight'
+      | 'ControlLeft'
+      | 'ControlRight'
+      | 'AltLeft'
+      | 'AltRight'
+      | 'Pause'
+      | 'CapsLock'
+      | 'Escape'
+      | 'Convert'
+      | 'NonConvert'
+      | 'Space'
+      | 'Numpad9'
+      | 'PageUp'
+      | 'Numpad3'
+      | 'PageDown'
+      | 'End'
+      | 'Numpad1'
+      | 'Home'
+      | 'Numpad7'
+      | 'ArrowLeft'
+      | 'Numpad4'
+      | 'Numpad8'
+      | 'ArrowUp'
+      | 'ArrowRight'
+      | 'Numpad6'
+      | 'Numpad2'
+      | 'ArrowDown'
+      | 'Select'
+      | 'Open'
+      | 'PrintScreen'
+      | 'Insert'
+      | 'Numpad0'
+      | 'Delete'
+      | 'NumpadDecimal'
+      | 'Digit0'
+      | 'Digit1'
+      | 'Digit2'
+      | 'Digit3'
+      | 'Digit4'
+      | 'Digit5'
+      | 'Digit6'
+      | 'Digit7'
+      | 'Digit8'
+      | 'Digit9'
+      | 'KeyA'
+      | 'KeyB'
+      | 'KeyC'
+      | 'KeyD'
+      | 'KeyE'
+      | 'KeyF'
+      | 'KeyG'
+      | 'KeyH'
+      | 'KeyI'
+      | 'KeyJ'
+      | 'KeyK'
+      | 'KeyL'
+      | 'KeyM'
+      | 'KeyN'
+      | 'KeyO'
+      | 'KeyP'
+      | 'KeyQ'
+      | 'KeyR'
+      | 'KeyS'
+      | 'KeyT'
+      | 'KeyU'
+      | 'KeyV'
+      | 'KeyW'
+      | 'KeyX'
+      | 'KeyY'
+      | 'KeyZ'
+      | 'MetaLeft'
+      | 'MetaRight'
+      | 'ContextMenu'
+      | 'NumpadMultiply'
+      | 'NumpadAdd'
+      | 'NumpadSubtract'
+      | 'NumpadDivide'
+      | 'F1'
+      | 'F2'
+      | 'F3'
+      | 'F4'
+      | 'F5'
+      | 'F6'
+      | 'F7'
+      | 'F8'
+      | 'F9'
+      | 'F10'
+      | 'F11'
+      | 'F12'
+      | 'F13'
+      | 'F14'
+      | 'F15'
+      | 'F16'
+      | 'F17'
+      | 'F18'
+      | 'F19'
+      | 'F20'
+      | 'F21'
+      | 'F22'
+      | 'F23'
+      | 'F24'
+      | 'NumLock'
+      | 'ScrollLock'
+      | 'AudioVolumeMute'
+      | 'AudioVolumeDown'
+      | 'AudioVolumeUp'
+      | 'MediaTrackNext'
+      | 'MediaTrackPrevious'
+      | 'MediaStop'
+      | 'MediaPlayPause'
+      | 'Semicolon'
+      | 'Equal'
+      | 'NumpadEqual'
+      | 'Comma'
+      | 'Minus'
+      | 'Period'
+      | 'Slash'
+      | 'Backquote'
+      | 'BracketLeft'
+      | 'Backslash'
+      | 'BracketRight'
+      | 'Quote'
+      | 'AltGraph'
+      | 'Props'
+      | 'Cancel'
+      | 'Clear'
+      | 'Shift'
+      | 'Control'
+      | 'Alt'
+      | 'Accept'
+      | 'ModeChange'
+      | ' '
+      | 'Print'
+      | 'Execute'
+      | ''
+      | 'a'
+      | 'b'
+      | 'c'
+      | 'd'
+      | 'e'
+      | 'f'
+      | 'g'
+      | 'h'
+      | 'i'
+      | 'j'
+      | 'k'
+      | 'l'
+      | 'm'
+      | 'n'
+      | 'o'
+      | 'p'
+      | 'q'
+      | 'r'
+      | 's'
+      | 't'
+      | 'u'
+      | 'v'
+      | 'w'
+      | 'x'
+      | 'y'
+      | 'z'
+      | 'Meta'
+      | '*'
+      | '+'
+      | '-'
+      | '/'
+      | ';'
+      | '='
+      | ','
+      | '.'
+      | '`'
+      | '['
+      | '\\'
+      | ']'
+      | "'"
+      | 'Attn'
+      | 'CrSel'
+      | 'ExSel'
+      | 'EraseEof'
+      | 'Play'
+      | 'ZoomOut'
+      | ')'
+      | '!'
+      | '@'
+      | '#'
+      | '$'
+      | '%'
+      | '^'
+      | '&'
+      | '('
+      | 'A'
+      | 'B'
+      | 'C'
+      | 'D'
+      | 'E'
+      | 'F'
+      | 'G'
+      | 'H'
+      | 'I'
+      | 'J'
+      | 'K'
+      | 'L'
+      | 'M'
+      | 'N'
+      | 'O'
+      | 'P'
+      | 'Q'
+      | 'R'
+      | 'S'
+      | 'T'
+      | 'U'
+      | 'V'
+      | 'W'
+      | 'X'
+      | 'Y'
+      | 'Z'
+      | ':'
+      | '<'
+      | '_'
+      | '>'
+      | '?'
+      | '~'
+      | '{'
+      | '|'
+      | '}'
+      | '"'
+      | 'SoftLeft'
+      | 'SoftRight'
+      | 'Camera'
+      | 'Call'
+      | 'EndCall'
+      | 'VolumeDown'
+      | 'VolumeUp';
+
+    /**
+     * Duration value that accepts various formats. Supports: number (ms), string
+     * ("1000"), or string with unit ("2s", "500ms", "2m", "1h")
+     */
+    delay?: number | string;
+
+    /**
+     * Whether this action is required. If true, pipeline stops on failure. Accepts
+     * boolean or string "true"/"false". Default: true.
+     */
+    required?: 'true' | 'false' | boolean;
+
+    /**
+     * Whether to skip this action. Accepts boolean or string "true"/"false". Default:
+     * false.
+     */
+    skip?: 'true' | 'false' | boolean;
+  }
+}
+
+/**
+ * Capture a page screenshot
+ */
+export interface ScreenshotAction {
+  screenshot: boolean | ScreenshotAction.UnionMember1;
+}
+
+export namespace ScreenshotAction {
+  export interface UnionMember1 {
+    format?: 'png' | 'jpeg' | 'webp';
+
+    full_page?: boolean;
+
+    quality?: number;
+
+    /**
+     * Whether this action is required. If true, pipeline stops on failure. Accepts
+     * boolean or string "true"/"false". Default: true.
+     */
+    required?: 'true' | 'false' | boolean;
+
+    /**
+     * Whether to skip this action. Accepts boolean or string "true"/"false". Default:
+     * false.
+     */
+    skip?: 'true' | 'false' | boolean;
+  }
+}
+
+/**
+ * Scroll the page or an element
+ */
+export interface ScrollAction {
+  scroll: number | string | ScrollAction.UnionMember2;
+}
+
+export namespace ScrollAction {
+  export interface UnionMember2 {
+    /**
+     * CSS selector or array of alternative selectors. Use an array when you have
+     * multiple possible selectors for the same element.
+     */
+    container?: string | Array<string>;
+
+    /**
+     * Whether this action is required. If true, pipeline stops on failure. Accepts
+     * boolean or string "true"/"false". Default: true.
+     */
+    required?: 'true' | 'false' | boolean;
+
+    /**
+     * Whether to skip this action. Accepts boolean or string "true"/"false". Default:
+     * false.
+     */
+    skip?: 'true' | 'false' | boolean;
+
+    /**
+     * CSS selector or array of alternative selectors. Use an array when you have
+     * multiple possible selectors for the same element.
+     */
+    to?: string | Array<string>;
+
+    visible?: boolean;
+
+    x?: number;
+
+    y?: number;
+  }
+}
+
+/**
+ * Wait for a specified duration
+ */
+export interface WaitAction {
+  wait: number | string | WaitAction.UnionMember2;
+}
+
+export namespace WaitAction {
+  export interface UnionMember2 {
+    /**
+     * Duration value that accepts various formats. Supports: number (ms), string
+     * ("1000"), or string with unit ("2s", "500ms", "2m", "1h")
+     */
+    duration: number | string;
+
+    /**
+     * Whether this action is required. If true, pipeline stops on failure. Accepts
+     * boolean or string "true"/"false". Default: true.
+     */
+    required?: 'true' | 'false' | boolean;
+
+    /**
+     * Whether to skip this action. Accepts boolean or string "true"/"false". Default:
+     * false.
+     */
+    skip?: 'true' | 'false' | boolean;
+  }
+}
+
+/**
+ * Wait for an element to appear or reach a specific state
+ */
+export interface WaitForElementAction {
+  wait_for_element: string | Array<string> | WaitForElementAction.UnionMember2;
+}
+
+export namespace WaitForElementAction {
+  export interface UnionMember2 {
+    /**
+     * CSS selector or array of alternative selectors. Use an array when you have
+     * multiple possible selectors for the same element.
+     */
+    selector: string | Array<string>;
+
+    /**
+     * Whether this action is required. If true, pipeline stops on failure. Accepts
+     * boolean or string "true"/"false". Default: true.
+     */
+    required?: 'true' | 'false' | boolean;
+
+    /**
+     * Whether to skip this action. Accepts boolean or string "true"/"false". Default:
+     * false.
+     */
+    skip?: 'true' | 'false' | boolean;
+
+    /**
+     * Timeout in milliseconds. Set to 0 for infinite timeout (no timeout). Default:
+     * 15000ms.
+     */
+    timeout?: number;
+
+    visible?: boolean;
+  }
+}
+
+/**
+ * Wait for page navigation to complete
+ */
+export interface WaitForNavigationAction {
+  wait_for_navigation:
+    | 'load'
+    | 'domcontentloaded'
+    | 'networkidle0'
+    | 'networkidle2'
+    | WaitForNavigationAction.UnionMember1;
+}
+
+export namespace WaitForNavigationAction {
+  export interface UnionMember1 {
+    navigation: 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2';
+
+    /**
+     * Whether this action is required. If true, pipeline stops on failure. Accepts
+     * boolean or string "true"/"false". Default: true.
+     */
+    required?: 'true' | 'false' | boolean;
+
+    /**
+     * Whether to skip this action. Accepts boolean or string "true"/"false". Default:
+     * false.
+     */
+    skip?: 'true' | 'false' | boolean;
+
+    /**
+     * Timeout in milliseconds. Set to 0 for infinite timeout (no timeout). Default:
+     * 15000ms.
+     */
+    timeout?: number;
+  }
+}