gbox_sdk.types.v1.boxes package¶

Submodules¶

gbox_sdk.types.v1.boxes.action_click_params module¶

class gbox_sdk.types.v1.boxes.action_click_params.ActionClickParams¶

Bases: TypedDict

button: Literal['left', 'right', 'middle']¶: Mouse button to click

double: bool¶: Whether to perform a double click

include_screenshot: Annotated[bool]¶

Whether to include screenshots in the action response.

If false, the screenshot object will still be returned but with empty URIs. Default is false.

output_format: Annotated[Literal['base64', 'storageKey']]¶: Type of the URI. default is base64.

screenshot_delay: Annotated[str]¶

Delay after performing the action, before taking the final screenshot.

Execution flow:

Take screenshot before action
Perform the action
Wait for screenshotDelay (this parameter)
Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

x: Required[float]¶: X coordinate of the click

y: Required[float]¶: Y coordinate of the click

gbox_sdk.types.v1.boxes.action_click_response module¶

class gbox_sdk.types.v1.boxes.action_click_response.ActionCommonResult(**data)¶

Bases: BaseModel

message: str¶: message

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gbox_sdk.types.v1.boxes.action_click_response.ActionIncludeScreenshotResult(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

screenshot: ActionIncludeScreenshotResultScreenshot¶: Complete screenshot result with operation trace, before and after images

class gbox_sdk.types.v1.boxes.action_click_response.ActionIncludeScreenshotResultScreenshot(**data)¶

Bases: BaseModel

after: ActionIncludeScreenshotResultScreenshotAfter¶: Screenshot taken after action execution

before: ActionIncludeScreenshotResultScreenshotBefore¶: Screenshot taken before action execution

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

trace: ActionIncludeScreenshotResultScreenshotTrace¶: Screenshot with action operation trace

class gbox_sdk.types.v1.boxes.action_click_response.ActionIncludeScreenshotResultScreenshotAfter(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot after the action

class gbox_sdk.types.v1.boxes.action_click_response.ActionIncludeScreenshotResultScreenshotBefore(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot before the action

class gbox_sdk.types.v1.boxes.action_click_response.ActionIncludeScreenshotResultScreenshotTrace(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot with operation trace

gbox_sdk.types.v1.boxes.action_drag_params module¶

class gbox_sdk.types.v1.boxes.action_drag_params.DragAdvanced¶

Bases: TypedDict

duration: str¶

Time interval between points (e.g. “50ms”)

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 50ms

include_screenshot: Annotated[bool]¶

Whether to include screenshots in the action response.

If false, the screenshot object will still be returned but with empty URIs. Default is false.

output_format: Annotated[Literal['base64', 'storageKey']]¶: Type of the URI. default is base64.

path: Required[Iterable[DragAdvancedPath]]¶: Path of the drag action as a series of coordinates

screenshot_delay: Annotated[str]¶

Delay after performing the action, before taking the final screenshot.

Execution flow:

Take screenshot before action
Perform the action
Wait for screenshotDelay (this parameter)
Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

class gbox_sdk.types.v1.boxes.action_drag_params.DragAdvancedPath¶

Bases: TypedDict

x: Required[float]¶: X coordinate of a point in the drag path

y: Required[float]¶: Y coordinate of a point in the drag path

class gbox_sdk.types.v1.boxes.action_drag_params.DragSimple¶

Bases: TypedDict

duration: str¶

Duration to complete the movement from start to end coordinates

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms

end: Required[DragSimpleEnd]¶: Single point in a drag path

include_screenshot: Annotated[bool]¶

Whether to include screenshots in the action response.

If false, the screenshot object will still be returned but with empty URIs. Default is false.

output_format: Annotated[Literal['base64', 'storageKey']]¶: Type of the URI. default is base64.

screenshot_delay: Annotated[str]¶

Delay after performing the action, before taking the final screenshot.

Execution flow:

Take screenshot before action
Perform the action
Wait for screenshotDelay (this parameter)
Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

start: Required[DragSimpleStart]¶: Single point in a drag path

class gbox_sdk.types.v1.boxes.action_drag_params.DragSimpleEnd¶

Bases: TypedDict

x: Required[float]¶: X coordinate of a point in the drag path

y: Required[float]¶: Y coordinate of a point in the drag path

class gbox_sdk.types.v1.boxes.action_drag_params.DragSimpleStart¶

Bases: TypedDict

x: Required[float]¶: X coordinate of a point in the drag path

y: Required[float]¶: Y coordinate of a point in the drag path

gbox_sdk.types.v1.boxes.action_drag_response module¶

class gbox_sdk.types.v1.boxes.action_drag_response.ActionCommonResult(**data)¶

Bases: BaseModel

message: str¶: message

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gbox_sdk.types.v1.boxes.action_drag_response.ActionIncludeScreenshotResult(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

screenshot: ActionIncludeScreenshotResultScreenshot¶: Complete screenshot result with operation trace, before and after images

class gbox_sdk.types.v1.boxes.action_drag_response.ActionIncludeScreenshotResultScreenshot(**data)¶

Bases: BaseModel

after: ActionIncludeScreenshotResultScreenshotAfter¶: Screenshot taken after action execution

before: ActionIncludeScreenshotResultScreenshotBefore¶: Screenshot taken before action execution

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

trace: ActionIncludeScreenshotResultScreenshotTrace¶: Screenshot with action operation trace

class gbox_sdk.types.v1.boxes.action_drag_response.ActionIncludeScreenshotResultScreenshotAfter(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot after the action

class gbox_sdk.types.v1.boxes.action_drag_response.ActionIncludeScreenshotResultScreenshotBefore(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot before the action

class gbox_sdk.types.v1.boxes.action_drag_response.ActionIncludeScreenshotResultScreenshotTrace(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot with operation trace

gbox_sdk.types.v1.boxes.action_move_params module¶

class gbox_sdk.types.v1.boxes.action_move_params.ActionMoveParams¶

Bases: TypedDict

include_screenshot: Annotated[bool]¶

Whether to include screenshots in the action response.

If false, the screenshot object will still be returned but with empty URIs. Default is false.

output_format: Annotated[Literal['base64', 'storageKey']]¶: Type of the URI. default is base64.

screenshot_delay: Annotated[str]¶

Delay after performing the action, before taking the final screenshot.

Execution flow:

Take screenshot before action
Perform the action
Wait for screenshotDelay (this parameter)
Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

x: Required[float]¶: X coordinate to move to

y: Required[float]¶: Y coordinate to move to

gbox_sdk.types.v1.boxes.action_move_response module¶

class gbox_sdk.types.v1.boxes.action_move_response.ActionCommonResult(**data)¶

Bases: BaseModel

message: str¶: message

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gbox_sdk.types.v1.boxes.action_move_response.ActionIncludeScreenshotResult(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

screenshot: ActionIncludeScreenshotResultScreenshot¶: Complete screenshot result with operation trace, before and after images

class gbox_sdk.types.v1.boxes.action_move_response.ActionIncludeScreenshotResultScreenshot(**data)¶

Bases: BaseModel

after: ActionIncludeScreenshotResultScreenshotAfter¶: Screenshot taken after action execution

before: ActionIncludeScreenshotResultScreenshotBefore¶: Screenshot taken before action execution

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

trace: ActionIncludeScreenshotResultScreenshotTrace¶: Screenshot with action operation trace

class gbox_sdk.types.v1.boxes.action_move_response.ActionIncludeScreenshotResultScreenshotAfter(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot after the action

class gbox_sdk.types.v1.boxes.action_move_response.ActionIncludeScreenshotResultScreenshotBefore(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot before the action

class gbox_sdk.types.v1.boxes.action_move_response.ActionIncludeScreenshotResultScreenshotTrace(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot with operation trace

gbox_sdk.types.v1.boxes.action_press_button_params module¶

class gbox_sdk.types.v1.boxes.action_press_button_params.ActionPressButtonParams¶

Bases: TypedDict

buttons: Required[List[Literal['power', 'volumeUp', 'volumeDown', 'volumeMute', 'home', 'back', 'menu', 'appSwitch']]]¶: Button to press

include_screenshot: Annotated[bool]¶

Whether to include screenshots in the action response.

If false, the screenshot object will still be returned but with empty URIs. Default is false.

output_format: Annotated[Literal['base64', 'storageKey']]¶: Type of the URI. default is base64.

screenshot_delay: Annotated[str]¶

Delay after performing the action, before taking the final screenshot.

Execution flow:

Take screenshot before action
Perform the action
Wait for screenshotDelay (this parameter)
Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

gbox_sdk.types.v1.boxes.action_press_button_response module¶

class gbox_sdk.types.v1.boxes.action_press_button_response.ActionCommonResult(**data)¶

Bases: BaseModel

message: str¶: message

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gbox_sdk.types.v1.boxes.action_press_button_response.ActionIncludeScreenshotResult(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

screenshot: ActionIncludeScreenshotResultScreenshot¶: Complete screenshot result with operation trace, before and after images

class gbox_sdk.types.v1.boxes.action_press_button_response.ActionIncludeScreenshotResultScreenshot(**data)¶

Bases: BaseModel

after: ActionIncludeScreenshotResultScreenshotAfter¶: Screenshot taken after action execution

before: ActionIncludeScreenshotResultScreenshotBefore¶: Screenshot taken before action execution

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

trace: ActionIncludeScreenshotResultScreenshotTrace¶: Screenshot with action operation trace

class gbox_sdk.types.v1.boxes.action_press_button_response.ActionIncludeScreenshotResultScreenshotAfter(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot after the action

class gbox_sdk.types.v1.boxes.action_press_button_response.ActionIncludeScreenshotResultScreenshotBefore(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot before the action

class gbox_sdk.types.v1.boxes.action_press_button_response.ActionIncludeScreenshotResultScreenshotTrace(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot with operation trace

gbox_sdk.types.v1.boxes.action_press_key_params module¶

class gbox_sdk.types.v1.boxes.action_press_key_params.ActionPressKeyParams¶

Bases: TypedDict

include_screenshot: Annotated[bool]¶

Whether to include screenshots in the action response.

If false, the screenshot object will still be returned but with empty URIs. Default is false.

output_format: Annotated[Literal['base64', 'storageKey']]¶: Type of the URI. default is base64.

screenshot_delay: Annotated[str]¶

Delay after performing the action, before taking the final screenshot.

Execution flow:

Take screenshot before action
Perform the action
Wait for screenshotDelay (this parameter)
Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

gbox_sdk.types.v1.boxes.action_press_key_response module¶

class gbox_sdk.types.v1.boxes.action_press_key_response.ActionCommonResult(**data)¶

Bases: BaseModel

message: str¶: message

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gbox_sdk.types.v1.boxes.action_press_key_response.ActionIncludeScreenshotResult(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

screenshot: ActionIncludeScreenshotResultScreenshot¶: Complete screenshot result with operation trace, before and after images

class gbox_sdk.types.v1.boxes.action_press_key_response.ActionIncludeScreenshotResultScreenshot(**data)¶

Bases: BaseModel

after: ActionIncludeScreenshotResultScreenshotAfter¶: Screenshot taken after action execution

before: ActionIncludeScreenshotResultScreenshotBefore¶: Screenshot taken before action execution

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

trace: ActionIncludeScreenshotResultScreenshotTrace¶: Screenshot with action operation trace

class gbox_sdk.types.v1.boxes.action_press_key_response.ActionIncludeScreenshotResultScreenshotAfter(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot after the action

class gbox_sdk.types.v1.boxes.action_press_key_response.ActionIncludeScreenshotResultScreenshotBefore(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot before the action

class gbox_sdk.types.v1.boxes.action_press_key_response.ActionIncludeScreenshotResultScreenshotTrace(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot with operation trace

gbox_sdk.types.v1.boxes.action_screen_rotation_params module¶

class gbox_sdk.types.v1.boxes.action_screen_rotation_params.ActionScreenRotationParams¶

Bases: TypedDict

angle: Required[Literal[90, 180, 270]]¶: Rotation angle in degrees

direction: Required[Literal['clockwise', 'counter-clockwise']]¶: Rotation direction

gbox_sdk.types.v1.boxes.action_screen_rotation_response module¶

class gbox_sdk.types.v1.boxes.action_screen_rotation_response.ActionCommonResult(**data)¶

Bases: BaseModel

message: str¶: message

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gbox_sdk.types.v1.boxes.action_screen_rotation_response.ActionIncludeScreenshotResult(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

screenshot: ActionIncludeScreenshotResultScreenshot¶: Complete screenshot result with operation trace, before and after images

class gbox_sdk.types.v1.boxes.action_screen_rotation_response.ActionIncludeScreenshotResultScreenshot(**data)¶

Bases: BaseModel

after: ActionIncludeScreenshotResultScreenshotAfter¶: Screenshot taken after action execution

before: ActionIncludeScreenshotResultScreenshotBefore¶: Screenshot taken before action execution

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

trace: ActionIncludeScreenshotResultScreenshotTrace¶: Screenshot with action operation trace

class gbox_sdk.types.v1.boxes.action_screen_rotation_response.ActionIncludeScreenshotResultScreenshotAfter(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot after the action

class gbox_sdk.types.v1.boxes.action_screen_rotation_response.ActionIncludeScreenshotResultScreenshotBefore(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot before the action

class gbox_sdk.types.v1.boxes.action_screen_rotation_response.ActionIncludeScreenshotResultScreenshotTrace(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot with operation trace

gbox_sdk.types.v1.boxes.action_screenshot_params module¶

class gbox_sdk.types.v1.boxes.action_screenshot_params.ActionScreenshotParams¶

Bases: TypedDict

clip: Clip¶: Clipping region for screenshot capture

output_format: Annotated[Literal['base64', 'storageKey']]¶: Type of the URI. default is base64.

class gbox_sdk.types.v1.boxes.action_screenshot_params.Clip¶

Bases: TypedDict

height: Required[float]¶: Height of the clip

width: Required[float]¶: Width of the clip

x: Required[float]¶: X coordinate of the clip

y: Required[float]¶: Y coordinate of the clip

gbox_sdk.types.v1.boxes.action_screenshot_response module¶

class gbox_sdk.types.v1.boxes.action_screenshot_response.ActionScreenshotResponse(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URL of the screenshot

gbox_sdk.types.v1.boxes.action_scroll_params module¶

class gbox_sdk.types.v1.boxes.action_scroll_params.ActionScrollParams¶

Bases: TypedDict

include_screenshot: Annotated[bool]¶

Whether to include screenshots in the action response.

If false, the screenshot object will still be returned but with empty URIs. Default is false.

output_format: Annotated[Literal['base64', 'storageKey']]¶: Type of the URI. default is base64.

screenshot_delay: Annotated[str]¶

Delay after performing the action, before taking the final screenshot.

Execution flow:

Take screenshot before action
Perform the action
Wait for screenshotDelay (this parameter)
Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

scroll_x: Required[Annotated[float]]¶: Horizontal scroll amount

scroll_y: Required[Annotated[float]]¶: Vertical scroll amount

x: Required[float]¶: X coordinate of the scroll position

y: Required[float]¶: Y coordinate of the scroll position

gbox_sdk.types.v1.boxes.action_scroll_response module¶

class gbox_sdk.types.v1.boxes.action_scroll_response.ActionCommonResult(**data)¶

Bases: BaseModel

message: str¶: message

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gbox_sdk.types.v1.boxes.action_scroll_response.ActionIncludeScreenshotResult(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

screenshot: ActionIncludeScreenshotResultScreenshot¶: Complete screenshot result with operation trace, before and after images

class gbox_sdk.types.v1.boxes.action_scroll_response.ActionIncludeScreenshotResultScreenshot(**data)¶

Bases: BaseModel

after: ActionIncludeScreenshotResultScreenshotAfter¶: Screenshot taken after action execution

before: ActionIncludeScreenshotResultScreenshotBefore¶: Screenshot taken before action execution

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

trace: ActionIncludeScreenshotResultScreenshotTrace¶: Screenshot with action operation trace

class gbox_sdk.types.v1.boxes.action_scroll_response.ActionIncludeScreenshotResultScreenshotAfter(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot after the action

class gbox_sdk.types.v1.boxes.action_scroll_response.ActionIncludeScreenshotResultScreenshotBefore(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot before the action

class gbox_sdk.types.v1.boxes.action_scroll_response.ActionIncludeScreenshotResultScreenshotTrace(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot with operation trace

gbox_sdk.types.v1.boxes.action_swipe_params module¶

class gbox_sdk.types.v1.boxes.action_swipe_params.SwipeAdvanced¶

Bases: TypedDict

duration: str¶

Duration of the swipe

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms

end: Required[SwipeAdvancedEnd]¶: Swipe path

include_screenshot: Annotated[bool]¶

Whether to include screenshots in the action response.

If false, the screenshot object will still be returned but with empty URIs. Default is false.

output_format: Annotated[Literal['base64', 'storageKey']]¶: Type of the URI. default is base64.

screenshot_delay: Annotated[str]¶

Delay after performing the action, before taking the final screenshot.

Execution flow:

Take screenshot before action
Perform the action
Wait for screenshotDelay (this parameter)
Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

start: Required[SwipeAdvancedStart]¶: Swipe path

class gbox_sdk.types.v1.boxes.action_swipe_params.SwipeAdvancedEnd¶

Bases: TypedDict

x: Required[float]¶: Start/end x coordinate of the swipe path

y: Required[float]¶: Start/end y coordinate of the swipe path

class gbox_sdk.types.v1.boxes.action_swipe_params.SwipeAdvancedStart¶

Bases: TypedDict

x: Required[float]¶: Start/end x coordinate of the swipe path

y: Required[float]¶: Start/end y coordinate of the swipe path

class gbox_sdk.types.v1.boxes.action_swipe_params.SwipeSimple¶

Bases: TypedDict

direction: Required[Literal['up', 'down', 'left', 'right', 'upLeft', 'upRight', 'downLeft', 'downRight']]¶

Direction to swipe.

The gesture will be performed from the center of the screen towards this direction.

distance: float¶

Distance of the swipe in pixels.

If not provided, the swipe will be performed from the center of the screen to the screen edge

duration: str¶

Duration of the swipe

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms

include_screenshot: Annotated[bool]¶

Whether to include screenshots in the action response.

If false, the screenshot object will still be returned but with empty URIs. Default is false.

output_format: Annotated[Literal['base64', 'storageKey']]¶: Type of the URI. default is base64.

screenshot_delay: Annotated[str]¶

Delay after performing the action, before taking the final screenshot.

Execution flow:

Take screenshot before action
Perform the action
Wait for screenshotDelay (this parameter)
Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

gbox_sdk.types.v1.boxes.action_swipe_response module¶

class gbox_sdk.types.v1.boxes.action_swipe_response.ActionCommonResult(**data)¶

Bases: BaseModel

message: str¶: message

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gbox_sdk.types.v1.boxes.action_swipe_response.ActionIncludeScreenshotResult(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

screenshot: ActionIncludeScreenshotResultScreenshot¶: Complete screenshot result with operation trace, before and after images

class gbox_sdk.types.v1.boxes.action_swipe_response.ActionIncludeScreenshotResultScreenshot(**data)¶

Bases: BaseModel

after: ActionIncludeScreenshotResultScreenshotAfter¶: Screenshot taken after action execution

before: ActionIncludeScreenshotResultScreenshotBefore¶: Screenshot taken before action execution

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

trace: ActionIncludeScreenshotResultScreenshotTrace¶: Screenshot with action operation trace

class gbox_sdk.types.v1.boxes.action_swipe_response.ActionIncludeScreenshotResultScreenshotAfter(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot after the action

class gbox_sdk.types.v1.boxes.action_swipe_response.ActionIncludeScreenshotResultScreenshotBefore(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot before the action

class gbox_sdk.types.v1.boxes.action_swipe_response.ActionIncludeScreenshotResultScreenshotTrace(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot with operation trace

gbox_sdk.types.v1.boxes.action_touch_params module¶

class gbox_sdk.types.v1.boxes.action_touch_params.ActionTouchParams¶

Bases: TypedDict

include_screenshot: Annotated[bool]¶

Whether to include screenshots in the action response.

If false, the screenshot object will still be returned but with empty URIs. Default is false.

output_format: Annotated[Literal['base64', 'storageKey']]¶: Type of the URI. default is base64.

points: Required[Iterable[Point]]¶: Array of touch points and their actions

screenshot_delay: Annotated[str]¶

Delay after performing the action, before taking the final screenshot.

Execution flow:

Take screenshot before action
Perform the action
Wait for screenshotDelay (this parameter)
Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

class gbox_sdk.types.v1.boxes.action_touch_params.Point¶

Bases: TypedDict

actions: Iterable[object]¶: Sequence of actions to perform after initial touch

start: Required[PointStart]¶: Initial touch point position

class gbox_sdk.types.v1.boxes.action_touch_params.PointStart¶

Bases: TypedDict

x: Required[float]¶: Starting X coordinate

y: Required[float]¶: Starting Y coordinate

gbox_sdk.types.v1.boxes.action_touch_response module¶

class gbox_sdk.types.v1.boxes.action_touch_response.ActionCommonResult(**data)¶

Bases: BaseModel

message: str¶: message

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gbox_sdk.types.v1.boxes.action_touch_response.ActionIncludeScreenshotResult(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

screenshot: ActionIncludeScreenshotResultScreenshot¶: Complete screenshot result with operation trace, before and after images

class gbox_sdk.types.v1.boxes.action_touch_response.ActionIncludeScreenshotResultScreenshot(**data)¶

Bases: BaseModel

after: ActionIncludeScreenshotResultScreenshotAfter¶: Screenshot taken after action execution

before: ActionIncludeScreenshotResultScreenshotBefore¶: Screenshot taken before action execution

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

trace: ActionIncludeScreenshotResultScreenshotTrace¶: Screenshot with action operation trace

class gbox_sdk.types.v1.boxes.action_touch_response.ActionIncludeScreenshotResultScreenshotAfter(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot after the action

class gbox_sdk.types.v1.boxes.action_touch_response.ActionIncludeScreenshotResultScreenshotBefore(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot before the action

class gbox_sdk.types.v1.boxes.action_touch_response.ActionIncludeScreenshotResultScreenshotTrace(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot with operation trace

gbox_sdk.types.v1.boxes.action_type_params module¶

class gbox_sdk.types.v1.boxes.action_type_params.ActionTypeParams¶

Bases: TypedDict

include_screenshot: Annotated[bool]¶

Whether to include screenshots in the action response.

If false, the screenshot object will still be returned but with empty URIs. Default is false.

output_format: Annotated[Literal['base64', 'storageKey']]¶: Type of the URI. default is base64.

screenshot_delay: Annotated[str]¶

Delay after performing the action, before taking the final screenshot.

Execution flow:

Take screenshot before action
Perform the action
Wait for screenshotDelay (this parameter)
Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

text: Required[str]¶: Text to type

gbox_sdk.types.v1.boxes.action_type_response module¶

class gbox_sdk.types.v1.boxes.action_type_response.ActionCommonResult(**data)¶

Bases: BaseModel

message: str¶: message

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gbox_sdk.types.v1.boxes.action_type_response.ActionIncludeScreenshotResult(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

screenshot: ActionIncludeScreenshotResultScreenshot¶: Complete screenshot result with operation trace, before and after images

class gbox_sdk.types.v1.boxes.action_type_response.ActionIncludeScreenshotResultScreenshot(**data)¶

Bases: BaseModel

after: ActionIncludeScreenshotResultScreenshotAfter¶: Screenshot taken after action execution

before: ActionIncludeScreenshotResultScreenshotBefore¶: Screenshot taken before action execution

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

trace: ActionIncludeScreenshotResultScreenshotTrace¶: Screenshot with action operation trace

class gbox_sdk.types.v1.boxes.action_type_response.ActionIncludeScreenshotResultScreenshotAfter(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot after the action

class gbox_sdk.types.v1.boxes.action_type_response.ActionIncludeScreenshotResultScreenshotBefore(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot before the action

class gbox_sdk.types.v1.boxes.action_type_response.ActionIncludeScreenshotResultScreenshotTrace(**data)¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶: URI of the screenshot with operation trace

gbox_sdk.types.v1.boxes.android_app module¶

class gbox_sdk.types.v1.boxes.android_app.AndroidApp(**data)¶

Bases: BaseModel

activity_class_name: str¶: Activity class name

activity_name: str¶: Activity name

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

package_name: str¶: App package name

gbox_sdk.types.v1.boxes.android_get_connect_address_response module¶

class gbox_sdk.types.v1.boxes.android_get_connect_address_response.AndroidGetConnectAddressResponse(**data)¶

Bases: BaseModel

adb: str¶

Android adb connect address.

use adb connect <adbConnectAddress> to connect to the Android device

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

gbox_sdk.types.v1.boxes.android_get_response module¶

class gbox_sdk.types.v1.boxes.android_get_response.AndroidGetResponse(**data)¶

Bases: BaseModel

apk_path: str¶: Android apk path

is_running: bool¶: Whether the pkg is currently running

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str¶: Android pkg name

package_name: str¶: Android package name

pkg_type: Literal['system', 'thirdParty']¶: Package type: system or thirdParty

version: str¶: Android pkg version

gbox_sdk.types.v1.boxes.android_install_params module¶

class gbox_sdk.types.v1.boxes.android_install_params.InstallAndroidPkgByFile¶

Bases: TypedDict

apk: Required[Union[IO[bytes], bytes, PathLike, Tuple[Optional[str], Union[IO[bytes], bytes, PathLike]], Tuple[Optional[str], Union[IO[bytes], bytes, PathLike], Optional[str]], Tuple[Optional[str], Union[IO[bytes], bytes, PathLike], Optional[str], Mapping[str, str]]]]¶: APK file to install (max file size: 512MB)

open: bool¶

Whether to open the app after installation.

Will find and launch the launcher activity of the installed app. If there are multiple launcher activities, only one will be opened. If the installed APK has no launcher activity, this parameter will have no effect.

class gbox_sdk.types.v1.boxes.android_install_params.InstallAndroidPkgByURL¶

Bases: TypedDict

apk: Required[str]¶: HTTP URL to download APK file (max file size: 512MB)

open: bool¶

Whether to open the app after installation.

Will find and launch the launcher activity of the installed app. If there are multiple launcher activities, only one will be opened. If the installed APK has no launcher activity, this parameter will have no effect.

gbox_sdk.types.v1.boxes.android_install_response module¶

class gbox_sdk.types.v1.boxes.android_install_response.Activity(**data)¶

Bases: BaseModel

class_name: str¶: Activity class name

is_exported: bool¶: Activity class name

is_launcher: bool¶

Whether the activity is a launcher activity.

Launcher activities appear in the device’s pkg launcher/home screen and can be directly launched by the user.

is_main: bool¶

Whether the activity is the main activity.

Main activity is the entry point of the pkg and is typically launched when the pkg is started.

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str¶: Activity name

package_name: str¶: Activity package name

class gbox_sdk.types.v1.boxes.android_install_response.AndroidInstallResponse(**data)¶

Bases: BaseModel

activities: List[Activity]¶: Activity list

apk_path: str¶: Android apk path

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

package_name: str¶: Android pkg package name

pkg_type: Literal['system', 'thirdParty']¶: Package type: system or thirdParty

gbox_sdk.types.v1.boxes.android_list_activities_response module¶

class gbox_sdk.types.v1.boxes.android_list_activities_response.AndroidListActivitiesResponse(**data)¶

Bases: BaseModel

data: List[Data]¶: Activity list

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gbox_sdk.types.v1.boxes.android_list_activities_response.Data(**data)¶

Bases: BaseModel

class_name: str¶: Activity class name

is_exported: bool¶: Activity class name

is_launcher: bool¶

Whether the activity is a launcher activity.

Launcher activities appear in the device’s pkg launcher/home screen and can be directly launched by the user.

is_main: bool¶

Whether the activity is the main activity.

Main activity is the entry point of the pkg and is typically launched when the pkg is started.

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str¶: Activity name

package_name: str¶: Activity package name

gbox_sdk.types.v1.boxes.android_list_app_response module¶

class gbox_sdk.types.v1.boxes.android_list_app_response.AndroidListAppResponse(**data)¶

Bases: BaseModel

data: List[AndroidApp]¶: App list

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

gbox_sdk.types.v1.boxes.android_list_pkg_params module¶

class gbox_sdk.types.v1.boxes.android_list_pkg_params.AndroidListPkgParams¶

Bases: TypedDict

pkg_type: Annotated[List[Literal['system', 'thirdParty']]]¶: Package type: system or thirdParty, default is thirdParty

running_filter: Annotated[List[Literal['running', 'notRunning']]]¶: Filter pkgs by running status: running (show only running pkgs), notRunning (show only non-running pkgs). Default is all

gbox_sdk.types.v1.boxes.android_list_pkg_response module¶

class gbox_sdk.types.v1.boxes.android_list_pkg_response.AndroidListPkgResponse(**data)¶

Bases: BaseModel

data: List[Data]¶: Android pkg list

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gbox_sdk.types.v1.boxes.android_list_pkg_response.Data(**data)¶

Bases: BaseModel

apk_path: str¶: Android apk path

is_running: bool¶: Whether the pkg is currently running

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str¶: Android pkg name

package_name: str¶: Android package name

pkg_type: Literal['system', 'thirdParty']¶: Package type: system or thirdParty

version: str¶: Android pkg version

gbox_sdk.types.v1.boxes.android_list_pkg_simple_params module¶

class gbox_sdk.types.v1.boxes.android_list_pkg_simple_params.AndroidListPkgSimpleParams¶

Bases: TypedDict

pkg_type: Annotated[List[Literal['system', 'thirdParty']]]¶: Package type: system or thirdParty, default is thirdParty

gbox_sdk.types.v1.boxes.android_list_pkg_simple_response module¶

class gbox_sdk.types.v1.boxes.android_list_pkg_simple_response.AndroidListPkgSimpleResponse(**data)¶

Bases: BaseModel

data: List[Data]¶: Android pkg simple list

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gbox_sdk.types.v1.boxes.android_list_pkg_simple_response.Data(**data)¶

Bases: BaseModel

apk_path: str¶: Android apk path

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

package_name: str¶: Android pkg package name

pkg_type: Literal['system', 'thirdParty']¶: Package type: system or thirdParty

gbox_sdk.types.v1.boxes.android_open_params module¶

class gbox_sdk.types.v1.boxes.android_open_params.AndroidOpenParams¶

Bases: TypedDict

activity_name: Annotated[str]¶: Activity name, default is the main activity.

box_id: Required[Annotated[str]]¶

gbox_sdk.types.v1.boxes.android_restart_params module¶

class gbox_sdk.types.v1.boxes.android_restart_params.AndroidRestartParams¶

Bases: TypedDict

activity_name: Annotated[str]¶: Activity name, default is the main activity.

box_id: Required[Annotated[str]]¶

gbox_sdk.types.v1.boxes.android_restore_params module¶

class gbox_sdk.types.v1.boxes.android_restore_params.AndroidRestoreParams¶

Bases: TypedDict

backup: Required[Union[IO[bytes], bytes, PathLike, Tuple[Optional[str], Union[IO[bytes], bytes, PathLike]], Tuple[Optional[str], Union[IO[bytes], bytes, PathLike], Optional[str]], Tuple[Optional[str], Union[IO[bytes], bytes, PathLike], Optional[str], Mapping[str, str]]]]¶: Backup file to restore (max file size: 100MB)

gbox_sdk.types.v1.boxes.android_uninstall_params module¶

class gbox_sdk.types.v1.boxes.android_uninstall_params.AndroidUninstallParams¶

Bases: TypedDict

box_id: Required[Annotated[str]]¶

keep_data: Annotated[bool]¶: uninstalls the pkg while retaining the data/cache

gbox_sdk.types.v1.boxes.browser_cdp_url_params module¶

class gbox_sdk.types.v1.boxes.browser_cdp_url_params.BrowserCdpURLParams¶

Bases: TypedDict

expires_in: Annotated[str]¶

The CDP url will be alive for the given duration

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 120m

gbox_sdk.types.v1.boxes.browser_cdp_url_response module¶

gbox_sdk.types.v1.boxes.browser_cdp_url_response.BrowserCdpURLResponse¶: alias of str

gbox_sdk.types.v1.boxes.f_exists_params module¶

class gbox_sdk.types.v1.boxes.f_exists_params.FExistsParams¶

Bases: TypedDict

path: Required[str]¶

Target path in the box.

If the path does not start with ‘/’, the file/directory will be checked relative to the working directory

working_dir: Annotated[str]¶

Working directory.

If not provided, the file will be read from the box.config.workingDir directory.

gbox_sdk.types.v1.boxes.f_exists_response module¶

class gbox_sdk.types.v1.boxes.f_exists_response.ExistsFileResult(**data)¶

Bases: BaseModel

exists: bool¶: Exists

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: str¶: Type

class gbox_sdk.types.v1.boxes.f_exists_response.NotExistsFileResult(**data)¶

Bases: BaseModel

exists: bool¶: Exists

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

gbox_sdk.types.v1.boxes.f_info_params module¶

class gbox_sdk.types.v1.boxes.f_info_params.FInfoParams¶

Bases: TypedDict

path: Required[str]¶

Target path in the box.

If the path does not start with ‘/’, the file/directory will be checked relative to the working directory

working_dir: Annotated[str]¶

Working directory.

If not provided, the file will be read from the box.config.workingDir directory.

gbox_sdk.types.v1.boxes.f_info_response module¶

class gbox_sdk.types.v1.boxes.f_info_response.Dir(**data)¶

Bases: BaseModel

last_modified: datetime¶: Last modified time of the directory

mode: str¶: Directory metadata

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str¶: Name of the directory

path: str¶: Full path to the directory in the box

type: Literal['dir']¶: Directory type indicator

class gbox_sdk.types.v1.boxes.f_info_response.File(**data)¶

Bases: BaseModel

last_modified: datetime¶: Last modified time of the file

mode: str¶: File metadata

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str¶: Name of the file

path: str¶: Full path to the file in the box

size: str¶: Size of the file

type: Literal['file']¶: File type indicator

gbox_sdk.types.v1.boxes.f_list_params module¶

class gbox_sdk.types.v1.boxes.f_list_params.FListParams¶

Bases: TypedDict

depth: float¶: Depth of the directory

path: Required[str]¶: Target directory path in the box

working_dir: Annotated[str]¶

Working directory.

If not provided, the file will be read from the box.config.workingDir directory.

gbox_sdk.types.v1.boxes.f_list_response module¶

class gbox_sdk.types.v1.boxes.f_list_response.DataDir(**data)¶

Bases: BaseModel

last_modified: datetime¶: Last modified time of the directory

mode: str¶: Directory metadata

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str¶: Name of the directory

path: str¶: Full path to the directory in the box

type: Literal['dir']¶: Directory type indicator

class gbox_sdk.types.v1.boxes.f_list_response.DataFile(**data)¶

Bases: BaseModel

last_modified: datetime¶: Last modified time of the file

mode: str¶: File metadata

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str¶: Name of the file

path: str¶: Full path to the file in the box

size: str¶: Size of the file

type: Literal['file']¶: File type indicator

class gbox_sdk.types.v1.boxes.f_list_response.FListResponse(**data)¶

Bases: BaseModel

data: List[Union[DataFile, DataDir]]¶: Array of files and directories

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

gbox_sdk.types.v1.boxes.f_read_params module¶

class gbox_sdk.types.v1.boxes.f_read_params.FReadParams¶

Bases: TypedDict

path: Required[str]¶

Target path in the box.

If the path does not start with ‘/’, the file will be read from the working directory.

working_dir: Annotated[str]¶

Working directory.

If not provided, the file will be read from the box.config.workingDir directory.

gbox_sdk.types.v1.boxes.f_read_response module¶

class gbox_sdk.types.v1.boxes.f_read_response.FReadResponse(**data)¶

Bases: BaseModel

content: str¶: Content of the file

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

gbox_sdk.types.v1.boxes.f_remove_params module¶

class gbox_sdk.types.v1.boxes.f_remove_params.FRemoveParams¶

Bases: TypedDict

path: Required[str]¶

Target path in the box.

If the path does not start with ‘/’, the file/directory will be deleted relative to the working directory. If the target path does not exist, the delete will fail.

working_dir: Annotated[str]¶

Working directory.

If not provided, the file will be read from the box.config.workingDir directory.

gbox_sdk.types.v1.boxes.f_remove_response module¶

class gbox_sdk.types.v1.boxes.f_remove_response.FRemoveResponse(**data)¶

Bases: BaseModel

message: str¶: Success message

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

gbox_sdk.types.v1.boxes.f_rename_params module¶

class gbox_sdk.types.v1.boxes.f_rename_params.FRenameParams¶

Bases: TypedDict

new_path: Required[Annotated[str]]¶

New path in the box.

If the path does not start with ‘/’, the file/directory will be renamed relative to the working directory. If the newPath already exists, the rename will fail.

old_path: Required[Annotated[str]]¶

Old path in the box.

If the path does not start with ‘/’, the file/directory will be renamed relative to the working directory. If the oldPath does not exist, the rename will fail.

working_dir: Annotated[str]¶

Working directory.

If not provided, the file will be read from the box.config.workingDir directory.

gbox_sdk.types.v1.boxes.f_rename_response module¶

class gbox_sdk.types.v1.boxes.f_rename_response.Dir(**data)¶

Bases: BaseModel

last_modified: datetime¶: Last modified time of the directory

mode: str¶: Directory metadata

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str¶: Name of the directory

path: str¶: Full path to the directory in the box

type: Literal['dir']¶: Directory type indicator

class gbox_sdk.types.v1.boxes.f_rename_response.File(**data)¶

Bases: BaseModel

last_modified: datetime¶: Last modified time of the file

mode: str¶: File metadata

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str¶: Name of the file

path: str¶: Full path to the file in the box

size: str¶: Size of the file

type: Literal['file']¶: File type indicator

gbox_sdk.types.v1.boxes.f_write_params module¶

class gbox_sdk.types.v1.boxes.f_write_params.WriteFile¶

Bases: TypedDict

content: Required[str]¶: Content of the file (Max size: 512MB)

path: Required[str]¶

Target path in the box.

If the path does not start with ‘/’, the file will be written relative to the working directory. Creates necessary directories in the path if they don’t exist. If the target path already exists, the write will fail.

working_dir: Annotated[str]¶

Working directory.

If not provided, the file will be read from the box.config.workingDir directory.

class gbox_sdk.types.v1.boxes.f_write_params.WriteFileByBinary¶

Bases: TypedDict

content: Required[Union[IO[bytes], bytes, PathLike, Tuple[Optional[str], Union[IO[bytes], bytes, PathLike]], Tuple[Optional[str], Union[IO[bytes], bytes, PathLike], Optional[str]], Tuple[Optional[str], Union[IO[bytes], bytes, PathLike], Optional[str], Mapping[str, str]]]]¶: Binary content of the file (Max file size: 512MB)

path: Required[str]¶

Target path in the box.

If the path does not start with ‘/’, the file will be written relative to the working directory. Creates necessary directories in the path if they don’t exist. If the target path already exists, the write will fail.

working_dir: Annotated[str]¶

Working directory.

If not provided, the file will be read from the box.config.workingDir directory.

gbox_sdk.types.v1.boxes.f_write_response module¶

class gbox_sdk.types.v1.boxes.f_write_response.FWriteResponse(**data)¶

Bases: BaseModel

last_modified: datetime¶: Last modified time of the file

mode: str¶: File metadata

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str¶: Name of the file

path: str¶: Full path to the file in the box

size: str¶: Size of the file

type: Literal['file']¶: File type indicator

gbox_sdk.types.v1.boxes package¶

Submodules¶

gbox_sdk.types.v1.boxes.action_click_params module¶

gbox_sdk.types.v1.boxes.action_click_response module¶

gbox_sdk.types.v1.boxes.action_drag_params module¶

gbox_sdk.types.v1.boxes.action_drag_response module¶

gbox_sdk.types.v1.boxes.action_move_params module¶

gbox_sdk.types.v1.boxes.action_move_response module¶

gbox_sdk.types.v1.boxes.action_press_button_params module¶

gbox_sdk.types.v1.boxes.action_press_button_response module¶

gbox_sdk.types.v1.boxes.action_press_key_params module¶

gbox_sdk.types.v1.boxes.action_press_key_response module¶

gbox_sdk.types.v1.boxes.action_screen_rotation_params module¶

gbox_sdk.types.v1.boxes.action_screen_rotation_response module¶

gbox_sdk.types.v1.boxes.action_screenshot_params module¶

gbox_sdk.types.v1.boxes.action_screenshot_response module¶

gbox_sdk.types.v1.boxes.action_scroll_params module¶

gbox_sdk.types.v1.boxes.action_scroll_response module¶

gbox_sdk.types.v1.boxes.action_swipe_params module¶

gbox_sdk.types.v1.boxes.action_swipe_response module¶

gbox_sdk.types.v1.boxes.action_touch_params module¶

gbox_sdk.types.v1.boxes.action_touch_response module¶

gbox_sdk.types.v1.boxes.action_type_params module¶

gbox_sdk.types.v1.boxes.action_type_response module¶

gbox_sdk.types.v1.boxes.android_app module¶

gbox_sdk.types.v1.boxes.android_get_connect_address_response module¶

gbox_sdk.types.v1.boxes.android_get_response module¶

gbox_sdk.types.v1.boxes.android_install_params module¶

gbox_sdk.types.v1.boxes.android_install_response module¶

gbox_sdk.types.v1.boxes.android_list_activities_response module¶

gbox_sdk.types.v1.boxes.android_list_app_response module¶

gbox_sdk.types.v1.boxes.android_list_pkg_params module¶

gbox_sdk.types.v1.boxes.android_list_pkg_response module¶

gbox_sdk.types.v1.boxes.android_list_pkg_simple_params module¶

gbox_sdk.types.v1.boxes.android_list_pkg_simple_response module¶

gbox_sdk.types.v1.boxes.android_open_params module¶

gbox_sdk.types.v1.boxes.android_restart_params module¶

gbox_sdk.types.v1.boxes.android_restore_params module¶

gbox_sdk.types.v1.boxes.android_uninstall_params module¶

gbox_sdk.types.v1.boxes.browser_cdp_url_params module¶

gbox_sdk.types.v1.boxes.browser_cdp_url_response module¶

gbox_sdk.types.v1.boxes.f_exists_params module¶

gbox_sdk.types.v1.boxes.f_exists_response module¶

gbox_sdk.types.v1.boxes.f_info_params module¶

gbox_sdk.types.v1.boxes.f_info_response module¶

gbox_sdk.types.v1.boxes.f_list_params module¶

gbox_sdk.types.v1.boxes.f_list_response module¶

gbox_sdk.types.v1.boxes.f_read_params module¶

gbox_sdk.types.v1.boxes.f_read_response module¶

gbox_sdk.types.v1.boxes.f_remove_params module¶

gbox_sdk.types.v1.boxes.f_remove_response module¶

gbox_sdk.types.v1.boxes.f_rename_params module¶

gbox_sdk.types.v1.boxes.f_rename_response module¶

gbox_sdk.types.v1.boxes.f_write_params module¶

gbox_sdk.types.v1.boxes.f_write_response module¶

Module contents¶