confluence.js 1.5.0 → 1.5.3

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 (77) hide show
  1. package/CHANGELOG.md +15 -3
  2. package/README.md +3 -3
  3. package/out/api/audit.d.ts +24 -12
  4. package/out/api/audit.js.map +1 -1
  5. package/out/api/content.d.ts +18 -12
  6. package/out/api/content.js.map +1 -1
  7. package/out/api/contentAttachments.d.ts +14 -8
  8. package/out/api/contentAttachments.js.map +1 -1
  9. package/out/api/contentBody.js +2 -4
  10. package/out/api/contentBody.js.map +1 -1
  11. package/out/api/contentMacroBody.d.ts +4 -2
  12. package/out/api/contentMacroBody.js.map +1 -1
  13. package/out/api/contentRestrictions.d.ts +16 -8
  14. package/out/api/contentRestrictions.js.map +1 -1
  15. package/out/api/contentWatches.d.ts +16 -8
  16. package/out/api/contentWatches.js.map +1 -1
  17. package/out/api/parameters/convertContentBody.d.ts +16 -2
  18. package/out/api/relation.d.ts +8 -4
  19. package/out/api/relation.js.map +1 -1
  20. package/out/api/settings.d.ts +4 -2
  21. package/out/api/settings.js.map +1 -1
  22. package/out/api/space.d.ts +4 -2
  23. package/out/api/space.js.map +1 -1
  24. package/out/api/template.d.ts +16 -8
  25. package/out/api/template.js.map +1 -1
  26. package/out/clients/baseClient.js +3 -1
  27. package/out/clients/baseClient.js.map +1 -1
  28. package/out/clients/serverClient.js.map +1 -1
  29. package/out/server/audit.js +6 -6
  30. package/out/server/audit.js.map +1 -1
  31. package/out/server/content.d.ts +34 -262
  32. package/out/server/content.js +40 -32
  33. package/out/server/content.js.map +1 -1
  34. package/out/server/contentBody.d.ts +2 -12
  35. package/out/server/contentBody.js +2 -1
  36. package/out/server/contentBody.js.map +1 -1
  37. package/out/server/group.js +3 -3
  38. package/out/server/group.js.map +1 -1
  39. package/out/server/longTask.js +2 -2
  40. package/out/server/longTask.js.map +1 -1
  41. package/out/server/parameters/convertContentBody.d.ts +16 -0
  42. package/out/server/parameters/updateAttachmentData.d.ts +8 -2
  43. package/out/server/search.d.ts +2 -22
  44. package/out/server/search.js +1 -1
  45. package/out/server/search.js.map +1 -1
  46. package/out/server/space.d.ts +12 -94
  47. package/out/server/space.js +14 -14
  48. package/out/server/space.js.map +1 -1
  49. package/out/server/user.d.ts +8 -152
  50. package/out/server/user.js +10 -10
  51. package/out/server/user.js.map +1 -1
  52. package/package.json +14 -14
  53. package/src/api/audit.ts +24 -12
  54. package/src/api/content.ts +23 -17
  55. package/src/api/contentAttachments.ts +19 -13
  56. package/src/api/contentBody.ts +2 -0
  57. package/src/api/contentMacroBody.ts +4 -2
  58. package/src/api/contentRestrictions.ts +16 -8
  59. package/src/api/contentWatches.ts +16 -8
  60. package/src/api/parameters/convertContentBody.ts +39 -2
  61. package/src/api/relation.ts +8 -4
  62. package/src/api/settings.ts +4 -2
  63. package/src/api/space.ts +4 -2
  64. package/src/api/template.ts +16 -8
  65. package/src/clients/baseClient.ts +5 -10
  66. package/src/clients/client.ts +1 -5
  67. package/src/clients/serverClient.ts +1 -10
  68. package/src/server/audit.ts +6 -6
  69. package/src/server/content.ts +78 -295
  70. package/src/server/contentBody.ts +4 -13
  71. package/src/server/group.ts +3 -3
  72. package/src/server/longTask.ts +2 -2
  73. package/src/server/parameters/convertContentBody.ts +37 -0
  74. package/src/server/parameters/updateAttachmentData.ts +7 -3
  75. package/src/server/search.ts +3 -23
  76. package/src/server/space.ts +26 -108
  77. package/src/server/user.ts +18 -162
