@growi/sdk-typescript 1.0.0 → 1.1.0

package/src/generated/v1/index.schemas.ts

@@ -2,7 +2,7 @@
  * Generated by orval v7.9.0 🍺
  * Do not edit manually.
  * GROWI REST API v1
- * OpenAPI spec version: 7.2.6-RC.0
+ * OpenAPI spec version: 7.2.8-RC.0
  */
 /**
  * The type for Comment.comment
@@ -30,37 +30,43 @@ export interface Comment {
   createdAt?: string;
 }
 
-/**
- * provider
- */
-export type UpdatePostProvider = (typeof UpdatePostProvider)[keyof typeof UpdatePostProvider];
+export interface PageTagsData {
+  /** Array of tag names associated with the page */
+  tags?: string[];
+}
 
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export const UpdatePostProvider = {
-  slack: 'slack',
-} as const;
+export interface UpdatePostData {
+  /** Array of channel names for notifications */
+  updatePost?: string[];
+}
+
+export interface PageRemoveData {
+  /** Path of the deleted page */
+  path?: string;
+  /** Whether deletion was recursive */
+  isRecursively?: boolean;
+  /** Whether deletion was complete */
+  isCompletely?: boolean;
+}
 
 /**
- * UpdatePost
+ * Restored page object
  */
