@resolution/confluence-api-client 0.4.4 → 0.4.5

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

@@ -20,12 +20,12 @@ export declare class AttachmentService extends CommonHttpService {
      * @scopes-current delete:attachment:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-attachment#api-attachments-id-delete
      */
-    deleteAttachment({ id, purge, }: {
+    deleteAttachment: ({ id, purge, }: {
         /** The ID of the attachment to be deleted. */
         id: number;
         /** If attempting to purge the attachment. */
-        purge?: boolean;
-    }): Promise<void>;
+        purge?: boolean | undefined;
+    }) => Promise<void>;
     /**
      * Returns a specific attachment.
      *
@@ -37,7 +37,7 @@ export declare class AttachmentService extends CommonHttpService {
      * @scopes-current read:attachment:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-attachment#api-attachments-id-get
      */
-    getAttachmentById({ id, version, includeLabels, includeProperties, includeOperations, includeVersions, includeVersion, }: {
+    getAttachmentById: ({ id, version, includeLabels, includeProperties, includeOperations, includeVersions, includeVersion, }: {
         /**
          * The ID of the attachment to be returned. If you don't know the attachment's ID,
          * use Get attachments for page/blogpost/custom content.
@@ -47,7 +47,7 @@ export declare class AttachmentService extends CommonHttpService {
          * 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 attachment in the response.
          * The number of results will be limited to 50 and sorted in the default sort
@@ -55,7 +55,7 @@ export declare class AttachmentService 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 attachment in the response.
          * The number of results will be limited to 50 and sorted in the default sort
@@ -63,7 +63,7 @@ export declare class AttachmentService 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 attachment in the response.
          * The number of results will be limited to 50 and sorted in the default sort
@@ -71,7 +71,7 @@ export declare class AttachmentService 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 attachment in the response.
          * The number of results will be limited to 50 and sorted in the default sort
@@ -79,22 +79,22 @@ export declare class AttachmentService 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 attachment in the response.
          * By default this is included and can be omitted by setting the value to `false`.
          */
-        includeVersion?: boolean;
-    }): Promise<AttachmentSingle & ({
-        _links?: {
+        includeVersion?: boolean | undefined;
+    }) => Promise<AttachmentSingle & {
+        _links?: ({
             /** Base url of the Confluence site. */
-            base?: string;
+            base?: string | undefined;
         } & {
             [key: string]: unknown;
-        };
+        }) | undefined;
     } & {
         [key: string]: unknown;
-    })>;
+    }>;
     /**
      * Returns all attachments. The number of results is limited by the `limit`
      * parameter and additional results (if available)
@@ -108,33 +108,33 @@ export declare class AttachmentService extends CommonHttpService {
      * @scopes-current read:attachment:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-attachment#api-attachments-get
      */
-    getAttachments({ sort, cursor, status, mediaType, filename, limit, }?: {
+    getAttachments: ({ sort, cursor, status, mediaType, filename, limit, }?: {
         /** Used to sort the result by a particular field. */
-        sort?: AttachmentSortOrder;
+        sort?: AttachmentSortOrder | 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;
         /**
          * Filter the results to attachments based on their status. By default, `current`
          * and `archived` are used.
          */
-        status?: ("current" | "archived" | "trashed")[];
+        status?: ("current" | "trashed" | "archived")[] | undefined;
         /** Filters on the mediaType of attachments. Only one may be specified. */
-        mediaType?: string;
+        mediaType?: string | undefined;
         /** Filters on the file-name of attachments. Only one may be specified. */
-        filename?: string;
+        filename?: string | undefined;
         /**
          * Maximum number of attachments 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?: AttachmentBulk[];
-        _links?: MultiEntityLinks;
+        limit?: number | undefined;
+    }) => Promise<{
+        results?: AttachmentBulk[] | undefined;
+        _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;
@@ -151,35 +151,35 @@ export declare class AttachmentService extends CommonHttpService {
      * @scopes-current read:attachment:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-attachment#api-blogposts-id-attachments-get
      */
-    getBlogpostAttachments({ id, sort, cursor, status, mediaType, filename, limit, }: {
+    getBlogpostAttachments: ({ id, sort, cursor, status, mediaType, filename, limit, }: {
         /** The ID of the blog post for which attachments should be returned. */
         id: number;
         /** Used to sort the result by a particular field. */
-        sort?: AttachmentSortOrder;
+        sort?: AttachmentSortOrder | 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;
         /**
          * Filter the results to attachments based on their status. By default, `current`
          * and `archived` are used.
          */
-        status?: ("current" | "archived" | "trashed")[];
+        status?: ("current" | "trashed" | "archived")[] | undefined;
         /** Filters on the mediaType of attachments. Only one may be specified. */
-        mediaType?: string;
+        mediaType?: string | undefined;
         /** Filters on the file-name of attachments. Only one may be specified. */
-        filename?: string;
+        filename?: string | undefined;
         /**
          * Maximum number of attachments 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?: AttachmentBulk[];
-        _links?: MultiEntityLinks;
+        limit?: number | undefined;
+    }) => Promise<{
+        results?: AttachmentBulk[] | undefined;
+        _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;
@@ -197,35 +197,35 @@ export declare class AttachmentService extends CommonHttpService {
      * @scopes-current read:attachment:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-attachment#api-custom-content-id-attachments-get
      */
-    getCustomContentAttachments({ id, sort, cursor, status, mediaType, filename, limit, }: {
+    getCustomContentAttachments: ({ id, sort, cursor, status, mediaType, filename, limit, }: {
         /** The ID of the custom content for which attachments should be returned. */
         id: number;
         /** Used to sort the result by a particular field. */
-        sort?: AttachmentSortOrder;
+        sort?: AttachmentSortOrder | 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;
         /**
          * Filter the results to attachments based on their status. By default, `current`
          * and `archived` are used.
          */
-        status?: ("current" | "archived" | "trashed")[];
+        status?: ("current" | "trashed" | "archived")[] | undefined;
         /** Filters on the mediaType of attachments. Only one may be specified. */
-        mediaType?: string;
+        mediaType?: string | undefined;
         /** Filters on the file-name of attachments. Only one may be specified. */
-        filename?: string;
+        filename?: string | undefined;
         /**
          * Maximum number of attachments 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?: AttachmentBulk[];
-        _links?: MultiEntityLinks;
+        limit?: number | undefined;
+    }) => Promise<{
+        results?: AttachmentBulk[] | undefined;
+        _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;
@@ -243,26 +243,26 @@ export declare class AttachmentService extends CommonHttpService {
      * @scopes-current read:attachment:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-attachment#api-labels-id-attachments-get
      */
-    getLabelAttachments({ id, sort, cursor, limit, }: {
+    getLabelAttachments: ({ id, sort, cursor, limit, }: {
         /** The ID of the label for which attachments should be returned. */
         id: number;
         /** Used to sort the result by a particular field. */
-        sort?: AttachmentSortOrder;
+        sort?: AttachmentSortOrder | 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;
-    }): Promise<{
-        results?: AttachmentBulk[];
-        _links?: MultiEntityLinks;
+        limit?: number | undefined;
+    }) => Promise<{
+        results?: AttachmentBulk[] | undefined;
+        _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;
@@ -279,35 +279,35 @@ export declare class AttachmentService extends CommonHttpService {
      * @scopes-current read:attachment:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-attachment#api-pages-id-attachments-get
      */
-    getPageAttachments({ id, sort, cursor, status, mediaType, filename, limit, }: {
+    getPageAttachments: ({ id, sort, cursor, status, mediaType, filename, limit, }: {
         /** The ID of the page for which attachments should be returned. */
         id: number;
         /** Used to sort the result by a particular field. */
-        sort?: AttachmentSortOrder;
+        sort?: AttachmentSortOrder | 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;
         /**
          * Filter the results to attachments based on their status. By default, `current`
          * and `archived` are used.
          */
-        status?: ("current" | "archived" | "trashed")[];
+        status?: ("current" | "trashed" | "archived")[] | undefined;
         /** Filters on the mediaType of attachments. Only one may be specified. */
-        mediaType?: string;
+        mediaType?: string | undefined;
         /** Filters on the file-name of attachments. Only one may be specified. */
-        filename?: string;
+        filename?: string | undefined;
         /**
          * Maximum number of attachments 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?: AttachmentBulk[];
-        _links?: MultiEntityLinks;
+        limit?: number | undefined;
+    }) => Promise<{
+        results?: AttachmentBulk[] | undefined;
+        _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;