@37signals/basecamp 0.12.0 → 0.13.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.
- package/README.md +112 -16
- package/dist/.build-complete +0 -0
- package/dist/client.d.ts +53 -11
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +132 -150
- package/dist/client.js.map +1 -1
- package/dist/download.d.ts +7 -0
- package/dist/download.d.ts.map +1 -1
- package/dist/download.js +82 -22
- package/dist/download.js.map +1 -1
- package/dist/errors.d.ts +18 -0
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +127 -14
- package/dist/errors.js.map +1 -1
- package/dist/generated/metadata.d.ts.map +1 -1
- package/dist/generated/metadata.js +280 -141
- package/dist/generated/metadata.js.map +1 -1
- package/dist/generated/metadata.ts +280 -141
- package/dist/generated/openapi-stripped.json +6435 -4283
- package/dist/generated/path-mapping.d.ts.map +1 -1
- package/dist/generated/path-mapping.js +27 -16
- package/dist/generated/path-mapping.js.map +1 -1
- package/dist/generated/path-mapping.ts +27 -16
- package/dist/generated/schema.d.ts +4283 -2457
- package/dist/generated/services/bookmarks.d.ts +1 -1
- package/dist/generated/services/bookmarks.d.ts.map +1 -1
- package/dist/generated/services/bookmarks.ts +1 -1
- package/dist/generated/services/boosts.d.ts +10 -0
- package/dist/generated/services/boosts.d.ts.map +1 -1
- package/dist/generated/services/boosts.js +8 -0
- package/dist/generated/services/boosts.js.map +1 -1
- package/dist/generated/services/boosts.ts +12 -0
- package/dist/generated/services/campfires.d.ts +54 -40
- package/dist/generated/services/campfires.d.ts.map +1 -1
- package/dist/generated/services/campfires.js +82 -65
- package/dist/generated/services/campfires.js.map +1 -1
- package/dist/generated/services/campfires.ts +107 -85
- package/dist/generated/services/cards.d.ts +5 -0
- package/dist/generated/services/cards.d.ts.map +1 -1
- package/dist/generated/services/cards.js +4 -0
- package/dist/generated/services/cards.js.map +1 -1
- package/dist/generated/services/cards.ts +6 -0
- package/dist/generated/services/checkins.d.ts +14 -0
- package/dist/generated/services/checkins.d.ts.map +1 -1
- package/dist/generated/services/checkins.js +14 -1
- package/dist/generated/services/checkins.js.map +1 -1
- package/dist/generated/services/checkins.ts +20 -0
- package/dist/generated/services/client-approvals.d.ts +6 -3
- package/dist/generated/services/client-approvals.d.ts.map +1 -1
- package/dist/generated/services/client-approvals.js +8 -5
- package/dist/generated/services/client-approvals.js.map +1 -1
- package/dist/generated/services/client-approvals.ts +10 -5
- package/dist/generated/services/client-correspondences.d.ts +6 -3
- package/dist/generated/services/client-correspondences.d.ts.map +1 -1
- package/dist/generated/services/client-correspondences.js +8 -5
- package/dist/generated/services/client-correspondences.js.map +1 -1
- package/dist/generated/services/client-correspondences.ts +10 -5
- package/dist/generated/services/client-replies.d.ts +11 -4
- package/dist/generated/services/client-replies.d.ts.map +1 -1
- package/dist/generated/services/client-replies.js +16 -8
- package/dist/generated/services/client-replies.js.map +1 -1
- package/dist/generated/services/client-replies.ts +18 -8
- package/dist/generated/services/cloud-files.d.ts +92 -0
- package/dist/generated/services/cloud-files.d.ts.map +1 -0
- package/dist/generated/services/cloud-files.js +121 -0
- package/dist/generated/services/cloud-files.js.map +1 -0
- package/dist/generated/services/cloud-files.ts +188 -0
- package/dist/generated/services/comments.d.ts +5 -0
- package/dist/generated/services/comments.d.ts.map +1 -1
- package/dist/generated/services/comments.js +4 -0
- package/dist/generated/services/comments.js.map +1 -1
- package/dist/generated/services/comments.ts +6 -0
- package/dist/generated/services/documents.d.ts +12 -7
- package/dist/generated/services/documents.d.ts.map +1 -1
- package/dist/generated/services/documents.js +10 -6
- package/dist/generated/services/documents.js.map +1 -1
- package/dist/generated/services/documents.ts +14 -8
- package/dist/generated/services/drafts.d.ts +1 -1
- package/dist/generated/services/drafts.d.ts.map +1 -1
- package/dist/generated/services/drafts.ts +1 -1
- package/dist/generated/services/events.d.ts +5 -0
- package/dist/generated/services/events.d.ts.map +1 -1
- package/dist/generated/services/events.js +4 -0
- package/dist/generated/services/events.js.map +1 -1
- package/dist/generated/services/events.ts +6 -0
- package/dist/generated/services/everything.d.ts +14 -14
- package/dist/generated/services/everything.d.ts.map +1 -1
- package/dist/generated/services/everything.ts +14 -14
- package/dist/generated/services/folders.d.ts +96 -0
- package/dist/generated/services/folders.d.ts.map +1 -0
- package/dist/generated/services/folders.js +140 -0
- package/dist/generated/services/folders.js.map +1 -0
- package/dist/generated/services/folders.ts +201 -0
- package/dist/generated/services/forwards.d.ts +7 -20
- package/dist/generated/services/forwards.d.ts.map +1 -1
- package/dist/generated/services/forwards.js +6 -35
- package/dist/generated/services/forwards.js.map +1 -1
- package/dist/generated/services/forwards.ts +10 -48
- package/dist/generated/services/gauges.d.ts +7 -0
- package/dist/generated/services/gauges.d.ts.map +1 -1
- package/dist/generated/services/gauges.js +5 -1
- package/dist/generated/services/gauges.js.map +1 -1
- package/dist/generated/services/gauges.ts +9 -1
- package/dist/generated/services/google-documents.d.ts +98 -0
- package/dist/generated/services/google-documents.d.ts.map +1 -0
- package/dist/generated/services/google-documents.js +123 -0
- package/dist/generated/services/google-documents.js.map +1 -0
- package/dist/generated/services/google-documents.ts +196 -0
- package/dist/generated/services/index.d.ts +7 -4
- package/dist/generated/services/index.d.ts.map +1 -1
- package/dist/generated/services/index.js +7 -4
- package/dist/generated/services/index.js.map +1 -1
- package/dist/generated/services/index.ts +7 -4
- package/dist/generated/services/messages.d.ts +2 -0
- package/dist/generated/services/messages.d.ts.map +1 -1
- package/dist/generated/services/messages.js +1 -1
- package/dist/generated/services/messages.js.map +1 -1
- package/dist/generated/services/messages.ts +3 -1
- package/dist/generated/services/my-notes.d.ts +1 -1
- package/dist/generated/services/my-notes.js +1 -1
- package/dist/generated/services/my-notes.ts +1 -1
- package/dist/generated/services/my-notifications.d.ts +4 -2
- package/dist/generated/services/my-notifications.d.ts.map +1 -1
- package/dist/generated/services/my-notifications.js.map +1 -1
- package/dist/generated/services/my-notifications.ts +4 -2
- package/dist/generated/services/people.d.ts +11 -1
- package/dist/generated/services/people.d.ts.map +1 -1
- package/dist/generated/services/people.js +13 -2
- package/dist/generated/services/people.js.map +1 -1
- package/dist/generated/services/people.ts +15 -1
- package/dist/generated/services/projects.d.ts +26 -0
- package/dist/generated/services/projects.d.ts.map +1 -1
- package/dist/generated/services/projects.js +49 -1
- package/dist/generated/services/projects.js.map +1 -1
- package/dist/generated/services/projects.ts +61 -1
- package/dist/generated/services/recordings.d.ts +2 -12
- package/dist/generated/services/recordings.d.ts.map +1 -1
- package/dist/generated/services/recordings.js +1 -26
- package/dist/generated/services/recordings.js.map +1 -1
- package/dist/generated/services/recordings.ts +3 -31
- package/dist/generated/services/reports.d.ts +8 -12
- package/dist/generated/services/reports.d.ts.map +1 -1
- package/dist/generated/services/reports.js +11 -5
- package/dist/generated/services/reports.js.map +1 -1
- package/dist/generated/services/reports.ts +13 -14
- package/dist/generated/services/schedules.d.ts +94 -15
- package/dist/generated/services/schedules.d.ts.map +1 -1
- package/dist/generated/services/schedules.js +19 -8
- package/dist/generated/services/schedules.js.map +1 -1
- package/dist/generated/services/schedules.ts +107 -17
- package/dist/generated/services/search.d.ts +2 -0
- package/dist/generated/services/search.d.ts.map +1 -1
- package/dist/generated/services/search.js +1 -1
- package/dist/generated/services/search.js.map +1 -1
- package/dist/generated/services/search.ts +3 -1
- package/dist/generated/services/templates.d.ts +2 -0
- package/dist/generated/services/templates.d.ts.map +1 -1
- package/dist/generated/services/templates.js +1 -1
- package/dist/generated/services/templates.js.map +1 -1
- package/dist/generated/services/templates.ts +3 -1
- package/dist/generated/services/timeline.d.ts +2 -0
- package/dist/generated/services/timeline.d.ts.map +1 -1
- package/dist/generated/services/timeline.js +1 -0
- package/dist/generated/services/timeline.js.map +1 -1
- package/dist/generated/services/timeline.ts +3 -0
- package/dist/generated/services/timesheets.d.ts +16 -0
- package/dist/generated/services/timesheets.d.ts.map +1 -1
- package/dist/generated/services/timesheets.js +26 -2
- package/dist/generated/services/timesheets.js.map +1 -1
- package/dist/generated/services/timesheets.ts +35 -2
- package/dist/generated/services/todolist-groups.d.ts +11 -6
- package/dist/generated/services/todolist-groups.d.ts.map +1 -1
- package/dist/generated/services/todolist-groups.js +7 -3
- package/dist/generated/services/todolist-groups.js.map +1 -1
- package/dist/generated/services/todolist-groups.ts +13 -7
- package/dist/generated/services/todolists.d.ts +15 -13
- package/dist/generated/services/todolists.d.ts.map +1 -1
- package/dist/generated/services/todolists.js +11 -8
- package/dist/generated/services/todolists.js.map +1 -1
- package/dist/generated/services/todolists.ts +19 -14
- package/dist/generated/services/todos.d.ts +2 -12
- package/dist/generated/services/todos.d.ts.map +1 -1
- package/dist/generated/services/todos.js +1 -25
- package/dist/generated/services/todos.js.map +1 -1
- package/dist/generated/services/todos.ts +3 -30
- package/dist/generated/services/uploads.d.ts +5 -0
- package/dist/generated/services/uploads.d.ts.map +1 -1
- package/dist/generated/services/uploads.js +4 -0
- package/dist/generated/services/uploads.js.map +1 -1
- package/dist/generated/services/uploads.ts +6 -0
- package/dist/generated/services/vaults.d.ts +5 -0
- package/dist/generated/services/vaults.d.ts.map +1 -1
- package/dist/generated/services/vaults.js +4 -0
- package/dist/generated/services/vaults.js.map +1 -1
- package/dist/generated/services/vaults.ts +6 -0
- package/dist/index.d.ts +15 -9
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +19 -8
- package/dist/index.js.map +1 -1
- package/dist/pagination-utils.d.ts +46 -0
- package/dist/pagination-utils.d.ts.map +1 -1
- package/dist/pagination-utils.js +85 -2
- package/dist/pagination-utils.js.map +1 -1
- package/dist/pagination.d.ts +11 -0
- package/dist/pagination.d.ts.map +1 -1
- package/dist/pagination.js.map +1 -1
- package/dist/retry.d.ts +110 -0
- package/dist/retry.d.ts.map +1 -0
- package/dist/retry.js +253 -0
- package/dist/retry.js.map +1 -0
- package/dist/services/base.d.ts.map +1 -1
- package/dist/services/base.js +59 -5
- package/dist/services/base.js.map +1 -1
- package/dist/services/cards-extensions.d.ts +26 -21
- package/dist/services/cards-extensions.d.ts.map +1 -1
- package/dist/services/cards-extensions.js +28 -31
- package/dist/services/cards-extensions.js.map +1 -1
- package/dist/services/documents-extensions.d.ts +122 -0
- package/dist/services/documents-extensions.d.ts.map +1 -0
- package/dist/services/documents-extensions.js +125 -0
- package/dist/services/documents-extensions.js.map +1 -0
- package/dist/services/merge-safe.d.ts +167 -0
- package/dist/services/merge-safe.d.ts.map +1 -0
- package/dist/services/merge-safe.js +217 -0
- package/dist/services/merge-safe.js.map +1 -0
- package/dist/services/schedules-extensions.d.ts +266 -0
- package/dist/services/schedules-extensions.d.ts.map +1 -0
- package/dist/services/schedules-extensions.js +268 -0
- package/dist/services/schedules-extensions.js.map +1 -0
- package/dist/services/todolists-extensions.d.ts +110 -0
- package/dist/services/todolists-extensions.d.ts.map +1 -0
- package/dist/services/todolists-extensions.js +262 -0
- package/dist/services/todolists-extensions.js.map +1 -0
- package/dist/services/todos-extensions.d.ts +12 -1
- package/dist/services/todos-extensions.d.ts.map +1 -1
- package/dist/services/todos-extensions.js +27 -8
- package/dist/services/todos-extensions.js.map +1 -1
- package/package.json +5 -4
- package/src/generated/metadata.ts +280 -141
- package/src/generated/openapi-stripped.json +6435 -4283
- package/src/generated/path-mapping.ts +27 -16
- package/src/generated/schema.d.ts +4283 -2457
- package/src/generated/services/bookmarks.ts +1 -1
- package/src/generated/services/boosts.ts +12 -0
- package/src/generated/services/campfires.ts +107 -85
- package/src/generated/services/cards.ts +6 -0
- package/src/generated/services/checkins.ts +20 -0
- package/src/generated/services/client-approvals.ts +10 -5
- package/src/generated/services/client-correspondences.ts +10 -5
- package/src/generated/services/client-replies.ts +18 -8
- package/src/generated/services/cloud-files.ts +188 -0
- package/src/generated/services/comments.ts +6 -0
- package/src/generated/services/documents.ts +14 -8
- package/src/generated/services/drafts.ts +1 -1
- package/src/generated/services/events.ts +6 -0
- package/src/generated/services/everything.ts +14 -14
- package/src/generated/services/folders.ts +201 -0
- package/src/generated/services/forwards.ts +10 -48
- package/src/generated/services/gauges.ts +9 -1
- package/src/generated/services/google-documents.ts +196 -0
- package/src/generated/services/index.ts +7 -4
- package/src/generated/services/messages.ts +3 -1
- package/src/generated/services/my-notes.ts +1 -1
- package/src/generated/services/my-notifications.ts +4 -2
- package/src/generated/services/people.ts +15 -1
- package/src/generated/services/projects.ts +61 -1
- package/src/generated/services/recordings.ts +3 -31
- package/src/generated/services/reports.ts +13 -14
- package/src/generated/services/schedules.ts +107 -17
- package/src/generated/services/search.ts +3 -1
- package/src/generated/services/templates.ts +3 -1
- package/src/generated/services/timeline.ts +3 -0
- package/src/generated/services/timesheets.ts +35 -2
- package/src/generated/services/todolist-groups.ts +13 -7
- package/src/generated/services/todolists.ts +19 -14
- package/src/generated/services/todos.ts +3 -30
- package/src/generated/services/uploads.ts +6 -0
- package/src/generated/services/vaults.ts +6 -0
|
@@ -18,9 +18,9 @@ import { Errors } from "../../errors.js";
|
|
|
18
18
|
export type Document = components["schemas"]["Document"];
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
|
-
* Request parameters for
|
|
21
|
+
* Request parameters for replace.
|
|
22
22
|
*/
|
|
23
|
-
export interface
|
|
23
|
+
export interface ReplaceDocumentRequest {
|
|
24
24
|
/** Title */
|
|
25
25
|
title?: string;
|
|
26
26
|
/** Text content */
|
|
@@ -31,6 +31,8 @@ export interface UpdateDocumentRequest {
|
|
|
31
31
|
* Options for list.
|
|
32
32
|
*/
|
|
33
33
|
export interface ListDocumentOptions extends PaginationOptions {
|
|
34
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
35
|
+
page?: number;
|
|
34
36
|
}
|
|
35
37
|
|
|
36
38
|
/**
|
|
@@ -90,22 +92,22 @@ export class DocumentsService extends BaseService {
|
|
|
90
92
|
}
|
|
91
93
|
|
|
92
94
|
/**
|
|
93
|
-
*
|
|
95
|
+
* Replace a document with a new complete representation.
|
|
94
96
|
* @param documentId - The document ID
|
|
95
|
-
* @param req - Document
|
|
97
|
+
* @param req - Document request parameters
|
|
96
98
|
* @returns The Document
|
|
97
|
-
* @throws {BasecampError} If the
|
|
99
|
+
* @throws {BasecampError} If the request fails
|
|
98
100
|
*
|
|
99
101
|
* @example
|
|
100
102
|
* ```ts
|
|
101
|
-
* const result = await client.documents.
|
|
103
|
+
* const result = await client.documents.replace(123, { });
|
|
102
104
|
* ```
|
|
103
105
|
*/
|
|
104
|
-
async
|
|
106
|
+
async replace(documentId: number, req: ReplaceDocumentRequest): Promise<Document> {
|
|
105
107
|
const response = await this.request(
|
|
106
108
|
{
|
|
107
109
|
service: "Documents",
|
|
108
|
-
operation: "
|
|
110
|
+
operation: "ReplaceDocument",
|
|
109
111
|
resourceType: "document",
|
|
110
112
|
isMutation: true,
|
|
111
113
|
resourceId: documentId,
|
|
@@ -133,6 +135,9 @@ export class DocumentsService extends BaseService {
|
|
|
133
135
|
* @example
|
|
134
136
|
* ```ts
|
|
135
137
|
* const result = await client.documents.list(123);
|
|
138
|
+
*
|
|
139
|
+
* // With options
|
|
140
|
+
* const filtered = await client.documents.list(123, { page: 1 });
|
|
136
141
|
* ```
|
|
137
142
|
*/
|
|
138
143
|
async list(vaultId: number, options?: ListDocumentOptions): Promise<ListResult<Document>> {
|
|
@@ -148,6 +153,7 @@ export class DocumentsService extends BaseService {
|
|
|
148
153
|
this.client.GET("/vaults/{vaultId}/documents.json", {
|
|
149
154
|
params: {
|
|
150
155
|
path: { vaultId },
|
|
156
|
+
query: { page: options?.page },
|
|
151
157
|
},
|
|
152
158
|
})
|
|
153
159
|
, options
|
|
@@ -13,7 +13,7 @@ export type Draft = components["schemas"]["Draft"];
|
|
|
13
13
|
* Options for listMyDrafts.
|
|
14
14
|
*/
|
|
15
15
|
export interface ListMyDraftsDraftOptions extends PaginationOptions {
|
|
16
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
16
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
17
17
|
page?: number;
|
|
18
18
|
}
|
|
19
19
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"drafts.d.ts","sourceRoot":"","sources":["../../../src/generated/services/drafts.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAM7D,0CAA0C;AAC1C,MAAM,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;IACjE,
|
|
1
|
+
{"version":3,"file":"drafts.d.ts","sourceRoot":"","sources":["../../../src/generated/services/drafts.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAM7D,0CAA0C;AAC1C,MAAM,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;IACjE,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAOD;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAE5C;;;;;;;;;;;;OAYG;IACG,YAAY,CAAC,OAAO,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;CAiBnF"}
|
|
@@ -20,7 +20,7 @@ export type Draft = components["schemas"]["Draft"];
|
|
|
20
20
|
* Options for listMyDrafts.
|
|
21
21
|
*/
|
|
22
22
|
export interface ListMyDraftsDraftOptions extends PaginationOptions {
|
|
23
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
23
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
24
24
|
page?: number;
|
|
25
25
|
}
|
|
26
26
|
|
|
@@ -13,6 +13,8 @@ export type Event = components["schemas"]["Event"];
|
|
|
13
13
|
* Options for list.
|
|
14
14
|
*/
|
|
15
15
|
export interface ListEventOptions extends PaginationOptions {
|
|
16
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
17
|
+
page?: number;
|
|
16
18
|
}
|
|
17
19
|
/**
|
|
18
20
|
* Service for Events operations.
|
|
@@ -27,6 +29,9 @@ export declare class EventsService extends BaseService {
|
|
|
27
29
|
* @example
|
|
28
30
|
* ```ts
|
|
29
31
|
* const result = await client.events.list(123);
|
|
32
|
+
*
|
|
33
|
+
* // With options
|
|
34
|
+
* const filtered = await client.events.list(123, { page: 1 });
|
|
30
35
|
* ```
|
|
31
36
|
*/
|
|
32
37
|
list(recordingId: number, options?: ListEventOptions): Promise<ListResult<Event>>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../src/generated/services/events.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAM7D,0CAA0C;AAC1C,MAAM,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;
|
|
1
|
+
{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../src/generated/services/events.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAM7D,0CAA0C;AAC1C,MAAM,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;IACzD,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAOD;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAE5C;;;;;;;;;;;;;OAaG;IACG,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;CAmBxF"}
|
|
@@ -20,6 +20,9 @@ export class EventsService extends BaseService {
|
|
|
20
20
|
* @example
|
|
21
21
|
* ```ts
|
|
22
22
|
* const result = await client.events.list(123);
|
|
23
|
+
*
|
|
24
|
+
* // With options
|
|
25
|
+
* const filtered = await client.events.list(123, { page: 1 });
|
|
23
26
|
* ```
|
|
24
27
|
*/
|
|
25
28
|
async list(recordingId, options) {
|
|
@@ -32,6 +35,7 @@ export class EventsService extends BaseService {
|
|
|
32
35
|
}, () => this.client.GET("/recordings/{recordingId}/events.json", {
|
|
33
36
|
params: {
|
|
34
37
|
path: { recordingId },
|
|
38
|
+
query: { page: options?.page },
|
|
35
39
|
},
|
|
36
40
|
}), options);
|
|
37
41
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../src/generated/services/events.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;
|
|
1
|
+
{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../src/generated/services/events.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAqBrD,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAE5C;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAI,CAAC,WAAmB,EAAE,OAA0B;QACxD,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,YAAY;YACvB,YAAY,EAAE,OAAO;YACrB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,WAAW;SACxB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,uCAAuC,EAAE;YACvD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,WAAW,EAAE;gBACrB,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE;aAC/B;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;CACF"}
|
|
@@ -20,6 +20,8 @@ export type Event = components["schemas"]["Event"];
|
|
|
20
20
|
* Options for list.
|
|
21
21
|
*/
|
|
22
22
|
export interface ListEventOptions extends PaginationOptions {
|
|
23
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
24
|
+
page?: number;
|
|
23
25
|
}
|
|
24
26
|
|
|
25
27
|
|
|
@@ -41,6 +43,9 @@ export class EventsService extends BaseService {
|
|
|
41
43
|
* @example
|
|
42
44
|
* ```ts
|
|
43
45
|
* const result = await client.events.list(123);
|
|
46
|
+
*
|
|
47
|
+
* // With options
|
|
48
|
+
* const filtered = await client.events.list(123, { page: 1 });
|
|
44
49
|
* ```
|
|
45
50
|
*/
|
|
46
51
|
async list(recordingId: number, options?: ListEventOptions): Promise<ListResult<Event>> {
|
|
@@ -56,6 +61,7 @@ export class EventsService extends BaseService {
|
|
|
56
61
|
this.client.GET("/recordings/{recordingId}/events.json", {
|
|
57
62
|
params: {
|
|
58
63
|
path: { recordingId },
|
|
64
|
+
query: { page: options?.page },
|
|
59
65
|
},
|
|
60
66
|
})
|
|
61
67
|
, options
|
|
@@ -28,7 +28,7 @@ export interface EverythingCompletedCardsEverythingOptions extends PaginationOpt
|
|
|
28
28
|
assigneeIds?: number[];
|
|
29
29
|
/** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
|
|
30
30
|
due?: string;
|
|
31
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
31
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
32
32
|
page?: number;
|
|
33
33
|
}
|
|
34
34
|
/**
|
|
@@ -40,7 +40,7 @@ export interface EverythingNoDueDateCardsEverythingOptions extends PaginationOpt
|
|
|
40
40
|
assigneeIds?: number[];
|
|
41
41
|
/** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
|
|
42
42
|
due?: string;
|
|
43
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
43
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
44
44
|
page?: number;
|
|
45
45
|
}
|
|
46
46
|
/**
|
|
@@ -52,7 +52,7 @@ export interface EverythingNotNowCardsEverythingOptions extends PaginationOption
|
|
|
52
52
|
assigneeIds?: number[];
|
|
53
53
|
/** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
|
|
54
54
|
due?: string;
|
|
55
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
55
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
56
56
|
page?: number;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
@@ -64,7 +64,7 @@ export interface EverythingOpenCardsEverythingOptions extends PaginationOptions
|
|
|
64
64
|
assigneeIds?: number[];
|
|
65
65
|
/** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
|
|
66
66
|
due?: string;
|
|
67
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
67
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
68
68
|
page?: number;
|
|
69
69
|
}
|
|
70
70
|
/**
|
|
@@ -86,21 +86,21 @@ export interface EverythingUnassignedCardsEverythingOptions extends PaginationOp
|
|
|
86
86
|
assigneeIds?: number[];
|
|
87
87
|
/** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
|
|
88
88
|
due?: string;
|
|
89
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
89
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
90
90
|
page?: number;
|
|
91
91
|
}
|
|
92
92
|
/**
|
|
93
93
|
* Options for everythingCheckins.
|
|
94
94
|
*/
|
|
95
95
|
export interface EverythingCheckinsEverythingOptions extends PaginationOptions {
|
|
96
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
96
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
97
97
|
page?: number;
|
|
98
98
|
}
|
|
99
99
|
/**
|
|
100
100
|
* Options for everythingComments.
|
|
101
101
|
*/
|
|
102
102
|
export interface EverythingCommentsEverythingOptions extends PaginationOptions {
|
|
103
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
103
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
104
104
|
page?: number;
|
|
105
105
|
}
|
|
106
106
|
/**
|
|
@@ -111,21 +111,21 @@ export interface EverythingFilesEverythingOptions extends PaginationOptions {
|
|
|
111
111
|
kind?: string;
|
|
112
112
|
/** Restrict to files created by the given people (repeatable). */
|
|
113
113
|
peopleIds?: number[];
|
|
114
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
114
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
115
115
|
page?: number;
|
|
116
116
|
}
|
|
117
117
|
/**
|
|
118
118
|
* Options for everythingForwards.
|
|
119
119
|
*/
|
|
120
120
|
export interface EverythingForwardsEverythingOptions extends PaginationOptions {
|
|
121
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
121
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
122
122
|
page?: number;
|
|
123
123
|
}
|
|
124
124
|
/**
|
|
125
125
|
* Options for everythingMessages.
|
|
126
126
|
*/
|
|
127
127
|
export interface EverythingMessagesEverythingOptions extends PaginationOptions {
|
|
128
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
128
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
129
129
|
page?: number;
|
|
130
130
|
}
|
|
131
131
|
/**
|
|
@@ -137,7 +137,7 @@ export interface EverythingCompletedTodosEverythingOptions extends PaginationOpt
|
|
|
137
137
|
assigneeIds?: number[];
|
|
138
138
|
/** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
|
|
139
139
|
due?: string;
|
|
140
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
140
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
141
141
|
page?: number;
|
|
142
142
|
}
|
|
143
143
|
/**
|
|
@@ -149,7 +149,7 @@ export interface EverythingNoDueDateTodosEverythingOptions extends PaginationOpt
|
|
|
149
149
|
assigneeIds?: number[];
|
|
150
150
|
/** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
|
|
151
151
|
due?: string;
|
|
152
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
152
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
153
153
|
page?: number;
|
|
154
154
|
}
|
|
155
155
|
/**
|
|
@@ -161,7 +161,7 @@ export interface EverythingOpenTodosEverythingOptions extends PaginationOptions
|
|
|
161
161
|
assigneeIds?: number[];
|
|
162
162
|
/** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
|
|
163
163
|
due?: string;
|
|
164
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
164
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
165
165
|
page?: number;
|
|
166
166
|
}
|
|
167
167
|
/**
|
|
@@ -183,7 +183,7 @@ export interface EverythingUnassignedTodosEverythingOptions extends PaginationOp
|
|
|
183
183
|
assigneeIds?: number[];
|
|
184
184
|
/** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
|
|
185
185
|
due?: string;
|
|
186
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
186
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
187
187
|
page?: number;
|
|
188
188
|
}
|
|
189
189
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"everything.d.ts","sourceRoot":"","sources":["../../../src/generated/services/everything.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAM7D,qDAAqD;AACrD,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AACzE,yCAAyC;AACzC,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AACjD,8CAA8C;AAC9C,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC;AAC3D,mDAAmD;AACnD,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC;AACrE,qDAAqD;AACrD,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AACzE,yCAAyC;AACzC,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,yCAA0C,SAAQ,iBAAiB;IAClF;kDAC8C;IAC9C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,sFAAsF;IACtF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,
|
|
1
|
+
{"version":3,"file":"everything.d.ts","sourceRoot":"","sources":["../../../src/generated/services/everything.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAM7D,qDAAqD;AACrD,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AACzE,yCAAyC;AACzC,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AACjD,8CAA8C;AAC9C,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC;AAC3D,mDAAmD;AACnD,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC;AACrE,qDAAqD;AACrD,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AACzE,yCAAyC;AACzC,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,yCAA0C,SAAQ,iBAAiB;IAClF;kDAC8C;IAC9C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,sFAAsF;IACtF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,yCAA0C,SAAQ,iBAAiB;IAClF;kDAC8C;IAC9C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,sFAAsF;IACtF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,sCAAuC,SAAQ,iBAAiB;IAC/E;kDAC8C;IAC9C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,sFAAsF;IACtF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,oCAAqC,SAAQ,iBAAiB;IAC7E;kDAC8C;IAC9C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,sFAAsF;IACtF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,uCAAuC;IACtD;kDAC8C;IAC9C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,sFAAsF;IACtF,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,0CAA2C,SAAQ,iBAAiB;IACnF;kDAC8C;IAC9C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,sFAAsF;IACtF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mCAAoC,SAAQ,iBAAiB;IAC5E,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mCAAoC,SAAQ,iBAAiB;IAC5E,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,gCAAiC,SAAQ,iBAAiB;IACzE,8EAA8E;IAC9E,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kEAAkE;IAClE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mCAAoC,SAAQ,iBAAiB;IAC5E,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mCAAoC,SAAQ,iBAAiB;IAC5E,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,yCAA0C,SAAQ,iBAAiB;IAClF;kDAC8C;IAC9C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,sFAAsF;IACtF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,yCAA0C,SAAQ,iBAAiB;IAClF;kDAC8C;IAC9C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,sFAAsF;IACtF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,oCAAqC,SAAQ,iBAAiB;IAC7E;kDAC8C;IAC9C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,sFAAsF;IACtF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,uCAAuC;IACtD;kDAC8C;IAC9C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,sFAAsF;IACtF,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,0CAA2C,SAAQ,iBAAiB;IACnF;kDAC8C;IAC9C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,sFAAsF;IACtF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAOD;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,WAAW;IAEhD;;;;;;;;;OASG;IACG,wBAAwB,CAAC,OAAO,CAAC,EAAE,yCAAyC,GAAG,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAkB1H;;;;;;;;;OASG;IACG,wBAAwB,CAAC,OAAO,CAAC,EAAE,yCAAyC,GAAG,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAkB1H;;;;;;;;;OASG;IACG,qBAAqB,CAAC,OAAO,CAAC,EAAE,sCAAsC,GAAG,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAkBpH;;;;;;;;;OASG;IACG,mBAAmB,CAAC,OAAO,CAAC,EAAE,oCAAoC,GAAG,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAkBhH;;;;;;;;;OASG;IACG,sBAAsB,CAAC,OAAO,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAkBhG;;;;;;;;;OASG;IACG,yBAAyB,CAAC,OAAO,CAAC,EAAE,0CAA0C,GAAG,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAkB5H;;;;;;;;;OASG;IACG,kBAAkB,CAAC,OAAO,CAAC,EAAE,mCAAmC,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAkBvG;;;;;;;;;OASG;IACG,kBAAkB,CAAC,OAAO,CAAC,EAAE,mCAAmC,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAkBvG;;;;;;;;;OASG;IACG,eAAe,CAAC,OAAO,CAAC,EAAE,gCAAgC,GAAG,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAkBtG;;;;;;;;;OASG;IACG,kBAAkB,CAAC,OAAO,CAAC,EAAE,mCAAmC,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAkBvG;;;;;;;;;OASG;IACG,kBAAkB,CAAC,OAAO,CAAC,EAAE,mCAAmC,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAkBvG;;;;;;;;;OASG;IACG,wBAAwB,CAAC,OAAO,CAAC,EAAE,yCAAyC,GAAG,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAkB1H;;;;;;;;;OASG;IACG,wBAAwB,CAAC,OAAO,CAAC,EAAE,yCAAyC,GAAG,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAkB1H;;;;;;;;;OASG;IACG,mBAAmB,CAAC,OAAO,CAAC,EAAE,oCAAoC,GAAG,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAkBhH;;;;;;;;;OASG;IACG,sBAAsB,CAAC,OAAO,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAkBhG;;;;;;;;;OASG;IACG,yBAAyB,CAAC,OAAO,CAAC,EAAE,0CAA0C,GAAG,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;CAiB7H"}
|
|
@@ -35,7 +35,7 @@ Assignees on nested steps are not considered. */
|
|
|
35
35
|
assigneeIds?: number[];
|
|
36
36
|
/** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
|
|
37
37
|
due?: string;
|
|
38
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
38
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
39
39
|
page?: number;
|
|
40
40
|
}
|
|
41
41
|
|
|
@@ -48,7 +48,7 @@ Assignees on nested steps are not considered. */
|
|
|
48
48
|
assigneeIds?: number[];
|
|
49
49
|
/** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
|
|
50
50
|
due?: string;
|
|
51
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
51
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
52
52
|
page?: number;
|
|
53
53
|
}
|
|
54
54
|
|
|
@@ -61,7 +61,7 @@ Assignees on nested steps are not considered. */
|
|
|
61
61
|
assigneeIds?: number[];
|
|
62
62
|
/** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
|
|
63
63
|
due?: string;
|
|
64
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
64
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
65
65
|
page?: number;
|
|
66
66
|
}
|
|
67
67
|
|
|
@@ -74,7 +74,7 @@ Assignees on nested steps are not considered. */
|
|
|
74
74
|
assigneeIds?: number[];
|
|
75
75
|
/** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
|
|
76
76
|
due?: string;
|
|
77
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
77
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
78
78
|
page?: number;
|
|
79
79
|
}
|
|
80
80
|
|
|
@@ -98,7 +98,7 @@ Assignees on nested steps are not considered. */
|
|
|
98
98
|
assigneeIds?: number[];
|
|
99
99
|
/** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
|
|
100
100
|
due?: string;
|
|
101
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
101
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
102
102
|
page?: number;
|
|
103
103
|
}
|
|
104
104
|
|
|
@@ -106,7 +106,7 @@ Assignees on nested steps are not considered. */
|
|
|
106
106
|
* Options for everythingCheckins.
|
|
107
107
|
*/
|
|
108
108
|
export interface EverythingCheckinsEverythingOptions extends PaginationOptions {
|
|
109
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
109
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
110
110
|
page?: number;
|
|
111
111
|
}
|
|
112
112
|
|
|
@@ -114,7 +114,7 @@ export interface EverythingCheckinsEverythingOptions extends PaginationOptions {
|
|
|
114
114
|
* Options for everythingComments.
|
|
115
115
|
*/
|
|
116
116
|
export interface EverythingCommentsEverythingOptions extends PaginationOptions {
|
|
117
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
117
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
118
118
|
page?: number;
|
|
119
119
|
}
|
|
120
120
|
|
|
@@ -126,7 +126,7 @@ export interface EverythingFilesEverythingOptions extends PaginationOptions {
|
|
|
126
126
|
kind?: string;
|
|
127
127
|
/** Restrict to files created by the given people (repeatable). */
|
|
128
128
|
peopleIds?: number[];
|
|
129
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
129
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
130
130
|
page?: number;
|
|
131
131
|
}
|
|
132
132
|
|
|
@@ -134,7 +134,7 @@ export interface EverythingFilesEverythingOptions extends PaginationOptions {
|
|
|
134
134
|
* Options for everythingForwards.
|
|
135
135
|
*/
|
|
136
136
|
export interface EverythingForwardsEverythingOptions extends PaginationOptions {
|
|
137
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
137
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
138
138
|
page?: number;
|
|
139
139
|
}
|
|
140
140
|
|
|
@@ -142,7 +142,7 @@ export interface EverythingForwardsEverythingOptions extends PaginationOptions {
|
|
|
142
142
|
* Options for everythingMessages.
|
|
143
143
|
*/
|
|
144
144
|
export interface EverythingMessagesEverythingOptions extends PaginationOptions {
|
|
145
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
145
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
146
146
|
page?: number;
|
|
147
147
|
}
|
|
148
148
|
|
|
@@ -155,7 +155,7 @@ Assignees on nested steps are not considered. */
|
|
|
155
155
|
assigneeIds?: number[];
|
|
156
156
|
/** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
|
|
157
157
|
due?: string;
|
|
158
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
158
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
159
159
|
page?: number;
|
|
160
160
|
}
|
|
161
161
|
|
|
@@ -168,7 +168,7 @@ Assignees on nested steps are not considered. */
|
|
|
168
168
|
assigneeIds?: number[];
|
|
169
169
|
/** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
|
|
170
170
|
due?: string;
|
|
171
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
171
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
172
172
|
page?: number;
|
|
173
173
|
}
|
|
174
174
|
|
|
@@ -181,7 +181,7 @@ Assignees on nested steps are not considered. */
|
|
|
181
181
|
assigneeIds?: number[];
|
|
182
182
|
/** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
|
|
183
183
|
due?: string;
|
|
184
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
184
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
185
185
|
page?: number;
|
|
186
186
|
}
|
|
187
187
|
|
|
@@ -205,7 +205,7 @@ Assignees on nested steps are not considered. */
|
|
|
205
205
|
assigneeIds?: number[];
|
|
206
206
|
/** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
|
|
207
207
|
due?: string;
|
|
208
|
-
/** Page number for paginating through results. Defaults to 1. */
|
|
208
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
209
209
|
page?: number;
|
|
210
210
|
}
|
|
211
211
|
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Folders service for the Basecamp API.
|
|
3
|
+
*
|
|
4
|
+
* @generated from OpenAPI spec - do not edit directly
|
|
5
|
+
*/
|
|
6
|
+
import { BaseService } from "../../services/base.js";
|
|
7
|
+
import type { components } from "../schema.js";
|
|
8
|
+
/** Folder entity from the Basecamp API. */
|
|
9
|
+
export type Folder = components["schemas"]["Folder"];
|
|
10
|
+
/** FolderWithProjects entity from the Basecamp API. */
|
|
11
|
+
export type FolderWithProjects = components["schemas"]["FolderWithProjects"];
|
|
12
|
+
/**
|
|
13
|
+
* Request parameters for createFolder.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateFolderFolderRequest {
|
|
16
|
+
/** The folder's name. Defaults to `New folder` when blank, null, or omitted. */
|
|
17
|
+
name?: string;
|
|
18
|
+
/** IDs of the projects to file into the folder — the same ids the folder
|
|
19
|
+
reports back as `bucket_ids` and expands as `projects`. This does not
|
|
20
|
+
round-trip under its own name. Omit it, or send null or an empty array,
|
|
21
|
+
for an empty folder. */
|
|
22
|
+
projectIds?: number[];
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Request parameters for updateFolder.
|
|
26
|
+
*/
|
|
27
|
+
export interface UpdateFolderFolderRequest {
|
|
28
|
+
/** The folder's new name. Blank is rejected with 422 — unlike create, update
|
|
29
|
+
does not fall back to a default name. */
|
|
30
|
+
name: string;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Service for Folders operations.
|
|
34
|
+
*/
|
|
35
|
+
export declare class FoldersService extends BaseService {
|
|
36
|
+
/**
|
|
37
|
+
* List the authenticated user's folders in home-screen order.
|
|
38
|
+
* @returns Array of Folder
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```ts
|
|
42
|
+
* const result = await client.folders.listFolders();
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
listFolders(): Promise<Folder[]>;
|
|
46
|
+
/**
|
|
47
|
+
* Create a folder for the authenticated user and file the given projects into it.
|
|
48
|
+
* @param req - Folder creation parameters
|
|
49
|
+
* @returns The FolderWithProjects
|
|
50
|
+
* @throws {BasecampError} If required fields are missing or invalid
|
|
51
|
+
*
|
|
52
|
+
* @example
|
|
53
|
+
* ```ts
|
|
54
|
+
* const result = await client.folders.createFolder({ });
|
|
55
|
+
* ```
|
|
56
|
+
*/
|
|
57
|
+
createFolder(req: CreateFolderFolderRequest): Promise<FolderWithProjects>;
|
|
58
|
+
/**
|
|
59
|
+
* Get one folder, with the projects grouped inside it expanded under `projects`.
|
|
60
|
+
* @param folderId - The folder ID
|
|
61
|
+
* @returns The FolderWithProjects
|
|
62
|
+
* @throws {BasecampError} If the resource is not found
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* ```ts
|
|
66
|
+
* const result = await client.folders.getFolder(123);
|
|
67
|
+
* ```
|
|
68
|
+
*/
|
|
69
|
+
getFolder(folderId: number): Promise<FolderWithProjects>;
|
|
70
|
+
/**
|
|
71
|
+
* Rename a folder.
|
|
72
|
+
* @param folderId - The folder ID
|
|
73
|
+
* @param req - Folder update parameters
|
|
74
|
+
* @returns The FolderWithProjects
|
|
75
|
+
* @throws {BasecampError} If the resource is not found or fields are invalid
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* ```ts
|
|
79
|
+
* const result = await client.folders.updateFolder(123, { name: "My example" });
|
|
80
|
+
* ```
|
|
81
|
+
*/
|
|
82
|
+
updateFolder(folderId: number, req: UpdateFolderFolderRequest): Promise<FolderWithProjects>;
|
|
83
|
+
/**
|
|
84
|
+
* Delete a folder and unpin its projects from the home screen.
|
|
85
|
+
* @param folderId - The folder ID
|
|
86
|
+
* @returns void
|
|
87
|
+
* @throws {BasecampError} If the request fails
|
|
88
|
+
*
|
|
89
|
+
* @example
|
|
90
|
+
* ```ts
|
|
91
|
+
* await client.folders.deleteFolder(123);
|
|
92
|
+
* ```
|
|
93
|
+
*/
|
|
94
|
+
deleteFolder(folderId: number): Promise<void>;
|
|
95
|
+
}
|
|
96
|
+
//# sourceMappingURL=folders.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"folders.d.ts","sourceRoot":"","sources":["../../../src/generated/services/folders.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAO/C,2CAA2C;AAC3C,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC;AACrD,uDAAuD;AACvD,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,CAAC;AAE7E;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,gFAAgF;IAChF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;yBAGqB;IACrB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;0CACsC;IACtC,IAAI,EAAE,MAAM,CAAC;CACd;AAOD;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAE7C;;;;;;;;OAQG;IACG,WAAW,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAetC;;;;;;;;;;OAUG;IACG,YAAY,CAAC,GAAG,EAAE,yBAAyB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAmB/E;;;;;;;;;;OAUG;IACG,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAmB9D;;;;;;;;;;;OAWG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,yBAAyB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAyBjG;;;;;;;;;;OAUG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAiBpD"}
|