[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

@@ -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__/**/*',

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

x-pack/plugins/cases/docs/README.md

@@ -7,19 +7,24 @@ or parameters are added.
 ## TypeDoc Info
 
 See more info at: <https://typedoc.org/>
-and: <https://www.npmjs.com/package/typedoc-plugin-markdown> for the markdown plugin
+markdown plugin: <https://www.npmjs.com/package/typedoc-plugin-markdown>
+missing exports plugin: <https://github.com/Gerrit0/typedoc-plugin-missing-exports>
 
 ## 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.

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.

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)

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

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

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

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

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

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)

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

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

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

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)

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)

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)

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

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)

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)

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

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)

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)

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)

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

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<string\>; }\> ; `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<string\>; }\> ; `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

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

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

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<Params, Query, Body, Method\>
+
+[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

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

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

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<P, Q, B\>
+
+[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

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

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

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

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

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

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

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

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

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)

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: [client.ts:23](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L23)
+#### Defined in
+
+[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: [client.ts:22](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L22)
+#### Defined in
+
+[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)
+
+___
+
+### \_metrics
+
+• `Private` `Readonly` **\_metrics**: [`MetricsSubClient`](../interfaces/metrics_client.MetricsSubClient.md)
+
+#### Defined in
+
+[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)
 
 ___
 
 ### \_stats
 
-• `Private` `Readonly` **\_stats**: [*StatsSubClient*](../interfaces/stats_client.statssubclient.md)
+• `Private` `Readonly` **\_stats**: [`StatsSubClient`](../interfaces/stats_client.StatsSubClient.md)
 
-Defined in: [client.ts:28](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L28)
+#### Defined in
 
-___
-
-### \_subCases
-
-• `Private` `Readonly` **\_subCases**: [*SubCasesClient*](../interfaces/sub_cases_client.subcasesclient.md)
-
-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: [client.ts:25](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L25)
+#### Defined in
+
+[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
 
-Defined in: [client.ts:43](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L43)
+[`CasesSubClient`](../interfaces/cases_client.CasesSubClient.md)
+
+#### 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
 
-Defined in: [client.ts:76](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L76)
+[`ConfigureSubClient`](../interfaces/configure_client.ConfigureSubClient.md)
+
+#### Defined in
+
+[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)
+
+___
+
+### metrics
+
+• `get` **metrics**(): [`MetricsSubClient`](../interfaces/metrics_client.MetricsSubClient.md)
+
+Retrieves an interface for retrieving metrics related to the cases entities.
+
+#### Returns
+
+[`MetricsSubClient`](../interfaces/metrics_client.MetricsSubClient.md)
+
+#### 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)
 
 ___
 
 ### stats
 
-• get **stats**(): [*StatsSubClient*](../interfaces/stats_client.statssubclient.md)
+• `get` **stats**(): [`StatsSubClient`](../interfaces/stats_client.StatsSubClient.md)
 
 Retrieves an interface for retrieving statistics related to the cases entities.
 
-**Returns:** [*StatsSubClient*](../interfaces/stats_client.statssubclient.md)
+#### Returns
 
-Defined in: [client.ts:83](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L83)
+[`StatsSubClient`](../interfaces/stats_client.StatsSubClient.md)
 
-___
+#### Defined in
 
-### subCases
-
-• get **subCases**(): [*SubCasesClient*](../interfaces/sub_cases_client.subcasesclient.md)
-
-Retrieves an interface for interacting with the case as a connector entities.
-
-Currently this functionality is disabled and will throw an error if this function is called.
-
-**Returns:** [*SubCasesClient*](../interfaces/sub_cases_client.subcasesclient.md)
-
-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
 
-Defined in: [client.ts:57](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/client.ts#L57)
+[`UserActionsSubClient`](../interfaces/user_actions_client.UserActionsSubClient.md)
+
+#### Defined in
+
+[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)

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

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

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)

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

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

x-pack/plugins/cases/docs/cases_client/interfaces/attachments_add.addargs.md

@@ -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)

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)

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)

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)

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)

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)

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)

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)

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)

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*<void\>
+▸ **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
 
-Defined in: [attachments/client.ts:43](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/client.ts#L43)
+`Promise`<`void`\>
+
+#### Defined in
+
+[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*<void\>
+▸ **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*<void\>
+#### 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
 
-Defined in: [attachments/client.ts:47](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/client.ts#L47)
+`Promise`<[`ICommentsResponse`](typedoc_interfaces.ICommentsResponse.md)\>
+
+#### Defined in
+
+[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
 
-Defined in: [attachments/client.ts:55](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/client.ts#L55)
+`Promise`<[`IAllCommentsResponse`](typedoc_interfaces.IAllCommentsResponse.md)\>
+
+#### Defined in
+
+[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
 
-Defined in: [attachments/client.ts:65](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/attachments/client.ts#L65)
+`Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\>
+
+#### Defined in
+
+[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)

x-pack/plugins/cases/docs/cases_client/interfaces/attachments_delete.deleteallargs.md

@@ -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)

x-pack/plugins/cases/docs/cases_client/interfaces/attachments_delete.deleteargs.md

@@ -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)

x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.findargs.md

@@ -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)

x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.getallalertsattachtocase.md

@@ -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)

x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.getallargs.md

@@ -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)

x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.getargs.md

@@ -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)

x-pack/plugins/cases/docs/cases_client/interfaces/attachments_update.updateargs.md

@@ -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)

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*<void\>
+▸ **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
 
-Defined in: [cases/client.ts:73](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/client.ts#L73)
+`Promise`<`void`\>
+
+#### Defined in
+
+[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
 
-Defined in: [cases/client.ts:59](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/client.ts#L59)
+`Promise`<[`ICaseResponse`](typedoc_interfaces.ICaseResponse.md)\>
+
+#### Defined in
+
+[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
 
-Defined in: [cases/client.ts:81](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/client.ts#L81)
+`Promise`<{ `email`: `undefined` \| ``null`` \| `string` ; `full_name`: `undefined` \| ``null`` \| `string` ; `username`: `undefined` \| ``null`` \| `string`  }[]\>
+
+#### Defined in
+
+[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*<string[]\>
+▸ **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*<string[]\>
+#### 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)\>
+#### 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`<[`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`<[`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
 
-Defined in: [cases/client.ts:67](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/client.ts#L67)
+`Promise`<[`ICasesResponse`](typedoc_interfaces.ICasesResponse.md)\>
+
+#### Defined in
+
+[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)

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: [cases/get.ts:48](https://github.com/elastic/kibana/blob/a80791aa4cc/x-pack/plugins/cases/server/client/cases/get.ts#L48)
+#### Defined in
+
+[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)

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)
+#### Defined in
 
-___
-
-### includeSubCaseComments
-
-• `Optional` **includeSubCaseComments**: *boolean*
-
-Whether to include the attachments for all children of a case in the response
-
-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)

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)

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

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<T\>
+
+[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

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

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<Config\>
+
+[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

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<Config, Secrets, Params, ExecutorResultData\>
+
+[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

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

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<Config, Secrets, Params\>
+
+[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

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<Data\>
+
+[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

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

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

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

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

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)

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)

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)

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)

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)

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

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)

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)

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

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

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)

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

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

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

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

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

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)

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)