@constructor-io/constructorio-node 4.6.0 → 4.6.2

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "4.6.0",
+  "version": "4.6.2",
   "description": "Constructor.io Node.js client",
   "main": "src/constructorio.js",
   "types": "src/types/constructorio.d.ts",
   "scripts": {
     "verify-node-version": "chmod +x ./scripts/verify-node-version.sh && ./scripts/verify-node-version.sh",
     "version": "npm run verify-node-version && npm run docs && git add ./docs/*",
-    "check-lisc": "license-checker --production --onlyAllow 'Apache-2.0;BSD-3-Clause;MIT'",
+    "check-license": "license-checker --production --onlyAllow 'Apache-2.0;BSD-3-Clause;MIT;0BSD;BSD-2-Clause'",
     "lint": "eslint 'src/**/*.js' 'spec/**/*.js' 'src/**/*.d.ts'",
     "test:parallel": "mkdir -p test && cp -rf src/* test && mocha --parallel ./spec/*",
     "test": "mkdir -p test && cp -rf src/* test && mocha ./spec/*",

package/src/modules/catalog.js

@@ -3312,6 +3312,170 @@ class Catalog {
       return helpers.throwHttpErrorFromResponse(new Error(), response);
     });
   }
+
+  /**
+   * Retrieve metadata searchabilities
+   *
+   * @function retrieveSearchabilities
+   * @param {object} [parameters] - Additional parameters for retrieving metadata searchabilities
+   * @param {string} [parameters.name] - Name of metadata searchability. Providing this field would filter the results based on name
+   * @param {number} [parameters.page] - The page number of the results. Can't be used together with 'offset'
+   * @param {number} [parameters.offset] - The number of results to skip from the beginning. Can't be used together with 'page'
+   * @param {number} [parameters.numResultsPerPage] - The number of searchability configurations to return. Defaults to 100
+   * @param {object} [parameters.filters] - Filters the results based on name, exactSearchable or fuzzySearchable
+   * @param {boolean} [parameters.searchable] - Retrieve only results which are either exactSearchable or fuzzySearchable
+   * @param {string} [parameters.sortBy] - The criteria by which searchability configurations should be sorted. Defaults to no sorting. Valid criteria is name
+   * @param {string} [parameters.sortOrder] - Either descending or ascending. The sort order by which searchability configurations should be sorted. Only valid in conjunction with sortBy
+   * @param {string} [parameters.section] - The section in which the searchability is defined. Default value is Products
+   * @param {object} [networkParameters] - Parameters relevant to the network request
+   * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+   * @returns {Promise}
+   * @see https://docs.constructor.io/rest_api/searchabilities/#retrieve-searchabilities
+   * @example
+   * constructorio.catalog.retrieveSearchabilities({
+   *     page: 2,
+   *     numResultsPerPage: 50,
+   *     filters: { exactSearchable: true }
+   * });
+   */
+  retrieveSearchabilities(parameters = {}, networkParameters = {}) {
+    let requestUrl;
+    const { fetch } = this.options;
+    const controller = new AbortController();
+    const { signal } = controller;
+    const { name, page, offset, numResultsPerPage, filters, searchable, sortBy, sortOrder, section = 'Products' } = parameters;
+    const additionalQueryParams = {};
+
+    if (!helpers.isNil(page)) {
+      additionalQueryParams.page = page;
+    }
+
+    if (!helpers.isNil(offset)) {
+      additionalQueryParams.offset = offset;
+    }
+
+    if (!helpers.isNil(numResultsPerPage)) {
+      additionalQueryParams.num_results_per_page = numResultsPerPage;
+    }
+
+    if (filters) {
+      additionalQueryParams.filters = toSnakeCaseKeys(filters);
+    }
+
+    if (searchable) {
+      additionalQueryParams.searchable = searchable;
+    }
+
+    if (sortBy) {
+      additionalQueryParams.sort_by = sortBy;
+    }
+
+    if (sortOrder) {
+      additionalQueryParams.sort_order = sortOrder;
+    }
+
+    if (sortOrder) {
+      additionalQueryParams.sort_order = sortOrder;
+    }
+
+    if (section) {
+      additionalQueryParams.section = section;
+    }
+
+    if (name) {
+      if (additionalQueryParams.filters) {
+        additionalQueryParams.filters.name = name;
+      } else {
+        additionalQueryParams.filters = { name };
+      }
+    }
+
+    try {
+      requestUrl = createCatalogUrl('searchabilities', this.options, additionalQueryParams);
+    } catch (e) {
+      return Promise.reject(e);
+    }
+
+    // Handle network timeout if specified
+    helpers.applyNetworkTimeout(this.options, networkParameters, controller);
+
+    return fetch(requestUrl, {
+      method: 'GET',
+      headers: {
+        'Content-Type': 'application/json',
+        ...helpers.createAuthHeader(this.options),
+      },
+      signal,
+    }).then((response) => {
+      if (response.ok) {
+        return response.json();
+      }
+
+      return helpers.throwHttpErrorFromResponse(new Error(), response);
+    });
+  }
+
+  /**
+   * Patch metadata searchabilities
+   *
+   * @function patchSearchabilities
+   * @param {object} parameters - Additional parameters for patching metadata searchabilities
+   * @param {object[]} parameters.searchabilities - Array of searchabilities. Additional information about the searchabilities schema can be found [here]{@link https://docs.constructor.io/rest_api/searchabilities/#patch-searchabilities}
+   * @param {string} [parameters.section] - The section in which the searchability is defined. Default value is Products
+   * @param {object} [networkParameters] - Parameters relevant to the network request
+   * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+   * @returns {Promise}
+   * @see https://docs.constructor.io/rest_api/searchabilities/#patch-searchabilities
+   * @example
+   * constructorio.catalog.patchSearchabilities({
+   *   searchabilities: [
+   *     {
+   *       name: 'style_id',
+   *       exactSearchable: true,
+   *     },
+   *     {
+   *       name: 'keywords',
+   *       fuzzySearchable: true,
+   *     },
+   *   ],
+   * });
+   */
+  patchSearchabilities(parameters = {}, networkParameters = {}) {
+    let requestUrl;
+    const { fetch } = this.options;
+    const controller = new AbortController();
+    const { signal } = controller;
+    const { searchabilities: searchabilitiesRaw, section = 'Products' } = parameters;
+    const searchabilities = searchabilitiesRaw?.map((config) => toSnakeCaseKeys(config));
+    const additionalQueryParams = {
+      section,
+    };
+
+    try {
+      requestUrl = createCatalogUrl('searchabilities', this.options, additionalQueryParams);
+    } catch (e) {
+      return Promise.reject(e);
+    }
+
+    // Handle network timeout if specified
+    helpers.applyNetworkTimeout(this.options, networkParameters, controller);
+
+    return fetch(requestUrl, {
+      method: 'PATCH',
+      body: JSON.stringify({ searchabilities }),
+      headers: {
+        'Content-Type': 'application/json',
+        ...helpers.createAuthHeader(this.options),
+      },
+      signal,
+    }).then((response) => {
+      if (response.ok) {
+        return response.json();
+      }
+
+      return helpers.throwHttpErrorFromResponse(new Error(), response);
+    });
+  }
 }
 
 module.exports = Catalog;

