@onkernel/sdk 0.81.0 → 0.83.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/client.d.mts +2 -2
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +2 -2
  5. package/client.d.ts.map +1 -1
  6. package/client.js.map +1 -1
  7. package/client.mjs +1 -1
  8. package/client.mjs.map +1 -1
  9. package/package.json +1 -1
  10. package/resources/auth/connections.d.mts +217 -0
  11. package/resources/auth/connections.d.mts.map +1 -1
  12. package/resources/auth/connections.d.ts +217 -0
  13. package/resources/auth/connections.d.ts.map +1 -1
  14. package/resources/auth/connections.js.map +1 -1
  15. package/resources/auth/connections.mjs.map +1 -1
  16. package/resources/index.d.mts +1 -1
  17. package/resources/index.d.mts.map +1 -1
  18. package/resources/index.d.ts +1 -1
  19. package/resources/index.d.ts.map +1 -1
  20. package/resources/index.js.map +1 -1
  21. package/resources/index.mjs.map +1 -1
  22. package/resources/profiles.d.mts +13 -3
  23. package/resources/profiles.d.mts.map +1 -1
  24. package/resources/profiles.d.ts +13 -3
  25. package/resources/profiles.d.ts.map +1 -1
  26. package/resources/profiles.js +6 -2
  27. package/resources/profiles.js.map +1 -1
  28. package/resources/profiles.mjs +6 -2
  29. package/resources/profiles.mjs.map +1 -1
  30. package/resources/projects/projects.d.mts +4 -4
  31. package/resources/projects/projects.d.ts +4 -4
  32. package/src/client.ts +8 -1
  33. package/src/resources/auth/connections.ts +235 -0
  34. package/src/resources/index.ts +1 -0
  35. package/src/resources/profiles.ts +19 -2
  36. package/src/resources/projects/projects.ts +4 -4
  37. package/src/version.ts +1 -1
  38. package/version.d.mts +1 -1
  39. package/version.d.ts +1 -1
  40. package/version.js +1 -1
  41. package/version.mjs +1 -1
