From d6a8ca55c417c75ff66eeb12146a2f572a99153d Mon Sep 17 00:00:00 2001 From: Esteban Beltran Date: Tue, 1 Feb 2022 12:34:58 +0100 Subject: [PATCH 01/73] [Cases] Show settting "sync alert" in user actions (#124116) --- .../components/case_view/translations.ts | 12 ++++ .../components/user_actions/builder.tsx | 2 + .../public/components/user_actions/common.tsx | 65 ++++++++++--------- .../components/user_actions/constants.ts | 2 +- .../components/user_actions/helpers.test.ts | 2 +- .../components/user_actions/settings.test.tsx | 51 +++++++++++++++ .../components/user_actions/settings.tsx | 43 ++++++++++++ 7 files changed, 143 insertions(+), 34 deletions(-) create mode 100644 x-pack/plugins/cases/public/components/user_actions/settings.test.tsx create mode 100644 x-pack/plugins/cases/public/components/user_actions/settings.tsx diff --git a/x-pack/plugins/cases/public/components/case_view/translations.ts b/x-pack/plugins/cases/public/components/case_view/translations.ts index 43fb1cedb13d6..7d6d81a22ca11 100644 --- a/x-pack/plugins/cases/public/components/case_view/translations.ts +++ b/x-pack/plugins/cases/public/components/case_view/translations.ts @@ -17,6 +17,14 @@ export const CHANGED_FIELD = i18n.translate('xpack.cases.caseView.actionLabel.ch defaultMessage: 'changed', }); +export const ENABLED_SETTING = i18n.translate('xpack.cases.caseView.actionLabel.enabledSetting', { + defaultMessage: 'enabled', +}); + +export const DISABLED_SETTING = i18n.translate('xpack.cases.caseView.actionLabel.disableSetting', { + defaultMessage: 'disabled', +}); + export const SELECTED_THIRD_PARTY = (thirdParty: string) => i18n.translate('xpack.cases.caseView.actionLabel.selectedThirdParty', { values: { @@ -119,6 +127,10 @@ export const SYNC_ALERTS = i18n.translate('xpack.cases.caseView.syncAlertsLabel' defaultMessage: `Sync alerts`, }); +export const SYNC_ALERTS_LC = i18n.translate('xpack.cases.caseView.syncAlertsLowercaseLabel', { + defaultMessage: `sync alerts`, +}); + export const DOES_NOT_EXIST_TITLE = i18n.translate('xpack.cases.caseView.doesNotExist.title', { defaultMessage: 'This case does not exist', }); diff --git a/x-pack/plugins/cases/public/components/user_actions/builder.tsx b/x-pack/plugins/cases/public/components/user_actions/builder.tsx index 92f1dd6c123da..5e1c11fbdd2df 100644 --- a/x-pack/plugins/cases/public/components/user_actions/builder.tsx +++ b/x-pack/plugins/cases/public/components/user_actions/builder.tsx @@ -9,6 +9,7 @@ import { createCommentUserActionBuilder } from './comment/comment'; import { createConnectorUserActionBuilder } from './connector'; import { createDescriptionUserActionBuilder } from './description'; import { createPushedUserActionBuilder } from './pushed'; +import { createSettingsUserActionBuilder } from './settings'; import { createStatusUserActionBuilder } from './status'; import { createTagsUserActionBuilder } from './tags'; import { createTitleUserActionBuilder } from './title'; @@ -22,4 +23,5 @@ export const builderMap: UserActionBuilderMap = { pushed: createPushedUserActionBuilder, comment: createCommentUserActionBuilder, description: createDescriptionUserActionBuilder, + settings: createSettingsUserActionBuilder, }; diff --git a/x-pack/plugins/cases/public/components/user_actions/common.tsx b/x-pack/plugins/cases/public/components/user_actions/common.tsx index 2709c89bde3ed..ba7ccabffb9c6 100644 --- a/x-pack/plugins/cases/public/components/user_actions/common.tsx +++ b/x-pack/plugins/cases/public/components/user_actions/common.tsx @@ -51,37 +51,38 @@ export const createCommonUpdateUserActionBuilder = ({ label, icon, handleOutlineComment, -}: BuilderArgs): ReturnType => ({ - // TODO: Fix this manually. Issue #123375 - // eslint-disable-next-line react/display-name - build: () => [ - { - username: ( - - ), - type: 'update' as const, - event: label, - 'data-test-subj': `${userAction.type}-${userAction.action}-action-${userAction.actionId}`, - timestamp: , - timelineIcon: icon, - actions: ( - - - - - {showMoveToReference(userAction.action, userAction.commentId) && ( +}: BuilderArgs): ReturnType => { + return { + // eslint-disable-next-line react/display-name + build: () => [ + { + username: ( + + ), + type: 'update' as const, + event: label, + 'data-test-subj': `${userAction.type}-${userAction.action}-action-${userAction.actionId}`, + timestamp: , + timelineIcon: icon, + actions: ( + - + - )} - - ), - }, - ], -}); + {showMoveToReference(userAction.action, userAction.commentId) && ( + + + + )} + + ), + }, + ], + }; +}; diff --git a/x-pack/plugins/cases/public/components/user_actions/constants.ts b/x-pack/plugins/cases/public/components/user_actions/constants.ts index 4cdc0f4fb5edb..11e16affad7d8 100644 --- a/x-pack/plugins/cases/public/components/user_actions/constants.ts +++ b/x-pack/plugins/cases/public/components/user_actions/constants.ts @@ -11,7 +11,7 @@ import { SupportedUserActionTypes } from './types'; export const DRAFT_COMMENT_STORAGE_ID = 'xpack.cases.commentDraft'; -export const UNSUPPORTED_ACTION_TYPES = ['create_case', 'delete_case', 'settings'] as const; +export const UNSUPPORTED_ACTION_TYPES = ['create_case', 'delete_case'] as const; export const SUPPORTED_ACTION_TYPES: SupportedUserActionTypes[] = Object.keys( omit(ActionTypes, UNSUPPORTED_ACTION_TYPES) ) as SupportedUserActionTypes[]; diff --git a/x-pack/plugins/cases/public/components/user_actions/helpers.test.ts b/x-pack/plugins/cases/public/components/user_actions/helpers.test.ts index 80b68450f9edd..eb2b7297a9e2e 100644 --- a/x-pack/plugins/cases/public/components/user_actions/helpers.test.ts +++ b/x-pack/plugins/cases/public/components/user_actions/helpers.test.ts @@ -61,7 +61,7 @@ describe('helpers', () => { ['tags', true], ['title', true], ['status', true], - ['settings', false], + ['settings', true], ['create_case', false], ['delete_case', false], ]; diff --git a/x-pack/plugins/cases/public/components/user_actions/settings.test.tsx b/x-pack/plugins/cases/public/components/user_actions/settings.test.tsx new file mode 100644 index 0000000000000..12960e8293edc --- /dev/null +++ b/x-pack/plugins/cases/public/components/user_actions/settings.test.tsx @@ -0,0 +1,51 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { EuiCommentList } from '@elastic/eui'; +import React from 'react'; +import { Actions } from '../../../common/api'; +import { AppMockRenderer, createAppMockRenderer } from '../../common/mock'; +import { getUserAction } from '../../containers/mock'; +import { getMockBuilderArgs } from './mock'; +import { createSettingsUserActionBuilder } from './settings'; + +jest.mock('../../common/lib/kibana'); +jest.mock('../../common/navigation/hooks'); + +describe('createStatusUserActionBuilder ', () => { + const builderArgs = getMockBuilderArgs(); + let appMock: AppMockRenderer; + + beforeEach(() => { + appMock = createAppMockRenderer(); + jest.clearAllMocks(); + }); + + const tests = [ + [false, 'disabled'], + [true, 'enabled'], + ]; + + it.each(tests)( + 'renders correctly when changed setting sync-alerts to %s', + async (syncAlerts, label) => { + const userAction = getUserAction('settings', Actions.update, { + payload: { settings: { syncAlerts } }, + }); + const builder = createSettingsUserActionBuilder({ + ...builderArgs, + userAction, + }); + + const createdUserAction = builder.build(); + const result = appMock.render(); + + expect(result.getByTestId('settings-update-action-settings-update')).toBeTruthy(); + expect(result.getByText(`${label} sync alerts`)).toBeTruthy(); + } + ); +}); diff --git a/x-pack/plugins/cases/public/components/user_actions/settings.tsx b/x-pack/plugins/cases/public/components/user_actions/settings.tsx new file mode 100644 index 0000000000000..40d773a186623 --- /dev/null +++ b/x-pack/plugins/cases/public/components/user_actions/settings.tsx @@ -0,0 +1,43 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { ReactNode } from 'react'; +import { SettingsUserAction } from '../../../common/api'; +import { UserActionBuilder, UserActionResponse } from './types'; + +import { createCommonUpdateUserActionBuilder } from './common'; +import { DISABLED_SETTING, ENABLED_SETTING, SYNC_ALERTS_LC } from './translations'; + +function getSettingsLabel(userAction: UserActionResponse): ReactNode { + if (userAction.payload.settings.syncAlerts) { + return `${ENABLED_SETTING} ${SYNC_ALERTS_LC}`; + } else { + return `${DISABLED_SETTING} ${SYNC_ALERTS_LC}`; + } +} + +export const createSettingsUserActionBuilder: UserActionBuilder = ({ + userAction, + handleOutlineComment, +}) => ({ + build: () => { + const action = userAction as UserActionResponse; + if (action?.payload?.settings?.syncAlerts !== undefined) { + const commonBuilder = createCommonUpdateUserActionBuilder({ + userAction, + handleOutlineComment, + label: getSettingsLabel(action), + icon: 'gear', + }); + + return commonBuilder.build(); + } + + // if new settings are introduced. they won't be rendered + return []; + }, +}); From fd82feae08359e7bc529bc28ce00e012dff3805d Mon Sep 17 00:00:00 2001 From: Walter Rafelsberger Date: Tue, 1 Feb 2022 12:44:53 +0100 Subject: [PATCH 02/73] [ML] Transforms: Adds reset action to transforms management. (#123735) Adds reset action to transforms management. Supports bulk resetting multiple transforms. --- .../common/api_schemas/reset_transforms.ts | 32 +++ .../common/api_schemas/type_guards.ts | 10 + x-pack/plugins/transform/common/constants.ts | 1 + .../transform/public/app/hooks/index.ts | 1 + .../transform/public/app/hooks/use_api.ts | 15 ++ .../public/app/hooks/use_reset_transform.tsx | 112 ++++++++ .../components/authorization_provider.tsx | 3 + .../lib/authorization/components/common.ts | 7 + .../components/action_reset/index.ts | 10 + .../action_reset/reset_action_modal.tsx | 88 ++++++ .../action_reset/reset_action_name.tsx | 70 +++++ .../action_reset/use_reset_action.tsx | 83 ++++++ .../transform_list/transform_list.tsx | 21 ++ .../transform_list/use_actions.test.tsx | 1 + .../components/transform_list/use_actions.tsx | 4 + .../server/routes/api/error_utils.ts | 11 +- .../transform/server/routes/api/transforms.ts | 92 ++++++- .../api_integration/apis/transform/index.ts | 1 + .../apis/transform/reset_transforms.ts | 254 ++++++++++++++++++ .../test/functional/apps/transform/cloning.ts | 1 - .../test/functional/apps/transform/index.ts | 1 + .../functional/apps/transform/resetting.ts | 143 ++++++++++ .../services/transform/transform_table.ts | 19 +- 23 files changed, 975 insertions(+), 5 deletions(-) create mode 100644 x-pack/plugins/transform/common/api_schemas/reset_transforms.ts create mode 100644 x-pack/plugins/transform/public/app/hooks/use_reset_transform.tsx create mode 100644 x-pack/plugins/transform/public/app/sections/transform_management/components/action_reset/index.ts create mode 100644 x-pack/plugins/transform/public/app/sections/transform_management/components/action_reset/reset_action_modal.tsx create mode 100644 x-pack/plugins/transform/public/app/sections/transform_management/components/action_reset/reset_action_name.tsx create mode 100644 x-pack/plugins/transform/public/app/sections/transform_management/components/action_reset/use_reset_action.tsx create mode 100644 x-pack/test/api_integration/apis/transform/reset_transforms.ts create mode 100644 x-pack/test/functional/apps/transform/resetting.ts diff --git a/x-pack/plugins/transform/common/api_schemas/reset_transforms.ts b/x-pack/plugins/transform/common/api_schemas/reset_transforms.ts new file mode 100644 index 0000000000000..951f5ad87716a --- /dev/null +++ b/x-pack/plugins/transform/common/api_schemas/reset_transforms.ts @@ -0,0 +1,32 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { schema, TypeOf } from '@kbn/config-schema'; + +import { transformStateSchema, ResponseStatus } from './common'; + +export const resetTransformsRequestSchema = schema.object({ + /** + * Reset Transforms + */ + transformsInfo: schema.arrayOf( + schema.object({ + id: schema.string(), + state: transformStateSchema, + }) + ), +}); + +export type ResetTransformsRequestSchema = TypeOf; + +export interface ResetTransformStatus { + transformReset: ResponseStatus; +} + +export interface ResetTransformsResponseSchema { + [key: string]: ResetTransformStatus; +} diff --git a/x-pack/plugins/transform/common/api_schemas/type_guards.ts b/x-pack/plugins/transform/common/api_schemas/type_guards.ts index 6c572a195b65f..3af08e57f7198 100644 --- a/x-pack/plugins/transform/common/api_schemas/type_guards.ts +++ b/x-pack/plugins/transform/common/api_schemas/type_guards.ts @@ -16,6 +16,7 @@ import { isPopulatedObject } from '../shared_imports'; import type { FieldHistogramsResponseSchema } from './field_histograms'; import type { GetTransformsAuditMessagesResponseSchema } from './audit_messages'; import type { DeleteTransformsResponseSchema } from './delete_transforms'; +import type { ResetTransformsResponseSchema } from './reset_transforms'; import type { StartTransformsResponseSchema } from './start_transforms'; import type { StopTransformsResponseSchema } from './stop_transforms'; import type { @@ -56,6 +57,15 @@ export const isDeleteTransformsResponseSchema = ( ); }; +export const isResetTransformsResponseSchema = ( + arg: unknown +): arg is ResetTransformsResponseSchema => { + return ( + isPopulatedObject(arg) && + Object.values(arg).every((d) => isPopulatedObject(d, ['transformReset'])) + ); +}; + export const isEsIndices = (arg: unknown): arg is EsIndex[] => { return Array.isArray(arg); }; diff --git a/x-pack/plugins/transform/common/constants.ts b/x-pack/plugins/transform/common/constants.ts index d56b1ad56898a..d2833f0e071fb 100644 --- a/x-pack/plugins/transform/common/constants.ts +++ b/x-pack/plugins/transform/common/constants.ts @@ -55,6 +55,7 @@ export const APP_CLUSTER_PRIVILEGES = [ 'cluster:admin/transform/delete', 'cluster:admin/transform/preview', 'cluster:admin/transform/put', + 'cluster:admin/transform/reset', 'cluster:admin/transform/start', 'cluster:admin/transform/start_task', 'cluster:admin/transform/stop', diff --git a/x-pack/plugins/transform/public/app/hooks/index.ts b/x-pack/plugins/transform/public/app/hooks/index.ts index b050192fb9fb3..88333224f786b 100644 --- a/x-pack/plugins/transform/public/app/hooks/index.ts +++ b/x-pack/plugins/transform/public/app/hooks/index.ts @@ -8,6 +8,7 @@ export { useApi } from './use_api'; export { useGetTransforms } from './use_get_transforms'; export { useDeleteTransforms, useDeleteIndexAndTargetIndex } from './use_delete_transform'; +export { useResetTransforms } from './use_reset_transform'; export { useStartTransforms } from './use_start_transform'; export { useStopTransforms } from './use_stop_transform'; export { useRequest } from './use_request'; diff --git a/x-pack/plugins/transform/public/app/hooks/use_api.ts b/x-pack/plugins/transform/public/app/hooks/use_api.ts index 21e37ca16c4de..64ea34c9470cf 100644 --- a/x-pack/plugins/transform/public/app/hooks/use_api.ts +++ b/x-pack/plugins/transform/public/app/hooks/use_api.ts @@ -22,6 +22,10 @@ import type { FieldHistogramsRequestSchema, FieldHistogramsResponseSchema, } from '../../../common/api_schemas/field_histograms'; +import type { + ResetTransformsRequestSchema, + ResetTransformsResponseSchema, +} from '../../../common/api_schemas/reset_transforms'; import type { StartTransformsRequestSchema, StartTransformsResponseSchema, @@ -157,6 +161,17 @@ export const useApi = () => { return e; } }, + async resetTransforms( + reqBody: ResetTransformsRequestSchema + ): Promise { + try { + return await http.post(`${API_BASE_PATH}reset_transforms`, { + body: JSON.stringify(reqBody), + }); + } catch (e) { + return e; + } + }, async startTransforms( reqBody: StartTransformsRequestSchema ): Promise { diff --git a/x-pack/plugins/transform/public/app/hooks/use_reset_transform.tsx b/x-pack/plugins/transform/public/app/hooks/use_reset_transform.tsx new file mode 100644 index 0000000000000..1687bd751ac19 --- /dev/null +++ b/x-pack/plugins/transform/public/app/hooks/use_reset_transform.tsx @@ -0,0 +1,112 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import { i18n } from '@kbn/i18n'; +import { toMountPoint } from '../../../../../../src/plugins/kibana_react/public'; +import type { + ResetTransformStatus, + ResetTransformsRequestSchema, +} from '../../../common/api_schemas/reset_transforms'; +import { isResetTransformsResponseSchema } from '../../../common/api_schemas/type_guards'; +import { getErrorMessage } from '../../../common/utils/errors'; +import { useAppDependencies, useToastNotifications } from '../app_dependencies'; +import { REFRESH_TRANSFORM_LIST_STATE, refreshTransformList$ } from '../common'; +import { ToastNotificationText } from '../components'; +import { useApi } from './use_api'; + +type SuccessCountField = keyof Omit; + +export const useResetTransforms = () => { + const { overlays, theme } = useAppDependencies(); + const toastNotifications = useToastNotifications(); + const api = useApi(); + + return async (reqBody: ResetTransformsRequestSchema) => { + const results = await api.resetTransforms(reqBody); + + if (!isResetTransformsResponseSchema(results)) { + toastNotifications.addDanger({ + title: i18n.translate('xpack.transform.transformList.resetTransformGenericErrorMessage', { + defaultMessage: 'An error occurred calling the API endpoint to reset transforms.', + }), + text: toMountPoint( + , + { theme$: theme.theme$ } + ), + }); + return; + } + + const isBulk = Object.keys(results).length > 1; + const successCount: Record = { + transformReset: 0, + }; + for (const transformId in results) { + // hasOwnProperty check to ensure only properties on object itself, and not its prototypes + if (results.hasOwnProperty(transformId)) { + const status = results[transformId]; + + // if we are only resetting one transform, show the success toast messages + if (!isBulk && status.transformReset) { + if (status.transformReset?.success) { + toastNotifications.addSuccess( + i18n.translate('xpack.transform.transformList.resetTransformSuccessMessage', { + defaultMessage: 'Request to reset transform {transformId} acknowledged.', + values: { transformId }, + }) + ); + } + } else { + (Object.keys(successCount) as SuccessCountField[]).forEach((key) => { + if (status[key]?.success) { + successCount[key] = successCount[key] + 1; + } + }); + } + if (status.transformReset?.error) { + const error = status.transformReset.error.reason; + toastNotifications.addDanger({ + title: i18n.translate('xpack.transform.transformList.resetTransformErrorMessage', { + defaultMessage: 'An error occurred resetting the transform {transformId}', + values: { transformId }, + }), + text: toMountPoint( + , + { theme$: theme.theme$ } + ), + }); + } + } + } + + // if we are deleting multiple transforms, combine the success messages + if (isBulk) { + if (successCount.transformReset > 0) { + toastNotifications.addSuccess( + i18n.translate('xpack.transform.transformList.bulkResetTransformSuccessMessage', { + defaultMessage: + 'Successfully reset {count} {count, plural, one {transform} other {transforms}}.', + values: { count: successCount.transformReset }, + }) + ); + } + } + + refreshTransformList$.next(REFRESH_TRANSFORM_LIST_STATE.REFRESH); + }; +}; diff --git a/x-pack/plugins/transform/public/app/lib/authorization/components/authorization_provider.tsx b/x-pack/plugins/transform/public/app/lib/authorization/components/authorization_provider.tsx index cc6313bf058c6..cae840b86a833 100644 --- a/x-pack/plugins/transform/public/app/lib/authorization/components/authorization_provider.tsx +++ b/x-pack/plugins/transform/public/app/lib/authorization/components/authorization_provider.tsx @@ -28,6 +28,7 @@ const initialCapabilities: Capabilities = { canStartStopTransform: false, canCreateTransformAlerts: false, canUseTransformAlerts: false, + canResetTransform: false, }; const initialValue: Authorization = { @@ -77,6 +78,8 @@ export const AuthorizationProvider = ({ privilegesEndpoint, children }: Props) = 'cluster:admin/transform/delete', ]); + value.capabilities.canResetTransform = hasPrivilege(['cluster', 'cluster:admin/transform/reset']); + value.capabilities.canPreviewTransform = hasPrivilege([ 'cluster', 'cluster:admin/transform/preview', diff --git a/x-pack/plugins/transform/public/app/lib/authorization/components/common.ts b/x-pack/plugins/transform/public/app/lib/authorization/components/common.ts index d430a4d059e5c..659d525643965 100644 --- a/x-pack/plugins/transform/public/app/lib/authorization/components/common.ts +++ b/x-pack/plugins/transform/public/app/lib/authorization/components/common.ts @@ -18,6 +18,7 @@ export interface Capabilities { canStartStopTransform: boolean; canCreateTransformAlerts: boolean; canUseTransformAlerts: boolean; + canResetTransform: boolean; } export type Privilege = [string, string]; @@ -91,6 +92,12 @@ export function createCapabilityFailureMessage( }); break; + case 'canResetTransform': + message = i18n.translate('xpack.transform.capability.noPermission.resetTransformTooltip', { + defaultMessage: 'You do not have permission to reset transforms.', + }); + break; + case 'noTransformNodes': message = i18n.translate('xpack.transform.capability.noPermission.noTransformNodesTooltip', { defaultMessage: 'There are no transform nodes available.', diff --git a/x-pack/plugins/transform/public/app/sections/transform_management/components/action_reset/index.ts b/x-pack/plugins/transform/public/app/sections/transform_management/components/action_reset/index.ts new file mode 100644 index 0000000000000..62f4d42715579 --- /dev/null +++ b/x-pack/plugins/transform/public/app/sections/transform_management/components/action_reset/index.ts @@ -0,0 +1,10 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export { useResetAction } from './use_reset_action'; +export { ResetActionModal } from './reset_action_modal'; +export { isResetActionDisabled, ResetActionName } from './reset_action_name'; diff --git a/x-pack/plugins/transform/public/app/sections/transform_management/components/action_reset/reset_action_modal.tsx b/x-pack/plugins/transform/public/app/sections/transform_management/components/action_reset/reset_action_modal.tsx new file mode 100644 index 0000000000000..001d2dcad5ee6 --- /dev/null +++ b/x-pack/plugins/transform/public/app/sections/transform_management/components/action_reset/reset_action_modal.tsx @@ -0,0 +1,88 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { FC, useMemo } from 'react'; +import { i18n } from '@kbn/i18n'; +import { EUI_MODAL_CONFIRM_BUTTON, EuiConfirmModal, EuiFlexGroup, EuiSpacer } from '@elastic/eui'; +import { ResetAction } from './use_reset_action'; +import { isManagedTransform } from '../../../../common/managed_transforms_utils'; +import { ManagedTransformsWarningCallout } from '../managed_transforms_callout/managed_transforms_callout'; + +export const ResetActionModal: FC = ({ + closeModal, + resetAndCloseModal, + items, + shouldForceReset, +}) => { + const hasManagedTransforms = useMemo(() => items.some((t) => isManagedTransform(t)), [items]); + const isBulkAction = items.length > 1; + + const bulkResetModalTitle = i18n.translate('xpack.transform.transformList.bulkResetModalTitle', { + defaultMessage: 'Reset {count} {count, plural, one {transform} other {transforms}}?', + values: { count: items.length }, + }); + const resetModalTitle = i18n.translate('xpack.transform.transformList.resetModalTitle', { + defaultMessage: 'Reset {transformId}?', + values: { transformId: items[0] && items[0].config.id }, + }); + const bulkResetModalContent = ( + <> + + {hasManagedTransforms ? ( + <> + + + + ) : null} + + + ); + + const resetModalContent = ( + <> + + {hasManagedTransforms ? ( + <> + + + + ) : null} + + + ); + + return ( + + {isBulkAction ? bulkResetModalContent : resetModalContent} + + ); +}; diff --git a/x-pack/plugins/transform/public/app/sections/transform_management/components/action_reset/reset_action_name.tsx b/x-pack/plugins/transform/public/app/sections/transform_management/components/action_reset/reset_action_name.tsx new file mode 100644 index 0000000000000..c6ea0f5f7270d --- /dev/null +++ b/x-pack/plugins/transform/public/app/sections/transform_management/components/action_reset/reset_action_name.tsx @@ -0,0 +1,70 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { FC } from 'react'; +import { i18n } from '@kbn/i18n'; +import { EuiToolTip } from '@elastic/eui'; +import { TransformState, TRANSFORM_STATE } from '../../../../../../common/constants'; +import { createCapabilityFailureMessage } from '../../../../lib/authorization'; +import { TransformListRow } from '../../../../common'; + +export const resetActionNameText = i18n.translate( + 'xpack.transform.transformList.resetActionNameText', + { + defaultMessage: 'Reset', + } +); + +const transformCanNotBeReseted = (i: TransformListRow) => + !([TRANSFORM_STATE.STOPPED, TRANSFORM_STATE.FAILED] as TransformState[]).includes(i.stats.state); + +export const isResetActionDisabled = (items: TransformListRow[], forceDisable: boolean) => { + const disabled = items.some(transformCanNotBeReseted); + return forceDisable === true || disabled; +}; + +export interface ResetActionNameProps { + canResetTransform: boolean; + disabled: boolean; + isBulkAction: boolean; +} + +export const ResetActionName: FC = ({ + canResetTransform, + disabled, + isBulkAction, +}) => { + const bulkResetButtonDisabledText = i18n.translate( + 'xpack.transform.transformList.resetBulkActionDisabledToolTipContent', + { + defaultMessage: 'One or more selected transforms must be stopped to be reset.', + } + ); + const resetButtonDisabledText = i18n.translate( + 'xpack.transform.transformList.resetActionDisabledToolTipContent', + { + defaultMessage: 'Stop the transform in order to reset it.', + } + ); + + if (disabled || !canResetTransform) { + let content; + if (disabled) { + content = isBulkAction ? bulkResetButtonDisabledText : resetButtonDisabledText; + } else { + content = createCapabilityFailureMessage('canResetTransform'); + } + + return ( + + <>{resetActionNameText} + + ); + } + + return <>{resetActionNameText}; +}; diff --git a/x-pack/plugins/transform/public/app/sections/transform_management/components/action_reset/use_reset_action.tsx b/x-pack/plugins/transform/public/app/sections/transform_management/components/action_reset/use_reset_action.tsx new file mode 100644 index 0000000000000..70164bc22a63c --- /dev/null +++ b/x-pack/plugins/transform/public/app/sections/transform_management/components/action_reset/use_reset_action.tsx @@ -0,0 +1,83 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useContext, useMemo, useState } from 'react'; + +import { TRANSFORM_STATE } from '../../../../../../common/constants'; + +import { TransformListAction, TransformListRow } from '../../../../common'; +import { useResetTransforms } from '../../../../hooks'; +import { AuthorizationContext } from '../../../../lib/authorization'; + +import { resetActionNameText, isResetActionDisabled, ResetActionName } from './reset_action_name'; + +export type ResetAction = ReturnType; +export const useResetAction = (forceDisable: boolean) => { + const { canResetTransform } = useContext(AuthorizationContext).capabilities; + + const resetTransforms = useResetTransforms(); + + const [isModalVisible, setModalVisible] = useState(false); + const [items, setItems] = useState([]); + + const shouldForceReset = useMemo( + () => items.some((i: TransformListRow) => i.stats.state === TRANSFORM_STATE.FAILED), + [items] + ); + + const closeModal = () => setModalVisible(false); + + const resetAndCloseModal = () => { + setModalVisible(false); + + resetTransforms({ + transformsInfo: items.map((i) => ({ + id: i.config.id, + state: i.stats.state, + })), + }); + }; + + const openModal = (newItems: TransformListRow[]) => { + if (Array.isArray(newItems)) { + setItems(newItems); + setModalVisible(true); + } + }; + + const action: TransformListAction = useMemo( + () => ({ + name: (item: TransformListRow) => ( + + ), + enabled: (item: TransformListRow) => + !isResetActionDisabled([item], forceDisable) && canResetTransform, + description: resetActionNameText, + icon: 'refresh', + type: 'icon', + onClick: (item: TransformListRow) => openModal([item]), + 'data-test-subj': 'transformActionReset', + }), + [canResetTransform, forceDisable] + ); + + return { + action, + closeModal, + resetAndCloseModal, + isModalVisible, + items, + openModal, + shouldForceReset, + }; +}; diff --git a/x-pack/plugins/transform/public/app/sections/transform_management/components/transform_list/transform_list.tsx b/x-pack/plugins/transform/public/app/sections/transform_management/components/transform_list/transform_list.tsx index cdf0c14409fdd..4c8447feae1ee 100644 --- a/x-pack/plugins/transform/public/app/sections/transform_management/components/transform_list/transform_list.tsx +++ b/x-pack/plugins/transform/public/app/sections/transform_management/components/transform_list/transform_list.tsx @@ -41,6 +41,12 @@ import { DeleteActionName, DeleteActionModal, } from '../action_delete'; +import { + isResetActionDisabled, + useResetAction, + ResetActionName, + ResetActionModal, +} from '../action_reset'; import { useStartAction, StartActionName, StartActionModal } from '../action_start'; import { StopActionName, useStopAction } from '../action_stop'; @@ -92,6 +98,7 @@ export const TransformList: FC = ({ const [isActionsMenuOpen, setIsActionsMenuOpen] = useState(false); const bulkStartAction = useStartAction(false, transformNodes); const bulkDeleteAction = useDeleteAction(false); + const bulkResetAction = useResetAction(false); const bulkStopAction = useStopAction(false); const [searchError, setSearchError] = useState(undefined); @@ -196,6 +203,19 @@ export const TransformList: FC = ({ , +
+ { + bulkResetAction.openModal(transformSelection); + }} + > + + +
,
bulkDeleteAction.openModal(transformSelection)}> = ({ {/* Bulk Action Modals */} {bulkStartAction.isModalVisible && } {bulkDeleteAction.isModalVisible && } + {bulkResetAction.isModalVisible && } {bulkStopAction.isModalVisible && } {/* Single Action Modals */} diff --git a/x-pack/plugins/transform/public/app/sections/transform_management/components/transform_list/use_actions.test.tsx b/x-pack/plugins/transform/public/app/sections/transform_management/components/transform_list/use_actions.test.tsx index 20d2f784a4d8b..68adbca5d662f 100644 --- a/x-pack/plugins/transform/public/app/sections/transform_management/components/transform_list/use_actions.test.tsx +++ b/x-pack/plugins/transform/public/app/sections/transform_management/components/transform_list/use_actions.test.tsx @@ -33,6 +33,7 @@ describe('Transform: Transform List Actions', () => { 'transformActionEdit', 'transformActionClone', 'transformActionDelete', + 'transformActionReset', ]); }); }); diff --git a/x-pack/plugins/transform/public/app/sections/transform_management/components/transform_list/use_actions.tsx b/x-pack/plugins/transform/public/app/sections/transform_management/components/transform_list/use_actions.tsx index 853c839a096fa..5d480003c7600 100644 --- a/x-pack/plugins/transform/public/app/sections/transform_management/components/transform_list/use_actions.tsx +++ b/x-pack/plugins/transform/public/app/sections/transform_management/components/transform_list/use_actions.tsx @@ -16,6 +16,7 @@ import { useDeleteAction, DeleteActionModal } from '../action_delete'; import { useDiscoverAction } from '../action_discover'; import { EditTransformFlyout } from '../edit_transform_flyout'; import { useEditAction } from '../action_edit'; +import { useResetAction, ResetActionModal } from '../action_reset'; import { useStartAction, StartActionModal } from '../action_start'; import { useStopAction } from '../action_stop'; import { useCreateAlertRuleAction } from '../action_create_alert'; @@ -35,6 +36,7 @@ export const useActions = ({ const deleteAction = useDeleteAction(forceDisable); const discoverAction = useDiscoverAction(forceDisable); const editAction = useEditAction(forceDisable, transformNodes); + const resetAction = useResetAction(forceDisable); const startAction = useStartAction(forceDisable, transformNodes); const stopAction = useStopAction(forceDisable); const createAlertRuleAction = useCreateAlertRuleAction(forceDisable); @@ -42,6 +44,7 @@ export const useActions = ({ return { modals: ( <> + {resetAction.isModalVisible && } {startAction.isModalVisible && } {stopAction.isModalVisible && } @@ -63,6 +66,7 @@ export const useActions = ({ editAction.action, cloneAction.action, deleteAction.action, + resetAction.action, ], }; }; diff --git a/x-pack/plugins/transform/server/routes/api/error_utils.ts b/x-pack/plugins/transform/server/routes/api/error_utils.ts index 7c4ac88576678..d9b892b7afcee 100644 --- a/x-pack/plugins/transform/server/routes/api/error_utils.ts +++ b/x-pack/plugins/transform/server/routes/api/error_utils.ts @@ -13,6 +13,7 @@ import { ResponseError, CustomHttpResponseOptions } from 'src/core/server'; import { CommonResponseStatusSchema, TransformIdsSchema } from '../../../common/api_schemas/common'; import { DeleteTransformsResponseSchema } from '../../../common/api_schemas/delete_transforms'; +import { ResetTransformsResponseSchema } from '../../../common/api_schemas/reset_transforms'; const REQUEST_TIMEOUT = 'RequestTimeout'; @@ -21,7 +22,10 @@ export function isRequestTimeout(error: any) { } interface Params { - results: CommonResponseStatusSchema | DeleteTransformsResponseSchema; + results: + | CommonResponseStatusSchema + | DeleteTransformsResponseSchema + | ResetTransformsResponseSchema; id: string; items: TransformIdsSchema; action: string; @@ -60,7 +64,10 @@ export function fillResultsWithTimeouts({ results, id, items, action }: Params) ], }; - const newResults: CommonResponseStatusSchema | DeleteTransformsResponseSchema = {}; + const newResults: + | CommonResponseStatusSchema + | DeleteTransformsResponseSchema + | ResetTransformsResponseSchema = {}; return items.reduce((accumResults, currentVal) => { if (results[currentVal.id] === undefined) { diff --git a/x-pack/plugins/transform/server/routes/api/transforms.ts b/x-pack/plugins/transform/server/routes/api/transforms.ts index 81f048c6202ab..e88f71f0e7f24 100644 --- a/x-pack/plugins/transform/server/routes/api/transforms.ts +++ b/x-pack/plugins/transform/server/routes/api/transforms.ts @@ -27,6 +27,11 @@ import { DeleteTransformsRequestSchema, DeleteTransformsResponseSchema, } from '../../../common/api_schemas/delete_transforms'; +import { + resetTransformsRequestSchema, + ResetTransformsRequestSchema, + ResetTransformsResponseSchema, +} from '../../../common/api_schemas/reset_transforms'; import { startTransformsRequestSchema, StartTransformsRequestSchema, @@ -62,9 +67,10 @@ import { isKeywordDuplicate } from '../../../common/utils/field_utils'; import { transformHealthServiceProvider } from '../../lib/alerting/transform_health_rule_type/transform_health_service'; enum TRANSFORM_ACTIONS { + DELETE = 'delete', + RESET = 'reset', STOP = 'stop', START = 'start', - DELETE = 'delete', } export function registerTransformsRoutes(routeDependencies: RouteDependencies) { @@ -316,6 +322,46 @@ export function registerTransformsRoutes(routeDependencies: RouteDependencies) { ) ); + /** + * @apiGroup Transforms + * + * @api {post} /api/transform/reset_transforms Post reset transforms + * @apiName ResetTransforms + * @apiDescription resets transforms + * + * @apiSchema (body) resetTransformsRequestSchema + */ + router.post( + { + path: addBasePath('reset_transforms'), + validate: { + body: resetTransformsRequestSchema, + }, + }, + license.guardApiRoute( + async (ctx, req, res) => { + try { + const body = await resetTransforms(req.body, ctx, res); + + if (body && body.status) { + if (body.status === 404) { + return res.notFound(); + } + if (body.status === 403) { + return res.forbidden(); + } + } + + return res.ok({ + body, + }); + } catch (e) { + return res.customError(wrapError(wrapEsError(e))); + } + } + ) + ); + /** * @apiGroup Transforms * @@ -550,6 +596,50 @@ async function deleteTransforms( return results; } +async function resetTransforms( + reqBody: ResetTransformsRequestSchema, + ctx: RequestHandlerContext, + response: KibanaResponseFactory +) { + const { transformsInfo } = reqBody; + + const results: ResetTransformsResponseSchema = {}; + + for (const transformInfo of transformsInfo) { + const transformReset: ResponseStatus = { success: false }; + const transformId = transformInfo.id; + + try { + try { + await ctx.core.elasticsearch.client.asCurrentUser.transform.resetTransform({ + transform_id: transformId, + }); + transformReset.success = true; + } catch (resetTransformJobError) { + transformReset.error = resetTransformJobError.meta.body.error; + if (resetTransformJobError.statusCode === 403) { + return response.forbidden(); + } + } + + results[transformId] = { + transformReset, + }; + } catch (e) { + if (isRequestTimeout(e)) { + return fillResultsWithTimeouts({ + results, + id: transformInfo.id, + items: transformsInfo, + action: TRANSFORM_ACTIONS.RESET, + }); + } + results[transformId] = { transformReset: { success: false, error: e.meta.body.error } }; + } + } + return results; +} + const previewTransformHandler: RequestHandler< undefined, undefined, diff --git a/x-pack/test/api_integration/apis/transform/index.ts b/x-pack/test/api_integration/apis/transform/index.ts index 351008f3f735e..153bdcebc692b 100644 --- a/x-pack/test/api_integration/apis/transform/index.ts +++ b/x-pack/test/api_integration/apis/transform/index.ts @@ -29,6 +29,7 @@ export default function ({ getService, loadTestFile }: FtrProviderContext) { }); loadTestFile(require.resolve('./delete_transforms')); + loadTestFile(require.resolve('./reset_transforms')); loadTestFile(require.resolve('./start_transforms')); loadTestFile(require.resolve('./stop_transforms')); loadTestFile(require.resolve('./transforms')); diff --git a/x-pack/test/api_integration/apis/transform/reset_transforms.ts b/x-pack/test/api_integration/apis/transform/reset_transforms.ts new file mode 100644 index 0000000000000..16d92ff133400 --- /dev/null +++ b/x-pack/test/api_integration/apis/transform/reset_transforms.ts @@ -0,0 +1,254 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import expect from '@kbn/expect'; + +import { ResetTransformsRequestSchema } from '../../../../plugins/transform/common/api_schemas/reset_transforms'; +import { TRANSFORM_STATE } from '../../../../plugins/transform/common/constants'; + +import { COMMON_REQUEST_HEADERS } from '../../../functional/services/ml/common_api'; +import { USER } from '../../../functional/services/transform/security_common'; + +import { FtrProviderContext } from '../../ftr_provider_context'; + +import { asyncForEach, generateTransformConfig } from './common'; + +export default ({ getService }: FtrProviderContext) => { + const esArchiver = getService('esArchiver'); + const supertest = getService('supertestWithoutAuth'); + const transform = getService('transform'); + + const expected = { + complete: { + state: 'stopped', + pagesProcessed: 2, + lastCheckpoint: 1, + }, + reset: { + state: 'stopped', + pagesProcessed: 0, + lastCheckpoint: 0, + }, + }; + + describe('/api/transform/reset_transforms', function () { + before(async () => { + await esArchiver.loadIfNeeded('x-pack/test/functional/es_archives/ml/farequote'); + await transform.testResources.setKibanaTimeZoneToUTC(); + }); + + after(async () => { + await transform.api.cleanTransformIndices(); + }); + + describe('single transform reset', function () { + const transformId = 'transform-test-reset'; + + beforeEach(async () => { + await transform.api.createAndRunTransform( + transformId, + generateTransformConfig(transformId) + ); + await transform.api.waitForBatchTransformToComplete(transformId); + }); + + afterEach(async () => { + await transform.api.cleanTransformIndices(); + }); + + it('should reset transform by transformId', async () => { + // Check that batch transform finished running and assert stats. + const completeStats = await transform.api.getTransformStats(transformId); + expect(completeStats.state).to.eql(expected.complete.state); + expect(completeStats.stats.pages_processed).to.eql(expected.complete.pagesProcessed); + expect(completeStats.checkpointing.last.checkpoint).to.eql( + expected.complete.lastCheckpoint + ); + + const reqBody: ResetTransformsRequestSchema = { + transformsInfo: [{ id: transformId, state: TRANSFORM_STATE.STOPPED }], + }; + const { body } = await supertest + .post(`/api/transform/reset_transforms`) + .auth( + USER.TRANSFORM_POWERUSER, + transform.securityCommon.getPasswordForUser(USER.TRANSFORM_POWERUSER) + ) + .set(COMMON_REQUEST_HEADERS) + .send(reqBody) + .expect(200); + + // Check that transform was reset and assert stats. + expect(body[transformId].transformReset.success).to.eql(true); + const resetStats = await transform.api.getTransformStats(transformId); + expect(resetStats.state).to.eql(expected.reset.state); + expect(resetStats.stats.pages_processed).to.eql(expected.reset.pagesProcessed); + expect(resetStats.checkpointing.last.checkpoint).to.eql(expected.reset.lastCheckpoint); + }); + + it('should return 403 for unauthorized user', async () => { + // Check that batch transform finished running and assert stats. + const completeStats = await transform.api.getTransformStats(transformId); + expect(completeStats.state).to.eql(expected.complete.state); + expect(completeStats.stats.pages_processed).to.eql(expected.complete.pagesProcessed); + expect(completeStats.checkpointing.last.checkpoint).to.eql( + expected.complete.lastCheckpoint + ); + + const reqBody: ResetTransformsRequestSchema = { + transformsInfo: [{ id: transformId, state: TRANSFORM_STATE.STOPPED }], + }; + await supertest + .post(`/api/transform/reset_transforms`) + .auth( + USER.TRANSFORM_VIEWER, + transform.securityCommon.getPasswordForUser(USER.TRANSFORM_VIEWER) + ) + .set(COMMON_REQUEST_HEADERS) + .send(reqBody) + .expect(403); + + await transform.api.waitForTransformToExist(transformId); + // Check that transform was not reset by asserting unchanged stats. + const resetStats = await transform.api.getTransformStats(transformId); + expect(resetStats.state).to.eql(expected.complete.state); + expect(resetStats.stats.pages_processed).to.eql(expected.complete.pagesProcessed); + expect(resetStats.checkpointing.last.checkpoint).to.eql(expected.complete.lastCheckpoint); + }); + }); + + describe('single transform reset with invalid transformId', function () { + it('should return 200 with error in response if invalid transformId', async () => { + const reqBody: ResetTransformsRequestSchema = { + transformsInfo: [{ id: 'invalid_transform_id', state: TRANSFORM_STATE.STOPPED }], + }; + const { body } = await supertest + .post(`/api/transform/reset_transforms`) + .auth( + USER.TRANSFORM_POWERUSER, + transform.securityCommon.getPasswordForUser(USER.TRANSFORM_POWERUSER) + ) + .set(COMMON_REQUEST_HEADERS) + .send(reqBody) + .expect(200); + + expect(body.invalid_transform_id.transformReset.success).to.eql(false); + expect(body.invalid_transform_id.transformReset).to.have.property('error'); + }); + }); + + describe('bulk reset', function () { + const reqBody: ResetTransformsRequestSchema = { + transformsInfo: [ + { id: 'bulk_reset_test_1', state: TRANSFORM_STATE.STOPPED }, + { id: 'bulk_reset_test_2', state: TRANSFORM_STATE.STOPPED }, + ], + }; + + beforeEach(async () => { + await asyncForEach(reqBody.transformsInfo, async ({ id }: { id: string }, idx: number) => { + await transform.api.createAndRunTransform(id, generateTransformConfig(id)); + await transform.api.waitForBatchTransformToComplete(id); + }); + }); + + afterEach(async () => { + await transform.api.cleanTransformIndices(); + }); + + it('should reset multiple transforms by transformIds', async () => { + await asyncForEach( + reqBody.transformsInfo, + async ({ id: transformId }: { id: string }, idx: number) => { + // Check that batch transform finished running and assert stats. + const completeStats = await transform.api.getTransformStats(transformId); + expect(completeStats.state).to.eql(expected.complete.state); + expect(completeStats.stats.pages_processed).to.eql(expected.complete.pagesProcessed); + expect(completeStats.checkpointing.last.checkpoint).to.eql( + expected.complete.lastCheckpoint + ); + } + ); + + const { body } = await supertest + .post(`/api/transform/reset_transforms`) + .auth( + USER.TRANSFORM_POWERUSER, + transform.securityCommon.getPasswordForUser(USER.TRANSFORM_POWERUSER) + ) + .set(COMMON_REQUEST_HEADERS) + .send(reqBody) + .expect(200); + + await asyncForEach( + reqBody.transformsInfo, + async ({ id: transformId }: { id: string }, idx: number) => { + await transform.api.waitForTransformToExist(transformId); + // Check that transform was reset and assert stats. + expect(body[transformId].transformReset.success).to.eql(true); + const resetStats = await transform.api.getTransformStats(transformId); + expect(resetStats.state).to.eql(expected.reset.state); + expect(resetStats.stats.pages_processed).to.eql(expected.reset.pagesProcessed); + expect(resetStats.checkpointing.last.checkpoint).to.eql(expected.reset.lastCheckpoint); + } + ); + }); + + it('should reset multiple transforms by transformIds, even if one of the transformIds is invalid', async () => { + await asyncForEach( + reqBody.transformsInfo, + async ({ id: transformId }: { id: string }, idx: number) => { + // Check that batch transform finished running and assert stats. + const completeStats = await transform.api.getTransformStats(transformId); + expect(completeStats.state).to.eql(expected.complete.state); + expect(completeStats.stats.pages_processed).to.eql(expected.complete.pagesProcessed); + expect(completeStats.checkpointing.last.checkpoint).to.eql( + expected.complete.lastCheckpoint + ); + } + ); + + const invalidTransformId = 'invalid_transform_id'; + const { body } = await supertest + .post(`/api/transform/reset_transforms`) + .auth( + USER.TRANSFORM_POWERUSER, + transform.securityCommon.getPasswordForUser(USER.TRANSFORM_POWERUSER) + ) + .set(COMMON_REQUEST_HEADERS) + .send({ + ...reqBody, + transformsInfo: [ + ...reqBody.transformsInfo, + { id: invalidTransformId, state: TRANSFORM_STATE.STOPPED }, + ], + }) + .expect(200); + + await asyncForEach( + reqBody.transformsInfo, + async ({ id: transformId }: { id: string }, idx: number) => { + if (transformId !== invalidTransformId) { + await transform.api.waitForTransformToExist(transformId); + // Check that transform was reset and assert stats. + expect(body[transformId].transformReset.success).to.eql(true); + const resetStats = await transform.api.getTransformStats(transformId); + expect(resetStats.state).to.eql(expected.reset.state); + expect(resetStats.stats.pages_processed).to.eql(expected.reset.pagesProcessed); + expect(resetStats.checkpointing.last.checkpoint).to.eql( + expected.reset.lastCheckpoint + ); + } else { + expect(body[transformId].transformReset.success).to.eql(false); + expect(body[transformId].transformReset).to.have.property('error'); + } + } + ); + }); + }); + }); +}; diff --git a/x-pack/test/functional/apps/transform/cloning.ts b/x-pack/test/functional/apps/transform/cloning.ts index ec6d3977841ce..382f1b5ba75ab 100644 --- a/x-pack/test/functional/apps/transform/cloning.ts +++ b/x-pack/test/functional/apps/transform/cloning.ts @@ -101,7 +101,6 @@ export default function ({ getService }: FtrProviderContext) { transformConfigWithRuntimeMapping.id, transformConfigWithRuntimeMapping ); - await transform.api.createAndRunTransform( transformConfigWithLatest.id, transformConfigWithLatest diff --git a/x-pack/test/functional/apps/transform/index.ts b/x-pack/test/functional/apps/transform/index.ts index cb90271bf885f..b716f5ecdc1b7 100644 --- a/x-pack/test/functional/apps/transform/index.ts +++ b/x-pack/test/functional/apps/transform/index.ts @@ -44,6 +44,7 @@ export default function ({ getService, loadTestFile }: FtrProviderContext) { loadTestFile(require.resolve('./editing')); loadTestFile(require.resolve('./feature_controls')); loadTestFile(require.resolve('./deleting')); + loadTestFile(require.resolve('./resetting')); loadTestFile(require.resolve('./starting')); }); } diff --git a/x-pack/test/functional/apps/transform/resetting.ts b/x-pack/test/functional/apps/transform/resetting.ts new file mode 100644 index 0000000000000..ea32c401f3551 --- /dev/null +++ b/x-pack/test/functional/apps/transform/resetting.ts @@ -0,0 +1,143 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { TRANSFORM_STATE } from '../../../../plugins/transform/common/constants'; + +import { FtrProviderContext } from '../../ftr_provider_context'; +import { getLatestTransformConfig, getPivotTransformConfig } from './index'; + +export default function ({ getService }: FtrProviderContext) { + const esArchiver = getService('esArchiver'); + const transform = getService('transform'); + + describe('resetting', function () { + const PREFIX = 'resetting'; + + const testDataList = [ + { + suiteTitle: 'batch transform with pivot configuration', + originalConfig: getPivotTransformConfig(PREFIX, false), + expected: { + messageText: 'reset transform.', + row: { + status: TRANSFORM_STATE.STOPPED, + type: 'pivot', + mode: 'batch', + progress: 100, + }, + }, + }, + { + suiteTitle: 'continuous transform with pivot configuration', + originalConfig: getPivotTransformConfig(PREFIX, true), + expected: { + messageText: 'reset transform.', + row: { + status: TRANSFORM_STATE.STOPPED, + type: 'pivot', + mode: 'continuous', + progress: undefined, + }, + }, + }, + { + suiteTitle: 'batch transform with latest configuration', + originalConfig: getLatestTransformConfig(PREFIX), + transformDescription: 'updated description', + transformDocsPerSecond: '1000', + transformFrequency: '10m', + expected: { + messageText: 'reset transform.', + row: { + status: TRANSFORM_STATE.STOPPED, + type: 'latest', + mode: 'batch', + progress: 100, + }, + }, + }, + ]; + + before(async () => { + await esArchiver.loadIfNeeded('x-pack/test/functional/es_archives/ml/ecommerce'); + await transform.testResources.createIndexPatternIfNeeded('ft_ecommerce', 'order_date'); + + for (const testData of testDataList) { + await transform.api.createAndRunTransform( + testData.originalConfig.id, + testData.originalConfig + ); + } + + await transform.testResources.setKibanaTimeZoneToUTC(); + await transform.securityUI.loginAsTransformPowerUser(); + }); + + after(async () => { + for (const testData of testDataList) { + await transform.testResources.deleteIndexPatternByTitle(testData.originalConfig.dest.index); + await transform.api.deleteIndices(testData.originalConfig.dest.index); + } + await transform.api.cleanTransformIndices(); + await transform.testResources.deleteIndexPatternByTitle('ft_ecommerce'); + }); + + for (const testData of testDataList) { + describe(`${testData.suiteTitle}`, function () { + it('reset transform', async () => { + await transform.testExecution.logTestStep('should load the home page'); + await transform.navigation.navigateTo(); + await transform.management.assertTransformListPageExists(); + + await transform.testExecution.logTestStep('should display the transforms table'); + await transform.management.assertTransformsTableExists(); + + if (testData.expected.row.mode === 'continuous') { + await transform.testExecution.logTestStep('should have the reset action disabled'); + await transform.table.assertTransformRowActionEnabled( + testData.originalConfig.id, + 'Reset', + false + ); + + await transform.testExecution.logTestStep('should stop the transform'); + await transform.table.clickTransformRowAction(testData.originalConfig.id, 'Stop'); + } + + await transform.testExecution.logTestStep('should display the stopped transform'); + await transform.table.assertTransformRowFields(testData.originalConfig.id, { + id: testData.originalConfig.id, + description: testData.originalConfig.description, + type: testData.expected.row.type, + status: testData.expected.row.status, + mode: testData.expected.row.mode, + progress: testData.expected.row.progress, + }); + + await transform.testExecution.logTestStep('should show the reset modal'); + await transform.table.assertTransformRowActionEnabled( + testData.originalConfig.id, + 'Reset', + true + ); + await transform.table.clickTransformRowAction(testData.originalConfig.id, 'Reset'); + await transform.table.assertTransformResetModalExists(); + + await transform.testExecution.logTestStep('should reset the transform'); + await transform.table.confirmResetTransform(); + + await transform.testExecution.logTestStep( + 'should display the messages tab and include a reset message' + ); + await transform.table.refreshTransformList(); + await transform.table.filterWithSearchString(testData.originalConfig.id, 1); + await transform.table.assertTransformExpandedRowMessages(testData.expected.messageText); + }); + }); + } + }); +} diff --git a/x-pack/test/functional/services/transform/transform_table.ts b/x-pack/test/functional/services/transform/transform_table.ts index 9e3ffcdfd8095..67b2c37438405 100644 --- a/x-pack/test/functional/services/transform/transform_table.ts +++ b/x-pack/test/functional/services/transform/transform_table.ts @@ -9,7 +9,7 @@ import expect from '@kbn/expect'; import { FtrProviderContext } from '../../ftr_provider_context'; -type TransformRowActionName = 'Clone' | 'Delete' | 'Edit' | 'Start' | 'Stop' | 'Discover'; +type TransformRowActionName = 'Clone' | 'Delete' | 'Discover' | 'Edit' | 'Reset' | 'Start' | 'Stop'; export function TransformTableProvider({ getService }: FtrProviderContext) { const find = getService('find'); @@ -303,6 +303,7 @@ export function TransformTableProvider({ getService }: FtrProviderContext) { await testSubjects.existOrFail('transformActionDelete'); await testSubjects.existOrFail('transformActionDiscover'); await testSubjects.existOrFail('transformActionEdit'); + await testSubjects.existOrFail('transformActionReset'); if (isTransformRunning) { await testSubjects.missingOrFail('transformActionStart'); @@ -363,6 +364,14 @@ export function TransformTableProvider({ getService }: FtrProviderContext) { await testSubjects.missingOrFail('transformDeleteModal', { timeout: 60 * 1000 }); } + public async assertTransformResetModalExists() { + await testSubjects.existOrFail('transformResetModal', { timeout: 60 * 1000 }); + } + + public async assertTransformResetModalNotExists() { + await testSubjects.missingOrFail('transformResetModal', { timeout: 60 * 1000 }); + } + public async assertTransformStartModalExists() { await testSubjects.existOrFail('transformStartModal', { timeout: 60 * 1000 }); } @@ -379,6 +388,14 @@ export function TransformTableProvider({ getService }: FtrProviderContext) { }); } + public async confirmResetTransform() { + await retry.tryForTime(30 * 1000, async () => { + await this.assertTransformResetModalExists(); + await testSubjects.click('transformResetModal > confirmModalConfirmButton'); + await this.assertTransformResetModalNotExists(); + }); + } + public async assertTransformRowNotExists(transformId: string) { await retry.tryForTime(30 * 1000, async () => { // If after deletion, and there's no transform left From 111b830735d9393000620d3d5f9131f48fabc0e2 Mon Sep 17 00:00:00 2001 From: Nathan Reese Date: Tue, 1 Feb 2022 05:12:22 -0700 Subject: [PATCH 03/73] [maps] allow feature editing with vector tile scaling (#123409) * [maps] allow feature editing with vector tile scaling * eslint Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- .../geojson_vector_layer.tsx | 35 ---------------- .../mvt_vector_layer/mvt_source_data.test.ts | 41 +++++++++++++++++++ .../mvt_vector_layer/mvt_source_data.ts | 7 +++- .../mvt_vector_layer/mvt_vector_layer.tsx | 1 + .../layers/vector_layer/vector_layer.tsx | 33 ++++++++++++++- 5 files changed, 79 insertions(+), 38 deletions(-) diff --git a/x-pack/plugins/maps/public/classes/layers/vector_layer/geojson_vector_layer/geojson_vector_layer.tsx b/x-pack/plugins/maps/public/classes/layers/vector_layer/geojson_vector_layer/geojson_vector_layer.tsx index e7fa87435cf09..ebcd4e23c5375 100644 --- a/x-pack/plugins/maps/public/classes/layers/vector_layer/geojson_vector_layer/geojson_vector_layer.tsx +++ b/x-pack/plugins/maps/public/classes/layers/vector_layer/geojson_vector_layer/geojson_vector_layer.tsx @@ -43,8 +43,6 @@ import { syncGeojsonSourceData } from './geojson_source_data'; import { JoinState, performInnerJoins } from './perform_inner_joins'; import { buildVectorRequestMeta } from '../../build_vector_request_meta'; -export const SUPPORTS_FEATURE_EDITING_REQUEST_ID = 'SUPPORTS_FEATURE_EDITING_REQUEST_ID'; - export class GeoJsonVectorLayer extends AbstractVectorLayer { static createDescriptor( options: Partial, @@ -65,12 +63,6 @@ export class GeoJsonVectorLayer extends AbstractVectorLayer { return layerDescriptor; } - supportsFeatureEditing(): boolean { - const dataRequest = this.getDataRequest(SUPPORTS_FEATURE_EDITING_REQUEST_ID); - const data = dataRequest?.getData() as { supportsFeatureEditing: boolean } | undefined; - return data ? data.supportsFeatureEditing : false; - } - async getBounds(syncContext: DataRequestContext) { const isStaticLayer = !this.getSource().isBoundsAware(); return isStaticLayer || this.hasJoins() @@ -380,33 +372,6 @@ export class GeoJsonVectorLayer extends AbstractVectorLayer { }); } - async _syncSupportsFeatureEditing({ - syncContext, - source, - }: { - syncContext: DataRequestContext; - source: IVectorSource; - }) { - if (syncContext.dataFilters.isReadOnly) { - return; - } - const { startLoading, stopLoading, onLoadError } = syncContext; - const dataRequestId = SUPPORTS_FEATURE_EDITING_REQUEST_ID; - const requestToken = Symbol(`layer-${this.getId()}-${dataRequestId}`); - const prevDataRequest = this.getDataRequest(dataRequestId); - if (prevDataRequest) { - return; - } - try { - startLoading(dataRequestId, requestToken); - const supportsFeatureEditing = await source.supportsFeatureEditing(); - stopLoading(dataRequestId, requestToken, { supportsFeatureEditing }); - } catch (error) { - onLoadError(dataRequestId, requestToken, error.message); - throw error; - } - } - _getSourceFeatureCollection() { const sourceDataRequest = this.getSourceDataRequest(); return sourceDataRequest ? (sourceDataRequest.getData() as FeatureCollection) : null; diff --git a/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_source_data.test.ts b/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_source_data.test.ts index e56884298a0b6..4b45adc8848bd 100644 --- a/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_source_data.test.ts +++ b/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_source_data.test.ts @@ -118,6 +118,47 @@ describe('syncMvtSourceData', () => { sinon.assert.notCalled(syncContext.stopLoading); }); + test('Should re-sync with forceRefreshDueToDrawing when there are no changes in source state or search state', async () => { + const syncContext = { + ...new MockSyncContext({ dataFilters: {} }), + forceRefreshDueToDrawing: true, + }; + const prevRequestMeta = { + ...syncContext.dataFilters, + applyGlobalQuery: true, + applyGlobalTime: true, + applyForceRefresh: true, + fieldNames: [], + sourceMeta: {}, + isForceRefresh: false, + }; + + await syncMvtSourceData({ + layerId: 'layer1', + prevDataRequest: { + getMeta: () => { + return prevRequestMeta; + }, + getData: () => { + return { + tileMinZoom: 4, + tileMaxZoom: 14, + tileSourceLayer: 'aggs', + tileUrl: 'https://example.com/{x}/{y}/{z}.pbf?token=12345', + refreshToken: '12345', + }; + }, + } as unknown as DataRequest, + requestMeta: { ...prevRequestMeta }, + source: mockSource, + syncContext, + }); + // @ts-expect-error + sinon.assert.calledOnce(syncContext.startLoading); + // @ts-expect-error + sinon.assert.calledOnce(syncContext.stopLoading); + }); + test('Should re-sync when there are changes to search state', async () => { const syncContext = new MockSyncContext({ dataFilters: {} }); const prevRequestMeta = { diff --git a/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_source_data.ts b/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_source_data.ts index 5d4008fc19220..f20ab0b5d200f 100644 --- a/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_source_data.ts +++ b/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_source_data.ts @@ -53,7 +53,8 @@ export async function syncMvtSourceData({ return true; }, }); - const canSkip = noChangesInSourceState && noChangesInSearchState; + const canSkip = + !syncContext.forceRefreshDueToDrawing && noChangesInSourceState && noChangesInSearchState; if (canSkip) { return; @@ -63,7 +64,9 @@ export async function syncMvtSourceData({ syncContext.startLoading(SOURCE_DATA_REQUEST_ID, requestToken, requestMeta); try { const refreshToken = - !prevData || (requestMeta.isForceRefresh && requestMeta.applyForceRefresh) + !prevData || + syncContext.forceRefreshDueToDrawing || + (requestMeta.isForceRefresh && requestMeta.applyForceRefresh) ? uuid() : prevData.refreshToken; diff --git a/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_vector_layer.tsx b/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_vector_layer.tsx index 796f37d4ce915..5947013dc39f1 100644 --- a/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_vector_layer.tsx +++ b/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_vector_layer.tsx @@ -189,6 +189,7 @@ export class MvtVectorLayer extends AbstractVectorLayer { } await this._syncSourceStyleMeta(syncContext, this.getSource(), this.getCurrentStyle()); await this._syncSourceFormatters(syncContext, this.getSource(), this.getCurrentStyle()); + await this._syncSupportsFeatureEditing({ syncContext, source: this.getSource() }); await syncMvtSourceData({ layerId: this.getId(), diff --git a/x-pack/plugins/maps/public/classes/layers/vector_layer/vector_layer.tsx b/x-pack/plugins/maps/public/classes/layers/vector_layer/vector_layer.tsx index 0384517bf9834..b8b90fdf75ff4 100644 --- a/x-pack/plugins/maps/public/classes/layers/vector_layer/vector_layer.tsx +++ b/x-pack/plugins/maps/public/classes/layers/vector_layer/vector_layer.tsx @@ -60,6 +60,8 @@ import { buildVectorRequestMeta } from '../build_vector_request_meta'; import { getJoinAggKey } from '../../../../common/get_agg_key'; import { syncBoundsData } from './bounds_data'; +const SUPPORTS_FEATURE_EDITING_REQUEST_ID = 'SUPPORTS_FEATURE_EDITING_REQUEST_ID'; + export function isVectorLayer(layer: ILayer) { return (layer as IVectorLayer).canShowTooltip !== undefined; } @@ -242,7 +244,9 @@ export class AbstractVectorLayer extends AbstractLayer implements IVectorLayer { } supportsFeatureEditing(): boolean { - return false; + const dataRequest = this.getDataRequest(SUPPORTS_FEATURE_EDITING_REQUEST_ID); + const data = dataRequest?.getData() as { supportsFeatureEditing: boolean } | undefined; + return data ? data.supportsFeatureEditing : false; } hasJoins() { @@ -522,6 +526,33 @@ export class AbstractVectorLayer extends AbstractLayer implements IVectorLayer { } } + async _syncSupportsFeatureEditing({ + syncContext, + source, + }: { + syncContext: DataRequestContext; + source: IVectorSource; + }) { + if (syncContext.dataFilters.isReadOnly) { + return; + } + const { startLoading, stopLoading, onLoadError } = syncContext; + const dataRequestId = SUPPORTS_FEATURE_EDITING_REQUEST_ID; + const requestToken = Symbol(`layer-${this.getId()}-${dataRequestId}`); + const prevDataRequest = this.getDataRequest(dataRequestId); + if (prevDataRequest) { + return; + } + try { + startLoading(dataRequestId, requestToken); + const supportsFeatureEditing = await source.supportsFeatureEditing(); + stopLoading(dataRequestId, requestToken, { supportsFeatureEditing }); + } catch (error) { + onLoadError(dataRequestId, requestToken, error.message); + throw error; + } + } + _setMbPointsProperties( mbMap: MbMap, mvtSourceLayer?: string, From d7bce1c95e91d5c5ad046097be6e6e4512149008 Mon Sep 17 00:00:00 2001 From: Nathan Reese Date: Tue, 1 Feb 2022 05:14:20 -0700 Subject: [PATCH 04/73] [maps] fix Unable to load layers from WMS capabilities for a specific URL (#123386) * [maps] fix Unable to load layers from WMS spec for a specific URL * eslint Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- .../maps/public/classes/sources/wms_source/wms_client.js | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/x-pack/plugins/maps/public/classes/sources/wms_source/wms_client.js b/x-pack/plugins/maps/public/classes/sources/wms_source/wms_client.js index d71c329ee7d3e..0cbcbcd7ab8fe 100644 --- a/x-pack/plugins/maps/public/classes/sources/wms_source/wms_client.js +++ b/x-pack/plugins/maps/public/classes/sources/wms_source/wms_client.js @@ -122,13 +122,17 @@ function reduceLayers(path, layers) { const updatedStyles = [...accumulatedCapabilities.styles]; if (_.has(layer, 'Style[0]')) { updatedStyles.push( - createOption(path, _.get(layer, 'Style[0].Title[0]'), _.get(layer, 'Style[0].Name[0]')) + createOption( + path, + _.get(layer, 'Style[0].Title[0]', ''), + _.get(layer, 'Style[0].Name[0]', '') + ) ); } return { layers: [ ...accumulatedCapabilities.layers, - createOption(path, layer.Title[0], layer.Name[0]), + createOption(path, _.get(layer, 'Title[0]', ''), _.get(layer, 'Name[0]', '')), ], styles: updatedStyles, }; From a201294b6cff3badb806b9ab7172dfd4765ff940 Mon Sep 17 00:00:00 2001 From: Josh Dover <1813008+joshdover@users.noreply.github.com> Date: Tue, 1 Feb 2022 12:18:16 +0000 Subject: [PATCH 05/73] Remove deployment URL from deployment details flyout (#124020) * Remove deployment URL from deployment details flyout * commit using @elastic.co Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- .../header/deployment_details.component.tsx | 22 +---------------- .../header/deployment_details.stories.tsx | 1 - .../components/header/deployment_details.tsx | 24 ++++--------------- 3 files changed, 5 insertions(+), 42 deletions(-) diff --git a/x-pack/plugins/fleet/public/applications/integrations/components/header/deployment_details.component.tsx b/x-pack/plugins/fleet/public/applications/integrations/components/header/deployment_details.component.tsx index 1fa673890fa82..aa43a6b336a7c 100644 --- a/x-pack/plugins/fleet/public/applications/integrations/components/header/deployment_details.component.tsx +++ b/x-pack/plugins/fleet/public/applications/integrations/components/header/deployment_details.component.tsx @@ -25,7 +25,6 @@ import { import { i18n } from '@kbn/i18n'; export interface Props { - endpointUrl: string; cloudId: string; managementUrl?: string; learnMoreUrl: string; @@ -35,7 +34,7 @@ const Description = styled(EuiText)` margin-bottom: ${({ theme }) => theme.eui.euiSizeL}; `; -export const DeploymentDetails = ({ endpointUrl, cloudId, learnMoreUrl, managementUrl }: Props) => { +export const DeploymentDetails = ({ cloudId, learnMoreUrl, managementUrl }: Props) => { const [isOpen, setIsOpen] = React.useState(false); const button = ( @@ -74,25 +73,6 @@ export const DeploymentDetails = ({ endpointUrl, cloudId, learnMoreUrl, manageme Elasticsearch information. - - - - - - - - {(copy) => ( - - )} - - - - diff --git a/x-pack/plugins/fleet/public/applications/integrations/components/header/deployment_details.stories.tsx b/x-pack/plugins/fleet/public/applications/integrations/components/header/deployment_details.stories.tsx index 445bf471c0fe9..5b311b3443e36 100644 --- a/x-pack/plugins/fleet/public/applications/integrations/components/header/deployment_details.stories.tsx +++ b/x-pack/plugins/fleet/public/applications/integrations/components/header/deployment_details.stories.tsx @@ -50,7 +50,6 @@ export const Component = (props: PureComponentProps) => { Component.args = { cloudId: 'cloud-id', - endpointUrl: 'https://endpoint-url', learnMoreUrl: 'https://learn-more-url', managementUrl: 'https://management-url', }; diff --git a/x-pack/plugins/fleet/public/applications/integrations/components/header/deployment_details.tsx b/x-pack/plugins/fleet/public/applications/integrations/components/header/deployment_details.tsx index 79175d241c29f..968d596a5f9d5 100644 --- a/x-pack/plugins/fleet/public/applications/integrations/components/header/deployment_details.tsx +++ b/x-pack/plugins/fleet/public/applications/integrations/components/header/deployment_details.tsx @@ -19,34 +19,18 @@ export const DeploymentDetails = () => { return null; } - const { isCloudEnabled, cloudId, cname } = cloud; + const { isCloudEnabled, cloudId } = cloud; - // If cloud isn't enabled, we don't have a cloudId or a cname, we can't display the flyout. - if (!isCloudEnabled || !cloudId || !cname) { + // If cloud isn't enabled or we don't have a cloudId we can't display the flyout. + if (!isCloudEnabled || !cloudId) { return null; } - // If the cname doesn't start with a known prefix, we can't display the flyout. - // TODO: dover - this is a short term solution, see https://github.com/elastic/kibana/pull/114287#issuecomment-940111026 - if ( - !( - cname.endsWith('elastic-cloud.com') || - cname.endsWith('found.io') || - cname.endsWith('found.no') || - cname.endsWith('foundit.no') - ) - ) { - return null; - } - - const cnameNormalized = cname.startsWith('.') ? cname.substring(1) : cname; - const endpointUrl = `https://${cloudId}.${cnameNormalized}`; - const managementUrl = share.url.locators .get('MANAGEMENT_APP_LOCATOR') ?.useUrl({ sectionId: 'security', appId: 'api_keys' }); const learnMoreUrl = docLinks.links.fleet.apiKeysLearnMore; - return ; + return ; }; From 7d9146c6b48d3e7843cc63399bcf037e339b3545 Mon Sep 17 00:00:00 2001 From: Jonathan Buttner <56361221+jonathan-buttner@users.noreply.github.com> Date: Tue, 1 Feb 2022 07:25:38 -0500 Subject: [PATCH 06/73] [Response Ops][Cases] Regenerating docs to remove sub cases references (#124179) * Regenerating typedocs * Updating readme since we don't need the option * Ignoring case docs filenames --- src/dev/precommit_hook/casing_check_config.js | 1 + x-pack/plugins/cases/README.md | 2 +- x-pack/plugins/cases/docs/README.md | 11 +- .../plugins/cases/docs/cases_client/.nojekyll | 1 + .../{cases_client_api.md => README.md} | 6 +- ...ient._internal_namespace.ActionExecutor.md | 153 ++ ...._internal_namespace.ActionTypeRegistry.md | 288 +++ .../client._internal_namespace.Actions.md | 144 ++ ...internal_namespace.ActionsAuthorization.md | 99 + ...lient._internal_namespace.ActionsClient.md | 432 ++++ ...client._internal_namespace.AlertService.md | 206 ++ ...ent._internal_namespace.AlertingActions.md | 68 + .../client._internal_namespace.ApiActions.md | 65 + .../client._internal_namespace.AppActions.md | 65 + ...t._internal_namespace.AttachmentService.md | 217 ++ ...lient._internal_namespace.Authorization.md | 241 ++ ...rnal_namespace.AuthorizationAuditLogger.md | 117 + .../client._internal_namespace.BasePath.md | 189 ++ ...ient._internal_namespace.BuilderFactory.md | 47 + ...internal_namespace.CaseConfigureService.md | 135 + ...nternal_namespace.CaseUserActionService.md | 304 +++ ...client._internal_namespace.CasesActions.md | 66 + ..._internal_namespace.CasesClientInternal.md | 59 + ...client._internal_namespace.CasesService.md | 470 ++++ ...rnal_namespace.ConnectorMappingsService.md | 93 + ...internal_namespace.ConnectorTokenClient.md | 162 ++ ...internal_namespace.ElasticsearchFeature.md | 122 + ...lient._internal_namespace.KibanaFeature.md | 268 ++ ...ient._internal_namespace.KibanaMigrator.md | 286 +++ ...lient._internal_namespace.KibanaRequest.md | 347 +++ ...client._internal_namespace.LicenseState.md | 215 ++ ...internal_namespace.RouteValidationError.md | 40 + ...ient._internal_namespace.RouteValidator.md | 272 ++ ...._internal_namespace.SavedObjectActions.md | 66 + ...ernal_namespace.SavedObjectTypeRegistry.md | 306 +++ ...._internal_namespace.SavedObjectsClient.md | 617 +++++ ...rnal_namespace.SavedObjectsErrorHelpers.md | 665 +++++ ...ternal_namespace.SavedObjectsRepository.md | 1082 ++++++++ ...client._internal_namespace.SpaceActions.md | 59 + .../client._internal_namespace.SubFeature.md | 97 + ...t._internal_namespace.TaskRunnerFactory.md | 114 + .../client._internal_namespace.UIActions.md | 66 + ...t._internal_namespace.UserActionBuilder.md | 251 ++ .../classes/client.casesclient.md | 152 +- ...nal_namespace.ActionExecutionSourceType.md | 32 + ...t._internal_namespace.AuthorizationMode.md | 32 + ...client._internal_namespace.CaseStatuses.md | 43 + .../client._internal_namespace.TaskStatus.md | 65 + .../client._internal_namespace.ViewMode.md | 54 + .../interfaces/attachments_add.addargs.md | 34 - ...ents_client._internal_namespace.AddArgs.md | 38 + ...lient._internal_namespace.DeleteAllArgs.md | 25 + ...s_client._internal_namespace.DeleteArgs.md | 38 + ...nts_client._internal_namespace.FindArgs.md | 54 + ...rnal_namespace.GetAllAlertsAttachToCase.md | 23 + ...s_client._internal_namespace.GetAllArgs.md | 25 + ...ents_client._internal_namespace.GetArgs.md | 36 + ...s_client._internal_namespace.UpdateArgs.md | 38 + ...attachments_client.attachmentssubclient.md | 114 +- .../attachments_delete.deleteallargs.md | 34 - .../attachments_delete.deleteargs.md | 45 - .../interfaces/attachments_get.findargs.md | 51 - ...ttachments_get.getallalertsattachtocase.md | 21 - .../interfaces/attachments_get.getallargs.md | 45 - .../interfaces/attachments_get.getargs.md | 32 - .../attachments_update.updateargs.md | 45 - .../interfaces/cases_client.casessubclient.md | 156 +- .../cases_get.casesbyalertidparams.md | 20 +- .../interfaces/cases_get.getparams.md | 27 +- .../interfaces/cases_push.pushparams.md | 18 +- .../client._internal_namespace.Action.md | 72 + ...nternal_namespace.ActionExecutionSource.md | 38 + ...nternal_namespace.ActionExecutorContext.md | 112 + ...client._internal_namespace.ActionResult.md | 90 + ...client._internal_namespace.ActionType-1.md | 120 + .../client._internal_namespace.ActionType.md | 76 + ...nal_namespace.ActionTypeExecutorOptions.md | 95 + ...rnal_namespace.ActionTypeExecutorResult.md | 82 + ...ternal_namespace.ActionTypeRegistryOpts.md | 76 + ...client._internal_namespace.ActionUpdate.md | 51 + ...namespace.ActionsConfigurationUtilities.md | 217 ++ ...nal_namespace.ActionsLicenseInformation.md | 43 + ...._internal_namespace.AggregationBuilder.md | 68 + .../client._internal_namespace.Alert.md | 43 + ...client._internal_namespace.AlertIdIndex.md | 32 + .../client._internal_namespace.AlertInfo.md | 34 + ...ient._internal_namespace.AlertsResponse.md | 21 + .../client._internal_namespace.AppCategory.md | 83 + ...._internal_namespace.AttachedToCaseArgs.md | 55 + .../client._internal_namespace.Attributes.md | 84 + .../client._internal_namespace.AuditEvent.md | 59 + .../client._internal_namespace.AuditLogger.md | 52 + ...t._internal_namespace.AuthFilterHelpers.md | 38 + ...t._internal_namespace.AuthenticatedUser.md | 170 ++ ...ternal_namespace.AuthenticationProvider.md | 34 + ..._internal_namespace.AuthorizationMode-1.md | 31 + ...nal_namespace.AuthorizationServiceSetup.md | 71 + ...t._internal_namespace.BeforeSaveContext.md | 21 + ...t._internal_namespace.BuilderParameters.md | 205 ++ ...._internal_namespace.BuilderReturnValue.md | 32 + ....BulkCreateAttachmentDeletionUserAction.md | 125 + ...ace.BulkCreateBulkUpdateCaseUserActions.md | 72 + ...espace.BulkCreateCaseDeletionUserAction.md | 61 + ...rnal_namespace.BulkUpdateAttachmentArgs.md | 42 + ...ent._internal_namespace.CancellableTask.md | 32 + ...client._internal_namespace.Capabilities.md | 63 + ...nt._internal_namespace.CaseCommentStats.md | 32 + ...ent._internal_namespace.CasesClientArgs.md | 160 ++ ...internal_namespace.CasesMapWithPageInfo.md | 54 + ...ent._internal_namespace.CheckPrivileges.md | 78 + ...ternal_namespace.CheckPrivilegesOptions.md | 27 + ...ternal_namespace.CheckPrivilegesPayload.md | 39 + ...ernal_namespace.CheckPrivilegesResponse.md | 52 + ...client._internal_namespace.ClientArgs-1.md | 55 + ...client._internal_namespace.ClientArgs-2.md | 31 + .../client._internal_namespace.ClientArgs.md | 33 + ...ent._internal_namespace.CommonArguments.md | 84 + ...internal_namespace.ConcreteTaskInstance.md | 291 +++ ...ient._internal_namespace.ConnectorToken.md | 82 + ...internal_namespace.ConstructorOptions-1.md | 60 + ...internal_namespace.ConstructorOptions-2.md | 43 + ...._internal_namespace.ConstructorOptions.md | 153 ++ ...amespace.CountActionsAttachedToCaseArgs.md | 72 + ...internal_namespace.CreateAttachmentArgs.md | 64 + ...internal_namespace.CreateAuditMsgParams.md | 43 + ...ent._internal_namespace.CreateOptions-1.md | 54 + ...lient._internal_namespace.CreateOptions.md | 21 + ...nt._internal_namespace.CreateUserAction.md | 38 + ...._internal_namespace.CreateUserActionES.md | 59 + ...ient._internal_namespace.DecoratedError.md | 27 + ...al_namespace.ElasticsearchFeatureConfig.md | 94 + ..._namespace.EmbeddableRegistryDefinition.md | 157 ++ ...l_namespace.EncryptedSavedObjectsClient.md | 39 + ...nt._internal_namespace.ExecuteOptions-1.md | 101 + ...ient._internal_namespace.ExecuteOptions.md | 104 + ...amespace.FeatureElasticsearchPrivileges.md | 106 + ...ernal_namespace.FeatureKibanaPrivileges.md | 246 ++ ...rnal_namespace.FeatureUsageServiceSetup.md | 34 + ...nt._internal_namespace.FindActionResult.md | 117 + ...internal_namespace.FindCaseCommentsArgs.md | 43 + ...nternal_namespace.FindCaseConfigureArgs.md | 42 + ...lient._internal_namespace.FindCasesArgs.md | 42 + ...nt._internal_namespace.FindCommentsArgs.md | 43 + ...nal_namespace.FindConnectorMappingsArgs.md | 42 + ..._internal_namespace.GetAllSpacesOptions.md | 44 + ...t._internal_namespace.GetAttachmentArgs.md | 42 + .../client._internal_namespace.GetCaseArgs.md | 42 + ...internal_namespace.GetCaseConfigureArgs.md | 42 + ...ernal_namespace.GetCaseIdsByAlertIdArgs.md | 53 + ...nternal_namespace.GetCaseUserActionArgs.md | 42 + ...client._internal_namespace.GetCasesArgs.md | 42 + ...nt._internal_namespace.GetReportersArgs.md | 32 + ...ient._internal_namespace.GetSpaceResult.md | 176 ++ .../client._internal_namespace.GetTagsArgs.md | 32 + ...namespace.GetUserActionItemByDifference.md | 162 ++ .../client._internal_namespace.GetUserArgs.md | 21 + ...client._internal_namespace.IEventLogger.md | 73 + ...lient._internal_namespace.IKibanaSocket.md | 150 ++ .../client._internal_namespace.ILicense.md | 236 ++ ...amespace.ISavedObjectsPointInTimeFinder.md | 61 + ...internal_namespace.IScopedClusterClient.md | 43 + ...lient._internal_namespace.ISpacesClient.md | 151 ++ ...lient._internal_namespace.IUsageCounter.md | 37 + ...ternal_namespace.IncrementCounterParams.md | 51 + ...client._internal_namespace.IndexMapping.md | 45 + ...nt._internal_namespace.IndexMappingMeta.md | 27 + ...nt._internal_namespace.IntervalSchedule.md | 23 + ..._internal_namespace.KibanaFeatureConfig.md | 257 ++ ...nternal_namespace.KibanaMigratorOptions.md | 76 + ...internal_namespace.KibanaMigratorStatus.md | 43 + ..._internal_namespace.KibanaRequestEvents.md | 43 + ...internal_namespace.LegacyUrlAliasTarget.md | 51 + ...client._internal_namespace.LicenseCheck.md | 36 + ...ient._internal_namespace.LicenseFeature.md | 32 + ...internal_namespace.LicensingPluginSetup.md | 60 + .../client._internal_namespace.Middleware.md | 43 + ...nt._internal_namespace.OperationDetails.md | 91 + .../client._internal_namespace.OwnerEntity.md | 35 + .../client._internal_namespace.PatchCase.md | 54 + ...ternal_namespace.PatchCaseConfigureArgs.md | 64 + ...ient._internal_namespace.PatchCasesArgs.md | 42 + ...nt._internal_namespace.PersistableState.md | 133 + ..._internal_namespace.PluginStartContract.md | 40 + ...client._internal_namespace.PostCaseArgs.md | 53 + ...nternal_namespace.PostCaseConfigureArgs.md | 53 + ...ternal_namespace.PostCaseUserActionArgs.md | 42 + ...nal_namespace.PostConnectorMappingsArgs.md | 60 + ..._internal_namespace.PreConfiguredAction.md | 124 + ...lient._internal_namespace.ProxySettings.md | 65 + ...lient._internal_namespace.PublicLicense.md | 80 + ...t._internal_namespace.PublicLicenseJSON.md | 46 + .../client._internal_namespace.PushedArgs.md | 40 + ...client._internal_namespace.Referencable.md | 21 + ...ernal_namespace.ReservedKibanaPrivilege.md | 32 + ...nt._internal_namespace.ResponseSettings.md | 32 + ...._internal_namespace.RouteConfigOptions.md | 100 + ...ternal_namespace.RouteConfigOptionsBody.md | 89 + ..._namespace.RouteValidationResultFactory.md | 71 + ...internal_namespace.RouteValidatorConfig.md | 60 + ...nternal_namespace.RouteValidatorOptions.md | 33 + .../client._internal_namespace.RunContext.md | 25 + ...client._internal_namespace.RunNowResult.md | 32 + .../client._internal_namespace.SSLSettings.md | 21 + .../client._internal_namespace.SavedObject.md | 167 ++ ...nternal_namespace.SavedObjectAttributes.md | 20 + ...ient._internal_namespace.SavedObjectDoc.md | 128 + ...nt._internal_namespace.SavedObjectError.md | 54 + ...l_namespace.SavedObjectMigrationContext.md | 64 + ...ernal_namespace.SavedObjectMigrationMap.md | 23 + ...internal_namespace.SavedObjectReference.md | 45 + ...mespace.SavedObjectReferenceWithContext.md | 91 + ...ernal_namespace.SavedObjectsBaseOptions.md | 47 + ..._namespace.SavedObjectsBulkCreateObject.md | 136 + ...nal_namespace.SavedObjectsBulkGetObject.md | 65 + ...namespace.SavedObjectsBulkResolveObject.md | 32 + ...mespace.SavedObjectsBulkResolveResponse.md | 27 + ...rnal_namespace.SavedObjectsBulkResponse.md | 27 + ..._namespace.SavedObjectsBulkUpdateObject.md | 111 + ...namespace.SavedObjectsBulkUpdateOptions.md | 46 + ...amespace.SavedObjectsBulkUpdateResponse.md | 27 + ...espace.SavedObjectsCheckConflictsObject.md | 32 + ...pace.SavedObjectsCheckConflictsResponse.md | 21 + ...ce.SavedObjectsClosePointInTimeResponse.md | 37 + ...tsCollectMultiNamespaceReferencesObject.md | 38 + ...sCollectMultiNamespaceReferencesOptions.md | 48 + ...CollectMultiNamespaceReferencesResponse.md | 23 + ...nal_namespace.SavedObjectsCreateOptions.md | 162 ++ ...ectsCreatePointInTimeFinderDependencies.md | 21 + ...ce.SavedObjectsDeleteByNamespaceOptions.md | 46 + ...nal_namespace.SavedObjectsDeleteOptions.md | 59 + ...pace.SavedObjectsExportTransformContext.md | 26 + ...ernal_namespace.SavedObjectsFindOptions.md | 270 ++ ...espace.SavedObjectsFindOptionsReference.md | 32 + ...rnal_namespace.SavedObjectsFindResponse.md | 88 + ...ternal_namespace.SavedObjectsFindResult.md | 262 ++ ...SavedObjectsImportActionRequiredWarning.md | 65 + ..._namespace.SavedObjectsImportHookResult.md | 25 + ...mespace.SavedObjectsImportSimpleWarning.md | 36 + ...space.SavedObjectsIncrementCounterField.md | 36 + ...ace.SavedObjectsIncrementCounterOptions.md | 93 + ...namespace.SavedObjectsMappingProperties.md | 11 + ...l_namespace.SavedObjectsMigrationLogger.md | 124 + ..._namespace.SavedObjectsMigrationVersion.md | 21 + ...pace.SavedObjectsOpenPointInTimeOptions.md | 54 + ...ace.SavedObjectsOpenPointInTimeResponse.md | 23 + ...nternal_namespace.SavedObjectsPitParams.md | 32 + ...e.SavedObjectsRemoveReferencesToOptions.md | 46 + ....SavedObjectsRemoveReferencesToResponse.md | 46 + ...l_namespace.SavedObjectsResolveResponse.md | 61 + ...nt._internal_namespace.SavedObjectsType.md | 212 ++ ...ce.SavedObjectsTypeManagementDefinition.md | 299 +++ ...space.SavedObjectsTypeMappingDefinition.md | 62 + ...e.SavedObjectsUpdateObjectsSpacesObject.md | 68 + ....SavedObjectsUpdateObjectsSpacesOptions.md | 48 + ...SavedObjectsUpdateObjectsSpacesResponse.md | 23 + ...bjectsUpdateObjectsSpacesResponseObject.md | 64 + ...nal_namespace.SavedObjectsUpdateOptions.md | 91 + ...al_namespace.SavedObjectsUpdateResponse.md | 199 ++ ...nal_namespace.SavedObjectsValidationMap.md | 34 + .../client._internal_namespace.Services.md | 43 + .../client._internal_namespace.Space.md | 131 + ...._internal_namespace.SpacesServiceStart.md | 150 ++ ...nt._internal_namespace.SubFeatureConfig.md | 38 + ...nal_namespace.SubFeaturePrivilegeConfig.md | 334 +++ ...amespace.SubFeaturePrivilegeGroupConfig.md | 43 + .../client._internal_namespace.TaskInfo.md | 32 + ...client._internal_namespace.TaskInstance.md | 199 ++ ...rnal_namespace.TaskManagerSetupContract.md | 70 + ...ternal_namespace.TaskRegisterDefinition.md | 130 + ...t._internal_namespace.TaskRunnerContext.md | 89 + ..._namespace.TranslatedUpdateAlertRequest.md | 43 + ...._internal_namespace.UpdateAlertRequest.md | 45 + .../client._internal_namespace.UpdateArgs.md | 43 + ...l_namespace.UpdateConnectorMappingsArgs.md | 64 + ...ent._internal_namespace.UpdateOptions-1.md | 54 + ...lient._internal_namespace.UpdateOptions.md | 32 + .../client._internal_namespace.User.md | 90 + .../client._internal_namespace.UserRealm.md | 32 + ...lient._internal_namespace.ValidatorType.md | 37 + .../client._internal_namespace.Verbs.md | 45 + ...._internal_namespace.CreateMappingsArgs.md | 42 + ...client._internal_namespace.MappingsArgs.md | 29 + ...._internal_namespace.UpdateMappingsArgs.md | 42 + .../configure_client.configuresubclient.md | 60 +- .../metrics_client.MetricsSubClient.md | 33 + ...t._internal_namespace.CaseMetricsParams.md | 36 + .../interfaces/stats_client.statssubclient.md | 18 +- .../sub_cases_client.subcasesclient.md | 89 - ...typedoc_interfaces.ICaseResolveResponse.md | 49 + ...typedoc_interfaces.iallcommentsresponse.md | 6 +- .../typedoc_interfaces.icasepostrequest.md | 63 +- .../typedoc_interfaces.icaseresponse.md | 189 +- ...typedoc_interfaces.icasesconfigurepatch.md | 30 +- ...pedoc_interfaces.icasesconfigurerequest.md | 30 +- ...edoc_interfaces.icasesconfigureresponse.md | 100 +- .../typedoc_interfaces.icasesfindrequest.md | 109 +- .../typedoc_interfaces.icasesfindresponse.md | 62 +- .../typedoc_interfaces.icasespatchrequest.md | 14 +- .../typedoc_interfaces.icasesresponse.md | 6 +- ...doc_interfaces.icaseuseractionsresponse.md | 6 +- .../typedoc_interfaces.icommentsresponse.md | 38 +- .../typedoc_interfaces.isubcaseresponse.md | 133 - ...ypedoc_interfaces.isubcasesfindresponse.md | 79 - .../typedoc_interfaces.isubcasesresponse.md | 11 - .../user_actions_client.useractionget.md | 19 +- ...ser_actions_client.useractionssubclient.md | 16 +- .../cases_client/modules/attachments_add.md | 9 - .../attachments_client._internal_namespace.md | 18 + .../modules/attachments_client.md | 8 +- .../modules/attachments_delete.md | 10 - .../cases_client/modules/attachments_get.md | 12 - .../modules/attachments_update.md | 9 - .../docs/cases_client/modules/cases_client.md | 4 +- .../modules/cases_get._internal_namespace.md | 35 + .../docs/cases_client/modules/cases_get.md | 66 +- .../docs/cases_client/modules/cases_push.md | 4 +- .../modules/client._internal_namespace.md | 2213 +++++++++++++++++ .../cases/docs/cases_client/modules/client.md | 8 +- .../configure_client._internal_namespace.md | 13 + .../cases_client/modules/configure_client.md | 32 +- .../metrics_client._internal_namespace.md | 11 + .../cases_client/modules/metrics_client.md | 13 + .../docs/cases_client/modules/stats_client.md | 4 +- .../cases_client/modules/sub_cases_client.md | 9 - .../typedoc_interfaces._internal_namespace.md | 277 +++ .../modules/typedoc_interfaces.md | 34 +- .../modules/user_actions_client.md | 6 +- .../cases/docs/cases_client_typedoc.json | 12 +- 328 files changed, 27750 insertions(+), 1237 deletions(-) create mode 100644 x-pack/plugins/cases/docs/cases_client/.nojekyll rename x-pack/plugins/cases/docs/cases_client/{cases_client_api.md => README.md} (66%) create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionExecutor.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionTypeRegistry.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.Actions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionsAuthorization.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionsClient.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AlertService.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AlertingActions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ApiActions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AppActions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AttachmentService.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.Authorization.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AuthorizationAuditLogger.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.BasePath.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.BuilderFactory.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CaseConfigureService.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CaseUserActionService.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesActions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesClientInternal.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesService.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ConnectorMappingsService.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ConnectorTokenClient.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ElasticsearchFeature.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaFeature.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaMigrator.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaRequest.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.LicenseState.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.RouteValidationError.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.RouteValidator.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectActions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectTypeRegistry.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsClient.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsErrorHelpers.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsRepository.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SpaceActions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SubFeature.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.TaskRunnerFactory.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.UIActions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.UserActionBuilder.md create mode 100644 x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.ActionExecutionSourceType.md create mode 100644 x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.AuthorizationMode.md create mode 100644 x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.CaseStatuses.md create mode 100644 x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.TaskStatus.md create mode 100644 x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.ViewMode.md delete mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/attachments_add.addargs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.AddArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.DeleteAllArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.DeleteArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.FindArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetAllAlertsAttachToCase.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetAllArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.UpdateArgs.md delete mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/attachments_delete.deleteallargs.md delete mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/attachments_delete.deleteargs.md delete mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.findargs.md delete mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.getallalertsattachtocase.md delete mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.getallargs.md delete mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.getargs.md delete mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/attachments_update.updateargs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Action.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionExecutionSource.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionExecutorContext.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionResult.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionType-1.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionType.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeExecutorOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeExecutorResult.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeRegistryOpts.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionUpdate.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionsConfigurationUtilities.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionsLicenseInformation.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AggregationBuilder.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Alert.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertIdIndex.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertInfo.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertsResponse.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AppCategory.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AttachedToCaseArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Attributes.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuditEvent.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuditLogger.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthFilterHelpers.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthenticatedUser.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthenticationProvider.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthorizationMode-1.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthorizationServiceSetup.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BeforeSaveContext.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BuilderParameters.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BuilderReturnValue.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateCaseDeletionUserAction.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkUpdateAttachmentArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CancellableTask.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Capabilities.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CaseCommentStats.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CasesClientArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CasesMapWithPageInfo.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivileges.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesPayload.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesResponse.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs-1.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs-2.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CommonArguments.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConcreteTaskInstance.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConnectorToken.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions-1.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions-2.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CountActionsAttachedToCaseArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateAttachmentArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateAuditMsgParams.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateOptions-1.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateUserAction.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateUserActionES.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.DecoratedError.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ElasticsearchFeatureConfig.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.EmbeddableRegistryDefinition.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.EncryptedSavedObjectsClient.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ExecuteOptions-1.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ExecuteOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureElasticsearchPrivileges.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureKibanaPrivileges.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureUsageServiceSetup.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindActionResult.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCaseCommentsArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCaseConfigureArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCasesArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCommentsArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindConnectorMappingsArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetAllSpacesOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetAttachmentArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseConfigureArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseIdsByAlertIdArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseUserActionArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCasesArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetReportersArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetSpaceResult.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetTagsArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetUserActionItemByDifference.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetUserArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IEventLogger.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IKibanaSocket.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ILicense.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IScopedClusterClient.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ISpacesClient.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IUsageCounter.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IncrementCounterParams.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IndexMapping.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IndexMappingMeta.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IntervalSchedule.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaFeatureConfig.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaMigratorOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaMigratorStatus.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaRequestEvents.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LegacyUrlAliasTarget.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicenseCheck.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicenseFeature.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicensingPluginSetup.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Middleware.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.OperationDetails.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.OwnerEntity.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCase.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCaseConfigureArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCasesArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PersistableState.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PluginStartContract.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseConfigureArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseUserActionArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostConnectorMappingsArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PreConfiguredAction.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ProxySettings.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PublicLicense.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PublicLicenseJSON.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PushedArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Referencable.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ReservedKibanaPrivilege.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ResponseSettings.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteConfigOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteConfigOptionsBody.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidationResultFactory.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidatorConfig.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidatorOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RunContext.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RunNowResult.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SSLSettings.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObject.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectAttributes.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectDoc.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectError.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectMigrationContext.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectMigrationMap.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectReference.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectReferenceWithContext.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBaseOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkCreateObject.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkGetObject.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResolveObject.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResolveResponse.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResponse.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateObject.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCheckConflictsObject.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCheckConflictsResponse.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsClosePointInTimeResponse.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesObject.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesResponse.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCreateOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCreatePointInTimeFinderDependencies.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsDeleteByNamespaceOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsDeleteOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsExportTransformContext.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindOptionsReference.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindResponse.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindResult.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportActionRequiredWarning.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportHookResult.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportSimpleWarning.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsIncrementCounterField.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsIncrementCounterOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMappingProperties.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMigrationLogger.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMigrationVersion.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeResponse.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsPitParams.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsResolveResponse.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsType.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsTypeManagementDefinition.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsTypeMappingDefinition.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponse.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponseObject.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsValidationMap.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Services.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Space.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SpacesServiceStart.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeatureConfig.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeaturePrivilegeConfig.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeaturePrivilegeGroupConfig.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskInfo.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskInstance.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskManagerSetupContract.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskRegisterDefinition.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskRunnerContext.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TranslatedUpdateAlertRequest.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateAlertRequest.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateConnectorMappingsArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateOptions-1.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateOptions.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.User.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UserRealm.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ValidatorType.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Verbs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.CreateMappingsArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.MappingsArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.UpdateMappingsArgs.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/metrics_client.MetricsSubClient.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/metrics_client._internal_namespace.CaseMetricsParams.md delete mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/sub_cases_client.subcasesclient.md create mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.ICaseResolveResponse.md delete mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.isubcaseresponse.md delete mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.isubcasesfindresponse.md delete mode 100644 x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.isubcasesresponse.md delete mode 100644 x-pack/plugins/cases/docs/cases_client/modules/attachments_add.md create mode 100644 x-pack/plugins/cases/docs/cases_client/modules/attachments_client._internal_namespace.md delete mode 100644 x-pack/plugins/cases/docs/cases_client/modules/attachments_delete.md delete mode 100644 x-pack/plugins/cases/docs/cases_client/modules/attachments_get.md delete mode 100644 x-pack/plugins/cases/docs/cases_client/modules/attachments_update.md create mode 100644 x-pack/plugins/cases/docs/cases_client/modules/cases_get._internal_namespace.md create mode 100644 x-pack/plugins/cases/docs/cases_client/modules/client._internal_namespace.md create mode 100644 x-pack/plugins/cases/docs/cases_client/modules/configure_client._internal_namespace.md create mode 100644 x-pack/plugins/cases/docs/cases_client/modules/metrics_client._internal_namespace.md create mode 100644 x-pack/plugins/cases/docs/cases_client/modules/metrics_client.md delete mode 100644 x-pack/plugins/cases/docs/cases_client/modules/sub_cases_client.md create mode 100644 x-pack/plugins/cases/docs/cases_client/modules/typedoc_interfaces._internal_namespace.md diff --git a/src/dev/precommit_hook/casing_check_config.js b/src/dev/precommit_hook/casing_check_config.js index 3eba9ffa4e7ad..e60eb936bf578 100644 --- a/src/dev/precommit_hook/casing_check_config.js +++ b/src/dev/precommit_hook/casing_check_config.js @@ -26,6 +26,7 @@ export const IGNORE_FILE_GLOBS = [ '**/{Dockerfile,docker-compose.yml}', 'x-pack/plugins/canvas/tasks/**/*', 'x-pack/plugins/canvas/canvas_plugin_src/**/*', + 'x-pack/plugins/cases/docs/**/*', 'x-pack/plugins/monitoring/public/lib/jquery_flot/**/*', '**/.*', '**/__mocks__/**/*', diff --git a/x-pack/plugins/cases/README.md b/x-pack/plugins/cases/README.md index e43d3c8f47087..86e81d78f69fd 100644 --- a/x-pack/plugins/cases/README.md +++ b/x-pack/plugins/cases/README.md @@ -154,4 +154,4 @@ UI component: [all-cases-modal-img]: images/all_cases_selector_modal.png [recent-cases-img]: images/recent_cases.png [case-view-img]: images/case_view.png -[cases-client-api-docs]: docs/cases_client/cases_client_api.md +[cases-client-api-docs]: docs/cases_client/README.md diff --git a/x-pack/plugins/cases/docs/README.md b/x-pack/plugins/cases/docs/README.md index 16e9311958763..03f089280bc57 100644 --- a/x-pack/plugins/cases/docs/README.md +++ b/x-pack/plugins/cases/docs/README.md @@ -7,19 +7,24 @@ or parameters are added. ## TypeDoc Info See more info at: -and: for the markdown plugin +markdown plugin: +missing exports plugin: ## Install dependencies +Ensure that your global typescript version is the same as kibana's + +You can run `npx tsc --version` to find the global compiler version and then check the version under `node_modules/typescript/lib`. + ```bash -yarn global add typedoc typedoc-plugin-markdown +yarn global add typedoc typedoc-plugin-markdown typedoc-plugin-missing-exports ``` ## Generate the docs ```bash cd x-pack/plugins/cases/docs -npx typedoc --gitRemote upstream --options cases_client_typedoc.json +npx typedoc --options cases_client_typedoc.json ``` After running the above commands the files in the `server` directory will be updated to match the new tsdocs. diff --git a/x-pack/plugins/cases/docs/cases_client/.nojekyll b/x-pack/plugins/cases/docs/cases_client/.nojekyll new file mode 100644 index 0000000000000..e2ac6616addc2 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/x-pack/plugins/cases/docs/cases_client/cases_client_api.md b/x-pack/plugins/cases/docs/cases_client/README.md similarity index 66% rename from x-pack/plugins/cases/docs/cases_client/cases_client_api.md rename to x-pack/plugins/cases/docs/cases_client/README.md index d7e75af3142e6..c3fa291458cca 100644 --- a/x-pack/plugins/cases/docs/cases_client/cases_client_api.md +++ b/x-pack/plugins/cases/docs/cases_client/README.md @@ -6,17 +6,13 @@ Cases Client API Interface ### Modules -- [attachments/add](modules/attachments_add.md) - [attachments/client](modules/attachments_client.md) -- [attachments/delete](modules/attachments_delete.md) -- [attachments/get](modules/attachments_get.md) -- [attachments/update](modules/attachments_update.md) - [cases/client](modules/cases_client.md) - [cases/get](modules/cases_get.md) - [cases/push](modules/cases_push.md) - [client](modules/client.md) - [configure/client](modules/configure_client.md) +- [metrics/client](modules/metrics_client.md) - [stats/client](modules/stats_client.md) -- [sub\_cases/client](modules/sub_cases_client.md) - [typedoc\_interfaces](modules/typedoc_interfaces.md) - [user\_actions/client](modules/user_actions_client.md) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionExecutor.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionExecutor.md new file mode 100644 index 0000000000000..720db77a77e7e --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionExecutor.md @@ -0,0 +1,153 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionExecutor + +# Class: ActionExecutor + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionExecutor + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.ActionExecutor.md#constructor) + +### Properties + +- [actionExecutorContext](client._internal_namespace.ActionExecutor.md#actionexecutorcontext) +- [actionInfo](client._internal_namespace.ActionExecutor.md#actioninfo) +- [isESOCanEncrypt](client._internal_namespace.ActionExecutor.md#isesocanencrypt) +- [isInitialized](client._internal_namespace.ActionExecutor.md#isinitialized) + +### Methods + +- [execute](client._internal_namespace.ActionExecutor.md#execute) +- [initialize](client._internal_namespace.ActionExecutor.md#initialize) +- [logCancellation](client._internal_namespace.ActionExecutor.md#logcancellation) + +## Constructors + +### constructor + +• **new ActionExecutor**(`__namedParameters`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Object` | +| `__namedParameters.isESOCanEncrypt` | `boolean` | + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:40 + +## Properties + +### actionExecutorContext + +• `Private` `Optional` **actionExecutorContext**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:37 + +___ + +### actionInfo + +• `Private` **actionInfo**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:39 + +___ + +### isESOCanEncrypt + +• `Private` `Readonly` **isESOCanEncrypt**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:38 + +___ + +### isInitialized + +• `Private` **isInitialized**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:36 + +## Methods + +### execute + +▸ **execute**(`__namedParameters`): `Promise`<[`ActionTypeExecutorResult`](../interfaces/client._internal_namespace.ActionTypeExecutorResult.md)<`unknown`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`ExecuteOptions`](../interfaces/client._internal_namespace.ExecuteOptions.md)<`unknown`\> | + +#### Returns + +`Promise`<[`ActionTypeExecutorResult`](../interfaces/client._internal_namespace.ActionTypeExecutorResult.md)<`unknown`\>\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:44 + +___ + +### initialize + +▸ **initialize**(`actionExecutorContext`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `actionExecutorContext` | [`ActionExecutorContext`](../interfaces/client._internal_namespace.ActionExecutorContext.md) | + +#### Returns + +`void` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:43 + +___ + +### logCancellation + +▸ **logCancellation**<`Source`\>(`__namedParameters`): `Promise`<`void`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Source` | `unknown` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Object` | +| `__namedParameters.actionId` | `string` | +| `__namedParameters.executionId?` | `string` | +| `__namedParameters.relatedSavedObjects` | `Readonly`<{ `namespace?`: `string` ; `typeId?`: `string` } & { `id`: `string` ; `type`: `string` }\>[] | +| `__namedParameters.request` | [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | +| `__namedParameters.source?` | [`ActionExecutionSource`](../interfaces/client._internal_namespace.ActionExecutionSource.md)<`Source`\> | +| `__namedParameters.taskInfo?` | [`TaskInfo`](../interfaces/client._internal_namespace.TaskInfo.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:45 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionTypeRegistry.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionTypeRegistry.md new file mode 100644 index 0000000000000..b801bdf26a158 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionTypeRegistry.md @@ -0,0 +1,288 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionTypeRegistry + +# Class: ActionTypeRegistry + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionTypeRegistry + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.ActionTypeRegistry.md#constructor) + +### Properties + +- [actionTypes](client._internal_namespace.ActionTypeRegistry.md#actiontypes) +- [actionsConfigUtils](client._internal_namespace.ActionTypeRegistry.md#actionsconfigutils) +- [licenseState](client._internal_namespace.ActionTypeRegistry.md#licensestate) +- [licensing](client._internal_namespace.ActionTypeRegistry.md#licensing) +- [preconfiguredActions](client._internal_namespace.ActionTypeRegistry.md#preconfiguredactions) +- [taskManager](client._internal_namespace.ActionTypeRegistry.md#taskmanager) +- [taskRunnerFactory](client._internal_namespace.ActionTypeRegistry.md#taskrunnerfactory) + +### Methods + +- [ensureActionTypeEnabled](client._internal_namespace.ActionTypeRegistry.md#ensureactiontypeenabled) +- [get](client._internal_namespace.ActionTypeRegistry.md#get) +- [has](client._internal_namespace.ActionTypeRegistry.md#has) +- [isActionExecutable](client._internal_namespace.ActionTypeRegistry.md#isactionexecutable) +- [isActionTypeEnabled](client._internal_namespace.ActionTypeRegistry.md#isactiontypeenabled) +- [list](client._internal_namespace.ActionTypeRegistry.md#list) +- [register](client._internal_namespace.ActionTypeRegistry.md#register) + +## Constructors + +### constructor + +• **new ActionTypeRegistry**(`constructorParams`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructorParams` | [`ActionTypeRegistryOpts`](../interfaces/client._internal_namespace.ActionTypeRegistryOpts.md) | + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:23 + +## Properties + +### actionTypes + +• `Private` `Readonly` **actionTypes**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:17 + +___ + +### actionsConfigUtils + +• `Private` `Readonly` **actionsConfigUtils**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:19 + +___ + +### licenseState + +• `Private` `Readonly` **licenseState**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:20 + +___ + +### licensing + +• `Private` `Readonly` **licensing**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:22 + +___ + +### preconfiguredActions + +• `Private` `Readonly` **preconfiguredActions**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:21 + +___ + +### taskManager + +• `Private` `Readonly` **taskManager**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:16 + +___ + +### taskRunnerFactory + +• `Private` `Readonly` **taskRunnerFactory**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:18 + +## Methods + +### ensureActionTypeEnabled + +▸ **ensureActionTypeEnabled**(`id`): `void` + +Throws error if action type is not enabled. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | + +#### Returns + +`void` + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:31 + +___ + +### get + +▸ **get**<`Config`, `Secrets`, `Params`, `ExecutorResultData`\>(`id`): [`ActionType`](../interfaces/client._internal_namespace.ActionType-1.md)<`Config`, `Secrets`, `Params`, `ExecutorResultData`\> + +Returns an action type, throws if not registered + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | extends [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) = [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) | +| `Secrets` | extends [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets) = [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets) | +| `Params` | extends [`ActionTypeParams`](../modules/client._internal_namespace.md#actiontypeparams) = [`ActionTypeParams`](../modules/client._internal_namespace.md#actiontypeparams) | +| `ExecutorResultData` | `void` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | + +#### Returns + +[`ActionType`](../interfaces/client._internal_namespace.ActionType-1.md)<`Config`, `Secrets`, `Params`, `ExecutorResultData`\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:51 + +___ + +### has + +▸ **has**(`id`): `boolean` + +Returns if the action type registry has the given action type registered + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:27 + +___ + +### isActionExecutable + +▸ **isActionExecutable**(`actionId`, `actionTypeId`, `options?`): `boolean` + +Returns true if action type is enabled or it is a preconfigured action type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `actionId` | `string` | +| `actionTypeId` | `string` | +| `options?` | `Object` | +| `options.notifyUsage` | `boolean` | + +#### Returns + +`boolean` + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:41 + +___ + +### isActionTypeEnabled + +▸ **isActionTypeEnabled**(`id`, `options?`): `boolean` + +Returns true if action type is enabled in the config and a valid license is used. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `options?` | `Object` | +| `options.notifyUsage` | `boolean` | + +#### Returns + +`boolean` + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:35 + +___ + +### list + +▸ **list**(): [`ActionType`](../interfaces/client._internal_namespace.ActionType.md)[] + +Returns a list of registered action types [{ id, name, enabled }] + +#### Returns + +[`ActionType`](../interfaces/client._internal_namespace.ActionType.md)[] + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:55 + +___ + +### register + +▸ **register**<`Config`, `Secrets`, `Params`, `ExecutorResultData`\>(`actionType`): `void` + +Registers an action type to the action type registry + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | extends [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) = [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) | +| `Secrets` | extends [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets) = [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets) | +| `Params` | extends [`ActionTypeParams`](../modules/client._internal_namespace.md#actiontypeparams) = [`ActionTypeParams`](../modules/client._internal_namespace.md#actiontypeparams) | +| `ExecutorResultData` | `void` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `actionType` | [`ActionType`](../interfaces/client._internal_namespace.ActionType-1.md)<`Config`, `Secrets`, `Params`, `ExecutorResultData`\> | + +#### Returns + +`void` + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:47 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.Actions.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.Actions.md new file mode 100644 index 0000000000000..c05dbe40c3657 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.Actions.md @@ -0,0 +1,144 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Actions + +# Class: Actions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Actions + +Actions are used to create the "actions" that are associated with Elasticsearch's +application privileges, and are used to perform the authorization checks implemented +by the various `checkPrivilegesWithRequest` derivatives. + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.Actions.md#constructor) + +### Properties + +- [alerting](client._internal_namespace.Actions.md#alerting) +- [api](client._internal_namespace.Actions.md#api) +- [app](client._internal_namespace.Actions.md#app) +- [cases](client._internal_namespace.Actions.md#cases) +- [login](client._internal_namespace.Actions.md#login) +- [savedObject](client._internal_namespace.Actions.md#savedobject) +- [space](client._internal_namespace.Actions.md#space) +- [ui](client._internal_namespace.Actions.md#ui) +- [version](client._internal_namespace.Actions.md#version) +- [versionNumber](client._internal_namespace.Actions.md#versionnumber) + +## Constructors + +### constructor + +• **new Actions**(`versionNumber`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `versionNumber` | `string` | + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:23 + +## Properties + +### alerting + +• `Readonly` **alerting**: [`AlertingActions`](client._internal_namespace.AlertingActions.md) + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:19 + +___ + +### api + +• `Readonly` **api**: [`ApiActions`](client._internal_namespace.ApiActions.md) + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:14 + +___ + +### app + +• `Readonly` **app**: [`AppActions`](client._internal_namespace.AppActions.md) + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:15 + +___ + +### cases + +• `Readonly` **cases**: [`CasesActions`](client._internal_namespace.CasesActions.md) + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:16 + +___ + +### login + +• `Readonly` **login**: `string` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:17 + +___ + +### savedObject + +• `Readonly` **savedObject**: [`SavedObjectActions`](client._internal_namespace.SavedObjectActions.md) + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:18 + +___ + +### space + +• `Readonly` **space**: [`SpaceActions`](client._internal_namespace.SpaceActions.md) + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:20 + +___ + +### ui + +• `Readonly` **ui**: [`UIActions`](client._internal_namespace.UIActions.md) + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:21 + +___ + +### version + +• `Readonly` **version**: `string` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:22 + +___ + +### versionNumber + +• `Private` `Readonly` **versionNumber**: `any` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/actions.d.ts:13 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionsAuthorization.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionsAuthorization.md new file mode 100644 index 0000000000000..eb1403431969d --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionsAuthorization.md @@ -0,0 +1,99 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionsAuthorization + +# Class: ActionsAuthorization + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionsAuthorization + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.ActionsAuthorization.md#constructor) + +### Properties + +- [authorization](client._internal_namespace.ActionsAuthorization.md#authorization) +- [authorizationMode](client._internal_namespace.ActionsAuthorization.md#authorizationmode) +- [isOperationExemptDueToLegacyRbac](client._internal_namespace.ActionsAuthorization.md#isoperationexemptduetolegacyrbac) +- [request](client._internal_namespace.ActionsAuthorization.md#request) + +### Methods + +- [ensureAuthorized](client._internal_namespace.ActionsAuthorization.md#ensureauthorized) + +## Constructors + +### constructor + +• **new ActionsAuthorization**(`__namedParameters`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`ConstructorOptions`](../interfaces/client._internal_namespace.ConstructorOptions-1.md) | + +#### Defined in + +x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:14 + +## Properties + +### authorization + +• `Private` `Optional` `Readonly` **authorization**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:12 + +___ + +### authorizationMode + +• `Private` `Readonly` **authorizationMode**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:13 + +___ + +### isOperationExemptDueToLegacyRbac + +• `Private` **isOperationExemptDueToLegacyRbac**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:16 + +___ + +### request + +• `Private` `Readonly` **request**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:11 + +## Methods + +### ensureAuthorized + +▸ **ensureAuthorized**(`operation`, `actionTypeId?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `operation` | `string` | +| `actionTypeId?` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:15 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionsClient.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionsClient.md new file mode 100644 index 0000000000000..a566950c5fa21 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ActionsClient.md @@ -0,0 +1,432 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionsClient + +# Class: ActionsClient + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionsClient + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.ActionsClient.md#constructor) + +### Properties + +- [actionExecutor](client._internal_namespace.ActionsClient.md#actionexecutor) +- [actionTypeRegistry](client._internal_namespace.ActionsClient.md#actiontyperegistry) +- [auditLogger](client._internal_namespace.ActionsClient.md#auditlogger) +- [authorization](client._internal_namespace.ActionsClient.md#authorization) +- [connectorTokenClient](client._internal_namespace.ActionsClient.md#connectortokenclient) +- [defaultKibanaIndex](client._internal_namespace.ActionsClient.md#defaultkibanaindex) +- [ephemeralExecutionEnqueuer](client._internal_namespace.ActionsClient.md#ephemeralexecutionenqueuer) +- [executionEnqueuer](client._internal_namespace.ActionsClient.md#executionenqueuer) +- [preconfiguredActions](client._internal_namespace.ActionsClient.md#preconfiguredactions) +- [request](client._internal_namespace.ActionsClient.md#request) +- [scopedClusterClient](client._internal_namespace.ActionsClient.md#scopedclusterclient) +- [unsecuredSavedObjectsClient](client._internal_namespace.ActionsClient.md#unsecuredsavedobjectsclient) +- [usageCounter](client._internal_namespace.ActionsClient.md#usagecounter) + +### Methods + +- [create](client._internal_namespace.ActionsClient.md#create) +- [delete](client._internal_namespace.ActionsClient.md#delete) +- [enqueueExecution](client._internal_namespace.ActionsClient.md#enqueueexecution) +- [ephemeralEnqueuedExecution](client._internal_namespace.ActionsClient.md#ephemeralenqueuedexecution) +- [execute](client._internal_namespace.ActionsClient.md#execute) +- [get](client._internal_namespace.ActionsClient.md#get) +- [getAll](client._internal_namespace.ActionsClient.md#getall) +- [getBulk](client._internal_namespace.ActionsClient.md#getbulk) +- [isActionTypeEnabled](client._internal_namespace.ActionsClient.md#isactiontypeenabled) +- [isPreconfigured](client._internal_namespace.ActionsClient.md#ispreconfigured) +- [listTypes](client._internal_namespace.ActionsClient.md#listtypes) +- [update](client._internal_namespace.ActionsClient.md#update) + +## Constructors + +### constructor + +• **new ActionsClient**(`__namedParameters`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`ConstructorOptions`](../interfaces/client._internal_namespace.ConstructorOptions.md) | + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:57 + +## Properties + +### actionExecutor + +• `Private` `Readonly` **actionExecutor**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:49 + +___ + +### actionTypeRegistry + +• `Private` `Readonly` **actionTypeRegistry**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:47 + +___ + +### auditLogger + +• `Private` `Optional` `Readonly` **auditLogger**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:54 + +___ + +### authorization + +• `Private` `Readonly` **authorization**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:51 + +___ + +### connectorTokenClient + +• `Private` `Readonly` **connectorTokenClient**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:56 + +___ + +### defaultKibanaIndex + +• `Private` `Readonly` **defaultKibanaIndex**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:44 + +___ + +### ephemeralExecutionEnqueuer + +• `Private` `Readonly` **ephemeralExecutionEnqueuer**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:53 + +___ + +### executionEnqueuer + +• `Private` `Readonly` **executionEnqueuer**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:52 + +___ + +### preconfiguredActions + +• `Private` `Readonly` **preconfiguredActions**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:48 + +___ + +### request + +• `Private` `Readonly` **request**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:50 + +___ + +### scopedClusterClient + +• `Private` `Readonly` **scopedClusterClient**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:45 + +___ + +### unsecuredSavedObjectsClient + +• `Private` `Readonly` **unsecuredSavedObjectsClient**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:46 + +___ + +### usageCounter + +• `Private` `Optional` `Readonly` **usageCounter**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:55 + +## Methods + +### create + +▸ **create**(`__namedParameters`): `Promise`<[`ActionResult`](../interfaces/client._internal_namespace.ActionResult.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig)\>\> + +Create an action + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`CreateOptions`](../interfaces/client._internal_namespace.CreateOptions.md) | + +#### Returns + +`Promise`<[`ActionResult`](../interfaces/client._internal_namespace.ActionResult.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig)\>\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:61 + +___ + +### delete + +▸ **delete**(`__namedParameters`): `Promise`<{}\> + +Delete action + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Object` | +| `__namedParameters.id` | `string` | + +#### Returns + +`Promise`<{}\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:83 + +___ + +### enqueueExecution + +▸ **enqueueExecution**(`options`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | [`ExecuteOptions`](../interfaces/client._internal_namespace.ExecuteOptions-1.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:87 + +___ + +### ephemeralEnqueuedExecution + +▸ **ephemeralEnqueuedExecution**(`options`): `Promise`<[`RunNowResult`](../interfaces/client._internal_namespace.RunNowResult.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | [`ExecuteOptions`](../interfaces/client._internal_namespace.ExecuteOptions-1.md) | + +#### Returns + +`Promise`<[`RunNowResult`](../interfaces/client._internal_namespace.RunNowResult.md)\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:88 + +___ + +### execute + +▸ **execute**(`__namedParameters`): `Promise`<[`ActionTypeExecutorResult`](../interfaces/client._internal_namespace.ActionTypeExecutorResult.md)<`unknown`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Omit`<[`ExecuteOptions`](../interfaces/client._internal_namespace.ExecuteOptions.md)<`unknown`\>, ``"request"``\> | + +#### Returns + +`Promise`<[`ActionTypeExecutorResult`](../interfaces/client._internal_namespace.ActionTypeExecutorResult.md)<`unknown`\>\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:86 + +___ + +### get + +▸ **get**(`__namedParameters`): `Promise`<[`ActionResult`](../interfaces/client._internal_namespace.ActionResult.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig)\>\> + +Get an action + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Object` | +| `__namedParameters.id` | `string` | + +#### Returns + +`Promise`<[`ActionResult`](../interfaces/client._internal_namespace.ActionResult.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig)\>\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:69 + +___ + +### getAll + +▸ **getAll**(): `Promise`<[`FindActionResult`](../interfaces/client._internal_namespace.FindActionResult.md)[]\> + +Get all actions with preconfigured list + +#### Returns + +`Promise`<[`FindActionResult`](../interfaces/client._internal_namespace.FindActionResult.md)[]\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:75 + +___ + +### getBulk + +▸ **getBulk**(`ids`): `Promise`<[`ActionResult`](../interfaces/client._internal_namespace.ActionResult.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig)\>[]\> + +Get bulk actions with preconfigured list + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `ids` | `string`[] | + +#### Returns + +`Promise`<[`ActionResult`](../interfaces/client._internal_namespace.ActionResult.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig)\>[]\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:79 + +___ + +### isActionTypeEnabled + +▸ **isActionTypeEnabled**(`actionTypeId`, `options?`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `actionTypeId` | `string` | +| `options?` | `Object` | +| `options.notifyUsage` | `boolean` | + +#### Returns + +`boolean` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:90 + +___ + +### isPreconfigured + +▸ **isPreconfigured**(`connectorId`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `connectorId` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:93 + +___ + +### listTypes + +▸ **listTypes**(): `Promise`<[`ActionType`](../interfaces/client._internal_namespace.ActionType.md)[]\> + +#### Returns + +`Promise`<[`ActionType`](../interfaces/client._internal_namespace.ActionType.md)[]\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:89 + +___ + +### update + +▸ **update**(`__namedParameters`): `Promise`<[`ActionResult`](../interfaces/client._internal_namespace.ActionResult.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig)\>\> + +Update action + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`UpdateOptions`](../interfaces/client._internal_namespace.UpdateOptions.md) | + +#### Returns + +`Promise`<[`ActionResult`](../interfaces/client._internal_namespace.ActionResult.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig)\>\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:65 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AlertService.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AlertService.md new file mode 100644 index 0000000000000..b231fddac4c61 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AlertService.md @@ -0,0 +1,206 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AlertService + +# Class: AlertService + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AlertService + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.AlertService.md#constructor) + +### Methods + +- [bucketAlertsByIndexAndStatus](client._internal_namespace.AlertService.md#bucketalertsbyindexandstatus) +- [executeAggregations](client._internal_namespace.AlertService.md#executeaggregations) +- [getAlerts](client._internal_namespace.AlertService.md#getalerts) +- [translateStatus](client._internal_namespace.AlertService.md#translatestatus) +- [updateAlertsStatus](client._internal_namespace.AlertService.md#updatealertsstatus) +- [updateByQuery](client._internal_namespace.AlertService.md#updatebyquery) +- [getUniqueIdsIndices](client._internal_namespace.AlertService.md#getuniqueidsindices) +- [isEmptyAlert](client._internal_namespace.AlertService.md#isemptyalert) + +## Constructors + +### constructor + +• **new AlertService**(`scopedClusterClient`, `logger`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scopedClusterClient` | [`ElasticsearchClient`](../modules/client._internal_namespace.md#elasticsearchclient) | +| `logger` | `Logger` | + +#### Defined in + +[x-pack/plugins/cases/server/services/alerts/index.ts:24](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L24) + +## Methods + +### bucketAlertsByIndexAndStatus + +▸ `Private` **bucketAlertsByIndexAndStatus**(`alerts`): `Map`<`string`, `Map`<`STATUS_VALUES`, [`TranslatedUpdateAlertRequest`](../interfaces/client._internal_namespace.TranslatedUpdateAlertRequest.md)[]\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `alerts` | [`UpdateAlertRequest`](../interfaces/client._internal_namespace.UpdateAlertRequest.md)[] | + +#### Returns + +`Map`<`string`, `Map`<`STATUS_VALUES`, [`TranslatedUpdateAlertRequest`](../interfaces/client._internal_namespace.TranslatedUpdateAlertRequest.md)[]\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/alerts/index.ts:98](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L98) + +___ + +### executeAggregations + +▸ **executeAggregations**(`__namedParameters`): `Promise`<[`AggregationResponse`](../modules/client._internal_namespace.md#aggregationresponse)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Object` | +| `__namedParameters.aggregationBuilders` | [`AggregationBuilder`](../interfaces/client._internal_namespace.AggregationBuilder.md)[] | +| `__namedParameters.alerts` | [`AlertIdIndex`](../interfaces/client._internal_namespace.AlertIdIndex.md)[] | + +#### Returns + +`Promise`<[`AggregationResponse`](../modules/client._internal_namespace.md#aggregationresponse)\> + +#### Defined in + +[x-pack/plugins/cases/server/services/alerts/index.ts:29](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L29) + +___ + +### getAlerts + +▸ **getAlerts**(`alertsInfo`): `Promise`<`undefined` \| [`AlertsResponse`](../interfaces/client._internal_namespace.AlertsResponse.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `alertsInfo` | [`AlertInfo`](../interfaces/client._internal_namespace.AlertInfo.md)[] | + +#### Returns + +`Promise`<`undefined` \| [`AlertsResponse`](../interfaces/client._internal_namespace.AlertsResponse.md)\> + +#### Defined in + +[x-pack/plugins/cases/server/services/alerts/index.ts:182](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L182) + +___ + +### translateStatus + +▸ `Private` **translateStatus**(`alert`): `STATUS_VALUES` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `alert` | [`UpdateAlertRequest`](../interfaces/client._internal_namespace.UpdateAlertRequest.md) | + +#### Returns + +`STATUS_VALUES` + +#### Defined in + +[x-pack/plugins/cases/server/services/alerts/index.ts:133](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L133) + +___ + +### updateAlertsStatus + +▸ **updateAlertsStatus**(`alerts`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `alerts` | [`UpdateAlertRequest`](../interfaces/client._internal_namespace.UpdateAlertRequest.md)[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[x-pack/plugins/cases/server/services/alerts/index.ts:78](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L78) + +___ + +### updateByQuery + +▸ `Private` **updateByQuery**(`__namedParameters`): `Promise`<`TransportResult`<`UpdateByQueryResponse`, `unknown`\>[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`string`, `Map`<`STATUS_VALUES`, [`TranslatedUpdateAlertRequest`](../interfaces/client._internal_namespace.TranslatedUpdateAlertRequest.md)[]\>] | + +#### Returns + +`Promise`<`TransportResult`<`UpdateByQueryResponse`, `unknown`\>[]\> + +#### Defined in + +[x-pack/plugins/cases/server/services/alerts/index.ts:151](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L151) + +___ + +### getUniqueIdsIndices + +▸ `Static` `Private` **getUniqueIdsIndices**(`alerts`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `alerts` | [`AlertIdIndex`](../interfaces/client._internal_namespace.AlertIdIndex.md)[] | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `ids` | `string`[] | +| `indices` | `string`[] | + +#### Defined in + +[x-pack/plugins/cases/server/services/alerts/index.ts:62](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L62) + +___ + +### isEmptyAlert + +▸ `Static` `Private` **isEmptyAlert**(`alert`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `alert` | [`AlertInfo`](../interfaces/client._internal_namespace.AlertInfo.md) | + +#### Returns + +`boolean` + +#### Defined in + +[x-pack/plugins/cases/server/services/alerts/index.ts:129](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L129) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AlertingActions.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AlertingActions.md new file mode 100644 index 0000000000000..6b45ea9b28110 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AlertingActions.md @@ -0,0 +1,68 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AlertingActions + +# Class: AlertingActions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AlertingActions + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.AlertingActions.md#constructor) + +### Properties + +- [prefix](client._internal_namespace.AlertingActions.md#prefix) + +### Methods + +- [get](client._internal_namespace.AlertingActions.md#get) + +## Constructors + +### constructor + +• **new AlertingActions**(`versionNumber`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `versionNumber` | `string` | + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/alerting.d.ts:3 + +## Properties + +### prefix + +• `Private` `Readonly` **prefix**: `any` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/alerting.d.ts:2 + +## Methods + +### get + +▸ **get**(`ruleTypeId`, `consumer`, `alertingEntity`, `operation`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `ruleTypeId` | `string` | +| `consumer` | `string` | +| `alertingEntity` | `string` | +| `operation` | `string` | + +#### Returns + +`string` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/alerting.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ApiActions.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ApiActions.md new file mode 100644 index 0000000000000..a7e6c51d4a649 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ApiActions.md @@ -0,0 +1,65 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ApiActions + +# Class: ApiActions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ApiActions + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.ApiActions.md#constructor) + +### Properties + +- [prefix](client._internal_namespace.ApiActions.md#prefix) + +### Methods + +- [get](client._internal_namespace.ApiActions.md#get) + +## Constructors + +### constructor + +• **new ApiActions**(`versionNumber`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `versionNumber` | `string` | + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/api.d.ts:3 + +## Properties + +### prefix + +• `Private` `Readonly` **prefix**: `any` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/api.d.ts:2 + +## Methods + +### get + +▸ **get**(`operation`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `operation` | `string` | + +#### Returns + +`string` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/api.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AppActions.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AppActions.md new file mode 100644 index 0000000000000..76fbfc84021c5 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AppActions.md @@ -0,0 +1,65 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AppActions + +# Class: AppActions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AppActions + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.AppActions.md#constructor) + +### Properties + +- [prefix](client._internal_namespace.AppActions.md#prefix) + +### Methods + +- [get](client._internal_namespace.AppActions.md#get) + +## Constructors + +### constructor + +• **new AppActions**(`versionNumber`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `versionNumber` | `string` | + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/app.d.ts:3 + +## Properties + +### prefix + +• `Private` `Readonly` **prefix**: `any` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/app.d.ts:2 + +## Methods + +### get + +▸ **get**(`appId`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `appId` | `string` | + +#### Returns + +`string` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/app.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AttachmentService.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AttachmentService.md new file mode 100644 index 0000000000000..064f9cf9567b3 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AttachmentService.md @@ -0,0 +1,217 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AttachmentService + +# Class: AttachmentService + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AttachmentService + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.AttachmentService.md#constructor) + +### Methods + +- [buildCountAlertsAggs](client._internal_namespace.AttachmentService.md#buildcountalertsaggs) +- [bulkUpdate](client._internal_namespace.AttachmentService.md#bulkupdate) +- [countAlertsAttachedToCase](client._internal_namespace.AttachmentService.md#countalertsattachedtocase) +- [create](client._internal_namespace.AttachmentService.md#create) +- [delete](client._internal_namespace.AttachmentService.md#delete) +- [executeCaseActionsAggregations](client._internal_namespace.AttachmentService.md#executecaseactionsaggregations) +- [get](client._internal_namespace.AttachmentService.md#get) +- [getAllAlertsAttachToCase](client._internal_namespace.AttachmentService.md#getallalertsattachtocase) +- [update](client._internal_namespace.AttachmentService.md#update) + +## Constructors + +### constructor + +• **new AttachmentService**(`log`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `log` | `Logger` | + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:66](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L66) + +## Methods + +### buildCountAlertsAggs + +▸ `Private` **buildCountAlertsAggs**(): `Record`<`string`, `AggregationsAggregationContainer`\> + +#### Returns + +`Record`<`string`, `AggregationsAggregationContainer`\> + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:104](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L104) + +___ + +### bulkUpdate + +▸ **bulkUpdate**(`__namedParameters`): `Promise`<[`SavedObjectsBulkUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`BulkUpdateAttachmentArgs`](../interfaces/client._internal_namespace.BulkUpdateAttachmentArgs.md) | + +#### Returns + +`Promise`<[`SavedObjectsBulkUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:262](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L262) + +___ + +### countAlertsAttachedToCase + +▸ **countAlertsAttachedToCase**(`__namedParameters`): `Promise`<`undefined` \| `number`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`AttachedToCaseArgs`](../interfaces/client._internal_namespace.AttachedToCaseArgs.md) | + +#### Returns + +`Promise`<`undefined` \| `number`\> + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:68](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L68) + +___ + +### create + +▸ **create**(`__namedParameters`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`CreateAttachmentArgs`](../interfaces/client._internal_namespace.CreateAttachmentArgs.md) | + +#### Returns + +`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:220](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L220) + +___ + +### delete + +▸ **delete**(`__namedParameters`): `Promise`<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`GetAttachmentArgs`](../interfaces/client._internal_namespace.GetAttachmentArgs.md) | + +#### Returns + +`Promise`<{}\> + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:210](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L210) + +___ + +### executeCaseActionsAggregations + +▸ **executeCaseActionsAggregations**(`__namedParameters`): `Promise`<[`AggregationResponse`](../modules/client._internal_namespace.md#aggregationresponse)\> + +Executes the aggregations against the actions attached to a case. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`CountActionsAttachedToCaseArgs`](../interfaces/client._internal_namespace.CountActionsAttachedToCaseArgs.md) | + +#### Returns + +`Promise`<[`AggregationResponse`](../modules/client._internal_namespace.md#aggregationresponse)\> + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:157](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L157) + +___ + +### get + +▸ **get**(`__namedParameters`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`GetAttachmentArgs`](../interfaces/client._internal_namespace.GetAttachmentArgs.md) | + +#### Returns + +`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:194](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L194) + +___ + +### getAllAlertsAttachToCase + +▸ **getAllAlertsAttachToCase**(`__namedParameters`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>[]\> + +Retrieves all the alerts attached to a case. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`AttachedToCaseArgs`](../interfaces/client._internal_namespace.AttachedToCaseArgs.md) | + +#### Returns + +`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>[]\> + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:117](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L117) + +___ + +### update + +▸ **update**(`__namedParameters`): `Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`UpdateAttachmentArgs`](../modules/client._internal_namespace.md#updateattachmentargs) | + +#### Returns + +`Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:242](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L242) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.Authorization.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.Authorization.md new file mode 100644 index 0000000000000..7c09e59f2216a --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.Authorization.md @@ -0,0 +1,241 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Authorization + +# Class: Authorization + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Authorization + +This class handles ensuring that the user making a request has the correct permissions +for the API request. + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.Authorization.md#constructor) + +### Properties + +- [auditLogger](client._internal_namespace.Authorization.md#auditlogger) +- [featureCaseOwners](client._internal_namespace.Authorization.md#featurecaseowners) +- [request](client._internal_namespace.Authorization.md#request) +- [securityAuth](client._internal_namespace.Authorization.md#securityauth) + +### Methods + +- [\_ensureAuthorized](client._internal_namespace.Authorization.md#_ensureauthorized) +- [\_getAuthorizationFilter](client._internal_namespace.Authorization.md#_getauthorizationfilter) +- [ensureAuthorized](client._internal_namespace.Authorization.md#ensureauthorized) +- [getAuthorizationFilter](client._internal_namespace.Authorization.md#getauthorizationfilter) +- [getAuthorizedOwners](client._internal_namespace.Authorization.md#getauthorizedowners) +- [shouldCheckAuthorization](client._internal_namespace.Authorization.md#shouldcheckauthorization) +- [create](client._internal_namespace.Authorization.md#create) + +## Constructors + +### constructor + +• `Private` **new Authorization**(`__namedParameters`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Object` | +| `__namedParameters.auditLogger` | [`AuthorizationAuditLogger`](client._internal_namespace.AuthorizationAuditLogger.md) | +| `__namedParameters.caseOwners` | `Set`<`string`\> | +| `__namedParameters.request` | [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | +| `__namedParameters.securityAuth?` | [`AuthorizationServiceSetup`](../interfaces/client._internal_namespace.AuthorizationServiceSetup.md) | + +#### Defined in + +[x-pack/plugins/cases/server/authorization/authorization.ts:27](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L27) + +## Properties + +### auditLogger + +• `Private` `Readonly` **auditLogger**: [`AuthorizationAuditLogger`](client._internal_namespace.AuthorizationAuditLogger.md) + +#### Defined in + +[x-pack/plugins/cases/server/authorization/authorization.ts:25](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L25) + +___ + +### featureCaseOwners + +• `Private` `Readonly` **featureCaseOwners**: `Set`<`string`\> + +#### Defined in + +[x-pack/plugins/cases/server/authorization/authorization.ts:24](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L24) + +___ + +### request + +• `Private` `Readonly` **request**: [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> + +#### Defined in + +[x-pack/plugins/cases/server/authorization/authorization.ts:22](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L22) + +___ + +### securityAuth + +• `Private` `Readonly` **securityAuth**: `undefined` \| [`AuthorizationServiceSetup`](../interfaces/client._internal_namespace.AuthorizationServiceSetup.md) + +#### Defined in + +[x-pack/plugins/cases/server/authorization/authorization.ts:23](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L23) + +## Methods + +### \_ensureAuthorized + +▸ `Private` **_ensureAuthorized**(`owners`, `operation`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `owners` | `string`[] | +| `operation` | [`OperationDetails`](../interfaces/client._internal_namespace.OperationDetails.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[x-pack/plugins/cases/server/authorization/authorization.ts:135](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L135) + +___ + +### \_getAuthorizationFilter + +▸ `Private` **_getAuthorizationFilter**(`operation`): `Promise`<[`AuthFilterHelpers`](../interfaces/client._internal_namespace.AuthFilterHelpers.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `operation` | [`OperationDetails`](../interfaces/client._internal_namespace.OperationDetails.md) | + +#### Returns + +`Promise`<[`AuthFilterHelpers`](../interfaces/client._internal_namespace.AuthFilterHelpers.md)\> + +#### Defined in + +[x-pack/plugins/cases/server/authorization/authorization.ts:170](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L170) + +___ + +### ensureAuthorized + +▸ **ensureAuthorized**(`__namedParameters`): `Promise`<`void`\> + +Checks that the user making the request for the passed in owners and operation has the correct authorization. This +function will throw if the user is not authorized for the requested operation and owners. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Object` | +| `__namedParameters.entities` | [`OwnerEntity`](../interfaces/client._internal_namespace.OwnerEntity.md)[] | +| `__namedParameters.operation` | [`OperationDetails`](../interfaces/client._internal_namespace.OperationDetails.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[x-pack/plugins/cases/server/authorization/authorization.ts:97](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L97) + +___ + +### getAuthorizationFilter + +▸ **getAuthorizationFilter**(`operation`): `Promise`<[`AuthFilterHelpers`](../interfaces/client._internal_namespace.AuthFilterHelpers.md)\> + +Returns an object to filter the saved object find request to the authorized owners of an entity. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `operation` | [`OperationDetails`](../interfaces/client._internal_namespace.OperationDetails.md) | + +#### Returns + +`Promise`<[`AuthFilterHelpers`](../interfaces/client._internal_namespace.AuthFilterHelpers.md)\> + +#### Defined in + +[x-pack/plugins/cases/server/authorization/authorization.ts:126](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L126) + +___ + +### getAuthorizedOwners + +▸ `Private` **getAuthorizedOwners**(`operations`): `Promise`<{ `authorizedOwners`: `string`[] ; `hasAllRequested`: `boolean` ; `username?`: `string` }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `operations` | [`OperationDetails`](../interfaces/client._internal_namespace.OperationDetails.md)[] | + +#### Returns + +`Promise`<{ `authorizedOwners`: `string`[] ; `hasAllRequested`: `boolean` ; `username?`: `string` }\> + +#### Defined in + +[x-pack/plugins/cases/server/authorization/authorization.ts:207](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L207) + +___ + +### shouldCheckAuthorization + +▸ `Private` **shouldCheckAuthorization**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[x-pack/plugins/cases/server/authorization/authorization.ts:85](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L85) + +___ + +### create + +▸ `Static` **create**(`__namedParameters`): `Promise`<[`Authorization`](client._internal_namespace.Authorization.md)\> + +Creates an Authorization object. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Object` | +| `__namedParameters.auditLogger` | [`AuthorizationAuditLogger`](client._internal_namespace.AuthorizationAuditLogger.md) | +| `__namedParameters.features` | [`PluginStartContract`](../interfaces/client._internal_namespace.PluginStartContract.md) | +| `__namedParameters.getSpace` | [`GetSpaceFn`](../modules/client._internal_namespace.md#getspacefn) | +| `__namedParameters.logger` | `Logger` | +| `__namedParameters.request` | [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | +| `__namedParameters.securityAuth?` | [`AuthorizationServiceSetup`](../interfaces/client._internal_namespace.AuthorizationServiceSetup.md) | + +#### Returns + +`Promise`<[`Authorization`](client._internal_namespace.Authorization.md)\> + +#### Defined in + +[x-pack/plugins/cases/server/authorization/authorization.ts:47](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/authorization.ts#L47) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AuthorizationAuditLogger.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AuthorizationAuditLogger.md new file mode 100644 index 0000000000000..5f80d4d21f4b2 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.AuthorizationAuditLogger.md @@ -0,0 +1,117 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AuthorizationAuditLogger + +# Class: AuthorizationAuditLogger + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AuthorizationAuditLogger + +Audit logger for authorization operations + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.AuthorizationAuditLogger.md#constructor) + +### Properties + +- [auditLogger](client._internal_namespace.AuthorizationAuditLogger.md#auditlogger) + +### Methods + +- [log](client._internal_namespace.AuthorizationAuditLogger.md#log) +- [createAuditMsg](client._internal_namespace.AuthorizationAuditLogger.md#createauditmsg) +- [createFailureMessage](client._internal_namespace.AuthorizationAuditLogger.md#createfailuremessage) + +## Constructors + +### constructor + +• **new AuthorizationAuditLogger**(`logger?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `logger?` | [`AuditLogger`](../interfaces/client._internal_namespace.AuditLogger.md) | + +#### Defined in + +[x-pack/plugins/cases/server/authorization/audit_logger.ts:25](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/audit_logger.ts#L25) + +## Properties + +### auditLogger + +• `Private` `Optional` `Readonly` **auditLogger**: [`AuditLogger`](../interfaces/client._internal_namespace.AuditLogger.md) + +#### Defined in + +[x-pack/plugins/cases/server/authorization/audit_logger.ts:23](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/audit_logger.ts#L23) + +## Methods + +### log + +▸ **log**(`auditMsgParams`): `void` + +Logs an audit event based on the status of an operation. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `auditMsgParams` | [`CreateAuditMsgParams`](../interfaces/client._internal_namespace.CreateAuditMsgParams.md) | + +#### Returns + +`void` + +#### Defined in + +[x-pack/plugins/cases/server/authorization/audit_logger.ts:98](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/audit_logger.ts#L98) + +___ + +### createAuditMsg + +▸ `Static` `Private` **createAuditMsg**(`__namedParameters`): [`AuditEvent`](../interfaces/client._internal_namespace.AuditEvent.md) + +Creates an AuditEvent describing the state of a request. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`CreateAuditMsgParams`](../interfaces/client._internal_namespace.CreateAuditMsgParams.md) | + +#### Returns + +[`AuditEvent`](../interfaces/client._internal_namespace.AuditEvent.md) + +#### Defined in + +[x-pack/plugins/cases/server/authorization/audit_logger.ts:32](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/audit_logger.ts#L32) + +___ + +### createFailureMessage + +▸ `Static` **createFailureMessage**(`__namedParameters`): `string` + +Creates a message to be passed to an Error or Boom. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Object` | +| `__namedParameters.operation` | [`OperationDetails`](../interfaces/client._internal_namespace.OperationDetails.md) | +| `__namedParameters.owners` | `string`[] | + +#### Returns + +`string` + +#### Defined in + +[x-pack/plugins/cases/server/authorization/audit_logger.ts:79](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/audit_logger.ts#L79) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.BasePath.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.BasePath.md new file mode 100644 index 0000000000000..50d50b457bfea --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.BasePath.md @@ -0,0 +1,189 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / BasePath + +# Class: BasePath + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).BasePath + +Access or manipulate the Kibana base path + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.BasePath.md#constructor) + +### Properties + +- [basePathCache](client._internal_namespace.BasePath.md#basepathcache) +- [get](client._internal_namespace.BasePath.md#get) +- [prepend](client._internal_namespace.BasePath.md#prepend) +- [publicBaseUrl](client._internal_namespace.BasePath.md#publicbaseurl) +- [remove](client._internal_namespace.BasePath.md#remove) +- [serverBasePath](client._internal_namespace.BasePath.md#serverbasepath) +- [set](client._internal_namespace.BasePath.md#set) + +## Constructors + +### constructor + +• **new BasePath**(`serverBasePath?`, `publicBaseUrl?`) + +**`internal`** + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `serverBasePath?` | `string` | +| `publicBaseUrl?` | `string` | + +#### Defined in + +src/core/target/types/server/http/base_path_service.d.ts:24 + +## Properties + +### basePathCache + +• `Private` `Readonly` **basePathCache**: `any` + +#### Defined in + +src/core/target/types/server/http/base_path_service.d.ts:8 + +___ + +### get + +• **get**: (`request`: [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\>) => `string` + +#### Type declaration + +▸ (`request`): `string` + +returns `basePath` value, specific for an incoming request. + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `request` | [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | + +##### Returns + +`string` + +#### Defined in + +src/core/target/types/server/http/base_path_service.d.ts:28 + +___ + +### prepend + +• **prepend**: (`path`: `string`) => `string` + +#### Type declaration + +▸ (`path`): `string` + +Prepends `path` with the basePath. + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | + +##### Returns + +`string` + +#### Defined in + +src/core/target/types/server/http/base_path_service.d.ts:38 + +___ + +### publicBaseUrl + +• `Optional` `Readonly` **publicBaseUrl**: `string` + +The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the +[BasePath.serverBasePath](client._internal_namespace.BasePath.md#serverbasepath). + +**`remarks`** +Should be used for generating external URL links back to this Kibana instance. + +#### Defined in + +src/core/target/types/server/http/base_path_service.d.ts:22 + +___ + +### remove + +• **remove**: (`path`: `string`) => `string` + +#### Type declaration + +▸ (`path`): `string` + +Removes the prepended basePath from the `path`. + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | + +##### Returns + +`string` + +#### Defined in + +src/core/target/types/server/http/base_path_service.d.ts:42 + +___ + +### serverBasePath + +• `Readonly` **serverBasePath**: `string` + +returns the server's basePath + +See [BasePath.get](client._internal_namespace.BasePath.md#get) for getting the basePath value for a specific request + +#### Defined in + +src/core/target/types/server/http/base_path_service.d.ts:14 + +___ + +### set + +• **set**: (`request`: [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\>, `requestSpecificBasePath`: `string`) => `void` + +#### Type declaration + +▸ (`request`, `requestSpecificBasePath`): `void` + +sets `basePath` value, specific for an incoming request. + +**`privateremarks`** should work only for KibanaRequest as soon as spaces migrate to NP + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `request` | [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | +| `requestSpecificBasePath` | `string` | + +##### Returns + +`void` + +#### Defined in + +src/core/target/types/server/http/base_path_service.d.ts:34 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.BuilderFactory.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.BuilderFactory.md new file mode 100644 index 0000000000000..a6f48bc77918b --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.BuilderFactory.md @@ -0,0 +1,47 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / BuilderFactory + +# Class: BuilderFactory + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).BuilderFactory + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.BuilderFactory.md#constructor) + +### Methods + +- [getBuilder](client._internal_namespace.BuilderFactory.md#getbuilder) + +## Constructors + +### constructor + +• **new BuilderFactory**() + +## Methods + +### getBuilder + +▸ **getBuilder**<`T`\>(`type`): `undefined` \| [`UserActionBuilder`](client._internal_namespace.UserActionBuilder.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends ``"description"`` \| ``"tags"`` \| ``"title"`` \| ``"connector"`` \| ``"settings"`` \| ``"status"`` \| ``"comment"`` \| ``"pushed"`` \| ``"create_case"`` \| ``"delete_case"`` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `T` | + +#### Returns + +`undefined` \| [`UserActionBuilder`](client._internal_namespace.UserActionBuilder.md) + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/builder_factory.ts:35](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/builder_factory.ts#L35) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CaseConfigureService.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CaseConfigureService.md new file mode 100644 index 0000000000000..bf61548e826ce --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CaseConfigureService.md @@ -0,0 +1,135 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CaseConfigureService + +# Class: CaseConfigureService + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CaseConfigureService + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.CaseConfigureService.md#constructor) + +### Methods + +- [delete](client._internal_namespace.CaseConfigureService.md#delete) +- [find](client._internal_namespace.CaseConfigureService.md#find) +- [get](client._internal_namespace.CaseConfigureService.md#get) +- [patch](client._internal_namespace.CaseConfigureService.md#patch) +- [post](client._internal_namespace.CaseConfigureService.md#post) + +## Constructors + +### constructor + +• **new CaseConfigureService**(`log`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `log` | `Logger` | + +#### Defined in + +[x-pack/plugins/cases/server/services/configure/index.ts:52](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L52) + +## Methods + +### delete + +▸ **delete**(`__namedParameters`): `Promise`<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`GetCaseConfigureArgs`](../interfaces/client._internal_namespace.GetCaseConfigureArgs.md) | + +#### Returns + +`Promise`<{}\> + +#### Defined in + +[x-pack/plugins/cases/server/services/configure/index.ts:54](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L54) + +___ + +### find + +▸ **find**(`__namedParameters`): `Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `closure_type`: ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt } & { `owner`: `string` = rt.string } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`FindCaseConfigureArgs`](../interfaces/client._internal_namespace.FindCaseConfigureArgs.md) | + +#### Returns + +`Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `closure_type`: ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt } & { `owner`: `string` = rt.string } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, `unknown`\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/configure/index.ts:82](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L82) + +___ + +### get + +▸ **get**(`__namedParameters`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `closure_type`: ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt } & { `owner`: `string` = rt.string } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`GetCaseConfigureArgs`](../interfaces/client._internal_namespace.GetCaseConfigureArgs.md) | + +#### Returns + +`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `closure_type`: ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt } & { `owner`: `string` = rt.string } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/configure/index.ts:64](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L64) + +___ + +### patch + +▸ **patch**(`__namedParameters`): `Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<{ `closure_type`: `undefined` \| ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: `undefined` \| { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } = CaseConnectorRt } & { `version`: `string` = rt.string }\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`PatchCaseConfigureArgs`](../interfaces/client._internal_namespace.PatchCaseConfigureArgs.md) | + +#### Returns + +`Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<{ `closure_type`: `undefined` \| ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: `undefined` \| { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } = CaseConnectorRt } & { `version`: `string` = rt.string }\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/configure/index.ts:125](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L125) + +___ + +### post + +▸ **post**(`__namedParameters`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `closure_type`: ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt } & { `owner`: `string` = rt.string } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`PostCaseConfigureArgs`](../interfaces/client._internal_namespace.PostCaseConfigureArgs.md) | + +#### Returns + +`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `closure_type`: ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt } & { `owner`: `string` = rt.string } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/configure/index.ts:104](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L104) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CaseUserActionService.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CaseUserActionService.md new file mode 100644 index 0000000000000..ed34d0f5389b7 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CaseUserActionService.md @@ -0,0 +1,304 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CaseUserActionService + +# Class: CaseUserActionService + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CaseUserActionService + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.CaseUserActionService.md#constructor) + +### Properties + +- [builderFactory](client._internal_namespace.CaseUserActionService.md#builderfactory) +- [userActionFieldsAllowed](client._internal_namespace.CaseUserActionService.md#useractionfieldsallowed) + +### Methods + +- [buildCountConnectorsAggs](client._internal_namespace.CaseUserActionService.md#buildcountconnectorsaggs) +- [bulkCreate](client._internal_namespace.CaseUserActionService.md#bulkcreate) +- [bulkCreateAttachmentDeletion](client._internal_namespace.CaseUserActionService.md#bulkcreateattachmentdeletion) +- [bulkCreateCaseDeletion](client._internal_namespace.CaseUserActionService.md#bulkcreatecasedeletion) +- [bulkCreateUpdateCase](client._internal_namespace.CaseUserActionService.md#bulkcreateupdatecase) +- [create](client._internal_namespace.CaseUserActionService.md#create) +- [createUserAction](client._internal_namespace.CaseUserActionService.md#createuseraction) +- [findStatusChanges](client._internal_namespace.CaseUserActionService.md#findstatuschanges) +- [getAll](client._internal_namespace.CaseUserActionService.md#getall) +- [getUniqueConnectors](client._internal_namespace.CaseUserActionService.md#getuniqueconnectors) +- [getUserActionItemByDifference](client._internal_namespace.CaseUserActionService.md#getuseractionitembydifference) + +## Constructors + +### constructor + +• **new CaseUserActionService**(`log`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `log` | `Logger` | + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:106](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L106) + +## Properties + +### builderFactory + +• `Private` `Readonly` **builderFactory**: [`BuilderFactory`](client._internal_namespace.BuilderFactory.md) + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:104](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L104) + +___ + +### userActionFieldsAllowed + +▪ `Static` `Private` `Readonly` **userActionFieldsAllowed**: `Set`<`string`\> + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:102](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L102) + +## Methods + +### buildCountConnectorsAggs + +▸ `Private` **buildCountConnectorsAggs**(`size?`): `Record`<`string`, `AggregationsAggregationContainer`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `size` | `number` | `100` | + +#### Returns + +`Record`<`string`, `AggregationsAggregationContainer`\> + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:470](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L470) + +___ + +### bulkCreate + +▸ **bulkCreate**(`__namedParameters`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`PostCaseUserActionArgs`](../interfaces/client._internal_namespace.PostCaseUserActionArgs.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:352](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L352) + +___ + +### bulkCreateAttachmentDeletion + +▸ **bulkCreateAttachmentDeletion**(`__namedParameters`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`BulkCreateAttachmentDeletionUserAction`](../interfaces/client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:244](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L244) + +___ + +### bulkCreateCaseDeletion + +▸ **bulkCreateCaseDeletion**(`__namedParameters`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`BulkCreateCaseDeletionUserAction`](../interfaces/client._internal_namespace.BulkCreateCaseDeletionUserAction.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:171](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L171) + +___ + +### bulkCreateUpdateCase + +▸ **bulkCreateUpdateCase**(`__namedParameters`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`BulkCreateBulkUpdateCaseUserActions`](../interfaces/client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:198](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L198) + +___ + +### create + +▸ **create**<`T`\>(`__namedParameters`): `Promise`<`void`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`CreateUserActionES`](../interfaces/client._internal_namespace.CreateUserActionES.md)<`T`\> | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:335](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L335) + +___ + +### createUserAction + +▸ **createUserAction**<`T`\>(`__namedParameters`): `Promise`<`void`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends keyof [`BuilderParameters`](../interfaces/client._internal_namespace.BuilderParameters.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`CreateUserActionClient`](../modules/client._internal_namespace.md#createuseractionclient)<`T`\> | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:275](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L275) + +___ + +### findStatusChanges + +▸ **findStatusChanges**(`__namedParameters`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `payload`: { description: string; } = DescriptionUserActionPayloadRt; `type`: ``"description"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { comment: { comment: string; type: CommentType.user; owner: string; } \| { type: CommentType.alert; alertId: string \| string[]; index: string \| string[]; rule: { id: string \| null; name: string \| null; }; owner: string; } \| { ...; }; } = CommentUserActionPayloadRt; `type`: ``"comment"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { tags: string[]; } = TagsUserActionPayloadRt; `type`: ``"tags"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { title: string; } = TitleUserActionPayloadRt; `type`: ``"title"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { settings: { syncAlerts: boolean; }; } = SettingsUserActionPayloadRt; `type`: ``"settings"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { status: CaseStatuses; } = StatusUserActionPayloadRt; `type`: ``"status"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `type`: ``"create_case"`` } & { `payload`: { connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; }) \| ... 4 more ... \| ({ ...; } & { ...; })); } & { description: string; status: string; tags: string[]; title: string; settings: { syncAlerts: boolean; }; owner: string; } } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; }) \| ... 4 more ... \| ({ ...; } & { ...; })); } = ConnectorUserActionPayloadRt; `type`: ``"connector"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { externalService: { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| ... 1 more ... \| undefined; username: string \| ... 1 more ... \| undefined; }; }; } = PushedUserActionPayloadRt; `type`: ``"pushed"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: {} ; `type`: ``"delete_case"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` }\>[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Object` | +| `__namedParameters.caseId` | `string` | +| `__namedParameters.filter?` | `KueryNode` | +| `__namedParameters.unsecuredSavedObjectsClient` | [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) | + +#### Returns + +`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `payload`: { description: string; } = DescriptionUserActionPayloadRt; `type`: ``"description"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { comment: { comment: string; type: CommentType.user; owner: string; } \| { type: CommentType.alert; alertId: string \| string[]; index: string \| string[]; rule: { id: string \| null; name: string \| null; }; owner: string; } \| { ...; }; } = CommentUserActionPayloadRt; `type`: ``"comment"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { tags: string[]; } = TagsUserActionPayloadRt; `type`: ``"tags"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { title: string; } = TitleUserActionPayloadRt; `type`: ``"title"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { settings: { syncAlerts: boolean; }; } = SettingsUserActionPayloadRt; `type`: ``"settings"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { status: CaseStatuses; } = StatusUserActionPayloadRt; `type`: ``"status"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `type`: ``"create_case"`` } & { `payload`: { connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; }) \| ... 4 more ... \| ({ ...; } & { ...; })); } & { description: string; status: string; tags: string[]; title: string; settings: { syncAlerts: boolean; }; owner: string; } } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; }) \| ... 4 more ... \| ({ ...; } & { ...; })); } = ConnectorUserActionPayloadRt; `type`: ``"connector"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { externalService: { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| ... 1 more ... \| undefined; username: string \| ... 1 more ... \| undefined; }; }; } = PushedUserActionPayloadRt; `type`: ``"pushed"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: {} ; `type`: ``"delete_case"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` }\>[]\> + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:372](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L372) + +___ + +### getAll + +▸ **getAll**(`__namedParameters`): `Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `payload`: { description: string; } = DescriptionUserActionPayloadRt; `type`: ``"description"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { comment: { comment: string; type: CommentType.user; owner: string; } \| { type: CommentType.alert; alertId: string \| string[]; index: string \| string[]; rule: { id: string \| null; name: string \| null; }; owner: string; } \| { ...; }; } = CommentUserActionPayloadRt; `type`: ``"comment"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { tags: string[]; } = TagsUserActionPayloadRt; `type`: ``"tags"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { title: string; } = TitleUserActionPayloadRt; `type`: ``"title"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { settings: { syncAlerts: boolean; }; } = SettingsUserActionPayloadRt; `type`: ``"settings"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { status: CaseStatuses; } = StatusUserActionPayloadRt; `type`: ``"status"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `type`: ``"create_case"`` } & { `payload`: { connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; }) \| ... 4 more ... \| ({ ...; } & { ...; })); } & { description: string; status: string; tags: string[]; title: string; settings: { syncAlerts: boolean; }; owner: string; } } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; }) \| ... 4 more ... \| ({ ...; } & { ...; })); } = ConnectorUserActionPayloadRt; `type`: ``"connector"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { externalService: { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| ... 1 more ... \| undefined; username: string \| ... 1 more ... \| undefined; }; }; } = PushedUserActionPayloadRt; `type`: ``"pushed"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: {} ; `type`: ``"delete_case"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` }, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`GetCaseUserActionArgs`](../interfaces/client._internal_namespace.GetCaseUserActionArgs.md) | + +#### Returns + +`Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `payload`: { description: string; } = DescriptionUserActionPayloadRt; `type`: ``"description"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { comment: { comment: string; type: CommentType.user; owner: string; } \| { type: CommentType.alert; alertId: string \| string[]; index: string \| string[]; rule: { id: string \| null; name: string \| null; }; owner: string; } \| { ...; }; } = CommentUserActionPayloadRt; `type`: ``"comment"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { tags: string[]; } = TagsUserActionPayloadRt; `type`: ``"tags"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { title: string; } = TitleUserActionPayloadRt; `type`: ``"title"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { settings: { syncAlerts: boolean; }; } = SettingsUserActionPayloadRt; `type`: ``"settings"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { status: CaseStatuses; } = StatusUserActionPayloadRt; `type`: ``"status"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `type`: ``"create_case"`` } & { `payload`: { connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; }) \| ... 4 more ... \| ({ ...; } & { ...; })); } & { description: string; status: string; tags: string[]; title: string; settings: { syncAlerts: boolean; }; owner: string; } } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; }) \| ... 4 more ... \| ({ ...; } & { ...; })); } = ConnectorUserActionPayloadRt; `type`: ``"connector"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: { externalService: { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| ... 1 more ... \| undefined; username: string \| ... 1 more ... \| undefined; }; }; } = PushedUserActionPayloadRt; `type`: ``"pushed"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` } & { `payload`: {} ; `type`: ``"delete_case"`` } & { `action`: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` = ActionsRt; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string } & { `action_id`: `string` = rt.string; `case_id`: `string` = rt.string; `comment_id`: ``null`` \| `string` }, `unknown`\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:310](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L310) + +___ + +### getUniqueConnectors + +▸ **getUniqueConnectors**(`__namedParameters`): `Promise`<{ `id`: `string` }[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Object` | +| `__namedParameters.caseId` | `string` | +| `__namedParameters.filter?` | `KueryNode` | +| `__namedParameters.unsecuredSavedObjectsClient` | [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) | + +#### Returns + +`Promise`<{ `id`: `string` }[]\> + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:426](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L426) + +___ + +### getUserActionItemByDifference + +▸ `Private` **getUserActionItemByDifference**(`__namedParameters`): [`BuilderReturnValue`](../interfaces/client._internal_namespace.BuilderReturnValue.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`GetUserActionItemByDifference`](../interfaces/client._internal_namespace.GetUserActionItemByDifference.md) | + +#### Returns + +[`BuilderReturnValue`](../interfaces/client._internal_namespace.BuilderReturnValue.md)[] + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:108](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L108) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesActions.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesActions.md new file mode 100644 index 0000000000000..40c474c66fc37 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesActions.md @@ -0,0 +1,66 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CasesActions + +# Class: CasesActions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CasesActions + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.CasesActions.md#constructor) + +### Properties + +- [prefix](client._internal_namespace.CasesActions.md#prefix) + +### Methods + +- [get](client._internal_namespace.CasesActions.md#get) + +## Constructors + +### constructor + +• **new CasesActions**(`versionNumber`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `versionNumber` | `string` | + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/cases.d.ts:3 + +## Properties + +### prefix + +• `Private` `Readonly` **prefix**: `any` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/cases.d.ts:2 + +## Methods + +### get + +▸ **get**(`owner`, `operation`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `owner` | `string` | +| `operation` | `string` | + +#### Returns + +`string` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/cases.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesClientInternal.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesClientInternal.md new file mode 100644 index 0000000000000..9a7fe6f6c11d5 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesClientInternal.md @@ -0,0 +1,59 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CasesClientInternal + +# Class: CasesClientInternal + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CasesClientInternal + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.CasesClientInternal.md#constructor) + +### Properties + +- [\_configuration](client._internal_namespace.CasesClientInternal.md#_configuration) + +### Accessors + +- [configuration](client._internal_namespace.CasesClientInternal.md#configuration) + +## Constructors + +### constructor + +• **new CasesClientInternal**(`args`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `args` | [`CasesClientArgs`](../interfaces/client._internal_namespace.CasesClientArgs.md) | + +#### Defined in + +[x-pack/plugins/cases/server/client/client_internal.ts:17](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client_internal.ts#L17) + +## Properties + +### \_configuration + +• `Private` `Readonly` **\_configuration**: `InternalConfigureSubClient` + +#### Defined in + +[x-pack/plugins/cases/server/client/client_internal.ts:15](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client_internal.ts#L15) + +## Accessors + +### configuration + +• `get` **configuration**(): `InternalConfigureSubClient` + +#### Returns + +`InternalConfigureSubClient` + +#### Defined in + +[x-pack/plugins/cases/server/client/client_internal.ts:21](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client_internal.ts#L21) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesService.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesService.md new file mode 100644 index 0000000000000..eb31fa2722c15 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.CasesService.md @@ -0,0 +1,470 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CasesService + +# Class: CasesService + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CasesService + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.CasesService.md#constructor) + +### Methods + +- [asArray](client._internal_namespace.CasesService.md#asarray) +- [buildCaseIdsAggs](client._internal_namespace.CasesService.md#buildcaseidsaggs) +- [deleteCase](client._internal_namespace.CasesService.md#deletecase) +- [findCaseStatusStats](client._internal_namespace.CasesService.md#findcasestatusstats) +- [findCases](client._internal_namespace.CasesService.md#findcases) +- [findCasesGroupedByID](client._internal_namespace.CasesService.md#findcasesgroupedbyid) +- [getAllCaseComments](client._internal_namespace.CasesService.md#getallcasecomments) +- [getAllComments](client._internal_namespace.CasesService.md#getallcomments) +- [getCase](client._internal_namespace.CasesService.md#getcase) +- [getCaseCommentStats](client._internal_namespace.CasesService.md#getcasecommentstats) +- [getCaseIdsByAlertId](client._internal_namespace.CasesService.md#getcaseidsbyalertid) +- [getCases](client._internal_namespace.CasesService.md#getcases) +- [getReporters](client._internal_namespace.CasesService.md#getreporters) +- [getResolveCase](client._internal_namespace.CasesService.md#getresolvecase) +- [getTags](client._internal_namespace.CasesService.md#gettags) +- [getUser](client._internal_namespace.CasesService.md#getuser) +- [patchCase](client._internal_namespace.CasesService.md#patchcase) +- [patchCases](client._internal_namespace.CasesService.md#patchcases) +- [postNewCase](client._internal_namespace.CasesService.md#postnewcase) +- [getCaseIDsFromAlertAggs](client._internal_namespace.CasesService.md#getcaseidsfromalertaggs) + +## Constructors + +### constructor + +• **new CasesService**(`log`, `authentication?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `log` | `Logger` | +| `authentication?` | `Object` | +| `authentication.getCurrentUser` | (`request`: [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\>) => ``null`` \| [`AuthenticatedUser`](../interfaces/client._internal_namespace.AuthenticatedUser.md) | + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:138](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L138) + +## Methods + +### asArray + +▸ `Private` **asArray**(`id`): `string`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `undefined` \| `string` \| `string`[] | + +#### Returns + +`string`[] + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:413](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L413) + +___ + +### buildCaseIdsAggs + +▸ `Private` **buildCaseIdsAggs**(`size?`): `Record`<`string`, `AggregationsAggregationContainer`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `size` | `number` | `100` | + +#### Returns + +`Record`<`string`, `AggregationsAggregationContainer`\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:143](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L143) + +___ + +### deleteCase + +▸ **deleteCase**(`__namedParameters`): `Promise`<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`GetCaseArgs`](../interfaces/client._internal_namespace.GetCaseArgs.md) | + +#### Returns + +`Promise`<{}\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:332](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L332) + +___ + +### findCaseStatusStats + +▸ **findCaseStatusStats**(`__namedParameters`): `Promise`<`number`\> + +Retrieves the number of cases that exist with a given status (open, closed, etc). + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Object` | +| `__namedParameters.caseOptions` | [`SavedObjectFindOptionsKueryNode`](../modules/client._internal_namespace.md#savedobjectfindoptionskuerynode) | +| `__namedParameters.ensureSavedObjectsAreAuthorized` | [`EnsureSOAuthCallback`](../modules/client._internal_namespace.md#ensuresoauthcallback) | +| `__namedParameters.unsecuredSavedObjectsClient` | [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) | + +#### Returns + +`Promise`<`number`\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:251](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L251) + +___ + +### findCases + +▸ **findCases**(`__namedParameters`): `Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`FindCasesArgs`](../interfaces/client._internal_namespace.FindCasesArgs.md) | + +#### Returns + +`Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, `unknown`\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:395](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L395) + +___ + +### findCasesGroupedByID + +▸ **findCasesGroupedByID**(`__namedParameters`): `Promise`<[`CasesMapWithPageInfo`](../interfaces/client._internal_namespace.CasesMapWithPageInfo.md)\> + +Returns a map of all cases. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Object` | +| `__namedParameters.caseOptions` | [`FindCaseOptions`](../modules/client._internal_namespace.md#findcaseoptions) | +| `__namedParameters.unsecuredSavedObjectsClient` | [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) | + +#### Returns + +`Promise`<[`CasesMapWithPageInfo`](../interfaces/client._internal_namespace.CasesMapWithPageInfo.md)\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:206](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L206) + +___ + +### getAllCaseComments + +▸ **getAllCaseComments**(`__namedParameters`): `Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, `unknown`\>\> + +Default behavior is to retrieve all comments that adhere to a given filter (if one is included). +to override this pass in the either the page or perPage options. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`FindCaseCommentsArgs`](../interfaces/client._internal_namespace.FindCaseCommentsArgs.md) | + +#### Returns + +`Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, `unknown`\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:455](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L455) + +___ + +### getAllComments + +▸ `Private` **getAllComments**(`__namedParameters`): `Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`FindCommentsArgs`](../interfaces/client._internal_namespace.FindCommentsArgs.md) | + +#### Returns + +`Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, `unknown`\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:423](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L423) + +___ + +### getCase + +▸ **getCase**(`__namedParameters`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`GetCaseArgs`](../interfaces/client._internal_namespace.GetCaseArgs.md) | + +#### Returns + +`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:342](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L342) + +___ + +### getCaseCommentStats + +▸ **getCaseCommentStats**(`__namedParameters`): `Promise`<[`CaseCommentStats`](../interfaces/client._internal_namespace.CaseCommentStats.md)\> + +Returns the number of total comments and alerts for a case + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Object` | +| `__namedParameters.ids` | `string`[] | +| `__namedParameters.unsecuredSavedObjectsClient` | [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) | + +#### Returns + +`Promise`<[`CaseCommentStats`](../interfaces/client._internal_namespace.CaseCommentStats.md)\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:280](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L280) + +___ + +### getCaseIdsByAlertId + +▸ **getCaseIdsByAlertId**(`__namedParameters`): `Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, { `references`: { doc\_count: number; caseIds: { buckets: { key: string; }[]; }; } }\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`GetCaseIdsByAlertIdArgs`](../interfaces/client._internal_namespace.GetCaseIdsByAlertIdArgs.md) | + +#### Returns + +`Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, { `references`: { doc\_count: number; caseIds: { buckets: { key: string; }[]; }; } }\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:161](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L161) + +___ + +### getCases + +▸ **getCases**(`__namedParameters`): `Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<{ `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`GetCasesArgs`](../interfaces/client._internal_namespace.GetCasesArgs.md) | + +#### Returns + +`Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<{ `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:379](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L379) + +___ + +### getReporters + +▸ **getReporters**(`__namedParameters`): `Promise`<{ `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` }[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`GetReportersArgs`](../interfaces/client._internal_namespace.GetReportersArgs.md) | + +#### Returns + +`Promise`<{ `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` }[]\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:488](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L488) + +___ + +### getResolveCase + +▸ **getResolveCase**(`__namedParameters`): `Promise`<[`SavedObjectsResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsResolveResponse.md)<{ `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`GetCaseArgs`](../interfaces/client._internal_namespace.GetCaseArgs.md) | + +#### Returns + +`Promise`<[`SavedObjectsResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsResolveResponse.md)<{ `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:359](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L359) + +___ + +### getTags + +▸ **getTags**(`__namedParameters`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`GetTagsArgs`](../interfaces/client._internal_namespace.GetTagsArgs.md) | + +#### Returns + +`Promise`<`string`[]\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:552](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L552) + +___ + +### getUser + +▸ **getUser**(`__namedParameters`): [`AuthenticatedUser`](../interfaces/client._internal_namespace.AuthenticatedUser.md) \| { `email`: ``null`` = null; `full_name`: ``null`` = null; `username`: ``null`` = null } + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`GetUserArgs`](../interfaces/client._internal_namespace.GetUserArgs.md) | + +#### Returns + +[`AuthenticatedUser`](../interfaces/client._internal_namespace.AuthenticatedUser.md) \| { `email`: ``null`` = null; `full_name`: ``null`` = null; `username`: ``null`` = null } + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:582](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L582) + +___ + +### patchCase + +▸ **patchCase**(`__namedParameters`): `Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<{ `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`PatchCaseArgs`](../modules/client._internal_namespace.md#patchcaseargs) | + +#### Returns + +`Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<{ `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:627](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L627) + +___ + +### patchCases + +▸ **patchCases**(`__namedParameters`): `Promise`<[`SavedObjectsBulkUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md)<{ `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`PatchCasesArgs`](../interfaces/client._internal_namespace.PatchCasesArgs.md) | + +#### Returns + +`Promise`<[`SavedObjectsBulkUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md)<{ `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:655](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L655) + +___ + +### postNewCase + +▸ **postNewCase**(`__namedParameters`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`PostCaseArgs`](../interfaces/client._internal_namespace.PostCaseArgs.md) | + +#### Returns + +`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:607](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L607) + +___ + +### getCaseIDsFromAlertAggs + +▸ `Static` **getCaseIDsFromAlertAggs**(`result`): `string`[] + +Extracts the case IDs from the alert aggregation + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `result` | [`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }, { `references`: { doc\_count: number; caseIds: { buckets: { key: string; }[]; }; } }\> | + +#### Returns + +`string`[] + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:197](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L197) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ConnectorMappingsService.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ConnectorMappingsService.md new file mode 100644 index 0000000000000..2b6649eca4111 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ConnectorMappingsService.md @@ -0,0 +1,93 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ConnectorMappingsService + +# Class: ConnectorMappingsService + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ConnectorMappingsService + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.ConnectorMappingsService.md#constructor) + +### Methods + +- [find](client._internal_namespace.ConnectorMappingsService.md#find) +- [post](client._internal_namespace.ConnectorMappingsService.md#post) +- [update](client._internal_namespace.ConnectorMappingsService.md#update) + +## Constructors + +### constructor + +• **new ConnectorMappingsService**(`log`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `log` | `Logger` | + +#### Defined in + +[x-pack/plugins/cases/server/services/connector_mappings/index.ts:33](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L33) + +## Methods + +### find + +▸ **find**(`__namedParameters`): `Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `mappings`: { action\_type: "append" \| "nothing" \| "overwrite"; source: "description" \| "title" \| "comments"; target: string; }[] ; `owner`: `string` = rt.string }, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`FindConnectorMappingsArgs`](../interfaces/client._internal_namespace.FindConnectorMappingsArgs.md) | + +#### Returns + +`Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<{ `mappings`: { action\_type: "append" \| "nothing" \| "overwrite"; source: "description" \| "title" \| "comments"; target: string; }[] ; `owner`: `string` = rt.string }, `unknown`\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/connector_mappings/index.ts:35](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L35) + +___ + +### post + +▸ **post**(`__namedParameters`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `mappings`: { action\_type: "append" \| "nothing" \| "overwrite"; source: "description" \| "title" \| "comments"; target: string; }[] ; `owner`: `string` = rt.string }\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`PostConnectorMappingsArgs`](../interfaces/client._internal_namespace.PostConnectorMappingsArgs.md) | + +#### Returns + +`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<{ `mappings`: { action\_type: "append" \| "nothing" \| "overwrite"; source: "description" \| "title" \| "comments"; target: string; }[] ; `owner`: `string` = rt.string }\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/connector_mappings/index.ts:48](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L48) + +___ + +### update + +▸ **update**(`__namedParameters`): `Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<{ `mappings`: { action\_type: "append" \| "nothing" \| "overwrite"; source: "description" \| "title" \| "comments"; target: string; }[] ; `owner`: `string` = rt.string }\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`UpdateConnectorMappingsArgs`](../interfaces/client._internal_namespace.UpdateConnectorMappingsArgs.md) | + +#### Returns + +`Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<{ `mappings`: { action\_type: "append" \| "nothing" \| "overwrite"; source: "description" \| "title" \| "comments"; target: string; }[] ; `owner`: `string` = rt.string }\>\> + +#### Defined in + +[x-pack/plugins/cases/server/services/connector_mappings/index.ts:68](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L68) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ConnectorTokenClient.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ConnectorTokenClient.md new file mode 100644 index 0000000000000..7e2a19e11efbe --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ConnectorTokenClient.md @@ -0,0 +1,162 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ConnectorTokenClient + +# Class: ConnectorTokenClient + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ConnectorTokenClient + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.ConnectorTokenClient.md#constructor) + +### Properties + +- [encryptedSavedObjectsClient](client._internal_namespace.ConnectorTokenClient.md#encryptedsavedobjectsclient) +- [logger](client._internal_namespace.ConnectorTokenClient.md#logger) +- [unsecuredSavedObjectsClient](client._internal_namespace.ConnectorTokenClient.md#unsecuredsavedobjectsclient) + +### Methods + +- [create](client._internal_namespace.ConnectorTokenClient.md#create) +- [deleteConnectorTokens](client._internal_namespace.ConnectorTokenClient.md#deleteconnectortokens) +- [get](client._internal_namespace.ConnectorTokenClient.md#get) +- [update](client._internal_namespace.ConnectorTokenClient.md#update) + +## Constructors + +### constructor + +• **new ConnectorTokenClient**(`__namedParameters`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`ConstructorOptions`](../interfaces/client._internal_namespace.ConstructorOptions-2.md) | + +#### Defined in + +x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:26 + +## Properties + +### encryptedSavedObjectsClient + +• `Private` `Readonly` **encryptedSavedObjectsClient**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:25 + +___ + +### logger + +• `Private` `Readonly` **logger**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:23 + +___ + +### unsecuredSavedObjectsClient + +• `Private` `Readonly` **unsecuredSavedObjectsClient**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:24 + +## Methods + +### create + +▸ **create**(`__namedParameters`): `Promise`<[`ConnectorToken`](../interfaces/client._internal_namespace.ConnectorToken.md)\> + +Create new token for connector + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`CreateOptions`](../interfaces/client._internal_namespace.CreateOptions-1.md) | + +#### Returns + +`Promise`<[`ConnectorToken`](../interfaces/client._internal_namespace.ConnectorToken.md)\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:30 + +___ + +### deleteConnectorTokens + +▸ **deleteConnectorTokens**(`__namedParameters`): `Promise`<{}[]\> + +Delete all connector tokens + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Object` | +| `__namedParameters.connectorId` | `string` | +| `__namedParameters.tokenType?` | `string` | + +#### Returns + +`Promise`<{}[]\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:48 + +___ + +### get + +▸ **get**(`__namedParameters`): `Promise`<{ `connectorToken`: ``null`` \| [`ConnectorToken`](../interfaces/client._internal_namespace.ConnectorToken.md) ; `hasErrors`: `boolean` }\> + +Get connector token + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Object` | +| `__namedParameters.connectorId` | `string` | +| `__namedParameters.tokenType?` | `string` | + +#### Returns + +`Promise`<{ `connectorToken`: ``null`` \| [`ConnectorToken`](../interfaces/client._internal_namespace.ConnectorToken.md) ; `hasErrors`: `boolean` }\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:38 + +___ + +### update + +▸ **update**(`__namedParameters`): `Promise`<``null`` \| [`ConnectorToken`](../interfaces/client._internal_namespace.ConnectorToken.md)\> + +Update connector token + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`UpdateOptions`](../interfaces/client._internal_namespace.UpdateOptions-1.md) | + +#### Returns + +`Promise`<``null`` \| [`ConnectorToken`](../interfaces/client._internal_namespace.ConnectorToken.md)\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:34 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ElasticsearchFeature.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ElasticsearchFeature.md new file mode 100644 index 0000000000000..95ffabe03d983 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.ElasticsearchFeature.md @@ -0,0 +1,122 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ElasticsearchFeature + +# Class: ElasticsearchFeature + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ElasticsearchFeature + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.ElasticsearchFeature.md#constructor) + +### Properties + +- [config](client._internal_namespace.ElasticsearchFeature.md#config) + +### Accessors + +- [catalogue](client._internal_namespace.ElasticsearchFeature.md#catalogue) +- [id](client._internal_namespace.ElasticsearchFeature.md#id) +- [management](client._internal_namespace.ElasticsearchFeature.md#management) +- [privileges](client._internal_namespace.ElasticsearchFeature.md#privileges) + +### Methods + +- [toRaw](client._internal_namespace.ElasticsearchFeature.md#toraw) + +## Constructors + +### constructor + +• **new ElasticsearchFeature**(`config`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | `Readonly`<{ `catalogue?`: `RecursiveReadonlyArray`<`string`\> ; `id`: `string` ; `management?`: `Readonly`<{ [x: string]: RecursiveReadonlyArray; }\> ; `privileges`: `RecursiveReadonlyArray`<[`FeatureElasticsearchPrivileges`](../interfaces/client._internal_namespace.FeatureElasticsearchPrivileges.md)\> }\> | + +#### Defined in + +x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:54 + +## Properties + +### config + +• `Protected` `Readonly` **config**: `Readonly`<{ `catalogue?`: `RecursiveReadonlyArray`<`string`\> ; `id`: `string` ; `management?`: `Readonly`<{ [x: string]: RecursiveReadonlyArray; }\> ; `privileges`: `RecursiveReadonlyArray`<[`FeatureElasticsearchPrivileges`](../interfaces/client._internal_namespace.FeatureElasticsearchPrivileges.md)\> }\> + +#### Defined in + +x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:53 + +## Accessors + +### catalogue + +• `get` **catalogue**(): `undefined` \| `RecursiveReadonlyArray`<`string`\> + +#### Returns + +`undefined` \| `RecursiveReadonlyArray`<`string`\> + +#### Defined in + +x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:56 + +___ + +### id + +• `get` **id**(): `string` + +#### Returns + +`string` + +#### Defined in + +x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:55 + +___ + +### management + +• `get` **management**(): `undefined` \| `Readonly`<{ [x: string]: `RecursiveReadonlyArray`; }\> + +#### Returns + +`undefined` \| `Readonly`<{ [x: string]: `RecursiveReadonlyArray`; }\> + +#### Defined in + +x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:57 + +___ + +### privileges + +• `get` **privileges**(): `RecursiveReadonlyArray`<[`FeatureElasticsearchPrivileges`](../interfaces/client._internal_namespace.FeatureElasticsearchPrivileges.md)\> + +#### Returns + +`RecursiveReadonlyArray`<[`FeatureElasticsearchPrivileges`](../interfaces/client._internal_namespace.FeatureElasticsearchPrivileges.md)\> + +#### Defined in + +x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:60 + +## Methods + +### toRaw + +▸ **toRaw**(): [`ElasticsearchFeatureConfig`](../interfaces/client._internal_namespace.ElasticsearchFeatureConfig.md) + +#### Returns + +[`ElasticsearchFeatureConfig`](../interfaces/client._internal_namespace.ElasticsearchFeatureConfig.md) + +#### Defined in + +x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:61 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaFeature.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaFeature.md new file mode 100644 index 0000000000000..88e1f958de6dc --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaFeature.md @@ -0,0 +1,268 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / KibanaFeature + +# Class: KibanaFeature + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).KibanaFeature + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.KibanaFeature.md#constructor) + +### Properties + +- [config](client._internal_namespace.KibanaFeature.md#config) +- [subFeatures](client._internal_namespace.KibanaFeature.md#subfeatures) + +### Accessors + +- [alerting](client._internal_namespace.KibanaFeature.md#alerting) +- [app](client._internal_namespace.KibanaFeature.md#app) +- [cases](client._internal_namespace.KibanaFeature.md#cases) +- [catalogue](client._internal_namespace.KibanaFeature.md#catalogue) +- [category](client._internal_namespace.KibanaFeature.md#category) +- [excludeFromBasePrivileges](client._internal_namespace.KibanaFeature.md#excludefrombaseprivileges) +- [id](client._internal_namespace.KibanaFeature.md#id) +- [management](client._internal_namespace.KibanaFeature.md#management) +- [minimumLicense](client._internal_namespace.KibanaFeature.md#minimumlicense) +- [name](client._internal_namespace.KibanaFeature.md#name) +- [order](client._internal_namespace.KibanaFeature.md#order) +- [privileges](client._internal_namespace.KibanaFeature.md#privileges) +- [reserved](client._internal_namespace.KibanaFeature.md#reserved) + +### Methods + +- [toRaw](client._internal_namespace.KibanaFeature.md#toraw) + +## Constructors + +### constructor + +• **new KibanaFeature**(`config`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | `Readonly`<{ `alerting?`: readonly `string`[] ; `app`: readonly `string`[] ; `cases?`: readonly `string`[] ; `catalogue?`: readonly `string`[] ; `category`: `Readonly`<{ id: string; label: string; ariaLabel?: string \| undefined; order?: number \| undefined; euiIconType?: string \| undefined; }\> ; `excludeFromBasePrivileges?`: `boolean` ; `id`: `string` ; `management?`: `Readonly`<{ [x: string]: readonly string[]; }\> ; `minimumLicense?`: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` ; `name`: `string` ; `order?`: `number` ; `privileges`: ``null`` \| `Readonly`<{ all: Readonly<{ excludeFromBasePrivileges?: boolean \| undefined; requireAllSpaces?: boolean \| undefined; disabled?: boolean \| undefined; management?: Readonly<{ [x: string]: readonly string[]; }\> \| undefined; ... 6 more ...; ui: readonly string[]; }\>; read: Readonly<...\>; }\> ; `privilegesTooltip?`: `string` ; `reserved?`: `Readonly`<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean \| undefined; requireAllSpaces?: boolean \| undefined; disabled?: boolean \| undefined; ... 7 more ...; ui: readonly string[]; }\>; }\>[]; }\> ; `subFeatures?`: readonly `Readonly`<{ name: string; privilegeGroups: readonly Readonly<{ groupType: SubFeaturePrivilegeGroupType; privileges: readonly Readonly<{ id: string; name: string; includeIn: "all" \| "none" \| "read"; ... 10 more ...; ui: readonly string[]; }\>[]; }\>[]; }\>[] }\> | + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:123 + +## Properties + +### config + +• `Protected` `Readonly` **config**: `Readonly`<{ `alerting?`: readonly `string`[] ; `app`: readonly `string`[] ; `cases?`: readonly `string`[] ; `catalogue?`: readonly `string`[] ; `category`: `Readonly`<{ id: string; label: string; ariaLabel?: string \| undefined; order?: number \| undefined; euiIconType?: string \| undefined; }\> ; `excludeFromBasePrivileges?`: `boolean` ; `id`: `string` ; `management?`: `Readonly`<{ [x: string]: readonly string[]; }\> ; `minimumLicense?`: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` ; `name`: `string` ; `order?`: `number` ; `privileges`: ``null`` \| `Readonly`<{ all: Readonly<{ excludeFromBasePrivileges?: boolean \| undefined; requireAllSpaces?: boolean \| undefined; disabled?: boolean \| undefined; management?: Readonly<{ [x: string]: readonly string[]; }\> \| undefined; ... 6 more ...; ui: readonly string[]; }\>; read: Readonly<...\>; }\> ; `privilegesTooltip?`: `string` ; `reserved?`: `Readonly`<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean \| undefined; requireAllSpaces?: boolean \| undefined; disabled?: boolean \| undefined; ... 7 more ...; ui: readonly string[]; }\>; }\>[]; }\> ; `subFeatures?`: readonly `Readonly`<{ name: string; privilegeGroups: readonly Readonly<{ groupType: SubFeaturePrivilegeGroupType; privileges: readonly Readonly<{ id: string; name: string; includeIn: "all" \| "none" \| "read"; ... 10 more ...; ui: readonly string[]; }\>[]; }\>[]; }\>[] }\> + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:121 + +___ + +### subFeatures + +• `Readonly` **subFeatures**: [`SubFeature`](client._internal_namespace.SubFeature.md)[] + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:122 + +## Accessors + +### alerting + +• `get` **alerting**(): `undefined` \| readonly `string`[] + +#### Returns + +`undefined` \| readonly `string`[] + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:202 + +___ + +### app + +• `get` **app**(): readonly `string`[] + +#### Returns + +readonly `string`[] + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:134 + +___ + +### cases + +• `get` **cases**(): `undefined` \| readonly `string`[] + +#### Returns + +`undefined` \| readonly `string`[] + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:203 + +___ + +### catalogue + +• `get` **catalogue**(): `undefined` \| readonly `string`[] + +#### Returns + +`undefined` \| readonly `string`[] + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:135 + +___ + +### category + +• `get` **category**(): `Readonly`<{ `ariaLabel?`: `string` ; `euiIconType?`: `string` ; `id`: `string` ; `label`: `string` ; `order?`: `number` }\> + +#### Returns + +`Readonly`<{ `ariaLabel?`: `string` ; `euiIconType?`: `string` ; `id`: `string` ; `label`: `string` ; `order?`: `number` }\> + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:127 + +___ + +### excludeFromBasePrivileges + +• `get` **excludeFromBasePrivileges**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:204 + +___ + +### id + +• `get` **id**(): `string` + +#### Returns + +`string` + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:124 + +___ + +### management + +• `get` **management**(): `undefined` \| `Readonly`<{ [x: string]: readonly `string`[]; }\> + +#### Returns + +`undefined` \| `Readonly`<{ [x: string]: readonly `string`[]; }\> + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:136 + +___ + +### minimumLicense + +• `get` **minimumLicense**(): `undefined` \| ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` + +#### Returns + +`undefined` \| ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:139 + +___ + +### name + +• `get` **name**(): `string` + +#### Returns + +`string` + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:125 + +___ + +### order + +• `get` **order**(): `undefined` \| `number` + +#### Returns + +`undefined` \| `number` + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:126 + +___ + +### privileges + +• `get` **privileges**(): ``null`` \| `Readonly`<{ `all`: `Readonly`<{ `alerting?`: `Readonly`<{ `alert?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> ; `rule?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> }\> ; `api?`: readonly `string`[] ; `app?`: readonly `string`[] ; `cases?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> ; `catalogue?`: readonly `string`[] ; `disabled?`: `boolean` ; `excludeFromBasePrivileges?`: `boolean` ; `management?`: `Readonly`<{ [x: string]: readonly `string`[]; }\> ; `requireAllSpaces?`: `boolean` ; `savedObject`: `Readonly`<{ `all`: readonly `string`[] ; `read`: readonly `string`[] }\> ; `ui`: readonly `string`[] }\> ; `read`: `Readonly`<{ `alerting?`: `Readonly`<{ `alert?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> ; `rule?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> }\> ; `api?`: readonly `string`[] ; `app?`: readonly `string`[] ; `cases?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> ; `catalogue?`: readonly `string`[] ; `disabled?`: `boolean` ; `excludeFromBasePrivileges?`: `boolean` ; `management?`: `Readonly`<{ [x: string]: readonly `string`[]; }\> ; `requireAllSpaces?`: `boolean` ; `savedObject`: `Readonly`<{ `all`: readonly `string`[] ; `read`: readonly `string`[] }\> ; `ui`: readonly `string`[] }\> }\> + +#### Returns + +``null`` \| `Readonly`<{ `all`: `Readonly`<{ `alerting?`: `Readonly`<{ `alert?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> ; `rule?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> }\> ; `api?`: readonly `string`[] ; `app?`: readonly `string`[] ; `cases?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> ; `catalogue?`: readonly `string`[] ; `disabled?`: `boolean` ; `excludeFromBasePrivileges?`: `boolean` ; `management?`: `Readonly`<{ [x: string]: readonly `string`[]; }\> ; `requireAllSpaces?`: `boolean` ; `savedObject`: `Readonly`<{ `all`: readonly `string`[] ; `read`: readonly `string`[] }\> ; `ui`: readonly `string`[] }\> ; `read`: `Readonly`<{ `alerting?`: `Readonly`<{ `alert?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> ; `rule?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> }\> ; `api?`: readonly `string`[] ; `app?`: readonly `string`[] ; `cases?`: `Readonly`<{ `all?`: readonly `string`[] ; `read?`: readonly `string`[] }\> ; `catalogue?`: readonly `string`[] ; `disabled?`: `boolean` ; `excludeFromBasePrivileges?`: `boolean` ; `management?`: `Readonly`<{ [x: string]: readonly `string`[]; }\> ; `requireAllSpaces?`: `boolean` ; `savedObject`: `Readonly`<{ `all`: readonly `string`[] ; `read`: readonly `string`[] }\> ; `ui`: readonly `string`[] }\> }\> + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:140 + +___ + +### reserved + +• `get` **reserved**(): `undefined` \| `Readonly`<{ `description`: `string` ; `privileges`: readonly `Readonly`<{ `id`: `string` ; `privilege`: `Readonly`<{ `alerting?`: `Readonly`<{ `alert?`: `Readonly`<{ `all?`: readonly string[] ; `read?`: readonly string[] }\> ; `rule?`: `Readonly`<{ `all?`: readonly string[] ; `read?`: readonly string[] }\> }\> ; `api?`: readonly string[] ; `app?`: readonly string[] ; `cases?`: `Readonly`<{ `all?`: readonly string[] ; `read?`: readonly string[] }\> ; `catalogue?`: readonly string[] ; `disabled?`: `boolean` ; `excludeFromBasePrivileges?`: `boolean` ; `management?`: `Readonly`<{ [x: string]: readonly `string`[]; }\> ; `requireAllSpaces?`: `boolean` ; `savedObject`: `Readonly`<{ `all`: readonly string[] ; `read`: readonly string[] }\> ; `ui`: readonly string[] }\> }\>[] }\> + +#### Returns + +`undefined` \| `Readonly`<{ `description`: `string` ; `privileges`: readonly `Readonly`<{ `id`: `string` ; `privilege`: `Readonly`<{ `alerting?`: `Readonly`<{ `alert?`: `Readonly`<{ `all?`: readonly string[] ; `read?`: readonly string[] }\> ; `rule?`: `Readonly`<{ `all?`: readonly string[] ; `read?`: readonly string[] }\> }\> ; `api?`: readonly string[] ; `app?`: readonly string[] ; `cases?`: `Readonly`<{ `all?`: readonly string[] ; `read?`: readonly string[] }\> ; `catalogue?`: readonly string[] ; `disabled?`: `boolean` ; `excludeFromBasePrivileges?`: `boolean` ; `management?`: `Readonly`<{ [x: string]: readonly `string`[]; }\> ; `requireAllSpaces?`: `boolean` ; `savedObject`: `Readonly`<{ `all`: readonly string[] ; `read`: readonly string[] }\> ; `ui`: readonly string[] }\> }\>[] }\> + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:205 + +## Methods + +### toRaw + +▸ **toRaw**(): [`KibanaFeatureConfig`](../interfaces/client._internal_namespace.KibanaFeatureConfig.md) + +#### Returns + +[`KibanaFeatureConfig`](../interfaces/client._internal_namespace.KibanaFeatureConfig.md) + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:241 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaMigrator.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaMigrator.md new file mode 100644 index 0000000000000..a26089d3ed6f4 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaMigrator.md @@ -0,0 +1,286 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / KibanaMigrator + +# Class: KibanaMigrator + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).KibanaMigrator + +Manages the shape of mappings and documents in the Kibana index. + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.KibanaMigrator.md#constructor) + +### Properties + +- [activeMappings](client._internal_namespace.KibanaMigrator.md#activemappings) +- [client](client._internal_namespace.KibanaMigrator.md#client) +- [documentMigrator](client._internal_namespace.KibanaMigrator.md#documentmigrator) +- [kibanaIndex](client._internal_namespace.KibanaMigrator.md#kibanaindex) +- [kibanaVersion](client._internal_namespace.KibanaMigrator.md#kibanaversion) +- [log](client._internal_namespace.KibanaMigrator.md#log) +- [mappingProperties](client._internal_namespace.KibanaMigrator.md#mappingproperties) +- [migrationResult](client._internal_namespace.KibanaMigrator.md#migrationresult) +- [runMigrationsInternal](client._internal_namespace.KibanaMigrator.md#runmigrationsinternal) +- [serializer](client._internal_namespace.KibanaMigrator.md#serializer) +- [soMigrationsConfig](client._internal_namespace.KibanaMigrator.md#somigrationsconfig) +- [status$](client._internal_namespace.KibanaMigrator.md#status$) +- [typeRegistry](client._internal_namespace.KibanaMigrator.md#typeregistry) + +### Methods + +- [getActiveMappings](client._internal_namespace.KibanaMigrator.md#getactivemappings) +- [getStatus$](client._internal_namespace.KibanaMigrator.md#getstatus$) +- [migrateDocument](client._internal_namespace.KibanaMigrator.md#migratedocument) +- [prepareMigrations](client._internal_namespace.KibanaMigrator.md#preparemigrations) +- [runMigrations](client._internal_namespace.KibanaMigrator.md#runmigrations) + +## Constructors + +### constructor + +• **new KibanaMigrator**(`__namedParameters`) + +Creates an instance of KibanaMigrator. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`KibanaMigratorOptions`](../interfaces/client._internal_namespace.KibanaMigratorOptions.md) | + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:42 + +## Properties + +### activeMappings + +• `Private` `Readonly` **activeMappings**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:36 + +___ + +### client + +• `Private` `Readonly` **client**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:27 + +___ + +### documentMigrator + +• `Private` `Readonly` **documentMigrator**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:28 + +___ + +### kibanaIndex + +• `Private` `Readonly` **kibanaIndex**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:29 + +___ + +### kibanaVersion + +• `Readonly` **kibanaVersion**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:38 + +___ + +### log + +• `Private` `Readonly` **log**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:30 + +___ + +### mappingProperties + +• `Private` `Readonly` **mappingProperties**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:31 + +___ + +### migrationResult + +• `Private` `Optional` **migrationResult**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:34 + +___ + +### runMigrationsInternal + +• `Private` **runMigrationsInternal**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:68 + +___ + +### serializer + +• `Private` `Readonly` **serializer**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:33 + +___ + +### soMigrationsConfig + +• `Private` `Readonly` **soMigrationsConfig**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:37 + +___ + +### status$ + +• `Private` `Readonly` **status$**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:35 + +___ + +### typeRegistry + +• `Private` `Readonly` **typeRegistry**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:32 + +## Methods + +### getActiveMappings + +▸ **getActiveMappings**(): [`IndexMapping`](../interfaces/client._internal_namespace.IndexMapping.md) + +Gets all the index mappings defined by Kibana's enabled plugins. + +#### Returns + +[`IndexMapping`](../interfaces/client._internal_namespace.IndexMapping.md) + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:73 + +___ + +### getStatus$ + +▸ **getStatus$**(): `Observable`<[`KibanaMigratorStatus`](../interfaces/client._internal_namespace.KibanaMigratorStatus.md)\> + +#### Returns + +`Observable`<[`KibanaMigratorStatus`](../interfaces/client._internal_namespace.KibanaMigratorStatus.md)\> + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:67 + +___ + +### migrateDocument + +▸ **migrateDocument**(`doc`): [`SavedObjectUnsanitizedDoc`](../modules/client._internal_namespace.md#savedobjectunsanitizeddoc)<`unknown`\> + +Migrates an individual doc to the latest version, as defined by the plugin migrations. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `doc` | [`SavedObjectUnsanitizedDoc`](../modules/client._internal_namespace.md#savedobjectunsanitizeddoc)<`unknown`\> | The saved object to migrate | + +#### Returns + +[`SavedObjectUnsanitizedDoc`](../modules/client._internal_namespace.md#savedobjectunsanitizeddoc)<`unknown`\> + +`doc` with all registered migrations applied. + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:80 + +___ + +### prepareMigrations + +▸ **prepareMigrations**(): `void` + +#### Returns + +`void` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:66 + +___ + +### runMigrations + +▸ **runMigrations**(`rerun?`): `Promise`<{ `status`: `string` }[]\> + +Migrates the mappings and documents in the Kibana index. By default, this will run only +once and subsequent calls will return the result of the original call. + +**`remarks`** When the `rerun` parameter is set to true, no checks are performed to ensure that no migration +is currently running. Chained or concurrent calls to `runMigrations({ rerun: true })` can lead to +multiple migrations running at the same time. When calling with this parameter, it's expected that the calling +code should ensure that the initial call resolves before calling the function again. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `rerun?` | `Object` | If true, method will run a new migration when called again instead of returning the result of the initial migration. This should only be used when factors external to Kibana itself alter the kibana index causing the saved objects mappings or data to change after the Kibana server performed the initial migration. | +| `rerun.rerun?` | `boolean` | - | + +#### Returns + +`Promise`<{ `status`: `string` }[]\> + +- A promise which resolves once all migrations have been applied. + The promise resolves with an array of migration statuses, one for each + elasticsearch index which was migrated. + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:61 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaRequest.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaRequest.md new file mode 100644 index 0000000000000..e0aae4835d6b7 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.KibanaRequest.md @@ -0,0 +1,347 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / KibanaRequest + +# Class: KibanaRequest + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).KibanaRequest + +Kibana specific abstraction for an incoming request. + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Params` | `unknown` | +| `Query` | `unknown` | +| `Body` | `unknown` | +| `Method` | extends [`RouteMethod`](../modules/client._internal_namespace.md#routemethod) = `any` | + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.KibanaRequest.md#constructor) + +### Properties + +- [[requestSymbol]](client._internal_namespace.KibanaRequest.md#[requestsymbol]) +- [auth](client._internal_namespace.KibanaRequest.md#auth) +- [body](client._internal_namespace.KibanaRequest.md#body) +- [events](client._internal_namespace.KibanaRequest.md#events) +- [getAuthRequired](client._internal_namespace.KibanaRequest.md#getauthrequired) +- [getEvents](client._internal_namespace.KibanaRequest.md#getevents) +- [getRouteInfo](client._internal_namespace.KibanaRequest.md#getrouteinfo) +- [headers](client._internal_namespace.KibanaRequest.md#headers) +- [id](client._internal_namespace.KibanaRequest.md#id) +- [isSystemRequest](client._internal_namespace.KibanaRequest.md#issystemrequest) +- [params](client._internal_namespace.KibanaRequest.md#params) +- [query](client._internal_namespace.KibanaRequest.md#query) +- [rewrittenUrl](client._internal_namespace.KibanaRequest.md#rewrittenurl) +- [route](client._internal_namespace.KibanaRequest.md#route) +- [socket](client._internal_namespace.KibanaRequest.md#socket) +- [url](client._internal_namespace.KibanaRequest.md#url) +- [uuid](client._internal_namespace.KibanaRequest.md#uuid) +- [withoutSecretHeaders](client._internal_namespace.KibanaRequest.md#withoutsecretheaders) +- [validate](client._internal_namespace.KibanaRequest.md#validate) + +### Methods + +- [from](client._internal_namespace.KibanaRequest.md#from) + +## Constructors + +### constructor + +• **new KibanaRequest**<`Params`, `Query`, `Body`, `Method`\>(`request`, `params`, `query`, `body`, `withoutSecretHeaders`) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Params` | `unknown` | +| `Query` | `unknown` | +| `Body` | `unknown` | +| `Method` | extends [`RouteMethod`](../modules/client._internal_namespace.md#routemethod) = `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `request` | `Request` | +| `params` | `Params` | +| `query` | `Query` | +| `body` | `Body` | +| `withoutSecretHeaders` | `boolean` | + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:126 + +## Properties + +### [requestSymbol] + +• `Protected` `Readonly` **[requestSymbol]**: `Request` + +**`internal`** + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:125 + +___ + +### auth + +• `Readonly` **auth**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `isAuthenticated` | `boolean` | + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:117 + +___ + +### body + +• `Readonly` **body**: `Body` + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:66 + +___ + +### events + +• `Readonly` **events**: [`KibanaRequestEvents`](../interfaces/client._internal_namespace.KibanaRequestEvents.md) + +Request events [KibanaRequestEvents](../interfaces/client._internal_namespace.KibanaRequestEvents.md) + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:116 + +___ + +### getAuthRequired + +• `Private` **getAuthRequired**: `any` + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:129 + +___ + +### getEvents + +• `Private` **getEvents**: `any` + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:127 + +___ + +### getRouteInfo + +• `Private` **getRouteInfo**: `any` + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:128 + +___ + +### headers + +• `Readonly` **headers**: [`Headers`](../modules/client._internal_namespace.md#headers) + +Readonly copy of incoming request headers. + +**`remarks`** +This property will contain a `filtered` copy of request headers. + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:107 + +___ + +### id + +• `Readonly` **id**: `string` + +A identifier to identify this request. + +**`remarks`** +Depending on the user's configuration, this value may be sourced from the +incoming request's `X-Opaque-Id` header which is not guaranteed to be unique +per request. + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:89 + +___ + +### isSystemRequest + +• `Readonly` **isSystemRequest**: `boolean` + +Whether or not the request is a "system request" rather than an application-level request. +Can be set on the client using the `HttpFetchOptions#asSystemRequest` option. + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:112 + +___ + +### params + +• `Readonly` **params**: `Params` + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:64 + +___ + +### query + +• `Readonly` **query**: `Query` + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:65 + +___ + +### rewrittenUrl + +• `Optional` `Readonly` **rewrittenUrl**: `URL` + +URL rewritten in onPreRouting request interceptor. + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:123 + +___ + +### route + +• `Readonly` **route**: `Readonly`<{ `method`: `RecursiveReadonly`<`Method`\> ; `options`: `RecursiveReadonly`<[`KibanaRequestRouteOptions`](../modules/client._internal_namespace.md#kibanarequestrouteoptions)<`Method`\>\> ; `path`: `string` }\> + +matched route details + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:101 + +___ + +### socket + +• `Readonly` **socket**: [`IKibanaSocket`](../interfaces/client._internal_namespace.IKibanaSocket.md) + +[IKibanaSocket](../interfaces/client._internal_namespace.IKibanaSocket.md) + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:114 + +___ + +### url + +• `Readonly` **url**: `URL` + +a WHATWG URL standard object. + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:99 + +___ + +### uuid + +• `Readonly` **uuid**: `string` + +A UUID to identify this request. + +**`remarks`** +This value is NOT sourced from the incoming request's `X-Opaque-Id` header. it +is always a UUID uniquely identifying the request. + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:97 + +___ + +### withoutSecretHeaders + +• `Private` `Readonly` **withoutSecretHeaders**: `any` + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:67 + +___ + +### validate + +▪ `Static` `Private` **validate**: `any` + +Validates the different parts of a request based on the schemas defined for +the route. Builds up the actual params, query and body object that will be +received in the route handler. + +**`internal`** + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:80 + +## Methods + +### from + +▸ `Static` **from**<`P`, `Q`, `B`\>(`req`, `routeSchemas?`, `withoutSecretHeaders?`): [`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`P`, `Q`, `B`, `any`\> + +Factory for creating requests. Validates the request before creating an +instance of a KibanaRequest. + +**`internal`** + +#### Type parameters + +| Name | +| :------ | +| `P` | +| `Q` | +| `B` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | `Request` | +| `routeSchemas?` | [`RouteValidator`](client._internal_namespace.RouteValidator.md)<`P`, `Q`, `B`\> \| [`RouteValidatorFullConfig`](../modules/client._internal_namespace.md#routevalidatorfullconfig)<`P`, `Q`, `B`\> | +| `withoutSecretHeaders?` | `boolean` | + +#### Returns + +[`KibanaRequest`](client._internal_namespace.KibanaRequest.md)<`P`, `Q`, `B`, `any`\> + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:73 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.LicenseState.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.LicenseState.md new file mode 100644 index 0000000000000..9b8af11cd73cf --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.LicenseState.md @@ -0,0 +1,215 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / LicenseState + +# Class: LicenseState + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).LicenseState + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.LicenseState.md#constructor) + +### Properties + +- [\_notifyUsage](client._internal_namespace.LicenseState.md#_notifyusage) +- [license](client._internal_namespace.LicenseState.md#license) +- [licenseInformation](client._internal_namespace.LicenseState.md#licenseinformation) +- [notifyUsage](client._internal_namespace.LicenseState.md#notifyusage) +- [subscription](client._internal_namespace.LicenseState.md#subscription) +- [updateInformation](client._internal_namespace.LicenseState.md#updateinformation) + +### Methods + +- [checkLicense](client._internal_namespace.LicenseState.md#checklicense) +- [clean](client._internal_namespace.LicenseState.md#clean) +- [ensureLicenseForActionType](client._internal_namespace.LicenseState.md#ensurelicenseforactiontype) +- [getLicenseInformation](client._internal_namespace.LicenseState.md#getlicenseinformation) +- [isLicenseValidForActionType](client._internal_namespace.LicenseState.md#islicensevalidforactiontype) +- [setNotifyUsage](client._internal_namespace.LicenseState.md#setnotifyusage) + +## Constructors + +### constructor + +• **new LicenseState**(`license$`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `license$` | `Observable`<[`ILicense`](../interfaces/client._internal_namespace.ILicense.md)\> | + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:17 + +## Properties + +### \_notifyUsage + +• `Private` **\_notifyUsage**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:16 + +___ + +### license + +• `Private` `Optional` **license**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:15 + +___ + +### licenseInformation + +• `Private` **licenseInformation**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:13 + +___ + +### notifyUsage + +• `Private` **notifyUsage**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:30 + +___ + +### subscription + +• `Private` **subscription**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:14 + +___ + +### updateInformation + +• `Private` **updateInformation**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:18 + +## Methods + +### checkLicense + +▸ **checkLicense**(`license`): [`ActionsLicenseInformation`](../interfaces/client._internal_namespace.ActionsLicenseInformation.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `license` | `undefined` \| [`ILicense`](../interfaces/client._internal_namespace.ILicense.md) | + +#### Returns + +[`ActionsLicenseInformation`](../interfaces/client._internal_namespace.ActionsLicenseInformation.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:32 + +___ + +### clean + +▸ **clean**(): `void` + +#### Returns + +`void` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:20 + +___ + +### ensureLicenseForActionType + +▸ **ensureLicenseForActionType**(`actionType`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `actionType` | [`ActionType`](../interfaces/client._internal_namespace.ActionType-1.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig), [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets), [`ActionTypeParams`](../modules/client._internal_namespace.md#actiontypeparams), `void`\> | + +#### Returns + +`void` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:31 + +___ + +### getLicenseInformation + +▸ **getLicenseInformation**(): [`ActionsLicenseInformation`](../interfaces/client._internal_namespace.ActionsLicenseInformation.md) + +#### Returns + +[`ActionsLicenseInformation`](../interfaces/client._internal_namespace.ActionsLicenseInformation.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:21 + +___ + +### isLicenseValidForActionType + +▸ **isLicenseValidForActionType**(`actionType`, `__namedParameters?`): { `isValid`: ``true`` } \| { `isValid`: ``false`` ; `reason`: ``"unavailable"`` \| ``"expired"`` \| ``"invalid"`` } + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `actionType` | [`ActionType`](../interfaces/client._internal_namespace.ActionType-1.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig), [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets), [`ActionTypeParams`](../modules/client._internal_namespace.md#actiontypeparams), `void`\> | +| `__namedParameters?` | `Object` | +| `__namedParameters.notifyUsage` | `boolean` | + +#### Returns + +{ `isValid`: ``true`` } \| { `isValid`: ``false`` ; `reason`: ``"unavailable"`` \| ``"expired"`` \| ``"invalid"`` } + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:22 + +___ + +### setNotifyUsage + +▸ **setNotifyUsage**(`notifyUsage`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `notifyUsage` | (`featureName`: `string`, `usedAt?`: `number` \| `Date`) => `void` | + +#### Returns + +`void` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:19 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.RouteValidationError.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.RouteValidationError.md new file mode 100644 index 0000000000000..a9fcf909bd74a --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.RouteValidationError.md @@ -0,0 +1,40 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / RouteValidationError + +# Class: RouteValidationError + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).RouteValidationError + +Error to return when the validation is not successful. + +## Hierarchy + +- `SchemaTypeError` + + ↳ **`RouteValidationError`** + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.RouteValidationError.md#constructor) + +## Constructors + +### constructor + +• **new RouteValidationError**(`error`, `path?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | `string` \| `Error` | +| `path?` | `string`[] | + +#### Overrides + +SchemaTypeError.constructor + +#### Defined in + +src/core/target/types/server/http/router/validator/validator_error.d.ts:7 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.RouteValidator.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.RouteValidator.md new file mode 100644 index 0000000000000..bf73fbda85719 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.RouteValidator.md @@ -0,0 +1,272 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / RouteValidator + +# Class: RouteValidator + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).RouteValidator + +Route validator class to define the validation logic for each new route. + +**`internal`** + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `P` | {} | +| `Q` | {} | +| `B` | {} | + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.RouteValidator.md#constructor) + +### Properties + +- [config](client._internal_namespace.RouteValidator.md#config) +- [customValidation](client._internal_namespace.RouteValidator.md#customvalidation) +- [options](client._internal_namespace.RouteValidator.md#options) +- [preValidateSchema](client._internal_namespace.RouteValidator.md#prevalidateschema) +- [safetyPostchecks](client._internal_namespace.RouteValidator.md#safetypostchecks) +- [safetyPrechecks](client._internal_namespace.RouteValidator.md#safetyprechecks) +- [validate](client._internal_namespace.RouteValidator.md#validate) +- [validateFunction](client._internal_namespace.RouteValidator.md#validatefunction) +- [ResultFactory](client._internal_namespace.RouteValidator.md#resultfactory) + +### Methods + +- [getBody](client._internal_namespace.RouteValidator.md#getbody) +- [getParams](client._internal_namespace.RouteValidator.md#getparams) +- [getQuery](client._internal_namespace.RouteValidator.md#getquery) +- [hasBody](client._internal_namespace.RouteValidator.md#hasbody) +- [from](client._internal_namespace.RouteValidator.md#from) + +## Constructors + +### constructor + +• `Private` **new RouteValidator**<`P`, `Q`, `B`\>() + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `P` | {} | +| `Q` | {} | +| `B` | {} | + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:112 + +## Properties + +### config + +• `Private` `Readonly` **config**: `any` + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:108 + +___ + +### customValidation + +• `Private` **customValidation**: `any` + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:136 + +___ + +### options + +• `Private` `Readonly` **options**: `any` + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:109 + +___ + +### preValidateSchema + +• `Private` **preValidateSchema**: `any` + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:138 + +___ + +### safetyPostchecks + +• `Private` **safetyPostchecks**: `any` + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:135 + +___ + +### safetyPrechecks + +• `Private` **safetyPrechecks**: `any` + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:134 + +___ + +### validate + +• `Private` **validate**: `any` + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:133 + +___ + +### validateFunction + +• `Private` **validateFunction**: `any` + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:137 + +___ + +### ResultFactory + +▪ `Static` `Private` **ResultFactory**: `any` + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:111 + +## Methods + +### getBody + +▸ **getBody**(`data`, `namespace?`): `Readonly`<`B`\> + +Get validated body + +**`internal`** + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `unknown` | +| `namespace?` | `string` | + +#### Returns + +`Readonly`<`B`\> + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:127 + +___ + +### getParams + +▸ **getParams**(`data`, `namespace?`): `Readonly`<`P`\> + +Get validated URL params + +**`internal`** + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `unknown` | +| `namespace?` | `string` | + +#### Returns + +`Readonly`<`P`\> + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:117 + +___ + +### getQuery + +▸ **getQuery**(`data`, `namespace?`): `Readonly`<`Q`\> + +Get validated query params + +**`internal`** + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `unknown` | +| `namespace?` | `string` | + +#### Returns + +`Readonly`<`Q`\> + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:122 + +___ + +### hasBody + +▸ **hasBody**(): `boolean` + +Has body validation + +**`internal`** + +#### Returns + +`boolean` + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:132 + +___ + +### from + +▸ `Static` **from**<`_P`, `_Q`, `_B`\>(`opts`): [`RouteValidator`](client._internal_namespace.RouteValidator.md)<`_P`, `_Q`, `_B`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `_P` | {} | +| `_Q` | {} | +| `_B` | {} | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | [`RouteValidator`](client._internal_namespace.RouteValidator.md)<`_P`, `_Q`, `_B`\> \| [`RouteValidatorFullConfig`](../modules/client._internal_namespace.md#routevalidatorfullconfig)<`_P`, `_Q`, `_B`\> | + +#### Returns + +[`RouteValidator`](client._internal_namespace.RouteValidator.md)<`_P`, `_Q`, `_B`\> + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:110 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectActions.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectActions.md new file mode 100644 index 0000000000000..cced678be25cc --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectActions.md @@ -0,0 +1,66 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectActions + +# Class: SavedObjectActions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectActions + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.SavedObjectActions.md#constructor) + +### Properties + +- [prefix](client._internal_namespace.SavedObjectActions.md#prefix) + +### Methods + +- [get](client._internal_namespace.SavedObjectActions.md#get) + +## Constructors + +### constructor + +• **new SavedObjectActions**(`versionNumber`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `versionNumber` | `string` | + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/saved_object.d.ts:3 + +## Properties + +### prefix + +• `Private` `Readonly` **prefix**: `any` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/saved_object.d.ts:2 + +## Methods + +### get + +▸ **get**(`type`, `operation`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | +| `operation` | `string` | + +#### Returns + +`string` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/saved_object.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectTypeRegistry.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectTypeRegistry.md new file mode 100644 index 0000000000000..bc38c9d6773b1 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectTypeRegistry.md @@ -0,0 +1,306 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectTypeRegistry + +# Class: SavedObjectTypeRegistry + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectTypeRegistry + +Registry holding information about all the registered [saved object types](../interfaces/client._internal_namespace.SavedObjectsType.md). + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.SavedObjectTypeRegistry.md#constructor) + +### Properties + +- [types](client._internal_namespace.SavedObjectTypeRegistry.md#types) + +### Methods + +- [getAllTypes](client._internal_namespace.SavedObjectTypeRegistry.md#getalltypes) +- [getImportableAndExportableTypes](client._internal_namespace.SavedObjectTypeRegistry.md#getimportableandexportabletypes) +- [getIndex](client._internal_namespace.SavedObjectTypeRegistry.md#getindex) +- [getType](client._internal_namespace.SavedObjectTypeRegistry.md#gettype) +- [getVisibleTypes](client._internal_namespace.SavedObjectTypeRegistry.md#getvisibletypes) +- [isHidden](client._internal_namespace.SavedObjectTypeRegistry.md#ishidden) +- [isImportableAndExportable](client._internal_namespace.SavedObjectTypeRegistry.md#isimportableandexportable) +- [isMultiNamespace](client._internal_namespace.SavedObjectTypeRegistry.md#ismultinamespace) +- [isNamespaceAgnostic](client._internal_namespace.SavedObjectTypeRegistry.md#isnamespaceagnostic) +- [isShareable](client._internal_namespace.SavedObjectTypeRegistry.md#isshareable) +- [isSingleNamespace](client._internal_namespace.SavedObjectTypeRegistry.md#issinglenamespace) +- [registerType](client._internal_namespace.SavedObjectTypeRegistry.md#registertype) + +## Constructors + +### constructor + +• **new SavedObjectTypeRegistry**() + +## Properties + +### types + +• `Private` `Readonly` **types**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:14 + +## Methods + +### getAllTypes + +▸ **getAllTypes**(): [`SavedObjectsType`](../interfaces/client._internal_namespace.SavedObjectsType.md)<`any`\>[] + +Return all [types](../interfaces/client._internal_namespace.SavedObjectsType.md) currently registered, including the hidden ones. + +To only get the visible types (which is the most common use case), use `getVisibleTypes` instead. + +#### Returns + +[`SavedObjectsType`](../interfaces/client._internal_namespace.SavedObjectsType.md)<`any`\>[] + +#### Defined in + +src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:35 + +___ + +### getImportableAndExportableTypes + +▸ **getImportableAndExportableTypes**(): [`SavedObjectsType`](../interfaces/client._internal_namespace.SavedObjectsType.md)<`any`\>[] + +Return all [types](../interfaces/client._internal_namespace.SavedObjectsType.md) currently registered that are importable/exportable. + +#### Returns + +[`SavedObjectsType`](../interfaces/client._internal_namespace.SavedObjectsType.md)<`any`\>[] + +#### Defined in + +src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:39 + +___ + +### getIndex + +▸ **getIndex**(`type`): `undefined` \| `string` + +Returns the `indexPattern` property for given type, or `undefined` if +the type is not registered. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | + +#### Returns + +`undefined` \| `string` + +#### Defined in + +src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:69 + +___ + +### getType + +▸ **getType**(`type`): `undefined` \| [`SavedObjectsType`](../interfaces/client._internal_namespace.SavedObjectsType.md)<`any`\> + +Return the [type](../interfaces/client._internal_namespace.SavedObjectsType.md) definition for given type name. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | + +#### Returns + +`undefined` \| [`SavedObjectsType`](../interfaces/client._internal_namespace.SavedObjectsType.md)<`any`\> + +#### Defined in + +src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:23 + +___ + +### getVisibleTypes + +▸ **getVisibleTypes**(): [`SavedObjectsType`](../interfaces/client._internal_namespace.SavedObjectsType.md)<`any`\>[] + +Returns all visible [types](../interfaces/client._internal_namespace.SavedObjectsType.md). + +A visible type is a type that doesn't explicitly define `hidden=true` during registration. + +#### Returns + +[`SavedObjectsType`](../interfaces/client._internal_namespace.SavedObjectsType.md)<`any`\>[] + +#### Defined in + +src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:29 + +___ + +### isHidden + +▸ **isHidden**(`type`): `boolean` + +Returns the `hidden` property for given type, or `false` if +the type is not registered. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:64 + +___ + +### isImportableAndExportable + +▸ **isImportableAndExportable**(`type`): `boolean` + +Returns the `management.importableAndExportable` property for given type, or +`false` if the type is not registered or does not define a management section. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:74 + +___ + +### isMultiNamespace + +▸ **isMultiNamespace**(`type`): `boolean` + +Returns whether the type is multi-namespace (shareable *or* isolated); +resolves to `false` if the type is not registered + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:54 + +___ + +### isNamespaceAgnostic + +▸ **isNamespaceAgnostic**(`type`): `boolean` + +Returns whether the type is namespace-agnostic (global); +resolves to `false` if the type is not registered + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:44 + +___ + +### isShareable + +▸ **isShareable**(`type`): `boolean` + +Returns whether the type is multi-namespace (shareable); +resolves to `false` if the type is not registered + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:59 + +___ + +### isSingleNamespace + +▸ **isSingleNamespace**(`type`): `boolean` + +Returns whether the type is single-namespace (isolated); +resolves to `true` if the type is not registered + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:49 + +___ + +### registerType + +▸ **registerType**(`type`): `void` + +Register a [type](../interfaces/client._internal_namespace.SavedObjectsType.md) inside the registry. +A type can only be registered once. subsequent calls with the same type name will throw an error. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | [`SavedObjectsType`](../interfaces/client._internal_namespace.SavedObjectsType.md)<`any`\> | + +#### Returns + +`void` + +#### Defined in + +src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:19 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsClient.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsClient.md new file mode 100644 index 0000000000000..1d97deadff81a --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsClient.md @@ -0,0 +1,617 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsClient + +# Class: SavedObjectsClient + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsClient + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.SavedObjectsClient.md#constructor) + +### Properties + +- [\_repository](client._internal_namespace.SavedObjectsClient.md#_repository) +- [errors](client._internal_namespace.SavedObjectsClient.md#errors) +- [errors](client._internal_namespace.SavedObjectsClient.md#errors) + +### Methods + +- [bulkCreate](client._internal_namespace.SavedObjectsClient.md#bulkcreate) +- [bulkGet](client._internal_namespace.SavedObjectsClient.md#bulkget) +- [bulkResolve](client._internal_namespace.SavedObjectsClient.md#bulkresolve) +- [bulkUpdate](client._internal_namespace.SavedObjectsClient.md#bulkupdate) +- [checkConflicts](client._internal_namespace.SavedObjectsClient.md#checkconflicts) +- [closePointInTime](client._internal_namespace.SavedObjectsClient.md#closepointintime) +- [collectMultiNamespaceReferences](client._internal_namespace.SavedObjectsClient.md#collectmultinamespacereferences) +- [create](client._internal_namespace.SavedObjectsClient.md#create) +- [createPointInTimeFinder](client._internal_namespace.SavedObjectsClient.md#createpointintimefinder) +- [delete](client._internal_namespace.SavedObjectsClient.md#delete) +- [find](client._internal_namespace.SavedObjectsClient.md#find) +- [get](client._internal_namespace.SavedObjectsClient.md#get) +- [openPointInTimeForType](client._internal_namespace.SavedObjectsClient.md#openpointintimefortype) +- [removeReferencesTo](client._internal_namespace.SavedObjectsClient.md#removereferencesto) +- [resolve](client._internal_namespace.SavedObjectsClient.md#resolve) +- [update](client._internal_namespace.SavedObjectsClient.md#update) +- [updateObjectsSpaces](client._internal_namespace.SavedObjectsClient.md#updateobjectsspaces) + +## Constructors + +### constructor + +• **new SavedObjectsClient**(`repository`) + +**`internal`** + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `repository` | [`ISavedObjectsRepository`](../modules/client._internal_namespace.md#isavedobjectsrepository) | + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:371 + +## Properties + +### \_repository + +• `Private` **\_repository**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:369 + +___ + +### errors + +• **errors**: typeof [`SavedObjectsErrorHelpers`](client._internal_namespace.SavedObjectsErrorHelpers.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:368 + +___ + +### errors + +▪ `Static` **errors**: typeof [`SavedObjectsErrorHelpers`](client._internal_namespace.SavedObjectsErrorHelpers.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:367 + +## Methods + +### bulkCreate + +▸ **bulkCreate**<`T`\>(`objects`, `options?`): `Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<`T`\>\> + +Persists multiple documents batched together as a single request + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `objects` | [`SavedObjectsBulkCreateObject`](../interfaces/client._internal_namespace.SavedObjectsBulkCreateObject.md)<`T`\>[] | +| `options?` | [`SavedObjectsCreateOptions`](../interfaces/client._internal_namespace.SavedObjectsCreateOptions.md) | + +#### Returns + +`Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<`T`\>\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:386 + +___ + +### bulkGet + +▸ **bulkGet**<`T`\>(`objects?`, `options?`): `Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<`T`\>\> + +Returns an array of objects by id + +**`example`** + +bulkGet([ + { id: 'one', type: 'config' }, + { id: 'foo', type: 'index-pattern' } +]) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `objects?` | [`SavedObjectsBulkGetObject`](../interfaces/client._internal_namespace.SavedObjectsBulkGetObject.md)[] | an array of ids, or an array of objects containing id, type and optionally fields | +| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | - | + +#### Returns + +`Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<`T`\>\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:420 + +___ + +### bulkResolve + +▸ **bulkResolve**<`T`\>(`objects`, `options?`): `Promise`<[`SavedObjectsBulkResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResolveResponse.md)<`T`\>\> + +Resolves an array of objects by id, using any legacy URL aliases if they exist + +**`example`** + +bulkResolve([ + { id: 'one', type: 'config' }, + { id: 'foo', type: 'index-pattern' } +]) + +**`note`** Saved objects that Kibana fails to find are replaced with an error object and an "exactMatch" outcome. The rationale behind the +outcome is that "exactMatch" is the default outcome, and the outcome only changes if an alias is found. This behavior is unique to +`bulkResolve`; the regular `resolve` API will throw an error instead. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `objects` | [`SavedObjectsBulkResolveObject`](../interfaces/client._internal_namespace.SavedObjectsBulkResolveObject.md)[] | an array of objects containing id, type | +| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | - | + +#### Returns + +`Promise`<[`SavedObjectsBulkResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResolveResponse.md)<`T`\>\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:444 + +___ + +### bulkUpdate + +▸ **bulkUpdate**<`T`\>(`objects`, `options?`): `Promise`<[`SavedObjectsBulkUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md)<`T`\>\> + +Bulk Updates multiple SavedObject at once + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `objects` | [`SavedObjectsBulkUpdateObject`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateObject.md)<`T`\>[] | +| `options?` | [`SavedObjectsBulkUpdateOptions`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateOptions.md) | + +#### Returns + +`Promise`<[`SavedObjectsBulkUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md)<`T`\>\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:466 + +___ + +### checkConflicts + +▸ **checkConflicts**(`objects?`, `options?`): `Promise`<[`SavedObjectsCheckConflictsResponse`](../interfaces/client._internal_namespace.SavedObjectsCheckConflictsResponse.md)\> + +Check what conflicts will result when creating a given array of saved objects. This includes "unresolvable conflicts", which are +multi-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `objects?` | [`SavedObjectsCheckConflictsObject`](../interfaces/client._internal_namespace.SavedObjectsCheckConflictsObject.md)[] | +| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | + +#### Returns + +`Promise`<[`SavedObjectsCheckConflictsResponse`](../interfaces/client._internal_namespace.SavedObjectsCheckConflictsResponse.md)\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:394 + +___ + +### closePointInTime + +▸ **closePointInTime**(`id`, `options?`): `Promise`<[`SavedObjectsClosePointInTimeResponse`](../interfaces/client._internal_namespace.SavedObjectsClosePointInTimeResponse.md)\> + +Closes a Point In Time (PIT) by ID. This simply proxies the request to ES via the +Elasticsearch client, and is included in the Saved Objects Client as a convenience +for consumers who are using [SavedObjectsClient.openPointInTimeForType](client._internal_namespace.SavedObjectsClient.md#openpointintimefortype). + +Only use this API if you have an advanced use case that's not solved by the +[SavedObjectsClient.createPointInTimeFinder](client._internal_namespace.SavedObjectsClient.md#createpointintimefinder) method. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | + +#### Returns + +`Promise`<[`SavedObjectsClosePointInTimeResponse`](../interfaces/client._internal_namespace.SavedObjectsClosePointInTimeResponse.md)\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:488 + +___ + +### collectMultiNamespaceReferences + +▸ **collectMultiNamespaceReferences**(`objects`, `options?`): `Promise`<[`SavedObjectsCollectMultiNamespaceReferencesResponse`](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesResponse.md)\> + +Gets all references and transitive references of the listed objects. Ignores any object that is not a multi-namespace type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `objects` | [`SavedObjectsCollectMultiNamespaceReferencesObject`](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesObject.md)[] | +| `options?` | [`SavedObjectsCollectMultiNamespaceReferencesOptions`](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesOptions.md) | + +#### Returns + +`Promise`<[`SavedObjectsCollectMultiNamespaceReferencesResponse`](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesResponse.md)\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:541 + +___ + +### create + +▸ **create**<`T`\>(`type`, `attributes`, `options?`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> + +Persists a SavedObject + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | +| `attributes` | `T` | +| `options?` | [`SavedObjectsCreateOptions`](../interfaces/client._internal_namespace.SavedObjectsCreateOptions.md) | + +#### Returns + +`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:379 + +___ + +### createPointInTimeFinder + +▸ **createPointInTimeFinder**<`T`, `A`\>(`findOptions`, `dependencies?`): [`ISavedObjectsPointInTimeFinder`](../interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md)<`T`, `A`\> + +Returns a [ISavedObjectsPointInTimeFinder](../interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md) to help page through +large sets of saved objects. We strongly recommend using this API for +any `find` queries that might return more than 1000 saved objects, +however this API is only intended for use in server-side "batch" +processing of objects where you are collecting all objects in memory +or streaming them back to the client. + +Do NOT use this API in a route handler to facilitate paging through +saved objects on the client-side unless you are streaming all of the +results back to the client at once. Because the returned generator is +stateful, you cannot rely on subsequent http requests retrieving new +pages from the same Kibana server in multi-instance deployments. + +The generator wraps calls to [SavedObjectsClient.find](client._internal_namespace.SavedObjectsClient.md#find) and iterates +over multiple pages of results using `_pit` and `search_after`. This will +open a new Point-In-Time (PIT), and continue paging until a set of +results is received that's smaller than the designated `perPage`. + +Once you have retrieved all of the results you need, it is recommended +to call `close()` to clean up the PIT and prevent Elasticsearch from +consuming resources unnecessarily. This is only required if you are +done iterating and have not yet paged through all of the results: the +PIT will automatically be closed for you once you reach the last page +of results, or if the underlying call to `find` fails for any reason. + +**`example`** +```ts +const findOptions: SavedObjectsCreatePointInTimeFinderOptions = { + type: 'visualization', + search: 'foo*', + perPage: 100, +}; + +const finder = savedObjectsClient.createPointInTimeFinder(findOptions); + +const responses: SavedObjectFindResponse[] = []; +for await (const response of finder.find()) { + responses.push(...response); + if (doneSearching) { + await finder.close(); + } +} +``` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | +| `A` | `unknown` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `findOptions` | [`SavedObjectsCreatePointInTimeFinderOptions`](../modules/client._internal_namespace.md#savedobjectscreatepointintimefinderoptions) | +| `dependencies?` | [`SavedObjectsCreatePointInTimeFinderDependencies`](../interfaces/client._internal_namespace.SavedObjectsCreatePointInTimeFinderDependencies.md) | + +#### Returns + +[`ISavedObjectsPointInTimeFinder`](../interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md)<`T`, `A`\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:534 + +___ + +### delete + +▸ **delete**(`type`, `id`, `options?`): `Promise`<{}\> + +Deletes a SavedObject + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | +| `id` | `string` | +| `options?` | [`SavedObjectsDeleteOptions`](../interfaces/client._internal_namespace.SavedObjectsDeleteOptions.md) | + +#### Returns + +`Promise`<{}\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:402 + +___ + +### find + +▸ **find**<`T`, `A`\>(`options`): `Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<`T`, `A`\>\> + +Find all SavedObjects matching the search query + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | +| `A` | `unknown` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | [`SavedObjectsFindOptions`](../interfaces/client._internal_namespace.SavedObjectsFindOptions.md) | + +#### Returns + +`Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<`T`, `A`\>\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:408 + +___ + +### get + +▸ **get**<`T`\>(`type`, `id`, `options?`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> + +Retrieves a single object + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | `string` | The type of SavedObject to retrieve | +| `id` | `string` | The ID of the SavedObject to retrieve | +| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | | + +#### Returns + +`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:428 + +___ + +### openPointInTimeForType + +▸ **openPointInTimeForType**(`type`, `options?`): `Promise`<[`SavedObjectsOpenPointInTimeResponse`](../interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeResponse.md)\> + +Opens a Point In Time (PIT) against the indices for the specified Saved Object types. +The returned `id` can then be passed to [SavedObjectsClient.find](client._internal_namespace.SavedObjectsClient.md#find) to search +against that PIT. + +Only use this API if you have an advanced use case that's not solved by the +[SavedObjectsClient.createPointInTimeFinder](client._internal_namespace.SavedObjectsClient.md#createpointintimefinder) method. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` \| `string`[] | +| `options?` | [`SavedObjectsOpenPointInTimeOptions`](../interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md) | + +#### Returns + +`Promise`<[`SavedObjectsOpenPointInTimeResponse`](../interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeResponse.md)\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:479 + +___ + +### removeReferencesTo + +▸ **removeReferencesTo**(`type`, `id`, `options?`): `Promise`<[`SavedObjectsRemoveReferencesToResponse`](../interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md)\> + +Updates all objects containing a reference to the given {type, id} tuple to remove the said reference. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | +| `id` | `string` | +| `options?` | [`SavedObjectsRemoveReferencesToOptions`](../interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToOptions.md) | + +#### Returns + +`Promise`<[`SavedObjectsRemoveReferencesToResponse`](../interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md)\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:470 + +___ + +### resolve + +▸ **resolve**<`T`\>(`type`, `id`, `options?`): `Promise`<[`SavedObjectsResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsResolveResponse.md)<`T`\>\> + +Resolves a single object, using any legacy URL alias if it exists + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | `string` | The type of SavedObject to retrieve | +| `id` | `string` | The ID of the SavedObject to retrieve | +| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | | + +#### Returns + +`Promise`<[`SavedObjectsResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsResolveResponse.md)<`T`\>\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:452 + +___ + +### update + +▸ **update**<`T`\>(`type`, `id`, `attributes`, `options?`): `Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<`T`\>\> + +Updates an SavedObject + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | +| `id` | `string` | +| `attributes` | `Partial`<`T`\> | +| `options?` | [`SavedObjectsUpdateOptions`](../interfaces/client._internal_namespace.SavedObjectsUpdateOptions.md)<`T`\> | + +#### Returns + +`Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<`T`\>\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:460 + +___ + +### updateObjectsSpaces + +▸ **updateObjectsSpaces**(`objects`, `spacesToAdd`, `spacesToRemove`, `options?`): `Promise`<[`SavedObjectsUpdateObjectsSpacesResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponse.md)\> + +Updates one or more objects to add and/or remove them from specified spaces. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `objects` | [`SavedObjectsUpdateObjectsSpacesObject`](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md)[] | +| `spacesToAdd` | `string`[] | +| `spacesToRemove` | `string`[] | +| `options?` | [`SavedObjectsUpdateObjectsSpacesOptions`](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesOptions.md) | + +#### Returns + +`Promise`<[`SavedObjectsUpdateObjectsSpacesResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponse.md)\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:550 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsErrorHelpers.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsErrorHelpers.md new file mode 100644 index 0000000000000..c428ccb237f1b --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsErrorHelpers.md @@ -0,0 +1,665 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsErrorHelpers + +# Class: SavedObjectsErrorHelpers + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsErrorHelpers + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.SavedObjectsErrorHelpers.md#constructor) + +### Methods + +- [createBadRequestError](client._internal_namespace.SavedObjectsErrorHelpers.md#createbadrequesterror) +- [createConflictError](client._internal_namespace.SavedObjectsErrorHelpers.md#createconflicterror) +- [createGenericNotFoundError](client._internal_namespace.SavedObjectsErrorHelpers.md#creategenericnotfounderror) +- [createGenericNotFoundEsUnavailableError](client._internal_namespace.SavedObjectsErrorHelpers.md#creategenericnotfoundesunavailableerror) +- [createIndexAliasNotFoundError](client._internal_namespace.SavedObjectsErrorHelpers.md#createindexaliasnotfounderror) +- [createInvalidVersionError](client._internal_namespace.SavedObjectsErrorHelpers.md#createinvalidversionerror) +- [createTooManyRequestsError](client._internal_namespace.SavedObjectsErrorHelpers.md#createtoomanyrequestserror) +- [createUnsupportedTypeError](client._internal_namespace.SavedObjectsErrorHelpers.md#createunsupportedtypeerror) +- [decorateBadRequestError](client._internal_namespace.SavedObjectsErrorHelpers.md#decoratebadrequesterror) +- [decorateConflictError](client._internal_namespace.SavedObjectsErrorHelpers.md#decorateconflicterror) +- [decorateEsCannotExecuteScriptError](client._internal_namespace.SavedObjectsErrorHelpers.md#decorateescannotexecutescripterror) +- [decorateEsUnavailableError](client._internal_namespace.SavedObjectsErrorHelpers.md#decorateesunavailableerror) +- [decorateForbiddenError](client._internal_namespace.SavedObjectsErrorHelpers.md#decorateforbiddenerror) +- [decorateGeneralError](client._internal_namespace.SavedObjectsErrorHelpers.md#decorategeneralerror) +- [decorateIndexAliasNotFoundError](client._internal_namespace.SavedObjectsErrorHelpers.md#decorateindexaliasnotfounderror) +- [decorateNotAuthorizedError](client._internal_namespace.SavedObjectsErrorHelpers.md#decoratenotauthorizederror) +- [decorateRequestEntityTooLargeError](client._internal_namespace.SavedObjectsErrorHelpers.md#decoraterequestentitytoolargeerror) +- [decorateTooManyRequestsError](client._internal_namespace.SavedObjectsErrorHelpers.md#decoratetoomanyrequestserror) +- [isBadRequestError](client._internal_namespace.SavedObjectsErrorHelpers.md#isbadrequesterror) +- [isConflictError](client._internal_namespace.SavedObjectsErrorHelpers.md#isconflicterror) +- [isEsCannotExecuteScriptError](client._internal_namespace.SavedObjectsErrorHelpers.md#isescannotexecutescripterror) +- [isEsUnavailableError](client._internal_namespace.SavedObjectsErrorHelpers.md#isesunavailableerror) +- [isForbiddenError](client._internal_namespace.SavedObjectsErrorHelpers.md#isforbiddenerror) +- [isGeneralError](client._internal_namespace.SavedObjectsErrorHelpers.md#isgeneralerror) +- [isInvalidVersionError](client._internal_namespace.SavedObjectsErrorHelpers.md#isinvalidversionerror) +- [isNotAuthorizedError](client._internal_namespace.SavedObjectsErrorHelpers.md#isnotauthorizederror) +- [isNotFoundError](client._internal_namespace.SavedObjectsErrorHelpers.md#isnotfounderror) +- [isRequestEntityTooLargeError](client._internal_namespace.SavedObjectsErrorHelpers.md#isrequestentitytoolargeerror) +- [isSavedObjectsClientError](client._internal_namespace.SavedObjectsErrorHelpers.md#issavedobjectsclienterror) +- [isTooManyRequestsError](client._internal_namespace.SavedObjectsErrorHelpers.md#istoomanyrequestserror) + +## Constructors + +### constructor + +• **new SavedObjectsErrorHelpers**() + +## Methods + +### createBadRequestError + +▸ `Static` **createBadRequestError**(`reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reason?` | `string` | + +#### Returns + +[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:12 + +___ + +### createConflictError + +▸ `Static` **createConflictError**(`type`, `id`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | +| `id` | `string` | +| `reason?` | `string` | + +#### Returns + +[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:28 + +___ + +### createGenericNotFoundError + +▸ `Static` **createGenericNotFoundError**(`type?`, `id?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type?` | ``null`` \| `string` | +| `id?` | ``null`` \| `string` | + +#### Returns + +[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:23 + +___ + +### createGenericNotFoundEsUnavailableError + +▸ `Static` **createGenericNotFoundEsUnavailableError**(`type?`, `id?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type?` | ``null`` \| `string` | +| `id?` | ``null`` \| `string` | + +#### Returns + +[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:39 + +___ + +### createIndexAliasNotFoundError + +▸ `Static` **createIndexAliasNotFoundError**(`alias`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `alias` | `string` | + +#### Returns + +[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:24 + +___ + +### createInvalidVersionError + +▸ `Static` **createInvalidVersionError**(`versionInput?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `versionInput?` | `string` | + +#### Returns + +[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:15 + +___ + +### createTooManyRequestsError + +▸ `Static` **createTooManyRequestsError**(`type`, `id`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | +| `id` | `string` | + +#### Returns + +[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:31 + +___ + +### createUnsupportedTypeError + +▸ `Static` **createUnsupportedTypeError**(`type`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | + +#### Returns + +[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:13 + +___ + +### decorateBadRequestError + +▸ `Static` **decorateBadRequestError**(`error`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | `Error` | +| `reason?` | `string` | + +#### Returns + +[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:11 + +___ + +### decorateConflictError + +▸ `Static` **decorateConflictError**(`error`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | `Error` | +| `reason?` | `string` | + +#### Returns + +[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:27 + +___ + +### decorateEsCannotExecuteScriptError + +▸ `Static` **decorateEsCannotExecuteScriptError**(`error`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | `Error` | +| `reason?` | `string` | + +#### Returns + +[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:33 + +___ + +### decorateEsUnavailableError + +▸ `Static` **decorateEsUnavailableError**(`error`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | `Error` | +| `reason?` | `string` | + +#### Returns + +[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:35 + +___ + +### decorateForbiddenError + +▸ `Static` **decorateForbiddenError**(`error`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | `Error` | +| `reason?` | `string` | + +#### Returns + +[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:19 + +___ + +### decorateGeneralError + +▸ `Static` **decorateGeneralError**(`error`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | `Error` | +| `reason?` | `string` | + +#### Returns + +[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:37 + +___ + +### decorateIndexAliasNotFoundError + +▸ `Static` **decorateIndexAliasNotFoundError**(`error`, `alias`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | `Error` | +| `alias` | `string` | + +#### Returns + +[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:25 + +___ + +### decorateNotAuthorizedError + +▸ `Static` **decorateNotAuthorizedError**(`error`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | `Error` | +| `reason?` | `string` | + +#### Returns + +[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:17 + +___ + +### decorateRequestEntityTooLargeError + +▸ `Static` **decorateRequestEntityTooLargeError**(`error`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | `Error` | +| `reason?` | `string` | + +#### Returns + +[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:21 + +___ + +### decorateTooManyRequestsError + +▸ `Static` **decorateTooManyRequestsError**(`error`, `reason?`): [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | `Error` | +| `reason?` | `string` | + +#### Returns + +[`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:30 + +___ + +### isBadRequestError + +▸ `Static` **isBadRequestError**(`error`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | + +#### Returns + +`boolean` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:14 + +___ + +### isConflictError + +▸ `Static` **isConflictError**(`error`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | + +#### Returns + +`boolean` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:29 + +___ + +### isEsCannotExecuteScriptError + +▸ `Static` **isEsCannotExecuteScriptError**(`error`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | + +#### Returns + +`boolean` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:34 + +___ + +### isEsUnavailableError + +▸ `Static` **isEsUnavailableError**(`error`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | + +#### Returns + +`boolean` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:36 + +___ + +### isForbiddenError + +▸ `Static` **isForbiddenError**(`error`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | + +#### Returns + +`boolean` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:20 + +___ + +### isGeneralError + +▸ `Static` **isGeneralError**(`error`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | + +#### Returns + +`boolean` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:38 + +___ + +### isInvalidVersionError + +▸ `Static` **isInvalidVersionError**(`error`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | + +#### Returns + +`boolean` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:16 + +___ + +### isNotAuthorizedError + +▸ `Static` **isNotAuthorizedError**(`error`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | + +#### Returns + +`boolean` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:18 + +___ + +### isNotFoundError + +▸ `Static` **isNotFoundError**(`error`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | + +#### Returns + +`boolean` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:26 + +___ + +### isRequestEntityTooLargeError + +▸ `Static` **isRequestEntityTooLargeError**(`error`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | + +#### Returns + +`boolean` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:22 + +___ + +### isSavedObjectsClientError + +▸ `Static` **isSavedObjectsClientError**(`error`): error is DecoratedError + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | `any` | + +#### Returns + +error is DecoratedError + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:10 + +___ + +### isTooManyRequestsError + +▸ `Static` **isTooManyRequestsError**(`error`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | [`DecoratedError`](../interfaces/client._internal_namespace.DecoratedError.md) \| `Error` | + +#### Returns + +`boolean` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:32 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsRepository.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsRepository.md new file mode 100644 index 0000000000000..967fa67b35640 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SavedObjectsRepository.md @@ -0,0 +1,1082 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsRepository + +# Class: SavedObjectsRepository + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsRepository + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.SavedObjectsRepository.md#constructor) + +### Properties + +- [\_allowedTypes](client._internal_namespace.SavedObjectsRepository.md#_allowedtypes) +- [\_index](client._internal_namespace.SavedObjectsRepository.md#_index) +- [\_logger](client._internal_namespace.SavedObjectsRepository.md#_logger) +- [\_mappings](client._internal_namespace.SavedObjectsRepository.md#_mappings) +- [\_migrator](client._internal_namespace.SavedObjectsRepository.md#_migrator) +- [\_rawToSavedObject](client._internal_namespace.SavedObjectsRepository.md#_rawtosavedobject) +- [\_registry](client._internal_namespace.SavedObjectsRepository.md#_registry) +- [\_serializer](client._internal_namespace.SavedObjectsRepository.md#_serializer) +- [client](client._internal_namespace.SavedObjectsRepository.md#client) +- [getIndexForType](client._internal_namespace.SavedObjectsRepository.md#getindexfortype) +- [getIndicesForTypes](client._internal_namespace.SavedObjectsRepository.md#getindicesfortypes) +- [incrementCounterInternal](client._internal_namespace.SavedObjectsRepository.md#incrementcounterinternal) +- [preflightCheckForUpsertAliasConflict](client._internal_namespace.SavedObjectsRepository.md#preflightcheckforupsertaliasconflict) +- [preflightCheckNamespaces](client._internal_namespace.SavedObjectsRepository.md#preflightchecknamespaces) +- [rawDocExistsInNamespace](client._internal_namespace.SavedObjectsRepository.md#rawdocexistsinnamespace) +- [rawDocExistsInNamespaces](client._internal_namespace.SavedObjectsRepository.md#rawdocexistsinnamespaces) +- [validateInitialNamespaces](client._internal_namespace.SavedObjectsRepository.md#validateinitialnamespaces) +- [validateObjectAttributes](client._internal_namespace.SavedObjectsRepository.md#validateobjectattributes) +- [validateObjectNamespaces](client._internal_namespace.SavedObjectsRepository.md#validateobjectnamespaces) + +### Methods + +- [bulkCreate](client._internal_namespace.SavedObjectsRepository.md#bulkcreate) +- [bulkGet](client._internal_namespace.SavedObjectsRepository.md#bulkget) +- [bulkResolve](client._internal_namespace.SavedObjectsRepository.md#bulkresolve) +- [bulkUpdate](client._internal_namespace.SavedObjectsRepository.md#bulkupdate) +- [checkConflicts](client._internal_namespace.SavedObjectsRepository.md#checkconflicts) +- [closePointInTime](client._internal_namespace.SavedObjectsRepository.md#closepointintime) +- [collectMultiNamespaceReferences](client._internal_namespace.SavedObjectsRepository.md#collectmultinamespacereferences) +- [create](client._internal_namespace.SavedObjectsRepository.md#create) +- [createPointInTimeFinder](client._internal_namespace.SavedObjectsRepository.md#createpointintimefinder) +- [delete](client._internal_namespace.SavedObjectsRepository.md#delete) +- [deleteByNamespace](client._internal_namespace.SavedObjectsRepository.md#deletebynamespace) +- [find](client._internal_namespace.SavedObjectsRepository.md#find) +- [get](client._internal_namespace.SavedObjectsRepository.md#get) +- [incrementCounter](client._internal_namespace.SavedObjectsRepository.md#incrementcounter) +- [openPointInTimeForType](client._internal_namespace.SavedObjectsRepository.md#openpointintimefortype) +- [removeReferencesTo](client._internal_namespace.SavedObjectsRepository.md#removereferencesto) +- [resolve](client._internal_namespace.SavedObjectsRepository.md#resolve) +- [update](client._internal_namespace.SavedObjectsRepository.md#update) +- [updateObjectsSpaces](client._internal_namespace.SavedObjectsRepository.md#updateobjectsspaces) +- [createRepository](client._internal_namespace.SavedObjectsRepository.md#createrepository) + +## Constructors + +### constructor + +• `Private` **new SavedObjectsRepository**() + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:88 + +## Properties + +### \_allowedTypes + +• `Private` **\_allowedTypes**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:75 + +___ + +### \_index + +• `Private` **\_index**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:72 + +___ + +### \_logger + +• `Private` **\_logger**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:78 + +___ + +### \_mappings + +• `Private` **\_mappings**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:73 + +___ + +### \_migrator + +• `Private` **\_migrator**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:71 + +___ + +### \_rawToSavedObject + +• `Private` **\_rawToSavedObject**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:445 + +___ + +### \_registry + +• `Private` **\_registry**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:74 + +___ + +### \_serializer + +• `Private` **\_serializer**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:77 + +___ + +### client + +• `Private` `Readonly` **client**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:76 + +___ + +### getIndexForType + +• `Private` **getIndexForType**: `any` + +Returns index specified by the given type or the default index + +**`param`** the type + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:436 + +___ + +### getIndicesForTypes + +• `Private` **getIndicesForTypes**: `any` + +Returns an array of indices as specified in `this._registry` for each of the +given `types`. If any of the types don't have an associated index, the +default index `this._index` will be included. + +**`param`** The types whose indices should be retrieved + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:444 + +___ + +### incrementCounterInternal + +• `Private` **incrementCounterInternal**: `any` + +**`internal`** incrementCounter function that is used internally and bypasses validation checks. + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:305 + +___ + +### preflightCheckForUpsertAliasConflict + +• `Private` **preflightCheckForUpsertAliasConflict**: `any` + +Pre-flight check to ensure that an upsert which would create a new object does not result in an alias conflict. + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:455 + +___ + +### preflightCheckNamespaces + +• `Private` **preflightCheckNamespaces**: `any` + +Pre-flight check to ensure that a multi-namespace object exists in the current namespace. + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:451 + +___ + +### rawDocExistsInNamespace + +• `Private` **rawDocExistsInNamespace**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:447 + +___ + +### rawDocExistsInNamespaces + +• `Private` **rawDocExistsInNamespaces**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:446 + +___ + +### validateInitialNamespaces + +• `Private` **validateInitialNamespaces**: `any` + +The `initialNamespaces` field (create, bulkCreate) is used to create an object in an initial set of spaces. + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:457 + +___ + +### validateObjectAttributes + +• `Private` **validateObjectAttributes**: `any` + +Validate a migrated doc against the registered saved object type's schema. + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:461 + +___ + +### validateObjectNamespaces + +• `Private` **validateObjectNamespaces**: `any` + +The object-specific `namespaces` field (bulkGet) is used to check if an object exists in any of a given number of spaces. + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:459 + +## Methods + +### bulkCreate + +▸ **bulkCreate**<`T`\>(`objects`, `options?`): `Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<`T`\>\> + +Creates multiple documents at once + +**`property`** {boolean} [options.overwrite=false] - overwrites existing documents + +**`property`** {string} [options.namespace] + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `objects` | [`SavedObjectsBulkCreateObject`](../interfaces/client._internal_namespace.SavedObjectsBulkCreateObject.md)<`T`\>[] | [{ type, id, attributes, references, migrationVersion }] | +| `options?` | [`SavedObjectsCreateOptions`](../interfaces/client._internal_namespace.SavedObjectsCreateOptions.md) | - | + +#### Returns + +`Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<`T`\>\> + +- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]} + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:112 + +___ + +### bulkGet + +▸ **bulkGet**<`T`\>(`objects?`, `options?`): `Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<`T`\>\> + +Returns an array of objects by id + +**`property`** {string} [options.namespace] + +**`example`** + +bulkGet([ + { id: 'one', type: 'config' }, + { id: 'foo', type: 'index-pattern' } +]) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `objects?` | [`SavedObjectsBulkGetObject`](../interfaces/client._internal_namespace.SavedObjectsBulkGetObject.md)[] | an array of objects containing id, type and optionally fields | +| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | - | + +#### Returns + +`Promise`<[`SavedObjectsBulkResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md)<`T`\>\> + +- { saved_objects: [{ id, type, version, attributes }] } + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:169 + +___ + +### bulkResolve + +▸ **bulkResolve**<`T`\>(`objects`, `options?`): `Promise`<[`SavedObjectsBulkResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResolveResponse.md)<`T`\>\> + +Resolves an array of objects by id, using any legacy URL aliases if they exist + +**`property`** {string} [options.namespace] + +**`example`** + +bulkResolve([ + { id: 'one', type: 'config' }, + { id: 'foo', type: 'index-pattern' } +]) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `objects` | [`SavedObjectsBulkResolveObject`](../interfaces/client._internal_namespace.SavedObjectsBulkResolveObject.md)[] | an array of objects containing id, type | +| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | - | + +#### Returns + +`Promise`<[`SavedObjectsBulkResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkResolveResponse.md)<`T`\>\> + +- { resolved_objects: [{ saved_object, outcome }] } + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:184 + +___ + +### bulkUpdate + +▸ **bulkUpdate**<`T`\>(`objects`, `options?`): `Promise`<[`SavedObjectsBulkUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md)<`T`\>\> + +Updates multiple objects in bulk + +**`property`** {string} options.version - ensures version matches that of persisted object + +**`property`** {string} [options.namespace] + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `objects` | [`SavedObjectsBulkUpdateObject`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateObject.md)<`T`\>[] | [{ type, id, attributes, options: { version, namespace } references }] | +| `options?` | [`SavedObjectsBulkUpdateOptions`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateOptions.md) | - | + +#### Returns + +`Promise`<[`SavedObjectsBulkUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md)<`T`\>\> + +- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]} + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:241 + +___ + +### checkConflicts + +▸ **checkConflicts**(`objects?`, `options?`): `Promise`<[`SavedObjectsCheckConflictsResponse`](../interfaces/client._internal_namespace.SavedObjectsCheckConflictsResponse.md)\> + +Check what conflicts will result when creating a given array of saved objects. This includes "unresolvable conflicts", which are +multi-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `objects?` | [`SavedObjectsCheckConflictsObject`](../interfaces/client._internal_namespace.SavedObjectsCheckConflictsObject.md)[] | +| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | + +#### Returns + +`Promise`<[`SavedObjectsCheckConflictsResponse`](../interfaces/client._internal_namespace.SavedObjectsCheckConflictsResponse.md)\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:117 + +___ + +### closePointInTime + +▸ **closePointInTime**(`id`, `options?`): `Promise`<[`SavedObjectsClosePointInTimeResponse`](../interfaces/client._internal_namespace.SavedObjectsClosePointInTimeResponse.md)\> + +Closes a Point In Time (PIT) by ID. This simply proxies the request to ES +via the Elasticsearch client, and is included in the Saved Objects Client +as a convenience for consumers who are using `openPointInTimeForType`. + +Only use this API if you have an advanced use case that's not solved by the +[SavedObjectsRepository.createPointInTimeFinder](client._internal_namespace.SavedObjectsRepository.md#createpointintimefinder) method. + +**`remarks`** +While the `keepAlive` that is provided will cause a PIT to automatically close, +it is highly recommended to explicitly close a PIT when you are done with it +in order to avoid consuming unneeded resources in Elasticsearch. + +**`example`** +```ts +const repository = coreStart.savedObjects.createInternalRepository(); + +const { id } = await repository.openPointInTimeForType( + type: 'index-pattern', + { keepAlive: '2m' }, +); + +const response = await repository.find({ + type: 'index-pattern', + search: 'foo*', + sortField: 'name', + sortOrder: 'desc', + pit: { + id: 'abc123', + keepAlive: '2m', + }, + searchAfter: [1234, 'abcd'], +}); + +await repository.closePointInTime(response.pit_id); +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | + +#### Returns + +`Promise`<[`SavedObjectsClosePointInTimeResponse`](../interfaces/client._internal_namespace.SavedObjectsClosePointInTimeResponse.md)\> + +- [SavedObjectsClosePointInTimeResponse](../interfaces/client._internal_namespace.SavedObjectsClosePointInTimeResponse.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:384 + +___ + +### collectMultiNamespaceReferences + +▸ **collectMultiNamespaceReferences**(`objects`, `options?`): `Promise`<[`SavedObjectsCollectMultiNamespaceReferencesResponse`](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesResponse.md)\> + +Gets all references and transitive references of the given objects. Ignores any object and/or reference that is not a multi-namespace +type. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `objects` | [`SavedObjectsCollectMultiNamespaceReferencesObject`](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesObject.md)[] | The objects to get the references for. | +| `options?` | [`SavedObjectsCollectMultiNamespaceReferencesOptions`](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesOptions.md) | - | + +#### Returns + +`Promise`<[`SavedObjectsCollectMultiNamespaceReferencesResponse`](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesResponse.md)\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:223 + +___ + +### create + +▸ **create**<`T`\>(`type`, `attributes`, `options?`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> + +Persists an object + +**`property`** {string} [options.id] - force id on creation, not recommended + +**`property`** {boolean} [options.overwrite=false] + +**`property`** {object} [options.migrationVersion=undefined] + +**`property`** {string} [options.namespace] + +**`property`** {array} [options.references=[]] - [{ name, type, id }] + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | +| `attributes` | `T` | +| `options?` | [`SavedObjectsCreateOptions`](../interfaces/client._internal_namespace.SavedObjectsCreateOptions.md) | + +#### Returns + +`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> + +- { id, type, version, attributes } + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:102 + +___ + +### createPointInTimeFinder + +▸ **createPointInTimeFinder**<`T`, `A`\>(`findOptions`, `dependencies?`): [`ISavedObjectsPointInTimeFinder`](../interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md)<`T`, `A`\> + +Returns a [ISavedObjectsPointInTimeFinder](../interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md) to help page through +large sets of saved objects. We strongly recommend using this API for +any `find` queries that might return more than 1000 saved objects, +however this API is only intended for use in server-side "batch" +processing of objects where you are collecting all objects in memory +or streaming them back to the client. + +Do NOT use this API in a route handler to facilitate paging through +saved objects on the client-side unless you are streaming all of the +results back to the client at once. Because the returned generator is +stateful, you cannot rely on subsequent http requests retrieving new +pages from the same Kibana server in multi-instance deployments. + +This generator wraps calls to [SavedObjectsRepository.find](client._internal_namespace.SavedObjectsRepository.md#find) and +iterates over multiple pages of results using `_pit` and `search_after`. +This will open a new Point-In-Time (PIT), and continue paging until a +set of results is received that's smaller than the designated `perPage`. + +Once you have retrieved all of the results you need, it is recommended +to call `close()` to clean up the PIT and prevent Elasticsearch from +consuming resources unnecessarily. This is only required if you are +done iterating and have not yet paged through all of the results: the +PIT will automatically be closed for you once you reach the last page +of results, or if the underlying call to `find` fails for any reason. + +**`example`** +```ts +const findOptions: SavedObjectsCreatePointInTimeFinderOptions = { + type: 'visualization', + search: 'foo*', + perPage: 100, +}; + +const finder = savedObjectsClient.createPointInTimeFinder(findOptions); + +const responses: SavedObjectFindResponse[] = []; +for await (const response of finder.find()) { + responses.push(...response); + if (doneSearching) { + await finder.close(); + } +} +``` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | +| `A` | `unknown` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `findOptions` | [`SavedObjectsCreatePointInTimeFinderOptions`](../modules/client._internal_namespace.md#savedobjectscreatepointintimefinderoptions) | +| `dependencies?` | [`SavedObjectsCreatePointInTimeFinderDependencies`](../interfaces/client._internal_namespace.SavedObjectsCreatePointInTimeFinderDependencies.md) | + +#### Returns + +[`ISavedObjectsPointInTimeFinder`](../interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md)<`T`, `A`\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:430 + +___ + +### delete + +▸ **delete**(`type`, `id`, `options?`): `Promise`<{}\> + +Deletes an object + +**`property`** {string} [options.namespace] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | +| `id` | `string` | +| `options?` | [`SavedObjectsDeleteOptions`](../interfaces/client._internal_namespace.SavedObjectsDeleteOptions.md) | + +#### Returns + +`Promise`<{}\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:127 + +___ + +### deleteByNamespace + +▸ **deleteByNamespace**(`namespace`, `options?`): `Promise`<`any`\> + +Deletes all objects from the provided namespace. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | `string` | +| `options?` | [`SavedObjectsDeleteByNamespaceOptions`](../interfaces/client._internal_namespace.SavedObjectsDeleteByNamespaceOptions.md) | + +#### Returns + +`Promise`<`any`\> + +- { took, timed_out, total, deleted, batches, version_conflicts, noops, retries, failures } + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:134 + +___ + +### find + +▸ **find**<`T`, `A`\>(`options`): `Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<`T`, `A`\>\> + +**`property`** {(string|Array)} [options.type] + +**`property`** {string} [options.search] + +**`property`** {string} [options.defaultSearchOperator] + +**`property`** {Array} [options.searchFields] - see Elasticsearch Simple Query String + Query field argument for more information + +**`property`** {integer} [options.page=1] + +**`property`** {integer} [options.perPage=20] + +**`property`** {Array} [options.searchAfter] + +**`property`** {string} [options.sortField] + +**`property`** {string} [options.sortOrder] + +**`property`** {Array} [options.fields] + +**`property`** {string} [options.namespace] + +**`property`** {object} [options.hasReference] - { type, id } + +**`property`** {string} [options.pit] + +**`property`** {string} [options.preference] + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | +| `A` | `unknown` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | [`SavedObjectsFindOptions`](../interfaces/client._internal_namespace.SavedObjectsFindOptions.md) | + +#### Returns + +`Promise`<[`SavedObjectsFindResponse`](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md)<`T`, `A`\>\> + +- { saved_objects: [{ id, type, version, attributes }], total, per_page, page } + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:154 + +___ + +### get + +▸ **get**<`T`\>(`type`, `id`, `options?`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> + +Gets a single object + +**`property`** {string} [options.namespace] + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | +| `id` | `string` | +| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | + +#### Returns + +`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> + +- { id, type, version, attributes } + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:194 + +___ + +### incrementCounter + +▸ **incrementCounter**<`T`\>(`type`, `id`, `counterFields`, `options?`): `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> + +Increments all the specified counter fields (by one by default). Creates the document +if one doesn't exist for the given id. + +**`remarks`** +When supplying a field name like `stats.api.counter` the field name will +be used as-is to create a document like: + `{attributes: {'stats.api.counter': 1}}` +It will not create a nested structure like: + `{attributes: {stats: {api: {counter: 1}}}}` + +When using incrementCounter for collecting usage data, you need to ensure +that usage collection happens on a best-effort basis and doesn't +negatively affect your plugin or users. See https://github.com/elastic/kibana/blob/main/src/plugins/usage_collection/README.mdx#tracking-interactions-with-incrementcounter) + +**`example`** +```ts +const repository = coreStart.savedObjects.createInternalRepository(); + +// Initialize all fields to 0 +repository + .incrementCounter('dashboard_counter_type', 'counter_id', [ + 'stats.apiCalls', + 'stats.sampleDataInstalled', + ], {initialize: true}); + +// Increment the apiCalls field counter +repository + .incrementCounter('dashboard_counter_type', 'counter_id', [ + 'stats.apiCalls', + ]) + +// Increment the apiCalls field counter by 4 +repository + .incrementCounter('dashboard_counter_type', 'counter_id', [ + { fieldName: 'stats.apiCalls' incrementBy: 4 }, + ]) + +// Initialize the document with arbitrary fields if not present +repository.incrementCounter<{ appId: string }>( + 'dashboard_counter_type', + 'counter_id', + [ 'stats.apiCalls'], + { upsertAttributes: { appId: 'myId' } } +) +``` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | `string` | The type of saved object whose fields should be incremented | +| `id` | `string` | The id of the document whose fields should be incremented | +| `counterFields` | (`string` \| [`SavedObjectsIncrementCounterField`](../interfaces/client._internal_namespace.SavedObjectsIncrementCounterField.md))[] | An array of field names to increment or an array of [SavedObjectsIncrementCounterField](../interfaces/client._internal_namespace.SavedObjectsIncrementCounterField.md) | +| `options?` | [`SavedObjectsIncrementCounterOptions`](../interfaces/client._internal_namespace.SavedObjectsIncrementCounterOptions.md)<`T`\> | [SavedObjectsIncrementCounterOptions](../interfaces/client._internal_namespace.SavedObjectsIncrementCounterOptions.md) | + +#### Returns + +`Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>\> + +The saved object after the specified fields were incremented + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:303 + +___ + +### openPointInTimeForType + +▸ **openPointInTimeForType**(`type`, `[options]?`): `Promise`<[`SavedObjectsOpenPointInTimeResponse`](../interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeResponse.md)\> + +Opens a Point In Time (PIT) against the indices for the specified Saved Object types. +The returned `id` can then be passed to `SavedObjects.find` to search against that PIT. + +Only use this API if you have an advanced use case that's not solved by the +[SavedObjectsRepository.createPointInTimeFinder](client._internal_namespace.SavedObjectsRepository.md#createpointintimefinder) method. + +**`example`** +```ts +const { id } = await savedObjectsClient.openPointInTimeForType( + type: 'visualization', + { keepAlive: '5m' }, +); +const page1 = await savedObjectsClient.find({ + type: 'visualization', + sortField: 'updated_at', + sortOrder: 'asc', + pit: { id, keepAlive: '2m' }, +}); +const lastHit = page1.saved_objects[page1.saved_objects.length - 1]; +const page2 = await savedObjectsClient.find({ + type: 'visualization', + sortField: 'updated_at', + sortOrder: 'asc', + pit: { id: page1.pit_id }, + searchAfter: lastHit.sort, +}); +await savedObjectsClient.closePointInTime(page2.pit_id); +``` + +**`property`** {string} [options.keepAlive] + +**`property`** {string} [options.preference] + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | `string` \| `string`[] | | +| `[options]?` | [`SavedObjectsOpenPointInTimeOptions`](../interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md) | [SavedObjectsOpenPointInTimeOptions](../interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md) | + +#### Returns + +`Promise`<[`SavedObjectsOpenPointInTimeResponse`](../interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeResponse.md)\> + +- { id: string } + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:342 + +___ + +### removeReferencesTo + +▸ **removeReferencesTo**(`type`, `id`, `options?`): `Promise`<[`SavedObjectsRemoveReferencesToResponse`](../interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md)\> + +Updates all objects containing a reference to the given {type, id} tuple to remove the said reference. + +**`remarks`** Will throw a conflict error if the `update_by_query` operation returns any failure. In that case + some references might have been removed, and some were not. It is the caller's responsibility + to handle and fix this situation if it was to happen. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | +| `id` | `string` | +| `options?` | [`SavedObjectsRemoveReferencesToOptions`](../interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToOptions.md) | + +#### Returns + +`Promise`<[`SavedObjectsRemoveReferencesToResponse`](../interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md)\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:249 + +___ + +### resolve + +▸ **resolve**<`T`\>(`type`, `id`, `options?`): `Promise`<[`SavedObjectsResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsResolveResponse.md)<`T`\>\> + +Resolves a single object, using any legacy URL alias if it exists + +**`property`** {string} [options.namespace] + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | +| `id` | `string` | +| `options?` | [`SavedObjectsBaseOptions`](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) | + +#### Returns + +`Promise`<[`SavedObjectsResolveResponse`](../interfaces/client._internal_namespace.SavedObjectsResolveResponse.md)<`T`\>\> + +- { saved_object, outcome } + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:204 + +___ + +### update + +▸ **update**<`T`\>(`type`, `id`, `attributes`, `options?`): `Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<`T`\>\> + +Updates an object + +**`property`** {string} options.version - ensures version matches that of persisted object + +**`property`** {string} [options.namespace] + +**`property`** {array} [options.references] - [{ name, type, id }] + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | +| `id` | `string` | +| `attributes` | `Partial`<`T`\> | +| `options?` | [`SavedObjectsUpdateOptions`](../interfaces/client._internal_namespace.SavedObjectsUpdateOptions.md)<`T`\> | + +#### Returns + +`Promise`<[`SavedObjectsUpdateResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md)<`T`\>\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:216 + +___ + +### updateObjectsSpaces + +▸ **updateObjectsSpaces**(`objects`, `spacesToAdd`, `spacesToRemove`, `options?`): `Promise`<[`SavedObjectsUpdateObjectsSpacesResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponse.md)\> + +Updates one or more objects to add and/or remove them from specified spaces. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `objects` | [`SavedObjectsUpdateObjectsSpacesObject`](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md)[] | +| `spacesToAdd` | `string`[] | +| `spacesToRemove` | `string`[] | +| `options?` | [`SavedObjectsUpdateObjectsSpacesOptions`](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesOptions.md) | + +#### Returns + +`Promise`<[`SavedObjectsUpdateObjectsSpacesResponse`](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponse.md)\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:232 + +___ + +### createRepository + +▸ `Static` **createRepository**(`migrator`, `typeRegistry`, `indexName`, `client`, `logger`, `includedHiddenTypes?`, `injectedConstructor?`): [`ISavedObjectsRepository`](../modules/client._internal_namespace.md#isavedobjectsrepository) + +A factory function for creating SavedObjectRepository instances. + +**`internalremarks`** +Tests are located in ./repository_create_repository.test.ts + +**`internal`** + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `migrator` | [`IKibanaMigrator`](../modules/client._internal_namespace.md#ikibanamigrator) | +| `typeRegistry` | [`ISavedObjectTypeRegistry`](../modules/client._internal_namespace.md#isavedobjecttyperegistry) | +| `indexName` | `string` | +| `client` | [`ElasticsearchClient`](../modules/client._internal_namespace.md#elasticsearchclient) | +| `logger` | `Logger` | +| `includedHiddenTypes?` | `string`[] | +| `injectedConstructor?` | `any` | + +#### Returns + +[`ISavedObjectsRepository`](../modules/client._internal_namespace.md#isavedobjectsrepository) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:87 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SpaceActions.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SpaceActions.md new file mode 100644 index 0000000000000..b39329e27b8ba --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SpaceActions.md @@ -0,0 +1,59 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SpaceActions + +# Class: SpaceActions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SpaceActions + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.SpaceActions.md#constructor) + +### Properties + +- [prefix](client._internal_namespace.SpaceActions.md#prefix) + +### Accessors + +- [manage](client._internal_namespace.SpaceActions.md#manage) + +## Constructors + +### constructor + +• **new SpaceActions**(`versionNumber`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `versionNumber` | `string` | + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/space.d.ts:3 + +## Properties + +### prefix + +• `Private` `Readonly` **prefix**: `any` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/space.d.ts:2 + +## Accessors + +### manage + +• `get` **manage**(): `string` + +#### Returns + +`string` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/space.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SubFeature.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SubFeature.md new file mode 100644 index 0000000000000..4e300b2231285 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.SubFeature.md @@ -0,0 +1,97 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SubFeature + +# Class: SubFeature + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SubFeature + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.SubFeature.md#constructor) + +### Properties + +- [config](client._internal_namespace.SubFeature.md#config) + +### Accessors + +- [name](client._internal_namespace.SubFeature.md#name) +- [privilegeGroups](client._internal_namespace.SubFeature.md#privilegegroups) + +### Methods + +- [toRaw](client._internal_namespace.SubFeature.md#toraw) + +## Constructors + +### constructor + +• **new SubFeature**(`config`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | `Readonly`<{ `name`: `string` ; `privilegeGroups`: readonly `Readonly`<{ groupType: SubFeaturePrivilegeGroupType; privileges: readonly Readonly<{ id: string; name: string; includeIn: "all" \| "none" \| "read"; minimumLicense?: "basic" \| "standard" \| ... 4 more ... \| undefined; ... 9 more ...; ui: readonly string[]; }\>[]; }\>[] }\> | + +#### Defined in + +x-pack/plugins/features/target/types/common/sub_feature.d.ts:66 + +## Properties + +### config + +• `Protected` `Readonly` **config**: `Readonly`<{ `name`: `string` ; `privilegeGroups`: readonly `Readonly`<{ groupType: SubFeaturePrivilegeGroupType; privileges: readonly Readonly<{ id: string; name: string; includeIn: "all" \| "none" \| "read"; minimumLicense?: "basic" \| "standard" \| ... 4 more ... \| undefined; ... 9 more ...; ui: readonly string[]; }\>[]; }\>[] }\> + +#### Defined in + +x-pack/plugins/features/target/types/common/sub_feature.d.ts:65 + +## Accessors + +### name + +• `get` **name**(): `string` + +#### Returns + +`string` + +#### Defined in + +x-pack/plugins/features/target/types/common/sub_feature.d.ts:67 + +___ + +### privilegeGroups + +• `get` **privilegeGroups**(): readonly `Readonly`<{ `groupType`: [`SubFeaturePrivilegeGroupType`](../modules/client._internal_namespace.md#subfeatureprivilegegrouptype) ; `privileges`: readonly Readonly<{ id: string; name: string; includeIn: "all" \| "none" \| "read"; minimumLicense?: "basic" \| "standard" \| "gold" \| "platinum" \| "enterprise" \| "trial" \| undefined; management?: Readonly<{ [x: string]: readonly string[]; }\> \| undefined; ... 8 more ...; savedObject: Readonly<...\>; }\>[] }\>[] + +#### Returns + +readonly `Readonly`<{ `groupType`: [`SubFeaturePrivilegeGroupType`](../modules/client._internal_namespace.md#subfeatureprivilegegrouptype) ; `privileges`: readonly Readonly<{ id: string; name: string; includeIn: "all" \| "none" \| "read"; minimumLicense?: "basic" \| "standard" \| "gold" \| "platinum" \| "enterprise" \| "trial" \| undefined; management?: Readonly<{ [x: string]: readonly string[]; }\> \| undefined; ... 8 more ...; savedObject: Readonly<...\>; }\>[] }\>[] + +#### Defined in + +x-pack/plugins/features/target/types/common/sub_feature.d.ts:68 + +## Methods + +### toRaw + +▸ **toRaw**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `privilegeGroups` | readonly `Readonly`<{ `groupType`: [`SubFeaturePrivilegeGroupType`](../modules/client._internal_namespace.md#subfeatureprivilegegrouptype) ; `privileges`: readonly Readonly<{ id: string; name: string; includeIn: "all" \| "none" \| "read"; minimumLicense?: "basic" \| "standard" \| "gold" \| "platinum" \| "enterprise" \| "trial" \| undefined; management?: Readonly<{ [x: string]: readonly string[]; }\> \| undefined; ... 8 more ...; savedObject: Readonly<...\>; }\>[] }\>[] | + +#### Defined in + +x-pack/plugins/features/target/types/common/sub_feature.d.ts:104 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.TaskRunnerFactory.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.TaskRunnerFactory.md new file mode 100644 index 0000000000000..7aed74f96c698 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.TaskRunnerFactory.md @@ -0,0 +1,114 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / TaskRunnerFactory + +# Class: TaskRunnerFactory + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).TaskRunnerFactory + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.TaskRunnerFactory.md#constructor) + +### Properties + +- [actionExecutor](client._internal_namespace.TaskRunnerFactory.md#actionexecutor) +- [isInitialized](client._internal_namespace.TaskRunnerFactory.md#isinitialized) +- [taskRunnerContext](client._internal_namespace.TaskRunnerFactory.md#taskrunnercontext) + +### Methods + +- [create](client._internal_namespace.TaskRunnerFactory.md#create) +- [initialize](client._internal_namespace.TaskRunnerFactory.md#initialize) + +## Constructors + +### constructor + +• **new TaskRunnerFactory**(`actionExecutor`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `actionExecutor` | [`ActionExecutorContract`](../modules/client._internal_namespace.md#actionexecutorcontract) | + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:18 + +## Properties + +### actionExecutor + +• `Private` `Readonly` **actionExecutor**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:17 + +___ + +### isInitialized + +• `Private` **isInitialized**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:15 + +___ + +### taskRunnerContext + +• `Private` `Optional` **taskRunnerContext**: `any` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:16 + +## Methods + +### create + +▸ **create**(`__namedParameters`, `maxAttempts?`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`RunContext`](../interfaces/client._internal_namespace.RunContext.md) | +| `maxAttempts?` | `number` | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `cancel` | () => `Promise`<{ `state`: {} }\> | +| `run` | () => `Promise`<`void`\> | + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:20 + +___ + +### initialize + +▸ **initialize**(`taskRunnerContext`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `taskRunnerContext` | [`TaskRunnerContext`](../interfaces/client._internal_namespace.TaskRunnerContext.md) | + +#### Returns + +`void` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:19 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.UIActions.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.UIActions.md new file mode 100644 index 0000000000000..8f74b5fff8806 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.UIActions.md @@ -0,0 +1,66 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / UIActions + +# Class: UIActions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).UIActions + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.UIActions.md#constructor) + +### Properties + +- [prefix](client._internal_namespace.UIActions.md#prefix) + +### Methods + +- [get](client._internal_namespace.UIActions.md#get) + +## Constructors + +### constructor + +• **new UIActions**(`versionNumber`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `versionNumber` | `string` | + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/ui.d.ts:4 + +## Properties + +### prefix + +• `Private` `Readonly` **prefix**: `any` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/ui.d.ts:3 + +## Methods + +### get + +▸ **get**(`featureId`, ...`uiCapabilityParts`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `featureId` | keyof [`Capabilities`](../interfaces/client._internal_namespace.Capabilities.md) | +| `...uiCapabilityParts` | `string`[] | + +#### Returns + +`string` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/actions/ui.d.ts:5 diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.UserActionBuilder.md b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.UserActionBuilder.md new file mode 100644 index 0000000000000..361d5e50fd923 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/classes/client._internal_namespace.UserActionBuilder.md @@ -0,0 +1,251 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / UserActionBuilder + +# Class: UserActionBuilder + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).UserActionBuilder + +## Table of contents + +### Constructors + +- [constructor](client._internal_namespace.UserActionBuilder.md#constructor) + +### Methods + +- [build](client._internal_namespace.UserActionBuilder.md#build) +- [buildCommonUserAction](client._internal_namespace.UserActionBuilder.md#buildcommonuseraction) +- [createActionReference](client._internal_namespace.UserActionBuilder.md#createactionreference) +- [createCaseReferences](client._internal_namespace.UserActionBuilder.md#createcasereferences) +- [createCommentReferences](client._internal_namespace.UserActionBuilder.md#createcommentreferences) +- [createConnectorPushReference](client._internal_namespace.UserActionBuilder.md#createconnectorpushreference) +- [createConnectorReference](client._internal_namespace.UserActionBuilder.md#createconnectorreference) +- [extractConnectorId](client._internal_namespace.UserActionBuilder.md#extractconnectorid) +- [extractConnectorIdFromExternalService](client._internal_namespace.UserActionBuilder.md#extractconnectoridfromexternalservice) +- [getCommonUserActionAttributes](client._internal_namespace.UserActionBuilder.md#getcommonuseractionattributes) + +## Constructors + +### constructor + +• **new UserActionBuilder**() + +## Methods + +### build + +▸ `Abstract` **build**<`T`\>(`args`): [`BuilderReturnValue`](../interfaces/client._internal_namespace.BuilderReturnValue.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends keyof [`BuilderParameters`](../interfaces/client._internal_namespace.BuilderParameters.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `args` | [`UserActionParameters`](../modules/client._internal_namespace.md#useractionparameters)<`T`\> | + +#### Returns + +[`BuilderReturnValue`](../interfaces/client._internal_namespace.BuilderReturnValue.md) + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:119](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L119) + +___ + +### buildCommonUserAction + +▸ `Protected` **buildCommonUserAction**(`__namedParameters`): [`BuilderReturnValue`](../interfaces/client._internal_namespace.BuilderReturnValue.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`CommonBuilderArguments`](../modules/client._internal_namespace.md#commonbuilderarguments) | + +#### Returns + +[`BuilderReturnValue`](../interfaces/client._internal_namespace.BuilderReturnValue.md) + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:88](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L88) + +___ + +### createActionReference + +▸ `Protected` **createActionReference**(`id`, `name`): [`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | ``null`` \| `string` | +| `name` | `string` | + +#### Returns + +[`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:55](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L55) + +___ + +### createCaseReferences + +▸ `Protected` **createCaseReferences**(`caseId`): [`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `caseId` | `string` | + +#### Returns + +[`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:45](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L45) + +___ + +### createCommentReferences + +▸ `Protected` **createCommentReferences**(`id`): [`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | ``null`` \| `string` | + +#### Returns + +[`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:61](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L61) + +___ + +### createConnectorPushReference + +▸ `Protected` **createConnectorPushReference**(`id`): [`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | ``null`` \| `string` | + +#### Returns + +[`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:77](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L77) + +___ + +### createConnectorReference + +▸ `Protected` **createConnectorReference**(`id`): [`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | ``null`` \| `string` | + +#### Returns + +[`SavedObjectReference`](../interfaces/client._internal_namespace.SavedObjectReference.md)[] + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:73](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L73) + +___ + +### extractConnectorId + +▸ `Protected` **extractConnectorId**(`connector`): `Omit`<{ `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string }, ``"id"``\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `connector` | { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } | + +#### Returns + +`Omit`<{ `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string }, ``"id"``\> + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:40](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L40) + +___ + +### extractConnectorIdFromExternalService + +▸ `Protected` **extractConnectorIdFromExternalService**(`externalService`): `Omit`<{ `connector_id`: `string` = rt.string } & { `connector_name`: `string` = rt.string; `external_id`: `string` = rt.string; `external_title`: `string` = rt.string; `external_url`: `string` = rt.string; `pushed_at`: `string` = rt.string; `pushed_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT }, ``"connector_id"``\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `externalService` | { `connector_id`: `string` = rt.string } & { `connector_name`: `string` = rt.string; `external_id`: `string` = rt.string; `external_title`: `string` = rt.string; `external_url`: `string` = rt.string; `pushed_at`: `string` = rt.string; `pushed_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT } | + +#### Returns + +`Omit`<{ `connector_id`: `string` = rt.string } & { `connector_name`: `string` = rt.string; `external_id`: `string` = rt.string; `external_title`: `string` = rt.string; `external_url`: `string` = rt.string; `pushed_at`: `string` = rt.string; `pushed_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT }, ``"connector_id"``\> + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:81](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L81) + +___ + +### getCommonUserActionAttributes + +▸ `Protected` **getCommonUserActionAttributes**(`__namedParameters`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Object` | +| `__namedParameters.owner` | `string` | +| `__namedParameters.user` | `Object` | +| `__namedParameters.user.email` | `undefined` \| ``null`` \| `string` | +| `__namedParameters.user.full_name` | `undefined` \| ``null`` \| `string` | +| `__namedParameters.user.username` | `undefined` \| ``null`` \| `string` | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `created_at` | `string` | +| `created_by` | `Object` | +| `created_by.email` | `undefined` \| ``null`` \| `string` | +| `created_by.full_name` | `undefined` \| ``null`` \| `string` | +| `created_by.username` | `undefined` \| ``null`` \| `string` | +| `owner` | `string` | + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts:32](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/abstract_builder.ts#L32) diff --git a/x-pack/plugins/cases/docs/cases_client/classes/client.casesclient.md b/x-pack/plugins/cases/docs/cases_client/classes/client.casesclient.md index b3bef7b36b571..d00f9f0edcd88 100644 --- a/x-pack/plugins/cases/docs/cases_client/classes/client.casesclient.md +++ b/x-pack/plugins/cases/docs/cases_client/classes/client.casesclient.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [client](../modules/client.md) / CasesClient +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / CasesClient # Class: CasesClient @@ -10,169 +10,205 @@ Client wrapper that contains accessor methods for individual entities within the ### Constructors -- [constructor](client.casesclient.md#constructor) +- [constructor](client.CasesClient.md#constructor) ### Properties -- [\_attachments](client.casesclient.md#_attachments) -- [\_cases](client.casesclient.md#_cases) -- [\_casesClientInternal](client.casesclient.md#_casesclientinternal) -- [\_configure](client.casesclient.md#_configure) -- [\_stats](client.casesclient.md#_stats) -- [\_subCases](client.casesclient.md#_subcases) -- [\_userActions](client.casesclient.md#_useractions) +- [\_attachments](client.CasesClient.md#_attachments) +- [\_cases](client.CasesClient.md#_cases) +- [\_casesClientInternal](client.CasesClient.md#_casesclientinternal) +- [\_configure](client.CasesClient.md#_configure) +- [\_metrics](client.CasesClient.md#_metrics) +- [\_stats](client.CasesClient.md#_stats) +- [\_userActions](client.CasesClient.md#_useractions) ### Accessors -- [attachments](client.casesclient.md#attachments) -- [cases](client.casesclient.md#cases) -- [configure](client.casesclient.md#configure) -- [stats](client.casesclient.md#stats) -- [subCases](client.casesclient.md#subcases) -- [userActions](client.casesclient.md#useractions) +- [attachments](client.CasesClient.md#attachments) +- [cases](client.CasesClient.md#cases) +- [configure](client.CasesClient.md#configure) +- [metrics](client.CasesClient.md#metrics) +- [stats](client.CasesClient.md#stats) +- [userActions](client.CasesClient.md#useractions) ## Constructors ### constructor -\+ **new CasesClient**(`args`: CasesClientArgs): [*CasesClient*](client.casesclient.md) +• **new CasesClient**(`args`) #### Parameters | Name | Type | | :------ | :------ | -| `args` | CasesClientArgs | +| `args` | [`CasesClientArgs`](../interfaces/client._internal_namespace.CasesClientArgs.md) | -**Returns:** [*CasesClient*](client.casesclient.md) +#### Defined in -Defined in: [client.ts:28](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L28) +[x-pack/plugins/cases/server/client/client.ts:29](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L29) ## Properties ### \_attachments -• `Private` `Readonly` **\_attachments**: [*AttachmentsSubClient*](../interfaces/attachments_client.attachmentssubclient.md) +• `Private` `Readonly` **\_attachments**: [`AttachmentsSubClient`](../interfaces/attachments_client.AttachmentsSubClient.md) -Defined in: [client.ts:24](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L24) +#### Defined in + +[x-pack/plugins/cases/server/client/client.ts:23](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L23) ___ ### \_cases -• `Private` `Readonly` **\_cases**: [*CasesSubClient*](../interfaces/cases_client.casessubclient.md) +• `Private` `Readonly` **\_cases**: [`CasesSubClient`](../interfaces/cases_client.CasesSubClient.md) + +#### Defined in -Defined in: [client.ts:23](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L23) +[x-pack/plugins/cases/server/client/client.ts:22](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L22) ___ ### \_casesClientInternal -• `Private` `Readonly` **\_casesClientInternal**: *CasesClientInternal* +• `Private` `Readonly` **\_casesClientInternal**: [`CasesClientInternal`](client._internal_namespace.CasesClientInternal.md) + +#### Defined in -Defined in: [client.ts:22](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L22) +[x-pack/plugins/cases/server/client/client.ts:21](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L21) ___ ### \_configure -• `Private` `Readonly` **\_configure**: [*ConfigureSubClient*](../interfaces/configure_client.configuresubclient.md) +• `Private` `Readonly` **\_configure**: [`ConfigureSubClient`](../interfaces/configure_client.ConfigureSubClient.md) -Defined in: [client.ts:27](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L27) +#### Defined in + +[x-pack/plugins/cases/server/client/client.ts:25](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L25) ___ -### \_stats +### \_metrics + +• `Private` `Readonly` **\_metrics**: [`MetricsSubClient`](../interfaces/metrics_client.MetricsSubClient.md) -• `Private` `Readonly` **\_stats**: [*StatsSubClient*](../interfaces/stats_client.statssubclient.md) +#### Defined in -Defined in: [client.ts:28](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L28) +[x-pack/plugins/cases/server/client/client.ts:27](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L27) ___ -### \_subCases +### \_stats + +• `Private` `Readonly` **\_stats**: [`StatsSubClient`](../interfaces/stats_client.StatsSubClient.md) -• `Private` `Readonly` **\_subCases**: [*SubCasesClient*](../interfaces/sub_cases_client.subcasesclient.md) +#### Defined in -Defined in: [client.ts:26](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L26) +[x-pack/plugins/cases/server/client/client.ts:26](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L26) ___ ### \_userActions -• `Private` `Readonly` **\_userActions**: [*UserActionsSubClient*](../interfaces/user_actions_client.useractionssubclient.md) +• `Private` `Readonly` **\_userActions**: [`UserActionsSubClient`](../interfaces/user_actions_client.UserActionsSubClient.md) + +#### Defined in -Defined in: [client.ts:25](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L25) +[x-pack/plugins/cases/server/client/client.ts:24](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L24) ## Accessors ### attachments -• get **attachments**(): [*AttachmentsSubClient*](../interfaces/attachments_client.attachmentssubclient.md) +• `get` **attachments**(): [`AttachmentsSubClient`](../interfaces/attachments_client.AttachmentsSubClient.md) Retrieves an interface for interacting with attachments (comments) entities. -**Returns:** [*AttachmentsSubClient*](../interfaces/attachments_client.attachmentssubclient.md) +#### Returns -Defined in: [client.ts:50](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L50) +[`AttachmentsSubClient`](../interfaces/attachments_client.AttachmentsSubClient.md) + +#### Defined in + +[x-pack/plugins/cases/server/client/client.ts:49](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L49) ___ ### cases -• get **cases**(): [*CasesSubClient*](../interfaces/cases_client.casessubclient.md) +• `get` **cases**(): [`CasesSubClient`](../interfaces/cases_client.CasesSubClient.md) Retrieves an interface for interacting with cases entities. -**Returns:** [*CasesSubClient*](../interfaces/cases_client.casessubclient.md) +#### Returns + +[`CasesSubClient`](../interfaces/cases_client.CasesSubClient.md) -Defined in: [client.ts:43](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L43) +#### Defined in + +[x-pack/plugins/cases/server/client/client.ts:42](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L42) ___ ### configure -• get **configure**(): [*ConfigureSubClient*](../interfaces/configure_client.configuresubclient.md) +• `get` **configure**(): [`ConfigureSubClient`](../interfaces/configure_client.ConfigureSubClient.md) Retrieves an interface for interacting with the configuration of external connectors for the plugin entities. -**Returns:** [*ConfigureSubClient*](../interfaces/configure_client.configuresubclient.md) +#### Returns + +[`ConfigureSubClient`](../interfaces/configure_client.ConfigureSubClient.md) + +#### Defined in -Defined in: [client.ts:76](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L76) +[x-pack/plugins/cases/server/client/client.ts:63](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L63) ___ -### stats +### metrics -• get **stats**(): [*StatsSubClient*](../interfaces/stats_client.statssubclient.md) +• `get` **metrics**(): [`MetricsSubClient`](../interfaces/metrics_client.MetricsSubClient.md) -Retrieves an interface for retrieving statistics related to the cases entities. +Retrieves an interface for retrieving metrics related to the cases entities. + +#### Returns -**Returns:** [*StatsSubClient*](../interfaces/stats_client.statssubclient.md) +[`MetricsSubClient`](../interfaces/metrics_client.MetricsSubClient.md) -Defined in: [client.ts:83](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L83) +#### Defined in + +[x-pack/plugins/cases/server/client/client.ts:77](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L77) ___ -### subCases +### stats + +• `get` **stats**(): [`StatsSubClient`](../interfaces/stats_client.StatsSubClient.md) -• get **subCases**(): [*SubCasesClient*](../interfaces/sub_cases_client.subcasesclient.md) +Retrieves an interface for retrieving statistics related to the cases entities. -Retrieves an interface for interacting with the case as a connector entities. +#### Returns -Currently this functionality is disabled and will throw an error if this function is called. +[`StatsSubClient`](../interfaces/stats_client.StatsSubClient.md) -**Returns:** [*SubCasesClient*](../interfaces/sub_cases_client.subcasesclient.md) +#### Defined in -Defined in: [client.ts:66](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L66) +[x-pack/plugins/cases/server/client/client.ts:70](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L70) ___ ### userActions -• get **userActions**(): [*UserActionsSubClient*](../interfaces/user_actions_client.useractionssubclient.md) +• `get` **userActions**(): [`UserActionsSubClient`](../interfaces/user_actions_client.UserActionsSubClient.md) Retrieves an interface for interacting with the user actions associated with the plugin entities. -**Returns:** [*UserActionsSubClient*](../interfaces/user_actions_client.useractionssubclient.md) +#### Returns + +[`UserActionsSubClient`](../interfaces/user_actions_client.UserActionsSubClient.md) + +#### Defined in -Defined in: [client.ts:57](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L57) +[x-pack/plugins/cases/server/client/client.ts:56](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/client.ts#L56) diff --git a/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.ActionExecutionSourceType.md b/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.ActionExecutionSourceType.md new file mode 100644 index 0000000000000..9d4fbc639a26c --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.ActionExecutionSourceType.md @@ -0,0 +1,32 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionExecutionSourceType + +# Enumeration: ActionExecutionSourceType + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionExecutionSourceType + +## Table of contents + +### Enumeration members + +- [HTTP\_REQUEST](client._internal_namespace.ActionExecutionSourceType.md#http_request) +- [SAVED\_OBJECT](client._internal_namespace.ActionExecutionSourceType.md#saved_object) + +## Enumeration members + +### HTTP\_REQUEST + +• **HTTP\_REQUEST** = `"HTTP_REQUEST"` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_execution_source.d.ts:4 + +___ + +### SAVED\_OBJECT + +• **SAVED\_OBJECT** = `"SAVED_OBJECT"` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_execution_source.d.ts:3 diff --git a/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.AuthorizationMode.md b/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.AuthorizationMode.md new file mode 100644 index 0000000000000..f1dc071f463d6 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.AuthorizationMode.md @@ -0,0 +1,32 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AuthorizationMode + +# Enumeration: AuthorizationMode + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AuthorizationMode + +## Table of contents + +### Enumeration members + +- [Legacy](client._internal_namespace.AuthorizationMode.md#legacy) +- [RBAC](client._internal_namespace.AuthorizationMode.md#rbac) + +## Enumeration members + +### Legacy + +• **Legacy** = `0` + +#### Defined in + +x-pack/plugins/actions/target/types/server/authorization/get_authorization_mode_by_source.d.ts:4 + +___ + +### RBAC + +• **RBAC** = `1` + +#### Defined in + +x-pack/plugins/actions/target/types/server/authorization/get_authorization_mode_by_source.d.ts:5 diff --git a/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.CaseStatuses.md b/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.CaseStatuses.md new file mode 100644 index 0000000000000..48d5689a52400 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.CaseStatuses.md @@ -0,0 +1,43 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CaseStatuses + +# Enumeration: CaseStatuses + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CaseStatuses + +## Table of contents + +### Enumeration members + +- [closed](client._internal_namespace.CaseStatuses.md#closed) +- [in-progress](client._internal_namespace.CaseStatuses.md#in-progress) +- [open](client._internal_namespace.CaseStatuses.md#open) + +## Enumeration members + +### closed + +• **closed** = `"closed"` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/status.ts:13](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/status.ts#L13) + +___ + +### in-progress + +• **in-progress** = `"in-progress"` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/status.ts:12](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/status.ts#L12) + +___ + +### open + +• **open** = `"open"` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/status.ts:11](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/status.ts#L11) diff --git a/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.TaskStatus.md b/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.TaskStatus.md new file mode 100644 index 0000000000000..a92a96681e137 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.TaskStatus.md @@ -0,0 +1,65 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / TaskStatus + +# Enumeration: TaskStatus + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).TaskStatus + +## Table of contents + +### Enumeration members + +- [Claiming](client._internal_namespace.TaskStatus.md#claiming) +- [Failed](client._internal_namespace.TaskStatus.md#failed) +- [Idle](client._internal_namespace.TaskStatus.md#idle) +- [Running](client._internal_namespace.TaskStatus.md#running) +- [Unrecognized](client._internal_namespace.TaskStatus.md#unrecognized) + +## Enumeration members + +### Claiming + +• **Claiming** = `"claiming"` + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:124 + +___ + +### Failed + +• **Failed** = `"failed"` + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:126 + +___ + +### Idle + +• **Idle** = `"idle"` + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:123 + +___ + +### Running + +• **Running** = `"running"` + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:125 + +___ + +### Unrecognized + +• **Unrecognized** = `"unrecognized"` + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:127 diff --git a/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.ViewMode.md b/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.ViewMode.md new file mode 100644 index 0000000000000..c00d063ffc864 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/enums/client._internal_namespace.ViewMode.md @@ -0,0 +1,54 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ViewMode + +# Enumeration: ViewMode + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ViewMode + +## Table of contents + +### Enumeration members + +- [EDIT](client._internal_namespace.ViewMode.md#edit) +- [PREVIEW](client._internal_namespace.ViewMode.md#preview) +- [PRINT](client._internal_namespace.ViewMode.md#print) +- [VIEW](client._internal_namespace.ViewMode.md#view) + +## Enumeration members + +### EDIT + +• **EDIT** = `"edit"` + +#### Defined in + +src/plugins/embeddable/target/types/common/types.d.ts:5 + +___ + +### PREVIEW + +• **PREVIEW** = `"preview"` + +#### Defined in + +src/plugins/embeddable/target/types/common/types.d.ts:6 + +___ + +### PRINT + +• **PRINT** = `"print"` + +#### Defined in + +src/plugins/embeddable/target/types/common/types.d.ts:7 + +___ + +### VIEW + +• **VIEW** = `"view"` + +#### Defined in + +src/plugins/embeddable/target/types/common/types.d.ts:8 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_add.addargs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_add.addargs.md deleted file mode 100644 index 0fafb377bcc41..0000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_add.addargs.md +++ /dev/null @@ -1,34 +0,0 @@ -[Cases Client API Interface](../cases_client_api.md) / [attachments/add](../modules/attachments_add.md) / AddArgs - -# Interface: AddArgs - -[attachments/add](../modules/attachments_add.md).AddArgs - -The arguments needed for creating a new attachment to a case. - -## Table of contents - -### Properties - -- [caseId](attachments_add.addargs.md#caseid) -- [comment](attachments_add.addargs.md#comment) - -## Properties - -### caseId - -• **caseId**: *string* - -The case ID that this attachment will be associated with - -Defined in: [attachments/add.ts:305](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/add.ts#L305) - -___ - -### comment - -• **comment**: { `comment`: *string* ; `owner`: *string* ; `type`: user } \| { `alertId`: *string* \| *string*[] ; `index`: *string* \| *string*[] ; `owner`: *string* ; `rule`: { id: string \| null; name: string \| null; } ; `type`: alert \| generatedAlert } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: *string* ; `owner`: *string* ; `type`: actions } - -The attachment values. - -Defined in: [attachments/add.ts:309](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/add.ts#L309) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.AddArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.AddArgs.md new file mode 100644 index 0000000000000..b1a96017c439b --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.AddArgs.md @@ -0,0 +1,38 @@ +[Cases Client API Interface](../README.md) / [attachments/client](../modules/attachments_client.md) / [\_internal\_namespace](../modules/attachments_client._internal_namespace.md) / AddArgs + +# Interface: AddArgs + +[attachments/client](../modules/attachments_client.md).[_internal_namespace](../modules/attachments_client._internal_namespace.md).AddArgs + +The arguments needed for creating a new attachment to a case. + +## Table of contents + +### Properties + +- [caseId](attachments_client._internal_namespace.AddArgs.md#caseid) +- [comment](attachments_client._internal_namespace.AddArgs.md#comment) + +## Properties + +### caseId + +• **caseId**: `string` + +The case ID that this attachment will be associated with + +#### Defined in + +[x-pack/plugins/cases/server/client/attachments/add.ts:77](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/add.ts#L77) + +___ + +### comment + +• **comment**: { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } + +The attachment values. + +#### Defined in + +[x-pack/plugins/cases/server/client/attachments/add.ts:81](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/add.ts#L81) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.DeleteAllArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.DeleteAllArgs.md new file mode 100644 index 0000000000000..d2f34ab040eb3 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.DeleteAllArgs.md @@ -0,0 +1,25 @@ +[Cases Client API Interface](../README.md) / [attachments/client](../modules/attachments_client.md) / [\_internal\_namespace](../modules/attachments_client._internal_namespace.md) / DeleteAllArgs + +# Interface: DeleteAllArgs + +[attachments/client](../modules/attachments_client.md).[_internal_namespace](../modules/attachments_client._internal_namespace.md).DeleteAllArgs + +Parameters for deleting all comments of a case. + +## Table of contents + +### Properties + +- [caseID](attachments_client._internal_namespace.DeleteAllArgs.md#caseid) + +## Properties + +### caseID + +• **caseID**: `string` + +The case ID to delete all attachments for + +#### Defined in + +[x-pack/plugins/cases/server/client/attachments/delete.ts:25](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/delete.ts#L25) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.DeleteArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.DeleteArgs.md new file mode 100644 index 0000000000000..0bee9af6c4f24 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.DeleteArgs.md @@ -0,0 +1,38 @@ +[Cases Client API Interface](../README.md) / [attachments/client](../modules/attachments_client.md) / [\_internal\_namespace](../modules/attachments_client._internal_namespace.md) / DeleteArgs + +# Interface: DeleteArgs + +[attachments/client](../modules/attachments_client.md).[_internal_namespace](../modules/attachments_client._internal_namespace.md).DeleteArgs + +Parameters for deleting a single attachment of a case. + +## Table of contents + +### Properties + +- [attachmentID](attachments_client._internal_namespace.DeleteArgs.md#attachmentid) +- [caseID](attachments_client._internal_namespace.DeleteArgs.md#caseid) + +## Properties + +### attachmentID + +• **attachmentID**: `string` + +The attachment ID to delete + +#### Defined in + +[x-pack/plugins/cases/server/client/attachments/delete.ts:39](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/delete.ts#L39) + +___ + +### caseID + +• **caseID**: `string` + +The case ID to delete an attachment from + +#### Defined in + +[x-pack/plugins/cases/server/client/attachments/delete.ts:35](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/delete.ts#L35) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.FindArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.FindArgs.md new file mode 100644 index 0000000000000..2fd5a356bc6f5 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.FindArgs.md @@ -0,0 +1,54 @@ +[Cases Client API Interface](../README.md) / [attachments/client](../modules/attachments_client.md) / [\_internal\_namespace](../modules/attachments_client._internal_namespace.md) / FindArgs + +# Interface: FindArgs + +[attachments/client](../modules/attachments_client.md).[_internal_namespace](../modules/attachments_client._internal_namespace.md).FindArgs + +Parameters for finding attachments of a case + +## Table of contents + +### Properties + +- [caseID](attachments_client._internal_namespace.FindArgs.md#caseid) +- [queryParams](attachments_client._internal_namespace.FindArgs.md#queryparams) + +## Properties + +### caseID + +• **caseID**: `string` + +The case ID for finding associated attachments + +#### Defined in + +[x-pack/plugins/cases/server/client/attachments/get.ts:42](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/get.ts#L42) + +___ + +### queryParams + +• `Optional` **queryParams**: `Object` + +Optional parameters for filtering the returned attachments + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `defaultSearchOperator` | `undefined` \| ``"AND"`` \| ``"OR"`` | +| `fields` | `undefined` \| `string`[] | +| `filter` | `undefined` \| `string` | +| `hasReference` | `undefined` \| { `id`: `string` = rt.string; `type`: `string` = rt.string } \| { `id`: `string` = rt.string; `type`: `string` = rt.string }[] | +| `hasReferenceOperator` | `undefined` \| ``"AND"`` \| ``"OR"`` | +| `page` | `undefined` \| `number` | +| `perPage` | `undefined` \| `number` | +| `search` | `undefined` \| `string` | +| `searchFields` | `undefined` \| `string`[] | +| `sortField` | `undefined` \| `string` | +| `sortOrder` | `undefined` \| ``"desc"`` \| ``"asc"`` | + +#### Defined in + +[x-pack/plugins/cases/server/client/attachments/get.ts:46](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/get.ts#L46) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetAllAlertsAttachToCase.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetAllAlertsAttachToCase.md new file mode 100644 index 0000000000000..d45019010a3d6 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetAllAlertsAttachToCase.md @@ -0,0 +1,23 @@ +[Cases Client API Interface](../README.md) / [attachments/client](../modules/attachments_client.md) / [\_internal\_namespace](../modules/attachments_client._internal_namespace.md) / GetAllAlertsAttachToCase + +# Interface: GetAllAlertsAttachToCase + +[attachments/client](../modules/attachments_client.md).[_internal_namespace](../modules/attachments_client._internal_namespace.md).GetAllAlertsAttachToCase + +## Table of contents + +### Properties + +- [caseId](attachments_client._internal_namespace.GetAllAlertsAttachToCase.md#caseid) + +## Properties + +### caseId + +• **caseId**: `string` + +The ID of the case to retrieve the alerts from + +#### Defined in + +[x-pack/plugins/cases/server/client/attachments/get.ts:74](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/get.ts#L74) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetAllArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetAllArgs.md new file mode 100644 index 0000000000000..f5ebbd40a2d08 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetAllArgs.md @@ -0,0 +1,25 @@ +[Cases Client API Interface](../README.md) / [attachments/client](../modules/attachments_client.md) / [\_internal\_namespace](../modules/attachments_client._internal_namespace.md) / GetAllArgs + +# Interface: GetAllArgs + +[attachments/client](../modules/attachments_client.md).[_internal_namespace](../modules/attachments_client._internal_namespace.md).GetAllArgs + +Parameters for retrieving all attachments of a case + +## Table of contents + +### Properties + +- [caseID](attachments_client._internal_namespace.GetAllArgs.md#caseid) + +## Properties + +### caseID + +• **caseID**: `string` + +The case ID to retrieve all attachments for + +#### Defined in + +[x-pack/plugins/cases/server/client/attachments/get.ts:56](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/get.ts#L56) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetArgs.md new file mode 100644 index 0000000000000..8c36ea3ab2f12 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.GetArgs.md @@ -0,0 +1,36 @@ +[Cases Client API Interface](../README.md) / [attachments/client](../modules/attachments_client.md) / [\_internal\_namespace](../modules/attachments_client._internal_namespace.md) / GetArgs + +# Interface: GetArgs + +[attachments/client](../modules/attachments_client.md).[_internal_namespace](../modules/attachments_client._internal_namespace.md).GetArgs + +## Table of contents + +### Properties + +- [attachmentID](attachments_client._internal_namespace.GetArgs.md#attachmentid) +- [caseID](attachments_client._internal_namespace.GetArgs.md#caseid) + +## Properties + +### attachmentID + +• **attachmentID**: `string` + +The ID of the attachment to retrieve + +#### Defined in + +[x-pack/plugins/cases/server/client/attachments/get.ts:67](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/get.ts#L67) + +___ + +### caseID + +• **caseID**: `string` + +The ID of the case to retrieve an attachment from + +#### Defined in + +[x-pack/plugins/cases/server/client/attachments/get.ts:63](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/get.ts#L63) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.UpdateArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.UpdateArgs.md new file mode 100644 index 0000000000000..75650928ba124 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client._internal_namespace.UpdateArgs.md @@ -0,0 +1,38 @@ +[Cases Client API Interface](../README.md) / [attachments/client](../modules/attachments_client.md) / [\_internal\_namespace](../modules/attachments_client._internal_namespace.md) / UpdateArgs + +# Interface: UpdateArgs + +[attachments/client](../modules/attachments_client.md).[_internal_namespace](../modules/attachments_client._internal_namespace.md).UpdateArgs + +Parameters for updating a single attachment + +## Table of contents + +### Properties + +- [caseID](attachments_client._internal_namespace.UpdateArgs.md#caseid) +- [updateRequest](attachments_client._internal_namespace.UpdateArgs.md#updaterequest) + +## Properties + +### caseID + +• **caseID**: `string` + +The ID of the case that is associated with this attachment + +#### Defined in + +[x-pack/plugins/cases/server/client/attachments/update.ts:28](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/update.ts#L28) + +___ + +### updateRequest + +• **updateRequest**: { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `id`: `string` = rt.string; `version`: `string` = rt.string } + +The full attachment request with the fields updated with appropriate values + +#### Defined in + +[x-pack/plugins/cases/server/client/attachments/update.ts:32](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/update.ts#L32) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client.attachmentssubclient.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client.attachmentssubclient.md index ff9744583cfaf..04b77c2141ed8 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client.attachmentssubclient.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client.attachmentssubclient.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [attachments/client](../modules/attachments_client.md) / AttachmentsSubClient +[Cases Client API Interface](../README.md) / [attachments/client](../modules/attachments_client.md) / AttachmentsSubClient # Interface: AttachmentsSubClient @@ -10,20 +10,20 @@ API for interacting with the attachments to a case. ### Methods -- [add](attachments_client.attachmentssubclient.md#add) -- [delete](attachments_client.attachmentssubclient.md#delete) -- [deleteAll](attachments_client.attachmentssubclient.md#deleteall) -- [find](attachments_client.attachmentssubclient.md#find) -- [get](attachments_client.attachmentssubclient.md#get) -- [getAll](attachments_client.attachmentssubclient.md#getall) -- [getAllAlertsAttachToCase](attachments_client.attachmentssubclient.md#getallalertsattachtocase) -- [update](attachments_client.attachmentssubclient.md#update) +- [add](attachments_client.AttachmentsSubClient.md#add) +- [delete](attachments_client.AttachmentsSubClient.md#delete) +- [deleteAll](attachments_client.AttachmentsSubClient.md#deleteall) +- [find](attachments_client.AttachmentsSubClient.md#find) +- [get](attachments_client.AttachmentsSubClient.md#get) +- [getAll](attachments_client.AttachmentsSubClient.md#getall) +- [getAllAlertsAttachToCase](attachments_client.AttachmentsSubClient.md#getallalertsattachtocase) +- [update](attachments_client.AttachmentsSubClient.md#update) ## Methods ### add -▸ **add**(`params`: [*AddArgs*](attachments_add.addargs.md)): *Promise*<[*ICaseResponse*](typedoc_interfaces.icaseresponse.md)\> +▸ **add**(`params`): `Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> Adds an attachment to a case. @@ -31,17 +31,21 @@ Adds an attachment to a case. | Name | Type | | :------ | :------ | -| `params` | [*AddArgs*](attachments_add.addargs.md) | +| `params` | [`AddArgs`](attachments_client._internal_namespace.AddArgs.md) | -**Returns:** *Promise*<[*ICaseResponse*](typedoc_interfaces.icaseresponse.md)\> +#### Returns -Defined in: [attachments/client.ts:35](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/client.ts#L35) +`Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> + +#### Defined in + +[x-pack/plugins/cases/server/client/attachments/client.ts:35](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/client.ts#L35) ___ ### delete -▸ **delete**(`deleteArgs`: [*DeleteArgs*](attachments_delete.deleteargs.md)): *Promise* +▸ **delete**(`deleteArgs`): `Promise`<`void`\> Deletes a single attachment for a specific case. @@ -49,17 +53,21 @@ Deletes a single attachment for a specific case. | Name | Type | | :------ | :------ | -| `deleteArgs` | [*DeleteArgs*](attachments_delete.deleteargs.md) | +| `deleteArgs` | [`DeleteArgs`](attachments_client._internal_namespace.DeleteArgs.md) | + +#### Returns + +`Promise`<`void`\> -**Returns:** *Promise* +#### Defined in -Defined in: [attachments/client.ts:43](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/client.ts#L43) +[x-pack/plugins/cases/server/client/attachments/client.ts:43](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/client.ts#L43) ___ ### deleteAll -▸ **deleteAll**(`deleteAllArgs`: [*DeleteAllArgs*](attachments_delete.deleteallargs.md)): *Promise* +▸ **deleteAll**(`deleteAllArgs`): `Promise`<`void`\> Deletes all attachments associated with a single case. @@ -67,17 +75,21 @@ Deletes all attachments associated with a single case. | Name | Type | | :------ | :------ | -| `deleteAllArgs` | [*DeleteAllArgs*](attachments_delete.deleteallargs.md) | +| `deleteAllArgs` | [`DeleteAllArgs`](attachments_client._internal_namespace.DeleteAllArgs.md) | -**Returns:** *Promise* +#### Returns -Defined in: [attachments/client.ts:39](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/client.ts#L39) +`Promise`<`void`\> + +#### Defined in + +[x-pack/plugins/cases/server/client/attachments/client.ts:39](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/client.ts#L39) ___ ### find -▸ **find**(`findArgs`: [*FindArgs*](attachments_get.findargs.md)): *Promise*<[*ICommentsResponse*](typedoc_interfaces.icommentsresponse.md)\> +▸ **find**(`findArgs`): `Promise`<[`ICommentsResponse`](typedoc_interfaces.ICommentsResponse.md)\> Retrieves all comments matching the search criteria. @@ -85,17 +97,21 @@ Retrieves all comments matching the search criteria. | Name | Type | | :------ | :------ | -| `findArgs` | [*FindArgs*](attachments_get.findargs.md) | +| `findArgs` | [`FindArgs`](attachments_client._internal_namespace.FindArgs.md) | + +#### Returns + +`Promise`<[`ICommentsResponse`](typedoc_interfaces.ICommentsResponse.md)\> -**Returns:** *Promise*<[*ICommentsResponse*](typedoc_interfaces.icommentsresponse.md)\> +#### Defined in -Defined in: [attachments/client.ts:47](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/client.ts#L47) +[x-pack/plugins/cases/server/client/attachments/client.ts:47](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/client.ts#L47) ___ ### get -▸ **get**(`getArgs`: [*GetArgs*](attachments_get.getargs.md)): *Promise*<{ `comment`: *string* ; `owner`: *string* ; `type`: user } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* } & { `alertId`: *string* \| *string*[] ; `index`: *string* \| *string*[] ; `owner`: *string* ; `rule`: { id: string \| null; name: string \| null; } ; `type`: alert \| generatedAlert } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: *string* ; `owner`: *string* ; `type`: actions } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* }\> +▸ **get**(`getArgs`): `Promise`<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string }\> Retrieves a single attachment for a case. @@ -103,17 +119,21 @@ Retrieves a single attachment for a case. | Name | Type | | :------ | :------ | -| `getArgs` | [*GetArgs*](attachments_get.getargs.md) | +| `getArgs` | [`GetArgs`](attachments_client._internal_namespace.GetArgs.md) | -**Returns:** *Promise*<{ `comment`: *string* ; `owner`: *string* ; `type`: user } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* } & { `alertId`: *string* \| *string*[] ; `index`: *string* \| *string*[] ; `owner`: *string* ; `rule`: { id: string \| null; name: string \| null; } ; `type`: alert \| generatedAlert } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: *string* ; `owner`: *string* ; `type`: actions } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* }\> +#### Returns -Defined in: [attachments/client.ts:59](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/client.ts#L59) +`Promise`<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string }\> + +#### Defined in + +[x-pack/plugins/cases/server/client/attachments/client.ts:59](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/client.ts#L59) ___ ### getAll -▸ **getAll**(`getAllArgs`: [*GetAllArgs*](attachments_get.getallargs.md)): *Promise*<[*IAllCommentsResponse*](typedoc_interfaces.iallcommentsresponse.md)\> +▸ **getAll**(`getAllArgs`): `Promise`<[`IAllCommentsResponse`](typedoc_interfaces.IAllCommentsResponse.md)\> Gets all attachments for a single case. @@ -121,17 +141,21 @@ Gets all attachments for a single case. | Name | Type | | :------ | :------ | -| `getAllArgs` | [*GetAllArgs*](attachments_get.getallargs.md) | +| `getAllArgs` | [`GetAllArgs`](attachments_client._internal_namespace.GetAllArgs.md) | + +#### Returns + +`Promise`<[`IAllCommentsResponse`](typedoc_interfaces.IAllCommentsResponse.md)\> -**Returns:** *Promise*<[*IAllCommentsResponse*](typedoc_interfaces.iallcommentsresponse.md)\> +#### Defined in -Defined in: [attachments/client.ts:55](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/client.ts#L55) +[x-pack/plugins/cases/server/client/attachments/client.ts:55](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/client.ts#L55) ___ ### getAllAlertsAttachToCase -▸ **getAllAlertsAttachToCase**(`params`: [*GetAllAlertsAttachToCase*](attachments_get.getallalertsattachtocase.md)): *Promise*<{ `attached_at`: *string* ; `id`: *string* ; `index`: *string* }[]\> +▸ **getAllAlertsAttachToCase**(`params`): `Promise`<{ `attached_at`: `string` = rt.string; `id`: `string` = rt.string; `index`: `string` = rt.string }[]\> Retrieves all alerts attach to a case given a single case ID @@ -139,17 +163,21 @@ Retrieves all alerts attach to a case given a single case ID | Name | Type | | :------ | :------ | -| `params` | [*GetAllAlertsAttachToCase*](attachments_get.getallalertsattachtocase.md) | +| `params` | [`GetAllAlertsAttachToCase`](attachments_client._internal_namespace.GetAllAlertsAttachToCase.md) | -**Returns:** *Promise*<{ `attached_at`: *string* ; `id`: *string* ; `index`: *string* }[]\> +#### Returns -Defined in: [attachments/client.ts:51](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/client.ts#L51) +`Promise`<{ `attached_at`: `string` = rt.string; `id`: `string` = rt.string; `index`: `string` = rt.string }[]\> + +#### Defined in + +[x-pack/plugins/cases/server/client/attachments/client.ts:51](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/client.ts#L51) ___ ### update -▸ **update**(`updateArgs`: [*UpdateArgs*](attachments_update.updateargs.md)): *Promise*<[*ICaseResponse*](typedoc_interfaces.icaseresponse.md)\> +▸ **update**(`updateArgs`): `Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> Updates a specific attachment. @@ -159,8 +187,12 @@ The request must include all fields for the attachment. Even the fields that are | Name | Type | | :------ | :------ | -| `updateArgs` | [*UpdateArgs*](attachments_update.updateargs.md) | +| `updateArgs` | [`UpdateArgs`](attachments_client._internal_namespace.UpdateArgs.md) | + +#### Returns + +`Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> -**Returns:** *Promise*<[*ICaseResponse*](typedoc_interfaces.icaseresponse.md)\> +#### Defined in -Defined in: [attachments/client.ts:65](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/client.ts#L65) +[x-pack/plugins/cases/server/client/attachments/client.ts:65](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/attachments/client.ts#L65) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_delete.deleteallargs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_delete.deleteallargs.md deleted file mode 100644 index 39c72e81a9935..0000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_delete.deleteallargs.md +++ /dev/null @@ -1,34 +0,0 @@ -[Cases Client API Interface](../cases_client_api.md) / [attachments/delete](../modules/attachments_delete.md) / DeleteAllArgs - -# Interface: DeleteAllArgs - -[attachments/delete](../modules/attachments_delete.md).DeleteAllArgs - -Parameters for deleting all comments of a case or sub case. - -## Table of contents - -### Properties - -- [caseID](attachments_delete.deleteallargs.md#caseid) -- [subCaseID](attachments_delete.deleteallargs.md#subcaseid) - -## Properties - -### caseID - -• **caseID**: *string* - -The case ID to delete all attachments for - -Defined in: [attachments/delete.ts:31](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/delete.ts#L31) - -___ - -### subCaseID - -• `Optional` **subCaseID**: *string* - -If specified the caseID will be ignored and this value will be used to find a sub case for deleting all the attachments - -Defined in: [attachments/delete.ts:35](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/delete.ts#L35) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_delete.deleteargs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_delete.deleteargs.md deleted file mode 100644 index fb7e61fa1521f..0000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_delete.deleteargs.md +++ /dev/null @@ -1,45 +0,0 @@ -[Cases Client API Interface](../cases_client_api.md) / [attachments/delete](../modules/attachments_delete.md) / DeleteArgs - -# Interface: DeleteArgs - -[attachments/delete](../modules/attachments_delete.md).DeleteArgs - -Parameters for deleting a single attachment of a case or sub case. - -## Table of contents - -### Properties - -- [attachmentID](attachments_delete.deleteargs.md#attachmentid) -- [caseID](attachments_delete.deleteargs.md#caseid) -- [subCaseID](attachments_delete.deleteargs.md#subcaseid) - -## Properties - -### attachmentID - -• **attachmentID**: *string* - -The attachment ID to delete - -Defined in: [attachments/delete.ts:49](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/delete.ts#L49) - -___ - -### caseID - -• **caseID**: *string* - -The case ID to delete an attachment from - -Defined in: [attachments/delete.ts:45](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/delete.ts#L45) - -___ - -### subCaseID - -• `Optional` **subCaseID**: *string* - -If specified the caseID will be ignored and this value will be used to find a sub case for deleting the attachment - -Defined in: [attachments/delete.ts:53](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/delete.ts#L53) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.findargs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.findargs.md deleted file mode 100644 index 826a05f5865ab..0000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.findargs.md +++ /dev/null @@ -1,51 +0,0 @@ -[Cases Client API Interface](../cases_client_api.md) / [attachments/get](../modules/attachments_get.md) / FindArgs - -# Interface: FindArgs - -[attachments/get](../modules/attachments_get.md).FindArgs - -Parameters for finding attachments of a case - -## Table of contents - -### Properties - -- [caseID](attachments_get.findargs.md#caseid) -- [queryParams](attachments_get.findargs.md#queryparams) - -## Properties - -### caseID - -• **caseID**: *string* - -The case ID for finding associated attachments - -Defined in: [attachments/get.ts:47](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/get.ts#L47) - -___ - -### queryParams - -• `Optional` **queryParams**: *object* - -Optional parameters for filtering the returned attachments - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `defaultSearchOperator` | *undefined* \| ``"AND"`` \| ``"OR"`` | -| `fields` | *undefined* \| *string*[] | -| `filter` | *undefined* \| *string* | -| `hasReference` | *undefined* \| { `id`: *string* ; `type`: *string* } \| { `id`: *string* ; `type`: *string* }[] | -| `hasReferenceOperator` | *undefined* \| ``"AND"`` \| ``"OR"`` | -| `page` | *undefined* \| *number* | -| `perPage` | *undefined* \| *number* | -| `search` | *undefined* \| *string* | -| `searchFields` | *undefined* \| *string*[] | -| `sortField` | *undefined* \| *string* | -| `sortOrder` | *undefined* \| ``"desc"`` \| ``"asc"`` | -| `subCaseId` | *undefined* \| *string* | - -Defined in: [attachments/get.ts:51](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/get.ts#L51) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.getallalertsattachtocase.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.getallalertsattachtocase.md deleted file mode 100644 index abeeaca19b23e..0000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.getallalertsattachtocase.md +++ /dev/null @@ -1,21 +0,0 @@ -[Cases Client API Interface](../cases_client_api.md) / [attachments/get](../modules/attachments_get.md) / GetAllAlertsAttachToCase - -# Interface: GetAllAlertsAttachToCase - -[attachments/get](../modules/attachments_get.md).GetAllAlertsAttachToCase - -## Table of contents - -### Properties - -- [caseId](attachments_get.getallalertsattachtocase.md#caseid) - -## Properties - -### caseId - -• **caseId**: *string* - -The ID of the case to retrieve the alerts from - -Defined in: [attachments/get.ts:87](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/get.ts#L87) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.getallargs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.getallargs.md deleted file mode 100644 index 9ea29437d5c2c..0000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.getallargs.md +++ /dev/null @@ -1,45 +0,0 @@ -[Cases Client API Interface](../cases_client_api.md) / [attachments/get](../modules/attachments_get.md) / GetAllArgs - -# Interface: GetAllArgs - -[attachments/get](../modules/attachments_get.md).GetAllArgs - -Parameters for retrieving all attachments of a case - -## Table of contents - -### Properties - -- [caseID](attachments_get.getallargs.md#caseid) -- [includeSubCaseComments](attachments_get.getallargs.md#includesubcasecomments) -- [subCaseID](attachments_get.getallargs.md#subcaseid) - -## Properties - -### caseID - -• **caseID**: *string* - -The case ID to retrieve all attachments for - -Defined in: [attachments/get.ts:61](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/get.ts#L61) - -___ - -### includeSubCaseComments - -• `Optional` **includeSubCaseComments**: *boolean* - -Optionally include the attachments associated with a sub case - -Defined in: [attachments/get.ts:65](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/get.ts#L65) - -___ - -### subCaseID - -• `Optional` **subCaseID**: *string* - -If included the case ID will be ignored and the attachments will be retrieved from the specified ID of the sub case - -Defined in: [attachments/get.ts:69](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/get.ts#L69) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.getargs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.getargs.md deleted file mode 100644 index e46d83d795f48..0000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.getargs.md +++ /dev/null @@ -1,32 +0,0 @@ -[Cases Client API Interface](../cases_client_api.md) / [attachments/get](../modules/attachments_get.md) / GetArgs - -# Interface: GetArgs - -[attachments/get](../modules/attachments_get.md).GetArgs - -## Table of contents - -### Properties - -- [attachmentID](attachments_get.getargs.md#attachmentid) -- [caseID](attachments_get.getargs.md#caseid) - -## Properties - -### attachmentID - -• **attachmentID**: *string* - -The ID of the attachment to retrieve - -Defined in: [attachments/get.ts:80](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/get.ts#L80) - -___ - -### caseID - -• **caseID**: *string* - -The ID of the case to retrieve an attachment from - -Defined in: [attachments/get.ts:76](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/get.ts#L76) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_update.updateargs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_update.updateargs.md deleted file mode 100644 index 23d7c88c9c864..0000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/attachments_update.updateargs.md +++ /dev/null @@ -1,45 +0,0 @@ -[Cases Client API Interface](../cases_client_api.md) / [attachments/update](../modules/attachments_update.md) / UpdateArgs - -# Interface: UpdateArgs - -[attachments/update](../modules/attachments_update.md).UpdateArgs - -Parameters for updating a single attachment - -## Table of contents - -### Properties - -- [caseID](attachments_update.updateargs.md#caseid) -- [subCaseID](attachments_update.updateargs.md#subcaseid) -- [updateRequest](attachments_update.updateargs.md#updaterequest) - -## Properties - -### caseID - -• **caseID**: *string* - -The ID of the case that is associated with this attachment - -Defined in: [attachments/update.ts:32](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/update.ts#L32) - -___ - -### subCaseID - -• `Optional` **subCaseID**: *string* - -The ID of a sub case, if specified a sub case will be searched for to perform the attachment update instead of on a case - -Defined in: [attachments/update.ts:40](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/update.ts#L40) - -___ - -### updateRequest - -• **updateRequest**: { `comment`: *string* ; `owner`: *string* ; `type`: user } & { `id`: *string* ; `version`: *string* } & { `alertId`: *string* \| *string*[] ; `index`: *string* \| *string*[] ; `owner`: *string* ; `rule`: { id: string \| null; name: string \| null; } ; `type`: alert \| generatedAlert } & { `id`: *string* ; `version`: *string* } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: *string* ; `owner`: *string* ; `type`: actions } & { `id`: *string* ; `version`: *string* } - -The full attachment request with the fields updated with appropriate values - -Defined in: [attachments/update.ts:36](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/update.ts#L36) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/cases_client.casessubclient.md b/x-pack/plugins/cases/docs/cases_client/interfaces/cases_client.casessubclient.md index 45285066b4608..df4d1bdf7966f 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/cases_client.casessubclient.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/cases_client.casessubclient.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [cases/client](../modules/cases_client.md) / CasesSubClient +[Cases Client API Interface](../README.md) / [cases/client](../modules/cases_client.md) / CasesSubClient # Interface: CasesSubClient @@ -10,21 +10,22 @@ API for interacting with the cases entities. ### Methods -- [create](cases_client.casessubclient.md#create) -- [delete](cases_client.casessubclient.md#delete) -- [find](cases_client.casessubclient.md#find) -- [get](cases_client.casessubclient.md#get) -- [getCasesByAlertID](cases_client.casessubclient.md#getcasesbyalertid) -- [getReporters](cases_client.casessubclient.md#getreporters) -- [getTags](cases_client.casessubclient.md#gettags) -- [push](cases_client.casessubclient.md#push) -- [update](cases_client.casessubclient.md#update) +- [create](cases_client.CasesSubClient.md#create) +- [delete](cases_client.CasesSubClient.md#delete) +- [find](cases_client.CasesSubClient.md#find) +- [get](cases_client.CasesSubClient.md#get) +- [getCasesByAlertID](cases_client.CasesSubClient.md#getcasesbyalertid) +- [getReporters](cases_client.CasesSubClient.md#getreporters) +- [getTags](cases_client.CasesSubClient.md#gettags) +- [push](cases_client.CasesSubClient.md#push) +- [resolve](cases_client.CasesSubClient.md#resolve) +- [update](cases_client.CasesSubClient.md#update) ## Methods ### create -▸ **create**(`data`: [*ICasePostRequest*](typedoc_interfaces.icasepostrequest.md)): *Promise*<[*ICaseResponse*](typedoc_interfaces.icaseresponse.md)\> +▸ **create**(`data`): `Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> Creates a case. @@ -32,17 +33,21 @@ Creates a case. | Name | Type | | :------ | :------ | -| `data` | [*ICasePostRequest*](typedoc_interfaces.icasepostrequest.md) | +| `data` | [`ICasePostRequest`](typedoc_interfaces.ICasePostRequest.md) | -**Returns:** *Promise*<[*ICaseResponse*](typedoc_interfaces.icaseresponse.md)\> +#### Returns -Defined in: [cases/client.ts:49](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/client.ts#L49) +`Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> + +#### Defined in + +[x-pack/plugins/cases/server/client/cases/client.ts:51](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L51) ___ ### delete -▸ **delete**(`ids`: *string*[]): *Promise* +▸ **delete**(`ids`): `Promise`<`void`\> Delete a case and all its comments. @@ -52,17 +57,21 @@ Delete a case and all its comments. | Name | Type | | :------ | :------ | -| `ids` | *string*[] | +| `ids` | `string`[] | + +#### Returns + +`Promise`<`void`\> -**Returns:** *Promise* +#### Defined in -Defined in: [cases/client.ts:73](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/client.ts#L73) +[x-pack/plugins/cases/server/client/cases/client.ts:80](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L80) ___ ### find -▸ **find**(`params`: [*ICasesFindRequest*](typedoc_interfaces.icasesfindrequest.md)): *Promise*<[*ICasesFindResponse*](typedoc_interfaces.icasesfindresponse.md)\> +▸ **find**(`params`): `Promise`<[`ICasesFindResponse`](typedoc_interfaces.ICasesFindResponse.md)\> Returns cases that match the search criteria. @@ -72,17 +81,21 @@ If the `owner` field is left empty then all the cases that the user has access t | Name | Type | | :------ | :------ | -| `params` | [*ICasesFindRequest*](typedoc_interfaces.icasesfindrequest.md) | +| `params` | [`ICasesFindRequest`](typedoc_interfaces.ICasesFindRequest.md) | -**Returns:** *Promise*<[*ICasesFindResponse*](typedoc_interfaces.icasesfindresponse.md)\> +#### Returns -Defined in: [cases/client.ts:55](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/client.ts#L55) +`Promise`<[`ICasesFindResponse`](typedoc_interfaces.ICasesFindResponse.md)\> + +#### Defined in + +[x-pack/plugins/cases/server/client/cases/client.ts:57](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L57) ___ ### get -▸ **get**(`params`: [*GetParams*](cases_get.getparams.md)): *Promise*<[*ICaseResponse*](typedoc_interfaces.icaseresponse.md)\> +▸ **get**(`params`): `Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> Retrieves a single case with the specified ID. @@ -90,17 +103,21 @@ Retrieves a single case with the specified ID. | Name | Type | | :------ | :------ | -| `params` | [*GetParams*](cases_get.getparams.md) | +| `params` | [`GetParams`](cases_get.GetParams.md) | + +#### Returns + +`Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> -**Returns:** *Promise*<[*ICaseResponse*](typedoc_interfaces.icaseresponse.md)\> +#### Defined in -Defined in: [cases/client.ts:59](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/client.ts#L59) +[x-pack/plugins/cases/server/client/cases/client.ts:61](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L61) ___ ### getCasesByAlertID -▸ **getCasesByAlertID**(`params`: [*CasesByAlertIDParams*](cases_get.casesbyalertidparams.md)): *Promise*<{ `id`: *string* ; `title`: *string* }[]\> +▸ **getCasesByAlertID**(`params`): `Promise`<{ `id`: `string` = rt.string; `title`: `string` = rt.string }[]\> Retrieves the cases ID and title that have the requested alert attached to them @@ -108,17 +125,21 @@ Retrieves the cases ID and title that have the requested alert attached to them | Name | Type | | :------ | :------ | -| `params` | [*CasesByAlertIDParams*](cases_get.casesbyalertidparams.md) | +| `params` | [`CasesByAlertIDParams`](cases_get.CasesByAlertIDParams.md) | -**Returns:** *Promise*<{ `id`: *string* ; `title`: *string* }[]\> +#### Returns -Defined in: [cases/client.ts:85](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/client.ts#L85) +`Promise`<{ `id`: `string` = rt.string; `title`: `string` = rt.string }[]\> + +#### Defined in + +[x-pack/plugins/cases/server/client/cases/client.ts:92](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L92) ___ ### getReporters -▸ **getReporters**(`params`: { `owner`: *undefined* \| *string* \| *string*[] }): *Promise*<{ `email`: *undefined* \| ``null`` \| *string* ; `full_name`: *undefined* \| ``null`` \| *string* ; `username`: *undefined* \| ``null`` \| *string* }[]\> +▸ **getReporters**(`params`): `Promise`<{ `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` }[]\> Retrieves all the reporters across all accessible cases. @@ -126,18 +147,22 @@ Retrieves all the reporters across all accessible cases. | Name | Type | | :------ | :------ | -| `params` | *object* | -| `params.owner` | *undefined* \| *string* \| *string*[] | +| `params` | `Object` | +| `params.owner` | `undefined` \| `string` \| `string`[] | + +#### Returns + +`Promise`<{ `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` }[]\> -**Returns:** *Promise*<{ `email`: *undefined* \| ``null`` \| *string* ; `full_name`: *undefined* \| ``null`` \| *string* ; `username`: *undefined* \| ``null`` \| *string* }[]\> +#### Defined in -Defined in: [cases/client.ts:81](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/client.ts#L81) +[x-pack/plugins/cases/server/client/cases/client.ts:88](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L88) ___ ### getTags -▸ **getTags**(`params`: { `owner`: *undefined* \| *string* \| *string*[] }): *Promise* +▸ **getTags**(`params`): `Promise`<`string`[]\> Retrieves all the tags across all cases the user making the request has access to. @@ -145,18 +170,22 @@ Retrieves all the tags across all cases the user making the request has access t | Name | Type | | :------ | :------ | -| `params` | *object* | -| `params.owner` | *undefined* \| *string* \| *string*[] | +| `params` | `Object` | +| `params.owner` | `undefined` \| `string` \| `string`[] | -**Returns:** *Promise* +#### Returns -Defined in: [cases/client.ts:77](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/client.ts#L77) +`Promise`<`string`[]\> + +#### Defined in + +[x-pack/plugins/cases/server/client/cases/client.ts:84](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L84) ___ ### push -▸ **push**(`args`: [*PushParams*](cases_push.pushparams.md)): *Promise*<[*ICaseResponse*](typedoc_interfaces.icaseresponse.md)\> +▸ **push**(`args`): `Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> Pushes a specific case to an external system. @@ -164,17 +193,44 @@ Pushes a specific case to an external system. | Name | Type | | :------ | :------ | -| `args` | [*PushParams*](cases_push.pushparams.md) | +| `args` | [`PushParams`](cases_push.PushParams.md) | + +#### Returns + +`Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\> + +#### Defined in + +[x-pack/plugins/cases/server/client/cases/client.ts:70](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L70) + +___ + +### resolve + +▸ **resolve**(`params`): `Promise`<[`ICaseResolveResponse`](typedoc_interfaces.ICaseResolveResponse.md)\> + +**`experimental`** +Retrieves a single case resolving the specified ID. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | [`GetParams`](cases_get.GetParams.md) | -**Returns:** *Promise*<[*ICaseResponse*](typedoc_interfaces.icaseresponse.md)\> +#### Returns -Defined in: [cases/client.ts:63](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/client.ts#L63) +`Promise`<[`ICaseResolveResponse`](typedoc_interfaces.ICaseResolveResponse.md)\> + +#### Defined in + +[x-pack/plugins/cases/server/client/cases/client.ts:66](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L66) ___ ### update -▸ **update**(`cases`: [*ICasesPatchRequest*](typedoc_interfaces.icasespatchrequest.md)): *Promise*<[*ICasesResponse*](typedoc_interfaces.icasesresponse.md)\> +▸ **update**(`cases`): `Promise`<[`ICasesResponse`](typedoc_interfaces.ICasesResponse.md)\> Update the specified cases with the passed in values. @@ -182,8 +238,12 @@ Update the specified cases with the passed in values. | Name | Type | | :------ | :------ | -| `cases` | [*ICasesPatchRequest*](typedoc_interfaces.icasespatchrequest.md) | +| `cases` | [`ICasesPatchRequest`](typedoc_interfaces.ICasesPatchRequest.md) | + +#### Returns + +`Promise`<[`ICasesResponse`](typedoc_interfaces.ICasesResponse.md)\> -**Returns:** *Promise*<[*ICasesResponse*](typedoc_interfaces.icasesresponse.md)\> +#### Defined in -Defined in: [cases/client.ts:67](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/client.ts#L67) +[x-pack/plugins/cases/server/client/cases/client.ts:74](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/client.ts#L74) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/cases_get.casesbyalertidparams.md b/x-pack/plugins/cases/docs/cases_client/interfaces/cases_get.casesbyalertidparams.md index 257269ca64566..2e0cf957be8e3 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/cases_get.casesbyalertidparams.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/cases_get.casesbyalertidparams.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [cases/get](../modules/cases_get.md) / CasesByAlertIDParams +[Cases Client API Interface](../README.md) / [cases/get](../modules/cases_get.md) / CasesByAlertIDParams # Interface: CasesByAlertIDParams @@ -10,24 +10,26 @@ Parameters for finding cases IDs using an alert ID ### Properties -- [alertID](cases_get.casesbyalertidparams.md#alertid) -- [options](cases_get.casesbyalertidparams.md#options) +- [alertID](cases_get.CasesByAlertIDParams.md#alertid) +- [options](cases_get.CasesByAlertIDParams.md#options) ## Properties ### alertID -• **alertID**: *string* +• **alertID**: `string` The alert ID to search for -Defined in: [cases/get.ts:44](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/get.ts#L44) +#### Defined in + +[x-pack/plugins/cases/server/client/cases/get.ts:45](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/get.ts#L45) ___ ### options -• **options**: *object* +• **options**: `Object` The filtering options when searching for associated cases. @@ -35,6 +37,8 @@ The filtering options when searching for associated cases. | Name | Type | | :------ | :------ | -| `owner` | *undefined* \| *string* \| *string*[] | +| `owner` | `undefined` \| `string` \| `string`[] | + +#### Defined in -Defined in: [cases/get.ts:48](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/get.ts#L48) +[x-pack/plugins/cases/server/client/cases/get.ts:49](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/get.ts#L49) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/cases_get.getparams.md b/x-pack/plugins/cases/docs/cases_client/interfaces/cases_get.getparams.md index 16cc952746818..ccd09fd4db48c 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/cases_get.getparams.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/cases_get.getparams.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [cases/get](../modules/cases_get.md) / GetParams +[Cases Client API Interface](../README.md) / [cases/get](../modules/cases_get.md) / GetParams # Interface: GetParams @@ -10,36 +10,29 @@ The parameters for retrieving a case ### Properties -- [id](cases_get.getparams.md#id) -- [includeComments](cases_get.getparams.md#includecomments) -- [includeSubCaseComments](cases_get.getparams.md#includesubcasecomments) +- [id](cases_get.GetParams.md#id) +- [includeComments](cases_get.GetParams.md#includecomments) ## Properties ### id -• **id**: *string* +• **id**: `string` Case ID -Defined in: [cases/get.ts:145](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/get.ts#L145) +#### Defined in + +[x-pack/plugins/cases/server/client/cases/get.ts:144](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/get.ts#L144) ___ ### includeComments -• `Optional` **includeComments**: *boolean* +• `Optional` **includeComments**: `boolean` Whether to include the attachments for a case in the response -Defined in: [cases/get.ts:149](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/get.ts#L149) - -___ - -### includeSubCaseComments - -• `Optional` **includeSubCaseComments**: *boolean* - -Whether to include the attachments for all children of a case in the response +#### Defined in -Defined in: [cases/get.ts:153](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/get.ts#L153) +[x-pack/plugins/cases/server/client/cases/get.ts:148](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/get.ts#L148) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/cases_push.pushparams.md b/x-pack/plugins/cases/docs/cases_client/interfaces/cases_push.pushparams.md index 3aa6ee77941a8..436850a7b64fd 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/cases_push.pushparams.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/cases_push.pushparams.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [cases/push](../modules/cases_push.md) / PushParams +[Cases Client API Interface](../README.md) / [cases/push](../modules/cases_push.md) / PushParams # Interface: PushParams @@ -10,25 +10,29 @@ Parameters for pushing a case to an external system ### Properties -- [caseId](cases_push.pushparams.md#caseid) -- [connectorId](cases_push.pushparams.md#connectorid) +- [caseId](cases_push.PushParams.md#caseid) +- [connectorId](cases_push.PushParams.md#connectorid) ## Properties ### caseId -• **caseId**: *string* +• **caseId**: `string` The ID of a case -Defined in: [cases/push.ts:53](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/push.ts#L53) +#### Defined in + +[x-pack/plugins/cases/server/client/cases/push.ts:48](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/push.ts#L48) ___ ### connectorId -• **connectorId**: *string* +• **connectorId**: `string` The ID of an external system to push to -Defined in: [cases/push.ts:57](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/push.ts#L57) +#### Defined in + +[x-pack/plugins/cases/server/client/cases/push.ts:52](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/push.ts#L52) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Action.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Action.md new file mode 100644 index 0000000000000..7f8e04653acf6 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Action.md @@ -0,0 +1,72 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Action + +# Interface: Action + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Action + +## Hierarchy + +- [`ActionUpdate`](client._internal_namespace.ActionUpdate.md) + + ↳ **`Action`** + +## Table of contents + +### Properties + +- [actionTypeId](client._internal_namespace.Action.md#actiontypeid) +- [config](client._internal_namespace.Action.md#config) +- [name](client._internal_namespace.Action.md#name) +- [secrets](client._internal_namespace.Action.md#secrets) + +## Properties + +### actionTypeId + +• **actionTypeId**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:19 + +___ + +### config + +• **config**: [`SavedObjectAttributes`](client._internal_namespace.SavedObjectAttributes.md) + +#### Inherited from + +[ActionUpdate](client._internal_namespace.ActionUpdate.md).[config](client._internal_namespace.ActionUpdate.md#config) + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:15 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[ActionUpdate](client._internal_namespace.ActionUpdate.md).[name](client._internal_namespace.ActionUpdate.md#name) + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:14 + +___ + +### secrets + +• **secrets**: [`SavedObjectAttributes`](client._internal_namespace.SavedObjectAttributes.md) + +#### Inherited from + +[ActionUpdate](client._internal_namespace.ActionUpdate.md).[secrets](client._internal_namespace.ActionUpdate.md#secrets) + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:16 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionExecutionSource.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionExecutionSource.md new file mode 100644 index 0000000000000..1b7033f5805c8 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionExecutionSource.md @@ -0,0 +1,38 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionExecutionSource + +# Interface: ActionExecutionSource + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionExecutionSource + +## Type parameters + +| Name | +| :------ | +| `T` | + +## Table of contents + +### Properties + +- [source](client._internal_namespace.ActionExecutionSource.md#source) +- [type](client._internal_namespace.ActionExecutionSource.md#type) + +## Properties + +### source + +• **source**: `T` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_execution_source.d.ts:8 + +___ + +### type + +• **type**: [`ActionExecutionSourceType`](../enums/client._internal_namespace.ActionExecutionSourceType.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_execution_source.d.ts:7 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionExecutorContext.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionExecutorContext.md new file mode 100644 index 0000000000000..093b2933ddfac --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionExecutorContext.md @@ -0,0 +1,112 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionExecutorContext + +# Interface: ActionExecutorContext + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionExecutorContext + +## Table of contents + +### Properties + +- [actionTypeRegistry](client._internal_namespace.ActionExecutorContext.md#actiontyperegistry) +- [encryptedSavedObjectsClient](client._internal_namespace.ActionExecutorContext.md#encryptedsavedobjectsclient) +- [eventLogger](client._internal_namespace.ActionExecutorContext.md#eventlogger) +- [getServices](client._internal_namespace.ActionExecutorContext.md#getservices) +- [logger](client._internal_namespace.ActionExecutorContext.md#logger) +- [preconfiguredActions](client._internal_namespace.ActionExecutorContext.md#preconfiguredactions) +- [spaces](client._internal_namespace.ActionExecutorContext.md#spaces) + +### Methods + +- [getActionsClientWithRequest](client._internal_namespace.ActionExecutorContext.md#getactionsclientwithrequest) + +## Properties + +### actionTypeRegistry + +• **actionTypeRegistry**: [`ActionTypeRegistryContract`](../modules/client._internal_namespace.md#actiontyperegistrycontract) + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:16 + +___ + +### encryptedSavedObjectsClient + +• **encryptedSavedObjectsClient**: [`EncryptedSavedObjectsClient`](client._internal_namespace.EncryptedSavedObjectsClient.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:15 + +___ + +### eventLogger + +• **eventLogger**: [`IEventLogger`](client._internal_namespace.IEventLogger.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:17 + +___ + +### getServices + +• **getServices**: [`GetServicesFunction`](../modules/client._internal_namespace.md#getservicesfunction) + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:13 + +___ + +### logger + +• **logger**: `Logger` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:11 + +___ + +### preconfiguredActions + +• **preconfiguredActions**: [`PreConfiguredAction`](client._internal_namespace.PreConfiguredAction.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig), [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets)\>[] + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:18 + +___ + +### spaces + +• `Optional` **spaces**: [`SpacesServiceStart`](client._internal_namespace.SpacesServiceStart.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:12 + +## Methods + +### getActionsClientWithRequest + +▸ **getActionsClientWithRequest**(`request`, `authorizationContext?`): `Promise`<`PublicMethodsOf`<[`ActionsClient`](../classes/client._internal_namespace.ActionsClient.md)\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | +| `authorizationContext?` | [`ActionExecutionSource`](client._internal_namespace.ActionExecutionSource.md)<`unknown`\> | + +#### Returns + +`Promise`<`PublicMethodsOf`<[`ActionsClient`](../classes/client._internal_namespace.ActionsClient.md)\>\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:14 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionResult.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionResult.md new file mode 100644 index 0000000000000..7a303e0216b3a --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionResult.md @@ -0,0 +1,90 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionResult + +# Interface: ActionResult + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionResult + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | extends [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) = [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) | + +## Hierarchy + +- **`ActionResult`** + + ↳ [`FindActionResult`](client._internal_namespace.FindActionResult.md) + + ↳ [`PreConfiguredAction`](client._internal_namespace.PreConfiguredAction.md) + +## Table of contents + +### Properties + +- [actionTypeId](client._internal_namespace.ActionResult.md#actiontypeid) +- [config](client._internal_namespace.ActionResult.md#config) +- [id](client._internal_namespace.ActionResult.md#id) +- [isMissingSecrets](client._internal_namespace.ActionResult.md#ismissingsecrets) +- [isPreconfigured](client._internal_namespace.ActionResult.md#ispreconfigured) +- [name](client._internal_namespace.ActionResult.md#name) + +## Properties + +### actionTypeId + +• **actionTypeId**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:50 + +___ + +### config + +• `Optional` **config**: `Config` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:53 + +___ + +### id + +• **id**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:49 + +___ + +### isMissingSecrets + +• `Optional` **isMissingSecrets**: `boolean` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:52 + +___ + +### isPreconfigured + +• **isPreconfigured**: `boolean` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:54 + +___ + +### name + +• **name**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:51 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionType-1.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionType-1.md new file mode 100644 index 0000000000000..ac0b15f74c84d --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionType-1.md @@ -0,0 +1,120 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionType + +# Interface: ActionType + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionType + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | extends [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) = [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) | +| `Secrets` | extends [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets) = [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets) | +| `Params` | extends [`ActionTypeParams`](../modules/client._internal_namespace.md#actiontypeparams) = [`ActionTypeParams`](../modules/client._internal_namespace.md#actiontypeparams) | +| `ExecutorResultData` | `void` | + +## Table of contents + +### Properties + +- [executor](client._internal_namespace.ActionType-1.md#executor) +- [id](client._internal_namespace.ActionType-1.md#id) +- [maxAttempts](client._internal_namespace.ActionType-1.md#maxattempts) +- [minimumLicenseRequired](client._internal_namespace.ActionType-1.md#minimumlicenserequired) +- [name](client._internal_namespace.ActionType-1.md#name) +- [validate](client._internal_namespace.ActionType-1.md#validate) + +### Methods + +- [renderParameterTemplates](client._internal_namespace.ActionType-1.md#renderparametertemplates) + +## Properties + +### executor + +• **executor**: [`ExecutorType`](../modules/client._internal_namespace.md#executortype)<`Config`, `Secrets`, `Params`, `ExecutorResultData`\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:82 + +___ + +### id + +• **id**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:71 + +___ + +### maxAttempts + +• `Optional` **maxAttempts**: `number` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:73 + +___ + +### minimumLicenseRequired + +• **minimumLicenseRequired**: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:74 + +___ + +### name + +• **name**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:72 + +___ + +### validate + +• `Optional` **validate**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `config?` | [`ValidatorType`](client._internal_namespace.ValidatorType.md)<`Config`\> | +| `params?` | [`ValidatorType`](client._internal_namespace.ValidatorType.md)<`Params`\> | +| `secrets?` | [`ValidatorType`](client._internal_namespace.ValidatorType.md)<`Secrets`\> | +| `connector?` | (`config`: `Config`, `secrets`: `Secrets`) => ``null`` \| `string` | + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:75 + +## Methods + +### renderParameterTemplates + +▸ `Optional` **renderParameterTemplates**(`params`, `variables`, `actionId?`): `Params` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Params` | +| `variables` | `Record`<`string`, `unknown`\> | +| `actionId?` | `string` | + +#### Returns + +`Params` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:81 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionType.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionType.md new file mode 100644 index 0000000000000..286e699d5c2f7 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionType.md @@ -0,0 +1,76 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionType + +# Interface: ActionType + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionType + +## Table of contents + +### Properties + +- [enabled](client._internal_namespace.ActionType.md#enabled) +- [enabledInConfig](client._internal_namespace.ActionType.md#enabledinconfig) +- [enabledInLicense](client._internal_namespace.ActionType.md#enabledinlicense) +- [id](client._internal_namespace.ActionType.md#id) +- [minimumLicenseRequired](client._internal_namespace.ActionType.md#minimumlicenserequired) +- [name](client._internal_namespace.ActionType.md#name) + +## Properties + +### enabled + +• **enabled**: `boolean` + +#### Defined in + +x-pack/plugins/actions/target/types/common/types.d.ts:5 + +___ + +### enabledInConfig + +• **enabledInConfig**: `boolean` + +#### Defined in + +x-pack/plugins/actions/target/types/common/types.d.ts:6 + +___ + +### enabledInLicense + +• **enabledInLicense**: `boolean` + +#### Defined in + +x-pack/plugins/actions/target/types/common/types.d.ts:7 + +___ + +### id + +• **id**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/common/types.d.ts:3 + +___ + +### minimumLicenseRequired + +• **minimumLicenseRequired**: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` + +#### Defined in + +x-pack/plugins/actions/target/types/common/types.d.ts:8 + +___ + +### name + +• **name**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/common/types.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeExecutorOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeExecutorOptions.md new file mode 100644 index 0000000000000..9c06e78c9c199 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeExecutorOptions.md @@ -0,0 +1,95 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionTypeExecutorOptions + +# Interface: ActionTypeExecutorOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionTypeExecutorOptions + +## Type parameters + +| Name | +| :------ | +| `Config` | +| `Secrets` | +| `Params` | + +## Table of contents + +### Properties + +- [actionId](client._internal_namespace.ActionTypeExecutorOptions.md#actionid) +- [config](client._internal_namespace.ActionTypeExecutorOptions.md#config) +- [isEphemeral](client._internal_namespace.ActionTypeExecutorOptions.md#isephemeral) +- [params](client._internal_namespace.ActionTypeExecutorOptions.md#params) +- [secrets](client._internal_namespace.ActionTypeExecutorOptions.md#secrets) +- [services](client._internal_namespace.ActionTypeExecutorOptions.md#services) +- [taskInfo](client._internal_namespace.ActionTypeExecutorOptions.md#taskinfo) + +## Properties + +### actionId + +• **actionId**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:40 + +___ + +### config + +• **config**: `Config` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:42 + +___ + +### isEphemeral + +• `Optional` **isEphemeral**: `boolean` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:45 + +___ + +### params + +• **params**: `Params` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:44 + +___ + +### secrets + +• **secrets**: `Secrets` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:43 + +___ + +### services + +• **services**: [`Services`](client._internal_namespace.Services.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:41 + +___ + +### taskInfo + +• `Optional` **taskInfo**: [`TaskInfo`](client._internal_namespace.TaskInfo.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:46 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeExecutorResult.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeExecutorResult.md new file mode 100644 index 0000000000000..039de06431a7c --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeExecutorResult.md @@ -0,0 +1,82 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionTypeExecutorResult + +# Interface: ActionTypeExecutorResult + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionTypeExecutorResult + +## Type parameters + +| Name | +| :------ | +| `Data` | + +## Table of contents + +### Properties + +- [actionId](client._internal_namespace.ActionTypeExecutorResult.md#actionid) +- [data](client._internal_namespace.ActionTypeExecutorResult.md#data) +- [message](client._internal_namespace.ActionTypeExecutorResult.md#message) +- [retry](client._internal_namespace.ActionTypeExecutorResult.md#retry) +- [serviceMessage](client._internal_namespace.ActionTypeExecutorResult.md#servicemessage) +- [status](client._internal_namespace.ActionTypeExecutorResult.md#status) + +## Properties + +### actionId + +• **actionId**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/common/types.d.ts:20 + +___ + +### data + +• `Optional` **data**: `Data` + +#### Defined in + +x-pack/plugins/actions/target/types/common/types.d.ts:24 + +___ + +### message + +• `Optional` **message**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/common/types.d.ts:22 + +___ + +### retry + +• `Optional` **retry**: ``null`` \| `boolean` \| `Date` + +#### Defined in + +x-pack/plugins/actions/target/types/common/types.d.ts:25 + +___ + +### serviceMessage + +• `Optional` **serviceMessage**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/common/types.d.ts:23 + +___ + +### status + +• **status**: ``"error"`` \| ``"ok"`` + +#### Defined in + +x-pack/plugins/actions/target/types/common/types.d.ts:21 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeRegistryOpts.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeRegistryOpts.md new file mode 100644 index 0000000000000..2f83edd5720f0 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionTypeRegistryOpts.md @@ -0,0 +1,76 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionTypeRegistryOpts + +# Interface: ActionTypeRegistryOpts + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionTypeRegistryOpts + +## Table of contents + +### Properties + +- [actionsConfigUtils](client._internal_namespace.ActionTypeRegistryOpts.md#actionsconfigutils) +- [licenseState](client._internal_namespace.ActionTypeRegistryOpts.md#licensestate) +- [licensing](client._internal_namespace.ActionTypeRegistryOpts.md#licensing) +- [preconfiguredActions](client._internal_namespace.ActionTypeRegistryOpts.md#preconfiguredactions) +- [taskManager](client._internal_namespace.ActionTypeRegistryOpts.md#taskmanager) +- [taskRunnerFactory](client._internal_namespace.ActionTypeRegistryOpts.md#taskrunnerfactory) + +## Properties + +### actionsConfigUtils + +• **actionsConfigUtils**: [`ActionsConfigurationUtilities`](client._internal_namespace.ActionsConfigurationUtilities.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:11 + +___ + +### licenseState + +• **licenseState**: [`ILicenseState`](../modules/client._internal_namespace.md#ilicensestate) + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:12 + +___ + +### licensing + +• **licensing**: [`LicensingPluginSetup`](client._internal_namespace.LicensingPluginSetup.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:8 + +___ + +### preconfiguredActions + +• **preconfiguredActions**: [`PreConfiguredAction`](client._internal_namespace.PreConfiguredAction.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig), [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets)\>[] + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:13 + +___ + +### taskManager + +• **taskManager**: [`TaskManagerSetupContract`](client._internal_namespace.TaskManagerSetupContract.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:9 + +___ + +### taskRunnerFactory + +• **taskRunnerFactory**: [`TaskRunnerFactory`](../classes/client._internal_namespace.TaskRunnerFactory.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/action_type_registry.d.ts:10 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionUpdate.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionUpdate.md new file mode 100644 index 0000000000000..1326f4f3b3361 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionUpdate.md @@ -0,0 +1,51 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionUpdate + +# Interface: ActionUpdate + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionUpdate + +## Hierarchy + +- [`SavedObjectAttributes`](client._internal_namespace.SavedObjectAttributes.md) + + ↳ **`ActionUpdate`** + + ↳↳ [`Action`](client._internal_namespace.Action.md) + +## Table of contents + +### Properties + +- [config](client._internal_namespace.ActionUpdate.md#config) +- [name](client._internal_namespace.ActionUpdate.md#name) +- [secrets](client._internal_namespace.ActionUpdate.md#secrets) + +## Properties + +### config + +• **config**: [`SavedObjectAttributes`](client._internal_namespace.SavedObjectAttributes.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:15 + +___ + +### name + +• **name**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:14 + +___ + +### secrets + +• **secrets**: [`SavedObjectAttributes`](client._internal_namespace.SavedObjectAttributes.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:16 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionsConfigurationUtilities.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionsConfigurationUtilities.md new file mode 100644 index 0000000000000..f2562a697f255 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionsConfigurationUtilities.md @@ -0,0 +1,217 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionsConfigurationUtilities + +# Interface: ActionsConfigurationUtilities + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionsConfigurationUtilities + +## Table of contents + +### Methods + +- [ensureActionTypeEnabled](client._internal_namespace.ActionsConfigurationUtilities.md#ensureactiontypeenabled) +- [ensureHostnameAllowed](client._internal_namespace.ActionsConfigurationUtilities.md#ensurehostnameallowed) +- [ensureUriAllowed](client._internal_namespace.ActionsConfigurationUtilities.md#ensureuriallowed) +- [getCustomHostSettings](client._internal_namespace.ActionsConfigurationUtilities.md#getcustomhostsettings) +- [getMicrosoftGraphApiUrl](client._internal_namespace.ActionsConfigurationUtilities.md#getmicrosoftgraphapiurl) +- [getProxySettings](client._internal_namespace.ActionsConfigurationUtilities.md#getproxysettings) +- [getResponseSettings](client._internal_namespace.ActionsConfigurationUtilities.md#getresponsesettings) +- [getSSLSettings](client._internal_namespace.ActionsConfigurationUtilities.md#getsslsettings) +- [isActionTypeEnabled](client._internal_namespace.ActionsConfigurationUtilities.md#isactiontypeenabled) +- [isHostnameAllowed](client._internal_namespace.ActionsConfigurationUtilities.md#ishostnameallowed) +- [isUriAllowed](client._internal_namespace.ActionsConfigurationUtilities.md#isuriallowed) + +## Methods + +### ensureActionTypeEnabled + +▸ **ensureActionTypeEnabled**(`actionType`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `actionType` | `string` | + +#### Returns + +`void` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_config.d.ts:10 + +___ + +### ensureHostnameAllowed + +▸ **ensureHostnameAllowed**(`hostname`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `hostname` | `string` | + +#### Returns + +`void` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_config.d.ts:8 + +___ + +### ensureUriAllowed + +▸ **ensureUriAllowed**(`uri`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `uri` | `string` | + +#### Returns + +`void` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_config.d.ts:9 + +___ + +### getCustomHostSettings + +▸ **getCustomHostSettings**(`targetUrl`): `undefined` \| `Readonly`<{ `smtp?`: `Readonly`<{ `ignoreTLS?`: `boolean` ; `requireTLS?`: `boolean` }\> ; `ssl?`: `Readonly`<{ `certificateAuthoritiesData?`: `string` ; `certificateAuthoritiesFiles?`: `string` \| `string`[] ; `rejectUnauthorized?`: `boolean` ; `verificationMode?`: ``"none"`` \| ``"certificate"`` \| ``"full"`` }\> } & { `url`: `string` }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetUrl` | `string` | + +#### Returns + +`undefined` \| `Readonly`<{ `smtp?`: `Readonly`<{ `ignoreTLS?`: `boolean` ; `requireTLS?`: `boolean` }\> ; `ssl?`: `Readonly`<{ `certificateAuthoritiesData?`: `string` ; `certificateAuthoritiesFiles?`: `string` \| `string`[] ; `rejectUnauthorized?`: `boolean` ; `verificationMode?`: ``"none"`` \| ``"certificate"`` \| ``"full"`` }\> } & { `url`: `string` }\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_config.d.ts:14 + +___ + +### getMicrosoftGraphApiUrl + +▸ **getMicrosoftGraphApiUrl**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_config.d.ts:15 + +___ + +### getProxySettings + +▸ **getProxySettings**(): `undefined` \| [`ProxySettings`](client._internal_namespace.ProxySettings.md) + +#### Returns + +`undefined` \| [`ProxySettings`](client._internal_namespace.ProxySettings.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_config.d.ts:12 + +___ + +### getResponseSettings + +▸ **getResponseSettings**(): [`ResponseSettings`](client._internal_namespace.ResponseSettings.md) + +#### Returns + +[`ResponseSettings`](client._internal_namespace.ResponseSettings.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_config.d.ts:13 + +___ + +### getSSLSettings + +▸ **getSSLSettings**(): [`SSLSettings`](client._internal_namespace.SSLSettings.md) + +#### Returns + +[`SSLSettings`](client._internal_namespace.SSLSettings.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_config.d.ts:11 + +___ + +### isActionTypeEnabled + +▸ **isActionTypeEnabled**(`actionType`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `actionType` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_config.d.ts:7 + +___ + +### isHostnameAllowed + +▸ **isHostnameAllowed**(`hostname`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `hostname` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_config.d.ts:5 + +___ + +### isUriAllowed + +▸ **isUriAllowed**(`uri`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `uri` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_config.d.ts:6 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionsLicenseInformation.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionsLicenseInformation.md new file mode 100644 index 0000000000000..c7ab568b57c35 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ActionsLicenseInformation.md @@ -0,0 +1,43 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ActionsLicenseInformation + +# Interface: ActionsLicenseInformation + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ActionsLicenseInformation + +## Table of contents + +### Properties + +- [enableAppLink](client._internal_namespace.ActionsLicenseInformation.md#enableapplink) +- [message](client._internal_namespace.ActionsLicenseInformation.md#message) +- [showAppLink](client._internal_namespace.ActionsLicenseInformation.md#showapplink) + +## Properties + +### enableAppLink + +• **enableAppLink**: `boolean` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:9 + +___ + +### message + +• **message**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:10 + +___ + +### showAppLink + +• **showAppLink**: `boolean` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:8 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AggregationBuilder.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AggregationBuilder.md new file mode 100644 index 0000000000000..9790711e77193 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AggregationBuilder.md @@ -0,0 +1,68 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AggregationBuilder + +# Interface: AggregationBuilder + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AggregationBuilder + +## Table of contents + +### Methods + +- [build](client._internal_namespace.AggregationBuilder.md#build) +- [formatResponse](client._internal_namespace.AggregationBuilder.md#formatresponse) +- [getName](client._internal_namespace.AggregationBuilder.md#getname) + +## Methods + +### build + +▸ **build**(): `Record`<`string`, `AggregationsAggregationContainer`\> + +#### Returns + +`Record`<`string`, `AggregationsAggregationContainer`\> + +#### Defined in + +[x-pack/plugins/cases/server/client/metrics/types.ts:20](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/metrics/types.ts#L20) + +___ + +### formatResponse + +▸ **formatResponse**(`aggregations`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `aggregations` | [`AggregationResponse`](../modules/client._internal_namespace.md#aggregationresponse) | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `actions` | `undefined` \| { isolateHost?: { isolate: { total: number; }; unisolate: { total: number; }; } \| undefined; } | +| `alerts` | `undefined` \| { count?: number \| undefined; hosts?: { total: number; values: { name: string \| undefined; id: string; count: number; }[]; } \| undefined; users?: { total: number; values: { name: string; count: number; }[]; } \| undefined; } | +| `connectors` | `undefined` \| { `total`: `number` = rt.number } | +| `lifespan` | `undefined` \| { `closeDate`: ``null`` \| `string` ; `creationDate`: `string` = rt.string; `statusInfo`: { openDuration: number; inProgressDuration: number; reopenDates: string[]; } = StatusInfoRt } | + +#### Defined in + +[x-pack/plugins/cases/server/client/metrics/types.ts:21](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/metrics/types.ts#L21) + +___ + +### getName + +▸ **getName**(): `string` + +#### Returns + +`string` + +#### Defined in + +[x-pack/plugins/cases/server/client/metrics/types.ts:22](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/metrics/types.ts#L22) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Alert.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Alert.md new file mode 100644 index 0000000000000..71ae71dd5cfaf --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Alert.md @@ -0,0 +1,43 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Alert + +# Interface: Alert + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Alert + +## Table of contents + +### Properties + +- [\_id](client._internal_namespace.Alert.md#_id) +- [\_index](client._internal_namespace.Alert.md#_index) +- [\_source](client._internal_namespace.Alert.md#_source) + +## Properties + +### \_id + +• **\_id**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/alerts/index.ts:233](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L233) + +___ + +### \_index + +• **\_index**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/alerts/index.ts:234](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L234) + +___ + +### \_source + +• **\_source**: `Record`<`string`, `unknown`\> + +#### Defined in + +[x-pack/plugins/cases/server/services/alerts/index.ts:235](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L235) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertIdIndex.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertIdIndex.md new file mode 100644 index 0000000000000..b9a09536ed21c --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertIdIndex.md @@ -0,0 +1,32 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AlertIdIndex + +# Interface: AlertIdIndex + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AlertIdIndex + +## Table of contents + +### Properties + +- [id](client._internal_namespace.AlertIdIndex.md#id) +- [index](client._internal_namespace.AlertIdIndex.md#index) + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/alerts/index.ts:243](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L243) + +___ + +### index + +• **index**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/alerts/index.ts:244](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L244) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertInfo.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertInfo.md new file mode 100644 index 0000000000000..acf8e3b09b74f --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertInfo.md @@ -0,0 +1,34 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AlertInfo + +# Interface: AlertInfo + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AlertInfo + +This structure holds the alert ID and index from an alert comment + +## Table of contents + +### Properties + +- [id](client._internal_namespace.AlertInfo.md#id) +- [index](client._internal_namespace.AlertInfo.md#index) + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/common/types.ts:15](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/common/types.ts#L15) + +___ + +### index + +• **index**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/common/types.ts:16](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/common/types.ts#L16) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertsResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertsResponse.md new file mode 100644 index 0000000000000..aae855d5d0d4a --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AlertsResponse.md @@ -0,0 +1,21 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AlertsResponse + +# Interface: AlertsResponse + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AlertsResponse + +## Table of contents + +### Properties + +- [docs](client._internal_namespace.AlertsResponse.md#docs) + +## Properties + +### docs + +• **docs**: [`Alert`](client._internal_namespace.Alert.md)[] + +#### Defined in + +[x-pack/plugins/cases/server/services/alerts/index.ts:239](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L239) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AppCategory.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AppCategory.md new file mode 100644 index 0000000000000..7ab9c4c95ff66 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AppCategory.md @@ -0,0 +1,83 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AppCategory + +# Interface: AppCategory + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AppCategory + +A category definition for nav links to know where to sort them in the left hand nav + +## Table of contents + +### Properties + +- [ariaLabel](client._internal_namespace.AppCategory.md#arialabel) +- [euiIconType](client._internal_namespace.AppCategory.md#euiicontype) +- [id](client._internal_namespace.AppCategory.md#id) +- [label](client._internal_namespace.AppCategory.md#label) +- [order](client._internal_namespace.AppCategory.md#order) + +## Properties + +### ariaLabel + +• `Optional` **ariaLabel**: `string` + +If the visual label isn't appropriate for screen readers, +can override it here + +#### Defined in + +src/core/target/types/types/app_category.d.ts:20 + +___ + +### euiIconType + +• `Optional` **euiIconType**: `string` + +Define an icon to be used for the category +If the category is only 1 item, and no icon is defined, will default to the product icon +Defaults to initials if no icon is defined + +#### Defined in + +src/core/target/types/types/app_category.d.ts:32 + +___ + +### id + +• **id**: `string` + +Unique identifier for the categories + +#### Defined in + +src/core/target/types/types/app_category.d.ts:10 + +___ + +### label + +• **label**: `string` + +Label used for category name. +Also used as aria-label if one isn't set. + +#### Defined in + +src/core/target/types/types/app_category.d.ts:15 + +___ + +### order + +• `Optional` **order**: `number` + +The order that categories will be sorted in +Prefer large steps between categories to allow for further editing +(Default categories are in steps of 1000) + +#### Defined in + +src/core/target/types/types/app_category.d.ts:26 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AttachedToCaseArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AttachedToCaseArgs.md new file mode 100644 index 0000000000000..86ea1605c1374 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AttachedToCaseArgs.md @@ -0,0 +1,55 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AttachedToCaseArgs + +# Interface: AttachedToCaseArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AttachedToCaseArgs + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) + + ↳ **`AttachedToCaseArgs`** + + ↳↳ [`CountActionsAttachedToCaseArgs`](client._internal_namespace.CountActionsAttachedToCaseArgs.md) + +## Table of contents + +### Properties + +- [caseId](client._internal_namespace.AttachedToCaseArgs.md#caseid) +- [filter](client._internal_namespace.AttachedToCaseArgs.md#filter) +- [unsecuredSavedObjectsClient](client._internal_namespace.AttachedToCaseArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### caseId + +• **caseId**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:33](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L33) + +___ + +### filter + +• `Optional` **filter**: `KueryNode` + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:34](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L34) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Attributes.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Attributes.md new file mode 100644 index 0000000000000..fd8a32f7afb6b --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Attributes.md @@ -0,0 +1,84 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Attributes + +# Interface: Attributes + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Attributes + +## Table of contents + +### Properties + +- [action](client._internal_namespace.Attributes.md#action) +- [created\_at](client._internal_namespace.Attributes.md#created_at) +- [created\_by](client._internal_namespace.Attributes.md#created_by) +- [owner](client._internal_namespace.Attributes.md#owner) +- [payload](client._internal_namespace.Attributes.md#payload) +- [type](client._internal_namespace.Attributes.md#type) + +## Properties + +### action + +• **action**: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:84](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L84) + +___ + +### created\_at + +• **created\_at**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:85](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L85) + +___ + +### created\_by + +• **created\_by**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `email` | `undefined` \| ``null`` \| `string` | +| `full_name` | `undefined` \| ``null`` \| `string` | +| `username` | `undefined` \| ``null`` \| `string` | + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:86](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L86) + +___ + +### owner + +• **owner**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:87](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L87) + +___ + +### payload + +• **payload**: `Record`<`string`, `unknown`\> + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:89](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L89) + +___ + +### type + +• **type**: ``"description"`` \| ``"tags"`` \| ``"title"`` \| ``"connector"`` \| ``"settings"`` \| ``"status"`` \| ``"comment"`` \| ``"pushed"`` \| ``"create_case"`` \| ``"delete_case"`` + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:88](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L88) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuditEvent.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuditEvent.md new file mode 100644 index 0000000000000..d0bbaabfc416b --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuditEvent.md @@ -0,0 +1,59 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AuditEvent + +# Interface: AuditEvent + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AuditEvent + +Audit event schema using ECS format: https://www.elastic.co/guide/en/ecs/1.12/index.html + +If you add additional fields to the schema ensure you update the Kibana Filebeat module: +https://github.com/elastic/beats/tree/master/filebeat/module/kibana + +## Hierarchy + +- `LogMeta` + + ↳ **`AuditEvent`** + +## Table of contents + +### Properties + +- [kibana](client._internal_namespace.AuditEvent.md#kibana) +- [message](client._internal_namespace.AuditEvent.md#message) + +## Properties + +### kibana + +• `Optional` **kibana**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `add_to_spaces?` | readonly `string`[] | Set of space IDs that a saved object was shared to. | +| `authentication_provider?` | `string` | Name of authentication provider associated with a login event. | +| `authentication_realm?` | `string` | Name of Elasticsearch realm that has authenticated the user. | +| `authentication_type?` | `string` | Type of authentication provider associated with a login event. | +| `delete_from_spaces?` | readonly `string`[] | Set of space IDs that a saved object was removed from. | +| `lookup_realm?` | `string` | Name of Elasticsearch realm where the user details were retrieved from. | +| `saved_object?` | `Object` | Saved object that was created, changed, deleted or accessed as part of this event. | +| `saved_object.id` | `string` | - | +| `saved_object.type` | `string` | - | +| `session_id?` | `string` | The ID of the user session associated with this event. Each login attempt results in a unique session id. | +| `space_id?` | `string` | The ID of the space associated with this event. | + +#### Defined in + +x-pack/plugins/security/target/types/server/audit/audit_events.d.ts:14 + +___ + +### message + +• **message**: `string` + +#### Defined in + +x-pack/plugins/security/target/types/server/audit/audit_events.d.ts:13 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuditLogger.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuditLogger.md new file mode 100644 index 0000000000000..c4caafd67c08d --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuditLogger.md @@ -0,0 +1,52 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AuditLogger + +# Interface: AuditLogger + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AuditLogger + +## Table of contents + +### Methods + +- [log](client._internal_namespace.AuditLogger.md#log) + +## Methods + +### log + +▸ **log**(`event`): `void` + +Logs an [AuditEvent](client._internal_namespace.AuditEvent.md) and automatically adds meta data about the +current user, space and correlation id. + +Guidelines around what events should be logged and how they should be +structured can be found in: `/x-pack/plugins/security/README.md` + +**`example`** +```typescript +const auditLogger = securitySetup.audit.asScoped(request); +auditLogger.log({ + message: 'User is updating dashboard [id=123]', + event: { + action: 'saved_object_update', + outcome: 'unknown' + }, + kibana: { + saved_object: { type: 'dashboard', id: '123' } + }, +}); +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `undefined` \| [`AuditEvent`](client._internal_namespace.AuditEvent.md) | + +#### Returns + +`void` + +#### Defined in + +x-pack/plugins/security/target/types/server/audit/audit_service.d.ts:32 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthFilterHelpers.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthFilterHelpers.md new file mode 100644 index 0000000000000..c4117202317cc --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthFilterHelpers.md @@ -0,0 +1,38 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AuthFilterHelpers + +# Interface: AuthFilterHelpers + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AuthFilterHelpers + +Defines the helper methods and necessary information for authorizing the find API's request. + +## Table of contents + +### Properties + +- [ensureSavedObjectsAreAuthorized](client._internal_namespace.AuthFilterHelpers.md#ensuresavedobjectsareauthorized) +- [filter](client._internal_namespace.AuthFilterHelpers.md#filter) + +## Properties + +### ensureSavedObjectsAreAuthorized + +• **ensureSavedObjectsAreAuthorized**: [`EnsureSOAuthCallback`](../modules/client._internal_namespace.md#ensuresoauthcallback) + +Utility function for checking that the returned entities are in fact authorized for the user making the request + +#### Defined in + +[x-pack/plugins/cases/server/authorization/types.ts:123](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L123) + +___ + +### filter + +• `Optional` **filter**: `KueryNode` + +The owner filter to pass to the saved object client's find operation that is scoped to the authorized owners + +#### Defined in + +[x-pack/plugins/cases/server/authorization/types.ts:119](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L119) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthenticatedUser.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthenticatedUser.md new file mode 100644 index 0000000000000..69dc207747edf --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthenticatedUser.md @@ -0,0 +1,170 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AuthenticatedUser + +# Interface: AuthenticatedUser + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AuthenticatedUser + +Represents the currently authenticated user. + +## Hierarchy + +- [`User`](client._internal_namespace.User.md) + + ↳ **`AuthenticatedUser`** + +## Table of contents + +### Properties + +- [authentication\_provider](client._internal_namespace.AuthenticatedUser.md#authentication_provider) +- [authentication\_realm](client._internal_namespace.AuthenticatedUser.md#authentication_realm) +- [authentication\_type](client._internal_namespace.AuthenticatedUser.md#authentication_type) +- [email](client._internal_namespace.AuthenticatedUser.md#email) +- [enabled](client._internal_namespace.AuthenticatedUser.md#enabled) +- [full\_name](client._internal_namespace.AuthenticatedUser.md#full_name) +- [lookup\_realm](client._internal_namespace.AuthenticatedUser.md#lookup_realm) +- [metadata](client._internal_namespace.AuthenticatedUser.md#metadata) +- [roles](client._internal_namespace.AuthenticatedUser.md#roles) +- [username](client._internal_namespace.AuthenticatedUser.md#username) + +## Properties + +### authentication\_provider + +• **authentication\_provider**: [`AuthenticationProvider`](client._internal_namespace.AuthenticationProvider.md) + +The authentication provider that used to authenticate user. + +#### Defined in + +x-pack/plugins/security/target/types/common/model/authenticated_user.d.ts:22 + +___ + +### authentication\_realm + +• **authentication\_realm**: [`UserRealm`](client._internal_namespace.UserRealm.md) + +The name and type of the Realm that has authenticated the user. + +#### Defined in + +x-pack/plugins/security/target/types/common/model/authenticated_user.d.ts:14 + +___ + +### authentication\_type + +• **authentication\_type**: `string` + +The AuthenticationType used by ES to authenticate the user. + +**`example`** "realm" | "api_key" | "token" | "anonymous" | "internal" + +#### Defined in + +x-pack/plugins/security/target/types/common/model/authenticated_user.d.ts:28 + +___ + +### email + +• `Optional` **email**: `string` + +#### Inherited from + +[User](client._internal_namespace.User.md).[email](client._internal_namespace.User.md#email) + +#### Defined in + +x-pack/plugins/security/target/types/common/model/user.d.ts:3 + +___ + +### enabled + +• **enabled**: `boolean` + +#### Inherited from + +[User](client._internal_namespace.User.md).[enabled](client._internal_namespace.User.md#enabled) + +#### Defined in + +x-pack/plugins/security/target/types/common/model/user.d.ts:6 + +___ + +### full\_name + +• `Optional` **full\_name**: `string` + +#### Inherited from + +[User](client._internal_namespace.User.md).[full_name](client._internal_namespace.User.md#full_name) + +#### Defined in + +x-pack/plugins/security/target/types/common/model/user.d.ts:4 + +___ + +### lookup\_realm + +• **lookup\_realm**: [`UserRealm`](client._internal_namespace.UserRealm.md) + +The name and type of the Realm where the user information were retrieved from. + +#### Defined in + +x-pack/plugins/security/target/types/common/model/authenticated_user.d.ts:18 + +___ + +### metadata + +• `Optional` **metadata**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `_deprecated?` | `boolean` | +| `_deprecated_reason?` | `string` | +| `_reserved` | `boolean` | + +#### Inherited from + +[User](client._internal_namespace.User.md).[metadata](client._internal_namespace.User.md#metadata) + +#### Defined in + +x-pack/plugins/security/target/types/common/model/user.d.ts:7 + +___ + +### roles + +• **roles**: readonly `string`[] + +#### Inherited from + +[User](client._internal_namespace.User.md).[roles](client._internal_namespace.User.md#roles) + +#### Defined in + +x-pack/plugins/security/target/types/common/model/user.d.ts:5 + +___ + +### username + +• **username**: `string` + +#### Inherited from + +[User](client._internal_namespace.User.md).[username](client._internal_namespace.User.md#username) + +#### Defined in + +x-pack/plugins/security/target/types/common/model/user.d.ts:2 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthenticationProvider.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthenticationProvider.md new file mode 100644 index 0000000000000..a10edc042b528 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthenticationProvider.md @@ -0,0 +1,34 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AuthenticationProvider + +# Interface: AuthenticationProvider + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AuthenticationProvider + +Type and name tuple to identify provider used to authenticate user. + +## Table of contents + +### Properties + +- [name](client._internal_namespace.AuthenticationProvider.md#name) +- [type](client._internal_namespace.AuthenticationProvider.md#type) + +## Properties + +### name + +• **name**: `string` + +#### Defined in + +x-pack/plugins/security/target/types/common/model/authentication_provider.d.ts:6 + +___ + +### type + +• **type**: `string` + +#### Defined in + +x-pack/plugins/security/target/types/common/model/authentication_provider.d.ts:5 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthorizationMode-1.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthorizationMode-1.md new file mode 100644 index 0000000000000..ff75cd19e524c --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthorizationMode-1.md @@ -0,0 +1,31 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AuthorizationMode + +# Interface: AuthorizationMode + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AuthorizationMode + +## Table of contents + +### Methods + +- [useRbacForRequest](client._internal_namespace.AuthorizationMode-1.md#userbacforrequest) + +## Methods + +### useRbacForRequest + +▸ **useRbacForRequest**(`request`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | + +#### Returns + +`boolean` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/mode.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthorizationServiceSetup.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthorizationServiceSetup.md new file mode 100644 index 0000000000000..5011fe972f36e --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.AuthorizationServiceSetup.md @@ -0,0 +1,71 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / AuthorizationServiceSetup + +# Interface: AuthorizationServiceSetup + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).AuthorizationServiceSetup + +Authorization services available on the setup contract of the security plugin. + +## Table of contents + +### Properties + +- [actions](client._internal_namespace.AuthorizationServiceSetup.md#actions) +- [checkPrivilegesDynamicallyWithRequest](client._internal_namespace.AuthorizationServiceSetup.md#checkprivilegesdynamicallywithrequest) +- [checkPrivilegesWithRequest](client._internal_namespace.AuthorizationServiceSetup.md#checkprivilegeswithrequest) +- [checkSavedObjectsPrivilegesWithRequest](client._internal_namespace.AuthorizationServiceSetup.md#checksavedobjectsprivilegeswithrequest) +- [mode](client._internal_namespace.AuthorizationServiceSetup.md#mode) + +## Properties + +### actions + +• **actions**: [`Actions`](../classes/client._internal_namespace.Actions.md) + +Actions are used to create the "actions" that are associated with Elasticsearch's +application privileges, and are used to perform the authorization checks implemented +by the various `checkPrivilegesWithRequest` derivatives. + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/authorization_service.d.ts:52 + +___ + +### checkPrivilegesDynamicallyWithRequest + +• **checkPrivilegesDynamicallyWithRequest**: [`CheckPrivilegesDynamicallyWithRequest`](../modules/client._internal_namespace.md#checkprivilegesdynamicallywithrequest) + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/authorization_service.d.ts:54 + +___ + +### checkPrivilegesWithRequest + +• **checkPrivilegesWithRequest**: [`CheckPrivilegesWithRequest`](../modules/client._internal_namespace.md#checkprivilegeswithrequest) + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/authorization_service.d.ts:53 + +___ + +### checkSavedObjectsPrivilegesWithRequest + +• **checkSavedObjectsPrivilegesWithRequest**: [`CheckSavedObjectsPrivilegesWithRequest`](../modules/client._internal_namespace.md#checksavedobjectsprivilegeswithrequest) + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/authorization_service.d.ts:55 + +___ + +### mode + +• **mode**: [`AuthorizationMode`](client._internal_namespace.AuthorizationMode-1.md) + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/authorization_service.d.ts:56 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BeforeSaveContext.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BeforeSaveContext.md new file mode 100644 index 0000000000000..6e52bf637eada --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BeforeSaveContext.md @@ -0,0 +1,21 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / BeforeSaveContext + +# Interface: BeforeSaveContext + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).BeforeSaveContext + +## Table of contents + +### Properties + +- [taskInstance](client._internal_namespace.BeforeSaveContext.md#taskinstance) + +## Properties + +### taskInstance + +• **taskInstance**: [`TaskInstance`](client._internal_namespace.TaskInstance.md) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/lib/middleware.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BuilderParameters.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BuilderParameters.md new file mode 100644 index 0000000000000..c91716f5b2248 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BuilderParameters.md @@ -0,0 +1,205 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / BuilderParameters + +# Interface: BuilderParameters + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).BuilderParameters + +## Table of contents + +### Properties + +- [comment](client._internal_namespace.BuilderParameters.md#comment) +- [connector](client._internal_namespace.BuilderParameters.md#connector) +- [create\_case](client._internal_namespace.BuilderParameters.md#create_case) +- [delete\_case](client._internal_namespace.BuilderParameters.md#delete_case) +- [description](client._internal_namespace.BuilderParameters.md#description) +- [pushed](client._internal_namespace.BuilderParameters.md#pushed) +- [settings](client._internal_namespace.BuilderParameters.md#settings) +- [status](client._internal_namespace.BuilderParameters.md#status) +- [tags](client._internal_namespace.BuilderParameters.md#tags) +- [title](client._internal_namespace.BuilderParameters.md#title) + +## Properties + +### comment + +• **comment**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `parameters` | `Object` | +| `parameters.payload` | `Object` | +| `parameters.payload.attachment` | { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } | + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:44](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L44) + +___ + +### connector + +• **connector**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `parameters` | `Object` | +| `parameters.payload` | `Object` | +| `parameters.payload.connector` | { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } | + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:49](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L49) + +___ + +### create\_case + +• **create\_case**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `parameters` | `Object` | +| `parameters.payload` | `Object` | +| `parameters.payload.connector` | { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } | +| `parameters.payload.description` | `string` | +| `parameters.payload.owner` | `string` | +| `parameters.payload.settings` | { syncAlerts: boolean; } | +| `parameters.payload.tags` | `string`[] | +| `parameters.payload.title` | `string` | + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:56](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L56) + +___ + +### delete\_case + +• **delete\_case**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `parameters` | `Object` | +| `parameters.payload` | `Object` | + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:61](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L61) + +___ + +### description + +• **description**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `parameters` | `Object` | +| `parameters.payload` | `Object` | +| `parameters.payload.description` | `string` | + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:25](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L25) + +___ + +### pushed + +• **pushed**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `parameters` | `Object` | +| `parameters.payload` | `Object` | +| `parameters.payload.externalService` | { `connector_id`: `string` = rt.string } & { `connector_name`: `string` = rt.string; `external_id`: `string` = rt.string; `external_title`: `string` = rt.string; `external_url`: `string` = rt.string; `pushed_at`: `string` = rt.string; `pushed_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT } | + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:34](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L34) + +___ + +### settings + +• **settings**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `parameters` | `Object` | +| `parameters.payload` | `Object` | +| `parameters.payload.settings` | `Object` | +| `parameters.payload.settings.syncAlerts` | `boolean` | + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:41](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L41) + +___ + +### status + +• **status**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `parameters` | `Object` | +| `parameters.payload` | `Object` | +| `parameters.payload.status` | [`CaseStatuses`](../enums/client._internal_namespace.CaseStatuses.md) | + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:28](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L28) + +___ + +### tags + +• **tags**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `parameters` | `Object` | +| `parameters.payload` | `Object` | +| `parameters.payload.tags` | `string`[] | + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:31](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L31) + +___ + +### title + +• **title**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `parameters` | `Object` | +| `parameters.payload` | `Object` | +| `parameters.payload.title` | `string` | + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:22](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L22) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BuilderReturnValue.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BuilderReturnValue.md new file mode 100644 index 0000000000000..ab7e6bdade21e --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BuilderReturnValue.md @@ -0,0 +1,32 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / BuilderReturnValue + +# Interface: BuilderReturnValue + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).BuilderReturnValue + +## Table of contents + +### Properties + +- [attributes](client._internal_namespace.BuilderReturnValue.md#attributes) +- [references](client._internal_namespace.BuilderReturnValue.md#references) + +## Properties + +### attributes + +• **attributes**: [`Attributes`](client._internal_namespace.Attributes.md) + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:93](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L93) + +___ + +### references + +• **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:94](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L94) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md new file mode 100644 index 0000000000000..ac16ce838e615 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md @@ -0,0 +1,125 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / BulkCreateAttachmentDeletionUserAction + +# Interface: BulkCreateAttachmentDeletionUserAction + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).BulkCreateAttachmentDeletionUserAction + +## Hierarchy + +- `Omit`<[`CommonUserActionArgs`](../modules/client._internal_namespace.md#commonuseractionargs), ``"owner"``\> + + ↳ **`BulkCreateAttachmentDeletionUserAction`** + +## Table of contents + +### Properties + +- [action](client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md#action) +- [attachmentId](client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md#attachmentid) +- [attachments](client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md#attachments) +- [caseId](client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md#caseid) +- [connectorId](client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md#connectorid) +- [unsecuredSavedObjectsClient](client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md#unsecuredsavedobjectsclient) +- [user](client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md#user) + +## Properties + +### action + +• `Optional` **action**: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` + +#### Inherited from + +Omit.action + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:80](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L80) + +___ + +### attachmentId + +• `Optional` **attachmentId**: `string` + +#### Inherited from + +Omit.attachmentId + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:78](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L78) + +___ + +### attachments + +• **attachments**: { `attachment`: { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } ; `id`: `string` ; `owner`: `string` }[] + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:95](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L95) + +___ + +### caseId + +• **caseId**: `string` + +#### Inherited from + +Omit.caseId + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:76](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L76) + +___ + +### connectorId + +• `Optional` **connectorId**: `string` + +#### Inherited from + +Omit.connectorId + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:79](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L79) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +Omit.unsecuredSavedObjectsClient + +#### Defined in + +[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) + +___ + +### user + +• **user**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `email` | `undefined` \| ``null`` \| `string` | +| `full_name` | `undefined` \| ``null`` \| `string` | +| `username` | `undefined` \| ``null`` \| `string` | + +#### Inherited from + +Omit.user + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:75](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L75) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md new file mode 100644 index 0000000000000..5acc559d72638 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md @@ -0,0 +1,72 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / BulkCreateBulkUpdateCaseUserActions + +# Interface: BulkCreateBulkUpdateCaseUserActions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).BulkCreateBulkUpdateCaseUserActions + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) + + ↳ **`BulkCreateBulkUpdateCaseUserActions`** + +## Table of contents + +### Properties + +- [originalCases](client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md#originalcases) +- [unsecuredSavedObjectsClient](client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md#unsecuredsavedobjectsclient) +- [updatedCases](client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md#updatedcases) +- [user](client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md#user) + +## Properties + +### originalCases + +• **originalCases**: [`SavedObject`](client._internal_namespace.SavedObject.md)<{ `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>[] + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:89](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L89) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) + +___ + +### updatedCases + +• **updatedCases**: [`SavedObjectsUpdateResponse`](client._internal_namespace.SavedObjectsUpdateResponse.md)<{ `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\>[] + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:90](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L90) + +___ + +### user + +• **user**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `email` | `undefined` \| ``null`` \| `string` | +| `full_name` | `undefined` \| ``null`` \| `string` | +| `username` | `undefined` \| ``null`` \| `string` | + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:91](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L91) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateCaseDeletionUserAction.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateCaseDeletionUserAction.md new file mode 100644 index 0000000000000..d925395547e55 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkCreateCaseDeletionUserAction.md @@ -0,0 +1,61 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / BulkCreateCaseDeletionUserAction + +# Interface: BulkCreateCaseDeletionUserAction + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).BulkCreateCaseDeletionUserAction + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) + + ↳ **`BulkCreateCaseDeletionUserAction`** + +## Table of contents + +### Properties + +- [cases](client._internal_namespace.BulkCreateCaseDeletionUserAction.md#cases) +- [unsecuredSavedObjectsClient](client._internal_namespace.BulkCreateCaseDeletionUserAction.md#unsecuredsavedobjectsclient) +- [user](client._internal_namespace.BulkCreateCaseDeletionUserAction.md#user) + +## Properties + +### cases + +• **cases**: { `connectorId`: `string` ; `id`: `string` ; `owner`: `string` }[] + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:78](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L78) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) + +___ + +### user + +• **user**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `email` | `undefined` \| ``null`` \| `string` | +| `full_name` | `undefined` \| ``null`` \| `string` | +| `username` | `undefined` \| ``null`` \| `string` | + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:79](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L79) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkUpdateAttachmentArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkUpdateAttachmentArgs.md new file mode 100644 index 0000000000000..ecaf5f4b535f7 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.BulkUpdateAttachmentArgs.md @@ -0,0 +1,42 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / BulkUpdateAttachmentArgs + +# Interface: BulkUpdateAttachmentArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).BulkUpdateAttachmentArgs + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) + + ↳ **`BulkUpdateAttachmentArgs`** + +## Table of contents + +### Properties + +- [comments](client._internal_namespace.BulkUpdateAttachmentArgs.md#comments) +- [unsecuredSavedObjectsClient](client._internal_namespace.BulkUpdateAttachmentArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### comments + +• **comments**: [`UpdateArgs`](client._internal_namespace.UpdateArgs.md)[] + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:62](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L62) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CancellableTask.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CancellableTask.md new file mode 100644 index 0000000000000..f7a6457695400 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CancellableTask.md @@ -0,0 +1,32 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CancellableTask + +# Interface: CancellableTask + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CancellableTask + +## Table of contents + +### Properties + +- [cancel](client._internal_namespace.CancellableTask.md#cancel) +- [run](client._internal_namespace.CancellableTask.md#run) + +## Properties + +### cancel + +• `Optional` **cancel**: [`CancelFunction`](../modules/client._internal_namespace.md#cancelfunction) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:68 + +___ + +### run + +• **run**: [`RunFunction`](../modules/client._internal_namespace.md#runfunction) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:67 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Capabilities.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Capabilities.md new file mode 100644 index 0000000000000..b9cddb8df9faf --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Capabilities.md @@ -0,0 +1,63 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Capabilities + +# Interface: Capabilities + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Capabilities + +The read-only set of capabilities available for the current UI session. +Capabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID, +and the boolean is a flag indicating if the capability is enabled or disabled. + +## Indexable + +▪ [key: `string`]: `Record`<`string`, `boolean` \| `Record`<`string`, `boolean`\>\> + +Custom capabilities, registered by plugins. + +## Table of contents + +### Properties + +- [catalogue](client._internal_namespace.Capabilities.md#catalogue) +- [management](client._internal_namespace.Capabilities.md#management) +- [navLinks](client._internal_namespace.Capabilities.md#navlinks) + +## Properties + +### catalogue + +• **catalogue**: `Record`<`string`, `boolean`\> + +Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options. + +#### Defined in + +src/core/target/types/types/capabilities.d.ts:16 + +___ + +### management + +• **management**: `Object` + +Management section capabilities. + +#### Index signature + +▪ [sectionId: `string`]: `Record`<`string`, `boolean`\> + +#### Defined in + +src/core/target/types/types/capabilities.d.ts:12 + +___ + +### navLinks + +• **navLinks**: `Record`<`string`, `boolean`\> + +Navigation link capabilities. + +#### Defined in + +src/core/target/types/types/capabilities.d.ts:10 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CaseCommentStats.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CaseCommentStats.md new file mode 100644 index 0000000000000..e4596ea3eacc1 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CaseCommentStats.md @@ -0,0 +1,32 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CaseCommentStats + +# Interface: CaseCommentStats + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CaseCommentStats + +## Table of contents + +### Properties + +- [alertTotals](client._internal_namespace.CaseCommentStats.md#alerttotals) +- [commentTotals](client._internal_namespace.CaseCommentStats.md#commenttotals) + +## Properties + +### alertTotals + +• **alertTotals**: `Map`<`string`, `number`\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:115](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L115) + +___ + +### commentTotals + +• **commentTotals**: `Map`<`string`, `number`\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:114](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L114) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CasesClientArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CasesClientArgs.md new file mode 100644 index 0000000000000..9ec38679b26d0 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CasesClientArgs.md @@ -0,0 +1,160 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CasesClientArgs + +# Interface: CasesClientArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CasesClientArgs + +Parameters for initializing a cases client + +## Table of contents + +### Properties + +- [actionsClient](client._internal_namespace.CasesClientArgs.md#actionsclient) +- [alertsService](client._internal_namespace.CasesClientArgs.md#alertsservice) +- [attachmentService](client._internal_namespace.CasesClientArgs.md#attachmentservice) +- [authorization](client._internal_namespace.CasesClientArgs.md#authorization) +- [caseConfigureService](client._internal_namespace.CasesClientArgs.md#caseconfigureservice) +- [caseService](client._internal_namespace.CasesClientArgs.md#caseservice) +- [connectorMappingsService](client._internal_namespace.CasesClientArgs.md#connectormappingsservice) +- [lensEmbeddableFactory](client._internal_namespace.CasesClientArgs.md#lensembeddablefactory) +- [logger](client._internal_namespace.CasesClientArgs.md#logger) +- [unsecuredSavedObjectsClient](client._internal_namespace.CasesClientArgs.md#unsecuredsavedobjectsclient) +- [user](client._internal_namespace.CasesClientArgs.md#user) +- [userActionService](client._internal_namespace.CasesClientArgs.md#useractionservice) + +## Properties + +### actionsClient + +• `Readonly` **actionsClient**: `PublicMethodsOf`<[`ActionsClient`](../modules/client._internal_namespace.md#actionsclient)\> + +#### Defined in + +[x-pack/plugins/cases/server/client/types.ts:38](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L38) + +___ + +### alertsService + +• `Readonly` **alertsService**: [`AlertService`](../classes/client._internal_namespace.AlertService.md) + +#### Defined in + +[x-pack/plugins/cases/server/client/types.ts:33](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L33) + +___ + +### attachmentService + +• `Readonly` **attachmentService**: [`AttachmentService`](../classes/client._internal_namespace.AttachmentService.md) + +#### Defined in + +[x-pack/plugins/cases/server/client/types.ts:34](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L34) + +___ + +### authorization + +• `Readonly` **authorization**: `PublicMethodsOf`<[`Authorization`](../classes/client._internal_namespace.Authorization.md)\> + +#### Defined in + +[x-pack/plugins/cases/server/client/types.ts:37](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L37) + +___ + +### caseConfigureService + +• `Readonly` **caseConfigureService**: [`CaseConfigureService`](../classes/client._internal_namespace.CaseConfigureService.md) + +#### Defined in + +[x-pack/plugins/cases/server/client/types.ts:27](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L27) + +___ + +### caseService + +• `Readonly` **caseService**: [`CasesService`](../classes/client._internal_namespace.CasesService.md) + +#### Defined in + +[x-pack/plugins/cases/server/client/types.ts:28](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L28) + +___ + +### connectorMappingsService + +• `Readonly` **connectorMappingsService**: [`ConnectorMappingsService`](../classes/client._internal_namespace.ConnectorMappingsService.md) + +#### Defined in + +[x-pack/plugins/cases/server/client/types.ts:29](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L29) + +___ + +### lensEmbeddableFactory + +• `Readonly` **lensEmbeddableFactory**: () => [`EmbeddableRegistryDefinition`](client._internal_namespace.EmbeddableRegistryDefinition.md)<[`EmbeddableStateWithType`](../modules/client._internal_namespace.md#embeddablestatewithtype)\> + +#### Type declaration + +▸ (): [`EmbeddableRegistryDefinition`](client._internal_namespace.EmbeddableRegistryDefinition.md)<[`EmbeddableStateWithType`](../modules/client._internal_namespace.md#embeddablestatewithtype)\> + +##### Returns + +[`EmbeddableRegistryDefinition`](client._internal_namespace.EmbeddableRegistryDefinition.md)<[`EmbeddableStateWithType`](../modules/client._internal_namespace.md#embeddablestatewithtype)\> + +#### Defined in + +[x-pack/plugins/cases/server/client/types.ts:36](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L36) + +___ + +### logger + +• `Readonly` **logger**: `Logger` + +#### Defined in + +[x-pack/plugins/cases/server/client/types.ts:35](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L35) + +___ + +### unsecuredSavedObjectsClient + +• `Readonly` **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Defined in + +[x-pack/plugins/cases/server/client/types.ts:31](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L31) + +___ + +### user + +• `Readonly` **user**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `email` | `undefined` \| ``null`` \| `string` | +| `full_name` | `undefined` \| ``null`` \| `string` | +| `username` | `undefined` \| ``null`` \| `string` | + +#### Defined in + +[x-pack/plugins/cases/server/client/types.ts:30](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L30) + +___ + +### userActionService + +• `Readonly` **userActionService**: [`CaseUserActionService`](../classes/client._internal_namespace.CaseUserActionService.md) + +#### Defined in + +[x-pack/plugins/cases/server/client/types.ts:32](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/types.ts#L32) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CasesMapWithPageInfo.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CasesMapWithPageInfo.md new file mode 100644 index 0000000000000..a39f560b084af --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CasesMapWithPageInfo.md @@ -0,0 +1,54 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CasesMapWithPageInfo + +# Interface: CasesMapWithPageInfo + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CasesMapWithPageInfo + +## Table of contents + +### Properties + +- [casesMap](client._internal_namespace.CasesMapWithPageInfo.md#casesmap) +- [page](client._internal_namespace.CasesMapWithPageInfo.md#page) +- [perPage](client._internal_namespace.CasesMapWithPageInfo.md#perpage) +- [total](client._internal_namespace.CasesMapWithPageInfo.md#total) + +## Properties + +### casesMap + +• **casesMap**: `Map`<`string`, { `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `totalAlerts`: `number` = rt.number; `totalComment`: `number` = rt.number; `version`: `string` = rt.string } & { `comments`: `undefined` \| { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string }[] }\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:119](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L119) + +___ + +### page + +• **page**: `number` + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:120](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L120) + +___ + +### perPage + +• **perPage**: `number` + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:121](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L121) + +___ + +### total + +• **total**: `number` + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:122](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L122) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivileges.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivileges.md new file mode 100644 index 0000000000000..6cf7583198177 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivileges.md @@ -0,0 +1,78 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CheckPrivileges + +# Interface: CheckPrivileges + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CheckPrivileges + +## Table of contents + +### Methods + +- [atSpace](client._internal_namespace.CheckPrivileges.md#atspace) +- [atSpaces](client._internal_namespace.CheckPrivileges.md#atspaces) +- [globally](client._internal_namespace.CheckPrivileges.md#globally) + +## Methods + +### atSpace + +▸ **atSpace**(`spaceId`, `privileges`, `options?`): `Promise`<[`CheckPrivilegesResponse`](client._internal_namespace.CheckPrivilegesResponse.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `spaceId` | `string` | +| `privileges` | [`CheckPrivilegesPayload`](client._internal_namespace.CheckPrivilegesPayload.md) | +| `options?` | [`CheckPrivilegesOptions`](client._internal_namespace.CheckPrivilegesOptions.md) | + +#### Returns + +`Promise`<[`CheckPrivilegesResponse`](client._internal_namespace.CheckPrivilegesResponse.md)\> + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/types.d.ts:61 + +___ + +### atSpaces + +▸ **atSpaces**(`spaceIds`, `privileges`, `options?`): `Promise`<[`CheckPrivilegesResponse`](client._internal_namespace.CheckPrivilegesResponse.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `spaceIds` | `string`[] | +| `privileges` | [`CheckPrivilegesPayload`](client._internal_namespace.CheckPrivilegesPayload.md) | +| `options?` | [`CheckPrivilegesOptions`](client._internal_namespace.CheckPrivilegesOptions.md) | + +#### Returns + +`Promise`<[`CheckPrivilegesResponse`](client._internal_namespace.CheckPrivilegesResponse.md)\> + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/types.d.ts:62 + +___ + +### globally + +▸ **globally**(`privileges`, `options?`): `Promise`<[`CheckPrivilegesResponse`](client._internal_namespace.CheckPrivilegesResponse.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `privileges` | [`CheckPrivilegesPayload`](client._internal_namespace.CheckPrivilegesPayload.md) | +| `options?` | [`CheckPrivilegesOptions`](client._internal_namespace.CheckPrivilegesOptions.md) | + +#### Returns + +`Promise`<[`CheckPrivilegesResponse`](client._internal_namespace.CheckPrivilegesResponse.md)\> + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/types.d.ts:63 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesOptions.md new file mode 100644 index 0000000000000..85caefaa3b490 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesOptions.md @@ -0,0 +1,27 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CheckPrivilegesOptions + +# Interface: CheckPrivilegesOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CheckPrivilegesOptions + +Options to influce the privilege checks. + +## Table of contents + +### Properties + +- [requireLoginAction](client._internal_namespace.CheckPrivilegesOptions.md#requireloginaction) + +## Properties + +### requireLoginAction + +• `Optional` **requireLoginAction**: `boolean` + +Whether or not the `login` action should be required (default: true). +Setting this to false is not advised except for special circumstances, when you do not require +the request to belong to a user capable of logging into Kibana. + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/types.d.ts:31 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesPayload.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesPayload.md new file mode 100644 index 0000000000000..29242fb43dbab --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesPayload.md @@ -0,0 +1,39 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CheckPrivilegesPayload + +# Interface: CheckPrivilegesPayload + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CheckPrivilegesPayload + +## Table of contents + +### Properties + +- [elasticsearch](client._internal_namespace.CheckPrivilegesPayload.md#elasticsearch) +- [kibana](client._internal_namespace.CheckPrivilegesPayload.md#kibana) + +## Properties + +### elasticsearch + +• `Optional` **elasticsearch**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `cluster` | `string`[] | +| `index` | `Record`<`string`, `string`[]\> | + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/types.d.ts:67 + +___ + +### kibana + +• `Optional` **kibana**: `string` \| `string`[] + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/types.d.ts:66 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesResponse.md new file mode 100644 index 0000000000000..8e4ce4ae9c815 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CheckPrivilegesResponse.md @@ -0,0 +1,52 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CheckPrivilegesResponse + +# Interface: CheckPrivilegesResponse + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CheckPrivilegesResponse + +## Table of contents + +### Properties + +- [hasAllRequested](client._internal_namespace.CheckPrivilegesResponse.md#hasallrequested) +- [privileges](client._internal_namespace.CheckPrivilegesResponse.md#privileges) +- [username](client._internal_namespace.CheckPrivilegesResponse.md#username) + +## Properties + +### hasAllRequested + +• **hasAllRequested**: `boolean` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/types.d.ts:34 + +___ + +### privileges + +• **privileges**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `elasticsearch` | `Object` | +| `elasticsearch.cluster` | { `authorized`: `boolean` ; `privilege`: `string` }[] | +| `elasticsearch.index` | `Object` | +| `kibana` | { `authorized`: `boolean` ; `privilege`: `string` ; `resource?`: `string` }[] | + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/types.d.ts:36 + +___ + +### username + +• **username**: `string` + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/types.d.ts:35 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs-1.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs-1.md new file mode 100644 index 0000000000000..ded25fa2ce105 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs-1.md @@ -0,0 +1,55 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ClientArgs + +# Interface: ClientArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ClientArgs + +## Hierarchy + +- **`ClientArgs`** + + ↳ [`GetCaseIdsByAlertIdArgs`](client._internal_namespace.GetCaseIdsByAlertIdArgs.md) + + ↳ [`GetCaseArgs`](client._internal_namespace.GetCaseArgs.md) + + ↳ [`GetCasesArgs`](client._internal_namespace.GetCasesArgs.md) + + ↳ [`FindCasesArgs`](client._internal_namespace.FindCasesArgs.md) + + ↳ [`PostCaseArgs`](client._internal_namespace.PostCaseArgs.md) + + ↳ [`PatchCasesArgs`](client._internal_namespace.PatchCasesArgs.md) + + ↳ [`BulkCreateCaseDeletionUserAction`](client._internal_namespace.BulkCreateCaseDeletionUserAction.md) + + ↳ [`BulkCreateBulkUpdateCaseUserActions`](client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md) + + ↳ [`GetCaseUserActionArgs`](client._internal_namespace.GetCaseUserActionArgs.md) + + ↳ [`CreateUserActionES`](client._internal_namespace.CreateUserActionES.md) + + ↳ [`PostCaseUserActionArgs`](client._internal_namespace.PostCaseUserActionArgs.md) + + ↳ [`AttachedToCaseArgs`](client._internal_namespace.AttachedToCaseArgs.md) + + ↳ [`GetAttachmentArgs`](client._internal_namespace.GetAttachmentArgs.md) + + ↳ [`CreateAttachmentArgs`](client._internal_namespace.CreateAttachmentArgs.md) + + ↳ [`BulkUpdateAttachmentArgs`](client._internal_namespace.BulkUpdateAttachmentArgs.md) + +## Table of contents + +### Properties + +- [unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) + +## Properties + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Defined in + +[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs-2.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs-2.md new file mode 100644 index 0000000000000..78bc19f876c89 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs-2.md @@ -0,0 +1,31 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ClientArgs + +# Interface: ClientArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ClientArgs + +## Hierarchy + +- **`ClientArgs`** + + ↳ [`FindConnectorMappingsArgs`](client._internal_namespace.FindConnectorMappingsArgs.md) + + ↳ [`PostConnectorMappingsArgs`](client._internal_namespace.PostConnectorMappingsArgs.md) + + ↳ [`UpdateConnectorMappingsArgs`](client._internal_namespace.UpdateConnectorMappingsArgs.md) + +## Table of contents + +### Properties + +- [unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-2.md#unsecuredsavedobjectsclient) + +## Properties + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Defined in + +[x-pack/plugins/cases/server/services/connector_mappings/index.ts:15](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L15) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs.md new file mode 100644 index 0000000000000..9e5709a8b99ba --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ClientArgs.md @@ -0,0 +1,33 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ClientArgs + +# Interface: ClientArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ClientArgs + +## Hierarchy + +- **`ClientArgs`** + + ↳ [`GetCaseConfigureArgs`](client._internal_namespace.GetCaseConfigureArgs.md) + + ↳ [`FindCaseConfigureArgs`](client._internal_namespace.FindCaseConfigureArgs.md) + + ↳ [`PostCaseConfigureArgs`](client._internal_namespace.PostCaseConfigureArgs.md) + + ↳ [`PatchCaseConfigureArgs`](client._internal_namespace.PatchCaseConfigureArgs.md) + +## Table of contents + +### Properties + +- [unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Defined in + +[x-pack/plugins/cases/server/services/configure/index.ts:30](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L30) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CommonArguments.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CommonArguments.md new file mode 100644 index 0000000000000..ed1bb0d81f42a --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CommonArguments.md @@ -0,0 +1,84 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CommonArguments + +# Interface: CommonArguments + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CommonArguments + +## Table of contents + +### Properties + +- [action](client._internal_namespace.CommonArguments.md#action) +- [attachmentId](client._internal_namespace.CommonArguments.md#attachmentid) +- [caseId](client._internal_namespace.CommonArguments.md#caseid) +- [connectorId](client._internal_namespace.CommonArguments.md#connectorid) +- [owner](client._internal_namespace.CommonArguments.md#owner) +- [user](client._internal_namespace.CommonArguments.md#user) + +## Properties + +### action + +• `Optional` **action**: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:80](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L80) + +___ + +### attachmentId + +• `Optional` **attachmentId**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:78](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L78) + +___ + +### caseId + +• **caseId**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:76](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L76) + +___ + +### connectorId + +• `Optional` **connectorId**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:79](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L79) + +___ + +### owner + +• **owner**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:77](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L77) + +___ + +### user + +• **user**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `email` | `undefined` \| ``null`` \| `string` | +| `full_name` | `undefined` \| ``null`` \| `string` | +| `username` | `undefined` \| ``null`` \| `string` | + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:75](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L75) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConcreteTaskInstance.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConcreteTaskInstance.md new file mode 100644 index 0000000000000..db3d362c3dbc3 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConcreteTaskInstance.md @@ -0,0 +1,291 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ConcreteTaskInstance + +# Interface: ConcreteTaskInstance + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ConcreteTaskInstance + +A task instance that has an id and is ready for storage. + +## Hierarchy + +- [`TaskInstance`](client._internal_namespace.TaskInstance.md) + + ↳ **`ConcreteTaskInstance`** + +## Table of contents + +### Properties + +- [attempts](client._internal_namespace.ConcreteTaskInstance.md#attempts) +- [id](client._internal_namespace.ConcreteTaskInstance.md#id) +- [ownerId](client._internal_namespace.ConcreteTaskInstance.md#ownerid) +- [params](client._internal_namespace.ConcreteTaskInstance.md#params) +- [retryAt](client._internal_namespace.ConcreteTaskInstance.md#retryat) +- [runAt](client._internal_namespace.ConcreteTaskInstance.md#runat) +- [schedule](client._internal_namespace.ConcreteTaskInstance.md#schedule) +- [scheduledAt](client._internal_namespace.ConcreteTaskInstance.md#scheduledat) +- [scope](client._internal_namespace.ConcreteTaskInstance.md#scope) +- [startedAt](client._internal_namespace.ConcreteTaskInstance.md#startedat) +- [state](client._internal_namespace.ConcreteTaskInstance.md#state) +- [status](client._internal_namespace.ConcreteTaskInstance.md#status) +- [taskType](client._internal_namespace.ConcreteTaskInstance.md#tasktype) +- [traceparent](client._internal_namespace.ConcreteTaskInstance.md#traceparent) +- [user](client._internal_namespace.ConcreteTaskInstance.md#user) +- [version](client._internal_namespace.ConcreteTaskInstance.md#version) + +## Properties + +### attempts + +• **attempts**: `number` + +The number of unsuccessful attempts since the last successful run. This +will be zeroed out after a successful run. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:244 + +___ + +### id + +• **id**: `string` + +The id of the Elastic document that stores this instance's data. This can +be passed by the caller when scheduling the task. + +#### Overrides + +[TaskInstance](client._internal_namespace.TaskInstance.md).[id](client._internal_namespace.TaskInstance.md#id) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:230 + +___ + +### ownerId + +• **ownerId**: ``null`` \| `string` + +The random uuid of the Kibana instance which claimed ownership of the task last + +#### Overrides + +[TaskInstance](client._internal_namespace.TaskInstance.md).[ownerId](client._internal_namespace.TaskInstance.md#ownerid) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:274 + +___ + +### params + +• **params**: `Record`<`string`, `any`\> + +A task-specific set of parameters, used by the task's run function to tailor +its work. This is generally user-input, such as { sms: '333-444-2222' }. + +#### Inherited from + +[TaskInstance](client._internal_namespace.TaskInstance.md).[params](client._internal_namespace.TaskInstance.md#params) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:182 + +___ + +### retryAt + +• **retryAt**: ``null`` \| `Date` + +The date and time that this task should re-execute if stuck in "running" / timeout +status. This value is only set when status is set to "running". + +#### Overrides + +[TaskInstance](client._internal_namespace.TaskInstance.md).[retryAt](client._internal_namespace.TaskInstance.md#retryat) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:264 + +___ + +### runAt + +• **runAt**: `Date` + +The date and time that this task is scheduled to be run. It is not guaranteed +to run at this time, but it is guaranteed not to run earlier than this. + +#### Overrides + +[TaskInstance](client._internal_namespace.TaskInstance.md).[runAt](client._internal_namespace.TaskInstance.md#runat) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:253 + +___ + +### schedule + +• `Optional` **schedule**: [`IntervalSchedule`](client._internal_namespace.IntervalSchedule.md) + +A TaskSchedule string, which specifies this as a recurring task. + +Currently, this supports a single format: an interval in minutes or seconds (e.g. '5m', '30s'). + +#### Inherited from + +[TaskInstance](client._internal_namespace.TaskInstance.md).[schedule](client._internal_namespace.TaskInstance.md#schedule) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:177 + +___ + +### scheduledAt + +• **scheduledAt**: `Date` + +The date and time that this task was originally scheduled. This is used +for convenience to task run functions, and for troubleshooting. + +#### Overrides + +[TaskInstance](client._internal_namespace.TaskInstance.md).[scheduledAt](client._internal_namespace.TaskInstance.md#scheduledat) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:239 + +___ + +### scope + +• `Optional` **scope**: `string`[] + +Used to group tasks for querying. So, reporting might schedule tasks with a scope of 'reporting', +and then query such tasks to provide a glimpse at only reporting tasks, rather than at all tasks. + +#### Inherited from + +[TaskInstance](client._internal_namespace.TaskInstance.md).[scope](client._internal_namespace.TaskInstance.md#scope) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:201 + +___ + +### startedAt + +• **startedAt**: ``null`` \| `Date` + +The date and time that this task started execution. This is used to determine +the "real" runAt that ended up running the task. This value is only set +when status is set to "running". + +#### Overrides + +[TaskInstance](client._internal_namespace.TaskInstance.md).[startedAt](client._internal_namespace.TaskInstance.md#startedat) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:259 + +___ + +### state + +• **state**: `Record`<`string`, `any`\> + +The state passed into the task's run function, and returned by the previous +run. If there was no previous run, or if the previous run did not return +any state, this will be the empy object: {} + +#### Overrides + +[TaskInstance](client._internal_namespace.TaskInstance.md).[state](client._internal_namespace.TaskInstance.md#state) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:270 + +___ + +### status + +• **status**: [`TaskStatus`](../enums/client._internal_namespace.TaskStatus.md) + +Indicates whether or not the task is currently running. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:248 + +___ + +### taskType + +• **taskType**: `string` + +The task definition type whose run function will execute this instance. + +#### Inherited from + +[TaskInstance](client._internal_namespace.TaskInstance.md).[taskType](client._internal_namespace.TaskInstance.md#tasktype) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:149 + +___ + +### traceparent + +• `Optional` **traceparent**: `string` + +The serialized traceparent string of the current APM transaction or span. + +#### Inherited from + +[TaskInstance](client._internal_namespace.TaskInstance.md).[traceparent](client._internal_namespace.TaskInstance.md#traceparent) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:192 + +___ + +### user + +• `Optional` **user**: `string` + +The id of the user who scheduled this task. + +#### Inherited from + +[TaskInstance](client._internal_namespace.TaskInstance.md).[user](client._internal_namespace.TaskInstance.md#user) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:196 + +___ + +### version + +• `Optional` **version**: `string` + +The saved object version from the Elaticsearch document. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:234 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConnectorToken.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConnectorToken.md new file mode 100644 index 0000000000000..c60e9bca79a7f --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConnectorToken.md @@ -0,0 +1,82 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ConnectorToken + +# Interface: ConnectorToken + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ConnectorToken + +## Hierarchy + +- [`SavedObjectAttributes`](client._internal_namespace.SavedObjectAttributes.md) + + ↳ **`ConnectorToken`** + +## Table of contents + +### Properties + +- [connectorId](client._internal_namespace.ConnectorToken.md#connectorid) +- [createdAt](client._internal_namespace.ConnectorToken.md#createdat) +- [expiresAt](client._internal_namespace.ConnectorToken.md#expiresat) +- [token](client._internal_namespace.ConnectorToken.md#token) +- [tokenType](client._internal_namespace.ConnectorToken.md#tokentype) +- [updatedAt](client._internal_namespace.ConnectorToken.md#updatedat) + +## Properties + +### connectorId + +• **connectorId**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:123 + +___ + +### createdAt + +• **createdAt**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:127 + +___ + +### expiresAt + +• **expiresAt**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:126 + +___ + +### token + +• **token**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:125 + +___ + +### tokenType + +• **tokenType**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:124 + +___ + +### updatedAt + +• `Optional` **updatedAt**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:128 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions-1.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions-1.md new file mode 100644 index 0000000000000..1f7901ac983f1 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions-1.md @@ -0,0 +1,60 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ConstructorOptions + +# Interface: ConstructorOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ConstructorOptions + +## Table of contents + +### Properties + +- [authentication](client._internal_namespace.ConstructorOptions-1.md#authentication) +- [authorization](client._internal_namespace.ConstructorOptions-1.md#authorization) +- [authorizationMode](client._internal_namespace.ConstructorOptions-1.md#authorizationmode) +- [request](client._internal_namespace.ConstructorOptions-1.md#request) + +## Properties + +### authentication + +• `Optional` **authentication**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `getCurrentUser` | (`request`: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\>) => ``null`` \| [`AuthenticatedUser`](client._internal_namespace.AuthenticatedUser.md) | + +#### Defined in + +x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:7 + +___ + +### authorization + +• `Optional` **authorization**: [`AuthorizationServiceSetup`](client._internal_namespace.AuthorizationServiceSetup.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:6 + +___ + +### authorizationMode + +• `Optional` **authorizationMode**: [`AuthorizationMode`](../enums/client._internal_namespace.AuthorizationMode.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:8 + +___ + +### request + +• **request**: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/authorization/actions_authorization.d.ts:5 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions-2.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions-2.md new file mode 100644 index 0000000000000..fed308c053049 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions-2.md @@ -0,0 +1,43 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ConstructorOptions + +# Interface: ConstructorOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ConstructorOptions + +## Table of contents + +### Properties + +- [encryptedSavedObjectsClient](client._internal_namespace.ConstructorOptions-2.md#encryptedsavedobjectsclient) +- [logger](client._internal_namespace.ConstructorOptions-2.md#logger) +- [unsecuredSavedObjectsClient](client._internal_namespace.ConstructorOptions-2.md#unsecuredsavedobjectsclient) + +## Properties + +### encryptedSavedObjectsClient + +• **encryptedSavedObjectsClient**: [`EncryptedSavedObjectsClient`](client._internal_namespace.EncryptedSavedObjectsClient.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:6 + +___ + +### logger + +• **logger**: `Logger` + +#### Defined in + +x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:8 + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Defined in + +x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:7 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions.md new file mode 100644 index 0000000000000..67923b89864f8 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ConstructorOptions.md @@ -0,0 +1,153 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ConstructorOptions + +# Interface: ConstructorOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ConstructorOptions + +## Table of contents + +### Properties + +- [actionExecutor](client._internal_namespace.ConstructorOptions.md#actionexecutor) +- [actionTypeRegistry](client._internal_namespace.ConstructorOptions.md#actiontyperegistry) +- [auditLogger](client._internal_namespace.ConstructorOptions.md#auditlogger) +- [authorization](client._internal_namespace.ConstructorOptions.md#authorization) +- [connectorTokenClient](client._internal_namespace.ConstructorOptions.md#connectortokenclient) +- [defaultKibanaIndex](client._internal_namespace.ConstructorOptions.md#defaultkibanaindex) +- [ephemeralExecutionEnqueuer](client._internal_namespace.ConstructorOptions.md#ephemeralexecutionenqueuer) +- [executionEnqueuer](client._internal_namespace.ConstructorOptions.md#executionenqueuer) +- [preconfiguredActions](client._internal_namespace.ConstructorOptions.md#preconfiguredactions) +- [request](client._internal_namespace.ConstructorOptions.md#request) +- [scopedClusterClient](client._internal_namespace.ConstructorOptions.md#scopedclusterclient) +- [unsecuredSavedObjectsClient](client._internal_namespace.ConstructorOptions.md#unsecuredsavedobjectsclient) +- [usageCounter](client._internal_namespace.ConstructorOptions.md#usagecounter) + +## Properties + +### actionExecutor + +• **actionExecutor**: [`ActionExecutorContract`](../modules/client._internal_namespace.md#actionexecutorcontract) + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:30 + +___ + +### actionTypeRegistry + +• **actionTypeRegistry**: [`ActionTypeRegistry`](../classes/client._internal_namespace.ActionTypeRegistry.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:27 + +___ + +### auditLogger + +• `Optional` **auditLogger**: [`AuditLogger`](client._internal_namespace.AuditLogger.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:35 + +___ + +### authorization + +• **authorization**: [`ActionsAuthorization`](../classes/client._internal_namespace.ActionsAuthorization.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:34 + +___ + +### connectorTokenClient + +• **connectorTokenClient**: [`ConnectorTokenClientContract`](../modules/client._internal_namespace.md#connectortokenclientcontract) + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:37 + +___ + +### defaultKibanaIndex + +• **defaultKibanaIndex**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:25 + +___ + +### ephemeralExecutionEnqueuer + +• **ephemeralExecutionEnqueuer**: [`ExecutionEnqueuer`](../modules/client._internal_namespace.md#executionenqueuer)<[`RunNowResult`](client._internal_namespace.RunNowResult.md)\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:32 + +___ + +### executionEnqueuer + +• **executionEnqueuer**: [`ExecutionEnqueuer`](../modules/client._internal_namespace.md#executionenqueuer)<`void`\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:31 + +___ + +### preconfiguredActions + +• **preconfiguredActions**: [`PreConfiguredAction`](client._internal_namespace.PreConfiguredAction.md)<[`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig), [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets)\>[] + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:29 + +___ + +### request + +• **request**: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:33 + +___ + +### scopedClusterClient + +• **scopedClusterClient**: [`IScopedClusterClient`](client._internal_namespace.IScopedClusterClient.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:26 + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:28 + +___ + +### usageCounter + +• `Optional` **usageCounter**: [`IUsageCounter`](client._internal_namespace.IUsageCounter.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:36 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CountActionsAttachedToCaseArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CountActionsAttachedToCaseArgs.md new file mode 100644 index 0000000000000..a71324b5543ff --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CountActionsAttachedToCaseArgs.md @@ -0,0 +1,72 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CountActionsAttachedToCaseArgs + +# Interface: CountActionsAttachedToCaseArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CountActionsAttachedToCaseArgs + +## Hierarchy + +- [`AttachedToCaseArgs`](client._internal_namespace.AttachedToCaseArgs.md) + + ↳ **`CountActionsAttachedToCaseArgs`** + +## Table of contents + +### Properties + +- [aggregations](client._internal_namespace.CountActionsAttachedToCaseArgs.md#aggregations) +- [caseId](client._internal_namespace.CountActionsAttachedToCaseArgs.md#caseid) +- [filter](client._internal_namespace.CountActionsAttachedToCaseArgs.md#filter) +- [unsecuredSavedObjectsClient](client._internal_namespace.CountActionsAttachedToCaseArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### aggregations + +• **aggregations**: `Record`<`string`, `AggregationsAggregationContainer`\> + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:40](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L40) + +___ + +### caseId + +• **caseId**: `string` + +#### Inherited from + +[AttachedToCaseArgs](client._internal_namespace.AttachedToCaseArgs.md).[caseId](client._internal_namespace.AttachedToCaseArgs.md#caseid) + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:33](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L33) + +___ + +### filter + +• `Optional` **filter**: `KueryNode` + +#### Inherited from + +[AttachedToCaseArgs](client._internal_namespace.AttachedToCaseArgs.md).[filter](client._internal_namespace.AttachedToCaseArgs.md#filter) + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:34](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L34) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[AttachedToCaseArgs](client._internal_namespace.AttachedToCaseArgs.md).[unsecuredSavedObjectsClient](client._internal_namespace.AttachedToCaseArgs.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateAttachmentArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateAttachmentArgs.md new file mode 100644 index 0000000000000..50030284f8fb6 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateAttachmentArgs.md @@ -0,0 +1,64 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CreateAttachmentArgs + +# Interface: CreateAttachmentArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CreateAttachmentArgs + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) + + ↳ **`CreateAttachmentArgs`** + +## Table of contents + +### Properties + +- [attributes](client._internal_namespace.CreateAttachmentArgs.md#attributes) +- [id](client._internal_namespace.CreateAttachmentArgs.md#id) +- [references](client._internal_namespace.CreateAttachmentArgs.md#references) +- [unsecuredSavedObjectsClient](client._internal_namespace.CreateAttachmentArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### attributes + +• **attributes**: { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:48](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L48) + +___ + +### id + +• **id**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:50](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L50) + +___ + +### references + +• **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:49](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L49) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateAuditMsgParams.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateAuditMsgParams.md new file mode 100644 index 0000000000000..30c4ab0076bf0 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateAuditMsgParams.md @@ -0,0 +1,43 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CreateAuditMsgParams + +# Interface: CreateAuditMsgParams + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CreateAuditMsgParams + +## Table of contents + +### Properties + +- [entity](client._internal_namespace.CreateAuditMsgParams.md#entity) +- [error](client._internal_namespace.CreateAuditMsgParams.md#error) +- [operation](client._internal_namespace.CreateAuditMsgParams.md#operation) + +## Properties + +### entity + +• `Optional` **entity**: [`OwnerEntity`](client._internal_namespace.OwnerEntity.md) + +#### Defined in + +[x-pack/plugins/cases/server/authorization/audit_logger.ts:15](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/audit_logger.ts#L15) + +___ + +### error + +• `Optional` **error**: `Error` + +#### Defined in + +[x-pack/plugins/cases/server/authorization/audit_logger.ts:16](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/audit_logger.ts#L16) + +___ + +### operation + +• **operation**: [`OperationDetails`](client._internal_namespace.OperationDetails.md) + +#### Defined in + +[x-pack/plugins/cases/server/authorization/audit_logger.ts:14](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/audit_logger.ts#L14) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateOptions-1.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateOptions-1.md new file mode 100644 index 0000000000000..77e84843801b5 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateOptions-1.md @@ -0,0 +1,54 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CreateOptions + +# Interface: CreateOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CreateOptions + +## Table of contents + +### Properties + +- [connectorId](client._internal_namespace.CreateOptions-1.md#connectorid) +- [expiresAtMillis](client._internal_namespace.CreateOptions-1.md#expiresatmillis) +- [token](client._internal_namespace.CreateOptions-1.md#token) +- [tokenType](client._internal_namespace.CreateOptions-1.md#tokentype) + +## Properties + +### connectorId + +• **connectorId**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:11 + +___ + +### expiresAtMillis + +• **expiresAtMillis**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:13 + +___ + +### token + +• **token**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:12 + +___ + +### tokenType + +• `Optional` **tokenType**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:14 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateOptions.md new file mode 100644 index 0000000000000..1070beb2f0304 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateOptions.md @@ -0,0 +1,21 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CreateOptions + +# Interface: CreateOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CreateOptions + +## Table of contents + +### Properties + +- [action](client._internal_namespace.CreateOptions.md#action) + +## Properties + +### action + +• **action**: [`Action`](client._internal_namespace.Action.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:22 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateUserAction.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateUserAction.md new file mode 100644 index 0000000000000..5211a50019cae --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateUserAction.md @@ -0,0 +1,38 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CreateUserAction + +# Interface: CreateUserAction + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CreateUserAction + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends keyof [`BuilderParameters`](client._internal_namespace.BuilderParameters.md) | + +## Table of contents + +### Properties + +- [payload](client._internal_namespace.CreateUserAction.md#payload) +- [type](client._internal_namespace.CreateUserAction.md#type) + +## Properties + +### payload + +• **payload**: [`BuilderParameters`](client._internal_namespace.BuilderParameters.md)[`T`][``"parameters"``][``"payload"``] + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:68](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L68) + +___ + +### type + +• **type**: `T` + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:67](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L67) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateUserActionES.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateUserActionES.md new file mode 100644 index 0000000000000..efc0b67c18a3e --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.CreateUserActionES.md @@ -0,0 +1,59 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / CreateUserActionES + +# Interface: CreateUserActionES + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).CreateUserActionES + +## Type parameters + +| Name | +| :------ | +| `T` | + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) + + ↳ **`CreateUserActionES`** + +## Table of contents + +### Properties + +- [attributes](client._internal_namespace.CreateUserActionES.md#attributes) +- [references](client._internal_namespace.CreateUserActionES.md#references) +- [unsecuredSavedObjectsClient](client._internal_namespace.CreateUserActionES.md#unsecuredsavedobjectsclient) + +## Properties + +### attributes + +• **attributes**: `T` + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:71](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L71) + +___ + +### references + +• **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:72](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L72) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.DecoratedError.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.DecoratedError.md new file mode 100644 index 0000000000000..77ef99caaf16a --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.DecoratedError.md @@ -0,0 +1,27 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / DecoratedError + +# Interface: DecoratedError + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).DecoratedError + +## Hierarchy + +- `Boom` + + ↳ **`DecoratedError`** + +## Table of contents + +### Properties + +- [[code]](client._internal_namespace.DecoratedError.md#[code]) + +## Properties + +### [code] + +• `Optional` **[code]**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/errors.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ElasticsearchFeatureConfig.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ElasticsearchFeatureConfig.md new file mode 100644 index 0000000000000..373ba63e5c659 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ElasticsearchFeatureConfig.md @@ -0,0 +1,94 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ElasticsearchFeatureConfig + +# Interface: ElasticsearchFeatureConfig + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ElasticsearchFeatureConfig + +Interface for registering an Elasticsearch feature. +Feature registration allows plugins to hide their applications based +on configured cluster or index privileges. + +## Table of contents + +### Properties + +- [catalogue](client._internal_namespace.ElasticsearchFeatureConfig.md#catalogue) +- [id](client._internal_namespace.ElasticsearchFeatureConfig.md#id) +- [management](client._internal_namespace.ElasticsearchFeatureConfig.md#management) +- [privileges](client._internal_namespace.ElasticsearchFeatureConfig.md#privileges) + +## Properties + +### catalogue + +• `Optional` **catalogue**: `string`[] + +If this feature includes a catalogue entry, you can specify them here to control visibility based on the current space. + +#### Defined in + +x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:34 + +___ + +### id + +• **id**: `string` + +Unique identifier for this feature. +This identifier is also used when generating UI Capabilities. + +**`see`** UICapabilities + +#### Defined in + +x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:15 + +___ + +### management + +• `Optional` **management**: `Object` + +Management sections associated with this feature. + +**`example`** +```ts + // Enables access to the "Advanced Settings" management page within the Kibana section + management: { + kibana: ['settings'] + } +``` + +#### Index signature + +▪ [sectionId: `string`]: `string`[] + +#### Defined in + +x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:27 + +___ + +### privileges + +• **privileges**: [`FeatureElasticsearchPrivileges`](client._internal_namespace.FeatureElasticsearchPrivileges.md)[] + +Feature privilege definition. Specify one or more privileges which grant access to this feature. +Users must satisfy all privileges in at least one of the defined sets of privileges in order to be granted access. + +**`example`** +```ts + [{ + requiredClusterPrivileges: ['monitor'], + requiredIndexPrivileges: { + ['metricbeat-*']: ['read', 'view_index_metadata'] + } + }] +``` + +**`see`** FeatureElasticsearchPrivileges + +#### Defined in + +x-pack/plugins/features/target/types/common/elasticsearch_feature.d.ts:50 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.EmbeddableRegistryDefinition.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.EmbeddableRegistryDefinition.md new file mode 100644 index 0000000000000..6a4eba88cc91d --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.EmbeddableRegistryDefinition.md @@ -0,0 +1,157 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / EmbeddableRegistryDefinition + +# Interface: EmbeddableRegistryDefinition + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).EmbeddableRegistryDefinition + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `P` | extends [`EmbeddableStateWithType`](../modules/client._internal_namespace.md#embeddablestatewithtype) = [`EmbeddableStateWithType`](../modules/client._internal_namespace.md#embeddablestatewithtype) | + +## Hierarchy + +- [`PersistableStateDefinition`](../modules/client._internal_namespace.md#persistablestatedefinition)<`P`\> + + ↳ **`EmbeddableRegistryDefinition`** + +## Table of contents + +### Properties + +- [id](client._internal_namespace.EmbeddableRegistryDefinition.md#id) +- [migrations](client._internal_namespace.EmbeddableRegistryDefinition.md#migrations) + +### Methods + +- [extract](client._internal_namespace.EmbeddableRegistryDefinition.md#extract) +- [inject](client._internal_namespace.EmbeddableRegistryDefinition.md#inject) +- [telemetry](client._internal_namespace.EmbeddableRegistryDefinition.md#telemetry) + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +src/plugins/embeddable/target/types/server/types.d.ts:13 + +___ + +### migrations + +• `Optional` **migrations**: [`MigrateFunctionsObject`](../modules/client._internal_namespace.md#migratefunctionsobject) \| [`GetMigrationFunctionObjectFn`](../modules/client._internal_namespace.md#getmigrationfunctionobjectfn) + +A list of migration functions, which migrate the persistable state +serializable object to the next version. Migration functions should are +keyed by the Kibana version using semver, where the version indicates to +which version the state will be migrated to. + +#### Inherited from + +PersistableStateDefinition.migrations + +#### Defined in + +src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:75 + +## Methods + +### extract + +▸ `Optional` **extract**(`state`): `Object` + +A function which receives state and should return the state with references +extracted and an array of the extracted references. The default case could +simply return the same state with an empty array of references. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `state` | `P` | The persistable state serializable state object. | + +#### Returns + +`Object` + +Persistable state object with references extracted and a list of + references. + +| Name | Type | +| :------ | :------ | +| `references` | [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] | +| `state` | `P` | + +#### Inherited from + +PersistableStateDefinition.extract + +#### Defined in + +src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:65 + +___ + +### inject + +▸ `Optional` **inject**(`state`, `references`): `P` + +A function which receives state and a list of references and should return +back the state with references injected. The default is an identity +function. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `state` | `P` | The persistable state serializable state object. | +| `references` | [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] | List of saved object references. | + +#### Returns + +`P` + +Persistable state object with references injected. + +#### Inherited from + +PersistableStateDefinition.inject + +#### Defined in + +src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:55 + +___ + +### telemetry + +▸ `Optional` **telemetry**(`state`, `stats`): `Record`<`string`, `any`\> + +Function which reports telemetry information. This function is essentially +a "reducer" - it receives the existing "stats" object and returns an +updated version of the "stats" object. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `state` | `P` | The persistable state serializable state object. | +| `stats` | `Record`<`string`, `any`\> | Stats object containing the stats which were already collected. This `stats` object shall not be mutated in-line. | + +#### Returns + +`Record`<`string`, `any`\> + +A new stats object augmented with new telemetry information. + +#### Inherited from + +PersistableStateDefinition.telemetry + +#### Defined in + +src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:45 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.EncryptedSavedObjectsClient.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.EncryptedSavedObjectsClient.md new file mode 100644 index 0000000000000..fff1cd9a9e369 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.EncryptedSavedObjectsClient.md @@ -0,0 +1,39 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / EncryptedSavedObjectsClient + +# Interface: EncryptedSavedObjectsClient + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).EncryptedSavedObjectsClient + +## Table of contents + +### Methods + +- [getDecryptedAsInternalUser](client._internal_namespace.EncryptedSavedObjectsClient.md#getdecryptedasinternaluser) + +## Methods + +### getDecryptedAsInternalUser + +▸ **getDecryptedAsInternalUser**<`T`\>(`type`, `id`, `options?`): `Promise`<[`SavedObject`](client._internal_namespace.SavedObject.md)<`T`\>\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | +| `id` | `string` | +| `options?` | [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) | + +#### Returns + +`Promise`<[`SavedObject`](client._internal_namespace.SavedObject.md)<`T`\>\> + +#### Defined in + +x-pack/plugins/encrypted_saved_objects/target/types/server/saved_objects/index.d.ts:18 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ExecuteOptions-1.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ExecuteOptions-1.md new file mode 100644 index 0000000000000..4004d5c484793 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ExecuteOptions-1.md @@ -0,0 +1,101 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ExecuteOptions + +# Interface: ExecuteOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ExecuteOptions + +## Hierarchy + +- `Pick`<[`ExecuteOptions`](client._internal_namespace.ExecuteOptions.md), ``"params"`` \| ``"source"``\> + + ↳ **`ExecuteOptions`** + +## Table of contents + +### Properties + +- [apiKey](client._internal_namespace.ExecuteOptions-1.md#apikey) +- [executionId](client._internal_namespace.ExecuteOptions-1.md#executionid) +- [id](client._internal_namespace.ExecuteOptions-1.md#id) +- [params](client._internal_namespace.ExecuteOptions-1.md#params) +- [relatedSavedObjects](client._internal_namespace.ExecuteOptions-1.md#relatedsavedobjects) +- [source](client._internal_namespace.ExecuteOptions-1.md#source) +- [spaceId](client._internal_namespace.ExecuteOptions-1.md#spaceid) + +## Properties + +### apiKey + +• **apiKey**: ``null`` \| `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/create_execute_function.d.ts:15 + +___ + +### executionId + +• **executionId**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/create_execute_function.d.ts:16 + +___ + +### id + +• **id**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/create_execute_function.d.ts:13 + +___ + +### params + +• **params**: `Record`<`string`, `unknown`\> + +#### Inherited from + +Pick.params + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:28 + +___ + +### relatedSavedObjects + +• `Optional` **relatedSavedObjects**: `Readonly`<{ `namespace?`: `string` ; `typeId?`: `string` } & { `id`: `string` ; `type`: `string` }\>[] + +#### Defined in + +x-pack/plugins/actions/target/types/server/create_execute_function.d.ts:17 + +___ + +### source + +• `Optional` **source**: [`ActionExecutionSource`](client._internal_namespace.ActionExecutionSource.md)<`unknown`\> + +#### Inherited from + +Pick.source + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:29 + +___ + +### spaceId + +• **spaceId**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/create_execute_function.d.ts:14 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ExecuteOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ExecuteOptions.md new file mode 100644 index 0000000000000..fb808b1afbbee --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ExecuteOptions.md @@ -0,0 +1,104 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ExecuteOptions + +# Interface: ExecuteOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ExecuteOptions + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Source` | `unknown` | + +## Table of contents + +### Properties + +- [actionId](client._internal_namespace.ExecuteOptions.md#actionid) +- [executionId](client._internal_namespace.ExecuteOptions.md#executionid) +- [isEphemeral](client._internal_namespace.ExecuteOptions.md#isephemeral) +- [params](client._internal_namespace.ExecuteOptions.md#params) +- [relatedSavedObjects](client._internal_namespace.ExecuteOptions.md#relatedsavedobjects) +- [request](client._internal_namespace.ExecuteOptions.md#request) +- [source](client._internal_namespace.ExecuteOptions.md#source) +- [taskInfo](client._internal_namespace.ExecuteOptions.md#taskinfo) + +## Properties + +### actionId + +• **actionId**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:25 + +___ + +### executionId + +• `Optional` **executionId**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:31 + +___ + +### isEphemeral + +• `Optional` **isEphemeral**: `boolean` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:26 + +___ + +### params + +• **params**: `Record`<`string`, `unknown`\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:28 + +___ + +### relatedSavedObjects + +• `Optional` **relatedSavedObjects**: `Readonly`<{ `namespace?`: `string` ; `typeId?`: `string` } & { `id`: `string` ; `type`: `string` }\>[] + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:32 + +___ + +### request + +• **request**: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:27 + +___ + +### source + +• `Optional` **source**: [`ActionExecutionSource`](client._internal_namespace.ActionExecutionSource.md)<`Source`\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:29 + +___ + +### taskInfo + +• `Optional` **taskInfo**: [`TaskInfo`](client._internal_namespace.TaskInfo.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:30 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureElasticsearchPrivileges.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureElasticsearchPrivileges.md new file mode 100644 index 0000000000000..bb462c5341233 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureElasticsearchPrivileges.md @@ -0,0 +1,106 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / FeatureElasticsearchPrivileges + +# Interface: FeatureElasticsearchPrivileges + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).FeatureElasticsearchPrivileges + +Elasticsearch Feature privilege definition + +## Table of contents + +### Properties + +- [requiredClusterPrivileges](client._internal_namespace.FeatureElasticsearchPrivileges.md#requiredclusterprivileges) +- [requiredIndexPrivileges](client._internal_namespace.FeatureElasticsearchPrivileges.md#requiredindexprivileges) +- [requiredRoles](client._internal_namespace.FeatureElasticsearchPrivileges.md#requiredroles) +- [ui](client._internal_namespace.FeatureElasticsearchPrivileges.md#ui) + +## Properties + +### requiredClusterPrivileges + +• **requiredClusterPrivileges**: `string`[] + +A set of Elasticsearch cluster privileges which are required for this feature to be enabled. +See https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_elasticsearch_privileges.d.ts:10 + +___ + +### requiredIndexPrivileges + +• `Optional` **requiredIndexPrivileges**: `Object` + +A set of Elasticsearch index privileges which are required for this feature to be enabled, keyed on index name or pattern. +See https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html#privileges-list-indices + +**`example`** + +Requiring `read` access to `logstash-*` and `all` access to `foo-*` +```ts +feature.registerElasticsearchPrivilege({ + privileges: [{ + requiredIndexPrivileges: { + ['logstash-*']: ['read'], + ['foo-*]: ['all'] + } + }] +}) +``` + +#### Index signature + +▪ [indexName: `string`]: `string`[] + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_elasticsearch_privileges.d.ts:30 + +___ + +### requiredRoles + +• `Optional` **requiredRoles**: `string`[] + +A set of Elasticsearch roles which are required for this feature to be enabled. + +**`deprecated`** do not rely on hard-coded role names. + +This is relied on by the reporting feature, and should be removed once reporting +migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/issues/19914 + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_elasticsearch_privileges.d.ts:41 + +___ + +### ui + +• **ui**: `string`[] + +A list of UI Capabilities that should be granted to users with this privilege. +These capabilities will automatically be namespaces within your feature id. + +**`example`** +```ts + { + ui: ['show', 'save'] + } + + This translates in the UI to the following (assuming a feature id of "foo"): + import { uiCapabilities } from 'ui/capabilities'; + + const canShowApp = uiCapabilities.foo.show; + const canSave = uiCapabilities.foo.save; +``` +Note: Since these are automatically namespaced, you are free to use generic names like "show" and "save". + +**`see`** UICapabilities + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_elasticsearch_privileges.d.ts:62 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureKibanaPrivileges.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureKibanaPrivileges.md new file mode 100644 index 0000000000000..caf57a8ff8987 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureKibanaPrivileges.md @@ -0,0 +1,246 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / FeatureKibanaPrivileges + +# Interface: FeatureKibanaPrivileges + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).FeatureKibanaPrivileges + +Feature privilege definition + +## Table of contents + +### Properties + +- [alerting](client._internal_namespace.FeatureKibanaPrivileges.md#alerting) +- [api](client._internal_namespace.FeatureKibanaPrivileges.md#api) +- [app](client._internal_namespace.FeatureKibanaPrivileges.md#app) +- [cases](client._internal_namespace.FeatureKibanaPrivileges.md#cases) +- [catalogue](client._internal_namespace.FeatureKibanaPrivileges.md#catalogue) +- [disabled](client._internal_namespace.FeatureKibanaPrivileges.md#disabled) +- [excludeFromBasePrivileges](client._internal_namespace.FeatureKibanaPrivileges.md#excludefrombaseprivileges) +- [management](client._internal_namespace.FeatureKibanaPrivileges.md#management) +- [requireAllSpaces](client._internal_namespace.FeatureKibanaPrivileges.md#requireallspaces) +- [savedObject](client._internal_namespace.FeatureKibanaPrivileges.md#savedobject) +- [ui](client._internal_namespace.FeatureKibanaPrivileges.md#ui) + +## Properties + +### alerting + +• `Optional` **alerting**: `Object` + +If your feature requires access to specific Alert Types, then specify your access needs here. +Include both Alert Types registered by the feature and external Alert Types such as built-in +Alert Types and Alert Types provided by other features to which you wish to grant access. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `alert?` | `Object` | +| `alert.all?` | readonly `string`[] | +| `alert.read?` | readonly `string`[] | +| `rule?` | `Object` | +| `rule.all?` | readonly `string`[] | +| `rule.read?` | readonly `string`[] | + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:82 + +___ + +### api + +• `Optional` **api**: readonly `string`[] + +If your feature includes server-side APIs, you can tag those routes to secure access based on user permissions. + +**`example`** +```ts + // Configure your routes with a tag starting with the 'access:' prefix + server.route({ + path: '/api/my-route', + method: 'GET', + handler: () => { ...}, + options: { + tags: ['access:my_feature-admin'] + } + }); + + Then, specify the tags here (without the 'access:' prefix) which should be secured: + + { + api: ['my_feature-admin'] + } +``` + +NOTE: It is important to name your tags in a way that will not collide with other plugins/features. +A generic tag name like "access:read" could be used elsewhere, and access to that API endpoint would also +extend to any routes you have also tagged with that name. + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:64 + +___ + +### app + +• `Optional` **app**: readonly `string`[] + +If your feature exposes a client-side application (most of them do!), then you can control access to them here. + +**`example`** +```ts + { + app: ['my-app', 'kibana'] + } +``` + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:76 + +___ + +### cases + +• `Optional` **cases**: `Object` + +If your feature requires access to specific owners of cases (aka plugins that have created cases), then specify your access needs here. The values here should +be unique identifiers for the owners of cases you want access to. + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `all?` | readonly `string`[] | List of case owners which users should have full read/write access to when granted this privilege. **`example`** ```ts { all: ['securitySolution'] } ``` | +| `read?` | readonly `string`[] | List of case owners which users should have read-only access to when granted this privilege. **`example`** ```ts { read: ['securitySolution'] } ``` | + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:132 + +___ + +### catalogue + +• `Optional` **catalogue**: readonly `string`[] + +If this feature includes a catalogue entry, you can specify them here to control visibility based on user permissions. + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:37 + +___ + +### disabled + +• `Optional` **disabled**: `boolean` + +Whether or not this privilege should be hidden in the roles UI and disallowed on the API. Defaults to `false`. + +**`deprecated`** + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:18 + +___ + +### excludeFromBasePrivileges + +• `Optional` **excludeFromBasePrivileges**: `boolean` + +Whether or not this specific privilege should be excluded from the base privileges. + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:8 + +___ + +### management + +• `Optional` **management**: `Object` + +If this feature includes management sections, you can specify them here to control visibility of those +pages based on user privileges. + +**`example`** +```ts + // Enables access to the "Advanced Settings" management page within the Kibana section + management: { + kibana: ['settings'] + } +``` + +#### Index signature + +▪ [sectionId: `string`]: readonly `string`[] + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:31 + +___ + +### requireAllSpaces + +• `Optional` **requireAllSpaces**: `boolean` + +Whether or not this privilege should only be granted to `All Spaces *`. Should be used for features that do not +support Spaces. Defaults to `false`. + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:13 + +___ + +### savedObject + +• **savedObject**: `Object` + +If your feature requires access to specific saved objects, then specify your access needs here. + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `all` | readonly `string`[] | List of saved object types which users should have full read/write access to when granted this privilege. **`example`** ```ts { all: ['my-saved-object-type'] } ``` | +| `read` | readonly `string`[] | List of saved object types which users should have read-only access to when granted this privilege. **`example`** ```ts { read: ['config'] } ``` | + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:157 + +___ + +### ui + +• **ui**: readonly `string`[] + +A list of UI Capabilities that should be granted to users with this privilege. +These capabilities will automatically be namespaces within your feature id. + +**`example`** +```ts + { + ui: ['show', 'save'] + } + + This translates in the UI to the following (assuming a feature id of "foo"): + import { uiCapabilities } from 'ui/capabilities'; + + const canShowApp = uiCapabilities.foo.show; + const canSave = uiCapabilities.foo.save; +``` +Note: Since these are automatically namespaced, you are free to use generic names like "show" and "save". + +**`see`** UICapabilities + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:199 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureUsageServiceSetup.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureUsageServiceSetup.md new file mode 100644 index 0000000000000..77770e22b41e2 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FeatureUsageServiceSetup.md @@ -0,0 +1,34 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / FeatureUsageServiceSetup + +# Interface: FeatureUsageServiceSetup + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).FeatureUsageServiceSetup + +## Table of contents + +### Methods + +- [register](client._internal_namespace.FeatureUsageServiceSetup.md#register) + +## Methods + +### register + +▸ **register**(`featureName`, `licenseType`): `void` + +Register a feature to be able to notify of it's usages using the {@link FeatureUsageServiceStart | service start contract}. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `featureName` | `string` | +| `licenseType` | ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` | + +#### Returns + +`void` + +#### Defined in + +x-pack/plugins/licensing/target/types/server/services/feature_usage_service.d.ts:7 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindActionResult.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindActionResult.md new file mode 100644 index 0000000000000..e7306b5d7b931 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindActionResult.md @@ -0,0 +1,117 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / FindActionResult + +# Interface: FindActionResult + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).FindActionResult + +## Hierarchy + +- [`ActionResult`](client._internal_namespace.ActionResult.md) + + ↳ **`FindActionResult`** + +## Table of contents + +### Properties + +- [actionTypeId](client._internal_namespace.FindActionResult.md#actiontypeid) +- [config](client._internal_namespace.FindActionResult.md#config) +- [id](client._internal_namespace.FindActionResult.md#id) +- [isMissingSecrets](client._internal_namespace.FindActionResult.md#ismissingsecrets) +- [isPreconfigured](client._internal_namespace.FindActionResult.md#ispreconfigured) +- [name](client._internal_namespace.FindActionResult.md#name) +- [referencedByCount](client._internal_namespace.FindActionResult.md#referencedbycount) + +## Properties + +### actionTypeId + +• **actionTypeId**: `string` + +#### Inherited from + +[ActionResult](client._internal_namespace.ActionResult.md).[actionTypeId](client._internal_namespace.ActionResult.md#actiontypeid) + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:50 + +___ + +### config + +• `Optional` **config**: [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) + +#### Inherited from + +[ActionResult](client._internal_namespace.ActionResult.md).[config](client._internal_namespace.ActionResult.md#config) + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:53 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[ActionResult](client._internal_namespace.ActionResult.md).[id](client._internal_namespace.ActionResult.md#id) + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:49 + +___ + +### isMissingSecrets + +• `Optional` **isMissingSecrets**: `boolean` + +#### Inherited from + +[ActionResult](client._internal_namespace.ActionResult.md).[isMissingSecrets](client._internal_namespace.ActionResult.md#ismissingsecrets) + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:52 + +___ + +### isPreconfigured + +• **isPreconfigured**: `boolean` + +#### Inherited from + +[ActionResult](client._internal_namespace.ActionResult.md).[isPreconfigured](client._internal_namespace.ActionResult.md#ispreconfigured) + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:54 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[ActionResult](client._internal_namespace.ActionResult.md).[name](client._internal_namespace.ActionResult.md#name) + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:51 + +___ + +### referencedByCount + +• **referencedByCount**: `number` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:60 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCaseCommentsArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCaseCommentsArgs.md new file mode 100644 index 0000000000000..a5b1689fc0e9b --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCaseCommentsArgs.md @@ -0,0 +1,43 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / FindCaseCommentsArgs + +# Interface: FindCaseCommentsArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).FindCaseCommentsArgs + +## Table of contents + +### Properties + +- [id](client._internal_namespace.FindCaseCommentsArgs.md#id) +- [options](client._internal_namespace.FindCaseCommentsArgs.md#options) +- [unsecuredSavedObjectsClient](client._internal_namespace.FindCaseCommentsArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### id + +• **id**: `string` \| `string`[] + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:84](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L84) + +___ + +### options + +• `Optional` **options**: [`SavedObjectFindOptionsKueryNode`](../modules/client._internal_namespace.md#savedobjectfindoptionskuerynode) + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:85](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L85) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:83](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L83) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCaseConfigureArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCaseConfigureArgs.md new file mode 100644 index 0000000000000..5e3635fe0c3ec --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCaseConfigureArgs.md @@ -0,0 +1,42 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / FindCaseConfigureArgs + +# Interface: FindCaseConfigureArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).FindCaseConfigureArgs + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs.md) + + ↳ **`FindCaseConfigureArgs`** + +## Table of contents + +### Properties + +- [options](client._internal_namespace.FindCaseConfigureArgs.md#options) +- [unsecuredSavedObjectsClient](client._internal_namespace.FindCaseConfigureArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### options + +• `Optional` **options**: [`SavedObjectFindOptionsKueryNode`](../modules/client._internal_namespace.md#savedobjectfindoptionskuerynode) + +#### Defined in + +[x-pack/plugins/cases/server/services/configure/index.ts:37](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L37) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/configure/index.ts:30](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L30) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCasesArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCasesArgs.md new file mode 100644 index 0000000000000..0ac807ecaadac --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCasesArgs.md @@ -0,0 +1,42 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / FindCasesArgs + +# Interface: FindCasesArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).FindCasesArgs + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) + + ↳ **`FindCasesArgs`** + +## Table of contents + +### Properties + +- [options](client._internal_namespace.FindCasesArgs.md#options) +- [unsecuredSavedObjectsClient](client._internal_namespace.FindCasesArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### options + +• `Optional` **options**: [`SavedObjectFindOptionsKueryNode`](../modules/client._internal_namespace.md#savedobjectfindoptionskuerynode) + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:89](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L89) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCommentsArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCommentsArgs.md new file mode 100644 index 0000000000000..b88437b3e33a8 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindCommentsArgs.md @@ -0,0 +1,43 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / FindCommentsArgs + +# Interface: FindCommentsArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).FindCommentsArgs + +## Table of contents + +### Properties + +- [id](client._internal_namespace.FindCommentsArgs.md#id) +- [options](client._internal_namespace.FindCommentsArgs.md#options) +- [unsecuredSavedObjectsClient](client._internal_namespace.FindCommentsArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### id + +• **id**: `string` \| `string`[] + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:78](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L78) + +___ + +### options + +• `Optional` **options**: [`SavedObjectFindOptionsKueryNode`](../modules/client._internal_namespace.md#savedobjectfindoptionskuerynode) + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:79](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L79) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:77](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L77) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindConnectorMappingsArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindConnectorMappingsArgs.md new file mode 100644 index 0000000000000..5f70d4ae539e8 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.FindConnectorMappingsArgs.md @@ -0,0 +1,42 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / FindConnectorMappingsArgs + +# Interface: FindConnectorMappingsArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).FindConnectorMappingsArgs + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs-2.md) + + ↳ **`FindConnectorMappingsArgs`** + +## Table of contents + +### Properties + +- [options](client._internal_namespace.FindConnectorMappingsArgs.md#options) +- [unsecuredSavedObjectsClient](client._internal_namespace.FindConnectorMappingsArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### options + +• `Optional` **options**: [`SavedObjectFindOptionsKueryNode`](../modules/client._internal_namespace.md#savedobjectfindoptionskuerynode) + +#### Defined in + +[x-pack/plugins/cases/server/services/connector_mappings/index.ts:18](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L18) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs-2.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-2.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/connector_mappings/index.ts:15](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L15) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetAllSpacesOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetAllSpacesOptions.md new file mode 100644 index 0000000000000..905d61791cb2e --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetAllSpacesOptions.md @@ -0,0 +1,44 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetAllSpacesOptions + +# Interface: GetAllSpacesOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetAllSpacesOptions + +Controls how spaces are retrieved. + +## Table of contents + +### Properties + +- [includeAuthorizedPurposes](client._internal_namespace.GetAllSpacesOptions.md#includeauthorizedpurposes) +- [purpose](client._internal_namespace.GetAllSpacesOptions.md#purpose) + +## Properties + +### includeAuthorizedPurposes + +• `Optional` **includeAuthorizedPurposes**: `boolean` + +Set to true to return a set of flags indicating which purposes the user is authorized for. + +**`see`** GetAllSpacesPurpose + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:65 + +___ + +### purpose + +• `Optional` **purpose**: [`GetAllSpacesPurpose`](../modules/client._internal_namespace.md#getallspacespurpose) + +An optional purpose describing how the set of spaces will be used. +The default purpose (`any`) will retrieve all spaces the user is authorized to see, +whereas a more specific purpose will retrieve all spaces the user is authorized to perform a specific action within. + +**`see`** GetAllSpacesPurpose + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:59 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetAttachmentArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetAttachmentArgs.md new file mode 100644 index 0000000000000..39f6f288c84c5 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetAttachmentArgs.md @@ -0,0 +1,42 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetAttachmentArgs + +# Interface: GetAttachmentArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetAttachmentArgs + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) + + ↳ **`GetAttachmentArgs`** + +## Table of contents + +### Properties + +- [attachmentId](client._internal_namespace.GetAttachmentArgs.md#attachmentid) +- [unsecuredSavedObjectsClient](client._internal_namespace.GetAttachmentArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### attachmentId + +• **attachmentId**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:44](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L44) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseArgs.md new file mode 100644 index 0000000000000..5cca6876f1821 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseArgs.md @@ -0,0 +1,42 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetCaseArgs + +# Interface: GetCaseArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetCaseArgs + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) + + ↳ **`GetCaseArgs`** + +## Table of contents + +### Properties + +- [id](client._internal_namespace.GetCaseArgs.md#id) +- [unsecuredSavedObjectsClient](client._internal_namespace.GetCaseArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:69](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L69) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseConfigureArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseConfigureArgs.md new file mode 100644 index 0000000000000..2aa37a7bf78a9 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseConfigureArgs.md @@ -0,0 +1,42 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetCaseConfigureArgs + +# Interface: GetCaseConfigureArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetCaseConfigureArgs + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs.md) + + ↳ **`GetCaseConfigureArgs`** + +## Table of contents + +### Properties + +- [configurationId](client._internal_namespace.GetCaseConfigureArgs.md#configurationid) +- [unsecuredSavedObjectsClient](client._internal_namespace.GetCaseConfigureArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### configurationId + +• **configurationId**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/configure/index.ts:34](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L34) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/configure/index.ts:30](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L30) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseIdsByAlertIdArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseIdsByAlertIdArgs.md new file mode 100644 index 0000000000000..267aa4fe7100a --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseIdsByAlertIdArgs.md @@ -0,0 +1,53 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetCaseIdsByAlertIdArgs + +# Interface: GetCaseIdsByAlertIdArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetCaseIdsByAlertIdArgs + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) + + ↳ **`GetCaseIdsByAlertIdArgs`** + +## Table of contents + +### Properties + +- [alertId](client._internal_namespace.GetCaseIdsByAlertIdArgs.md#alertid) +- [filter](client._internal_namespace.GetCaseIdsByAlertIdArgs.md#filter) +- [unsecuredSavedObjectsClient](client._internal_namespace.GetCaseIdsByAlertIdArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### alertId + +• **alertId**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:59](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L59) + +___ + +### filter + +• `Optional` **filter**: `KueryNode` + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:60](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L60) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseUserActionArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseUserActionArgs.md new file mode 100644 index 0000000000000..08edac1f82b2c --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCaseUserActionArgs.md @@ -0,0 +1,42 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetCaseUserActionArgs + +# Interface: GetCaseUserActionArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetCaseUserActionArgs + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) + + ↳ **`GetCaseUserActionArgs`** + +## Table of contents + +### Properties + +- [caseId](client._internal_namespace.GetCaseUserActionArgs.md#caseid) +- [unsecuredSavedObjectsClient](client._internal_namespace.GetCaseUserActionArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### caseId + +• **caseId**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:58](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L58) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCasesArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCasesArgs.md new file mode 100644 index 0000000000000..d5e802e19b9c0 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetCasesArgs.md @@ -0,0 +1,42 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetCasesArgs + +# Interface: GetCasesArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetCasesArgs + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) + + ↳ **`GetCasesArgs`** + +## Table of contents + +### Properties + +- [caseIds](client._internal_namespace.GetCasesArgs.md#caseids) +- [unsecuredSavedObjectsClient](client._internal_namespace.GetCasesArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### caseIds + +• **caseIds**: `string`[] + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:73](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L73) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetReportersArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetReportersArgs.md new file mode 100644 index 0000000000000..af1116f4c3ddb --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetReportersArgs.md @@ -0,0 +1,32 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetReportersArgs + +# Interface: GetReportersArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetReportersArgs + +## Table of contents + +### Properties + +- [filter](client._internal_namespace.GetReportersArgs.md#filter) +- [unsecuredSavedObjectsClient](client._internal_namespace.GetReportersArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### filter + +• `Optional` **filter**: `KueryNode` + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:134](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L134) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:133](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L133) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetSpaceResult.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetSpaceResult.md new file mode 100644 index 0000000000000..8e4162988105e --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetSpaceResult.md @@ -0,0 +1,176 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetSpaceResult + +# Interface: GetSpaceResult + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetSpaceResult + +Response format when querying for spaces. + +## Hierarchy + +- [`Space`](client._internal_namespace.Space.md) + + ↳ **`GetSpaceResult`** + +## Table of contents + +### Properties + +- [\_reserved](client._internal_namespace.GetSpaceResult.md#_reserved) +- [authorizedPurposes](client._internal_namespace.GetSpaceResult.md#authorizedpurposes) +- [color](client._internal_namespace.GetSpaceResult.md#color) +- [description](client._internal_namespace.GetSpaceResult.md#description) +- [disabledFeatures](client._internal_namespace.GetSpaceResult.md#disabledfeatures) +- [id](client._internal_namespace.GetSpaceResult.md#id) +- [imageUrl](client._internal_namespace.GetSpaceResult.md#imageurl) +- [initials](client._internal_namespace.GetSpaceResult.md#initials) +- [name](client._internal_namespace.GetSpaceResult.md#name) + +## Properties + +### \_reserved + +• `Optional` `Private` **\_reserved**: `boolean` + +Indicates that this space is reserved (system controlled). +Reserved spaces cannot be created or deleted by end-users. + +#### Inherited from + +[Space](client._internal_namespace.Space.md).[_reserved](client._internal_namespace.Space.md#_reserved) + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:46 + +___ + +### authorizedPurposes + +• `Optional` **authorizedPurposes**: `Record`<[`GetAllSpacesPurpose`](../modules/client._internal_namespace.md#getallspacespurpose), `boolean`\> + +A set of flags indicating which purposes the user is authorized for. + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:82 + +___ + +### color + +• `Optional` **color**: `string` + +Optional color (hex code) for this space. +If neither `color` nor `imageUrl` is specified, then a color will be automatically generated. + +#### Inherited from + +[Space](client._internal_namespace.Space.md).[color](client._internal_namespace.Space.md#color) + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:24 + +___ + +### description + +• `Optional` **description**: `string` + +Optional description for this space. + +#### Inherited from + +[Space](client._internal_namespace.Space.md).[description](client._internal_namespace.Space.md#description) + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:19 + +___ + +### disabledFeatures + +• **disabledFeatures**: `string`[] + +The set of feature ids that should be hidden within this space. + +#### Inherited from + +[Space](client._internal_namespace.Space.md).[disabledFeatures](client._internal_namespace.Space.md#disabledfeatures) + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:40 + +___ + +### id + +• **id**: `string` + +The unique identifier for this space. +The id becomes part of the "URL Identifier" of the space. + +Example: an id of `marketing` would result in the URL identifier of `/s/marketing`. + +#### Inherited from + +[Space](client._internal_namespace.Space.md).[id](client._internal_namespace.Space.md#id) + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:11 + +___ + +### imageUrl + +• `Optional` **imageUrl**: `string` + +Optional base-64 encoded data image url to show as this space's avatar. +This setting takes precedence over any configured `color` or `initials`. + +#### Inherited from + +[Space](client._internal_namespace.Space.md).[imageUrl](client._internal_namespace.Space.md#imageurl) + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:36 + +___ + +### initials + +• `Optional` **initials**: `string` + +Optional display initials for this space's avatar. Supports a maximum of 2 characters. +If initials are not provided, then they will be derived from the space name automatically. + +Initials are not displayed if an `imageUrl` has been specified. + +#### Inherited from + +[Space](client._internal_namespace.Space.md).[initials](client._internal_namespace.Space.md#initials) + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:31 + +___ + +### name + +• **name**: `string` + +Display name for this space. + +#### Inherited from + +[Space](client._internal_namespace.Space.md).[name](client._internal_namespace.Space.md#name) + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:15 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetTagsArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetTagsArgs.md new file mode 100644 index 0000000000000..31088513fe67f --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetTagsArgs.md @@ -0,0 +1,32 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetTagsArgs + +# Interface: GetTagsArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetTagsArgs + +## Table of contents + +### Properties + +- [filter](client._internal_namespace.GetTagsArgs.md#filter) +- [unsecuredSavedObjectsClient](client._internal_namespace.GetTagsArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### filter + +• `Optional` **filter**: `KueryNode` + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:129](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L129) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:128](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L128) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetUserActionItemByDifference.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetUserActionItemByDifference.md new file mode 100644 index 0000000000000..50f9ae9a6fc34 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetUserActionItemByDifference.md @@ -0,0 +1,162 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetUserActionItemByDifference + +# Interface: GetUserActionItemByDifference + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetUserActionItemByDifference + +## Hierarchy + +- [`CommonUserActionArgs`](../modules/client._internal_namespace.md#commonuseractionargs) + + ↳ **`GetUserActionItemByDifference`** + +## Table of contents + +### Properties + +- [action](client._internal_namespace.GetUserActionItemByDifference.md#action) +- [attachmentId](client._internal_namespace.GetUserActionItemByDifference.md#attachmentid) +- [caseId](client._internal_namespace.GetUserActionItemByDifference.md#caseid) +- [connectorId](client._internal_namespace.GetUserActionItemByDifference.md#connectorid) +- [field](client._internal_namespace.GetUserActionItemByDifference.md#field) +- [newValue](client._internal_namespace.GetUserActionItemByDifference.md#newvalue) +- [originalValue](client._internal_namespace.GetUserActionItemByDifference.md#originalvalue) +- [owner](client._internal_namespace.GetUserActionItemByDifference.md#owner) +- [unsecuredSavedObjectsClient](client._internal_namespace.GetUserActionItemByDifference.md#unsecuredsavedobjectsclient) +- [user](client._internal_namespace.GetUserActionItemByDifference.md#user) + +## Properties + +### action + +• `Optional` **action**: ``"add"`` \| ``"create"`` \| ``"delete"`` \| ``"update"`` \| ``"push_to_service"`` + +#### Inherited from + +CommonUserActionArgs.action + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:80](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L80) + +___ + +### attachmentId + +• `Optional` **attachmentId**: `string` + +#### Inherited from + +CommonUserActionArgs.attachmentId + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:78](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L78) + +___ + +### caseId + +• **caseId**: `string` + +#### Inherited from + +CommonUserActionArgs.caseId + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:76](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L76) + +___ + +### connectorId + +• `Optional` **connectorId**: `string` + +#### Inherited from + +CommonUserActionArgs.connectorId + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:79](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L79) + +___ + +### field + +• **field**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:83](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L83) + +___ + +### newValue + +• **newValue**: `unknown` + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:85](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L85) + +___ + +### originalValue + +• **originalValue**: `unknown` + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:84](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L84) + +___ + +### owner + +• **owner**: `string` + +#### Inherited from + +CommonUserActionArgs.owner + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:77](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L77) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +CommonUserActionArgs.unsecuredSavedObjectsClient + +#### Defined in + +[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) + +___ + +### user + +• **user**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `email` | `undefined` \| ``null`` \| `string` | +| `full_name` | `undefined` \| ``null`` \| `string` | +| `username` | `undefined` \| ``null`` \| `string` | + +#### Inherited from + +CommonUserActionArgs.user + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:75](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L75) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetUserArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetUserArgs.md new file mode 100644 index 0000000000000..d4913925ff206 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.GetUserArgs.md @@ -0,0 +1,21 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / GetUserArgs + +# Interface: GetUserArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).GetUserArgs + +## Table of contents + +### Properties + +- [request](client._internal_namespace.GetUserArgs.md#request) + +## Properties + +### request + +• **request**: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:110](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L110) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IEventLogger.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IEventLogger.md new file mode 100644 index 0000000000000..a1b44e51859d4 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IEventLogger.md @@ -0,0 +1,73 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / IEventLogger + +# Interface: IEventLogger + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).IEventLogger + +## Table of contents + +### Methods + +- [logEvent](client._internal_namespace.IEventLogger.md#logevent) +- [startTiming](client._internal_namespace.IEventLogger.md#starttiming) +- [stopTiming](client._internal_namespace.IEventLogger.md#stoptiming) + +## Methods + +### logEvent + +▸ **logEvent**(`properties`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `properties` | [`IEvent`](../modules/client._internal_namespace.md#ievent) | + +#### Returns + +`void` + +#### Defined in + +x-pack/plugins/event_log/target/types/server/types.d.ts:34 + +___ + +### startTiming + +▸ **startTiming**(`event`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | [`IEvent`](../modules/client._internal_namespace.md#ievent) | + +#### Returns + +`void` + +#### Defined in + +x-pack/plugins/event_log/target/types/server/types.d.ts:35 + +___ + +### stopTiming + +▸ **stopTiming**(`event`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | [`IEvent`](../modules/client._internal_namespace.md#ievent) | + +#### Returns + +`void` + +#### Defined in + +x-pack/plugins/event_log/target/types/server/types.d.ts:36 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IKibanaSocket.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IKibanaSocket.md new file mode 100644 index 0000000000000..cc2ea54f3975a --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IKibanaSocket.md @@ -0,0 +1,150 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / IKibanaSocket + +# Interface: IKibanaSocket + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).IKibanaSocket + +A tiny abstraction for TCP socket. + +## Table of contents + +### Properties + +- [authorizationError](client._internal_namespace.IKibanaSocket.md#authorizationerror) +- [authorized](client._internal_namespace.IKibanaSocket.md#authorized) + +### Methods + +- [getPeerCertificate](client._internal_namespace.IKibanaSocket.md#getpeercertificate) +- [getProtocol](client._internal_namespace.IKibanaSocket.md#getprotocol) +- [renegotiate](client._internal_namespace.IKibanaSocket.md#renegotiate) + +## Properties + +### authorizationError + +• `Optional` `Readonly` **authorizationError**: `Error` + +The reason why the peer's certificate has not been verified. This property becomes available +only when `authorized` is `false`. + +#### Defined in + +src/core/target/types/server/http/router/socket.d.ts:45 + +___ + +### authorized + +• `Optional` `Readonly` **authorized**: `boolean` + +Indicates whether or not the peer certificate was signed by one of the specified CAs. When TLS +isn't used the value is `undefined`. + +#### Defined in + +src/core/target/types/server/http/router/socket.d.ts:40 + +## Methods + +### getPeerCertificate + +▸ **getPeerCertificate**(`detailed`): ``null`` \| `DetailedPeerCertificate` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `detailed` | ``true`` | + +#### Returns + +``null`` \| `DetailedPeerCertificate` + +#### Defined in + +src/core/target/types/server/http/router/socket.d.ts:9 + +▸ **getPeerCertificate**(`detailed`): ``null`` \| `PeerCertificate` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `detailed` | ``false`` | + +#### Returns + +``null`` \| `PeerCertificate` + +#### Defined in + +src/core/target/types/server/http/router/socket.d.ts:10 + +▸ **getPeerCertificate**(`detailed?`): ``null`` \| `DetailedPeerCertificate` \| `PeerCertificate` + +Returns an object representing the peer's certificate. +The returned object has some properties corresponding to the field of the certificate. +If detailed argument is true the full chain with issuer property will be returned, +if false only the top certificate without issuer property. +If the peer does not provide a certificate, it returns null. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `detailed?` | `boolean` | If true; the full chain with issuer property will be returned. | + +#### Returns + +``null`` \| `DetailedPeerCertificate` \| `PeerCertificate` + +An object representing the peer's certificate. + +#### Defined in + +src/core/target/types/server/http/router/socket.d.ts:20 + +___ + +### getProtocol + +▸ **getProtocol**(): ``null`` \| `string` + +Returns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for +connected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected +client sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_get_version.html for more information. + +#### Returns + +``null`` \| `string` + +#### Defined in + +src/core/target/types/server/http/router/socket.d.ts:26 + +___ + +### renegotiate + +▸ **renegotiate**(`options`): `Promise`<`void`\> + +Renegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `options` | `Object` | The options may contain the following fields: rejectUnauthorized, requestCert (See tls.createServer() for details). | +| `options.rejectUnauthorized?` | `boolean` | - | +| `options.requestCert?` | `boolean` | - | + +#### Returns + +`Promise`<`void`\> + +A Promise that will be resolved if renegotiation succeeded, or will be rejected if renegotiation failed. + +#### Defined in + +src/core/target/types/server/http/router/socket.d.ts:32 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ILicense.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ILicense.md new file mode 100644 index 0000000000000..8449411b85e42 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ILicense.md @@ -0,0 +1,236 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ILicense + +# Interface: ILicense + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ILicense + +## Table of contents + +### Properties + +- [error](client._internal_namespace.ILicense.md#error) +- [expiryDateInMillis](client._internal_namespace.ILicense.md#expirydateinmillis) +- [isActive](client._internal_namespace.ILicense.md#isactive) +- [isAvailable](client._internal_namespace.ILicense.md#isavailable) +- [mode](client._internal_namespace.ILicense.md#mode) +- [signature](client._internal_namespace.ILicense.md#signature) +- [status](client._internal_namespace.ILicense.md#status) +- [type](client._internal_namespace.ILicense.md#type) +- [uid](client._internal_namespace.ILicense.md#uid) + +### Methods + +- [check](client._internal_namespace.ILicense.md#check) +- [getFeature](client._internal_namespace.ILicense.md#getfeature) +- [getUnavailableReason](client._internal_namespace.ILicense.md#getunavailablereason) +- [hasAtLeast](client._internal_namespace.ILicense.md#hasatleast) +- [toJSON](client._internal_namespace.ILicense.md#tojson) + +## Properties + +### error + +• `Optional` **error**: `string` + +A potential error denoting the failure of the license from being retrieved. + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:119 + +___ + +### expiryDateInMillis + +• `Optional` **expiryDateInMillis**: `number` + +Unix epoch of the expiration date of the license. + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:94 + +___ + +### isActive + +• **isActive**: `boolean` + +Determine if the status of the license is active. + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:90 + +___ + +### isAvailable + +• **isAvailable**: `boolean` + +Determine if the license container has information. + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:111 + +___ + +### mode + +• `Optional` **mode**: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` + +The license type, being usually one of basic, standard, gold, platinum, or trial. + +**`deprecated`** use 'type' instead. + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:103 + +___ + +### signature + +• **signature**: `string` + +Signature of the license content. + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:107 + +___ + +### status + +• `Optional` **status**: [`LicenseStatus`](../modules/client._internal_namespace.md#licensestatus) + +The validity status of the license. + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:86 + +___ + +### type + +• `Optional` **type**: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` + +The license type, being usually one of basic, standard, gold, platinum, or trial. + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:98 + +___ + +### uid + +• `Optional` **uid**: `string` + +UID for license. + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:82 + +## Methods + +### check + +▸ **check**(`pluginName`, `minimumLicenseRequired`): [`LicenseCheck`](client._internal_namespace.LicenseCheck.md) + +For a given plugin and license type, receive information about the status of the license. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `pluginName` | `string` | the name of the plugin | +| `minimumLicenseRequired` | ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` | the minimum valid license for operating the given plugin | + +#### Returns + +[`LicenseCheck`](client._internal_namespace.LicenseCheck.md) + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:134 + +___ + +### getFeature + +▸ **getFeature**(`name`): [`LicenseFeature`](client._internal_namespace.LicenseFeature.md) + +A specific API for interacting with the specific features of the license. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `name` | `string` | the name of the feature to interact with | + +#### Returns + +[`LicenseFeature`](client._internal_namespace.LicenseFeature.md) + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:139 + +___ + +### getUnavailableReason + +▸ **getUnavailableReason**(): `undefined` \| `string` + +If the license is not available, provides a string or Error containing the reason. + +#### Returns + +`undefined` \| `string` + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:123 + +___ + +### hasAtLeast + +▸ **hasAtLeast**(`minimumLicenseRequired`): `boolean` + +Determine if license type >= minimal required license type. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `minimumLicenseRequired` | ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` | the minimum valid license required for the given feature | + +#### Returns + +`boolean` + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:128 + +___ + +### toJSON + +▸ **toJSON**(): [`PublicLicenseJSON`](client._internal_namespace.PublicLicenseJSON.md) + +Returns + +#### Returns + +[`PublicLicenseJSON`](client._internal_namespace.PublicLicenseJSON.md) + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:115 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md new file mode 100644 index 0000000000000..17a5e67c8b2b6 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md @@ -0,0 +1,61 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ISavedObjectsPointInTimeFinder + +# Interface: ISavedObjectsPointInTimeFinder + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ISavedObjectsPointInTimeFinder + +## Type parameters + +| Name | +| :------ | +| `T` | +| `A` | + +## Table of contents + +### Methods + +- [close](client._internal_namespace.ISavedObjectsPointInTimeFinder.md#close) +- [find](client._internal_namespace.ISavedObjectsPointInTimeFinder.md#find) + +## Methods + +### close + +▸ **close**(): `Promise`<`void`\> + +Closes the Point-In-Time associated with this finder instance. + +Once you have retrieved all of the results you need, it is recommended +to call `close()` to clean up the PIT and prevent Elasticsearch from +consuming resources unnecessarily. This is only required if you are +done iterating and have not yet paged through all of the results: the +PIT will automatically be closed for you once you reach the last page +of results, or if the underlying call to `find` fails for any reason. + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/point_in_time_finder.d.ts:43 + +___ + +### find + +▸ **find**(): `AsyncGenerator`<[`SavedObjectsFindResponse`](client._internal_namespace.SavedObjectsFindResponse.md)<`T`, `A`\>, `any`, `unknown`\> + +An async generator which wraps calls to `savedObjectsClient.find` and +iterates over multiple pages of results using `_pit` and `search_after`. +This will open a new Point-In-Time (PIT), and continue paging until a set +of results is received that's smaller than the designated `perPage` size. + +#### Returns + +`AsyncGenerator`<[`SavedObjectsFindResponse`](client._internal_namespace.SavedObjectsFindResponse.md)<`T`, `A`\>, `any`, `unknown`\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/point_in_time_finder.d.ts:32 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IScopedClusterClient.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IScopedClusterClient.md new file mode 100644 index 0000000000000..47f8263232290 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IScopedClusterClient.md @@ -0,0 +1,43 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / IScopedClusterClient + +# Interface: IScopedClusterClient + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).IScopedClusterClient + +Serves the same purpose as the normal {@link IClusterClient | cluster client} but exposes +an additional `asCurrentUser` method that doesn't use credentials of the Kibana internal +user (as `asInternalUser` does) to request Elasticsearch API, but rather passes HTTP headers +extracted from the current user request to the API instead. + +## Table of contents + +### Properties + +- [asCurrentUser](client._internal_namespace.IScopedClusterClient.md#ascurrentuser) +- [asInternalUser](client._internal_namespace.IScopedClusterClient.md#asinternaluser) + +## Properties + +### asCurrentUser + +• `Readonly` **asCurrentUser**: [`ElasticsearchClient`](../modules/client._internal_namespace.md#elasticsearchclient) + +A [client](../modules/client._internal_namespace.md#elasticsearchclient) to be used to query the elasticsearch cluster +on behalf of the user that initiated the request to the Kibana server. + +#### Defined in + +src/core/target/types/server/elasticsearch/client/scoped_cluster_client.d.ts:20 + +___ + +### asInternalUser + +• `Readonly` **asInternalUser**: [`ElasticsearchClient`](../modules/client._internal_namespace.md#elasticsearchclient) + +A [client](../modules/client._internal_namespace.md#elasticsearchclient) to be used to query the elasticsearch cluster +on behalf of the internal Kibana user. + +#### Defined in + +src/core/target/types/server/elasticsearch/client/scoped_cluster_client.d.ts:15 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ISpacesClient.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ISpacesClient.md new file mode 100644 index 0000000000000..5b7aab2435b5a --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ISpacesClient.md @@ -0,0 +1,151 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ISpacesClient + +# Interface: ISpacesClient + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ISpacesClient + +Client interface for interacting with spaces. + +## Table of contents + +### Methods + +- [create](client._internal_namespace.ISpacesClient.md#create) +- [delete](client._internal_namespace.ISpacesClient.md#delete) +- [disableLegacyUrlAliases](client._internal_namespace.ISpacesClient.md#disablelegacyurlaliases) +- [get](client._internal_namespace.ISpacesClient.md#get) +- [getAll](client._internal_namespace.ISpacesClient.md#getall) +- [update](client._internal_namespace.ISpacesClient.md#update) + +## Methods + +### create + +▸ **create**(`space`): `Promise`<[`Space`](client._internal_namespace.Space.md)\> + +Creates a space. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `space` | [`Space`](client._internal_namespace.Space.md) | the space to create. | + +#### Returns + +`Promise`<[`Space`](client._internal_namespace.Space.md)\> + +#### Defined in + +x-pack/plugins/spaces/target/types/server/spaces_client/spaces_client.d.ts:22 + +___ + +### delete + +▸ **delete**(`id`): `Promise`<`void`\> + +Deletes a space, and all saved objects belonging to that space. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | the id of the space to delete. | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +x-pack/plugins/spaces/target/types/server/spaces_client/spaces_client.d.ts:33 + +___ + +### disableLegacyUrlAliases + +▸ **disableLegacyUrlAliases**(`aliases`): `Promise`<`void`\> + +Disables the specified legacy URL aliases. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `aliases` | [`LegacyUrlAliasTarget`](client._internal_namespace.LegacyUrlAliasTarget.md)[] | the aliases to disable. | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +x-pack/plugins/spaces/target/types/server/spaces_client/spaces_client.d.ts:38 + +___ + +### get + +▸ **get**(`id`): `Promise`<[`Space`](client._internal_namespace.Space.md)\> + +Retrieve a space by its id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | the space id. | + +#### Returns + +`Promise`<[`Space`](client._internal_namespace.Space.md)\> + +#### Defined in + +x-pack/plugins/spaces/target/types/server/spaces_client/spaces_client.d.ts:17 + +___ + +### getAll + +▸ **getAll**(`options?`): `Promise`<[`GetSpaceResult`](client._internal_namespace.GetSpaceResult.md)[]\> + +Retrieve all available spaces. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `options?` | [`GetAllSpacesOptions`](client._internal_namespace.GetAllSpacesOptions.md) | controls which spaces are retrieved. | + +#### Returns + +`Promise`<[`GetSpaceResult`](client._internal_namespace.GetSpaceResult.md)[]\> + +#### Defined in + +x-pack/plugins/spaces/target/types/server/spaces_client/spaces_client.d.ts:12 + +___ + +### update + +▸ **update**(`id`, `space`): `Promise`<[`Space`](client._internal_namespace.Space.md)\> + +Updates a space. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | the id of the space to update. | +| `space` | [`Space`](client._internal_namespace.Space.md) | the updated space. | + +#### Returns + +`Promise`<[`Space`](client._internal_namespace.Space.md)\> + +#### Defined in + +x-pack/plugins/spaces/target/types/server/spaces_client/spaces_client.d.ts:28 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IUsageCounter.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IUsageCounter.md new file mode 100644 index 0000000000000..9ed76ff78e51b --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IUsageCounter.md @@ -0,0 +1,37 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / IUsageCounter + +# Interface: IUsageCounter + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).IUsageCounter + +Usage Counter allows to keep track of any events that occur. +By calling [IUsageCounter.incrementCounter](client._internal_namespace.IUsageCounter.md#incrementcounter) devs can notify this +API whenever the event happens. + +## Table of contents + +### Methods + +- [incrementCounter](client._internal_namespace.IUsageCounter.md#incrementcounter) + +## Methods + +### incrementCounter + +▸ **incrementCounter**(`params`): `void` + +Notifies the counter about a new event happening so it can increase the count internally. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `params` | [`IncrementCounterParams`](client._internal_namespace.IncrementCounterParams.md) | [IncrementCounterParams](client._internal_namespace.IncrementCounterParams.md) | + +#### Returns + +`void` + +#### Defined in + +src/plugins/usage_collection/target/types/server/usage_counters/usage_counter.d.ts:33 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IncrementCounterParams.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IncrementCounterParams.md new file mode 100644 index 0000000000000..0c79f0d867cdc --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IncrementCounterParams.md @@ -0,0 +1,51 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / IncrementCounterParams + +# Interface: IncrementCounterParams + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).IncrementCounterParams + +Details about the counter to be incremented + +## Table of contents + +### Properties + +- [counterName](client._internal_namespace.IncrementCounterParams.md#countername) +- [counterType](client._internal_namespace.IncrementCounterParams.md#countertype) +- [incrementBy](client._internal_namespace.IncrementCounterParams.md#incrementby) + +## Properties + +### counterName + +• **counterName**: `string` + +The name of the counter + +#### Defined in + +src/plugins/usage_collection/target/types/server/usage_counters/usage_counter.d.ts:17 + +___ + +### counterType + +• `Optional` **counterType**: `string` + +The counter type ("count" by default) + +#### Defined in + +src/plugins/usage_collection/target/types/server/usage_counters/usage_counter.d.ts:19 + +___ + +### incrementBy + +• `Optional` **incrementBy**: `number` + +Increment the counter by this number (1 if not specified) + +#### Defined in + +src/plugins/usage_collection/target/types/server/usage_counters/usage_counter.d.ts:21 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IndexMapping.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IndexMapping.md new file mode 100644 index 0000000000000..71cfddb7c8981 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IndexMapping.md @@ -0,0 +1,45 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / IndexMapping + +# Interface: IndexMapping + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).IndexMapping + +**`internal`** + +## Table of contents + +### Properties + +- [\_meta](client._internal_namespace.IndexMapping.md#_meta) +- [dynamic](client._internal_namespace.IndexMapping.md#dynamic) +- [properties](client._internal_namespace.IndexMapping.md#properties) + +## Properties + +### \_meta + +• `Optional` **\_meta**: [`IndexMappingMeta`](client._internal_namespace.IndexMappingMeta.md) + +#### Defined in + +src/core/target/types/server/saved_objects/mappings/types.d.ts:104 + +___ + +### dynamic + +• `Optional` **dynamic**: `boolean` \| ``"strict"`` + +#### Defined in + +src/core/target/types/server/saved_objects/mappings/types.d.ts:102 + +___ + +### properties + +• **properties**: [`SavedObjectsMappingProperties`](client._internal_namespace.SavedObjectsMappingProperties.md) + +#### Defined in + +src/core/target/types/server/saved_objects/mappings/types.d.ts:103 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IndexMappingMeta.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IndexMappingMeta.md new file mode 100644 index 0000000000000..de9e76ae00099 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IndexMappingMeta.md @@ -0,0 +1,27 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / IndexMappingMeta + +# Interface: IndexMappingMeta + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).IndexMappingMeta + +**`internal`** + +## Table of contents + +### Properties + +- [migrationMappingPropertyHashes](client._internal_namespace.IndexMappingMeta.md#migrationmappingpropertyhashes) + +## Properties + +### migrationMappingPropertyHashes + +• `Optional` **migrationMappingPropertyHashes**: `Object` + +#### Index signature + +▪ [k: `string`]: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/mappings/types.d.ts:108 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IntervalSchedule.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IntervalSchedule.md new file mode 100644 index 0000000000000..365dfd5f7dfdf --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.IntervalSchedule.md @@ -0,0 +1,23 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / IntervalSchedule + +# Interface: IntervalSchedule + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).IntervalSchedule + +## Table of contents + +### Properties + +- [interval](client._internal_namespace.IntervalSchedule.md#interval) + +## Properties + +### interval + +• **interval**: `string` + +An interval in minutes (e.g. '5m'). If specified, this is a recurring task. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:137 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaFeatureConfig.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaFeatureConfig.md new file mode 100644 index 0000000000000..2013e42ad5bf2 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaFeatureConfig.md @@ -0,0 +1,257 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / KibanaFeatureConfig + +# Interface: KibanaFeatureConfig + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).KibanaFeatureConfig + +Interface for registering a feature. +Feature registration allows plugins to hide their applications with spaces, +and secure access when configured for security. + +## Table of contents + +### Properties + +- [alerting](client._internal_namespace.KibanaFeatureConfig.md#alerting) +- [app](client._internal_namespace.KibanaFeatureConfig.md#app) +- [cases](client._internal_namespace.KibanaFeatureConfig.md#cases) +- [catalogue](client._internal_namespace.KibanaFeatureConfig.md#catalogue) +- [category](client._internal_namespace.KibanaFeatureConfig.md#category) +- [excludeFromBasePrivileges](client._internal_namespace.KibanaFeatureConfig.md#excludefrombaseprivileges) +- [id](client._internal_namespace.KibanaFeatureConfig.md#id) +- [management](client._internal_namespace.KibanaFeatureConfig.md#management) +- [minimumLicense](client._internal_namespace.KibanaFeatureConfig.md#minimumlicense) +- [name](client._internal_namespace.KibanaFeatureConfig.md#name) +- [order](client._internal_namespace.KibanaFeatureConfig.md#order) +- [privileges](client._internal_namespace.KibanaFeatureConfig.md#privileges) +- [privilegesTooltip](client._internal_namespace.KibanaFeatureConfig.md#privilegestooltip) +- [reserved](client._internal_namespace.KibanaFeatureConfig.md#reserved) +- [subFeatures](client._internal_namespace.KibanaFeatureConfig.md#subfeatures) + +## Properties + +### alerting + +• `Optional` **alerting**: readonly `string`[] + +If your feature grants access to specific Alert Types, you can specify them here to control visibility based on the current space. +Include both Alert Types registered by the feature and external Alert Types such as built-in +Alert Types and Alert Types provided by other features to which you wish to grant access. + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:83 + +___ + +### app + +• **app**: readonly `string`[] + +An array of app ids that are enabled when this feature is enabled. +Apps specified here will automatically cascade to the privileges defined below, unless specified differently there. + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:54 + +___ + +### cases + +• `Optional` **cases**: readonly `string`[] + +If your feature grants access to specific case types, you can specify them here to control visibility based on the current space. + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:87 + +___ + +### catalogue + +• `Optional` **catalogue**: readonly `string`[] + +If this feature includes a catalogue entry, you can specify them here to control visibility based on the current space. + +Items specified here will automatically cascade to the privileges defined below, unless specified differently there. + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:77 + +___ + +### category + +• **category**: [`AppCategory`](client._internal_namespace.AppCategory.md) + +The category for this feature. +This will be used to organize the list of features for display within the +Spaces and Roles management screens. + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:30 + +___ + +### excludeFromBasePrivileges + +• `Optional` **excludeFromBasePrivileges**: `boolean` + +Whether or not this feature should be excluded from the base privileges. +This is primarily helpful when migrating applications with a "legacy" privileges model +to use Kibana privileges. We don't want these features to be considered part of the `all` +or `read` base privileges in a minor release if the user was previously granted access +using an additional reserved role. + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:42 + +___ + +### id + +• **id**: `string` + +Unique identifier for this feature. +This identifier is also used when generating UI Capabilities. + +**`see`** UICapabilities + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:19 + +___ + +### management + +• `Optional` **management**: `Object` + +If this feature includes management sections, you can specify them here to control visibility of those +pages based on the current space. + +Items specified here will automatically cascade to the privileges defined below, unless specified differently there. + +**`example`** +```ts + // Enables access to the "Advanced Settings" management page within the Kibana section + management: { + kibana: ['settings'] + } +``` + +#### Index signature + +▪ [sectionId: `string`]: readonly `string`[] + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:69 + +___ + +### minimumLicense + +• `Optional` **minimumLicense**: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` + +Optional minimum supported license. +If omitted, all licenses are allowed. +This does not restrict access to your feature based on license. +Its only purpose is to inform the space and roles UIs on which features to display. + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:49 + +___ + +### name + +• **name**: `string` + +Display name for this feature. +This will be displayed to end-users, so a translatable string is advised for i18n. + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:24 + +___ + +### order + +• `Optional` **order**: `number` + +An ordinal used to sort features relative to one another for display. + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:34 + +___ + +### privileges + +• **privileges**: ``null`` \| { `all`: [`FeatureKibanaPrivileges`](client._internal_namespace.FeatureKibanaPrivileges.md) ; `read`: [`FeatureKibanaPrivileges`](client._internal_namespace.FeatureKibanaPrivileges.md) } + +Feature privilege definition. + +**`example`** +```ts + { + all: {...}, + read: {...} + } +``` + +**`see`** FeatureKibanaPrivileges + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:100 + +___ + +### privilegesTooltip + +• `Optional` **privilegesTooltip**: `string` + +Optional message to display on the Role Management screen when configuring permissions for this feature. + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:111 + +___ + +### reserved + +• `Optional` `Private` **reserved**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `description` | `string` | +| `privileges` | readonly [`ReservedKibanaPrivilege`](client._internal_namespace.ReservedKibanaPrivilege.md)[] | + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:115 + +___ + +### subFeatures + +• `Optional` **subFeatures**: readonly [`SubFeatureConfig`](client._internal_namespace.SubFeatureConfig.md)[] + +Optional sub-feature privilege definitions. This can only be specified if `privileges` are are also defined. + +#### Defined in + +x-pack/plugins/features/target/types/common/kibana_feature.d.ts:107 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaMigratorOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaMigratorOptions.md new file mode 100644 index 0000000000000..1b316e68c5771 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaMigratorOptions.md @@ -0,0 +1,76 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / KibanaMigratorOptions + +# Interface: KibanaMigratorOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).KibanaMigratorOptions + +## Table of contents + +### Properties + +- [client](client._internal_namespace.KibanaMigratorOptions.md#client) +- [kibanaIndex](client._internal_namespace.KibanaMigratorOptions.md#kibanaindex) +- [kibanaVersion](client._internal_namespace.KibanaMigratorOptions.md#kibanaversion) +- [logger](client._internal_namespace.KibanaMigratorOptions.md#logger) +- [soMigrationsConfig](client._internal_namespace.KibanaMigratorOptions.md#somigrationsconfig) +- [typeRegistry](client._internal_namespace.KibanaMigratorOptions.md#typeregistry) + +## Properties + +### client + +• **client**: [`ElasticsearchClient`](../modules/client._internal_namespace.md#elasticsearchclient) + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:10 + +___ + +### kibanaIndex + +• **kibanaIndex**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:13 + +___ + +### kibanaVersion + +• **kibanaVersion**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:14 + +___ + +### logger + +• **logger**: `Logger` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:15 + +___ + +### soMigrationsConfig + +• **soMigrationsConfig**: `Readonly`<{} & { `batchSize`: `number` ; `maxBatchSizeBytes`: `ByteSizeValue` ; `pollInterval`: `number` ; `retryAttempts`: `number` ; `scrollDuration`: `string` ; `skip`: `boolean` }\> + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:12 + +___ + +### typeRegistry + +• **typeRegistry**: [`ISavedObjectTypeRegistry`](../modules/client._internal_namespace.md#isavedobjecttyperegistry) + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:11 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaMigratorStatus.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaMigratorStatus.md new file mode 100644 index 0000000000000..21bba02200fa4 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaMigratorStatus.md @@ -0,0 +1,43 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / KibanaMigratorStatus + +# Interface: KibanaMigratorStatus + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).KibanaMigratorStatus + +## Table of contents + +### Properties + +- [result](client._internal_namespace.KibanaMigratorStatus.md#result) +- [status](client._internal_namespace.KibanaMigratorStatus.md#status) +- [waitingIndex](client._internal_namespace.KibanaMigratorStatus.md#waitingindex) + +## Properties + +### result + +• `Optional` **result**: [`MigrationResult`](../modules/client._internal_namespace.md#migrationresult)[] + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:20 + +___ + +### status + +• **status**: [`MigrationStatus`](../modules/client._internal_namespace.md#migrationstatus) + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:19 + +___ + +### waitingIndex + +• `Optional` **waitingIndex**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:21 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaRequestEvents.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaRequestEvents.md new file mode 100644 index 0000000000000..c4b610af9ba99 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.KibanaRequestEvents.md @@ -0,0 +1,43 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / KibanaRequestEvents + +# Interface: KibanaRequestEvents + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).KibanaRequestEvents + +Request events. + +## Table of contents + +### Properties + +- [aborted$](client._internal_namespace.KibanaRequestEvents.md#aborted$) +- [completed$](client._internal_namespace.KibanaRequestEvents.md#completed$) + +## Properties + +### aborted$ + +• **aborted$**: `Observable`<`void`\> + +Observable that emits once if and when the request has been aborted. + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:48 + +___ + +### completed$ + +• **completed$**: `Observable`<`void`\> + +Observable that emits once if and when the request has been completely handled. + +**`remarks`** +The request may be considered completed if: +- A response has been sent to the client; or +- The request was aborted. + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:57 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LegacyUrlAliasTarget.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LegacyUrlAliasTarget.md new file mode 100644 index 0000000000000..1580adc5c3127 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LegacyUrlAliasTarget.md @@ -0,0 +1,51 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / LegacyUrlAliasTarget + +# Interface: LegacyUrlAliasTarget + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).LegacyUrlAliasTarget + +Client interface for interacting with legacy URL aliases. + +## Table of contents + +### Properties + +- [sourceId](client._internal_namespace.LegacyUrlAliasTarget.md#sourceid) +- [targetSpace](client._internal_namespace.LegacyUrlAliasTarget.md#targetspace) +- [targetType](client._internal_namespace.LegacyUrlAliasTarget.md#targettype) + +## Properties + +### sourceId + +• **sourceId**: `string` + +The original ID of the object, before it was converted. + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:99 + +___ + +### targetSpace + +• **targetSpace**: `string` + +The namespace that the object existed in when it was converted. + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:91 + +___ + +### targetType + +• **targetType**: `string` + +The type of the object when it was converted. + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:95 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicenseCheck.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicenseCheck.md new file mode 100644 index 0000000000000..084c5ae23607e --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicenseCheck.md @@ -0,0 +1,36 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / LicenseCheck + +# Interface: LicenseCheck + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).LicenseCheck + +## Table of contents + +### Properties + +- [message](client._internal_namespace.LicenseCheck.md#message) +- [state](client._internal_namespace.LicenseCheck.md#state) + +## Properties + +### message + +• `Optional` **message**: `string` + +A message containing the reason for a license type not being valid. + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:75 + +___ + +### state + +• **state**: [`LicenseCheckState`](../modules/client._internal_namespace.md#licensecheckstate) + +The state of checking the results of a license type meeting the license minimum. + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:71 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicenseFeature.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicenseFeature.md new file mode 100644 index 0000000000000..e6794cd50d933 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicenseFeature.md @@ -0,0 +1,32 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / LicenseFeature + +# Interface: LicenseFeature + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).LicenseFeature + +## Table of contents + +### Properties + +- [isAvailable](client._internal_namespace.LicenseFeature.md#isavailable) +- [isEnabled](client._internal_namespace.LicenseFeature.md#isenabled) + +## Properties + +### isAvailable + +• **isAvailable**: `boolean` + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:16 + +___ + +### isEnabled + +• **isEnabled**: `boolean` + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:17 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicensingPluginSetup.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicensingPluginSetup.md new file mode 100644 index 0000000000000..240dbd27ad2fc --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.LicensingPluginSetup.md @@ -0,0 +1,60 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / LicensingPluginSetup + +# Interface: LicensingPluginSetup + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).LicensingPluginSetup + +## Table of contents + +### Properties + +- [featureUsage](client._internal_namespace.LicensingPluginSetup.md#featureusage) +- [license$](client._internal_namespace.LicensingPluginSetup.md#license$) + +### Methods + +- [refresh](client._internal_namespace.LicensingPluginSetup.md#refresh) + +## Properties + +### featureUsage + +• **featureUsage**: [`FeatureUsageServiceSetup`](client._internal_namespace.FeatureUsageServiceSetup.md) + +APIs to register licensed feature usage. + +#### Defined in + +x-pack/plugins/licensing/target/types/server/types.d.ts:49 + +___ + +### license$ + +• **license$**: `Observable`<[`ILicense`](client._internal_namespace.ILicense.md)\> + +Steam of licensing information [ILicense](client._internal_namespace.ILicense.md). + +**`deprecated`** in favour of the counterpart provided from start contract + +#### Defined in + +x-pack/plugins/licensing/target/types/server/types.d.ts:40 + +## Methods + +### refresh + +▸ **refresh**(): `Promise`<[`ILicense`](client._internal_namespace.ILicense.md)\> + +Triggers licensing information re-fetch. + +**`deprecated`** in favour of the counterpart provided from start contract + +#### Returns + +`Promise`<[`ILicense`](client._internal_namespace.ILicense.md)\> + +#### Defined in + +x-pack/plugins/licensing/target/types/server/types.d.ts:45 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Middleware.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Middleware.md new file mode 100644 index 0000000000000..0a6d5169b4278 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Middleware.md @@ -0,0 +1,43 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Middleware + +# Interface: Middleware + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Middleware + +## Table of contents + +### Properties + +- [beforeMarkRunning](client._internal_namespace.Middleware.md#beforemarkrunning) +- [beforeRun](client._internal_namespace.Middleware.md#beforerun) +- [beforeSave](client._internal_namespace.Middleware.md#beforesave) + +## Properties + +### beforeMarkRunning + +• **beforeMarkRunning**: [`BeforeRunContextFunction`](../modules/client._internal_namespace.md#beforeruncontextfunction) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/lib/middleware.d.ts:11 + +___ + +### beforeRun + +• **beforeRun**: [`BeforeRunContextFunction`](../modules/client._internal_namespace.md#beforeruncontextfunction) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/lib/middleware.d.ts:10 + +___ + +### beforeSave + +• **beforeSave**: [`BeforeSaveContextFunction`](../modules/client._internal_namespace.md#beforesavecontextfunction) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/lib/middleware.d.ts:9 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.OperationDetails.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.OperationDetails.md new file mode 100644 index 0000000000000..a7e428f943d05 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.OperationDetails.md @@ -0,0 +1,91 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / OperationDetails + +# Interface: OperationDetails + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).OperationDetails + +Defines the structure for a case API route. + +## Table of contents + +### Properties + +- [action](client._internal_namespace.OperationDetails.md#action) +- [docType](client._internal_namespace.OperationDetails.md#doctype) +- [ecsType](client._internal_namespace.OperationDetails.md#ecstype) +- [name](client._internal_namespace.OperationDetails.md#name) +- [savedObjectType](client._internal_namespace.OperationDetails.md#savedobjecttype) +- [verbs](client._internal_namespace.OperationDetails.md#verbs) + +## Properties + +### action + +• **action**: `string` + +The ECS `event.action` field, should be in the form of _ e.g comment_get, case_fined + +#### Defined in + +[x-pack/plugins/cases/server/authorization/types.ts:83](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L83) + +___ + +### docType + +• **docType**: `string` + +The readable name of the entity being operated on e.g. case, comment, configurations (make it plural if it reads better that way etc) + +#### Defined in + +[x-pack/plugins/cases/server/authorization/types.ts:91](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L91) + +___ + +### ecsType + +• **ecsType**: `EcsEventType` + +The ECS event type that this operation should be audit logged as (creation, deletion, access, etc) + +#### Defined in + +[x-pack/plugins/cases/server/authorization/types.ts:74](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L74) + +___ + +### name + +• **name**: `string` + +The name of the operation to authorize against for the privilege check. +These values need to match one of the operation strings defined here: x-pack/plugins/security/server/authorization/privileges/feature_privilege_builder/cases.ts + +#### Defined in + +[x-pack/plugins/cases/server/authorization/types.ts:79](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L79) + +___ + +### savedObjectType + +• **savedObjectType**: `string` + +The actual saved object type of the entity e.g. cases, cases-comments + +#### Defined in + +[x-pack/plugins/cases/server/authorization/types.ts:95](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L95) + +___ + +### verbs + +• **verbs**: [`Verbs`](client._internal_namespace.Verbs.md) + +The verbs that are associated with this type of operation, these should line up with the event type e.g. creating, created, create etc + +#### Defined in + +[x-pack/plugins/cases/server/authorization/types.ts:87](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L87) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.OwnerEntity.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.OwnerEntity.md new file mode 100644 index 0000000000000..771823c8e9711 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.OwnerEntity.md @@ -0,0 +1,35 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / OwnerEntity + +# Interface: OwnerEntity + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).OwnerEntity + +Describes an entity with the necessary fields to identify if the user is authorized to interact with the saved object +returned from some find query. + +## Table of contents + +### Properties + +- [id](client._internal_namespace.OwnerEntity.md#id) +- [owner](client._internal_namespace.OwnerEntity.md#owner) + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/authorization/types.ts:104](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L104) + +___ + +### owner + +• **owner**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/authorization/types.ts:103](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L103) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCase.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCase.md new file mode 100644 index 0000000000000..39774f46c552f --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCase.md @@ -0,0 +1,54 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PatchCase + +# Interface: PatchCase + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PatchCase + +## Table of contents + +### Properties + +- [caseId](client._internal_namespace.PatchCase.md#caseid) +- [originalCase](client._internal_namespace.PatchCase.md#originalcase) +- [updatedAttributes](client._internal_namespace.PatchCase.md#updatedattributes) +- [version](client._internal_namespace.PatchCase.md#version) + +## Properties + +### caseId + +• **caseId**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:98](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L98) + +___ + +### originalCase + +• **originalCase**: [`SavedObject`](client._internal_namespace.SavedObject.md)<{ `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:100](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L100) + +___ + +### updatedAttributes + +• **updatedAttributes**: `Partial`<{ `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & [`PushedArgs`](client._internal_namespace.PushedArgs.md)\> + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:99](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L99) + +___ + +### version + +• `Optional` **version**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:101](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L101) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCaseConfigureArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCaseConfigureArgs.md new file mode 100644 index 0000000000000..c6909426e1088 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCaseConfigureArgs.md @@ -0,0 +1,64 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PatchCaseConfigureArgs + +# Interface: PatchCaseConfigureArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PatchCaseConfigureArgs + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs.md) + + ↳ **`PatchCaseConfigureArgs`** + +## Table of contents + +### Properties + +- [configurationId](client._internal_namespace.PatchCaseConfigureArgs.md#configurationid) +- [originalConfiguration](client._internal_namespace.PatchCaseConfigureArgs.md#originalconfiguration) +- [unsecuredSavedObjectsClient](client._internal_namespace.PatchCaseConfigureArgs.md#unsecuredsavedobjectsclient) +- [updatedAttributes](client._internal_namespace.PatchCaseConfigureArgs.md#updatedattributes) + +## Properties + +### configurationId + +• **configurationId**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/configure/index.ts:46](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L46) + +___ + +### originalConfiguration + +• **originalConfiguration**: [`SavedObject`](client._internal_namespace.SavedObject.md)<{ `closure_type`: ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt } & { `owner`: `string` = rt.string } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\> + +#### Defined in + +[x-pack/plugins/cases/server/services/configure/index.ts:48](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L48) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/configure/index.ts:30](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L30) + +___ + +### updatedAttributes + +• **updatedAttributes**: `Partial`<{ `closure_type`: ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt } & { `owner`: `string` = rt.string } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\> + +#### Defined in + +[x-pack/plugins/cases/server/services/configure/index.ts:47](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L47) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCasesArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCasesArgs.md new file mode 100644 index 0000000000000..24db998f64f3d --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PatchCasesArgs.md @@ -0,0 +1,42 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PatchCasesArgs + +# Interface: PatchCasesArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PatchCasesArgs + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) + + ↳ **`PatchCasesArgs`** + +## Table of contents + +### Properties + +- [cases](client._internal_namespace.PatchCasesArgs.md#cases) +- [unsecuredSavedObjectsClient](client._internal_namespace.PatchCasesArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### cases + +• **cases**: [`PatchCase`](client._internal_namespace.PatchCase.md)[] + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:106](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L106) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PersistableState.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PersistableState.md new file mode 100644 index 0000000000000..7300cc96a8fd2 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PersistableState.md @@ -0,0 +1,133 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PersistableState + +# Interface: PersistableState + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PersistableState + +Persistable state interface can be implemented by something that persists +(stores) state, for example, in a saved object. Once implemented that thing +will gain ability to "extract" and "inject" saved object references, which +are necessary for various saved object tasks, such as export. It will also be +able to do state migrations across Kibana versions, if the shape of the state +would change over time. + +**`todo`** Maybe rename it to `PersistableStateItem`? + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `P` | extends `SerializableRecord` = `SerializableRecord` | + +## Table of contents + +### Properties + +- [migrations](client._internal_namespace.PersistableState.md#migrations) + +### Methods + +- [extract](client._internal_namespace.PersistableState.md#extract) +- [inject](client._internal_namespace.PersistableState.md#inject) +- [telemetry](client._internal_namespace.PersistableState.md#telemetry) + +## Properties + +### migrations + +• **migrations**: [`MigrateFunctionsObject`](../modules/client._internal_namespace.md#migratefunctionsobject) \| [`GetMigrationFunctionObjectFn`](../modules/client._internal_namespace.md#getmigrationfunctionobjectfn) + +A list of migration functions, which migrate the persistable state +serializable object to the next version. Migration functions should are +keyed by the Kibana version using semver, where the version indicates to +which version the state will be migrated to. + +#### Defined in + +src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:75 + +## Methods + +### extract + +▸ **extract**(`state`): `Object` + +A function which receives state and should return the state with references +extracted and an array of the extracted references. The default case could +simply return the same state with an empty array of references. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `state` | `P` | The persistable state serializable state object. | + +#### Returns + +`Object` + +Persistable state object with references extracted and a list of + references. + +| Name | Type | +| :------ | :------ | +| `references` | [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] | +| `state` | `P` | + +#### Defined in + +src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:65 + +___ + +### inject + +▸ **inject**(`state`, `references`): `P` + +A function which receives state and a list of references and should return +back the state with references injected. The default is an identity +function. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `state` | `P` | The persistable state serializable state object. | +| `references` | [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] | List of saved object references. | + +#### Returns + +`P` + +Persistable state object with references injected. + +#### Defined in + +src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:55 + +___ + +### telemetry + +▸ **telemetry**(`state`, `stats`): `Record`<`string`, `any`\> + +Function which reports telemetry information. This function is essentially +a "reducer" - it receives the existing "stats" object and returns an +updated version of the "stats" object. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `state` | `P` | The persistable state serializable state object. | +| `stats` | `Record`<`string`, `any`\> | Stats object containing the stats which were already collected. This `stats` object shall not be mutated in-line. | + +#### Returns + +`Record`<`string`, `any`\> + +A new stats object augmented with new telemetry information. + +#### Defined in + +src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:45 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PluginStartContract.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PluginStartContract.md new file mode 100644 index 0000000000000..3ded8d5c50642 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PluginStartContract.md @@ -0,0 +1,40 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PluginStartContract + +# Interface: PluginStartContract + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PluginStartContract + +## Table of contents + +### Methods + +- [getElasticsearchFeatures](client._internal_namespace.PluginStartContract.md#getelasticsearchfeatures) +- [getKibanaFeatures](client._internal_namespace.PluginStartContract.md#getkibanafeatures) + +## Methods + +### getElasticsearchFeatures + +▸ **getElasticsearchFeatures**(): [`ElasticsearchFeature`](../classes/client._internal_namespace.ElasticsearchFeature.md)[] + +#### Returns + +[`ElasticsearchFeature`](../classes/client._internal_namespace.ElasticsearchFeature.md)[] + +#### Defined in + +x-pack/plugins/features/target/types/server/plugin.d.ts:28 + +___ + +### getKibanaFeatures + +▸ **getKibanaFeatures**(): [`KibanaFeature`](../classes/client._internal_namespace.KibanaFeature.md)[] + +#### Returns + +[`KibanaFeature`](../classes/client._internal_namespace.KibanaFeature.md)[] + +#### Defined in + +x-pack/plugins/features/target/types/server/plugin.d.ts:29 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseArgs.md new file mode 100644 index 0000000000000..03690ece438b7 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseArgs.md @@ -0,0 +1,53 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PostCaseArgs + +# Interface: PostCaseArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PostCaseArgs + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) + + ↳ **`PostCaseArgs`** + +## Table of contents + +### Properties + +- [attributes](client._internal_namespace.PostCaseArgs.md#attributes) +- [id](client._internal_namespace.PostCaseArgs.md#id) +- [unsecuredSavedObjectsClient](client._internal_namespace.PostCaseArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### attributes + +• **attributes**: { `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:93](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L93) + +___ + +### id + +• **id**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:94](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L94) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseConfigureArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseConfigureArgs.md new file mode 100644 index 0000000000000..b10f3e3ae51ba --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseConfigureArgs.md @@ -0,0 +1,53 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PostCaseConfigureArgs + +# Interface: PostCaseConfigureArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PostCaseConfigureArgs + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs.md) + + ↳ **`PostCaseConfigureArgs`** + +## Table of contents + +### Properties + +- [attributes](client._internal_namespace.PostCaseConfigureArgs.md#attributes) +- [id](client._internal_namespace.PostCaseConfigureArgs.md#id) +- [unsecuredSavedObjectsClient](client._internal_namespace.PostCaseConfigureArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### attributes + +• **attributes**: { `closure_type`: ``"close-by-user"`` \| ``"close-by-pushing"`` = ClosureTypeRT; `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt } & { `owner`: `string` = rt.string } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } + +#### Defined in + +[x-pack/plugins/cases/server/services/configure/index.ts:41](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L41) + +___ + +### id + +• **id**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/configure/index.ts:42](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L42) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/configure/index.ts:30](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/configure/index.ts#L30) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseUserActionArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseUserActionArgs.md new file mode 100644 index 0000000000000..5b890d18106ea --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostCaseUserActionArgs.md @@ -0,0 +1,42 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PostCaseUserActionArgs + +# Interface: PostCaseUserActionArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PostCaseUserActionArgs + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs-1.md) + + ↳ **`PostCaseUserActionArgs`** + +## Table of contents + +### Properties + +- [actions](client._internal_namespace.PostCaseUserActionArgs.md#actions) +- [unsecuredSavedObjectsClient](client._internal_namespace.PostCaseUserActionArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### actions + +• **actions**: [`BuilderReturnValue`](client._internal_namespace.BuilderReturnValue.md)[] + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:67](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L67) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs-1.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-1.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/index.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/index.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostConnectorMappingsArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostConnectorMappingsArgs.md new file mode 100644 index 0000000000000..d4cc3e71a0ba8 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PostConnectorMappingsArgs.md @@ -0,0 +1,60 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PostConnectorMappingsArgs + +# Interface: PostConnectorMappingsArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PostConnectorMappingsArgs + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs-2.md) + + ↳ **`PostConnectorMappingsArgs`** + +## Table of contents + +### Properties + +- [attributes](client._internal_namespace.PostConnectorMappingsArgs.md#attributes) +- [references](client._internal_namespace.PostConnectorMappingsArgs.md#references) +- [unsecuredSavedObjectsClient](client._internal_namespace.PostConnectorMappingsArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### attributes + +• **attributes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `mappings` | { action\_type: "append" \| "nothing" \| "overwrite"; source: "description" \| "title" \| "comments"; target: string; }[] | +| `owner` | `string` | + +#### Defined in + +[x-pack/plugins/cases/server/services/connector_mappings/index.ts:22](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L22) + +___ + +### references + +• **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] + +#### Defined in + +[x-pack/plugins/cases/server/services/connector_mappings/index.ts:23](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L23) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs-2.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-2.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/connector_mappings/index.ts:15](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L15) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PreConfiguredAction.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PreConfiguredAction.md new file mode 100644 index 0000000000000..d5bd141afd372 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PreConfiguredAction.md @@ -0,0 +1,124 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PreConfiguredAction + +# Interface: PreConfiguredAction + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PreConfiguredAction + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Config` | extends [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) = [`ActionTypeConfig`](../modules/client._internal_namespace.md#actiontypeconfig) | +| `Secrets` | extends [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets) = [`ActionTypeSecrets`](../modules/client._internal_namespace.md#actiontypesecrets) | + +## Hierarchy + +- [`ActionResult`](client._internal_namespace.ActionResult.md)<`Config`\> + + ↳ **`PreConfiguredAction`** + +## Table of contents + +### Properties + +- [actionTypeId](client._internal_namespace.PreConfiguredAction.md#actiontypeid) +- [config](client._internal_namespace.PreConfiguredAction.md#config) +- [id](client._internal_namespace.PreConfiguredAction.md#id) +- [isMissingSecrets](client._internal_namespace.PreConfiguredAction.md#ismissingsecrets) +- [isPreconfigured](client._internal_namespace.PreConfiguredAction.md#ispreconfigured) +- [name](client._internal_namespace.PreConfiguredAction.md#name) +- [secrets](client._internal_namespace.PreConfiguredAction.md#secrets) + +## Properties + +### actionTypeId + +• **actionTypeId**: `string` + +#### Inherited from + +[ActionResult](client._internal_namespace.ActionResult.md).[actionTypeId](client._internal_namespace.ActionResult.md#actiontypeid) + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:50 + +___ + +### config + +• `Optional` **config**: `Config` + +#### Inherited from + +[ActionResult](client._internal_namespace.ActionResult.md).[config](client._internal_namespace.ActionResult.md#config) + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:53 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[ActionResult](client._internal_namespace.ActionResult.md).[id](client._internal_namespace.ActionResult.md#id) + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:49 + +___ + +### isMissingSecrets + +• `Optional` **isMissingSecrets**: `boolean` + +#### Inherited from + +[ActionResult](client._internal_namespace.ActionResult.md).[isMissingSecrets](client._internal_namespace.ActionResult.md#ismissingsecrets) + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:52 + +___ + +### isPreconfigured + +• **isPreconfigured**: `boolean` + +#### Inherited from + +[ActionResult](client._internal_namespace.ActionResult.md).[isPreconfigured](client._internal_namespace.ActionResult.md#ispreconfigured) + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:54 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[ActionResult](client._internal_namespace.ActionResult.md).[name](client._internal_namespace.ActionResult.md#name) + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:51 + +___ + +### secrets + +• **secrets**: `Secrets` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:57 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ProxySettings.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ProxySettings.md new file mode 100644 index 0000000000000..e1816a9f513cd --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ProxySettings.md @@ -0,0 +1,65 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ProxySettings + +# Interface: ProxySettings + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ProxySettings + +## Table of contents + +### Properties + +- [proxyBypassHosts](client._internal_namespace.ProxySettings.md#proxybypasshosts) +- [proxyHeaders](client._internal_namespace.ProxySettings.md#proxyheaders) +- [proxyOnlyHosts](client._internal_namespace.ProxySettings.md#proxyonlyhosts) +- [proxySSLSettings](client._internal_namespace.ProxySettings.md#proxysslsettings) +- [proxyUrl](client._internal_namespace.ProxySettings.md#proxyurl) + +## Properties + +### proxyBypassHosts + +• **proxyBypassHosts**: `undefined` \| `Set`<`string`\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:110 + +___ + +### proxyHeaders + +• `Optional` **proxyHeaders**: `Record`<`string`, `string`\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:112 + +___ + +### proxyOnlyHosts + +• **proxyOnlyHosts**: `undefined` \| `Set`<`string`\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:111 + +___ + +### proxySSLSettings + +• **proxySSLSettings**: [`SSLSettings`](client._internal_namespace.SSLSettings.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:113 + +___ + +### proxyUrl + +• **proxyUrl**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:109 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PublicLicense.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PublicLicense.md new file mode 100644 index 0000000000000..63c54f6be23cd --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PublicLicense.md @@ -0,0 +1,80 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PublicLicense + +# Interface: PublicLicense + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PublicLicense + +Subset of license data considered as non-sensitive information. +Can be passed to the client. + +## Table of contents + +### Properties + +- [expiryDateInMillis](client._internal_namespace.PublicLicense.md#expirydateinmillis) +- [mode](client._internal_namespace.PublicLicense.md#mode) +- [status](client._internal_namespace.PublicLicense.md#status) +- [type](client._internal_namespace.PublicLicense.md#type) +- [uid](client._internal_namespace.PublicLicense.md#uid) + +## Properties + +### expiryDateInMillis + +• **expiryDateInMillis**: `number` + +Unix epoch of the expiration date of the license. + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:36 + +___ + +### mode + +• **mode**: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` + +The license type, being usually one of basic, standard, gold, platinum, or trial. + +**`deprecated`** use 'type' instead + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:45 + +___ + +### status + +• **status**: [`LicenseStatus`](../modules/client._internal_namespace.md#licensestatus) + +The validity status of the license. + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:32 + +___ + +### type + +• **type**: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` + +The license type, being usually one of basic, standard, gold, platinum, or trial. + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:40 + +___ + +### uid + +• **uid**: `string` + +UID for license. + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:28 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PublicLicenseJSON.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PublicLicenseJSON.md new file mode 100644 index 0000000000000..895a3654baaf2 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PublicLicenseJSON.md @@ -0,0 +1,46 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PublicLicenseJSON + +# Interface: PublicLicenseJSON + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PublicLicenseJSON + +Subset of license & features data considered as non-sensitive information. +Structured as json to be passed to the client. + +## Table of contents + +### Properties + +- [features](client._internal_namespace.PublicLicenseJSON.md#features) +- [license](client._internal_namespace.PublicLicenseJSON.md#license) +- [signature](client._internal_namespace.PublicLicenseJSON.md#signature) + +## Properties + +### features + +• `Optional` **features**: [`PublicFeatures`](../modules/client._internal_namespace.md#publicfeatures) + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:59 + +___ + +### license + +• `Optional` **license**: [`PublicLicense`](client._internal_namespace.PublicLicense.md) + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:58 + +___ + +### signature + +• **signature**: `string` + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:60 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PushedArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PushedArgs.md new file mode 100644 index 0000000000000..0637bcb1cb21f --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.PushedArgs.md @@ -0,0 +1,40 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / PushedArgs + +# Interface: PushedArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).PushedArgs + +## Table of contents + +### Properties + +- [pushed\_at](client._internal_namespace.PushedArgs.md#pushed_at) +- [pushed\_by](client._internal_namespace.PushedArgs.md#pushed_by) + +## Properties + +### pushed\_at + +• **pushed\_at**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:64](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L64) + +___ + +### pushed\_by + +• **pushed\_by**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `email` | `undefined` \| ``null`` \| `string` | +| `full_name` | `undefined` \| ``null`` \| `string` | +| `username` | `undefined` \| ``null`` \| `string` | + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:65](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L65) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Referencable.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Referencable.md new file mode 100644 index 0000000000000..b8914a27eb524 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Referencable.md @@ -0,0 +1,21 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Referencable + +# Interface: Referencable + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Referencable + +## Table of contents + +### Properties + +- [references](client._internal_namespace.Referencable.md#references) + +## Properties + +### references + +• **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] + +#### Defined in + +src/core/target/types/server/saved_objects/serialization/types.d.ts:40 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ReservedKibanaPrivilege.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ReservedKibanaPrivilege.md new file mode 100644 index 0000000000000..cfd5cc23baa8c --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ReservedKibanaPrivilege.md @@ -0,0 +1,32 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ReservedKibanaPrivilege + +# Interface: ReservedKibanaPrivilege + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ReservedKibanaPrivilege + +## Table of contents + +### Properties + +- [id](client._internal_namespace.ReservedKibanaPrivilege.md#id) +- [privilege](client._internal_namespace.ReservedKibanaPrivilege.md#privilege) + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +x-pack/plugins/features/target/types/common/reserved_kibana_privilege.d.ts:3 + +___ + +### privilege + +• **privilege**: [`FeatureKibanaPrivileges`](client._internal_namespace.FeatureKibanaPrivileges.md) + +#### Defined in + +x-pack/plugins/features/target/types/common/reserved_kibana_privilege.d.ts:4 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ResponseSettings.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ResponseSettings.md new file mode 100644 index 0000000000000..b5c3a7374e03d --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ResponseSettings.md @@ -0,0 +1,32 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ResponseSettings + +# Interface: ResponseSettings + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ResponseSettings + +## Table of contents + +### Properties + +- [maxContentLength](client._internal_namespace.ResponseSettings.md#maxcontentlength) +- [timeout](client._internal_namespace.ResponseSettings.md#timeout) + +## Properties + +### maxContentLength + +• **maxContentLength**: `number` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:116 + +___ + +### timeout + +• **timeout**: `number` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:117 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteConfigOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteConfigOptions.md new file mode 100644 index 0000000000000..447612f4b9ece --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteConfigOptions.md @@ -0,0 +1,100 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / RouteConfigOptions + +# Interface: RouteConfigOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).RouteConfigOptions + +Additional route options. + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Method` | extends [`RouteMethod`](../modules/client._internal_namespace.md#routemethod) | + +## Table of contents + +### Properties + +- [authRequired](client._internal_namespace.RouteConfigOptions.md#authrequired) +- [body](client._internal_namespace.RouteConfigOptions.md#body) +- [tags](client._internal_namespace.RouteConfigOptions.md#tags) +- [timeout](client._internal_namespace.RouteConfigOptions.md#timeout) +- [xsrfRequired](client._internal_namespace.RouteConfigOptions.md#xsrfrequired) + +## Properties + +### authRequired + +• `Optional` **authRequired**: `boolean` \| ``"optional"`` + +Defines authentication mode for a route: +- true. A user has to have valid credentials to access a resource +- false. A user can access a resource without any credentials. +- 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid. + Can be useful when we grant access to a resource but want to identify a user if possible. + +Defaults to `true` if an auth mechanism is registered. + +#### Defined in + +src/core/target/types/server/http/router/route.d.ts:89 + +___ + +### body + +• `Optional` **body**: `Method` extends ``"options"`` \| ``"get"`` ? `undefined` : [`RouteConfigOptionsBody`](client._internal_namespace.RouteConfigOptionsBody.md) + +Additional body options [RouteConfigOptionsBody](client._internal_namespace.RouteConfigOptionsBody.md). + +#### Defined in + +src/core/target/types/server/http/router/route.d.ts:105 + +___ + +### tags + +• `Optional` **tags**: readonly `string`[] + +Additional metadata tag strings to attach to the route. + +#### Defined in + +src/core/target/types/server/http/router/route.d.ts:101 + +___ + +### timeout + +• `Optional` **timeout**: `Object` + +Defines per-route timeouts. + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `idleSocket?` | `number` | Milliseconds the socket can be idle before it's closed | +| `payload?` | `Method` extends ``"options"`` \| ``"get"`` ? `undefined` : `number` | Milliseconds to receive the payload | + +#### Defined in + +src/core/target/types/server/http/router/route.d.ts:109 + +___ + +### xsrfRequired + +• `Optional` **xsrfRequired**: `Method` extends ``"get"`` ? `never` : `boolean` + +Defines xsrf protection requirements for a route: +- true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header. +- false. Disables xsrf protection. + +Set to true by default + +#### Defined in + +src/core/target/types/server/http/router/route.d.ts:97 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteConfigOptionsBody.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteConfigOptionsBody.md new file mode 100644 index 0000000000000..c392c1845b22a --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteConfigOptionsBody.md @@ -0,0 +1,89 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / RouteConfigOptionsBody + +# Interface: RouteConfigOptionsBody + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).RouteConfigOptionsBody + +Additional body options for a route + +## Table of contents + +### Properties + +- [accepts](client._internal_namespace.RouteConfigOptionsBody.md#accepts) +- [maxBytes](client._internal_namespace.RouteConfigOptionsBody.md#maxbytes) +- [output](client._internal_namespace.RouteConfigOptionsBody.md#output) +- [parse](client._internal_namespace.RouteConfigOptionsBody.md#parse) + +## Properties + +### accepts + +• `Optional` **accepts**: `string` \| `string`[] \| [`RouteContentType`](../modules/client._internal_namespace.md#routecontenttype)[] + +A string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed +above will not enable them to be parsed, and if parse is true, the request will result in an error response. + +Default value: allows parsing of the following mime types: +* application/json +* application/*+json +* application/octet-stream +* application/x-www-form-urlencoded +* multipart/form-data +* text/* + +#### Defined in + +src/core/target/types/server/http/router/route.d.ts:45 + +___ + +### maxBytes + +• `Optional` **maxBytes**: `number` + +Limits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory. + +Default value: The one set in the kibana.yml config file under the parameter `server.maxPayload`. + +#### Defined in + +src/core/target/types/server/http/router/route.d.ts:51 + +___ + +### output + +• `Optional` **output**: ``"data"`` \| ``"stream"`` + +The processed payload format. The value must be one of: +* 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw +Buffer is returned. +* 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files +are provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart +payloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the +multipart payload in the handler using a streaming parser (e.g. pez). + +Default value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure. + +#### Defined in + +src/core/target/types/server/http/router/route.d.ts:63 + +___ + +### parse + +• `Optional` **parse**: `boolean` \| ``"gunzip"`` + +Determines if the incoming payload is processed or presented raw. Available values: +* true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the +format is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded. +* false - the raw payload is returned unmodified. +* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded. + +Default value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure. + +#### Defined in + +src/core/target/types/server/http/router/route.d.ts:73 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidationResultFactory.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidationResultFactory.md new file mode 100644 index 0000000000000..4e45bca74bdee --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidationResultFactory.md @@ -0,0 +1,71 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / RouteValidationResultFactory + +# Interface: RouteValidationResultFactory + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).RouteValidationResultFactory + +Validation result factory to be used in the custom validation function to return the valid data or validation errors + +See [RouteValidationFunction](../modules/client._internal_namespace.md#routevalidationfunction). + +## Table of contents + +### Methods + +- [badRequest](client._internal_namespace.RouteValidationResultFactory.md#badrequest) +- [ok](client._internal_namespace.RouteValidationResultFactory.md#ok) + +## Methods + +### badRequest + +▸ **badRequest**(`error`, `path?`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | `string` \| `Error` | +| `path?` | `string`[] | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `error` | [`RouteValidationError`](../classes/client._internal_namespace.RouteValidationError.md) | + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:14 + +___ + +### ok + +▸ **ok**<`T`\>(`value`): `Object` + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `T` | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `value` | `T` | + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:11 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidatorConfig.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidatorConfig.md new file mode 100644 index 0000000000000..dcea2693b8a07 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidatorConfig.md @@ -0,0 +1,60 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / RouteValidatorConfig + +# Interface: RouteValidatorConfig + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).RouteValidatorConfig + +The configuration object to the RouteValidator class. +Set `params`, `query` and/or `body` to specify the validation logic to follow for that property. + +## Type parameters + +| Name | +| :------ | +| `P` | +| `Q` | +| `B` | + +## Table of contents + +### Properties + +- [body](client._internal_namespace.RouteValidatorConfig.md#body) +- [params](client._internal_namespace.RouteValidatorConfig.md#params) +- [query](client._internal_namespace.RouteValidatorConfig.md#query) + +## Properties + +### body + +• `Optional` **body**: [`RouteValidationSpec`](../modules/client._internal_namespace.md#routevalidationspec)<`B`\> + +Validation logic for the body payload + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:79 + +___ + +### params + +• `Optional` **params**: [`RouteValidationSpec`](../modules/client._internal_namespace.md#routevalidationspec)<`P`\> + +Validation logic for the URL params + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:69 + +___ + +### query + +• `Optional` **query**: [`RouteValidationSpec`](../modules/client._internal_namespace.md#routevalidationspec)<`Q`\> + +Validation logic for the Query params + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:74 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidatorOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidatorOptions.md new file mode 100644 index 0000000000000..2652ad7475e82 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RouteValidatorOptions.md @@ -0,0 +1,33 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / RouteValidatorOptions + +# Interface: RouteValidatorOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).RouteValidatorOptions + +Additional options for the RouteValidator class to modify its default behaviour. + +## Table of contents + +### Properties + +- [unsafe](client._internal_namespace.RouteValidatorOptions.md#unsafe) + +## Properties + +### unsafe + +• `Optional` **unsafe**: `Object` + +Set the `unsafe` config to avoid running some additional internal *safe* validations on top of your custom validation + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `body?` | `boolean` | +| `params?` | `boolean` | +| `query?` | `boolean` | + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:91 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RunContext.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RunContext.md new file mode 100644 index 0000000000000..01eec0d08684b --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RunContext.md @@ -0,0 +1,25 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / RunContext + +# Interface: RunContext + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).RunContext + +The run context is passed into a task's run function as its sole argument. + +## Table of contents + +### Properties + +- [taskInstance](client._internal_namespace.RunContext.md#taskinstance) + +## Properties + +### taskInstance + +• **taskInstance**: [`ConcreteTaskInstance`](client._internal_namespace.ConcreteTaskInstance.md) + +The document describing the task instance, its params, state, id, etc. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:23 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RunNowResult.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RunNowResult.md new file mode 100644 index 0000000000000..d5a584a4b99c5 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.RunNowResult.md @@ -0,0 +1,32 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / RunNowResult + +# Interface: RunNowResult + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).RunNowResult + +## Table of contents + +### Properties + +- [id](client._internal_namespace.RunNowResult.md#id) +- [state](client._internal_namespace.RunNowResult.md#state) + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task_scheduling.d.ts:18 + +___ + +### state + +• `Optional` **state**: `Record`<`string`, `any`\> + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task_scheduling.d.ts:19 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SSLSettings.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SSLSettings.md new file mode 100644 index 0000000000000..ce1f83e937876 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SSLSettings.md @@ -0,0 +1,21 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SSLSettings + +# Interface: SSLSettings + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SSLSettings + +## Table of contents + +### Properties + +- [verificationMode](client._internal_namespace.SSLSettings.md#verificationmode) + +## Properties + +### verificationMode + +• `Optional` **verificationMode**: ``"none"`` \| ``"certificate"`` \| ``"full"`` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:120 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObject.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObject.md new file mode 100644 index 0000000000000..7a2ab41e7cf9c --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObject.md @@ -0,0 +1,167 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObject + +# Interface: SavedObject + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObject + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +## Hierarchy + +- **`SavedObject`** + + ↳ [`SavedObjectsFindResult`](client._internal_namespace.SavedObjectsFindResult.md) + +## Table of contents + +### Properties + +- [attributes](client._internal_namespace.SavedObject.md#attributes) +- [coreMigrationVersion](client._internal_namespace.SavedObject.md#coremigrationversion) +- [error](client._internal_namespace.SavedObject.md#error) +- [id](client._internal_namespace.SavedObject.md#id) +- [migrationVersion](client._internal_namespace.SavedObject.md#migrationversion) +- [namespaces](client._internal_namespace.SavedObject.md#namespaces) +- [originId](client._internal_namespace.SavedObject.md#originid) +- [references](client._internal_namespace.SavedObject.md#references) +- [type](client._internal_namespace.SavedObject.md#type) +- [updated\_at](client._internal_namespace.SavedObject.md#updated_at) +- [version](client._internal_namespace.SavedObject.md#version) + +## Properties + +### attributes + +• **attributes**: `T` + +{@inheritdoc SavedObjectAttributes} + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:61 + +___ + +### coreMigrationVersion + +• `Optional` **coreMigrationVersion**: `string` + +A semver value that is used when upgrading objects between Kibana versions. + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:67 + +___ + +### error + +• `Optional` **error**: [`SavedObjectError`](client._internal_namespace.SavedObjectError.md) + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:59 + +___ + +### id + +• **id**: `string` + +The ID of this Saved Object, guaranteed to be unique for all objects of the same `type` + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:52 + +___ + +### migrationVersion + +• `Optional` **migrationVersion**: [`SavedObjectsMigrationVersion`](client._internal_namespace.SavedObjectsMigrationVersion.md) + +{@inheritdoc SavedObjectsMigrationVersion} + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:65 + +___ + +### namespaces + +• `Optional` **namespaces**: `string`[] + +Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with +`namespaceType: 'agnostic'`. + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:72 + +___ + +### originId + +• `Optional` **originId**: `string` + +The ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration +from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import +to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given +space. + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:79 + +___ + +### references + +• **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] + +{@inheritdoc SavedObjectReference} + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:63 + +___ + +### type + +• **type**: `string` + +The type of Saved Object. Each plugin can define it's own custom Saved Object types. + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:54 + +___ + +### updated\_at + +• `Optional` **updated\_at**: `string` + +Timestamp of the last time this document had been updated. + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:58 + +___ + +### version + +• `Optional` **version**: `string` + +An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:56 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectAttributes.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectAttributes.md new file mode 100644 index 0000000000000..2f260171ce47a --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectAttributes.md @@ -0,0 +1,20 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectAttributes + +# Interface: SavedObjectAttributes + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectAttributes + +The data for a Saved Object is stored as an object in the `attributes` +property. + +## Hierarchy + +- **`SavedObjectAttributes`** + + ↳ [`ActionUpdate`](client._internal_namespace.ActionUpdate.md) + + ↳ [`ConnectorToken`](client._internal_namespace.ConnectorToken.md) + +## Indexable + +▪ [key: `string`]: [`SavedObjectAttribute`](../modules/client._internal_namespace.md#savedobjectattribute) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectDoc.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectDoc.md new file mode 100644 index 0000000000000..50478fb7b3cf2 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectDoc.md @@ -0,0 +1,128 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectDoc + +# Interface: SavedObjectDoc + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectDoc + +Saved Object base document + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +## Table of contents + +### Properties + +- [attributes](client._internal_namespace.SavedObjectDoc.md#attributes) +- [coreMigrationVersion](client._internal_namespace.SavedObjectDoc.md#coremigrationversion) +- [id](client._internal_namespace.SavedObjectDoc.md#id) +- [migrationVersion](client._internal_namespace.SavedObjectDoc.md#migrationversion) +- [namespace](client._internal_namespace.SavedObjectDoc.md#namespace) +- [namespaces](client._internal_namespace.SavedObjectDoc.md#namespaces) +- [originId](client._internal_namespace.SavedObjectDoc.md#originid) +- [type](client._internal_namespace.SavedObjectDoc.md#type) +- [updated\_at](client._internal_namespace.SavedObjectDoc.md#updated_at) +- [version](client._internal_namespace.SavedObjectDoc.md#version) + +## Properties + +### attributes + +• **attributes**: `T` + +#### Defined in + +src/core/target/types/server/saved_objects/serialization/types.d.ts:28 + +___ + +### coreMigrationVersion + +• `Optional` **coreMigrationVersion**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/serialization/types.d.ts:34 + +___ + +### id + +• **id**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/serialization/types.d.ts:29 + +___ + +### migrationVersion + +• `Optional` **migrationVersion**: [`SavedObjectsMigrationVersion`](client._internal_namespace.SavedObjectsMigrationVersion.md) + +#### Defined in + +src/core/target/types/server/saved_objects/serialization/types.d.ts:33 + +___ + +### namespace + +• `Optional` **namespace**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/serialization/types.d.ts:31 + +___ + +### namespaces + +• `Optional` **namespaces**: `string`[] + +#### Defined in + +src/core/target/types/server/saved_objects/serialization/types.d.ts:32 + +___ + +### originId + +• `Optional` **originId**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/serialization/types.d.ts:37 + +___ + +### type + +• **type**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/serialization/types.d.ts:30 + +___ + +### updated\_at + +• `Optional` **updated\_at**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/serialization/types.d.ts:36 + +___ + +### version + +• `Optional` **version**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/serialization/types.d.ts:35 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectError.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectError.md new file mode 100644 index 0000000000000..8b93bb038d5fa --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectError.md @@ -0,0 +1,54 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectError + +# Interface: SavedObjectError + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectError + +## Table of contents + +### Properties + +- [error](client._internal_namespace.SavedObjectError.md#error) +- [message](client._internal_namespace.SavedObjectError.md#message) +- [metadata](client._internal_namespace.SavedObjectError.md#metadata) +- [statusCode](client._internal_namespace.SavedObjectError.md#statuscode) + +## Properties + +### error + +• **error**: `string` + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:82 + +___ + +### message + +• **message**: `string` + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:83 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:85 + +___ + +### statusCode + +• **statusCode**: `number` + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:84 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectMigrationContext.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectMigrationContext.md new file mode 100644 index 0000000000000..b16816fc5ec40 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectMigrationContext.md @@ -0,0 +1,64 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectMigrationContext + +# Interface: SavedObjectMigrationContext + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectMigrationContext + +Migration context provided when invoking a [migration handler](../modules/client._internal_namespace.md#savedobjectmigrationfn) + +## Table of contents + +### Properties + +- [convertToMultiNamespaceTypeVersion](client._internal_namespace.SavedObjectMigrationContext.md#converttomultinamespacetypeversion) +- [isSingleNamespaceType](client._internal_namespace.SavedObjectMigrationContext.md#issinglenamespacetype) +- [log](client._internal_namespace.SavedObjectMigrationContext.md#log) +- [migrationVersion](client._internal_namespace.SavedObjectMigrationContext.md#migrationversion) + +## Properties + +### convertToMultiNamespaceTypeVersion + +• `Optional` `Readonly` **convertToMultiNamespaceTypeVersion**: `string` + +The version in which this object type is being converted to a multi-namespace type + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/types.d.ts:57 + +___ + +### isSingleNamespaceType + +• `Readonly` **isSingleNamespaceType**: `boolean` + +Whether this is a single-namespace type or not + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/types.d.ts:61 + +___ + +### log + +• `Readonly` **log**: [`SavedObjectsMigrationLogger`](client._internal_namespace.SavedObjectsMigrationLogger.md) + +logger instance to be used by the migration handler + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/types.d.ts:49 + +___ + +### migrationVersion + +• `Readonly` **migrationVersion**: `string` + +The migration version that this migration function is defined for + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/types.d.ts:53 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectMigrationMap.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectMigrationMap.md new file mode 100644 index 0000000000000..2632e6259ff5b --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectMigrationMap.md @@ -0,0 +1,23 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectMigrationMap + +# Interface: SavedObjectMigrationMap + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectMigrationMap + +A map of [migration functions](../modules/client._internal_namespace.md#savedobjectmigrationfn) to be used for a given type. +The map's keys must be valid semver versions, and they cannot exceed the current Kibana version. + +For a given document, only migrations with a higher version number than that of the document will be applied. +Migrations are executed in order, starting from the lowest version and ending with the highest one. + +**`example`** +```typescript +const migrationsMap: SavedObjectMigrationMap = { + '1.0.0': migrateToV1, + '2.1.0': migrateToV21 +} +``` + +## Indexable + +▪ [version: `string`]: [`SavedObjectMigrationFn`](../modules/client._internal_namespace.md#savedobjectmigrationfn)<`any`, `any`\> diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectReference.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectReference.md new file mode 100644 index 0000000000000..2c3f8ac1c7cc0 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectReference.md @@ -0,0 +1,45 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectReference + +# Interface: SavedObjectReference + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectReference + +A reference to another saved object. + +## Table of contents + +### Properties + +- [id](client._internal_namespace.SavedObjectReference.md#id) +- [name](client._internal_namespace.SavedObjectReference.md#name) +- [type](client._internal_namespace.SavedObjectReference.md#type) + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:30 + +___ + +### name + +• **name**: `string` + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:28 + +___ + +### type + +• **type**: `string` + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:29 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectReferenceWithContext.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectReferenceWithContext.md new file mode 100644 index 0000000000000..511e6aec3d9b6 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectReferenceWithContext.md @@ -0,0 +1,91 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectReferenceWithContext + +# Interface: SavedObjectReferenceWithContext + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectReferenceWithContext + +A returned input object or one of its references, with additional context. + +## Table of contents + +### Properties + +- [id](client._internal_namespace.SavedObjectReferenceWithContext.md#id) +- [inboundReferences](client._internal_namespace.SavedObjectReferenceWithContext.md#inboundreferences) +- [isMissing](client._internal_namespace.SavedObjectReferenceWithContext.md#ismissing) +- [spaces](client._internal_namespace.SavedObjectReferenceWithContext.md#spaces) +- [spacesWithMatchingAliases](client._internal_namespace.SavedObjectReferenceWithContext.md#spaceswithmatchingaliases) +- [type](client._internal_namespace.SavedObjectReferenceWithContext.md#type) + +## Properties + +### id + +• **id**: `string` + +The ID of the referenced object + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:45 + +___ + +### inboundReferences + +• **inboundReferences**: { `id`: `string` ; `name`: `string` ; `type`: `string` }[] + +References to this object; note that this does not contain _all inbound references everywhere for this object_, it only contains +inbound references for the scope of this operation + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:52 + +___ + +### isMissing + +• `Optional` **isMissing**: `boolean` + +Whether or not this object or reference is missing + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:61 + +___ + +### spaces + +• **spaces**: `string`[] + +The space(s) that the referenced object exists in + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:47 + +___ + +### spacesWithMatchingAliases + +• `Optional` **spacesWithMatchingAliases**: `string`[] + +The space(s) that legacy URL aliases matching this type/id exist in + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:63 + +___ + +### type + +• **type**: `string` + +The type of the referenced object + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:43 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBaseOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBaseOptions.md new file mode 100644 index 0000000000000..afce23c52c88d --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBaseOptions.md @@ -0,0 +1,47 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsBaseOptions + +# Interface: SavedObjectsBaseOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsBaseOptions + +## Hierarchy + +- **`SavedObjectsBaseOptions`** + + ↳ [`SavedObjectsRemoveReferencesToResponse`](client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md) + + ↳ [`SavedObjectsCreateOptions`](client._internal_namespace.SavedObjectsCreateOptions.md) + + ↳ [`SavedObjectsDeleteOptions`](client._internal_namespace.SavedObjectsDeleteOptions.md) + + ↳ [`SavedObjectsUpdateOptions`](client._internal_namespace.SavedObjectsUpdateOptions.md) + + ↳ [`SavedObjectsBulkUpdateOptions`](client._internal_namespace.SavedObjectsBulkUpdateOptions.md) + + ↳ [`SavedObjectsRemoveReferencesToOptions`](client._internal_namespace.SavedObjectsRemoveReferencesToOptions.md) + + ↳ [`SavedObjectsCollectMultiNamespaceReferencesOptions`](client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesOptions.md) + + ↳ [`SavedObjectsUpdateObjectsSpacesOptions`](client._internal_namespace.SavedObjectsUpdateObjectsSpacesOptions.md) + + ↳ [`SavedObjectsDeleteByNamespaceOptions`](client._internal_namespace.SavedObjectsDeleteByNamespaceOptions.md) + + ↳ [`SavedObjectsIncrementCounterOptions`](client._internal_namespace.SavedObjectsIncrementCounterOptions.md) + +## Table of contents + +### Properties + +- [namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) + +## Properties + +### namespace + +• `Optional` **namespace**: `string` + +Specify the namespace for this operation + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:126 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkCreateObject.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkCreateObject.md new file mode 100644 index 0000000000000..1a5bbd79801ba --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkCreateObject.md @@ -0,0 +1,136 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsBulkCreateObject + +# Interface: SavedObjectsBulkCreateObject + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsBulkCreateObject + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +## Table of contents + +### Properties + +- [attributes](client._internal_namespace.SavedObjectsBulkCreateObject.md#attributes) +- [coreMigrationVersion](client._internal_namespace.SavedObjectsBulkCreateObject.md#coremigrationversion) +- [id](client._internal_namespace.SavedObjectsBulkCreateObject.md#id) +- [initialNamespaces](client._internal_namespace.SavedObjectsBulkCreateObject.md#initialnamespaces) +- [migrationVersion](client._internal_namespace.SavedObjectsBulkCreateObject.md#migrationversion) +- [originId](client._internal_namespace.SavedObjectsBulkCreateObject.md#originid) +- [references](client._internal_namespace.SavedObjectsBulkCreateObject.md#references) +- [type](client._internal_namespace.SavedObjectsBulkCreateObject.md#type) +- [version](client._internal_namespace.SavedObjectsBulkCreateObject.md#version) + +## Properties + +### attributes + +• **attributes**: `T` + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:54 + +___ + +### coreMigrationVersion + +• `Optional` **coreMigrationVersion**: `string` + +A semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current +Kibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the +current Kibana version, it will result in an error. + +**`remarks`** +Do not attempt to set this manually. It should only be used if you retrieved an existing object that had the `coreMigrationVersion` +field set and you want to create it again. + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:68 + +___ + +### id + +• `Optional` **id**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:52 + +___ + +### initialNamespaces + +• `Optional` **initialNamespaces**: `string`[] + +Optional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in +[SavedObjectsCreateOptions](client._internal_namespace.SavedObjectsCreateOptions.md). + +* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces, + including the "All spaces" identifier (`'*'`). +* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only + be used to specify a single space, and the "All spaces" identifier (`'*'`) is not allowed. +* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used. + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:81 + +___ + +### migrationVersion + +• `Optional` **migrationVersion**: [`SavedObjectsMigrationVersion`](client._internal_namespace.SavedObjectsMigrationVersion.md) + +{@inheritDoc SavedObjectsMigrationVersion} + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:58 + +___ + +### originId + +• `Optional` **originId**: `string` + +Optional ID of the original saved object, if this object's `id` was regenerated + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:70 + +___ + +### references + +• `Optional` **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:56 + +___ + +### type + +• **type**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:53 + +___ + +### version + +• `Optional` **version**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:55 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkGetObject.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkGetObject.md new file mode 100644 index 0000000000000..3b3dd0ecbc28b --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkGetObject.md @@ -0,0 +1,65 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsBulkGetObject + +# Interface: SavedObjectsBulkGetObject + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsBulkGetObject + +## Table of contents + +### Properties + +- [fields](client._internal_namespace.SavedObjectsBulkGetObject.md#fields) +- [id](client._internal_namespace.SavedObjectsBulkGetObject.md#id) +- [namespaces](client._internal_namespace.SavedObjectsBulkGetObject.md#namespaces) +- [type](client._internal_namespace.SavedObjectsBulkGetObject.md#type) + +## Properties + +### fields + +• `Optional` **fields**: `string`[] + +SavedObject fields to include in the response + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:239 + +___ + +### id + +• **id**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:236 + +___ + +### namespaces + +• `Optional` **namespaces**: `string`[] + +Optional namespace(s) for the object to be retrieved in. If this is defined, it will supersede the namespace ID that is in the +top-level options. + +* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces, + including the "All spaces" identifier (`'*'`). +* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only + be used to specify a single space, and the "All spaces" identifier (`'*'`) is not allowed. +* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used. + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:250 + +___ + +### type + +• **type**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:237 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResolveObject.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResolveObject.md new file mode 100644 index 0000000000000..56105f08768ae --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResolveObject.md @@ -0,0 +1,32 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsBulkResolveObject + +# Interface: SavedObjectsBulkResolveObject + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsBulkResolveObject + +## Table of contents + +### Properties + +- [id](client._internal_namespace.SavedObjectsBulkResolveObject.md#id) +- [type](client._internal_namespace.SavedObjectsBulkResolveObject.md#type) + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:279 + +___ + +### type + +• **type**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:280 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResolveResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResolveResponse.md new file mode 100644 index 0000000000000..4f7fc1463bb4b --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResolveResponse.md @@ -0,0 +1,27 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsBulkResolveResponse + +# Interface: SavedObjectsBulkResolveResponse + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsBulkResolveResponse + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +## Table of contents + +### Properties + +- [resolved\_objects](client._internal_namespace.SavedObjectsBulkResolveResponse.md#resolved_objects) + +## Properties + +### resolved\_objects + +• **resolved\_objects**: [`SavedObjectsResolveResponse`](client._internal_namespace.SavedObjectsResolveResponse.md)<`T`\>[] + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:287 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResponse.md new file mode 100644 index 0000000000000..76af857d6f612 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkResponse.md @@ -0,0 +1,27 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsBulkResponse + +# Interface: SavedObjectsBulkResponse + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsBulkResponse + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +## Table of contents + +### Properties + +- [saved\_objects](client._internal_namespace.SavedObjectsBulkResponse.md#saved_objects) + +## Properties + +### saved\_objects + +• **saved\_objects**: [`SavedObject`](client._internal_namespace.SavedObject.md)<`T`\>[] + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:107 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateObject.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateObject.md new file mode 100644 index 0000000000000..f0ae9c5aa503f --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateObject.md @@ -0,0 +1,111 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsBulkUpdateObject + +# Interface: SavedObjectsBulkUpdateObject + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsBulkUpdateObject + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +## Hierarchy + +- `Pick`<[`SavedObjectsUpdateOptions`](client._internal_namespace.SavedObjectsUpdateOptions.md)<`T`\>, ``"version"`` \| ``"references"``\> + + ↳ **`SavedObjectsBulkUpdateObject`** + +## Table of contents + +### Properties + +- [attributes](client._internal_namespace.SavedObjectsBulkUpdateObject.md#attributes) +- [id](client._internal_namespace.SavedObjectsBulkUpdateObject.md#id) +- [namespace](client._internal_namespace.SavedObjectsBulkUpdateObject.md#namespace) +- [references](client._internal_namespace.SavedObjectsBulkUpdateObject.md#references) +- [type](client._internal_namespace.SavedObjectsBulkUpdateObject.md#type) +- [version](client._internal_namespace.SavedObjectsBulkUpdateObject.md#version) + +## Properties + +### attributes + +• **attributes**: `Partial`<`T`\> + +{@inheritdoc SavedObjectAttributes} + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:93 + +___ + +### id + +• **id**: `string` + +The ID of this Saved Object, guaranteed to be unique for all objects of the same `type` + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:89 + +___ + +### namespace + +• `Optional` **namespace**: `string` + +Optional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in +[SavedObjectsBulkUpdateOptions](client._internal_namespace.SavedObjectsBulkUpdateOptions.md). + +Note: the default namespace's string representation is `'default'`, and its ID representation is `undefined`. + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:100 + +___ + +### references + +• `Optional` **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] + +{@inheritdoc SavedObjectReference} + +#### Inherited from + +Pick.references + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:191 + +___ + +### type + +• **type**: `string` + +The type of this Saved Object. Each plugin can define it's own custom Saved Object types. + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:91 + +___ + +### version + +• `Optional` **version**: `string` + +An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. + +#### Inherited from + +Pick.version + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:189 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateOptions.md new file mode 100644 index 0000000000000..4de3a8eefdb02 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateOptions.md @@ -0,0 +1,46 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsBulkUpdateOptions + +# Interface: SavedObjectsBulkUpdateOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsBulkUpdateOptions + +## Hierarchy + +- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) + + ↳ **`SavedObjectsBulkUpdateOptions`** + +## Table of contents + +### Properties + +- [namespace](client._internal_namespace.SavedObjectsBulkUpdateOptions.md#namespace) +- [refresh](client._internal_namespace.SavedObjectsBulkUpdateOptions.md#refresh) + +## Properties + +### namespace + +• `Optional` **namespace**: `string` + +Specify the namespace for this operation + +#### Inherited from + +[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:126 + +___ + +### refresh + +• `Optional` **refresh**: [`MutatingOperationRefreshSetting`](../modules/client._internal_namespace.md#mutatingoperationrefreshsetting) + +The Elasticsearch Refresh setting for this operation + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:219 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md new file mode 100644 index 0000000000000..93fb3c3f3a3b2 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md @@ -0,0 +1,27 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsBulkUpdateResponse + +# Interface: SavedObjectsBulkUpdateResponse + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsBulkUpdateResponse + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +## Table of contents + +### Properties + +- [saved\_objects](client._internal_namespace.SavedObjectsBulkUpdateResponse.md#saved_objects) + +## Properties + +### saved\_objects + +• **saved\_objects**: [`SavedObjectsUpdateResponse`](client._internal_namespace.SavedObjectsUpdateResponse.md)<`T`\>[] + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:264 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCheckConflictsObject.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCheckConflictsObject.md new file mode 100644 index 0000000000000..7b8a8b1b6982f --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCheckConflictsObject.md @@ -0,0 +1,32 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsCheckConflictsObject + +# Interface: SavedObjectsCheckConflictsObject + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsCheckConflictsObject + +## Table of contents + +### Properties + +- [id](client._internal_namespace.SavedObjectsCheckConflictsObject.md#id) +- [type](client._internal_namespace.SavedObjectsCheckConflictsObject.md#type) + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:169 + +___ + +### type + +• **type**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:170 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCheckConflictsResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCheckConflictsResponse.md new file mode 100644 index 0000000000000..d43f929a18fed --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCheckConflictsResponse.md @@ -0,0 +1,21 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsCheckConflictsResponse + +# Interface: SavedObjectsCheckConflictsResponse + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsCheckConflictsResponse + +## Table of contents + +### Properties + +- [errors](client._internal_namespace.SavedObjectsCheckConflictsResponse.md#errors) + +## Properties + +### errors + +• **errors**: { `error`: [`SavedObjectError`](client._internal_namespace.SavedObjectError.md) ; `id`: `string` ; `type`: `string` }[] + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:177 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsClosePointInTimeResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsClosePointInTimeResponse.md new file mode 100644 index 0000000000000..acf9af85bdc20 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsClosePointInTimeResponse.md @@ -0,0 +1,37 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsClosePointInTimeResponse + +# Interface: SavedObjectsClosePointInTimeResponse + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsClosePointInTimeResponse + +## Table of contents + +### Properties + +- [num\_freed](client._internal_namespace.SavedObjectsClosePointInTimeResponse.md#num_freed) +- [succeeded](client._internal_namespace.SavedObjectsClosePointInTimeResponse.md#succeeded) + +## Properties + +### num\_freed + +• **num\_freed**: `number` + +The number of search contexts that have been successfully closed. + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:360 + +___ + +### succeeded + +• **succeeded**: `boolean` + +If true, all search contexts associated with the PIT id are +successfully closed. + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:356 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesObject.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesObject.md new file mode 100644 index 0000000000000..7db1c04858eb3 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesObject.md @@ -0,0 +1,38 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsCollectMultiNamespaceReferencesObject + +# Interface: SavedObjectsCollectMultiNamespaceReferencesObject + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsCollectMultiNamespaceReferencesObject + +An object to collect references for. It must be a multi-namespace type (in other words, the object type must be registered with the +`namespaceType: 'multiple'` or `namespaceType: 'multiple-isolated'` option). + +Note: if options.purpose is 'updateObjectsSpaces', it must be a shareable type (in other words, the object type must be registered with +the `namespaceType: 'multiple'`). + +## Table of contents + +### Properties + +- [id](client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesObject.md#id) +- [type](client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesObject.md#type) + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:24 + +___ + +### type + +• **type**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:25 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesOptions.md new file mode 100644 index 0000000000000..32ffe4158cc00 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesOptions.md @@ -0,0 +1,48 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsCollectMultiNamespaceReferencesOptions + +# Interface: SavedObjectsCollectMultiNamespaceReferencesOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsCollectMultiNamespaceReferencesOptions + +Options for collecting references. + +## Hierarchy + +- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) + + ↳ **`SavedObjectsCollectMultiNamespaceReferencesOptions`** + +## Table of contents + +### Properties + +- [namespace](client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesOptions.md#namespace) +- [purpose](client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesOptions.md#purpose) + +## Properties + +### namespace + +• `Optional` **namespace**: `string` + +Specify the namespace for this operation + +#### Inherited from + +[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:126 + +___ + +### purpose + +• `Optional` **purpose**: ``"collectMultiNamespaceReferences"`` \| ``"updateObjectsSpaces"`` + +Optional purpose used to determine filtering and authorization checks; default is 'collectMultiNamespaceReferences' + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:34 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesResponse.md new file mode 100644 index 0000000000000..768ce8c1c6094 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesResponse.md @@ -0,0 +1,23 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsCollectMultiNamespaceReferencesResponse + +# Interface: SavedObjectsCollectMultiNamespaceReferencesResponse + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsCollectMultiNamespaceReferencesResponse + +The response when object references are collected. + +## Table of contents + +### Properties + +- [objects](client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesResponse.md#objects) + +## Properties + +### objects + +• **objects**: [`SavedObjectReferenceWithContext`](client._internal_namespace.SavedObjectReferenceWithContext.md)[] + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/collect_multi_namespace_references.d.ts:71 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCreateOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCreateOptions.md new file mode 100644 index 0000000000000..d2b13605808ac --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCreateOptions.md @@ -0,0 +1,162 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsCreateOptions + +# Interface: SavedObjectsCreateOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsCreateOptions + +## Hierarchy + +- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) + + ↳ **`SavedObjectsCreateOptions`** + +## Table of contents + +### Properties + +- [coreMigrationVersion](client._internal_namespace.SavedObjectsCreateOptions.md#coremigrationversion) +- [id](client._internal_namespace.SavedObjectsCreateOptions.md#id) +- [initialNamespaces](client._internal_namespace.SavedObjectsCreateOptions.md#initialnamespaces) +- [migrationVersion](client._internal_namespace.SavedObjectsCreateOptions.md#migrationversion) +- [namespace](client._internal_namespace.SavedObjectsCreateOptions.md#namespace) +- [originId](client._internal_namespace.SavedObjectsCreateOptions.md#originid) +- [overwrite](client._internal_namespace.SavedObjectsCreateOptions.md#overwrite) +- [references](client._internal_namespace.SavedObjectsCreateOptions.md#references) +- [refresh](client._internal_namespace.SavedObjectsCreateOptions.md#refresh) +- [version](client._internal_namespace.SavedObjectsCreateOptions.md#version) + +## Properties + +### coreMigrationVersion + +• `Optional` **coreMigrationVersion**: `string` + +A semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current +Kibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the +current Kibana version, it will result in an error. + +**`remarks`** +Do not attempt to set this manually. It should only be used if you retrieved an existing object that had the `coreMigrationVersion` +field set and you want to create it again. + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:29 + +___ + +### id + +• `Optional` **id**: `string` + +(not recommended) Specify an id for the document + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:10 + +___ + +### initialNamespaces + +• `Optional` **initialNamespaces**: `string`[] + +Optional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in +[SavedObjectsCreateOptions](client._internal_namespace.SavedObjectsCreateOptions.md). + +* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces, + including the "All spaces" identifier (`'*'`). +* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only + be used to specify a single space, and the "All spaces" identifier (`'*'`) is not allowed. +* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used. + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:45 + +___ + +### migrationVersion + +• `Optional` **migrationVersion**: [`SavedObjectsMigrationVersion`](client._internal_namespace.SavedObjectsMigrationVersion.md) + +{@inheritDoc SavedObjectsMigrationVersion} + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:19 + +___ + +### namespace + +• `Optional` **namespace**: `string` + +Specify the namespace for this operation + +#### Inherited from + +[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:126 + +___ + +### originId + +• `Optional` **originId**: `string` + +Optional ID of the original saved object, if this object's `id` was regenerated + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:34 + +___ + +### overwrite + +• `Optional` **overwrite**: `boolean` + +Overwrite existing documents (defaults to false) + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:12 + +___ + +### references + +• `Optional` **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:30 + +___ + +### refresh + +• `Optional` **refresh**: [`MutatingOperationRefreshSetting`](../modules/client._internal_namespace.md#mutatingoperationrefreshsetting) + +The Elasticsearch Refresh setting for this operation + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:32 + +___ + +### version + +• `Optional` **version**: `string` + +An opaque version number which changes on each successful write operation. +Can be used in conjunction with `overwrite` for implementing optimistic concurrency control. + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:17 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCreatePointInTimeFinderDependencies.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCreatePointInTimeFinderDependencies.md new file mode 100644 index 0000000000000..3289e3cb4144f --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsCreatePointInTimeFinderDependencies.md @@ -0,0 +1,21 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsCreatePointInTimeFinderDependencies + +# Interface: SavedObjectsCreatePointInTimeFinderDependencies + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsCreatePointInTimeFinderDependencies + +## Table of contents + +### Properties + +- [client](client._internal_namespace.SavedObjectsCreatePointInTimeFinderDependencies.md#client) + +## Properties + +### client + +• **client**: `Pick`<[`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract), ``"find"`` \| ``"openPointInTimeForType"`` \| ``"closePointInTime"``\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/point_in_time_finder.d.ts:12 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsDeleteByNamespaceOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsDeleteByNamespaceOptions.md new file mode 100644 index 0000000000000..17fa13e76ec5f --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsDeleteByNamespaceOptions.md @@ -0,0 +1,46 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsDeleteByNamespaceOptions + +# Interface: SavedObjectsDeleteByNamespaceOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsDeleteByNamespaceOptions + +## Hierarchy + +- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) + + ↳ **`SavedObjectsDeleteByNamespaceOptions`** + +## Table of contents + +### Properties + +- [namespace](client._internal_namespace.SavedObjectsDeleteByNamespaceOptions.md#namespace) +- [refresh](client._internal_namespace.SavedObjectsDeleteByNamespaceOptions.md#refresh) + +## Properties + +### namespace + +• `Optional` **namespace**: `string` + +Specify the namespace for this operation + +#### Inherited from + +[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:126 + +___ + +### refresh + +• `Optional` **refresh**: `boolean` + +The Elasticsearch supports only boolean flag for this operation + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:49 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsDeleteOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsDeleteOptions.md new file mode 100644 index 0000000000000..21bd9feec57cf --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsDeleteOptions.md @@ -0,0 +1,59 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsDeleteOptions + +# Interface: SavedObjectsDeleteOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsDeleteOptions + +## Hierarchy + +- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) + + ↳ **`SavedObjectsDeleteOptions`** + +## Table of contents + +### Properties + +- [force](client._internal_namespace.SavedObjectsDeleteOptions.md#force) +- [namespace](client._internal_namespace.SavedObjectsDeleteOptions.md#namespace) +- [refresh](client._internal_namespace.SavedObjectsDeleteOptions.md#refresh) + +## Properties + +### force + +• `Optional` **force**: `boolean` + +Force deletion of an object that exists in multiple namespaces + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:229 + +___ + +### namespace + +• `Optional` **namespace**: `string` + +Specify the namespace for this operation + +#### Inherited from + +[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:126 + +___ + +### refresh + +• `Optional` **refresh**: [`MutatingOperationRefreshSetting`](../modules/client._internal_namespace.md#mutatingoperationrefreshsetting) + +The Elasticsearch Refresh setting for this operation + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:227 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsExportTransformContext.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsExportTransformContext.md new file mode 100644 index 0000000000000..2b82cecc98091 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsExportTransformContext.md @@ -0,0 +1,26 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsExportTransformContext + +# Interface: SavedObjectsExportTransformContext + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsExportTransformContext + +Context passed down to a [export transform function](../modules/client._internal_namespace.md#savedobjectsexporttransform) + +## Table of contents + +### Properties + +- [request](client._internal_namespace.SavedObjectsExportTransformContext.md#request) + +## Properties + +### request + +• **request**: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> + +The request that initiated the export request. Can be used to create scoped +services or client inside the [transformation](../modules/client._internal_namespace.md#savedobjectsexporttransform) + +#### Defined in + +src/core/target/types/server/saved_objects/export/types.d.ts:87 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindOptions.md new file mode 100644 index 0000000000000..1cc767734ce55 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindOptions.md @@ -0,0 +1,270 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsFindOptions + +# Interface: SavedObjectsFindOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsFindOptions + +## Table of contents + +### Properties + +- [aggs](client._internal_namespace.SavedObjectsFindOptions.md#aggs) +- [defaultSearchOperator](client._internal_namespace.SavedObjectsFindOptions.md#defaultsearchoperator) +- [fields](client._internal_namespace.SavedObjectsFindOptions.md#fields) +- [filter](client._internal_namespace.SavedObjectsFindOptions.md#filter) +- [hasReference](client._internal_namespace.SavedObjectsFindOptions.md#hasreference) +- [hasReferenceOperator](client._internal_namespace.SavedObjectsFindOptions.md#hasreferenceoperator) +- [namespaces](client._internal_namespace.SavedObjectsFindOptions.md#namespaces) +- [page](client._internal_namespace.SavedObjectsFindOptions.md#page) +- [perPage](client._internal_namespace.SavedObjectsFindOptions.md#perpage) +- [pit](client._internal_namespace.SavedObjectsFindOptions.md#pit) +- [preference](client._internal_namespace.SavedObjectsFindOptions.md#preference) +- [rootSearchFields](client._internal_namespace.SavedObjectsFindOptions.md#rootsearchfields) +- [search](client._internal_namespace.SavedObjectsFindOptions.md#search) +- [searchAfter](client._internal_namespace.SavedObjectsFindOptions.md#searchafter) +- [searchFields](client._internal_namespace.SavedObjectsFindOptions.md#searchfields) +- [sortField](client._internal_namespace.SavedObjectsFindOptions.md#sortfield) +- [sortOrder](client._internal_namespace.SavedObjectsFindOptions.md#sortorder) +- [type](client._internal_namespace.SavedObjectsFindOptions.md#type) +- [typeToNamespacesMap](client._internal_namespace.SavedObjectsFindOptions.md#typetonamespacesmap) + +## Properties + +### aggs + +• `Optional` **aggs**: `Record`<`string`, `AggregationsAggregationContainer`\> + +A record of aggregations to perform. +The API currently only supports a limited set of metrics and bucket aggregation types. +Additional aggregation types can be contributed to Core. + +**`example`** +Aggregating on SO attribute field +```ts +const aggs = { latest_version: { max: { field: 'dashboard.attributes.version' } } }; +return client.find({ type: 'dashboard', aggs }) +``` + +**`example`** +Aggregating on SO root field +```ts +const aggs = { latest_update: { max: { field: 'dashboard.updated_at' } } }; +return client.find({ type: 'dashboard', aggs }) +``` + +**`alpha`** + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:103 + +___ + +### defaultSearchOperator + +• `Optional` **defaultSearchOperator**: ``"AND"`` \| ``"OR"`` + +The search operator to use with the provided filter. Defaults to `OR` + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:80 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +An array of fields to include in the results + +**`example`** +SavedObjects.find({type: 'dashboard', fields: ['attributes.name', 'attributes.location']}) + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:54 + +___ + +### filter + +• `Optional` **filter**: `any` + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:81 + +___ + +### hasReference + +• `Optional` **hasReference**: [`SavedObjectsFindOptionsReference`](client._internal_namespace.SavedObjectsFindOptionsReference.md) \| [`SavedObjectsFindOptionsReference`](client._internal_namespace.SavedObjectsFindOptionsReference.md)[] + +Search for documents having a reference to the specified objects. +Use `hasReferenceOperator` to specify the operator to use when searching for multiple references. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:72 + +___ + +### hasReferenceOperator + +• `Optional` **hasReferenceOperator**: ``"AND"`` \| ``"OR"`` + +The operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR` + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:76 + +___ + +### namespaces + +• `Optional` **namespaces**: `string`[] + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:104 + +___ + +### page + +• `Optional` **page**: `number` + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:45 + +___ + +### perPage + +• `Optional` **perPage**: `number` + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:46 + +___ + +### pit + +• `Optional` **pit**: [`SavedObjectsPitParams`](client._internal_namespace.SavedObjectsPitParams.md) + +Search against a specific Point In Time (PIT) that you've opened with [SavedObjectsClient.openPointInTimeForType](../classes/client._internal_namespace.SavedObjectsClient.md#openpointintimefortype). + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:118 + +___ + +### preference + +• `Optional` **preference**: `string` + +An optional ES preference value to be used for the query + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:114 + +___ + +### rootSearchFields + +• `Optional` **rootSearchFields**: `string`[] + +The fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not +be modified. If used in conjunction with `searchFields`, both are concatenated together. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:67 + +___ + +### search + +• `Optional` **search**: `string` + +Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:56 + +___ + +### searchAfter + +• `Optional` **searchAfter**: `string`[] + +Use the sort values from the previous page to retrieve the next page of results. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:62 + +___ + +### searchFields + +• `Optional` **searchFields**: `string`[] + +The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:58 + +___ + +### sortField + +• `Optional` **sortField**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:47 + +___ + +### sortOrder + +• `Optional` **sortOrder**: `SortOrder` + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:48 + +___ + +### type + +• **type**: `string` \| `string`[] + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:44 + +___ + +### typeToNamespacesMap + +• `Optional` **typeToNamespacesMap**: `Map`<`string`, `undefined` \| `string`[]\> + +This map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved +object client wrapper. +If this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query. +Any types that are not included in this map will be excluded entirely. +If a type is included but its value is undefined, the operation will search for that type in the Default namespace. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:112 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindOptionsReference.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindOptionsReference.md new file mode 100644 index 0000000000000..dd1f782c26b7d --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindOptionsReference.md @@ -0,0 +1,32 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsFindOptionsReference + +# Interface: SavedObjectsFindOptionsReference + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsFindOptionsReference + +## Table of contents + +### Properties + +- [id](client._internal_namespace.SavedObjectsFindOptionsReference.md#id) +- [type](client._internal_namespace.SavedObjectsFindOptionsReference.md#type) + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:30 + +___ + +### type + +• **type**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:29 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindResponse.md new file mode 100644 index 0000000000000..5fd16ec67e781 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindResponse.md @@ -0,0 +1,88 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsFindResponse + +# Interface: SavedObjectsFindResponse + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsFindResponse + +Return type of the Saved Objects `find()` method. + +*Note*: this type is different between the Public and Server Saved Objects +clients. + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | +| `A` | `unknown` | + +## Table of contents + +### Properties + +- [aggregations](client._internal_namespace.SavedObjectsFindResponse.md#aggregations) +- [page](client._internal_namespace.SavedObjectsFindResponse.md#page) +- [per\_page](client._internal_namespace.SavedObjectsFindResponse.md#per_page) +- [pit\_id](client._internal_namespace.SavedObjectsFindResponse.md#pit_id) +- [saved\_objects](client._internal_namespace.SavedObjectsFindResponse.md#saved_objects) +- [total](client._internal_namespace.SavedObjectsFindResponse.md#total) + +## Properties + +### aggregations + +• `Optional` **aggregations**: `A` + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:157 + +___ + +### page + +• **page**: `number` + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:161 + +___ + +### per\_page + +• **per\_page**: `number` + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:160 + +___ + +### pit\_id + +• `Optional` **pit\_id**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:162 + +___ + +### saved\_objects + +• **saved\_objects**: [`SavedObjectsFindResult`](client._internal_namespace.SavedObjectsFindResult.md)<`T`\>[] + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:158 + +___ + +### total + +• **total**: `number` + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:159 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindResult.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindResult.md new file mode 100644 index 0000000000000..aa7578f7daaa6 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsFindResult.md @@ -0,0 +1,262 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsFindResult + +# Interface: SavedObjectsFindResult + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsFindResult + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +## Hierarchy + +- [`SavedObject`](client._internal_namespace.SavedObject.md)<`T`\> + + ↳ **`SavedObjectsFindResult`** + +## Table of contents + +### Properties + +- [attributes](client._internal_namespace.SavedObjectsFindResult.md#attributes) +- [coreMigrationVersion](client._internal_namespace.SavedObjectsFindResult.md#coremigrationversion) +- [error](client._internal_namespace.SavedObjectsFindResult.md#error) +- [id](client._internal_namespace.SavedObjectsFindResult.md#id) +- [migrationVersion](client._internal_namespace.SavedObjectsFindResult.md#migrationversion) +- [namespaces](client._internal_namespace.SavedObjectsFindResult.md#namespaces) +- [originId](client._internal_namespace.SavedObjectsFindResult.md#originid) +- [references](client._internal_namespace.SavedObjectsFindResult.md#references) +- [score](client._internal_namespace.SavedObjectsFindResult.md#score) +- [sort](client._internal_namespace.SavedObjectsFindResult.md#sort) +- [type](client._internal_namespace.SavedObjectsFindResult.md#type) +- [updated\_at](client._internal_namespace.SavedObjectsFindResult.md#updated_at) +- [version](client._internal_namespace.SavedObjectsFindResult.md#version) + +## Properties + +### attributes + +• **attributes**: `T` + +{@inheritdoc SavedObjectAttributes} + +#### Inherited from + +[SavedObject](client._internal_namespace.SavedObject.md).[attributes](client._internal_namespace.SavedObject.md#attributes) + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:61 + +___ + +### coreMigrationVersion + +• `Optional` **coreMigrationVersion**: `string` + +A semver value that is used when upgrading objects between Kibana versions. + +#### Inherited from + +[SavedObject](client._internal_namespace.SavedObject.md).[coreMigrationVersion](client._internal_namespace.SavedObject.md#coremigrationversion) + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:67 + +___ + +### error + +• `Optional` **error**: [`SavedObjectError`](client._internal_namespace.SavedObjectError.md) + +#### Inherited from + +[SavedObject](client._internal_namespace.SavedObject.md).[error](client._internal_namespace.SavedObject.md#error) + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:59 + +___ + +### id + +• **id**: `string` + +The ID of this Saved Object, guaranteed to be unique for all objects of the same `type` + +#### Inherited from + +[SavedObject](client._internal_namespace.SavedObject.md).[id](client._internal_namespace.SavedObject.md#id) + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:52 + +___ + +### migrationVersion + +• `Optional` **migrationVersion**: [`SavedObjectsMigrationVersion`](client._internal_namespace.SavedObjectsMigrationVersion.md) + +{@inheritdoc SavedObjectsMigrationVersion} + +#### Inherited from + +[SavedObject](client._internal_namespace.SavedObject.md).[migrationVersion](client._internal_namespace.SavedObject.md#migrationversion) + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:65 + +___ + +### namespaces + +• `Optional` **namespaces**: `string`[] + +Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with +`namespaceType: 'agnostic'`. + +#### Inherited from + +[SavedObject](client._internal_namespace.SavedObject.md).[namespaces](client._internal_namespace.SavedObject.md#namespaces) + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:72 + +___ + +### originId + +• `Optional` **originId**: `string` + +The ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration +from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import +to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given +space. + +#### Inherited from + +[SavedObject](client._internal_namespace.SavedObject.md).[originId](client._internal_namespace.SavedObject.md#originid) + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:79 + +___ + +### references + +• **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] + +{@inheritdoc SavedObjectReference} + +#### Inherited from + +[SavedObject](client._internal_namespace.SavedObject.md).[references](client._internal_namespace.SavedObject.md#references) + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:63 + +___ + +### score + +• **score**: `number` + +The Elasticsearch `_score` of this result. + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:117 + +___ + +### sort + +• `Optional` **sort**: `string`[] + +The Elasticsearch `sort` value of this result. + +**`remarks`** +This can be passed directly to the `searchAfter` param in the [SavedObjectsFindOptions](client._internal_namespace.SavedObjectsFindOptions.md) +in order to page through large numbers of hits. It is recommended you use this alongside +a Point In Time (PIT) that was opened with [SavedObjectsClient.openPointInTimeForType](../classes/client._internal_namespace.SavedObjectsClient.md#openpointintimefortype). + +**`example`** +```ts +const { id } = await savedObjectsClient.openPointInTimeForType('visualization'); +const page1 = await savedObjectsClient.find({ + type: 'visualization', + sortField: 'updated_at', + sortOrder: 'asc', + pit: { id }, +}); +const lastHit = page1.saved_objects[page1.saved_objects.length - 1]; +const page2 = await savedObjectsClient.find({ + type: 'visualization', + sortField: 'updated_at', + sortOrder: 'asc', + pit: { id: page1.pit_id }, + searchAfter: lastHit.sort, +}); +await savedObjectsClient.closePointInTime(page2.pit_id); +``` + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:146 + +___ + +### type + +• **type**: `string` + +The type of Saved Object. Each plugin can define it's own custom Saved Object types. + +#### Inherited from + +[SavedObject](client._internal_namespace.SavedObject.md).[type](client._internal_namespace.SavedObject.md#type) + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:54 + +___ + +### updated\_at + +• `Optional` **updated\_at**: `string` + +Timestamp of the last time this document had been updated. + +#### Inherited from + +[SavedObject](client._internal_namespace.SavedObject.md).[updated_at](client._internal_namespace.SavedObject.md#updated_at) + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:58 + +___ + +### version + +• `Optional` **version**: `string` + +An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. + +#### Inherited from + +[SavedObject](client._internal_namespace.SavedObject.md).[version](client._internal_namespace.SavedObject.md#version) + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:56 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportActionRequiredWarning.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportActionRequiredWarning.md new file mode 100644 index 0000000000000..e2996e270116e --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportActionRequiredWarning.md @@ -0,0 +1,65 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsImportActionRequiredWarning + +# Interface: SavedObjectsImportActionRequiredWarning + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsImportActionRequiredWarning + +A warning meant to notify that a specific user action is required to finalize the import +of some type of object. + +**`remark`** The `actionUrl` must be a path relative to the basePath, and not include it. + +## Table of contents + +### Properties + +- [actionPath](client._internal_namespace.SavedObjectsImportActionRequiredWarning.md#actionpath) +- [buttonLabel](client._internal_namespace.SavedObjectsImportActionRequiredWarning.md#buttonlabel) +- [message](client._internal_namespace.SavedObjectsImportActionRequiredWarning.md#message) +- [type](client._internal_namespace.SavedObjectsImportActionRequiredWarning.md#type) + +## Properties + +### actionPath + +• **actionPath**: `string` + +The path (without the basePath) that the user should be redirect to address this warning. + +#### Defined in + +src/core/target/types/server/saved_objects/import/types.d.ts:191 + +___ + +### buttonLabel + +• `Optional` **buttonLabel**: `string` + +An optional label to use for the link button. If unspecified, a default label will be used. + +#### Defined in + +src/core/target/types/server/saved_objects/import/types.d.ts:193 + +___ + +### message + +• **message**: `string` + +The translated message to display to the user. + +#### Defined in + +src/core/target/types/server/saved_objects/import/types.d.ts:189 + +___ + +### type + +• **type**: ``"action_required"`` + +#### Defined in + +src/core/target/types/server/saved_objects/import/types.d.ts:187 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportHookResult.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportHookResult.md new file mode 100644 index 0000000000000..37e2cbd5d788b --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportHookResult.md @@ -0,0 +1,25 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsImportHookResult + +# Interface: SavedObjectsImportHookResult + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsImportHookResult + +Result from a [import hook](../modules/client._internal_namespace.md#savedobjectsimporthook) + +## Table of contents + +### Properties + +- [warnings](client._internal_namespace.SavedObjectsImportHookResult.md#warnings) + +## Properties + +### warnings + +• `Optional` **warnings**: [`SavedObjectsImportWarning`](../modules/client._internal_namespace.md#savedobjectsimportwarning)[] + +An optional list of warnings to display in the UI when the import succeeds. + +#### Defined in + +src/core/target/types/server/saved_objects/import/types.d.ts:213 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportSimpleWarning.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportSimpleWarning.md new file mode 100644 index 0000000000000..55f2c60462af4 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsImportSimpleWarning.md @@ -0,0 +1,36 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsImportSimpleWarning + +# Interface: SavedObjectsImportSimpleWarning + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsImportSimpleWarning + +A simple informative warning that will be displayed to the user. + +## Table of contents + +### Properties + +- [message](client._internal_namespace.SavedObjectsImportSimpleWarning.md#message) +- [type](client._internal_namespace.SavedObjectsImportSimpleWarning.md#type) + +## Properties + +### message + +• **message**: `string` + +The translated message to display to the user + +#### Defined in + +src/core/target/types/server/saved_objects/import/types.d.ts:176 + +___ + +### type + +• **type**: ``"simple"`` + +#### Defined in + +src/core/target/types/server/saved_objects/import/types.d.ts:174 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsIncrementCounterField.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsIncrementCounterField.md new file mode 100644 index 0000000000000..b215848243659 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsIncrementCounterField.md @@ -0,0 +1,36 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsIncrementCounterField + +# Interface: SavedObjectsIncrementCounterField + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsIncrementCounterField + +## Table of contents + +### Properties + +- [fieldName](client._internal_namespace.SavedObjectsIncrementCounterField.md#fieldname) +- [incrementBy](client._internal_namespace.SavedObjectsIncrementCounterField.md#incrementby) + +## Properties + +### fieldName + +• **fieldName**: `string` + +The field name to increment the counter by. + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:63 + +___ + +### incrementBy + +• `Optional` **incrementBy**: `number` + +The number to increment the field by (defaults to 1). + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:65 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsIncrementCounterOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsIncrementCounterOptions.md new file mode 100644 index 0000000000000..ce239bd55e5c2 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsIncrementCounterOptions.md @@ -0,0 +1,93 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsIncrementCounterOptions + +# Interface: SavedObjectsIncrementCounterOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsIncrementCounterOptions + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Attributes` | `unknown` | + +## Hierarchy + +- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) + + ↳ **`SavedObjectsIncrementCounterOptions`** + +## Table of contents + +### Properties + +- [initialize](client._internal_namespace.SavedObjectsIncrementCounterOptions.md#initialize) +- [migrationVersion](client._internal_namespace.SavedObjectsIncrementCounterOptions.md#migrationversion) +- [namespace](client._internal_namespace.SavedObjectsIncrementCounterOptions.md#namespace) +- [refresh](client._internal_namespace.SavedObjectsIncrementCounterOptions.md#refresh) +- [upsertAttributes](client._internal_namespace.SavedObjectsIncrementCounterOptions.md#upsertattributes) + +## Properties + +### initialize + +• `Optional` **initialize**: `boolean` + +(default=false) If true, sets all the counter fields to 0 if they don't +already exist. Existing fields will be left as-is and won't be incremented. + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:30 + +___ + +### migrationVersion + +• `Optional` **migrationVersion**: [`SavedObjectsMigrationVersion`](client._internal_namespace.SavedObjectsMigrationVersion.md) + +[SavedObjectsMigrationVersion](client._internal_namespace.SavedObjectsMigrationVersion.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:32 + +___ + +### namespace + +• `Optional` **namespace**: `string` + +Specify the namespace for this operation + +#### Inherited from + +[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:126 + +___ + +### refresh + +• `Optional` **refresh**: [`MutatingOperationRefreshSetting`](../modules/client._internal_namespace.md#mutatingoperationrefreshsetting) + +(default='wait_for') The Elasticsearch refresh setting for this +operation. See [MutatingOperationRefreshSetting](../modules/client._internal_namespace.md#mutatingoperationrefreshsetting) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:37 + +___ + +### upsertAttributes + +• `Optional` **upsertAttributes**: `Attributes` + +Attributes to use when upserting the document if it doesn't exist. + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:41 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMappingProperties.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMappingProperties.md new file mode 100644 index 0000000000000..5dca5a908c566 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMappingProperties.md @@ -0,0 +1,11 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsMappingProperties + +# Interface: SavedObjectsMappingProperties + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsMappingProperties + +Describe the fields of a [saved object type](client._internal_namespace.SavedObjectsTypeMappingDefinition.md). + +## Indexable + +▪ [field: `string`]: [`SavedObjectsFieldMapping`](../modules/client._internal_namespace.md#savedobjectsfieldmapping) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMigrationLogger.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMigrationLogger.md new file mode 100644 index 0000000000000..399885d1ab4ae --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMigrationLogger.md @@ -0,0 +1,124 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsMigrationLogger + +# Interface: SavedObjectsMigrationLogger + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsMigrationLogger + +## Table of contents + +### Methods + +- [debug](client._internal_namespace.SavedObjectsMigrationLogger.md#debug) +- [error](client._internal_namespace.SavedObjectsMigrationLogger.md#error) +- [info](client._internal_namespace.SavedObjectsMigrationLogger.md#info) +- [warn](client._internal_namespace.SavedObjectsMigrationLogger.md#warn) +- [warning](client._internal_namespace.SavedObjectsMigrationLogger.md#warning) + +## Methods + +### debug + +▸ **debug**(`msg`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `string` | + +#### Returns + +`void` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/core/migration_logger.d.ts:5 + +___ + +### error + +▸ **error**<`Meta`\>(`msg`, `meta`): `void` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Meta` | extends `LogMeta` = `LogMeta` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `string` | +| `meta` | `Meta` | + +#### Returns + +`void` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/core/migration_logger.d.ts:12 + +___ + +### info + +▸ **info**(`msg`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `string` | + +#### Returns + +`void` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/core/migration_logger.d.ts:6 + +___ + +### warn + +▸ **warn**(`msg`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `string` | + +#### Returns + +`void` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/core/migration_logger.d.ts:11 + +___ + +### warning + +▸ **warning**(`msg`): `void` + +**`deprecated`** Use `warn` instead. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `string` | + +#### Returns + +`void` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/core/migration_logger.d.ts:10 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMigrationVersion.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMigrationVersion.md new file mode 100644 index 0000000000000..deee7313ee96b --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsMigrationVersion.md @@ -0,0 +1,21 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsMigrationVersion + +# Interface: SavedObjectsMigrationVersion + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsMigrationVersion + +Information about the migrations that have been applied to this SavedObject. +When Kibana starts up, KibanaMigrator detects outdated documents and +migrates them based on this value. For each migration that has been applied, +the plugin's name is used as a key and the latest migration version as the +value. + +**`example`** +migrationVersion: { + dashboard: '7.1.1', + space: '6.6.6', +} + +## Indexable + +▪ [pluginName: `string`]: `string` diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md new file mode 100644 index 0000000000000..1b5d7dd5c90ea --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md @@ -0,0 +1,54 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsOpenPointInTimeOptions + +# Interface: SavedObjectsOpenPointInTimeOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsOpenPointInTimeOptions + +## Table of contents + +### Properties + +- [keepAlive](client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md#keepalive) +- [namespaces](client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md#namespaces) +- [preference](client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md#preference) + +## Properties + +### keepAlive + +• `Optional` **keepAlive**: `string` + +Optionally specify how long ES should keep the PIT alive until the next request. Defaults to `5m`. + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:320 + +___ + +### namespaces + +• `Optional` **namespaces**: `string`[] + +An optional list of namespaces to be used when opening the PIT. + +When the spaces plugin is enabled: + - this will default to the user's current space (as determined by the URL) + - if specified, the user's current space will be ignored + - `['*']` will search across all available spaces + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:333 + +___ + +### preference + +• `Optional` **preference**: `string` + +An optional ES preference value to be used for the query. + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:324 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeResponse.md new file mode 100644 index 0000000000000..22718b1c3177c --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeResponse.md @@ -0,0 +1,23 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsOpenPointInTimeResponse + +# Interface: SavedObjectsOpenPointInTimeResponse + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsOpenPointInTimeResponse + +## Table of contents + +### Properties + +- [id](client._internal_namespace.SavedObjectsOpenPointInTimeResponse.md#id) + +## Properties + +### id + +• **id**: `string` + +PIT ID returned from ES. + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:342 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsPitParams.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsPitParams.md new file mode 100644 index 0000000000000..0c2d6fdc1cc4e --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsPitParams.md @@ -0,0 +1,32 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsPitParams + +# Interface: SavedObjectsPitParams + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsPitParams + +## Table of contents + +### Properties + +- [id](client._internal_namespace.SavedObjectsPitParams.md#id) +- [keepAlive](client._internal_namespace.SavedObjectsPitParams.md#keepalive) + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:36 + +___ + +### keepAlive + +• `Optional` **keepAlive**: `string` + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:37 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToOptions.md new file mode 100644 index 0000000000000..79de02623cf8a --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToOptions.md @@ -0,0 +1,46 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsRemoveReferencesToOptions + +# Interface: SavedObjectsRemoveReferencesToOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsRemoveReferencesToOptions + +## Hierarchy + +- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) + + ↳ **`SavedObjectsRemoveReferencesToOptions`** + +## Table of contents + +### Properties + +- [namespace](client._internal_namespace.SavedObjectsRemoveReferencesToOptions.md#namespace) +- [refresh](client._internal_namespace.SavedObjectsRemoveReferencesToOptions.md#refresh) + +## Properties + +### namespace + +• `Optional` **namespace**: `string` + +Specify the namespace for this operation + +#### Inherited from + +[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:126 + +___ + +### refresh + +• `Optional` **refresh**: `boolean` + +The Elasticsearch Refresh setting for this operation. Defaults to `true` + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:203 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md new file mode 100644 index 0000000000000..c6d285307c99d --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md @@ -0,0 +1,46 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsRemoveReferencesToResponse + +# Interface: SavedObjectsRemoveReferencesToResponse + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsRemoveReferencesToResponse + +## Hierarchy + +- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) + + ↳ **`SavedObjectsRemoveReferencesToResponse`** + +## Table of contents + +### Properties + +- [namespace](client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md#namespace) +- [updated](client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md#updated) + +## Properties + +### namespace + +• `Optional` **namespace**: `string` + +Specify the namespace for this operation + +#### Inherited from + +[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:126 + +___ + +### updated + +• **updated**: `number` + +The number of objects that have been updated by this operation + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:211 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsResolveResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsResolveResponse.md new file mode 100644 index 0000000000000..a4d66d064bf63 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsResolveResponse.md @@ -0,0 +1,61 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsResolveResponse + +# Interface: SavedObjectsResolveResponse + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsResolveResponse + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +## Table of contents + +### Properties + +- [alias\_target\_id](client._internal_namespace.SavedObjectsResolveResponse.md#alias_target_id) +- [outcome](client._internal_namespace.SavedObjectsResolveResponse.md#outcome) +- [saved\_object](client._internal_namespace.SavedObjectsResolveResponse.md#saved_object) + +## Properties + +### alias\_target\_id + +• `Optional` **alias\_target\_id**: `string` + +The ID of the object that the legacy URL alias points to. This is only defined when the outcome is `'aliasMatch'` or `'conflict'`. + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:311 + +___ + +### outcome + +• **outcome**: ``"exactMatch"`` \| ``"aliasMatch"`` \| ``"conflict"`` + +The outcome for a successful `resolve` call is one of the following values: + + * `'exactMatch'` -- One document exactly matched the given ID. + * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different + than the given ID. + * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the + `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID. + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:307 + +___ + +### saved\_object + +• **saved\_object**: [`SavedObject`](client._internal_namespace.SavedObject.md)<`T`\> + +The saved object that was found. + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:297 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsType.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsType.md new file mode 100644 index 0000000000000..b211135fc93ac --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsType.md @@ -0,0 +1,212 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsType + +# Interface: SavedObjectsType + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsType + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Attributes` | `any` | + +## Table of contents + +### Properties + +- [convertToAliasScript](client._internal_namespace.SavedObjectsType.md#converttoaliasscript) +- [convertToMultiNamespaceTypeVersion](client._internal_namespace.SavedObjectsType.md#converttomultinamespacetypeversion) +- [excludeOnUpgrade](client._internal_namespace.SavedObjectsType.md#excludeonupgrade) +- [hidden](client._internal_namespace.SavedObjectsType.md#hidden) +- [indexPattern](client._internal_namespace.SavedObjectsType.md#indexpattern) +- [management](client._internal_namespace.SavedObjectsType.md#management) +- [mappings](client._internal_namespace.SavedObjectsType.md#mappings) +- [migrations](client._internal_namespace.SavedObjectsType.md#migrations) +- [name](client._internal_namespace.SavedObjectsType.md#name) +- [namespaceType](client._internal_namespace.SavedObjectsType.md#namespacetype) +- [schemas](client._internal_namespace.SavedObjectsType.md#schemas) + +## Properties + +### convertToAliasScript + +• `Optional` **convertToAliasScript**: `string` + +If defined, will be used to convert the type to an alias. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:235 + +___ + +### convertToMultiNamespaceTypeVersion + +• `Optional` **convertToMultiNamespaceTypeVersion**: `string` + +If defined, objects of this type will be converted to a 'multiple' or 'multiple-isolated' namespace type when migrating to this +version. + +Requirements: + + 1. This string value must be a valid semver version + 2. This type must have previously specified [`namespaceType: 'single'`](../modules/client._internal_namespace.md#savedobjectsnamespacetype) + 3. This type must also specify [`namespaceType: 'multiple'`](../modules/client._internal_namespace.md#savedobjectsnamespacetype) *or* + [`namespaceType: 'multiple-isolated'`](../modules/client._internal_namespace.md#savedobjectsnamespacetype) + +Example of a single-namespace type in 7.12: + +```ts +{ + name: 'foo', + hidden: false, + namespaceType: 'single', + mappings: {...} +} +``` + +Example after converting to a multi-namespace (isolated) type in 8.0: + +```ts +{ + name: 'foo', + hidden: false, + namespaceType: 'multiple-isolated', + mappings: {...}, + convertToMultiNamespaceTypeVersion: '8.0.0' +} +``` + +Example after converting to a multi-namespace (shareable) type in 8.1: + +```ts +{ + name: 'foo', + hidden: false, + namespaceType: 'multiple', + mappings: {...}, + convertToMultiNamespaceTypeVersion: '8.0.0' +} +``` + +Note: migration function(s) can be optionally specified for any of these versions and will not interfere with the conversion process. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:305 + +___ + +### excludeOnUpgrade + +• `Optional` **excludeOnUpgrade**: [`SavedObjectTypeExcludeFromUpgradeFilterHook`](../modules/client._internal_namespace.md#savedobjecttypeexcludefromupgradefilterhook) + +If defined, allows a type to exclude unneeded documents from the migration process and effectively be deleted. +See [SavedObjectTypeExcludeFromUpgradeFilterHook](../modules/client._internal_namespace.md#savedobjecttypeexcludefromupgradefilterhook) for more details. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:240 + +___ + +### hidden + +• **hidden**: `boolean` + +Is the type hidden by default. If true, repositories will not have access to this type unless explicitly +declared as an `extraType` when creating the repository. + +See {@link SavedObjectsServiceStart.createInternalRepository | createInternalRepository}. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:223 + +___ + +### indexPattern + +• `Optional` **indexPattern**: `string` + +If defined, the type instances will be stored in the given index instead of the default one. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:231 + +___ + +### management + +• `Optional` **management**: [`SavedObjectsTypeManagementDefinition`](client._internal_namespace.SavedObjectsTypeManagementDefinition.md)<`Attributes`\> + +An optional [saved objects management section](client._internal_namespace.SavedObjectsTypeManagementDefinition.md) definition for the type. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:309 + +___ + +### mappings + +• **mappings**: [`SavedObjectsTypeMappingDefinition`](client._internal_namespace.SavedObjectsTypeMappingDefinition.md) + +The [mapping definition](client._internal_namespace.SavedObjectsTypeMappingDefinition.md) for the type. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:244 + +___ + +### migrations + +• `Optional` **migrations**: [`SavedObjectMigrationMap`](client._internal_namespace.SavedObjectMigrationMap.md) \| () => [`SavedObjectMigrationMap`](client._internal_namespace.SavedObjectMigrationMap.md) + +An optional map of [migrations](../modules/client._internal_namespace.md#savedobjectmigrationfn) or a function returning a map of [migrations](../modules/client._internal_namespace.md#savedobjectmigrationfn) to be used to migrate the type. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:248 + +___ + +### name + +• **name**: `string` + +The name of the type, which is also used as the internal id. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:216 + +___ + +### namespaceType + +• **namespaceType**: [`SavedObjectsNamespaceType`](../modules/client._internal_namespace.md#savedobjectsnamespacetype) + +The [namespace type](../modules/client._internal_namespace.md#savedobjectsnamespacetype) for the type. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:227 + +___ + +### schemas + +• `Optional` **schemas**: [`SavedObjectsValidationMap`](client._internal_namespace.SavedObjectsValidationMap.md) \| () => [`SavedObjectsValidationMap`](client._internal_namespace.SavedObjectsValidationMap.md) + +An optional schema that can be used to validate the attributes of the type. + +When provided, calls to [create](../classes/client._internal_namespace.SavedObjectsClient.md#create) will be validated against this schema. + +See [SavedObjectsValidationMap](client._internal_namespace.SavedObjectsValidationMap.md) for more details. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:256 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsTypeManagementDefinition.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsTypeManagementDefinition.md new file mode 100644 index 0000000000000..4c9f9b9342215 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsTypeManagementDefinition.md @@ -0,0 +1,299 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsTypeManagementDefinition + +# Interface: SavedObjectsTypeManagementDefinition + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsTypeManagementDefinition + +Configuration options for the [type](client._internal_namespace.SavedObjectsType.md)'s management section. + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Attributes` | `any` | + +## Table of contents + +### Properties + +- [defaultSearchField](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#defaultsearchfield) +- [displayName](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#displayname) +- [icon](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#icon) +- [importableAndExportable](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#importableandexportable) +- [isExportable](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#isexportable) +- [onExport](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#onexport) +- [onImport](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#onimport) +- [visibleInManagement](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#visibleinmanagement) + +### Methods + +- [getEditUrl](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#getediturl) +- [getInAppUrl](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#getinappurl) +- [getTitle](client._internal_namespace.SavedObjectsTypeManagementDefinition.md#gettitle) + +## Properties + +### defaultSearchField + +• `Optional` **defaultSearchField**: `string` + +The default search field to use for this type. Defaults to `id`. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:337 + +___ + +### displayName + +• `Optional` **displayName**: `string` + +When specified, will be used instead of the type's name in SO management section's labels. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:324 + +___ + +### icon + +• `Optional` **icon**: `string` + +The eui icon name to display in the management table. +If not defined, the default icon will be used. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:342 + +___ + +### importableAndExportable + +• `Optional` **importableAndExportable**: `boolean` + +Is the type importable or exportable. Defaults to `false`. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:320 + +___ + +### isExportable + +• `Optional` **isExportable**: [`SavedObjectsExportablePredicate`](../modules/client._internal_namespace.md#savedobjectsexportablepredicate)<`Attributes`\> + +Optional hook to specify whether an object should be exportable. + +If specified, `isExportable` will be called during export for each +of this type's objects in the export, and the ones not matching the +predicate will be excluded from the export. + +When implementing both `isExportable` and `onExport`, it is mandatory that +`isExportable` returns the same value for an object before and after going +though the export transform. +E.g `isExportable(objectBeforeTransform) === isExportable(objectAfterTransform)` + +**`example`** +Registering a type with a per-object exportability predicate +```ts +// src/plugins/my_plugin/server/plugin.ts +import { myType } from './saved_objects'; + +export class Plugin() { + setup: (core: CoreSetup) => { + core.savedObjects.registerType({ + ...myType, + management: { + ...myType.management, + isExportable: (object) => { + if (object.attributes.myCustomAttr === 'foo') { + return false; + } + return true; + } + }, + }); + } +} +``` + +**`remarks`** `importableAndExportable` must be `true` to specify this property. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:462 + +___ + +### onExport + +• `Optional` **onExport**: [`SavedObjectsExportTransform`](../modules/client._internal_namespace.md#savedobjectsexporttransform)<`Attributes`\> + +An optional export transform function that can be used transform the objects of the registered type during +the export process. + +It can be used to either mutate the exported objects, or add additional objects (of any type) to the export list. + +See [the transform type documentation](../modules/client._internal_namespace.md#savedobjectsexporttransform) for more info and examples. + +When implementing both `isExportable` and `onExport`, it is mandatory that +`isExportable` returns the same value for an object before and after going +though the export transform. +E.g `isExportable(objectBeforeTransform) === isExportable(objectAfterTransform)` + +**`remarks`** `importableAndExportable` must be `true` to specify this property. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:380 + +___ + +### onImport + +• `Optional` **onImport**: [`SavedObjectsImportHook`](../modules/client._internal_namespace.md#savedobjectsimporthook)<`Attributes`\> + +An optional [import hook](../modules/client._internal_namespace.md#savedobjectsimporthook) to use when importing given type. + +Import hooks are executed during the savedObjects import process and allow to interact +with the imported objects. See the [hook documentation](../modules/client._internal_namespace.md#savedobjectsimporthook) +for more info. + +**`example`** +Registering a hook displaying a warning about a specific type of object +```ts +// src/plugins/my_plugin/server/plugin.ts +import { myType } from './saved_objects'; + +export class Plugin() { + setup: (core: CoreSetup) => { + core.savedObjects.registerType({ + ...myType, + management: { + ...myType.management, + onImport: (objects) => { + if(someActionIsNeeded(objects)) { + return { + warnings: [ + { + type: 'action_required', + message: 'Objects need to be manually enabled after import', + actionPath: '/app/my-app/require-activation', + }, + ] + } + } + return {}; + } + }, + }); + } +} +``` + +**`remarks`** messages returned in the warnings are user facing and must be translated. + +**`remarks`** `importableAndExportable` must be `true` to specify this property. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:423 + +___ + +### visibleInManagement + +• `Optional` **visibleInManagement**: `boolean` + +When set to false, the type will not be listed or searchable in the SO management section. +Main usage of setting this property to false for a type is when objects from the type should +be included in the export via references or export hooks, but should not directly appear in the SOM. +Defaults to `true`. + +**`remarks`** `importableAndExportable` must be `true` to specify this property. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:333 + +## Methods + +### getEditUrl + +▸ `Optional` **getEditUrl**(`savedObject`): `string` + +Function returning the url to use to redirect to the editing page of this object. +If not defined, editing will not be allowed. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `savedObject` | [`SavedObject`](client._internal_namespace.SavedObject.md)<`Attributes`\> | + +#### Returns + +`string` + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:352 + +___ + +### getInAppUrl + +▸ `Optional` **getInAppUrl**(`savedObject`): `Object` + +Function returning the url to use to redirect to this object from the management section. +If not defined, redirecting to the object will not be allowed. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `savedObject` | [`SavedObject`](client._internal_namespace.SavedObject.md)<`Attributes`\> | + +#### Returns + +`Object` + +an object containing a `path` and `uiCapabilitiesPath` properties. the `path` is the path to + the object page, relative to the base path. `uiCapabilitiesPath` is the path to check in the + [uiCapabilities](client._internal_namespace.Capabilities.md) to check if the user has permission to access the object. + +| Name | Type | +| :------ | :------ | +| `path` | `string` | +| `uiCapabilitiesPath` | `string` | + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:361 + +___ + +### getTitle + +▸ `Optional` **getTitle**(`savedObject`): `string` + +Function returning the title to display in the management table. +If not defined, will use the object's type and id to generate a label. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `savedObject` | [`SavedObject`](client._internal_namespace.SavedObject.md)<`Attributes`\> | + +#### Returns + +`string` + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:347 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsTypeMappingDefinition.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsTypeMappingDefinition.md new file mode 100644 index 0000000000000..4ebbf456a0556 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsTypeMappingDefinition.md @@ -0,0 +1,62 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsTypeMappingDefinition + +# Interface: SavedObjectsTypeMappingDefinition + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsTypeMappingDefinition + +Describe a saved object type mapping. + +**`example`** +```ts +const typeDefinition: SavedObjectsTypeMappingDefinition = { + properties: { + enabled: { + type: "boolean" + }, + sendUsageFrom: { + ignore_above: 256, + type: "keyword" + }, + lastReported: { + type: "date" + }, + lastVersionChecked: { + ignore_above: 256, + type: "keyword" + }, + } +} +``` + +## Table of contents + +### Properties + +- [dynamic](client._internal_namespace.SavedObjectsTypeMappingDefinition.md#dynamic) +- [properties](client._internal_namespace.SavedObjectsTypeMappingDefinition.md#properties) + +## Properties + +### dynamic + +• `Optional` **dynamic**: ``false`` \| ``"strict"`` + +The dynamic property of the mapping, either `false` or `'strict'`. If +unspecified `dynamic: 'strict'` will be inherited from the top-level +index mappings. + +#### Defined in + +src/core/target/types/server/saved_objects/mappings/types.d.ts:33 + +___ + +### properties + +• **properties**: [`SavedObjectsMappingProperties`](client._internal_namespace.SavedObjectsMappingProperties.md) + +The underlying properties of the type mapping + +#### Defined in + +src/core/target/types/server/saved_objects/mappings/types.d.ts:35 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md new file mode 100644 index 0000000000000..5f5243a72ad69 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md @@ -0,0 +1,68 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsUpdateObjectsSpacesObject + +# Interface: SavedObjectsUpdateObjectsSpacesObject + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsUpdateObjectsSpacesObject + +An object that should have its spaces updated. + +## Table of contents + +### Properties + +- [id](client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md#id) +- [spaces](client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md#spaces) +- [type](client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md#type) +- [version](client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md#version) + +## Properties + +### id + +• **id**: `string` + +The type of the object to update + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:14 + +___ + +### spaces + +• `Optional` **spaces**: `string`[] + +The space(s) that the object to update currently exists in. This is only intended to be used by SOC wrappers. + +**`internal`** + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:22 + +___ + +### type + +• **type**: `string` + +The ID of the object to update + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:16 + +___ + +### version + +• `Optional` **version**: `string` + +The version of the object to update; this is used for optimistic concurrency control. This is only intended to be used by SOC wrappers. + +**`internal`** + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:28 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesOptions.md new file mode 100644 index 0000000000000..403680115772c --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesOptions.md @@ -0,0 +1,48 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsUpdateObjectsSpacesOptions + +# Interface: SavedObjectsUpdateObjectsSpacesOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsUpdateObjectsSpacesOptions + +Options for the update operation. + +## Hierarchy + +- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) + + ↳ **`SavedObjectsUpdateObjectsSpacesOptions`** + +## Table of contents + +### Properties + +- [namespace](client._internal_namespace.SavedObjectsUpdateObjectsSpacesOptions.md#namespace) +- [refresh](client._internal_namespace.SavedObjectsUpdateObjectsSpacesOptions.md#refresh) + +## Properties + +### namespace + +• `Optional` **namespace**: `string` + +Specify the namespace for this operation + +#### Inherited from + +[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:126 + +___ + +### refresh + +• `Optional` **refresh**: [`MutatingOperationRefreshSetting`](../modules/client._internal_namespace.md#mutatingoperationrefreshsetting) + +The Elasticsearch Refresh setting for this operation + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:37 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponse.md new file mode 100644 index 0000000000000..204b50f484657 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponse.md @@ -0,0 +1,23 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsUpdateObjectsSpacesResponse + +# Interface: SavedObjectsUpdateObjectsSpacesResponse + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsUpdateObjectsSpacesResponse + +The response when objects' spaces are updated. + +## Table of contents + +### Properties + +- [objects](client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponse.md#objects) + +## Properties + +### objects + +• **objects**: [`SavedObjectsUpdateObjectsSpacesResponseObject`](client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponseObject.md)[] + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:45 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponseObject.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponseObject.md new file mode 100644 index 0000000000000..f529bdcf9344b --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponseObject.md @@ -0,0 +1,64 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsUpdateObjectsSpacesResponseObject + +# Interface: SavedObjectsUpdateObjectsSpacesResponseObject + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsUpdateObjectsSpacesResponseObject + +Details about a specific object's update result. + +## Table of contents + +### Properties + +- [error](client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponseObject.md#error) +- [id](client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponseObject.md#id) +- [spaces](client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponseObject.md#spaces) +- [type](client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponseObject.md#type) + +## Properties + +### error + +• `Optional` **error**: [`SavedObjectError`](client._internal_namespace.SavedObjectError.md) + +Included if there was an error updating this object's spaces + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:60 + +___ + +### id + +• **id**: `string` + +The ID of the referenced object + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:56 + +___ + +### spaces + +• **spaces**: `string`[] + +The space(s) that the referenced object exists in + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:58 + +___ + +### type + +• **type**: `string` + +The type of the referenced object + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/update_objects_spaces.d.ts:54 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateOptions.md new file mode 100644 index 0000000000000..0c7500b08b2fe --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateOptions.md @@ -0,0 +1,91 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsUpdateOptions + +# Interface: SavedObjectsUpdateOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsUpdateOptions + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Attributes` | `unknown` | + +## Hierarchy + +- [`SavedObjectsBaseOptions`](client._internal_namespace.SavedObjectsBaseOptions.md) + + ↳ **`SavedObjectsUpdateOptions`** + +## Table of contents + +### Properties + +- [namespace](client._internal_namespace.SavedObjectsUpdateOptions.md#namespace) +- [references](client._internal_namespace.SavedObjectsUpdateOptions.md#references) +- [refresh](client._internal_namespace.SavedObjectsUpdateOptions.md#refresh) +- [upsert](client._internal_namespace.SavedObjectsUpdateOptions.md#upsert) +- [version](client._internal_namespace.SavedObjectsUpdateOptions.md#version) + +## Properties + +### namespace + +• `Optional` **namespace**: `string` + +Specify the namespace for this operation + +#### Inherited from + +[SavedObjectsBaseOptions](client._internal_namespace.SavedObjectsBaseOptions.md).[namespace](client._internal_namespace.SavedObjectsBaseOptions.md#namespace) + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:126 + +___ + +### references + +• `Optional` **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] + +{@inheritdoc SavedObjectReference} + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:191 + +___ + +### refresh + +• `Optional` **refresh**: [`MutatingOperationRefreshSetting`](../modules/client._internal_namespace.md#mutatingoperationrefreshsetting) + +The Elasticsearch Refresh setting for this operation + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:193 + +___ + +### upsert + +• `Optional` **upsert**: `Attributes` + +If specified, will be used to perform an upsert if the document doesn't exist + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:195 + +___ + +### version + +• `Optional` **version**: `string` + +An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:189 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md new file mode 100644 index 0000000000000..2fa6a0e54a556 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md @@ -0,0 +1,199 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsUpdateResponse + +# Interface: SavedObjectsUpdateResponse + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsUpdateResponse + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +## Hierarchy + +- `Omit`<[`SavedObject`](client._internal_namespace.SavedObject.md)<`T`\>, ``"attributes"`` \| ``"references"``\> + + ↳ **`SavedObjectsUpdateResponse`** + +## Table of contents + +### Properties + +- [attributes](client._internal_namespace.SavedObjectsUpdateResponse.md#attributes) +- [coreMigrationVersion](client._internal_namespace.SavedObjectsUpdateResponse.md#coremigrationversion) +- [error](client._internal_namespace.SavedObjectsUpdateResponse.md#error) +- [id](client._internal_namespace.SavedObjectsUpdateResponse.md#id) +- [migrationVersion](client._internal_namespace.SavedObjectsUpdateResponse.md#migrationversion) +- [namespaces](client._internal_namespace.SavedObjectsUpdateResponse.md#namespaces) +- [originId](client._internal_namespace.SavedObjectsUpdateResponse.md#originid) +- [references](client._internal_namespace.SavedObjectsUpdateResponse.md#references) +- [type](client._internal_namespace.SavedObjectsUpdateResponse.md#type) +- [updated\_at](client._internal_namespace.SavedObjectsUpdateResponse.md#updated_at) +- [version](client._internal_namespace.SavedObjectsUpdateResponse.md#version) + +## Properties + +### attributes + +• **attributes**: `Partial`<`T`\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:271 + +___ + +### coreMigrationVersion + +• `Optional` **coreMigrationVersion**: `string` + +A semver value that is used when upgrading objects between Kibana versions. + +#### Inherited from + +Omit.coreMigrationVersion + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:67 + +___ + +### error + +• `Optional` **error**: [`SavedObjectError`](client._internal_namespace.SavedObjectError.md) + +#### Inherited from + +Omit.error + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:59 + +___ + +### id + +• **id**: `string` + +The ID of this Saved Object, guaranteed to be unique for all objects of the same `type` + +#### Inherited from + +Omit.id + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:52 + +___ + +### migrationVersion + +• `Optional` **migrationVersion**: [`SavedObjectsMigrationVersion`](client._internal_namespace.SavedObjectsMigrationVersion.md) + +{@inheritdoc SavedObjectsMigrationVersion} + +#### Inherited from + +Omit.migrationVersion + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:65 + +___ + +### namespaces + +• `Optional` **namespaces**: `string`[] + +Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with +`namespaceType: 'agnostic'`. + +#### Inherited from + +Omit.namespaces + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:72 + +___ + +### originId + +• `Optional` **originId**: `string` + +The ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration +from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import +to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given +space. + +#### Inherited from + +Omit.originId + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:79 + +___ + +### references + +• **references**: `undefined` \| [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] + +#### Defined in + +src/core/target/types/server/saved_objects/service/saved_objects_client.d.ts:272 + +___ + +### type + +• **type**: `string` + +The type of Saved Object. Each plugin can define it's own custom Saved Object types. + +#### Inherited from + +Omit.type + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:54 + +___ + +### updated\_at + +• `Optional` **updated\_at**: `string` + +Timestamp of the last time this document had been updated. + +#### Inherited from + +Omit.updated\_at + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:58 + +___ + +### version + +• `Optional` **version**: `string` + +An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. + +#### Inherited from + +Omit.version + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:56 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsValidationMap.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsValidationMap.md new file mode 100644 index 0000000000000..366dc9fe0a476 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SavedObjectsValidationMap.md @@ -0,0 +1,34 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SavedObjectsValidationMap + +# Interface: SavedObjectsValidationMap + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SavedObjectsValidationMap + +A map of [validation specs](../modules/client._internal_namespace.md#savedobjectsvalidationspec) to be used for a given type. +The map's keys must be valid semver versions. + +Any time you change the schema of a [SavedObjectsType](client._internal_namespace.SavedObjectsType.md), you should add a new entry +to this map for the Kibana version the change was introduced in. + +**`example`** +```typescript +const validationMap: SavedObjectsValidationMap = { + '1.0.0': schema.object({ + foo: schema.string(), + }), + '2.0.0': schema.object({ + foo: schema.string({ + minLength: 2, + validate(value) { + if (!/^[a-z]+$/.test(value)) { + return 'must be lowercase letters only'; + } + } + }), + }), +} +``` + +## Indexable + +▪ [version: `string`]: [`SavedObjectsValidationSpec`](../modules/client._internal_namespace.md#savedobjectsvalidationspec) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Services.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Services.md new file mode 100644 index 0000000000000..3a770aca3f595 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Services.md @@ -0,0 +1,43 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Services + +# Interface: Services + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Services + +## Table of contents + +### Properties + +- [connectorTokenClient](client._internal_namespace.Services.md#connectortokenclient) +- [savedObjectsClient](client._internal_namespace.Services.md#savedobjectsclient) +- [scopedClusterClient](client._internal_namespace.Services.md#scopedclusterclient) + +## Properties + +### connectorTokenClient + +• **connectorTokenClient**: [`ConnectorTokenClient`](../classes/client._internal_namespace.ConnectorTokenClient.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:26 + +___ + +### savedObjectsClient + +• **savedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:24 + +___ + +### scopedClusterClient + +• **scopedClusterClient**: [`ElasticsearchClient`](../modules/client._internal_namespace.md#elasticsearchclient) + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:25 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Space.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Space.md new file mode 100644 index 0000000000000..018efefd6f456 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Space.md @@ -0,0 +1,131 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Space + +# Interface: Space + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Space + +A Space. + +## Hierarchy + +- **`Space`** + + ↳ [`GetSpaceResult`](client._internal_namespace.GetSpaceResult.md) + +## Table of contents + +### Properties + +- [\_reserved](client._internal_namespace.Space.md#_reserved) +- [color](client._internal_namespace.Space.md#color) +- [description](client._internal_namespace.Space.md#description) +- [disabledFeatures](client._internal_namespace.Space.md#disabledfeatures) +- [id](client._internal_namespace.Space.md#id) +- [imageUrl](client._internal_namespace.Space.md#imageurl) +- [initials](client._internal_namespace.Space.md#initials) +- [name](client._internal_namespace.Space.md#name) + +## Properties + +### \_reserved + +• `Optional` `Private` **\_reserved**: `boolean` + +Indicates that this space is reserved (system controlled). +Reserved spaces cannot be created or deleted by end-users. + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:46 + +___ + +### color + +• `Optional` **color**: `string` + +Optional color (hex code) for this space. +If neither `color` nor `imageUrl` is specified, then a color will be automatically generated. + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:24 + +___ + +### description + +• `Optional` **description**: `string` + +Optional description for this space. + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:19 + +___ + +### disabledFeatures + +• **disabledFeatures**: `string`[] + +The set of feature ids that should be hidden within this space. + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:40 + +___ + +### id + +• **id**: `string` + +The unique identifier for this space. +The id becomes part of the "URL Identifier" of the space. + +Example: an id of `marketing` would result in the URL identifier of `/s/marketing`. + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:11 + +___ + +### imageUrl + +• `Optional` **imageUrl**: `string` + +Optional base-64 encoded data image url to show as this space's avatar. +This setting takes precedence over any configured `color` or `initials`. + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:36 + +___ + +### initials + +• `Optional` **initials**: `string` + +Optional display initials for this space's avatar. Supports a maximum of 2 characters. +If initials are not provided, then they will be derived from the space name automatically. + +Initials are not displayed if an `imageUrl` has been specified. + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:31 + +___ + +### name + +• **name**: `string` + +Display name for this space. + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:15 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SpacesServiceStart.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SpacesServiceStart.md new file mode 100644 index 0000000000000..5dd67943c579f --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SpacesServiceStart.md @@ -0,0 +1,150 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SpacesServiceStart + +# Interface: SpacesServiceStart + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SpacesServiceStart + +The Spaces service start contract. + +## Table of contents + +### Methods + +- [createSpacesClient](client._internal_namespace.SpacesServiceStart.md#createspacesclient) +- [getActiveSpace](client._internal_namespace.SpacesServiceStart.md#getactivespace) +- [getSpaceId](client._internal_namespace.SpacesServiceStart.md#getspaceid) +- [isInDefaultSpace](client._internal_namespace.SpacesServiceStart.md#isindefaultspace) +- [namespaceToSpaceId](client._internal_namespace.SpacesServiceStart.md#namespacetospaceid) +- [spaceIdToNamespace](client._internal_namespace.SpacesServiceStart.md#spaceidtonamespace) + +## Methods + +### createSpacesClient + +▸ **createSpacesClient**(`request`): [`ISpacesClient`](client._internal_namespace.ISpacesClient.md) + +Creates a scoped instance of the SpacesClient. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | the request. | + +#### Returns + +[`ISpacesClient`](client._internal_namespace.ISpacesClient.md) + +#### Defined in + +x-pack/plugins/spaces/target/types/server/spaces_service/spaces_service.d.ts:32 + +___ + +### getActiveSpace + +▸ **getActiveSpace**(`request`): `Promise`<[`Space`](client._internal_namespace.Space.md)\> + +Retrieves the Space associated with the provided request. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | the request. | + +#### Returns + +`Promise`<[`Space`](client._internal_namespace.Space.md)\> + +#### Defined in + +x-pack/plugins/spaces/target/types/server/spaces_service/spaces_service.d.ts:47 + +___ + +### getSpaceId + +▸ **getSpaceId**(`request`): `string` + +Retrieves the space id associated with the provided request. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | the request. | + +#### Returns + +`string` + +#### Defined in + +x-pack/plugins/spaces/target/types/server/spaces_service/spaces_service.d.ts:37 + +___ + +### isInDefaultSpace + +▸ **isInDefaultSpace**(`request`): `boolean` + +Indicates if the provided request is executing within the context of the `default` space. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | the request. | + +#### Returns + +`boolean` + +#### Defined in + +x-pack/plugins/spaces/target/types/server/spaces_service/spaces_service.d.ts:42 + +___ + +### namespaceToSpaceId + +▸ **namespaceToSpaceId**(`namespace`): `string` + +Converts the provided namespace into the corresponding space id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `namespace` | `undefined` \| `string` | the namespace to convert. | + +#### Returns + +`string` + +#### Defined in + +x-pack/plugins/spaces/target/types/server/spaces_service/spaces_service.d.ts:57 + +___ + +### spaceIdToNamespace + +▸ **spaceIdToNamespace**(`spaceId`): `undefined` \| `string` + +Converts the provided space id into the corresponding Saved Objects `namespace` id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `spaceId` | `string` | the space id to convert. | + +#### Returns + +`undefined` \| `string` + +#### Defined in + +x-pack/plugins/spaces/target/types/server/spaces_service/spaces_service.d.ts:52 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeatureConfig.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeatureConfig.md new file mode 100644 index 0000000000000..adfb11e4efd7d --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeatureConfig.md @@ -0,0 +1,38 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SubFeatureConfig + +# Interface: SubFeatureConfig + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SubFeatureConfig + +Configuration for a sub-feature. + +## Table of contents + +### Properties + +- [name](client._internal_namespace.SubFeatureConfig.md#name) +- [privilegeGroups](client._internal_namespace.SubFeatureConfig.md#privilegegroups) + +## Properties + +### name + +• **name**: `string` + +Display name for this sub-feature + +#### Defined in + +x-pack/plugins/features/target/types/common/sub_feature.d.ts:9 + +___ + +### privilegeGroups + +• **privilegeGroups**: readonly [`SubFeaturePrivilegeGroupConfig`](client._internal_namespace.SubFeaturePrivilegeGroupConfig.md)[] + +Collection of privilege groups + +#### Defined in + +x-pack/plugins/features/target/types/common/sub_feature.d.ts:11 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeaturePrivilegeConfig.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeaturePrivilegeConfig.md new file mode 100644 index 0000000000000..4cbd7bc89efc7 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeaturePrivilegeConfig.md @@ -0,0 +1,334 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SubFeaturePrivilegeConfig + +# Interface: SubFeaturePrivilegeConfig + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SubFeaturePrivilegeConfig + +Configuration for a sub-feature privilege. + +## Hierarchy + +- `Omit`<[`FeatureKibanaPrivileges`](client._internal_namespace.FeatureKibanaPrivileges.md), ``"excludeFromBasePrivileges"``\> + + ↳ **`SubFeaturePrivilegeConfig`** + +## Table of contents + +### Properties + +- [alerting](client._internal_namespace.SubFeaturePrivilegeConfig.md#alerting) +- [api](client._internal_namespace.SubFeaturePrivilegeConfig.md#api) +- [app](client._internal_namespace.SubFeaturePrivilegeConfig.md#app) +- [cases](client._internal_namespace.SubFeaturePrivilegeConfig.md#cases) +- [catalogue](client._internal_namespace.SubFeaturePrivilegeConfig.md#catalogue) +- [disabled](client._internal_namespace.SubFeaturePrivilegeConfig.md#disabled) +- [id](client._internal_namespace.SubFeaturePrivilegeConfig.md#id) +- [includeIn](client._internal_namespace.SubFeaturePrivilegeConfig.md#includein) +- [management](client._internal_namespace.SubFeaturePrivilegeConfig.md#management) +- [minimumLicense](client._internal_namespace.SubFeaturePrivilegeConfig.md#minimumlicense) +- [name](client._internal_namespace.SubFeaturePrivilegeConfig.md#name) +- [requireAllSpaces](client._internal_namespace.SubFeaturePrivilegeConfig.md#requireallspaces) +- [savedObject](client._internal_namespace.SubFeaturePrivilegeConfig.md#savedobject) +- [ui](client._internal_namespace.SubFeaturePrivilegeConfig.md#ui) + +## Properties + +### alerting + +• `Optional` **alerting**: `Object` + +If your feature requires access to specific Alert Types, then specify your access needs here. +Include both Alert Types registered by the feature and external Alert Types such as built-in +Alert Types and Alert Types provided by other features to which you wish to grant access. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `alert?` | `Object` | +| `alert.all?` | readonly `string`[] | +| `alert.read?` | readonly `string`[] | +| `rule?` | `Object` | +| `rule.all?` | readonly `string`[] | +| `rule.read?` | readonly `string`[] | + +#### Inherited from + +Omit.alerting + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:82 + +___ + +### api + +• `Optional` **api**: readonly `string`[] + +If your feature includes server-side APIs, you can tag those routes to secure access based on user permissions. + +**`example`** +```ts + // Configure your routes with a tag starting with the 'access:' prefix + server.route({ + path: '/api/my-route', + method: 'GET', + handler: () => { ...}, + options: { + tags: ['access:my_feature-admin'] + } + }); + + Then, specify the tags here (without the 'access:' prefix) which should be secured: + + { + api: ['my_feature-admin'] + } +``` + +NOTE: It is important to name your tags in a way that will not collide with other plugins/features. +A generic tag name like "access:read" could be used elsewhere, and access to that API endpoint would also +extend to any routes you have also tagged with that name. + +#### Inherited from + +Omit.api + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:64 + +___ + +### app + +• `Optional` **app**: readonly `string`[] + +If your feature exposes a client-side application (most of them do!), then you can control access to them here. + +**`example`** +```ts + { + app: ['my-app', 'kibana'] + } +``` + +#### Inherited from + +Omit.app + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:76 + +___ + +### cases + +• `Optional` **cases**: `Object` + +If your feature requires access to specific owners of cases (aka plugins that have created cases), then specify your access needs here. The values here should +be unique identifiers for the owners of cases you want access to. + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `all?` | readonly `string`[] | List of case owners which users should have full read/write access to when granted this privilege. **`example`** ```ts { all: ['securitySolution'] } ``` | +| `read?` | readonly `string`[] | List of case owners which users should have read-only access to when granted this privilege. **`example`** ```ts { read: ['securitySolution'] } ``` | + +#### Inherited from + +Omit.cases + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:132 + +___ + +### catalogue + +• `Optional` **catalogue**: readonly `string`[] + +If this feature includes a catalogue entry, you can specify them here to control visibility based on user permissions. + +#### Inherited from + +Omit.catalogue + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:37 + +___ + +### disabled + +• `Optional` **disabled**: `boolean` + +Whether or not this privilege should be hidden in the roles UI and disallowed on the API. Defaults to `false`. + +**`deprecated`** + +#### Inherited from + +Omit.disabled + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:18 + +___ + +### id + +• **id**: `string` + +Identifier for this privilege. Must be unique across all other privileges within a feature. + +#### Defined in + +x-pack/plugins/features/target/types/common/sub_feature.d.ts:47 + +___ + +### includeIn + +• **includeIn**: ``"all"`` \| ``"none"`` \| ``"read"`` + +Denotes which Primary Feature Privilege this sub-feature privilege should be included in. +`read` is also included in `all` automatically. + +#### Defined in + +x-pack/plugins/features/target/types/common/sub_feature.d.ts:56 + +___ + +### management + +• `Optional` **management**: `Object` + +If this feature includes management sections, you can specify them here to control visibility of those +pages based on user privileges. + +**`example`** +```ts + // Enables access to the "Advanced Settings" management page within the Kibana section + management: { + kibana: ['settings'] + } +``` + +#### Index signature + +▪ [sectionId: `string`]: readonly `string`[] + +#### Inherited from + +Omit.management + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:31 + +___ + +### minimumLicense + +• `Optional` **minimumLicense**: ``"basic"`` \| ``"standard"`` \| ``"gold"`` \| ``"platinum"`` \| ``"enterprise"`` \| ``"trial"`` + +The minimum supported license level for this sub-feature privilege. +If no license level is supplied, then this privilege will be available for all licences +that are valid for the overall feature. + +#### Defined in + +x-pack/plugins/features/target/types/common/sub_feature.d.ts:62 + +___ + +### name + +• **name**: `string` + +The display name for this privilege. + +#### Defined in + +x-pack/plugins/features/target/types/common/sub_feature.d.ts:51 + +___ + +### requireAllSpaces + +• `Optional` **requireAllSpaces**: `boolean` + +Whether or not this privilege should only be granted to `All Spaces *`. Should be used for features that do not +support Spaces. Defaults to `false`. + +#### Inherited from + +Omit.requireAllSpaces + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:13 + +___ + +### savedObject + +• **savedObject**: `Object` + +If your feature requires access to specific saved objects, then specify your access needs here. + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `all` | readonly `string`[] | List of saved object types which users should have full read/write access to when granted this privilege. **`example`** ```ts { all: ['my-saved-object-type'] } ``` | +| `read` | readonly `string`[] | List of saved object types which users should have read-only access to when granted this privilege. **`example`** ```ts { read: ['config'] } ``` | + +#### Inherited from + +Omit.savedObject + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:157 + +___ + +### ui + +• **ui**: readonly `string`[] + +A list of UI Capabilities that should be granted to users with this privilege. +These capabilities will automatically be namespaces within your feature id. + +**`example`** +```ts + { + ui: ['show', 'save'] + } + + This translates in the UI to the following (assuming a feature id of "foo"): + import { uiCapabilities } from 'ui/capabilities'; + + const canShowApp = uiCapabilities.foo.show; + const canSave = uiCapabilities.foo.save; +``` +Note: Since these are automatically namespaced, you are free to use generic names like "show" and "save". + +**`see`** UICapabilities + +#### Inherited from + +Omit.ui + +#### Defined in + +x-pack/plugins/features/target/types/common/feature_kibana_privileges.d.ts:199 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeaturePrivilegeGroupConfig.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeaturePrivilegeGroupConfig.md new file mode 100644 index 0000000000000..28dcebc6af10c --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.SubFeaturePrivilegeGroupConfig.md @@ -0,0 +1,43 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / SubFeaturePrivilegeGroupConfig + +# Interface: SubFeaturePrivilegeGroupConfig + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).SubFeaturePrivilegeGroupConfig + +Configuration for a sub-feature privilege group. + +## Table of contents + +### Properties + +- [groupType](client._internal_namespace.SubFeaturePrivilegeGroupConfig.md#grouptype) +- [privileges](client._internal_namespace.SubFeaturePrivilegeGroupConfig.md#privileges) + +## Properties + +### groupType + +• **groupType**: [`SubFeaturePrivilegeGroupType`](../modules/client._internal_namespace.md#subfeatureprivilegegrouptype) + +The type of privilege group. +- `mutually_exclusive`:: + Users will be able to select at most one privilege within this group. + Privileges must be specified in descending order of permissiveness (e.g. `All`, `Read`, not `Read`, `All) +- `independent`:: + Users will be able to select any combination of privileges within this group. + +#### Defined in + +x-pack/plugins/features/target/types/common/sub_feature.d.ts:34 + +___ + +### privileges + +• **privileges**: readonly [`SubFeaturePrivilegeConfig`](client._internal_namespace.SubFeaturePrivilegeConfig.md)[] + +The privileges which belong to this group. + +#### Defined in + +x-pack/plugins/features/target/types/common/sub_feature.d.ts:38 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskInfo.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskInfo.md new file mode 100644 index 0000000000000..56843b1283c19 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskInfo.md @@ -0,0 +1,32 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / TaskInfo + +# Interface: TaskInfo + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).TaskInfo + +## Table of contents + +### Properties + +- [attempts](client._internal_namespace.TaskInfo.md#attempts) +- [scheduled](client._internal_namespace.TaskInfo.md#scheduled) + +## Properties + +### attempts + +• **attempts**: `number` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:22 + +___ + +### scheduled + +• **scheduled**: `Date` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:21 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskInstance.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskInstance.md new file mode 100644 index 0000000000000..4cea61eafbdb2 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskInstance.md @@ -0,0 +1,199 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / TaskInstance + +# Interface: TaskInstance + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).TaskInstance + +## Hierarchy + +- **`TaskInstance`** + + ↳ [`ConcreteTaskInstance`](client._internal_namespace.ConcreteTaskInstance.md) + +## Table of contents + +### Properties + +- [id](client._internal_namespace.TaskInstance.md#id) +- [ownerId](client._internal_namespace.TaskInstance.md#ownerid) +- [params](client._internal_namespace.TaskInstance.md#params) +- [retryAt](client._internal_namespace.TaskInstance.md#retryat) +- [runAt](client._internal_namespace.TaskInstance.md#runat) +- [schedule](client._internal_namespace.TaskInstance.md#schedule) +- [scheduledAt](client._internal_namespace.TaskInstance.md#scheduledat) +- [scope](client._internal_namespace.TaskInstance.md#scope) +- [startedAt](client._internal_namespace.TaskInstance.md#startedat) +- [state](client._internal_namespace.TaskInstance.md#state) +- [taskType](client._internal_namespace.TaskInstance.md#tasktype) +- [traceparent](client._internal_namespace.TaskInstance.md#traceparent) +- [user](client._internal_namespace.TaskInstance.md#user) + +## Properties + +### id + +• `Optional` **id**: `string` + +Optional ID that can be passed by the caller. When ID is undefined, ES +will auto-generate a unique id. Otherwise, ID will be used to either +create a new document, or update existing document + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:145 + +___ + +### ownerId + +• `Optional` **ownerId**: ``null`` \| `string` + +The random uuid of the Kibana instance which claimed ownership of the task last + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:205 + +___ + +### params + +• **params**: `Record`<`string`, `any`\> + +A task-specific set of parameters, used by the task's run function to tailor +its work. This is generally user-input, such as { sms: '333-444-2222' }. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:182 + +___ + +### retryAt + +• `Optional` **retryAt**: ``null`` \| `Date` + +The date and time that this task should re-execute if stuck in "running" / timeout +status. This value is only set when status is set to "running". + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:165 + +___ + +### runAt + +• `Optional` **runAt**: `Date` + +The date and time that this task is scheduled to be run. It is not +guaranteed to run at this time, but it is guaranteed not to run earlier +than this. Defaults to immediately. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:171 + +___ + +### schedule + +• `Optional` **schedule**: [`IntervalSchedule`](client._internal_namespace.IntervalSchedule.md) + +A TaskSchedule string, which specifies this as a recurring task. + +Currently, this supports a single format: an interval in minutes or seconds (e.g. '5m', '30s'). + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:177 + +___ + +### scheduledAt + +• `Optional` **scheduledAt**: `Date` + +The date and time that this task was originally scheduled. This is used +for convenience to task run functions, and for troubleshooting. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:154 + +___ + +### scope + +• `Optional` **scope**: `string`[] + +Used to group tasks for querying. So, reporting might schedule tasks with a scope of 'reporting', +and then query such tasks to provide a glimpse at only reporting tasks, rather than at all tasks. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:201 + +___ + +### startedAt + +• `Optional` **startedAt**: ``null`` \| `Date` + +The date and time that this task started execution. This is used to determine +the "real" runAt that ended up running the task. This value is only set +when status is set to "running". + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:160 + +___ + +### state + +• **state**: `Record`<`string`, `any`\> + +The state passed into the task's run function, and returned by the previous +run. If there was no previous run, or if the previous run did not return +any state, this will be the empy object: {} + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:188 + +___ + +### taskType + +• **taskType**: `string` + +The task definition type whose run function will execute this instance. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:149 + +___ + +### traceparent + +• `Optional` **traceparent**: `string` + +The serialized traceparent string of the current APM transaction or span. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:192 + +___ + +### user + +• `Optional` **user**: `string` + +The id of the user who scheduled this task. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:196 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskManagerSetupContract.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskManagerSetupContract.md new file mode 100644 index 0000000000000..15c8f2fe2b91e --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskManagerSetupContract.md @@ -0,0 +1,70 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / TaskManagerSetupContract + +# Interface: TaskManagerSetupContract + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).TaskManagerSetupContract + +## Table of contents + +### Properties + +- [index](client._internal_namespace.TaskManagerSetupContract.md#index) + +### Methods + +- [addMiddleware](client._internal_namespace.TaskManagerSetupContract.md#addmiddleware) +- [registerTaskDefinitions](client._internal_namespace.TaskManagerSetupContract.md#registertaskdefinitions) + +## Properties + +### index + +• **index**: `string` + +**`deprecated`** + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/plugin.d.ts:12 + +## Methods + +### addMiddleware + +▸ **addMiddleware**(`middleware`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `middleware` | [`Middleware`](client._internal_namespace.Middleware.md) | + +#### Returns + +`void` + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/plugin.d.ts:13 + +___ + +### registerTaskDefinitions + +▸ **registerTaskDefinitions**(`taskDefinitions`): `void` + +Method for allowing consumers to register task definitions into the system. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `taskDefinitions` | [`TaskDefinitionRegistry`](../modules/client._internal_namespace.md#taskdefinitionregistry) | The Kibana task definitions dictionary | + +#### Returns + +`void` + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/plugin.d.ts:18 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskRegisterDefinition.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskRegisterDefinition.md new file mode 100644 index 0000000000000..f5d534feba600 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskRegisterDefinition.md @@ -0,0 +1,130 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / TaskRegisterDefinition + +# Interface: TaskRegisterDefinition + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).TaskRegisterDefinition + +Defines a task which can be scheduled and run by the Kibana +task manager. + +## Table of contents + +### Properties + +- [createTaskRunner](client._internal_namespace.TaskRegisterDefinition.md#createtaskrunner) +- [description](client._internal_namespace.TaskRegisterDefinition.md#description) +- [maxAttempts](client._internal_namespace.TaskRegisterDefinition.md#maxattempts) +- [maxConcurrency](client._internal_namespace.TaskRegisterDefinition.md#maxconcurrency) +- [timeout](client._internal_namespace.TaskRegisterDefinition.md#timeout) +- [title](client._internal_namespace.TaskRegisterDefinition.md#title) + +### Methods + +- [getRetry](client._internal_namespace.TaskRegisterDefinition.md#getretry) + +## Properties + +### createTaskRunner + +• **createTaskRunner**: [`TaskRunCreatorFunction`](../modules/client._internal_namespace.md#taskruncreatorfunction) + +Creates an object that has a run function which performs the task's work, +and an optional cancel function which cancels the task. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task_type_dictionary.d.ts:35 + +___ + +### description + +• `Optional` **description**: `string` + +An optional more detailed description of what this task does. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task_type_dictionary.d.ts:22 + +___ + +### maxAttempts + +• `Optional` **maxAttempts**: `number` + +Up to how many times the task should retry when it fails to run. This will +default to the global variable. The default value, if not specified, is 1. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task_type_dictionary.d.ts:40 + +___ + +### maxConcurrency + +• `Optional` **maxConcurrency**: `number` + +The maximum number tasks of this type that can be run concurrently per Kibana instance. +Setting this value will force Task Manager to poll for this task type separately from other task types +which can add significant load to the ES cluster, so please use this configuration only when absolutely necessary. +The default value, if not given, is 0. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task_type_dictionary.d.ts:47 + +___ + +### timeout + +• `Optional` **timeout**: `string` + +How long, in minutes or seconds, the system should wait for the task to complete +before it is considered to be timed out. (e.g. '5m', the default). If +the task takes longer than this, Kibana will send it a kill command and +the task will be re-attempted. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task_type_dictionary.d.ts:18 + +___ + +### title + +• `Optional` **title**: `string` + +A brief, human-friendly title for this task. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task_type_dictionary.d.ts:11 + +## Methods + +### getRetry + +▸ `Optional` **getRetry**(`attempts`, `error`): `boolean` \| `Date` + +Function that customizes how the task should behave when the task fails. This +function can return `true`, `false` or a Date. True will tell task manager +to retry using default delay logic. False will tell task manager to stop retrying +this task. Date will suggest when to the task manager the task should retry. +This function isn't used for recurring tasks, those retry as per their configured recurring schedule. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `attempts` | `number` | +| `error` | `object` | + +#### Returns + +`boolean` \| `Date` + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task_type_dictionary.d.ts:30 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskRunnerContext.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskRunnerContext.md new file mode 100644 index 0000000000000..d79cef9c996c1 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TaskRunnerContext.md @@ -0,0 +1,89 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / TaskRunnerContext + +# Interface: TaskRunnerContext + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).TaskRunnerContext + +## Table of contents + +### Properties + +- [actionTypeRegistry](client._internal_namespace.TaskRunnerContext.md#actiontyperegistry) +- [basePathService](client._internal_namespace.TaskRunnerContext.md#basepathservice) +- [encryptedSavedObjectsClient](client._internal_namespace.TaskRunnerContext.md#encryptedsavedobjectsclient) +- [logger](client._internal_namespace.TaskRunnerContext.md#logger) +- [spaceIdToNamespace](client._internal_namespace.TaskRunnerContext.md#spaceidtonamespace) + +### Methods + +- [getUnsecuredSavedObjectsClient](client._internal_namespace.TaskRunnerContext.md#getunsecuredsavedobjectsclient) + +## Properties + +### actionTypeRegistry + +• **actionTypeRegistry**: [`ActionTypeRegistryContract`](../modules/client._internal_namespace.md#actiontyperegistrycontract) + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:8 + +___ + +### basePathService + +• **basePathService**: [`IBasePath`](../modules/client._internal_namespace.md#ibasepath) + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:11 + +___ + +### encryptedSavedObjectsClient + +• **encryptedSavedObjectsClient**: [`EncryptedSavedObjectsClient`](client._internal_namespace.EncryptedSavedObjectsClient.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:9 + +___ + +### logger + +• **logger**: `Logger` + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:7 + +___ + +### spaceIdToNamespace + +• **spaceIdToNamespace**: [`SpaceIdToNamespaceFunction`](../modules/client._internal_namespace.md#spaceidtonamespacefunction) + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:10 + +## Methods + +### getUnsecuredSavedObjectsClient + +▸ **getUnsecuredSavedObjectsClient**(`request`): [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)<`unknown`, `unknown`, `unknown`, `any`\> | + +#### Returns + +[`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/task_runner_factory.d.ts:12 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TranslatedUpdateAlertRequest.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TranslatedUpdateAlertRequest.md new file mode 100644 index 0000000000000..0a44beb8592e7 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.TranslatedUpdateAlertRequest.md @@ -0,0 +1,43 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / TranslatedUpdateAlertRequest + +# Interface: TranslatedUpdateAlertRequest + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).TranslatedUpdateAlertRequest + +## Table of contents + +### Properties + +- [id](client._internal_namespace.TranslatedUpdateAlertRequest.md#id) +- [index](client._internal_namespace.TranslatedUpdateAlertRequest.md#index) +- [status](client._internal_namespace.TranslatedUpdateAlertRequest.md#status) + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/alerts/index.ts:208](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L208) + +___ + +### index + +• **index**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/alerts/index.ts:209](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L209) + +___ + +### status + +• **status**: `STATUS_VALUES` + +#### Defined in + +[x-pack/plugins/cases/server/services/alerts/index.ts:210](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/alerts/index.ts#L210) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateAlertRequest.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateAlertRequest.md new file mode 100644 index 0000000000000..53ee404bbf12a --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateAlertRequest.md @@ -0,0 +1,45 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / UpdateAlertRequest + +# Interface: UpdateAlertRequest + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).UpdateAlertRequest + +Defines the fields necessary to update an alert's status. + +## Table of contents + +### Properties + +- [id](client._internal_namespace.UpdateAlertRequest.md#id) +- [index](client._internal_namespace.UpdateAlertRequest.md#index) +- [status](client._internal_namespace.UpdateAlertRequest.md#status) + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/client/alerts/types.ts:28](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/alerts/types.ts#L28) + +___ + +### index + +• **index**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/client/alerts/types.ts:29](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/alerts/types.ts#L29) + +___ + +### status + +• **status**: [`CaseStatuses`](../enums/client._internal_namespace.CaseStatuses.md) + +#### Defined in + +[x-pack/plugins/cases/server/client/alerts/types.ts:30](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/alerts/types.ts#L30) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateArgs.md new file mode 100644 index 0000000000000..c0f6cf3d0d1a2 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateArgs.md @@ -0,0 +1,43 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / UpdateArgs + +# Interface: UpdateArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).UpdateArgs + +## Table of contents + +### Properties + +- [attachmentId](client._internal_namespace.UpdateArgs.md#attachmentid) +- [options](client._internal_namespace.UpdateArgs.md#options) +- [updatedAttributes](client._internal_namespace.UpdateArgs.md#updatedattributes) + +## Properties + +### attachmentId + +• **attachmentId**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:54](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L54) + +___ + +### options + +• `Optional` **options**: [`SavedObjectsUpdateOptions`](client._internal_namespace.SavedObjectsUpdateOptions.md)<{ `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } \| { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } }\> + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:56](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L56) + +___ + +### updatedAttributes + +• **updatedAttributes**: { `created_at`: `undefined` \| `string` = rt.string; `created_by`: `undefined` \| { `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` } = UserRT; `owner`: `undefined` \| `string` = rt.string; `pushed_at`: `undefined` \| ``null`` \| `string` ; `pushed_by`: `undefined` \| ``null`` \| { `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` } ; `updated_at`: `undefined` \| ``null`` \| `string` ; `updated_by`: `undefined` \| ``null`` \| { `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` } } & { `alertId`: `undefined` \| `string` \| `string`[] ; `index`: `undefined` \| `string` \| `string`[] ; `owner`: `undefined` \| `string` = rt.string; `rule`: `undefined` \| { `id`: ``null`` \| `string` ; `name`: ``null`` \| `string` } ; `type`: `undefined` \| [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `undefined` \| `string` = rt.string; `created_by`: `undefined` \| { `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` } = UserRT; `owner`: `undefined` \| `string` = rt.string; `pushed_at`: `undefined` \| ``null`` \| `string` ; `pushed_by`: `undefined` \| ``null`` \| { `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` } ; `updated_at`: `undefined` \| ``null`` \| `string` ; `updated_by`: `undefined` \| ``null`` \| { `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` } } + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:55](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L55) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateConnectorMappingsArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateConnectorMappingsArgs.md new file mode 100644 index 0000000000000..4af6344e575d6 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateConnectorMappingsArgs.md @@ -0,0 +1,64 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / UpdateConnectorMappingsArgs + +# Interface: UpdateConnectorMappingsArgs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).UpdateConnectorMappingsArgs + +## Hierarchy + +- [`ClientArgs`](client._internal_namespace.ClientArgs-2.md) + + ↳ **`UpdateConnectorMappingsArgs`** + +## Table of contents + +### Properties + +- [attributes](client._internal_namespace.UpdateConnectorMappingsArgs.md#attributes) +- [mappingId](client._internal_namespace.UpdateConnectorMappingsArgs.md#mappingid) +- [references](client._internal_namespace.UpdateConnectorMappingsArgs.md#references) +- [unsecuredSavedObjectsClient](client._internal_namespace.UpdateConnectorMappingsArgs.md#unsecuredsavedobjectsclient) + +## Properties + +### attributes + +• **attributes**: `Partial`<{ `mappings`: { action\_type: "append" \| "nothing" \| "overwrite"; source: "description" \| "title" \| "comments"; target: string; }[] ; `owner`: `string` = rt.string }\> + +#### Defined in + +[x-pack/plugins/cases/server/services/connector_mappings/index.ts:28](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L28) + +___ + +### mappingId + +• **mappingId**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/services/connector_mappings/index.ts:27](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L27) + +___ + +### references + +• **references**: [`SavedObjectReference`](client._internal_namespace.SavedObjectReference.md)[] + +#### Defined in + +[x-pack/plugins/cases/server/services/connector_mappings/index.ts:29](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L29) + +___ + +### unsecuredSavedObjectsClient + +• **unsecuredSavedObjectsClient**: [`SavedObjectsClientContract`](../modules/client._internal_namespace.md#savedobjectsclientcontract) + +#### Inherited from + +[ClientArgs](client._internal_namespace.ClientArgs-2.md).[unsecuredSavedObjectsClient](client._internal_namespace.ClientArgs-2.md#unsecuredsavedobjectsclient) + +#### Defined in + +[x-pack/plugins/cases/server/services/connector_mappings/index.ts:15](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/connector_mappings/index.ts#L15) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateOptions-1.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateOptions-1.md new file mode 100644 index 0000000000000..cd8125ed13bf5 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateOptions-1.md @@ -0,0 +1,54 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / UpdateOptions + +# Interface: UpdateOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).UpdateOptions + +## Table of contents + +### Properties + +- [expiresAtMillis](client._internal_namespace.UpdateOptions-1.md#expiresatmillis) +- [id](client._internal_namespace.UpdateOptions-1.md#id) +- [token](client._internal_namespace.UpdateOptions-1.md#token) +- [tokenType](client._internal_namespace.UpdateOptions-1.md#tokentype) + +## Properties + +### expiresAtMillis + +• **expiresAtMillis**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:19 + +___ + +### id + +• **id**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:17 + +___ + +### token + +• **token**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:18 + +___ + +### tokenType + +• `Optional` **tokenType**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/builtin_action_types/lib/connector_token_client.d.ts:20 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateOptions.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateOptions.md new file mode 100644 index 0000000000000..f1bc374522175 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UpdateOptions.md @@ -0,0 +1,32 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / UpdateOptions + +# Interface: UpdateOptions + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).UpdateOptions + +## Table of contents + +### Properties + +- [action](client._internal_namespace.UpdateOptions.md#action) +- [id](client._internal_namespace.UpdateOptions.md#id) + +## Properties + +### action + +• **action**: [`ActionUpdate`](client._internal_namespace.ActionUpdate.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:41 + +___ + +### id + +• **id**: `string` + +#### Defined in + +x-pack/plugins/actions/target/types/server/actions_client.d.ts:40 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.User.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.User.md new file mode 100644 index 0000000000000..947805536297f --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.User.md @@ -0,0 +1,90 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / User + +# Interface: User + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).User + +## Hierarchy + +- **`User`** + + ↳ [`AuthenticatedUser`](client._internal_namespace.AuthenticatedUser.md) + +## Table of contents + +### Properties + +- [email](client._internal_namespace.User.md#email) +- [enabled](client._internal_namespace.User.md#enabled) +- [full\_name](client._internal_namespace.User.md#full_name) +- [metadata](client._internal_namespace.User.md#metadata) +- [roles](client._internal_namespace.User.md#roles) +- [username](client._internal_namespace.User.md#username) + +## Properties + +### email + +• `Optional` **email**: `string` + +#### Defined in + +x-pack/plugins/security/target/types/common/model/user.d.ts:3 + +___ + +### enabled + +• **enabled**: `boolean` + +#### Defined in + +x-pack/plugins/security/target/types/common/model/user.d.ts:6 + +___ + +### full\_name + +• `Optional` **full\_name**: `string` + +#### Defined in + +x-pack/plugins/security/target/types/common/model/user.d.ts:4 + +___ + +### metadata + +• `Optional` **metadata**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `_deprecated?` | `boolean` | +| `_deprecated_reason?` | `string` | +| `_reserved` | `boolean` | + +#### Defined in + +x-pack/plugins/security/target/types/common/model/user.d.ts:7 + +___ + +### roles + +• **roles**: readonly `string`[] + +#### Defined in + +x-pack/plugins/security/target/types/common/model/user.d.ts:5 + +___ + +### username + +• **username**: `string` + +#### Defined in + +x-pack/plugins/security/target/types/common/model/user.d.ts:2 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UserRealm.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UserRealm.md new file mode 100644 index 0000000000000..2d1d75692a0e0 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.UserRealm.md @@ -0,0 +1,32 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / UserRealm + +# Interface: UserRealm + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).UserRealm + +## Table of contents + +### Properties + +- [name](client._internal_namespace.UserRealm.md#name) +- [type](client._internal_namespace.UserRealm.md#type) + +## Properties + +### name + +• **name**: `string` + +#### Defined in + +x-pack/plugins/security/target/types/common/model/authenticated_user.d.ts:4 + +___ + +### type + +• **type**: `string` + +#### Defined in + +x-pack/plugins/security/target/types/common/model/authenticated_user.d.ts:5 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ValidatorType.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ValidatorType.md new file mode 100644 index 0000000000000..c771a20cde115 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.ValidatorType.md @@ -0,0 +1,37 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / ValidatorType + +# Interface: ValidatorType + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).ValidatorType + +## Type parameters + +| Name | +| :------ | +| `Type` | + +## Table of contents + +### Methods + +- [validate](client._internal_namespace.ValidatorType.md#validate) + +## Methods + +### validate + +▸ **validate**(`value`): `Type` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `unknown` | + +#### Returns + +`Type` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:64 diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Verbs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Verbs.md new file mode 100644 index 0000000000000..6234a71241e99 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/client._internal_namespace.Verbs.md @@ -0,0 +1,45 @@ +[Cases Client API Interface](../README.md) / [client](../modules/client.md) / [\_internal\_namespace](../modules/client._internal_namespace.md) / Verbs + +# Interface: Verbs + +[client](../modules/client.md).[_internal_namespace](../modules/client._internal_namespace.md).Verbs + +The tenses for describing the action performed by a API route + +## Table of contents + +### Properties + +- [past](client._internal_namespace.Verbs.md#past) +- [present](client._internal_namespace.Verbs.md#present) +- [progressive](client._internal_namespace.Verbs.md#progressive) + +## Properties + +### past + +• **past**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/authorization/types.ts:18](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L18) + +___ + +### present + +• **present**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/authorization/types.ts:16](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L16) + +___ + +### progressive + +• **progressive**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/authorization/types.ts:17](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L17) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.CreateMappingsArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.CreateMappingsArgs.md new file mode 100644 index 0000000000000..14e3f0fc93459 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.CreateMappingsArgs.md @@ -0,0 +1,42 @@ +[Cases Client API Interface](../README.md) / [configure/client](../modules/configure_client.md) / [\_internal\_namespace](../modules/configure_client._internal_namespace.md) / CreateMappingsArgs + +# Interface: CreateMappingsArgs + +[configure/client](../modules/configure_client.md).[_internal_namespace](../modules/configure_client._internal_namespace.md).CreateMappingsArgs + +## Hierarchy + +- [`MappingsArgs`](configure_client._internal_namespace.MappingsArgs.md) + + ↳ **`CreateMappingsArgs`** + +## Table of contents + +### Properties + +- [connector](configure_client._internal_namespace.CreateMappingsArgs.md#connector) +- [owner](configure_client._internal_namespace.CreateMappingsArgs.md#owner) + +## Properties + +### connector + +• **connector**: { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } + +#### Inherited from + +[MappingsArgs](configure_client._internal_namespace.MappingsArgs.md).[connector](configure_client._internal_namespace.MappingsArgs.md#connector) + +#### Defined in + +[x-pack/plugins/cases/server/client/configure/types.ts:11](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/types.ts#L11) + +___ + +### owner + +• **owner**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/client/configure/types.ts:15](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/types.ts#L15) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.MappingsArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.MappingsArgs.md new file mode 100644 index 0000000000000..b21de0e3f9018 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.MappingsArgs.md @@ -0,0 +1,29 @@ +[Cases Client API Interface](../README.md) / [configure/client](../modules/configure_client.md) / [\_internal\_namespace](../modules/configure_client._internal_namespace.md) / MappingsArgs + +# Interface: MappingsArgs + +[configure/client](../modules/configure_client.md).[_internal_namespace](../modules/configure_client._internal_namespace.md).MappingsArgs + +## Hierarchy + +- **`MappingsArgs`** + + ↳ [`CreateMappingsArgs`](configure_client._internal_namespace.CreateMappingsArgs.md) + + ↳ [`UpdateMappingsArgs`](configure_client._internal_namespace.UpdateMappingsArgs.md) + +## Table of contents + +### Properties + +- [connector](configure_client._internal_namespace.MappingsArgs.md#connector) + +## Properties + +### connector + +• **connector**: { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } + +#### Defined in + +[x-pack/plugins/cases/server/client/configure/types.ts:11](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/types.ts#L11) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.UpdateMappingsArgs.md b/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.UpdateMappingsArgs.md new file mode 100644 index 0000000000000..e81c67f5bd4a0 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client._internal_namespace.UpdateMappingsArgs.md @@ -0,0 +1,42 @@ +[Cases Client API Interface](../README.md) / [configure/client](../modules/configure_client.md) / [\_internal\_namespace](../modules/configure_client._internal_namespace.md) / UpdateMappingsArgs + +# Interface: UpdateMappingsArgs + +[configure/client](../modules/configure_client.md).[_internal_namespace](../modules/configure_client._internal_namespace.md).UpdateMappingsArgs + +## Hierarchy + +- [`MappingsArgs`](configure_client._internal_namespace.MappingsArgs.md) + + ↳ **`UpdateMappingsArgs`** + +## Table of contents + +### Properties + +- [connector](configure_client._internal_namespace.UpdateMappingsArgs.md#connector) +- [mappingId](configure_client._internal_namespace.UpdateMappingsArgs.md#mappingid) + +## Properties + +### connector + +• **connector**: { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } + +#### Inherited from + +[MappingsArgs](configure_client._internal_namespace.MappingsArgs.md).[connector](configure_client._internal_namespace.MappingsArgs.md#connector) + +#### Defined in + +[x-pack/plugins/cases/server/client/configure/types.ts:11](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/types.ts#L11) + +___ + +### mappingId + +• **mappingId**: `string` + +#### Defined in + +[x-pack/plugins/cases/server/client/configure/types.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/types.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client.configuresubclient.md b/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client.configuresubclient.md index f94e7d6c7f49e..393957ba1c7f5 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client.configuresubclient.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/configure_client.configuresubclient.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [configure/client](../modules/configure_client.md) / ConfigureSubClient +[Cases Client API Interface](../README.md) / [configure/client](../modules/configure_client.md) / ConfigureSubClient # Interface: ConfigureSubClient @@ -10,16 +10,16 @@ This is the public API for interacting with the connector configuration for case ### Methods -- [create](configure_client.configuresubclient.md#create) -- [get](configure_client.configuresubclient.md#get) -- [getConnectors](configure_client.configuresubclient.md#getconnectors) -- [update](configure_client.configuresubclient.md#update) +- [create](configure_client.ConfigureSubClient.md#create) +- [get](configure_client.ConfigureSubClient.md#get) +- [getConnectors](configure_client.ConfigureSubClient.md#getconnectors) +- [update](configure_client.ConfigureSubClient.md#update) ## Methods ### create -▸ **create**(`configuration`: [*ICasesConfigureRequest*](typedoc_interfaces.icasesconfigurerequest.md)): *Promise*<[*ICasesConfigureResponse*](typedoc_interfaces.icasesconfigureresponse.md)\> +▸ **create**(`configuration`): `Promise`<[`ICasesConfigureResponse`](typedoc_interfaces.ICasesConfigureResponse.md)\> Creates a configuration if one does not already exist. If one exists it is deleted and a new one is created. @@ -27,17 +27,21 @@ Creates a configuration if one does not already exist. If one exists it is delet | Name | Type | | :------ | :------ | -| `configuration` | [*ICasesConfigureRequest*](typedoc_interfaces.icasesconfigurerequest.md) | +| `configuration` | [`ICasesConfigureRequest`](typedoc_interfaces.ICasesConfigureRequest.md) | -**Returns:** *Promise*<[*ICasesConfigureResponse*](typedoc_interfaces.icasesconfigureresponse.md)\> +#### Returns -Defined in: [configure/client.ts:98](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/configure/client.ts#L98) +`Promise`<[`ICasesConfigureResponse`](typedoc_interfaces.ICasesConfigureResponse.md)\> + +#### Defined in + +[x-pack/plugins/cases/server/client/configure/client.ts:93](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/client.ts#L93) ___ ### get -▸ **get**(`params`: { `owner`: *undefined* \| *string* \| *string*[] }): *Promise*<{} \| [*ICasesConfigureResponse*](typedoc_interfaces.icasesconfigureresponse.md)\> +▸ **get**(`params`): `Promise`<{} \| [`ICasesConfigureResponse`](typedoc_interfaces.ICasesConfigureResponse.md)\> Retrieves the external connector configuration for a particular case owner. @@ -45,30 +49,38 @@ Retrieves the external connector configuration for a particular case owner. | Name | Type | | :------ | :------ | -| `params` | *object* | -| `params.owner` | *undefined* \| *string* \| *string*[] | +| `params` | `Object` | +| `params.owner` | `undefined` \| `string` \| `string`[] | + +#### Returns + +`Promise`<{} \| [`ICasesConfigureResponse`](typedoc_interfaces.ICasesConfigureResponse.md)\> -**Returns:** *Promise*<{} \| [*ICasesConfigureResponse*](typedoc_interfaces.icasesconfigureresponse.md)\> +#### Defined in -Defined in: [configure/client.ts:80](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/configure/client.ts#L80) +[x-pack/plugins/cases/server/client/configure/client.ts:75](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/client.ts#L75) ___ ### getConnectors -▸ **getConnectors**(): *Promise* +▸ **getConnectors**(): `Promise`<[`FindActionResult`](client._internal_namespace.FindActionResult.md)[]\> Retrieves the valid external connectors supported by the cases plugin. -**Returns:** *Promise* +#### Returns -Defined in: [configure/client.ts:84](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/configure/client.ts#L84) +`Promise`<[`FindActionResult`](client._internal_namespace.FindActionResult.md)[]\> + +#### Defined in + +[x-pack/plugins/cases/server/client/configure/client.ts:79](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/client.ts#L79) ___ ### update -▸ **update**(`configurationId`: *string*, `configurations`: [*ICasesConfigurePatch*](typedoc_interfaces.icasesconfigurepatch.md)): *Promise*<[*ICasesConfigureResponse*](typedoc_interfaces.icasesconfigureresponse.md)\> +▸ **update**(`configurationId`, `configurations`): `Promise`<[`ICasesConfigureResponse`](typedoc_interfaces.ICasesConfigureResponse.md)\> Updates a particular configuration with new values. @@ -76,9 +88,13 @@ Updates a particular configuration with new values. | Name | Type | Description | | :------ | :------ | :------ | -| `configurationId` | *string* | the ID of the configuration to update | -| `configurations` | [*ICasesConfigurePatch*](typedoc_interfaces.icasesconfigurepatch.md) | the new configuration parameters | +| `configurationId` | `string` | the ID of the configuration to update | +| `configurations` | [`ICasesConfigurePatch`](typedoc_interfaces.ICasesConfigurePatch.md) | the new configuration parameters | + +#### Returns + +`Promise`<[`ICasesConfigureResponse`](typedoc_interfaces.ICasesConfigureResponse.md)\> -**Returns:** *Promise*<[*ICasesConfigureResponse*](typedoc_interfaces.icasesconfigureresponse.md)\> +#### Defined in -Defined in: [configure/client.ts:91](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/configure/client.ts#L91) +[x-pack/plugins/cases/server/client/configure/client.ts:86](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/client.ts#L86) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/metrics_client.MetricsSubClient.md b/x-pack/plugins/cases/docs/cases_client/interfaces/metrics_client.MetricsSubClient.md new file mode 100644 index 0000000000000..c59b437c7f23e --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/metrics_client.MetricsSubClient.md @@ -0,0 +1,33 @@ +[Cases Client API Interface](../README.md) / [metrics/client](../modules/metrics_client.md) / MetricsSubClient + +# Interface: MetricsSubClient + +[metrics/client](../modules/metrics_client.md).MetricsSubClient + +API for interacting with the metrics. + +## Table of contents + +### Methods + +- [getCaseMetrics](metrics_client.MetricsSubClient.md#getcasemetrics) + +## Methods + +### getCaseMetrics + +▸ **getCaseMetrics**(`params`): `Promise`<{ `actions`: `undefined` \| { isolateHost?: { isolate: { total: number; }; unisolate: { total: number; }; } \| undefined; } ; `alerts`: `undefined` \| { count?: number \| undefined; hosts?: { total: number; values: { name: string \| undefined; id: string; count: number; }[]; } \| undefined; users?: { total: number; values: { name: string; count: number; }[]; } \| undefined; } ; `connectors`: `undefined` \| { `total`: `number` = rt.number } ; `lifespan`: `undefined` \| { `closeDate`: ``null`` \| `string` ; `creationDate`: `string` = rt.string; `statusInfo`: { openDuration: number; inProgressDuration: number; reopenDates: string[]; } = StatusInfoRt } }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | [`CaseMetricsParams`](metrics_client._internal_namespace.CaseMetricsParams.md) | + +#### Returns + +`Promise`<{ `actions`: `undefined` \| { isolateHost?: { isolate: { total: number; }; unisolate: { total: number; }; } \| undefined; } ; `alerts`: `undefined` \| { count?: number \| undefined; hosts?: { total: number; values: { name: string \| undefined; id: string; count: number; }[]; } \| undefined; users?: { total: number; values: { name: string; count: number; }[]; } \| undefined; } ; `connectors`: `undefined` \| { `total`: `number` = rt.number } ; `lifespan`: `undefined` \| { `closeDate`: ``null`` \| `string` ; `creationDate`: `string` = rt.string; `statusInfo`: { openDuration: number; inProgressDuration: number; reopenDates: string[]; } = StatusInfoRt } }\> + +#### Defined in + +[x-pack/plugins/cases/server/client/metrics/client.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/metrics/client.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/metrics_client._internal_namespace.CaseMetricsParams.md b/x-pack/plugins/cases/docs/cases_client/interfaces/metrics_client._internal_namespace.CaseMetricsParams.md new file mode 100644 index 0000000000000..8f03bed67e646 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/metrics_client._internal_namespace.CaseMetricsParams.md @@ -0,0 +1,36 @@ +[Cases Client API Interface](../README.md) / [metrics/client](../modules/metrics_client.md) / [\_internal\_namespace](../modules/metrics_client._internal_namespace.md) / CaseMetricsParams + +# Interface: CaseMetricsParams + +[metrics/client](../modules/metrics_client.md).[_internal_namespace](../modules/metrics_client._internal_namespace.md).CaseMetricsParams + +## Table of contents + +### Properties + +- [caseId](metrics_client._internal_namespace.CaseMetricsParams.md#caseid) +- [features](metrics_client._internal_namespace.CaseMetricsParams.md#features) + +## Properties + +### caseId + +• **caseId**: `string` + +The ID of the case. + +#### Defined in + +[x-pack/plugins/cases/server/client/metrics/get_case_metrics.ts:26](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/metrics/get_case_metrics.ts#L26) + +___ + +### features + +• **features**: `string`[] + +The metrics to retrieve. + +#### Defined in + +[x-pack/plugins/cases/server/client/metrics/get_case_metrics.ts:30](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/metrics/get_case_metrics.ts#L30) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/stats_client.statssubclient.md b/x-pack/plugins/cases/docs/cases_client/interfaces/stats_client.statssubclient.md index 9bbf3cdaf015f..37dab1782ee06 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/stats_client.statssubclient.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/stats_client.statssubclient.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [stats/client](../modules/stats_client.md) / StatsSubClient +[Cases Client API Interface](../README.md) / [stats/client](../modules/stats_client.md) / StatsSubClient # Interface: StatsSubClient @@ -10,13 +10,13 @@ Statistics API contract. ### Methods -- [getStatusTotalsByType](stats_client.statssubclient.md#getstatustotalsbytype) +- [getStatusTotalsByType](stats_client.StatsSubClient.md#getstatustotalsbytype) ## Methods ### getStatusTotalsByType -▸ **getStatusTotalsByType**(`params`: { `owner`: *undefined* \| *string* \| *string*[] }): *Promise*<{ `count_closed_cases`: *number* ; `count_in_progress_cases`: *number* ; `count_open_cases`: *number* }\> +▸ **getStatusTotalsByType**(`params`): `Promise`<{ `count_closed_cases`: `number` = rt.number; `count_in_progress_cases`: `number` = rt.number; `count_open_cases`: `number` = rt.number }\> Retrieves the total number of open, closed, and in-progress cases. @@ -24,9 +24,13 @@ Retrieves the total number of open, closed, and in-progress cases. | Name | Type | | :------ | :------ | -| `params` | *object* | -| `params.owner` | *undefined* \| *string* \| *string*[] | +| `params` | `Object` | +| `params.owner` | `undefined` \| `string` \| `string`[] | -**Returns:** *Promise*<{ `count_closed_cases`: *number* ; `count_in_progress_cases`: *number* ; `count_open_cases`: *number* }\> +#### Returns -Defined in: [stats/client.ts:34](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/stats/client.ts#L34) +`Promise`<{ `count_closed_cases`: `number` = rt.number; `count_in_progress_cases`: `number` = rt.number; `count_open_cases`: `number` = rt.number }\> + +#### Defined in + +[x-pack/plugins/cases/server/client/stats/client.ts:34](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/stats/client.ts#L34) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/sub_cases_client.subcasesclient.md b/x-pack/plugins/cases/docs/cases_client/interfaces/sub_cases_client.subcasesclient.md deleted file mode 100644 index e3ca5a756f8a7..0000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/sub_cases_client.subcasesclient.md +++ /dev/null @@ -1,89 +0,0 @@ -[Cases Client API Interface](../cases_client_api.md) / [sub_cases/client](../modules/sub_cases_client.md) / SubCasesClient - -# Interface: SubCasesClient - -[sub_cases/client](../modules/sub_cases_client.md).SubCasesClient - -The API routes for interacting with sub cases. - -## Table of contents - -### Methods - -- [delete](sub_cases_client.subcasesclient.md#delete) -- [find](sub_cases_client.subcasesclient.md#find) -- [get](sub_cases_client.subcasesclient.md#get) -- [update](sub_cases_client.subcasesclient.md#update) - -## Methods - -### delete - -▸ **delete**(`ids`: *string*[]): *Promise* - -Deletes the specified entities and their attachments. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ids` | *string*[] | - -**Returns:** *Promise* - -Defined in: [sub_cases/client.ts:68](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/sub_cases/client.ts#L68) - -___ - -### find - -▸ **find**(`findArgs`: FindArgs): *Promise*<[*ISubCasesFindResponse*](typedoc_interfaces.isubcasesfindresponse.md)\> - -Retrieves the sub cases matching the search criteria. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `findArgs` | FindArgs | - -**Returns:** *Promise*<[*ISubCasesFindResponse*](typedoc_interfaces.isubcasesfindresponse.md)\> - -Defined in: [sub_cases/client.ts:72](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/sub_cases/client.ts#L72) - -___ - -### get - -▸ **get**(`getArgs`: GetArgs): *Promise*<[*ISubCaseResponse*](typedoc_interfaces.isubcaseresponse.md)\> - -Retrieves a single sub case. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `getArgs` | GetArgs | - -**Returns:** *Promise*<[*ISubCaseResponse*](typedoc_interfaces.isubcaseresponse.md)\> - -Defined in: [sub_cases/client.ts:76](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/sub_cases/client.ts#L76) - -___ - -### update - -▸ **update**(`subCases`: { `subCases`: { `status`: *undefined* \| open \| *any*[*any*] \| closed } & { id: string; version: string; }[] }): *Promise*<[*ISubCasesResponse*](typedoc_interfaces.isubcasesresponse.md)\> - -Updates the specified sub cases to the new values included in the request. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `subCases` | *object* | -| `subCases.subCases` | { `status`: *undefined* \| open \| *any*[*any*] \| closed } & { id: string; version: string; }[] | - -**Returns:** *Promise*<[*ISubCasesResponse*](typedoc_interfaces.isubcasesresponse.md)\> - -Defined in: [sub_cases/client.ts:80](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/sub_cases/client.ts#L80) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.ICaseResolveResponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.ICaseResolveResponse.md new file mode 100644 index 0000000000000..a428247ab70ba --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.ICaseResolveResponse.md @@ -0,0 +1,49 @@ +[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICaseResolveResponse + +# Interface: ICaseResolveResponse + +[typedoc_interfaces](../modules/typedoc_interfaces.md).ICaseResolveResponse + +## Hierarchy + +- [`CaseResolveResponse`](../modules/typedoc_interfaces._internal_namespace.md#caseresolveresponse) + + ↳ **`ICaseResolveResponse`** + +## Table of contents + +### Properties + +- [alias\_target\_id](typedoc_interfaces.ICaseResolveResponse.md#alias_target_id) +- [case](typedoc_interfaces.ICaseResolveResponse.md#case) +- [outcome](typedoc_interfaces.ICaseResolveResponse.md#outcome) + +## Properties + +### alias\_target\_id + +• **alias\_target\_id**: `undefined` \| `string` = `rt.string` + +#### Inherited from + +CaseResolveResponse.alias\_target\_id + +___ + +### case + +• **case**: { `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `totalAlerts`: `number` = rt.number; `totalComment`: `number` = rt.number; `version`: `string` = rt.string } & { `comments`: `undefined` \| { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string }[] } = `CaseResponseRt` + +#### Inherited from + +CaseResolveResponse.case + +___ + +### outcome + +• **outcome**: ``"exactMatch"`` \| ``"aliasMatch"`` \| ``"conflict"`` + +#### Inherited from + +CaseResolveResponse.outcome diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.iallcommentsresponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.iallcommentsresponse.md index 06322bb51e2ad..e4d0d7cdaa594 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.iallcommentsresponse.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.iallcommentsresponse.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [typedoc_interfaces](../modules/typedoc_interfaces.md) / IAllCommentsResponse +[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / IAllCommentsResponse # Interface: IAllCommentsResponse @@ -6,6 +6,6 @@ ## Hierarchy -- *AllCommentsResponse* +- [`AllCommentsResponse`](../modules/typedoc_interfaces._internal_namespace.md#allcommentsresponse) - ↳ **IAllCommentsResponse** + ↳ **`IAllCommentsResponse`** diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasepostrequest.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasepostrequest.md index 5f9189ea41e48..bcca7301539f5 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasepostrequest.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasepostrequest.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [typedoc_interfaces](../modules/typedoc_interfaces.md) / ICasePostRequest +[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICasePostRequest # Interface: ICasePostRequest @@ -9,80 +9,83 @@ the docs are huge. ## Hierarchy -- *CasePostRequest* +- [`CasePostRequest`](../modules/typedoc_interfaces._internal_namespace.md#casepostrequest) - ↳ **ICasePostRequest** + ↳ **`ICasePostRequest`** ## Table of contents ### Properties -- [connector](typedoc_interfaces.icasepostrequest.md#connector) -- [description](typedoc_interfaces.icasepostrequest.md#description) -- [owner](typedoc_interfaces.icasepostrequest.md#owner) -- [settings](typedoc_interfaces.icasepostrequest.md#settings) -- [tags](typedoc_interfaces.icasepostrequest.md#tags) -- [title](typedoc_interfaces.icasepostrequest.md#title) -- [type](typedoc_interfaces.icasepostrequest.md#type) +- [connector](typedoc_interfaces.ICasePostRequest.md#connector) +- [description](typedoc_interfaces.ICasePostRequest.md#description) +- [owner](typedoc_interfaces.ICasePostRequest.md#owner) +- [settings](typedoc_interfaces.ICasePostRequest.md#settings) +- [tags](typedoc_interfaces.ICasePostRequest.md#tags) +- [title](typedoc_interfaces.ICasePostRequest.md#title) ## Properties ### connector -• **connector**: { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: jira } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` ; `type`: none } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: resilient } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: serviceNowITSM } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: serviceNowSIR } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: swimlane } +• **connector**: { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } = `CaseConnectorRt` -Inherited from: CasePostRequest.connector +#### Inherited from + +CasePostRequest.connector ___ ### description -• **description**: *string* +• **description**: `string` = `rt.string` + +#### Inherited from -Inherited from: CasePostRequest.description +CasePostRequest.description ___ ### owner -• **owner**: *string* +• **owner**: `string` = `rt.string` + +#### Inherited from -Inherited from: CasePostRequest.owner +CasePostRequest.owner ___ ### settings -• **settings**: *object* +• **settings**: `Object` = `SettingsRt` #### Type declaration | Name | Type | | :------ | :------ | -| `syncAlerts` | *boolean* | +| `syncAlerts` | `boolean` | -Inherited from: CasePostRequest.settings +#### Inherited from + +CasePostRequest.settings ___ ### tags -• **tags**: *string*[] +• **tags**: `string`[] + +#### Inherited from -Inherited from: CasePostRequest.tags +CasePostRequest.tags ___ ### title -• **title**: *string* - -Inherited from: CasePostRequest.title - -___ - -### type +• **title**: `string` = `rt.string` -• **type**: *undefined* \| collection \| individual +#### Inherited from -Inherited from: CasePostRequest.type +CasePostRequest.title diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icaseresponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icaseresponse.md index dc591a508844b..5a323c8095768 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icaseresponse.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icaseresponse.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [typedoc_interfaces](../modules/typedoc_interfaces.md) / ICaseResponse +[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICaseResponse # Interface: ICaseResponse @@ -6,223 +6,234 @@ ## Hierarchy -- *CaseResponse* +- [`CaseResponse`](../modules/typedoc_interfaces._internal_namespace.md#caseresponse) - ↳ **ICaseResponse** + ↳ **`ICaseResponse`** ## Table of contents ### Properties -- [closed\_at](typedoc_interfaces.icaseresponse.md#closed_at) -- [closed\_by](typedoc_interfaces.icaseresponse.md#closed_by) -- [comments](typedoc_interfaces.icaseresponse.md#comments) -- [connector](typedoc_interfaces.icaseresponse.md#connector) -- [created\_at](typedoc_interfaces.icaseresponse.md#created_at) -- [created\_by](typedoc_interfaces.icaseresponse.md#created_by) -- [description](typedoc_interfaces.icaseresponse.md#description) -- [external\_service](typedoc_interfaces.icaseresponse.md#external_service) -- [id](typedoc_interfaces.icaseresponse.md#id) -- [owner](typedoc_interfaces.icaseresponse.md#owner) -- [settings](typedoc_interfaces.icaseresponse.md#settings) -- [status](typedoc_interfaces.icaseresponse.md#status) -- [subCaseIds](typedoc_interfaces.icaseresponse.md#subcaseids) -- [subCases](typedoc_interfaces.icaseresponse.md#subcases) -- [tags](typedoc_interfaces.icaseresponse.md#tags) -- [title](typedoc_interfaces.icaseresponse.md#title) -- [totalAlerts](typedoc_interfaces.icaseresponse.md#totalalerts) -- [totalComment](typedoc_interfaces.icaseresponse.md#totalcomment) -- [type](typedoc_interfaces.icaseresponse.md#type) -- [updated\_at](typedoc_interfaces.icaseresponse.md#updated_at) -- [updated\_by](typedoc_interfaces.icaseresponse.md#updated_by) -- [version](typedoc_interfaces.icaseresponse.md#version) +- [closed\_at](typedoc_interfaces.ICaseResponse.md#closed_at) +- [closed\_by](typedoc_interfaces.ICaseResponse.md#closed_by) +- [comments](typedoc_interfaces.ICaseResponse.md#comments) +- [connector](typedoc_interfaces.ICaseResponse.md#connector) +- [created\_at](typedoc_interfaces.ICaseResponse.md#created_at) +- [created\_by](typedoc_interfaces.ICaseResponse.md#created_by) +- [description](typedoc_interfaces.ICaseResponse.md#description) +- [external\_service](typedoc_interfaces.ICaseResponse.md#external_service) +- [id](typedoc_interfaces.ICaseResponse.md#id) +- [owner](typedoc_interfaces.ICaseResponse.md#owner) +- [settings](typedoc_interfaces.ICaseResponse.md#settings) +- [status](typedoc_interfaces.ICaseResponse.md#status) +- [tags](typedoc_interfaces.ICaseResponse.md#tags) +- [title](typedoc_interfaces.ICaseResponse.md#title) +- [totalAlerts](typedoc_interfaces.ICaseResponse.md#totalalerts) +- [totalComment](typedoc_interfaces.ICaseResponse.md#totalcomment) +- [updated\_at](typedoc_interfaces.ICaseResponse.md#updated_at) +- [updated\_by](typedoc_interfaces.ICaseResponse.md#updated_by) +- [version](typedoc_interfaces.ICaseResponse.md#version) ## Properties ### closed\_at -• **closed\_at**: ``null`` \| *string* +• **closed\_at**: ``null`` \| `string` -Inherited from: CaseResponse.closed\_at +#### Inherited from + +CaseResponse.closed\_at ___ ### closed\_by -• **closed\_by**: ``null`` \| { `email`: *undefined* \| ``null`` \| *string* ; `full_name`: *undefined* \| ``null`` \| *string* ; `username`: *undefined* \| ``null`` \| *string* } +• **closed\_by**: ``null`` \| { `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` } + +#### Inherited from -Inherited from: CaseResponse.closed\_by +CaseResponse.closed\_by ___ ### comments -• **comments**: *undefined* \| { `comment`: *string* ; `owner`: *string* ; `type`: user } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* } & { `alertId`: *string* \| *string*[] ; `index`: *string* \| *string*[] ; `owner`: *string* ; `rule`: { id: string \| null; name: string \| null; } ; `type`: alert \| generatedAlert } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: *string* ; `owner`: *string* ; `type`: actions } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* }[] +• **comments**: `undefined` \| { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string }[] -Inherited from: CaseResponse.comments +#### Inherited from + +CaseResponse.comments ___ ### connector -• **connector**: { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: jira } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` ; `type`: none } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: resilient } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: serviceNowITSM } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: serviceNowSIR } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: swimlane } +• **connector**: { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } = `CaseConnectorRt` + +#### Inherited from -Inherited from: CaseResponse.connector +CaseResponse.connector ___ ### created\_at -• **created\_at**: *string* +• **created\_at**: `string` = `rt.string` -Inherited from: CaseResponse.created\_at +#### Inherited from + +CaseResponse.created\_at ___ ### created\_by -• **created\_by**: *object* +• **created\_by**: `Object` = `UserRT` #### Type declaration | Name | Type | | :------ | :------ | -| `email` | *undefined* \| ``null`` \| *string* | -| `full_name` | *undefined* \| ``null`` \| *string* | -| `username` | *undefined* \| ``null`` \| *string* | +| `email` | `undefined` \| ``null`` \| `string` | +| `full_name` | `undefined` \| ``null`` \| `string` | +| `username` | `undefined` \| ``null`` \| `string` | + +#### Inherited from -Inherited from: CaseResponse.created\_by +CaseResponse.created\_by ___ ### description -• **description**: *string* +• **description**: `string` = `rt.string` -Inherited from: CaseResponse.description +#### Inherited from + +CaseResponse.description ___ ### external\_service -• **external\_service**: ``null`` \| { `connector_id`: *string* ; `connector_name`: *string* ; `external_id`: *string* ; `external_title`: *string* ; `external_url`: *string* } & { `pushed_at`: *string* ; `pushed_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } +• **external\_service**: ``null`` \| { `connector_id`: `string` = rt.string } & { `connector_name`: `string` = rt.string; `external_id`: `string` = rt.string; `external_title`: `string` = rt.string; `external_url`: `string` = rt.string; `pushed_at`: `string` = rt.string; `pushed_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT } = `CaseFullExternalServiceRt` + +#### Inherited from -Inherited from: CaseResponse.external\_service +CaseResponse.external\_service ___ ### id -• **id**: *string* +• **id**: `string` = `rt.string` -Inherited from: CaseResponse.id +#### Inherited from + +CaseResponse.id ___ ### owner -• **owner**: *string* +• **owner**: `string` = `rt.string` + +#### Inherited from -Inherited from: CaseResponse.owner +CaseResponse.owner ___ ### settings -• **settings**: *object* +• **settings**: `Object` = `SettingsRt` #### Type declaration | Name | Type | | :------ | :------ | -| `syncAlerts` | *boolean* | - -Inherited from: CaseResponse.settings - -___ - -### status +| `syncAlerts` | `boolean` | -• **status**: CaseStatuses +#### Inherited from -Inherited from: CaseResponse.status +CaseResponse.settings ___ -### subCaseIds - -• **subCaseIds**: *undefined* \| *string*[] - -Inherited from: CaseResponse.subCaseIds - -___ +### status -### subCases +• **status**: `CaseStatuses` = `CaseStatusRt` -• **subCases**: *undefined* \| { `status`: CaseStatuses } & { `closed_at`: ``null`` \| *string* ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: *string* ; `created_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `totalAlerts`: *number* ; `totalComment`: *number* ; `version`: *string* } & { `comments`: *undefined* \| { `comment`: *string* ; `owner`: *string* ; `type`: user } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* } & { `alertId`: *string* \| *string*[] ; `index`: *string* \| *string*[] ; `owner`: *string* ; `rule`: { id: string \| null; name: string \| null; } ; `type`: alert \| generatedAlert } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: *string* ; `owner`: *string* ; `type`: actions } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* }[] }[] +#### Inherited from -Inherited from: CaseResponse.subCases +CaseResponse.status ___ ### tags -• **tags**: *string*[] +• **tags**: `string`[] + +#### Inherited from -Inherited from: CaseResponse.tags +CaseResponse.tags ___ ### title -• **title**: *string* +• **title**: `string` = `rt.string` -Inherited from: CaseResponse.title +#### Inherited from + +CaseResponse.title ___ ### totalAlerts -• **totalAlerts**: *number* +• **totalAlerts**: `number` = `rt.number` + +#### Inherited from -Inherited from: CaseResponse.totalAlerts +CaseResponse.totalAlerts ___ ### totalComment -• **totalComment**: *number* +• **totalComment**: `number` = `rt.number` -Inherited from: CaseResponse.totalComment +#### Inherited from -___ - -### type - -• **type**: CaseType - -Inherited from: CaseResponse.type +CaseResponse.totalComment ___ ### updated\_at -• **updated\_at**: ``null`` \| *string* +• **updated\_at**: ``null`` \| `string` -Inherited from: CaseResponse.updated\_at +#### Inherited from + +CaseResponse.updated\_at ___ ### updated\_by -• **updated\_by**: ``null`` \| { `email`: *undefined* \| ``null`` \| *string* ; `full_name`: *undefined* \| ``null`` \| *string* ; `username`: *undefined* \| ``null`` \| *string* } +• **updated\_by**: ``null`` \| { `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` } + +#### Inherited from -Inherited from: CaseResponse.updated\_by +CaseResponse.updated\_by ___ ### version -• **version**: *string* +• **version**: `string` = `rt.string` + +#### Inherited from -Inherited from: CaseResponse.version +CaseResponse.version diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigurepatch.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigurepatch.md index 9ab5341a2dbc6..b645740febc08 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigurepatch.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigurepatch.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [typedoc_interfaces](../modules/typedoc_interfaces.md) / ICasesConfigurePatch +[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICasesConfigurePatch # Interface: ICasesConfigurePatch @@ -6,38 +6,44 @@ ## Hierarchy -- *CasesConfigurePatch* +- [`CasesConfigurePatch`](../modules/typedoc_interfaces._internal_namespace.md#casesconfigurepatch) - ↳ **ICasesConfigurePatch** + ↳ **`ICasesConfigurePatch`** ## Table of contents ### Properties -- [closure\_type](typedoc_interfaces.icasesconfigurepatch.md#closure_type) -- [connector](typedoc_interfaces.icasesconfigurepatch.md#connector) -- [version](typedoc_interfaces.icasesconfigurepatch.md#version) +- [closure\_type](typedoc_interfaces.ICasesConfigurePatch.md#closure_type) +- [connector](typedoc_interfaces.ICasesConfigurePatch.md#connector) +- [version](typedoc_interfaces.ICasesConfigurePatch.md#version) ## Properties ### closure\_type -• **closure\_type**: *undefined* \| ``"close-by-user"`` \| ``"close-by-pushing"`` +• **closure\_type**: `undefined` \| ``"close-by-user"`` \| ``"close-by-pushing"`` = `ClosureTypeRT` -Inherited from: CasesConfigurePatch.closure\_type +#### Inherited from + +CasesConfigurePatch.closure\_type ___ ### connector -• **connector**: *undefined* \| { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: jira } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` ; `type`: none } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: resilient } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: serviceNowITSM } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: serviceNowSIR } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: swimlane } +• **connector**: `undefined` \| { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } = `CaseConnectorRt` + +#### Inherited from -Inherited from: CasesConfigurePatch.connector +CasesConfigurePatch.connector ___ ### version -• **version**: *string* +• **version**: `string` = `rt.string` + +#### Inherited from -Inherited from: CasesConfigurePatch.version +CasesConfigurePatch.version diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigurerequest.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigurerequest.md index 0b1c11ac548a6..5dc7249d20f57 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigurerequest.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigurerequest.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [typedoc_interfaces](../modules/typedoc_interfaces.md) / ICasesConfigureRequest +[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICasesConfigureRequest # Interface: ICasesConfigureRequest @@ -6,38 +6,44 @@ ## Hierarchy -- *CasesConfigureRequest* +- [`CasesConfigureRequest`](../modules/typedoc_interfaces._internal_namespace.md#casesconfigurerequest) - ↳ **ICasesConfigureRequest** + ↳ **`ICasesConfigureRequest`** ## Table of contents ### Properties -- [closure\_type](typedoc_interfaces.icasesconfigurerequest.md#closure_type) -- [connector](typedoc_interfaces.icasesconfigurerequest.md#connector) -- [owner](typedoc_interfaces.icasesconfigurerequest.md#owner) +- [closure\_type](typedoc_interfaces.ICasesConfigureRequest.md#closure_type) +- [connector](typedoc_interfaces.ICasesConfigureRequest.md#connector) +- [owner](typedoc_interfaces.ICasesConfigureRequest.md#owner) ## Properties ### closure\_type -• **closure\_type**: ``"close-by-user"`` \| ``"close-by-pushing"`` +• **closure\_type**: ``"close-by-user"`` \| ``"close-by-pushing"`` = `ClosureTypeRT` -Inherited from: CasesConfigureRequest.closure\_type +#### Inherited from + +CasesConfigureRequest.closure\_type ___ ### connector -• **connector**: { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: jira } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` ; `type`: none } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: resilient } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: serviceNowITSM } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: serviceNowSIR } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: swimlane } +• **connector**: { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } = `CaseConnectorRt` + +#### Inherited from -Inherited from: CasesConfigureRequest.connector +CasesConfigureRequest.connector ___ ### owner -• **owner**: *string* +• **owner**: `string` = `rt.string` + +#### Inherited from -Inherited from: CasesConfigureRequest.owner +CasesConfigureRequest.owner diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigureresponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigureresponse.md index 42c7378431c1b..20754bcaa22b6 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigureresponse.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesconfigureresponse.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [typedoc_interfaces](../modules/typedoc_interfaces.md) / ICasesConfigureResponse +[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICasesConfigureResponse # Interface: ICasesConfigureResponse @@ -6,118 +6,140 @@ ## Hierarchy -- *CasesConfigureResponse* +- [`CasesConfigureResponse`](../modules/typedoc_interfaces._internal_namespace.md#casesconfigureresponse) - ↳ **ICasesConfigureResponse** + ↳ **`ICasesConfigureResponse`** ## Table of contents ### Properties -- [closure\_type](typedoc_interfaces.icasesconfigureresponse.md#closure_type) -- [connector](typedoc_interfaces.icasesconfigureresponse.md#connector) -- [created\_at](typedoc_interfaces.icasesconfigureresponse.md#created_at) -- [created\_by](typedoc_interfaces.icasesconfigureresponse.md#created_by) -- [error](typedoc_interfaces.icasesconfigureresponse.md#error) -- [id](typedoc_interfaces.icasesconfigureresponse.md#id) -- [mappings](typedoc_interfaces.icasesconfigureresponse.md#mappings) -- [owner](typedoc_interfaces.icasesconfigureresponse.md#owner) -- [updated\_at](typedoc_interfaces.icasesconfigureresponse.md#updated_at) -- [updated\_by](typedoc_interfaces.icasesconfigureresponse.md#updated_by) -- [version](typedoc_interfaces.icasesconfigureresponse.md#version) +- [closure\_type](typedoc_interfaces.ICasesConfigureResponse.md#closure_type) +- [connector](typedoc_interfaces.ICasesConfigureResponse.md#connector) +- [created\_at](typedoc_interfaces.ICasesConfigureResponse.md#created_at) +- [created\_by](typedoc_interfaces.ICasesConfigureResponse.md#created_by) +- [error](typedoc_interfaces.ICasesConfigureResponse.md#error) +- [id](typedoc_interfaces.ICasesConfigureResponse.md#id) +- [mappings](typedoc_interfaces.ICasesConfigureResponse.md#mappings) +- [owner](typedoc_interfaces.ICasesConfigureResponse.md#owner) +- [updated\_at](typedoc_interfaces.ICasesConfigureResponse.md#updated_at) +- [updated\_by](typedoc_interfaces.ICasesConfigureResponse.md#updated_by) +- [version](typedoc_interfaces.ICasesConfigureResponse.md#version) ## Properties ### closure\_type -• **closure\_type**: ``"close-by-user"`` \| ``"close-by-pushing"`` +• **closure\_type**: ``"close-by-user"`` \| ``"close-by-pushing"`` = `ClosureTypeRT` -Inherited from: CasesConfigureResponse.closure\_type +#### Inherited from + +CasesConfigureResponse.closure\_type ___ ### connector -• **connector**: { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: jira } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` ; `type`: none } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: resilient } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: serviceNowITSM } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: serviceNowSIR } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: swimlane } +• **connector**: { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } = `CaseConnectorRt` + +#### Inherited from -Inherited from: CasesConfigureResponse.connector +CasesConfigureResponse.connector ___ ### created\_at -• **created\_at**: *string* +• **created\_at**: `string` = `rt.string` + +#### Inherited from -Inherited from: CasesConfigureResponse.created\_at +CasesConfigureResponse.created\_at ___ ### created\_by -• **created\_by**: *object* +• **created\_by**: `Object` = `UserRT` #### Type declaration | Name | Type | | :------ | :------ | -| `email` | *undefined* \| ``null`` \| *string* | -| `full_name` | *undefined* \| ``null`` \| *string* | -| `username` | *undefined* \| ``null`` \| *string* | +| `email` | `undefined` \| ``null`` \| `string` | +| `full_name` | `undefined` \| ``null`` \| `string` | +| `username` | `undefined` \| ``null`` \| `string` | -Inherited from: CasesConfigureResponse.created\_by +#### Inherited from + +CasesConfigureResponse.created\_by ___ ### error -• **error**: ``null`` \| *string* +• **error**: ``null`` \| `string` + +#### Inherited from -Inherited from: CasesConfigureResponse.error +CasesConfigureResponse.error ___ ### id -• **id**: *string* +• **id**: `string` = `rt.string` + +#### Inherited from -Inherited from: CasesConfigureResponse.id +CasesConfigureResponse.id ___ ### mappings -• **mappings**: { `action_type`: ``"append"`` \| ``"nothing"`` \| ``"overwrite"`` ; `source`: ``"description"`` \| ``"title"`` \| ``"comments"`` ; `target`: *string* }[] +• **mappings**: { `action_type`: ``"append"`` \| ``"nothing"`` \| ``"overwrite"`` = ActionTypeRT; `source`: ``"description"`` \| ``"title"`` \| ``"comments"`` = CaseFieldRT; `target`: `string` = ThirdPartyFieldRT }[] -Inherited from: CasesConfigureResponse.mappings +#### Inherited from + +CasesConfigureResponse.mappings ___ ### owner -• **owner**: *string* +• **owner**: `string` = `rt.string` + +#### Inherited from -Inherited from: CasesConfigureResponse.owner +CasesConfigureResponse.owner ___ ### updated\_at -• **updated\_at**: ``null`` \| *string* +• **updated\_at**: ``null`` \| `string` + +#### Inherited from -Inherited from: CasesConfigureResponse.updated\_at +CasesConfigureResponse.updated\_at ___ ### updated\_by -• **updated\_by**: ``null`` \| { `email`: *undefined* \| ``null`` \| *string* ; `full_name`: *undefined* \| ``null`` \| *string* ; `username`: *undefined* \| ``null`` \| *string* } +• **updated\_by**: ``null`` \| { `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string` } -Inherited from: CasesConfigureResponse.updated\_by +#### Inherited from + +CasesConfigureResponse.updated\_by ___ ### version -• **version**: *string* +• **version**: `string` = `rt.string` + +#### Inherited from -Inherited from: CasesConfigureResponse.version +CasesConfigureResponse.version diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesfindrequest.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesfindrequest.md index cb8ec7797677f..b9cc22c6eee44 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesfindrequest.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesfindrequest.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [typedoc_interfaces](../modules/typedoc_interfaces.md) / ICasesFindRequest +[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICasesFindRequest # Interface: ICasesFindRequest @@ -6,128 +6,143 @@ ## Hierarchy -- *CasesFindRequest* +- [`CasesFindRequest`](../modules/client._internal_namespace.md#casesfindrequest) - ↳ **ICasesFindRequest** + ↳ **`ICasesFindRequest`** ## Table of contents ### Properties -- [defaultSearchOperator](typedoc_interfaces.icasesfindrequest.md#defaultsearchoperator) -- [fields](typedoc_interfaces.icasesfindrequest.md#fields) -- [owner](typedoc_interfaces.icasesfindrequest.md#owner) -- [page](typedoc_interfaces.icasesfindrequest.md#page) -- [perPage](typedoc_interfaces.icasesfindrequest.md#perpage) -- [reporters](typedoc_interfaces.icasesfindrequest.md#reporters) -- [search](typedoc_interfaces.icasesfindrequest.md#search) -- [searchFields](typedoc_interfaces.icasesfindrequest.md#searchfields) -- [sortField](typedoc_interfaces.icasesfindrequest.md#sortfield) -- [sortOrder](typedoc_interfaces.icasesfindrequest.md#sortorder) -- [status](typedoc_interfaces.icasesfindrequest.md#status) -- [tags](typedoc_interfaces.icasesfindrequest.md#tags) -- [type](typedoc_interfaces.icasesfindrequest.md#type) +- [defaultSearchOperator](typedoc_interfaces.ICasesFindRequest.md#defaultsearchoperator) +- [fields](typedoc_interfaces.ICasesFindRequest.md#fields) +- [owner](typedoc_interfaces.ICasesFindRequest.md#owner) +- [page](typedoc_interfaces.ICasesFindRequest.md#page) +- [perPage](typedoc_interfaces.ICasesFindRequest.md#perpage) +- [reporters](typedoc_interfaces.ICasesFindRequest.md#reporters) +- [search](typedoc_interfaces.ICasesFindRequest.md#search) +- [searchFields](typedoc_interfaces.ICasesFindRequest.md#searchfields) +- [sortField](typedoc_interfaces.ICasesFindRequest.md#sortfield) +- [sortOrder](typedoc_interfaces.ICasesFindRequest.md#sortorder) +- [status](typedoc_interfaces.ICasesFindRequest.md#status) +- [tags](typedoc_interfaces.ICasesFindRequest.md#tags) ## Properties ### defaultSearchOperator -• **defaultSearchOperator**: *undefined* \| ``"AND"`` \| ``"OR"`` +• **defaultSearchOperator**: `undefined` \| ``"AND"`` \| ``"OR"`` -Inherited from: CasesFindRequest.defaultSearchOperator +#### Inherited from + +CasesFindRequest.defaultSearchOperator ___ ### fields -• **fields**: *undefined* \| *string*[] +• **fields**: `undefined` \| `string`[] + +#### Inherited from -Inherited from: CasesFindRequest.fields +CasesFindRequest.fields ___ ### owner -• **owner**: *undefined* \| *string* \| *string*[] +• **owner**: `undefined` \| `string` \| `string`[] -Inherited from: CasesFindRequest.owner +#### Inherited from + +CasesFindRequest.owner ___ ### page -• **page**: *undefined* \| *number* +• **page**: `undefined` \| `number` = `NumberFromString` + +#### Inherited from -Inherited from: CasesFindRequest.page +CasesFindRequest.page ___ ### perPage -• **perPage**: *undefined* \| *number* +• **perPage**: `undefined` \| `number` = `NumberFromString` -Inherited from: CasesFindRequest.perPage +#### Inherited from + +CasesFindRequest.perPage ___ ### reporters -• **reporters**: *undefined* \| *string* \| *string*[] +• **reporters**: `undefined` \| `string` \| `string`[] + +#### Inherited from -Inherited from: CasesFindRequest.reporters +CasesFindRequest.reporters ___ ### search -• **search**: *undefined* \| *string* +• **search**: `undefined` \| `string` = `rt.string` -Inherited from: CasesFindRequest.search +#### Inherited from + +CasesFindRequest.search ___ ### searchFields -• **searchFields**: *undefined* \| *string* \| *string*[] +• **searchFields**: `undefined` \| `string` \| `string`[] + +#### Inherited from -Inherited from: CasesFindRequest.searchFields +CasesFindRequest.searchFields ___ ### sortField -• **sortField**: *undefined* \| *string* +• **sortField**: `undefined` \| `string` = `rt.string` -Inherited from: CasesFindRequest.sortField +#### Inherited from + +CasesFindRequest.sortField ___ ### sortOrder -• **sortOrder**: *undefined* \| ``"desc"`` \| ``"asc"`` +• **sortOrder**: `undefined` \| ``"desc"`` \| ``"asc"`` + +#### Inherited from -Inherited from: CasesFindRequest.sortOrder +CasesFindRequest.sortOrder ___ ### status -• **status**: *undefined* \| open \| *any*[*any*] \| closed +• **status**: `undefined` \| [`open`](../enums/client._internal_namespace.CaseStatuses.md#open) \| `any`[`any`] \| [`closed`](../enums/client._internal_namespace.CaseStatuses.md#closed) = `CaseStatusRt` -Inherited from: CasesFindRequest.status +#### Inherited from + +CasesFindRequest.status ___ ### tags -• **tags**: *undefined* \| *string* \| *string*[] - -Inherited from: CasesFindRequest.tags - -___ - -### type +• **tags**: `undefined` \| `string` \| `string`[] -• **type**: *undefined* \| collection \| individual +#### Inherited from -Inherited from: CasesFindRequest.type +CasesFindRequest.tags diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesfindresponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesfindresponse.md index 06e14d219cde0..16b88c29d4d8e 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesfindresponse.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesfindresponse.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [typedoc_interfaces](../modules/typedoc_interfaces.md) / ICasesFindResponse +[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICasesFindResponse # Interface: ICasesFindResponse @@ -6,74 +6,88 @@ ## Hierarchy -- *CasesFindResponse* +- [`CasesFindResponse`](../modules/typedoc_interfaces._internal_namespace.md#casesfindresponse) - ↳ **ICasesFindResponse** + ↳ **`ICasesFindResponse`** ## Table of contents ### Properties -- [cases](typedoc_interfaces.icasesfindresponse.md#cases) -- [count\_closed\_cases](typedoc_interfaces.icasesfindresponse.md#count_closed_cases) -- [count\_in\_progress\_cases](typedoc_interfaces.icasesfindresponse.md#count_in_progress_cases) -- [count\_open\_cases](typedoc_interfaces.icasesfindresponse.md#count_open_cases) -- [page](typedoc_interfaces.icasesfindresponse.md#page) -- [per\_page](typedoc_interfaces.icasesfindresponse.md#per_page) -- [total](typedoc_interfaces.icasesfindresponse.md#total) +- [cases](typedoc_interfaces.ICasesFindResponse.md#cases) +- [count\_closed\_cases](typedoc_interfaces.ICasesFindResponse.md#count_closed_cases) +- [count\_in\_progress\_cases](typedoc_interfaces.ICasesFindResponse.md#count_in_progress_cases) +- [count\_open\_cases](typedoc_interfaces.ICasesFindResponse.md#count_open_cases) +- [page](typedoc_interfaces.ICasesFindResponse.md#page) +- [per\_page](typedoc_interfaces.ICasesFindResponse.md#per_page) +- [total](typedoc_interfaces.ICasesFindResponse.md#total) ## Properties ### cases -• **cases**: { `connector`: { id: string; name: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { id: string; name: string; } & { type: ConnectorTypes.none; fields: null; } & { id: string; name: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { id: string; name: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { id: string; name: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { id: string; name: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } ; `description`: *string* ; `owner`: *string* ; `settings`: { syncAlerts: boolean; } ; `status`: CaseStatuses ; `tags`: *string*[] ; `title`: *string* ; `type`: CaseType } & { `closed_at`: ``null`` \| *string* ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `external_service`: ``null`` \| { connector\_id: string; connector\_name: string; external\_id: string; external\_title: string; external\_url: string; } & { pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; }; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `totalAlerts`: *number* ; `totalComment`: *number* ; `version`: *string* } & { `comments`: *undefined* \| { `comment`: *string* ; `owner`: *string* ; `type`: user } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* } & { `alertId`: *string* \| *string*[] ; `index`: *string* \| *string*[] ; `owner`: *string* ; `rule`: { id: string \| null; name: string \| null; } ; `type`: alert \| generatedAlert } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: *string* ; `owner`: *string* ; `type`: actions } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* }[] ; `subCaseIds`: *undefined* \| *string*[] ; `subCases`: *undefined* \| { `status`: CaseStatuses } & { `closed_at`: ``null`` \| *string* ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: *string* ; `created_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `totalAlerts`: *number* ; `totalComment`: *number* ; `version`: *string* } & { comments?: ((({ comment: string; type: CommentType.user; owner: string; } & { associationType: AssociationType; created\_at: string; created\_by: { email: string \| null \| undefined; full\_name: string \| ... 1 more ... \| undefined; username: string \| ... 1 more ... \| undefined; }; ... 4 more ...; updated\_by: { ...; } ...[] }[] +• **cases**: { `connector`: { id: string; } & { type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.none; fields: null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.resilient; fields: { incidentTypes: string[] \| null; severityCode: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowITSM; fields: { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.serviceNowSIR; fields: { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } \| null; } & { name: string; } & { id: string; } & { type: ConnectorTypes.swimlane; fields: { caseId: string \| null; } \| null; } & { name: string; } = CaseConnectorRt; `description`: `string` = rt.string; `owner`: `string` = rt.string; `settings`: { syncAlerts: boolean; } = SettingsRt; `status`: `CaseStatuses` = CaseStatusRt; `tags`: `string`[] ; `title`: `string` = rt.string } & { `closed_at`: ``null`` \| `string` ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `external_service`: ``null`` \| { connector\_id: string; } & { connector\_name: string; external\_id: string; external\_title: string; external\_url: string; pushed\_at: string; pushed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| ... 1 more ... \| undefined; }; } = CaseFullExternalServiceRt; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `totalAlerts`: `number` = rt.number; `totalComment`: `number` = rt.number; `version`: `string` = rt.string } & { `comments`: `undefined` \| { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string }[] }[] -Inherited from: CasesFindResponse.cases +#### Inherited from + +CasesFindResponse.cases ___ ### count\_closed\_cases -• **count\_closed\_cases**: *number* +• **count\_closed\_cases**: `number` = `rt.number` + +#### Inherited from -Inherited from: CasesFindResponse.count\_closed\_cases +CasesFindResponse.count\_closed\_cases ___ ### count\_in\_progress\_cases -• **count\_in\_progress\_cases**: *number* +• **count\_in\_progress\_cases**: `number` = `rt.number` -Inherited from: CasesFindResponse.count\_in\_progress\_cases +#### Inherited from + +CasesFindResponse.count\_in\_progress\_cases ___ ### count\_open\_cases -• **count\_open\_cases**: *number* +• **count\_open\_cases**: `number` = `rt.number` + +#### Inherited from -Inherited from: CasesFindResponse.count\_open\_cases +CasesFindResponse.count\_open\_cases ___ ### page -• **page**: *number* +• **page**: `number` = `rt.number` -Inherited from: CasesFindResponse.page +#### Inherited from + +CasesFindResponse.page ___ ### per\_page -• **per\_page**: *number* +• **per\_page**: `number` = `rt.number` + +#### Inherited from -Inherited from: CasesFindResponse.per\_page +CasesFindResponse.per\_page ___ ### total -• **total**: *number* +• **total**: `number` = `rt.number` + +#### Inherited from -Inherited from: CasesFindResponse.total +CasesFindResponse.total diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasespatchrequest.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasespatchrequest.md index d4747a1836cc4..5cf299204ef13 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasespatchrequest.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasespatchrequest.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [typedoc_interfaces](../modules/typedoc_interfaces.md) / ICasesPatchRequest +[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICasesPatchRequest # Interface: ICasesPatchRequest @@ -6,20 +6,22 @@ ## Hierarchy -- *CasesPatchRequest* +- [`CasesPatchRequest`](../modules/typedoc_interfaces._internal_namespace.md#casespatchrequest) - ↳ **ICasesPatchRequest** + ↳ **`ICasesPatchRequest`** ## Table of contents ### Properties -- [cases](typedoc_interfaces.icasespatchrequest.md#cases) +- [cases](typedoc_interfaces.ICasesPatchRequest.md#cases) ## Properties ### cases -• **cases**: { `connector`: *undefined* \| { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: jira } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` ; `type`: none } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: resilient } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: serviceNowITSM } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: serviceNowSIR } & { `id`: *string* ; `name`: *string* } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: swimlane } ; `description`: *undefined* \| *string* ; `owner`: *undefined* \| *string* ; `settings`: *undefined* \| { `syncAlerts`: *boolean* } ; `status`: *undefined* \| open \| *any*[*any*] \| closed ; `tags`: *undefined* \| *string*[] ; `title`: *undefined* \| *string* ; `type`: *undefined* \| collection \| individual } & { `id`: *string* ; `version`: *string* }[] +• **cases**: { `connector`: `undefined` \| { `id`: `string` = rt.string } & { `fields`: ``null`` \| { issueType: string \| null; priority: string \| null; parent: string \| null; } ; `type`: [`jira`](../modules/client._internal_namespace.md#jira) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` = rt.null; `type`: [`none`](../modules/client._internal_namespace.md#none) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { incidentTypes: string[] \| null; severityCode: string \| null; } ; `type`: [`resilient`](../modules/client._internal_namespace.md#resilient) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { impact: string \| null; severity: string \| null; urgency: string \| null; category: string \| null; subcategory: string \| null; } ; `type`: [`serviceNowITSM`](../modules/client._internal_namespace.md#servicenowitsm) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { category: string \| null; destIp: boolean \| null; malwareHash: boolean \| null; malwareUrl: boolean \| null; priority: string \| null; sourceIp: boolean \| null; subcategory: string \| null; } ; `type`: [`serviceNowSIR`](../modules/client._internal_namespace.md#servicenowsir) } & { `name`: `string` = rt.string } & { `id`: `string` = rt.string } & { `fields`: ``null`` \| { caseId: string \| null; } ; `type`: [`swimlane`](../modules/client._internal_namespace.md#swimlane) } & { `name`: `string` = rt.string } = CaseConnectorRt; `description`: `undefined` \| `string` = rt.string; `owner`: `undefined` \| `string` = rt.string; `settings`: `undefined` \| { `syncAlerts`: `boolean` = rt.boolean } = SettingsRt; `status`: `undefined` \| [`open`](../enums/client._internal_namespace.CaseStatuses.md#open) \| `any`[`any`] \| [`closed`](../enums/client._internal_namespace.CaseStatuses.md#closed) = CaseStatusRt; `tags`: `undefined` \| `string`[] ; `title`: `undefined` \| `string` = rt.string } & { `id`: `string` = rt.string; `version`: `string` = rt.string }[] -Inherited from: CasesPatchRequest.cases +#### Inherited from + +CasesPatchRequest.cases diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesresponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesresponse.md index 2c9eed242d1fb..250ac66e4a680 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesresponse.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icasesresponse.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [typedoc_interfaces](../modules/typedoc_interfaces.md) / ICasesResponse +[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICasesResponse # Interface: ICasesResponse @@ -6,6 +6,6 @@ ## Hierarchy -- *CasesResponse* +- [`CasesResponse`](../modules/typedoc_interfaces._internal_namespace.md#casesresponse) - ↳ **ICasesResponse** + ↳ **`ICasesResponse`** diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icaseuseractionsresponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icaseuseractionsresponse.md index 0347711e331dc..d3b936903e42c 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icaseuseractionsresponse.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icaseuseractionsresponse.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [typedoc_interfaces](../modules/typedoc_interfaces.md) / ICaseUserActionsResponse +[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICaseUserActionsResponse # Interface: ICaseUserActionsResponse @@ -6,6 +6,6 @@ ## Hierarchy -- *CaseUserActionsResponse* +- [`CaseUserActionsResponse`](../modules/typedoc_interfaces._internal_namespace.md#caseuseractionsresponse) - ↳ **ICaseUserActionsResponse** + ↳ **`ICaseUserActionsResponse`** diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icommentsresponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icommentsresponse.md index 4a720e2c6d9be..012b28393f5b9 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icommentsresponse.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.icommentsresponse.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [typedoc_interfaces](../modules/typedoc_interfaces.md) / ICommentsResponse +[Cases Client API Interface](../README.md) / [typedoc\_interfaces](../modules/typedoc_interfaces.md) / ICommentsResponse # Interface: ICommentsResponse @@ -6,47 +6,55 @@ ## Hierarchy -- *CommentsResponse* +- [`CommentsResponse`](../modules/typedoc_interfaces._internal_namespace.md#commentsresponse) - ↳ **ICommentsResponse** + ↳ **`ICommentsResponse`** ## Table of contents ### Properties -- [comments](typedoc_interfaces.icommentsresponse.md#comments) -- [page](typedoc_interfaces.icommentsresponse.md#page) -- [per\_page](typedoc_interfaces.icommentsresponse.md#per_page) -- [total](typedoc_interfaces.icommentsresponse.md#total) +- [comments](typedoc_interfaces.ICommentsResponse.md#comments) +- [page](typedoc_interfaces.ICommentsResponse.md#page) +- [per\_page](typedoc_interfaces.ICommentsResponse.md#per_page) +- [total](typedoc_interfaces.ICommentsResponse.md#total) ## Properties ### comments -• **comments**: { `comment`: *string* ; `owner`: *string* ; `type`: user } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* } & { `alertId`: *string* \| *string*[] ; `index`: *string* \| *string*[] ; `owner`: *string* ; `rule`: { id: string \| null; name: string \| null; } ; `type`: alert \| generatedAlert } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: *string* ; `owner`: *string* ; `type`: actions } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* }[] +• **comments**: { `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`user`](../modules/client._internal_namespace.md#user) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `alertId`: `string` \| `string`[] ; `index`: `string` \| `string`[] ; `owner`: `string` = rt.string; `rule`: { id: string \| null; name: string \| null; } ; `type`: [`alert`](../modules/client._internal_namespace.md#alert) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: `string` = rt.string; `owner`: `string` = rt.string; `type`: [`actions`](../modules/client._internal_namespace.md#actions) } & { `created_at`: `string` = rt.string; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } = UserRT; `owner`: `string` = rt.string; `pushed_at`: ``null`` \| `string` ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| `string` ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: `string` = rt.string; `version`: `string` = rt.string }[] -Inherited from: CommentsResponse.comments +#### Inherited from + +CommentsResponse.comments ___ ### page -• **page**: *number* +• **page**: `number` = `rt.number` + +#### Inherited from -Inherited from: CommentsResponse.page +CommentsResponse.page ___ ### per\_page -• **per\_page**: *number* +• **per\_page**: `number` = `rt.number` -Inherited from: CommentsResponse.per\_page +#### Inherited from + +CommentsResponse.per\_page ___ ### total -• **total**: *number* +• **total**: `number` = `rt.number` + +#### Inherited from -Inherited from: CommentsResponse.total +CommentsResponse.total diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.isubcaseresponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.isubcaseresponse.md deleted file mode 100644 index a6bf610f86349..0000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.isubcaseresponse.md +++ /dev/null @@ -1,133 +0,0 @@ -[Cases Client API Interface](../cases_client_api.md) / [typedoc_interfaces](../modules/typedoc_interfaces.md) / ISubCaseResponse - -# Interface: ISubCaseResponse - -[typedoc_interfaces](../modules/typedoc_interfaces.md).ISubCaseResponse - -## Hierarchy - -- *SubCaseResponse* - - ↳ **ISubCaseResponse** - -## Table of contents - -### Properties - -- [closed\_at](typedoc_interfaces.isubcaseresponse.md#closed_at) -- [closed\_by](typedoc_interfaces.isubcaseresponse.md#closed_by) -- [comments](typedoc_interfaces.isubcaseresponse.md#comments) -- [created\_at](typedoc_interfaces.isubcaseresponse.md#created_at) -- [created\_by](typedoc_interfaces.isubcaseresponse.md#created_by) -- [id](typedoc_interfaces.isubcaseresponse.md#id) -- [owner](typedoc_interfaces.isubcaseresponse.md#owner) -- [status](typedoc_interfaces.isubcaseresponse.md#status) -- [totalAlerts](typedoc_interfaces.isubcaseresponse.md#totalalerts) -- [totalComment](typedoc_interfaces.isubcaseresponse.md#totalcomment) -- [updated\_at](typedoc_interfaces.isubcaseresponse.md#updated_at) -- [updated\_by](typedoc_interfaces.isubcaseresponse.md#updated_by) -- [version](typedoc_interfaces.isubcaseresponse.md#version) - -## Properties - -### closed\_at - -• **closed\_at**: ``null`` \| *string* - -Inherited from: SubCaseResponse.closed\_at - -___ - -### closed\_by - -• **closed\_by**: ``null`` \| { `email`: *undefined* \| ``null`` \| *string* ; `full_name`: *undefined* \| ``null`` \| *string* ; `username`: *undefined* \| ``null`` \| *string* } - -Inherited from: SubCaseResponse.closed\_by - -___ - -### comments - -• **comments**: *undefined* \| { `comment`: *string* ; `owner`: *string* ; `type`: user } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* } & { `alertId`: *string* \| *string*[] ; `index`: *string* \| *string*[] ; `owner`: *string* ; `rule`: { id: string \| null; name: string \| null; } ; `type`: alert \| generatedAlert } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: *string* ; `owner`: *string* ; `type`: actions } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* }[] - -Inherited from: SubCaseResponse.comments - -___ - -### created\_at - -• **created\_at**: *string* - -Inherited from: SubCaseResponse.created\_at - -___ - -### created\_by - -• **created\_by**: ``null`` \| { `email`: *undefined* \| ``null`` \| *string* ; `full_name`: *undefined* \| ``null`` \| *string* ; `username`: *undefined* \| ``null`` \| *string* } - -Inherited from: SubCaseResponse.created\_by - -___ - -### id - -• **id**: *string* - -Inherited from: SubCaseResponse.id - -___ - -### owner - -• **owner**: *string* - -Inherited from: SubCaseResponse.owner - -___ - -### status - -• **status**: CaseStatuses - -Inherited from: SubCaseResponse.status - -___ - -### totalAlerts - -• **totalAlerts**: *number* - -Inherited from: SubCaseResponse.totalAlerts - -___ - -### totalComment - -• **totalComment**: *number* - -Inherited from: SubCaseResponse.totalComment - -___ - -### updated\_at - -• **updated\_at**: ``null`` \| *string* - -Inherited from: SubCaseResponse.updated\_at - -___ - -### updated\_by - -• **updated\_by**: ``null`` \| { `email`: *undefined* \| ``null`` \| *string* ; `full_name`: *undefined* \| ``null`` \| *string* ; `username`: *undefined* \| ``null`` \| *string* } - -Inherited from: SubCaseResponse.updated\_by - -___ - -### version - -• **version**: *string* - -Inherited from: SubCaseResponse.version diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.isubcasesfindresponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.isubcasesfindresponse.md deleted file mode 100644 index 61fb60a54db00..0000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.isubcasesfindresponse.md +++ /dev/null @@ -1,79 +0,0 @@ -[Cases Client API Interface](../cases_client_api.md) / [typedoc_interfaces](../modules/typedoc_interfaces.md) / ISubCasesFindResponse - -# Interface: ISubCasesFindResponse - -[typedoc_interfaces](../modules/typedoc_interfaces.md).ISubCasesFindResponse - -## Hierarchy - -- *SubCasesFindResponse* - - ↳ **ISubCasesFindResponse** - -## Table of contents - -### Properties - -- [count\_closed\_cases](typedoc_interfaces.isubcasesfindresponse.md#count_closed_cases) -- [count\_in\_progress\_cases](typedoc_interfaces.isubcasesfindresponse.md#count_in_progress_cases) -- [count\_open\_cases](typedoc_interfaces.isubcasesfindresponse.md#count_open_cases) -- [page](typedoc_interfaces.isubcasesfindresponse.md#page) -- [per\_page](typedoc_interfaces.isubcasesfindresponse.md#per_page) -- [subCases](typedoc_interfaces.isubcasesfindresponse.md#subcases) -- [total](typedoc_interfaces.isubcasesfindresponse.md#total) - -## Properties - -### count\_closed\_cases - -• **count\_closed\_cases**: *number* - -Inherited from: SubCasesFindResponse.count\_closed\_cases - -___ - -### count\_in\_progress\_cases - -• **count\_in\_progress\_cases**: *number* - -Inherited from: SubCasesFindResponse.count\_in\_progress\_cases - -___ - -### count\_open\_cases - -• **count\_open\_cases**: *number* - -Inherited from: SubCasesFindResponse.count\_open\_cases - -___ - -### page - -• **page**: *number* - -Inherited from: SubCasesFindResponse.page - -___ - -### per\_page - -• **per\_page**: *number* - -Inherited from: SubCasesFindResponse.per\_page - -___ - -### subCases - -• **subCases**: { `status`: CaseStatuses } & { `closed_at`: ``null`` \| *string* ; `closed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `created_at`: *string* ; `created_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `totalAlerts`: *number* ; `totalComment`: *number* ; `version`: *string* } & { `comments`: *undefined* \| { `comment`: *string* ; `owner`: *string* ; `type`: user } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* } & { `alertId`: *string* \| *string*[] ; `index`: *string* \| *string*[] ; `owner`: *string* ; `rule`: { id: string \| null; name: string \| null; } ; `type`: alert \| generatedAlert } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* } & { `actions`: { targets: { hostname: string; endpointId: string; }[]; type: string; } ; `comment`: *string* ; `owner`: *string* ; `type`: actions } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } } & { `id`: *string* ; `version`: *string* }[] }[] - -Inherited from: SubCasesFindResponse.subCases - -___ - -### total - -• **total**: *number* - -Inherited from: SubCasesFindResponse.total diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.isubcasesresponse.md b/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.isubcasesresponse.md deleted file mode 100644 index 6ee45e59b53b5..0000000000000 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/typedoc_interfaces.isubcasesresponse.md +++ /dev/null @@ -1,11 +0,0 @@ -[Cases Client API Interface](../cases_client_api.md) / [typedoc_interfaces](../modules/typedoc_interfaces.md) / ISubCasesResponse - -# Interface: ISubCasesResponse - -[typedoc_interfaces](../modules/typedoc_interfaces.md).ISubCasesResponse - -## Hierarchy - -- *SubCasesResponse* - - ↳ **ISubCasesResponse** diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/user_actions_client.useractionget.md b/x-pack/plugins/cases/docs/cases_client/interfaces/user_actions_client.useractionget.md index 1cbebef379dbd..8650aed9753f1 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/user_actions_client.useractionget.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/user_actions_client.useractionget.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [user_actions/client](../modules/user_actions_client.md) / UserActionGet +[Cases Client API Interface](../README.md) / [user\_actions/client](../modules/user_actions_client.md) / UserActionGet # Interface: UserActionGet @@ -10,25 +10,16 @@ Parameters for retrieving user actions for a particular case ### Properties -- [caseId](user_actions_client.useractionget.md#caseid) -- [subCaseId](user_actions_client.useractionget.md#subcaseid) +- [caseId](user_actions_client.UserActionGet.md#caseid) ## Properties ### caseId -• **caseId**: *string* +• **caseId**: `string` The ID of the case -Defined in: [user_actions/client.ts:19](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/user_actions/client.ts#L19) +#### Defined in -___ - -### subCaseId - -• `Optional` **subCaseId**: *string* - -If specified then a sub case will be used for finding all the user actions - -Defined in: [user_actions/client.ts:23](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/user_actions/client.ts#L23) +[x-pack/plugins/cases/server/client/user_actions/client.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/user_actions/client.ts#L19) diff --git a/x-pack/plugins/cases/docs/cases_client/interfaces/user_actions_client.useractionssubclient.md b/x-pack/plugins/cases/docs/cases_client/interfaces/user_actions_client.useractionssubclient.md index 065f20b4cefcb..0cf541f5cc445 100644 --- a/x-pack/plugins/cases/docs/cases_client/interfaces/user_actions_client.useractionssubclient.md +++ b/x-pack/plugins/cases/docs/cases_client/interfaces/user_actions_client.useractionssubclient.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / [user_actions/client](../modules/user_actions_client.md) / UserActionsSubClient +[Cases Client API Interface](../README.md) / [user\_actions/client](../modules/user_actions_client.md) / UserActionsSubClient # Interface: UserActionsSubClient @@ -10,13 +10,13 @@ API for interacting the actions performed by a user when interacting with the ca ### Methods -- [getAll](user_actions_client.useractionssubclient.md#getall) +- [getAll](user_actions_client.UserActionsSubClient.md#getall) ## Methods ### getAll -▸ **getAll**(`clientArgs`: [*UserActionGet*](user_actions_client.useractionget.md)): *Promise*<[*ICaseUserActionsResponse*](typedoc_interfaces.icaseuseractionsresponse.md)\> +▸ **getAll**(`clientArgs`): `Promise`<[`ICaseUserActionsResponse`](typedoc_interfaces.ICaseUserActionsResponse.md)\> Retrieves all user actions for a particular case. @@ -24,8 +24,12 @@ Retrieves all user actions for a particular case. | Name | Type | | :------ | :------ | -| `clientArgs` | [*UserActionGet*](user_actions_client.useractionget.md) | +| `clientArgs` | [`UserActionGet`](user_actions_client.UserActionGet.md) | -**Returns:** *Promise*<[*ICaseUserActionsResponse*](typedoc_interfaces.icaseuseractionsresponse.md)\> +#### Returns -Defined in: [user_actions/client.ts:33](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/user_actions/client.ts#L33) +`Promise`<[`ICaseUserActionsResponse`](typedoc_interfaces.ICaseUserActionsResponse.md)\> + +#### Defined in + +[x-pack/plugins/cases/server/client/user_actions/client.ts:29](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/user_actions/client.ts#L29) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/attachments_add.md b/x-pack/plugins/cases/docs/cases_client/modules/attachments_add.md deleted file mode 100644 index d9ac6e6ce431b..0000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/attachments_add.md +++ /dev/null @@ -1,9 +0,0 @@ -[Cases Client API Interface](../cases_client_api.md) / attachments/add - -# Module: attachments/add - -## Table of contents - -### Interfaces - -- [AddArgs](../interfaces/attachments_add.addargs.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/attachments_client._internal_namespace.md b/x-pack/plugins/cases/docs/cases_client/modules/attachments_client._internal_namespace.md new file mode 100644 index 0000000000000..953648379c08f --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/modules/attachments_client._internal_namespace.md @@ -0,0 +1,18 @@ +[Cases Client API Interface](../README.md) / [attachments/client](attachments_client.md) / \_internal\_namespace + +# Namespace: \_internal\_namespace + +[attachments/client](attachments_client.md)._internal_namespace + +## Table of contents + +### Interfaces + +- [AddArgs](../interfaces/attachments_client._internal_namespace.AddArgs.md) +- [DeleteAllArgs](../interfaces/attachments_client._internal_namespace.DeleteAllArgs.md) +- [DeleteArgs](../interfaces/attachments_client._internal_namespace.DeleteArgs.md) +- [FindArgs](../interfaces/attachments_client._internal_namespace.FindArgs.md) +- [GetAllAlertsAttachToCase](../interfaces/attachments_client._internal_namespace.GetAllAlertsAttachToCase.md) +- [GetAllArgs](../interfaces/attachments_client._internal_namespace.GetAllArgs.md) +- [GetArgs](../interfaces/attachments_client._internal_namespace.GetArgs.md) +- [UpdateArgs](../interfaces/attachments_client._internal_namespace.UpdateArgs.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/attachments_client.md b/x-pack/plugins/cases/docs/cases_client/modules/attachments_client.md index 47d96b98356e7..2463e2c654e93 100644 --- a/x-pack/plugins/cases/docs/cases_client/modules/attachments_client.md +++ b/x-pack/plugins/cases/docs/cases_client/modules/attachments_client.md @@ -1,9 +1,13 @@ -[Cases Client API Interface](../cases_client_api.md) / attachments/client +[Cases Client API Interface](../README.md) / attachments/client # Module: attachments/client ## Table of contents +### Namespaces + +- [\_internal\_namespace](attachments_client._internal_namespace.md) + ### Interfaces -- [AttachmentsSubClient](../interfaces/attachments_client.attachmentssubclient.md) +- [AttachmentsSubClient](../interfaces/attachments_client.AttachmentsSubClient.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/attachments_delete.md b/x-pack/plugins/cases/docs/cases_client/modules/attachments_delete.md deleted file mode 100644 index 0e2cf420b6375..0000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/attachments_delete.md +++ /dev/null @@ -1,10 +0,0 @@ -[Cases Client API Interface](../cases_client_api.md) / attachments/delete - -# Module: attachments/delete - -## Table of contents - -### Interfaces - -- [DeleteAllArgs](../interfaces/attachments_delete.deleteallargs.md) -- [DeleteArgs](../interfaces/attachments_delete.deleteargs.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/attachments_get.md b/x-pack/plugins/cases/docs/cases_client/modules/attachments_get.md deleted file mode 100644 index 6460511da79a1..0000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/attachments_get.md +++ /dev/null @@ -1,12 +0,0 @@ -[Cases Client API Interface](../cases_client_api.md) / attachments/get - -# Module: attachments/get - -## Table of contents - -### Interfaces - -- [FindArgs](../interfaces/attachments_get.findargs.md) -- [GetAllAlertsAttachToCase](../interfaces/attachments_get.getallalertsattachtocase.md) -- [GetAllArgs](../interfaces/attachments_get.getallargs.md) -- [GetArgs](../interfaces/attachments_get.getargs.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/attachments_update.md b/x-pack/plugins/cases/docs/cases_client/modules/attachments_update.md deleted file mode 100644 index 011fe531ede34..0000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/attachments_update.md +++ /dev/null @@ -1,9 +0,0 @@ -[Cases Client API Interface](../cases_client_api.md) / attachments/update - -# Module: attachments/update - -## Table of contents - -### Interfaces - -- [UpdateArgs](../interfaces/attachments_update.updateargs.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/cases_client.md b/x-pack/plugins/cases/docs/cases_client/modules/cases_client.md index c6e9cf17d9840..daf591f75c1f8 100644 --- a/x-pack/plugins/cases/docs/cases_client/modules/cases_client.md +++ b/x-pack/plugins/cases/docs/cases_client/modules/cases_client.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / cases/client +[Cases Client API Interface](../README.md) / cases/client # Module: cases/client @@ -6,4 +6,4 @@ ### Interfaces -- [CasesSubClient](../interfaces/cases_client.casessubclient.md) +- [CasesSubClient](../interfaces/cases_client.CasesSubClient.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/cases_get._internal_namespace.md b/x-pack/plugins/cases/docs/cases_client/modules/cases_get._internal_namespace.md new file mode 100644 index 0000000000000..a43b25f69372f --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/modules/cases_get._internal_namespace.md @@ -0,0 +1,35 @@ +[Cases Client API Interface](../README.md) / [cases/get](cases_get.md) / \_internal\_namespace + +# Namespace: \_internal\_namespace + +[cases/get](cases_get.md)._internal_namespace + +## Table of contents + +### Type aliases + +- [User](cases_get._internal_namespace.md#user) + +### Variables + +- [UserRT](cases_get._internal_namespace.md#userrt) + +## Type aliases + +### User + +Ƭ **User**: `rt.TypeOf` + +#### Defined in + +[x-pack/plugins/cases/common/api/user.ts:18](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/user.ts#L18) + +## Variables + +### UserRT + +• **UserRT**: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> + +#### Defined in + +[x-pack/plugins/cases/common/api/user.ts:10](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/user.ts#L10) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/cases_get.md b/x-pack/plugins/cases/docs/cases_client/modules/cases_get.md index 4c165866cec47..6dbf7bb10d0a3 100644 --- a/x-pack/plugins/cases/docs/cases_client/modules/cases_get.md +++ b/x-pack/plugins/cases/docs/cases_client/modules/cases_get.md @@ -1,24 +1,29 @@ -[Cases Client API Interface](../cases_client_api.md) / cases/get +[Cases Client API Interface](../README.md) / cases/get # Module: cases/get ## Table of contents +### Namespaces + +- [\_internal\_namespace](cases_get._internal_namespace.md) + ### Interfaces -- [CasesByAlertIDParams](../interfaces/cases_get.casesbyalertidparams.md) -- [GetParams](../interfaces/cases_get.getparams.md) +- [CasesByAlertIDParams](../interfaces/cases_get.CasesByAlertIDParams.md) +- [GetParams](../interfaces/cases_get.GetParams.md) ### Functions - [getReporters](cases_get.md#getreporters) - [getTags](cases_get.md#gettags) +- [resolve](cases_get.md#resolve) ## Functions ### getReporters -▸ **getReporters**(`params`: AllReportersFindRequest, `clientArgs`: CasesClientArgs): *Promise* +▸ **getReporters**(`params`, `clientArgs`): `Promise`<[`User`](cases_get._internal_namespace.md#user)[]\> Retrieves the reporters from all the cases. @@ -26,18 +31,23 @@ Retrieves the reporters from all the cases. | Name | Type | | :------ | :------ | -| `params` | AllReportersFindRequest | -| `clientArgs` | CasesClientArgs | +| `params` | `Object` | +| `params.owner` | `undefined` \| `string` \| `string`[] | +| `clientArgs` | [`CasesClientArgs`](../interfaces/client._internal_namespace.CasesClientArgs.md) | + +#### Returns -**Returns:** *Promise* +`Promise`<[`User`](cases_get._internal_namespace.md#user)[]\> -Defined in: [cases/get.ts:289](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/get.ts#L289) +#### Defined in + +[x-pack/plugins/cases/server/client/cases/get.ts:301](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/get.ts#L301) ___ ### getTags -▸ **getTags**(`params`: AllTagsFindRequest, `clientArgs`: CasesClientArgs): *Promise* +▸ **getTags**(`params`, `clientArgs`): `Promise`<`string`[]\> Retrieves the tags from all the cases. @@ -45,9 +55,39 @@ Retrieves the tags from all the cases. | Name | Type | | :------ | :------ | -| `params` | AllTagsFindRequest | -| `clientArgs` | CasesClientArgs | +| `params` | `Object` | +| `params.owner` | `undefined` \| `string` \| `string`[] | +| `clientArgs` | [`CasesClientArgs`](../interfaces/client._internal_namespace.CasesClientArgs.md) | + +#### Returns + +`Promise`<`string`[]\> + +#### Defined in + +[x-pack/plugins/cases/server/client/cases/get.ts:269](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/get.ts#L269) + +___ + +### resolve + +▸ `Const` **resolve**(`__namedParameters`, `clientArgs`): `Promise`<{ `case`: { description: string; status: CaseStatuses; tags: string[]; title: string; connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { ...; }) \| ... 4 more ... \| ({ ...; } & { ...; })); settings: { ...; }; owner: str... & { closed\_at: string \| null; closed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } \| null; created\_at: string; created\_by: { ...; }; external\_service: ({ ...; } & { ...; }) \| null; updated\_at: string \| null; updated\_by: { ...; } \| null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { `comments`: `undefined` \| { comment: string; type: CommentType.user; owner: string; } & { created\_at: string; created\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; }; owner: string; pushed\_at: string \| null; pushed\_by: { ...; } \| null; updated\_at: string \| null; updated\_by: { ...; } \| null; } & { id: string; version: string; } & { type: CommentType.alert; alertId: string \| string[]; index: string \| string[]; rule: { id: string \| null; name: string \| null; }; owner: string; } & { created\_at: string; created\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; }; owner: string; pushed\_at: string \| null; pushed\_by: { ...; } \| null; updated\_at: string \| null; updated\_by: { ...; } \| null; } & { id: string; version: string; } & { type: CommentType.actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; } & { created\_at: string; created\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; }; owner: string; pushed\_at: string \| null; pushed\_by: { ...; } \| null; updated\_at: string \| null; updated\_by: { ...; } \| null; } & { id: string; version: string; }[] } = CaseResponseRt; `outcome`: ``"exactMatch"`` \| ``"aliasMatch"`` \| ``"conflict"`` } & { `alias_target_id`: `undefined` \| `string` = rt.string }\> + +Retrieves a case resolving its ID and optionally loading its comments. + +**`experimental`** + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`GetParams`](../interfaces/cases_get.GetParams.md) | +| `clientArgs` | [`CasesClientArgs`](../interfaces/client._internal_namespace.CasesClientArgs.md) | + +#### Returns + +`Promise`<{ `case`: { description: string; status: CaseStatuses; tags: string[]; title: string; connector: { id: string; } & (({ type: ConnectorTypes.jira; fields: { issueType: string \| null; priority: string \| null; parent: string \| null; } \| null; } & { ...; }) \| ... 4 more ... \| ({ ...; } & { ...; })); settings: { ...; }; owner: str... & { closed\_at: string \| null; closed\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } \| null; created\_at: string; created\_by: { ...; }; external\_service: ({ ...; } & { ...; }) \| null; updated\_at: string \| null; updated\_by: { ...; } \| null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { `comments`: `undefined` \| { comment: string; type: CommentType.user; owner: string; } & { created\_at: string; created\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; }; owner: string; pushed\_at: string \| null; pushed\_by: { ...; } \| null; updated\_at: string \| null; updated\_by: { ...; } \| null; } & { id: string; version: string; } & { type: CommentType.alert; alertId: string \| string[]; index: string \| string[]; rule: { id: string \| null; name: string \| null; }; owner: string; } & { created\_at: string; created\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; }; owner: string; pushed\_at: string \| null; pushed\_by: { ...; } \| null; updated\_at: string \| null; updated\_by: { ...; } \| null; } & { id: string; version: string; } & { type: CommentType.actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; } & { created\_at: string; created\_by: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; }; owner: string; pushed\_at: string \| null; pushed\_by: { ...; } \| null; updated\_at: string \| null; updated\_by: { ...; } \| null; } & { id: string; version: string; }[] } = CaseResponseRt; `outcome`: ``"exactMatch"`` \| ``"aliasMatch"`` \| ``"conflict"`` } & { `alias_target_id`: `undefined` \| `string` = rt.string }\> -**Returns:** *Promise* +#### Defined in -Defined in: [cases/get.ts:239](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/get.ts#L239) +[x-pack/plugins/cases/server/client/cases/get.ts:208](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/cases/get.ts#L208) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/cases_push.md b/x-pack/plugins/cases/docs/cases_client/modules/cases_push.md index 4be9df64bb420..bb9667b3308db 100644 --- a/x-pack/plugins/cases/docs/cases_client/modules/cases_push.md +++ b/x-pack/plugins/cases/docs/cases_client/modules/cases_push.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / cases/push +[Cases Client API Interface](../README.md) / cases/push # Module: cases/push @@ -6,4 +6,4 @@ ### Interfaces -- [PushParams](../interfaces/cases_push.pushparams.md) +- [PushParams](../interfaces/cases_push.PushParams.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/client._internal_namespace.md b/x-pack/plugins/cases/docs/cases_client/modules/client._internal_namespace.md new file mode 100644 index 0000000000000..4489106b370d1 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/modules/client._internal_namespace.md @@ -0,0 +1,2213 @@ +[Cases Client API Interface](../README.md) / [client](client.md) / \_internal\_namespace + +# Namespace: \_internal\_namespace + +[client](client.md)._internal_namespace + +## Table of contents + +### Enumerations + +- [ActionExecutionSourceType](../enums/client._internal_namespace.ActionExecutionSourceType.md) +- [AuthorizationMode](../enums/client._internal_namespace.AuthorizationMode.md) +- [CaseStatuses](../enums/client._internal_namespace.CaseStatuses.md) +- [TaskStatus](../enums/client._internal_namespace.TaskStatus.md) +- [ViewMode](../enums/client._internal_namespace.ViewMode.md) + +### Enumeration members + +- [actions](client._internal_namespace.md#actions) +- [alert](client._internal_namespace.md#alert) +- [jira](client._internal_namespace.md#jira) +- [none](client._internal_namespace.md#none) +- [resilient](client._internal_namespace.md#resilient) +- [serviceNowITSM](client._internal_namespace.md#servicenowitsm) +- [serviceNowSIR](client._internal_namespace.md#servicenowsir) +- [swimlane](client._internal_namespace.md#swimlane) +- [user](client._internal_namespace.md#user) + +### Classes + +- [ActionExecutor](../classes/client._internal_namespace.ActionExecutor.md) +- [ActionTypeRegistry](../classes/client._internal_namespace.ActionTypeRegistry.md) +- [Actions](../classes/client._internal_namespace.Actions.md) +- [ActionsAuthorization](../classes/client._internal_namespace.ActionsAuthorization.md) +- [ActionsClient](../classes/client._internal_namespace.ActionsClient.md) +- [AlertService](../classes/client._internal_namespace.AlertService.md) +- [AlertingActions](../classes/client._internal_namespace.AlertingActions.md) +- [ApiActions](../classes/client._internal_namespace.ApiActions.md) +- [AppActions](../classes/client._internal_namespace.AppActions.md) +- [AttachmentService](../classes/client._internal_namespace.AttachmentService.md) +- [Authorization](../classes/client._internal_namespace.Authorization.md) +- [AuthorizationAuditLogger](../classes/client._internal_namespace.AuthorizationAuditLogger.md) +- [BasePath](../classes/client._internal_namespace.BasePath.md) +- [BuilderFactory](../classes/client._internal_namespace.BuilderFactory.md) +- [CaseConfigureService](../classes/client._internal_namespace.CaseConfigureService.md) +- [CaseUserActionService](../classes/client._internal_namespace.CaseUserActionService.md) +- [CasesActions](../classes/client._internal_namespace.CasesActions.md) +- [CasesClientInternal](../classes/client._internal_namespace.CasesClientInternal.md) +- [CasesService](../classes/client._internal_namespace.CasesService.md) +- [ConnectorMappingsService](../classes/client._internal_namespace.ConnectorMappingsService.md) +- [ConnectorTokenClient](../classes/client._internal_namespace.ConnectorTokenClient.md) +- [ElasticsearchFeature](../classes/client._internal_namespace.ElasticsearchFeature.md) +- [KibanaFeature](../classes/client._internal_namespace.KibanaFeature.md) +- [KibanaMigrator](../classes/client._internal_namespace.KibanaMigrator.md) +- [KibanaRequest](../classes/client._internal_namespace.KibanaRequest.md) +- [LicenseState](../classes/client._internal_namespace.LicenseState.md) +- [RouteValidationError](../classes/client._internal_namespace.RouteValidationError.md) +- [RouteValidator](../classes/client._internal_namespace.RouteValidator.md) +- [SavedObjectActions](../classes/client._internal_namespace.SavedObjectActions.md) +- [SavedObjectTypeRegistry](../classes/client._internal_namespace.SavedObjectTypeRegistry.md) +- [SavedObjectsClient](../classes/client._internal_namespace.SavedObjectsClient.md) +- [SavedObjectsErrorHelpers](../classes/client._internal_namespace.SavedObjectsErrorHelpers.md) +- [SavedObjectsRepository](../classes/client._internal_namespace.SavedObjectsRepository.md) +- [SpaceActions](../classes/client._internal_namespace.SpaceActions.md) +- [SubFeature](../classes/client._internal_namespace.SubFeature.md) +- [TaskRunnerFactory](../classes/client._internal_namespace.TaskRunnerFactory.md) +- [UIActions](../classes/client._internal_namespace.UIActions.md) +- [UserActionBuilder](../classes/client._internal_namespace.UserActionBuilder.md) + +### Interfaces + +- [Action](../interfaces/client._internal_namespace.Action.md) +- [ActionExecutionSource](../interfaces/client._internal_namespace.ActionExecutionSource.md) +- [ActionExecutorContext](../interfaces/client._internal_namespace.ActionExecutorContext.md) +- [ActionResult](../interfaces/client._internal_namespace.ActionResult.md) +- [ActionType](../interfaces/client._internal_namespace.ActionType.md) +- [ActionType](../interfaces/client._internal_namespace.ActionType-1.md) +- [ActionTypeExecutorOptions](../interfaces/client._internal_namespace.ActionTypeExecutorOptions.md) +- [ActionTypeExecutorResult](../interfaces/client._internal_namespace.ActionTypeExecutorResult.md) +- [ActionTypeRegistryOpts](../interfaces/client._internal_namespace.ActionTypeRegistryOpts.md) +- [ActionUpdate](../interfaces/client._internal_namespace.ActionUpdate.md) +- [ActionsConfigurationUtilities](../interfaces/client._internal_namespace.ActionsConfigurationUtilities.md) +- [ActionsLicenseInformation](../interfaces/client._internal_namespace.ActionsLicenseInformation.md) +- [AggregationBuilder](../interfaces/client._internal_namespace.AggregationBuilder.md) +- [Alert](../interfaces/client._internal_namespace.Alert.md) +- [AlertIdIndex](../interfaces/client._internal_namespace.AlertIdIndex.md) +- [AlertInfo](../interfaces/client._internal_namespace.AlertInfo.md) +- [AlertsResponse](../interfaces/client._internal_namespace.AlertsResponse.md) +- [AppCategory](../interfaces/client._internal_namespace.AppCategory.md) +- [AttachedToCaseArgs](../interfaces/client._internal_namespace.AttachedToCaseArgs.md) +- [Attributes](../interfaces/client._internal_namespace.Attributes.md) +- [AuditEvent](../interfaces/client._internal_namespace.AuditEvent.md) +- [AuditLogger](../interfaces/client._internal_namespace.AuditLogger.md) +- [AuthFilterHelpers](../interfaces/client._internal_namespace.AuthFilterHelpers.md) +- [AuthenticatedUser](../interfaces/client._internal_namespace.AuthenticatedUser.md) +- [AuthenticationProvider](../interfaces/client._internal_namespace.AuthenticationProvider.md) +- [AuthorizationMode](../interfaces/client._internal_namespace.AuthorizationMode-1.md) +- [AuthorizationServiceSetup](../interfaces/client._internal_namespace.AuthorizationServiceSetup.md) +- [BeforeSaveContext](../interfaces/client._internal_namespace.BeforeSaveContext.md) +- [BuilderParameters](../interfaces/client._internal_namespace.BuilderParameters.md) +- [BuilderReturnValue](../interfaces/client._internal_namespace.BuilderReturnValue.md) +- [BulkCreateAttachmentDeletionUserAction](../interfaces/client._internal_namespace.BulkCreateAttachmentDeletionUserAction.md) +- [BulkCreateBulkUpdateCaseUserActions](../interfaces/client._internal_namespace.BulkCreateBulkUpdateCaseUserActions.md) +- [BulkCreateCaseDeletionUserAction](../interfaces/client._internal_namespace.BulkCreateCaseDeletionUserAction.md) +- [BulkUpdateAttachmentArgs](../interfaces/client._internal_namespace.BulkUpdateAttachmentArgs.md) +- [CancellableTask](../interfaces/client._internal_namespace.CancellableTask.md) +- [Capabilities](../interfaces/client._internal_namespace.Capabilities.md) +- [CaseCommentStats](../interfaces/client._internal_namespace.CaseCommentStats.md) +- [CasesClientArgs](../interfaces/client._internal_namespace.CasesClientArgs.md) +- [CasesMapWithPageInfo](../interfaces/client._internal_namespace.CasesMapWithPageInfo.md) +- [CheckPrivileges](../interfaces/client._internal_namespace.CheckPrivileges.md) +- [CheckPrivilegesOptions](../interfaces/client._internal_namespace.CheckPrivilegesOptions.md) +- [CheckPrivilegesPayload](../interfaces/client._internal_namespace.CheckPrivilegesPayload.md) +- [CheckPrivilegesResponse](../interfaces/client._internal_namespace.CheckPrivilegesResponse.md) +- [ClientArgs](../interfaces/client._internal_namespace.ClientArgs.md) +- [ClientArgs](../interfaces/client._internal_namespace.ClientArgs-1.md) +- [ClientArgs](../interfaces/client._internal_namespace.ClientArgs-2.md) +- [CommonArguments](../interfaces/client._internal_namespace.CommonArguments.md) +- [ConcreteTaskInstance](../interfaces/client._internal_namespace.ConcreteTaskInstance.md) +- [ConnectorToken](../interfaces/client._internal_namespace.ConnectorToken.md) +- [ConstructorOptions](../interfaces/client._internal_namespace.ConstructorOptions.md) +- [ConstructorOptions](../interfaces/client._internal_namespace.ConstructorOptions-1.md) +- [ConstructorOptions](../interfaces/client._internal_namespace.ConstructorOptions-2.md) +- [CountActionsAttachedToCaseArgs](../interfaces/client._internal_namespace.CountActionsAttachedToCaseArgs.md) +- [CreateAttachmentArgs](../interfaces/client._internal_namespace.CreateAttachmentArgs.md) +- [CreateAuditMsgParams](../interfaces/client._internal_namespace.CreateAuditMsgParams.md) +- [CreateOptions](../interfaces/client._internal_namespace.CreateOptions.md) +- [CreateOptions](../interfaces/client._internal_namespace.CreateOptions-1.md) +- [CreateUserAction](../interfaces/client._internal_namespace.CreateUserAction.md) +- [CreateUserActionES](../interfaces/client._internal_namespace.CreateUserActionES.md) +- [DecoratedError](../interfaces/client._internal_namespace.DecoratedError.md) +- [ElasticsearchFeatureConfig](../interfaces/client._internal_namespace.ElasticsearchFeatureConfig.md) +- [EmbeddableRegistryDefinition](../interfaces/client._internal_namespace.EmbeddableRegistryDefinition.md) +- [EncryptedSavedObjectsClient](../interfaces/client._internal_namespace.EncryptedSavedObjectsClient.md) +- [ExecuteOptions](../interfaces/client._internal_namespace.ExecuteOptions.md) +- [ExecuteOptions](../interfaces/client._internal_namespace.ExecuteOptions-1.md) +- [FeatureElasticsearchPrivileges](../interfaces/client._internal_namespace.FeatureElasticsearchPrivileges.md) +- [FeatureKibanaPrivileges](../interfaces/client._internal_namespace.FeatureKibanaPrivileges.md) +- [FeatureUsageServiceSetup](../interfaces/client._internal_namespace.FeatureUsageServiceSetup.md) +- [FindActionResult](../interfaces/client._internal_namespace.FindActionResult.md) +- [FindCaseCommentsArgs](../interfaces/client._internal_namespace.FindCaseCommentsArgs.md) +- [FindCaseConfigureArgs](../interfaces/client._internal_namespace.FindCaseConfigureArgs.md) +- [FindCasesArgs](../interfaces/client._internal_namespace.FindCasesArgs.md) +- [FindCommentsArgs](../interfaces/client._internal_namespace.FindCommentsArgs.md) +- [FindConnectorMappingsArgs](../interfaces/client._internal_namespace.FindConnectorMappingsArgs.md) +- [GetAllSpacesOptions](../interfaces/client._internal_namespace.GetAllSpacesOptions.md) +- [GetAttachmentArgs](../interfaces/client._internal_namespace.GetAttachmentArgs.md) +- [GetCaseArgs](../interfaces/client._internal_namespace.GetCaseArgs.md) +- [GetCaseConfigureArgs](../interfaces/client._internal_namespace.GetCaseConfigureArgs.md) +- [GetCaseIdsByAlertIdArgs](../interfaces/client._internal_namespace.GetCaseIdsByAlertIdArgs.md) +- [GetCaseUserActionArgs](../interfaces/client._internal_namespace.GetCaseUserActionArgs.md) +- [GetCasesArgs](../interfaces/client._internal_namespace.GetCasesArgs.md) +- [GetReportersArgs](../interfaces/client._internal_namespace.GetReportersArgs.md) +- [GetSpaceResult](../interfaces/client._internal_namespace.GetSpaceResult.md) +- [GetTagsArgs](../interfaces/client._internal_namespace.GetTagsArgs.md) +- [GetUserActionItemByDifference](../interfaces/client._internal_namespace.GetUserActionItemByDifference.md) +- [GetUserArgs](../interfaces/client._internal_namespace.GetUserArgs.md) +- [IEventLogger](../interfaces/client._internal_namespace.IEventLogger.md) +- [IKibanaSocket](../interfaces/client._internal_namespace.IKibanaSocket.md) +- [ILicense](../interfaces/client._internal_namespace.ILicense.md) +- [ISavedObjectsPointInTimeFinder](../interfaces/client._internal_namespace.ISavedObjectsPointInTimeFinder.md) +- [IScopedClusterClient](../interfaces/client._internal_namespace.IScopedClusterClient.md) +- [ISpacesClient](../interfaces/client._internal_namespace.ISpacesClient.md) +- [IUsageCounter](../interfaces/client._internal_namespace.IUsageCounter.md) +- [IncrementCounterParams](../interfaces/client._internal_namespace.IncrementCounterParams.md) +- [IndexMapping](../interfaces/client._internal_namespace.IndexMapping.md) +- [IndexMappingMeta](../interfaces/client._internal_namespace.IndexMappingMeta.md) +- [IntervalSchedule](../interfaces/client._internal_namespace.IntervalSchedule.md) +- [KibanaFeatureConfig](../interfaces/client._internal_namespace.KibanaFeatureConfig.md) +- [KibanaMigratorOptions](../interfaces/client._internal_namespace.KibanaMigratorOptions.md) +- [KibanaMigratorStatus](../interfaces/client._internal_namespace.KibanaMigratorStatus.md) +- [KibanaRequestEvents](../interfaces/client._internal_namespace.KibanaRequestEvents.md) +- [LegacyUrlAliasTarget](../interfaces/client._internal_namespace.LegacyUrlAliasTarget.md) +- [LicenseCheck](../interfaces/client._internal_namespace.LicenseCheck.md) +- [LicenseFeature](../interfaces/client._internal_namespace.LicenseFeature.md) +- [LicensingPluginSetup](../interfaces/client._internal_namespace.LicensingPluginSetup.md) +- [Middleware](../interfaces/client._internal_namespace.Middleware.md) +- [OperationDetails](../interfaces/client._internal_namespace.OperationDetails.md) +- [OwnerEntity](../interfaces/client._internal_namespace.OwnerEntity.md) +- [PatchCase](../interfaces/client._internal_namespace.PatchCase.md) +- [PatchCaseConfigureArgs](../interfaces/client._internal_namespace.PatchCaseConfigureArgs.md) +- [PatchCasesArgs](../interfaces/client._internal_namespace.PatchCasesArgs.md) +- [PersistableState](../interfaces/client._internal_namespace.PersistableState.md) +- [PluginStartContract](../interfaces/client._internal_namespace.PluginStartContract.md) +- [PostCaseArgs](../interfaces/client._internal_namespace.PostCaseArgs.md) +- [PostCaseConfigureArgs](../interfaces/client._internal_namespace.PostCaseConfigureArgs.md) +- [PostCaseUserActionArgs](../interfaces/client._internal_namespace.PostCaseUserActionArgs.md) +- [PostConnectorMappingsArgs](../interfaces/client._internal_namespace.PostConnectorMappingsArgs.md) +- [PreConfiguredAction](../interfaces/client._internal_namespace.PreConfiguredAction.md) +- [ProxySettings](../interfaces/client._internal_namespace.ProxySettings.md) +- [PublicLicense](../interfaces/client._internal_namespace.PublicLicense.md) +- [PublicLicenseJSON](../interfaces/client._internal_namespace.PublicLicenseJSON.md) +- [PushedArgs](../interfaces/client._internal_namespace.PushedArgs.md) +- [Referencable](../interfaces/client._internal_namespace.Referencable.md) +- [ReservedKibanaPrivilege](../interfaces/client._internal_namespace.ReservedKibanaPrivilege.md) +- [ResponseSettings](../interfaces/client._internal_namespace.ResponseSettings.md) +- [RouteConfigOptions](../interfaces/client._internal_namespace.RouteConfigOptions.md) +- [RouteConfigOptionsBody](../interfaces/client._internal_namespace.RouteConfigOptionsBody.md) +- [RouteValidationResultFactory](../interfaces/client._internal_namespace.RouteValidationResultFactory.md) +- [RouteValidatorConfig](../interfaces/client._internal_namespace.RouteValidatorConfig.md) +- [RouteValidatorOptions](../interfaces/client._internal_namespace.RouteValidatorOptions.md) +- [RunContext](../interfaces/client._internal_namespace.RunContext.md) +- [RunNowResult](../interfaces/client._internal_namespace.RunNowResult.md) +- [SSLSettings](../interfaces/client._internal_namespace.SSLSettings.md) +- [SavedObject](../interfaces/client._internal_namespace.SavedObject.md) +- [SavedObjectAttributes](../interfaces/client._internal_namespace.SavedObjectAttributes.md) +- [SavedObjectDoc](../interfaces/client._internal_namespace.SavedObjectDoc.md) +- [SavedObjectError](../interfaces/client._internal_namespace.SavedObjectError.md) +- [SavedObjectMigrationContext](../interfaces/client._internal_namespace.SavedObjectMigrationContext.md) +- [SavedObjectMigrationMap](../interfaces/client._internal_namespace.SavedObjectMigrationMap.md) +- [SavedObjectReference](../interfaces/client._internal_namespace.SavedObjectReference.md) +- [SavedObjectReferenceWithContext](../interfaces/client._internal_namespace.SavedObjectReferenceWithContext.md) +- [SavedObjectsBaseOptions](../interfaces/client._internal_namespace.SavedObjectsBaseOptions.md) +- [SavedObjectsBulkCreateObject](../interfaces/client._internal_namespace.SavedObjectsBulkCreateObject.md) +- [SavedObjectsBulkGetObject](../interfaces/client._internal_namespace.SavedObjectsBulkGetObject.md) +- [SavedObjectsBulkResolveObject](../interfaces/client._internal_namespace.SavedObjectsBulkResolveObject.md) +- [SavedObjectsBulkResolveResponse](../interfaces/client._internal_namespace.SavedObjectsBulkResolveResponse.md) +- [SavedObjectsBulkResponse](../interfaces/client._internal_namespace.SavedObjectsBulkResponse.md) +- [SavedObjectsBulkUpdateObject](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateObject.md) +- [SavedObjectsBulkUpdateOptions](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateOptions.md) +- [SavedObjectsBulkUpdateResponse](../interfaces/client._internal_namespace.SavedObjectsBulkUpdateResponse.md) +- [SavedObjectsCheckConflictsObject](../interfaces/client._internal_namespace.SavedObjectsCheckConflictsObject.md) +- [SavedObjectsCheckConflictsResponse](../interfaces/client._internal_namespace.SavedObjectsCheckConflictsResponse.md) +- [SavedObjectsClosePointInTimeResponse](../interfaces/client._internal_namespace.SavedObjectsClosePointInTimeResponse.md) +- [SavedObjectsCollectMultiNamespaceReferencesObject](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesObject.md) +- [SavedObjectsCollectMultiNamespaceReferencesOptions](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesOptions.md) +- [SavedObjectsCollectMultiNamespaceReferencesResponse](../interfaces/client._internal_namespace.SavedObjectsCollectMultiNamespaceReferencesResponse.md) +- [SavedObjectsCreateOptions](../interfaces/client._internal_namespace.SavedObjectsCreateOptions.md) +- [SavedObjectsCreatePointInTimeFinderDependencies](../interfaces/client._internal_namespace.SavedObjectsCreatePointInTimeFinderDependencies.md) +- [SavedObjectsDeleteByNamespaceOptions](../interfaces/client._internal_namespace.SavedObjectsDeleteByNamespaceOptions.md) +- [SavedObjectsDeleteOptions](../interfaces/client._internal_namespace.SavedObjectsDeleteOptions.md) +- [SavedObjectsExportTransformContext](../interfaces/client._internal_namespace.SavedObjectsExportTransformContext.md) +- [SavedObjectsFindOptions](../interfaces/client._internal_namespace.SavedObjectsFindOptions.md) +- [SavedObjectsFindOptionsReference](../interfaces/client._internal_namespace.SavedObjectsFindOptionsReference.md) +- [SavedObjectsFindResponse](../interfaces/client._internal_namespace.SavedObjectsFindResponse.md) +- [SavedObjectsFindResult](../interfaces/client._internal_namespace.SavedObjectsFindResult.md) +- [SavedObjectsImportActionRequiredWarning](../interfaces/client._internal_namespace.SavedObjectsImportActionRequiredWarning.md) +- [SavedObjectsImportHookResult](../interfaces/client._internal_namespace.SavedObjectsImportHookResult.md) +- [SavedObjectsImportSimpleWarning](../interfaces/client._internal_namespace.SavedObjectsImportSimpleWarning.md) +- [SavedObjectsIncrementCounterField](../interfaces/client._internal_namespace.SavedObjectsIncrementCounterField.md) +- [SavedObjectsIncrementCounterOptions](../interfaces/client._internal_namespace.SavedObjectsIncrementCounterOptions.md) +- [SavedObjectsMappingProperties](../interfaces/client._internal_namespace.SavedObjectsMappingProperties.md) +- [SavedObjectsMigrationLogger](../interfaces/client._internal_namespace.SavedObjectsMigrationLogger.md) +- [SavedObjectsMigrationVersion](../interfaces/client._internal_namespace.SavedObjectsMigrationVersion.md) +- [SavedObjectsOpenPointInTimeOptions](../interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeOptions.md) +- [SavedObjectsOpenPointInTimeResponse](../interfaces/client._internal_namespace.SavedObjectsOpenPointInTimeResponse.md) +- [SavedObjectsPitParams](../interfaces/client._internal_namespace.SavedObjectsPitParams.md) +- [SavedObjectsRemoveReferencesToOptions](../interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToOptions.md) +- [SavedObjectsRemoveReferencesToResponse](../interfaces/client._internal_namespace.SavedObjectsRemoveReferencesToResponse.md) +- [SavedObjectsResolveResponse](../interfaces/client._internal_namespace.SavedObjectsResolveResponse.md) +- [SavedObjectsType](../interfaces/client._internal_namespace.SavedObjectsType.md) +- [SavedObjectsTypeManagementDefinition](../interfaces/client._internal_namespace.SavedObjectsTypeManagementDefinition.md) +- [SavedObjectsTypeMappingDefinition](../interfaces/client._internal_namespace.SavedObjectsTypeMappingDefinition.md) +- [SavedObjectsUpdateObjectsSpacesObject](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesObject.md) +- [SavedObjectsUpdateObjectsSpacesOptions](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesOptions.md) +- [SavedObjectsUpdateObjectsSpacesResponse](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponse.md) +- [SavedObjectsUpdateObjectsSpacesResponseObject](../interfaces/client._internal_namespace.SavedObjectsUpdateObjectsSpacesResponseObject.md) +- [SavedObjectsUpdateOptions](../interfaces/client._internal_namespace.SavedObjectsUpdateOptions.md) +- [SavedObjectsUpdateResponse](../interfaces/client._internal_namespace.SavedObjectsUpdateResponse.md) +- [SavedObjectsValidationMap](../interfaces/client._internal_namespace.SavedObjectsValidationMap.md) +- [Services](../interfaces/client._internal_namespace.Services.md) +- [Space](../interfaces/client._internal_namespace.Space.md) +- [SpacesServiceStart](../interfaces/client._internal_namespace.SpacesServiceStart.md) +- [SubFeatureConfig](../interfaces/client._internal_namespace.SubFeatureConfig.md) +- [SubFeaturePrivilegeConfig](../interfaces/client._internal_namespace.SubFeaturePrivilegeConfig.md) +- [SubFeaturePrivilegeGroupConfig](../interfaces/client._internal_namespace.SubFeaturePrivilegeGroupConfig.md) +- [TaskInfo](../interfaces/client._internal_namespace.TaskInfo.md) +- [TaskInstance](../interfaces/client._internal_namespace.TaskInstance.md) +- [TaskManagerSetupContract](../interfaces/client._internal_namespace.TaskManagerSetupContract.md) +- [TaskRegisterDefinition](../interfaces/client._internal_namespace.TaskRegisterDefinition.md) +- [TaskRunnerContext](../interfaces/client._internal_namespace.TaskRunnerContext.md) +- [TranslatedUpdateAlertRequest](../interfaces/client._internal_namespace.TranslatedUpdateAlertRequest.md) +- [UpdateAlertRequest](../interfaces/client._internal_namespace.UpdateAlertRequest.md) +- [UpdateArgs](../interfaces/client._internal_namespace.UpdateArgs.md) +- [UpdateConnectorMappingsArgs](../interfaces/client._internal_namespace.UpdateConnectorMappingsArgs.md) +- [UpdateOptions](../interfaces/client._internal_namespace.UpdateOptions.md) +- [UpdateOptions](../interfaces/client._internal_namespace.UpdateOptions-1.md) +- [User](../interfaces/client._internal_namespace.User.md) +- [UserRealm](../interfaces/client._internal_namespace.UserRealm.md) +- [ValidatorType](../interfaces/client._internal_namespace.ValidatorType.md) +- [Verbs](../interfaces/client._internal_namespace.Verbs.md) + +### Type aliases + +- [ActionExecutorContract](client._internal_namespace.md#actionexecutorcontract) +- [ActionTypeConfig](client._internal_namespace.md#actiontypeconfig) +- [ActionTypeParams](client._internal_namespace.md#actiontypeparams) +- [ActionTypeRegistryContract](client._internal_namespace.md#actiontyperegistrycontract) +- [ActionTypeSecrets](client._internal_namespace.md#actiontypesecrets) +- [ActionsClient](client._internal_namespace.md#actionsclient) +- [AggregationResponse](client._internal_namespace.md#aggregationresponse) +- [BeforeRunContextFunction](client._internal_namespace.md#beforeruncontextfunction) +- [BeforeSaveContextFunction](client._internal_namespace.md#beforesavecontextfunction) +- [CancelFunction](client._internal_namespace.md#cancelfunction) +- [CasesFindRequest](client._internal_namespace.md#casesfindrequest) +- [CheckPrivilegesDynamically](client._internal_namespace.md#checkprivilegesdynamically) +- [CheckPrivilegesDynamicallyWithRequest](client._internal_namespace.md#checkprivilegesdynamicallywithrequest) +- [CheckPrivilegesWithRequest](client._internal_namespace.md#checkprivilegeswithrequest) +- [CheckSavedObjectsPrivileges](client._internal_namespace.md#checksavedobjectsprivileges) +- [CheckSavedObjectsPrivilegesWithRequest](client._internal_namespace.md#checksavedobjectsprivilegeswithrequest) +- [CommonBuilderArguments](client._internal_namespace.md#commonbuilderarguments) +- [CommonUserActionArgs](client._internal_namespace.md#commonuseractionargs) +- [ConnectorTokenClientContract](client._internal_namespace.md#connectortokenclientcontract) +- [CreateUserActionClient](client._internal_namespace.md#createuseractionclient) +- [DeepPartial](client._internal_namespace.md#deeppartial) +- [DeepWriteable](client._internal_namespace.md#deepwriteable) +- [DestructiveRouteMethod](client._internal_namespace.md#destructiveroutemethod) +- [ElasticsearchClient](client._internal_namespace.md#elasticsearchclient) +- [EmbeddableInput](client._internal_namespace.md#embeddableinput) +- [EmbeddableStateWithType](client._internal_namespace.md#embeddablestatewithtype) +- [EnsureSOAuthCallback](client._internal_namespace.md#ensuresoauthcallback) +- [ExecutionEnqueuer](client._internal_namespace.md#executionenqueuer) +- [ExecutorType](client._internal_namespace.md#executortype) +- [FailedRunResult](client._internal_namespace.md#failedrunresult) +- [FindCaseOptions](client._internal_namespace.md#findcaseoptions) +- [GetAllSpacesPurpose](client._internal_namespace.md#getallspacespurpose) +- [GetMigrationFunctionObjectFn](client._internal_namespace.md#getmigrationfunctionobjectfn) +- [GetServicesFunction](client._internal_namespace.md#getservicesfunction) +- [GetSpaceFn](client._internal_namespace.md#getspacefn) +- [Headers](client._internal_namespace.md#headers) +- [IBasePath](client._internal_namespace.md#ibasepath) +- [IEvent](client._internal_namespace.md#ievent) +- [IKibanaMigrator](client._internal_namespace.md#ikibanamigrator) +- [ILicenseState](client._internal_namespace.md#ilicensestate) +- [ISavedObjectTypeRegistry](client._internal_namespace.md#isavedobjecttyperegistry) +- [ISavedObjectsRepository](client._internal_namespace.md#isavedobjectsrepository) +- [IValidatedEvent](client._internal_namespace.md#ivalidatedevent) +- [KibanaExecutionContext](client._internal_namespace.md#kibanaexecutioncontext) +- [KibanaRequestRouteOptions](client._internal_namespace.md#kibanarequestrouteoptions) +- [KnownHeaders](client._internal_namespace.md#knownheaders) +- [KnownKeys](client._internal_namespace.md#knownkeys) +- [LicenseCheckState](client._internal_namespace.md#licensecheckstate) +- [LicenseStatus](client._internal_namespace.md#licensestatus) +- [Mapper](client._internal_namespace.md#mapper) +- [MigrateFunction](client._internal_namespace.md#migratefunction) +- [MigrateFunctionsObject](client._internal_namespace.md#migratefunctionsobject) +- [MigrationResult](client._internal_namespace.md#migrationresult) +- [MigrationStatus](client._internal_namespace.md#migrationstatus) +- [MutatingOperationRefreshSetting](client._internal_namespace.md#mutatingoperationrefreshsetting) +- [PatchCaseArgs](client._internal_namespace.md#patchcaseargs) +- [PersistableStateDefinition](client._internal_namespace.md#persistablestatedefinition) +- [PublicFeatures](client._internal_namespace.md#publicfeatures) +- [RouteContentType](client._internal_namespace.md#routecontenttype) +- [RouteMethod](client._internal_namespace.md#routemethod) +- [RouteValidationFunction](client._internal_namespace.md#routevalidationfunction) +- [RouteValidationSpec](client._internal_namespace.md#routevalidationspec) +- [RouteValidatorFullConfig](client._internal_namespace.md#routevalidatorfullconfig) +- [RunFunction](client._internal_namespace.md#runfunction) +- [RunResult](client._internal_namespace.md#runresult) +- [SafeRouteMethod](client._internal_namespace.md#saferoutemethod) +- [SavedObjectAttribute](client._internal_namespace.md#savedobjectattribute) +- [SavedObjectAttributeSingle](client._internal_namespace.md#savedobjectattributesingle) +- [SavedObjectFindOptions](client._internal_namespace.md#savedobjectfindoptions) +- [SavedObjectFindOptionsKueryNode](client._internal_namespace.md#savedobjectfindoptionskuerynode) +- [SavedObjectMigrationFn](client._internal_namespace.md#savedobjectmigrationfn) +- [SavedObjectTypeExcludeFromUpgradeFilterHook](client._internal_namespace.md#savedobjecttypeexcludefromupgradefilterhook) +- [SavedObjectUnsanitizedDoc](client._internal_namespace.md#savedobjectunsanitizeddoc) +- [SavedObjectsClientContract](client._internal_namespace.md#savedobjectsclientcontract) +- [SavedObjectsCreatePointInTimeFinderOptions](client._internal_namespace.md#savedobjectscreatepointintimefinderoptions) +- [SavedObjectsExportTransform](client._internal_namespace.md#savedobjectsexporttransform) +- [SavedObjectsExportablePredicate](client._internal_namespace.md#savedobjectsexportablepredicate) +- [SavedObjectsFieldMapping](client._internal_namespace.md#savedobjectsfieldmapping) +- [SavedObjectsImportHook](client._internal_namespace.md#savedobjectsimporthook) +- [SavedObjectsImportWarning](client._internal_namespace.md#savedobjectsimportwarning) +- [SavedObjectsNamespaceType](client._internal_namespace.md#savedobjectsnamespacetype) +- [SavedObjectsValidationSpec](client._internal_namespace.md#savedobjectsvalidationspec) +- [SpaceIdToNamespaceFunction](client._internal_namespace.md#spaceidtonamespacefunction) +- [StringKeysAsVals](client._internal_namespace.md#stringkeysasvals) +- [SubFeaturePrivilegeGroupType](client._internal_namespace.md#subfeatureprivilegegrouptype) +- [SuccessfulRunResult](client._internal_namespace.md#successfulrunresult) +- [TaskDefinitionRegistry](client._internal_namespace.md#taskdefinitionregistry) +- [TaskRunCreatorFunction](client._internal_namespace.md#taskruncreatorfunction) +- [UpdateAttachmentArgs](client._internal_namespace.md#updateattachmentargs) +- [UserAction](client._internal_namespace.md#useraction) +- [UserActionParameters](client._internal_namespace.md#useractionparameters) +- [UserActionTypes](client._internal_namespace.md#useractiontypes) + +### Variables + +- [ActionTypesRt](client._internal_namespace.md#actiontypesrt) +- [ActionsRt](client._internal_namespace.md#actionsrt) +- [CasesFindRequestRt](client._internal_namespace.md#casesfindrequestrt) +- [EventSchema](client._internal_namespace.md#eventschema) +- [SavedObjectFindOptionsRt](client._internal_namespace.md#savedobjectfindoptionsrt) + +## Enumeration members + +### actions + +• **actions**: `Object` = `"actions"` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/comment.ts:26](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/comment.ts#L26) + +___ + +### alert + +• **alert**: `Object` = `"alert"` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/comment.ts:25](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/comment.ts#L25) + +___ + +### jira + +• **jira**: `Object` = `".jira"` + +#### Defined in + +[x-pack/plugins/cases/common/api/connectors/index.ts:36](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/connectors/index.ts#L36) + +___ + +### none + +• **none**: `Object` = `".none"` + +#### Defined in + +[x-pack/plugins/cases/common/api/connectors/index.ts:37](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/connectors/index.ts#L37) + +___ + +### resilient + +• **resilient**: `Object` = `".resilient"` + +#### Defined in + +[x-pack/plugins/cases/common/api/connectors/index.ts:38](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/connectors/index.ts#L38) + +___ + +### serviceNowITSM + +• **serviceNowITSM**: `Object` = `".servicenow"` + +#### Defined in + +[x-pack/plugins/cases/common/api/connectors/index.ts:39](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/connectors/index.ts#L39) + +___ + +### serviceNowSIR + +• **serviceNowSIR**: `Object` = `".servicenow-sir"` + +#### Defined in + +[x-pack/plugins/cases/common/api/connectors/index.ts:40](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/connectors/index.ts#L40) + +___ + +### swimlane + +• **swimlane**: `Object` = `".swimlane"` + +#### Defined in + +[x-pack/plugins/cases/common/api/connectors/index.ts:41](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/connectors/index.ts#L41) + +___ + +### user + +• **user**: `Object` = `"user"` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/comment.ts:24](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/comment.ts#L24) + +## Type aliases + +### ActionExecutorContract + +Ƭ **ActionExecutorContract**: `PublicMethodsOf`<[`ActionExecutor`](../classes/client._internal_namespace.ActionExecutor.md)\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/action_executor.d.ts:34 + +___ + +### ActionTypeConfig + +Ƭ **ActionTypeConfig**: `Record`<`string`, `unknown`\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:19 + +___ + +### ActionTypeParams + +Ƭ **ActionTypeParams**: `Record`<`string`, `unknown`\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:21 + +___ + +### ActionTypeRegistryContract + +Ƭ **ActionTypeRegistryContract**: `PublicMethodsOf`<[`ActionTypeRegistry`](../classes/client._internal_namespace.ActionTypeRegistry.md)\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:17 + +___ + +### ActionTypeSecrets + +Ƭ **ActionTypeSecrets**: `Record`<`string`, `unknown`\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:20 + +___ + +### ActionsClient + +Ƭ **ActionsClient**: `PublicMethodsOf`<[`ActionsClient`](../classes/client._internal_namespace.ActionsClient.md)\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/index.d.ts:7 + +___ + +### AggregationResponse + +Ƭ **AggregationResponse**: `Record`<`string`, `estypes.AggregationsAggregate`\> \| `undefined` + +#### Defined in + +[x-pack/plugins/cases/server/client/metrics/types.ts:25](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/metrics/types.ts#L25) + +___ + +### BeforeRunContextFunction + +Ƭ **BeforeRunContextFunction**: [`Mapper`](client._internal_namespace.md#mapper)<[`RunContext`](../interfaces/client._internal_namespace.RunContext.md)\> + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/lib/middleware.d.ts:7 + +___ + +### BeforeSaveContextFunction + +Ƭ **BeforeSaveContextFunction**: [`Mapper`](client._internal_namespace.md#mapper)<[`BeforeSaveContext`](../interfaces/client._internal_namespace.BeforeSaveContext.md)\> + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/lib/middleware.d.ts:6 + +___ + +### CancelFunction + +Ƭ **CancelFunction**: () => `Promise`<[`RunResult`](client._internal_namespace.md#runresult) \| `undefined` \| `void`\> + +#### Type declaration + +▸ (): `Promise`<[`RunResult`](client._internal_namespace.md#runresult) \| `undefined` \| `void`\> + +##### Returns + +`Promise`<[`RunResult`](client._internal_namespace.md#runresult) \| `undefined` \| `void`\> + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:65 + +___ + +### CasesFindRequest + +Ƭ **CasesFindRequest**: `rt.TypeOf` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/case.ts:284](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L284) + +___ + +### CheckPrivilegesDynamically + +Ƭ **CheckPrivilegesDynamically**: (`privileges`: [`CheckPrivilegesPayload`](../interfaces/client._internal_namespace.CheckPrivilegesPayload.md), `options?`: [`CheckPrivilegesOptions`](../interfaces/client._internal_namespace.CheckPrivilegesOptions.md)) => `Promise`<[`CheckPrivilegesResponse`](../interfaces/client._internal_namespace.CheckPrivilegesResponse.md)\> + +#### Type declaration + +▸ (`privileges`, `options?`): `Promise`<[`CheckPrivilegesResponse`](../interfaces/client._internal_namespace.CheckPrivilegesResponse.md)\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `privileges` | [`CheckPrivilegesPayload`](../interfaces/client._internal_namespace.CheckPrivilegesPayload.md) | +| `options?` | [`CheckPrivilegesOptions`](../interfaces/client._internal_namespace.CheckPrivilegesOptions.md) | + +##### Returns + +`Promise`<[`CheckPrivilegesResponse`](../interfaces/client._internal_namespace.CheckPrivilegesResponse.md)\> + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/check_privileges_dynamically.d.ts:4 + +___ + +### CheckPrivilegesDynamicallyWithRequest + +Ƭ **CheckPrivilegesDynamicallyWithRequest**: (`request`: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)) => [`CheckPrivilegesDynamically`](client._internal_namespace.md#checkprivilegesdynamically) + +#### Type declaration + +▸ (`request`): [`CheckPrivilegesDynamically`](client._internal_namespace.md#checkprivilegesdynamically) + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md) | + +##### Returns + +[`CheckPrivilegesDynamically`](client._internal_namespace.md#checkprivilegesdynamically) + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/check_privileges_dynamically.d.ts:5 + +___ + +### CheckPrivilegesWithRequest + +Ƭ **CheckPrivilegesWithRequest**: (`request`: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)) => [`CheckPrivileges`](../interfaces/client._internal_namespace.CheckPrivileges.md) + +#### Type declaration + +▸ (`request`): [`CheckPrivileges`](../interfaces/client._internal_namespace.CheckPrivileges.md) + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md) | + +##### Returns + +[`CheckPrivileges`](../interfaces/client._internal_namespace.CheckPrivileges.md) + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/types.d.ts:59 + +___ + +### CheckSavedObjectsPrivileges + +Ƭ **CheckSavedObjectsPrivileges**: (`actions`: `string` \| `string`[], `namespaceOrNamespaces?`: `string` \| (`undefined` \| `string`)[]) => `Promise`<[`CheckPrivilegesResponse`](../interfaces/client._internal_namespace.CheckPrivilegesResponse.md)\> + +#### Type declaration + +▸ (`actions`, `namespaceOrNamespaces?`): `Promise`<[`CheckPrivilegesResponse`](../interfaces/client._internal_namespace.CheckPrivilegesResponse.md)\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `actions` | `string` \| `string`[] | +| `namespaceOrNamespaces?` | `string` \| (`undefined` \| `string`)[] | + +##### Returns + +`Promise`<[`CheckPrivilegesResponse`](../interfaces/client._internal_namespace.CheckPrivilegesResponse.md)\> + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/check_saved_objects_privileges.d.ts:5 + +___ + +### CheckSavedObjectsPrivilegesWithRequest + +Ƭ **CheckSavedObjectsPrivilegesWithRequest**: (`request`: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)) => [`CheckSavedObjectsPrivileges`](client._internal_namespace.md#checksavedobjectsprivileges) + +#### Type declaration + +▸ (`request`): [`CheckSavedObjectsPrivileges`](client._internal_namespace.md#checksavedobjectsprivileges) + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md) | + +##### Returns + +[`CheckSavedObjectsPrivileges`](client._internal_namespace.md#checksavedobjectsprivileges) + +#### Defined in + +x-pack/plugins/security/target/types/server/authorization/check_saved_objects_privileges.d.ts:4 + +___ + +### CommonBuilderArguments + +Ƭ **CommonBuilderArguments**: [`CommonArguments`](../interfaces/client._internal_namespace.CommonArguments.md) & { `action`: [`UserAction`](client._internal_namespace.md#useraction) ; `type`: [`UserActionTypes`](client._internal_namespace.md#useractiontypes) ; `value`: `unknown` ; `valueKey`: `string` } + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:97](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L97) + +___ + +### CommonUserActionArgs + +Ƭ **CommonUserActionArgs**: [`ClientArgs`](../interfaces/client._internal_namespace.ClientArgs-1.md) & [`CommonArguments`](../interfaces/client._internal_namespace.CommonArguments.md) + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:75](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L75) + +___ + +### ConnectorTokenClientContract + +Ƭ **ConnectorTokenClientContract**: `PublicMethodsOf`<[`ConnectorTokenClient`](../classes/client._internal_namespace.ConnectorTokenClient.md)\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:22 + +___ + +### CreateUserActionClient + +Ƭ **CreateUserActionClient**<`T`\>: [`CreateUserAction`](../interfaces/client._internal_namespace.CreateUserAction.md)<`T`\> & [`CommonUserActionArgs`](client._internal_namespace.md#commonuseractionargs) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends keyof [`BuilderParameters`](../interfaces/client._internal_namespace.BuilderParameters.md) | + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/index.ts:98](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/index.ts#L98) + +___ + +### DeepPartial + +Ƭ **DeepPartial**<`T`\>: { [P in keyof T]?: T[P] extends infer U[] ? DeepPartial[] : DeepPartial } + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +x-pack/plugins/event_log/target/types/generated/schemas.d.ts:5 + +___ + +### DeepWriteable + +Ƭ **DeepWriteable**<`T`\>: { -readonly [P in keyof T]: DeepWriteable } + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +x-pack/plugins/event_log/target/types/generated/schemas.d.ts:2 + +___ + +### DestructiveRouteMethod + +Ƭ **DestructiveRouteMethod**: ``"post"`` \| ``"put"`` \| ``"delete"`` \| ``"patch"`` + +Set of HTTP methods changing the state of the server. + +#### Defined in + +src/core/target/types/server/http/router/route.d.ts:7 + +___ + +### ElasticsearchClient + +Ƭ **ElasticsearchClient**: `Omit`<`KibanaClient`, ``"connectionPool"`` \| ``"transport"`` \| ``"serializer"`` \| ``"extend"`` \| ``"child"`` \| ``"close"`` \| ``"diagnostic"``\> & { `transport`: { `request`: (`params`: `TransportRequestParams`, `options?`: `TransportRequestOptions`) => `Promise`<`TransportResult`<`TResponse`, `unknown`\>\> } } + +Client used to query the elasticsearch cluster. + +#### Defined in + +src/core/target/types/server/elasticsearch/client/types.d.ts:8 + +___ + +### EmbeddableInput + +Ƭ **EmbeddableInput**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `disableTriggers?` | `boolean` | Whether this embeddable should not execute triggers. | +| `disabledActions?` | `string`[] | List of action IDs that this embeddable should not render. | +| `enhancements?` | `SerializableRecord` | Reserved key for enhancements added by other plugins. | +| `executionContext?` | [`KibanaExecutionContext`](client._internal_namespace.md#kibanaexecutioncontext) | - | +| `hidePanelTitles?` | `boolean` | - | +| `id` | `string` | Note this is not a saved object id. It is used to uniquely identify this Embeddable instance from others (e.g. inside a container). It's possible to have two Embeddables where everything else is the same but the id. | +| `lastReloadRequestTime?` | `number` | - | +| `searchSessionId?` | `string` | Search session id to group searches | +| `syncColors?` | `boolean` | Flag whether colors should be synced with other panels | +| `title?` | `string` | - | +| `viewMode?` | [`ViewMode`](../enums/client._internal_namespace.ViewMode.md) | - | + +#### Defined in + +src/plugins/embeddable/target/types/common/types.d.ts:10 + +___ + +### EmbeddableStateWithType + +Ƭ **EmbeddableStateWithType**: [`EmbeddableInput`](client._internal_namespace.md#embeddableinput) & { `type`: `string` } + +#### Defined in + +src/plugins/embeddable/target/types/common/types.d.ts:53 + +___ + +### EnsureSOAuthCallback + +Ƭ **EnsureSOAuthCallback**: (`entities`: [`OwnerEntity`](../interfaces/client._internal_namespace.OwnerEntity.md)[]) => `void` + +#### Type declaration + +▸ (`entities`): `void` + +Function callback for making sure the found saved objects are of the authorized owner + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `entities` | [`OwnerEntity`](../interfaces/client._internal_namespace.OwnerEntity.md)[] | + +##### Returns + +`void` + +#### Defined in + +[x-pack/plugins/cases/server/authorization/types.ts:110](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L110) + +___ + +### ExecutionEnqueuer + +Ƭ **ExecutionEnqueuer**<`T`\>: (`unsecuredSavedObjectsClient`: [`SavedObjectsClientContract`](client._internal_namespace.md#savedobjectsclientcontract), `options`: [`ExecuteOptions`](../interfaces/client._internal_namespace.ExecuteOptions-1.md)) => `Promise`<`T`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Type declaration + +▸ (`unsecuredSavedObjectsClient`, `options`): `Promise`<`T`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `unsecuredSavedObjectsClient` | [`SavedObjectsClientContract`](client._internal_namespace.md#savedobjectsclientcontract) | +| `options` | [`ExecuteOptions`](../interfaces/client._internal_namespace.ExecuteOptions-1.md) | + +##### Returns + +`Promise`<`T`\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/create_execute_function.d.ts:19 + +___ + +### ExecutorType + +Ƭ **ExecutorType**<`Config`, `Secrets`, `Params`, `ResultData`\>: (`options`: [`ActionTypeExecutorOptions`](../interfaces/client._internal_namespace.ActionTypeExecutorOptions.md)<`Config`, `Secrets`, `Params`\>) => `Promise`<[`ActionTypeExecutorResult`](../interfaces/client._internal_namespace.ActionTypeExecutorResult.md)<`ResultData`\>\> + +#### Type parameters + +| Name | +| :------ | +| `Config` | +| `Secrets` | +| `Params` | +| `ResultData` | + +#### Type declaration + +▸ (`options`): `Promise`<[`ActionTypeExecutorResult`](../interfaces/client._internal_namespace.ActionTypeExecutorResult.md)<`ResultData`\>\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | [`ActionTypeExecutorOptions`](../interfaces/client._internal_namespace.ActionTypeExecutorOptions.md)<`Config`, `Secrets`, `Params`\> | + +##### Returns + +`Promise`<[`ActionTypeExecutorResult`](../interfaces/client._internal_namespace.ActionTypeExecutorResult.md)<`ResultData`\>\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:62 + +___ + +### FailedRunResult + +Ƭ **FailedRunResult**: [`SuccessfulRunResult`](client._internal_namespace.md#successfulrunresult) & { `error`: `Error` } + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:52 + +___ + +### FindCaseOptions + +Ƭ **FindCaseOptions**: [`CasesFindRequest`](client._internal_namespace.md#casesfindrequest) & [`SavedObjectFindOptionsKueryNode`](client._internal_namespace.md#savedobjectfindoptionskuerynode) + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:125](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L125) + +___ + +### GetAllSpacesPurpose + +Ƭ **GetAllSpacesPurpose**: ``"any"`` \| ``"copySavedObjectsIntoSpace"`` \| ``"findSavedObjects"`` \| ``"shareSavedObjectsIntoSpace"`` + +The set of purposes to retrieve spaces: +- `any`: retrieves all spaces the user is authorized to see. +- `copySavedObjectsIntoSpace`: retrieves all spaces the user is authorized to copy saved objects into. +- `findSavedObjects`: retrieves all spaces the user is authorized to search within. +- `shareSavedObjectsIntoSpace`: retrieves all spaces the user is authorized to share saved objects into. + +#### Defined in + +x-pack/plugins/spaces/target/types/common/types.d.ts:74 + +___ + +### GetMigrationFunctionObjectFn + +Ƭ **GetMigrationFunctionObjectFn**: () => [`MigrateFunctionsObject`](client._internal_namespace.md#migratefunctionsobject) + +#### Type declaration + +▸ (): [`MigrateFunctionsObject`](client._internal_namespace.md#migratefunctionsobject) + +##### Returns + +[`MigrateFunctionsObject`](client._internal_namespace.md#migratefunctionsobject) + +#### Defined in + +src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:77 + +___ + +### GetServicesFunction + +Ƭ **GetServicesFunction**: (`request`: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)) => [`Services`](../interfaces/client._internal_namespace.Services.md) + +#### Type declaration + +▸ (`request`): [`Services`](../interfaces/client._internal_namespace.Services.md) + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md) | + +##### Returns + +[`Services`](../interfaces/client._internal_namespace.Services.md) + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:16 + +___ + +### GetSpaceFn + +Ƭ **GetSpaceFn**: (`request`: [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md)) => `Promise`<[`Space`](../interfaces/client._internal_namespace.Space.md) \| `undefined`\> + +#### Type declaration + +▸ (`request`): `Promise`<[`Space`](../interfaces/client._internal_namespace.Space.md) \| `undefined`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `request` | [`KibanaRequest`](../classes/client._internal_namespace.KibanaRequest.md) | + +##### Returns + +`Promise`<[`Space`](../interfaces/client._internal_namespace.Space.md) \| `undefined`\> + +#### Defined in + +[x-pack/plugins/cases/server/authorization/types.ts:21](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/authorization/types.ts#L21) + +___ + +### Headers + +Ƭ **Headers**: { [header in KnownHeaders]?: string \| string[] } & { [header: string]: `string` \| `string`[] \| `undefined`; } + +Http request headers to read. + +#### Defined in + +src/core/target/types/server/http/router/headers.d.ts:36 + +___ + +### IBasePath + +Ƭ **IBasePath**: `Pick`<[`BasePath`](../classes/client._internal_namespace.BasePath.md), keyof [`BasePath`](../classes/client._internal_namespace.BasePath.md)\> + +Access or manipulate the Kibana base path + +[BasePath](../classes/client._internal_namespace.BasePath.md) + +#### Defined in + +src/core/target/types/server/http/base_path_service.d.ts:50 + +___ + +### IEvent + +Ƭ **IEvent**: [`DeepPartial`](client._internal_namespace.md#deeppartial)<[`DeepWriteable`](client._internal_namespace.md#deepwriteable)<[`IValidatedEvent`](client._internal_namespace.md#ivalidatedevent)\>\> + +#### Defined in + +x-pack/plugins/event_log/target/types/generated/schemas.d.ts:10 + +___ + +### IKibanaMigrator + +Ƭ **IKibanaMigrator**: `Pick`<[`KibanaMigrator`](../classes/client._internal_namespace.KibanaMigrator.md), keyof [`KibanaMigrator`](../classes/client._internal_namespace.KibanaMigrator.md)\> + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/kibana_migrator.d.ts:17 + +___ + +### ILicenseState + +Ƭ **ILicenseState**: `PublicMethodsOf`<[`LicenseState`](../classes/client._internal_namespace.LicenseState.md)\> + +#### Defined in + +x-pack/plugins/actions/target/types/server/lib/license_state.d.ts:6 + +___ + +### ISavedObjectTypeRegistry + +Ƭ **ISavedObjectTypeRegistry**: `Omit`<[`SavedObjectTypeRegistry`](../classes/client._internal_namespace.SavedObjectTypeRegistry.md), ``"registerType"``\> + +See [SavedObjectTypeRegistry](../classes/client._internal_namespace.SavedObjectTypeRegistry.md) for documentation. + +#### Defined in + +src/core/target/types/server/saved_objects/saved_objects_type_registry.d.ts:7 + +___ + +### ISavedObjectsRepository + +Ƭ **ISavedObjectsRepository**: `Pick`<[`SavedObjectsRepository`](../classes/client._internal_namespace.SavedObjectsRepository.md), keyof [`SavedObjectsRepository`](../classes/client._internal_namespace.SavedObjectsRepository.md)\> + +See [SavedObjectsRepository](../classes/client._internal_namespace.SavedObjectsRepository.md) + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/repository.d.ts:57 + +___ + +### IValidatedEvent + +Ƭ **IValidatedEvent**: `TypeOf` + +#### Defined in + +x-pack/plugins/event_log/target/types/generated/schemas.d.ts:9 + +___ + +### KibanaExecutionContext + +Ƭ **KibanaExecutionContext**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `description` | `string` | human readable description. For example, a vis title, action name | +| `id` | `string` | unique value to identify the source | +| `name` | `string` | public name of a user-facing feature | +| `parent?` | [`KibanaExecutionContext`](client._internal_namespace.md#kibanaexecutioncontext) | a context that spawned the current context. | +| `type` | `string` | Kibana application initated an operation. | +| `url?` | `string` | in browser - url to navigate to a current page, on server - endpoint path, for task: task SO url | + +#### Defined in + +src/core/target/types/types/execution_context.d.ts:5 + +___ + +### KibanaRequestRouteOptions + +Ƭ **KibanaRequestRouteOptions**<`Method`\>: `Method` extends ``"get"`` \| ``"options"`` ? `Required`<`Omit`<[`RouteConfigOptions`](../interfaces/client._internal_namespace.RouteConfigOptions.md)<`Method`\>, ``"body"``\>\> : `Required`<[`RouteConfigOptions`](../interfaces/client._internal_namespace.RouteConfigOptions.md)<`Method`\>\> + +Route options: If 'GET' or 'OPTIONS' method, body options won't be returned. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Method` | extends [`RouteMethod`](client._internal_namespace.md#routemethod) | + +#### Defined in + +src/core/target/types/server/http/router/request.d.ts:30 + +___ + +### KnownHeaders + +Ƭ **KnownHeaders**: [`KnownKeys`](client._internal_namespace.md#knownkeys)<`IncomingHttpHeaders`\> + +Set of well-known HTTP headers. + +#### Defined in + +src/core/target/types/server/http/router/headers.d.ts:31 + +___ + +### KnownKeys + +Ƭ **KnownKeys**<`T`\>: [`StringKeysAsVals`](client._internal_namespace.md#stringkeysasvals)<`T`\> extends { [\_ in keyof T]: infer U } ? `U` : `never` + +Creates a Union type of all known keys of a given interface. + +**`example`** +```ts +interface Person { + name: string; + age: number; + [attributes: string]: string | number; +} +type PersonKnownKeys = KnownKeys; // "age" | "name" +``` + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +src/core/target/types/server/http/router/headers.d.ts:24 + +___ + +### LicenseCheckState + +Ƭ **LicenseCheckState**: ``"unavailable"`` \| ``"invalid"`` \| ``"valid"`` \| ``"expired"`` + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:1 + +___ + +### LicenseStatus + +Ƭ **LicenseStatus**: ``"active"`` \| ``"invalid"`` \| ``"expired"`` + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:13 + +___ + +### Mapper + +Ƭ **Mapper**<`T`\>: (`params`: `T`) => `Promise`<`T`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Type declaration + +▸ (`params`): `Promise`<`T`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `T` | + +##### Returns + +`Promise`<`T`\> + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/lib/middleware.d.ts:2 + +___ + +### MigrateFunction + +Ƭ **MigrateFunction**<`FromVersion`, `ToVersion`\>: (`state`: `FromVersion`) => `ToVersion` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `FromVersion` | extends `Serializable` = `SerializableRecord` | +| `ToVersion` | extends `Serializable` = `SerializableRecord` | + +#### Type declaration + +▸ (`state`): `ToVersion` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `state` | `FromVersion` | + +##### Returns + +`ToVersion` + +#### Defined in + +src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:86 + +___ + +### MigrateFunctionsObject + +Ƭ **MigrateFunctionsObject**: `Object` + +Collection of migrations that a given type of persistable state object has +accumulated over time. Migration functions are keyed using semver version +of Kibana releases. + +#### Index signature + +▪ [semver: `string`]: [`MigrateFunction`](client._internal_namespace.md#migratefunction)<`any`, `any`\> + +#### Defined in + +src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:83 + +___ + +### MigrationResult + +Ƭ **MigrationResult**: { `status`: ``"skipped"`` } \| { `status`: ``"patched"`` } \| { `destIndex`: `string` ; `elapsedMs`: `number` ; `sourceIndex`: `string` ; `status`: ``"migrated"`` } + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/core/types.d.ts:2 + +___ + +### MigrationStatus + +Ƭ **MigrationStatus**: ``"waiting_to_start"`` \| ``"waiting_for_other_nodes"`` \| ``"running"`` \| ``"completed"`` + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/core/types.d.ts:1 + +___ + +### MutatingOperationRefreshSetting + +Ƭ **MutatingOperationRefreshSetting**: `boolean` \| ``"wait_for"`` + +Elasticsearch Refresh setting for mutating operation + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:132 + +___ + +### PatchCaseArgs + +Ƭ **PatchCaseArgs**: [`PatchCase`](../interfaces/client._internal_namespace.PatchCase.md) & [`ClientArgs`](../interfaces/client._internal_namespace.ClientArgs-1.md) + +#### Defined in + +[x-pack/plugins/cases/server/services/cases/index.ts:103](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/cases/index.ts#L103) + +___ + +### PersistableStateDefinition + +Ƭ **PersistableStateDefinition**<`P`\>: `Partial`<[`PersistableState`](../interfaces/client._internal_namespace.PersistableState.md)<`P`\>\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `P` | extends `SerializableRecord` = `SerializableRecord` | + +#### Defined in + +src/plugins/kibana_utils/target/types/common/persistable_state/types.d.ts:93 + +___ + +### PublicFeatures + +Ƭ **PublicFeatures**: `Record`<`string`, [`LicenseFeature`](../interfaces/client._internal_namespace.LicenseFeature.md)\> + +Provides information about feature availability for the current license. + +#### Defined in + +x-pack/plugins/licensing/target/types/common/types.d.ts:51 + +___ + +### RouteContentType + +Ƭ **RouteContentType**: ``"application/json"`` \| ``"application/*+json"`` \| ``"application/octet-stream"`` \| ``"application/x-www-form-urlencoded"`` \| ``"multipart/form-data"`` \| ``"text/*"`` + +The set of supported parseable Content-Types + +#### Defined in + +src/core/target/types/server/http/router/route.d.ts:27 + +___ + +### RouteMethod + +Ƭ **RouteMethod**: [`SafeRouteMethod`](client._internal_namespace.md#saferoutemethod) \| [`DestructiveRouteMethod`](client._internal_namespace.md#destructiveroutemethod) + +The set of common HTTP methods supported by Kibana routing. + +#### Defined in + +src/core/target/types/server/http/router/route.d.ts:17 + +___ + +### RouteValidationFunction + +Ƭ **RouteValidationFunction**<`T`\>: (`data`: `any`, `validationResult`: [`RouteValidationResultFactory`](../interfaces/client._internal_namespace.RouteValidationResultFactory.md)) => { `error?`: `never` ; `value`: `T` } \| { `error`: [`RouteValidationError`](../classes/client._internal_namespace.RouteValidationError.md) ; `value?`: `never` } + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Type declaration + +▸ (`data`, `validationResult`): { `error?`: `never` ; `value`: `T` } \| { `error`: [`RouteValidationError`](../classes/client._internal_namespace.RouteValidationError.md) ; `value?`: `never` } + +The custom validation function if @kbn/config-schema is not a valid solution for your specific plugin requirements. + +**`example`** + +The validation should look something like: +```typescript +interface MyExpectedBody { + bar: string; + baz: number; +} + +const myBodyValidation: RouteValidationFunction = (data, validationResult) => { + const { ok, badRequest } = validationResult; + const { bar, baz } = data || {}; + if (typeof bar === 'string' && typeof baz === 'number') { + return ok({ bar, baz }); + } else { + return badRequest('Wrong payload', ['body']); + } +} +``` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `any` | +| `validationResult` | [`RouteValidationResultFactory`](../interfaces/client._internal_namespace.RouteValidationResultFactory.md) | + +##### Returns + +{ `error?`: `never` ; `value`: `T` } \| { `error`: [`RouteValidationError`](../classes/client._internal_namespace.RouteValidationError.md) ; `value?`: `never` } + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:43 + +___ + +### RouteValidationSpec + +Ƭ **RouteValidationSpec**<`T`\>: `ObjectType` \| `Type`<`T`\> \| [`RouteValidationFunction`](client._internal_namespace.md#routevalidationfunction)<`T`\> + +Allowed property validation options: either @kbn/config-schema validations or custom validation functions + +See [RouteValidationFunction](client._internal_namespace.md#routevalidationfunction) for custom validation. + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:57 + +___ + +### RouteValidatorFullConfig + +Ƭ **RouteValidatorFullConfig**<`P`, `Q`, `B`\>: [`RouteValidatorConfig`](../interfaces/client._internal_namespace.RouteValidatorConfig.md)<`P`, `Q`, `B`\> & [`RouteValidatorOptions`](../interfaces/client._internal_namespace.RouteValidatorOptions.md) + +Route validations config and options merged into one object + +#### Type parameters + +| Name | +| :------ | +| `P` | +| `Q` | +| `B` | + +#### Defined in + +src/core/target/types/server/http/router/validator/validator.d.ts:101 + +___ + +### RunFunction + +Ƭ **RunFunction**: () => `Promise`<[`RunResult`](client._internal_namespace.md#runresult) \| `undefined` \| `void`\> + +#### Type declaration + +▸ (): `Promise`<[`RunResult`](client._internal_namespace.md#runresult) \| `undefined` \| `void`\> + +##### Returns + +`Promise`<[`RunResult`](client._internal_namespace.md#runresult) \| `undefined` \| `void`\> + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:64 + +___ + +### RunResult + +Ƭ **RunResult**: [`FailedRunResult`](client._internal_namespace.md#failedrunresult) \| [`SuccessfulRunResult`](client._internal_namespace.md#successfulrunresult) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:59 + +___ + +### SafeRouteMethod + +Ƭ **SafeRouteMethod**: ``"get"`` \| ``"options"`` + +Set of HTTP methods not changing the state of the server. + +#### Defined in + +src/core/target/types/server/http/router/route.d.ts:12 + +___ + +### SavedObjectAttribute + +Ƭ **SavedObjectAttribute**: [`SavedObjectAttributeSingle`](client._internal_namespace.md#savedobjectattributesingle) \| [`SavedObjectAttributeSingle`](client._internal_namespace.md#savedobjectattributesingle)[] + +Type definition for a Saved Object attribute value + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:12 + +___ + +### SavedObjectAttributeSingle + +Ƭ **SavedObjectAttributeSingle**: `string` \| `number` \| `boolean` \| ``null`` \| `undefined` \| [`SavedObjectAttributes`](../interfaces/client._internal_namespace.SavedObjectAttributes.md) + +Don't use this type, it's simply a helper type for [SavedObjectAttribute](client._internal_namespace.md#savedobjectattribute) + +#### Defined in + +src/core/target/types/types/saved_objects.d.ts:6 + +___ + +### SavedObjectFindOptions + +Ƭ **SavedObjectFindOptions**: `rt.TypeOf` + +#### Defined in + +[x-pack/plugins/cases/common/api/saved_object.ts:72](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/saved_object.ts#L72) + +___ + +### SavedObjectFindOptionsKueryNode + +Ƭ **SavedObjectFindOptionsKueryNode**: `Omit`<[`SavedObjectFindOptions`](client._internal_namespace.md#savedobjectfindoptions), ``"filter"``\> & { `filter?`: `KueryNode` } + +#### Defined in + +[x-pack/plugins/cases/server/common/types.ts:19](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/common/types.ts#L19) + +___ + +### SavedObjectMigrationFn + +Ƭ **SavedObjectMigrationFn**<`InputAttributes`, `MigratedAttributes`\>: (`doc`: [`SavedObjectUnsanitizedDoc`](client._internal_namespace.md#savedobjectunsanitizeddoc)<`InputAttributes`\>, `context`: [`SavedObjectMigrationContext`](../interfaces/client._internal_namespace.SavedObjectMigrationContext.md)) => [`SavedObjectUnsanitizedDoc`](client._internal_namespace.md#savedobjectunsanitizeddoc)<`MigratedAttributes`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `InputAttributes` | `unknown` | +| `MigratedAttributes` | `unknown` | + +#### Type declaration + +▸ (`doc`, `context`): [`SavedObjectUnsanitizedDoc`](client._internal_namespace.md#savedobjectunsanitizeddoc)<`MigratedAttributes`\> + +A migration function for a [saved object type](../interfaces/client._internal_namespace.SavedObjectsType.md) +used to migrate it to a given version + +**`example`** +```typescript +interface TypeV1Attributes { + someKey: string; + obsoleteProperty: number; +} + +interface TypeV2Attributes { + someKey: string; + newProperty: string; +} + +const migrateToV2: SavedObjectMigrationFn = (doc, { log }) => { + const { obsoleteProperty, ...otherAttributes } = doc.attributes; + // instead of mutating `doc` we make a shallow copy so that we can use separate types for the input + // and output attributes. We don't need to make a deep copy, we just need to ensure that obsolete + // attributes are not present on the returned doc. + return { + ...doc, + attributes: { + ...otherAttributes, + newProperty: migrate(obsoleteProperty), + }, + }; +}; +``` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `doc` | [`SavedObjectUnsanitizedDoc`](client._internal_namespace.md#savedobjectunsanitizeddoc)<`InputAttributes`\> | +| `context` | [`SavedObjectMigrationContext`](../interfaces/client._internal_namespace.SavedObjectMigrationContext.md) | + +##### Returns + +[`SavedObjectUnsanitizedDoc`](client._internal_namespace.md#savedobjectunsanitizeddoc)<`MigratedAttributes`\> + +#### Defined in + +src/core/target/types/server/saved_objects/migrations/types.d.ts:39 + +___ + +### SavedObjectTypeExcludeFromUpgradeFilterHook + +Ƭ **SavedObjectTypeExcludeFromUpgradeFilterHook**: (`toolkit`: { `readonlyEsClient`: `Pick`<[`ElasticsearchClient`](client._internal_namespace.md#elasticsearchclient), ``"search"``\> }) => `estypes.QueryDslQueryContainer` \| `Promise`<`estypes.QueryDslQueryContainer`\> + +#### Type declaration + +▸ (`toolkit`): `estypes.QueryDslQueryContainer` \| `Promise`<`estypes.QueryDslQueryContainer`\> + +If defined, allows a type to run a search query and return a query filter that may match any documents which may +be excluded from the next migration upgrade process. Useful for cleaning up large numbers of old documents which +are no longer needed and may slow the migration process. + +If this hook fails, the migration will proceed without these documents having been filtered out, so this +should not be used as a guarantee that these documents have been deleted. + +**`alpha`** Experimental and subject to change + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `toolkit` | `Object` | +| `toolkit.readonlyEsClient` | `Pick`<[`ElasticsearchClient`](client._internal_namespace.md#elasticsearchclient), ``"search"``\> | + +##### Returns + +`estypes.QueryDslQueryContainer` \| `Promise`<`estypes.QueryDslQueryContainer`\> + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:479 + +___ + +### SavedObjectUnsanitizedDoc + +Ƭ **SavedObjectUnsanitizedDoc**<`T`\>: [`SavedObjectDoc`](../interfaces/client._internal_namespace.SavedObjectDoc.md)<`T`\> & `Partial`<[`Referencable`](../interfaces/client._internal_namespace.Referencable.md)\> + +Describes Saved Object documents from Kibana < 7.0.0 which don't have a +`references` root property defined. This type should only be used in +migrations. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Defined in + +src/core/target/types/server/saved_objects/serialization/types.d.ts:49 + +___ + +### SavedObjectsClientContract + +Ƭ **SavedObjectsClientContract**: `Pick`<[`SavedObjectsClient`](../classes/client._internal_namespace.SavedObjectsClient.md), keyof [`SavedObjectsClient`](../classes/client._internal_namespace.SavedObjectsClient.md)\> + +Saved Objects is Kibana's data persisentence mechanism allowing plugins to +use Elasticsearch for storing plugin state. + +## SavedObjectsClient errors + +Since the SavedObjectsClient has its hands in everything we +are a little paranoid about the way we present errors back to +to application code. Ideally, all errors will be either: + + 1. Caused by bad implementation (ie. undefined is not a function) and + as such unpredictable + 2. An error that has been classified and decorated appropriately + by the decorators in [SavedObjectsErrorHelpers](../classes/client._internal_namespace.SavedObjectsErrorHelpers.md) + +Type 1 errors are inevitable, but since all expected/handle-able errors +should be Type 2 the `isXYZError()` helpers exposed at +`SavedObjectsErrorHelpers` should be used to understand and manage error +responses from the `SavedObjectsClient`. + +Type 2 errors are decorated versions of the source error, so if +the elasticsearch client threw an error it will be decorated based +on its type. That means that rather than looking for `error.body.error.type` or +doing substring checks on `error.body.error.reason`, just use the helpers to +understand the meaning of the error: + + ```js + if (SavedObjectsErrorHelpers.isNotFoundError(error)) { + // handle 404 + } + + if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) { + // 401 handling should be automatic, but in case you wanted to know + } + + // always rethrow the error unless you handle it + throw error; + ``` + +### 404s from missing index + +From the perspective of application code and APIs the SavedObjectsClient is +a black box that persists objects. One of the internal details that users have +no control over is that we use an elasticsearch index for persistence and that +index might be missing. + +At the time of writing we are in the process of transitioning away from the +operating assumption that the SavedObjects index is always available. Part of +this transition is handling errors resulting from an index missing. These used +to trigger a 500 error in most cases, and in others cause 404s with different +error messages. + +From my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The +object the request/call was targeting could not be found. This is why #14141 +takes special care to ensure that 404 errors are generic and don't distinguish +between index missing or document missing. + +See [SavedObjectsClient](../classes/client._internal_namespace.SavedObjectsClient.md) +See [SavedObjectsErrorHelpers](../classes/client._internal_namespace.SavedObjectsErrorHelpers.md) + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:195 + +___ + +### SavedObjectsCreatePointInTimeFinderOptions + +Ƭ **SavedObjectsCreatePointInTimeFinderOptions**: `Omit`<[`SavedObjectsFindOptions`](../interfaces/client._internal_namespace.SavedObjectsFindOptions.md), ``"page"`` \| ``"pit"`` \| ``"searchAfter"``\> + +#### Defined in + +src/core/target/types/server/saved_objects/service/lib/point_in_time_finder.d.ts:7 + +___ + +### SavedObjectsExportTransform + +Ƭ **SavedObjectsExportTransform**<`T`\>: (`context`: [`SavedObjectsExportTransformContext`](../interfaces/client._internal_namespace.SavedObjectsExportTransformContext.md), `objects`: [`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>[]) => [`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)[] \| `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)[]\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Type declaration + +▸ (`context`, `objects`): [`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)[] \| `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)[]\> + +Transformation function used to mutate the exported objects of the associated type. + +A type's export transform function will be executed once per user-initiated export, +for all objects of that type. + +**`example`** +Registering a transform function changing the object's attributes during the export +```ts +// src/plugins/my_plugin/server/plugin.ts +import { myType } from './saved_objects'; + +export class Plugin() { + setup: (core: CoreSetup) => { + core.savedObjects.registerType({ + ...myType, + management: { + ...myType.management, + onExport: (ctx, objects) => { + return objects.map((obj) => ({ + ...obj, + attributes: { + ...obj.attributes, + enabled: false, + } + }) + } + }, + }); + } +} +``` + +**`example`** +Registering a transform function adding additional objects to the export +```ts +// src/plugins/my_plugin/server/plugin.ts +import { myType } from './saved_objects'; + +export class Plugin() { + setup: (core: CoreSetup) => { + const savedObjectStartContractPromise = getStartServices().then( + ([{ savedObjects: savedObjectsStart }]) => savedObjectsStart + ); + + core.savedObjects.registerType({ + ...myType, + management: { + ...myType.management, + onExport: async (ctx, objects) => { + const { getScopedClient } = await savedObjectStartContractPromise; + const client = getScopedClient(ctx.request); + + const depResponse = await client.find({ + type: 'my-nested-object', + hasReference: objs.map(({ id, type }) => ({ id, type })), + }); + + return [...objs, ...depResponse.saved_objects]; + } + }, + }); + } +} +``` + +**`remarks`** Trying to change an object's id or type during the transform will result in + a runtime error during the export process. + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `context` | [`SavedObjectsExportTransformContext`](../interfaces/client._internal_namespace.SavedObjectsExportTransformContext.md) | +| `objects` | [`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>[] | + +##### Returns + +[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)[] \| `Promise`<[`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)[]\> + +#### Defined in + +src/core/target/types/server/saved_objects/export/types.d.ts:160 + +___ + +### SavedObjectsExportablePredicate + +Ƭ **SavedObjectsExportablePredicate**<`Attributes`\>: (`obj`: [`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`Attributes`\>) => `boolean` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Attributes` | `unknown` | + +#### Type declaration + +▸ (`obj`): `boolean` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `obj` | [`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`Attributes`\> | + +##### Returns + +`boolean` + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:467 + +___ + +### SavedObjectsFieldMapping + +Ƭ **SavedObjectsFieldMapping**: `estypes.MappingProperty` & { `dynamic?`: ``false`` \| ``"strict"`` } + +Describe a [saved object type mapping](../interfaces/client._internal_namespace.SavedObjectsTypeMappingDefinition.md) field. + +Please refer to [elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-types.html) +For the mapping documentation + +#### Defined in + +src/core/target/types/server/saved_objects/mappings/types.d.ts:89 + +___ + +### SavedObjectsImportHook + +Ƭ **SavedObjectsImportHook**<`T`\>: (`objects`: [`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>[]) => [`SavedObjectsImportHookResult`](../interfaces/client._internal_namespace.SavedObjectsImportHookResult.md) \| `Promise`<[`SavedObjectsImportHookResult`](../interfaces/client._internal_namespace.SavedObjectsImportHookResult.md)\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Type declaration + +▸ (`objects`): [`SavedObjectsImportHookResult`](../interfaces/client._internal_namespace.SavedObjectsImportHookResult.md) \| `Promise`<[`SavedObjectsImportHookResult`](../interfaces/client._internal_namespace.SavedObjectsImportHookResult.md)\> + +A hook associated with a specific saved object type, that will be invoked during +the import process. The hook will have access to the objects of the registered type. + +Currently, the only supported feature for import hooks is to return warnings to be displayed +in the UI when the import succeeds. + +**`remark`** The only interactions the hook can have with the import process is via the hook's + response. Mutating the objects inside the hook's code will have no effect. + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `objects` | [`SavedObject`](../interfaces/client._internal_namespace.SavedObject.md)<`T`\>[] | + +##### Returns + +[`SavedObjectsImportHookResult`](../interfaces/client._internal_namespace.SavedObjectsImportHookResult.md) \| `Promise`<[`SavedObjectsImportHookResult`](../interfaces/client._internal_namespace.SavedObjectsImportHookResult.md)\> + +#### Defined in + +src/core/target/types/server/saved_objects/import/types.d.ts:227 + +___ + +### SavedObjectsImportWarning + +Ƭ **SavedObjectsImportWarning**: [`SavedObjectsImportSimpleWarning`](../interfaces/client._internal_namespace.SavedObjectsImportSimpleWarning.md) \| [`SavedObjectsImportActionRequiredWarning`](../interfaces/client._internal_namespace.SavedObjectsImportActionRequiredWarning.md) + +Composite type of all the possible types of import warnings. + +See [SavedObjectsImportSimpleWarning](../interfaces/client._internal_namespace.SavedObjectsImportSimpleWarning.md) and [SavedObjectsImportActionRequiredWarning](../interfaces/client._internal_namespace.SavedObjectsImportActionRequiredWarning.md) +for more details. + +#### Defined in + +src/core/target/types/server/saved_objects/import/types.d.ts:203 + +___ + +### SavedObjectsNamespaceType + +Ƭ **SavedObjectsNamespaceType**: ``"single"`` \| ``"multiple"`` \| ``"multiple-isolated"`` \| ``"agnostic"`` + +The namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive: + * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace. + * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces. + * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be + unique across all namespaces. This is intended to be an intermediate step when objects with a "single" namespace type are being + converted to a "multiple" namespace type. In other words, objects with a "multiple-isolated" namespace type will be *share-capable*, + but will not actually be shareable until the namespace type is changed to "multiple". + * agnostic: This type of saved object is global. + +#### Defined in + +src/core/target/types/server/saved_objects/types.d.ts:208 + +___ + +### SavedObjectsValidationSpec + +Ƭ **SavedObjectsValidationSpec**: `ObjectType` + +Allows for validating properties using @kbn/config-schema validations. + +#### Defined in + +src/core/target/types/server/saved_objects/validation/types.d.ts:7 + +___ + +### SpaceIdToNamespaceFunction + +Ƭ **SpaceIdToNamespaceFunction**: (`spaceId?`: `string`) => `string` \| `undefined` + +#### Type declaration + +▸ (`spaceId?`): `string` \| `undefined` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `spaceId?` | `string` | + +##### Returns + +`string` \| `undefined` + +#### Defined in + +x-pack/plugins/actions/target/types/server/types.d.ts:18 + +___ + +### StringKeysAsVals + +Ƭ **StringKeysAsVals**<`T`\>: { [K in keyof T]: string extends K ? never : number extends K ? never : K } + +Converts an object type to a new object type where each string +key is copied to the values of the object, and non string keys are +given a `never` value. This allows us to map over the values and +get the list of all string keys on a type in `KnownKeys` + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +src/core/target/types/server/http/router/headers.d.ts:9 + +___ + +### SubFeaturePrivilegeGroupType + +Ƭ **SubFeaturePrivilegeGroupType**: ``"mutually_exclusive"`` \| ``"independent"`` + +The type of privilege group. +- `mutually_exclusive`:: + Users will be able to select at most one privilege within this group. + Privileges must be specified in descending order of permissiveness (e.g. `All`, `Read`, not `Read`, `All) +- `independent`:: + Users will be able to select any combination of privileges within this group. + +#### Defined in + +x-pack/plugins/features/target/types/common/sub_feature.d.ts:21 + +___ + +### SuccessfulRunResult + +Ƭ **SuccessfulRunResult**: { `state`: `Record`<`string`, `unknown`\> } & { `runAt?`: `Date` ; `schedule?`: `never` } \| { `runAt?`: `never` ; `schedule?`: [`IntervalSchedule`](../interfaces/client._internal_namespace.IntervalSchedule.md) } + +The return value of a task's run function should be a promise of RunResult. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:28 + +___ + +### TaskDefinitionRegistry + +Ƭ **TaskDefinitionRegistry**: `Record`<`string`, [`TaskRegisterDefinition`](../interfaces/client._internal_namespace.TaskRegisterDefinition.md)\> + +A mapping of task type id to the task definition. + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task_type_dictionary.d.ts:52 + +___ + +### TaskRunCreatorFunction + +Ƭ **TaskRunCreatorFunction**: (`context`: [`RunContext`](../interfaces/client._internal_namespace.RunContext.md)) => [`CancellableTask`](../interfaces/client._internal_namespace.CancellableTask.md) + +#### Type declaration + +▸ (`context`): [`CancellableTask`](../interfaces/client._internal_namespace.CancellableTask.md) + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `context` | [`RunContext`](../interfaces/client._internal_namespace.RunContext.md) | + +##### Returns + +[`CancellableTask`](../interfaces/client._internal_namespace.CancellableTask.md) + +#### Defined in + +x-pack/plugins/task_manager/target/types/server/task.d.ts:70 + +___ + +### UpdateAttachmentArgs + +Ƭ **UpdateAttachmentArgs**: [`UpdateArgs`](../interfaces/client._internal_namespace.UpdateArgs.md) & [`ClientArgs`](../interfaces/client._internal_namespace.ClientArgs-1.md) + +#### Defined in + +[x-pack/plugins/cases/server/services/attachments/index.ts:59](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/attachments/index.ts#L59) + +___ + +### UserAction + +Ƭ **UserAction**: `rt.TypeOf` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/user_actions/index.ts:85](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/user_actions/index.ts#L85) + +___ + +### UserActionParameters + +Ƭ **UserActionParameters**<`T`\>: [`BuilderParameters`](../interfaces/client._internal_namespace.BuilderParameters.md)[`T`][``"parameters"``] & [`CommonArguments`](../interfaces/client._internal_namespace.CommonArguments.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends keyof [`BuilderParameters`](../interfaces/client._internal_namespace.BuilderParameters.md) | + +#### Defined in + +[x-pack/plugins/cases/server/services/user_actions/types.ts:71](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/services/user_actions/types.ts#L71) + +___ + +### UserActionTypes + +Ƭ **UserActionTypes**: `rt.TypeOf` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/user_actions/index.ts:86](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/user_actions/index.ts#L86) + +## Variables + +### ActionTypesRt + +• **ActionTypesRt**: `KeyofC`<{ `comment`: ``"comment"`` = 'comment'; `connector`: ``"connector"`` = 'connector'; `create_case`: ``"create_case"`` = 'create\_case'; `delete_case`: ``"delete_case"`` = 'delete\_case'; `description`: ``"description"`` = 'description'; `pushed`: ``"pushed"`` = 'pushed'; `settings`: ``"settings"`` = 'settings'; `status`: ``"status"`` = 'status'; `tags`: ``"tags"`` = 'tags'; `title`: ``"title"`` = 'title' }\> + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/user_actions/common.ts:35](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/user_actions/common.ts#L35) + +___ + +### ActionsRt + +• **ActionsRt**: `KeyofC`<{ `add`: ``"add"`` = 'add'; `create`: ``"create"`` = 'create'; `delete`: ``"delete"`` = 'delete'; `push_to_service`: ``"push_to_service"`` = 'push\_to\_service'; `update`: ``"update"`` = 'update' }\> + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/user_actions/common.ts:36](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/user_actions/common.ts#L36) + +___ + +### CasesFindRequestRt + +• **CasesFindRequestRt**: `PartialC`<{ `defaultSearchOperator`: `UnionC`<[`LiteralC`<``"AND"``\>, `LiteralC`<``"OR"``\>]\> ; `fields`: `ArrayC`<`StringC`\> ; `owner`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `page`: `Type`<`number`, `string`, `unknown`\> = NumberFromString; `perPage`: `Type`<`number`, `string`, `unknown`\> = NumberFromString; `reporters`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `search`: `StringC` = rt.string; `searchFields`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `sortField`: `StringC` = rt.string; `sortOrder`: `UnionC`<[`LiteralC`<``"desc"``\>, `LiteralC`<``"asc"``\>]\> ; `status`: `UnionC`<[`LiteralC`<[`open`](../enums/client._internal_namespace.CaseStatuses.md#open)\>, `LiteralC`<`any`[`any`]\>, `LiteralC`<[`closed`](../enums/client._internal_namespace.CaseStatuses.md#closed)\>]\> = CaseStatusRt; `tags`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> }\> + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/case.ts:136](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L136) + +___ + +### EventSchema + +• **EventSchema**: `Type` + +#### Defined in + +x-pack/plugins/event_log/target/types/generated/schemas.d.ts:11 + +___ + +### SavedObjectFindOptionsRt + +• **SavedObjectFindOptionsRt**: `PartialC`<{ `defaultSearchOperator`: `UnionC`<[`LiteralC`<``"AND"``\>, `LiteralC`<``"OR"``\>]\> ; `fields`: `ArrayC`<`StringC`\> ; `filter`: `StringC` = rt.string; `hasReference`: `UnionC`<[`ArrayC`<`TypeC`<{ `id`: `StringC` = rt.string; `type`: `StringC` = rt.string }\>\>, `TypeC`<{ `id`: `StringC` = rt.string; `type`: `StringC` = rt.string }\>]\> ; `hasReferenceOperator`: `UnionC`<[`LiteralC`<``"AND"``\>, `LiteralC`<``"OR"``\>]\> ; `page`: `Type`<`number`, `string`, `unknown`\> = NumberFromString; `perPage`: `Type`<`number`, `string`, `unknown`\> = NumberFromString; `search`: `StringC` = rt.string; `searchFields`: `ArrayC`<`StringC`\> ; `sortField`: `StringC` = rt.string; `sortOrder`: `UnionC`<[`LiteralC`<``"desc"``\>, `LiteralC`<``"asc"``\>]\> }\> + +#### Defined in + +[x-pack/plugins/cases/common/api/saved_object.ts:25](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/saved_object.ts#L25) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/client.md b/x-pack/plugins/cases/docs/cases_client/modules/client.md index 7fb6b64253dd9..b03a7ba7673bb 100644 --- a/x-pack/plugins/cases/docs/cases_client/modules/client.md +++ b/x-pack/plugins/cases/docs/cases_client/modules/client.md @@ -1,9 +1,13 @@ -[Cases Client API Interface](../cases_client_api.md) / client +[Cases Client API Interface](../README.md) / client # Module: client ## Table of contents +### Namespaces + +- [\_internal\_namespace](client._internal_namespace.md) + ### Classes -- [CasesClient](../classes/client.casesclient.md) +- [CasesClient](../classes/client.CasesClient.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/configure_client._internal_namespace.md b/x-pack/plugins/cases/docs/cases_client/modules/configure_client._internal_namespace.md new file mode 100644 index 0000000000000..cb22acb5a298c --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/modules/configure_client._internal_namespace.md @@ -0,0 +1,13 @@ +[Cases Client API Interface](../README.md) / [configure/client](configure_client.md) / \_internal\_namespace + +# Namespace: \_internal\_namespace + +[configure/client](configure_client.md)._internal_namespace + +## Table of contents + +### Interfaces + +- [CreateMappingsArgs](../interfaces/configure_client._internal_namespace.CreateMappingsArgs.md) +- [MappingsArgs](../interfaces/configure_client._internal_namespace.MappingsArgs.md) +- [UpdateMappingsArgs](../interfaces/configure_client._internal_namespace.UpdateMappingsArgs.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/configure_client.md b/x-pack/plugins/cases/docs/cases_client/modules/configure_client.md index 7cfc43e3d0a88..690afd51a4f65 100644 --- a/x-pack/plugins/cases/docs/cases_client/modules/configure_client.md +++ b/x-pack/plugins/cases/docs/cases_client/modules/configure_client.md @@ -1,9 +1,37 @@ -[Cases Client API Interface](../cases_client_api.md) / configure/client +[Cases Client API Interface](../README.md) / configure/client # Module: configure/client ## Table of contents +### Namespaces + +- [\_internal\_namespace](configure_client._internal_namespace.md) + ### Interfaces -- [ConfigureSubClient](../interfaces/configure_client.configuresubclient.md) +- [ConfigureSubClient](../interfaces/configure_client.ConfigureSubClient.md) + +### Functions + +- [getConnectors](configure_client.md#getconnectors) + +## Functions + +### getConnectors + +▸ **getConnectors**(`__namedParameters`): `Promise`<[`FindActionResult`](../interfaces/client._internal_namespace.FindActionResult.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | [`CasesClientArgs`](../interfaces/client._internal_namespace.CasesClientArgs.md) | + +#### Returns + +`Promise`<[`FindActionResult`](../interfaces/client._internal_namespace.FindActionResult.md)[]\> + +#### Defined in + +[x-pack/plugins/cases/server/client/configure/client.ts:206](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/server/client/configure/client.ts#L206) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/metrics_client._internal_namespace.md b/x-pack/plugins/cases/docs/cases_client/modules/metrics_client._internal_namespace.md new file mode 100644 index 0000000000000..318b517747494 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/modules/metrics_client._internal_namespace.md @@ -0,0 +1,11 @@ +[Cases Client API Interface](../README.md) / [metrics/client](metrics_client.md) / \_internal\_namespace + +# Namespace: \_internal\_namespace + +[metrics/client](metrics_client.md)._internal_namespace + +## Table of contents + +### Interfaces + +- [CaseMetricsParams](../interfaces/metrics_client._internal_namespace.CaseMetricsParams.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/metrics_client.md b/x-pack/plugins/cases/docs/cases_client/modules/metrics_client.md new file mode 100644 index 0000000000000..c4c7354ba5afe --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/modules/metrics_client.md @@ -0,0 +1,13 @@ +[Cases Client API Interface](../README.md) / metrics/client + +# Module: metrics/client + +## Table of contents + +### Namespaces + +- [\_internal\_namespace](metrics_client._internal_namespace.md) + +### Interfaces + +- [MetricsSubClient](../interfaces/metrics_client.MetricsSubClient.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/stats_client.md b/x-pack/plugins/cases/docs/cases_client/modules/stats_client.md index 992a1a1ab501a..f0632f6ca0069 100644 --- a/x-pack/plugins/cases/docs/cases_client/modules/stats_client.md +++ b/x-pack/plugins/cases/docs/cases_client/modules/stats_client.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / stats/client +[Cases Client API Interface](../README.md) / stats/client # Module: stats/client @@ -6,4 +6,4 @@ ### Interfaces -- [StatsSubClient](../interfaces/stats_client.statssubclient.md) +- [StatsSubClient](../interfaces/stats_client.StatsSubClient.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/sub_cases_client.md b/x-pack/plugins/cases/docs/cases_client/modules/sub_cases_client.md deleted file mode 100644 index 6bdf073566b1c..0000000000000 --- a/x-pack/plugins/cases/docs/cases_client/modules/sub_cases_client.md +++ /dev/null @@ -1,9 +0,0 @@ -[Cases Client API Interface](../cases_client_api.md) / sub_cases/client - -# Module: sub\_cases/client - -## Table of contents - -### Interfaces - -- [SubCasesClient](../interfaces/sub_cases_client.subcasesclient.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/typedoc_interfaces._internal_namespace.md b/x-pack/plugins/cases/docs/cases_client/modules/typedoc_interfaces._internal_namespace.md new file mode 100644 index 0000000000000..38b2fc2ea5150 --- /dev/null +++ b/x-pack/plugins/cases/docs/cases_client/modules/typedoc_interfaces._internal_namespace.md @@ -0,0 +1,277 @@ +[Cases Client API Interface](../README.md) / [typedoc\_interfaces](typedoc_interfaces.md) / \_internal\_namespace + +# Namespace: \_internal\_namespace + +[typedoc_interfaces](typedoc_interfaces.md)._internal_namespace + +## Table of contents + +### Type aliases + +- [AllCommentsResponse](typedoc_interfaces._internal_namespace.md#allcommentsresponse) +- [CasePostRequest](typedoc_interfaces._internal_namespace.md#casepostrequest) +- [CaseResolveResponse](typedoc_interfaces._internal_namespace.md#caseresolveresponse) +- [CaseResponse](typedoc_interfaces._internal_namespace.md#caseresponse) +- [CaseUserActionsResponse](typedoc_interfaces._internal_namespace.md#caseuseractionsresponse) +- [CasesConfigurePatch](typedoc_interfaces._internal_namespace.md#casesconfigurepatch) +- [CasesConfigureRequest](typedoc_interfaces._internal_namespace.md#casesconfigurerequest) +- [CasesConfigureResponse](typedoc_interfaces._internal_namespace.md#casesconfigureresponse) +- [CasesFindResponse](typedoc_interfaces._internal_namespace.md#casesfindresponse) +- [CasesPatchRequest](typedoc_interfaces._internal_namespace.md#casespatchrequest) +- [CasesResponse](typedoc_interfaces._internal_namespace.md#casesresponse) +- [CommentsResponse](typedoc_interfaces._internal_namespace.md#commentsresponse) + +### Variables + +- [AllCommentsResponseRt](typedoc_interfaces._internal_namespace.md#allcommentsresponsert) +- [CaseConfigureResponseRt](typedoc_interfaces._internal_namespace.md#caseconfigureresponsert) +- [CasePostRequestRt](typedoc_interfaces._internal_namespace.md#casepostrequestrt) +- [CaseResolveResponseRt](typedoc_interfaces._internal_namespace.md#caseresolveresponsert) +- [CaseResponseRt](typedoc_interfaces._internal_namespace.md#caseresponsert) +- [CaseUserActionsResponseRt](typedoc_interfaces._internal_namespace.md#caseuseractionsresponsert) +- [CasesConfigurePatchRt](typedoc_interfaces._internal_namespace.md#casesconfigurepatchrt) +- [CasesConfigureRequestRt](typedoc_interfaces._internal_namespace.md#casesconfigurerequestrt) +- [CasesFindResponseRt](typedoc_interfaces._internal_namespace.md#casesfindresponsert) +- [CasesPatchRequestRt](typedoc_interfaces._internal_namespace.md#casespatchrequestrt) +- [CasesResponseRt](typedoc_interfaces._internal_namespace.md#casesresponsert) +- [CommentsResponseRt](typedoc_interfaces._internal_namespace.md#commentsresponsert) + +## Type aliases + +### AllCommentsResponse + +Ƭ **AllCommentsResponse**: `rt.TypeOf` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/comment.ts:166](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/comment.ts#L166) + +___ + +### CasePostRequest + +Ƭ **CasePostRequest**: `rt.TypeOf` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/case.ts:280](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L280) + +___ + +### CaseResolveResponse + +Ƭ **CaseResolveResponse**: `rt.TypeOf` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/case.ts:282](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L282) + +___ + +### CaseResponse + +Ƭ **CaseResponse**: `rt.TypeOf` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/case.ts:281](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L281) + +___ + +### CaseUserActionsResponse + +Ƭ **CaseUserActionsResponse**: `rt.TypeOf` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/user_actions/index.ts:82](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/user_actions/index.ts#L82) + +___ + +### CasesConfigurePatch + +Ƭ **CasesConfigurePatch**: `rt.TypeOf` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/configure.ts:81](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/configure.ts#L81) + +___ + +### CasesConfigureRequest + +Ƭ **CasesConfigureRequest**: `rt.TypeOf` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/configure.ts:80](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/configure.ts#L80) + +___ + +### CasesConfigureResponse + +Ƭ **CasesConfigureResponse**: `rt.TypeOf` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/configure.ts:83](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/configure.ts#L83) + +___ + +### CasesFindResponse + +Ƭ **CasesFindResponse**: `rt.TypeOf` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/case.ts:286](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L286) + +___ + +### CasesPatchRequest + +Ƭ **CasesPatchRequest**: `rt.TypeOf` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/case.ts:288](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L288) + +___ + +### CasesResponse + +Ƭ **CasesResponse**: `rt.TypeOf` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/case.ts:283](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L283) + +___ + +### CommentsResponse + +Ƭ **CommentsResponse**: `rt.TypeOf` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/comment.ts:167](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/comment.ts#L167) + +## Variables + +### AllCommentsResponseRt + +• **AllCommentsResponseRt**: `ArrayC`<`IntersectionC`<[`UnionC`<[`IntersectionC`<[`TypeC`<{ `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`user`](client._internal_namespace.md#user)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `alertId`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `index`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `owner`: `StringC` = rt.string; `rule`: `TypeC`<{ `id`: `UnionC`<[`StringC`, `NullC`]\> ; `name`: `UnionC`<[`StringC`, `NullC`]\> }\> ; `type`: `LiteralC`<[`alert`](client._internal_namespace.md#alert)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `actions`: `TypeC`<{ `targets`: `ArrayC`<`TypeC`<{ `endpointId`: `StringC` = rt.string; `hostname`: `StringC` = rt.string }\>\> ; `type`: `StringC` = rt.string }\> ; `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`actions`](client._internal_namespace.md#actions)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `version`: `StringC` = rt.string }\>]\>\> + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/comment.ts:150](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/comment.ts#L150) + +___ + +### CaseConfigureResponseRt + +• **CaseConfigureResponseRt**: `IntersectionC`<[`IntersectionC`<[`IntersectionC`<[`TypeC`<{ `closure_type`: `UnionC`<[`LiteralC`<``"close-by-user"``\>, `LiteralC`<``"close-by-pushing"``\>]\> = ClosureTypeRT; `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt }\>, `TypeC`<{ `owner`: `StringC` = rt.string }\>]\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `TypeC`<{ `mappings`: `ArrayC`<`TypeC`<{ `action_type`: `UnionC`<[`LiteralC`<``"append"``\>, `LiteralC`<``"nothing"``\>, `LiteralC`<``"overwrite"``\>]\> = ActionTypeRT; `source`: `UnionC`<[`LiteralC`<``"title"``\>, `LiteralC`<``"description"``\>, `LiteralC`<``"comments"``\>]\> = CaseFieldRT; `target`: `UnionC`<[`StringC`, `LiteralC`<``"not_mapped"``\>]\> = ThirdPartyFieldRT }\>\> ; `owner`: `StringC` = rt.string }\>, `TypeC`<{ `error`: `UnionC`<[`StringC`, `NullC`]\> ; `id`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `version`: `StringC` = rt.string }\>]\> + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/configure.ts:53](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/configure.ts#L53) + +___ + +### CasePostRequestRt + +• **CasePostRequestRt**: `TypeC`<{ `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt; `description`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `settings`: `TypeC`<{ `syncAlerts`: `BooleanC` = rt.boolean }\> = SettingsRt; `tags`: `ArrayC`<`StringC`\> ; `title`: `StringC` = rt.string }\> + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/case.ts:108](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L108) + +___ + +### CaseResolveResponseRt + +• **CaseResolveResponseRt**: `IntersectionC`<[`TypeC`<{ `case`: `IntersectionC`<[`IntersectionC`<[`TypeC`<{ `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt; `description`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `settings`: `TypeC`<{ `syncAlerts`: `BooleanC` = rt.boolean }\> = SettingsRt; `status`: `UnionC`<[`LiteralC`<[`open`](../enums/client._internal_namespace.CaseStatuses.md#open)\>, `LiteralC`<`any`[`any`]\>, `LiteralC`<[`closed`](../enums/client._internal_namespace.CaseStatuses.md#closed)\>]\> = CaseStatusRt; `tags`: `ArrayC`<`StringC`\> ; `title`: `StringC` = rt.string }\>, `TypeC`<{ `closed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `closed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `external_service`: `UnionC`<[`IntersectionC`<[`TypeC`<{ `connector_id`: `StringC` = rt.string }\>, `TypeC`<{ `connector_name`: `StringC` = rt.string; `external_id`: `StringC` = rt.string; `external_title`: `StringC` = rt.string; `external_url`: `StringC` = rt.string; `pushed_at`: `StringC` = rt.string; `pushed_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT }\>]\>, `NullC`]\> = CaseFullExternalServiceRt; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `totalAlerts`: `NumberC` = rt.number; `totalComment`: `NumberC` = rt.number; `version`: `StringC` = rt.string }\>, `PartialC`<{ `comments`: `ArrayC`<`IntersectionC`<[`UnionC`<[`IntersectionC`<[`TypeC`<{ `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`user`](client._internal_namespace.md#user)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `alertId`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `index`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `owner`: `StringC` = rt.string; `rule`: `TypeC`<{ `id`: `UnionC`<[`StringC`, `NullC`]\> ; `name`: `UnionC`<[`StringC`, `NullC`]\> }\> ; `type`: `LiteralC`<[`alert`](client._internal_namespace.md#alert)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `actions`: `TypeC`<{ `targets`: `ArrayC`<`TypeC`<{ `endpointId`: `StringC` = rt.string; `hostname`: `StringC` = rt.string }\>\> ; `type`: `StringC` = rt.string }\> ; `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`actions`](client._internal_namespace.md#actions)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `version`: `StringC` = rt.string }\>]\>\> }\>]\> = CaseResponseRt; `outcome`: `UnionC`<[`LiteralC`<``"exactMatch"``\>, `LiteralC`<``"aliasMatch"``\>, `LiteralC`<``"conflict"``\>]\> }\>, `PartialC`<{ `alias_target_id`: `StringC` = rt.string }\>]\> + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/case.ts:212](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L212) + +___ + +### CaseResponseRt + +• **CaseResponseRt**: `IntersectionC`<[`IntersectionC`<[`TypeC`<{ `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt; `description`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `settings`: `TypeC`<{ `syncAlerts`: `BooleanC` = rt.boolean }\> = SettingsRt; `status`: `UnionC`<[`LiteralC`<[`open`](../enums/client._internal_namespace.CaseStatuses.md#open)\>, `LiteralC`<`any`[`any`]\>, `LiteralC`<[`closed`](../enums/client._internal_namespace.CaseStatuses.md#closed)\>]\> = CaseStatusRt; `tags`: `ArrayC`<`StringC`\> ; `title`: `StringC` = rt.string }\>, `TypeC`<{ `closed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `closed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `external_service`: `UnionC`<[`IntersectionC`<[`TypeC`<{ `connector_id`: `StringC` = rt.string }\>, `TypeC`<{ `connector_name`: `StringC` = rt.string; `external_id`: `StringC` = rt.string; `external_title`: `StringC` = rt.string; `external_url`: `StringC` = rt.string; `pushed_at`: `StringC` = rt.string; `pushed_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT }\>]\>, `NullC`]\> = CaseFullExternalServiceRt; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `totalAlerts`: `NumberC` = rt.number; `totalComment`: `NumberC` = rt.number; `version`: `StringC` = rt.string }\>, `PartialC`<{ `comments`: `ArrayC`<`IntersectionC`<[`UnionC`<[`IntersectionC`<[`TypeC`<{ `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`user`](client._internal_namespace.md#user)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `alertId`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `index`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `owner`: `StringC` = rt.string; `rule`: `TypeC`<{ `id`: `UnionC`<[`StringC`, `NullC`]\> ; `name`: `UnionC`<[`StringC`, `NullC`]\> }\> ; `type`: `LiteralC`<[`alert`](client._internal_namespace.md#alert)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `actions`: `TypeC`<{ `targets`: `ArrayC`<`TypeC`<{ `endpointId`: `StringC` = rt.string; `hostname`: `StringC` = rt.string }\>\> ; `type`: `StringC` = rt.string }\> ; `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`actions`](client._internal_namespace.md#actions)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `version`: `StringC` = rt.string }\>]\>\> }\>]\> + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/case.ts:199](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L199) + +___ + +### CaseUserActionsResponseRt + +• **CaseUserActionsResponseRt**: `ArrayC`<`IntersectionC`<[`IntersectionC`<[`UnionC`<[`UnionC`<[`TypeC`<{ `payload`: `TypeC`<{ `description`: `StringC` = rt.string }\> = DescriptionUserActionPayloadRt; `type`: `LiteralC`<``"description"``\> }\>, `TypeC`<{ `payload`: `TypeC`<{ `comment`: `UnionC`<[`TypeC`<{ `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`user`](client._internal_namespace.md#user)\> }\>, `TypeC`<{ `alertId`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `index`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `owner`: `StringC` = rt.string; `rule`: `TypeC`<{ `id`: `UnionC`<[`StringC`, `NullC`]\> ; `name`: `UnionC`<[`StringC`, `NullC`]\> }\> ; `type`: `LiteralC`<[`alert`](client._internal_namespace.md#alert)\> }\>, `TypeC`<{ `actions`: `TypeC`<{ `targets`: `ArrayC`<`TypeC`<{ `endpointId`: `StringC` = rt.string; `hostname`: `StringC` = rt.string }\>\> ; `type`: `StringC` = rt.string }\> ; `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`actions`](client._internal_namespace.md#actions)\> }\>]\> = CommentRequestRt }\> = CommentUserActionPayloadRt; `type`: `LiteralC`<``"comment"``\> }\>, `TypeC`<{ `payload`: `TypeC`<{ `tags`: `ArrayC`<`StringC`\> }\> = TagsUserActionPayloadRt; `type`: `LiteralC`<``"tags"``\> }\>, `TypeC`<{ `payload`: `TypeC`<{ `title`: `StringC` = rt.string }\> = TitleUserActionPayloadRt; `type`: `LiteralC`<``"title"``\> }\>, `TypeC`<{ `payload`: `TypeC`<{ `settings`: `TypeC`<{ `syncAlerts`: `BooleanC` = rt.boolean }\> = SettingsRt }\> = SettingsUserActionPayloadRt; `type`: `LiteralC`<``"settings"``\> }\>, `TypeC`<{ `payload`: `TypeC`<{ `status`: `UnionC`<[`LiteralC`<[`open`](../enums/client._internal_namespace.CaseStatuses.md#open)\>, `LiteralC`<`any`[`any`]\>, `LiteralC`<[`closed`](../enums/client._internal_namespace.CaseStatuses.md#closed)\>]\> = CaseStatusRt }\> = StatusUserActionPayloadRt; `type`: `LiteralC`<``"status"``\> }\>]\>, `IntersectionC`<[`TypeC`<{ `type`: `LiteralC`<``"create_case"``\> }\>, `TypeC`<{ `payload`: `IntersectionC`<[`TypeC`<{ `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt }\>, `TypeC`<{ `description`: `StringC` = DescriptionUserActionPayloadRt.props.description; `owner`: `StringC` = rt.string; `settings`: `TypeC`<{ `syncAlerts`: `BooleanC` = rt.boolean }\> = SettingsUserActionPayloadRt.props.settings; `status`: `StringC` = rt.string; `tags`: `ArrayC`<`StringC`\> = TagsUserActionPayloadRt.props.tags; `title`: `StringC` = TitleUserActionPayloadRt.props.title }\>]\> }\>]\>, `TypeC`<{ `payload`: `TypeC`<{ `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt }\> = ConnectorUserActionPayloadRt; `type`: `LiteralC`<``"connector"``\> }\>, `TypeC`<{ `payload`: `TypeC`<{ `externalService`: `IntersectionC`<[`TypeC`<{ `connector_id`: `StringC` = rt.string }\>, `TypeC`<{ `connector_name`: `StringC` = rt.string; `external_id`: `StringC` = rt.string; `external_title`: `StringC` = rt.string; `external_url`: `StringC` = rt.string; `pushed_at`: `StringC` = rt.string; `pushed_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT }\>]\> = CaseExternalServiceBasicRt }\> = PushedUserActionPayloadRt; `type`: `LiteralC`<``"pushed"``\> }\>, `TypeC`<{ `payload`: `TypeC`<{}\> ; `type`: `LiteralC`<``"delete_case"``\> }\>]\>, `TypeC`<{ `action`: `KeyofC`<{ `add`: ``"add"`` = 'add'; `create`: ``"create"`` = 'create'; `delete`: ``"delete"`` = 'delete'; `push_to_service`: ``"push_to_service"`` = 'push\_to\_service'; `update`: ``"update"`` = 'update' }\> = ActionsRt; `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string }\>]\>, `TypeC`<{ `action_id`: `StringC` = rt.string; `case_id`: `StringC` = rt.string; `comment_id`: `UnionC`<[`StringC`, `NullC`]\> }\>]\>\> + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/user_actions/index.ts:76](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/user_actions/index.ts#L76) + +___ + +### CasesConfigurePatchRt + +• **CasesConfigurePatchRt**: `IntersectionC`<[`PartialC`<{ `closure_type`: `UnionC`<[`LiteralC`<``"close-by-user"``\>, `LiteralC`<``"close-by-pushing"``\>]\> = ClosureTypeRT; `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt }\>, `TypeC`<{ `version`: `StringC` = rt.string }\>]\> + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/configure.ts:38](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/configure.ts#L38) + +___ + +### CasesConfigureRequestRt + +• **CasesConfigureRequestRt**: `IntersectionC`<[`TypeC`<{ `closure_type`: `UnionC`<[`LiteralC`<``"close-by-user"``\>, `LiteralC`<``"close-by-pushing"``\>]\> = ClosureTypeRT; `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt }\>, `TypeC`<{ `owner`: `StringC` = rt.string }\>]\> = `CasesConfigureBasicRt` + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/configure.ts:37](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/configure.ts#L37) + +___ + +### CasesFindResponseRt + +• **CasesFindResponseRt**: `IntersectionC`<[`TypeC`<{ `cases`: `ArrayC`<`IntersectionC`<[`IntersectionC`<[`TypeC`<{ `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt; `description`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `settings`: `TypeC`<{ `syncAlerts`: `BooleanC` = rt.boolean }\> = SettingsRt; `status`: `UnionC`<[`LiteralC`<[`open`](../enums/client._internal_namespace.CaseStatuses.md#open)\>, `LiteralC`<`any`[`any`]\>, `LiteralC`<[`closed`](../enums/client._internal_namespace.CaseStatuses.md#closed)\>]\> = CaseStatusRt; `tags`: `ArrayC`<`StringC`\> ; `title`: `StringC` = rt.string }\>, `TypeC`<{ `closed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `closed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `external_service`: `UnionC`<[`IntersectionC`<[`TypeC`<{ `connector_id`: `StringC` = rt.string }\>, `TypeC`<{ `connector_name`: `StringC` = rt.string; `external_id`: `StringC` = rt.string; `external_title`: `StringC` = rt.string; `external_url`: `StringC` = rt.string; `pushed_at`: `StringC` = rt.string; `pushed_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT }\>]\>, `NullC`]\> = CaseFullExternalServiceRt; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `totalAlerts`: `NumberC` = rt.number; `totalComment`: `NumberC` = rt.number; `version`: `StringC` = rt.string }\>, `PartialC`<{ `comments`: `ArrayC`<`IntersectionC`<[`UnionC`<[`IntersectionC`<[`TypeC`<{ `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`user`](client._internal_namespace.md#user)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `alertId`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `index`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `owner`: `StringC` = rt.string; `rule`: `TypeC`<{ `id`: `UnionC`<[`StringC`, `NullC`]\> ; `name`: `UnionC`<[`StringC`, `NullC`]\> }\> ; `type`: `LiteralC`<[`alert`](client._internal_namespace.md#alert)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `actions`: `TypeC`<{ `targets`: `ArrayC`<`TypeC`<{ `endpointId`: `StringC` = rt.string; `hostname`: `StringC` = rt.string }\>\> ; `type`: `StringC` = rt.string }\> ; `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`actions`](client._internal_namespace.md#actions)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `version`: `StringC` = rt.string }\>]\>\> }\>]\>\> ; `page`: `NumberC` = rt.number; `per_page`: `NumberC` = rt.number; `total`: `NumberC` = rt.number }\>, `TypeC`<{ `count_closed_cases`: `NumberC` = rt.number; `count_in_progress_cases`: `NumberC` = rt.number; `count_open_cases`: `NumberC` = rt.number }\>]\> + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/case.ts:222](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L222) + +___ + +### CasesPatchRequestRt + +• **CasesPatchRequestRt**: `TypeC`<{ `cases`: `ArrayC`<`IntersectionC`<[`PartialC`<{ `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt; `description`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `settings`: `TypeC`<{ `syncAlerts`: `BooleanC` = rt.boolean }\> = SettingsRt; `status`: `UnionC`<[`LiteralC`<[`open`](../enums/client._internal_namespace.CaseStatuses.md#open)\>, `LiteralC`<`any`[`any`]\>, `LiteralC`<[`closed`](../enums/client._internal_namespace.CaseStatuses.md#closed)\>]\> = CaseStatusRt; `tags`: `ArrayC`<`StringC`\> ; `title`: `StringC` = rt.string }\>, `TypeC`<{ `id`: `StringC` = rt.string; `version`: `StringC` = rt.string }\>]\>\> }\> + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/case.ts:240](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L240) + +___ + +### CasesResponseRt + +• **CasesResponseRt**: `ArrayC`<`IntersectionC`<[`IntersectionC`<[`TypeC`<{ `connector`: `IntersectionC`<[`TypeC`<{ `id`: `StringC` = rt.string }\>, `UnionC`<[`IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `issueType`: `UnionC`<[`StringC`, `NullC`]\> ; `parent`: `UnionC`<[`StringC`, `NullC`]\> ; `priority`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`jira`](client._internal_namespace.md#jira)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `NullC` = rt.null; `type`: `LiteralC`<[`none`](client._internal_namespace.md#none)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>, `IntersectionC`<[`TypeC`<{ `fields`: `UnionC`<[`TypeC`<{ `incidentTypes`: `UnionC`<[`ArrayC`<`StringC`\>, `NullC`]\> ; `severityCode`: `UnionC`<[`StringC`, `NullC`]\> }\>, `NullC`]\> ; `type`: `LiteralC`<[`resilient`](client._internal_namespace.md#resilient)\> }\>, `TypeC`<{ `name`: `StringC` = rt.string }\>]\>]\>]\> = CaseConnectorRt; `description`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `settings`: `TypeC`<{ `syncAlerts`: `BooleanC` = rt.boolean }\> = SettingsRt; `status`: `UnionC`<[`LiteralC`<[`open`](../enums/client._internal_namespace.CaseStatuses.md#open)\>, `LiteralC`<`any`[`any`]\>, `LiteralC`<[`closed`](../enums/client._internal_namespace.CaseStatuses.md#closed)\>]\> = CaseStatusRt; `tags`: `ArrayC`<`StringC`\> ; `title`: `StringC` = rt.string }\>, `TypeC`<{ `closed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `closed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `external_service`: `UnionC`<[`IntersectionC`<[`TypeC`<{ `connector_id`: `StringC` = rt.string }\>, `TypeC`<{ `connector_name`: `StringC` = rt.string; `external_id`: `StringC` = rt.string; `external_title`: `StringC` = rt.string; `external_url`: `StringC` = rt.string; `pushed_at`: `StringC` = rt.string; `pushed_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT }\>]\>, `NullC`]\> = CaseFullExternalServiceRt; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `totalAlerts`: `NumberC` = rt.number; `totalComment`: `NumberC` = rt.number; `version`: `StringC` = rt.string }\>, `PartialC`<{ `comments`: `ArrayC`<`IntersectionC`<[`UnionC`<[`IntersectionC`<[`TypeC`<{ `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`user`](client._internal_namespace.md#user)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `alertId`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `index`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `owner`: `StringC` = rt.string; `rule`: `TypeC`<{ `id`: `UnionC`<[`StringC`, `NullC`]\> ; `name`: `UnionC`<[`StringC`, `NullC`]\> }\> ; `type`: `LiteralC`<[`alert`](client._internal_namespace.md#alert)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `actions`: `TypeC`<{ `targets`: `ArrayC`<`TypeC`<{ `endpointId`: `StringC` = rt.string; `hostname`: `StringC` = rt.string }\>\> ; `type`: `StringC` = rt.string }\> ; `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`actions`](client._internal_namespace.md#actions)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `version`: `StringC` = rt.string }\>]\>\> }\>]\>\> + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/case.ts:241](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/case.ts#L241) + +___ + +### CommentsResponseRt + +• **CommentsResponseRt**: `TypeC`<{ `comments`: `ArrayC`<`IntersectionC`<[`UnionC`<[`IntersectionC`<[`TypeC`<{ `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`user`](client._internal_namespace.md#user)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `alertId`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `index`: `UnionC`<[`ArrayC`<`StringC`\>, `StringC`]\> ; `owner`: `StringC` = rt.string; `rule`: `TypeC`<{ `id`: `UnionC`<[`StringC`, `NullC`]\> ; `name`: `UnionC`<[`StringC`, `NullC`]\> }\> ; `type`: `LiteralC`<[`alert`](client._internal_namespace.md#alert)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>, `IntersectionC`<[`TypeC`<{ `actions`: `TypeC`<{ `targets`: `ArrayC`<`TypeC`<{ `endpointId`: `StringC` = rt.string; `hostname`: `StringC` = rt.string }\>\> ; `type`: `StringC` = rt.string }\> ; `comment`: `StringC` = rt.string; `owner`: `StringC` = rt.string; `type`: `LiteralC`<[`actions`](client._internal_namespace.md#actions)\> }\>, `TypeC`<{ `created_at`: `StringC` = rt.string; `created_by`: `TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\> = UserRT; `owner`: `StringC` = rt.string; `pushed_at`: `UnionC`<[`StringC`, `NullC`]\> ; `pushed_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> ; `updated_at`: `UnionC`<[`StringC`, `NullC`]\> ; `updated_by`: `UnionC`<[`TypeC`<{ `email`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `full_name`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> ; `username`: `UnionC`<[`UndefinedC`, `NullC`, `StringC`]\> }\>, `NullC`]\> }\>]\>]\>, `TypeC`<{ `id`: `StringC` = rt.string; `version`: `StringC` = rt.string }\>]\>\> ; `page`: `NumberC` = rt.number; `per_page`: `NumberC` = rt.number; `total`: `NumberC` = rt.number }\> + +#### Defined in + +[x-pack/plugins/cases/common/api/cases/comment.ts:143](https://github.com/elastic/kibana/blob/c427bf270ae/x-pack/plugins/cases/common/api/cases/comment.ts#L143) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/typedoc_interfaces.md b/x-pack/plugins/cases/docs/cases_client/modules/typedoc_interfaces.md index 4719d2a2719c0..9f9d1f9a8808c 100644 --- a/x-pack/plugins/cases/docs/cases_client/modules/typedoc_interfaces.md +++ b/x-pack/plugins/cases/docs/cases_client/modules/typedoc_interfaces.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / typedoc_interfaces +[Cases Client API Interface](../README.md) / typedoc\_interfaces # Module: typedoc\_interfaces @@ -7,20 +7,22 @@ can be very large. These types are equivalent to the io-ts aliases. ## Table of contents +### Namespaces + +- [\_internal\_namespace](typedoc_interfaces._internal_namespace.md) + ### Interfaces -- [IAllCommentsResponse](../interfaces/typedoc_interfaces.iallcommentsresponse.md) -- [ICasePostRequest](../interfaces/typedoc_interfaces.icasepostrequest.md) -- [ICaseResponse](../interfaces/typedoc_interfaces.icaseresponse.md) -- [ICaseUserActionsResponse](../interfaces/typedoc_interfaces.icaseuseractionsresponse.md) -- [ICasesConfigurePatch](../interfaces/typedoc_interfaces.icasesconfigurepatch.md) -- [ICasesConfigureRequest](../interfaces/typedoc_interfaces.icasesconfigurerequest.md) -- [ICasesConfigureResponse](../interfaces/typedoc_interfaces.icasesconfigureresponse.md) -- [ICasesFindRequest](../interfaces/typedoc_interfaces.icasesfindrequest.md) -- [ICasesFindResponse](../interfaces/typedoc_interfaces.icasesfindresponse.md) -- [ICasesPatchRequest](../interfaces/typedoc_interfaces.icasespatchrequest.md) -- [ICasesResponse](../interfaces/typedoc_interfaces.icasesresponse.md) -- [ICommentsResponse](../interfaces/typedoc_interfaces.icommentsresponse.md) -- [ISubCaseResponse](../interfaces/typedoc_interfaces.isubcaseresponse.md) -- [ISubCasesFindResponse](../interfaces/typedoc_interfaces.isubcasesfindresponse.md) -- [ISubCasesResponse](../interfaces/typedoc_interfaces.isubcasesresponse.md) +- [IAllCommentsResponse](../interfaces/typedoc_interfaces.IAllCommentsResponse.md) +- [ICasePostRequest](../interfaces/typedoc_interfaces.ICasePostRequest.md) +- [ICaseResolveResponse](../interfaces/typedoc_interfaces.ICaseResolveResponse.md) +- [ICaseResponse](../interfaces/typedoc_interfaces.ICaseResponse.md) +- [ICaseUserActionsResponse](../interfaces/typedoc_interfaces.ICaseUserActionsResponse.md) +- [ICasesConfigurePatch](../interfaces/typedoc_interfaces.ICasesConfigurePatch.md) +- [ICasesConfigureRequest](../interfaces/typedoc_interfaces.ICasesConfigureRequest.md) +- [ICasesConfigureResponse](../interfaces/typedoc_interfaces.ICasesConfigureResponse.md) +- [ICasesFindRequest](../interfaces/typedoc_interfaces.ICasesFindRequest.md) +- [ICasesFindResponse](../interfaces/typedoc_interfaces.ICasesFindResponse.md) +- [ICasesPatchRequest](../interfaces/typedoc_interfaces.ICasesPatchRequest.md) +- [ICasesResponse](../interfaces/typedoc_interfaces.ICasesResponse.md) +- [ICommentsResponse](../interfaces/typedoc_interfaces.ICommentsResponse.md) diff --git a/x-pack/plugins/cases/docs/cases_client/modules/user_actions_client.md b/x-pack/plugins/cases/docs/cases_client/modules/user_actions_client.md index b48e3faac2135..4ec27e0beee46 100644 --- a/x-pack/plugins/cases/docs/cases_client/modules/user_actions_client.md +++ b/x-pack/plugins/cases/docs/cases_client/modules/user_actions_client.md @@ -1,4 +1,4 @@ -[Cases Client API Interface](../cases_client_api.md) / user_actions/client +[Cases Client API Interface](../README.md) / user\_actions/client # Module: user\_actions/client @@ -6,5 +6,5 @@ ### Interfaces -- [UserActionGet](../interfaces/user_actions_client.useractionget.md) -- [UserActionsSubClient](../interfaces/user_actions_client.useractionssubclient.md) +- [UserActionGet](../interfaces/user_actions_client.UserActionGet.md) +- [UserActionsSubClient](../interfaces/user_actions_client.UserActionsSubClient.md) diff --git a/x-pack/plugins/cases/docs/cases_client_typedoc.json b/x-pack/plugins/cases/docs/cases_client_typedoc.json index 5f67719b47574..a5e1305196491 100644 --- a/x-pack/plugins/cases/docs/cases_client_typedoc.json +++ b/x-pack/plugins/cases/docs/cases_client_typedoc.json @@ -2,15 +2,16 @@ "entryPoints": [ "../server/client/client.ts", "../server/client/typedoc_interfaces.ts", - "../server/client/attachments", + "../server/client/attachments/client.ts", "../server/client/cases/client.ts", "../server/client/cases/get.ts", "../server/client/cases/push.ts", "../server/client/configure/client.ts", + "../server/client/metrics/client.ts", "../server/client/stats/client.ts", - "../server/client/sub_cases/client.ts", "../server/client/user_actions/client.ts" ], + "entryPointStrategy": "expand", "exclude": [ "**/mock.ts", "../server/client/cases/+(mock.ts|utils.ts|utils.test.ts|types.ts)" @@ -18,8 +19,9 @@ "excludeExternals": true, "out": "cases_client", "theme": "markdown", - "plugin": "typedoc-plugin-markdown", - "entryDocument": "cases_client_api.md", + "internalNamespace": "_internal_namespace", + "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-missing-exports"], "readme": "none", - "name": "Cases Client API Interface" + "name": "Cases Client API Interface", + "gitRemote": "upstream" } From 6e93e83779418c50352c23f17c27c742a4c373dd Mon Sep 17 00:00:00 2001 From: Peter Pisljar Date: Tue, 1 Feb 2022 13:30:49 +0100 Subject: [PATCH 07/73] eql expression function (#123226) --- .../eql_raw_response.test.ts.snap | 208 ++++++++++++++++++ .../data/common/search/expressions/eql.ts | 172 +++++++++++++++ .../expressions/eql_raw_response.test.ts | 133 +++++++++++ .../search/expressions/eql_raw_response.ts | 134 +++++++++++ .../data/common/search/expressions/index.ts | 2 + .../__snapshots__/eql.test.ts.snap | 184 ++++++++++++++++ .../public/search/expressions/eql.test.ts | 165 ++++++++++++++ .../data/public/search/expressions/eql.ts | 43 ++++ .../data/public/search/expressions/index.ts | 1 + .../data/public/search/search_service.ts | 9 +- .../data/server/search/expressions/eql.ts | 52 +++++ .../data/server/search/expressions/index.ts | 1 + .../data/server/search/search_service.ts | 5 +- 13 files changed, 1107 insertions(+), 2 deletions(-) create mode 100644 src/plugins/data/common/search/expressions/__snapshots__/eql_raw_response.test.ts.snap create mode 100644 src/plugins/data/common/search/expressions/eql.ts create mode 100644 src/plugins/data/common/search/expressions/eql_raw_response.test.ts create mode 100644 src/plugins/data/common/search/expressions/eql_raw_response.ts create mode 100644 src/plugins/data/public/search/expressions/__snapshots__/eql.test.ts.snap create mode 100644 src/plugins/data/public/search/expressions/eql.test.ts create mode 100644 src/plugins/data/public/search/expressions/eql.ts create mode 100644 src/plugins/data/server/search/expressions/eql.ts diff --git a/src/plugins/data/common/search/expressions/__snapshots__/eql_raw_response.test.ts.snap b/src/plugins/data/common/search/expressions/__snapshots__/eql_raw_response.test.ts.snap new file mode 100644 index 0000000000000..341a04cef373f --- /dev/null +++ b/src/plugins/data/common/search/expressions/__snapshots__/eql_raw_response.test.ts.snap @@ -0,0 +1,208 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`eqlRawResponse converts events to table simple aggregation response 1`] = ` +Object { + "columns": Array [ + Object { + "id": "prop", + "meta": Object { + "field": "prop", + "params": Object {}, + "type": "string", + }, + "name": "prop", + }, + Object { + "id": "prop2", + "meta": Object { + "field": "prop2", + "params": Object {}, + "type": "number", + }, + "name": "prop2", + }, + ], + "meta": Object { + "source": "*", + "type": "eql", + }, + "rows": Array [ + Object { + "prop": "value", + "prop2": 3, + }, + Object { + "prop": "value2", + "prop2": 5, + }, + ], + "type": "datatable", +} +`; + +exports[`eqlRawResponse converts sequences to table simple docs response 1`] = ` +Object { + "columns": Array [ + Object { + "id": "category", + "meta": Object { + "field": "category", + "params": Object {}, + "type": "object", + }, + "name": "category", + }, + Object { + "id": "currency", + "meta": Object { + "field": "currency", + "params": Object {}, + "type": "string", + }, + "name": "currency", + }, + Object { + "id": "customer_first_name", + "meta": Object { + "field": "customer_first_name", + "params": Object {}, + "type": "string", + }, + "name": "customer_first_name", + }, + Object { + "id": "customer_full_name", + "meta": Object { + "field": "customer_full_name", + "params": Object {}, + "type": "string", + }, + "name": "customer_full_name", + }, + Object { + "id": "customer_gender", + "meta": Object { + "field": "customer_gender", + "params": Object {}, + "type": "string", + }, + "name": "customer_gender", + }, + Object { + "id": "products", + "meta": Object { + "field": "products", + "params": Object {}, + "type": "object", + }, + "name": "products", + }, + Object { + "id": "sku", + "meta": Object { + "field": "sku", + "params": Object {}, + "type": "object", + }, + "name": "sku", + }, + Object { + "id": "geoip.country_iso_code", + "meta": Object { + "field": "geoip.country_iso_code", + "params": Object {}, + "type": "string", + }, + "name": "geoip.country_iso_code", + }, + Object { + "id": "geoip.location.lon", + "meta": Object { + "field": "geoip.location.lon", + "params": Object {}, + "type": "number", + }, + "name": "geoip.location.lon", + }, + Object { + "id": "geoip.location.lat", + "meta": Object { + "field": "geoip.location.lat", + "params": Object {}, + "type": "number", + }, + "name": "geoip.location.lat", + }, + Object { + "id": "geoip.continent_name", + "meta": Object { + "field": "geoip.continent_name", + "params": Object {}, + "type": "string", + }, + "name": "geoip.continent_name", + }, + ], + "meta": Object { + "source": "*", + "type": "eql", + }, + "rows": Array [ + Object { + "category": Array [ + "Men's Clothing", + ], + "currency": "EUR", + "customer_first_name": "Oliver", + "customer_full_name": "Oliver Rios", + "customer_gender": "MALE", + "geoip.continent_name": "Europe", + "geoip.country_iso_code": "GB", + "geoip.location.lat": 51.5, + "geoip.location.lon": -0.1, + "products": Array [ + Object { + "base_price": 20.99, + "discount_percentage": 0, + }, + Object { + "base_price": 24.99, + "discount_percentage": 0, + }, + ], + "sku": Array [ + "ZO0417504175", + "ZO0535205352", + ], + }, + Object { + "category": Array [ + "Men's Clothing", + ], + "currency": "EUR", + "customer_first_name": "Boris", + "customer_full_name": "Boris Bradley", + "customer_gender": "MALE", + "geoip.continent_name": "Europe", + "geoip.country_iso_code": "GB", + "geoip.location.lat": 51.5, + "geoip.location.lon": -0.1, + "products": Array [ + Object { + "base_price": 32.99, + "discount_percentage": 0, + }, + Object { + "base_price": 28.99, + "discount_percentage": 0, + }, + ], + "sku": Array [ + "ZO0112101121", + "ZO0530405304", + ], + }, + ], + "type": "datatable", +} +`; diff --git a/src/plugins/data/common/search/expressions/eql.ts b/src/plugins/data/common/search/expressions/eql.ts new file mode 100644 index 0000000000000..b7a8c47985601 --- /dev/null +++ b/src/plugins/data/common/search/expressions/eql.ts @@ -0,0 +1,172 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { i18n } from '@kbn/i18n'; +import { buildEsQuery } from '@kbn/es-query'; +import { ExpressionFunctionDefinition } from 'src/plugins/expressions/common'; + +import { EqlSearchRequest } from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import { RequestStatistics, RequestAdapter } from '../../../../inspector/common'; +import { + ISearchGeneric, + KibanaContext, + EqlSearchStrategyResponse, + EQL_SEARCH_STRATEGY, + EqlSearchStrategyRequest, +} from '..'; +import { getEsQueryConfig } from '../../es_query'; +import { DataViewsContract, UiSettingsCommon } from '../..'; +import { EqlRawResponse } from './eql_raw_response'; + +const name = 'eql'; + +type Input = KibanaContext | null; +type Output = Promise; + +interface Arguments { + query: string; + index: string; + size: number; + field: string[]; +} + +export type EqlExpressionFunctionDefinition = ExpressionFunctionDefinition< + typeof name, + Input, + Arguments, + Output +>; + +interface EqlStartDependencies { + search: ISearchGeneric; + uiSettingsClient: UiSettingsCommon; + dataViews: DataViewsContract; +} + +export const getEqlFn = ({ + getStartDependencies, +}: { + getStartDependencies: (getKibanaRequest: any) => Promise; +}) => { + const eql: EqlExpressionFunctionDefinition = { + name, + type: 'eql_raw_response', + inputTypes: ['kibana_context', 'null'], + help: i18n.translate('data.search.eql.help', { + defaultMessage: 'Run Elasticsearch request', + }), + args: { + query: { + types: ['string'], + aliases: ['_', 'q', 'query'], + help: i18n.translate('data.search.eql.q.help', { + defaultMessage: 'Query DSL', + }), + required: true, + }, + index: { + types: ['string'], + help: i18n.translate('data.search.eql.index.help', { + defaultMessage: 'ElasticSearch index to query', + }), + required: true, + }, + size: { + types: ['number'], + help: i18n.translate('data.search.eql.size.help', { + defaultMessage: 'ElasticSearch searchAPI size parameter', + }), + default: 10, + }, + field: { + types: ['string'], + help: i18n.translate('data.search.eql.field.help', { + defaultMessage: 'List of fields to retrieve', + }), + multi: true, + required: false, + }, + }, + async fn(input, args, { inspectorAdapters, abortSignal, getKibanaRequest }) { + const { search, uiSettingsClient, dataViews } = await getStartDependencies(getKibanaRequest); + + const dsl = { + query: args.query, + size: args.size, + fields: args.field, + } as unknown as Required['body']; + + if (input) { + const dataview = args.index ? await dataViews.create({ title: args.index }) : undefined; + const esQueryConfigs = getEsQueryConfig(uiSettingsClient as any); + const query = buildEsQuery( + dataview, + input.query || [], + input.filters || [], + esQueryConfigs + ); + + dsl.filter = query; + } + + if (!inspectorAdapters.requests) { + inspectorAdapters.requests = new RequestAdapter(); + } + + const request = inspectorAdapters.requests.start( + i18n.translate('data.search.dataRequest.title', { + defaultMessage: 'Data', + }), + { + description: i18n.translate('data.search.es_search.dataRequest.description', { + defaultMessage: + 'This request queries Elasticsearch to fetch the data for the visualization.', + }), + } + ); + + request.stats({ + indexPattern: { + label: i18n.translate('data.search.es_search.dataViewLabel', { + defaultMessage: 'Data view', + }), + value: args.index, + description: i18n.translate('data.search.es_search.indexPatternDescription', { + defaultMessage: 'The data view that connected to the Elasticsearch indices.', + }), + }, + }); + + try { + const response = await search( + { + params: { + index: args.index, + body: dsl, + }, + }, + { abortSignal, strategy: EQL_SEARCH_STRATEGY } + ).toPromise(); + + const stats: RequestStatistics = {}; + + request.stats(stats).ok({ json: response }); + request.json(dsl!); + + return { + type: 'eql_raw_response', + body: response.rawResponse.body, + }; + } catch (e) { + request.error({ json: e }); + throw e; + } + }, + }; + return eql; +}; diff --git a/src/plugins/data/common/search/expressions/eql_raw_response.test.ts b/src/plugins/data/common/search/expressions/eql_raw_response.test.ts new file mode 100644 index 0000000000000..80d7ca25c89df --- /dev/null +++ b/src/plugins/data/common/search/expressions/eql_raw_response.test.ts @@ -0,0 +1,133 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { EqlRawResponse, eqlRawResponse } from './eql_raw_response'; + +jest.mock('@kbn/i18n', () => { + return { + i18n: { + translate: (id: string, { defaultMessage }: { defaultMessage: string }) => defaultMessage, + }, + }; +}); + +describe('eqlRawResponse', () => { + describe('converts events to table', () => { + test('simple aggregation response', () => { + const response: EqlRawResponse = { + type: 'eql_raw_response', + body: { + hits: { + events: [ + { + _source: { + prop: 'value', + prop2: 3, + }, + }, + { + _source: { + prop: 'value2', + prop2: 5, + }, + }, + ], + }, + }, + }; + const result = eqlRawResponse.to!.datatable(response, {}); + expect(result).toMatchSnapshot(); + }); + }); + + describe('converts sequences to table', () => { + test('simple docs response', () => { + const response: EqlRawResponse = { + type: 'eql_raw_response', + body: { + hits: { + sequences: [ + { + events: [ + { + _index: 'kibana_sample_data_ecommerce', + _id: 'AncqUnMBMY_orZma2mZy', + _score: 0, + _source: { + category: ["Men's Clothing"], + currency: 'EUR', + customer_first_name: 'Oliver', + customer_full_name: 'Oliver Rios', + customer_gender: 'MALE', + products: [ + { + base_price: 20.99, + discount_percentage: 0, + }, + { + base_price: 24.99, + discount_percentage: 0, + }, + ], + sku: ['ZO0417504175', 'ZO0535205352'], + geoip: { + country_iso_code: 'GB', + location: { + lon: -0.1, + lat: 51.5, + }, + continent_name: 'Europe', + }, + }, + }, + ], + }, + { + events: [ + { + _index: 'kibana_sample_data_ecommerce', + _id: 'I3cqUnMBMY_orZma2mZy', + _score: 0, + _source: { + category: ["Men's Clothing"], + currency: 'EUR', + customer_first_name: 'Boris', + customer_full_name: 'Boris Bradley', + customer_gender: 'MALE', + products: [ + { + base_price: 32.99, + discount_percentage: 0, + }, + { + base_price: 28.99, + discount_percentage: 0, + }, + ], + sku: ['ZO0112101121', 'ZO0530405304'], + geoip: { + country_iso_code: 'GB', + location: { + lon: -0.1, + lat: 51.5, + }, + continent_name: 'Europe', + }, + }, + }, + ], + }, + ], + }, + }, + }; + const result = eqlRawResponse.to?.datatable(response, {}); + expect(result).toMatchSnapshot(); + }); + }); +}); diff --git a/src/plugins/data/common/search/expressions/eql_raw_response.ts b/src/plugins/data/common/search/expressions/eql_raw_response.ts new file mode 100644 index 0000000000000..64e41332a8c17 --- /dev/null +++ b/src/plugins/data/common/search/expressions/eql_raw_response.ts @@ -0,0 +1,134 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { ExpressionTypeDefinition } from '../../../../expressions/common'; +import { EqlSearchStrategyResponse } from '..'; + +const name = 'eql_raw_response'; + +export interface EqlRawResponse { + type: typeof name; + body: EqlSearchStrategyResponse['rawResponse']['body']; +} + +// duplocated from x-pack/timelines plugin +export type SearchTypes = + | string + | string[] + | number + | number[] + | boolean + | boolean[] + | object + | object[] + | undefined; + +export interface TotalValue { + value: number; + relation: string; +} + +export interface BaseHit { + _index: string; + _id: string; + _source: T; + fields?: Record; +} + +export interface EqlSequence { + join_keys: SearchTypes[]; + events: Array>; +} + +export interface EqlSearchResponse { + is_partial: boolean; + is_running: boolean; + took: number; + timed_out: boolean; + hits: { + total: TotalValue; + sequences?: Array>; + events?: Array>; + }; +} + +export type EqlRawResponseExpressionTypeDefinition = ExpressionTypeDefinition< + typeof name, + EqlRawResponse, + EqlRawResponse +>; + +const flatten = (obj: Record) => { + const _flatten = (o: Record, path: string[] = []): unknown[] => { + return Object.keys(o) + .map((k: string) => { + if (typeof o[k] === 'object' && o[k] !== null && !Array.isArray(o[k])) { + return _flatten(o[k] as Record, [...path, k]); + } else { + const key = [...path, k].join('.'); + return { [key]: o[k] }; + } + }) + .flat(); + }; + + return Object.assign({}, ..._flatten(obj)); +}; + +const parseEventDocs = (events: Array>, joinKeys?: unknown[]) => { + return events + .map((hit) => hit.fields || hit._source) + .filter((hit) => hit) + .map((event) => flatten(event as Record)) + .map((event) => { + if (joinKeys) { + event.joinKeys = joinKeys; + } + return event; + }); +}; + +const parseResponse = (hits: EqlSearchResponse['hits']) => { + if (hits.sequences) { + return hits.sequences.flatMap((sequence) => + parseEventDocs(sequence.events, sequence.join_keys) + ); + } + return parseEventDocs(hits.events!); +}; + +export const eqlRawResponse: EqlRawResponseExpressionTypeDefinition = { + name, + to: { + datatable: (context: EqlRawResponse) => { + // improved handling needs to be added when we know some usecases + const rows = parseResponse((context.body as EqlSearchResponse).hits); + const columns = rows.length + ? Object.keys(rows[0]).map((key) => ({ + id: key, + name: key, + meta: { + type: typeof rows[0][key], + field: key, + params: {}, + }, + })) + : []; + + return { + type: 'datatable', + meta: { + type: 'eql', + source: '*', + }, + columns, + rows, + }; + }, + }, +}; diff --git a/src/plugins/data/common/search/expressions/index.ts b/src/plugins/data/common/search/expressions/index.ts index 05496b4d8c885..23d3b865b4c05 100644 --- a/src/plugins/data/common/search/expressions/index.ts +++ b/src/plugins/data/common/search/expressions/index.ts @@ -42,4 +42,6 @@ export * from './kibana_filter'; export * from './filters_to_ast'; export * from './timerange'; export * from './es_raw_response'; +export * from './eql_raw_response'; export * from './esdsl'; +export * from './eql'; diff --git a/src/plugins/data/public/search/expressions/__snapshots__/eql.test.ts.snap b/src/plugins/data/public/search/expressions/__snapshots__/eql.test.ts.snap new file mode 100644 index 0000000000000..ea1d33aef1b12 --- /dev/null +++ b/src/plugins/data/public/search/expressions/__snapshots__/eql.test.ts.snap @@ -0,0 +1,184 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`eql correctly handles filter, query and timerange on context 1`] = ` +Object { + "body": Object { + "params": Object { + "body": Object { + "fields": Array [], + "filter": Object { + "bool": Object { + "filter": Array [ + Object { + "match_phrase": Object { + "gender": "male", + }, + }, + ], + "must": Array [ + Object { + "query_string": Object { + "query": "*", + "time_zone": true, + }, + }, + ], + "must_not": Array [], + "should": Array [], + }, + }, + "query": "test", + "size": 4, + }, + "index": "kibana_sample_data_logs", + }, + }, + "type": "eql_raw_response", +} +`; + +exports[`eql correctly handles input adds filters 1`] = ` +Object { + "body": Object { + "params": Object { + "body": Object { + "fields": Array [], + "filter": Object { + "bool": Object { + "filter": Array [ + Object { + "match_phrase": Object { + "gender": "male", + }, + }, + ], + "must": Array [], + "must_not": Array [], + "should": Array [], + }, + }, + "query": "test", + "size": 0, + }, + "index": "test", + }, + }, + "type": "eql_raw_response", +} +`; + +exports[`eql correctly handles input adds filters to query with filters 1`] = ` +Object { + "body": Object { + "params": Object { + "body": Object { + "fields": Array [], + "filter": Object { + "bool": Object { + "filter": Array [ + Object { + "match_phrase": Object { + "gender": "male", + }, + }, + ], + "must": Array [], + "must_not": Array [], + "should": Array [], + }, + }, + "query": "test", + "size": 4, + }, + "index": "kibana_sample_data_logs", + }, + }, + "type": "eql_raw_response", +} +`; + +exports[`eql correctly handles input adds query 1`] = ` +Object { + "body": Object { + "params": Object { + "body": Object { + "fields": Array [], + "filter": Object { + "bool": Object { + "filter": Array [], + "must": Array [ + Object { + "query_string": Object { + "query": "*", + "time_zone": true, + }, + }, + ], + "must_not": Array [], + "should": Array [], + }, + }, + "query": "test", + "size": 0, + }, + "index": "test", + }, + }, + "type": "eql_raw_response", +} +`; + +exports[`eql correctly handles input adds query to a query with filters 1`] = ` +Object { + "body": Object { + "params": Object { + "body": Object { + "fields": Array [], + "filter": Object { + "bool": Object { + "filter": Array [], + "must": Array [ + Object { + "query_string": Object { + "query": "*", + "time_zone": true, + }, + }, + ], + "must_not": Array [], + "should": Array [], + }, + }, + "query": "test", + "size": 4, + }, + "index": "kibana_sample_data_logs", + }, + }, + "type": "eql_raw_response", +} +`; + +exports[`eql correctly handles input ignores timerange 1`] = ` +Object { + "body": Object { + "params": Object { + "body": Object { + "fields": Array [], + "filter": Object { + "bool": Object { + "filter": Array [], + "must": Array [], + "must_not": Array [], + "should": Array [], + }, + }, + "query": "test", + "size": 0, + }, + "index": "test", + }, + }, + "type": "eql_raw_response", +} +`; diff --git a/src/plugins/data/public/search/expressions/eql.test.ts b/src/plugins/data/public/search/expressions/eql.test.ts new file mode 100644 index 0000000000000..71655a551253c --- /dev/null +++ b/src/plugins/data/public/search/expressions/eql.test.ts @@ -0,0 +1,165 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { getEql } from './eql'; +import { MockedKeys } from '@kbn/utility-types/jest'; +import { EqlExpressionFunctionDefinition } from '../../../common/search/expressions'; +import { StartServicesAccessor } from 'kibana/public'; +import { DataPublicPluginStart, DataStartDependencies } from '../../types'; +import { of } from 'rxjs'; + +jest.mock('@kbn/i18n', () => { + return { + i18n: { + translate: (id: string, { defaultMessage }: { defaultMessage: string }) => defaultMessage, + }, + }; +}); + +describe('eql', () => { + let getStartServices: StartServicesAccessor; + let startDependencies: MockedKeys< + StartServicesAccessor + >; + let eql: EqlExpressionFunctionDefinition; + + beforeEach(() => { + jest.clearAllMocks(); + startDependencies = [ + { + uiSettings: { + get: jest.fn().mockReturnValue(true), + }, + }, + {}, + { + search: { + search: jest.fn((params: any) => of({ rawResponse: { body: params } })), + }, + indexPatterns: { + get: jest.fn(), + create: jest.fn(), + }, + }, + ]; + getStartServices = jest.fn().mockResolvedValue(startDependencies); + eql = getEql({ getStartServices }); + }); + + describe('correctly handles input', () => { + test('adds filters', async () => { + const result = await eql.fn( + { + type: 'kibana_context', + filters: [ + { + meta: { index: '1', alias: 'test', negate: false, disabled: false }, + query: { match_phrase: { gender: 'male' } }, + }, + ], + }, + { query: 'test', index: 'test', size: 0, field: [] }, + { inspectorAdapters: {} } as any + ); + + expect(result).toMatchSnapshot(); + }); + + test('adds filters to query with filters', async () => { + const result = await eql.fn( + { + type: 'kibana_context', + filters: [ + { + meta: { index: '1', alias: 'test', negate: false, disabled: false }, + query: { match_phrase: { gender: 'male' } }, + }, + ], + }, + { + index: 'kibana_sample_data_logs', + size: 4, + query: 'test', + field: [], + }, + { inspectorAdapters: {} } as any + ); + + expect(result).toMatchSnapshot(); + }); + + test('adds query', async () => { + const result = await eql.fn( + { + type: 'kibana_context', + query: { language: 'lucene', query: '*' }, + }, + { query: 'test', index: 'test', size: 0, field: [] }, + { inspectorAdapters: {} } as any + ); + + expect(result).toMatchSnapshot(); + }); + + test('adds query to a query with filters', async () => { + const result = await eql.fn( + { + type: 'kibana_context', + query: { language: 'lucene', query: '*' }, + }, + { + index: 'kibana_sample_data_logs', + size: 4, + query: 'test', + field: [], + }, + { inspectorAdapters: {} } as any + ); + + expect(result).toMatchSnapshot(); + }); + + test('ignores timerange', async () => { + const result = await eql.fn( + { + type: 'kibana_context', + timeRange: { from: 'now-15m', to: 'now' }, + }, + { query: 'test', index: 'test', size: 0, field: [] }, + { inspectorAdapters: {} } as any + ); + + expect(result).toMatchSnapshot(); + }); + }); + + test('correctly handles filter, query and timerange on context', async () => { + const result = await eql.fn( + { + type: 'kibana_context', + query: { language: 'lucene', query: '*' }, + timeRange: { from: 'now-15m', to: 'now' }, + filters: [ + { + meta: { index: '1', alias: 'test', negate: false, disabled: false }, + query: { match_phrase: { gender: 'male' } }, + }, + ], + }, + { + index: 'kibana_sample_data_logs', + size: 4, + query: 'test', + field: [], + }, + { inspectorAdapters: {} } as any + ); + + expect(result).toMatchSnapshot(); + }); +}); diff --git a/src/plugins/data/public/search/expressions/eql.ts b/src/plugins/data/public/search/expressions/eql.ts new file mode 100644 index 0000000000000..03444dd22adc2 --- /dev/null +++ b/src/plugins/data/public/search/expressions/eql.ts @@ -0,0 +1,43 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { StartServicesAccessor } from 'src/core/public'; +import { DataPublicPluginStart, DataStartDependencies } from '../../types'; +import { getEqlFn } from '../../../common/search/expressions/eql'; +import { UiSettingsCommon } from '../../../common'; + +/** + * This is some glue code that takes in `core.getStartServices`, extracts the dependencies + * needed for this function, and wraps them behind a `getStartDependencies` function that + * is then called at runtime. + * + * We do this so that we can be explicit about exactly which dependencies the function + * requires, without cluttering up the top-level `plugin.ts` with this logic. It also + * makes testing the expression function a bit easier since `getStartDependencies` is + * the only thing you should need to mock. + * + * @param getStartServices - core's StartServicesAccessor for this plugin + * + * @internal + */ +export function getEql({ + getStartServices, +}: { + getStartServices: StartServicesAccessor; +}) { + return getEqlFn({ + getStartDependencies: async () => { + const [core, , { search, indexPatterns }] = await getStartServices(); + return { + uiSettingsClient: core.uiSettings as unknown as UiSettingsCommon, + search: search.search, + dataViews: indexPatterns, + }; + }, + }); +} diff --git a/src/plugins/data/public/search/expressions/index.ts b/src/plugins/data/public/search/expressions/index.ts index d60ab610d27b5..6594b235fda72 100644 --- a/src/plugins/data/public/search/expressions/index.ts +++ b/src/plugins/data/public/search/expressions/index.ts @@ -9,3 +9,4 @@ export * from './esaggs'; export * from './esdsl'; export * from '../../../common/search/expressions'; +export * from './eql'; diff --git a/src/plugins/data/public/search/search_service.ts b/src/plugins/data/public/search/search_service.ts index 311a863a74933..961599de713df 100644 --- a/src/plugins/data/public/search/search_service.ts +++ b/src/plugins/data/public/search/search_service.ts @@ -44,13 +44,14 @@ import { kibanaFilterFunction, phraseFilterFunction, esRawResponse, + eqlRawResponse, } from '../../common/search'; import { AggsService, AggsStartDependencies } from './aggs'; import { IKibanaSearchResponse, IndexPatternsContract, SearchRequest } from '..'; import { ISearchInterceptor, SearchInterceptor } from './search_interceptor'; import { SearchUsageCollector, createUsageCollector } from './collectors'; import { UsageCollectionSetup } from '../../../usage_collection/public'; -import { getEsaggs, getEsdsl } from './expressions'; +import { getEsaggs, getEsdsl, getEql } from './expressions'; import { ExpressionsSetup } from '../../../expressions/public'; import { ISessionsClient, ISessionService, SessionsClient, SessionService } from './session'; import { ConfigSchema } from '../../config'; @@ -152,7 +153,13 @@ export class SearchService implements Plugin { getStartServices: StartServicesAccessor; }) ); + expressions.registerFunction( + getEql({ getStartServices } as { + getStartServices: StartServicesAccessor; + }) + ); expressions.registerType(esRawResponse); + expressions.registerType(eqlRawResponse); const aggs = this.aggsService.setup({ registerFunction: expressions.registerFunction, diff --git a/src/plugins/data/server/search/expressions/eql.ts b/src/plugins/data/server/search/expressions/eql.ts new file mode 100644 index 0000000000000..e9acac3ffc08f --- /dev/null +++ b/src/plugins/data/server/search/expressions/eql.ts @@ -0,0 +1,52 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { StartServicesAccessor } from 'src/core/server'; +import { DataPluginStart, DataPluginStartDependencies } from '../../plugin'; +import { getEqlFn } from '../../../common/search/expressions/eql'; + +/** + * This is some glue code that takes in `core.getStartServices`, extracts the dependencies + * needed for this function, and wraps them behind a `getStartDependencies` function that + * is then called at runtime. + * + * We do this so that we can be explicit about exactly which dependencies the function + * requires, without cluttering up the top-level `plugin.ts` with this logic. It also + * makes testing the expression function a bit easier since `getStartDependencies` is + * the only thing you should need to mock. + * + * @param getStartServices - core's StartServicesAccessor for this plugin + * + * @internal + */ +export function getEql({ + getStartServices, +}: { + getStartServices: StartServicesAccessor; +}) { + return getEqlFn({ + getStartDependencies: async (getKibanaRequest: any) => { + const [core, , { search, indexPatterns }] = await getStartServices(); + const request = getKibanaRequest?.(); + if (request) { + throw new Error('missing dependencies'); + } + const savedObjectsClient = core.savedObjects.getScopedClient(request); + const dataViews = await indexPatterns.dataViewsServiceFactory( + savedObjectsClient, + core.elasticsearch.client.asScoped(request).asCurrentUser, + request + ); + return { + uiSettingsClient: core.uiSettings.asScopedToClient(savedObjectsClient), + search: search.asScoped(request).search, + dataViews, + }; + }, + }); +} diff --git a/src/plugins/data/server/search/expressions/index.ts b/src/plugins/data/server/search/expressions/index.ts index bb690c2e6e7c6..8273f6f424a2d 100644 --- a/src/plugins/data/server/search/expressions/index.ts +++ b/src/plugins/data/server/search/expressions/index.ts @@ -8,3 +8,4 @@ export * from './esaggs'; export * from './esdsl'; +export * from './eql'; diff --git a/src/plugins/data/server/search/search_service.ts b/src/plugins/data/server/search/search_service.ts index d3b1c57b67779..c3d335ed2b6df 100644 --- a/src/plugins/data/server/search/search_service.ts +++ b/src/plugins/data/server/search/search_service.ts @@ -74,10 +74,11 @@ import { SearchSourceService, phraseFilterFunction, esRawResponse, + eqlRawResponse, ENHANCED_ES_SEARCH_STRATEGY, EQL_SEARCH_STRATEGY, } from '../../common/search'; -import { getEsaggs, getEsdsl } from './expressions'; +import { getEsaggs, getEsdsl, getEql } from './expressions'; import { getShardDelayBucketAgg, SHARD_DELAY_AGG_NAME, @@ -189,6 +190,7 @@ export class SearchService implements Plugin { expressions.registerFunction(getEsaggs({ getStartServices: core.getStartServices })); expressions.registerFunction(getEsdsl({ getStartServices: core.getStartServices })); + expressions.registerFunction(getEql({ getStartServices: core.getStartServices })); expressions.registerFunction(cidrFunction); expressions.registerFunction(dateRangeFunction); expressions.registerFunction(extendedBoundsFunction); @@ -212,6 +214,7 @@ export class SearchService implements Plugin { expressions.registerFunction(phraseFilterFunction); expressions.registerType(kibanaContext); expressions.registerType(esRawResponse); + expressions.registerType(eqlRawResponse); const aggs = this.aggsService.setup({ registerFunction: expressions.registerFunction }); From 0aee9829a23b1ae51a20899717a0377fab2855ee Mon Sep 17 00:00:00 2001 From: Joe Portner <5295965+jportner@users.noreply.github.com> Date: Tue, 1 Feb 2022 07:43:20 -0500 Subject: [PATCH 08/73] Replace deprecated index patterns API usage with data views API (#124134) --- .../roles/edit_role/edit_role_page.test.tsx | 12 ++++++------ .../roles/edit_role/edit_role_page.tsx | 16 +++++++++------- .../management/roles/roles_management_app.tsx | 2 +- 3 files changed, 16 insertions(+), 14 deletions(-) diff --git a/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.test.tsx b/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.test.tsx index f621ca0eddb0f..a99e08fd5a8a6 100644 --- a/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.test.tsx +++ b/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.test.tsx @@ -139,9 +139,9 @@ function getProps({ const rolesAPIClient = rolesAPIClientMock.create(); rolesAPIClient.getRole.mockResolvedValue(role); - const indexPatterns = dataPluginMock.createStartContract().indexPatterns; + const dataViews = dataPluginMock.createStartContract().dataViews; // `undefined` titles can technically happen via import/export or other manual manipulation - indexPatterns.getTitles = jest.fn().mockResolvedValue(['foo*', 'bar*', undefined]); + dataViews.getTitles = jest.fn().mockResolvedValue(['foo*', 'bar*', undefined]); const indicesAPIClient = indicesAPIClientMock.create(); @@ -171,7 +171,7 @@ function getProps({ roleName: role?.name, license, http, - indexPatterns, + dataViews, indicesAPIClient, privilegesAPIClient, rolesAPIClient, @@ -352,11 +352,11 @@ describe('', () => { }); it('can render if index patterns are not available', async () => { - const indexPatterns = dataPluginMock.createStartContract().indexPatterns; - indexPatterns.getTitles = jest.fn().mockRejectedValue({ response: { status: 403 } }); + const dataViews = dataPluginMock.createStartContract().dataViews; + dataViews.getTitles = jest.fn().mockRejectedValue({ response: { status: 403 } }); const wrapper = mountWithIntl( - + ); await waitForRender(wrapper); diff --git a/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.tsx b/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.tsx index 2bfc23b446966..2e9b5f126f6db 100644 --- a/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.tsx +++ b/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.tsx @@ -34,7 +34,7 @@ import type { NotificationsStart, ScopedHistory, } from 'src/core/public'; -import type { IndexPatternsContract } from 'src/plugins/data/public'; +import type { DataViewsContract } from 'src/plugins/data/public'; import { reactRouterNavigate } from '../../../../../../../src/plugins/kibana_react/public'; import type { KibanaFeature } from '../../../../../features/common'; @@ -69,7 +69,7 @@ import { RoleValidator } from './validate_role'; interface Props { action: 'edit' | 'clone'; roleName?: string; - indexPatterns: IndexPatternsContract; + dataViews: DataViewsContract; userAPIClient: PublicMethodsOf; indicesAPIClient: PublicMethodsOf; rolesAPIClient: PublicMethodsOf; @@ -101,13 +101,13 @@ function useRunAsUsers( } function useIndexPatternsTitles( - indexPatterns: IndexPatternsContract, + dataViews: DataViewsContract, fatalErrors: FatalErrorsSetup, notifications: NotificationsStart ) { const [indexPatternsTitles, setIndexPatternsTitles] = useState(null); useEffect(() => { - indexPatterns + dataViews .getTitles() .catch((err: IHttpFetchError) => { // If user doesn't have access to the index patterns they still should be able to create new @@ -115,6 +115,8 @@ function useIndexPatternsTitles( if (err.response?.status === 403) { notifications.toasts.addDanger({ title: i18n.translate('xpack.security.management.roles.noIndexPatternsPermission', { + // Note: we are attempting to fetch data views (a Kibana construct), but we are using those to render a list of usable index + // patterns (an Elasticsearch construct) for the user. This error message reflects what is shown on the UI. defaultMessage: 'You need permission to access the list of available index patterns.', }), }); @@ -125,7 +127,7 @@ function useIndexPatternsTitles( throw err; }) .then((titles) => setIndexPatternsTitles(titles.filter(Boolean))); - }, [fatalErrors, indexPatterns, notifications]); + }, [fatalErrors, dataViews, notifications]); return indexPatternsTitles; } @@ -271,7 +273,7 @@ function useFeatures( export const EditRolePage: FunctionComponent = ({ userAPIClient, - indexPatterns, + dataViews, rolesAPIClient, indicesAPIClient, privilegesAPIClient, @@ -294,7 +296,7 @@ export const EditRolePage: FunctionComponent = ({ const { current: validator } = useRef(new RoleValidator({ shouldValidate: false })); const [formError, setFormError] = useState(null); const runAsUsers = useRunAsUsers(userAPIClient, fatalErrors); - const indexPatternsTitles = useIndexPatternsTitles(indexPatterns, fatalErrors, notifications); + const indexPatternsTitles = useIndexPatternsTitles(dataViews, fatalErrors, notifications); const privileges = usePrivileges(privilegesAPIClient, fatalErrors); const spaces = useSpaces(http, fatalErrors); const features = useFeatures(getFeatures, fatalErrors); diff --git a/x-pack/plugins/security/public/management/roles/roles_management_app.tsx b/x-pack/plugins/security/public/management/roles/roles_management_app.tsx index fb68fa7857668..3c723bdfcc988 100644 --- a/x-pack/plugins/security/public/management/roles/roles_management_app.tsx +++ b/x-pack/plugins/security/public/management/roles/roles_management_app.tsx @@ -108,7 +108,7 @@ export const rolesManagementApp = Object.freeze({ license={license} docLinks={docLinks} uiCapabilities={application.capabilities} - indexPatterns={data.indexPatterns} + dataViews={data.dataViews} history={history} spacesApiUi={spacesApiUi} /> From 8a849f503f9cdf2986e270656ef52347dd448c6c Mon Sep 17 00:00:00 2001 From: Chris Cowan Date: Tue, 1 Feb 2022 06:05:15 -0700 Subject: [PATCH 09/73] [Observability] Enable parseTechnicalFields to accept partial alert documents (#123983) Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- .../pages/alerts/components/parse_alert.ts | 16 ++++++++++------ .../common/parse_experimental_fields.ts | 13 +++++++++++-- .../common/parse_technical_fields.test.ts | 14 ++++++++++++++ .../common/parse_technical_fields.ts | 13 +++++++++++-- 4 files changed, 46 insertions(+), 10 deletions(-) diff --git a/x-pack/plugins/observability/public/pages/alerts/components/parse_alert.ts b/x-pack/plugins/observability/public/pages/alerts/components/parse_alert.ts index a938998c6f8ea..2c07aed15122e 100644 --- a/x-pack/plugins/observability/public/pages/alerts/components/parse_alert.ts +++ b/x-pack/plugins/observability/public/pages/alerts/components/parse_alert.ts @@ -23,14 +23,18 @@ export const parseAlert = (observabilityRuleTypeRegistry: ObservabilityRuleTypeRegistry) => (alert: Record): TopAlert => { const experimentalFields = Object.keys(experimentalRuleFieldMap); - const alertWithExperimentalFields = experimentalFields.reduce( - (acc, key) => ({ ...acc, [key]: alert[key] }), - {} - ); + const alertWithExperimentalFields = experimentalFields.reduce((acc, key) => { + if (alert[key]) { + return { ...acc, [key]: alert[key] }; + } + return acc; + }, {}); + const parsedFields = { - ...parseTechnicalFields(alert), - ...parseExperimentalFields(alertWithExperimentalFields), + ...parseTechnicalFields(alert, true), + ...parseExperimentalFields(alertWithExperimentalFields, true), }; + const formatter = observabilityRuleTypeRegistry.getFormatter(parsedFields[ALERT_RULE_TYPE_ID]!); const formatted = { link: undefined, diff --git a/x-pack/plugins/rule_registry/common/parse_experimental_fields.ts b/x-pack/plugins/rule_registry/common/parse_experimental_fields.ts index 9299b8eac6921..4347a7e5b8d48 100644 --- a/x-pack/plugins/rule_registry/common/parse_experimental_fields.ts +++ b/x-pack/plugins/rule_registry/common/parse_experimental_fields.ts @@ -6,6 +6,7 @@ */ import { isLeft } from 'fp-ts/lib/Either'; import { PathReporter } from 'io-ts/lib/PathReporter'; +import { pick } from 'lodash'; import { experimentalRuleFieldMap, ExperimentalRuleFieldMap, @@ -16,8 +17,16 @@ import { runtimeTypeFromFieldMap } from './field_map'; const experimentalFieldRuntimeType = runtimeTypeFromFieldMap(experimentalRuleFieldMap); -export const parseExperimentalFields = (input: unknown) => { - const validate = experimentalFieldRuntimeType.decode(input); +export const parseExperimentalFields = (input: unknown, partial = false) => { + const decodePartial = (alert: unknown) => { + const limitedFields = pick(experimentalRuleFieldMap, Object.keys(alert as object)); + const partialTechnicalFieldRuntimeType = runtimeTypeFromFieldMap( + limitedFields as unknown as ExperimentalRuleFieldMap + ); + return partialTechnicalFieldRuntimeType.decode(alert); + }; + + const validate = partial ? decodePartial(input) : experimentalFieldRuntimeType.decode(input); if (isLeft(validate)) { throw new Error(PathReporter.report(validate).join('\n')); diff --git a/x-pack/plugins/rule_registry/common/parse_technical_fields.test.ts b/x-pack/plugins/rule_registry/common/parse_technical_fields.test.ts index dfc351099b444..b292e0744a3a5 100644 --- a/x-pack/plugins/rule_registry/common/parse_technical_fields.test.ts +++ b/x-pack/plugins/rule_registry/common/parse_technical_fields.test.ts @@ -45,6 +45,20 @@ describe('parseTechnicalFields', () => { expect(() => parseTechnicalFields(ALERT_WITH_MISSING_REQUIRED_FIELDS)).toThrow(); }); + it('parses a partial alert with missing required fields without error', () => { + const ALERT_WITH_MISSING_REQUIRED_FIELDS = { + '@timestamp': ['2021-12-06T12:30:59.411Z'], + 'kibana.alert.duration.us': ['488935266000'], + 'kibana.alert.reason': ['host.uptime has reported no data over the past 1m for *'], + 'kibana.alert.workflow_status': ['open'], + 'kibana.alert.start': ['2021-11-30T20:42:04.145Z'], + 'event.action': ['active'], + 'kibana.version': ['8.1.0'], + 'event.kind': ['signal'], + }; + expect(() => parseTechnicalFields(ALERT_WITH_MISSING_REQUIRED_FIELDS, true)).not.toThrow(); + }); + it('parses an alert with missing optional fields without error', () => { const ALERT_WITH_MISSING_OPTIONAL_FIELDS = { '@timestamp': ['2021-12-06T12:30:59.411Z'], diff --git a/x-pack/plugins/rule_registry/common/parse_technical_fields.ts b/x-pack/plugins/rule_registry/common/parse_technical_fields.ts index 59a170ba3f9f6..c5b7d0425f245 100644 --- a/x-pack/plugins/rule_registry/common/parse_technical_fields.ts +++ b/x-pack/plugins/rule_registry/common/parse_technical_fields.ts @@ -7,6 +7,7 @@ import { isLeft } from 'fp-ts/lib/Either'; import { PathReporter } from 'io-ts/lib/PathReporter'; +import { pick } from 'lodash'; import { technicalRuleFieldMap, TechnicalRuleFieldMap, @@ -16,8 +17,16 @@ import { runtimeTypeFromFieldMap } from './field_map'; const technicalFieldRuntimeType = runtimeTypeFromFieldMap(technicalRuleFieldMap); -export const parseTechnicalFields = (input: unknown) => { - const validate = technicalFieldRuntimeType.decode(input); +export const parseTechnicalFields = (input: unknown, partial = false) => { + const decodePartial = (alert: unknown) => { + const limitedFields = pick(technicalRuleFieldMap, Object.keys(alert as object)); + const partialTechnicalFieldRuntimeType = runtimeTypeFromFieldMap( + limitedFields as unknown as TechnicalRuleFieldMap + ); + return partialTechnicalFieldRuntimeType.decode(alert); + }; + + const validate = partial ? decodePartial(input) : technicalFieldRuntimeType.decode(input); if (isLeft(validate)) { throw new Error(PathReporter.report(validate).join('\n')); From 0f9ab925c3aac341a2ca5719ca758f3630a52661 Mon Sep 17 00:00:00 2001 From: Alison Goryachev Date: Tue, 1 Feb 2022 08:08:39 -0500 Subject: [PATCH 10/73] [Index Management] Fix cluster_nodes API test --- .../apis/management/index_management/cluster_nodes.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/x-pack/test/api_integration/apis/management/index_management/cluster_nodes.ts b/x-pack/test/api_integration/apis/management/index_management/cluster_nodes.ts index 30c12bf33d763..e885b677aaffb 100644 --- a/x-pack/test/api_integration/apis/management/index_management/cluster_nodes.ts +++ b/x-pack/test/api_integration/apis/management/index_management/cluster_nodes.ts @@ -19,7 +19,7 @@ export default function ({ getService }: FtrProviderContext) { it('should fetch the nodes plugins', async () => { const { body } = await getNodesPlugins().expect(200); - expect(body).eql([]); + expect(Array.isArray(body)).to.be(true); }); }); } From 322c2bdb07370bf9b8b018a84b2702ce74196f80 Mon Sep 17 00:00:00 2001 From: Vadim Kibana <82822460+vadimkibana@users.noreply.github.com> Date: Tue, 1 Feb 2022 14:27:56 +0100 Subject: [PATCH 11/73] Switch transform plugin to use locators (#124123) * add navigateSync() method * deprecate discover url generator * use locators in transform plugin * update mock --- src/plugins/discover/public/index.ts | 5 ++++ src/plugins/discover/public/url_generator.ts | 9 +++++++ .../common/url_service/locators/locator.ts | 9 +++++++ .../common/url_service/locators/types.ts | 10 +++++++ src/plugins/share/public/mocks.ts | 1 + .../step_create/step_create_form.tsx | 24 ++++++----------- .../action_discover/use_action_discover.tsx | 27 ++++++------------- 7 files changed, 50 insertions(+), 35 deletions(-) diff --git a/src/plugins/discover/public/index.ts b/src/plugins/discover/public/index.ts index e7abbdfc328ab..15707e4cda284 100644 --- a/src/plugins/discover/public/index.ts +++ b/src/plugins/discover/public/index.ts @@ -28,5 +28,10 @@ export { SEARCH_EMBEDDABLE_TYPE } from './embeddable'; export { loadSharingDataHelpers } from './utils'; export type { DiscoverUrlGeneratorState } from './url_generator'; + +/** + * @deprecated + */ export { DISCOVER_APP_URL_GENERATOR } from './url_generator'; +export { DISCOVER_APP_LOCATOR } from './locator'; export type { DiscoverAppLocator, DiscoverAppLocatorParams } from './locator'; diff --git a/src/plugins/discover/public/url_generator.ts b/src/plugins/discover/public/url_generator.ts index 32e89691574df..450ad15e3598b 100644 --- a/src/plugins/discover/public/url_generator.ts +++ b/src/plugins/discover/public/url_generator.ts @@ -12,8 +12,14 @@ import { esFilters } from '../../data/public'; import { setStateToKbnUrl } from '../../kibana_utils/public'; import { VIEW_MODE } from './components/view_mode_toggle'; +/** + * @deprecated + */ export const DISCOVER_APP_URL_GENERATOR = 'DISCOVER_APP_URL_GENERATOR'; +/** + * @deprecated + */ export interface DiscoverUrlGeneratorState { /** * Optionally set saved search ID. @@ -87,6 +93,9 @@ interface Params { export const SEARCH_SESSION_ID_QUERY_PARAM = 'searchSessionId'; +/** + * @deprecated + */ export class DiscoverUrlGenerator implements UrlGeneratorsDefinition { diff --git a/src/plugins/share/common/url_service/locators/locator.ts b/src/plugins/share/common/url_service/locators/locator.ts index 2bacdd67875bd..224a6eac07e8f 100644 --- a/src/plugins/share/common/url_service/locators/locator.ts +++ b/src/plugins/share/common/url_service/locators/locator.ts @@ -118,6 +118,15 @@ export class Locator

implements LocatorPublic

{ }); } + public navigateSync(locatorParams: P, navigationParams: LocatorNavigationParams = {}): void { + this.navigate(locatorParams, navigationParams).catch((error) => { + // eslint-disable-next-line no-console + console.log(`Failed to navigate [locator = ${this.id}].`, locatorParams, navigationParams); + // eslint-disable-next-line no-console + console.error(error); + }); + } + public readonly useUrl = ( params: P, getUrlParams?: LocatorGetUrlParams, diff --git a/src/plugins/share/common/url_service/locators/types.ts b/src/plugins/share/common/url_service/locators/types.ts index c64dc588aaf22..3148c03f03c3e 100644 --- a/src/plugins/share/common/url_service/locators/types.ts +++ b/src/plugins/share/common/url_service/locators/types.ts @@ -98,6 +98,16 @@ export interface LocatorPublic

extends Persistable */ navigate(params: P, navigationParams?: LocatorNavigationParams): Promise; + /** + * Synchronous fire-and-forget navigation method. Use it when you want to + * navigate without waiting for the navigation to complete and you don't + * care to process any async promise errors. + * + * @param params URL locator parameters. + * @param navigationParams Navigation parameters. + */ + navigateSync(params: P, navigationParams?: LocatorNavigationParams): void; + /** * React hook which returns a URL string given locator parameters. Returns * empty string if URL is being loaded or an error happened. diff --git a/src/plugins/share/public/mocks.ts b/src/plugins/share/public/mocks.ts index 33cdf141de9f3..629f44840e81c 100644 --- a/src/plugins/share/public/mocks.ts +++ b/src/plugins/share/public/mocks.ts @@ -70,6 +70,7 @@ const createLocator = (): jes getRedirectUrl: jest.fn(), useUrl: jest.fn(), navigate: jest.fn(), + navigateSync: jest.fn(), extract: jest.fn(), inject: jest.fn(), telemetry: jest.fn(), diff --git a/x-pack/plugins/transform/public/app/sections/create_transform/components/step_create/step_create_form.tsx b/x-pack/plugins/transform/public/app/sections/create_transform/components/step_create/step_create_form.tsx index 728fcef23f8a0..42b50e6ef4c1f 100644 --- a/x-pack/plugins/transform/public/app/sections/create_transform/components/step_create/step_create_form.tsx +++ b/x-pack/plugins/transform/public/app/sections/create_transform/components/step_create/step_create_form.tsx @@ -26,10 +26,7 @@ import { import { FormattedMessage } from '@kbn/i18n-react'; import { toMountPoint } from '../../../../../../../../../src/plugins/kibana_react/public'; -import { - DISCOVER_APP_URL_GENERATOR, - DiscoverUrlGeneratorState, -} from '../../../../../../../../../src/plugins/discover/public'; +import { DISCOVER_APP_LOCATOR } from '../../../../../../../../../src/plugins/discover/public'; import type { PutTransformsResponseSchema } from '../../../../../../common/api_schemas/transforms'; import { @@ -96,9 +93,9 @@ export const StepCreateForm: FC = React.memo( const [discoverLink, setDiscoverLink] = useState(); const deps = useAppDependencies(); + const { share } = deps; const indexPatterns = deps.data.indexPatterns; const toastNotifications = useToastNotifications(); - const { getUrlGenerator } = deps.share.urlGenerators; const isDiscoverAvailable = deps.application.capabilities.discover?.show ?? false; useEffect(() => { @@ -107,19 +104,14 @@ export const StepCreateForm: FC = React.memo( onChange({ created, started, indexPatternId }); const getDiscoverUrl = async (): Promise => { - const state: DiscoverUrlGeneratorState = { + const locator = share.url.locators.get(DISCOVER_APP_LOCATOR); + + if (!locator) return; + + const discoverUrl = await locator.getUrl({ indexPatternId, - }; - - let discoverUrlGenerator; - try { - discoverUrlGenerator = getUrlGenerator(DISCOVER_APP_URL_GENERATOR); - } catch (error) { - // ignore error thrown when url generator is not available - return; - } + }); - const discoverUrl = await discoverUrlGenerator.createUrl(state); if (!unmounted) { setDiscoverLink(discoverUrl); } diff --git a/x-pack/plugins/transform/public/app/sections/transform_management/components/action_discover/use_action_discover.tsx b/x-pack/plugins/transform/public/app/sections/transform_management/components/action_discover/use_action_discover.tsx index 468ed0e6b892d..9b1d7ed066404 100644 --- a/x-pack/plugins/transform/public/app/sections/transform_management/components/action_discover/use_action_discover.tsx +++ b/x-pack/plugins/transform/public/app/sections/transform_management/components/action_discover/use_action_discover.tsx @@ -7,10 +7,7 @@ import React, { useCallback, useEffect, useMemo, useState } from 'react'; -import { - DiscoverUrlGeneratorState, - DISCOVER_APP_URL_GENERATOR, -} from '../../../../../../../../../src/plugins/discover/public'; +import { DISCOVER_APP_LOCATOR } from '../../../../../../../../../src/plugins/discover/public'; import { TransformListAction, TransformListRow } from '../../../../common'; @@ -29,9 +26,9 @@ const getIndexPatternTitleFromTargetIndex = (item: TransformListRow) => export type DiscoverAction = ReturnType; export const useDiscoverAction = (forceDisable: boolean) => { const appDeps = useAppDependencies(); + const { share } = appDeps; const savedObjectsClient = appDeps.savedObjects.client; const indexPatterns = appDeps.data.indexPatterns; - const { getUrlGenerator } = appDeps.share.urlGenerators; const isDiscoverAvailable = !!appDeps.application.capabilities.discover?.show; const { getIndexPatternIdByTitle, loadIndexPatterns } = useSearchItems(undefined); @@ -48,24 +45,16 @@ export const useDiscoverAction = (forceDisable: boolean) => { }, [indexPatterns, loadIndexPatterns, savedObjectsClient]); const clickHandler = useCallback( - async (item: TransformListRow) => { - let discoverUrlGenerator; - try { - discoverUrlGenerator = getUrlGenerator(DISCOVER_APP_URL_GENERATOR); - } catch (error) { - // ignore error thrown when url generator is not available - return; - } - + (item: TransformListRow) => { + const locator = share.url.locators.get(DISCOVER_APP_LOCATOR); + if (!locator) return; const indexPatternTitle = getIndexPatternTitleFromTargetIndex(item); const indexPatternId = getIndexPatternIdByTitle(indexPatternTitle); - const state: DiscoverUrlGeneratorState = { + locator.navigateSync({ indexPatternId, - }; - const path = await discoverUrlGenerator.createUrl(state); - appDeps.application.navigateToApp('discover', { path }); + }); }, - [appDeps.application, getIndexPatternIdByTitle, getUrlGenerator] + [getIndexPatternIdByTitle, share] ); const indexPatternExists = useCallback( From 268c8963154f9a1d25b87e518cb3bb8e9e6cf6cb Mon Sep 17 00:00:00 2001 From: Shahzad Date: Tue, 1 Feb 2022 14:43:56 +0100 Subject: [PATCH 12/73] [Uptime monitor management] Handle duplicate monitor name (#124005) --- .../runtime_types/monitor_management/state.ts | 2 + .../uptime/common/types/saved_objects.ts | 8 +++ x-pack/plugins/uptime/e2e/journeys/index.ts | 1 + .../e2e/journeys/monitor_name.journey.ts | 59 ++++++++++++++++ x-pack/plugins/uptime/e2e/playwright_start.ts | 3 + .../uptime/e2e/tasks/import_monitors.ts | 50 ++++++++++++++ .../uptime/e2e/tasks/uptime_monitor.ndjson | 3 + .../action_bar/action_bar.tsx | 1 + .../monitor_config/monitor_name_location.tsx | 34 ++++++--- .../monitor_config/use_monitor_name.test.tsx | 69 +++++++++++++++++++ .../monitor_config/use_monitor_name.ts | 64 +++++++++++++++++ .../uptime/public/lib/helper/rtl_helpers.tsx | 4 +- .../public/state/api/monitor_management.ts | 2 - .../synthetics_service/get_monitor.ts | 5 +- 14 files changed, 292 insertions(+), 13 deletions(-) create mode 100644 x-pack/plugins/uptime/common/types/saved_objects.ts create mode 100644 x-pack/plugins/uptime/e2e/journeys/monitor_name.journey.ts create mode 100644 x-pack/plugins/uptime/e2e/tasks/import_monitors.ts create mode 100644 x-pack/plugins/uptime/e2e/tasks/uptime_monitor.ndjson create mode 100644 x-pack/plugins/uptime/public/components/monitor_management/monitor_config/use_monitor_name.test.tsx create mode 100644 x-pack/plugins/uptime/public/components/monitor_management/monitor_config/use_monitor_name.ts diff --git a/x-pack/plugins/uptime/common/runtime_types/monitor_management/state.ts b/x-pack/plugins/uptime/common/runtime_types/monitor_management/state.ts index 27a1a59dbf0a6..1fa96451053a8 100644 --- a/x-pack/plugins/uptime/common/runtime_types/monitor_management/state.ts +++ b/x-pack/plugins/uptime/common/runtime_types/monitor_management/state.ts @@ -10,6 +10,8 @@ import * as t from 'io-ts'; export const FetchMonitorManagementListQueryArgsType = t.partial({ page: t.number, perPage: t.number, + search: t.string, + searchFields: t.array(t.string), }); export type FetchMonitorManagementListQueryArgs = t.TypeOf< diff --git a/x-pack/plugins/uptime/common/types/saved_objects.ts b/x-pack/plugins/uptime/common/types/saved_objects.ts new file mode 100644 index 0000000000000..b4baf0d48d627 --- /dev/null +++ b/x-pack/plugins/uptime/common/types/saved_objects.ts @@ -0,0 +1,8 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export const syntheticsMonitorType = 'synthetics-monitor'; diff --git a/x-pack/plugins/uptime/e2e/journeys/index.ts b/x-pack/plugins/uptime/e2e/journeys/index.ts index 941adf378ab29..5de0ddf24dc4b 100644 --- a/x-pack/plugins/uptime/e2e/journeys/index.ts +++ b/x-pack/plugins/uptime/e2e/journeys/index.ts @@ -10,3 +10,4 @@ export * from './uptime.journey'; export * from './monitor_management.journey'; export * from './step_duration.journey'; export * from './alerts'; +export * from './monitor_name.journey'; diff --git a/x-pack/plugins/uptime/e2e/journeys/monitor_name.journey.ts b/x-pack/plugins/uptime/e2e/journeys/monitor_name.journey.ts new file mode 100644 index 0000000000000..beb84a9a003a2 --- /dev/null +++ b/x-pack/plugins/uptime/e2e/journeys/monitor_name.journey.ts @@ -0,0 +1,59 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { journey, step, expect, before, Page } from '@elastic/synthetics'; +import { monitorManagementPageProvider } from '../page_objects/monitor_management'; +import { byTestId } from './utils'; + +journey(`MonitorName`, async ({ page, params }: { page: Page; params: any }) => { + const uptime = monitorManagementPageProvider({ page, kibanaUrl: params.kibanaUrl }); + + before(async () => { + await uptime.waitForLoadingToFinish(); + }); + + step('Go to monitor-management', async () => { + await uptime.navigateToMonitorManagement(); + }); + + step('login to Kibana', async () => { + await uptime.loginToKibana(); + const invalid = await page.locator(`text=Username or password is incorrect. Please try again.`); + expect(await invalid.isVisible()).toBeFalsy(); + }); + + step(`shows error if name already exists`, async () => { + await uptime.clickAddMonitor(); + await uptime.createBasicMonitorDetails({ + name: 'Test monitor', + locations: ['US Central'], + apmServiceName: 'synthetics', + }); + await uptime.fillByTestSubj('syntheticsUrlField', 'https://www.google.com'); + + await uptime.assertText({ text: 'Monitor name already exists.' }); + + expect(await page.isEnabled(byTestId('monitorTestNowRunBtn'))).toBeFalsy(); + }); + + step(`form becomes valid after change`, async () => { + await uptime.createBasicMonitorDetails({ + name: 'Test monitor 2', + locations: ['US Central'], + apmServiceName: 'synthetics', + }); + + expect(await page.isEnabled(byTestId('monitorTestNowRunBtn'))).toBeTruthy(); + }); +}); diff --git a/x-pack/plugins/uptime/e2e/playwright_start.ts b/x-pack/plugins/uptime/e2e/playwright_start.ts index 6f6bcd73e3692..b692b13f07921 100644 --- a/x-pack/plugins/uptime/e2e/playwright_start.ts +++ b/x-pack/plugins/uptime/e2e/playwright_start.ts @@ -13,6 +13,7 @@ import { esArchiverLoad, esArchiverUnload } from './tasks/es_archiver'; import './journeys'; import { createApmAndObsUsersAndRoles } from '../../apm/scripts/create_apm_users_and_roles/create_apm_users_and_roles'; +import { importMonitors } from './tasks/import_monitors'; const listOfJourneys = [ 'uptime', @@ -56,6 +57,8 @@ async function playwrightStart(getService: any, headless = true, match?: string) port: config.get('servers.kibana.port'), }); + await importMonitors({ kibanaUrl }); + await createApmAndObsUsersAndRoles({ elasticsearch: { username: 'elastic', password: 'changeme' }, kibana: { roleSuffix: 'e2e', hostname: kibanaUrl }, diff --git a/x-pack/plugins/uptime/e2e/tasks/import_monitors.ts b/x-pack/plugins/uptime/e2e/tasks/import_monitors.ts new file mode 100644 index 0000000000000..caa3ccac4118c --- /dev/null +++ b/x-pack/plugins/uptime/e2e/tasks/import_monitors.ts @@ -0,0 +1,50 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import axios from 'axios'; +import path from 'path'; +import FormData from 'form-data'; +import * as fs from 'fs'; + +export const importMonitors = async ({ + kibanaUrl, + username, + password, +}: { + kibanaUrl: string; + username?: string; + password?: string; +}) => { + // eslint-disable-next-line no-console + console.log('Loading sample monitors'); + + const form = new FormData(); + + const file = fs.readFileSync(path.join(__dirname, './uptime_monitor.ndjson')); + + form.append('file', file, 'uptime_monitor.ndjson'); + + try { + axios + .request({ + method: 'post', + url: kibanaUrl + '/api/saved_objects/_import?overwrite=true', + auth: { username: username ?? 'elastic', password: password ?? 'changeme' }, + headers: { 'kbn-xsrf': 'true', ...form.getHeaders() }, + data: form, + }) + .then(({ data }) => { + if (data.successCount === 2) { + // eslint-disable-next-line no-console + console.log('Successfully imported 2 monitors'); + } + }); + } catch (e) { + // eslint-disable-next-line no-console + console.log(e); + } +}; diff --git a/x-pack/plugins/uptime/e2e/tasks/uptime_monitor.ndjson b/x-pack/plugins/uptime/e2e/tasks/uptime_monitor.ndjson new file mode 100644 index 0000000000000..e0088725d6e69 --- /dev/null +++ b/x-pack/plugins/uptime/e2e/tasks/uptime_monitor.ndjson @@ -0,0 +1,3 @@ +{"attributes":{"__ui":{"is_tls_enabled":false,"is_zip_url_tls_enabled":false},"check.request.body":{"type":"text","value":""},"check.request.headers":{},"check.request.method":"GET","check.response.body.negative":[],"check.response.body.positive":[],"check.response.headers":{},"check.response.status":[],"enabled":true,"locations":[{"geo":{"lat":41.25,"lon":-95.86},"id":"us_central","label":"US Central","url":"https://us-central.synthetics.elastic.dev"}],"max_redirects":"0","name":"Test Monitor","password":"4SdnK70F8YLqril8Mh5qVveP","proxy_url":"","response.include_body":"on_error","response.include_headers":true,"schedule":{"number":"3","unit":"m"},"service.name":"","tags":[],"timeout":"16","type":"http","urls":"https://www.google.com","username":""},"coreMigrationVersion":"8.1.0","id":"832b9980-7fba-11ec-b360-25a79ce3f496","references":[],"sort":[1643319958480,20371],"type":"synthetics-monitor","updated_at":"2022-01-27T21:45:58.480Z","version":"WzExOTg3ODYsMl0="} +{"attributes":{"__ui":{"is_tls_enabled":false,"is_zip_url_tls_enabled":false},"check.request.body":{"type":"text","value":""},"check.request.headers":{},"check.request.method":"GET","check.response.body.negative":[],"check.response.body.positive":[],"check.response.headers":{},"check.response.status":[],"enabled":true,"locations":[{"geo":{"lat":41.25,"lon":-95.86},"id":"us_central","label":"US Central","url":"https://us-central.synthetics.elastic.dev"}],"max_redirects":"0","name":"Test Monito","password":"4SdnK70F8YLqril8Mh5qVveP","proxy_url":"","response.include_body":"on_error","response.include_headers":true,"schedule":{"number":"3","unit":"m"},"service.name":"","tags":[],"timeout":"16","type":"http","urls":"https://www.google.com","username":""},"coreMigrationVersion":"8.1.0","id":"b28380d0-7fba-11ec-b360-25a79ce3f496","references":[],"sort":[1643320037906,20374],"type":"synthetics-monitor","updated_at":"2022-01-27T21:47:17.906Z","version":"WzExOTg4MDAsMl0="} +{"excludedObjects":[],"excludedObjectsCount":0,"exportedCount":2,"missingRefCount":0,"missingReferences":[]} \ No newline at end of file diff --git a/x-pack/plugins/uptime/public/components/monitor_management/action_bar/action_bar.tsx b/x-pack/plugins/uptime/public/components/monitor_management/action_bar/action_bar.tsx index 6321688d92c4c..8c9dc7ffe6275 100644 --- a/x-pack/plugins/uptime/public/components/monitor_management/action_bar/action_bar.tsx +++ b/x-pack/plugins/uptime/public/components/monitor_management/action_bar/action_bar.tsx @@ -110,6 +110,7 @@ export const ActionBar = ({ monitor, isValid, onSave, onTestNow, testRun }: Acti iconType="play" onClick={() => onTestNow()} disabled={!isValid} + data-test-subj={'monitorTestNowRunBtn'} > {testRun ? RE_RUN_TEST_LABEL : RUN_TEST_LABEL} diff --git a/x-pack/plugins/uptime/public/components/monitor_management/monitor_config/monitor_name_location.tsx b/x-pack/plugins/uptime/public/components/monitor_management/monitor_config/monitor_name_location.tsx index 11c7862b32cc5..b5a4c7c4f7b0f 100644 --- a/x-pack/plugins/uptime/public/components/monitor_management/monitor_config/monitor_name_location.tsx +++ b/x-pack/plugins/uptime/public/components/monitor_management/monitor_config/monitor_name_location.tsx @@ -5,13 +5,15 @@ * 2.0. */ -import React from 'react'; +import React, { useEffect, useState } from 'react'; +import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; import { EuiFormRow, EuiFieldText } from '@elastic/eui'; import { ConfigKey } from '../../../../common/runtime_types'; import { Validation } from '../../../../common/types'; import { usePolicyConfigContext } from '../../fleet_package/contexts'; import { ServiceLocations } from './locations'; +import { useMonitorName } from './use_monitor_name'; interface Props { validate: Validation; @@ -24,6 +26,14 @@ export const MonitorNameAndLocation = ({ validate }: Props) => { [ConfigKey.LOCATIONS]: locations, }); + const [localName, setLocalName] = useState(name); + + const { validName, nameAlreadyExists } = useMonitorName({ search: localName }); + + useEffect(() => { + setName(validName); + }, [setName, validName]); + return ( <> { /> } fullWidth={true} - isInvalid={isNameInvalid} + isInvalid={isNameInvalid || nameAlreadyExists} error={ - + nameAlreadyExists ? ( + NAME_ALREADY_EXISTS + ) : ( + + ) } > setName(event.target.value)} + onChange={(event) => setLocalName(event.target.value)} data-test-subj="monitorManagementMonitorName" /> @@ -61,3 +75,7 @@ export const MonitorNameAndLocation = ({ validate }: Props) => { ); }; + +const NAME_ALREADY_EXISTS = i18n.translate('xpack.uptime.monitorManagement.duplicateNameError', { + defaultMessage: 'Monitor name already exists.', +}); diff --git a/x-pack/plugins/uptime/public/components/monitor_management/monitor_config/use_monitor_name.test.tsx b/x-pack/plugins/uptime/public/components/monitor_management/monitor_config/use_monitor_name.test.tsx new file mode 100644 index 0000000000000..f1d2d9d470cfe --- /dev/null +++ b/x-pack/plugins/uptime/public/components/monitor_management/monitor_config/use_monitor_name.test.tsx @@ -0,0 +1,69 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { defaultCore, WrappedHelper } from '../../../lib/helper/rtl_helpers'; +import { renderHook } from '@testing-library/react-hooks'; +import { useMonitorName } from './use_monitor_name'; + +import * as hooks from '../../../hooks/use_monitor'; + +describe('useMonitorName', () => { + it('returns expected results', () => { + const { result } = renderHook(() => useMonitorName({}), { wrapper: WrappedHelper }); + + expect(result.current).toStrictEqual({ nameAlreadyExists: false, validName: '' }); + expect(defaultCore.savedObjects.client.find).toHaveBeenCalledWith({ + aggs: { + monitorNames: { terms: { field: 'synthetics-monitor.attributes.name', size: 10000 } }, + }, + perPage: 0, + type: 'synthetics-monitor', + }); + }); + + it('returns expected results after data', async () => { + defaultCore.savedObjects.client.find = jest.fn().mockReturnValue({ + aggregations: { + monitorNames: { + buckets: [{ key: 'Test' }, { key: 'Test 1' }], + }, + }, + }); + + const { result, waitForNextUpdate } = renderHook(() => useMonitorName({ search: 'Test' }), { + wrapper: WrappedHelper, + }); + + expect(result.current).toStrictEqual({ nameAlreadyExists: false, validName: 'Test' }); + + await waitForNextUpdate(); + + expect(result.current).toStrictEqual({ nameAlreadyExists: true, validName: '' }); + }); + + it('returns expected results after data while editing monitor', async () => { + defaultCore.savedObjects.client.find = jest.fn().mockReturnValue({ + aggregations: { + monitorNames: { + buckets: [{ key: 'Test' }, { key: 'Test 1' }], + }, + }, + }); + + jest.spyOn(hooks, 'useMonitorId').mockReturnValue('test-id'); + + const { result, waitForNextUpdate } = renderHook(() => useMonitorName({ search: 'Test' }), { + wrapper: WrappedHelper, + }); + + expect(result.current).toStrictEqual({ nameAlreadyExists: false, validName: 'Test' }); + + await waitForNextUpdate(); + + expect(result.current).toStrictEqual({ nameAlreadyExists: false, validName: 'Test' }); + }); +}); diff --git a/x-pack/plugins/uptime/public/components/monitor_management/monitor_config/use_monitor_name.ts b/x-pack/plugins/uptime/public/components/monitor_management/monitor_config/use_monitor_name.ts new file mode 100644 index 0000000000000..f37bd94944b92 --- /dev/null +++ b/x-pack/plugins/uptime/public/components/monitor_management/monitor_config/use_monitor_name.ts @@ -0,0 +1,64 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { useEffect, useState } from 'react'; +import { useFetcher } from '../../../../../observability/public'; +import { useKibana } from '../../../../../../../src/plugins/kibana_react/public'; +import { syntheticsMonitorType } from '../../../../common/types/saved_objects'; +import { useMonitorId } from '../../../hooks'; + +interface AggsResponse { + monitorNames: { + buckets: Array<{ + key: string; + }>; + }; +} + +export const useMonitorName = ({ search = '' }: { search?: string }) => { + const [values, setValues] = useState([]); + + const monitorId = useMonitorId(); + + const { savedObjects } = useKibana().services; + + const { data } = useFetcher(() => { + const aggs = { + monitorNames: { + terms: { + field: `${syntheticsMonitorType}.attributes.name`, + size: 10000, + }, + }, + }; + return savedObjects?.client.find({ + type: syntheticsMonitorType, + perPage: 0, + aggs, + }); + }, []); + + useEffect(() => { + if (data?.aggregations) { + const newValues = (data.aggregations as AggsResponse)?.monitorNames.buckets.map(({ key }) => + key.toLowerCase() + ); + if (monitorId && newValues.includes(search.toLowerCase())) { + setValues(newValues.filter((val) => val !== search.toLowerCase())); + } else { + setValues(newValues); + } + } + // eslint-disable-next-line react-hooks/exhaustive-deps + }, [data, monitorId]); + + const hasMonitor = Boolean( + search && values && values.length > 0 && values?.includes(search.trim().toLowerCase()) + ); + + return { nameAlreadyExists: hasMonitor, validName: hasMonitor ? '' : search }; +}; diff --git a/x-pack/plugins/uptime/public/lib/helper/rtl_helpers.tsx b/x-pack/plugins/uptime/public/lib/helper/rtl_helpers.tsx index 799c5350c6451..187ed52a05855 100644 --- a/x-pack/plugins/uptime/public/lib/helper/rtl_helpers.tsx +++ b/x-pack/plugins/uptime/public/lib/helper/rtl_helpers.tsx @@ -101,8 +101,8 @@ const mockAppUrls: Record = { }; /* default mock core */ -const defaultCore = coreMock.createStart(); -const mockCore: () => Partial = () => { +export const defaultCore = coreMock.createStart(); +export const mockCore: () => Partial = () => { const core: Partial = { ...defaultCore, application: { diff --git a/x-pack/plugins/uptime/public/state/api/monitor_management.ts b/x-pack/plugins/uptime/public/state/api/monitor_management.ts index ee2e376990d2d..06a49df596d13 100644 --- a/x-pack/plugins/uptime/public/state/api/monitor_management.ts +++ b/x-pack/plugins/uptime/public/state/api/monitor_management.ts @@ -17,7 +17,6 @@ import { import { SyntheticsMonitorSavedObject } from '../../../common/types'; import { apiService } from './utils'; -// TODO: Type the return type from runtime types export const setMonitor = async ({ monitor, id, @@ -32,7 +31,6 @@ export const setMonitor = async ({ } }; -// TODO, change to monitor runtime type export const getMonitor = async ({ id }: { id: string }): Promise => { return await apiService.get(`${API_URLS.SYNTHETICS_MONITORS}/${id}`); }; diff --git a/x-pack/plugins/uptime/server/rest_api/synthetics_service/get_monitor.ts b/x-pack/plugins/uptime/server/rest_api/synthetics_service/get_monitor.ts index cfe409c9f06bd..c35e1a33ed215 100644 --- a/x-pack/plugins/uptime/server/rest_api/synthetics_service/get_monitor.ts +++ b/x-pack/plugins/uptime/server/rest_api/synthetics_service/get_monitor.ts @@ -41,10 +41,12 @@ export const getAllSyntheticsMonitorRoute: UMRestApiRouteFactory = () => ({ query: schema.object({ page: schema.maybe(schema.number()), perPage: schema.maybe(schema.number()), + search: schema.maybe(schema.string()), }), }, handler: async ({ request, savedObjectsClient }): Promise => { - const { perPage = 50, page } = request.query; + const { perPage = 50, page, search } = request.query; + // TODO: add query/filtering params const { saved_objects: monitors, @@ -54,6 +56,7 @@ export const getAllSyntheticsMonitorRoute: UMRestApiRouteFactory = () => ({ type: syntheticsMonitorType, perPage, page, + filter: search ? `${syntheticsMonitorType}.attributes.name: ${search}` : '', }); return { ...rest, From 934302d5b1a030ccb14e7047405838f22f6431ff Mon Sep 17 00:00:00 2001 From: Matthew Kime Date: Tue, 1 Feb 2022 07:44:55 -0600 Subject: [PATCH 13/73] [data views] Reduce deprecated api usage (#124059) * address deprecated apis * lint fixes * remove iindexpattern usage Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- packages/kbn-optimizer/limits.yml | 2 +- src/plugins/data/common/index.ts | 2 -- src/plugins/data/common/kbn_field_types/index.ts | 15 +-------------- src/plugins/data/public/index.ts | 9 +-------- src/plugins/data/server/index.ts | 2 +- .../data_view_editor_flyout_content.tsx | 6 +++--- .../data_view_flyout_content_container.tsx | 6 +++--- .../data_view_editor/public/shared_imports.ts | 2 +- .../field_format_editor/field_format_editor.tsx | 2 +- .../scripted_field_table.test.tsx | 14 +++++++------- .../data_views/common/data_views/data_views.ts | 8 +------- src/plugins/data_views/common/fields/types.ts | 2 +- src/plugins/data_views/common/index.ts | 4 ++-- src/plugins/data_views/public/index.ts | 1 + .../server/deprecations/scripted_fields.ts | 4 ++-- src/plugins/data_views/server/utils.ts | 8 ++++---- 16 files changed, 30 insertions(+), 57 deletions(-) diff --git a/packages/kbn-optimizer/limits.yml b/packages/kbn-optimizer/limits.yml index 5ad540f982d61..3e5b2c77d1839 100644 --- a/packages/kbn-optimizer/limits.yml +++ b/packages/kbn-optimizer/limits.yml @@ -112,7 +112,7 @@ pageLoadAssetSize: uiActionsEnhanced: 38494 urlDrilldown: 30063 dataViewEditor: 12000 - dataViewFieldEditor: 20000 + dataViewFieldEditor: 27000 dataViewManagement: 5000 reporting: 57003 visTypeHeatmap: 25340 diff --git a/src/plugins/data/common/index.ts b/src/plugins/data/common/index.ts index 9a58b73d2c49c..404249d56d638 100644 --- a/src/plugins/data/common/index.ts +++ b/src/plugins/data/common/index.ts @@ -54,7 +54,6 @@ export type { export type { IndexPatternsContract, DataViewsContract, - IndexPatternListItem, DataViewListItem, } from '../../data_views/common'; export { @@ -68,7 +67,6 @@ export { DataViewField, IndexPatternField, DataViewType, - IndexPatternType, IndexPatternsService, DataViewsService, IndexPattern, diff --git a/src/plugins/data/common/kbn_field_types/index.ts b/src/plugins/data/common/kbn_field_types/index.ts index 26fd3abd232d4..f01401948dec8 100644 --- a/src/plugins/data/common/kbn_field_types/index.ts +++ b/src/plugins/data/common/kbn_field_types/index.ts @@ -8,19 +8,12 @@ // NOTE: trick to mark exports as deprecated (only for constants and types, but not for interfaces, classes or enums) import { - castEsToKbnFieldTypeName as oldCastEsToKbnFieldTypeName, getFilterableKbnTypeNames as oldGetFilterableKbnTypeNames, getKbnFieldType as oldGetKbnFieldType, getKbnTypeNames as oldGetKbnTypeNames, KbnFieldType, } from '@kbn/field-types'; -/** - * @deprecated Import from the "@kbn/field-types" package directly instead. - * @removeBy 8.1 - */ -const castEsToKbnFieldTypeName = oldCastEsToKbnFieldTypeName; - /** * @deprecated Import from the "@kbn/field-types" package directly instead. * @removeBy 8.1 @@ -39,10 +32,4 @@ const getKbnFieldType = oldGetKbnFieldType; */ const getKbnTypeNames = oldGetKbnTypeNames; -export { - castEsToKbnFieldTypeName, - getKbnFieldType, - getKbnTypeNames, - getFilterableKbnTypeNames, - KbnFieldType, -}; +export { getKbnFieldType, getKbnTypeNames, getFilterableKbnTypeNames, KbnFieldType }; diff --git a/src/plugins/data/public/index.ts b/src/plugins/data/public/index.ts index ec380a0845985..7037af5ce54b1 100644 --- a/src/plugins/data/public/index.ts +++ b/src/plugins/data/public/index.ts @@ -82,7 +82,6 @@ export type { IndexPatternLoadExpressionFunctionDefinition, GetFieldsOptions, AggregationRestrictions, - IndexPatternListItem, DataViewListItem, } from '../common'; export { @@ -90,7 +89,6 @@ export { KBN_FIELD_TYPES, UI_SETTINGS, fieldList, - IndexPatternType, DuplicateDataViewError, } from '../common'; @@ -295,12 +293,7 @@ export type { export type { AggsStart } from './search/aggs'; -export { - getTime, - // kbn field types - castEsToKbnFieldTypeName, - getKbnTypeNames, -} from '../common'; +export { getTime, getKbnTypeNames } from '../common'; export { isTimeRange, isQuery } from '../common'; diff --git a/src/plugins/data/server/index.ts b/src/plugins/data/server/index.ts index 939d4a9fa3237..87c41cf76a359 100644 --- a/src/plugins/data/server/index.ts +++ b/src/plugins/data/server/index.ts @@ -106,7 +106,7 @@ export const search = { */ export type { TimeRange } from '../common'; -export { castEsToKbnFieldTypeName, getTime, parseInterval } from '../common'; +export { getTime, parseInterval } from '../common'; /** * Static code to be shared externally diff --git a/src/plugins/data_view_editor/public/components/data_view_editor_flyout_content.tsx b/src/plugins/data_view_editor/public/components/data_view_editor_flyout_content.tsx index 3c62d6f5eb8c4..c28b03de77adc 100644 --- a/src/plugins/data_view_editor/public/components/data_view_editor_flyout_content.tsx +++ b/src/plugins/data_view_editor/public/components/data_view_editor_flyout_content.tsx @@ -13,7 +13,7 @@ import memoizeOne from 'memoize-one'; import { DataViewField } from '../../../data_views/public'; import { - IndexPatternSpec, + DataViewSpec, Form, useForm, useFormData, @@ -51,7 +51,7 @@ export interface Props { /** * Handler for the "save" footer button */ - onSave: (indexPatternSpec: IndexPatternSpec) => void; + onSave: (indexPatternSpec: DataViewSpec) => void; /** * Handler for the "cancel" footer button */ @@ -84,7 +84,7 @@ const IndexPatternEditorFlyoutContentComponent = ({ return; } - const indexPatternStub: IndexPatternSpec = { + const indexPatternStub: DataViewSpec = { title: formData.title, timeFieldName: formData.timestampField?.value, id: formData.id, diff --git a/src/plugins/data_view_editor/public/components/data_view_flyout_content_container.tsx b/src/plugins/data_view_editor/public/components/data_view_flyout_content_container.tsx index bf42582db8e3f..2fe95d753bb09 100644 --- a/src/plugins/data_view_editor/public/components/data_view_flyout_content_container.tsx +++ b/src/plugins/data_view_editor/public/components/data_view_flyout_content_container.tsx @@ -9,7 +9,7 @@ import React from 'react'; import { i18n } from '@kbn/i18n'; -import { IndexPatternSpec, useKibana } from '../shared_imports'; +import { DataViewSpec, useKibana } from '../shared_imports'; import { IndexPatternEditorFlyoutContent } from './data_view_editor_flyout_content'; import { DataViewEditorContext, DataViewEditorProps } from '../types'; @@ -23,9 +23,9 @@ const IndexPatternFlyoutContentContainer = ({ services: { dataViews, notifications }, } = useKibana(); - const onSaveClick = async (indexPatternSpec: IndexPatternSpec) => { + const onSaveClick = async (dataViewSpec: DataViewSpec) => { try { - const indexPattern = await dataViews.createAndSave(indexPatternSpec); + const indexPattern = await dataViews.createAndSave(dataViewSpec); const message = i18n.translate('indexPatternEditor.saved', { defaultMessage: "Saved '{indexPatternTitle}'", diff --git a/src/plugins/data_view_editor/public/shared_imports.ts b/src/plugins/data_view_editor/public/shared_imports.ts index 02204bb1c176f..cca695bc9a95e 100644 --- a/src/plugins/data_view_editor/public/shared_imports.ts +++ b/src/plugins/data_view_editor/public/shared_imports.ts @@ -8,11 +8,11 @@ export type { DataPublicPluginStart, - IndexPatternSpec, GetFieldsOptions, IndexPatternAggRestrictions, } from '../../data/public'; export { IndexPattern, IndexPatternField } from '../../data/public'; +export type { DataViewSpec } from '../../data_views/public'; export { DataView } from '../../data_views/public'; export { diff --git a/src/plugins/data_view_field_editor/public/components/field_format_editor/field_format_editor.tsx b/src/plugins/data_view_field_editor/public/components/field_format_editor/field_format_editor.tsx index 3879abeab2f58..c55385e152bcf 100644 --- a/src/plugins/data_view_field_editor/public/components/field_format_editor/field_format_editor.tsx +++ b/src/plugins/data_view_field_editor/public/components/field_format_editor/field_format_editor.tsx @@ -19,7 +19,7 @@ import { } from 'src/plugins/data/public'; import type { FieldFormatInstanceType } from 'src/plugins/field_formats/common'; import { CoreStart } from 'src/core/public'; -import { castEsToKbnFieldTypeName } from '../../../../data/public'; +import { castEsToKbnFieldTypeName } from '@kbn/field-types'; import { FormatEditor } from './format_editor'; import { FormatEditorServiceStart } from '../../service'; import { FieldFormatConfig } from '../../types'; diff --git a/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_field_table.test.tsx b/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_field_table.test.tsx index d797da7221575..aa74ae8c78fae 100644 --- a/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_field_table.test.tsx +++ b/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_field_table.test.tsx @@ -10,7 +10,7 @@ import React from 'react'; import { shallow, ShallowWrapper } from 'enzyme'; import { ScriptedFieldsTable } from '../scripted_fields_table'; -import { IIndexPattern, IndexPattern } from '../../../../../../plugins/data/common'; +import { DataView } from '../../../../../../plugins/data_views/public'; jest.mock('@elastic/eui', () => ({ EuiTitle: 'eui-title', @@ -40,10 +40,10 @@ const helpers = { getRouteHref: () => '#', }; -const getIndexPatternMock = (mockedFields: any = {}) => ({ ...mockedFields } as IIndexPattern); +const getIndexPatternMock = (mockedFields: any = {}) => ({ ...mockedFields } as DataView); describe('ScriptedFieldsTable', () => { - let indexPattern: IndexPattern; + let indexPattern: DataView; beforeEach(() => { indexPattern = getIndexPatternMock({ @@ -56,7 +56,7 @@ describe('ScriptedFieldsTable', () => { script: 'z++', }, ], - }) as IndexPattern; + }) as DataView; }); test('should render normally', async () => { @@ -112,7 +112,7 @@ describe('ScriptedFieldsTable', () => { { isUserEditable: true, name: 'JustATest', lang: 'painless', script: 'z++' }, { isUserEditable: true, name: 'Bad', lang: 'somethingElse', script: 'z++' }, ], - }) as IndexPattern + }) as DataView } painlessDocLink={'painlessDoc'} helpers={helpers} @@ -137,7 +137,7 @@ describe('ScriptedFieldsTable', () => { indexPattern={ getIndexPatternMock({ getScriptedFields: () => [], - }) as IndexPattern + }) as DataView } painlessDocLink={'painlessDoc'} helpers={helpers} @@ -184,7 +184,7 @@ describe('ScriptedFieldsTable', () => { { ...indexPattern, removeScriptedField, - } as unknown as IndexPattern + } as unknown as DataView } helpers={helpers} painlessDocLink={'painlessDoc'} diff --git a/src/plugins/data_views/common/data_views/data_views.ts b/src/plugins/data_views/common/data_views/data_views.ts index 26e1683b60006..ddd7989eb5990 100644 --- a/src/plugins/data_views/common/data_views/data_views.ts +++ b/src/plugins/data_views/common/data_views/data_views.ts @@ -53,12 +53,6 @@ export interface DataViewListItem { typeMeta?: TypeMeta; } -/** - * @deprecated Use DataViewListItem. All index pattern interfaces were renamed. - */ - -export type IndexPatternListItem = DataViewListItem; - export interface DataViewsServiceDeps { uiSettings: UiSettingsCommon; savedObjectsClient: SavedObjectsClientCommon; @@ -173,7 +167,7 @@ export class DataViewsService { * Get list of index pattern ids with titles * @param refresh Force refresh of index pattern list */ - getIdsWithTitle = async (refresh: boolean = false): Promise => { + getIdsWithTitle = async (refresh: boolean = false): Promise => { if (!this.savedObjectsCache || refresh) { await this.refreshSavedObjectsCache(); } diff --git a/src/plugins/data_views/common/fields/types.ts b/src/plugins/data_views/common/fields/types.ts index 2bd1cf5834548..b68f5db4f2cdc 100644 --- a/src/plugins/data_views/common/fields/types.ts +++ b/src/plugins/data_views/common/fields/types.ts @@ -10,7 +10,7 @@ import { FieldSpec, DataView } from '..'; /** * @deprecated Use {@link IndexPatternField} - * @removeBy 8.1 + * @removeBy 8.2 */ export interface IFieldType extends DataViewFieldBase { count?: number; diff --git a/src/plugins/data_views/common/index.ts b/src/plugins/data_views/common/index.ts index 7253091e8115b..4de8e98acef39 100644 --- a/src/plugins/data_views/common/index.ts +++ b/src/plugins/data_views/common/index.ts @@ -54,10 +54,10 @@ export type { IndexPatternSpec, SourceFilter, } from './types'; -export { DataViewType, IndexPatternType } from './types'; +export { DataViewType } from './types'; export type { IndexPatternsContract, DataViewsContract } from './data_views'; export { IndexPatternsService, DataViewsService } from './data_views'; -export type { IndexPatternListItem, DataViewListItem, TimeBasedDataView } from './data_views'; +export type { DataViewListItem, TimeBasedDataView } from './data_views'; export { IndexPattern, DataView } from './data_views'; export { DuplicateDataViewError, diff --git a/src/plugins/data_views/public/index.ts b/src/plugins/data_views/public/index.ts index 9cb07d4f3c54f..11b3edaa09628 100644 --- a/src/plugins/data_views/public/index.ts +++ b/src/plugins/data_views/public/index.ts @@ -16,6 +16,7 @@ export { export { onRedirectNoIndexPattern } from './data_views'; export type { IIndexPatternFieldList, TypeMeta } from '../common'; +export type { DataViewSpec } from '../common'; export { IndexPatternField, DataViewField, DataViewType, META_FIELDS } from '../common'; export type { IndexPatternsContract } from './data_views'; diff --git a/src/plugins/data_views/server/deprecations/scripted_fields.ts b/src/plugins/data_views/server/deprecations/scripted_fields.ts index 684115a19299a..0d668466ff099 100644 --- a/src/plugins/data_views/server/deprecations/scripted_fields.ts +++ b/src/plugins/data_views/server/deprecations/scripted_fields.ts @@ -13,9 +13,9 @@ import { RegisterDeprecationsConfig, } from 'kibana/server'; import { i18n } from '@kbn/i18n'; -import { IndexPatternAttributes } from '../../common'; +import { DataViewAttributes } from '../../common'; -type IndexPatternAttributesWithFields = Pick; +type IndexPatternAttributesWithFields = Pick; export const createScriptedFieldsDeprecationsConfig: ( core: CoreSetup diff --git a/src/plugins/data_views/server/utils.ts b/src/plugins/data_views/server/utils.ts index bb7d23f832233..a3b6aeb5e8c26 100644 --- a/src/plugins/data_views/server/utils.ts +++ b/src/plugins/data_views/server/utils.ts @@ -10,13 +10,13 @@ import { SavedObjectsClientContract } from 'kibana/server'; import { IFieldType, DATA_VIEW_SAVED_OBJECT_TYPE, - IndexPatternAttributes, + DataViewAttributes, SavedObject, } from '../common'; export const getFieldByName = ( fieldName: string, - indexPattern: SavedObject + indexPattern: SavedObject ): IFieldType | undefined => { const fields: IFieldType[] = indexPattern && JSON.parse(indexPattern.attributes.fields); const field = fields && fields.find((f) => f.name === fieldName); @@ -27,8 +27,8 @@ export const getFieldByName = ( export const findIndexPatternById = async ( savedObjectsClient: SavedObjectsClientContract, index: string -): Promise | undefined> => { - const savedObjectsResponse = await savedObjectsClient.find({ +): Promise | undefined> => { + const savedObjectsResponse = await savedObjectsClient.find({ type: DATA_VIEW_SAVED_OBJECT_TYPE, fields: ['fields'], search: `"${index}"`, From d862d9bf8f545226452811dd7f5225913ab8f9db Mon Sep 17 00:00:00 2001 From: Pablo Machado Date: Tue, 1 Feb 2022 14:47:38 +0100 Subject: [PATCH 14/73] Add host risk tab to Hosts page (#122980) * Add host risk tab to Hosts page Co-authored-by: Steph Milovic Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- .../security_solution/hosts/common/index.ts | 19 + .../hosts/kpi/risky_hosts/index.ts | 2 +- .../hosts/risk_score/index.ts | 17 +- .../integration/host_details/risk_tab.ts | 52 + .../integration/hosts/host_risk_tab.spec.ts | 43 + .../integration/hosts/risky_hosts_kpi.spec.ts | 20 - .../cypress/screens/hosts/host_risk.ts | 12 +- .../cti_details/host_risk_summary.tsx | 14 +- .../cti_details/threat_summary_view.tsx | 2 +- .../event_details/event_details.tsx | 4 +- .../__snapshots__/index.test.tsx.snap | 1 + .../components/header_section/index.tsx | 12 +- .../public/common/components/link_to/index.ts | 2 +- .../public/common/components/links/index.tsx | 23 +- .../common/components/page/manage_query.tsx | 65 +- .../components/paginated_table/index.tsx | 13 +- .../common/containers/hosts_risk/types.ts | 9 + .../hosts_risk/use_hosts_risk_score.ts | 150 -- .../use_hosts_risk_score_complete.ts | 63 - .../public/common/mock/global_state.ts | 15 +- .../rules/all/use_columns.tsx | 42 +- .../security_solution/public/helper_hooks.tsx | 21 + .../components/common/host_risk_score.tsx | 54 +- .../host_risk_information/index.tsx | 24 +- .../host_risk_score_table/columns.tsx | 112 ++ .../host_risk_score_table/index.tsx | 194 ++ .../host_risk_score_table/severity_badges.tsx | 52 + .../host_risk_score_table/severity_bar.tsx | 58 + .../severity_filter_group.tsx | 128 ++ .../host_risk_score_table/translations.ts | 47 + .../host_score_over_time/index.test.tsx | 18 +- .../components/host_score_over_time/index.tsx | 60 +- .../hosts/components/hosts_table/columns.tsx | 19 +- .../components/hosts_table/index.test.tsx | 6 + .../hosts/components/hosts_table/index.tsx | 25 +- .../components/hosts_table/translations.ts | 4 + .../hosts/components/kpi_hosts/index.tsx | 41 +- .../kpi_hosts/risky_hosts/index.tsx | 6 + .../index.test.tsx | 66 +- .../top_host_score_contributors/index.tsx | 61 +- .../containers/host_risk_score/index.tsx | 223 +++ .../host_risk_score/translations.ts | 22 + .../kpi_hosts/risky_hosts/index.tsx | 52 +- .../hosts/pages/details/details_tabs.test.tsx | 6 + .../public/hosts/pages/hosts.tsx | 25 +- .../public/hosts/pages/hosts_tabs.tsx | 4 + .../public/hosts/pages/index.tsx | 1 + .../public/hosts/pages/nav_tabs.test.tsx | 21 +- .../public/hosts/pages/nav_tabs.tsx | 22 +- .../navigation/host_risk_score_tab_body.tsx | 75 + .../pages/navigation/host_risk_tab_body.tsx | 22 +- .../public/hosts/pages/navigation/index.ts | 1 + .../public/hosts/pages/translations.ts | 2 +- .../public/hosts/store/actions.ts | 16 +- .../public/hosts/store/helpers.test.ts | 44 +- .../public/hosts/store/helpers.ts | 25 + .../public/hosts/store/model.ts | 13 +- .../public/hosts/store/reducer.ts | 51 +- .../public/hosts/store/selectors.ts | 6 + .../components/host_overview/index.test.tsx | 48 +- .../components/host_overview/index.tsx | 11 +- .../overview_risky_host_links/index.test.tsx | 34 +- .../overview_risky_host_links/index.tsx | 34 +- .../risky_hosts_enabled_module.test.tsx | 28 +- .../risky_hosts_enabled_module.tsx | 8 +- .../public/overview/pages/overview.test.tsx | 12 +- .../public/overview/pages/overview.tsx | 2 + .../__snapshots__/index.test.tsx.snap | 1563 +++++++++++++++++ .../event_details/expandable_event.tsx | 2 +- .../side_panel/event_details/index.tsx | 17 +- .../components/side_panel/index.test.tsx | 1544 +--------------- .../factory/hosts/kpi/risky_hosts/index.ts | 2 +- .../query.hosts_kpi_risky_hosts.dsl.ts | 26 +- .../factory/hosts/risk_score/index.ts | 13 +- .../hosts/risk_score/query.hosts_risk.dsl.ts | 57 +- .../translations/translations/ja-JP.json | 1 - .../translations/translations/zh-CN.json | 1 - 77 files changed, 3472 insertions(+), 2138 deletions(-) create mode 100644 x-pack/plugins/security_solution/cypress/integration/host_details/risk_tab.ts create mode 100644 x-pack/plugins/security_solution/cypress/integration/hosts/host_risk_tab.spec.ts delete mode 100644 x-pack/plugins/security_solution/cypress/integration/hosts/risky_hosts_kpi.spec.ts delete mode 100644 x-pack/plugins/security_solution/public/common/containers/hosts_risk/use_hosts_risk_score.ts delete mode 100644 x-pack/plugins/security_solution/public/common/containers/hosts_risk/use_hosts_risk_score_complete.ts create mode 100644 x-pack/plugins/security_solution/public/helper_hooks.tsx create mode 100644 x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/columns.tsx create mode 100644 x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/index.tsx create mode 100644 x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/severity_badges.tsx create mode 100644 x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/severity_bar.tsx create mode 100644 x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/severity_filter_group.tsx create mode 100644 x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/translations.ts create mode 100644 x-pack/plugins/security_solution/public/hosts/containers/host_risk_score/index.tsx create mode 100644 x-pack/plugins/security_solution/public/hosts/containers/host_risk_score/translations.ts create mode 100644 x-pack/plugins/security_solution/public/hosts/pages/navigation/host_risk_score_tab_body.tsx diff --git a/x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/common/index.ts b/x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/common/index.ts index 8a9a047aab3fd..ee836b89f901f 100644 --- a/x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/common/index.ts +++ b/x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/common/index.ts @@ -9,6 +9,7 @@ import { CloudEcs } from '../../../../ecs/cloud'; import { HostEcs, OsEcs } from '../../../../ecs/host'; import { Hit, Hits, Maybe, SearchHit, StringOrNumber, TotalValue } from '../../../common'; import { EndpointPendingActions, HostStatus } from '../../../../endpoint/types'; +import { HostRiskSeverity } from '../kpi'; export enum HostPolicyResponseActionStatus { success = 'success', @@ -126,3 +127,21 @@ export interface HostHit extends Hit { } export type HostHits = Hits; + +export const enum HostRiskScoreFields { + timestamp = '@timestamp', + hostName = 'host.name', + riskScore = 'risk_stats.risk_score', + risk = 'risk', + // TODO: Steph/Host Risk + // ruleRisks = 'rule_risks', +} + +export interface HostRiskScoreItem { + _id?: Maybe; + [HostRiskScoreFields.hostName]: Maybe; + [HostRiskScoreFields.risk]: Maybe; + [HostRiskScoreFields.riskScore]: Maybe; + // TODO: Steph/Host Risk + // [HostRiskScoreFields.ruleRisks]: Maybe; +} diff --git a/x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/kpi/risky_hosts/index.ts b/x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/kpi/risky_hosts/index.ts index 5216052b1a6b1..610077bd6bc65 100644 --- a/x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/kpi/risky_hosts/index.ts +++ b/x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/kpi/risky_hosts/index.ts @@ -18,7 +18,7 @@ export interface HostsKpiRiskyHostsStrategyResponse extends IEsSearchResponse { }; } -export enum HostRiskSeverity { +export const enum HostRiskSeverity { unknown = 'Unknown', low = 'Low', moderate = 'Moderate', diff --git a/x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/risk_score/index.ts b/x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/risk_score/index.ts index 1c0d20161823b..b36fbd5ce57a3 100644 --- a/x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/risk_score/index.ts +++ b/x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/risk_score/index.ts @@ -5,13 +5,14 @@ * 2.0. */ -import { FactoryQueryTypes } from '../..'; +import { FactoryQueryTypes, HostRiskScoreFields } from '../..'; import type { IEsSearchRequest, IEsSearchResponse, } from '../../../../../../../../src/plugins/data/common'; import { RISKY_HOSTS_INDEX_PREFIX } from '../../../../constants'; -import { Direction, Inspect, Maybe, TimerangeInput } from '../../../common'; +import { ESQuery } from '../../../../typed_json'; +import { Inspect, Maybe, SortField, TimerangeInput } from '../../../common'; export interface HostsRiskScoreRequestOptions extends IEsSearchRequest { defaultIndex: string[]; @@ -19,12 +20,17 @@ export interface HostsRiskScoreRequestOptions extends IEsSearchRequest { hostNames?: string[]; timerange?: TimerangeInput; onlyLatest?: boolean; - limit?: number; - sortOrder?: Direction.asc | Direction.desc; + pagination?: { + cursorStart: number; + querySize: number; + }; + sort?: HostRiskScoreSortField; + filterQuery?: ESQuery | string | undefined; } export interface HostsRiskScoreStrategyResponse extends IEsSearchResponse { inspect?: Maybe; + totalCount: number; } export interface HostsRiskScore { @@ -42,8 +48,11 @@ export interface HostsRiskScore { export interface RuleRisk { rule_name: string; rule_risk: number; + rule_id?: string; // TODO Remove the '?' when the new transform is delivered } export const getHostRiskIndex = (spaceId: string, onlyLatest: boolean = true): string => { return `${RISKY_HOSTS_INDEX_PREFIX}${onlyLatest ? 'latest_' : ''}${spaceId}`; }; + +export type HostRiskScoreSortField = SortField; diff --git a/x-pack/plugins/security_solution/cypress/integration/host_details/risk_tab.ts b/x-pack/plugins/security_solution/cypress/integration/host_details/risk_tab.ts new file mode 100644 index 0000000000000..7cf1a06acdd9b --- /dev/null +++ b/x-pack/plugins/security_solution/cypress/integration/host_details/risk_tab.ts @@ -0,0 +1,52 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { loginAndWaitForHostDetailsPage } from '../../tasks/login'; + +import { cleanKibana } from '../../tasks/common'; +import { esArchiverLoad, esArchiverUnload } from '../../tasks/es_archiver'; +import { TABLE_CELL, TABLE_ROWS } from '../../screens/alerts_details'; + +describe('risk tab', () => { + before(() => { + cleanKibana(); + esArchiverLoad('risky_hosts'); + }); + + after(() => { + esArchiverUnload('risky_hosts'); + }); + + it('renders risk tab', () => { + loginAndWaitForHostDetailsPage('siem-kibana'); + cy.get('[data-test-subj="navigation-hostRisk"]').click(); + waitForTableToLoad(); + + cy.get('[data-test-subj="topHostScoreContributors"]') + .find(TABLE_ROWS) + .within(() => { + cy.get(TABLE_CELL).contains('Unusual Linux Username'); + }); + }); + + it('shows risk information overlay when button is clicked', () => { + loginAndWaitForHostDetailsPage('siem-kibana'); + cy.get('[data-test-subj="navigation-hostRisk"]').click(); + waitForTableToLoad(); + + cy.get('[data-test-subj="open-risk-information-flyout-trigger"]').click(); + + cy.get('[data-test-subj="open-risk-information-flyout"] .euiFlyoutHeader').contains( + 'How is host risk calculated?' + ); + }); +}); + +export const waitForTableToLoad = () => { + cy.get('.euiBasicTable-loading').should('exist'); + cy.get('.euiBasicTable-loading').should('not.exist'); +}; diff --git a/x-pack/plugins/security_solution/cypress/integration/hosts/host_risk_tab.spec.ts b/x-pack/plugins/security_solution/cypress/integration/hosts/host_risk_tab.spec.ts new file mode 100644 index 0000000000000..38a639e19c6b8 --- /dev/null +++ b/x-pack/plugins/security_solution/cypress/integration/hosts/host_risk_tab.spec.ts @@ -0,0 +1,43 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { cleanKibana } from '../../tasks/common'; +import { esArchiverLoad, esArchiverUnload } from '../../tasks/es_archiver'; +import { navigateToHostRiskDetailTab } from '../../tasks/host_risk'; +import { + HOST_BY_RISK_TABLE_CELL, + HOST_BY_RISK_TABLE_FILTER, + HOST_BY_RISK_TABLE_FILTER_CRITICAL, +} from '../../screens/hosts/host_risk'; +import { loginAndWaitForPage } from '../../tasks/login'; +import { HOSTS_URL } from '../../urls/navigation'; + +describe('risk tab', () => { + before(() => { + cleanKibana(); + esArchiverLoad('risky_hosts'); + loginAndWaitForPage(HOSTS_URL); + navigateToHostRiskDetailTab(); + }); + + after(() => { + esArchiverUnload('risky_hosts'); + }); + + it('renders the table', () => { + cy.get(HOST_BY_RISK_TABLE_CELL).eq(3).should('have.text', 'siem-kibana'); + cy.get(HOST_BY_RISK_TABLE_CELL).eq(4).should('have.text', '21.00'); + cy.get(HOST_BY_RISK_TABLE_CELL).eq(5).should('have.text', 'Low'); + }); + + it('filters the table', () => { + cy.get(HOST_BY_RISK_TABLE_FILTER).click(); + cy.get(HOST_BY_RISK_TABLE_FILTER_CRITICAL).click(); + + cy.get(HOST_BY_RISK_TABLE_CELL).eq(3).should('not.have.text', 'siem-kibana'); + }); +}); diff --git a/x-pack/plugins/security_solution/cypress/integration/hosts/risky_hosts_kpi.spec.ts b/x-pack/plugins/security_solution/cypress/integration/hosts/risky_hosts_kpi.spec.ts deleted file mode 100644 index 6661e6308971f..0000000000000 --- a/x-pack/plugins/security_solution/cypress/integration/hosts/risky_hosts_kpi.spec.ts +++ /dev/null @@ -1,20 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { loginAndWaitForPage } from '../../tasks/login'; - -import { HOSTS_URL } from '../../urls/navigation'; - -describe('RiskyHosts KPI', () => { - it('renders', () => { - loginAndWaitForPage(HOSTS_URL); - - cy.get('[data-test-subj="riskyHostsTotal"]').should('have.text', '0 Risky Hosts'); - cy.get('[data-test-subj="riskyHostsCriticalQuantity"]').should('have.text', '0 hosts'); - cy.get('[data-test-subj="riskyHostsHighQuantity"]').should('have.text', '0 hosts'); - }); -}); diff --git a/x-pack/plugins/security_solution/cypress/screens/hosts/host_risk.ts b/x-pack/plugins/security_solution/cypress/screens/hosts/host_risk.ts index 00bd39b911fb8..58331518255df 100644 --- a/x-pack/plugins/security_solution/cypress/screens/hosts/host_risk.ts +++ b/x-pack/plugins/security_solution/cypress/screens/hosts/host_risk.ts @@ -5,7 +5,7 @@ * 2.0. */ -export const RULE_NAME = '[data-test-subj="topHostScoreContributors"] .euiTableCellContent__text'; +export const RULE_NAME = '[data-test-subj="topHostScoreContributors"] .euiTableCellContent'; export const RISK_FLYOUT = '[data-test-subj="open-risk-information-flyout"] .euiFlyoutHeader'; @@ -14,3 +14,13 @@ export const RISK_DETAILS_NAV = '[data-test-subj="navigation-hostRisk"]'; export const RISK_FLYOUT_TRIGGER = '[data-test-subj="open-risk-information-flyout-trigger"]'; export const LOADING_TABLE = '.euiBasicTable-loading'; + +export const HOST_BY_RISK_TABLE = '.table-hostRisk-loading-false'; + +export const HOST_BY_RISK_TABLE_CELL = + '[data-test-subj="table-hostRisk-loading-false"] .euiTableCellContent'; + +export const HOST_BY_RISK_TABLE_FILTER = '[data-test-subj="host-risk-filter-button"]'; + +export const HOST_BY_RISK_TABLE_FILTER_CRITICAL = + '[data-test-subj="host-risk-filter-item-Critical"]'; diff --git a/x-pack/plugins/security_solution/public/common/components/event_details/cti_details/host_risk_summary.tsx b/x-pack/plugins/security_solution/public/common/components/event_details/cti_details/host_risk_summary.tsx index 8b15ed4b250b8..dbf73f7a6654d 100644 --- a/x-pack/plugins/security_solution/public/common/components/event_details/cti_details/host_risk_summary.tsx +++ b/x-pack/plugins/security_solution/public/common/components/event_details/cti_details/host_risk_summary.tsx @@ -10,8 +10,10 @@ import { EuiLoadingSpinner, EuiPanel, EuiSpacer, EuiLink, EuiText } from '@elast import { FormattedMessage } from '@kbn/i18n-react'; import * as i18n from './translations'; import { RISKY_HOSTS_DOC_LINK } from '../../../../overview/components/overview_risky_host_links/risky_hosts_disabled_module'; -import type { HostRisk } from '../../../containers/hosts_risk/use_hosts_risk_score'; import { EnrichedDataRow, ThreatSummaryPanelHeader } from './threat_summary_view'; +import { HostRisk } from '../../../containers/hosts_risk/types'; +import { HostRiskScore } from '../../../../hosts/components/common/host_risk_score'; +import { HostRiskSeverity } from '../../../../../common/search_strategy'; const HostRiskSummaryComponent: React.FC<{ hostRisk: HostRisk; @@ -51,7 +53,15 @@ const HostRiskSummaryComponent: React.FC<{ {hostRisk.isModuleEnabled && hostRisk.result && hostRisk.result.length > 0 && ( <> - + + } + /> )} diff --git a/x-pack/plugins/security_solution/public/common/components/event_details/cti_details/threat_summary_view.tsx b/x-pack/plugins/security_solution/public/common/components/event_details/cti_details/threat_summary_view.tsx index 9939f7c688040..4da090bfa106a 100644 --- a/x-pack/plugins/security_solution/public/common/components/event_details/cti_details/threat_summary_view.tsx +++ b/x-pack/plugins/security_solution/public/common/components/event_details/cti_details/threat_summary_view.tsx @@ -28,9 +28,9 @@ import { BrowserFields, TimelineEventsDetailsItem, } from '../../../../../common/search_strategy'; -import { HostRisk } from '../../../containers/hosts_risk/use_hosts_risk_score'; import { HostRiskSummary } from './host_risk_summary'; import { EnrichmentSummary } from './enrichment_summary'; +import { HostRisk } from '../../../containers/hosts_risk/types'; export interface ThreatSummaryDescription { browserField: BrowserField; diff --git a/x-pack/plugins/security_solution/public/common/components/event_details/event_details.tsx b/x-pack/plugins/security_solution/public/common/components/event_details/event_details.tsx index 272404d179b96..13eadfc53ae42 100644 --- a/x-pack/plugins/security_solution/public/common/components/event_details/event_details.tsx +++ b/x-pack/plugins/security_solution/public/common/components/event_details/event_details.tsx @@ -38,11 +38,9 @@ import { } from './cti_details/helpers'; import { EnrichmentRangePicker } from './cti_details/enrichment_range_picker'; import { Reason } from './reason'; - import { InvestigationGuideView } from './investigation_guide_view'; - -import { HostRisk } from '../../containers/hosts_risk/use_hosts_risk_score'; import { Overview } from './overview'; +import { HostRisk } from '../../containers/hosts_risk/types'; type EventViewTab = EuiTabbedContentTab; diff --git a/x-pack/plugins/security_solution/public/common/components/header_section/__snapshots__/index.test.tsx.snap b/x-pack/plugins/security_solution/public/common/components/header_section/__snapshots__/index.test.tsx.snap index 7fe76e05b2f02..6701224289e66 100644 --- a/x-pack/plugins/security_solution/public/common/components/header_section/__snapshots__/index.test.tsx.snap +++ b/x-pack/plugins/security_solution/public/common/components/header_section/__snapshots__/index.test.tsx.snap @@ -6,6 +6,7 @@ exports[`HeaderSection it renders 1`] = ` > = ({ border, children, + headerFilters, height, id, isInspectDisabled, split, + stackHeader, subtitle, title, titleSize = 'm', @@ -68,7 +72,11 @@ const HeaderSectionComponent: React.FC = ({ hideSubtitle = false, }) => (

- + @@ -99,6 +107,8 @@ const HeaderSectionComponent: React.FC = ({ /> )} + + {headerFilters && {headerFilters}} diff --git a/x-pack/plugins/security_solution/public/common/components/link_to/index.ts b/x-pack/plugins/security_solution/public/common/components/link_to/index.ts index 6681ee2cb7e8f..2f7f876bda9bc 100644 --- a/x-pack/plugins/security_solution/public/common/components/link_to/index.ts +++ b/x-pack/plugins/security_solution/public/common/components/link_to/index.ts @@ -15,7 +15,7 @@ import { SecurityPageName } from '../../../app/types'; export { getDetectionEngineUrl, getRuleDetailsUrl } from './redirect_to_detection_engine'; export { getAppOverviewUrl } from './redirect_to_overview'; -export { getHostDetailsUrl, getHostsUrl } from './redirect_to_hosts'; +export { getHostDetailsUrl, getTabsOnHostDetailsUrl, getHostsUrl } from './redirect_to_hosts'; export { getNetworkUrl, getNetworkDetailsUrl } from './redirect_to_network'; export { getTimelineTabsUrl, getTimelineUrl } from './redirect_to_timelines'; export { diff --git a/x-pack/plugins/security_solution/public/common/components/links/index.tsx b/x-pack/plugins/security_solution/public/common/components/links/index.tsx index a232b795d1dba..d54d7efd267b8 100644 --- a/x-pack/plugins/security_solution/public/common/components/links/index.tsx +++ b/x-pack/plugins/security_solution/public/common/components/links/index.tsx @@ -25,6 +25,7 @@ import { encodeIpv6 } from '../../lib/helpers'; import { getCaseDetailsUrl, getHostDetailsUrl, + getTabsOnHostDetailsUrl, getNetworkDetailsUrl, getCreateCaseUrl, useFormatUrl, @@ -40,6 +41,7 @@ import * as i18n from './translations'; import { SecurityPageName } from '../../../app/types'; import { getUebaDetailsUrl } from '../link_to/redirect_to_ueba'; import { LinkButton, LinkAnchor, GenericLinkButton, PortContainer, Comma } from './helpers'; +import { HostsTableType } from '../../../hosts/store/model'; export { LinkButton, LinkAnchor } from './helpers'; @@ -92,23 +94,34 @@ const HostDetailsLinkComponent: React.FC<{ hostName: string; isButton?: boolean; onClick?: (e: SyntheticEvent) => void; + hostTab?: HostsTableType; title?: string; -}> = ({ children, Component, hostName, isButton, onClick, title }) => { +}> = ({ children, Component, hostName, isButton, onClick, title, hostTab }) => { const { formatUrl, search } = useFormatUrl(SecurityPageName.hosts); const { navigateToApp } = useKibana().services.application; + + const encodedHostName = encodeURIComponent(hostName); + const goToHostDetails = useCallback( (ev) => { ev.preventDefault(); navigateToApp(APP_UI_ID, { deepLinkId: SecurityPageName.hosts, - path: getHostDetailsUrl(encodeURIComponent(hostName), search), + path: hostTab + ? getTabsOnHostDetailsUrl(encodedHostName, hostTab, search) + : getHostDetailsUrl(encodedHostName, search), }); }, - [hostName, navigateToApp, search] + [encodedHostName, navigateToApp, search, hostTab] ); const href = useMemo( - () => formatUrl(getHostDetailsUrl(encodeURIComponent(hostName))), - [formatUrl, hostName] + () => + formatUrl( + hostTab + ? getTabsOnHostDetailsUrl(encodedHostName, hostTab) + : getHostDetailsUrl(encodedHostName) + ), + [formatUrl, encodedHostName, hostTab] ); return isButton ? ( ( WrappedComponent: React.ComponentClass | React.ComponentType -): React.ComponentClass { - class ManageQuery extends React.PureComponent { - static displayName: string; - public componentDidUpdate(prevProps: OwnProps) { - const { loading, id, refetch, setQuery, inspect = null } = this.props; - setQuery({ id, inspect, loading, refetch }); - } - - public componentWillUnmount() { - const { deleteQuery, id } = this.props; - if (deleteQuery) { - deleteQuery({ id }); - } - } +): React.FC { + const ManageQuery = (props: OwnProps & T) => { + const { loading, id, refetch, setQuery, deleteQuery, inspect = null } = props; + useQueryInspector({ + queryId: id, + loading, + refetch, + setQuery, + deleteQuery, + inspect, + }); + + const otherProps = omit(['refetch', 'setQuery'], props); + return ; + }; - public render() { - const otherProps = omit(['refetch', 'setQuery'], this.props); - return ; - } - } ManageQuery.displayName = `ManageQuery (${WrappedComponent?.displayName ?? 'Unknown'})`; return ManageQuery; } + +interface UseQueryInspectorTypes extends Pick { + queryId: string; + legendPosition?: Position; + loading: boolean; + refetch: inputsModel.Refetch; + inspect?: inputsModel.InspectQuery | null; +} + +export const useQueryInspector = ({ + setQuery, + deleteQuery, + refetch, + inspect, + loading, + queryId, +}: UseQueryInspectorTypes) => { + useEffect(() => { + setQuery({ id: queryId, inspect: inspect ?? null, loading, refetch }); + }, [deleteQuery, setQuery, queryId, refetch, inspect, loading]); + + useEffect(() => { + return () => { + if (deleteQuery) { + deleteQuery({ id: queryId }); + } + }; + }, [deleteQuery, queryId]); +}; diff --git a/x-pack/plugins/security_solution/public/common/components/paginated_table/index.tsx b/x-pack/plugins/security_solution/public/common/components/paginated_table/index.tsx index ef49c8e2a5e8c..032ab1f505fca 100644 --- a/x-pack/plugins/security_solution/public/common/components/paginated_table/index.tsx +++ b/x-pack/plugins/security_solution/public/common/components/paginated_table/index.tsx @@ -39,6 +39,8 @@ import { } from '../../../network/components/network_top_countries_table/columns'; import { TlsColumns } from '../../../network/components/tls_table/columns'; import { UncommonProcessTableColumns } from '../../../hosts/components/uncommon_process_table'; +import { HostRiskScoreColumns } from '../../../hosts/components/host_risk_score_table'; + import { UsersColumns } from '../../../network/components/users_table/columns'; import { HeaderSection } from '../header_section'; import { Loader } from '../loader'; @@ -88,7 +90,7 @@ declare type BasicTableColumns = | NetworkTopCountriesColumnsNetworkDetails | NetworkTopNFlowColumns | NetworkTopNFlowColumnsNetworkDetails - | NetworkHttpColumns + | HostRiskScoreColumns | RiskScoreColumns | TlsColumns | UncommonProcessTableColumns @@ -102,6 +104,7 @@ export interface BasicTableProps { columns: T; dataTestSubj?: string; headerCount: number; + headerFilters?: string | React.ReactNode; headerSupplement?: React.ReactElement; headerTitle: string | React.ReactElement; headerTooltip?: string; @@ -118,6 +121,8 @@ export interface BasicTableProps { pageOfItems: any[]; showMorePagesIndicator: boolean; sorting?: SortingBasicTable; + split?: boolean; + stackHeader?: boolean; totalCount: number; updateActivePage: (activePage: number) => void; updateLimitPagination: (limit: number) => void; @@ -140,6 +145,7 @@ const PaginatedTableComponent: FC = ({ columns, dataTestSubj = DEFAULT_DATA_TEST_SUBJ, headerCount, + headerFilters, headerSupplement, headerTitle, headerTooltip, @@ -155,6 +161,8 @@ const PaginatedTableComponent: FC = ({ pageOfItems, showMorePagesIndicator, sorting = null, + split, + stackHeader, totalCount, updateActivePage, updateLimitPagination, @@ -255,7 +263,10 @@ const PaginatedTableComponent: FC = ({ {}; - -const isRecord = (item: unknown): item is Record => - typeof item === 'object' && !!item; - -const isHostsRiskScoreHit = (item: Partial): item is HostsRiskScore => - isRecord(item) && - isRecord(item.host) && - typeof item.host.name === 'string' && - typeof item.risk_stats?.risk_score === 'number' && - typeof item.risk === 'string'; - -export interface HostRisk { - loading: boolean; - isModuleEnabled?: boolean; - result?: HostsRiskScore[]; -} - -/** - * @param queryId Provide this parameter when using query inspector to identify the query. - */ -export const useHostsRiskScore = ({ - timerange, - hostName, - onlyLatest = true, - queryId = HostRiskScoreQueryId.DEFAULT, - sortOrder, - limit, -}: { - timerange?: { to: string; from: string }; - hostName?: string; - onlyLatest?: boolean; - queryId?: HostRiskScoreQueryId; - limit?: number; - sortOrder?: Direction; -}): HostRisk | null => { - const riskyHostsFeatureEnabled = useIsExperimentalFeatureEnabled('riskyHostsEnabled'); - const [isModuleEnabled, setIsModuleEnabled] = useState(undefined); - const [loading, setLoading] = useState(riskyHostsFeatureEnabled); - - const { addError } = useAppToasts(); - const { data, spaces } = useKibana().services; - - const dispatch = useDispatch(); - - const { error, result, start, loading: isHostsRiskScoreLoading } = useHostsRiskScoreComplete(); - - const deleteQuery = useCallback(() => { - dispatch(inputsActions.deleteOneQuery({ inputId: 'global', id: queryId })); - }, [dispatch, queryId]); - - useEffect(() => { - if (!isHostsRiskScoreLoading && result) { - setIsModuleEnabled(true); - setLoading(false); - dispatch( - inputsActions.setQuery({ - inputId: 'global', - id: queryId, - inspect: { - dsl: result.inspect?.dsl ?? [], - response: [JSON.stringify(result.rawResponse, null, 2)], - }, - loading: isHostsRiskScoreLoading, - refetch: noop, - }) - ); - } - return deleteQuery; - }, [deleteQuery, dispatch, isHostsRiskScoreLoading, result, setIsModuleEnabled, queryId]); - - useEffect(() => { - if (error) { - if (isIndexNotFoundError(error)) { - setIsModuleEnabled(false); - setLoading(false); - } else { - addError(error, { - title: i18n.translate('xpack.securitySolution.overview.hostsRiskError', { - defaultMessage: 'Error Fetching Hosts Risk', - }), - }); - setLoading(false); - setIsModuleEnabled(true); - } - } - }, [addError, error, setIsModuleEnabled]); - - useEffect(() => { - if (riskyHostsFeatureEnabled && (hostName || timerange)) { - spaces?.getActiveSpace().then((space) => { - start({ - data, - timerange: timerange - ? { to: timerange.to, from: timerange.from, interval: '' } - : undefined, - hostNames: hostName ? [hostName] : undefined, - defaultIndex: [getHostRiskIndex(space.id, onlyLatest)], - onlyLatest, - sortOrder, - limit, - }); - }); - } - }, [ - start, - data, - timerange, - hostName, - onlyLatest, - riskyHostsFeatureEnabled, - spaces, - sortOrder, - limit, - ]); - - if ((!hostName && !timerange) || !riskyHostsFeatureEnabled) { - return null; - } - - const hits = result?.rawResponse?.hits?.hits; - - return { - result: isHostsRiskScoreHit(hits?.[0]?._source) - ? (hits?.map((hit) => hit._source) as HostsRiskScore[]) - : [], - isModuleEnabled, - loading, - }; -}; diff --git a/x-pack/plugins/security_solution/public/common/containers/hosts_risk/use_hosts_risk_score_complete.ts b/x-pack/plugins/security_solution/public/common/containers/hosts_risk/use_hosts_risk_score_complete.ts deleted file mode 100644 index 2531d533d830b..0000000000000 --- a/x-pack/plugins/security_solution/public/common/containers/hosts_risk/use_hosts_risk_score_complete.ts +++ /dev/null @@ -1,63 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ -import type { Observable } from 'rxjs'; -import { filter } from 'rxjs/operators'; - -import { useObservable, withOptionalSignal } from '@kbn/securitysolution-hook-utils'; -import { - DataPublicPluginStart, - isCompleteResponse, - isErrorResponse, -} from '../../../../../../../src/plugins/data/public'; -import { - HostsQueries, - HostsRiskScoreRequestOptions, - HostsRiskScoreStrategyResponse, -} from '../../../../common/search_strategy'; - -type GetHostsRiskScoreProps = HostsRiskScoreRequestOptions & { - data: DataPublicPluginStart; - signal: AbortSignal; -}; - -export const getHostsRiskScore = ({ - data, - defaultIndex, - timerange, - hostNames, - signal, - limit, - sortOrder, -}: GetHostsRiskScoreProps): Observable => - data.search.search( - { - defaultIndex, - factoryQueryType: HostsQueries.hostsRiskScore, - timerange, - hostNames, - limit, - sortOrder, - }, - { - strategy: 'securitySolutionSearchStrategy', - abortSignal: signal, - } - ); - -export const getHostsRiskScoreComplete = ( - props: GetHostsRiskScoreProps -): Observable => { - return getHostsRiskScore(props).pipe( - filter((response) => { - return isErrorResponse(response) || isCompleteResponse(response); - }) - ); -}; - -const getHostsRiskScoreWithOptionalSignal = withOptionalSignal(getHostsRiskScoreComplete); - -export const useHostsRiskScoreComplete = () => useObservable(getHostsRiskScoreWithOptionalSignal); diff --git a/x-pack/plugins/security_solution/public/common/mock/global_state.ts b/x-pack/plugins/security_solution/public/common/mock/global_state.ts index cf7d9f1dae23e..91bafffdaa25f 100644 --- a/x-pack/plugins/security_solution/public/common/mock/global_state.ts +++ b/x-pack/plugins/security_solution/public/common/mock/global_state.ts @@ -16,6 +16,7 @@ import { RiskScoreFields, HostRulesFields, HostTacticsFields, + HostRiskScoreFields, } from '../../../common/search_strategy'; import { State } from '../store'; @@ -83,7 +84,12 @@ export const mockGlobalState: State = { uncommonProcesses: { activePage: 0, limit: 10 }, anomalies: null, externalAlerts: { activePage: 0, limit: 10 }, - hostRisk: null, + hostRisk: { + activePage: 0, + limit: 10, + sort: { field: HostRiskScoreFields.riskScore, direction: Direction.desc }, + severitySelection: [], + }, }, }, details: { @@ -99,7 +105,12 @@ export const mockGlobalState: State = { uncommonProcesses: { activePage: 0, limit: 10 }, anomalies: null, externalAlerts: { activePage: 0, limit: 10 }, - hostRisk: null, + hostRisk: { + activePage: 0, + limit: 10, + sort: { field: HostRiskScoreFields.riskScore, direction: Direction.desc }, + severitySelection: [], + }, }, }, }, diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/all/use_columns.tsx b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/all/use_columns.tsx index d7477a792a115..f41112e23c4d9 100644 --- a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/all/use_columns.tsx +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/all/use_columns.tsx @@ -91,36 +91,40 @@ const useEnabledColumn = ({ hasPermissions }: ColumnsProps): TableColumn => { ); }; -const useRuleNameColumn = (): TableColumn => { +export const RuleLink = ({ name, id }: Pick) => { const { formatUrl } = useFormatUrl(SecurityPageName.rules); const { navigateToApp } = useKibana().services.application; + return ( + + void }) => { + ev.preventDefault(); + navigateToApp(APP_UI_ID, { + deepLinkId: SecurityPageName.rules, + path: getRuleDetailsUrl(id), + }); + }} + href={formatUrl(getRuleDetailsUrl(id))} + > + {name} + + + ); +}; + +const useRuleNameColumn = (): TableColumn => { return useMemo( () => ({ field: 'name', name: i18n.COLUMN_RULE, - render: (value: Rule['name'], item: Rule) => ( - - void }) => { - ev.preventDefault(); - navigateToApp(APP_UI_ID, { - deepLinkId: SecurityPageName.rules, - path: getRuleDetailsUrl(item.id), - }); - }} - href={formatUrl(getRuleDetailsUrl(item.id))} - > - {value} - - - ), + render: (value: Rule['name'], item: Rule) => , sortable: true, truncateText: true, width: '38%', }), - [formatUrl, navigateToApp] + [] ); }; diff --git a/x-pack/plugins/security_solution/public/helper_hooks.tsx b/x-pack/plugins/security_solution/public/helper_hooks.tsx new file mode 100644 index 0000000000000..2030fa14ad696 --- /dev/null +++ b/x-pack/plugins/security_solution/public/helper_hooks.tsx @@ -0,0 +1,21 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { useCallback, useState } from 'react'; + +export const useOnOpenCloseHandler = (): [boolean, () => void, () => void] => { + const [isOpen, setIsOpen] = useState(false); + + const handleOnClose = useCallback(() => { + setIsOpen(false); + }, []); + + const handleOnOpen = useCallback(() => { + setIsOpen(true); + }, []); + return [isOpen, handleOnOpen, handleOnClose]; +}; diff --git a/x-pack/plugins/security_solution/public/hosts/components/common/host_risk_score.tsx b/x-pack/plugins/security_solution/public/hosts/components/common/host_risk_score.tsx index 982cde1e90a00..39909b736a612 100644 --- a/x-pack/plugins/security_solution/public/hosts/components/common/host_risk_score.tsx +++ b/x-pack/plugins/security_solution/public/hosts/components/common/host_risk_score.tsx @@ -12,13 +12,14 @@ import { EuiHealth, transparentize } from '@elastic/eui'; import styled, { css } from 'styled-components'; import { euiLightVars } from '@kbn/ui-theme'; import { HostRiskSeverity } from '../../../../common/search_strategy'; +import { WithHoverActions } from '../../../common/components/with_hover_actions'; -const HOST_RISK_SEVERITY_COLOUR = { - Unknown: euiLightVars.euiColorMediumShade, - Low: euiLightVars.euiColorVis0, - Moderate: euiLightVars.euiColorWarning, - High: euiLightVars.euiColorVis9_behindText, - Critical: euiLightVars.euiColorDanger, +export const HOST_RISK_SEVERITY_COLOUR: { [k in HostRiskSeverity]: string } = { + [HostRiskSeverity.unknown]: euiLightVars.euiColorMediumShade, + [HostRiskSeverity.low]: euiLightVars.euiColorVis0, + [HostRiskSeverity.moderate]: euiLightVars.euiColorWarning, + [HostRiskSeverity.high]: euiLightVars.euiColorVis9_behindText, + [HostRiskSeverity.critical]: euiLightVars.euiColorDanger, }; const HostRiskBadge = styled.div<{ $severity: HostRiskSeverity; $hideBackgroundColor: boolean }>` @@ -35,19 +36,34 @@ const HostRiskBadge = styled.div<{ $severity: HostRiskSeverity; $hideBackgroundC `}; `} `; - +const TooltipContainer = styled.div` + padding: ${({ theme }) => theme.eui.paddingSizes.s}; +`; export const HostRiskScore: React.FC<{ severity: HostRiskSeverity; hideBackgroundColor?: boolean; -}> = ({ severity, hideBackgroundColor = false }) => ( - - - {severity} - - -); + toolTipContent?: JSX.Element; +}> = ({ severity, hideBackgroundColor = false, toolTipContent }) => { + const badge = ( + + + {severity} + + + ); + + if (toolTipContent != null) { + return ( + {toolTipContent}} + render={() => badge} + /> + ); + } + return badge; +}; diff --git a/x-pack/plugins/security_solution/public/hosts/components/host_risk_information/index.tsx b/x-pack/plugins/security_solution/public/hosts/components/host_risk_information/index.tsx index 00230b0a4d278..8abfbb59965ef 100644 --- a/x-pack/plugins/security_solution/public/hosts/components/host_risk_information/index.tsx +++ b/x-pack/plugins/security_solution/public/hosts/components/host_risk_information/index.tsx @@ -25,11 +25,12 @@ import { } from '@elastic/eui'; import { FormattedMessage } from '@kbn/i18n-react'; -import React, { useState, useCallback, memo } from 'react'; +import React from 'react'; import { HostRiskSeverity } from '../../../../common/search_strategy'; import { RISKY_HOSTS_DOC_LINK } from '../../../overview/components/overview_risky_host_links/risky_hosts_disabled_module'; import { HostRiskScore } from '../common/host_risk_score'; import * as i18n from './translations'; +import { useOnOpenCloseHandler } from '../../../helper_hooks'; const tableColumns: Array> = [ { @@ -62,7 +63,7 @@ const tableItems: TableItem[] = [ export const HOST_RISK_INFO_BUTTON_CLASS = 'HostRiskInformation__button'; -export const HostRiskInformationButtonIcon = memo(() => { +export const HostRiskInformationButtonIcon = () => { const [isFlyoutVisible, handleOnOpen, handleOnClose] = useOnOpenCloseHandler(); return ( @@ -79,10 +80,9 @@ export const HostRiskInformationButtonIcon = memo(() => { {isFlyoutVisible && } ); -}); -HostRiskInformationButtonIcon.displayName = 'HostRiskInformationButtonIcon'; +}; -export const HostRiskInformationButtonEmpty = memo(() => { +export const HostRiskInformationButtonEmpty = () => { const [isFlyoutVisible, handleOnOpen, handleOnClose] = useOnOpenCloseHandler(); return ( @@ -93,20 +93,6 @@ export const HostRiskInformationButtonEmpty = memo(() => { {isFlyoutVisible && } ); -}); -HostRiskInformationButtonEmpty.displayName = 'HostRiskInformationButtonEmpty'; - -const useOnOpenCloseHandler = (): [boolean, () => void, () => void] => { - const [isOpen, setIsOpen] = useState(false); - - const handleOnClose = useCallback(() => { - setIsOpen(false); - }, []); - - const handleOnOpen = useCallback(() => { - setIsOpen(true); - }, []); - return [isOpen, handleOnOpen, handleOnClose]; }; const HostRiskInformationFlyout = ({ handleOnClose }: { handleOnClose: () => void }) => { diff --git a/x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/columns.tsx b/x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/columns.tsx new file mode 100644 index 0000000000000..cab6dd08ef018 --- /dev/null +++ b/x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/columns.tsx @@ -0,0 +1,112 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import { EuiIcon, EuiLink, EuiText, EuiToolTip } from '@elastic/eui'; +import { + DragEffects, + DraggableWrapper, +} from '../../../common/components/drag_and_drop/draggable_wrapper'; +import { escapeDataProviderId } from '../../../common/components/drag_and_drop/helpers'; +import { getEmptyTagValue } from '../../../common/components/empty_value'; +import { HostDetailsLink } from '../../../common/components/links'; +import { IS_OPERATOR } from '../../../timelines/components/timeline/data_providers/data_provider'; +import { Provider } from '../../../timelines/components/timeline/data_providers/provider'; +import { HostRiskScoreColumns } from '.'; + +import * as i18n from './translations'; +import { HostRiskScore } from '../common/host_risk_score'; +import { HostRiskSeverity } from '../../../../common/search_strategy'; +import { HostsTableType } from '../../store/model'; + +export const getHostRiskScoreColumns = ({ + dispatchSeverityUpdate, +}: { + dispatchSeverityUpdate: (s: HostRiskSeverity) => void; +}): HostRiskScoreColumns => [ + { + field: 'host.name', + name: i18n.HOST_NAME, + truncateText: false, + mobileOptions: { show: true }, + sortable: true, + render: (hostName) => { + if (hostName != null && hostName.length > 0) { + const id = escapeDataProviderId(`host-risk-score-table-hostName-${hostName}`); + return ( + + snapshot.isDragging ? ( + + + + ) : ( + + ) + } + /> + ); + } + return getEmptyTagValue(); + }, + }, + { + field: 'risk_stats.risk_score', + name: i18n.HOST_RISK_SCORE, + truncateText: true, + mobileOptions: { show: true }, + sortable: true, + render: (riskScore) => { + if (riskScore != null) { + return ( + + {riskScore.toFixed(2)} + + ); + } + return getEmptyTagValue(); + }, + }, + { + field: 'risk', + name: ( + + <> + {i18n.HOST_RISK} + + + ), + truncateText: false, + mobileOptions: { show: true }, + sortable: true, + render: (risk) => { + if (risk != null) { + return ( + dispatchSeverityUpdate(risk)}> + {i18n.VIEW_HOSTS_BY_SEVERITY(risk.toLowerCase())} + + } + severity={risk} + /> + ); + } + return getEmptyTagValue(); + }, + }, +]; diff --git a/x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/index.tsx b/x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/index.tsx new file mode 100644 index 0000000000000..9994a03b1e666 --- /dev/null +++ b/x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/index.tsx @@ -0,0 +1,194 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useMemo, useCallback } from 'react'; +import { useDispatch } from 'react-redux'; + +import { EuiFlexGroup, EuiFlexItem, EuiIconTip } from '@elastic/eui'; +import { + Columns, + Criteria, + ItemsPerRow, + PaginatedTable, +} from '../../../common/components/paginated_table'; +import { useDeepEqualSelector } from '../../../common/hooks/use_selector'; +import { hostsActions, hostsModel, hostsSelectors } from '../../store'; +import { getHostRiskScoreColumns } from './columns'; +import type { + HostsRiskScore, + HostRiskScoreItem, + HostRiskScoreSortField, +} from '../../../../common/search_strategy'; +import { HostRiskScoreFields, HostRiskSeverity } from '../../../../common/search_strategy'; +import { State } from '../../../common/store'; +import * as i18n from '../hosts_table/translations'; +import * as i18nHosts from './translations'; +import { SeverityBar } from './severity_bar'; +import { SeverityBadges } from './severity_badges'; +import { SeverityFilterGroup } from './severity_filter_group'; +import { SeverityCount } from '../../containers/kpi_hosts/risky_hosts'; + +export const rowItems: ItemsPerRow[] = [ + { + text: i18n.ROWS_5, + numberOfRow: 5, + }, + { + text: i18n.ROWS_10, + numberOfRow: 10, + }, +]; + +const tableType = hostsModel.HostsTableType.risk; + +interface HostRiskScoreTableProps { + data: HostsRiskScore[]; + id: string; + isInspect: boolean; + loading: boolean; + loadPage: (newActivePage: number) => void; + severityCount: SeverityCount; + totalCount: number; + type: hostsModel.HostsType; +} + +export type HostRiskScoreColumns = [ + Columns, + Columns, + Columns +]; + +const HostRiskScoreTableComponent: React.FC = ({ + data, + id, + isInspect, + loading, + loadPage, + severityCount, + totalCount, + type, +}) => { + const dispatch = useDispatch(); + const getHostRiskScoreSelector = useMemo(() => hostsSelectors.hostRiskScoreSelector(), []); + const { activePage, limit, sort } = useDeepEqualSelector((state: State) => + getHostRiskScoreSelector(state, hostsModel.HostsType.page) + ); + const updateLimitPagination = useCallback( + (newLimit) => + dispatch( + hostsActions.updateTableLimit({ + hostsType: type, + limit: newLimit, + tableType, + }) + ), + [type, dispatch] + ); + + const updateActivePage = useCallback( + (newPage) => + dispatch( + hostsActions.updateTableActivePage({ + activePage: newPage, + hostsType: type, + tableType, + }) + ), + [type, dispatch] + ); + + const onSort = useCallback( + (criteria: Criteria) => { + if (criteria.sort != null) { + const newSort = criteria.sort; + if (newSort.direction !== sort.direction || newSort.field !== sort.field) { + dispatch( + hostsActions.updateHostRiskScoreSort({ + sort: newSort as HostRiskScoreSortField, + hostsType: type, + }) + ); + } + } + }, + [dispatch, sort, type] + ); + const dispatchSeverityUpdate = useCallback( + (s: HostRiskSeverity) => { + dispatch( + hostsActions.updateHostRiskScoreSeverityFilter({ + severitySelection: [s], + hostsType: type, + }) + ); + }, + [dispatch, type] + ); + const columns = useMemo( + () => getHostRiskScoreColumns({ dispatchSeverityUpdate }), + [dispatchSeverityUpdate] + ); + + const risk = ( + + + + + + + + + ); + + const headerTitle = ( + + {i18nHosts.HOSTS_BY_RISK} + + + + + ); + return ( + } + headerSupplement={risk} + headerTitle={headerTitle} + headerUnit={i18n.UNIT(totalCount)} + id={id} + isInspect={isInspect} + itemsPerRow={rowItems} + limit={limit} + loading={loading} + loadPage={loadPage} + onChange={onSort} + pageOfItems={data} + showMorePagesIndicator={false} + sorting={sort} + split={true} + stackHeader={true} + totalCount={totalCount} + updateLimitPagination={updateLimitPagination} + updateActivePage={updateActivePage} + /> + ); +}; + +HostRiskScoreTableComponent.displayName = 'HostRiskScoreTableComponent'; + +export const HostRiskScoreTable = React.memo(HostRiskScoreTableComponent); + +HostRiskScoreTable.displayName = 'HostRiskScoreTable'; diff --git a/x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/severity_badges.tsx b/x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/severity_badges.tsx new file mode 100644 index 0000000000000..655a11a8da421 --- /dev/null +++ b/x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/severity_badges.tsx @@ -0,0 +1,52 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { EuiFlexGroup, EuiNotificationBadge, EuiFlexItem } from '@elastic/eui'; +import React from 'react'; +import { HOST_RISK_SEVERITY_COLOUR, HostRiskScore } from '../common/host_risk_score'; +import { HostRiskSeverity } from '../../../../common/search_strategy'; +import { SeverityCount } from '../../containers/kpi_hosts/risky_hosts'; + +export const SeverityBadges: React.FC<{ + severityCount: SeverityCount; +}> = React.memo(({ severityCount }) => ( + + + + + {(Object.keys(HOST_RISK_SEVERITY_COLOUR) as HostRiskSeverity[]).map((status) => ( + + + + ))} + + + +)); + +SeverityBadges.displayName = 'SeverityBadges'; + +const SeverityBadge: React.FC<{ status: HostRiskSeverity; count: number }> = React.memo( + ({ status, count }) => ( + + + + + + + {count} + + + + ) +); + +SeverityBadge.displayName = 'SeverityBadge'; diff --git a/x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/severity_bar.tsx b/x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/severity_bar.tsx new file mode 100644 index 0000000000000..9522e84333e30 --- /dev/null +++ b/x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/severity_bar.tsx @@ -0,0 +1,58 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import styled from 'styled-components'; +import { EuiColorPaletteDisplay } from '@elastic/eui'; +import React, { useMemo } from 'react'; + +import { HostRiskSeverity } from '../../../../common/search_strategy'; +import { HOST_RISK_SEVERITY_COLOUR } from '../common/host_risk_score'; +import { SeverityCount } from '../../containers/kpi_hosts/risky_hosts'; + +const StyledEuiColorPaletteDisplay = styled(EuiColorPaletteDisplay)` + &.risk-score-severity-bar { + border: none; + border-radius: 0; + &:after { + border: none; + } + } +`; +interface PalletteObject { + stop: number; + color: string; +} +type PalletteArray = PalletteObject[]; + +export const SeverityBar: React.FC<{ + severityCount: SeverityCount; +}> = ({ severityCount }) => { + const palette = useMemo( + () => + (Object.keys(HOST_RISK_SEVERITY_COLOUR) as HostRiskSeverity[]).reduce( + (acc: PalletteArray, status: HostRiskSeverity) => { + const previousStop = acc.length > 0 ? acc[acc.length - 1].stop : 0; + const newEntry: PalletteObject = { + stop: previousStop + (severityCount[status] || 0), + color: HOST_RISK_SEVERITY_COLOUR[status], + }; + acc.push(newEntry); + return acc; + }, + [] as PalletteArray + ), + [severityCount] + ); + return ( + + ); +}; diff --git a/x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/severity_filter_group.tsx b/x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/severity_filter_group.tsx new file mode 100644 index 0000000000000..656129aec3e5b --- /dev/null +++ b/x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/severity_filter_group.tsx @@ -0,0 +1,128 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import React, { useCallback, useMemo, useState } from 'react'; + +import { + EuiFilterButton, + EuiFilterGroup, + EuiFilterSelectItem, + EuiPopover, + FilterChecked, + useGeneratedHtmlId, +} from '@elastic/eui'; +import { useDispatch } from 'react-redux'; +import { HostRiskSeverity } from '../../../../common/search_strategy'; +import * as i18n from './translations'; +import { hostsActions, hostsModel, hostsSelectors } from '../../store'; +import { SeverityCount } from '../../containers/kpi_hosts/risky_hosts'; +import { HostRiskScore } from '../common/host_risk_score'; +import { useDeepEqualSelector } from '../../../common/hooks/use_selector'; +import { State } from '../../../common/store'; + +interface SeverityItems { + risk: HostRiskSeverity; + count: number; + checked?: FilterChecked; +} +export const SeverityFilterGroup: React.FC<{ + severityCount: SeverityCount; + type: hostsModel.HostsType; +}> = ({ severityCount, type }) => { + const [isPopoverOpen, setIsPopoverOpen] = useState(false); + + const dispatch = useDispatch(); + + const onButtonClick = useCallback(() => { + setIsPopoverOpen(!isPopoverOpen); + }, [isPopoverOpen]); + + const closePopover = useCallback(() => { + setIsPopoverOpen(false); + }, []); + + const filterGroupPopoverId = useGeneratedHtmlId({ + prefix: 'filterGroupPopover', + }); + const getHostRiskScoreFilterQuerySelector = useMemo( + () => hostsSelectors.hostRiskScoreSeverityFilterSelector(), + [] + ); + const severitySelectionRedux = useDeepEqualSelector((state: State) => + getHostRiskScoreFilterQuerySelector(state, type) + ); + + const items: SeverityItems[] = useMemo(() => { + const checked: FilterChecked = 'on'; + return (Object.keys(severityCount) as HostRiskSeverity[]).map((k) => ({ + risk: k, + count: severityCount[k], + checked: severitySelectionRedux.includes(k) ? checked : undefined, + })); + }, [severityCount, severitySelectionRedux]); + + const updateSeverityFilter = useCallback( + (selectedSeverity: HostRiskSeverity) => { + const currentSelection = severitySelectionRedux ?? []; + const newSelection = currentSelection.includes(selectedSeverity) + ? currentSelection.filter((s) => s !== selectedSeverity) + : [...currentSelection, selectedSeverity]; + dispatch( + hostsActions.updateHostRiskScoreSeverityFilter({ + severitySelection: newSelection, + hostsType: type, + }) + ); + }, + [dispatch, severitySelectionRedux, type] + ); + + const totalActiveHosts = useMemo( + () => items.reduce((total, item) => (item.checked === 'on' ? total + item.count : total), 0), + [items] + ); + + const button = useMemo( + () => ( + item.checked === 'on')} + iconType="arrowDown" + isSelected={isPopoverOpen} + numActiveFilters={totalActiveHosts} + onClick={onButtonClick} + > + {i18n.HOST_RISK} + + ), + [isPopoverOpen, items, onButtonClick, totalActiveHosts] + ); + + return ( + + +
+ {items.map((item, index) => ( + updateSeverityFilter(item.risk)} + > + + + ))} +
+ + + ); +}; diff --git a/x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/translations.ts b/x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/translations.ts new file mode 100644 index 0000000000000..9a1fc5600f528 --- /dev/null +++ b/x-pack/plugins/security_solution/public/hosts/components/host_risk_score_table/translations.ts @@ -0,0 +1,47 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import { i18n } from '@kbn/i18n'; + +export const HOST_NAME = i18n.translate('xpack.securitySolution.hostsRiskTable.hostNameTitle', { + defaultMessage: 'Host Name', +}); + +export const HOST_RISK_SCORE = i18n.translate( + 'xpack.securitySolution.hostsRiskTable.hostRiskScoreTitle', + { + defaultMessage: 'Host risk score', + } +); + +export const HOST_RISK = i18n.translate('xpack.securitySolution.hostsRiskTable.riskTitle', { + defaultMessage: 'Host risk classification', +}); +export const HOST_RISK_TOOLTIP = i18n.translate( + 'xpack.securitySolution.hostsRiskTable.hostRiskToolTip', + { + defaultMessage: + 'Host risk classification is determined by host risk score. Hosts classified as Critical or High are indicated as risky.', + } +); + +export const HOSTS_BY_RISK = i18n.translate('xpack.securitySolution.hostsRiskTable.hostsTitle', { + defaultMessage: 'Hosts by risk', +}); + +export const HOST_RISK_TABLE_TOOLTIP = i18n.translate( + 'xpack.securitySolution.hostsRiskTable.hostsTableTitle', + { + defaultMessage: + 'The host risk table is not affected by the KQL time range. This table shows the latest recorded risk score for each host.', + } +); + +export const VIEW_HOSTS_BY_SEVERITY = (severity: string) => + i18n.translate('xpack.securitySolution.hostsRiskTable.filteredHostsTitle', { + values: { severity }, + defaultMessage: 'View {severity} risk hosts', + }); diff --git a/x-pack/plugins/security_solution/public/hosts/components/host_score_over_time/index.test.tsx b/x-pack/plugins/security_solution/public/hosts/components/host_score_over_time/index.test.tsx index 9a7dfcc967fbb..cf0d881b09235 100644 --- a/x-pack/plugins/security_solution/public/hosts/components/host_score_over_time/index.test.tsx +++ b/x-pack/plugins/security_solution/public/hosts/components/host_score_over_time/index.test.tsx @@ -9,16 +9,20 @@ import { render } from '@testing-library/react'; import React from 'react'; import { HostRiskScoreOverTime } from '.'; import { TestProviders } from '../../../common/mock'; -import { useHostsRiskScore } from '../../../common/containers/hosts_risk/use_hosts_risk_score'; +import { useHostRiskScore } from '../../containers/host_risk_score'; -jest.mock('../../../common/containers/hosts_risk/use_hosts_risk_score'); -const useHostsRiskScoreMock = useHostsRiskScore as jest.Mock; +jest.mock('../../containers/host_risk_score'); +const useHostRiskScoreMock = useHostRiskScore as jest.Mock; describe('Host Risk Flyout', () => { it('renders', () => { + useHostRiskScoreMock.mockReturnValueOnce([false, { data: [], isModuleEnabled: true }]); + const { queryByTestId } = render( { }); it('renders loader when HostsRiskScore is laoding', () => { - useHostsRiskScoreMock.mockReturnValueOnce({ - loading: true, - isModuleEnabled: true, - result: [], - }); + useHostRiskScoreMock.mockReturnValueOnce([true, { data: [], isModuleEnabled: true }]); const { queryByTestId } = render( { hostName: string; from: string; to: string; } -const RISKY_TRESHOULD = 70; -const DEFAULT_CHART_HEIGH = 250; +const RISKY_THRESHOLD = 70; +const DEFAULT_CHART_HEIGHT = 250; +const QUERY_ID = HostRiskScoreQueryId.HOST_RISK_SCORE_OVER_TIME; const StyledEuiText = styled(EuiText)` font-size: 9px; @@ -54,13 +58,12 @@ const HostRiskScoreOverTimeComponent: React.FC = ({ hostName, from, to, + setQuery, + deleteQuery, }) => { const timeZone = useTimeZone(); - const memoizedDataTimeFormatter = useMemo( - () => histogramDateTimeFormatter([from, to]), - [from, to] - ); + const dataTimeFormatter = useMemo(() => histogramDateTimeFormatter([from, to]), [from, to]); const scoreFormatter = useCallback((d: number) => Math.round(d).toString(), []); const headerFormatter = useCallback( (tooltip: TooltipValue) => , @@ -76,24 +79,32 @@ const HostRiskScoreOverTimeComponent: React.FC = ({ ); const theme = useTheme(); - const hostRisk = useHostsRiskScore({ + const [loading, { data, refetch, inspect }] = useHostRiskScore({ hostName, onlyLatest: false, timerange, - queryId: HostRiskScoreQueryId.HOST_RISK_SCORE_OVER_TIME, }); - const data = useMemo( + const graphData = useMemo( () => - hostRisk?.result - ?.map((result) => ({ - x: result['@timestamp'], - y: result.risk_stats.risk_score, + data + ?.map((hostRisk) => ({ + x: hostRisk['@timestamp'], + y: hostRisk.risk_stats.risk_score, })) .reverse() ?? [], - [hostRisk] + [data] ); + useQueryInspector({ + queryId: QUERY_ID, + loading, + refetch, + setQuery, + deleteQuery, + inspect, + }); + return ( @@ -103,17 +114,14 @@ const HostRiskScoreOverTimeComponent: React.FC = ({ - + -
- {hostRisk?.loading ? ( +
+ {loading ? ( ) : ( @@ -127,7 +135,7 @@ const HostRiskScoreOverTimeComponent: React.FC = ({ = ({ xAccessor="x" yAccessors={['y']} timeZone={timeZone} - data={data} + data={graphData} tickFormat={scoreFormatter} /> = ({ domainType={AnnotationDomainType.YDomain} dataValues={[ { - dataValue: RISKY_TRESHOULD, - details: RISKY_TRESHOULD.toString(), + dataValue: RISKY_THRESHOLD, + details: `${RISKY_THRESHOLD}`, header: i18n.HOST_RISK_THRESHOLD, }, ]} diff --git a/x-pack/plugins/security_solution/public/hosts/components/hosts_table/columns.tsx b/x-pack/plugins/security_solution/public/hosts/components/hosts_table/columns.tsx index 30f62c7637974..d6f7809cca606 100644 --- a/x-pack/plugins/security_solution/public/hosts/components/hosts_table/columns.tsx +++ b/x-pack/plugins/security_solution/public/hosts/components/hosts_table/columns.tsx @@ -5,7 +5,7 @@ * 2.0. */ -import { EuiIcon, EuiToolTip } from '@elastic/eui'; +import { EuiIcon, EuiLink, EuiText, EuiToolTip } from '@elastic/eui'; import React from 'react'; import { DragEffects, @@ -23,8 +23,12 @@ import { HostsTableColumns } from './'; import * as i18n from './translations'; import { HostRiskSeverity, Maybe } from '../../../../common/search_strategy'; import { HostRiskScore } from '../common/host_risk_score'; +import { VIEW_HOSTS_BY_SEVERITY } from '../host_risk_score_table/translations'; -export const getHostsColumns = (showRiskColumn: boolean): HostsTableColumns => { +export const getHostsColumns = ( + showRiskColumn: boolean, + dispatchSeverityUpdate: (s: HostRiskSeverity) => void +): HostsTableColumns => { const columns: HostsTableColumns = [ { field: 'node.host.name', @@ -153,7 +157,16 @@ export const getHostsColumns = (showRiskColumn: boolean): HostsTableColumns => { sortable: false, render: (riskScore: HostRiskSeverity) => { if (riskScore != null) { - return ; + return ( + dispatchSeverityUpdate(riskScore)}> + {VIEW_HOSTS_BY_SEVERITY(riskScore.toLowerCase())} + + } + severity={riskScore} + /> + ); } return getEmptyTagValue(); }, diff --git a/x-pack/plugins/security_solution/public/hosts/components/hosts_table/index.test.tsx b/x-pack/plugins/security_solution/public/hosts/components/hosts_table/index.test.tsx index e30e87ffcb8fb..71efbb0a44d15 100644 --- a/x-pack/plugins/security_solution/public/hosts/components/hosts_table/index.test.tsx +++ b/x-pack/plugins/security_solution/public/hosts/components/hosts_table/index.test.tsx @@ -27,6 +27,12 @@ import { useIsExperimentalFeatureEnabled } from '../../../common/hooks/use_exper jest.mock('../../../common/lib/kibana'); +jest.mock('../../../common/lib/kibana/hooks', () => ({ + useNavigateTo: () => ({ + navigateTo: jest.fn(), + }), +})); + // Test will fail because we will to need to mock some core services to make the test work // For now let's forget about SiemSearchBar and QueryBar jest.mock('../../../common/components/search_bar', () => ({ diff --git a/x-pack/plugins/security_solution/public/hosts/components/hosts_table/index.tsx b/x-pack/plugins/security_solution/public/hosts/components/hosts_table/index.tsx index dc9312b1ad4c4..2415d83f11fef 100644 --- a/x-pack/plugins/security_solution/public/hosts/components/hosts_table/index.tsx +++ b/x-pack/plugins/security_solution/public/hosts/components/hosts_table/index.tsx @@ -30,6 +30,9 @@ import { import { Direction } from '../../../../common/search_strategy'; import { HostEcs, OsEcs } from '../../../../common/ecs/host'; import { useIsExperimentalFeatureEnabled } from '../../../common/hooks/use_experimental_features'; +import { SecurityPageName } from '../../../../common/constants'; +import { HostsTableType } from '../../store/model'; +import { useNavigateTo } from '../../../common/lib/kibana/hooks'; const tableType = hostsModel.HostsTableType.hosts; @@ -80,10 +83,12 @@ const HostsTableComponent: React.FC = ({ type, }) => { const dispatch = useDispatch(); + const { navigateTo } = useNavigateTo(); const getHostsSelector = useMemo(() => hostsSelectors.hostsSelector(), []); const { activePage, direction, limit, sortField } = useDeepEqualSelector((state) => getHostsSelector(state, type) ); + const updateLimitPagination = useCallback( (newLimit) => dispatch( @@ -129,9 +134,25 @@ const HostsTableComponent: React.FC = ({ ); const riskyHostsFeatureEnabled = useIsExperimentalFeatureEnabled('riskyHostsEnabled'); + const dispatchSeverityUpdate = useCallback( + (s: HostRiskSeverity) => { + dispatch( + hostsActions.updateHostRiskScoreSeverityFilter({ + severitySelection: [s], + hostsType: type, + }) + ); + navigateTo({ + deepLinkId: SecurityPageName.hosts, + path: HostsTableType.risk, + }); + }, + [dispatch, navigateTo, type] + ); + const hostsColumns = useMemo( - () => getHostsColumns(riskyHostsFeatureEnabled), - [riskyHostsFeatureEnabled] + () => getHostsColumns(riskyHostsFeatureEnabled, dispatchSeverityUpdate), + [dispatchSeverityUpdate, riskyHostsFeatureEnabled] ); const sorting = useMemo(() => getSorting(sortField, direction), [sortField, direction]); diff --git a/x-pack/plugins/security_solution/public/hosts/components/hosts_table/translations.ts b/x-pack/plugins/security_solution/public/hosts/components/hosts_table/translations.ts index 15276355f800c..4c825ad0e5d37 100644 --- a/x-pack/plugins/security_solution/public/hosts/components/hosts_table/translations.ts +++ b/x-pack/plugins/security_solution/public/hosts/components/hosts_table/translations.ts @@ -17,6 +17,10 @@ export const UNIT = (totalCount: number) => defaultMessage: `{totalCount, plural, =1 {host} other {hosts}}`, }); +export const RISK_SCORE = i18n.translate('xpack.securitySolution.hostsRiskTable.tableTitle', { + defaultMessage: 'Host risk', +}); + export const NAME = i18n.translate('xpack.securitySolution.hostsTable.nameTitle', { defaultMessage: 'Host name', }); diff --git a/x-pack/plugins/security_solution/public/hosts/components/kpi_hosts/index.tsx b/x-pack/plugins/security_solution/public/hosts/components/kpi_hosts/index.tsx index 1f854b1328aad..9660aa059e773 100644 --- a/x-pack/plugins/security_solution/public/hosts/components/kpi_hosts/index.tsx +++ b/x-pack/plugins/security_solution/public/hosts/components/kpi_hosts/index.tsx @@ -12,31 +12,18 @@ import { HostsKpiAuthentications } from './authentications'; import { HostsKpiHosts } from './hosts'; import { HostsKpiUniqueIps } from './unique_ips'; import { HostsKpiProps } from './types'; -import { RiskyHosts } from './risky_hosts'; -import { useIsExperimentalFeatureEnabled } from '../../../common/hooks/use_experimental_features'; -import { useRiskyHosts } from '../../containers/kpi_hosts/risky_hosts'; import { CallOutSwitcher } from '../../../common/components/callouts'; import { RISKY_HOSTS_DOC_LINK } from '../../../overview/components/overview_risky_host_links/risky_hosts_disabled_module'; import * as i18n from './translations'; +import { useHostRiskScore } from '../../containers/host_risk_score'; export const HostsKpiComponent = React.memo( ({ filterQuery, from, indexNames, to, setQuery, skip, narrowDateRange }) => { - const riskyHostsExperimentEnabled = useIsExperimentalFeatureEnabled('riskyHostsEnabled'); - const { - error, - response, - loading, - isModuleDisabled: isRiskHostsModuleDisabled, - } = useRiskyHosts({ - filterQuery, - from, - to, - skip: skip || !riskyHostsExperimentEnabled, - }); + const [_, { isModuleEnabled }] = useHostRiskScore({}); return ( <> - {isRiskHostsModuleDisabled && ( + {isModuleEnabled === false && ( <> ( )} - + ( skip={skip} /> - {riskyHostsExperimentEnabled && ( - - - - )} + + + { it('renders', () => { + useHostRiskScoreMock.mockReturnValueOnce([ + true, + { + data: [], + isModuleEnabled: true, + }, + ]); + const { queryByTestId } = render( { }); it('renders sorted items', () => { - useHostsRiskScoreMock.mockReturnValueOnce({ - loading: true, - isModuleEnabled: true, - result: [ - { - risk_stats: { - rule_risks: [ - { - rule_name: 'third', - rule_risk: '10', - }, - { - rule_name: 'first', - rule_risk: '99', - }, - { - rule_name: 'second', - rule_risk: '55', - }, - ], + useHostRiskScoreMock.mockReturnValueOnce([ + true, + { + data: [ + { + risk_stats: { + rule_risks: [ + { + rule_name: 'third', + rule_risk: '10', + }, + { + rule_name: 'first', + rule_risk: '99', + }, + { + rule_name: 'second', + rule_risk: '55', + }, + ], + }, }, - }, - ], - }); + ], + isModuleEnabled: true, + }, + ]); const { queryAllByRole } = render( { hostName: string; from: string; to: string; } - interface TableItem { rank: number; name: string; + id?: string; // TODO Remove the '?' when the new transform is delivered } const columns: Array> = [ @@ -45,15 +51,20 @@ const columns: Array> = [ field: 'name', sortable: true, truncateText: true, + render: (value: TableItem['name'], { id }: TableItem) => + id ? : value, }, ]; const PAGE_SIZE = 5; +const QUERY_ID = HostRiskScoreQueryId.TOP_HOST_SCORE_CONTRIBUTORS; const TopHostScoreContributorsComponent: React.FC = ({ hostName, from, to, + setQuery, + deleteQuery, }) => { const timerange = useMemo( () => ({ @@ -63,25 +74,31 @@ const TopHostScoreContributorsComponent: React.FC [from, to] ); - const hostRisk = useHostsRiskScore({ + const sort = useMemo( + () => ({ field: HostRiskScoreFields.timestamp, direction: Direction.desc }), + [] + ); + + const [loading, { data, refetch, inspect }] = useHostRiskScore({ hostName, timerange, onlyLatest: false, - queryId: HostRiskScoreQueryId.TOP_HOST_SCORE_CONTRIBUTORS, - limit: 1, - sortOrder: Direction.desc, + sort, + pagination: { + querySize: 1, + cursorStart: 0, + }, }); - const result = hostRisk?.result; - const items = useMemo(() => { - const rules = result && result.length > 0 ? result[0].risk_stats.rule_risks : []; + const rules = data && data.length > 0 ? data[0].risk_stats.rule_risks : []; + return rules .sort((a, b) => b.rule_risk - a.rule_risk) - .map(({ rule_name: name }, i) => ({ rank: i + 1, name })); - }, [result]); + .map(({ rule_name: name, rule_id: id }, i) => ({ rank: i + 1, name, id })); + }, [data]); - const pagination = useMemo( + const tablePagination = useMemo( () => ({ hidePerPageOptions: true, pageSize: PAGE_SIZE, @@ -90,6 +107,15 @@ const TopHostScoreContributorsComponent: React.FC [items.length] ); + useQueryInspector({ + queryId: QUERY_ID, + loading, + refetch, + setQuery, + deleteQuery, + inspect, + }); + return ( @@ -99,10 +125,7 @@ const TopHostScoreContributorsComponent: React.FC - + @@ -111,8 +134,8 @@ const TopHostScoreContributorsComponent: React.FC diff --git a/x-pack/plugins/security_solution/public/hosts/containers/host_risk_score/index.tsx b/x-pack/plugins/security_solution/public/hosts/containers/host_risk_score/index.tsx new file mode 100644 index 0000000000000..7f2c41f1414cf --- /dev/null +++ b/x-pack/plugins/security_solution/public/hosts/containers/host_risk_score/index.tsx @@ -0,0 +1,223 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import deepEqual from 'fast-deep-equal'; +import { noop } from 'lodash/fp'; +import { useCallback, useEffect, useRef, useState } from 'react'; +import { Subscription } from 'rxjs'; + +import { inputsModel } from '../../../common/store'; +import { createFilter } from '../../../common/containers/helpers'; +import { useKibana } from '../../../common/lib/kibana'; +import { + HostsQueries, + HostsRiskScoreStrategyResponse, + getHostRiskIndex, + HostsRiskScore, + HostRiskScoreSortField, + HostsRiskScoreRequestOptions, +} from '../../../../common/search_strategy'; +import { ESQuery } from '../../../../common/typed_json'; + +import * as i18n from './translations'; +import { isCompleteResponse, isErrorResponse } from '../../../../../../../src/plugins/data/common'; +import { getInspectResponse } from '../../../helpers'; +import { InspectResponse } from '../../../types'; +import { useTransforms } from '../../../transforms/containers/use_transforms'; +import { useAppToasts } from '../../../common/hooks/use_app_toasts'; +import { isIndexNotFoundError } from '../../../common/utils/exceptions'; +import { useIsExperimentalFeatureEnabled } from '../../../common/hooks/use_experimental_features'; + +export interface HostRiskScoreState { + data?: HostsRiskScore[]; + inspect: InspectResponse; + isInspected: boolean; + refetch: inputsModel.Refetch; + totalCount: number; + isModuleEnabled: boolean | undefined; +} + +interface UseHostRiskScore { + sort?: HostRiskScoreSortField; + filterQuery?: ESQuery | string; + skip?: boolean; + timerange?: { to: string; from: string }; + hostName?: string; + onlyLatest?: boolean; + pagination?: HostsRiskScoreRequestOptions['pagination']; +} + +const isRecord = (item: unknown): item is Record => + typeof item === 'object' && !!item; + +export const isHostsRiskScoreHit = (item: Partial): item is HostsRiskScore => + isRecord(item) && + isRecord(item.host) && + typeof item.risk_stats?.risk_score === 'number' && + typeof item.risk === 'string'; + +export const useHostRiskScore = ({ + timerange, + hostName, + onlyLatest = true, + filterQuery, + sort, + skip = false, + pagination, +}: UseHostRiskScore): [boolean, HostRiskScoreState] => { + const { querySize, cursorStart } = pagination || {}; + const { data, spaces } = useKibana().services; + const refetch = useRef(noop); + const abortCtrl = useRef(new AbortController()); + const searchSubscription = useRef(new Subscription()); + const riskyHostsFeatureEnabled = useIsExperimentalFeatureEnabled('riskyHostsEnabled'); + const [loading, setLoading] = useState(riskyHostsFeatureEnabled); + const [riskScoreRequest, setHostRiskScoreRequest] = useState( + null + ); + const { getTransformChangesIfTheyExist } = useTransforms(); + const { addError, addWarning } = useAppToasts(); + + const [riskScoreResponse, setHostRiskScoreResponse] = useState({ + data: undefined, + inspect: { + dsl: [], + response: [], + }, + isInspected: false, + refetch: refetch.current, + totalCount: 0, + isModuleEnabled: undefined, + }); + + const riskScoreSearch = useCallback( + (request: HostsRiskScoreRequestOptions | null) => { + if (request == null || skip) { + return; + } + + const asyncSearch = async () => { + abortCtrl.current = new AbortController(); + setLoading(true); + + searchSubscription.current = data.search + .search(request, { + strategy: 'securitySolutionSearchStrategy', + abortSignal: abortCtrl.current.signal, + }) + .subscribe({ + next: (response) => { + if (isCompleteResponse(response)) { + const hits = response?.rawResponse?.hits?.hits; + + setHostRiskScoreResponse((prevResponse) => ({ + ...prevResponse, + data: isHostsRiskScoreHit(hits?.[0]?._source) + ? (hits?.map((hit) => hit._source) as HostsRiskScore[]) + : [], + inspect: getInspectResponse(response, prevResponse.inspect), + refetch: refetch.current, + totalCount: response.totalCount, + isModuleEnabled: true, + })); + searchSubscription.current.unsubscribe(); + setLoading(false); + } else if (isErrorResponse(response)) { + setLoading(false); + addWarning(i18n.ERROR_RISK_SCORE); + searchSubscription.current.unsubscribe(); + } + }, + error: (error) => { + setLoading(false); + if (isIndexNotFoundError(error)) { + setHostRiskScoreResponse((prevResponse) => + !prevResponse + ? prevResponse + : { + ...prevResponse, + isModuleEnabled: false, + } + ); + + setLoading(false); + } else { + addError(error, { title: i18n.FAIL_RISK_SCORE }); + } + + searchSubscription.current.unsubscribe(); + }, + }); + }; + searchSubscription.current.unsubscribe(); + abortCtrl.current.abort(); + if (riskyHostsFeatureEnabled) { + asyncSearch(); + } + + refetch.current = asyncSearch; + }, + [data.search, addError, addWarning, skip, riskyHostsFeatureEnabled] + ); + const [spaceId, setSpaceId] = useState(); + + useEffect(() => { + if (spaces) { + spaces.getActiveSpace().then((space) => setSpaceId(space.id)); + } + }, [spaces]); + + useEffect(() => { + if (spaceId) { + setHostRiskScoreRequest((prevRequest) => { + const myRequest = { + ...(prevRequest ?? {}), + defaultIndex: [getHostRiskIndex(spaceId, onlyLatest)], + factoryQueryType: HostsQueries.hostsRiskScore, + filterQuery: createFilter(filterQuery), + pagination: + cursorStart && querySize + ? { + cursorStart, + querySize, + } + : undefined, + hostNames: hostName ? [hostName] : undefined, + timerange: timerange + ? { to: timerange.to, from: timerange.from, interval: '' } + : undefined, + sort, + }; + + if (!deepEqual(prevRequest, myRequest)) { + return myRequest; + } + return prevRequest; + }); + } + }, [ + filterQuery, + spaceId, + onlyLatest, + timerange, + cursorStart, + querySize, + sort, + hostName, + getTransformChangesIfTheyExist, + ]); + + useEffect(() => { + riskScoreSearch(riskScoreRequest); + return () => { + searchSubscription.current.unsubscribe(); + abortCtrl.current.abort(); + }; + }, [riskScoreRequest, riskScoreSearch]); + + return [loading, riskScoreResponse]; +}; diff --git a/x-pack/plugins/security_solution/public/hosts/containers/host_risk_score/translations.ts b/x-pack/plugins/security_solution/public/hosts/containers/host_risk_score/translations.ts new file mode 100644 index 0000000000000..8cc275674d4e9 --- /dev/null +++ b/x-pack/plugins/security_solution/public/hosts/containers/host_risk_score/translations.ts @@ -0,0 +1,22 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { i18n } from '@kbn/i18n'; + +export const ERROR_RISK_SCORE = i18n.translate( + 'xpack.securitySolution.riskScore.errorSearchDescription', + { + defaultMessage: `An error has occurred on risk score search`, + } +); + +export const FAIL_RISK_SCORE = i18n.translate( + 'xpack.securitySolution.riskScore.failSearchDescription', + { + defaultMessage: `Failed to run search on risk score`, + } +); diff --git a/x-pack/plugins/security_solution/public/hosts/containers/kpi_hosts/risky_hosts/index.tsx b/x-pack/plugins/security_solution/public/hosts/containers/kpi_hosts/risky_hosts/index.tsx index d3785c842af90..090560842f388 100644 --- a/x-pack/plugins/security_solution/public/hosts/containers/kpi_hosts/risky_hosts/index.tsx +++ b/x-pack/plugins/security_solution/public/hosts/containers/kpi_hosts/risky_hosts/index.tsx @@ -7,12 +7,13 @@ import type { Observable } from 'rxjs'; import { filter } from 'rxjs/operators'; -import { useEffect, useState } from 'react'; +import { useEffect, useMemo, useState } from 'react'; import { useObservable, withOptionalSignal } from '@kbn/securitysolution-hook-utils'; import { createFilter } from '../../../../common/containers/helpers'; import { getHostRiskIndex, + HostRiskSeverity, HostsKpiQueries, RequestBasicOptions, } from '../../../../../common/search_strategy'; @@ -25,6 +26,8 @@ import type { DataPublicPluginStart } from '../../../../../../../../src/plugins/ import type { HostsKpiRiskyHostsStrategyResponse } from '../../../../../common/search_strategy/security_solution/hosts/kpi/risky_hosts'; import { useKibana } from '../../../../common/lib/kibana'; import { isIndexNotFoundError } from '../../../../common/utils/exceptions'; +import { ESTermQuery } from '../../../../../common/typed_json'; +import { useIsExperimentalFeatureEnabled } from '../../../../common/hooks/use_experimental_features'; export type RiskyHostsScoreRequestOptions = RequestBasicOptions; @@ -33,7 +36,7 @@ type GetHostsRiskScoreProps = RiskyHostsScoreRequestOptions & { signal: AbortSignal; }; -export const getRiskyHosts = ({ +const getRiskyHosts = ({ data, defaultIndex, timerange, @@ -53,7 +56,7 @@ export const getRiskyHosts = ({ } ); -export const getRiskyHostsComplete = ( +const getRiskyHostsComplete = ( props: GetHostsRiskScoreProps ): Observable => { return getRiskyHosts(props).pipe( @@ -68,16 +71,32 @@ const getRiskyHostsWithOptionalSignal = withOptionalSignal(getRiskyHostsComplete const useRiskyHostsComplete = () => useObservable(getRiskyHostsWithOptionalSignal); interface UseRiskyHostProps { - filterQuery?: string; + filterQuery?: string | ESTermQuery; from: string; to: string; - skip: boolean; + skip?: boolean; +} +export type SeverityCount = { + [k in HostRiskSeverity]: number; +}; + +interface RiskScoreKpi { + error: unknown; + isModuleDisabled: boolean; + severityCount: SeverityCount; + loading: boolean; } -export const useRiskyHosts = ({ filterQuery, from, to, skip }: UseRiskyHostProps) => { - const { error, result: response, start, loading } = useRiskyHostsComplete(); +export const useRiskScoreKpi = ({ + filterQuery, + from, + to, + skip, +}: UseRiskyHostProps): RiskScoreKpi => { + const riskyHostsFeatureEnabled = useIsExperimentalFeatureEnabled('riskyHostsEnabled'); + const { error, result, start, loading } = useRiskyHostsComplete(); const { data, spaces } = useKibana().services; - const isModuleDisabled = error && isIndexNotFoundError(error); + const isModuleDisabled = !!error && isIndexNotFoundError(error); const [spaceId, setSpaceId] = useState(); useEffect(() => { @@ -87,7 +106,7 @@ export const useRiskyHosts = ({ filterQuery, from, to, skip }: UseRiskyHostProps }, [spaces]); useEffect(() => { - if (!skip && spaceId) { + if (!skip && spaceId && riskyHostsFeatureEnabled) { start({ data, timerange: { to, from, interval: '' }, @@ -95,7 +114,18 @@ export const useRiskyHosts = ({ filterQuery, from, to, skip }: UseRiskyHostProps defaultIndex: [getHostRiskIndex(spaceId)], }); } - }, [data, spaceId, start, filterQuery, to, from, skip]); + }, [data, spaceId, start, filterQuery, to, from, skip, riskyHostsFeatureEnabled]); - return { error, response, loading, isModuleDisabled }; + const severityCount = useMemo( + () => ({ + [HostRiskSeverity.unknown]: 0, + [HostRiskSeverity.low]: 0, + [HostRiskSeverity.moderate]: 0, + [HostRiskSeverity.high]: 0, + [HostRiskSeverity.critical]: 0, + ...(result?.riskyHosts ?? {}), + }), + [result] + ); + return { error, severityCount, loading, isModuleDisabled }; }; diff --git a/x-pack/plugins/security_solution/public/hosts/pages/details/details_tabs.test.tsx b/x-pack/plugins/security_solution/public/hosts/pages/details/details_tabs.test.tsx index 259f3f7540e73..f2b0a64cbe60c 100644 --- a/x-pack/plugins/security_solution/public/hosts/pages/details/details_tabs.test.tsx +++ b/x-pack/plugins/security_solution/public/hosts/pages/details/details_tabs.test.tsx @@ -23,6 +23,12 @@ jest.mock('../../../common/lib/kibana'); jest.mock('../../../common/components/url_state/normalize_time_range.ts'); +jest.mock('../../../common/lib/kibana/hooks', () => ({ + useNavigateTo: () => ({ + navigateTo: jest.fn(), + }), +})); + jest.mock('../../../common/containers/source', () => ({ useFetchIndex: () => [false, { indicesExist: true, indexPatterns: mockIndexPattern }], })); diff --git a/x-pack/plugins/security_solution/public/hosts/pages/hosts.tsx b/x-pack/plugins/security_solution/public/hosts/pages/hosts.tsx index 96086e2de1b3e..f850ff4c63026 100644 --- a/x-pack/plugins/security_solution/public/hosts/pages/hosts.tsx +++ b/x-pack/plugins/security_solution/public/hosts/pages/hosts.tsx @@ -29,7 +29,7 @@ import { TimelineId } from '../../../common/types/timeline'; import { LastEventIndexKey } from '../../../common/search_strategy'; import { useKibana } from '../../common/lib/kibana'; import { convertToBuildEsQuery } from '../../common/lib/keury'; -import { inputsSelectors } from '../../common/store'; +import { inputsSelectors, State } from '../../common/store'; import { setAbsoluteRangeDatePicker } from '../../common/store/inputs/actions'; import { SpyRoute } from '../../common/utils/route/spy_routes'; @@ -41,7 +41,8 @@ import { HostsTabs } from './hosts_tabs'; import { navTabsHosts } from './nav_tabs'; import * as i18n from './translations'; import { filterHostData } from './navigation'; -import { hostsModel } from '../store'; +import { hostsModel, hostsSelectors } from '../store'; +import { generateSeverityFilter } from '../store/helpers'; import { HostsTableType } from '../store/model'; import { onTimelineTabKeyPressed, @@ -54,6 +55,7 @@ import { useSourcererDataView } from '../../common/containers/sourcerer'; import { useDeepEqualSelector, useShallowEqualSelector } from '../../common/hooks/use_selector'; import { useInvalidFilterQuery } from '../../common/hooks/use_invalid_filter_query'; import { ID } from '../containers/hosts'; +import { useIsExperimentalFeatureEnabled } from '../../common/hooks/use_experimental_features'; /** * Need a 100% height here to account for the graph/analyze tool, which sets no explicit height parameters, but fills the available space. @@ -83,6 +85,13 @@ const HostsComponent = () => { const getGlobalQuerySelector = useMemo(() => inputsSelectors.globalQuerySelector(), []); const query = useDeepEqualSelector(getGlobalQuerySelector); const filters = useDeepEqualSelector(getGlobalFiltersQuerySelector); + const getHostRiskScoreFilterQuerySelector = useMemo( + () => hostsSelectors.hostRiskScoreSeverityFilterSelector(), + [] + ); + const severitySelection = useDeepEqualSelector((state: State) => + getHostRiskScoreFilterQuerySelector(state, hostsModel.HostsType.page) + ); const { to, from, deleteQuery, setQuery, isInitializing } = useGlobalTime(); const { globalFullScreen } = useGlobalFullScreen(); @@ -93,8 +102,14 @@ const HostsComponent = () => { if (tabName === HostsTableType.alerts) { return filters.length > 0 ? [...filters, ...filterHostData] : filterHostData; } + + if (tabName === HostsTableType.risk) { + const severityFilter = generateSeverityFilter(severitySelection); + + return [...severityFilter, ...filterHostData, ...filters]; + } return filters; - }, [tabName, filters]); + }, [severitySelection, tabName, filters]); const narrowDateRange = useCallback( ({ x }) => { if (!x) { @@ -133,6 +148,8 @@ const HostsComponent = () => { [indexPattern, query, tabsFilters, uiSettings] ); + const riskyHostsFeatureEnabled = useIsExperimentalFeatureEnabled('riskyHostsEnabled'); + useInvalidFilterQuery({ id: ID, filterQuery, kqlError, query, startDate: from, endDate: to }); const onSkipFocusBeforeEventsTable = useCallback(() => { @@ -195,7 +212,7 @@ const HostsComponent = () => { diff --git a/x-pack/plugins/security_solution/public/hosts/pages/hosts_tabs.tsx b/x-pack/plugins/security_solution/public/hosts/pages/hosts_tabs.tsx index 7d7288c878369..07979c289309a 100644 --- a/x-pack/plugins/security_solution/public/hosts/pages/hosts_tabs.tsx +++ b/x-pack/plugins/security_solution/public/hosts/pages/hosts_tabs.tsx @@ -18,6 +18,7 @@ import { UpdateDateRange } from '../../common/components/charts/common'; import { HOSTS_PATH } from '../../../common/constants'; import { HostsQueryTabBody, + HostRiskScoreQueryTabBody, AuthenticationsQueryTabBody, UncommonProcessQueryTabBody, EventsQueryTabBody, @@ -85,6 +86,9 @@ export const HostsTabs = memo( + + + diff --git a/x-pack/plugins/security_solution/public/hosts/pages/index.tsx b/x-pack/plugins/security_solution/public/hosts/pages/index.tsx index 64acbbc666312..0f5b2ca20da48 100644 --- a/x-pack/plugins/security_solution/public/hosts/pages/index.tsx +++ b/x-pack/plugins/security_solution/public/hosts/pages/index.tsx @@ -22,6 +22,7 @@ const getHostsTabPath = () => `${HostsTableType.uncommonProcesses}|` + `${HostsTableType.anomalies}|` + `${HostsTableType.events}|` + + `${HostsTableType.risk}|` + `${HostsTableType.alerts})`; const getHostDetailsTabPath = () => diff --git a/x-pack/plugins/security_solution/public/hosts/pages/nav_tabs.test.tsx b/x-pack/plugins/security_solution/public/hosts/pages/nav_tabs.test.tsx index 154dd8dda0f5d..50e301d4b4f57 100644 --- a/x-pack/plugins/security_solution/public/hosts/pages/nav_tabs.test.tsx +++ b/x-pack/plugins/security_solution/public/hosts/pages/nav_tabs.test.tsx @@ -10,7 +10,7 @@ import { navTabsHosts } from './nav_tabs'; describe('navTabsHosts', () => { test('it should skip anomalies tab if without mlUserPermission', () => { - const tabs = navTabsHosts(false); + const tabs = navTabsHosts(false, false); expect(tabs).toHaveProperty(HostsTableType.hosts); expect(tabs).toHaveProperty(HostsTableType.authentications); expect(tabs).toHaveProperty(HostsTableType.uncommonProcesses); @@ -19,11 +19,28 @@ describe('navTabsHosts', () => { }); test('it should display anomalies tab if with mlUserPermission', () => { - const tabs = navTabsHosts(true); + const tabs = navTabsHosts(true, false); expect(tabs).toHaveProperty(HostsTableType.hosts); expect(tabs).toHaveProperty(HostsTableType.authentications); expect(tabs).toHaveProperty(HostsTableType.uncommonProcesses); expect(tabs).toHaveProperty(HostsTableType.anomalies); expect(tabs).toHaveProperty(HostsTableType.events); }); + test('it should skip risk tab if without hostRisk', () => { + const tabs = navTabsHosts(false, false); + expect(tabs).toHaveProperty(HostsTableType.hosts); + expect(tabs).toHaveProperty(HostsTableType.authentications); + expect(tabs).toHaveProperty(HostsTableType.uncommonProcesses); + expect(tabs).not.toHaveProperty(HostsTableType.risk); + expect(tabs).toHaveProperty(HostsTableType.events); + }); + + test('it should display risk tab if with hostRisk', () => { + const tabs = navTabsHosts(false, true); + expect(tabs).toHaveProperty(HostsTableType.hosts); + expect(tabs).toHaveProperty(HostsTableType.authentications); + expect(tabs).toHaveProperty(HostsTableType.uncommonProcesses); + expect(tabs).toHaveProperty(HostsTableType.risk); + expect(tabs).toHaveProperty(HostsTableType.events); + }); }); diff --git a/x-pack/plugins/security_solution/public/hosts/pages/nav_tabs.tsx b/x-pack/plugins/security_solution/public/hosts/pages/nav_tabs.tsx index c43a6431d2da8..0d8a5e252bfbb 100644 --- a/x-pack/plugins/security_solution/public/hosts/pages/nav_tabs.tsx +++ b/x-pack/plugins/security_solution/public/hosts/pages/nav_tabs.tsx @@ -13,7 +13,11 @@ import { HOSTS_PATH } from '../../../common/constants'; const getTabsOnHostsUrl = (tabName: HostsTableType) => `${HOSTS_PATH}/${tabName}`; -export const navTabsHosts = (hasMlUserPermissions: boolean): HostsNavTab => { +export const navTabsHosts = ( + hasMlUserPermissions: boolean, + isRiskyHostsEnabled: boolean +): HostsNavTab => { + const hiddenTabs = []; const hostsNavTabs = { [HostsTableType.hosts]: { id: HostsTableType.hosts, @@ -51,7 +55,21 @@ export const navTabsHosts = (hasMlUserPermissions: boolean): HostsNavTab => { href: getTabsOnHostsUrl(HostsTableType.alerts), disabled: false, }, + [HostsTableType.risk]: { + id: HostsTableType.risk, + name: i18n.NAVIGATION_HOST_RISK_TITLE, + href: getTabsOnHostsUrl(HostsTableType.risk), + disabled: false, + }, }; - return hasMlUserPermissions ? hostsNavTabs : omit([HostsTableType.anomalies], hostsNavTabs); + if (!hasMlUserPermissions) { + hiddenTabs.push(HostsTableType.anomalies); + } + + if (!isRiskyHostsEnabled) { + hiddenTabs.push(HostsTableType.risk); + } + + return omit(hiddenTabs, hostsNavTabs); }; diff --git a/x-pack/plugins/security_solution/public/hosts/pages/navigation/host_risk_score_tab_body.tsx b/x-pack/plugins/security_solution/public/hosts/pages/navigation/host_risk_score_tab_body.tsx new file mode 100644 index 0000000000000..f2d7c70ab2f0c --- /dev/null +++ b/x-pack/plugins/security_solution/public/hosts/pages/navigation/host_risk_score_tab_body.tsx @@ -0,0 +1,75 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useMemo } from 'react'; +import { noop } from 'lodash/fp'; +import { useHostRiskScore } from '../../containers/host_risk_score'; +import { HostsComponentsQueryProps } from './types'; +import { manageQuery } from '../../../common/components/page/manage_query'; +import { HostRiskScoreTable } from '../../components/host_risk_score_table'; +import { useRiskScoreKpi } from '../../containers/kpi_hosts/risky_hosts'; +import { useDeepEqualSelector } from '../../../common/hooks/use_selector'; +import { hostsModel, hostsSelectors } from '../../store'; +import { State } from '../../../common/store'; +import { HostRiskScoreQueryId } from '../../../common/containers/hosts_risk/types'; + +const HostRiskScoreTableManage = manageQuery(HostRiskScoreTable); + +export const HostRiskScoreQueryTabBody = ({ + deleteQuery, + endDate, + filterQuery, + skip, + setQuery, + startDate, + type, +}: HostsComponentsQueryProps) => { + const getHosRiskScoreSelector = useMemo(() => hostsSelectors.hostRiskScoreSelector(), []); + const { activePage, limit, sort } = useDeepEqualSelector((state: State) => + getHosRiskScoreSelector(state, hostsModel.HostsType.page) + ); + + const pagination = useMemo( + () => ({ + cursorStart: activePage * limit, + querySize: limit, + }), + [activePage, limit] + ); + + const [loading, { data, totalCount, inspect, isInspected, refetch }] = useHostRiskScore({ + filterQuery, + skip, + pagination, + sort, + }); + + const { severityCount, loading: isKpiLoading } = useRiskScoreKpi({ + filterQuery, + from: startDate, + to: endDate, + }); + + return ( + + ); +}; + +HostRiskScoreQueryTabBody.displayName = 'HostRiskScoreQueryTabBody'; diff --git a/x-pack/plugins/security_solution/public/hosts/pages/navigation/host_risk_tab_body.tsx b/x-pack/plugins/security_solution/public/hosts/pages/navigation/host_risk_tab_body.tsx index 6982047aa26ad..cebcc0ee855ea 100644 --- a/x-pack/plugins/security_solution/public/hosts/pages/navigation/host_risk_tab_body.tsx +++ b/x-pack/plugins/security_solution/public/hosts/pages/navigation/host_risk_tab_body.tsx @@ -20,18 +20,32 @@ const StyledEuiFlexGroup = styled(EuiFlexGroup)` `; const HostRiskTabBodyComponent: React.FC< - Pick & { hostName: string } -> = ({ hostName, startDate, endDate }) => { + Pick & { + hostName: string; + } +> = ({ hostName, startDate, endDate, setQuery, deleteQuery }) => { const { buttonHref } = useRiskyHostsDashboardButtonHref(startDate, endDate); return ( <> - + - + diff --git a/x-pack/plugins/security_solution/public/hosts/pages/navigation/index.ts b/x-pack/plugins/security_solution/public/hosts/pages/navigation/index.ts index d5961cdc788e4..6b74418549164 100644 --- a/x-pack/plugins/security_solution/public/hosts/pages/navigation/index.ts +++ b/x-pack/plugins/security_solution/public/hosts/pages/navigation/index.ts @@ -11,3 +11,4 @@ export * from './hosts_query_tab_body'; export * from './uncommon_process_query_tab_body'; export * from './alerts_query_tab_body'; export * from './host_risk_tab_body'; +export * from './host_risk_score_tab_body'; diff --git a/x-pack/plugins/security_solution/public/hosts/pages/translations.ts b/x-pack/plugins/security_solution/public/hosts/pages/translations.ts index 337f18ef33503..c2ece6c40e701 100644 --- a/x-pack/plugins/security_solution/public/hosts/pages/translations.ts +++ b/x-pack/plugins/security_solution/public/hosts/pages/translations.ts @@ -60,7 +60,7 @@ export const NAVIGATION_ALERTS_TITLE = i18n.translate( export const NAVIGATION_HOST_RISK_TITLE = i18n.translate( 'xpack.securitySolution.hosts.navigation.hostRisk', { - defaultMessage: 'Host risk', + defaultMessage: 'Hosts by risk', } ); diff --git a/x-pack/plugins/security_solution/public/hosts/store/actions.ts b/x-pack/plugins/security_solution/public/hosts/store/actions.ts index ab4033ebe7f5a..92029913e6fcc 100644 --- a/x-pack/plugins/security_solution/public/hosts/store/actions.ts +++ b/x-pack/plugins/security_solution/public/hosts/store/actions.ts @@ -6,7 +6,11 @@ */ import actionCreatorFactory from 'typescript-fsa'; -import { HostsSortField } from '../../../common/search_strategy/security_solution/hosts'; +import { + HostRiskSeverity, + HostsSortField, + HostRiskScoreSortField, +} from '../../../common/search_strategy/security_solution/hosts'; import { HostsTableType, HostsType } from './model'; const actionCreator = actionCreatorFactory('x-pack/security_solution/local/hosts'); @@ -33,3 +37,13 @@ export const updateHostsSort = actionCreator<{ sort: HostsSortField; hostsType: HostsType; }>('UPDATE_HOSTS_SORT'); + +export const updateHostRiskScoreSort = actionCreator<{ + sort: HostRiskScoreSortField; + hostsType: HostsType; +}>('UPDATE_HOST_RISK_SCORE_SORT'); + +export const updateHostRiskScoreSeverityFilter = actionCreator<{ + severitySelection: HostRiskSeverity[]; + hostsType: HostsType; +}>('UPDATE_HOST_RISK_SCORE_SEVERITY'); diff --git a/x-pack/plugins/security_solution/public/hosts/store/helpers.test.ts b/x-pack/plugins/security_solution/public/hosts/store/helpers.test.ts index 0d7df790f8f31..b9a194ea07fc2 100644 --- a/x-pack/plugins/security_solution/public/hosts/store/helpers.test.ts +++ b/x-pack/plugins/security_solution/public/hosts/store/helpers.test.ts @@ -5,10 +5,10 @@ * 2.0. */ -import { DEFAULT_TABLE_LIMIT } from '../../common/store/constants'; +import { DEFAULT_TABLE_ACTIVE_PAGE, DEFAULT_TABLE_LIMIT } from '../../common/store/constants'; import { HostsModel, HostsTableType, HostsType } from './model'; import { setHostsQueriesActivePageToZero } from './helpers'; -import { Direction, HostsFields } from '../../../common/search_strategy'; +import { Direction, HostsFields, HostRiskScoreFields } from '../../../common/search_strategy'; export const mockHostsState: HostsModel = { page: { @@ -36,7 +36,15 @@ export const mockHostsState: HostsModel = { activePage: 4, limit: DEFAULT_TABLE_LIMIT, }, - [HostsTableType.risk]: null, + [HostsTableType.risk]: { + activePage: DEFAULT_TABLE_ACTIVE_PAGE, + limit: DEFAULT_TABLE_LIMIT, + sort: { + field: HostRiskScoreFields.riskScore, + direction: Direction.desc, + }, + severitySelection: [], + }, }, }, details: { @@ -64,7 +72,15 @@ export const mockHostsState: HostsModel = { activePage: 4, limit: DEFAULT_TABLE_LIMIT, }, - [HostsTableType.risk]: null, + [HostsTableType.risk]: { + activePage: DEFAULT_TABLE_ACTIVE_PAGE, + limit: DEFAULT_TABLE_LIMIT, + sort: { + field: HostRiskScoreFields.riskScore, + direction: Direction.desc, + }, + severitySelection: [], + }, }, }, }; @@ -96,7 +112,15 @@ describe('Hosts redux store', () => { activePage: 0, limit: 10, }, - [HostsTableType.risk]: null, + [HostsTableType.risk]: { + activePage: 0, + limit: 10, + severitySelection: [], + sort: { + direction: 'desc', + field: 'risk_stats.risk_score', + }, + }, }); }); @@ -125,7 +149,15 @@ describe('Hosts redux store', () => { activePage: 0, limit: 10, }, - [HostsTableType.risk]: null, + [HostsTableType.risk]: { + activePage: 0, + limit: 10, + severitySelection: [], + sort: { + direction: 'desc', + field: 'risk_stats.risk_score', + }, + }, }); }); }); diff --git a/x-pack/plugins/security_solution/public/hosts/store/helpers.ts b/x-pack/plugins/security_solution/public/hosts/store/helpers.ts index 6d4ddc2f78fbf..4d93aa3b0312f 100644 --- a/x-pack/plugins/security_solution/public/hosts/store/helpers.ts +++ b/x-pack/plugins/security_solution/public/hosts/store/helpers.ts @@ -8,6 +8,7 @@ import { DEFAULT_TABLE_ACTIVE_PAGE } from '../../common/store/constants'; import { HostsModel, HostsTableType, Queries, HostsType } from './model'; +import { HostRiskSeverity } from '../../../common/search_strategy'; export const setHostPageQueriesActivePageToZero = (state: HostsModel): Queries => ({ ...state.page.queries, @@ -65,3 +66,27 @@ export const setHostsQueriesActivePageToZero = (state: HostsModel, type: HostsTy } throw new Error(`HostsType ${type} is unknown`); }; + +export const generateSeverityFilter = (severitySelection: HostRiskSeverity[]) => + severitySelection.length > 0 + ? [ + { + query: { + bool: { + should: severitySelection.map((query) => ({ + match_phrase: { + 'risk.keyword': { + query, + }, + }, + })), + }, + }, + meta: { + alias: null, + disabled: false, + negate: false, + }, + }, + ] + : []; diff --git a/x-pack/plugins/security_solution/public/hosts/store/model.ts b/x-pack/plugins/security_solution/public/hosts/store/model.ts index 0a82d3961aa02..78e8299cc8dea 100644 --- a/x-pack/plugins/security_solution/public/hosts/store/model.ts +++ b/x-pack/plugins/security_solution/public/hosts/store/model.ts @@ -5,7 +5,11 @@ * 2.0. */ -import { Direction } from '../../../common/search_strategy'; +import { + Direction, + HostRiskSeverity, + HostRiskScoreSortField, +} from '../../../common/search_strategy'; import { HostsFields } from '../../../common/search_strategy/security_solution'; export enum HostsType { @@ -33,6 +37,11 @@ export interface HostsQuery extends BasicQueryPaginated { sortField: HostsFields; } +export interface HostRiskScoreQuery extends BasicQueryPaginated { + sort: HostRiskScoreSortField; + severitySelection: HostRiskSeverity[]; +} + export interface Queries { [HostsTableType.authentications]: BasicQueryPaginated; [HostsTableType.hosts]: HostsQuery; @@ -40,7 +49,7 @@ export interface Queries { [HostsTableType.uncommonProcesses]: BasicQueryPaginated; [HostsTableType.anomalies]: null | undefined; [HostsTableType.alerts]: BasicQueryPaginated; - [HostsTableType.risk]: null | undefined; + [HostsTableType.risk]: HostRiskScoreQuery; } export interface GenericHostsModel { diff --git a/x-pack/plugins/security_solution/public/hosts/store/reducer.ts b/x-pack/plugins/security_solution/public/hosts/store/reducer.ts index 171431144a746..0922ede935946 100644 --- a/x-pack/plugins/security_solution/public/hosts/store/reducer.ts +++ b/x-pack/plugins/security_solution/public/hosts/store/reducer.ts @@ -6,7 +6,7 @@ */ import { reducerWithInitialState } from 'typescript-fsa-reducers'; -import { Direction, HostsFields } from '../../../common/search_strategy'; +import { Direction, HostsFields, HostRiskScoreFields } from '../../../common/search_strategy'; import { DEFAULT_TABLE_ACTIVE_PAGE, DEFAULT_TABLE_LIMIT } from '../../common/store/constants'; @@ -14,6 +14,8 @@ import { setHostDetailsTablesActivePageToZero, setHostTablesActivePageToZero, updateHostsSort, + updateHostRiskScoreSeverityFilter, + updateHostRiskScoreSort, updateTableActivePage, updateTableLimit, } from './actions'; @@ -51,7 +53,15 @@ export const initialHostsState: HostsState = { activePage: DEFAULT_TABLE_ACTIVE_PAGE, limit: DEFAULT_TABLE_LIMIT, }, - [HostsTableType.risk]: null, + [HostsTableType.risk]: { + activePage: DEFAULT_TABLE_ACTIVE_PAGE, + limit: DEFAULT_TABLE_LIMIT, + sort: { + field: HostRiskScoreFields.riskScore, + direction: Direction.desc, + }, + severitySelection: [], + }, }, }, details: { @@ -79,7 +89,15 @@ export const initialHostsState: HostsState = { activePage: DEFAULT_TABLE_ACTIVE_PAGE, limit: DEFAULT_TABLE_LIMIT, }, - [HostsTableType.risk]: null, + [HostsTableType.risk]: { + activePage: DEFAULT_TABLE_ACTIVE_PAGE, + limit: DEFAULT_TABLE_LIMIT, + sort: { + field: HostRiskScoreFields.riskScore, + direction: Direction.desc, + }, + severitySelection: [], + }, }, }, }; @@ -143,4 +161,31 @@ export const hostsReducer = reducerWithInitialState(initialHostsState) }, }, })) + .case(updateHostRiskScoreSort, (state, { sort, hostsType }) => ({ + ...state, + [hostsType]: { + ...state[hostsType], + queries: { + ...state[hostsType].queries, + [HostsTableType.risk]: { + ...state[hostsType].queries[HostsTableType.risk], + sort, + }, + }, + }, + })) + .case(updateHostRiskScoreSeverityFilter, (state, { severitySelection, hostsType }) => ({ + ...state, + [hostsType]: { + ...state[hostsType], + queries: { + ...state[hostsType].queries, + [HostsTableType.risk]: { + ...state[hostsType].queries[HostsTableType.risk], + severitySelection, + activePage: DEFAULT_TABLE_ACTIVE_PAGE, + }, + }, + }, + })) .build(); diff --git a/x-pack/plugins/security_solution/public/hosts/store/selectors.ts b/x-pack/plugins/security_solution/public/hosts/store/selectors.ts index 9ee4cb7352ae9..92247a9fea2e6 100644 --- a/x-pack/plugins/security_solution/public/hosts/store/selectors.ts +++ b/x-pack/plugins/security_solution/public/hosts/store/selectors.ts @@ -21,6 +21,12 @@ export const authenticationsSelector = () => export const hostsSelector = () => createSelector(selectHosts, (hosts) => hosts.queries[HostsTableType.hosts]); +export const hostRiskScoreSelector = () => + createSelector(selectHosts, (hosts) => hosts.queries[HostsTableType.risk]); + +export const hostRiskScoreSeverityFilterSelector = () => + createSelector(selectHosts, (hosts) => hosts.queries[HostsTableType.risk].severitySelection); + export const eventsSelector = () => createSelector(selectHosts, (hosts) => hosts.queries.events); export const uncommonProcessesSelector = () => diff --git a/x-pack/plugins/security_solution/public/overview/components/host_overview/index.test.tsx b/x-pack/plugins/security_solution/public/overview/components/host_overview/index.test.tsx index 4e5418816ee9c..82c45c8e5bf7e 100644 --- a/x-pack/plugins/security_solution/public/overview/components/host_overview/index.test.tsx +++ b/x-pack/plugins/security_solution/public/overview/components/host_overview/index.test.tsx @@ -12,16 +12,18 @@ import '../../../common/mock/match_media'; import { TestProviders } from '../../../common/mock'; import { HostOverview } from './index'; -import { useHostsRiskScore } from '../../../common/containers/hosts_risk/use_hosts_risk_score'; +import { useHostRiskScore } from '../../../hosts/containers/host_risk_score'; import { mockData } from './mock'; import { mockAnomalies } from '../../../common/components/ml/mock'; -jest.mock('../../../common/containers/hosts_risk/use_hosts_risk_score', () => ({ - useHostsRiskScore: jest.fn().mockReturnValue({ - result: [], - isModuleEnabled: false, - loading: true, - }), +jest.mock('../../../hosts/containers/host_risk_score', () => ({ + useHostRiskScore: jest.fn().mockReturnValue([ + true, + { + data: [], + isModuleEnabled: false, + }, + ]), })); describe('Host Summary Component', () => { @@ -74,22 +76,24 @@ describe('Host Summary Component', () => { const risk = 'very high hos risk'; const riskScore = 9999999; - (useHostsRiskScore as jest.Mock).mockReturnValue({ - result: [ - { - host: { - name: 'testHostmame', + (useHostRiskScore as jest.Mock).mockReturnValue([ + false, + { + data: [ + { + host: { + name: 'testHostmame', + }, + risk, + risk_stats: { + rule_risks: [], + risk_score: riskScore, + }, }, - risk, - risk_stats: { - rule_risks: [], - risk_score: riskScore, - }, - }, - ], - isModuleEnabled: true, - loading: false, - }); + ], + isModuleEnabled: true, + }, + ]); const { getByTestId } = render( diff --git a/x-pack/plugins/security_solution/public/overview/components/host_overview/index.tsx b/x-pack/plugins/security_solution/public/overview/components/host_overview/index.tsx index 06f7787085ddc..479580a6bfb95 100644 --- a/x-pack/plugins/security_solution/public/overview/components/host_overview/index.tsx +++ b/x-pack/plugins/security_solution/public/overview/components/host_overview/index.tsx @@ -35,8 +35,8 @@ import { import * as i18n from './translations'; import { EndpointOverview } from './endpoint_overview'; import { OverviewDescriptionList } from '../../../common/components/overview_description_list'; -import { useHostsRiskScore } from '../../../common/containers/hosts_risk/use_hosts_risk_score'; import { HostRiskScore } from '../../../hosts/components/common/host_risk_score'; +import { useHostRiskScore } from '../../../hosts/containers/host_risk_score'; interface HostSummaryProps { contextID?: string; // used to provide unique draggable context when viewing in the side panel @@ -80,7 +80,7 @@ export const HostOverview = React.memo( const capabilities = useMlCapabilities(); const userPermissions = hasMlUserPermissions(capabilities); const [darkMode] = useUiSetting$(DEFAULT_DARK_MODE); - const hostRisk = useHostsRiskScore({ + const [_, { data: hostRisk, isModuleEnabled }] = useHostRiskScore({ hostName, }); @@ -97,9 +97,8 @@ export const HostOverview = React.memo( ); const [hostRiskScore, hostRiskLevel] = useMemo(() => { - if (hostRisk?.isModuleEnabled) { - const hostRiskData = - hostRisk.result && hostRisk.result.length > 0 ? hostRisk.result[0] : undefined; + if (isModuleEnabled) { + const hostRiskData = hostRisk && hostRisk.length > 0 ? hostRisk[0] : undefined; return [ { title: i18n.HOST_RISK_SCORE, @@ -128,7 +127,7 @@ export const HostOverview = React.memo( ]; } return [undefined, undefined]; - }, [hostRisk]); + }, [hostRisk, isModuleEnabled]); const column: DescriptionList[] = useMemo( () => [ diff --git a/x-pack/plugins/security_solution/public/overview/components/overview_risky_host_links/index.test.tsx b/x-pack/plugins/security_solution/public/overview/components/overview_risky_host_links/index.test.tsx index 95ebe9be77019..8f34a94ea6aa2 100644 --- a/x-pack/plugins/security_solution/public/overview/components/overview_risky_host_links/index.test.tsx +++ b/x-pack/plugins/security_solution/public/overview/components/overview_risky_host_links/index.test.tsx @@ -22,12 +22,12 @@ import { } from '../../../common/mock'; import { useRiskyHostsDashboardButtonHref } from '../../containers/overview_risky_host_links/use_risky_hosts_dashboard_button_href'; import { useRiskyHostsDashboardLinks } from '../../containers/overview_risky_host_links/use_risky_hosts_dashboard_links'; -import { useHostsRiskScore } from '../../../common/containers/hosts_risk/use_hosts_risk_score'; +import { useHostRiskScore } from '../../../hosts/containers/host_risk_score'; jest.mock('../../../common/lib/kibana'); -jest.mock('../../../common/containers/hosts_risk/use_hosts_risk_score'); -const useHostsRiskScoreMock = useHostsRiskScore as jest.Mock; +jest.mock('../../../hosts/containers/host_risk_score'); +const useHostRiskScoreMock = useHostRiskScore as jest.Mock; jest.mock('../../containers/overview_risky_host_links/use_risky_hosts_dashboard_button_href'); const useRiskyHostsDashboardButtonHrefMock = useRiskyHostsDashboardButtonHref as jest.Mock; @@ -51,17 +51,21 @@ describe('RiskyHostLinks', () => { }); it('renders enabled module view if module is enabled', () => { - useHostsRiskScoreMock.mockReturnValueOnce({ - loading: false, - isModuleEnabled: true, - result: [], - }); + useHostRiskScoreMock.mockReturnValueOnce([ + false, + { + data: [], + isModuleEnabled: true, + }, + ]); render( { }); it('renders disabled module view if module is disabled', () => { - useHostsRiskScoreMock.mockReturnValueOnce({ - loading: false, - isModuleEnabled: false, - result: [], - }); + useHostRiskScoreMock.mockReturnValueOnce([ + false, + { + data: [], + isModuleEnabled: false, + }, + ]); render( { timerange: { to: string; from: string }; } -const RiskyHostLinksComponent: React.FC = ({ timerange }) => { - const hostRiskScore = useHostsRiskScore({ +const QUERY_ID = HostRiskScoreQueryId.OVERVIEW_RISKY_HOSTS; + +const RiskyHostLinksComponent: React.FC = ({ + timerange, + deleteQuery, + setQuery, +}) => { + const [loading, { data, isModuleEnabled, inspect, refetch }] = useHostRiskScore({ timerange, - queryId: HostRiskScoreQueryId.OVERVIEW_RISKY_HOSTS, }); - switch (hostRiskScore?.isModuleEnabled) { + useQueryInspector({ + queryId: QUERY_ID, + loading, + refetch, + setQuery, + deleteQuery, + inspect, + }); + + switch (isModuleEnabled) { case true: return ( - + ); case false: return ; diff --git a/x-pack/plugins/security_solution/public/overview/components/overview_risky_host_links/risky_hosts_enabled_module.test.tsx b/x-pack/plugins/security_solution/public/overview/components/overview_risky_host_links/risky_hosts_enabled_module.test.tsx index bc45faf1f0580..65c22d634cf27 100644 --- a/x-pack/plugins/security_solution/public/overview/components/overview_risky_host_links/risky_hosts_enabled_module.test.tsx +++ b/x-pack/plugins/security_solution/public/overview/components/overview_risky_host_links/risky_hosts_enabled_module.test.tsx @@ -52,23 +52,19 @@ describe('RiskyHostsEnabledModule', () => { diff --git a/x-pack/plugins/security_solution/public/overview/components/overview_risky_host_links/risky_hosts_enabled_module.tsx b/x-pack/plugins/security_solution/public/overview/components/overview_risky_host_links/risky_hosts_enabled_module.tsx index 875b7c206d793..cdab0a1353e1f 100644 --- a/x-pack/plugins/security_solution/public/overview/components/overview_risky_host_links/risky_hosts_enabled_module.tsx +++ b/x-pack/plugins/security_solution/public/overview/components/overview_risky_host_links/risky_hosts_enabled_module.tsx @@ -10,7 +10,6 @@ import { RiskyHostsPanelView } from './risky_hosts_panel_view'; import { LinkPanelListItem } from '../link_panel'; import { useRiskyHostsDashboardButtonHref } from '../../containers/overview_risky_host_links/use_risky_hosts_dashboard_button_href'; import { useRiskyHostsDashboardLinks } from '../../containers/overview_risky_host_links/use_risky_hosts_dashboard_links'; -import { HostRisk } from '../../../common/containers/hosts_risk/use_hosts_risk_score'; import { HostsRiskScore } from '../../../../common/search_strategy'; const getListItemsFromHits = (items: HostsRiskScore[]): LinkPanelListItem[] => { @@ -24,13 +23,10 @@ const getListItemsFromHits = (items: HostsRiskScore[]): LinkPanelListItem[] => { const RiskyHostsEnabledModuleComponent: React.FC<{ from: string; - hostRiskScore: HostRisk; + hostRiskScore?: HostsRiskScore[]; to: string; }> = ({ hostRiskScore, to, from }) => { - const listItems = useMemo( - () => getListItemsFromHits(hostRiskScore?.result || []), - [hostRiskScore] - ); + const listItems = useMemo(() => getListItemsFromHits(hostRiskScore || []), [hostRiskScore]); const { buttonHref } = useRiskyHostsDashboardButtonHref(to, from); const { listItemsWithLinks } = useRiskyHostsDashboardLinks(to, from, listItems); diff --git a/x-pack/plugins/security_solution/public/overview/pages/overview.test.tsx b/x-pack/plugins/security_solution/public/overview/pages/overview.test.tsx index c98b612375f9b..0226617725e62 100644 --- a/x-pack/plugins/security_solution/public/overview/pages/overview.test.tsx +++ b/x-pack/plugins/security_solution/public/overview/pages/overview.test.tsx @@ -27,7 +27,7 @@ import { useCtiDashboardLinks } from '../containers/overview_cti_links'; import { useIsExperimentalFeatureEnabled } from '../../common/hooks/use_experimental_features'; import { initialUserPrivilegesState } from '../../common/components/user_privileges/user_privileges_context'; import { EndpointPrivileges } from '../../../common/endpoint/types'; -import { useHostsRiskScore } from '../../common/containers/hosts_risk/use_hosts_risk_score'; +import { useHostRiskScore } from '../../hosts/containers/host_risk_score'; jest.mock('../../common/lib/kibana'); jest.mock('../../common/containers/source'); @@ -80,13 +80,9 @@ jest.mock('../containers/overview_cti_links/use_ti_integrations'); const useTiIntegrationsMock = useTiIntegrations as jest.Mock; useTiIntegrationsMock.mockReturnValue({}); -jest.mock('../../common/containers/hosts_risk/use_hosts_risk_score'); -const useHostsRiskScoreMock = useHostsRiskScore as jest.Mock; -useHostsRiskScoreMock.mockReturnValue({ - loading: false, - isModuleEnabled: false, - listItems: [], -}); +jest.mock('../../hosts/containers/host_risk_score'); +const useHostRiskScoreMock = useHostRiskScore as jest.Mock; +useHostRiskScoreMock.mockReturnValue([false, { data: [], isModuleEnabled: false }]); jest.mock('../../common/hooks/use_experimental_features'); const useIsExperimentalFeatureEnabledMock = useIsExperimentalFeatureEnabled as jest.Mock; diff --git a/x-pack/plugins/security_solution/public/overview/pages/overview.tsx b/x-pack/plugins/security_solution/public/overview/pages/overview.tsx index 8de31fa8ebe8a..91c3be79a680b 100644 --- a/x-pack/plugins/security_solution/public/overview/pages/overview.tsx +++ b/x-pack/plugins/security_solution/public/overview/pages/overview.tsx @@ -161,6 +161,8 @@ const OverviewComponent = () => { {riskyHostsEnabled && ( + 1`] = ` + +`; + +exports[`Details Panel Component DetailsPanel: rendering it should not render the DetailsPanel if no expanded detail has been set in the reducer 1`] = ` + +`; + +exports[`Details Panel Component DetailsPanel:EventDetails: rendering it should render the Event Details Panel when the panelView is set and the associated params are set 1`] = ` +.c0 { + -webkit-flex: 0 1 auto; + -ms-flex: 0 1 auto; + flex: 0 1 auto; + margin-top: 8px; +} + + + + + +
+ +
+ + +
+ + + +
+ +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +`; + +exports[`Details Panel Component DetailsPanel:EventDetails: rendering it should render the Event Details view of the Details Panel in the flyout when the panelView is eventDetail and the eventId is set 1`] = ` +Array [ + .c0 { + -webkit-flex: 0 1 auto; + -ms-flex: 0 1 auto; + flex: 0 1 auto; + margin-top: 8px; +} + +.c1 .euiFlyoutBody__overflow { + display: -webkit-box; + display: -webkit-flex; + display: -ms-flexbox; + display: flex; + -webkit-flex: 1; + -ms-flex: 1; + flex: 1; + overflow: hidden; +} + +.c1 .euiFlyoutBody__overflow .euiFlyoutBody__overflowContent { + -webkit-flex: 1; + -ms-flex: 1; + flex: 1; + overflow: hidden; + padding: 0 16px 16px; +} + + +
+ - -
- -
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - `); + expect(wrapper.find('EventDetailsPanelComponent')).toMatchSnapshot(); }); test('it should render the Event Details view of the Details Panel in the flyout when the panelView is eventDetail and the eventId is set', () => { @@ -379,584 +163,7 @@ describe('Details Panel Component', () => { ); - expect(wrapper.find('[data-test-subj="timeline:details-panel:flyout"]')) - .toMatchInlineSnapshot(` - Array [ - .c0 { - -webkit-flex: 0 1 auto; - -ms-flex: 0 1 auto; - flex: 0 1 auto; - margin-top: 8px; - } - - .c1 .euiFlyoutBody__overflow { - display: -webkit-box; - display: -webkit-flex; - display: -ms-flexbox; - display: flex; - -webkit-flex: 1; - -ms-flex: 1; - flex: 1; - overflow: hidden; - } - - .c1 .euiFlyoutBody__overflow .euiFlyoutBody__overflowContent { - -webkit-flex: 1; - -ms-flex: 1; - flex: 1; - overflow: hidden; - padding: 0 16px 16px; - } - - -
-