@closerplatform/spinner-openapi
Version:
swagger client for @closerplatform/spinner-openapi
2,838 lines • 450 kB
TypeScript
/**
* Spinner API
* No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
*
* OpenAPI spec version: 0.0.1
*
*
* NOTE: This file is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the file manually.
*/
/// <reference path="../custom.d.ts" />
import { Configuration } from "./configuration";
/**
*
* @export
*/
export declare const COLLECTION_FORMATS: {
csv: string;
ssv: string;
tsv: string;
pipes: string;
};
/**
*
* @export
* @interface FetchAPI
*/
export interface FetchAPI {
(url: string, init?: any): Promise<Response>;
}
/**
*
* @export
* @interface FetchArgs
*/
export interface FetchArgs {
url: string;
options: any;
}
/**
*
* @export
* @class BaseAPI
*/
export declare class BaseAPI {
protected basePath: string;
protected fetch: FetchAPI;
protected configuration: Configuration;
constructor(configuration?: Configuration, basePath?: string, fetch?: FetchAPI);
}
/**
*
* @export
* @class RequiredError
* @extends {Error}
*/
export declare class RequiredError extends Error {
field: string;
name: "RequiredError";
constructor(field: string, msg?: string);
}
/**
*
* @export
* @interface AcceptInvitationForm
*/
export interface AcceptInvitationForm {
/**
*
* @type {string}
* @memberof AcceptInvitationForm
*/
firstName: string;
/**
*
* @type {string}
* @memberof AcceptInvitationForm
*/
lastName: string;
/**
*
* @type {string}
* @memberof AcceptInvitationForm
*/
password: string;
}
/**
*
* @export
* @interface AddMark
*/
export interface AddMark {
/**
*
* @type {number}
* @memberof AddMark
*/
timestamp: number;
}
/**
*
* @export
* @interface AddWidgetForm
*/
export interface AddWidgetForm {
/**
*
* @type {string}
* @memberof AddWidgetForm
*/
roomId: string;
/**
*
* @type {string}
* @memberof AddWidgetForm
*/
widgetId: string;
/**
*
* @type {string}
* @memberof AddWidgetForm
*/
message?: string;
/**
*
* @type {boolean}
* @memberof AddWidgetForm
*/
blockInputUntilSubmitted?: boolean;
}
/**
*
* @export
* @interface AdminSetNames
*/
export interface AdminSetNames {
/**
*
* @type {string}
* @memberof AdminSetNames
*/
firstName?: string;
/**
*
* @type {string}
* @memberof AdminSetNames
*/
lastName?: string;
}
/**
*
* @export
* @interface AdviserAverageSpeedOfAnswerDto
*/
export interface AdviserAverageSpeedOfAnswerDto {
/**
*
* @type {number}
* @memberof AdviserAverageSpeedOfAnswerDto
*/
avgResponseTimeMillis?: number;
}
/**
*
* @export
* @interface AdviserBatchPatchForm
*/
export interface AdviserBatchPatchForm {
/**
*
* @type {string}
* @memberof AdviserBatchPatchForm
*/
id: string;
/**
*
* @type {string}
* @memberof AdviserBatchPatchForm
*/
roleId?: string;
/**
*
* @type {number}
* @memberof AdviserBatchPatchForm
*/
validFrom?: number;
/**
*
* @type {number}
* @memberof AdviserBatchPatchForm
*/
validTo?: number;
/**
*
* @type {Array<string>}
* @memberof AdviserBatchPatchForm
*/
tagIds?: Array<string>;
/**
*
* @type {Array<string>}
* @memberof AdviserBatchPatchForm
*/
tagGroupIds?: Array<string>;
/**
*
* @type {number}
* @memberof AdviserBatchPatchForm
*/
autoAssignedLimit?: number;
/**
*
* @type {number}
* @memberof AdviserBatchPatchForm
*/
rating?: number;
}
/**
*
* @export
* @interface AdviserCobrowseJwtResponse
*/
export interface AdviserCobrowseJwtResponse {
/**
*
* @type {string}
* @memberof AdviserCobrowseJwtResponse
*/
jwt: string;
}
/**
*
* @export
* @interface AdviserPatchForm
*/
export interface AdviserPatchForm {
/**
*
* @type {string}
* @memberof AdviserPatchForm
*/
roleId?: string;
/**
*
* @type {number}
* @memberof AdviserPatchForm
*/
validFrom?: number;
/**
*
* @type {number}
* @memberof AdviserPatchForm
*/
validTo?: number;
/**
*
* @type {Array<string>}
* @memberof AdviserPatchForm
*/
tagIds?: Array<string>;
/**
*
* @type {Array<string>}
* @memberof AdviserPatchForm
*/
tagGroupIds?: Array<string>;
/**
*
* @type {number}
* @memberof AdviserPatchForm
*/
autoAssignedLimit?: number;
/**
*
* @type {number}
* @memberof AdviserPatchForm
*/
rating?: number;
}
/**
*
* @export
* @interface AdviserToast
*/
export interface AdviserToast {
/**
*
* @type {string}
* @memberof AdviserToast
*/
status?: string;
}
/**
*
* @export
* @interface AgentAutoAssignedLimit
*/
export interface AgentAutoAssignedLimit {
/**
*
* @type {number}
* @memberof AgentAutoAssignedLimit
*/
limit: number;
}
/**
*
* @export
* @interface AgentCtx
*/
export interface AgentCtx {
/**
*
* @type {string}
* @memberof AgentCtx
*/
id: string;
/**
*
* @type {string}
* @memberof AgentCtx
*/
apiKey: string;
/**
*
* @type {string}
* @memberof AgentCtx
*/
orgId: string;
/**
*
* @type {string}
* @memberof AgentCtx
*/
orgRole: string;
/**
*
* @type {string}
* @memberof AgentCtx
*/
firstName: string;
/**
*
* @type {string}
* @memberof AgentCtx
*/
lastName: string;
/**
*
* @type {string}
* @memberof AgentCtx
*/
email: string;
/**
*
* @type {string}
* @memberof AgentCtx
*/
pendingEmail?: string;
/**
*
* @type {Phone}
* @memberof AgentCtx
*/
phone?: Phone;
/**
*
* @type {string}
* @memberof AgentCtx
*/
importedCalendar?: string;
/**
*
* @type {number}
* @memberof AgentCtx
*/
autoAssignedLimit?: number;
/**
*
* @type {string}
* @memberof AgentCtx
*/
avatarToken?: string;
/**
*
* @type {string}
* @memberof AgentCtx
*/
closerCustomerApiKey?: string;
/**
*
* @type {AvailableSubstatus}
* @memberof AgentCtx
*/
available?: AvailableSubstatus;
/**
*
* @type {UnreadySubstatus}
* @memberof AgentCtx
*/
unready?: UnreadySubstatus;
/**
*
* @type {string}
* @memberof AgentCtx
*/
unavailable?: string;
/**
*
* @type {Presence}
* @memberof AgentCtx
*/
presence: Presence;
/**
*
* @type {boolean}
* @memberof AgentCtx
*/
registeredForPush: boolean;
/**
*
* @type {Array<string>}
* @memberof AgentCtx
*/
groups: Array<string>;
/**
*
* @type {Array<string>}
* @memberof AgentCtx
*/
tags: Array<string>;
/**
*
* @type {Array<string>}
* @memberof AgentCtx
*/
tagGroups: Array<string>;
}
/**
*
* @export
* @interface AgentGroup
*/
export interface AgentGroup {
/**
*
* @type {string}
* @memberof AgentGroup
*/
id: string;
/**
*
* @type {string}
* @memberof AgentGroup
*/
orgId: string;
/**
*
* @type {string}
* @memberof AgentGroup
*/
name: string;
/**
*
* @type {Array<string>}
* @memberof AgentGroup
*/
tags: Array<string>;
/**
*
* @type {Array<string>}
* @memberof AgentGroup
*/
tagGroups: Array<string>;
/**
*
* @type {Array<string>}
* @memberof AgentGroup
*/
advisers: Array<string>;
}
/**
*
* @export
* @interface AgentGroupBatchPatchDto
*/
export interface AgentGroupBatchPatchDto {
/**
*
* @type {string}
* @memberof AgentGroupBatchPatchDto
*/
id: string;
/**
*
* @type {Array<string>}
* @memberof AgentGroupBatchPatchDto
*/
tags?: Array<string>;
/**
*
* @type {Array<string>}
* @memberof AgentGroupBatchPatchDto
*/
tagGroups?: Array<string>;
/**
*
* @type {Array<string>}
* @memberof AgentGroupBatchPatchDto
*/
advisers?: Array<string>;
/**
*
* @type {string}
* @memberof AgentGroupBatchPatchDto
*/
name?: string;
}
/**
*
* @export
* @interface AgentGroupPatchDto
*/
export interface AgentGroupPatchDto {
/**
*
* @type {Array<string>}
* @memberof AgentGroupPatchDto
*/
tags?: Array<string>;
/**
*
* @type {Array<string>}
* @memberof AgentGroupPatchDto
*/
tagGroups?: Array<string>;
/**
*
* @type {Array<string>}
* @memberof AgentGroupPatchDto
*/
advisers?: Array<string>;
/**
*
* @type {string}
* @memberof AgentGroupPatchDto
*/
name?: string;
}
/**
*
* @export
* @interface AgentPendingEmail
*/
export interface AgentPendingEmail {
/**
*
* @type {string}
* @memberof AgentPendingEmail
*/
pendingEmail: string;
}
/**
*
* @export
* @interface AgentPreferences
*/
export interface AgentPreferences {
/**
*
* @type {AgentPreferencesNotifications}
* @memberof AgentPreferences
*/
notifications: AgentPreferencesNotifications;
/**
*
* @type {InboxSorting}
* @memberof AgentPreferences
*/
inboxSorting?: InboxSorting;
}
/**
*
* @export
* @interface AgentPreferencesNotifications
*/
export interface AgentPreferencesNotifications {
/**
*
* @type {boolean}
* @memberof AgentPreferencesNotifications
*/
messageInAssignedConversation: boolean;
/**
*
* @type {boolean}
* @memberof AgentPreferencesNotifications
*/
messageInFollowedConversation: boolean;
/**
*
* @type {boolean}
* @memberof AgentPreferencesNotifications
*/
upcomingMeeting: boolean;
}
/**
*
* @export
* @interface AgentProfile
*/
export interface AgentProfile {
/**
*
* @type {string}
* @memberof AgentProfile
*/
id: string;
/**
*
* @type {string}
* @memberof AgentProfile
*/
orgRole: string;
/**
*
* @type {boolean}
* @memberof AgentProfile
*/
isActive: boolean;
/**
*
* @type {string}
* @memberof AgentProfile
*/
firstName: string;
/**
*
* @type {string}
* @memberof AgentProfile
*/
lastName: string;
/**
*
* @type {string}
* @memberof AgentProfile
*/
email?: string;
/**
*
* @type {string}
* @memberof AgentProfile
*/
pendingEmail?: string;
/**
*
* @type {number}
* @memberof AgentProfile
*/
validFrom?: number;
/**
*
* @type {number}
* @memberof AgentProfile
*/
validTo?: number;
/**
*
* @type {number}
* @memberof AgentProfile
*/
autoAssignedLimit?: number;
/**
*
* @type {string}
* @memberof AgentProfile
*/
avatarToken?: string;
/**
*
* @type {AvailableSubstatus}
* @memberof AgentProfile
*/
available?: AvailableSubstatus;
/**
*
* @type {UnreadySubstatus}
* @memberof AgentProfile
*/
unready?: UnreadySubstatus;
/**
*
* @type {string}
* @memberof AgentProfile
*/
unavailable?: string;
/**
*
* @type {Presence}
* @memberof AgentProfile
*/
presence: Presence;
/**
*
* @type {boolean}
* @memberof AgentProfile
*/
registeredForPush: boolean;
/**
*
* @type {boolean}
* @memberof AgentProfile
*/
isBot: boolean;
/**
*
* @type {UserRole}
* @memberof AgentProfile
*/
role: UserRole;
/**
*
* @type {Array<string>}
* @memberof AgentProfile
*/
groups: Array<string>;
/**
*
* @type {Array<string>}
* @memberof AgentProfile
*/
tags: Array<string>;
/**
*
* @type {Array<string>}
* @memberof AgentProfile
*/
tagGroups: Array<string>;
}
/**
*
* @export
* @interface AgentProfileForm
*/
export interface AgentProfileForm {
/**
*
* @type {string}
* @memberof AgentProfileForm
*/
firstName: string;
/**
*
* @type {string}
* @memberof AgentProfileForm
*/
lastName: string;
/**
*
* @type {RawPhone}
* @memberof AgentProfileForm
*/
phone?: RawPhone;
}
/**
*
* @export
* @interface Agents
*/
export interface Agents {
/**
*
* @type {Array<string>}
* @memberof Agents
*/
agentsIds: Array<string>;
}
/**
*
* @export
* @interface AgreementForm
*/
export interface AgreementForm {
/**
*
* @type {boolean}
* @memberof AgreementForm
*/
agree: boolean;
/**
*
* @type {string}
* @memberof AgreementForm
*/
orgId?: string;
}
/**
*
* @export
* @enum {string}
*/
export declare enum AppPermission {
AdminPermission = "admin_permission",
DisplayClosedConversations = "display_closed_conversations",
DisplayWaitingConversations = "display_waiting_conversations",
DisplayFollowedConversations = "display_followed_conversations",
DisplayInProgressConversations = "display_in_progress_conversations",
DisplayYoursConversations = "display_yours_conversations",
DisplayCalls = "display_calls",
DisplayCallRecordings = "display_call_recordings",
SettingsProactiveMessages = "settings_proactive_messages",
SettingsTags = "settings_tags",
SettingsAiSuggestions = "settings_ai_suggestions",
SettingsWebhooks = "settings_webhooks",
SettingsKnowledgeBases = "settings_knowledge_bases",
SettingsAdvisersConfiguration = "settings_advisers_configuration",
SettingsAgentGroupsConfiguration = "settings_agent_groups_configuration",
SettingsAdvisersAssignments = "settings_advisers_assignments",
SettingsAdvisersAutoAssignedLimit = "settings_advisers_auto_assigned_limit",
SettingsAdvisersAvatar = "settings_advisers_avatar",
SettingsActionForms = "settings_action_forms",
SettingsStatuses = "settings_statuses",
SettingsRoles = "settings_roles",
SettingsGeneral = "settings_general",
ReportsYours = "reports_yours",
ReportsGroups = "reports_groups",
ReportsOrg = "reports_org",
ReportsYoursEfficiency = "reports_yours_efficiency",
ReportsGroupsEfficiency = "reports_groups_efficiency",
ReportsConversationsServiceLevelTagGroups = "reports_conversations_service_level_tag_groups",
ReportsConversationsServiceLevelTags = "reports_conversations_service_level_tags",
ReportsConversationsBackLineTags = "reports_conversations_back_line_tags",
ReportsAdvisersAdviserGroups = "reports_advisers_adviser_groups",
ReportsAdvisersTagGroups = "reports_advisers_tag_groups",
ReportsOrgOther = "reports_org_other",
ReportsOrgEfficiency = "reports_org_efficiency",
LeadDeleteProfile = "lead_delete_profile",
LeadUpdateProfile = "lead_update_profile",
UpdatePersonalData = "update_personal_data",
RoomAssignSelf = "room_assign_self",
RoomAssignAgent = "room_assign_agent",
RoomAssignByTag = "room_assign_by_tag",
RoomAssignByTagGroup = "room_assign_by_tag_group",
RoomCloseNotOwn = "room_close_not_own",
AiIntentsClassify = "ai_intents_classify",
DisplayOwnTagGroupsConversations = "display_own_tag_groups_conversations",
DisplayHistoricallyAssignedConversations = "display_historically_assigned_conversations",
SettingsPasswordChange = "settings_password_change",
SettingsPersonal = "settings_personal",
MeetingsPageVisibility = "meetings_page_visibility",
HelpPageVisibility = "help_page_visibility"
}
/**
*
* @export
* @enum {string}
*/
export declare enum AppicationErrorReason {
WidgetNotAvailable = "widget_not_available",
WidgetNotAllowed = "widget_not_allowed",
WidgetPreviousUnsubmitted = "widget_previous_unsubmitted",
WidgetIntervalNotPassed = "widget_interval_not_passed",
WidgetInvalidTagGroups = "widget_invalid_tag_groups",
SubmissionAlreadySubmitted = "submission_already_submitted",
SubmissionInputsNotFilled = "submission_inputs_not_filled",
SubmissionTextLimitsExceeded = "submission_text_limits_exceeded",
SubmissionFormExpired = "submission_form_expired",
SubmissionIncorrectTagGroupId = "submission_incorrect_tag_group_id",
SubmissionIncorrectAutoAssignFormInputs = "submission_incorrect_auto_assign_form_inputs",
SubmissionNoContactInput = "submission_no_contact_input",
SubmissionNoAgreementInput = "submission_no_agreement_input",
SubmissionInvalidPhoneNumber = "submission_invalid_phone_number",
AgentEmailAlreadyUsed = "agent_email_already_used",
SessionExpired = "session_expired",
SessionInvalidCredentials = "session_invalid_credentials"
}
/**
*
* @export
* @interface ApplicationError
*/
export interface ApplicationError {
/**
*
* @type {AppicationErrorReason}
* @memberof ApplicationError
*/
error: AppicationErrorReason;
/**
*
* @type {string}
* @memberof ApplicationError
*/
message?: string;
}
/**
*
* @export
* @interface AuthCode
*/
export interface AuthCode {
/**
*
* @type {string}
* @memberof AuthCode
*/
authCode: string;
}
/**
*
* @export
* @interface AuthCtx
*/
export interface AuthCtx {
/**
*
* @type {string}
* @memberof AuthCtx
*/
id: string;
/**
*
* @type {string}
* @memberof AuthCtx
*/
apiKey: string;
/**
*
* @type {string}
* @memberof AuthCtx
*/
orgId: string;
/**
*
* @type {number}
* @memberof AuthCtx
*/
deletedAt?: number;
}
/**
*
* @export
* @interface AutoAssign
*/
export interface AutoAssign {
/**
*
* @type {string}
* @memberof AutoAssign
*/
tag?: string;
/**
*
* @type {string}
* @memberof AutoAssign
*/
tagGroupId?: string;
/**
*
* @type {string}
* @memberof AutoAssign
*/
tagGroup?: string;
/**
*
* @type {Array<string>}
* @memberof AutoAssign
*/
tags?: Array<string>;
}
/**
*
* @export
* @interface AutoAssignConfigContext
*/
export interface AutoAssignConfigContext {
/**
*
* @type {MessageWidgetConfigContextType}
* @memberof AutoAssignConfigContext
*/
type: MessageWidgetConfigContextType;
/**
*
* @type {Array<AutoAssignConfigTagGroup>}
* @memberof AutoAssignConfigContext
*/
tagGroups: Array<AutoAssignConfigTagGroup>;
}
/**
*
* @export
* @interface AutoAssignConfigTagGroup
*/
export interface AutoAssignConfigTagGroup {
/**
*
* @type {string}
* @memberof AutoAssignConfigTagGroup
*/
tagGroupId: string;
/**
*
* @type {string}
* @memberof AutoAssignConfigTagGroup
*/
displayName: string;
}
/**
*
* @export
* @enum {string}
*/
export declare enum AvailableSubstatus {
Only = "chat_only",
AndCall = "chat_and_call"
}
/**
*
* @export
* @interface BackOfficeField
*/
export interface BackOfficeField {
/**
*
* @type {string}
* @memberof BackOfficeField
*/
key: string;
/**
*
* @type {any}
* @memberof BackOfficeField
*/
value: any;
/**
*
* @type {string}
* @memberof BackOfficeField
*/
displayName?: string;
}
/**
* field to be updated. If value is not present, field with this key will be deleted
* @export
* @interface BackOfficeFieldPatch
*/
export interface BackOfficeFieldPatch {
/**
*
* @type {string}
* @memberof BackOfficeFieldPatch
*/
key: string;
/**
*
* @type {any}
* @memberof BackOfficeFieldPatch
*/
value?: any;
/**
*
* @type {string}
* @memberof BackOfficeFieldPatch
*/
displayName?: string;
}
/**
*
* @export
* @interface BillingPlan
*/
export interface BillingPlan {
/**
*
* @type {string}
* @memberof BillingPlan
*/
name: string;
/**
*
* @type {number}
* @memberof BillingPlan
*/
callLengthLimit?: number;
/**
*
* @type {number}
* @memberof BillingPlan
*/
callsPerPeriod?: number;
/**
*
* @type {number}
* @memberof BillingPlan
*/
limitPeriod?: number;
/**
*
* @type {number}
* @memberof BillingPlan
*/
messageHistoryLimit?: number;
/**
*
* @type {number}
* @memberof BillingPlan
*/
price: number;
/**
*
* @type {string}
* @memberof BillingPlan
*/
currency?: string;
/**
*
* @type {number}
* @memberof BillingPlan
*/
trialDuration?: number;
}
/**
*
* @export
* @interface BotDto
*/
export interface BotDto {
/**
*
* @type {string}
* @memberof BotDto
*/
userId: string;
/**
*
* @type {string}
* @memberof BotDto
*/
orgId: string;
/**
*
* @type {BotType}
* @memberof BotDto
*/
botType: BotType;
/**
*
* @type {string}
* @memberof BotDto
*/
externalId?: string;
/**
*
* @type {string}
* @memberof BotDto
*/
knowledgeBaseId?: string;
/**
*
* @type {number}
* @memberof BotDto
*/
knowledgeBaseUpdatedAt?: number;
}
/**
*
* @export
* @interface BotPersonalDataForm
*/
export interface BotPersonalDataForm {
/**
*
* @type {string}
* @memberof BotPersonalDataForm
*/
firstName: string;
/**
*
* @type {string}
* @memberof BotPersonalDataForm
*/
lastName: string;
}
/**
*
* @export
* @enum {string}
*/
export declare enum BotType {
LektaBotType = "LektaBotType",
Disabled = "Disabled"
}
/**
*
* @export
* @interface CalendarForm
*/
export interface CalendarForm {
/**
*
* @type {string}
* @memberof CalendarForm
*/
calendarId: string;
/**
*
* @type {string}
* @memberof CalendarForm
*/
calendarName: string;
}
/**
*
* @export
* @interface CalendarInfo
*/
export interface CalendarInfo {
/**
*
* @type {string}
* @memberof CalendarInfo
*/
id: string;
/**
*
* @type {string}
* @memberof CalendarInfo
*/
title: string;
}
/**
*
* @export
* @interface CalendarSlot
*/
export interface CalendarSlot {
/**
*
* @type {number}
* @memberof CalendarSlot
*/
start: number;
/**
*
* @type {number}
* @memberof CalendarSlot
*/
duration?: number;
/**
*
* @type {string}
* @memberof CalendarSlot
*/
title?: string;
}
/**
*
* @export
* @interface Call
*/
export interface Call {
/**
*
* @type {string}
* @memberof Call
*/
id: string;
/**
*
* @type {string}
* @memberof Call
*/
roomId: string;
/**
*
* @type {string}
* @memberof Call
*/
orgId: string;
/**
*
* @type {string}
* @memberof Call
*/
creator: string;
/**
*
* @type {boolean}
* @memberof Call
*/
recordingEnabled: boolean;
/**
*
* @type {number}
* @memberof Call
*/
created: number;
/**
*
* @type {number}
* @memberof Call
*/
answered?: number;
/**
*
* @type {number}
* @memberof Call
*/
ended?: number;
/**
*
* @type {string}
* @memberof Call
*/
invitee: string;
}
/**
*
* @export
* @interface CallPaging
*/
export interface CallPaging {
/**
* Page of calls
* @type {Array<Call>}
* @memberof CallPaging
*/
items: Array<Call>;
/**
* Timestamp to use as `afterCreated` for the next page
* @type {number}
* @memberof CallPaging
*/
nextTimestamp?: number;
/**
* ID to use as `afterId` for the next page
* @type {string}
* @memberof CallPaging
*/
nextId?: string;
}
/**
*
* @export
* @interface CallProposalConfigContext
*/
export interface CallProposalConfigContext {
/**
*
* @type {MessageWidgetConfigContextType}
* @memberof CallProposalConfigContext
*/
type: MessageWidgetConfigContextType;
}
/**
*
* @export
* @interface CancelMeeting
*/
export interface CancelMeeting {
/**
*
* @type {string}
* @memberof CancelMeeting
*/
id: string;
}
/**
*
* @export
* @interface ChangeBotTypeForm
*/
export interface ChangeBotTypeForm {
/**
*
* @type {BotType}
* @memberof ChangeBotTypeForm
*/
botType: BotType;
}
/**
*
* @export
* @interface CheckboxListInput
*/
export interface CheckboxListInput {
/**
*
* @type {number}
* @memberof CheckboxListInput
*/
index: number;
/**
*
* @type {string}
* @memberof CheckboxListInput
*/
name: string;
/**
*
* @type {string}
* @memberof CheckboxListInput
*/
displayName: string;
/**
*
* @type {Array<CheckboxOption>}
* @memberof CheckboxListInput
*/
options: Array<CheckboxOption>;
}
/**
*
* @export
* @interface CheckboxOption
*/
export interface CheckboxOption {
/**
*
* @type {string}
* @memberof CheckboxOption
*/
value: string;
/**
*
* @type {string}
* @memberof CheckboxOption
*/
displayName: string;
}
/**
*
* @export
* @interface CobrowsingEndForm
*/
export interface CobrowsingEndForm {
/**
*
* @type {number}
* @memberof CobrowsingEndForm
*/
duration: number;
/**
*
* @type {string}
* @memberof CobrowsingEndForm
*/
roomId: string;
}
/**
*
* @export
* @interface CobrowsingStartForm
*/
export interface CobrowsingStartForm {
/**
*
* @type {number}
* @memberof CobrowsingStartForm
*/
timestamp: number;
/**
*
* @type {string}
* @memberof CobrowsingStartForm
*/
roomId: string;
}
/**
*
* @export
* @interface CodeAuthorizationForm
*/
export interface CodeAuthorizationForm {
/**
*
* @type {string}
* @memberof CodeAuthorizationForm
*/
nonce: string;
/**
*
* @type {string}
* @memberof CodeAuthorizationForm
*/
code: string;
/**
*
* @type {string}
* @memberof CodeAuthorizationForm
*/
orgId: string;
/**
*
* @type {string}
* @memberof CodeAuthorizationForm
*/
redirectUri: string;
}
/**
*
* @export
* @interface Compatibility
*/
export interface Compatibility {
/**
*
* @type {boolean}
* @memberof Compatibility
*/
compatible: boolean;
}
/**
*
* @export
* @interface ContactEnquiryConfigContext
*/
export interface ContactEnquiryConfigContext {
/**
*
* @type {MessageWidgetConfigContextType}
* @memberof ContactEnquiryConfigContext
*/
type: MessageWidgetConfigContextType;
/**
*
* @type {ContactEnquiryConfigContextGdpr}
* @memberof ContactEnquiryConfigContext
*/
gdpr: ContactEnquiryConfigContextGdpr;
}
/**
*
* @export
* @interface ContactEnquiryConfigContextGdpr
*/
export interface ContactEnquiryConfigContextGdpr {
/**
*
* @type {boolean}
* @memberof ContactEnquiryConfigContextGdpr
*/
enabled: boolean;
/**
*
* @type {string}
* @memberof ContactEnquiryConfigContextGdpr
*/
text?: string;
}
/**
*
* @export
* @enum {string}
*/
export declare enum ConversationStatus {
Waiting = "waiting",
InProgress = "inProgress",
Solved = "solved",
Unsolved = "unsolved"
}
/**
*
* @export
* @interface ConversationStatusForm
*/
export interface ConversationStatusForm {
/**
*
* @type {ConversationStatus}
* @memberof ConversationStatusForm
*/
status: ConversationStatus;
/**
*
* @type {string}
* @memberof ConversationStatusForm
*/
agentId?: string;
}
/**
*
* @export
* @interface ConversationToken
*/
export interface ConversationToken {
/**
*
* @type {string}
* @memberof ConversationToken
*/
token: string;
}
/**
*
* @export
* @interface CreateAgentGroupForm
*/
export interface CreateAgentGroupForm {
/**
*
* @type {string}
* @memberof CreateAgentGroupForm
*/
name: string;
/**
*
* @type {Array<string>}
* @memberof CreateAgentGroupForm
*/
advisers?: Array<string>;
}
/**
*
* @export
* @interface CreateBotRequest
*/
export interface CreateBotRequest {
/**
*
* @type {BotType}
* @memberof CreateBotRequest
*/
botType: BotType;
/**
*
* @type {boolean}
* @memberof CreateBotRequest
*/
attachOrgContext: boolean;
}
/**
*
* @export
* @interface CreateCall
*/
export interface CreateCall {
/**
*
* @type {string}
* @memberof CreateCall
*/
invitee: string;
}
/**
*
* @export
* @interface CreateEventActionConfigForm
*/
export interface CreateEventActionConfigForm {
/**
*
* @type {EventActionEvent}
* @memberof CreateEventActionConfigForm
*/
event: EventActionEvent;
/**
*
* @type {boolean}
* @memberof CreateEventActionConfigForm
*/
enabled: boolean;
/**
*
* @type {string}
* @memberof CreateEventActionConfigForm
*/
response: string;
/**
*
* @type {string}
* @memberof CreateEventActionConfigForm
*/
locale: string;
/**
*
* @type {string}
* @memberof CreateEventActionConfigForm
*/
widgetId?: string;
/**
*
* @type {string}
* @memberof CreateEventActionConfigForm
*/
tagGroupId?: string;
/**
*
* @type {boolean}
* @memberof CreateEventActionConfigForm
*/
widgetBlockInput?: boolean;
}
/**
*
* @export
* @interface CreateProactiveMsgForm
*/
export interface CreateProactiveMsgForm {
/**
*
* @type {string}
* @memberof CreateProactiveMsgForm
*/
tagId: string;
/**
*
* @type {string}
* @memberof CreateProactiveMsgForm
*/
text: string;
/**
*
* @type {string}
* @memberof CreateProactiveMsgForm
*/
langTag: string;
}
/**
*
* @export
* @interface CreateRoleForm
*/
export interface CreateRoleForm {
/**
*
* @type {string}
* @memberof CreateRoleForm
*/
name: string;
}
/**
*
* @export
* @interface CreateTagForm
*/
export interface CreateTagForm {
/**
*
* @type {string}
* @memberof CreateTagForm
*/
tag: string;
/**
*
* @type {boolean}
* @memberof CreateTagForm
*/
enabled?: boolean;
/**
*
* @type {boolean}
* @memberof CreateTagForm
*/
required?: boolean;
/**
*
* @type {boolean}
* @memberof CreateTagForm
*/
priority?: boolean;
/**
*
* @type {boolean}
* @memberof CreateTagForm
*/
showInConversationDetails?: boolean;
/**
*
* @type {string}
* @memberof CreateTagForm
*/
description?: string;
}
/**
*
* @export
* @interface CreateTagGroupForm
*/
export interface CreateTagGroupForm {
/**
*
* @type {string}
* @memberof CreateTagGroupForm
*/
name: string;
/**
*
* @type {Array<string>}
* @memberof CreateTagGroupForm
*/
tagIds: Array<string>;
/**
*
* @type {boolean}
* @memberof CreateTagGroupForm
*/
attachmentsEnabled?: boolean;
/**
*
* @type {Array<WorkingHours>}
* @memberof CreateTagGroupForm
*/
activeHours?: Array<WorkingHours>;
/**
*
* @type {string}
* @memberof CreateTagGroupForm
*/
description?: string;
/**
*
* @type {number}
* @memberof CreateTagGroupForm
*/
autoSnoozeTimeoutSeconds?: number;
/**
*
* @type {number}
* @memberof CreateTagGroupForm
*/
autoCloseTimeoutSeconds?: number;
/**
*
* @type {boolean}
* @memberof CreateTagGroupForm
*/
callsEnabled?: boolean;
/**
*
* @type {boolean}
* @memberof CreateTagGroupForm
*/
screenSharingEnabled?: boolean;
/**
*
* @type {boolean}
* @memberof CreateTagGroupForm
*/
videoEnabled?: boolean;
/**
*
* @type {boolean}
* @memberof CreateTagGroupForm
*/
canLeadInitiateCall?: boolean;
}
/**
*
* @export
* @interface CreateTagMappingForm
*/
export interface CreateTagMappingForm {
/**
*
* @type {string}
* @memberof CreateTagMappingForm
*/
urlPattern: string;
/**
*
* @type {MatchingStrategy}
* @memberof CreateTagMappingForm
*/
matchingStrategy: MatchingStrategy;
/**
*
* @type {string}
* @memberof CreateTagMappingForm
*/
tagId: string;
}
/**
*
* @export
* @interface CustomMessage
*/
export interface CustomMessage {
/**
*
* @type {string}
* @memberof CustomMessage
*/
message: string;
/**
*
* @type {string}
* @memberof CustomMessage
*/
subtag: string;
/**
*
* @type {any}
* @memberof CustomMessage
*/
context?: any;
}
/**
*
* @export
* @interface CustomerAddress
*/
export interface CustomerAddress {
/**
*
* @type {string}
* @memberof CustomerAddress
*/
id: string;
/**
*
* @type {string}
* @memberof CustomerAddress
*/
userId?: string;
/**
*
* @type {string}
* @memberof CustomerAddress
*/
addressLine1: string;
/**
*
* @type {string}
* @memberof CustomerAddress
*/
addressLine2?: string;
/**
*
* @type {string}
* @memberof CustomerAddress
*/
postalCode: string;
/**
*
* @type {string}
* @memberof CustomerAddress
*/
city: string;
/**
*
* @type {string}
* @memberof CustomerAddress
*/
alias?: string;
}
/**
*
* @export
* @interface CustomerAddressForm
*/
export interface CustomerAddressForm {
/**
*
* @type {string}
* @memberof CustomerAddressForm
*/
addressLine1: string;
/**
*
* @type {string}
* @memberof CustomerAddressForm
*/
addressLine2?: string;
/**
*
* @type {string}
* @memberof CustomerAddressForm
*/
postalCode: string;
/**
*
* @type {string}
* @memberof CustomerAddressForm
*/
city: string;
/**
*
* @type {string}
* @memberof CustomerAddressForm
*/
alias?: string;
}
/**
*
* @export
* @interface CustomerCtx
*/
export interface CustomerCtx {
/**
*
* @type {string}
* @memberof CustomerCtx
*/
id: string;
/**
*
* @type {string}
* @memberof CustomerCtx
*/
apiKey: string;
/**
*
* @type {string}
* @memberof CustomerCtx
*/
firstName?: string;
/**
*
* @type {string}
* @memberof CustomerCtx
*/
lastName?: string;
/**
*
* @type {string}
* @memberof CustomerCtx
*/
languageLocale: string;
}
/**
*
* @export
* @interface CustomerLogin
*/
export interface CustomerLogin {
/**
*
* @type {string}
* @memberof CustomerLogin
*/
id: string;
/**
*
* @type {string}
* @memberof CustomerLogin
*/
userId?: string;
/**
*
* @type {string}
* @memberof CustomerLogin
*/
value: string;
/**
*
* @type {boolean}
* @memberof CustomerLogin
*/
confirmed: boolean;
}
/**
*
* @export
* @interface CustomerNames
*/
export interface CustomerNames {
/**
*
* @type {string}
* @memberof CustomerNames
*/
firstName?: string;
/**
*
* @type {string}
* @memberof CustomerNames
*/
lastName?: string;
}
/**
*
* @export
* @interface CustomerProfile
*/
export interface CustomerProfile {
/**
*
* @type {string}
* @memberof CustomerProfile
*/
userId: string;
/**
*
* @type {string}
* @memberof CustomerProfile
*/
firstName?: string;
/**
*
* @type {string}
* @memberof CustomerProfile
*/
lastName?: string;
/**
*
* @type {string}
* @memberof CustomerProfile
*/
languageLocale: string;
}
/**
*
* @export
* @interface DatasetEntryDto
*/
export interface DatasetEntryDto {
/**
*
* @type {string}
* @memberof DatasetEntryDto
*/
id: string;
/**
*
* @type {string}
* @memberof DatasetEntryDto
*/
text: string;
/**
*
* @type {Array<string>}
* @memberof DatasetEntryDto
*/
context: Array<string>;
/**
*
* @type {string}
* @memberof DatasetEntryDto
*/
intentId?: string;
/**
*
* @type {number}
* @memberof DatasetEntryDto
*/
updatedAt: number;
/**
*
* @type {number}
* @memberof DatasetEntryDto
*/
deletedAt?: number;
}
/**
*
* @export
* @interface DatasetEntryForm
*/
export interface DatasetEntryForm {
/**
*
* @type {string}
* @memberof DatasetEntryForm
*/
text: string;
/**
*
* @type {Array<string>}
* @memberof DatasetEntryForm
*/
context: Array<string>;
}
/**
*
* @export
* @interface DepsStatus
*/
export interface DepsStatus {
/**
*
* @type {string}
* @memberof DepsStatus
*/
name?: string;
/**
*
* @type {string}
* @memberof DepsStatus
*/
status?: string;
}
/**
*
* @export
* @interface EmailChangeConfirm
*/
export interface EmailChangeConfirm {
/**
*
* @type {string}
* @memberof EmailChangeConfirm
*/
token: string;
}
/**
*
* @export
* @interface EnabledFlag
*/
export interface EnabledFlag {
/**
*
* @type {boolean}
* @memberof EnabledFlag
*/
enabled: boolean;
}
/**
*
* @export
* @interface Error
*/
export interface Error {
/**
*
* @type {string}
* @memberof Error
*/
reason?: string;
}
/**
*
* @export
* @interface EventActionConfig
*/
export interface EventActionConfig {
/**
*
* @type {string}
* @memberof EventActionConfig
*/
id: string;
/**
*
* @type {string}
* @memberof EventActionConfig
*/
orgId: string;
/**
*
* @type {EventActionEvent}
* @memberof EventActionConfig
*/
event: EventActionEvent;
/**
*
* @type {boolean}
* @memberof EventActionConfig
*/
enabled: boolean;
/**
*
* @type {string}
* @memberof EventActionConfig
*/
response: string;
/**
*
* @type {string}
* @memberof EventActionConfig
*/
locale: string;
/**
*
* @type {string}
* @memberof EventActionConfig
*/
widgetId?: string;
/**
*
* @type {string}
* @memberof EventActionConfig
*/
tagGroupId?: string;
/**
*
* @type {boolean}
* @memberof EventActionConfig
*/
widgetBlockInput?: boolean;
}
/**
*
* @export
* @enum {string}
*/
export declare enum EventActionEvent {
ThreadOpenedOutsideWorkingHours = "thread_opened_outside_working_hours",
ClosedSolvedThreadAction = "closed_solved_thread_action",
ClosedUnsolvedThreadAction = "closed_unsolved_thread_action",
ThreadOpened = "thread_opened",
AssignedConversationAction = "assigned_conversation_action",
ThreadOpenedAgentsUnavailable = "thread_opened_agents_unavailable",
WidgetOpenedNoOpenThread = "widget_opened_no_open_thread"
}
/**
*
* @export
* @interface ExternalMessageForm
*/
export interface ExternalMessageForm {
/**
* Text that should be displayed in the message
* @type {string}
* @memberof ExternalMessageForm
*/
text: string;
/**
* Any metadata that should be sent along with the message
* @type {any}
* @memberof ExternalMessageForm
*/
context?: any;
}
/**
*
* @export
* @interface FileHandle
*/
export interface FileHandle {
/**
*
* @type {string}
* @memberof FileHandle
*/
fileToken: string;
/**
*
* @type {string}
* @memberof FileHandle
*/
fileId?: string;
}
/**
*
* @export
* @interface Follower
*/
export interface Follower {
/**
*
* @type {string}
* @memberof Follower
*/
userId: string;
}
/**
*
* @export
* @interface FreeOrgAdminForm
*/
export interface FreeOrgAdminForm {
/**
*
* @type {string}
* @memberof FreeOrgAdminForm
*/
password: string;
/**
*
* @type {string}
* @memberof FreeOrgAdminForm
*/
firstName: string;
/**
*
* @type {string}
* @memberof FreeOrgAdminForm
*/
lastName: string;
/**
*
* @type {string}
* @memberof FreeOrgAdminForm
*/
orgName: string;
/**
*
* @type {string}
* @memberof FreeOrgAdminForm
*/
baseUrl: string;
/**
*
* @type {Array<InviteeForm>}
* @memberof FreeOrgAdminForm
*/
invitees: Array<InviteeForm>;
/**
*
* @type {string}
* @memberof FreeOrgAdminForm
*/
ipAddress?: string;
}
/**
*
* @export
* @interface FreeSlotsInfo
*/
export interface FreeSlotsInfo {
/**
*
* @type {number}
* @memberof FreeSlotsInfo
*/
sum: number;
}
/**
*
* @export
* @interface GuestAssignee
*/
export interface GuestAssignee {
/**
*
* @type {LimitedAgentProfile}
* @memberof GuestAssignee
*/
assignee?: LimitedAgentProfile;
}
/**
*
* @export
* @interface GuestMeetingToken
*/
export interface GuestMeetingToken {
/**
*
* @type {string}
* @memberof GuestMeetingToken
*/
token: string;
}
/**
*
* @export
* @interface GuestProfile
*/
export interface GuestProfile {
/**
*
* @type {string}
* @memberof GuestProfile
*/
id: string;
/**
*
* @type {string}
* @memberof GuestProfile
*/
firstName?: string;
/**
*
* @type {string}
* @memberof GuestProfile
*/
lastName?: string;
/**
*
* @type {Phone}
* @memberof GuestProfile
*/
phone?: Phone;
/**
*
* @type {string}
* @memberof GuestProfile
*/
email?: string;
/**
*
* @type {string}
* @memberof GuestProfile
*/
roomId: string;
/**
*
* @type {string}
* @memberof GuestProfile
*/
randomName?: string;
/**
*
* @type {string}
* @memberof GuestProfile
*/
languageLocale?: string;
/**
*
* @type {string}
* @memberof GuestProfile
*/
zoneId?: string;
/**
*
* @type {string}
* @memberof GuestProfile
*/
location?: string;
/**
*
* @type {Array<string>}
* @memberof GuestProfile
*/
tags: Array<string>;
/**
*
* @type {number}
* @memberof GuestProfile
*/
deletedAt?: number;
/**
*
* @type {Array<BackOfficeField>}
* @memberof GuestProfile
*/
backOfficeData?: Array<BackOfficeField>;
/**
*
* @type {string}
* @memberof GuestProfile
*/
searchableField?: string;
/**
*
* @type {string}
* @memberof GuestProfile
*/
tagGroupId?: string;
/**
*
* @type {Array<string>}
* @memberof GuestProfile
*/
topics?: Array<string>;
/**
*
* @type {string}
* @memberof GuestProfile
*/
accessToken?: string;
}
/**
*
* @export
* @interface GuestProfileForm
*/
export interface GuestProfileForm {
/**
*
* @type {string}
* @memberof GuestProfileForm
*/
firstName?: string;
/**
*
* @type {string}
* @memberof GuestProfileForm
*/
lastName?: string;
/**
*
* @type {string}
* @memberof GuestProfileForm
*/
email?: string;
/**
*
* @type {RawPhone}
* @memberof GuestProfileForm
*/
phone?: RawPhone;
/**
*
* @type {string}
* @memberof GuestProfileForm
*/
languageLocale?: string;
/**
* format Europe/Warsaw
* @type {string}
* @memberof GuestProfileForm
*/
zoneId?: string;
/**
*
* @type {string}
* @memberof GuestProfileForm
*/
location?: string;
/**
*
* @type {Array<string>}
* @memberof GuestProfileForm
*/
tags?: Array<string>;
/**
*
* @type {Array<BackOfficeField>}
* @memberof GuestProfileForm
*/
backOfficeData?: Array<BackOfficeField>;
/**
*
* @type {Array<string>}
* @memberof GuestProfileForm
*/
topics?: Array<string>;
}
/**
*
* @export
* @interface GuestProfileFormPatch
*/
export interface GuestProfileFormPatch {
/**
*
* @type {string}
* @memberof GuestProfileFormPatch
*/
firstName?: string;
/**
*
* @type {string}
* @memberof GuestProfileFormPatch
*/
lastName?: string;
/**
*
* @type {string}
* @memberof GuestProfileFormPatch
*/
email?: string;
/**
*
* @type {RawPhone}
* @memberof GuestProfileFormPatch
*/
phone?: RawPhone;
/**
*
* @type {string}
* @memberof GuestProfileFormPatch
*/
languageLocale?: string;
/**
* format Europe/Warsaw
* @type {string}
* @memberof GuestProfileFormPatch
*/
zoneId?: string;
/**
*
* @type {string}
* @memberof GuestProfileFormPatch
*/
location?: string;
/**
*
* @type {Array<string>}
* @memberof GuestProfileFormPatch
*/
tags?: Array<string>;
/**
*
* @type {Array<BackOfficeFieldPatch>}
* @memberof GuestProfileFormPatch
*/
backOfficeData?: Array<BackOfficeFieldPatch>;
/**
*
* @type {Array<string>}
* @memberof GuestProfileFormPatch
*/
topics?: Array<string>;
/**
*
* @type {boolean}
* @memberof GuestProfileFormPatch
*/
widgetIsOpen?: boolean;
}
/**
*
* @export
* @interface InboxEntry
*/
export interface InboxEntry {
/**
*
* @type {string}
* @memberof InboxEntry
*/
room: string;
/**
*
* @type {string}
* @memberof InboxEntry
*/
owner: string;
/**
*
* @type {string}
* @memberof InboxEntry
*/
sender: string;
/**
*
* @type {InboxEntryProfile}
* @memberof InboxEntry
*/
profile: InboxEntryProfile;
/**
*
* @type {ConversationStatus}
* @memberof InboxEntry
*/
status: ConversationStatus;
/**
*
* @type {Array<string>}
* @memberof InboxEntry
*/
followers: Array<string>;
/**
*
* @type {string}
* @memberof InboxEntry
*/
assignee?: string;
/**
*
* @type {InboxEntryType}
* @memberof InboxEntry
*/
type: InboxEntryType;
/**
*
* @type {string}
* @memberof InboxEntry
*/
message?: string;
/**
*
* @type {number}
* @memberof InboxEntry
*/
timestamp: number;
/**
*
* @type {any}
* @memberof InboxEntry
*/
payload?: any;
/**
*
* @type {number}
* @memberof InboxEntry
*/
lastGuestTimestamp: number;
/**
*
* @type {number}
* @memberof InboxEntry
*/
lastAdviserTimestamp?: number;
/**
*
* @type {number}
* @memberof InboxEntry
*/
threadCreatedAt?: number;
/**
*
* @type {number}
* @memberof InboxEntry
*/
threadClosedAt?: number;
/**
*
* @type {number}
* @memberof InboxEntry
*/
mark: number;
/**
*
* @type {number}
* @memberof InboxEntry
*/
unreadCount: number;
/**
*
* @type {Presence}
* @memberof InboxEntry
*/
ownerPresence: Presence;
/**
*
* @type {Array<string>}
* @memberof InboxEntry
*/
tags: Array<string>;
/**
*
* @type {boolean}
* @memberof InboxEntry
*/
isSnoozed: boolean;
/**
*
* @type {SnoozedStatus}
* @memberof InboxEntry
*/
snoozedStatus?: SnoozedStatus;
/**
*
* @type {string}
* @memberof InboxEntry
*/
tagGroupId?: string;
}
/**
*
* @export
* @interface InboxEntryProfile
*/
export interface InboxEntryProfile {
/**
*
* @type {string}
* @memberof InboxEntryProfile
*/
firstName?: string;
/