@airtop/sdk 0.1.34-beta0 → 0.1.35-beta0

package/reference.md

@@ -113,7 +113,7 @@ Create an automation of a browser window asynchronously
 ```typescript
 await client.windows.asyncCreateAutomation(
     "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
-    "0334da2a-91b0-42c5-6156-76a5eba87430"
+    "0334da2a-91b0-42c5-6156-76a5eba87430",
 );
 ```
 
@@ -198,7 +198,7 @@ await client.windows.asyncExecuteAutomation(
     "0334da2a-91b0-42c5-6156-76a5eba87430",
     {
         automationId: "automationId",
-    }
+    },
 );
 ```
 
@@ -466,7 +466,7 @@ await client.windows.asyncPaginatedExtraction(
     "0334da2a-91b0-42c5-6156-76a5eba87430",
     {
         prompt: "This site contains a list of results about <provide details about the list>. Navigate through 3 pages of results and return the title and <provide details about the data you want to extract> about each result in this list.",
-    }
+    },
 );
 ```
 
@@ -551,7 +551,7 @@ await client.windows.asyncPromptContent(
     "0334da2a-91b0-42c5-6156-76a5eba87430",
     {
         prompt: "What is the main idea of this page?",
-    }
+    },
 );
 ```
 
@@ -712,7 +712,7 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
 ```typescript
 await client.windows.asyncSummarizeContent(
     "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
-    "0334da2a-91b0-42c5-6156-76a5eba87430"
+    "0334da2a-91b0-42c5-6156-76a5eba87430",
 );
 ```
 
@@ -1476,7 +1476,7 @@ await client.windows.paginatedExtraction(
     "0334da2a-91b0-42c5-6156-76a5eba87430",
     {
         prompt: "This site contains a list of results about <provide details about the list>. Navigate through 3 pages of results and return the title and <provide details about the data you want to extract> about each result in this list.",
-    }
+    },
 );
 ```
 
@@ -2256,9 +2256,9 @@ await client.automations.deleteAutomation("automationId");
 </dl>
 </details>
 
-## ExtensionConfigurations
+## Files
 
-<details><summary><code>client.extensionConfigurations.<a href="/src/api/resources/extensionConfigurations/client/Client.ts">extensionConfigurationGetInfo</a>(name) -> Airtop.ExtensionConfigurationOutput</code></summary>
+<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">list</a>({ ...params }) -> Airtop.FilesResponse</code></summary>
 <dl>
 <dd>
 
@@ -2270,7 +2270,7 @@ await client.automations.deleteAutomation("automationId");
 <dl>
 <dd>
 
-Get an extension configuration by name
+Get a list of files filtered by session ID
 
 </dd>
 </dl>
@@ -2286,7 +2286,10 @@ Get an extension configuration by name
 <dd>
 
 ```typescript
-await client.extensionConfigurations.extensionConfigurationGetInfo("my-configuration");
+await client.files.list({
+    offset: 1,
+    limit: 10,
+});
 ```
 
 </dd>
