@resolution/confluence-api-client 0.4.4 → 0.4.6

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

@@ -16,28 +16,28 @@ export declare class LabelService extends CommonHttpService {
      * @scopes-current read:attachment:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-label#api-attachments-id-labels-get
      */
-    getAttachmentLabels({ id, prefix, sort, cursor, limit, }: {
+    getAttachmentLabels: ({ id, prefix, sort, cursor, limit, }: {
         /** The ID of the attachment for which labels should be returned. */
         id: number;
         /** Filter the results to labels based on their prefix. */
-        prefix?: "my" | "team" | "global" | "system";
+        prefix?: "global" | "my" | "team" | "system" | undefined;
         /** Used to sort the result by a particular field. */
-        sort?: string;
+        sort?: string | 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 labels 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?: Label[];
-        _links?: MultiEntityLinks;
+        limit?: number | undefined;
+    }) => Promise<{
+        results?: Label[] | undefined;
+        _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;
@@ -54,28 +54,28 @@ export declare class LabelService extends CommonHttpService {
      * @scopes-current read:page:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-label#api-blogposts-id-labels-get
      */
-    getBlogPostLabels({ id, prefix, sort, cursor, limit, }: {
+    getBlogPostLabels: ({ id, prefix, sort, cursor, limit, }: {
         /** The ID of the blog post for which labels should be returned. */
         id: number;
         /** Filter the results to labels based on their prefix. */
-        prefix?: "my" | "team" | "global" | "system";
+        prefix?: "global" | "my" | "team" | "system" | undefined;
         /** Used to sort the result by a particular field. */
-        sort?: string;
+        sort?: string | 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 labels 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?: Label[];
-        _links?: MultiEntityLinks;
+        limit?: number | undefined;
+    }) => Promise<{
+        results?: Label[] | undefined;
+        _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;
@@ -93,28 +93,28 @@ export declare class LabelService extends CommonHttpService {
      * @scopes-current read:custom-content:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-label#api-custom-content-id-labels-get
      */
-    getCustomContentLabels({ id, prefix, sort, cursor, limit, }: {
+    getCustomContentLabels: ({ id, prefix, sort, cursor, limit, }: {
         /** The ID of the custom content for which labels should be returned. */
         id: number;
         /** Filter the results to labels based on their prefix. */
-        prefix?: "my" | "team" | "global" | "system";
+        prefix?: "global" | "my" | "team" | "system" | undefined;
         /** Used to sort the result by a particular field. */
-        sort?: string;
+        sort?: string | 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 labels 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?: Label[];
-        _links?: MultiEntityLinks;
+        limit?: number | undefined;
+    }) => Promise<{
+        results?: Label[] | undefined;
+        _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;
@@ -132,31 +132,31 @@ export declare class LabelService extends CommonHttpService {
      * @scopes-current read:label:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-label#api-labels-get
      */
-    getLabels({ labelId, prefix, cursor, sort, limit, }?: {
+    getLabels: ({ labelId, prefix, cursor, sort, limit, }?: {
         /** Filters on label ID. Multiple IDs can be specified as a comma-separated list. */
-        labelId?: number[];
+        labelId?: number[] | undefined;
         /**
          * Filters on label prefix. Multiple IDs can be specified as a comma-separated
          * list.
          */
-        prefix?: string[];
+        prefix?: string[] | 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;
         /** Used to sort the result by a particular field. */
-        sort?: string;
+        sort?: string | undefined;
         /**
          * Maximum number of labels 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?: Label[];
-        _links?: MultiEntityLinks;
+        limit?: number | undefined;
+    }) => Promise<{
+        results?: Label[] | undefined;
+        _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;
@@ -173,28 +173,28 @@ export declare class LabelService extends CommonHttpService {
      * @scopes-current read:page:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-label#api-pages-id-labels-get
      */
-    getPageLabels({ id, prefix, sort, cursor, limit, }: {
+    getPageLabels: ({ id, prefix, sort, cursor, limit, }: {
         /** The ID of the page for which labels should be returned. */
         id: number;
         /** Filter the results to labels based on their prefix. */
-        prefix?: "my" | "team" | "global" | "system";
+        prefix?: "global" | "my" | "team" | "system" | undefined;
         /** Used to sort the result by a particular field. */
-        sort?: string;
+        sort?: string | 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 labels 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?: Label[];
-        _links?: MultiEntityLinks;
+        limit?: number | undefined;
+    }) => Promise<{
+        results?: Label[] | undefined;
+        _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;
@@ -212,28 +212,28 @@ export declare class LabelService extends CommonHttpService {
      * @scopes-current read:space:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-label#api-spaces-id-content-labels-get
      */
-    getSpaceContentLabels({ id, prefix, sort, cursor, limit, }: {
+    getSpaceContentLabels: ({ id, prefix, sort, cursor, limit, }: {
         /** The ID of the space for which labels should be returned. */
         id: number;
         /** Filter the results to labels based on their prefix. */
-        prefix?: "my" | "team";
+        prefix?: "my" | "team" | undefined;
         /** Used to sort the result by a particular field. */
-        sort?: string;
+        sort?: string | 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 labels 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?: Label[];
-        _links?: MultiEntityLinks;
+        limit?: number | undefined;
+    }) => Promise<{
+        results?: Label[] | undefined;
+        _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;
@@ -250,28 +250,28 @@ export declare class LabelService extends CommonHttpService {
      * @scopes-current read:space:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-label#api-spaces-id-labels-get
      */
-    getSpaceLabels({ id, prefix, sort, cursor, limit, }: {
+    getSpaceLabels: ({ id, prefix, sort, cursor, limit, }: {
         /** The ID of the space for which labels should be returned. */
         id: number;
         /** Filter the results to labels based on their prefix. */
-        prefix?: "my" | "team";
+        prefix?: "my" | "team" | undefined;
         /** Used to sort the result by a particular field. */
-        sort?: string;
+        sort?: string | 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 labels 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?: Label[];
-        _links?: MultiEntityLinks;
+        limit?: number | undefined;
+    }) => Promise<{
+        results?: Label[] | undefined;
+        _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;