/** * Faraday REST API * The [Faraday](https://faraday.ai) API makes it easy to predict customer behavior programmatically. See our [API change policy](https://faraday.ai/legal). * * The version of the OpenAPI document: 1.0.0 * Contact: support@faraday.ai * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { KnowledgebaseOverview, KnowledgebaseOverviewPatch, KnowledgebaseOverviewRevisionSummary, UseCase, UseCasePatch, UseCasePost, UseCaseRevision, UseCaseRevisionSummary, UseCaseSummary } from '../models'; export interface ArchiveUseCaseRequest { useCaseId: string; } export interface CreateUseCaseRequest { useCaseFields: UseCasePost; } export interface GetKnowledgebaseOverviewRevisionRequest { revisionId: string; } export interface GetUseCaseRequest { useCaseId: string; } export interface GetUseCaseRevisionRequest { useCaseId: string; revisionId: string; } export interface ListUseCaseRevisionsRequest { useCaseId: string; } export interface ListUseCasesRequest { ids?: Array; } export interface UnarchiveUseCaseRequest { useCaseId: string; } export interface UpdateKnowledgebaseOverviewRequest { knowledgebaseOverviewFields: KnowledgebaseOverviewPatch; } export interface UpdateUseCaseRequest { useCaseId: string; useCaseFields: UseCasePatch; } /** * */ export declare class KnowledgebaseApi extends runtime.BaseAPI { /** * Archive a use case. Use cases have no downstream dependents so no cascade configuration is required. * Archive a use case */ archiveUseCaseRaw(requestParameters: ArchiveUseCaseRequest): Promise>; /** * Archive a use case. Use cases have no downstream dependents so no cascade configuration is required. * Archive a use case */ archiveUseCase(useCaseId: string): Promise; /** * Create a new use case under the calling account. * Create a use case */ createUseCaseRaw(requestParameters: CreateUseCaseRequest): Promise>; /** * Create a new use case under the calling account. * Create a use case */ createUseCase(useCaseFields: UseCasePost): Promise; /** * Get the current revision of this account\'s knowledgebase overview. If no overview has ever been written, `revision_id` and `created_at` are absent and `content` is the empty string. * Retrieve the account overview */ getKnowledgebaseOverviewRaw(): Promise>; /** * Get the current revision of this account\'s knowledgebase overview. If no overview has ever been written, `revision_id` and `created_at` are absent and `content` is the empty string. * Retrieve the account overview */ getKnowledgebaseOverview(): Promise; /** * Read an older saved revision of the account overview. The shape matches the current-revision endpoint. * Retrieve a specific account overview revision */ getKnowledgebaseOverviewRevisionRaw(requestParameters: GetKnowledgebaseOverviewRevisionRequest): Promise>; /** * Read an older saved revision of the account overview. The shape matches the current-revision endpoint. * Retrieve a specific account overview revision */ getKnowledgebaseOverviewRevision(revisionId: string): Promise; /** * Get the full current revision of a use case, including its computed `resources` list. * Retrieve a use case */ getUseCaseRaw(requestParameters: GetUseCaseRequest): Promise>; /** * Get the full current revision of a use case, including its computed `resources` list. * Retrieve a use case */ getUseCase(useCaseId: string): Promise; /** * Read an older saved revision of a use case. The shape matches the current-revision endpoint, except `resources` is omitted (resources are a live computed property, not part of the versioned content). * Retrieve a specific use case revision */ getUseCaseRevisionRaw(requestParameters: GetUseCaseRevisionRequest): Promise>; /** * Read an older saved revision of a use case. The shape matches the current-revision endpoint, except `resources` is omitted (resources are a live computed property, not part of the versioned content). * Retrieve a specific use case revision */ getUseCaseRevision(useCaseId: string, revisionId: string): Promise; /** * List every saved revision of the account overview, newest first. * List account overview revisions */ listKnowledgebaseOverviewRevisionsRaw(): Promise>>; /** * List every saved revision of the account overview, newest first. * List account overview revisions */ listKnowledgebaseOverviewRevisions(): Promise>; /** * List every saved revision of a use case, newest first. * List use case revisions */ listUseCaseRevisionsRaw(requestParameters: ListUseCaseRevisionsRequest): Promise>>; /** * List every saved revision of a use case, newest first. * List use case revisions */ listUseCaseRevisions(useCaseId: string): Promise>; /** * Get a list of use cases for the calling account. Returns summary fields only; fetch a specific use case to see its preface, guide, and resources. * List use cases */ listUseCasesRaw(requestParameters: ListUseCasesRequest): Promise>>; /** * Get a list of use cases for the calling account. Returns summary fields only; fetch a specific use case to see its preface, guide, and resources. * List use cases */ listUseCases(ids?: Array): Promise>; /** * Unarchive a use case. * Unarchive a use case */ unarchiveUseCaseRaw(requestParameters: UnarchiveUseCaseRequest): Promise>; /** * Unarchive a use case. * Unarchive a use case */ unarchiveUseCase(useCaseId: string): Promise; /** * Save a new revision of the account overview. Optimistic locking: pass back the `revision_id` you read; if the server\'s current revision has moved past it, the request is rejected with 409. Omit `revision_id` only when the overview has never been written before. * Update the account overview */ updateKnowledgebaseOverviewRaw(requestParameters: UpdateKnowledgebaseOverviewRequest): Promise>; /** * Save a new revision of the account overview. Optimistic locking: pass back the `revision_id` you read; if the server\'s current revision has moved past it, the request is rejected with 409. Omit `revision_id` only when the overview has never been written before. * Update the account overview */ updateKnowledgebaseOverview(knowledgebaseOverviewFields: KnowledgebaseOverviewPatch): Promise; /** * Save a new revision of a use case. Optimistic locking: pass back the `revision_id` you read; if the server\'s current revision has moved past it, the request is rejected with 409. Fields not present are left at their current values. * Update a use case */ updateUseCaseRaw(requestParameters: UpdateUseCaseRequest): Promise>; /** * Save a new revision of a use case. Optimistic locking: pass back the `revision_id` you read; if the server\'s current revision has moved past it, the request is rejected with 409. Fields not present are left at their current values. * Update a use case */ updateUseCase(useCaseId: string, useCaseFields: UseCasePatch): Promise; }