@@ -2302,7 +2305,7 @@ await client.extensionConfigurations.extensionConfigurationGetInfo("my-configura
 <dl>
 <dd>
 
-**name:** `string` — Name of the extension configuration to get
+**request:** `Airtop.FilesListRequest`
 
 </dd>
 </dl>
@@ -2310,7 +2313,7 @@ await client.extensionConfigurations.extensionConfigurationGetInfo("my-configura
 <dl>
 <dd>
 
-**requestOptions:** `ExtensionConfigurations.RequestOptions`
+**requestOptions:** `Files.RequestOptions`
 
 </dd>
 </dl>
@@ -2321,13 +2324,30 @@ await client.extensionConfigurations.extensionConfigurationGetInfo("my-configura
 </dl>
 </details>
 
-## Profiles
+<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">create</a>({ ...params }) -> Airtop.EnvelopeCreateFileV1EnvelopeDefaultMeta</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
 
-<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
 <dl>
 <dd>
 
-#### 📝 Description
+<dl>
+<dd>
+
+```typescript
+await client.files.create({
+    fileName: "fileName",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
 
 <dl>
 <dd>
@@ -2335,12 +2355,28 @@ await client.extensionConfigurations.extensionConfigurationGetInfo("my-configura
 <dl>
 <dd>
 
-Delete profiles matching by id
+**request:** `Airtop.CreateFileRestInputV1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
 
+**requestOptions:** `Files.RequestOptions`
+
+</dd>
+</dl>
 </dd>
 </dl>
+
 </dd>
 </dl>
+</details>
+
+<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">get</a>(id) -> Airtop.EnvelopeGetFileV1EnvelopeDefaultMeta</code></summary>
+<dl>
+<dd>
 
 #### 🔌 Usage
 
@@ -2351,7 +2387,7 @@ Delete profiles matching by id
 <dd>
 
 ```typescript
-await client.profiles.delete();
+await client.files.get("id");
 ```
 
 </dd>
@@ -2367,7 +2403,7 @@ await client.profiles.delete();
 <dl>
 <dd>
 
-**request:** `Airtop.ProfilesDeleteRequest`
+**id:** `string` — ID of the file
 
 </dd>
 </dl>
@@ -2375,7 +2411,7 @@ await client.profiles.delete();
 <dl>
 <dd>
 
-**requestOptions:** `Profiles.RequestOptions`
+**requestOptions:** `Files.RequestOptions`
 
 </dd>
 </dl>
@@ -2386,9 +2422,7 @@ await client.profiles.delete();
 </dl>
 </details>
 
-## Requests
-
-<details><summary><code>client.requests.<a href="/src/api/resources/requests/client/Client.ts">getRequestStatus</a>(requestId) -> Airtop.RequestStatusResponse</code></summary>
+<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">delete</a>(id) -> void</code></summary>
 <dl>
 <dd>
 
@@ -2401,7 +2435,7 @@ await client.profiles.delete();
 <dd>
 
 ```typescript
-await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000");
+await client.files.delete("id");
 ```
 
 </dd>
@@ -2417,7 +2451,7 @@ await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000");
 <dl>
 <dd>
 
-**requestId:** `string` — The ID of the request to check.
+**id:** `string` — ID of the file
 
 </dd>
 </dl>
@@ -2425,7 +2459,7 @@ await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000");
 <dl>
 <dd>
 
-**requestOptions:** `Requests.RequestOptions`
+**requestOptions:** `Files.RequestOptions`
 
 </dd>
 </dl>
@@ -2436,9 +2470,9 @@ await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000");
 </dl>
 </details>
 
-## Sessions
+## Automations
 
-<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">list</a>({ ...params }) -> Airtop.SessionsResponse</code></summary>
+<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">listAutomations</a>() -> Airtop.ListAutomationsOutput</code></summary>
 <dl>
 <dd>
 
@@ -2450,7 +2484,7 @@ await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000");
 <dl>
 <dd>
 
-Get a list of sessions by ID
+List all automations for a given organization
 
 </dd>
 </dl>
@@ -2466,9 +2500,65 @@ Get a list of sessions by ID
 <dd>
 
 ```typescript
-await client.sessions.list({
-    offset: 1,
-    limit: 10,
+await client.automations.listAutomations();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Automations.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">updateAutomationDescription</a>({ ...params }) -> Airtop.AutomationOutput</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Update the description of a specific automation
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.automations.updateAutomationDescription({
+    description: "description",
+    id: "id",
+    orgId: "orgId",
 });
 ```
 
@@ -2485,7 +2575,7 @@ await client.sessions.list({
 <dl>
 <dd>
 
-**request:** `Airtop.SessionsListRequest`
+**request:** `Airtop.UpdateAutomationDescriptionInputBody`
 
 </dd>
 </dl>
@@ -2493,7 +2583,7 @@ await client.sessions.list({
 <dl>
 <dd>
 
-**requestOptions:** `Sessions.RequestOptions`
+**requestOptions:** `Automations.RequestOptions`
 
 </dd>
 </dl>
@@ -2504,10 +2594,25 @@ await client.sessions.list({
 </dl>
 </details>
 
-<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">create</a>({ ...params }) -> Airtop.SessionResponse</code></summary>
+<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">getAutomation</a>(automationId) -> Airtop.AutomationOutput</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
 <dl>
 <dd>
 
+Get a specific automation by ID
+
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -2517,7 +2622,7 @@ await client.sessions.list({
 <dd>
 
 ```typescript
-await client.sessions.create();
+await client.automations.getAutomation("automationId");
 ```
 
 </dd>
@@ -2533,7 +2638,7 @@ await client.sessions.create();
 <dl>
 <dd>
 
-**request:** `Airtop.SessionRestInputV1`
+**automationId:** `string` — ID of the automation to retrieve
 
 </dd>
 </dl>
@@ -2541,7 +2646,7 @@ await client.sessions.create();
 <dl>
 <dd>
 
-**requestOptions:** `Sessions.RequestOptions`
+**requestOptions:** `Automations.RequestOptions`
 
 </dd>
 </dl>
@@ -2552,7 +2657,7 @@ await client.sessions.create();
 </dl>
 </details>
 
-<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">getInfo</a>(id) -> Airtop.SessionResponse</code></summary>
+<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">deleteAutomation</a>(automationId) -> Airtop.DeleteAutomationOutputWrapperBody</code></summary>
 <dl>
 <dd>
 
@@ -2564,7 +2669,7 @@ await client.sessions.create();
 <dl>
 <dd>
 
-Get a session by ID
+Delete a specific automation
 
 </dd>
 </dl>
@@ -2580,7 +2685,7 @@ Get a session by ID
 <dd>
 
 ```typescript
-await client.sessions.getInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
+await client.automations.deleteAutomation("automationId");
 ```
 
 </dd>
@@ -2596,7 +2701,7 @@ await client.sessions.getInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
 <dl>
 <dd>
 
-**id:** `string` — Id of the session to get
+**automationId:** `string` — ID of the automation to delete
 
 </dd>
 </dl>
@@ -2604,7 +2709,7 @@ await client.sessions.getInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
 <dl>
 <dd>
 
-**requestOptions:** `Sessions.RequestOptions`
+**requestOptions:** `Automations.RequestOptions`
 
 </dd>
 </dl>
@@ -2615,7 +2720,9 @@ await client.sessions.getInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
 </dl>
 </details>
 
-<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">terminate</a>(id) -> void</code></summary>
+## Files
+
+<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">list</a>({ ...params }) -> Airtop.FilesResponse</code></summary>
 <dl>
 <dd>
 
@@ -2627,7 +2734,7 @@ await client.sessions.getInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
 <dl>
 <dd>
 
-Ends a session by ID. If a given session id does not exist within the organization, it is ignored.
+Get a list of files filtered by session ID
 
 </dd>
 </dl>
@@ -2643,7 +2750,10 @@ Ends a session by ID. If a given session id does not exist within the organizati
 <dd>
 
 ```typescript
-await client.sessions.terminate("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
+await client.files.list({
+    offset: 1,
+    limit: 10,
+});
 ```
 
 </dd>
@@ -2659,7 +2769,588 @@ await client.sessions.terminate("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
 <dl>
 <dd>
 
-**id:** `string` — ID of the session to delete.
+**request:** `Airtop.FilesListRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Files.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">create</a>({ ...params }) -> Airtop.EnvelopeCreateFileV1EnvelopeDefaultMeta</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.files.create({
+    fileName: "fileName",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Airtop.CreateFileRestInputV1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Files.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">get</a>(id) -> Airtop.EnvelopeGetFileV1EnvelopeDefaultMeta</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.files.get("id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` — ID of the file
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Files.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">delete</a>(id) -> void</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.files.delete("id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` — ID of the file
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Files.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## Profiles
+
+<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Delete profiles matching by id
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.profiles.delete();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Airtop.ProfilesDeleteRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Profiles.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## Requests
+
+<details><summary><code>client.requests.<a href="/src/api/resources/requests/client/Client.ts">getRequestStatus</a>(requestId) -> Airtop.RequestStatusResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestId:** `string` — The ID of the request to check.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Requests.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## Sessions
+
+<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">list</a>({ ...params }) -> Airtop.SessionsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get a paginated list of sessions filtered by ID or status
+Get a paginated list of sessions filtered by ID or status
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.sessions.list({
+    offset: 1,
+    limit: 10,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Airtop.SessionsListRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Sessions.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">create</a>({ ...params }) -> Airtop.SessionResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.sessions.create();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Airtop.SessionRestInputV1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Sessions.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">getInfo</a>(id) -> Airtop.SessionResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get a session by ID
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.sessions.getInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` — Id of the session to get
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Sessions.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">terminate</a>(id) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Ends a session by ID. If a given session id does not exist within the organization, it is ignored.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.sessions.terminate("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` — ID of the session to delete.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Sessions.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">events</a>(id, { ...params }) -> core.Stream<Airtop.SessionsEventsResponse></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get a session event stream for a given session ID
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+const response = await client.sessions.events("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", {
+    lastEventId: 0,
+    all: true,
+});
+for await (const item of response) {
+    console.log(item);
+}
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` — ID of the session to get status info for
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Airtop.SessionsEventsRequest`
 
 </dd>
 </dl>