2021-10-06 23:02:57 +02:00
{
"id" : "@kbn/securitysolution-list-hooks" ,
"client" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
} ,
"server" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
} ,
"common" : {
"classes" : [ ] ,
"functions" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.addIdToExceptionItemEntries" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "addIdToExceptionItemEntries" ,
"description" : [
"\nThis adds an id to the incoming exception item entries as ReactJS prefers to have\nan id added to them for use as a stable id. Later if we decide to change the data\nmodel to have id's within the array then this code should be removed. If not, then\nthis code should stay as an adapter for ReactJS.\n\nThis does break the type system slightly as we are lying a bit to the type system as we return\nthe same exceptionItem as we have previously but are augmenting the arrays with an id which TypeScript\ndoesn't mind us doing here. However, downstream you will notice that you have an id when the type\ndoes not indicate it. In that case use (ExceptionItem & { id: string }) temporarily if you're using the id. If you're not,\nyou can ignore the id and just use the normal TypeScript with ReactJS.\n"
] ,
"signature" : [
2021-10-14 17:54:35 +02:00
"(exceptionItem: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }) => { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }"
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.addIdToExceptionItemEntries.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "exceptionItem" ,
"description" : [
"The exceptionItem to add an id to the threat matches."
] ,
"signature" : [
2021-10-14 17:54:35 +02:00
"{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }"
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [
"exceptionItem The exceptionItem but with id added to the exception item entries"
] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.removeIdFromExceptionItemsEntries" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "removeIdFromExceptionItemsEntries" ,
"description" : [
"\nThis removes an id from the exceptionItem entries as ReactJS prefers to have\nan id added to them for use as a stable id. Later if we decide to change the data\nmodel to have id's within the array then this code should be removed. If not, then\nthis code should stay as an adapter for ReactJS.\n"
] ,
"signature" : [
2021-10-14 17:54:35 +02:00
"<T extends { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; }>(exceptionItem: T) => T"
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.removeIdFromExceptionItemsEntries.$1" ,
"type" : "Uncategorized" ,
"tags" : [ ] ,
"label" : "exceptionItem" ,
"description" : [
"The exceptionItem to remove an id from the entries."
] ,
"signature" : [
"T"
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [
"exceptionItem The exceptionItem but with id removed from the entries"
] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.transformInput" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "transformInput" ,
"description" : [
"\nTransforms the output of rules to compensate for technical debt or UI concerns such as\nReactJS preferences for having ids within arrays if the data is not modeled that way.\n\nIf you add a new transform of the input called \"myNewTransform\" do it\nin the form of:\nflow(addIdToExceptionItemEntries, myNewTransform)(exceptionItem)\n"
] ,
"signature" : [
2021-10-14 17:54:35 +02:00
"(exceptionItem: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }) => { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }"
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.transformInput.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "exceptionItem" ,
"description" : [
"The exceptionItem to transform the output of"
] ,
"signature" : [
2021-10-14 17:54:35 +02:00
"{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }"
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [
"The exceptionItem transformed from the output"
] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.transformNewItemOutput" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "transformNewItemOutput" ,
"description" : [ ] ,
"signature" : [
2021-10-14 17:54:35 +02:00
"(exceptionItem: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) => { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }"
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.transformNewItemOutput.$1" ,
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "exceptionItem" ,
"description" : [ ] ,
"signature" : [
2021-10-14 17:54:35 +02:00
"{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }"
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.transformOutput" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "transformOutput" ,
"description" : [
"\nTransforms the output of exception items to compensate for technical debt or UI concerns such as\nReactJS preferences for having ids within arrays if the data is not modeled that way.\n\nIf you add a new transform of the output called \"myNewTransform\" do it\nin the form of:\nflow(removeIdFromExceptionItemsEntries, myNewTransform)(exceptionItem)\n"
] ,
"signature" : [
2021-10-14 17:54:35 +02:00
"(exceptionItem: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; })) => { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\" ; t y
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.transformOutput.$1" ,
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "exceptionItem" ,
"description" : [
"The exceptionItem to transform the output of"
] ,
"signature" : [
2021-10-14 17:54:35 +02:00
"{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; })"
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [
"The exceptionItem transformed from the output"
] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.useApi" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "useApi" ,
"description" : [ ] ,
"signature" : [
"(http: HttpStart) => " ,
{
"pluginId" : "@kbn/securitysolution-list-hooks" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionListHooksPluginApi" ,
"section" : "def-common.ExceptionsApi" ,
"text" : "ExceptionsApi"
}
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.useApi.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "http" ,
"description" : [ ] ,
"signature" : [
"HttpStart"
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.useCreateListIndex" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "useCreateListIndex" ,
"description" : [ ] ,
"signature" : [
"() => " ,
"Task" ,
"<[args: " ,
{
"pluginId" : "@kbn/securitysolution-hook-utils" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionHookUtilsPluginApi" ,
"section" : "def-common.OptionalSignalArgs" ,
"text" : "OptionalSignalArgs"
} ,
"<" ,
"ApiParams" ,
">], { acknowledged: boolean; }>"
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_create_list_index/index.ts" ,
"deprecated" : false ,
"children" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.useCursor" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "useCursor" ,
"description" : [ ] ,
"signature" : [
"({ pageIndex, pageSize }: " ,
{
"pluginId" : "@kbn/securitysolution-list-hooks" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionListHooksPluginApi" ,
"section" : "def-common.UseCursorProps" ,
"text" : "UseCursorProps"
} ,
") => [string | undefined, SetCursor]"
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_cursor/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.useCursor.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "{ pageIndex, pageSize }" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "@kbn/securitysolution-list-hooks" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionListHooksPluginApi" ,
"section" : "def-common.UseCursorProps" ,
"text" : "UseCursorProps"
}
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_cursor/index.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.useDeleteList" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "useDeleteList" ,
"description" : [ ] ,
"signature" : [
"() => " ,
"Task" ,
"<[args: " ,
{
"pluginId" : "@kbn/securitysolution-hook-utils" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionHookUtilsPluginApi" ,
"section" : "def-common.OptionalSignalArgs" ,
"text" : "OptionalSignalArgs"
} ,
"<" ,
"DeleteListParams" ,
2021-10-14 17:54:35 +02:00
">], { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>"
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_delete_list/index.ts" ,
"deprecated" : false ,
"children" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.useExceptionListItems" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "useExceptionListItems" ,
"description" : [
"\nHook for using to get an ExceptionList and it's ExceptionListItems\n"
] ,
"signature" : [
"({ http, lists, pagination, filterOptions, showDetectionsListsOnly, showEndpointListsOnly, matchFilters, onError, onSuccess, }: " ,
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.UseExceptionListProps" ,
"text" : "UseExceptionListProps"
} ,
") => " ,
{
"pluginId" : "@kbn/securitysolution-list-hooks" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionListHooksPluginApi" ,
"section" : "def-common.ReturnExceptionListAndItems" ,
"text" : "ReturnExceptionListAndItems"
}
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_exception_list_items/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.useExceptionListItems.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "{\n http,\n lists,\n pagination = {\n page: 1,\n perPage: 20,\n total: 0,\n },\n filterOptions,\n showDetectionsListsOnly,\n showEndpointListsOnly,\n matchFilters,\n onError,\n onSuccess,\n}" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.UseExceptionListProps" ,
"text" : "UseExceptionListProps"
}
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_exception_list_items/index.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.useExceptionLists" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "useExceptionLists" ,
"description" : [
"\nHook for fetching ExceptionLists\n"
] ,
"signature" : [
"({ errorMessage, http, initialPagination, filterOptions, namespaceTypes, notifications, showTrustedApps, showEventFilters, }: " ,
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.UseExceptionListsProps" ,
"text" : "UseExceptionListsProps"
} ,
") => " ,
{
"pluginId" : "@kbn/securitysolution-list-hooks" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionListHooksPluginApi" ,
"section" : "def-common.ReturnExceptionLists" ,
"text" : "ReturnExceptionLists"
}
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_exception_lists/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.useExceptionLists.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "{\n errorMessage,\n http,\n initialPagination = DEFAULT_PAGINATION,\n filterOptions = {},\n namespaceTypes,\n notifications,\n showTrustedApps = false,\n showEventFilters = false,\n}" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.UseExceptionListsProps" ,
"text" : "UseExceptionListsProps"
}
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_exception_lists/index.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.useExportList" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "useExportList" ,
"description" : [ ] ,
"signature" : [
"() => " ,
"Task" ,
"<[args: " ,
{
"pluginId" : "@kbn/securitysolution-hook-utils" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionHookUtilsPluginApi" ,
"section" : "def-common.OptionalSignalArgs" ,
"text" : "OptionalSignalArgs"
} ,
"<" ,
"ExportListParams" ,
">], Blob>"
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_export_list/index.ts" ,
"deprecated" : false ,
"children" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.useFindLists" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "useFindLists" ,
"description" : [ ] ,
"signature" : [
"() => " ,
"Task" ,
"<[args: " ,
{
"pluginId" : "@kbn/securitysolution-hook-utils" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionHookUtilsPluginApi" ,
"section" : "def-common.OptionalSignalArgs" ,
"text" : "OptionalSignalArgs"
} ,
"<" ,
"FindListsParams" ,
2021-10-14 17:54:35 +02:00
">], { cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>"
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_find_lists/index.ts" ,
"deprecated" : false ,
"children" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.useImportList" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "useImportList" ,
"description" : [ ] ,
"signature" : [
"() => " ,
"Task" ,
"<[args: " ,
{
"pluginId" : "@kbn/securitysolution-hook-utils" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionHookUtilsPluginApi" ,
"section" : "def-common.OptionalSignalArgs" ,
"text" : "OptionalSignalArgs"
} ,
"<" ,
"ImportListParams" ,
2021-10-14 17:54:35 +02:00
">], { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>"
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_import_list/index.ts" ,
"deprecated" : false ,
"children" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.usePersistExceptionItem" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "usePersistExceptionItem" ,
"description" : [
"\nHook for creating or updating ExceptionListItem\n"
] ,
"signature" : [
"({ http, onError, }: " ,
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.PersistHookProps" ,
"text" : "PersistHookProps"
} ,
") => " ,
{
"pluginId" : "@kbn/securitysolution-list-hooks" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionListHooksPluginApi" ,
"section" : "def-common.ReturnPersistExceptionItem" ,
"text" : "ReturnPersistExceptionItem"
}
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_persist_exception_item/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.usePersistExceptionItem.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "{\n http,\n onError,\n}" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.PersistHookProps" ,
"text" : "PersistHookProps"
}
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_persist_exception_item/index.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.usePersistExceptionList" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "usePersistExceptionList" ,
"description" : [
"\nHook for creating or updating ExceptionList\n"
] ,
"signature" : [
"({ http, onError, }: " ,
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.PersistHookProps" ,
"text" : "PersistHookProps"
} ,
") => " ,
{
"pluginId" : "@kbn/securitysolution-list-hooks" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionListHooksPluginApi" ,
"section" : "def-common.ReturnPersistExceptionList" ,
"text" : "ReturnPersistExceptionList"
}
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_persist_exception_list/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.usePersistExceptionList.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "{\n http,\n onError,\n}" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.PersistHookProps" ,
"text" : "PersistHookProps"
}
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_persist_exception_list/index.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.useReadListIndex" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "useReadListIndex" ,
"description" : [ ] ,
"signature" : [
"() => " ,
"Task" ,
"<[args: " ,
{
"pluginId" : "@kbn/securitysolution-hook-utils" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionHookUtilsPluginApi" ,
"section" : "def-common.OptionalSignalArgs" ,
"text" : "OptionalSignalArgs"
} ,
"<" ,
"ApiParams" ,
">], { list_index: boolean; list_item_index: boolean; }>"
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_read_list_index/index.ts" ,
"deprecated" : false ,
"children" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.useReadListPrivileges" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "useReadListPrivileges" ,
"description" : [ ] ,
"signature" : [
"() => " ,
"Task" ,
"<[args: " ,
{
"pluginId" : "@kbn/securitysolution-hook-utils" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionHookUtilsPluginApi" ,
"section" : "def-common.OptionalSignalArgs" ,
"text" : "OptionalSignalArgs"
} ,
"<" ,
"ApiParams" ,
">], unknown>"
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_read_list_privileges/index.ts" ,
"deprecated" : false ,
"children" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
}
] ,
"interfaces" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ExceptionsApi" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "ExceptionsApi" ,
"description" : [ ] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ExceptionsApi.addExceptionListItem" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "addExceptionListItem" ,
"description" : [ ] ,
"signature" : [
2021-10-14 17:54:35 +02:00
"(arg: { listItem: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }; }) => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>"
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ExceptionsApi.addExceptionListItem.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "arg" ,
"description" : [ ] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ExceptionsApi.addExceptionListItem.$1.listItem" ,
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "listItem" ,
"description" : [ ] ,
"signature" : [
2021-10-14 17:54:35 +02:00
"{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }"
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false
}
]
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ExceptionsApi.updateExceptionListItem" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "updateExceptionListItem" ,
"description" : [ ] ,
"signature" : [
2021-10-14 17:54:35 +02:00
"(arg: { listItem: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }; }) => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>"
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ExceptionsApi.updateExceptionListItem.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "arg" ,
"description" : [ ] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ExceptionsApi.updateExceptionListItem.$1.listItem" ,
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "listItem" ,
"description" : [ ] ,
"signature" : [
2021-10-14 17:54:35 +02:00
"{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }"
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false
}
]
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ExceptionsApi.deleteExceptionItem" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "deleteExceptionItem" ,
"description" : [ ] ,
"signature" : [
"(arg: " ,
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.ApiCallMemoProps" ,
"text" : "ApiCallMemoProps"
} ,
") => Promise<void>"
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ExceptionsApi.deleteExceptionItem.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "arg" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.ApiCallMemoProps" ,
"text" : "ApiCallMemoProps"
}
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ExceptionsApi.deleteExceptionList" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "deleteExceptionList" ,
"description" : [ ] ,
"signature" : [
"(arg: " ,
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.ApiCallMemoProps" ,
"text" : "ApiCallMemoProps"
} ,
") => Promise<void>"
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ExceptionsApi.deleteExceptionList.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "arg" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.ApiCallMemoProps" ,
"text" : "ApiCallMemoProps"
}
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ExceptionsApi.getExceptionItem" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "getExceptionItem" ,
"description" : [ ] ,
"signature" : [
"(arg: " ,
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.ApiCallMemoProps" ,
"text" : "ApiCallMemoProps"
} ,
2021-10-14 17:54:35 +02:00
" & { onSuccess: (arg: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }) => void; }) => Promise<void>"
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ExceptionsApi.getExceptionItem.$1" ,
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "arg" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.ApiCallMemoProps" ,
"text" : "ApiCallMemoProps"
} ,
2021-10-14 17:54:35 +02:00
" & { onSuccess: (arg: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }) => void; }"
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ExceptionsApi.getExceptionList" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "getExceptionList" ,
"description" : [ ] ,
"signature" : [
"(arg: " ,
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.ApiCallMemoProps" ,
"text" : "ApiCallMemoProps"
} ,
" & { onSuccess: (arg: { _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\"; updated_at: string; updated_by: string; version: number; }) => void; }) => Promise<void>"
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ExceptionsApi.getExceptionList.$1" ,
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "arg" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.ApiCallMemoProps" ,
"text" : "ApiCallMemoProps"
} ,
" & { onSuccess: (arg: { _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\"; updated_at: string; updated_by: string; version: number; }) => void; }"
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ExceptionsApi.getExceptionListsItems" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "getExceptionListsItems" ,
"description" : [ ] ,
"signature" : [
"(arg: " ,
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.ApiCallFindListsItemsMemoProps" ,
"text" : "ApiCallFindListsItemsMemoProps"
} ,
") => Promise<void>"
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ExceptionsApi.getExceptionListsItems.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "arg" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.ApiCallFindListsItemsMemoProps" ,
"text" : "ApiCallFindListsItemsMemoProps"
}
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ExceptionsApi.exportExceptionList" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "exportExceptionList" ,
"description" : [ ] ,
"signature" : [
"(arg: " ,
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.ApiListExportProps" ,
"text" : "ApiListExportProps"
} ,
") => Promise<void>"
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ExceptionsApi.exportExceptionList.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "arg" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.ApiListExportProps" ,
"text" : "ApiListExportProps"
}
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
}
] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.UseCursorProps" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "UseCursorProps" ,
"description" : [ ] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_cursor/index.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.UseCursorProps.pageIndex" ,
"type" : "number" ,
"tags" : [ ] ,
"label" : "pageIndex" ,
"description" : [ ] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_cursor/index.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.UseCursorProps.pageSize" ,
"type" : "number" ,
"tags" : [ ] ,
"label" : "pageSize" ,
"description" : [ ] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_cursor/index.ts" ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
}
] ,
"enums" : [ ] ,
"misc" : [
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.Func" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "Func" ,
"description" : [ ] ,
"signature" : [
"() => void"
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_exception_lists/index.ts" ,
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [ ] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ReturnExceptionListAndItems" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "ReturnExceptionListAndItems" ,
"description" : [ ] ,
"signature" : [
2021-10-14 17:54:35 +02:00
"[boolean, { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[], " ,
2021-10-06 23:02:57 +02:00
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.Pagination" ,
"text" : "Pagination"
} ,
", Func | null]"
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_exception_list_items/index.ts" ,
"deprecated" : false ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ReturnExceptionLists" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "ReturnExceptionLists" ,
"description" : [ ] ,
"signature" : [
"[loading: boolean, exceptionLists: { _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\"; updated_at: string; updated_by: string; version: number; }[], pagination: " ,
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.Pagination" ,
"text" : "Pagination"
} ,
", setPagination: React.Dispatch<React.SetStateAction<" ,
{
"pluginId" : "@kbn/securitysolution-io-ts-list-types" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionIoTsListTypesPluginApi" ,
"section" : "def-common.Pagination" ,
"text" : "Pagination"
} ,
">>, fetchLists: " ,
{
"pluginId" : "@kbn/securitysolution-list-hooks" ,
"scope" : "common" ,
"docId" : "kibKbnSecuritysolutionListHooksPluginApi" ,
"section" : "def-common.Func" ,
"text" : "Func"
} ,
" | null]"
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_exception_lists/index.ts" ,
"deprecated" : false ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ReturnPersistExceptionItem" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "ReturnPersistExceptionItem" ,
"description" : [ ] ,
"signature" : [
2021-10-14 17:54:35 +02:00
"[PersistReturnExceptionItem, React.Dispatch<({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip_range\" | \"date_range\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | null>]"
2021-10-06 23:02:57 +02:00
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_persist_exception_item/index.ts" ,
"deprecated" : false ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "@kbn/securitysolution-list-hooks" ,
"id" : "def-common.ReturnPersistExceptionList" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "ReturnPersistExceptionList" ,
"description" : [ ] ,
"signature" : [
"[PersistReturnExceptionList, React.Dispatch<({ description: string; name: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\"; } & { list_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; version?: number | undefined; }) | ({ description: string; name: string; type: \"endpoint\" | \"detection\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\"; } & { _version?: string | undefined; id?: string | undefined; list_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; version?: number | undefined; }) | null>]"
] ,
"path" : "packages/kbn-securitysolution-list-hooks/src/use_persist_exception_list/index.ts" ,
"deprecated" : false ,
"initialIsOpen" : false
}
] ,
"objects" : [ ]
}
}