@@ -8,28 +8,12 @@ import { RequestConfig } from '../requestConfig';
8
8
  export class Content {
9
9
  constructor(private client: Client) {}
10
10
 
11
- /**
12
- * Returns a paginated list of Content.
13
- *
14
- * @example
15
- * Example request URI(s):
16
- *
17
- * - http://example.com/rest/api/content?spaceKey=TST&title=Cheese&expand=space,body.view,version,container
18
- * - http://example.com/rest/api/content?type=blogpost&spaceKey=TST&title=Bacon&postingDay=2014-02-13&expand=space,body.view,version,container
19
- */
11
+ /** Returns a paginated list of Content. */
20
12
  async getContent<T = Pagination<Models.Content>>(
21
13
  parameters: Parameters.GetContent | undefined,
22
14
  callback: Callback<T>
23
15
  ): Promise<void>;
24
- /**
25
- * Returns a paginated list of Content.
26
- *
27
- * @example
28
- * Example request URI(s):
29
- *
30
- * - http://example.com/rest/api/content?spaceKey=TST&title=Cheese&expand=space,body.view,version,container
31
- * - http://example.com/rest/api/content?type=blogpost&spaceKey=TST&title=Bacon&postingDay=2014-02-13&expand=space,body.view,version,container
32
- */
16
+ /** Returns a paginated list of Content. */
33
17
  async getContent<T = Pagination<Models.Content>>(parameters?: Parameters.GetContent, callback?: never): Promise<T>;
34
18
  async getContent<T = Pagination<Models.Content>>(
35
19
  parameters?: Parameters.GetContent,
@@ -50,12 +34,13 @@ export class Content {
50
34
  },
51
35
  };
52
36
 
53
- return this.client.sendRequest(config, callback, { methodName: 'server.getContent' });
37
+ return this.client.sendRequest(config, callback);
54
38
  }
55
39
 
56
40
  /**
57
41
  * Creates a new piece of Content or publishes the draft if the content id is present.For the case publishing draft, a
58
- * new piece of content will be created and all metadata from the draft will be transferred into the newly created content.
42
+ * new piece of content will be created and all metadata from the draft will be transferred into the newly created
43
+ * content.
59
44
  */
60
45
  async createContent<T = Models.Content>(
61
46
  parameters: Parameters.CreateContent | undefined,
@@ -63,7 +48,8 @@ export class Content {
63
48
  ): Promise<void>;
64
49
  /**
65
50
  * Creates a new piece of Content or publishes the draft if the content id is present.For the case publishing draft, a
66
- * new piece of content will be created and all metadata from the draft will be transferred into the newly created content.
51
+ * new piece of content will be created and all metadata from the draft will be transferred into the newly created
52
+ * content.
67
53
  */
68
54
  async createContent<T = Models.Content>(parameters?: Parameters.CreateContent, callback?: never): Promise<T>;
69
55
  async createContent<T = Models.Content>(
@@ -84,7 +70,7 @@ export class Content {
84
70
  },
85
71
  };
86
72
 
87
- return this.client.sendRequest(config, callback, { methodName: 'server.createContent' });
73
+ return this.client.sendRequest(config, callback);
88
74
  }
89
75
 
90
76
  /**
@@ -117,28 +103,12 @@ export class Content {
117
103
  },
118
104
  };
119
105
 
120
- return this.client.sendRequest(config, callback, { methodName: 'server.updateContent' });
106
+ return this.client.sendRequest(config, callback);
121
107
  }
122
108
 
123
- /**
124
- * Returns a piece of Content.
125
- *
126
- * @example
127
- * Example request URI(s):
128
- *
129
- * http://example.com/rest/api/content/1234?expand=space,body.view,version,container
130
- * http://example.com/rest/api/content/1234?status=any
131
- */
109
+ /** Returns a piece of Content. */
132
110
  async getContentById<T = Models.Content>(parameters: Parameters.GetContentById, callback: Callback<T>): Promise<void>;
133
- /**
134
- * Returns a piece of Content.
135
- *
136
- * @example
137
- * Example request URI(s):
138
- *
139
- * http://example.com/rest/api/content/1234?expand=space,body.view,version,container
140
- * http://example.com/rest/api/content/1234?status=any
141
- */
111
+ /** Returns a piece of Content. */
142
112
  async getContentById<T = Models.Content>(parameters: Parameters.GetContentById, callback?: never): Promise<T>;
143
113
  async getContentById<T = Models.Content>(
144
114
  parameters: Parameters.GetContentById,
@@ -154,7 +124,7 @@ export class Content {
154
124
  },
155
125
  };
156
126
 
157
- return this.client.sendRequest(config, callback, { methodName: 'server.getContentById' });
127
+ return this.client.sendRequest(config, callback);
158
128
  }
159
129
 
160
130
  /**
@@ -184,26 +154,12 @@ export class Content {
184
154
  },
185
155
  };
186
156
 
187
- return this.client.sendRequest(config, callback, { methodName: 'server.deleteContent' });
157
+ return this.client.sendRequest(config, callback);
188
158
  }
189
159
 
190
- /**
191
- * Returns the history of a particular piece of content
192
- *
193
- * @example
194
- * Example request URI(s):
195
- *
196
- * http://example.com/rest/api/content/1234/history
197
- */
160
+ /** Returns the history of a particular piece of content */
198
161
  async getHistory<T = Models.ContentHistory>(parameters: Parameters.GetHistory, callback: Callback<T>): Promise<void>;
199
- /**
200
- * Returns the history of a particular piece of content
201
- *
202
- * @example
203
- * Example request URI(s):
204
- *
205
- * http://example.com/rest/api/content/1234/history
206
- */
162
+ /** Returns the history of a particular piece of content */
207
163
  async getHistory<T = Models.ContentHistory>(parameters: Parameters.GetHistory, callback?: never): Promise<T>;
