Add pl-api to workspace
Signed-off-by: marcin mikołajczak <git@mkljczk.pl>
This commit is contained in:
marcin mikołajczak
200
packages/pl-api/lib/params/admin.ts
Normal file
200
packages/pl-api/lib/params/admin.ts
Normal file
@ -0,0 +1,200 @@
|
||||
import type { PaginationParams } from './common';
|
||||
|
||||
interface AdminGetAccountsParams extends PaginationParams {
|
||||
/** String. Filter for `local` or `remote` accounts. */
|
||||
origin?: 'local' | 'remote';
|
||||
/** String. Filter for `active`, `pending`, `disabled`, `silenced`, or suspended accounts. */
|
||||
status?: 'active' | 'pending' | 'disabled' | 'silenced' | 'suspended';
|
||||
/** String. Filter for accounts with `staff` permissions (users that can manage reports). */
|
||||
permissions?: 'staff';
|
||||
/** Array of String. Filter for users with these roles. */
|
||||
role_ids?: string[];
|
||||
/** String. Lookup users invited by the account with this ID. */
|
||||
invited_by?: string;
|
||||
/** String. Search for the given username. */
|
||||
username?: string;
|
||||
/** String. Search for the given display name */
|
||||
display_name?: string;
|
||||
/** String. Filter by the given domain */
|
||||
by_domain?: string;
|
||||
/** String. Lookup a user with this email */
|
||||
email?: string;
|
||||
/** String. Lookup users with this IP address */
|
||||
ip?: string;
|
||||
}
|
||||
|
||||
type AdminAccountAction = 'none' | 'sensitive' | 'disable' | 'silence' | 'suspend';
|
||||
|
||||
interface AdminPerformAccountActionParams {
|
||||
/** String. The ID of an associated report that caused this action to be taken. */
|
||||
report_id?: string;
|
||||
/** String. The ID of a preset warning. */
|
||||
warning_preset_id?: string;
|
||||
/** String. Additional clarification for why this action was taken. */
|
||||
text?: string;
|
||||
/** Boolean. Should an email be sent to the user with the above information? */
|
||||
send_email_notification?: boolean;
|
||||
}
|
||||
|
||||
type AdminGetDomainBlocksParams = PaginationParams;
|
||||
|
||||
interface AdminCreateDomainBlockParams {
|
||||
/** String. Whether to apply a `silence`, `suspend`, or `noop` to the domain. Defaults to `silence` */
|
||||
severity?: 'silence' | 'suspend' | 'noop';
|
||||
/** Boolean. Whether media attachments should be rejected. Defaults to false */
|
||||
reject_media?: boolean;
|
||||
/** Boolean. Whether reports from this domain should be rejected. Defaults to false */
|
||||
reject_reports?: boolean;
|
||||
/** String. A private note about this domain block, visible only to admins. */
|
||||
private_comment?: string;
|
||||
/** String. A public note about this domain block, optionally shown on the about page. */
|
||||
public_comment?: string;
|
||||
/** Boolean. Whether to partially censor the domain when shown in public. Defaults to false */
|
||||
obfuscate?: boolean;
|
||||
}
|
||||
|
||||
type AdminUpdateDomainBlockParams = AdminCreateDomainBlockParams;
|
||||
|
||||
interface AdminGetReportsParams extends PaginationParams {
|
||||
/** Boolean. Filter for resolved reports? */
|
||||
resolved?: boolean;
|
||||
/** String. Filter for reports filed by this account. */
|
||||
account_id?: string;
|
||||
/** String. Filter for reports targeting this account. */
|
||||
target_account_id?: string;
|
||||
}
|
||||
|
||||
interface AdminUpdateReportParams {
|
||||
/** String. Change the classification of the report to `spam`, `violation`, or `other`. */
|
||||
category?: 'spam' | 'violation' | 'other';
|
||||
/** Array of Integer. For `violation` category reports, specify the ID of the exact rules broken. Rules and their IDs are available via [GET /api/v1/instance/rules](https://docs.joinmastodon.org/methods/instance/#rules) and [GET /api/v1/instance](https://docs.joinmastodon.org/methods/instance/#get). */
|
||||
rule_ids?: string[];
|
||||
}
|
||||
|
||||
interface AdminGetStatusesParams {
|
||||
limit?: number;
|
||||
local_only?: boolean;
|
||||
with_reblogs?: boolean;
|
||||
with_private?: boolean;
|
||||
}
|
||||
|
||||
interface AdminUpdateStatusParams {
|
||||
sensitive?: boolean;
|
||||
visibility?: 'public' | 'private' | 'unlisted';
|
||||
}
|
||||
|
||||
type AdminGetCanonicalEmailBlocks = PaginationParams;
|
||||
|
||||
type AdminDimensionKey = 'languages' | 'sources' | 'servers' | 'space_usage' | 'software_versions' | 'tag_servers' | 'tag_languages' | 'instance_accounts' | 'instance_languages';
|
||||
|
||||
interface AdminGetDimensionsParams {
|
||||
/** String (ISO 8601 Datetime). The start date for the time period. If a time is provided, it will be ignored. */
|
||||
start_at?: string;
|
||||
/** String (ISO 8601 Datetime). The end date for the time period. If a time is provided, it will be ignored. */
|
||||
end_at?: string;
|
||||
/** Integer. The maximum number of results to return for sources, servers, languages, tag or instance dimensions. */
|
||||
limit?: number;
|
||||
tag_servers?: {
|
||||
/** String. When tag_servers is one of the requested keys, you must provide a trending tag ID to obtain information about which servers are posting the tag. */
|
||||
id?: string;
|
||||
};
|
||||
tag_languages?: {
|
||||
/** String. When tag_languages is one of the requested keys, you must provide a trending tag ID to obtain information about which languages are posting the tag. */
|
||||
id?: string;
|
||||
};
|
||||
instance_accounts?: {
|
||||
/** String. When instance_accounts is one of the requested keys, you must provide a domain to obtain information about popular accounts from that server. */
|
||||
domain?: string;
|
||||
};
|
||||
instance_languages?: {
|
||||
/** String. When instance_accounts is one of the requested keys, you must provide a domain to obtain information about popular languages from that server. */
|
||||
domain?: string;
|
||||
};
|
||||
}
|
||||
|
||||
type AdminGetDomainAllowsParams = PaginationParams;
|
||||
|
||||
type AdminGetEmailDomainBlocksParams = PaginationParams;
|
||||
|
||||
type AdminGetIpBlocksParams = PaginationParams;
|
||||
|
||||
interface AdminCreateIpBlockParams {
|
||||
/** String. The IP address and prefix to block. Defaults to 0.0.0.0/32 */
|
||||
ip?: string;
|
||||
/** String. The policy to apply to this IP range: sign_up_requires_approval, sign_up_block, or no_access */
|
||||
severity: string;
|
||||
/** String. The reason for this IP block. */
|
||||
comment?: string;
|
||||
/** Integer. The number of seconds in which this IP block will expire. */
|
||||
expires_in?: number;
|
||||
}
|
||||
|
||||
type AdminUpdateIpBlockParams = Partial<AdminCreateIpBlockParams>;
|
||||
|
||||
type AdminMeasureKey = 'active_users' | 'new_users' | 'interactions' | 'opened_reports' | 'resolved_reports' | 'tag_accounts' | 'tag_uses' | 'tag_servers' | 'instance_accounts' | 'instance_media_attachments' | 'instance_reports' | 'instance_statuses' | 'instance_follows' | 'instance_followers';
|
||||
|
||||
interface AdminGetMeasuresParams {
|
||||
tag_accounts?: {
|
||||
/** String. When `tag_accounts` is one of the requested keys, you must provide a tag ID to obtain the measure of how many accounts used that hashtag in at least one status within the given time period. */
|
||||
id?: string;
|
||||
};
|
||||
tag_uses?: {
|
||||
/** String. When `tag_uses` is one of the requested keys, you must provide a tag ID to obtain the measure of how many statuses used that hashtag within the given time period. */
|
||||
id?: string;
|
||||
};
|
||||
tag_servers?: {
|
||||
/** String. When `tag_servers` is one of the requested keys, you must provide a tag ID to obtain the measure of how many servers used that hashtag in at least one status within the given time period. */
|
||||
id?: string;
|
||||
};
|
||||
instance_accounts?: {
|
||||
/** String. When `instance_accounts` is one of the requested keys, you must provide a remote domain to obtain the measure of how many accounts have been discovered from that server within the given time period. */
|
||||
domain?: string;
|
||||
};
|
||||
instance_media_attachments?: {
|
||||
/** String. When `instance_media_attachments` is one of the requested keys, you must provide a remote domain to obtain the measure of how much space is used by media attachments from that server within the given time period. */
|
||||
domain?: string;
|
||||
};
|
||||
instance_reports?: {
|
||||
/** String. When `instance_reports` is one of the requested keys, you must provide a remote domain to obtain the measure of how many reports have been filed against accounts from that server within the given time period. */
|
||||
domain?: string;
|
||||
};
|
||||
instance_statuses?: {
|
||||
/** String. When `instance_statuses` is one of the requested keys, you must provide a remote domain to obtain the measure of how many statuses originate from that server within the given time period. */
|
||||
domain?: string;
|
||||
};
|
||||
instance_follows?: {
|
||||
/** String. When `instance_follows` is one of the requested keys, you must provide a remote domain to obtain the measure of how many follows were performed on accounts from that server by local accounts within the given time period. */
|
||||
domain?: string;
|
||||
};
|
||||
instance_followers?: {
|
||||
/** String. When `instance_followers` is one of the requested keys, you must provide a remote domain to obtain the measure of how many follows were performed by accounts from that server on local accounts within the given time period. */
|
||||
domain?: string;
|
||||
};
|
||||
}
|
||||
|
||||
interface AdminGetGroupsParams {
|
||||
}
|
||||
|
||||
export type {
|
||||
AdminGetAccountsParams,
|
||||
AdminAccountAction,
|
||||
AdminPerformAccountActionParams,
|
||||
AdminGetDomainBlocksParams,
|
||||
AdminCreateDomainBlockParams,
|
||||
AdminUpdateDomainBlockParams,
|
||||
AdminGetReportsParams,
|
||||
AdminUpdateReportParams,
|
||||
AdminGetStatusesParams,
|
||||
AdminUpdateStatusParams,
|
||||
AdminGetCanonicalEmailBlocks,
|
||||
AdminDimensionKey,
|
||||
AdminGetDimensionsParams,
|
||||
AdminGetDomainAllowsParams,
|
||||
AdminGetEmailDomainBlocksParams,
|
||||
AdminGetIpBlocksParams,
|
||||
AdminCreateIpBlockParams,
|
||||
AdminUpdateIpBlockParams,
|
||||
AdminMeasureKey,
|
||||
AdminGetMeasuresParams,
|
||||
AdminGetGroupsParams,
|
||||
};
|
||||
Reference in New Issue
Block a user