-export interface UpdatePost {
-  /** update post ID */
+export type PageRevertDataPage = {
   _id?: string;
-  /** DB record version */
-  __v?: number;
-  /** path pattern */
-  pathPattern?: string;
-  /** patternPrefix prefix */
-  patternPrefix?: string;
-  /** path */
-  patternPrefix2?: string;
-  /** channel */
-  channel?: string;
-  /** provider */
-  provider?: UpdatePostProvider;
-  creator?: User;
-  /** date created at */
-  createdAt?: string;
+  path?: string;
+  title?: string;
+  status?: string;
+};
+
+export interface PageRevertData {
+  /** Restored page object */
+  page?: PageRevertDataPage;
+}
+
+export interface PageUnlinkData {
+  /** Path for which redirects were removed */
+  path?: string;
 }
 
 export interface ElasticsearchResultMeta {
@@ -345,38 +351,90 @@ export interface Tag {
   count?: number;
 }
 
+export interface ApiResponseBase {
+  /** Indicates if the request was successful */
+  ok: boolean;
+}
+
+export type ApiResponseSuccessAllOf = {
+  /** Success indicator (always true for successful responses) */
+  ok?: boolean;
+};
+
 /**
- * API is succeeded
+ * Successful API response
  */
-export type V1ResponseOK = boolean;
+export type ApiResponseSuccess = ApiResponseBase & ApiResponseSuccessAllOf;
 
 /**
- * Response v1
+ * Detailed error object
  */
-export interface V1Response {
-  ok?: V1ResponseOK;
-}
+export type ApiResponseErrorAllOfErrorOneOf = { [key: string]: unknown };
+
+/**
+ * Error message or error object containing details about the failure
+ */
+export type ApiResponseErrorAllOfError = string | ApiResponseErrorAllOfErrorOneOf;
+
+export type ApiResponseErrorAllOf = {
+  /** Success indicator (always false for error responses) */
+  ok?: boolean;
+  /** Error message or error object containing details about the failure */
+  error?: ApiResponseErrorAllOfError;
+};
+
+/**
+ * Error API response
+ */
+export type ApiResponseError = ApiResponseBase & ApiResponseErrorAllOf;
+
+export type PageTagsSuccessResponse = ApiResponseSuccess & PageTagsData;
+
+export type UpdatePostSuccessResponse = ApiResponseSuccess & UpdatePostData;
+
+export type PageRemoveSuccessResponse = ApiResponseSuccess & PageRemoveData;
+
+export type PageRevertSuccessResponse = ApiResponseSuccess & PageRevertData;
+
+export type PageUnlinkSuccessResponse = ApiResponseSuccess & PageUnlinkData;
+
+/**
+ * Bad request
+ */
+export type BadRequestResponse = ApiResponseError;
+
+/**
+ * Forbidden - insufficient permissions
+ */
+export type ForbiddenResponse = ApiResponseError;
 
 /**
- * Forbidden
+ * Resource not found
  */
-export type N403Response = void;
+export type NotFoundResponse = ApiResponseError;
 
 /**
- * Internal Server Error
+ * Conflict
  */
-export type N500Response = void;
+export type ConflictResponse = ApiResponseError;
+
+/**
+ * Internal server error
+ */
+export type InternalServerErrorResponse = ApiResponseError;
 
 export type GetCommentsParams = {
   page_id?: ObjectId;
   revision_id?: ObjectId;
 };
 
-export type GetComments200 = {
-  ok?: V1ResponseOK;
+export type GetComments200AllOf = {
+  /** List of comments for the page revision */
   comments?: Comment[];
 };
 
+export type GetComments200 = ApiResponseSuccess & GetComments200AllOf;
+
 export type AddCommentBodyCommentForm = {
   page_id?: ObjectId;
   revision_id?: ObjectId;
@@ -388,11 +446,13 @@ export type AddCommentBody = {
   commentForm: AddCommentBodyCommentForm;
 };
 
-export type AddComment200 = {
-  ok?: V1ResponseOK;
+export type AddComment200AllOf = {
+  /** The newly created comment */
   comment?: Comment;
 };
 
+export type AddComment200 = ApiResponseSuccess & AddComment200AllOf;
+
 export type UpdateCommentBodyFormCommentForm = {
   page_id?: ObjectId;
   revision_id?: ObjectId;
@@ -408,20 +468,17 @@ export type UpdateCommentBody = {
   form: UpdateCommentBodyForm;
 };
 
-export type UpdateComment200 = {
-  ok?: V1ResponseOK;
+export type UpdateComment200AllOf = {
+  /** The updated comment */
   comment?: Comment;
 };
 
+export type UpdateComment200 = ApiResponseSuccess & UpdateComment200AllOf;
+
 export type RemoveCommentBody = {
   comment_id: ObjectId;
 };
 
-export type RemoveComment200 = {
-  ok?: V1ResponseOK;
-  comment?: Comment;
-};
-
 export type PostLoginBodyLoginForm = {
   username?: string;
   password?: string;
@@ -451,21 +508,40 @@ export type PostRegister200 = {
 };
 
 export type GetPageTagParams = {
-  pageId?: ObjectId;
+  /**
+   * Unique identifier of the page
+   */
+  pageId: string;
 };
 
-export type GetPageTag200 = {
-  ok?: V1ResponseOK;
-  tags?: Tags;
+export type GetUpdatePostParams = {
+  /**
+   * Page path to get UpdatePost settings for
+   */
+  path: string;
 };
 
-export type GetUpdatePostPageParams = {
-  path?: PagePath;
+export type RemovePageBody = {
+  /** Unique identifier of the page to delete */
+  page_id: string;
+  /** Revision ID for conflict detection */
+  revision_id?: string;
+  /** Whether to delete the page completely (true) or soft delete (false) */
+  completely?: boolean;
+  /** Whether to delete child pages recursively */
+  recursively?: boolean;
+};
+
+export type RevertRemovePageBody = {
+  /** Unique identifier of the page to restore */
+  page_id: string;
+  /** Whether to restore child pages recursively */
+  recursively?: boolean;
 };
 
-export type GetUpdatePostPage200 = {
-  ok?: V1ResponseOK;
-  updatePost?: UpdatePost;
+export type UnlinkPageBody = {
+  /** Target path to remove redirects for */
+  path: string;
 };
 
 export type SearchPagesParams = {
@@ -475,8 +551,8 @@ export type SearchPagesParams = {
   limit?: Limit;
 };
 
-export type SearchPages200 = {
-  ok?: V1ResponseOK;
+export type SearchPages200AllOf = {
+  /** Elasticsearch metadata */
   meta?: ElasticsearchResultMeta;
   /** total count of pages */
   totalCount?: number;
@@ -484,6 +560,8 @@ export type SearchPages200 = {
   data?: Page[];
 };
 
+export type SearchPages200 = ApiResponseSuccess & SearchPages200AllOf;
+
 export type SearchTagsParams = {
   /**
    * keyword to search
@@ -491,32 +569,38 @@ export type SearchTagsParams = {
   q?: string;
 };
 
-export type SearchTags200 = {
-  ok?: V1ResponseOK;
+export type SearchTags200AllOf = {
+  /** List of matching tags */
   tags?: Tags;
 };
 
+export type SearchTags200 = ApiResponseSuccess & SearchTags200AllOf;
+
 export type UpdateTagBody = {
   pageId?: ObjectId;
   revisionId?: ObjectId;
   tags?: Tags;
 };
 
-export type UpdateTag200 = {
-  ok?: V1ResponseOK;
+export type UpdateTag200AllOf = {
+  /** Updated tags for the page */
   tags?: Tags;
 };
 
+export type UpdateTag200 = ApiResponseSuccess & UpdateTag200AllOf;
+
 export type ListTagsParams = {
   limit?: Limit;
   offset?: Offset;
 };
 
-export type ListTags200 = {
-  ok?: V1ResponseOK;
+export type ListTags200AllOf = {
+  /** List of tags with count information */
   data?: Tag[];
 };
 
+export type ListTags200 = ApiResponseSuccess & ListTags200AllOf;
+
 export type UploadProfileImageBodyOne = {
   /** attachment data */
   file?: Blob;
@@ -531,24 +615,18 @@ export type UploadProfileImageBodyTwo = {
   user?: string;
 };
 
-export type UploadProfileImage200 = {
-  ok?: V1ResponseOK;
+export type UploadProfileImage200AllOf = {
+  /** The uploaded profile image attachment */
   attachment?: AttachmentProfile;
 };
 
+export type UploadProfileImage200 = ApiResponseSuccess & UploadProfileImage200AllOf;
+
 export type RemoveAttachmentBody = {
   attachment_id: ObjectId;
 };
 
-export type RemoveAttachment200 = {
-  ok?: V1ResponseOK;
-};
-
 export type RemoveProfileImageBody = {
   /** user to remove profile image */
   user?: string;
 };
-
-export type RemoveProfileImage200 = {
-  ok?: V1ResponseOK;
-};

package/src/generated/v1/index.ts

@@ -2,35 +2,39 @@
  * Generated by orval v7.9.0 🍺
  * Do not edit manually.
  * GROWI REST API v1
- * OpenAPI spec version: 7.2.6-RC.0
+ * OpenAPI spec version: 7.2.8-RC.0
  */
 import type {
   AddComment200,
   AddCommentBody,
+  ApiResponseSuccess,
   GetComments200,
   GetCommentsParams,
-  GetPageTag200,
   GetPageTagParams,
-  GetUpdatePostPage200,
-  GetUpdatePostPageParams,
+  GetUpdatePostParams,
   ListTags200,
   ListTagsParams,
+  PageRemoveSuccessResponse,
+  PageRevertSuccessResponse,
+  PageTagsSuccessResponse,
+  PageUnlinkSuccessResponse,
   PostLogin200,
   PostLoginBody,
   PostRegister200,
   PostRegisterBody,
-  RemoveAttachment200,
   RemoveAttachmentBody,
-  RemoveComment200,
   RemoveCommentBody,
-  RemoveProfileImage200,
+  RemovePageBody,
   RemoveProfileImageBody,
+  RevertRemovePageBody,
   SearchPages200,
   SearchPagesParams,
   SearchTags200,
   SearchTagsParams,
+  UnlinkPageBody,
   UpdateComment200,
   UpdateCommentBody,
+  UpdatePostSuccessResponse,
   UpdateTag200,
   UpdateTagBody,
   UploadProfileImage200,
@@ -78,7 +82,7 @@ export const getGrowirestapiv1 = () => {
    * @summary /comments.remove
    */
   const removeComment = (removeCommentBody: RemoveCommentBody, options?: SecondParameter<typeof customInstance>) => {
-    return customInstance<RemoveComment200>(
+    return customInstance<ApiResponseSuccess>(
       { url: `/comments.remove`, method: 'POST', headers: { 'Content-Type': 'application/json' }, data: removeCommentBody },
       options,
     );
@@ -102,19 +106,52 @@ export const getGrowirestapiv1 = () => {
   };
 
   /**
-   * Get page tag
-   * @summary /pages.getPageTag
+   * Retrieve all tags associated with a specific page
+   * @summary Get page tags
    */
-  const getPageTag = (params?: GetPageTagParams, options?: SecondParameter<typeof customInstance>) => {
-    return customInstance<GetPageTag200>({ url: `/pages.getPageTag`, method: 'GET', params }, options);
+  const getPageTag = (params: GetPageTagParams, options?: SecondParameter<typeof customInstance>) => {
+    return customInstance<PageTagsSuccessResponse>({ url: `/pages.getPageTag`, method: 'GET', params }, options);
   };
 
   /**
-   * Get UpdatePost setting list
-   * @summary /pages.updatePost
+   * Retrieve UpdatePost notification settings for a specific path
+   * @summary Get UpdatePost settings
    */
-  const getUpdatePostPage = (params?: GetUpdatePostPageParams, options?: SecondParameter<typeof customInstance>) => {
-    return customInstance<GetUpdatePostPage200>({ url: `/pages.updatePost`, method: 'GET', params }, options);
+  const getUpdatePost = (params: GetUpdatePostParams, options?: SecondParameter<typeof customInstance>) => {
+    return customInstance<UpdatePostSuccessResponse>({ url: `/pages.updatePost`, method: 'GET', params }, options);
+  };
+
+  /**
+   * Delete a page either softly or completely, with optional recursive deletion
+   * @summary Remove page
+   */
+  const removePage = (removePageBody: RemovePageBody, options?: SecondParameter<typeof customInstance>) => {
+    return customInstance<PageRemoveSuccessResponse>(
+      { url: `/pages.remove`, method: 'POST', headers: { 'Content-Type': 'application/json' }, data: removePageBody },
+      options,
+    );
+  };
+
+  /**
+   * Restore a previously deleted (soft-deleted) page
+   * @summary Revert removed page
+   */
+  const revertRemovePage = (revertRemovePageBody: RevertRemovePageBody, options?: SecondParameter<typeof customInstance>) => {
+    return customInstance<PageRevertSuccessResponse>(
+      { url: `/pages.revertRemove`, method: 'POST', headers: { 'Content-Type': 'application/json' }, data: revertRemovePageBody },
+      options,
+    );
+  };
+
+  /**
+   * Remove all redirect entries that point to the specified page path
+   * @summary Remove page redirects
+   */
+  const unlinkPage = (unlinkPageBody: UnlinkPageBody, options?: SecondParameter<typeof customInstance>) => {
+    return customInstance<PageUnlinkSuccessResponse>(
+      { url: `/pages.unlink`, method: 'POST', headers: { 'Content-Type': 'application/json' }, data: unlinkPageBody },
+      options,
+    );
   };
 
   /**
@@ -172,7 +209,7 @@ export const getGrowirestapiv1 = () => {
    * @summary /attachments.remove
    */
   const removeAttachment = (removeAttachmentBody: RemoveAttachmentBody, options?: SecondParameter<typeof customInstance>) => {
-    return customInstance<RemoveAttachment200>(
+    return customInstance<ApiResponseSuccess>(
       { url: `/attachments.remove`, method: 'POST', headers: { 'Content-Type': 'application/json' }, data: removeAttachmentBody },
       options,
     );
@@ -183,7 +220,7 @@ export const getGrowirestapiv1 = () => {
    * @summary /attachments.removeProfileImage
    */
   const removeProfileImage = (removeProfileImageBody: RemoveProfileImageBody, options?: SecondParameter<typeof customInstance>) => {
-    return customInstance<RemoveProfileImage200>(
+    return customInstance<ApiResponseSuccess>(
       { url: `/attachments.removeProfileImage`, method: 'POST', headers: { 'Content-Type': 'application/json' }, data: removeProfileImageBody },
       options,
     );
@@ -197,7 +234,10 @@ export const getGrowirestapiv1 = () => {
     postLogin,
     postRegister,
     getPageTag,
-    getUpdatePostPage,
+    getUpdatePost,
+    removePage,
+    revertRemovePage,
+    unlinkPage,
     searchPages,
     searchTags,
     updateTag,
@@ -220,7 +260,10 @@ export type RemoveCommentResult = NonNullable<Awaited<ReturnType<ReturnType<type
 export type PostLoginResult = NonNullable<Awaited<ReturnType<ReturnType<typeof getGrowirestapiv1>['postLogin']>>>;
 export type PostRegisterResult = NonNullable<Awaited<ReturnType<ReturnType<typeof getGrowirestapiv1>['postRegister']>>>;
 export type GetPageTagResult = NonNullable<Awaited<ReturnType<ReturnType<typeof getGrowirestapiv1>['getPageTag']>>>;
-export type GetUpdatePostPageResult = NonNullable<Awaited<ReturnType<ReturnType<typeof getGrowirestapiv1>['getUpdatePostPage']>>>;
+export type GetUpdatePostResult = NonNullable<Awaited<ReturnType<ReturnType<typeof getGrowirestapiv1>['getUpdatePost']>>>;
+export type RemovePageResult = NonNullable<Awaited<ReturnType<ReturnType<typeof getGrowirestapiv1>['removePage']>>>;
+export type RevertRemovePageResult = NonNullable<Awaited<ReturnType<ReturnType<typeof getGrowirestapiv1>['revertRemovePage']>>>;
+export type UnlinkPageResult = NonNullable<Awaited<ReturnType<ReturnType<typeof getGrowirestapiv1>['unlinkPage']>>>;
 export type SearchPagesResult = NonNullable<Awaited<ReturnType<ReturnType<typeof getGrowirestapiv1>['searchPages']>>>;
 export type SearchTagsResult = NonNullable<Awaited<ReturnType<ReturnType<typeof getGrowirestapiv1>['searchTags']>>>;
 export type UpdateTagResult = NonNullable<Awaited<ReturnType<ReturnType<typeof getGrowirestapiv1>['updateTag']>>>;

package/src/generated/v3/index.schemas.ts

@@ -2,7 +2,7 @@
  * Generated by orval v7.9.0 🍺
  * Do not edit manually.
  * GROWI REST API v3
- * OpenAPI spec version: 7.2.6-RC.0
+ * OpenAPI spec version: 7.2.8-RC.0
  */
 export interface SyncStatus {
   isExecutingSync?: boolean;
@@ -1614,27 +1614,67 @@ export interface Tag {
   count?: number;
 }
 
+export interface ApiResponseBase {
+  /** Indicates if the request was successful */
+  ok: boolean;
+}
+
+export type ApiResponseSuccessAllOf = {
+  /** Success indicator (always true for successful responses) */
+  ok?: boolean;
+};
+
 /**
- * API is succeeded
+ * Successful API response
  */
-export type V1ResponseOK = boolean;
+export type ApiResponseSuccess = ApiResponseBase & ApiResponseSuccessAllOf;
 
 /**
- * Response v1
+ * Detailed error object
  */
-export interface V1Response {
-  ok?: V1ResponseOK;
-}
+export type ApiResponseErrorAllOfErrorOneOf = { [key: string]: unknown };
+
+/**
+ * Error message or error object containing details about the failure
+ */
+export type ApiResponseErrorAllOfError = string | ApiResponseErrorAllOfErrorOneOf;
+
+export type ApiResponseErrorAllOf = {
+  /** Success indicator (always false for error responses) */
+  ok?: boolean;
+  /** Error message or error object containing details about the failure */
+  error?: ApiResponseErrorAllOfError;
+};
+
+/**
+ * Error API response
+ */
+export type ApiResponseError = ApiResponseBase & ApiResponseErrorAllOf;
+
+/**
+ * Bad request
+ */
+export type BadRequestResponse = ApiResponseError;
+
+/**
+ * Forbidden - insufficient permissions
+ */
+export type ForbiddenResponse = ApiResponseError;
+
+/**
+ * Resource not found
+ */
+export type NotFoundResponse = ApiResponseError;
 
 /**
- * Forbidden
+ * Conflict
  */
-export type N403Response = void;
+export type ConflictResponse = ApiResponseError;
 
 /**
- * Internal Server Error
+ * Internal server error
  */
-export type N500Response = void;
+export type InternalServerErrorResponse = ApiResponseError;
 
 export type GetExternalUserGroupRelationsParams = {
   /**

package/src/generated/v3/index.ts

@@ -2,7 +2,7 @@
  * Generated by orval v7.9.0 🍺
  * Do not edit manually.
  * GROWI REST API v3
- * OpenAPI spec version: 7.2.6-RC.0
+ * OpenAPI spec version: 7.2.8-RC.0
  */
 import type {
   ActivityResponse,