208
164
  async getHistory<T = Models.ContentHistory>(
209
165
  parameters: Parameters.GetHistory,
@@ -217,7 +173,7 @@ export class Content {
217
173
  },
218
174
  };
219
175
 
220
- return this.client.sendRequest(config, callback, { methodName: 'server.getHistory' });
176
+ return this.client.sendRequest(config, callback);
221
177
  }
222
178
 
223
179
  /**
@@ -229,7 +185,8 @@ export class Content {
229
185
  *
230
186
  * Collecting a macro by its hash should now be considered deprecated and will be replaced, transparently with
231
187
  * macroIds. This resource is currently only called from connect addons which will eventually all use the
232
- * {@link #getContentById(com.atlassian.confluence.api.model.content.id.ContentId, java.util.List, Integer, String)} resource.
188
+ * {@link #getContentById(com.atlassian.confluence.api.model.content.id.ContentId, java.util.List, Integer, String)}
189
+ * resource.
233
190
  *
234
191
  * To make the migration as seamless as possible, this resource will match macros against a generated hash or a stored
235
192
  * macroId. This will allow add ons to work during the migration period.
@@ -247,7 +204,8 @@ export class Content {
247
204
  *
248
205
  * Collecting a macro by its hash should now be considered deprecated and will be replaced, transparently with
249
206
  * macroIds. This resource is currently only called from connect addons which will eventually all use the
250
- * {@link #getContentById(com.atlassian.confluence.api.model.content.id.ContentId, java.util.List, Integer, String)} resource.
207
+ * {@link #getContentById(com.atlassian.confluence.api.model.content.id.ContentId, java.util.List, Integer, String)}
208
+ * resource.
251
209
  *
252
210
  * To make the migration as seamless as possible, this resource will match macros against a generated hash or a stored
253
211
  * macroId. This will allow add ons to work during the migration period.
@@ -265,7 +223,7 @@ export class Content {
265
223
  method: 'GET',
266
224
  };
267
225
 
268
- return this.client.sendRequest(config, callback, { methodName: 'server.getMacroBodyByHash' });
226
+ return this.client.sendRequest(config, callback);
269
227
  }
270
228
 
271
229
  /**
@@ -307,35 +265,15 @@ export class Content {
307
265
  method: 'GET',
308
266
  };
309
267
 
310
- return this.client.sendRequest(config, callback, { methodName: 'server.getMacroBodyByMacroId' });
268
+ return this.client.sendRequest(config, callback);
311
269
  }
312
270
 
313
- /**
314
- * Fetch a list of content using the Confluence Query Language (CQL). See: Advanced searching using CQL
315
- *
316
- * @example
317
- * For example :
318
- *
319
- * Example request URI(s):
320
- *
321
- * - http://localhost:8080/confluence/rest/api/content/search?cql=creator=currentUser()&cqlcontext={%22spaceKey%22:%22TST%22,%22contentId%22:%2255%22}
322
- * - http://localhost:8080/confluence/rest/api/content/search?cql=space=DEV%20AND%20label=docs&expand=space,metadata.labels&limit=10
323
- */
271
+ /** Fetch a list of content using the Confluence Query Language (CQL). See: Advanced searching using CQL */
324
272
  async searchContent<T = Pagination<Models.Content>>(
325
273
  parameters: Parameters.SearchContent | undefined,
326
274
  callback: Callback<T>
327
275
  ): Promise<void>;
328
- /**
329
- * Fetch a list of content using the Confluence Query Language (CQL). See: Advanced searching using CQL
330
- *
331
- * @example
332
- * For example :
333
- *
334
- * Example request URI(s):
335
- *
336
- * - http://localhost:8080/confluence/rest/api/content/search?cql=creator=currentUser()&cqlcontext={%22spaceKey%22:%22TST%22,%22contentId%22:%2255%22}
337
- * - http://localhost:8080/confluence/rest/api/content/search?cql=space=DEV%20AND%20label=docs&expand=space,metadata.labels&limit=10
338
- */
276
+ /** Fetch a list of content using the Confluence Query Language (CQL). See: Advanced searching using CQL */
339
277
  async searchContent<T = Pagination<Models.Content>>(
340
278
  parameters?: Parameters.SearchContent,
341
279
  callback?: never
@@ -356,7 +294,7 @@ export class Content {
356
294
  },
357
295
  };
358
296
 
359
- return this.client.sendRequest(config, callback, { methodName: 'server.searchContent' });
297
+ return this.client.sendRequest(config, callback);
360
298
  }
361
299
 
