diff --git a/packages/client-search/src/types/RedirectRuleIndexMetadata.ts b/packages/client-search/src/types/RedirectRuleIndexMetadata.ts new file mode 100644 index 000000000..3f7011eb9 --- /dev/null +++ b/packages/client-search/src/types/RedirectRuleIndexMetadata.ts @@ -0,0 +1,31 @@ +export type RedirectRuleIndexMetadata = { + /** + * Source index for the redirect rule + */ + readonly source: string; + + /** + * Destination index for the redirect rule + */ + readonly dest: string; + + /** + * Reason for the redirect rule + */ + readonly reason: string; + + /** + * Status for the redirect rule + */ + readonly succeed: boolean; + + /** + * Data for the redirect rule + */ + readonly data: { + /** + * Rule objectId + */ + readonly ruleObjectID: string; + }; +}; diff --git a/packages/client-search/src/types/SearchResponse.ts b/packages/client-search/src/types/SearchResponse.ts index dc6cb62cd..b219c5eaf 100644 --- a/packages/client-search/src/types/SearchResponse.ts +++ b/packages/client-search/src/types/SearchResponse.ts @@ -1,4 +1,5 @@ import { Hit, Settings } from '.'; +import { RedirectRuleIndexMetadata } from './RedirectRuleIndexMetadata'; export type SearchResponse = { /** @@ -224,6 +225,13 @@ export type SearchResponse = { * as a JSON object with one field per parameter. */ params?: Record; + + /** + * This parameter is for internal use only. + */ + redirect?: { + index?: RedirectRuleIndexMetadata[]; + }; }; /** diff --git a/packages/client-search/src/types/index.ts b/packages/client-search/src/types/index.ts index 1087df4f3..e661c20e7 100644 --- a/packages/client-search/src/types/index.ts +++ b/packages/client-search/src/types/index.ts @@ -63,6 +63,7 @@ export * from './MultipleQueriesResponse'; export * from './ObjectWithObjectID'; export * from './PartialUpdateObjectResponse'; export * from './PartialUpdateObjectsOptions'; +export * from './RedirectRuleIndexMetadata'; export * from './RemoveUserIDResponse'; export * from './ReplaceAllObjectsOptions'; export * from './RequireAtLeastOne';