@apideck/portman
Version:
Port OpenAPI Spec to Postman Collection, with contract & variation tests included
25 lines (24 loc) • 1.26 kB
TypeScript
import { PostmanApiCollectionResult, PostmanApiService, PostmanApiWorkspaceDetailResult, PostmanApiWorkspaceResult } from 'services';
export type PostmanCache = {
collections: PostmanApiCollectionResult[];
workspaces: PostmanApiWorkspaceResult[];
workspace?: PostmanApiWorkspaceDetailResult;
collectionsLastUpdated: number;
workspacesLastUpdated: number;
};
export declare class PostmanRepo {
private cacheFile;
private postmanApi;
cache: PostmanCache;
constructor(cacheFile: string, postmanApi: PostmanApiService);
initCache(refreshCollectionCache?: boolean, refreshWorkspaceCache?: boolean): Promise<void>;
persistCache(): Promise<void>;
getWorkspaces(): Promise<PostmanApiWorkspaceResult[]>;
getWorkspace(id: string): Promise<PostmanApiWorkspaceDetailResult>;
getCollections(): Promise<PostmanApiCollectionResult[]>;
findCollectionByName(name: string): PostmanApiCollectionResult | undefined;
findCollectionByUid(uid: string): PostmanApiCollectionResult | undefined;
findWorkspaceCollectionByName(name: string): unknown | undefined;
findWorkspaceByName(name: string): PostmanApiWorkspaceResult | undefined;
findWorkspaceById(id: string): PostmanApiWorkspaceResult | undefined;
}