362
300
  /**
@@ -368,13 +306,6 @@ export class Content {
368
306
  *
369
307
  * If no types are included in the expand parameter, the map returned will just list the child types that are
370
308
  * available to be expanded for the Content referenced by the "id" path parameter.
371
- *
372
- * @example
373
- * Example request URI(s):
374
- *
375
- * - http://example.com/rest/api/content/1234/child
376
- * - http://example.com/rest/api/content/1234/child?expand=page.body.VIEW
377
- * - http://example.com/rest/api/content/1234/child?expand=page&start=20&limit=10
378
309
  */
379
310
  async getContentChildren<T = Models.ContentChildren>(
380
311
  parameters: Parameters.GetContentChildren,
@@ -389,15 +320,11 @@ export class Content {
389
320
  *
390
321
  * If no types are included in the expand parameter, the map returned will just list the child types that are
391
322
  * available to be expanded for the Content referenced by the "id" path parameter.
392
- *
393
- * @example
394
- * Example request URI(s):
395
- *
396
- * - http://example.com/rest/api/content/1234/child
397
- * - http://example.com/rest/api/content/1234/child?expand=page.body.VIEW
398
- * - http://example.com/rest/api/content/1234/child?expand=page&start=20&limit=10
399
323
  */
400
- async getContentChildren<T = Models.ContentChildren>(parameters: Parameters.GetContentChildren, callback?: never): Promise<T>;
324
+ async getContentChildren<T = Models.ContentChildren>(
325
+ parameters: Parameters.GetContentChildren,
326
+ callback?: never
327
+ ): Promise<T>;
401
328
  async getContentChildren<T = Models.ContentChildren>(
402
329
  parameters: Parameters.GetContentChildren,
403
330
  callback?: Callback<T>,
@@ -413,21 +340,13 @@ export class Content {
413
340
  },
414
341
  };
415
342
 
416
- return this.client.sendRequest(config, callback, { methodName: 'server.getContentChildren' });
343
+ return this.client.sendRequest(config, callback);
417
344
  }
418
345
 
419
346
  /**
420
347
  * Returns the direct children of a piece of Content, limited to a single child type.
421
348
  *
422
349
  * The ContentType(s) of the children returned is specified by the "type" path parameter in the request.
423
- *
424
- * @example
425
- * Example request URI(s):
426
- *
427
- * - http://example.com/rest/api/content/1234/child/page
428
- * - http://example.com/rest/api/content/1234/child/comment
429
- * - http://example.com/rest/api/content/1234/child/page?expand=body.view
430
- * - http://example.com/rest/api/content/1234/child/comment?start=20&limit=10
431
350
  */
432
351
  async getContentChildrenByType<T = Pagination<Models.Content>>(
433
352
  parameters: Parameters.GetContentChildrenByType,
@@ -437,14 +356,6 @@ export class Content {
437
356
  * Returns the direct children of a piece of Content, limited to a single child type.
438
357
  *
439
358
  * The ContentType(s) of the children returned is specified by the "type" path parameter in the request.
440
- *
441
- * @example
442
- * Example request URI(s):
443
- *
444
- * - http://example.com/rest/api/content/1234/child/page
445
- * - http://example.com/rest/api/content/1234/child/comment
446
- * - http://example.com/rest/api/content/1234/child/page?expand=body.view
447
- * - http://example.com/rest/api/content/1234/child/comment?start=20&limit=10
448
359
  */
449
360
  async getContentChildrenByType<T = Pagination<Models.Content>>(
450
361
  parameters: Parameters.GetContentChildrenByType,
@@ -465,37 +376,15 @@ export class Content {
465
376
  },
466
377
  };
467
378
 
468
- return this.client.sendRequest(config, callback, { methodName: 'server.getContentChildrenByType' });
379
+ return this.client.sendRequest(config, callback);
469
380
  }
470
381
 
471
- /**
472
- * Returns the comments of a content
473
- *
474
- * @example
475
- * Example request URI(s):
476
- *
477
- * - http://example.com/rest/api/content/1234/child/comment
478
- * - http://example.com/rest/api/content/1234/child/comment?expand=body.view
479
- * - http://example.com/rest/api/content/1234/child/comment?start=20&limit=10
480
- * - http://example.com/rest/api/content/1234/child/comment?location=footer&location=inline&location=resolved
481
- * - http://example.com/rest/api/content/1234/child/comment?expand=extensions.inlineProperties,extensions.resolution
482
- */
382
+ /** Returns the comments of a content */
483
383
  async getContentComments<T = Pagination<Models.Content>>(
484
384
  parameters: Parameters.GetContentComments,
485
385
  callback: Callback<T>
486
386
  ): Promise<void>;
487
- /**
488
- * Returns the comments of a content
489
- *
490
- * @example
491
- * Example request URI(s):
492
- *
493
- * - http://example.com/rest/api/content/1234/child/comment
494
- * - http://example.com/rest/api/content/1234/child/comment?expand=body.view
495
- * - http://example.com/rest/api/content/1234/child/comment?start=20&limit=10
496
- * - http://example.com/rest/api/content/1234/child/comment?location=footer&location=inline&location=resolved
497
- * - http://example.com/rest/api/content/1234/child/comment?expand=extensions.inlineProperties,extensions.resolution
498
- */
387
+ /** Returns the comments of a content */
499
388
  async getContentComments<T = Pagination<Models.Content>>(
500
389
  parameters: Parameters.GetContentComments,
501
390
  callback?: never
@@ -517,31 +406,15 @@ export class Content {
517
406
  },
518
407
  };
519
408
 
520
- return this.client.sendRequest(config, callback, { methodName: 'server.getContentComments' });
409
+ return this.client.sendRequest(config, callback);
521
410
  }
522
411
 
523
- /**
524
- * Returns a paginated list of attachment Content entities within a single container.
525
- *
526
- * @example
527
- * Example request URI(s):
528
- *
529
- * - http://example.com/rest/api/content/1234/child/attachment?start=0&limit=10
530
- * - http://example.com/rest/api/content/1234/child/attachment?filename=myfile.txt&expand=version,container
531
- */
412
+ /** Returns a paginated list of attachment Content entities within a single container. */
532
413
  async getAttachments<T = Pagination<Models.Content>>(
533
414
  parameters: Parameters.GetAttachments,
534
415
  callback: Callback<T>
535
416
  ): Promise<void>;
536
- /**
537
- * Returns a paginated list of attachment Content entities within a single container.
538
- *
539
- * @example
540
- * Example request URI(s):
541
- *
542
- * - http://example.com/rest/api/content/1234/child/attachment?start=0&limit=10
543
- * - http://example.com/rest/api/content/1234/child/attachment?filename=myfile.txt&expand=version,container
544
- */
417
+ /** Returns a paginated list of attachment Content entities within a single container. */
545
418
  async getAttachments<T = Pagination<Models.Content>>(
546
419
  parameters: Parameters.GetAttachments,
547
420
  callback?: never
@@ -562,7 +435,7 @@ export class Content {
562
435
  },
563
436
  };
564
437
 
565
- return this.client.sendRequest(config, callback, { methodName: 'server.getAttachments' });
438
+ return this.client.sendRequest(config, callback);
566
439
  }
