@surgeapi/node 0.38.0 → 0.39.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.
@@ -2,8 +2,34 @@ import { APIResource } from "../core/resource.js";
2
2
  import * as ContactsAPI from "./contacts.js";
3
3
  import * as Shared from "./shared.js";
4
4
  import { APIPromise } from "../core/api-promise.js";
5
+ import { Cursor, type CursorParams, PagePromise } from "../core/pagination.js";
5
6
  import { RequestOptions } from "../internal/request-options.js";
6
7
  export declare class Recordings extends APIResource {
8
+ /**
9
+ * Retrieves a Recording object.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const recording = await client.recordings.retrieve(
14
+ * 'rec_01kfyc9dgdec1avkgs7tng8htg',
15
+ * );
16
+ * ```
17
+ */
18
+ retrieve(id: string, options?: RequestOptions): APIPromise<RecordingRetrieveResponse>;
19
+ /**
20
+ * List all recordings for an account with cursor-based pagination.
21
+ *
22
+ * @example
23
+ * ```ts
24
+ * // Automatically fetches more pages as needed.
25
+ * for await (const recordingListResponse of client.recordings.list(
26
+ * 'acct_01j9a43avnfqzbjfch6pygv1td',
27
+ * )) {
28
+ * // ...
29
+ * }
30
+ * ```
31
+ */
32
+ list(accountID: string, query?: RecordingListParams | null | undefined, options?: RequestOptions): PagePromise<RecordingListResponsesCursor, RecordingListResponse>;
7
33
  /**
8
34
  * Deletes a recording. The recording file will be removed from storage
9
35
  * asynchronously.
@@ -29,6 +55,95 @@ export declare class Recordings extends APIResource {
29
55
  */
30
56
  getFile(recordingID: string, options?: RequestOptions): APIPromise<RecordingGetFileResponse>;
31
57
  }
58
+ export type RecordingListResponsesCursor = Cursor<RecordingListResponse>;
59
+ /**
60
+ * A call recording
61
+ */
62
+ export interface RecordingRetrieveResponse {
63
+ /**
64
+ * The unique identifier for the recording
65
+ */
66
+ id: string;
67
+ /**
68
+ * The call that produced this recording
69
+ */
70
+ call: RecordingRetrieveResponse.Call;
71
+ /**
72
+ * The duration of the recording in seconds
73
+ */
74
+ duration: number;
75
+ }
76
+ export declare namespace RecordingRetrieveResponse {
77
+ /**
78
+ * The call that produced this recording
79
+ */
80
+ interface Call {
81
+ /**
82
+ * The unique identifier for the call
83
+ */
84
+ id: string;
85
+ /**
86
+ * A contact who has consented to receive messages
87
+ */
88
+ contact: ContactsAPI.Contact;
89
+ /**
90
+ * The duration of the call in seconds
91
+ */
92
+ duration: number;
93
+ /**
94
+ * When the call was initiated
95
+ */
96
+ initiated_at: string;
97
+ /**
98
+ * The status of the call
99
+ */
100
+ status: 'busy' | 'canceled' | 'completed' | 'failed' | 'in_progress' | 'missed' | 'no_answer' | 'queued' | 'ringing';
101
+ }
102
+ }
103
+ /**
104
+ * A call recording
105
+ */
106
+ export interface RecordingListResponse {
107
+ /**
108
+ * The unique identifier for the recording
109
+ */
110
+ id: string;
111
+ /**
112
+ * The call that produced this recording
113
+ */
114
+ call: RecordingListResponse.Call;
115
+ /**
116
+ * The duration of the recording in seconds
117
+ */
118
+ duration: number;
119
+ }
120
+ export declare namespace RecordingListResponse {
121
+ /**
122
+ * The call that produced this recording
123
+ */
124
+ interface Call {
125
+ /**
126
+ * The unique identifier for the call
127
+ */
128
+ id: string;
129
+ /**
130
+ * A contact who has consented to receive messages
131
+ */
132
+ contact: ContactsAPI.Contact;
133
+ /**
134
+ * The duration of the call in seconds
135
+ */
136
+ duration: number;
137
+ /**
138
+ * When the call was initiated
139
+ */
140
+ initiated_at: string;
141
+ /**
142
+ * The status of the call
143
+ */
144
+ status: 'busy' | 'canceled' | 'completed' | 'failed' | 'in_progress' | 'missed' | 'no_answer' | 'queued' | 'ringing';
145
+ }
146
+ }
32
147
  /**
33
148
  * A call recording
34
149
  */
