@growi/sdk-typescript 1.8.0 → 1.11.0

package/dist/generated/v3/index.schemas.d.ts

@@ -2,13 +2,47 @@
  * Generated by orval v7.9.0 🍺
  * Do not edit manually.
  * GROWI REST API v3
- * OpenAPI spec version: 7.3.3-RC.0
+ * OpenAPI spec version: 7.5.7-RC.0
  */
 export interface SyncStatus {
     isExecutingSync?: boolean;
     totalCount?: number;
     count?: number;
 }
+/**
+ * The type of suggestion
+ */
+export type PathSuggestionType = (typeof PathSuggestionType)[keyof typeof PathSuggestionType];
+export declare const PathSuggestionType: {
+    readonly memo: "memo";
+    readonly search: "search";
+    readonly category: "category";
+};
+/**
+ * Whether the content is flow (time-based) or stock (reference)
+ */
+export type PathSuggestionInformationType = (typeof PathSuggestionInformationType)[keyof typeof PathSuggestionInformationType];
+export declare const PathSuggestionInformationType: {
+    readonly flow: "flow";
+    readonly stock: "stock";
+};
+export interface PathSuggestion {
+    /** The type of suggestion */
+    type: PathSuggestionType;
+    /** Suggested page path */
+    path: string;
+    /** Human-readable label for the suggestion */
+    label: string;
+    /** Explanation of why this path is suggested */
+    description: string;
+    /** Page grant (1=public, 4=owner_only, 5=user_group) */
+    grant: number;
+    /** Whether the content is flow (time-based) or stock (reference) */
+    informationType?: PathSuggestionInformationType;
+}
+export interface SuggestPathResponse {
+    suggestions?: PathSuggestion[];
+}
 export type ActivityResponseSerializedPaginationResultDocsItemSnapshot = {
     username?: string;
     _id?: string;
@@ -508,8 +542,6 @@ export interface ThemesMetadata {
 export interface CustomizeSidebar {
     /** The flag whether sidebar is collapsed mode or not. */
     isSidebarCollapsedMode?: boolean;
-    /** The flag whether sidebar is closed at dock mode or not. */
-    isSidebarClosedAtDockMode?: boolean;
 }
 /**
  * Customize Presentation
@@ -1023,6 +1055,8 @@ export interface GeneralSetting {
     isAllGroupMembershipRequiredForPageCompleteDeletion?: boolean;
     /** type of pageDeletionAuthority */
     pageCompleteDeletionAuthority?: string;
+    /** hide all user pages from general users */
+    disableUserPages?: boolean;
     /** enable hide by owner */
     hideRestrictedByOwner?: boolean;
     /** enable hide by group */
@@ -1096,50 +1130,6 @@ export interface LdapAuthSetting {
     /** The property of user object to use in dn interpolation of Group Search Filter */
     ldapGroupDnProperty?: string;
 }
-export interface SamlAuthSetting {
-    /** array of missing mandatory config keys */
-    missingMandatoryConfigKeys?: string[];
-    /** use only env vars for some options */
-    useOnlyEnvVarsForSomeOptions?: boolean;
-    /** entry point for saml */
-    samlEntryPoint?: string;
-    /** issuer for saml */
-    samlIssuer?: string;
-    /** issuer for saml */
-    samlEnvVarIssuer?: string;
-    /** certificate for saml */
-    samlCert?: string;
-    /** certificate for saml */
-    samlEnvVarCert?: string;
-    /** attribute mapping id for saml */
-    samlAttrMapId?: string;
-    /** attribute mapping user name for saml */
-    samlAttrMapUserName?: string;
-    /** attribute mapping mail for saml */
-    samlAttrMapMail?: string;
-    /** attribute mapping id for saml */
-    samlEnvVarAttrMapId?: string;
-    /** attribute mapping user name for saml */
-    samlEnvVarAttrMapUserName?: string;
-    /** attribute mapping mail for saml */
-    samlEnvVarAttrMapMail?: string;
-    /** attribute mapping first name for saml */
-    samlAttrMapFirstName?: string;
-    /** attribute mapping last name for saml */
-    samlAttrMapLastName?: string;
-    /** attribute mapping first name for saml */
-    samlEnvVarAttrMapFirstName?: string;
-    /** attribute mapping last name for saml */
-    samlEnvVarAttrMapLastName?: string;
-    /** local account automatically linked the user name matched */
-    isSameUsernameTreatedAsIdenticalUser?: boolean;
-    /** local account automatically linked the email matched */
-    isSameEmailTreatedAsIdenticalUser?: boolean;
-    /** ABLCRule for saml */
-    samlABLCRule?: string;
-    /** ABLCRule for saml */
-    samlEnvVarABLCRule?: string;
-}
 export interface OidcAuthSetting {
     /** provider name for oidc */
     oidcProviderName?: string;
@@ -1194,6 +1184,50 @@ export interface GoogleOAuthSetting {
     /** local account automatically linked the email matched */
     isSameUsernameTreatedAsIdenticalUser?: boolean;
 }
+export interface SamlAuthSetting {
+    /** array of missing mandatory config keys */
+    missingMandatoryConfigKeys?: string[];
+    /** use only env vars for some options */
+    useOnlyEnvVarsForSomeOptions?: boolean;
+    /** entry point for saml */
+    samlEntryPoint?: string;
+    /** issuer for saml */
+    samlIssuer?: string;
+    /** issuer for saml */
+    samlEnvVarIssuer?: string;
+    /** certificate for saml */
+    samlCert?: string;
+    /** certificate for saml */
+    samlEnvVarCert?: string;
+    /** attribute mapping id for saml */
+    samlAttrMapId?: string;
+    /** attribute mapping user name for saml */
+    samlAttrMapUserName?: string;
+    /** attribute mapping mail for saml */
+    samlAttrMapMail?: string;
+    /** attribute mapping id for saml */
+    samlEnvVarAttrMapId?: string;
+    /** attribute mapping user name for saml */
+    samlEnvVarAttrMapUserName?: string;
+    /** attribute mapping mail for saml */
+    samlEnvVarAttrMapMail?: string;
+    /** attribute mapping first name for saml */
+    samlAttrMapFirstName?: string;
+    /** attribute mapping last name for saml */
+    samlAttrMapLastName?: string;
+    /** attribute mapping first name for saml */
+    samlEnvVarAttrMapFirstName?: string;
+    /** attribute mapping last name for saml */
+    samlEnvVarAttrMapLastName?: string;
+    /** local account automatically linked the user name matched */
+    isSameUsernameTreatedAsIdenticalUser?: boolean;
+    /** local account automatically linked the email matched */
+    isSameEmailTreatedAsIdenticalUser?: boolean;
+    /** ABLCRule for saml */
+    samlABLCRule?: string;
+    /** ABLCRule for saml */
+    samlEnvVarABLCRule?: string;
+}
 export type ShareLinkRelatedPage = {
     /** The unique identifier of the related page */
     _id?: string;
@@ -1322,10 +1356,55 @@ export interface ErrorV3 {
  * Object ID
  */
 export type ObjectId = string;
+/**
+ * Page
+ */
+export interface PageForTreeItem {
+    _id?: ObjectId;
+    path?: PagePath;
+    parent?: PagePath;
+    grant?: PageGrant;
+    lastUpdateUser?: User;
+    descendantCount?: number;
+    isEmpty?: boolean;
+    wip?: boolean;
+    /** date created at */
+    createdAt?: string;
+    /** date updated at */
+    updatedAt?: string;
+}
 /**
  * Page path
  */
 export type PagePath = string;
+/**
+ * @nullable
+ */
+export type GetPageResponsePage = (Page & unknown) | null;
+/**
+ * Metadata about the page request
+ * @nullable
+ */
+export type GetPageResponseMeta = {
+    [key: string]: unknown;
+} | null;
+/**
+ * Response for GET /page endpoint
+ */
+export interface GetPageResponse {
+    /** @nullable */
+    page?: GetPageResponsePage;
+    /**
+     * Array of pages when findAll parameter is used. Null otherwise.
+     * @nullable
+     */
+    pages?: Page[] | null;
+    /**
+     * Metadata about the page request
+     * @nullable
+     */
+    meta?: GetPageResponseMeta;
+}
 /**
  * Grant for page
  */
@@ -1400,7 +1479,7 @@ export type PageInfoForListing = PageInfoForEntity & PageInfoForListingAllOf;
 /**
  * Page information (union of all page info types)
  */
-export type PageInfoAll = PageInfo | PageInfoForEntity | PageInfoForOperation | PageInfoForListing;
+export type PageInfoExt = PageInfo | PageInfoForEntity | PageInfoForOperation | PageInfoForListing;
 /**
  * extend data
  */
@@ -1776,6 +1855,13 @@ export type GetPresetTemplatesByLocaleByTemplateIdForTemplates200 = {
 export type GetPluginTemplatesByLocaleByTemplateIdByReposIdByOrganizationIdForTemplates200 = {
     markdown?: string;
 };
+export type PostSuggestPathForAiToolsBody = {
+    /**
+     * The page content to analyze for path suggestions
+     * @maxLength 50000
+     */
+    body: string;
+};
 export type PostPluginsBodyPluginInstallerForm = {
     url?: string;
     ghBranch?: string;
@@ -1804,6 +1890,9 @@ export type GetActivityParams = {
 export type GetAdminHome200 = {
     adminHomeParams?: SystemInformationParams;
 };
+export type PutFileUploadSettingsForAppSettings200 = {
+    responseParams?: FileUploadSettingParams;
+};
 export type GetAppSettings200 = {
     appSettingsParams?: AppSettingParams;
 };
@@ -1826,8 +1915,25 @@ export type PutSmtpSettingForAppSettings200 = {
 export type PostSmtpTestForAppSettings200 = {
     [key: string]: unknown;
 };
-export type PutFileUploadSettingsForAppSettings200 = {
-    responseParams?: FileUploadSettingParams;
+export type PutOauth2SettingForAppSettingsBody = {
+    /** e-mail address used as from address */
+    fromAddress?: string;
+    /** transmission method */
+    transmissionMethod?: string;
+    /** OAuth 2.0 Client ID */
+    oauth2ClientId?: string;
+    /** OAuth 2.0 Client Secret */
+    oauth2ClientSecret?: string;
+    /** OAuth 2.0 Refresh Token */
+    oauth2RefreshToken?: string;
+    /** Email address of the authorized account */
+    oauth2User?: string;
+};
+export type PutOauth2SettingForAppSettings200MailSettingParams = {
+    [key: string]: unknown;
+};
+export type PutOauth2SettingForAppSettings200 = {
+    mailSettingParams?: PutOauth2SettingForAppSettings200MailSettingParams;
 };
 export type PostV5SchemaMigrationForAppSettings200 = {
     /** is V5 compatible, or not */
@@ -1949,6 +2055,24 @@ export type GetInfoForBookmarksParams = {
 export type PutBookmarks200 = {
     bookmark?: Bookmark;
 };
+export type PutContentDispositionSettings200CurrentDispositionSettings = {
+    /** The list of MIME types set to inline. */
+    inlineMimeTypes?: string[];
+    /** The list of MIME types set to attachment. */
+    attachmentMimeTypes?: string[];
+};
+export type PutContentDispositionSettings200 = {
+    currentDispositionSettings?: PutContentDispositionSettings200CurrentDispositionSettings;
+};
+export type GetContentDispositionSettings200CurrentDispositionSettings = {
+    /** The list of MIME types set to inline. */
+    inlineMimeTypes?: string[];
+    /** The list of MIME types set to attachment. */
+    attachmentMimeTypes?: string[];
+};
+export type GetContentDispositionSettings200 = {
+    currentDispositionSettings?: GetContentDispositionSettings200CurrentDispositionSettings;
+};
 export type GetCustomizeSetting200 = {
     /** customize params */
     customizeParams?: CustomizeSetting;
@@ -2155,22 +2279,8 @@ export type GetHealthcheck503 = {
     errors?: GetHealthcheck503ErrorsItem[];
     info?: HealthcheckInfo;
 };
-/**
- * import settings params
- */
-export type GetImport200ImportSettingsParams = {
-    /** the team name of esa.io */
-    esaTeamName?: string;
-    /** the access token of esa.io */
-    esaAccessToken?: string;
-    /** the team name of qiita.com */
-    qiitaTeamName?: string;
-    /** the access token of qiita.com */
-    qiitaAccessToken?: string;
-};
-export type GetImport200 = {
-    /** import settings params */
-    importSettingsParams?: GetImport200ImportSettingsParams;
+export type GetStatusForImport200 = {
+    status?: ImportStatus;
 };
 /**
  * the array of importing option that have collection name as the key
@@ -2188,9 +2298,6 @@ export type PostImportBody = {
      */
     options?: PostImportBodyOptions;
 };
-export type GetStatusForImport200 = {
-    status?: ImportStatus;
-};
 export type PostUploadForImportBody = {
     file?: Blob;
 };
@@ -2299,39 +2406,14 @@ export type PutEnabledByIdForNotificationSettingGlobalNotification200 = {
     id?: string;
 };
 export type GetRootForPageListing200 = {
-    rootPage?: Page;
-};
-export type GetAncestorsChildrenForPageListingParams = {
-    path: string;
-};
-export type GetAncestorsChildrenForPageListing200AncestorsChildren = {
-    [key: string]: {
-        /** Document ID */
-        _id?: string;
-        /** Number of descendants */
-        descendantCount?: number;
-        /** Indicates if the node is empty */
-        isEmpty?: boolean;
-        /** Access level */
-        grant?: number;
-        /** Path string */
-        path?: string;
-        /**
-         * Revision ID (nullable)
-         * @nullable
-         */
-        revision?: string | null;
-    };
-};
-export type GetAncestorsChildrenForPageListing200 = {
-    ancestorsChildren?: GetAncestorsChildrenForPageListing200AncestorsChildren;
+    rootPage?: PageForTreeItem;
 };
 export type GetChildrenForPageListingParams = {
     id?: string;
     path?: string;
 };
 export type GetChildrenForPageListing200 = {
-    children?: Page[];
+    children?: PageForTreeItem[];
 };
 export type GetInfoForPageListingParams = {
     /**
@@ -2346,7 +2428,33 @@ export type GetInfoForPageListingParams = {
     attachShortBody?: boolean;
 };
 export type GetInfoForPageListing200 = {
-    [key: string]: PageInfoAll;
+    [key: string]: PageInfoExt;
+};
+export type GetItemForPageListingParams = {
+    id: string;
+};
+export type GetItemForPageListing200 = {
+    item?: PageForTreeItem;
+};
+export type GetSharedForPageParams = {
+    /**
+     * share link ID
+     */
+    shareLinkId: ObjectId;
+    /**
+     * page ID
+     */
+    pageId: ObjectId;
+};
+export type GetInfoForPageParams = {
+    /**
+     * page id
+     */
+    pageId: ObjectId;
+    /**
+     * share link id for shared page access
+     */
+    shareLinkId?: ObjectId;
 };
 export type GetPageParams = {
     /**
@@ -2357,6 +2465,18 @@ export type GetPageParams = {
      * page path
      */
     path?: PagePath;
+    /**
+     * If set, returns all pages matching the path (returns pages array instead of single page)
+     */
+    findAll?: boolean;
+    /**
+     * Specific revision ID to retrieve
+     */
+    revisionId?: ObjectId;
+    /**
+     * Include empty pages in results when using findAll
+     */
+    includeEmpty?: boolean;
 };
 export type PostPageBodyGrantUserGroupIdsItem = {
     /** Group type */
@@ -2413,12 +2533,6 @@ export type GetExistForPageParams = {
 export type GetExistForPage200 = {
     isExist?: boolean;
 };
-export type GetInfoForPageParams = {
-    /**
-     * page id
-     */
-    pageId: ObjectId;
-};
 export type GetGrantDataForPageParams = {
     /**
      * page id
@@ -2524,8 +2638,6 @@ export type GetRecentForPagesParams = {
 export type PutRenameForPagesBody = {
     pageId: ObjectId;
     path?: PagePath;
-    /** revision ID */
-    revisionId: string;
     /** new path */
     newPagePath?: string;
     /** whether redirect page */