567
440
 
568
441
  /**
@@ -576,7 +449,8 @@ export class Content {
576
449
  * Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.
577
450
  *
578
451
  * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection
579
- * on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.
452
+ * on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be
453
+ * blocked.
580
454
  *
581
455
  * The name of the multipart/form-data parameter that contains attachments must be "file"
582
456
  *
@@ -588,11 +462,6 @@ export class Content {
588
462
  * http://myhost/rest/api/content/123/child/attachment An example to attach the same file, with no comment: curl -D-
589
463
  * -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt"
590
464
  * http://myhost/rest/api/content/123/child/attachment
591
- *
592
- * @example
593
- * Example request URI(s):
594
- *
595
- * - http://example.com/rest/api/content/1234/child/attachment
596
465
  */
597
466
  async createAttachments<T = Pagination<Models.Content>>(
598
467
  parameters: Parameters.CreateAttachments,
@@ -609,7 +478,8 @@ export class Content {
609
478
  * Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.
610
479
  *
611
480
  * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection
612
- * on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.
481
+ * on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be
482
+ * blocked.
613
483
  *
614
484
  * The name of the multipart/form-data parameter that contains attachments must be "file"
615
485
  *
@@ -621,11 +491,6 @@ export class Content {
621
491
  * http://myhost/rest/api/content/123/child/attachment An example to attach the same file, with no comment: curl -D-
622
492
  * -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt"
623
493
  * http://myhost/rest/api/content/123/child/attachment
624
- *
625
- * @example
626
- * Example request URI(s):
627
- *
628
- * - http://example.com/rest/api/content/1234/child/attachment
629
494
  */
630
495
  async createAttachments<T = Pagination<Models.Content>>(
631
496
  parameters: Parameters.CreateAttachments,
@@ -638,6 +503,10 @@ export class Content {
638
503
  const config: RequestConfig = {
639
504
  url: `/rest/api/content/${parameters.id}/child/attachment`,
640
505
  method: 'POST',
506
+ headers: {
507
+ 'Content-Type': 'multipart/form-data',
508
+ 'X-Atlassian-Token': 'nocheck',
509
+ },
641
510
  params: {
642
511
  status: parameters.status,
643
512
  },
@@ -648,18 +517,13 @@ export class Content {
648
517
  },
649
518
  };
650
519
 
651
- return this.client.sendRequest(config, callback, { methodName: 'server.createAttachments' });
520
+ return this.client.sendRequest(config, callback);
652
521
  }
653
522
 
654
523
  /**
655
524
  * Update the non-binary data of an Attachment.
656
525
  *
657
526
  * This resource can be used to update an attachment's filename, media-type, comment, and parent container.
658
- *
659
- * @example
660
- * Example request URI(s):
661
- *
662
- * - http://example.com/rest/api/content/1234/child/attachment/5678
663
527
  */
664
528
  async updateAttachmentProperties<T = Models.Content>(
665
529
  parameters: Parameters.UpdateAttachmentProperties,
@@ -669,11 +533,6 @@ export class Content {
669
533
  * Update the non-binary data of an Attachment.
670
534
  *
671
535
  * This resource can be used to update an attachment's filename, media-type, comment, and parent container.
672
- *
673
- * @example
674
- * Example request URI(s):
675
- *
676
- * - http://example.com/rest/api/content/1234/child/attachment/5678
677
536
  */
678
537
  async updateAttachmentProperties<T = Models.Content>(
679
538
  parameters: Parameters.UpdateAttachmentProperties,
@@ -693,7 +552,7 @@ export class Content {
693
552
  },
694
553
  };
695
554
 
696
- return this.client.sendRequest(config, callback, { methodName: 'server.updateAttachmentProperties' });
555
+ return this.client.sendRequest(config, callback);
697
556
  }
698
557
 
699
558
  /**
@@ -709,7 +568,8 @@ export class Content {
709
568
  * Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.
710
569
  *
711
570
  * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection
712
- * on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.
571
+ * on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be
572
+ * blocked.
713
573
  *
714
574
  * The name of the multipart/form-data parameter that contains attachments must be "file"
715
575
  *
@@ -720,11 +580,6 @@ export class Content {
720
580
  *
721
581
  * An example to upload the same file, with no comment: curl -D- -u admin:admin -X POST -H "X-Atlassian-Token:
722
582
  * nocheck" -F "file=@myfile.txt" http://myhost/rest/api/content/123/child/attachment/456/data
723
- *
724
- * @example
725
- * Example request URI(s):
726
- *
727
- * - http://example.com/rest/api/content/1234/child/attachment/5678/data
728
583
  */
729
584
  async updateAttachmentData<T = Models.Content>(
730
585
  parameters: Parameters.UpdateAttachmentData,
@@ -743,7 +598,8 @@ export class Content {
743
598
  * Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.
744
599
  *
745
600
  * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection
746
- * on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.
601
+ * on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be
602
+ * blocked.
747
603
  *
748
604
  * The name of the multipart/form-data parameter that contains attachments must be "file"
749
605
  *
@@ -754,11 +610,6 @@ export class Content {
754
610
  *
755
611
  * An example to upload the same file, with no comment: curl -D- -u admin:admin -X POST -H "X-Atlassian-Token:
756
612
  * nocheck" -F "file=@myfile.txt" http://myhost/rest/api/content/123/child/attachment/456/data
757
- *
758
- * @example
759
- * Example request URI(s):
760
- *
761
- * - http://example.com/rest/api/content/1234/child/attachment/5678/data
762
613
  */
763
614
  async updateAttachmentData<T = Models.Content>(
764
615
  parameters: Parameters.UpdateAttachmentData,
@@ -771,6 +622,10 @@ export class Content {
771
622
  const config: RequestConfig = {
772
623
  url: `/rest/api/content/${parameters.id}/child/attachment/${parameters.attachmentId}/data`,
773
624
  method: 'POST',
625
+ headers: {
626
+ 'Content-Type': 'multipart/form-data',
627
+ 'X-Atlassian-Token': 'nocheck',
628
+ },
774
629
  data: {
775
630
  ...parameters,
776
631
  id: undefined,
@@ -778,7 +633,7 @@ export class Content {
778
633
  },
779
634
  };
780
635
 
781
- return this.client.sendRequest(config, callback, { methodName: 'server.updateAttachmentData' });
636
+ return this.client.sendRequest(config, callback);
782
637
  }
783
638
 
784
639
  /**
@@ -792,13 +647,6 @@ export class Content {
792
647
  * available to be expanded for the Content referenced by the "id" path parameter.
793
648
  *
794
649
  * Currently the only supported descendants are comment descendants of non-comment Content.
795
- *
796
- * @example
797
- * Example request URI(s):
798
- *
799
- * - http://example.com/rest/api/content/1234/descendant
800
- * - http://example.com/rest/api/content/1234/descendant?expand=comment.body.VIEW
801
- * - http://example.com/rest/api/content/1234/descendant?expand=comment
802
650
  */
803
651
  async getContentDescendants<T = Models.ContentChildren>(
804
652
  parameters: Parameters.GetContentDescendants,
@@ -815,13 +663,6 @@ export class Content {
815
663
  * available to be expanded for the Content referenced by the "id" path parameter.
816
664
  *
817
665
  * Currently the only supported descendants are comment descendants of non-comment Content.
818
- *
819
- * @example
820
- * Example request URI(s):
821
- *
822
- * - http://example.com/rest/api/content/1234/descendant
823
- * - http://example.com/rest/api/content/1234/descendant?expand=comment.body.VIEW
824
- * - http://example.com/rest/api/content/1234/descendant?expand=comment
825
666
  */
826
667
  async getContentDescendants<T = Models.ContentChildren>(
827
668
  parameters: Parameters.GetContentDescendants,
@@ -839,7 +680,7 @@ export class Content {
839
680
  },
840
681
  };
841
682
 
842
- return this.client.sendRequest(config, callback, { methodName: 'server.getContentDescendants' });
683
+ return this.client.sendRequest(config, callback);
843
684
  }
844
685
 
845
686
  /**
@@ -848,13 +689,6 @@ export class Content {
848
689
  * The ContentType(s) of the descendants returned is specified by the "type" path parameter in the request.
849
690
  *
850
691
  * Currently the only supported descendants are comment descendants of non-comment Content.
851
- *
852
- * @example
853
- * Example request URI(s):
854
- *
855
- * - http://example.com/rest/api/content/1234/descendant/comment
856
- * - http://example.com/rest/api/content/1234/descendant/comment?expand=body.VIEW
857
- * - http://example.com/rest/api/content/1234/descendant/comment?start=20&limit=10
858
692
  */
859
693
  async getContentDescendantsOfType<T = Pagination<Models.Content>>(
860
694
  parameters: Parameters.GetContentDescendantsOfType,
@@ -866,13 +700,6 @@ export class Content {
866
700
  * The ContentType(s) of the descendants returned is specified by the "type" path parameter in the request.
867
701
  *
868
702
  * Currently the only supported descendants are comment descendants of non-comment Content.
869
- *
870
- * @example
871
- * Example request URI(s):
872
- *
873
- * - http://example.com/rest/api/content/1234/descendant/comment
874
- * - http://example.com/rest/api/content/1234/descendant/comment?expand=body.VIEW
875
- * - http://example.com/rest/api/content/1234/descendant/comment?start=20&limit=10
876
703
  */
877
704
  async getContentDescendantsOfType<T = Pagination<Models.Content>>(
878
705
  parameters: Parameters.GetContentDescendantsOfType,
@@ -892,31 +719,15 @@ export class Content {
892
719
  },
893
720
  };
894
721
 
895
- return this.client.sendRequest(config, callback, { methodName: 'server.getContentDescendantsOfType' });
722
+ return this.client.sendRequest(config, callback);
896
723
  }
897
724
 
898
- /**
899
- * Returns the list of labels on a piece of Content.
900
- *
901
- * @example
902
- * Example request URI(s):
903
- *
904
- * - http://example.com/rest/api/content/1234/label
905
- * - http://example.com/rest/api/content/1234/label?prefix=global&start=0&limit=200
906
- */
725
+ /** Returns the list of labels on a piece of Content. */
907
726
  async getContentLabels<T = Pagination<Models.Label>>(
908
727
  parameters: Parameters.GetContentLabels,
909
728
  callback: Callback<T>
910
729
  ): Promise<void>;
911
- /**
912
- * Returns the list of labels on a piece of Content.
913
- *
914
- * @example
915
- * Example request URI(s):
916
- *
917
- * - http://example.com/rest/api/content/1234/label
918
- * - http://example.com/rest/api/content/1234/label?prefix=global&start=0&limit=200
919
- */
730
+ /** Returns the list of labels on a piece of Content. */
920
731
  async getContentLabels<T = Pagination<Models.Label>>(
921
732
  parameters: Parameters.GetContentLabels,
922
733
  callback?: never
@@ -935,7 +746,7 @@ export class Content {
935
746
  },
936
747
  };
937
748
 
938
- return this.client.sendRequest(config, callback, { methodName: 'server.getContentLabels' });
749
+ return this.client.sendRequest(config, callback);
939
750
  }
940
751
 
941
752
  /** Adds a list of labels to the specified content. The body is the json representation of the list. */
@@ -958,7 +769,7 @@ export class Content {
958
769
  data: parameters.labels,
959
770
  };
960
771
 
961
- return this.client.sendRequest(config, callback, { methodName: 'server.addLabelsToContent' });
772
+ return this.client.sendRequest(config, callback);
962
773
  }
963
774
 
964
775
  /** Deletes a labels to the specified content. */
@@ -983,7 +794,7 @@ export class Content {
983
794
  },
984
795
  };
985
796
 
986
- return this.client.sendRequest(config, callback, { methodName: 'server.deleteLabelWithQueryParam' });
797
+ return this.client.sendRequest(config, callback);
987
798
  }
988
799
 
989
800
  /**
@@ -1004,29 +815,15 @@ export class Content {
1004
815
  method: 'DELETE',
1005
816
  };
1006
817
 
1007
- return this.client.sendRequest(config, callback, { methodName: 'server.deleteLabel' });
818
+ return this.client.sendRequest(config, callback);
1008
819
  }
1009
820
 
1010
- /**
1011
- * Returns a paginated list of content properties.
1012
- *
1013
- * @example
1014
- * Example request URI:
1015
- *
1016
- * - http://example.com/rest/api/content/1234/property?expand=content,version
1017
- */
821
+ /** Returns a paginated list of content properties. */
1018
822
  async getContentProperties<T = Pagination<Models.ContentProperty>>(
1019
823
  parameters: Parameters.GetContentProperties,
1020
824
  callback: Callback<T>
1021
825
  ): Promise<void>;
1022
- /**
1023
- * Returns a paginated list of content properties.
1024
- *
1025
- * @example
1026
- * Example request URI:
1027
- *
1028
- * - http://example.com/rest/api/content/1234/property?expand=content,version
1029
- */
826
+ /** Returns a paginated list of content properties. */
1030
827
  async getContentProperties<T = Pagination<Models.ContentProperty>>(
1031
828
  parameters: Parameters.GetContentProperties,
1032
829
  callback?: never
@@ -1045,7 +842,7 @@ export class Content {
1045
842
  },
1046
843
  };
1047
844
 
1048
- return this.client.sendRequest(config, callback, { methodName: 'server.getContentProperties' });
845
+ return this.client.sendRequest(config, callback);
1049
846
  }
1050
847
 
1051
848
  /** Creates a new content property. */
@@ -1071,29 +868,15 @@ export class Content {
1071
868
  },
1072
869
  };
1073
870
 
1074
- return this.client.sendRequest(config, callback, { methodName: 'server.createContentProperty' });
871
+ return this.client.sendRequest(config, callback);
1075
872
  }
1076
873
 
1077
- /**
1078
- * Returns a content property.
1079
- *
1080
- * @example
1081
- * Example request URI:
1082
- *
1083
- * - http://example.com/rest/api/content/1234/property/example-property-key?expand=content,version
1084
- */
874
+ /** Returns a content property. */
1085
875
  async getContentProperty<T = Models.ContentProperty>(
1086
876
  parameters: Parameters.GetContentProperty,
1087
877
  callback: Callback<T>
1088
878
  ): Promise<void>;
1089
- /**
1090
- * Returns a content property.
1091
- *
1092
- * @example
1093
- * Example request URI:
1094
- *
1095
- * - http://example.com/rest/api/content/1234/property/example-property-key?expand=content,version
1096
- */
879
+ /** Returns a content property. */
1097
880
  async getContentProperty<T = Models.ContentProperty>(
1098
881
  parameters: Parameters.GetContentProperty,
1099
882
  callback?: never
@@ -1110,7 +893,7 @@ export class Content {
1110
893
  },
1111
894
  };
1112
895
 
1113
- return this.client.sendRequest(config, callback, { methodName: 'server.getContentProperty' });
896
+ return this.client.sendRequest(config, callback);
1114
897
  }
1115
898
 
1116
899
  /** Creates a new content property. */
@@ -1135,7 +918,7 @@ export class Content {
1135
918
  },
1136
919
  };
1137
920
 
1138
- return this.client.sendRequest(config, callback, { methodName: 'server.createContentPropertyForKey' });
921
+ return this.client.sendRequest(config, callback);
1139
922
  }
1140
923
 
1141
924
  /**
@@ -1173,7 +956,7 @@ export class Content {
1173
956
  },
1174
957
  };
1175
958
 
1176
- return this.client.sendRequest(config, callback, { methodName: 'server.updateContentProperty' });
959
+ return this.client.sendRequest(config, callback);
1177
960
  }
1178
961
 
1179
962
  /** Deletes a content property. */
@@ -1192,7 +975,7 @@ export class Content {
1192
975
  method: 'DELETE',
1193
976
  };
1194
977
 
1195
- return this.client.sendRequest(config, callback, { methodName: 'server.deleteContentProperty' });
978
+ return this.client.sendRequest(config, callback);
1196
979
  }
1197
980
 
1198
981
  /** Returns info about all restrictions by operation */
@@ -1217,7 +1000,7 @@ export class Content {
1217
1000
  },
1218
1001
  };