package/src/types/catalog.d.ts

@@ -10,94 +10,305 @@ import {
   RedirectRuleResponse,
   OneWaySynonymRelation,
   SynonymGroup,
+  SearchabilityConfiguration,
+  SearchabilityConfigurationResponse,
 } from '.';
 
 export default Catalog;
 
+export interface CreateOrReplaceItemsParameters {
+  items: Item[];
+  force?: boolean;
+  notificationEmail?: string;
+  section?: string;
+}
+
+export interface UpdateItemsParameters extends CreateOrReplaceItemsParameters {
+  onMissing?: 'IGNORE' | 'CREATE' | 'FAIL';
+}
+
+export interface DeleteItemsParameters {
+  items: Pick<Item, 'id'>[];
+  section?: string;
+  notificationEmail?: string;
+}
+
+export interface RetrieveItemsParameters {
+  ids?: string[];
+  section?: string;
+  numResultsPerPage?: number;
+  page?: number;
+}
+
+export interface CreateOrReplaceVariationsParameters {
+  variations: Variation[];
+  force?: boolean;
+  notificationEmail?: string;
+  section?: string;
+}
+
+export interface UpdateVariationsParameters
+  extends CreateOrReplaceVariationsParameters {
+    onMissing?: 'IGNORE' | 'CREATE' | 'FAIL';
+  }
+
+export interface DeleteVariationsParameters {
+  variations: Pick<Variation, 'id'>[];
+  force?: boolean;
+  notificationEmail?: string;
+  section?: string;
+}
+
+export interface RetrieveVariationsParameters {
+  section?: string;
+  ids?: string[];
+  itemId?: string;
+  numResultsPerPage?: number;
+  page?: number;
+}
+
+export interface AddItemGroupParameters {
+  id: string;
+  name: string;
+  parent_id?: string;
+  data?: Record<string, any>;
+}
+
+export interface AddItemGroupsParameters {
+  item_groups: ItemGroup[];
+}
+
+export interface GetItemGroupParameters {
+  id: string;
+}
+
+export interface AddOrUpdateItemGroupsParameters
+  extends AddItemGroupsParameters {}
+
+export interface AddOneWaySynonymParameters {
+  phrase: string;
+  child_phrases: string[];
+}
+
+export interface ModifyOneWaySynonymParameters
+  extends AddOneWaySynonymParameters {}
+
+export interface GetOneWaySynonymParameters {
+  phrase: string;
+}
+
+export interface GetOneWaySynonymsParameters {
+  num_results_per_page?: number;
+  page?: number;
+}
+
+export interface RemoveOneWaySynonymParameters {
+  phrase: string;
+}
+
+export interface AddSynonymGroupParameters {
+  synonyms: string[];
+}
+
+export interface ModifySynonymGroupParameters {
+  synonyms: string[];
+}
+
+export interface GetSynonymGroupParameters {
+  id: number;
+}
+
+export interface GetSynonymGroupsParameters {
+  phrase?: string;
+  num_results_per_page?: number;
+  page?: number;
+}
+
+export interface RemoveSynonymGroupParameters {
+  id: number;
+}
+
+export interface AddRedirectRuleParameters {
+  url: string;
+  matches: RedirectRuleMatchObject[];
+  start_time?: string;
+  end_time?: string;
+  user_segments?: string[];
+  metadata?: Record<string, any>;
+}
+
+export interface UpdateRedirectRuleParameters
+  extends AddRedirectRuleParameters {
+  id: string;
+}
+
+export interface ModifyRedirectRuleParameters
+  extends AddRedirectRuleParameters {
+  id: string;
+}
+
+export interface GetRedirectRuleParameters {
+  id: string;
+}
+
+export interface GetRedirectRulesParameters {
+  num_results_per_page?: number;
+  page?: number;
+  query?: string;
+  status?: string;
+}
+
+export interface RemoveRedirectRuleParameters {
+  id: string;
+}
+
+export interface ReplaceCatalogParameters {
+  section: string;
+  notification_email?: string;
+  force?: boolean;
+  items?: File;
+  variations?: File;
+  item_groups?: File;
+}
+
+export interface UpdateCatalogParameters extends ReplaceCatalogParameters {}
+
+export interface PatchCatalogParameters {
+  section: string;
+  notification_email?: string;
+  force?: boolean;
+  onMissing?: 'IGNORE' | 'CREATE' | 'FAIL';
+  items?: File;
+  variations?: File;
+  item_groups?: File;
+}
+
+export interface ReplaceCatalogUsingTarArchiveParameters {
+  section: string;
+  notification_email?: string;
+  force?: boolean;
+  tarArchive?: File;
+}
+
+export interface UpdateCatalogUsingTarArchiveParameters
+  extends ReplaceCatalogUsingTarArchiveParameters {}
+
+export interface PatchCatalogUsingTarArchiveParameters
+  extends ReplaceCatalogUsingTarArchiveParameters {
+    onMissing?: 'IGNORE' | 'CREATE' | 'FAIL';
+  }
+
+export interface GetFacetConfigurationsParameters {
+  page?: number;
+  num_results_per_page?: number;
+  section?: string;
+}
+
+export interface GetFacetConfigurationParameters {
+  name?: string;
+  section?: string;
+}
+
+export interface ModifyFacetConfigurationsParameters {
+  facetConfigurations: FacetConfiguration[];
+}
+
+export interface RemoveFacetConfigurationParameters {
+  name: string;
+  section?: string;
+}
+
+export type AddFacetOptionConfigurationParameters = FacetOptionConfiguration & {
+  facetGroupName: string;
+  section?: string;
+};
+
+export interface AddOrModifyFacetOptionConfigurationsParameters {
+  facetGroupName: string;
+  facetOptionConfigurations: FacetOptionConfiguration[];
+  section?: string;
+}
+
+export interface GetFacetOptionConfigurationsParameters {
+  facetGroupName: string;
+  page?: number;
+  num_results_per_page?: number;
+  section?: string;
+}
+
+export interface GetFacetOptionConfigurationParameters {
+  facetGroupName: string;
+  value: string;
+  section?: string;
+}
+
+export type ReplaceFacetOptionConfigurationParameters = {
+  facetGroupName: string;
+  section?: string;
+} & FacetOptionConfiguration;
+
+export type ModifyFacetOptionConfigurationParameters = ReplaceFacetOptionConfigurationParameters
+
+export interface RemoveFacetOptionConfiguration extends GetFacetOptionConfigurationParameters {}
+
+export interface RetrieveSearchabilitiesParameters {
+  name?: string;
+  page?: number;
+  offset?: number;
+  numResultsPerPage?: number;
+  filters?: Record<string, any>;
+  searchable?: boolean;
+  sortBy?: string;
+  sortOrder?: string;
+  section?: string;
+}
+
+export interface PatchSearchabilitiesParameters {
+  searchabilities: SearchabilityConfiguration[],
+}
+
 declare class Catalog {
   constructor(options: ConstructorClientOptions);
 
   options: ConstructorClientOptions;
 
   createOrReplaceItems(
-    parameters: {
-      items: Item[];
-      force?: boolean;
-      notificationEmail?: string;
-      section?: string;
-    },
+    parameters: CreateOrReplaceItemsParameters,
     networkParameters?: NetworkParameters
   ): Promise<void>;
 
   updateItems(
-    parameters: {
-      items: Item[];
-      force?: boolean;
-      notificationEmail?: string;
-      section?: string;
-      onMissing?: 'IGNORE' | 'CREATE' | 'FAIL';
-    },
+    parameters: UpdateItemsParameters,
     networkParameters?: NetworkParameters
   ): Promise<void>;
 
   deleteItems(
-    parameters: {
-      items: Pick<Item, 'id'>[];
-      section?: string;
-      notificationEmail?: string;
-    },
+    parameters: DeleteItemsParameters,
     networkParameters?: NetworkParameters
   ): Promise<void>;
 
   retrieveItems(
-    parameters: {
-      ids?: string[];
-      section?: string;
-      numResultsPerPage?: number;
-      page?: number;
-    },
+    parameters: RetrieveItemsParameters,
     networkParameters?: NetworkParameters
   ): Promise<{ items: Item[]; total_count: number; [key: string]: any }>;
 
   createOrReplaceVariations(
-    parameters: {
-      variations: Variation[];
-      force?: boolean;
-      notificationEmail?: string;
-      section?: string;
-    },
+    parameters: CreateOrReplaceVariationsParameters,
     networkParameters?: NetworkParameters
   ): Promise<void>;
 
   updateVariations(
-    parameters: {
-      variations: Variation[];
-      force?: boolean;
-      notificationEmail?: string;
-      section?: string;
-      onMissing?: 'IGNORE' | 'CREATE' | 'FAIL';
-    },
+    parameters: UpdateVariationsParameters,
     networkParameters?: NetworkParameters
   ): Promise<void>;
 
   deleteVariations(
-    parameters: {
-      variations: Pick<Variation, 'id'>[];
-      force?: boolean;
-      notificationEmail?: string;
-      section?: string;
-    },
+    parameters: DeleteVariationsParameters,
     networkParameters?: NetworkParameters
   ): Promise<void>;
 
   retrieveVariations(
-    parameters: {
-      section?: string;
-      ids?: string[];
-      itemId?: string;
-      numResultsPerPage?: number;
-      page?: number;
-    },
+    parameters: RetrieveVariationsParameters,
     networkParameters?: NetworkParameters
   ): Promise<{
     variations: Variation[];
@@ -106,26 +317,17 @@ declare class Catalog {
   }>;
 
   addItemGroup(
-    parameters: {
-      id: string;
-      name: string;
-      parent_id?: string;
-      data?: Record<string, any>;
-    },
+    parameters: AddItemGroupParameters,
     networkParameters?: NetworkParameters
   ): Promise<void>;
 
   addItemGroups(
-    parameters: {
-      item_groups: ItemGroup[];
-    },
+    parameters: AddItemGroupsParameters,
     networkParameters?: NetworkParameters
   ): Promise<void>;
 
   getItemGroup(
-    parameters: {
-      id: string;
-    },
+    parameters: GetItemGroupParameters,
     networkParameters?: NetworkParameters
   ): Promise<{
     item_groups: ItemGroup[];
@@ -140,9 +342,7 @@ declare class Catalog {
   }>;
 
   addOrUpdateItemGroups(
-    parameters: {
-      item_groups: ItemGroup[];
-    },
+    parameters: AddOrUpdateItemGroupsParameters,
     networkParameters?: NetworkParameters
   ): Promise<{
     item_groups: {
@@ -171,35 +371,24 @@ declare class Catalog {
   ): Promise<{ message: string }>;
 
   addOneWaySynonym(
-    parameters: {
-      phrase: string;
-      child_phrases: string[];
-    },
+    parameters: AddOneWaySynonymParameters,
     networkParameters?: NetworkParameters
   ): Promise<void>;
 
   modifyOneWaySynonym(
-    parameters: {
-      phrase: string;
-      child_phrases: string[];
-    },
+    parameters: ModifyOneWaySynonymParameters,
     networkParameters?: NetworkParameters
   ): Promise<void>;
 
   getOneWaySynonym(
-    parameters: {
-      phrase: string;
-    },
+    parameters: GetOneWaySynonymParameters,
     networkParameters?: NetworkParameters
   ): Promise<{
     one_way_synonym_relations: OneWaySynonymRelation[];
   }>;
 
   getOneWaySynonyms(
-    parameters?: {
-      num_results_per_page?: number;
-      page?: number;
-    },
+    parameters?: GetOneWaySynonymsParameters,
     networkParameters?: NetworkParameters
   ): Promise<{
     one_way_synonym_relations: OneWaySynonymRelation[];
@@ -207,33 +396,24 @@ declare class Catalog {
   }>;
 
   removeOneWaySynonym(
-    parameters: {
-      phrase: string;
-    },
+    parameters: RemoveOneWaySynonymParameters,
     networkParameters?: NetworkParameters
   ): Promise<void>;
 
   removeOneWaySynonyms(networkParameters?: NetworkParameters): Promise<void>;
 
   addSynonymGroup(
-    parameters: {
-      synonyms: string[];
-    },
+    parameters: AddSynonymGroupParameters,
     networkParameters?: NetworkParameters
   ): Promise<{ group_id: number; [key: string]: any }>;
 
   modifySynonymGroup(
-    parameters: {
-      id: number;
-      synonyms: string[];
-    },
+    parameters: ModifySynonymGroupParameters,
     networkParameters?: NetworkParameters
   ): Promise<void>;
 
   getSynonymGroup(
-    parameters: {
-      id: number;
-    },
+    parameters: GetSynonymGroupParameters,
     networkParameters?: NetworkParameters
   ): Promise<{
     synonym_groups: SynonymGroup[];
@@ -242,11 +422,7 @@ declare class Catalog {
   }>;
 
   getSynonymGroups(
-    parameters?: {
-      phrase?: string;
-      num_results_per_page?: number;
-      page?: number;
-    },
+    parameters?: GetSynonymGroupsParameters,
     networkParameters?: NetworkParameters
   ): Promise<{
     synonym_groups: SynonymGroup[];
@@ -255,66 +431,34 @@ declare class Catalog {
   }>;
 
   removeSynonymGroup(
-    parameters: {
-      id: number;
-    },
+    parameters:RemoveSynonymGroupParameters,
     networkParameters?: NetworkParameters
   ): Promise<void>;
 
   removeSynonymGroups(networkParameters?: NetworkParameters): Promise<void>;
 
   addRedirectRule(
-    parameters: {
-      url: string;
-      matches: RedirectRuleMatchObject[];
-      start_time?: string;
-      end_time?: string;
-      user_segments?: string[];
-      metadata?: Record<string, any>;
-    },
+    parameters: AddRedirectRuleParameters,
     networkParameters?: NetworkParameters
   ): Promise<RedirectRuleResponse>;
 
   updateRedirectRule(
-    parameters: {
-      id: string;
-      url: string;
-      matches: RedirectRuleMatchObject[];
-      start_time?: string;
-      end_time?: string;
-      user_segments?: string[];
-      metadata?: Record<string, any>;
-    },
+    parameters: UpdateRedirectRuleParameters,
     networkParameters?: NetworkParameters
   ): Promise<RedirectRuleResponse>;
 
   modifyRedirectRule(
-    parameters: {
-      id: string;
-      url: string;
-      matches: RedirectRuleMatchObject[];
-      start_time?: string;
-      end_time?: string;
-      user_segments?: string[];
-      metadata?: Record<string, any>;
-    },
+    parameters: ModifyRedirectRuleParameters,
     networkParameters?: NetworkParameters
   ): Promise<RedirectRuleResponse>;
 
   getRedirectRule(
-    parameters: {
-      id: string;
-    },
+    parameters: GetRedirectRuleParameters,
     networkParameters?: NetworkParameters
   ): Promise<RedirectRuleResponse>;
 
   getRedirectRules(
-    parameters?: {
-      num_results_per_page?: number;
-      page?: number;
-      query?: string;
-      status?: string;
-    },
+    parameters?: GetRedirectRulesParameters,
     networkParameters?: NetworkParameters
   ): Promise<{
     redirect_rules: RedirectRuleResponse[];
@@ -323,21 +467,12 @@ declare class Catalog {
   }>;
 
   removeRedirectRule(
-    parameters: {
-      id: string;
-    },
+    parameters: RemoveRedirectRuleParameters,
     networkParameters?: NetworkParameters
   ): Promise<RedirectRuleResponse>;
 
   replaceCatalog(
-    parameters: {
-      section: string;
-      notification_email?: string;
-      force?: boolean;
-      items?: File;
-      variations?: File;
-      item_groups?: File;
-    },
+    parameters: ReplaceCatalogParameters,
     networkParameters?: NetworkParameters
   ): Promise<{
     task_id: string;
@@ -346,14 +481,7 @@ declare class Catalog {
   }>;
 
   updateCatalog(
-    parameters: {
-      section: string;
-      notification_email?: string;
-      force?: boolean;
-      items?: File;
-      variations?: File;
-      item_groups?: File;
-    },
+    parameters: UpdateCatalogParameters,
     networkParameters?: NetworkParameters
   ): Promise<{
     task_id: string;
@@ -362,15 +490,7 @@ declare class Catalog {
   }>;
 
   patchCatalog(
-    parameters: {
-      section: string;
-      notification_email?: string;
-      force?: boolean;
-      onMissing?: 'IGNORE' | 'CREATE' | 'FAIL';
-      items?: File;
-      variations?: File;
-      item_groups?: File;
-    },
+    parameters: PatchCatalogParameters,
     networkParameters?: NetworkParameters
   ): Promise<{
     task_id: string;
@@ -379,12 +499,7 @@ declare class Catalog {
   }>;
 
   replaceCatalogUsingTarArchive(
-    parameters: {
-      section: string;
-      notification_email?: string;
-      force?: boolean;
-      tarArchive?: File;
-    },
+    parameters: ReplaceCatalogUsingTarArchiveParameters,
     networkParameters?: NetworkParameters
   ): Promise<{
     task_id: string;
@@ -393,12 +508,7 @@ declare class Catalog {
   }>;
 
   updateCatalogUsingTarArchive(
-    parameters: {
-      section: string;
-      notification_email?: string;
-      force?: boolean;
-      tarArchive?: File;
-    },
+    parameters: UpdateCatalogUsingTarArchiveParameters,
     networkParameters?: NetworkParameters
   ): Promise<{
     task_id: string;
@@ -407,12 +517,7 @@ declare class Catalog {
   }>;
 
   patchCatalogUsingTarArchive(
-    parameters: {
-      section: string;
-      notification_email?: string;
-      force?: boolean;
-      tarArchive?: File;
-    },
+    parameters: PatchCatalogUsingTarArchiveParameters,
     networkParameters?: NetworkParameters
   ): Promise<{
     task_id: string;
@@ -426,11 +531,7 @@ declare class Catalog {
   ): Promise<FacetConfiguration>;
 
   getFacetConfigurations(
-    parameters: {
-      page?: number;
-      num_results_per_page?: number;
-      section?: string;
-    },
+    parameters: GetFacetConfigurationsParameters,
     networkParameters?: NetworkParameters
   ): Promise<{
     facets: FacetConfiguration[];
@@ -439,17 +540,12 @@ declare class Catalog {
   }>;
 
   getFacetConfiguration(
-    parameters: {
-      name?: string;
-      section?: string;
-    },
+    parameters: GetFacetConfigurationParameters,
     networkParameters?: NetworkParameters
   ): Promise<FacetConfiguration>;
 
   modifyFacetConfigurations(
-    parameters?: {
-      facetConfigurations: FacetConfiguration[];
-    },
+    parameters?: ModifyFacetConfigurationsParameters,
     networkParameters?: NetworkParameters
   ): Promise<FacetConfiguration[]>;
 
@@ -464,37 +560,22 @@ declare class Catalog {
   ): Promise<FacetConfiguration>;
 
   removeFacetConfiguration(
-    parameters?: {
-      name: string;
-      section?: string;
-    },
+    parameters?: RemoveFacetConfigurationParameters,
     networkParameters?: NetworkParameters
   ): Promise<FacetConfiguration>;
 
   addFacetOptionConfiguration(
-    parameters: FacetOptionConfiguration & {
-      facetGroupName: string;
-      section?: string;
-    },
+    parameters: AddFacetOptionConfigurationParameters,
     networkParameters?: NetworkParameters
   ): Promise<FacetOptionConfiguration>;
 
   addOrModifyFacetOptionConfigurations(
-    parameters: {
-      facetGroupName: string;
-      facetOptionConfigurations: FacetOptionConfiguration[];
-      section?: string;
-    },
+    parameters: AddOrModifyFacetOptionConfigurationsParameters,
     networkParameters?: NetworkParameters
   ): Promise<FacetOptionConfiguration[]>;
 
   getFacetOptionConfigurations(
-    parameters: {
-      facetGroupName: string;
-      page?: number;
-      num_results_per_page?: number;
-      section?: string;
-    },
+    parameters: GetFacetOptionConfigurationsParameters,
     networkParameters?: NetworkParameters
   ): Promise<{
     facet_options: FacetOptionConfiguration[];
@@ -503,36 +584,37 @@ declare class Catalog {
   }>;
 
   getFacetOptionConfiguration(
-    parameters: {
-      facetGroupName: string;
-      value: string;
-      section?: string;
-    },
+    parameters: GetFacetOptionConfigurationParameters,
     networkParameters?: NetworkParameters
   ): Promise<FacetOptionConfiguration>;
 
   replaceFacetOptionConfiguration(
-    parameters: {
-      facetGroupName: string;
-      section?: string;
-    } & FacetOptionConfiguration,
+    parameters: ReplaceFacetOptionConfigurationParameters,
     networkParameters?: NetworkParameters
   ): Promise<FacetOptionConfiguration>;
 
   modifyFacetOptionConfiguration(
-    parameters?: {
-      facetGroupName: string;
-      section?: string;
-    } & FacetOptionConfiguration,
+    parameters?: ModifyFacetOptionConfigurationParameters,
     networkParameters?: NetworkParameters
   ): Promise<FacetOptionConfiguration>;
 
   removeFacetOptionConfiguration(
-    parameters: {
-      facetGroupName: string;
-      value: string;
-      section?: string;
-    },
+    parameters: RemoveFacetOptionConfiguration,
     networkParameters?: NetworkParameters
   ): Promise<FacetOptionConfiguration>;
+
+  retrieveSearchabilities(
+    parameters?: RetrieveSearchabilitiesParameters,
+    networkParameters?: NetworkParameters
+  ): Promise<{
+    searchabilities: SearchabilityConfigurationResponse[];
+    total_count: number;
+  }>;
+
+  patchSearchabilities(
+    parameters: PatchSearchabilitiesParameters,
+    networkParameters?: NetworkParameters
+  ): Promise<{
+    searchabilities: SearchabilityConfigurationResponse[];
+  }>;
 }

package/src/types/index.d.ts

@@ -298,3 +298,23 @@ export type FilterExpressionRange = {
 };
 
 export type FilterExpressionRangeValue = ['-inf' | number, 'inf' | number];
+
+export interface SearchabilityConfigurationResponse {
+  name: string;
+  fuzzy_searchable: boolean,
+  exact_searchable: boolean,
+  type: string,
+  displayable: boolean,
+  hidden: boolean,
+  created_at: string,
+  updated_at: string
+}
+
+export interface SearchabilityConfiguration {
+  name: string;
+  fuzzySearchable?: boolean,
+  exactSearchable?: boolean,
+  type?: string,
+  displayable?: boolean,
+  hidden?: boolean,
+}

package/src/types/tests/catalog.test-d.ts

@@ -7,6 +7,7 @@ import {
   OneWaySynonymRelation,
   RedirectRuleResponse,
   Variation,
+  SearchabilityConfigurationResponse,
 } from '..';
 
 expectAssignable<Item>({
@@ -107,3 +108,14 @@ expectAssignable<FacetOptionConfiguration>({
   data: null,
   hidden: false,
 });
+
+expectAssignable<SearchabilityConfigurationResponse>({
+  name: 'groups',
+  fuzzy_searchable: false,
+  exact_searchable: false,
+  type: 'string',
+  displayable: true,
+  hidden: false,
+  created_at: '2019-04-12T18:15:30',
+  updated_at: '2019-04-12T18:15:30',
+});