/**
* Generated by orval v7.2.0 🍺
* Do not edit manually.
* storyden
* Storyden social API for building community driven platforms.
The Storyden API does not adhere to semantic versioning but instead applies a rolling strategy with deprecations and minimal breaking changes. This has been done mainly for a simpler development process and it may be changed to a more fixed versioning strategy in the future. Ultimately, the primary way Storyden tracks versions is dates, there are no set release tags currently.
* OpenAPI spec version: v1.26.2-canary
*/
import useSwr from "swr";
import type { Arguments, Key, SWRConfiguration } from "swr";
import useSWRMutation from "swr/mutation";
import type { SWRMutationConfiguration } from "swr/mutation";
import { fetcher } from "../client";
import type {
AccountGetOKResponse,
AdminAccessKeyListOKResponse,
AdminSettingsGetOKResponse,
AdminSettingsUpdateBody,
AdminSettingsUpdateOKResponse,
AuditEventCreatedOKResponse,
AuditEventGetOKResponse,
AuditEventListOKResponse,
AuditEventListParams,
BadRequestResponse,
ForbiddenResponse,
InternalServerErrorResponse,
ModerationActionCreateBody,
NoContentResponse,
NotFoundResponse,
UnauthorisedResponse,
} from "../openapi-schema";
/**
* Retrieve all configuration settings for installation. This includes the
publicly accessible information for the instance as well as admin-only
access to sensitive configuration (environment variables) and settings.
*/
export const adminSettingsGet = () => {
return fetcher<AdminSettingsGetOKResponse>({ url: `/admin`, method: "GET" });
};
export const getAdminSettingsGetKey = () => [`/admin`] as const;
export type AdminSettingsGetQueryResult = NonNullable<
Awaited<ReturnType<typeof adminSettingsGet>>
>;
export type AdminSettingsGetQueryError =
| UnauthorisedResponse
| InternalServerErrorResponse;
export const useAdminSettingsGet = <
TError = UnauthorisedResponse | InternalServerErrorResponse,
>(options?: {
swr?: SWRConfiguration<
Awaited<ReturnType<typeof adminSettingsGet>>,
TError
> & { swrKey?: Key; enabled?: boolean };
}) => {
const { swr: swrOptions } = options ?? {};
const isEnabled = swrOptions?.enabled !== false;
const swrKey =
swrOptions?.swrKey ?? (() => (isEnabled ? getAdminSettingsGetKey() : null));
const swrFn = () => adminSettingsGet();
const query = useSwr<Awaited<ReturnType<typeof swrFn>>, TError>(
swrKey,
swrFn,
swrOptions,
);
return {
swrKey,
...query,
};
};
/**
* Update non-env configuration settings for installation.
*/
export const adminSettingsUpdate = (
adminSettingsUpdateBody: AdminSettingsUpdateBody,
) => {
return fetcher<AdminSettingsUpdateOKResponse>({
url: `/admin`,
method: "PATCH",
headers: { "Content-Type": "application/json" },
data: adminSettingsUpdateBody,
});
};
export const getAdminSettingsUpdateMutationFetcher = () => {
return (
_: Key,
{ arg }: { arg: AdminSettingsUpdateBody },
): Promise<AdminSettingsUpdateOKResponse> => {
return adminSettingsUpdate(arg);
};
};
export const getAdminSettingsUpdateMutationKey = () => [`/admin`] as const;
export type AdminSettingsUpdateMutationResult = NonNullable<
Awaited<ReturnType<typeof adminSettingsUpdate>>
>;
export type AdminSettingsUpdateMutationError =
| BadRequestResponse
| UnauthorisedResponse
| InternalServerErrorResponse;
export const useAdminSettingsUpdate = <
TError =
| BadRequestResponse
| UnauthorisedResponse
| InternalServerErrorResponse,
>(options?: {
swr?: SWRMutationConfiguration<
Awaited<ReturnType<typeof adminSettingsUpdate>>,
TError,
Key,
AdminSettingsUpdateBody,
Awaited<ReturnType<typeof adminSettingsUpdate>>
> & { swrKey?: string };
}) => {
const { swr: swrOptions } = options ?? {};
const swrKey = swrOptions?.swrKey ?? getAdminSettingsUpdateMutationKey();
const swrFn = getAdminSettingsUpdateMutationFetcher();
const query = useSWRMutation(swrKey, swrFn, swrOptions);
return {
swrKey,
...query,
};
};
/**
* List audit events for the installation. Audit events track important
actions taken by accounts with elevated permissions such as admin
accounts and moderators. It also provides error logs for system internal
components that could not be responded to the client directly such as
background job failures and configuration issues.
*/
export const auditEventList = (params?: AuditEventListParams) => {
return fetcher<AuditEventListOKResponse>({
url: `/admin/audit-events`,
method: "GET",
params,
});
};
export const getAuditEventListKey = (params?: AuditEventListParams) =>
[`/admin/audit-events`, ...(params ? [params] : [])] as const;
export type AuditEventListQueryResult = NonNullable<
Awaited<ReturnType<typeof auditEventList>>
>;
export type AuditEventListQueryError =
| BadRequestResponse
| UnauthorisedResponse
| InternalServerErrorResponse;
export const useAuditEventList = <
TError =
| BadRequestResponse
| UnauthorisedResponse
| InternalServerErrorResponse,
>(
params?: AuditEventListParams,
options?: {
swr?: SWRConfiguration<
Awaited<ReturnType<typeof auditEventList>>,
TError
> & { swrKey?: Key; enabled?: boolean };
},
) => {
const { swr: swrOptions } = options ?? {};
const isEnabled = swrOptions?.enabled !== false;
const swrKey =
swrOptions?.swrKey ??
(() => (isEnabled ? getAuditEventListKey(params) : null));
const swrFn = () => auditEventList(params);
const query = useSwr<Awaited<ReturnType<typeof swrFn>>, TError>(
swrKey,
swrFn,
swrOptions,
);
return {
swrKey,
...query,
};
};
/**
* Retrieve a specific audit event by ID.
*/
export const auditEventGet = (auditEventId: string) => {
return fetcher<AuditEventGetOKResponse>({
url: `/admin/audit-events/${auditEventId}`,
method: "GET",
});
};
export const getAuditEventGetKey = (auditEventId: string) =>
[`/admin/audit-events/${auditEventId}`] as const;
export type AuditEventGetQueryResult = NonNullable<
Awaited<ReturnType<typeof auditEventGet>>
>;
export type AuditEventGetQueryError =
| UnauthorisedResponse
| NotFoundResponse
| InternalServerErrorResponse;
export const useAuditEventGet = <
TError =
| UnauthorisedResponse
| NotFoundResponse
| InternalServerErrorResponse,
>(
auditEventId: string,
options?: {
swr?: SWRConfiguration<
Awaited<ReturnType<typeof auditEventGet>>,
TError
> & { swrKey?: Key; enabled?: boolean };
},
) => {
const { swr: swrOptions } = options ?? {};
const isEnabled = swrOptions?.enabled !== false && !!auditEventId;
const swrKey =
swrOptions?.swrKey ??
(() => (isEnabled ? getAuditEventGetKey(auditEventId) : null));
const swrFn = () => auditEventGet(auditEventId);
const query = useSwr<Awaited<ReturnType<typeof swrFn>>, TError>(
swrKey,
swrFn,
swrOptions,
);
return {
swrKey,
...query,
};
};
/**
* Create a new moderation action such as a ban or content purge.
*/
export const moderationActionCreate = (
moderationActionCreateBody: ModerationActionCreateBody,
) => {
return fetcher<AuditEventCreatedOKResponse>({
url: `/admin/actions`,
method: "POST",
headers: { "Content-Type": "application/json" },
data: moderationActionCreateBody,
});
};
export const getModerationActionCreateMutationFetcher = () => {
return (
_: Key,
{ arg }: { arg: ModerationActionCreateBody },
): Promise<AuditEventCreatedOKResponse> => {
return moderationActionCreate(arg);
};
};
export const getModerationActionCreateMutationKey = () =>
[`/admin/actions`] as const;
export type ModerationActionCreateMutationResult = NonNullable<
Awaited<ReturnType<typeof moderationActionCreate>>
>;
export type ModerationActionCreateMutationError =
| BadRequestResponse
| UnauthorisedResponse
| InternalServerErrorResponse;
export const useModerationActionCreate = <
TError =
| BadRequestResponse
| UnauthorisedResponse
| InternalServerErrorResponse,
>(options?: {
swr?: SWRMutationConfiguration<
Awaited<ReturnType<typeof moderationActionCreate>>,
TError,
Key,
ModerationActionCreateBody,
Awaited<ReturnType<typeof moderationActionCreate>>
> & { swrKey?: string };
}) => {
const { swr: swrOptions } = options ?? {};
const swrKey = swrOptions?.swrKey ?? getModerationActionCreateMutationKey();
const swrFn = getModerationActionCreateMutationFetcher();
const query = useSWRMutation(swrKey, swrFn, swrOptions);
return {
swrKey,
...query,
};
};
/**
* Suspend an account - soft delete. This disables the ability for the
account owner to log in and use the platform. It keeps the account on
record for linkage to content so UI doesn't break. It does not change
anything else about the account such as the avatar, name, etc.
*/
export const adminAccountBanCreate = (accountHandle: string) => {
return fetcher<AccountGetOKResponse>({
url: `/admin/bans/${accountHandle}`,
method: "POST",
});
};
export const getAdminAccountBanCreateMutationFetcher = (
accountHandle: string,
) => {
return (_: Key, __: { arg: Arguments }): Promise<AccountGetOKResponse> => {
return adminAccountBanCreate(accountHandle);
};
};
export const getAdminAccountBanCreateMutationKey = (accountHandle: string) =>
[`/admin/bans/${accountHandle}`] as const;
export type AdminAccountBanCreateMutationResult = NonNullable<
Awaited<ReturnType<typeof adminAccountBanCreate>>
>;
export type AdminAccountBanCreateMutationError =
| UnauthorisedResponse
| NotFoundResponse
| InternalServerErrorResponse;
export const useAdminAccountBanCreate = <
TError =
| UnauthorisedResponse
| NotFoundResponse
| InternalServerErrorResponse,
>(
accountHandle: string,
options?: {
swr?: SWRMutationConfiguration<
Awaited<ReturnType<typeof adminAccountBanCreate>>,
TError,
Key,
Arguments,
Awaited<ReturnType<typeof adminAccountBanCreate>>
> & { swrKey?: string };
},
) => {
const { swr: swrOptions } = options ?? {};
const swrKey =
swrOptions?.swrKey ?? getAdminAccountBanCreateMutationKey(accountHandle);
const swrFn = getAdminAccountBanCreateMutationFetcher(accountHandle);
const query = useSWRMutation(swrKey, swrFn, swrOptions);
return {
swrKey,
...query,
};
};
/**
* Given the account is suspended, remove the suspended state.
*/
export const adminAccountBanRemove = (accountHandle: string) => {
return fetcher<AccountGetOKResponse>({
url: `/admin/bans/${accountHandle}`,
method: "DELETE",
});
};
export const getAdminAccountBanRemoveMutationFetcher = (
accountHandle: string,
) => {
return (_: Key, __: { arg: Arguments }): Promise<AccountGetOKResponse> => {
return adminAccountBanRemove(accountHandle);
};
};
export const getAdminAccountBanRemoveMutationKey = (accountHandle: string) =>
[`/admin/bans/${accountHandle}`] as const;
export type AdminAccountBanRemoveMutationResult = NonNullable<
Awaited<ReturnType<typeof adminAccountBanRemove>>
>;
export type AdminAccountBanRemoveMutationError =
| UnauthorisedResponse
| NotFoundResponse
| InternalServerErrorResponse;
export const useAdminAccountBanRemove = <
TError =
| UnauthorisedResponse
| NotFoundResponse
| InternalServerErrorResponse,
>(
accountHandle: string,
options?: {
swr?: SWRMutationConfiguration<
Awaited<ReturnType<typeof adminAccountBanRemove>>,
TError,
Key,
Arguments,
Awaited<ReturnType<typeof adminAccountBanRemove>>
> & { swrKey?: string };
},
) => {
const { swr: swrOptions } = options ?? {};
const swrKey =
swrOptions?.swrKey ?? getAdminAccountBanRemoveMutationKey(accountHandle);
const swrFn = getAdminAccountBanRemoveMutationFetcher(accountHandle);
const query = useSWRMutation(swrKey, swrFn, swrOptions);
return {
swrKey,
...query,
};
};
/**
* List all access keys for the entire instance. This is only available to
admin accounts and is used to manage access keys from other accounts.
*/
export const adminAccessKeyList = () => {
return fetcher<AdminAccessKeyListOKResponse>({
url: `/admin/access-keys`,
method: "GET",
});
};
export const getAdminAccessKeyListKey = () => [`/admin/access-keys`] as const;
export type AdminAccessKeyListQueryResult = NonNullable<
Awaited<ReturnType<typeof adminAccessKeyList>>
>;
export type AdminAccessKeyListQueryError =
| BadRequestResponse
| ForbiddenResponse
| InternalServerErrorResponse;
export const useAdminAccessKeyList = <
TError = BadRequestResponse | ForbiddenResponse | InternalServerErrorResponse,
>(options?: {
swr?: SWRConfiguration<
Awaited<ReturnType<typeof adminAccessKeyList>>,
TError
> & { swrKey?: Key; enabled?: boolean };
}) => {
const { swr: swrOptions } = options ?? {};
const isEnabled = swrOptions?.enabled !== false;
const swrKey =
swrOptions?.swrKey ??
(() => (isEnabled ? getAdminAccessKeyListKey() : null));
const swrFn = () => adminAccessKeyList();
const query = useSwr<Awaited<ReturnType<typeof swrFn>>, TError>(
swrKey,
swrFn,
swrOptions,
);
return {
swrKey,
...query,
};
};
/**
* Revoke an access key. This will immediately invalidate the key and it
will no longer be usable for authentication.
*/
export const adminAccessKeyDelete = (accessKeyId: string) => {
return fetcher<NoContentResponse>({
url: `/admin/access-keys/${accessKeyId}`,
method: "DELETE",
});
};
export const getAdminAccessKeyDeleteMutationFetcher = (accessKeyId: string) => {
return (_: Key, __: { arg: Arguments }): Promise<NoContentResponse> => {
return adminAccessKeyDelete(accessKeyId);
};
};
export const getAdminAccessKeyDeleteMutationKey = (accessKeyId: string) =>
[`/admin/access-keys/${accessKeyId}`] as const;
export type AdminAccessKeyDeleteMutationResult = NonNullable<
Awaited<ReturnType<typeof adminAccessKeyDelete>>
>;
export type AdminAccessKeyDeleteMutationError =
| BadRequestResponse
| ForbiddenResponse
| InternalServerErrorResponse;
export const useAdminAccessKeyDelete = <
TError = BadRequestResponse | ForbiddenResponse | InternalServerErrorResponse,
>(
accessKeyId: string,
options?: {
swr?: SWRMutationConfiguration<
Awaited<ReturnType<typeof adminAccessKeyDelete>>,
TError,
Key,
Arguments,
Awaited<ReturnType<typeof adminAccessKeyDelete>>
> & { swrKey?: string };
},
) => {
const { swr: swrOptions } = options ?? {};
const swrKey =
swrOptions?.swrKey ?? getAdminAccessKeyDeleteMutationKey(accessKeyId);
const swrFn = getAdminAccessKeyDeleteMutationFetcher(accessKeyId);
const query = useSWRMutation(swrKey, swrFn, swrOptions);
return {
swrKey,
...query,
};
};