1219
1002
 
1220
- return this.client.sendRequest(config, callback, { methodName: 'server.getRestrictionsByOperation' });
1003
+ return this.client.sendRequest(config, callback);
1221
1004
  }
1222
1005
 
1223
1006
  /** Returns info about all restrictions of given operation */
@@ -1244,7 +1027,7 @@ export class Content {
1244
1027
  },
1245
1028
  };
1246
1029
 
1247
- return this.client.sendRequest(config, callback, { methodName: 'server.getRestrictionsForOperation' });
1030
+ return this.client.sendRequest(config, callback);
1248
1031
  }
1249
1032
 
1250
1033
  /** Publishes a legacy draft of a Content created from a ContentBlueprint */
@@ -1267,7 +1050,7 @@ export class Content {
1267
1050
  },
1268
1051
  };
1269
1052
 
1270
- return this.client.sendRequest(config, callback, { methodName: 'server.publishLegacyDraft' });
1053
+ return this.client.sendRequest(config, callback);
1271
1054
  }
1272
1055
 
1273
1056
  /** Publishes a shared draft of a Content created from a ContentBlueprint */
@@ -1290,6 +1073,6 @@ export class Content {
1290
1073
  },
1291
1074
  };
1292
1075
 
1293
- return this.client.sendRequest(config, callback, { methodName: 'server.publishSharedDraft' });
1076
+ return this.client.sendRequest(config, callback);
1294
1077
  }
1295
1078
  }