@resolution/confluence-api-client 0.12.4 → 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.
Files changed (40) hide show
  1. package/lib/index.d.ts +2 -2
  2. package/lib/index.js +2 -1
  3. package/lib/index.js.map +1 -1
  4. package/lib/openapi/core/CommonHttpClient.d.ts +4 -0
  5. package/lib/openapi/core/CommonHttpClient.js +32 -20
  6. package/lib/openapi/core/CommonHttpClient.js.map +1 -1
  7. package/lib/openapi/v1/services/ContentAttachmentsService.d.ts +7 -2
  8. package/lib/openapi/v1/services/ContentAttachmentsService.js +4 -3
  9. package/lib/openapi/v1/services/ContentAttachmentsService.js.map +1 -1
  10. package/lib/openapi/v1/services/ContentMacroBodyService.d.ts +69 -0
  11. package/lib/openapi/v1/services/ContentMacroBodyService.js +69 -0
  12. package/lib/openapi/v1/services/ContentMacroBodyService.js.map +1 -1
  13. package/lib/openapi/v1/services/TemplateService.d.ts +15 -5
  14. package/lib/openapi/v1/services/TemplateService.js +11 -1
  15. package/lib/openapi/v1/services/TemplateService.js.map +1 -1
  16. package/lib/openapi/v2/services/AttachmentService.d.ts +3 -1
  17. package/lib/openapi/v2/services/AttachmentService.js +3 -2
  18. package/lib/openapi/v2/services/AttachmentService.js.map +1 -1
  19. package/lib/openapi/v2/services/BlogPostService.d.ts +9 -1
  20. package/lib/openapi/v2/services/BlogPostService.js +4 -2
  21. package/lib/openapi/v2/services/BlogPostService.js.map +1 -1
  22. package/lib/openapi/v2/services/CustomContentService.d.ts +3 -1
  23. package/lib/openapi/v2/services/CustomContentService.js +3 -2
  24. package/lib/openapi/v2/services/CustomContentService.js.map +1 -1
  25. package/lib/openapi/v2/services/DatabaseService.d.ts +27 -1
  26. package/lib/openapi/v2/services/DatabaseService.js +7 -1
  27. package/lib/openapi/v2/services/DatabaseService.js.map +1 -1
  28. package/lib/openapi/v2/services/FolderService.d.ts +27 -1
  29. package/lib/openapi/v2/services/FolderService.js +7 -1
  30. package/lib/openapi/v2/services/FolderService.js.map +1 -1
  31. package/lib/openapi/v2/services/PageService.d.ts +12 -1
  32. package/lib/openapi/v2/services/PageService.js +11 -2
  33. package/lib/openapi/v2/services/PageService.js.map +1 -1
  34. package/lib/openapi/v2/services/SmartLinkService.d.ts +27 -1
  35. package/lib/openapi/v2/services/SmartLinkService.js +7 -1
  36. package/lib/openapi/v2/services/SmartLinkService.js.map +1 -1
  37. package/lib/openapi/v2/services/WhiteboardService.d.ts +27 -1
  38. package/lib/openapi/v2/services/WhiteboardService.js +7 -1
  39. package/lib/openapi/v2/services/WhiteboardService.js.map +1 -1
  40. package/package.json +3 -3
