@resolution/confluence-api-client 0.4.4 → 0.4.6

package/lib/openapi/v1/services/SpaceService.d.ts

@@ -19,10 +19,10 @@ export declare class SpaceService extends CommonHttpService {
      * write:space.permission:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-private-post
      */
-    createPrivateSpace({ spaceCreate, }: {
+    createPrivateSpace: ({ spaceCreate, }: {
         /** The space to be created. */
         spaceCreate: SpaceCreate;
-    }): Promise<Space | null>;
+    }) => Promise<Space | null>;
     /**
      * Creates a new space. Note, currently you cannot set space labels when
      * creating a space.
@@ -37,10 +37,10 @@ export declare class SpaceService extends CommonHttpService {
      * write:space.permission:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-post
      */
-    createSpace({ spaceCreate, }: {
+    createSpace: ({ spaceCreate, }: {
         /** The space to be created. */
         spaceCreate: SpaceCreate;
-    }): Promise<Space | null>;
+    }) => Promise<Space | null>;
     /**
      * Permanently deletes a space without sending it to the trash. Note, the space
      * will be deleted in a long running task.
@@ -57,10 +57,10 @@ export declare class SpaceService extends CommonHttpService {
      * @scopes-beta read:content.metadata:confluence, delete:space:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-delete
      */
-    deleteSpace({ spaceKey, }: {
+    deleteSpace: ({ spaceKey, }: {
         /** The key of the space to delete. */
         spaceKey: string;
-    }): Promise<LongTask>;
+    }) => Promise<LongTask>;
     /**
      * Deprecated, use [Confluence's v2
      * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
@@ -83,7 +83,7 @@ export declare class SpaceService extends CommonHttpService {
      * @scopes-beta read:content-details:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-content-type-get
      */
-    getContentByTypeForSpace({ spaceKey, type, depth, expand, start, limit, }: {
+    getContentByTypeForSpace: ({ spaceKey, type, depth, expand, start, limit, }: {
         /** The key of the space to be queried for its content. */
         spaceKey: string;
         /** The type of content to return. `page`, `blogpost`, `<some_customContentType>`. */
@@ -92,7 +92,7 @@ export declare class SpaceService extends CommonHttpService {
          * Filter the results to content at the root level of the space or all
          * content.
          */
-        depth?: "all" | "root";
+        depth?: "all" | "root" | undefined;
         /**
          * A multi-value parameter indicating which properties of the content to expand.
          *
@@ -187,15 +187,15 @@ export declare class SpaceService extends CommonHttpService {
          * - `extensions.inlineProperties` returns inline comment-specific properties.
          * - `extensions.resolution` returns the resolution status of each comment.
          */
-        expand?: string[];
+        expand?: string[] | undefined;
         /** The starting index of the returned content. */
-        start?: number;
+        start?: number | undefined;
         /**
          * The maximum number of content objects to return per page. Note, this
          * may be restricted by fixed system limits.
          */
-        limit?: number;
-    }): Promise<ContentArray>;
+        limit?: number | undefined;
+    }) => Promise<ContentArray>;
     /**
      * Deprecated, use [Confluence's v2
      * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
@@ -218,11 +218,11 @@ export declare class SpaceService extends CommonHttpService {
      * @scopes-beta read:content-details:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-content-get
      */
-    getContentForSpace({ spaceKey, depth, expand, start, limit, }: {
+    getContentForSpace: ({ spaceKey, depth, expand, start, limit, }: {
         /** The key of the space to be queried for its content. */
         spaceKey: string;
         /** Filter the results to content at the root level of the space or all content. */
-        depth?: "all" | "root";
+        depth?: "all" | "root" | undefined;
         /**
          * A multi-value parameter indicating which properties of the content to expand.
          *
@@ -317,18 +317,18 @@ export declare class SpaceService extends CommonHttpService {
          * - `extensions.inlineProperties` returns inline comment-specific properties.
          * - `extensions.resolution` returns the resolution status of each comment.
          */
-        expand?: string[];
+        expand?: string[] | undefined;
         /** The starting index of the returned content. */
-        start?: number;
+        start?: number | undefined;
         /**
          * The maximum number of content objects to return per page. Note, this
          * may be restricted by fixed system limits.
          */
-        limit?: number;
-    }): Promise<{
-        page?: ContentArray;
-        blogpost?: ContentArray;
-        _links?: GenericLinks;
+        limit?: number | undefined;
+    }) => Promise<{
+        page?: ContentArray | undefined;
+        blogpost?: ContentArray | undefined;
+        _links?: GenericLinks | undefined;
     } & {
         [key: string]: unknown;
     }>;
@@ -349,7 +349,7 @@ export declare class SpaceService extends CommonHttpService {
      * @scopes-beta read:content-details:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-get
      */
-    getSpace({ spaceKey, expand, }: {
+    getSpace: ({ spaceKey, expand, }: {
         /** The key of the space to be returned. */
         spaceKey: string;
         /**
@@ -376,8 +376,8 @@ export declare class SpaceService extends CommonHttpService {
          *   - `homepage` returns information about the space homepage.
          *   - `history` returns information about the history of the space.
          */
-        expand?: ("settings" | "metadata" | "metadata.labels" | "operations" | "lookAndFeel" | "permissions" | "icon" | "description" | "description.plain" | "description.view" | "theme" | "homepage" | "history")[];
-    }): Promise<Space | null>;
+        expand?: ("metadata" | "description" | "history" | "settings" | "icon" | "homepage" | "operations" | "permissions" | "theme" | "lookAndFeel" | "metadata.labels" | "description.plain" | "description.view")[] | undefined;
+    }) => Promise<Space | null>;
     /**
      * Deprecated, use [Confluence's v2
      * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
@@ -397,29 +397,29 @@ export declare class SpaceService extends CommonHttpService {
      * @scopes-beta read:content-details:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-get
      */
-    getSpaces({ spaceKey, spaceId, type, status, label, favourite, favouriteUserKey, expand, start, limit, }?: {
+    getSpaces: ({ spaceKey, spaceId, type, status, label, favourite, favouriteUserKey, expand, start, limit, }?: {
         /**
          * The key of the space to be returned. To return multiple spaces,
          * specify this parameter multiple times with different values.
          */
-        spaceKey?: string[];
+        spaceKey?: string[] | undefined;
         /**
          * The id of the space to be returned. To return multiple spaces,
          * specify this parameter multiple times with different values.
          */
-        spaceId?: number[];
+        spaceId?: number[] | undefined;
         /** Filter the results to spaces based on their type. */
-        type?: "global" | "collaboration" | "knowledge_base" | "personal";
+        type?: "global" | "personal" | "collaboration" | "knowledge_base" | undefined;
         /** Filter the results to spaces based on their status. */
-        status?: "current" | "archived";
+        status?: "current" | "archived" | undefined;
         /** Filter the results to spaces based on their label. */
-        label?: string[];
+        label?: string[] | undefined;
         /**
          * Filter the results to the favourite spaces of the user specified by
          * `favouriteUserKey`. Note, 'favourite' spaces are also
          * known as 'saved for later' spaces.
          */
-        favourite?: boolean;
+        favourite?: boolean | undefined;
         /**
          * The userKey of the user, whose favourite spaces are used to filter
          * the results when using the `favourite` parameter.
@@ -427,7 +427,7 @@ export declare class SpaceService extends CommonHttpService {
          * Leave blank for the current user. Use [Get user](#api-user-get) to
          * get the userKey for a user.
          */
-        favouriteUserKey?: string;
+        favouriteUserKey?: string | undefined;
         /**
          * A multi-value parameter indicating which properties of the spaces to
          * expand, where:
@@ -452,15 +452,15 @@ export declare class SpaceService extends CommonHttpService {
          *   - `homepage` returns information about the space homepage.
          *   - `history` returns information about the history of the space.
          */
-        expand?: ("settings" | "metadata" | "metadata.labels" | "operations" | "lookAndFeel" | "permissions" | "icon" | "description" | "description.plain" | "description.view" | "theme" | "homepage" | "history")[];
+        expand?: ("metadata" | "description" | "history" | "settings" | "icon" | "homepage" | "operations" | "permissions" | "theme" | "lookAndFeel" | "metadata.labels" | "description.plain" | "description.view")[] | undefined;
         /** The starting index of the returned spaces. */
-        start?: number;
+        start?: number | undefined;
         /**
          * The maximum number of spaces to return per page. Note, this may be
          * restricted by fixed system limits.
          */
-        limit?: number;
-    }): Promise<SpaceArray>;
+        limit?: number | undefined;
+    }) => Promise<SpaceArray>;
     /**
      * Updates the name, description, or homepage of a space.
      *
@@ -478,11 +478,11 @@ export declare class SpaceService extends CommonHttpService {
      * write:space.permission:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-put
      */
-    updateSpace({ spaceKey, spaceUpdate, }: {
+    updateSpace: ({ spaceKey, spaceUpdate, }: {
         /** The key of the space to update. */
         spaceKey: string;
         /** The updated space. */
         spaceUpdate: SpaceUpdate;
-    }): Promise<Space | null>;
+    }) => Promise<Space | null>;
     static initialize(): void;
 }