import {z} from 'zod' export type GetApiGroupsNameArgs = {confidential_data?: number | undefined}; export type GetApiGroupsNameOptions = {baseUrl: string, BearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const permission = z.enum(["*", "list", "download", "upload", "overwrite", "delete", "delete_files", "delete_dirs", "rename", "rename_files", "rename_dirs", "create_dirs", "create_symlinks", "chmod", "chown", "chtimes", "copy"]); export const loginMethods = z.enum(["publickey", "password", "password-over-SSH", "keyboard-interactive", "publickey+password", "publickey+keyboard-interactive", "TLSCertificate", "TLSCertificate+password"]); export const supportedProtocols = z.enum(["SSH", "FTP", "DAV", "HTTP"]); export const patternsFilter = z.object({path: z.string().optional(), allowed_patterns: z.array(z.string()).optional(), denied_patterns: z.array(z.string()).optional(), deny_policy: z.union([z.literal(0), z.literal(1)]).optional()}); export const hooksFilter = z.object({external_auth_disabled: z.boolean().optional(), pre_login_disabled: z.boolean().optional(), check_password_disabled: z.boolean().optional()}); export const webClientOptions = z.enum(["publickey-change-disabled", "tls-cert-change-disabled", "write-disabled", "mfa-disabled", "password-change-disabled", "api-key-auth-change-disabled", "info-change-disabled", "shares-disabled", "password-reset-disabled", "shares-without-password-disabled"]); export const userType = z.enum(["", "LDAPUser", "OSUser"]); export const bandwidthLimit = z.object({sources: z.array(z.string()).optional(), upload_bandwidth: z.number().int().optional(), download_bandwidth: z.number().int().optional()}); export const mFAProtocols = z.enum(["SSH", "FTP", "HTTP"]); export const timePeriod = z.object({day_of_week: z.union([z.literal(0), z.literal(1), z.literal(2), z.literal(3), z.literal(4), z.literal(5), z.literal(6)]).optional(), from: z.string().optional(), to: z.string().optional()}); export const baseUserFilters = z.object({allowed_ip: z.array(z.string()).optional(), denied_ip: z.array(z.string()).optional(), denied_login_methods: z.array(loginMethods).optional(), denied_protocols: z.array(supportedProtocols).optional(), file_patterns: z.array(patternsFilter).optional(), max_upload_file_size: z.number().int().optional(), tls_username: z.string().optional(), tls_certs: z.array(z.string()).optional(), hooks: hooksFilter.optional(), disable_fs_checks: z.boolean().optional(), web_client: z.array(webClientOptions).optional(), allow_api_key_auth: z.boolean().optional(), user_type: userType.optional(), bandwidth_limits: z.array(bandwidthLimit).optional(), external_auth_cache_time: z.number().int().optional(), start_directory: z.string().optional(), two_factor_protocols: z.array(mFAProtocols).optional(), ftp_security: z.union([z.literal(0), z.literal(1)]).optional(), is_anonymous: z.boolean().optional(), default_shares_expiration: z.number().int().optional(), max_shares_expiration: z.number().int().optional(), password_expiration: z.number().int().optional(), password_strength: z.number().int().optional(), access_time: z.array(timePeriod).optional()}); export const fsProviders = z.union([z.literal(0), z.literal(1), z.literal(2), z.literal(3), z.literal(4), z.literal(5), z.literal(6)]); export const oSFsConfig = z.object({read_buffer_size: z.number().int().gte(0).lte(10).optional(), write_buffer_size: z.number().int().gte(0).lte(10).optional()}); export const secret = z.object({status: z.enum(["Plain", "AES-256-GCM", "Secretbox", "GCP", "AWS", "VaultTransit", "AzureKeyVault", "Redacted"]).optional(), payload: z.string().optional(), key: z.string().optional(), additional_data: z.string().optional(), mode: z.number().int().optional()}); export const s3Config = z.object({bucket: z.string().min(1).optional(), region: z.string().min(1).optional(), access_key: z.string().optional(), access_secret: secret.optional(), role_arn: z.string().optional(), session_token: z.string().optional(), endpoint: z.string().optional(), storage_class: z.string().optional(), acl: z.string().optional(), upload_part_size: z.number().int().optional(), upload_concurrency: z.number().int().optional(), upload_part_max_time: z.number().int().optional(), download_part_size: z.number().int().optional(), download_concurrency: z.number().int().optional(), download_part_max_time: z.number().int().optional(), force_path_style: z.boolean().optional(), key_prefix: z.string().optional()}); export const gCSConfig = z.object({bucket: z.string().min(1).optional(), credentials: secret.optional(), automatic_credentials: z.union([z.literal(0), z.literal(1)]).optional(), storage_class: z.string().optional(), acl: z.string().optional(), key_prefix: z.string().optional(), upload_part_size: z.number().int().optional(), upload_part_max_time: z.number().int().optional()}); export const azureBlobFsConfig = z.object({container: z.string().optional(), account_name: z.string().optional(), account_key: secret.optional(), sas_url: secret.optional(), endpoint: z.string().optional(), upload_part_size: z.number().int().optional(), upload_concurrency: z.number().int().optional(), download_part_size: z.number().int().optional(), download_concurrency: z.number().int().optional(), access_tier: z.enum(["", "Archive", "Hot", "Cool"]).optional(), key_prefix: z.string().optional(), use_emulator: z.boolean().optional()}); export const cryptFsConfig = z.object({passphrase: secret.optional(), read_buffer_size: z.number().int().gte(0).lte(10).optional(), write_buffer_size: z.number().int().gte(0).lte(10).optional()}); export const sFTPFsConfig = z.object({endpoint: z.string().optional(), username: z.string().optional(), password: secret.optional(), private_key: secret.optional(), key_passphrase: secret.optional(), fingerprints: z.array(z.string()).optional(), prefix: z.string().optional(), disable_concurrent_reads: z.boolean().optional(), buffer_size: z.number().int().gte(0).lte(16).optional(), equality_check_mode: z.union([z.literal(0), z.literal(1)]).optional()}); export const hTTPFsConfig = z.object({endpoint: z.string().optional(), username: z.string().optional(), password: secret.optional(), api_key: secret.optional(), skip_tls_verify: z.boolean().optional(), equality_check_mode: z.union([z.literal(0), z.literal(1)]).optional()}); export const filesystemConfig = z.object({provider: fsProviders.optional(), osconfig: oSFsConfig.optional(), s3config: s3Config.optional(), gcsconfig: gCSConfig.optional(), azblobconfig: azureBlobFsConfig.optional(), cryptconfig: cryptFsConfig.optional(), sftpconfig: sFTPFsConfig.optional(), httpconfig: hTTPFsConfig.optional()}); export const groupUserSettings = z.object({home_dir: z.string().optional(), max_sessions: z.number().int().optional(), quota_size: z.number().int().optional(), quota_files: z.number().int().optional(), permissions: z.record(z.string(), z.array(permission)).optional(), upload_bandwidth: z.number().int().optional(), download_bandwidth: z.number().int().optional(), upload_data_transfer: z.number().int().optional(), download_data_transfer: z.number().int().optional(), total_data_transfer: z.number().int().optional(), expires_in: z.number().int().optional(), filters: baseUserFilters.optional(), filesystem: filesystemConfig.optional()}); export const virtualFolder = z.object({id: z.number().int().gte(1).optional(), name: z.string().optional(), mapped_path: z.string().optional(), description: z.string().optional(), used_quota_size: z.number().int().optional(), used_quota_files: z.number().int().optional(), last_quota_update: z.number().int().optional(), users: z.array(z.string()).optional(), filesystem: filesystemConfig.optional(), virtual_path: z.string(), quota_size: z.number().int().optional(), quota_files: z.number().int().optional()}); export const group = z.object({id: z.number().int().gte(1).optional(), name: z.string().optional(), description: z.string().optional(), created_at: z.number().int().optional(), updated_at: z.number().int().optional(), user_settings: groupUserSettings.optional(), virtual_folders: z.array(virtualFolder).optional(), users: z.array(z.string()).optional(), admins: z.array(z.string()).optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Find groups by name * * GET /groups/{name} * * Also accepts auth: APIKeyAuth */ export const getApiGroupsName = async (args: GetApiGroupsNameArgs, options: GetApiGroupsNameOptions) => { const {baseUrl, fetch: fetchFn = fetch, BearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.confidential_data != null) query.append("confidential_data", String(args.confidential_data)) if (BearerAuth !== undefined) headers.set('authorization', `Bearer ${BearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/groups/${encodeURIComponent(String(args.name))}${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(group, await res.json()) };