@@ -82,9 +82,35 @@ export declare class WhiteboardService extends CommonHttpService {
82
82
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard#api-whiteboards-id-get
83
83
  * @param params
84
84
  */
85
- getWhiteboardById: ({ id }: {
85
+ getWhiteboardById: ({ id, includeCollaborators, includeDirectChildren, includeOperations, includeProperties }: {
86
86
  /** The ID of the whiteboard to be returned */
87
87
  id: number;
88
+ /** Includes collaborators on the whiteboard. */
89
+ includeCollaborators?: boolean | undefined;
90
+ /**
91
+ * Includes direct children of the whiteboard.
92
+ * The number of results will be limited to 50 and sorted in the default sort
93
+ * order.
94
+ * A `meta` and `_links` property will be present to indicate if more results are
95
+ * available and a link to retrieve the rest of the results.
96
+ */
97
+ includeDirectChildren?: boolean | undefined;
98
+ /**
99
+ * Includes operations associated with this whiteboard in the response.
100
+ * The number of results will be limited to 50 and sorted in the default sort
101
+ * order.
102
+ * A `meta` and `_links` property will be present to indicate if more results are
103
+ * available and a link to retrieve the rest of the results.
104
+ */
105
+ includeOperations?: boolean | undefined;
106
+ /**
107
+ * Includes content properties associated with this whiteboard in the response.
108
+ * The number of results will be limited to 50 and sorted in the default sort
109
+ * order.
110
+ * A `meta` and `_links` property will be present to indicate if more results are
111
+ * available and a link to retrieve the rest of the results.
112
+ */
113
+ includeProperties?: boolean | undefined;
88
114
  }) => Promise<WhiteboardSingle & {
89
115
  _links?: ({
90
116
  /** Base url of the Confluence site. */
@@ -82,12 +82,18 @@ class WhiteboardService extends CommonHttpService_1.CommonHttpService {
82
82
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard#api-whiteboards-id-get
83
83
  * @param params
84
84
  */
85
- this.getWhiteboardById = ({ id }) => {
85
+ this.getWhiteboardById = ({ id, includeCollaborators, includeDirectChildren, includeOperations, includeProperties }) => {
86
86
  return this.getClientInstance().request({
87
87
  path: "/whiteboards/{id}",
88
88
  method: "GET",
89
89
  pathParams: {
90
90
  id
91
+ },
92
+ query: {
93
+ "include-collaborators": includeCollaborators,
94
+ "include-direct-children": includeDirectChildren,
95
+ "include-operations": includeOperations,
96
+ "include-properties": includeProperties
91
97
  }
92
98
  }).then(this.getClientInstance().responseHandler({
93
99
  200: {
@@ -1 +1 @@
1
- {"version":3,"file":"WhiteboardService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/WhiteboardService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,gEAAgE;AAChE,oEAAiE;AACjE,qDAAkG;AAClG,wEAAqE;AACrE,6BAAwB;AACxB;;;GAGG;AACH,MAAa,iBAAkB,SAAQ,qCAAiB;IAAxD;;QACE;;;;;;;;;;;;WAYG;QACH,qBAAgB,GAAG,CAAC,EAClB,OAAO,EAAE,YAAY,EACrB,WAAW,EAwBZ,EASG,EAAE;YACJ,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,cAAc;gBACpB,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE;oBACL,OAAO,EAAE,YAAY;iBACtB;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,WAAW;aAClB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAYlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,6CAA6C,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACnK,CAAC,CAAC;QACF;;;;;;;;;;;;;;WAcG;QACH,qBAAgB,GAAG,CAAC,EAClB,EAAE,EAIH,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,mBAAmB;gBACzB,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,EAAE;iBACH;aACF,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;WAWG;QACH,sBAAiB,GAAG,CAAC,EACnB,EAAE,EAIH,EASG,EAAE;YACJ,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,mBAAmB;gBACzB,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAYlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,8CAA8C,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpK,CAAC,CAAC;IAsBJ,CAAC;IArBW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CAAC,6CAA6C,EAAE,OAAC,CAAC,MAAM,CAAC;YACjG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,YAAY,CAAC,iDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,OAAC,CAAC,MAAM,CAAC;gBAC9E,MAAM,EAAE,OAAC,CAAC,MAAM,CAAC;oBACf,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;iBAC5B,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;aACpC,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SAC1B,CAAC,CAAC,QAAQ,CAAC,6CAA6C,CAAC,CAAC,CAAC;QAC5D,iDAAuB,CAAC,kBAAkB,CAAC,8CAA8C,EAAE,OAAC,CAAC,MAAM,CAAC;YAClG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,YAAY,CAAC,iDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,OAAC,CAAC,MAAM,CAAC;gBAC9E,MAAM,EAAE,OAAC,CAAC,MAAM,CAAC;oBACf,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;iBAC5B,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;aACpC,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SAC1B,CAAC,CAAC,QAAQ,CAAC,8CAA8C,CAAC,CAAC,CAAC;QAC7D,iDAAuB,CAAC,YAAY,CAAC,CAAC,gDAAmC,CAAC,CAAC,CAAC;IAC9E,CAAC;CACF;AAnLD,8CAmLC"}
1
+ {"version":3,"file":"WhiteboardService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/WhiteboardService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,gEAAgE;AAChE,oEAAiE;AACjE,qDAAkG;AAClG,wEAAqE;AACrE,6BAAwB;AACxB;;;GAGG;AACH,MAAa,iBAAkB,SAAQ,qCAAiB;IAAxD;;QACE;;;;;;;;;;;;WAYG;QACH,qBAAgB,GAAG,CAAC,EAClB,OAAO,EAAE,YAAY,EACrB,WAAW,EAwBZ,EASG,EAAE;YACJ,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,cAAc;gBACpB,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE;oBACL,OAAO,EAAE,YAAY;iBACtB;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,WAAW;aAClB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAYlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,6CAA6C,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACnK,CAAC,CAAC;QACF;;;;;;;;;;;;;;WAcG;QACH,qBAAgB,GAAG,CAAC,EAClB,EAAE,EAIH,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,mBAAmB;gBACzB,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,EAAE;iBACH;aACF,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;WAWG;QACH,sBAAiB,GAAG,CAAC,EACnB,EAAE,EACF,oBAAoB,EACpB,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,EA8BlB,EASG,EAAE;YACJ,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,mBAAmB;gBACzB,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,uBAAuB,EAAE,oBAAoB;oBAC7C,yBAAyB,EAAE,qBAAqB;oBAChD,oBAAoB,EAAE,iBAAiB;oBACvC,oBAAoB,EAAE,iBAAiB;iBACxC;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAYlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,8CAA8C,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpK,CAAC,CAAC;IAsBJ,CAAC;IArBW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CAAC,6CAA6C,EAAE,OAAC,CAAC,MAAM,CAAC;YACjG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,YAAY,CAAC,iDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,OAAC,CAAC,MAAM,CAAC;gBAC9E,MAAM,EAAE,OAAC,CAAC,MAAM,CAAC;oBACf,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;iBAC5B,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;aACpC,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SAC1B,CAAC,CAAC,QAAQ,CAAC,6CAA6C,CAAC,CAAC,CAAC;QAC5D,iDAAuB,CAAC,kBAAkB,CAAC,8CAA8C,EAAE,OAAC,CAAC,MAAM,CAAC;YAClG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,YAAY,CAAC,iDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,OAAC,CAAC,MAAM,CAAC;gBAC9E,MAAM,EAAE,OAAC,CAAC,MAAM,CAAC;oBACf,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;iBAC5B,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;aACpC,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SAC1B,CAAC,CAAC,QAAQ,CAAC,8CAA8C,CAAC,CAAC,CAAC;QAC7D,iDAAuB,CAAC,YAAY,CAAC,CAAC,gDAAmC,CAAC,CAAC,CAAC;IAC9E,CAAC;CACF;AAvND,8CAuNC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@resolution/confluence-api-client",
3
- "version": "0.12.4",
3
+ "version": "0.13.0",
4
4
  "description": "Confluence API Client based on OpenAPI Schema from Atlassian.",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",
@@ -38,10 +38,10 @@
38
38
  },
39
39
  "homepage": "https://bitbucket.org/resolutiongmbh/atlassian-api-clients#readme",
40
40
  "dependencies": {
41
- "@resolution/atlassian-api-common": "^0.12.4"
41
+ "@resolution/atlassian-api-common": "^0.13.0"
42
42
  },
43
43
  "publishConfig": {
44
44
  "access": "public"
45
45
  },
46
- "gitHead": "d7d07f75eb9c8d9e89bf229adae2468bddfb057f"
46
+ "gitHead": "efae5401ad76d0470aad8744f460e11dce3083b5"
47
47
  }