@resolution/confluence-api-client 0.4.4 → 0.4.6

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

@@ -18,36 +18,36 @@ export declare class CustomContentService extends CommonHttpService {
      * @scopes-current write:custom-content:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-custom-content-post
      */
-    createCustomContent({ requestBody, }: {
+    createCustomContent: ({ requestBody, }: {
         requestBody: {
             /** Type of custom content. */
             type: string;
             /** The status of the custom content. */
-            status?: "current";
+            status?: "current" | undefined;
             /** ID of the containing space. */
-            spaceId?: string;
+            spaceId?: string | undefined;
             /** ID of the containing page. */
-            pageId?: string;
+            pageId?: string | undefined;
             /** ID of the containing Blog Post. */
-            blogPostId?: string;
+            blogPostId?: string | undefined;
             /** ID of the containing custom content. */
-            customContentId?: string;
+            customContentId?: string | undefined;
             /** Title of the custom content. */
             title: string;
             body: CustomContentBodyWrite | CustomContentNestedBodyWrite;
         } & {
             [key: string]: unknown;
         };
-    }): Promise<CustomContentSingle & ({
-        _links?: {
+    }) => Promise<CustomContentSingle & {
+        _links?: ({
             /** Base url of the Confluence site. */
-            base?: string;
+            base?: string | undefined;
         } & {
             [key: string]: unknown;
-        };
+        }) | undefined;
     } & {
         [key: string]: unknown;
-    })>;
+    }>;
     /**
      * Delete a custom content by id.
      *
@@ -66,12 +66,12 @@ export declare class CustomContentService extends CommonHttpService {
      * @scopes-current delete:custom-content:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-custom-content-id-delete
      */
-    deleteCustomContent({ id, purge, }: {
+    deleteCustomContent: ({ id, purge, }: {
         /** The ID of the custom content to be deleted. */
         id: number;
         /** If attempting to purge the custom content. */
-        purge?: boolean;
-    }): Promise<void>;
+        purge?: boolean | undefined;
+    }) => Promise<void>;
     /**
      * Returns a specific piece of custom content.
      *
@@ -84,7 +84,7 @@ export declare class CustomContentService extends CommonHttpService {
      * @scopes-current read:custom-content:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-custom-content-id-get
      */
-    getCustomContentById({ id, bodyFormat, version, includeLabels, includeProperties, includeOperations, includeVersions, includeVersion, }: {
+    getCustomContentById: ({ id, bodyFormat, version, includeLabels, includeProperties, includeOperations, includeVersions, includeVersion, }: {
         /**
          * The ID of the custom content to be returned. If you don't know the custom
          * content ID, use Get Custom Content by Type and filter the results.
@@ -99,12 +99,12 @@ export declare class CustomContentService extends CommonHttpService {
          * `atlas_doc_format` body formats are able to be returned. If the custom content
          * body type is `raw`, only the `raw` body format is able to be returned.
          */
-        bodyFormat?: CustomContentBodyRepresentationSingle;
+        bodyFormat?: CustomContentBodyRepresentationSingle | 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 custom content in the response.
          * The number of results will be limited to 50 and sorted in the default sort
@@ -112,7 +112,7 @@ export declare class CustomContentService 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 custom content in the response.
          * The number of results will be limited to 50 and sorted in the default sort
@@ -120,7 +120,7 @@ export declare class CustomContentService 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 custom content in the response.
          * The number of results will be limited to 50 and sorted in the default sort
@@ -128,7 +128,7 @@ export declare class CustomContentService 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 versions associated with this custom content in the response.
          * The number of results will be limited to 50 and sorted in the default sort
@@ -136,23 +136,23 @@ export declare class CustomContentService 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 custom content in the
          * response.
          * By default this is included and can be omitted by setting the value to `false`.
          */
-        includeVersion?: boolean;
-    }): Promise<CustomContentSingle & ({
-        _links?: {
+        includeVersion?: boolean | undefined;
+    }) => Promise<CustomContentSingle & {
+        _links?: ({
             /** Base url of the Confluence site. */
-            base?: string;
+            base?: string | undefined;
         } & {
             [key: string]: unknown;
-        };
+        }) | undefined;
     } & {
         [key: string]: unknown;
-    })>;
+    }>;
     /**
      * Returns all custom content for a given type. The number of results is limited
      * by the `limit` parameter and additional results (if available)
@@ -167,7 +167,7 @@ export declare class CustomContentService extends CommonHttpService {
      * @scopes-current read:custom-content:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-custom-content-get
      */
-    getCustomContentByType({ type, id, spaceId, sort, cursor, limit, bodyFormat, }: {
+    getCustomContentByType: ({ type, id, spaceId, sort, cursor, limit, bodyFormat, }: {
         /**
          * The type of custom content being requested. See:
          * https://developer.atlassian.com/cloud/confluence/custom-content/ for additional
@@ -178,26 +178,26 @@ export declare class CustomContentService extends CommonHttpService {
          * Filter the results based on custom content ids. Multiple custom content 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?: CustomContentSortOrder;
+        sort?: CustomContentSortOrder | 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 pages 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;
+        limit?: 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
@@ -207,10 +207,10 @@ export declare class CustomContentService extends CommonHttpService {
          * `atlas_doc_format` body formats are able to be returned. If the custom content
          * body type is `raw`, only the `raw` body format is able to be returned.
          */
-        bodyFormat?: CustomContentBodyRepresentation;
-    }): Promise<{
-        results?: CustomContentBulk[];
-        _links?: MultiEntityLinks;
+        bodyFormat?: CustomContentBodyRepresentation | undefined;
+    }) => Promise<{
+        results?: CustomContentBulk[] | undefined;
+        _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;
@@ -229,7 +229,7 @@ export declare class CustomContentService extends CommonHttpService {
      * @scopes-current read:custom-content:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-blogposts-id-custom-content-get
      */
-    getCustomContentByTypeInBlogPost({ id, type, sort, cursor, limit, bodyFormat, }: {
+    getCustomContentByTypeInBlogPost: ({ id, type, sort, cursor, limit, bodyFormat, }: {
         /** The ID of the blog post for which custom content should be returned. */
         id: number;
         /**
@@ -239,19 +239,19 @@ export declare class CustomContentService extends CommonHttpService {
          */
         type: string;
         /** Used to sort the result by a particular field. */
-        sort?: CustomContentSortOrder;
+        sort?: CustomContentSortOrder | 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 pages 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;
+        limit?: 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
@@ -261,10 +261,10 @@ export declare class CustomContentService extends CommonHttpService {
          * `atlas_doc_format` body formats are able to be returned. If the custom content
          * body type is `raw`, only the `raw` body format is able to be returned.
          */
-        bodyFormat?: CustomContentBodyRepresentation;
-    }): Promise<{
-        results?: CustomContentBulk[];
-        _links?: MultiEntityLinks;
+        bodyFormat?: CustomContentBodyRepresentation | undefined;
+    }) => Promise<{
+        results?: CustomContentBulk[] | undefined;
+        _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;
@@ -283,7 +283,7 @@ export declare class CustomContentService extends CommonHttpService {
      * @scopes-current read:custom-content:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-pages-id-custom-content-get
      */
-    getCustomContentByTypeInPage({ id, type, sort, cursor, limit, bodyFormat, }: {
+    getCustomContentByTypeInPage: ({ id, type, sort, cursor, limit, bodyFormat, }: {
         /** The ID of the page for which custom content should be returned. */
         id: number;
         /**
@@ -293,19 +293,19 @@ export declare class CustomContentService extends CommonHttpService {
          */
         type: string;
         /** Used to sort the result by a particular field. */
-        sort?: CustomContentSortOrder;
+        sort?: CustomContentSortOrder | 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 pages 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;
+        limit?: 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
@@ -315,10 +315,10 @@ export declare class CustomContentService extends CommonHttpService {
          * `atlas_doc_format` body formats are able to be returned. If the custom content
          * body type is `raw`, only the `raw` body format is able to be returned.
          */
-        bodyFormat?: CustomContentBodyRepresentation;
-    }): Promise<{
-        results?: CustomContentBulk[];
-        _links?: MultiEntityLinks;
+        bodyFormat?: CustomContentBodyRepresentation | undefined;
+    }) => Promise<{
+        results?: CustomContentBulk[] | undefined;
+        _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;
@@ -336,7 +336,7 @@ export declare class CustomContentService extends CommonHttpService {
      * @scopes-current read:custom-content:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-spaces-id-custom-content-get
      */
-    getCustomContentByTypeInSpace({ id, type, cursor, limit, bodyFormat, }: {
+    getCustomContentByTypeInSpace: ({ id, type, cursor, limit, bodyFormat, }: {
         /** The ID of the space for which custom content should be returned. */
         id: number;
         /**
@@ -350,13 +350,13 @@ export declare class CustomContentService extends CommonHttpService {
          * 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 pages 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;
+        limit?: 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
@@ -366,10 +366,10 @@ export declare class CustomContentService extends CommonHttpService {
          * `atlas_doc_format` body formats are able to be returned. If the custom content
          * body type is `raw`, only the `raw` body format is able to be returned.
          */
-        bodyFormat?: CustomContentBodyRepresentation;
-    }): Promise<{
-        results?: CustomContentBulk[];
-        _links?: MultiEntityLinks;
+        bodyFormat?: CustomContentBodyRepresentation | undefined;
+    }) => Promise<{
+        results?: CustomContentBulk[] | undefined;
+        _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;
@@ -387,7 +387,7 @@ export declare class CustomContentService extends CommonHttpService {
      * @scopes-current write:custom-content:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-custom-content-id-put
      */
-    updateCustomContent({ id, requestBody, }: {
+    updateCustomContent: ({ id, requestBody, }: {
         /**
          * The ID of the custom content to be updated. If you don't know the custom
          * content ID, use Get Custom Content by Type and filter the results.
@@ -401,36 +401,36 @@ export declare class CustomContentService extends CommonHttpService {
             /** The status of the custom content. */
             status: "current";
             /** ID of the containing space. */
-            spaceId?: string;
+            spaceId?: string | undefined;
             /** ID of the containing page. */
-            pageId?: string;
+            pageId?: string | undefined;
             /** ID of the containing Blog Post. */
-            blogPostId?: string;
+            blogPostId?: string | undefined;
             /** ID of the containing custom content. */
-            customContentId?: string;
+            customContentId?: string | undefined;
             /** Title of the custom content. */
             title: string;
             body: CustomContentBodyWrite | CustomContentNestedBodyWrite;
             version: {
                 /** The version number, must be incremented by one. */
-                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<CustomContentSingle & ({
-        _links?: {
+    }) => Promise<CustomContentSingle & {
+        _links?: ({
             /** Base url of the Confluence site. */
-            base?: string;
+            base?: string | undefined;
         } & {
             [key: string]: unknown;
-        };
+        }) | undefined;
     } & {
         [key: string]: unknown;
-    })>;
+    }>;
     static initialize(): void;
 }