@uservitals/import
Version:
Import helpers for uploading feedback to UserVitals
110 lines • 2.28 kB
TypeScript
import { AxiosInstance } from "axios";
export interface Importer {
name: string;
defaultTeamName?: string;
import(): Promise<ImportResult>;
}
export interface APIClient {
client: AxiosInstance;
apiKey: string;
}
export interface ContactCreationInput {
name: string;
email: string;
}
export interface ImportResult {
messages: MessageCreationInput[];
insights: InsightCreationInput[];
stories: StoryCreationInput[];
changelogs: GenericChangelogInput[];
labels: {
[id: string]: {
name: string;
};
};
categories: {
[id: string]: {
name: string;
};
};
changelogLabels: {
[id: string]: {
name: string;
};
};
contacts: {
[id: string]: {
name: string;
email: string;
role: string;
};
};
}
export interface StoryCreationInput {
name: string;
desc: string;
privDesc: string;
status: string;
category: string;
labels: string[];
visibility: string;
contactId: string;
contactName: string;
contactEmail: string;
}
export interface Team {
name: string;
id: string;
storyLabel: [StoryLabel];
}
export interface StoryLabel {
name: string;
id: string;
}
export interface ImportAnswers {
userVitalsApiKey: string;
service: string;
path: string;
}
export interface Membership {
id: string;
user: User;
}
export interface User {
name: string;
email: string;
role: string;
}
export interface MessageCreationInput {
title: string;
content: string;
contactId: string;
contactName: string;
contactEmail: string;
creatorName: string;
creatorEmail: string;
creatorId: string;
status: string;
sourceUrl: string;
labels: string[];
}
export interface InsightCreationInput {
text: string;
type: string;
contactName: string;
contactEmail: string;
contactId: string;
source: string;
integration: string;
story: string;
}
export interface teamInfoInput {
apiKey: string;
}
export interface GenericChangelogInput {
title: string;
desc: string;
status: string;
labels: string[];
}
//# sourceMappingURL=types.d.ts.map