@resolution/confluence-api-client 0.4.4 → 0.4.6

package/lib/openapi/v2/services/BlogPostService.d.ts

@@ -18,12 +18,12 @@ export declare class BlogPostService extends CommonHttpService {
      * @scopes-current write:page:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-blog-post#api-blogposts-post
      */
-    createBlogPost({ private: privateQuery, requestBody, }: {
+    createBlogPost: ({ private: privateQuery, requestBody, }: {
         /**
          * The blog post will be private. Only the user who creates this blog post will
          * have permission to view and edit one.
          */
-        private?: boolean;
+        private?: boolean | undefined;
         requestBody: {
             /** ID of the space */
             spaceId: string;
@@ -31,23 +31,23 @@ export declare class BlogPostService extends CommonHttpService {
              * The status of the blog post, specifies if the blog post will be created as a
              * new blog post or a draft
              */
-            status?: "current" | "draft";
+            status?: "current" | "draft" | undefined;
             /** Title of the blog post, required if creating non-draft. */
-            title?: string;
-            body?: BlogPostBodyWrite | BlogPostNestedBodyWrite;
+            title?: string | undefined;
+            body?: BlogPostBodyWrite | BlogPostNestedBodyWrite | undefined;
         } & {
             [key: string]: unknown;
         };
-    }): Promise<BlogPostSingle & ({
-        _links?: {
+    }) => Promise<BlogPostSingle & {
+        _links?: ({
             /** Base url of the Confluence site. */
-            base?: string;
+            base?: string | undefined;
         } & {
             [key: string]: unknown;
-        };
+        }) | undefined;
     } & {
         [key: string]: unknown;
-    })>;
+    }>;
     /**
      * Delete a blog post by id.
      *
@@ -70,14 +70,14 @@ export declare class BlogPostService extends CommonHttpService {
      * @scopes-current delete:page:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-blog-post#api-blogposts-id-delete
      */
-    deleteBlogPost({ id, purge, draft, }: {
+    deleteBlogPost: ({ id, purge, draft, }: {
         /** The ID of the blog post to be deleted. */
         id: number;
         /** If attempting to purge the blog post. */
-        purge?: boolean;
+        purge?: boolean | undefined;
         /** If attempting to delete a blog post that is a draft. */
-        draft?: boolean;
-    }): Promise<void>;
+        draft?: boolean | undefined;
+    }) => Promise<void>;
     /**
      * Returns a specific blog post.
      *
@@ -89,7 +89,7 @@ export declare class BlogPostService extends CommonHttpService {
      * @scopes-current read:page:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-blog-post#api-blogposts-id-get
      */
-    getBlogPostById({ id, bodyFormat, getDraft, version, includeLabels, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, includeFavoritedByCurrentUserStatus, }: {
+    getBlogPostById: ({ id, bodyFormat, getDraft, version, includeLabels, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, includeFavoritedByCurrentUserStatus, }: {
         /**
          * The ID of the blog post to be returned. If you don't know the blog post ID, use
          * Get blog posts and filter the results.
@@ -100,14 +100,14 @@ export declare class BlogPostService extends CommonHttpService {
          * available, the representation will be available under a response field of the
          * same name under the `body` field.
          */
-        bodyFormat?: PrimaryBodyRepresentationSingle;
+        bodyFormat?: PrimaryBodyRepresentationSingle | undefined;
         /** Retrieve the draft version of this blog post. */
-        getDraft?: boolean;
+        getDraft?: boolean | undefined;
         /**
          * Allows you to retrieve a previously published version. Specify the previous
          * version's number to retrieve its details.
          */
-        version?: number;
+        version?: number | undefined;
         /**
          * Includes labels associated with this blog post in the response.
          * The number of results will be limited to 50 and sorted in the default sort
@@ -115,7 +115,7 @@ export declare class BlogPostService extends CommonHttpService {
          * A `meta` and `_links` property will be present to indicate if more results are
          * available and a link to retrieve the rest of the results.
          */
-        includeLabels?: boolean;
+        includeLabels?: boolean | undefined;
         /**
          * Includes content properties associated with this blog post in the response.
          * The number of results will be limited to 50 and sorted in the default sort
@@ -123,7 +123,7 @@ export declare class BlogPostService extends CommonHttpService {
          * A `meta` and `_links` property will be present to indicate if more results are
          * available and a link to retrieve the rest of the results.
          */
-        includeProperties?: boolean;
+        includeProperties?: boolean | undefined;
         /**
          * Includes operations associated with this blog post in the response.
          * The number of results will be limited to 50 and sorted in the default sort
@@ -131,7 +131,7 @@ export declare class BlogPostService extends CommonHttpService {
          * A `meta` and `_links` property will be present to indicate if more results are
          * available and a link to retrieve the rest of the results.
          */
-        includeOperations?: boolean;
+        includeOperations?: boolean | undefined;
         /**
          * Includes likes associated with this blog post in the response.
          * The number of results will be limited to 50 and sorted in the default sort
@@ -139,7 +139,7 @@ export declare class BlogPostService extends CommonHttpService {
          * A `meta` and `_links` property will be present to indicate if more results are
          * available and a link to retrieve the rest of the results.
          */
-        includeLikes?: boolean;
+        includeLikes?: boolean | undefined;
         /**
          * Includes versions associated with this blog post in the response.
          * The number of results will be limited to 50 and sorted in the default sort
@@ -147,24 +147,24 @@ export declare class BlogPostService extends CommonHttpService {
          * A `meta` and `_links` property will be present to indicate if more results are
          * available and a link to retrieve the rest of the results.
          */
-        includeVersions?: boolean;
+        includeVersions?: boolean | undefined;
         /**
          * Includes the current version associated with this blog post in the response.
          * By default this is included and can be omitted by setting the value to `false`.
          */
-        includeVersion?: boolean;
+        includeVersion?: boolean | undefined;
         /** Includes whether this blog post has been favorited by the current user. */
-        includeFavoritedByCurrentUserStatus?: boolean;
-    }): Promise<BlogPostSingle & ({
-        _links?: {
+        includeFavoritedByCurrentUserStatus?: boolean | undefined;
+    }) => Promise<BlogPostSingle & {
+        _links?: ({
             /** Base url of the Confluence site. */
-            base?: string;
+            base?: string | undefined;
         } & {
             [key: string]: unknown;
-        };
+        }) | undefined;
     } & {
         [key: string]: unknown;
-    })>;
+    }>;
     /**
      * Returns all blog posts. The number of results is limited by the `limit`
      * parameter and additional results (if available)
@@ -179,47 +179,47 @@ export declare class BlogPostService extends CommonHttpService {
      * @scopes-current read:page:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-blog-post#api-blogposts-get
      */
-    getBlogPosts({ id, spaceId, sort, status, title, bodyFormat, cursor, limit, }?: {
+    getBlogPosts: ({ id, spaceId, sort, status, title, bodyFormat, cursor, limit, }?: {
         /**
          * Filter the results based on blog post ids. Multiple blog post ids can be
          * specified as a comma-separated list.
          */
-        id?: number[];
+        id?: number[] | undefined;
         /**
          * Filter the results based on space ids. Multiple space ids can be specified as a
          * comma-separated list.
          */
-        spaceId?: number[];
+        spaceId?: number[] | undefined;
         /** Used to sort the result by a particular field. */
-        sort?: BlogPostSortOrder;
+        sort?: BlogPostSortOrder | undefined;
         /**
          * Filter the results to blog posts based on their status. By default, `current`
          * is used.
          */
-        status?: ("current" | "deleted" | "trashed")[];
+        status?: ("current" | "deleted" | "trashed")[] | undefined;
         /** Filter the results to blog posts based on their title. */
-        title?: string;
+        title?: string | undefined;
         /**
          * The content format types to be returned in the `body` field of the response. If
          * available, the representation will be available under a response field of the
          * same name under the `body` field.
          */
-        bodyFormat?: PrimaryBodyRepresentation;
+        bodyFormat?: PrimaryBodyRepresentation | undefined;
         /**
          * Used for pagination, this opaque cursor will be returned in the `next` URL in
          * the `Link` response header. Use the relative URL in the `Link` header to
          * retrieve the `next` set of results.
          */
-        cursor?: string;
+        cursor?: string | undefined;
         /**
          * Maximum number of blog posts per result to return. If more results exist, use
          * the `Link` response header to retrieve a relative URL that will return the next
          * set of results.
          */
-        limit?: number;
-    }): Promise<{
-        results?: BlogPostBulk[];
-        _links?: MultiEntityLinks;
+        limit?: number | undefined;
+    }) => Promise<{
+        results?: BlogPostBulk[] | undefined;
+        _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;
@@ -238,39 +238,39 @@ export declare class BlogPostService extends CommonHttpService {
      * @scopes-current read:page:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-blog-post#api-spaces-id-blogposts-get
      */
-    getBlogPostsInSpace({ id, sort, status, title, bodyFormat, cursor, limit, }: {
+    getBlogPostsInSpace: ({ id, sort, status, title, bodyFormat, cursor, limit, }: {
         /** The ID of the space for which blog posts should be returned. */
         id: number;
         /** Used to sort the result by a particular field. */
-        sort?: BlogPostSortOrder;
+        sort?: BlogPostSortOrder | undefined;
         /**
          * Filter the results to blog posts based on their status. By default, `current`
          * is used.
          */
-        status?: ("current" | "deleted" | "trashed")[];
+        status?: ("current" | "deleted" | "trashed")[] | undefined;
         /** Filter the results to blog posts based on their title. */
-        title?: string;
+        title?: string | undefined;
         /**
          * The content format types to be returned in the `body` field of the response. If
          * available, the representation will be available under a response field of the
          * same name under the `body` field.
          */
-        bodyFormat?: PrimaryBodyRepresentation;
+        bodyFormat?: PrimaryBodyRepresentation | undefined;
         /**
          * Used for pagination, this opaque cursor will be returned in the `next` URL in
          * the `Link` response header. Use the relative URL in the `Link` header to
          * retrieve the `next` set of results.
          */
-        cursor?: string;
+        cursor?: string | undefined;
         /**
          * Maximum number of blog posts per result to return. If more results exist, use
          * the `Link` header to retrieve a relative URL that will return the next set of
          * results.
          */
-        limit?: number;
-    }): Promise<{
-        results?: BlogPostBulk[];
-        _links?: MultiEntityLinks;
+        limit?: number | undefined;
+    }) => Promise<{
+        results?: BlogPostBulk[] | undefined;
+        _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;
@@ -288,37 +288,37 @@ export declare class BlogPostService extends CommonHttpService {
      * @scopes-current read:page:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-blog-post#api-labels-id-blogposts-get
      */
-    getLabelBlogPosts({ id, spaceId, bodyFormat, sort, cursor, limit, }: {
+    getLabelBlogPosts: ({ id, spaceId, bodyFormat, sort, cursor, limit, }: {
         /** The ID of the label for which blog posts should be returned. */
         id: number;
         /**
          * Filter the results based on space ids. Multiple space ids can be specified as a
          * comma-separated list.
          */
-        spaceId?: number[];
+        spaceId?: number[] | undefined;
         /**
          * The content format types to be returned in the `body` field of the response. If
          * available, the representation will be available under a response field of the
          * same name under the `body` field.
          */
-        bodyFormat?: PrimaryBodyRepresentation;
+        bodyFormat?: PrimaryBodyRepresentation | undefined;
         /** Used to sort the result by a particular field. */
-        sort?: BlogPostSortOrder;
+        sort?: BlogPostSortOrder | undefined;
         /**
          * Used for pagination, this opaque cursor will be returned in the `next` URL in
          * the `Link` response header. Use the relative URL in the `Link` header to
          * retrieve the `next` set of results.
          */
-        cursor?: string;
+        cursor?: string | undefined;
         /**
          * Maximum number of blog posts per result to return. If more results exist, use
          * the `Link` header to retrieve a relative URL that will return the next set of
          * results.
          */
-        limit?: number;
-    }): Promise<{
-        results?: BlogPostBulk[];
-        _links?: MultiEntityLinks;
+        limit?: number | undefined;
+    }) => Promise<{
+        results?: BlogPostBulk[] | undefined;
+        _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;
@@ -334,7 +334,7 @@ export declare class BlogPostService extends CommonHttpService {
      * @scopes-current write:page:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-blog-post#api-blogposts-id-put
      */
-    updateBlogPost({ id, requestBody, }: {
+    updateBlogPost: ({ id, requestBody, }: {
         /**
          * The ID of the blog post to be updated. If you don't know the blog post ID, use
          * Get Blog Posts and filter the results.
@@ -361,7 +361,7 @@ export declare class BlogPostService extends CommonHttpService {
              *
              * This currently **does not support moving the blog post to a different space**.
              */
-            spaceId?: string;
+            spaceId?: string | undefined;
             body: BlogPostBodyWrite | BlogPostNestedBodyWrite;
             version: {
                 /**
@@ -371,24 +371,24 @@ export declare class BlogPostService extends CommonHttpService {
                  *
                  * If you don't know the current version number, use Get blog post by id.
                  */
-                number?: number;
+                number?: number | undefined;
                 /** An optional message to be stored with the version. */
-                message?: string;
+                message?: string | undefined;
             } & {
                 [key: string]: unknown;
             };
         } & {
             [key: string]: unknown;
         };
-    }): Promise<BlogPostSingle & ({
-        _links?: {
+    }) => Promise<BlogPostSingle & {
+        _links?: ({
             /** Base url of the Confluence site. */
-            base?: string;
+            base?: string | undefined;
         } & {
             [key: string]: unknown;
-        };
+        }) | undefined;
     } & {
         [key: string]: unknown;
-    })>;
+    }>;
     static initialize(): void;
 }