mirror of
https://github.com/shlinkio/shlink-web-client.git
synced 2026-04-20 05:26:20 +00:00
Extract shlink-web-component outside of src folder
This commit is contained in:
62
shlink-web-component/api-contract/ShlinkApiClient.ts
Normal file
62
shlink-web-component/api-contract/ShlinkApiClient.ts
Normal file
@@ -0,0 +1,62 @@
|
||||
import type { ShortUrl, ShortUrlData } from '../short-urls/data';
|
||||
import type {
|
||||
ShlinkDomainRedirects,
|
||||
ShlinkDomainsResponse,
|
||||
ShlinkEditDomainRedirects,
|
||||
ShlinkHealth,
|
||||
ShlinkMercureInfo,
|
||||
ShlinkShortUrlData,
|
||||
ShlinkShortUrlsListParams,
|
||||
ShlinkShortUrlsResponse,
|
||||
ShlinkTags,
|
||||
ShlinkVisits,
|
||||
ShlinkVisitsOverview,
|
||||
ShlinkVisitsParams,
|
||||
} from './types';
|
||||
|
||||
export type ShlinkApiClient = {
|
||||
baseUrl: string;
|
||||
apiKey: string;
|
||||
|
||||
listShortUrls(params?: ShlinkShortUrlsListParams): Promise<ShlinkShortUrlsResponse>;
|
||||
|
||||
createShortUrl(options: ShortUrlData): Promise<ShortUrl>;
|
||||
|
||||
getShortUrlVisits(shortCode: string, query?: ShlinkVisitsParams): Promise<ShlinkVisits>;
|
||||
|
||||
getTagVisits(tag: string, query?: Omit<ShlinkVisitsParams, 'domain'>): Promise<ShlinkVisits>;
|
||||
|
||||
getDomainVisits(domain: string, query?: Omit<ShlinkVisitsParams, 'domain'>): Promise<ShlinkVisits>;
|
||||
|
||||
getOrphanVisits(query?: Omit<ShlinkVisitsParams, 'domain'>): Promise<ShlinkVisits>;
|
||||
|
||||
getNonOrphanVisits(query?: Omit<ShlinkVisitsParams, 'domain'>): Promise<ShlinkVisits>;
|
||||
|
||||
getVisitsOverview(): Promise<ShlinkVisitsOverview>;
|
||||
|
||||
getShortUrl(shortCode: string, domain?: string | null): Promise<ShortUrl>;
|
||||
|
||||
deleteShortUrl(shortCode: string, domain?: string | null): Promise<void>;
|
||||
|
||||
updateShortUrl(
|
||||
shortCode: string,
|
||||
domain: string | null | undefined,
|
||||
body: ShlinkShortUrlData,
|
||||
): Promise<ShortUrl>;
|
||||
|
||||
listTags(): Promise<ShlinkTags>;
|
||||
|
||||
tagsStats(): Promise<ShlinkTags>;
|
||||
|
||||
deleteTags(tags: string[]): Promise<{ tags: string[] }>;
|
||||
|
||||
editTag(oldName: string, newName: string): Promise<{ oldName: string; newName: string }>;
|
||||
|
||||
health(authority?: string): Promise<ShlinkHealth>;
|
||||
|
||||
mercureInfo(): Promise<ShlinkMercureInfo>;
|
||||
|
||||
listDomains(): Promise<ShlinkDomainsResponse>;
|
||||
|
||||
editDomainRedirects(domainRedirects: ShlinkEditDomainRedirects): Promise<ShlinkDomainRedirects>;
|
||||
};
|
||||
Reference in New Issue
Block a user