@@ -82,7 +197,9 @@ export interface RecordingGetFileResponse {
82
197
  */
83
198
  error: Shared.Error;
84
199
  }
200
+ export interface RecordingListParams extends CursorParams {
201
+ }
85
202
  export declare namespace Recordings {
86
- export { type RecordingDeleteResponse as RecordingDeleteResponse, type RecordingGetFileResponse as RecordingGetFileResponse, };
203
+ export { type RecordingRetrieveResponse as RecordingRetrieveResponse, type RecordingListResponse as RecordingListResponse, type RecordingDeleteResponse as RecordingDeleteResponse, type RecordingGetFileResponse as RecordingGetFileResponse, type RecordingListResponsesCursor as RecordingListResponsesCursor, type RecordingListParams as RecordingListParams, };
87
204
  }
88
205
  //# sourceMappingURL=recordings.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"recordings.d.ts","sourceRoot":"","sources":["../src/resources/recordings.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIjF;;;;;;;;;;OAUG;IACH,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG7F;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC;QAE7B;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,MAAM,EACF,MAAM,GACN,UAAU,GACV,WAAW,GACX,QAAQ,GACR,aAAa,GACb,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,SAAS,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
1
+ {"version":3,"file":"recordings.d.ts","sourceRoot":"","sources":["../src/resources/recordings.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE;OAC1C,EAAE,cAAc,EAAE;AAGzB,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAIrF;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,4BAA4B,EAAE,qBAAqB,CAAC;IAOnE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIjF;;;;;;;;;;OAUG;IACH,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG7F;AAED,MAAM,MAAM,4BAA4B,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;IAErC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC;QAE7B;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,MAAM,EACF,MAAM,GACN,UAAU,GACV,WAAW,GACX,QAAQ,GACR,aAAa,GACb,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,SAAS,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;IAEjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC;QAE7B;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,MAAM,EACF,MAAM,GACN,UAAU,GACV,WAAW,GACX,QAAQ,GACR,aAAa,GACb,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,SAAS,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC;QAE7B;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,MAAM,EACF,MAAM,GACN,UAAU,GACV,WAAW,GACX,QAAQ,GACR,aAAa,GACb,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,SAAS,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;CACrB;AAED,MAAM,WAAW,mBAAoB,SAAQ,YAAY;CAAG;AAE5D,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
@@ -3,8 +3,41 @@
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.Recordings = void 0;
5
5
  const resource_1 = require("../core/resource.js");
6
+ const pagination_1 = require("../core/pagination.js");
6
7
  const path_1 = require("../internal/utils/path.js");
7
8
  class Recordings extends resource_1.APIResource {
9
+ /**
10
+ * Retrieves a Recording object.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const recording = await client.recordings.retrieve(
15
+ * 'rec_01kfyc9dgdec1avkgs7tng8htg',
16
+ * );
17
+ * ```
18
+ */
19
+ retrieve(id, options) {
20
+ return this._client.get((0, path_1.path) `/recordings/${id}`, options);
21
+ }
22
+ /**
23
+ * List all recordings for an account with cursor-based pagination.
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * // Automatically fetches more pages as needed.
28
+ * for await (const recordingListResponse of client.recordings.list(
29
+ * 'acct_01j9a43avnfqzbjfch6pygv1td',
30
+ * )) {
31
+ * // ...
32
+ * }
33
+ * ```
34
+ */
35
+ list(accountID, query = {}, options) {
36
+ return this._client.getAPIList((0, path_1.path) `/accounts/${accountID}/recordings`, (pagination_1.Cursor), {
37
+ query,
38
+ ...options,
39
+ });
40
+ }
8
41
  /**
9
42
  * Deletes a recording. The recording file will be removed from storage
10
43
  * asynchronously.
@@ -1 +1 @@
1
- {"version":3,"file":"recordings.js","sourceRoot":"","sources":["../src/resources/recordings.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAK/C,oDAA8C;AAE9C,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,WAAmB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,WAAW,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF;AA9BD,gCA8BC"}
1
+ {"version":3,"file":"recordings.js","sourceRoot":"","sources":["../src/resources/recordings.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAA4E;AAE5E,oDAA8C;AAE9C,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAiB,EACjB,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,aAAa,EAAE,CAAA,mBAA6B,CAAA,EAAE;YACrG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,WAAmB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,WAAW,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF;AApED,gCAoEC"}
@@ -1,7 +1,40 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
  import { APIResource } from "../core/resource.mjs";
3
+ import { Cursor } from "../core/pagination.mjs";
3
4
  import { path } from "../internal/utils/path.mjs";
4
5
  export class Recordings extends APIResource {
6
+ /**
7
+ * Retrieves a Recording object.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const recording = await client.recordings.retrieve(
12
+ * 'rec_01kfyc9dgdec1avkgs7tng8htg',
13
+ * );
14
+ * ```
15
+ */
16
+ retrieve(id, options) {
17
+ return this._client.get(path `/recordings/${id}`, options);
18
+ }
19
+ /**
20
+ * List all recordings for an account with cursor-based pagination.
21
+ *
22
+ * @example
23
+ * ```ts
24
+ * // Automatically fetches more pages as needed.
25
+ * for await (const recordingListResponse of client.recordings.list(
26
+ * 'acct_01j9a43avnfqzbjfch6pygv1td',
27
+ * )) {
28
+ * // ...
29
+ * }
30
+ * ```
31
+ */
32
+ list(accountID, query = {}, options) {
33
+ return this._client.getAPIList(path `/accounts/${accountID}/recordings`, (Cursor), {
34
+ query,
35
+ ...options,
36
+ });
37
+ }
5
38
  /**
6
39
  * Deletes a recording. The recording file will be removed from storage
7
40
  * asynchronously.
@@ -1 +1 @@
1
- {"version":3,"file":"recordings.mjs","sourceRoot":"","sources":["../src/resources/recordings.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,WAAmB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,WAAW,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF"}
1
+ {"version":3,"file":"recordings.mjs","sourceRoot":"","sources":["../src/resources/recordings.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,MAAM,EAAkC;OAE1C,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAiB,EACjB,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,aAAa,SAAS,aAAa,EAAE,CAAA,MAA6B,CAAA,EAAE;YACrG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,WAAmB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,WAAW,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF"}
@@ -1,5 +1,6 @@
1
1
  import { APIResource } from "../core/resource.mjs";
2
2
  import { APIPromise } from "../core/api-promise.mjs";
3
+ import { Cursor, type CursorParams, PagePromise } from "../core/pagination.mjs";
3
4
  import { RequestOptions } from "../internal/request-options.mjs";
4
5
  export declare class Users extends APIResource {
5
6
  /**
@@ -37,6 +38,20 @@ export declare class Users extends APIResource {
37
38
  * ```
38
39
  */
39
40
  update(id: string, body: UserUpdateParams, options?: RequestOptions): APIPromise<User>;
41
+ /**
42
+ * List all users for an account with cursor-based pagination.
43
+ *
44
+ * @example
45
+ * ```ts
46
+ * // Automatically fetches more pages as needed.
47
+ * for await (const user of client.users.list(
48
+ * 'acct_01j9a43avnfqzbjfch6pygv1td',
49
+ * )) {
50
+ * // ...
51
+ * }
52
+ * ```
53
+ */
54
+ list(accountID: string, query?: UserListParams | null | undefined, options?: RequestOptions): PagePromise<UsersCursor, User>;
40
55
  /**
41
56
  * Deletes a user.
42
57
  *
@@ -65,6 +80,7 @@ export declare class Users extends APIResource {
65
80
  */
66
81
  createToken(userID: string, body: UserCreateTokenParams, options?: RequestOptions): APIPromise<UserTokenResponse>;
67
82
  }
83
+ export type UsersCursor = Cursor<User>;
68
84
  /**
69
85
  * A user of the app
70
86
  */
@@ -141,6 +157,8 @@ export interface UserUpdateParams {
141
157
  */
142
158
  photo_url?: string;
143
159
  }
160
+ export interface UserListParams extends CursorParams {
161
+ }
144
162
  export interface UserCreateTokenParams {
145
163
  /**
146
164
  * For how many seconds the token should be accepted. Defaults to 15 minutes.
@@ -148,6 +166,6 @@ export interface UserCreateTokenParams {
148
166
  duration_seconds?: number;
149
167
  }
150
168
  export declare namespace Users {
151
- export { type User as User, type UserTokenResponse as UserTokenResponse, type UserCreateParams as UserCreateParams, type UserUpdateParams as UserUpdateParams, type UserCreateTokenParams as UserCreateTokenParams, };
169
+ export { type User as User, type UserTokenResponse as UserTokenResponse, type UsersCursor as UsersCursor, type UserCreateParams as UserCreateParams, type UserUpdateParams as UserUpdateParams, type UserListParams as UserListParams, type UserCreateTokenParams as UserCreateTokenParams, };
152
170
  }
153
171
  //# sourceMappingURL=users.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"users.d.mts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAI7F;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAIhE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAItF;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAI9D;;;;;;;;;;OAUG;IACH,WAAW,CACT,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;CAGjC;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
1
+ {"version":3,"file":"users.d.mts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE;OAC1C,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAI7F;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAIhE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAItF;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,WAAW,EAAE,IAAI,CAAC;IAIjC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAI9D;;;;;;;;;;OAUG;IACH,WAAW,CACT,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;CAGjC;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAe,SAAQ,YAAY;CAAG;AAEvD,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
@@ -1,5 +1,6 @@
1
1
  import { APIResource } from "../core/resource.js";
2
2
  import { APIPromise } from "../core/api-promise.js";
3
+ import { Cursor, type CursorParams, PagePromise } from "../core/pagination.js";
3
4
  import { RequestOptions } from "../internal/request-options.js";
4
5
  export declare class Users extends APIResource {
5
6
  /**
@@ -37,6 +38,20 @@ export declare class Users extends APIResource {
37
38
  * ```
38
39
  */
39
40
  update(id: string, body: UserUpdateParams, options?: RequestOptions): APIPromise<User>;
41
+ /**
42
+ * List all users for an account with cursor-based pagination.
43
+ *
44
+ * @example
45
+ * ```ts
46
+ * // Automatically fetches more pages as needed.
47
+ * for await (const user of client.users.list(
48
+ * 'acct_01j9a43avnfqzbjfch6pygv1td',
49
+ * )) {
50
+ * // ...
51
+ * }
52
+ * ```
53
+ */
54
+ list(accountID: string, query?: UserListParams | null | undefined, options?: RequestOptions): PagePromise<UsersCursor, User>;
40
55
  /**
41
56
  * Deletes a user.
42
57
  *
@@ -65,6 +80,7 @@ export declare class Users extends APIResource {
65
80
  */
66
81
  createToken(userID: string, body: UserCreateTokenParams, options?: RequestOptions): APIPromise<UserTokenResponse>;
67
82
  }
83
+ export type UsersCursor = Cursor<User>;
68
84
  /**
69
85
  * A user of the app
70
86
  */
@@ -141,6 +157,8 @@ export interface UserUpdateParams {
141
157
  */
142
158
  photo_url?: string;
143
159
  }
160
+ export interface UserListParams extends CursorParams {
161
+ }
144
162
  export interface UserCreateTokenParams {
145
163
  /**
146
164
  * For how many seconds the token should be accepted. Defaults to 15 minutes.
@@ -148,6 +166,6 @@ export interface UserCreateTokenParams {
148
166
  duration_seconds?: number;
149
167
  }
150
168
  export declare namespace Users {
151
- export { type User as User, type UserTokenResponse as UserTokenResponse, type UserCreateParams as UserCreateParams, type UserUpdateParams as UserUpdateParams, type UserCreateTokenParams as UserCreateTokenParams, };
169
+ export { type User as User, type UserTokenResponse as UserTokenResponse, type UsersCursor as UsersCursor, type UserCreateParams as UserCreateParams, type UserUpdateParams as UserUpdateParams, type UserListParams as UserListParams, type UserCreateTokenParams as UserCreateTokenParams, };
152
170
  }
153
171
  //# sourceMappingURL=users.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAI7F;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAIhE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAItF;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAI9D;;;;;;;;;;OAUG;IACH,WAAW,CACT,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;CAGjC;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
1
+ {"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE;OAC1C,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAI7F;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAIhE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAItF;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,WAAW,EAAE,IAAI,CAAC;IAIjC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAI9D;;;;;;;;;;OAUG;IACH,WAAW,CACT,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;CAGjC;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAe,SAAQ,YAAY;CAAG;AAEvD,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
@@ -3,6 +3,7 @@
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.Users = void 0;
5
5
  const resource_1 = require("../core/resource.js");
6
+ const pagination_1 = require("../core/pagination.js");
6
7
  const path_1 = require("../internal/utils/path.js");
7
8
  class Users extends resource_1.APIResource {
8
9
  /**
@@ -46,6 +47,22 @@ class Users extends resource_1.APIResource {
46
47
  update(id, body, options) {
47
48
  return this._client.patch((0, path_1.path) `/users/${id}`, { body, ...options });
48
49
  }
50
+ /**
51
+ * List all users for an account with cursor-based pagination.
52
+ *
53
+ * @example
54
+ * ```ts
55
+ * // Automatically fetches more pages as needed.
56
+ * for await (const user of client.users.list(
57
+ * 'acct_01j9a43avnfqzbjfch6pygv1td',
58
+ * )) {
59
+ * // ...
60
+ * }
61
+ * ```
62
+ */
63
+ list(accountID, query = {}, options) {
64
+ return this._client.getAPIList((0, path_1.path) `/accounts/${accountID}/users`, (pagination_1.Cursor), { query, ...options });
65
+ }
49
66
  /**
50
67
  * Deletes a user.
51
68
  *
@@ -1 +1 @@
1
- {"version":3,"file":"users.js","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAsB,EAAE,OAAwB;QACxE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,IAAsB,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,UAAU,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CACT,MAAc,EACd,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AAjFD,sBAiFC"}
1
+ {"version":3,"file":"users.js","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAA4E;AAE5E,oDAA8C;AAE9C,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAsB,EAAE,OAAwB;QACxE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,IAAsB,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,UAAU,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAiB,EACjB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,QAAQ,EAAE,CAAA,mBAAY,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CACT,MAAc,EACd,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AAtGD,sBAsGC"}
@@ -1,5 +1,6 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
  import { APIResource } from "../core/resource.mjs";
3
+ import { Cursor } from "../core/pagination.mjs";
3
4
  import { path } from "../internal/utils/path.mjs";
4
5
  export class Users extends APIResource {
5
6
  /**
@@ -43,6 +44,22 @@ export class Users extends APIResource {
43
44
  update(id, body, options) {
44
45
  return this._client.patch(path `/users/${id}`, { body, ...options });
45
46
  }
47
+ /**
48
+ * List all users for an account with cursor-based pagination.
49
+ *
50
+ * @example
51
+ * ```ts
52
+ * // Automatically fetches more pages as needed.
53
+ * for await (const user of client.users.list(
54
+ * 'acct_01j9a43avnfqzbjfch6pygv1td',
55
+ * )) {
56
+ * // ...
57
+ * }
58
+ * ```
59
+ */
60
+ list(accountID, query = {}, options) {
61
+ return this._client.getAPIList(path `/accounts/${accountID}/users`, (Cursor), { query, ...options });
62
+ }
46
63
  /**
47
64
  * Deletes a user.
48
65
  *
@@ -1 +1 @@
1
- {"version":3,"file":"users.mjs","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAsB,EAAE,OAAwB;QACxE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,SAAS,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,IAAsB,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,UAAU,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CACT,MAAc,EACd,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,UAAU,MAAM,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF"}
1
+ {"version":3,"file":"users.mjs","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,MAAM,EAAkC;OAE1C,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAsB,EAAE,OAAwB;QACxE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,SAAS,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,IAAsB,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,UAAU,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAiB,EACjB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,aAAa,SAAS,QAAQ,EAAE,CAAA,MAAY,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CACT,MAAc,EACd,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,UAAU,MAAM,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF"}
package/src/client.ts CHANGED
@@ -58,14 +58,24 @@ import {
58
58
  PhoneNumbers,
59
59
  PhoneNumbersCursor,
60
60
  } from './resources/phone-numbers';
61
- import { RecordingDeleteResponse, RecordingGetFileResponse, Recordings } from './resources/recordings';
61
+ import {
62
+ RecordingDeleteResponse,
63
+ RecordingGetFileResponse,
64
+ RecordingListParams,
65
+ RecordingListResponse,
66
+ RecordingListResponsesCursor,
67
+ RecordingRetrieveResponse,
68
+ Recordings,
69
+ } from './resources/recordings';
62
70
  import {
63
71
  User,
64
72
  UserCreateParams,
65
73
  UserCreateTokenParams,
74
+ UserListParams,
66
75
  UserTokenResponse,
67
76
  UserUpdateParams,
68
77
  Users,
78
+ UsersCursor,
69
79
  } from './resources/users';
70
80
  import {
71
81
  Verification,
@@ -899,16 +909,22 @@ export declare namespace Surge {
899
909
 
900
910
  export {
901
911
  Recordings as Recordings,
912
+ type RecordingRetrieveResponse as RecordingRetrieveResponse,
913
+ type RecordingListResponse as RecordingListResponse,
902
914
  type RecordingDeleteResponse as RecordingDeleteResponse,
903
915
  type RecordingGetFileResponse as RecordingGetFileResponse,
916
+ type RecordingListResponsesCursor as RecordingListResponsesCursor,
917
+ type RecordingListParams as RecordingListParams,
904
918
  };
905
919
 
906
920
  export {
907
921
  Users as Users,
908
922
  type User as User,
909
923
  type UserTokenResponse as UserTokenResponse,
924
+ type UsersCursor as UsersCursor,
910
925
  type UserCreateParams as UserCreateParams,
911
926
  type UserUpdateParams as UserUpdateParams,
927
+ type UserListParams as UserListParams,
912
928
  type UserCreateTokenParams as UserCreateTokenParams,
913
929
  };
914
930
 
@@ -40,14 +40,24 @@ export {
40
40
  type PhoneNumberPurchaseParams,
41
41
  type PhoneNumbersCursor,
42
42
  } from './phone-numbers';
43
- export { Recordings, type RecordingDeleteResponse, type RecordingGetFileResponse } from './recordings';
43
+ export {
44
+ Recordings,
45
+ type RecordingRetrieveResponse,
46
+ type RecordingListResponse,
47
+ type RecordingDeleteResponse,
48
+ type RecordingGetFileResponse,
49
+ type RecordingListParams,
50
+ type RecordingListResponsesCursor,
51
+ } from './recordings';
44
52
  export {
45
53
  Users,
46
54
  type User,
47
55
  type UserTokenResponse,
48
56
  type UserCreateParams,
49
57
  type UserUpdateParams,
58
+ type UserListParams,
50
59
  type UserCreateTokenParams,
60
+ type UsersCursor,
51
61
  } from './users';
52
62
  export {
53
63
  Verifications,