@@ -1 +1 @@
1
- {"version":3,"file":"profiles.mjs","sourceRoot":"","sources":["../src/resources/profiles.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,gBAAgB,EAA4C,+BAA2B;AAChG,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,QAAgB,EAChB,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,aAAa,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,gBAAqC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,QAAQ,EAAE,EAAE;YACtD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,QAAQ,WAAW,EAAE;YAC5D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,0BAA0B,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YACjF,gBAAgB,EAAE,IAAI;SACvB,CAAC,CAAC;IACL,CAAC;CACF"}
1
+ {"version":3,"file":"profiles.mjs","sourceRoot":"","sources":["../src/resources/profiles.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,gBAAgB,EAA4C,+BAA2B;AAChG,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,QAAgB,EAChB,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,aAAa,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,gBAAqC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,QAAQ,EAAE,EAAE;YACtD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CACN,QAAgB,EAChB,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,QAAQ,WAAW,EAAE;YAC5D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,0BAA0B,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YACjF,gBAAgB,EAAE,IAAI;SACvB,CAAC,CAAC;IACL,CAAC;CACF"}
@@ -63,7 +63,7 @@ export declare class Projects extends APIResource {
63
63
  export type ProjectsOffsetPagination = OffsetPagination<Project>;
64
64
  export interface CreateProjectRequest {
65
65
  /**
66
- * Project name (1-255 characters)
66
+ * Project name (1-255 Unicode code points)
67
67
  */
68
68
  name: string;
69
69
  }
@@ -91,7 +91,7 @@ export interface Project {
91
91
  }
92
92
  export interface UpdateProjectRequest {
93
93
  /**
94
- * New project name
94
+ * New project name (1-255 Unicode code points)
95
95
  */
96
96
  name?: string;
97
97
  /**
@@ -101,13 +101,13 @@ export interface UpdateProjectRequest {
101
101
  }
102
102
  export interface ProjectCreateParams {
103
103
  /**
104
- * Project name (1-255 characters)
104
+ * Project name (1-255 Unicode code points)
105
105
  */
106
106
  name: string;
107
107
  }
108
108
  export interface ProjectUpdateParams {
109
109
  /**
110
- * New project name
110
+ * New project name (1-255 Unicode code points)
111
111
  */
112
112
  name?: string;
113
113
  /**
@@ -63,7 +63,7 @@ export declare class Projects extends APIResource {
63
63
  export type ProjectsOffsetPagination = OffsetPagination<Project>;
64
64
  export interface CreateProjectRequest {
65
65
  /**
66
- * Project name (1-255 characters)
66
+ * Project name (1-255 Unicode code points)
67
67
  */
68
68
  name: string;
69
69
  }
@@ -91,7 +91,7 @@ export interface Project {
91
91
  }
92
92
  export interface UpdateProjectRequest {
93
93
  /**
94
- * New project name
94
+ * New project name (1-255 Unicode code points)
95
95
  */
96
96
  name?: string;
97
97
  /**
@@ -101,13 +101,13 @@ export interface UpdateProjectRequest {
101
101
  }
102
102
  export interface ProjectCreateParams {
103
103
  /**
104
- * Project name (1-255 characters)
104
+ * Project name (1-255 Unicode code points)
105
105
  */
106
106
  name: string;
107
107
  }
108
108
  export interface ProjectUpdateParams {
109
109
  /**
110
- * New project name
110
+ * New project name (1-255 Unicode code points)
111
111
  */
112
112
  name?: string;
113
113
  /**
package/src/client.ts CHANGED
@@ -123,7 +123,13 @@ import {
123
123
  InvocationUpdateResponse,
124
124
  Invocations,
125
125
  } from './resources/invocations';
126
- import { ProfileCreateParams, ProfileListParams, ProfileUpdateParams, Profiles } from './resources/profiles';
126
+ import {
127
+ ProfileCreateParams,
128
+ ProfileDownloadParams,
129
+ ProfileListParams,
130
+ ProfileUpdateParams,
131
+ Profiles,
132
+ } from './resources/profiles';
127
133
  import {
128
134
  Proxies,
129
135
  ProxyCheckParams,
@@ -1126,6 +1132,7 @@ export declare namespace Kernel {
1126
1132
  type ProfileCreateParams as ProfileCreateParams,
1127
1133
  type ProfileUpdateParams as ProfileUpdateParams,
1128
1134
  type ProfileListParams as ProfileListParams,
1135
+ type ProfileDownloadParams as ProfileDownloadParams,
1129
1136
  };
1130
1137
 
1131
1138
  export { Auth as Auth };
@@ -2,6 +2,7 @@
2
2
 
3
3
  import { APIResource } from '../../core/resource';
4
4
  import * as Shared from '../shared';
5
+ import * as TelemetryAPI from '../browsers/telemetry';
5
6
  import { APIPromise } from '../../core/api-promise';
6
7
  import { OffsetPagination, type OffsetPaginationParams, PagePromise } from '../../core/pagination';
7
8
  import { Stream } from '../../core/streaming';
@@ -297,6 +298,13 @@ export interface ManagedAuth {
297
298
  */
298
299
  browser_session_id?: string | null;
299
300
 
301
+ /**
302
+ * Browser telemetry configuration used by this connection's browser sessions by
303
+ * default. The exact create-browser configuration is preserved and can be
304
+ * overridden per-login.
305
+ */
306
+ browser_telemetry?: ManagedAuth.BrowserTelemetry | null;
307
+
300
308
  /**
301
309
  * Whether Kernel can automatically re-authenticate this connection when the
302
310
  * session expires. Requires a prior successful login plus either a Kernel
@@ -515,6 +523,38 @@ export interface ManagedAuth {
515
523
  }
516
524
 
517
525
  export namespace ManagedAuth {
526
+ /**
527
+ * Browser telemetry configuration used by this connection's browser sessions by
528
+ * default. The exact create-browser configuration is preserved and can be
529
+ * overridden per-login.
530
+ */
531
+ export interface BrowserTelemetry {
532
+ /**
533
+ * Per-category capture flags. The operational categories (control, connection,
534
+ * system, captcha) are captured whenever telemetry is enabled; set one to
535
+ * enabled=false to opt out. The CDP categories (console, network, page,
536
+ * interaction) and screenshot are off by default; set enabled=true to opt in. On
537
+ * create, provided categories layer onto the default set. On update, provided
538
+ * categories merge onto the session's current config; when no telemetry is active
539
+ * this falls back to the default set (matching create). If browser is omitted or
540
+ * empty, the default set is used. A browser config that disables every category
541
+ * stops capture on update and starts no capture on create.
542
+ */
543
+ browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
544
+
545
+ /**
546
+ * Request shortcut for browser telemetry capture. True enables capture; with no
547
+ * browser category settings it captures the default set (control, connection,
548
+ * system, captcha), and any browser category settings are layered onto that
549
+ * default set. On update, enabled=true resolves the config fresh from the default
550
+ * set plus any provided categories, replacing the session's current selection
551
+ * rather than merging onto it; omit enabled to merge categories onto the current
552
+ * selection instead. False stops capture on update and starts no capture on
553
+ * create. enabled=false cannot be combined with browser category settings.
554
+ */
555
+ enabled?: boolean;
556
+ }
557
+
518
558
  /**
519
559
  * Canonical auth-flow choice awaiting user selection.
520
560
  */
@@ -780,6 +820,13 @@ export interface ManagedAuthCreateRequest {
780
820
  */
781
821
  auto_reauth?: boolean;
782
822
 
823
+ /**
824
+ * Browser telemetry configuration used by this connection's browser sessions by
825
+ * default. Uses the exact create-browser configuration. Can be overridden
826
+ * per-login.
827
+ */
828
+ browser_telemetry?: ManagedAuthCreateRequest.BrowserTelemetry | null;
829
+
783
830
  /**
784
831
  * Reference to credentials for the auth connection. Use one of:
785
832
  *
@@ -833,6 +880,38 @@ export interface ManagedAuthCreateRequest {
833
880
  }
834
881
 
835
882
  export namespace ManagedAuthCreateRequest {
883
+ /**
884
+ * Browser telemetry configuration used by this connection's browser sessions by
885
+ * default. Uses the exact create-browser configuration. Can be overridden
886
+ * per-login.
887
+ */
888
+ export interface BrowserTelemetry {
889
+ /**
890
+ * Per-category capture flags. The operational categories (control, connection,
891
+ * system, captcha) are captured whenever telemetry is enabled; set one to
892
+ * enabled=false to opt out. The CDP categories (console, network, page,
893
+ * interaction) and screenshot are off by default; set enabled=true to opt in. On
894
+ * create, provided categories layer onto the default set. On update, provided
895
+ * categories merge onto the session's current config; when no telemetry is active
896
+ * this falls back to the default set (matching create). If browser is omitted or
897
+ * empty, the default set is used. A browser config that disables every category
898
+ * stops capture on update and starts no capture on create.
899
+ */
900
+ browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
901
+
902
+ /**
903
+ * Request shortcut for browser telemetry capture. True enables capture; with no
904
+ * browser category settings it captures the default set (control, connection,
905
+ * system, captcha), and any browser category settings are layered onto that
906
+ * default set. On update, enabled=true resolves the config fresh from the default
907
+ * set plus any provided categories, replacing the session's current selection
908
+ * rather than merging onto it; omit enabled to merge categories onto the current
909
+ * selection instead. False stops capture on update and starts no capture on
910
+ * create. enabled=false cannot be combined with browser category settings.
911
+ */
912
+ enabled?: boolean;
913
+ }
914
+
836
915
  /**
837
916
  * Reference to credentials for the auth connection. Use one of:
838
917
  *
@@ -981,6 +1060,13 @@ export interface ManagedAuthUpdateRequest {
981
1060
  */
982
1061
  auto_reauth?: boolean;
983
1062
 
1063
+ /**
1064
+ * Browser telemetry configuration used by future browser sessions for this
1065
+ * connection. Uses the exact create-browser configuration. Set enabled to false to
1066
+ * disable telemetry.
1067
+ */
1068
+ browser_telemetry?: ManagedAuthUpdateRequest.BrowserTelemetry | null;
1069
+
984
1070
  /**
985
1071
  * Reference to credentials for the auth connection. Use one of:
986
1072
  *
@@ -1028,6 +1114,38 @@ export interface ManagedAuthUpdateRequest {
1028
1114
  }
1029
1115
 
1030
1116
  export namespace ManagedAuthUpdateRequest {
1117
+ /**
1118
+ * Browser telemetry configuration used by future browser sessions for this
1119
+ * connection. Uses the exact create-browser configuration. Set enabled to false to
1120
+ * disable telemetry.
1121
+ */
1122
+ export interface BrowserTelemetry {
1123
+ /**
1124
+ * Per-category capture flags. The operational categories (control, connection,
1125
+ * system, captcha) are captured whenever telemetry is enabled; set one to
1126
+ * enabled=false to opt out. The CDP categories (console, network, page,
1127
+ * interaction) and screenshot are off by default; set enabled=true to opt in. On
1128
+ * create, provided categories layer onto the default set. On update, provided
1129
+ * categories merge onto the session's current config; when no telemetry is active
1130
+ * this falls back to the default set (matching create). If browser is omitted or
1131
+ * empty, the default set is used. A browser config that disables every category
1132
+ * stops capture on update and starts no capture on create.
1133
+ */
1134
+ browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
1135
+
1136
+ /**
1137
+ * Request shortcut for browser telemetry capture. True enables capture; with no
1138
+ * browser category settings it captures the default set (control, connection,
1139
+ * system, captcha), and any browser category settings are layered onto that
1140
+ * default set. On update, enabled=true resolves the config fresh from the default
1141
+ * set plus any provided categories, replacing the session's current selection
1142
+ * rather than merging onto it; omit enabled to merge categories onto the current
1143
+ * selection instead. False stops capture on update and starts no capture on
1144
+ * create. enabled=false cannot be combined with browser category settings.
1145
+ */
1146
+ enabled?: boolean;
1147
+ }
1148
+
1031
1149
  /**
1032
1150
  * Reference to credentials for the auth connection. Use one of:
1033
1151
  *
@@ -1480,6 +1598,13 @@ export interface ConnectionCreateParams {
1480
1598
  */
1481
1599
  auto_reauth?: boolean;
1482
1600
 
1601
+ /**
1602
+ * Browser telemetry configuration used by this connection's browser sessions by
1603
+ * default. Uses the exact create-browser configuration. Can be overridden
1604
+ * per-login.
1605
+ */
1606
+ browser_telemetry?: ConnectionCreateParams.BrowserTelemetry | null;
1607
+
1483
1608
  /**
1484
1609
  * Reference to credentials for the auth connection. Use one of:
1485
1610
  *
@@ -1533,6 +1658,38 @@ export interface ConnectionCreateParams {
1533
1658
  }
1534
1659
 
1535
1660
  export namespace ConnectionCreateParams {
1661
+ /**
1662
+ * Browser telemetry configuration used by this connection's browser sessions by
1663
+ * default. Uses the exact create-browser configuration. Can be overridden
1664
+ * per-login.
1665
+ */
1666
+ export interface BrowserTelemetry {
1667
+ /**
1668
+ * Per-category capture flags. The operational categories (control, connection,
1669
+ * system, captcha) are captured whenever telemetry is enabled; set one to
1670
+ * enabled=false to opt out. The CDP categories (console, network, page,
1671
+ * interaction) and screenshot are off by default; set enabled=true to opt in. On
1672
+ * create, provided categories layer onto the default set. On update, provided
1673
+ * categories merge onto the session's current config; when no telemetry is active
1674
+ * this falls back to the default set (matching create). If browser is omitted or
1675
+ * empty, the default set is used. A browser config that disables every category
1676
+ * stops capture on update and starts no capture on create.
1677
+ */
1678
+ browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
1679
+
1680
+ /**
1681
+ * Request shortcut for browser telemetry capture. True enables capture; with no
1682
+ * browser category settings it captures the default set (control, connection,
1683
+ * system, captcha), and any browser category settings are layered onto that
1684
+ * default set. On update, enabled=true resolves the config fresh from the default
1685
+ * set plus any provided categories, replacing the session's current selection
1686
+ * rather than merging onto it; omit enabled to merge categories onto the current
1687
+ * selection instead. False stops capture on update and starts no capture on
1688
+ * create. enabled=false cannot be combined with browser category settings.
1689
+ */
1690
+ enabled?: boolean;
1691
+ }
1692
+
1536
1693
  /**
1537
1694
  * Reference to credentials for the auth connection. Use one of:
1538
1695
  *
@@ -1598,6 +1755,13 @@ export interface ConnectionUpdateParams {
1598
1755
  */
1599
1756
  auto_reauth?: boolean;
1600
1757
 
1758
+ /**
1759
+ * Browser telemetry configuration used by future browser sessions for this
1760
+ * connection. Uses the exact create-browser configuration. Set enabled to false to
1761
+ * disable telemetry.
1762
+ */
1763
+ browser_telemetry?: ConnectionUpdateParams.BrowserTelemetry | null;
1764
+
1601
1765
  /**
1602
1766
  * Reference to credentials for the auth connection. Use one of:
1603
1767
  *
@@ -1645,6 +1809,38 @@ export interface ConnectionUpdateParams {
1645
1809
  }
1646
1810
 
1647
1811
  export namespace ConnectionUpdateParams {
1812
+ /**
1813
+ * Browser telemetry configuration used by future browser sessions for this
1814
+ * connection. Uses the exact create-browser configuration. Set enabled to false to
1815
+ * disable telemetry.
1816
+ */
1817
+ export interface BrowserTelemetry {
1818
+ /**
1819
+ * Per-category capture flags. The operational categories (control, connection,
1820
+ * system, captcha) are captured whenever telemetry is enabled; set one to
1821
+ * enabled=false to opt out. The CDP categories (console, network, page,
1822
+ * interaction) and screenshot are off by default; set enabled=true to opt in. On
1823
+ * create, provided categories layer onto the default set. On update, provided
1824
+ * categories merge onto the session's current config; when no telemetry is active
1825
+ * this falls back to the default set (matching create). If browser is omitted or
1826
+ * empty, the default set is used. A browser config that disables every category
1827
+ * stops capture on update and starts no capture on create.
1828
+ */
1829
+ browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
1830
+
1831
+ /**
1832
+ * Request shortcut for browser telemetry capture. True enables capture; with no
1833
+ * browser category settings it captures the default set (control, connection,
1834
+ * system, captcha), and any browser category settings are layered onto that
1835
+ * default set. On update, enabled=true resolves the config fresh from the default
1836
+ * set plus any provided categories, replacing the session's current selection
1837
+ * rather than merging onto it; omit enabled to merge categories onto the current
1838
+ * selection instead. False stops capture on update and starts no capture on
1839
+ * create. enabled=false cannot be combined with browser category settings.
1840
+ */
1841
+ enabled?: boolean;
1842
+ }
1843
+
1648
1844
  /**
1649
1845
  * Reference to credentials for the auth connection. Use one of:
1650
1846
  *
@@ -1711,6 +1907,13 @@ export interface ConnectionListParams extends OffsetPaginationParams {
1711
1907
  }
1712
1908
 
1713
1909
  export interface ConnectionLoginParams {
1910
+ /**
1911
+ * Override the connection's default browser telemetry configuration for this
1912
+ * login. When omitted, the connection's browser_telemetry default is used. Uses
1913
+ * the exact create-browser configuration.
1914
+ */
1915
+ browser_telemetry?: ConnectionLoginParams.BrowserTelemetry | null;
1916
+
1714
1917
  /**
1715
1918
  * Proxy selection. Provide either id or name. The proxy must be in the same
1716
1919
  * project as the resource referencing it. When selecting by name, the name must
@@ -1727,6 +1930,38 @@ export interface ConnectionLoginParams {
1727
1930
  }
1728
1931
 
1729
1932
  export namespace ConnectionLoginParams {
1933
+ /**
1934
+ * Override the connection's default browser telemetry configuration for this
1935
+ * login. When omitted, the connection's browser_telemetry default is used. Uses
1936
+ * the exact create-browser configuration.
1937
+ */
1938
+ export interface BrowserTelemetry {
1939
+ /**
1940
+ * Per-category capture flags. The operational categories (control, connection,
1941
+ * system, captcha) are captured whenever telemetry is enabled; set one to
1942
+ * enabled=false to opt out. The CDP categories (console, network, page,
1943
+ * interaction) and screenshot are off by default; set enabled=true to opt in. On
1944
+ * create, provided categories layer onto the default set. On update, provided
1945
+ * categories merge onto the session's current config; when no telemetry is active
1946
+ * this falls back to the default set (matching create). If browser is omitted or
1947
+ * empty, the default set is used. A browser config that disables every category
1948
+ * stops capture on update and starts no capture on create.
1949
+ */
1950
+ browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
1951
+
1952
+ /**
1953
+ * Request shortcut for browser telemetry capture. True enables capture; with no
1954
+ * browser category settings it captures the default set (control, connection,
1955
+ * system, captcha), and any browser category settings are layered onto that
1956
+ * default set. On update, enabled=true resolves the config fresh from the default
1957
+ * set plus any provided categories, replacing the session's current selection
1958
+ * rather than merging onto it; omit enabled to merge categories onto the current
1959
+ * selection instead. False stops capture on update and starts no capture on
1960
+ * create. enabled=false cannot be combined with browser category settings.
1961
+ */
1962
+ enabled?: boolean;
1963
+ }
1964
+
1730
1965
  /**
1731
1966
  * Proxy selection. Provide either id or name. The proxy must be in the same
1732
1967
  * project as the resource referencing it. When selecting by name, the name must
@@ -125,6 +125,7 @@ export {
125
125
  type ProfileCreateParams,
126
126
  type ProfileUpdateParams,
127
127
  type ProfileListParams,
128
+ type ProfileDownloadParams,
128
129
  } from './profiles';
129
130
  export {
130
131
  Projects,
@@ -98,7 +98,10 @@ export class Profiles extends APIResource {
98
98
  }
99
99
 
100
100
  /**
101
- * Returns a zstd-compressed tar file of the full user-data directory.
101
+ * Downloads the profile in its stored format by default. Current profiles are
102
+ * returned as zstd-compressed tar archives, while legacy profiles remain JSON. Set
103
+ * `format=tar` to decompress current profiles during download; legacy profiles
104
+ * remain JSON.
102
105
  *
103
106
  * @example
104
107
  * ```ts
@@ -110,8 +113,13 @@ export class Profiles extends APIResource {
110
113
  * console.log(content);
111
114
  * ```
112
115
  */
113
- download(idOrName: string, options?: RequestOptions): APIPromise<Response> {
116
+ download(
117
+ idOrName: string,
118
+ query: ProfileDownloadParams | null | undefined = {},
119
+ options?: RequestOptions,
120
+ ): APIPromise<Response> {
114
121
  return this._client.get(path`/profiles/${idOrName}/download`, {
122
+ query,
115
123
  ...options,
116
124
  headers: buildHeaders([{ Accept: 'application/octet-stream' }, options?.headers]),
117
125
  __binaryResponse: true,
@@ -152,11 +160,20 @@ export interface ProfileListParams extends OffsetPaginationParams {
152
160
  query?: string;
153
161
  }
154
162
 
163
+ export interface ProfileDownloadParams {
164
+ /**
165
+ * Response format for current profile archives. Legacy profiles are always
166
+ * returned as JSON.
167
+ */
168
+ format?: 'tar.zst' | 'tar';
169
+ }
170
+
155
171
  export declare namespace Profiles {
156
172
  export {
157
173
  type ProfileCreateParams as ProfileCreateParams,
158
174
  type ProfileUpdateParams as ProfileUpdateParams,
159
175
  type ProfileListParams as ProfileListParams,
176
+ type ProfileDownloadParams as ProfileDownloadParams,
160
177
  };
161
178
  }
162
179
 
@@ -91,7 +91,7 @@ export type ProjectsOffsetPagination = OffsetPagination<Project>;
91
91
 
92
92
  export interface CreateProjectRequest {
93
93
  /**
94
- * Project name (1-255 characters)
94
+ * Project name (1-255 Unicode code points)
95
95
  */
96
96
  name: string;
97
97
  }
@@ -125,7 +125,7 @@ export interface Project {
125
125
 
126
126
  export interface UpdateProjectRequest {
127
127
  /**
128
- * New project name
128
+ * New project name (1-255 Unicode code points)
129
129
  */
130
130
  name?: string;
131
131
 
@@ -137,14 +137,14 @@ export interface UpdateProjectRequest {
137
137
 
138
138
  export interface ProjectCreateParams {
139
139
  /**
140
- * Project name (1-255 characters)
140
+ * Project name (1-255 Unicode code points)
141
141
  */
142
142
  name: string;
143
143
  }
144
144
 
145
145
  export interface ProjectUpdateParams {
146
146
  /**
147
- * New project name
147
+ * New project name (1-255 Unicode code points)
148
148
  */
149
149
  name?: string;
150
150
 
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.81.0'; // x-release-please-version
1
+ export const VERSION = '0.83.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.81.0";
1
+ export declare const VERSION = "0.83.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.81.0";
1
+ export declare const VERSION = "0.83.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.81.0'; // x-release-please-version
4
+ exports.VERSION = '0.83.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.81.0'; // x-release-please-version
1
+ export const VERSION = '0.83.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map