confluence.js 1.5.1 → 1.6.0

package/out/server/content.d.ts

@@ -6,34 +6,20 @@ import { Pagination } from '../pagination';
 export declare class Content {
     private client;
     constructor(client: Client);
-    /**
-     * Returns a paginated list of Content.
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content?spaceKey=TST&title=Cheese&expand=space,body.view,version,container
-     *   - http://example.com/rest/api/content?type=blogpost&spaceKey=TST&title=Bacon&postingDay=2014-02-13&expand=space,body.view,version,container
-     */
+    /** Returns a paginated list of Content. */
     getContent<T = Pagination<Models.Content>>(parameters: Parameters.GetContent | undefined, callback: Callback<T>): Promise<void>;
-    /**
-     * Returns a paginated list of Content.
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content?spaceKey=TST&title=Cheese&expand=space,body.view,version,container
-     *   - http://example.com/rest/api/content?type=blogpost&spaceKey=TST&title=Bacon&postingDay=2014-02-13&expand=space,body.view,version,container
-     */
+    /** Returns a paginated list of Content. */
     getContent<T = Pagination<Models.Content>>(parameters?: Parameters.GetContent, callback?: never): Promise<T>;
     /**
      * Creates a new piece of Content or publishes the draft if the content id is present.For the case publishing draft, a
-     * new piece of content will be created and all metadata from the draft will be transferred into the newly created content.
+     * new piece of content will be created and all metadata from the draft will be transferred into the newly created
+     * content.
      */
     createContent<T = Models.Content>(parameters: Parameters.CreateContent | undefined, callback: Callback<T>): Promise<void>;
     /**
      * Creates a new piece of Content or publishes the draft if the content id is present.For the case publishing draft, a
-     * new piece of content will be created and all metadata from the draft will be transferred into the newly created content.
+     * new piece of content will be created and all metadata from the draft will be transferred into the newly created
+     * content.
      */
     createContent<T = Models.Content>(parameters?: Parameters.CreateContent, callback?: never): Promise<T>;
     /**
@@ -48,25 +34,9 @@ export declare class Content {
      * content, body can be updated on all content that has a body (not attachments).
      */
     updateContent<T = Models.Content>(parameters: Parameters.UpdateContent, callback?: never): Promise<T>;
-    /**
-     * Returns a piece of Content.
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   http://example.com/rest/api/content/1234?expand=space,body.view,version,container
-     *   http://example.com/rest/api/content/1234?status=any
-     */
+    /** Returns a piece of Content. */
     getContentById<T = Models.Content>(parameters: Parameters.GetContentById, callback: Callback<T>): Promise<void>;
-    /**
-     * Returns a piece of Content.
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   http://example.com/rest/api/content/1234?expand=space,body.view,version,container
-     *   http://example.com/rest/api/content/1234?status=any
-     */
+    /** Returns a piece of Content. */
     getContentById<T = Models.Content>(parameters: Parameters.GetContentById, callback?: never): Promise<T>;
     /**
      * Trashes or purges a piece of Content, based on its ContentType and ContentStatus. There are three cases:
@@ -86,23 +56,9 @@ export declare class Content {
      * - If the content is not trashable it will be deleted permanently without being trashed.
      */
     deleteContent<T = void>(parameters: Parameters.DeleteContent, callback?: never): Promise<T>;
-    /**
-     * Returns the history of a particular piece of content
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   http://example.com/rest/api/content/1234/history
-     */
+    /** Returns the history of a particular piece of content */
     getHistory<T = Models.ContentHistory>(parameters: Parameters.GetHistory, callback: Callback<T>): Promise<void>;
-    /**
-     * Returns the history of a particular piece of content
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   http://example.com/rest/api/content/1234/history
-     */
+    /** Returns the history of a particular piece of content */
     getHistory<T = Models.ContentHistory>(parameters: Parameters.GetHistory, callback?: never): Promise<T>;
     /**
      * Returns the body of a macro (in storage format) with the given hash. This resource is primarily used by connect
@@ -113,7 +69,8 @@ export declare class Content {
      *
      * Collecting a macro by its hash should now be considered deprecated and will be replaced, transparently with
      * macroIds. This resource is currently only called from connect addons which will eventually all use the
-     * {@link #getContentById(com.atlassian.confluence.api.model.content.id.ContentId, java.util.List, Integer, String)} resource.
+     * {@link #getContentById(com.atlassian.confluence.api.model.content.id.ContentId, java.util.List, Integer, String)}
+     * resource.
      *
      * To make the migration as seamless as possible, this resource will match macros against a generated hash or a stored
      * macroId. This will allow add ons to work during the migration period.
@@ -128,7 +85,8 @@ export declare class Content {
      *
      * Collecting a macro by its hash should now be considered deprecated and will be replaced, transparently with
      * macroIds. This resource is currently only called from connect addons which will eventually all use the
-     * {@link #getContentById(com.atlassian.confluence.api.model.content.id.ContentId, java.util.List, Integer, String)} resource.
+     * {@link #getContentById(com.atlassian.confluence.api.model.content.id.ContentId, java.util.List, Integer, String)}
+     * resource.
      *
      * To make the migration as seamless as possible, this resource will match macros against a generated hash or a stored
      * macroId. This will allow add ons to work during the migration period.
@@ -158,29 +116,9 @@ export declare class Content {
      * out to all instances.
      */
     getMacroBodyByMacroId<T = Models.MacroInstance>(parameters: Parameters.GetMacroBodyByMacroId, callback?: never): Promise<T>;
-    /**
-     * Fetch a list of content using the Confluence Query Language (CQL). See: Advanced searching using CQL
-     *
-     * @example
-     *   For example :
-     *
-     *   Example request URI(s):
-     *
-     *   - http://localhost:8080/confluence/rest/api/content/search?cql=creator=currentUser()&cqlcontext={%22spaceKey%22:%22TST%22,%22contentId%22:%2255%22}
-     *   - http://localhost:8080/confluence/rest/api/content/search?cql=space=DEV%20AND%20label=docs&expand=space,metadata.labels&limit=10
-     */
+    /** Fetch a list of content using the Confluence Query Language (CQL). See: Advanced searching using CQL */
     searchContent<T = Pagination<Models.Content>>(parameters: Parameters.SearchContent | undefined, callback: Callback<T>): Promise<void>;
-    /**
-     * Fetch a list of content using the Confluence Query Language (CQL). See: Advanced searching using CQL
-     *
-     * @example
-     *   For example :
-     *
-     *   Example request URI(s):
-     *
-     *   - http://localhost:8080/confluence/rest/api/content/search?cql=creator=currentUser()&cqlcontext={%22spaceKey%22:%22TST%22,%22contentId%22:%2255%22}
-     *   - http://localhost:8080/confluence/rest/api/content/search?cql=space=DEV%20AND%20label=docs&expand=space,metadata.labels&limit=10
-     */
+    /** Fetch a list of content using the Confluence Query Language (CQL). See: Advanced searching using CQL */
     searchContent<T = Pagination<Models.Content>>(parameters?: Parameters.SearchContent, callback?: never): Promise<T>;
     /**
      * Returns a map of the direct children of a piece of Content. Content can have multiple types of children - for
@@ -191,13 +129,6 @@ export declare class Content {
      *
      * If no types are included in the expand parameter, the map returned will just list the child types that are
      * available to be expanded for the Content referenced by the "id" path parameter.
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/child
-     *   - http://example.com/rest/api/content/1234/child?expand=page.body.VIEW
-     *   - http://example.com/rest/api/content/1234/child?expand=page&start=20&limit=10
      */
     getContentChildren<T = Models.ContentChildren>(parameters: Parameters.GetContentChildren, callback: Callback<T>): Promise<void>;
     /**
@@ -209,88 +140,27 @@ export declare class Content {
      *
      * If no types are included in the expand parameter, the map returned will just list the child types that are
      * available to be expanded for the Content referenced by the "id" path parameter.
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/child
-     *   - http://example.com/rest/api/content/1234/child?expand=page.body.VIEW
-     *   - http://example.com/rest/api/content/1234/child?expand=page&start=20&limit=10
      */
     getContentChildren<T = Models.ContentChildren>(parameters: Parameters.GetContentChildren, callback?: never): Promise<T>;
     /**
      * Returns the direct children of a piece of Content, limited to a single child type.
      *
      * The ContentType(s) of the children returned is specified by the "type" path parameter in the request.
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/child/page
-     *   - http://example.com/rest/api/content/1234/child/comment
-     *   - http://example.com/rest/api/content/1234/child/page?expand=body.view
-     *   - http://example.com/rest/api/content/1234/child/comment?start=20&limit=10
      */
     getContentChildrenByType<T = Pagination<Models.Content>>(parameters: Parameters.GetContentChildrenByType, callback: Callback<T>): Promise<void>;
     /**
      * Returns the direct children of a piece of Content, limited to a single child type.
      *
      * The ContentType(s) of the children returned is specified by the "type" path parameter in the request.
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/child/page
-     *   - http://example.com/rest/api/content/1234/child/comment
-     *   - http://example.com/rest/api/content/1234/child/page?expand=body.view
-     *   - http://example.com/rest/api/content/1234/child/comment?start=20&limit=10
      */
     getContentChildrenByType<T = Pagination<Models.Content>>(parameters: Parameters.GetContentChildrenByType, callback?: never): Promise<T>;
-    /**
-     * Returns the comments of a content
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/child/comment
-     *   - http://example.com/rest/api/content/1234/child/comment?expand=body.view
-     *   - http://example.com/rest/api/content/1234/child/comment?start=20&limit=10
-     *   - http://example.com/rest/api/content/1234/child/comment?location=footer&location=inline&location=resolved
-     *   - http://example.com/rest/api/content/1234/child/comment?expand=extensions.inlineProperties,extensions.resolution
-     */
+    /** Returns the comments of a content */
     getContentComments<T = Pagination<Models.Content>>(parameters: Parameters.GetContentComments, callback: Callback<T>): Promise<void>;
-    /**
-     * Returns the comments of a content
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/child/comment
-     *   - http://example.com/rest/api/content/1234/child/comment?expand=body.view
-     *   - http://example.com/rest/api/content/1234/child/comment?start=20&limit=10
-     *   - http://example.com/rest/api/content/1234/child/comment?location=footer&location=inline&location=resolved
-     *   - http://example.com/rest/api/content/1234/child/comment?expand=extensions.inlineProperties,extensions.resolution
-     */
+    /** Returns the comments of a content */
     getContentComments<T = Pagination<Models.Content>>(parameters: Parameters.GetContentComments, callback?: never): Promise<T>;
-    /**
-     * Returns a paginated list of attachment Content entities within a single container.
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/child/attachment?start=0&limit=10
-     *   - http://example.com/rest/api/content/1234/child/attachment?filename=myfile.txt&expand=version,container
-     */
+    /** Returns a paginated list of attachment Content entities within a single container. */
     getAttachments<T = Pagination<Models.Content>>(parameters: Parameters.GetAttachments, callback: Callback<T>): Promise<void>;
-    /**
-     * Returns a paginated list of attachment Content entities within a single container.
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/child/attachment?start=0&limit=10
-     *   - http://example.com/rest/api/content/1234/child/attachment?filename=myfile.txt&expand=version,container
-     */
+    /** Returns a paginated list of attachment Content entities within a single container. */
     getAttachments<T = Pagination<Models.Content>>(parameters: Parameters.GetAttachments, callback?: never): Promise<T>;
     /**
      * Add one or more attachments to a Confluence Content entity, with optional comments.
@@ -303,7 +173,8 @@ export declare class Content {
      * Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.
      *
      * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection
-     * on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.
+     * on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be
+     * blocked.
      *
      * The name of the multipart/form-data parameter that contains attachments must be "file"
      *
@@ -315,11 +186,6 @@ export declare class Content {
      * http://myhost/rest/api/content/123/child/attachment An example to attach the same file, with no comment: curl -D-
      * -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt"
      * http://myhost/rest/api/content/123/child/attachment
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/child/attachment
      */
     createAttachments<T = Pagination<Models.Content>>(parameters: Parameters.CreateAttachments, callback: Callback<T>): Promise<void>;
     /**
@@ -333,7 +199,8 @@ export declare class Content {
      * Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.
      *
      * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection
-     * on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.
+     * on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be
+     * blocked.
      *
      * The name of the multipart/form-data parameter that contains attachments must be "file"
      *
@@ -345,33 +212,18 @@ export declare class Content {
      * http://myhost/rest/api/content/123/child/attachment An example to attach the same file, with no comment: curl -D-
      * -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt"
      * http://myhost/rest/api/content/123/child/attachment
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/child/attachment
      */
     createAttachments<T = Pagination<Models.Content>>(parameters: Parameters.CreateAttachments, callback?: never): Promise<T>;
     /**
      * Update the non-binary data of an Attachment.
      *
      * This resource can be used to update an attachment's filename, media-type, comment, and parent container.
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/child/attachment/5678
      */
     updateAttachmentProperties<T = Models.Content>(parameters: Parameters.UpdateAttachmentProperties, callback: Callback<T>): Promise<void>;
     /**
      * Update the non-binary data of an Attachment.
      *
      * This resource can be used to update an attachment's filename, media-type, comment, and parent container.
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/child/attachment/5678
      */
     updateAttachmentProperties<T = Models.Content>(parameters: Parameters.UpdateAttachmentProperties, callback?: never): Promise<T>;
     /**
@@ -387,7 +239,8 @@ export declare class Content {
      * Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.
      *
      * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection
-     * on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.
+     * on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be
+     * blocked.
      *
      * The name of the multipart/form-data parameter that contains attachments must be "file"
      *
@@ -398,11 +251,6 @@ export declare class Content {
      *
      * An example to upload the same file, with no comment: curl -D- -u admin:admin -X POST -H "X-Atlassian-Token:
      * nocheck" -F "file=@myfile.txt" http://myhost/rest/api/content/123/child/attachment/456/data
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/child/attachment/5678/data
      */
     updateAttachmentData<T = Models.Content>(parameters: Parameters.UpdateAttachmentData, callback: Callback<T>): Promise<void>;
     /**
@@ -418,7 +266,8 @@ export declare class Content {
      * Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.
      *
      * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection
-     * on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.
+     * on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be
+     * blocked.
      *
      * The name of the multipart/form-data parameter that contains attachments must be "file"
      *
@@ -429,11 +278,6 @@ export declare class Content {
      *
      * An example to upload the same file, with no comment: curl -D- -u admin:admin -X POST -H "X-Atlassian-Token:
      * nocheck" -F "file=@myfile.txt" http://myhost/rest/api/content/123/child/attachment/456/data
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/child/attachment/5678/data
      */
     updateAttachmentData<T = Models.Content>(parameters: Parameters.UpdateAttachmentData, callback?: never): Promise<T>;
     /**
@@ -447,13 +291,6 @@ export declare class Content {
      * available to be expanded for the Content referenced by the "id" path parameter.
      *
      * Currently the only supported descendants are comment descendants of non-comment Content.
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/descendant
-     *   - http://example.com/rest/api/content/1234/descendant?expand=comment.body.VIEW
-     *   - http://example.com/rest/api/content/1234/descendant?expand=comment
      */
     getContentDescendants<T = Models.ContentChildren>(parameters: Parameters.GetContentDescendants, callback: Callback<T>): Promise<void>;
     /**
@@ -467,13 +304,6 @@ export declare class Content {
      * available to be expanded for the Content referenced by the "id" path parameter.
      *
      * Currently the only supported descendants are comment descendants of non-comment Content.
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/descendant
-     *   - http://example.com/rest/api/content/1234/descendant?expand=comment.body.VIEW
-     *   - http://example.com/rest/api/content/1234/descendant?expand=comment
      */
     getContentDescendants<T = Models.ContentChildren>(parameters: Parameters.GetContentDescendants, callback?: never): Promise<T>;
     /**
@@ -482,13 +312,6 @@ export declare class Content {
      * The ContentType(s) of the descendants returned is specified by the "type" path parameter in the request.
      *
      * Currently the only supported descendants are comment descendants of non-comment Content.
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/descendant/comment
-     *   - http://example.com/rest/api/content/1234/descendant/comment?expand=body.VIEW
-     *   - http://example.com/rest/api/content/1234/descendant/comment?start=20&limit=10
      */
     getContentDescendantsOfType<T = Pagination<Models.Content>>(parameters: Parameters.GetContentDescendantsOfType, callback: Callback<T>): Promise<void>;
     /**
@@ -497,34 +320,11 @@ export declare class Content {
      * The ContentType(s) of the descendants returned is specified by the "type" path parameter in the request.
      *
      * Currently the only supported descendants are comment descendants of non-comment Content.
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/descendant/comment
-     *   - http://example.com/rest/api/content/1234/descendant/comment?expand=body.VIEW
-     *   - http://example.com/rest/api/content/1234/descendant/comment?start=20&limit=10
      */
     getContentDescendantsOfType<T = Pagination<Models.Content>>(parameters: Parameters.GetContentDescendantsOfType, callback?: never): Promise<T>;
-    /**
-     * Returns the list of labels on a piece of Content.
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/label
-     *   - http://example.com/rest/api/content/1234/label?prefix=global&start=0&limit=200
-     */
+    /** Returns the list of labels on a piece of Content. */
     getContentLabels<T = Pagination<Models.Label>>(parameters: Parameters.GetContentLabels, callback: Callback<T>): Promise<void>;
-    /**
-     * Returns the list of labels on a piece of Content.
-     *
-     * @example
-     *   Example request URI(s):
-     *
-     *   - http://example.com/rest/api/content/1234/label
-     *   - http://example.com/rest/api/content/1234/label?prefix=global&start=0&limit=200
-     */
+    /** Returns the list of labels on a piece of Content. */
     getContentLabels<T = Pagination<Models.Label>>(parameters: Parameters.GetContentLabels, callback?: never): Promise<T>;
     /** Adds a list of labels to the specified content. The body is the json representation of the list. */
     addLabelsToContent<T = Pagination<Models.Label>>(parameters: Parameters.AddLabelsToContent, callback: Callback<T>): Promise<void>;
@@ -546,45 +346,17 @@ export declare class Content {
      * version of this method (/content/{id}/label?name={label}Responses
      */
     deleteLabel<T = void>(parameters: Parameters.DeleteLabel, callback?: never): Promise<T>;
-    /**
-     * Returns a paginated list of content properties.
-     *
-     * @example
-     *   Example request URI:
-     *
-     *   - http://example.com/rest/api/content/1234/property?expand=content,version
-     */
+    /** Returns a paginated list of content properties. */
     getContentProperties<T = Pagination<Models.ContentProperty>>(parameters: Parameters.GetContentProperties, callback: Callback<T>): Promise<void>;
-    /**
-     * Returns a paginated list of content properties.
-     *
-     * @example
-     *   Example request URI:
-     *
-     *   - http://example.com/rest/api/content/1234/property?expand=content,version
-     */
+    /** Returns a paginated list of content properties. */
     getContentProperties<T = Pagination<Models.ContentProperty>>(parameters: Parameters.GetContentProperties, callback?: never): Promise<T>;
     /** Creates a new content property. */
     createContentProperty<T = Models.ContentProperty>(parameters: Parameters.CreateContentProperty, callback: Callback<T>): Promise<void>;
     /** Creates a new content property. */
     createContentProperty<T = Models.ContentProperty>(parameters: Parameters.CreateContentProperty, callback?: never): Promise<T>;
-    /**
-     * Returns a content property.
-     *
-     * @example
-     *   Example request URI:
-     *
-     *   - http://example.com/rest/api/content/1234/property/example-property-key?expand=content,version
-     */
+    /** Returns a content property. */
     getContentProperty<T = Models.ContentProperty>(parameters: Parameters.GetContentProperty, callback: Callback<T>): Promise<void>;
-    /**
-     * Returns a content property.
-     *
-     * @example
-     *   Example request URI:
-     *
-     *   - http://example.com/rest/api/content/1234/property/example-property-key?expand=content,version
-     */
+    /** Returns a content property. */
     getContentProperty<T = Models.ContentProperty>(parameters: Parameters.GetContentProperty, callback?: never): Promise<T>;
     /** Creates a new content property. */
     createContentPropertyForKey<T = Models.ContentProperty>(parameters: Parameters.CreateContentPropertyForKey, callback: Callback<T>): Promise<void>;