@sprucelabs/mercury-client
Version:
The simple way to interact with the Spruce Experience Platform
32 lines (31 loc) • 3.29 kB
TypeScript
import { EventContract } from '@sprucelabs/mercury-types';
import { SpruceSchemas } from '@sprucelabs/mercury-types';
import AbstractSpruceTest from '@sprucelabs/test';
import { ConnectionOptions, MercuryClient } from '../types/client.types';
type Client = MercuryClient;
type Person = SpruceSchemas.Spruce.v2020_07_22.Person;
export default class AbstractClientTest extends AbstractSpruceTest {
private static dummySkillCount;
protected static clients: Client[];
protected static skillName: string;
protected static afterEach(): Promise<void>;
protected static beforeEach(): Promise<void>;
protected static beforeAll(): Promise<void>;
protected static afterAll(): Promise<void>;
protected static connectToApi(options?: Partial<ConnectionOptions>): Promise<Client>;
protected static loginAsDemoPerson(phone?: string | undefined): Promise<{
person: Person;
client: Client;
token: string;
}>;
protected static seedDummyOrg(client: Client): Promise<Pick<import("@sprucelabs/schema").SchemaStaticValues<SpruceSchemas.Spruce.v2020_07_22.OrganizationSchema, false, import("@sprucelabs/schema").SchemaOptionalFieldNames<SpruceSchemas.Spruce.v2020_07_22.OrganizationSchema>, import("@sprucelabs/schema").StaticSchemaAllValues<SpruceSchemas.Spruce.v2020_07_22.OrganizationSchema, false>>, "id" | "address" | "dateCreated" | "name" | "slug" | "dateDeleted" | "isPublic">>;
protected static seedInstallAndLoginAsSkill(client: Client, orgId: string): Promise<{
skill: Pick<import("@sprucelabs/schema").SchemaStaticValues<SpruceSchemas.Spruce.v2020_07_22.SkillSchema, false, import("@sprucelabs/schema").SchemaOptionalFieldNames<SpruceSchemas.Spruce.v2020_07_22.SkillSchema>, import("@sprucelabs/schema").StaticSchemaAllValues<SpruceSchemas.Spruce.v2020_07_22.SkillSchema, false>>, "id" | "dateCreated" | "apiKey" | "name" | "description" | "slug" | "isPublished" | "canBeInstalled" | "creators" | "dateDeleted">;
client: Client;
}>;
protected static seedAndInstallDummySkill(client: Client, orgId: string): Promise<Pick<import("@sprucelabs/schema").SchemaStaticValues<SpruceSchemas.Spruce.v2020_07_22.SkillSchema, false, import("@sprucelabs/schema").SchemaOptionalFieldNames<SpruceSchemas.Spruce.v2020_07_22.SkillSchema>, import("@sprucelabs/schema").StaticSchemaAllValues<SpruceSchemas.Spruce.v2020_07_22.SkillSchema, false>>, "id" | "dateCreated" | "apiKey" | "name" | "description" | "slug" | "isPublished" | "canBeInstalled" | "creators" | "dateDeleted">>;
protected static seedDemoSkill(client: Client): Promise<Pick<import("@sprucelabs/schema").SchemaStaticValues<SpruceSchemas.Spruce.v2020_07_22.SkillSchema, false, import("@sprucelabs/schema").SchemaOptionalFieldNames<SpruceSchemas.Spruce.v2020_07_22.SkillSchema>, import("@sprucelabs/schema").StaticSchemaAllValues<SpruceSchemas.Spruce.v2020_07_22.SkillSchema, false>>, "id" | "dateCreated" | "apiKey" | "name" | "description" | "slug" | "isPublished" | "canBeInstalled" | "creators" | "dateDeleted">>;
protected static registerEvent(namespace: string, client: MercuryClient): Promise<SpruceSchemas.Mercury.v2020_12_25.EventContract>;
protected static generateWillSendVipEventSignature(slug?: string): EventContract;
}
export {};