@constructor-io/constructorio-node 4.6.2 → 4.6.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "4.6.2",
+  "version": "4.6.4",
   "description": "Constructor.io Node.js client",
   "main": "src/constructorio.js",
   "types": "src/types/constructorio.d.ts",

package/src/modules/catalog.js

@@ -898,12 +898,12 @@ class Catalog {
    * constructorio.catalog.addItemGroups({
    *     itemGroups: [
    *         {
-   *             id: 'subcat_12891',
+   *             id: 'cat_49203',
    *             name: 'Hoodies & Sweaters',
-   *             parentId: 'cat_49203',
+   *             children: [{ id: 'subcat_12891', name: 'Blazers'}],
    *         },
    *         {
-   *             id: 'cat49203',
+   *             id: 'cat49204',
    *             name: 'Outerwear',
    *         },
    *     ],
@@ -1048,12 +1048,12 @@ class Catalog {
    * constructorio.catalog.addOrUpdateItemGroups({
    *     itemGroups: [
    *         {
-   *             id: 'subcat_12891',
-   *             name: 'Hoodies, Sweaters, & Jackets',
-   *             parentId: 'cat_49203',
+   *             id: 'cat_49203',
+   *             name: 'Hoodies & Sweaters',
+   *             children: [{ id: 'subcat_12891', name: 'Blazers'}],
    *         },
    *         {
-   *             id: 'cat49203',
+   *             id: 'cat49204',
    *             name: 'Outerwear',
    *         },
    *     ],

package/src/types/catalog.d.ts

@@ -70,12 +70,12 @@ export interface RetrieveVariationsParameters {
 export interface AddItemGroupParameters {
   id: string;
   name: string;
-  parent_id?: string;
+  parentId?: string;
   data?: Record<string, any>;
 }
 
 export interface AddItemGroupsParameters {
-  item_groups: ItemGroup[];
+  itemGroups: ItemGroup[];
 }
 
 export interface GetItemGroupParameters {
@@ -87,7 +87,7 @@ export interface AddOrUpdateItemGroupsParameters
 
 export interface AddOneWaySynonymParameters {
   phrase: string;
-  child_phrases: string[];
+  childPhrases: string[];
 }
 
 export interface ModifyOneWaySynonymParameters
@@ -98,7 +98,7 @@ export interface GetOneWaySynonymParameters {
 }
 
 export interface GetOneWaySynonymsParameters {
-  num_results_per_page?: number;
+  numResultsPerPage?: number;
   page?: number;
 }
 
@@ -120,7 +120,7 @@ export interface GetSynonymGroupParameters {
 
 export interface GetSynonymGroupsParameters {
   phrase?: string;
-  num_results_per_page?: number;
+  numResultsPerPage?: number;
   page?: number;
 }
 
@@ -131,9 +131,9 @@ export interface RemoveSynonymGroupParameters {
 export interface AddRedirectRuleParameters {
   url: string;
   matches: RedirectRuleMatchObject[];
-  start_time?: string;
-  end_time?: string;
-  user_segments?: string[];
+  startTime?: string;
+  endTime?: string;
+  userSegments?: string[];
   metadata?: Record<string, any>;
 }
 
@@ -152,7 +152,7 @@ export interface GetRedirectRuleParameters {
 }
 
 export interface GetRedirectRulesParameters {
-  num_results_per_page?: number;
+  numResultsPerPage?: number;
   page?: number;
   query?: string;
   status?: string;
@@ -164,28 +164,28 @@ export interface RemoveRedirectRuleParameters {
 
 export interface ReplaceCatalogParameters {
   section: string;
-  notification_email?: string;
+  notificationEmail?: string;
   force?: boolean;
   items?: File;
   variations?: File;
-  item_groups?: File;
+  itemGroups?: File;
 }
 
 export interface UpdateCatalogParameters extends ReplaceCatalogParameters {}
 
 export interface PatchCatalogParameters {
   section: string;
-  notification_email?: string;
+  notificationEmail?: string;
   force?: boolean;
   onMissing?: 'IGNORE' | 'CREATE' | 'FAIL';
   items?: File;
   variations?: File;
-  item_groups?: File;
+  itemGroups?: File;
 }
 
 export interface ReplaceCatalogUsingTarArchiveParameters {
   section: string;
-  notification_email?: string;
+  notificationEmail?: string;
   force?: boolean;
   tarArchive?: File;
 }
@@ -200,7 +200,7 @@ export interface PatchCatalogUsingTarArchiveParameters
 
 export interface GetFacetConfigurationsParameters {
   page?: number;
-  num_results_per_page?: number;
+  numResultsPerPage?: number;
   section?: string;
 }
 
@@ -232,7 +232,7 @@ export interface AddOrModifyFacetOptionConfigurationsParameters {
 export interface GetFacetOptionConfigurationsParameters {
   facetGroupName: string;
   page?: number;
-  num_results_per_page?: number;
+  numResultsPerPage?: number;
   section?: string;
 }
 

package/src/types/index.d.ts

@@ -17,7 +17,7 @@ export interface ConstructorClientOptions {
   securityToken?: string;
   version?: string;
   serviceUrl?: string;
-  fetch?: () => any;
+  fetch?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
   networkParameters?: NetworkParameters;
 }
 
@@ -149,7 +149,7 @@ export interface ItemData extends Record<string, any> {
   keywords?: string[];
   url?: string;
   image_url?: string;
-  facets?: Record<string, any>;
+  facets?: Record<string, string[] | number[]>;
   group_ids?: string[];
   description?: string;
   active?: boolean;

package/src/types/search.d.ts

@@ -17,6 +17,7 @@ export default Search;
 
 export interface SearchParameters {
   page?: number;
+  offset?: number;
   resultsPerPage?: number;
   filters?: Record<string, any>;
   sortBy?: string;

package/src/types/tracker.d.ts

@@ -35,9 +35,10 @@ declare class Tracker {
 
   trackItemDetailLoad(
     parameters: {
-      item_name: string;
-      item_id: string;
-      variation_id?: string;
+      itemName: string;
+      itemId: string;
+      url: string;
+      variationId?: string;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -46,11 +47,11 @@ declare class Tracker {
   trackAutocompleteSelect(
     term: string,
     parameters: {
-      original_query: string;
+      originalQuery: string;
       section: string;
       tr?: string;
-      group_id?: string;
-      display_name?: string;
+      groupId?: string;
+      displayName?: string;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -59,9 +60,9 @@ declare class Tracker {
   trackSearchSubmit(
     term: string,
     parameters: {
-      original_query: string;
-      group_id?: string;
-      display_name?: string;
+      originalQuery: string;
+      groupId?: string;
+      displayName?: string;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -70,8 +71,8 @@ declare class Tracker {
   trackSearchResultsLoaded(
     term: string,
     parameters: {
-      num_results: number;
-      item_ids?: string[];
+      numResults: number;
+      itemIds?: string[];
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -80,11 +81,11 @@ declare class Tracker {
   trackSearchResultClick(
     term: string,
     parameters: {
-      item_name: string;
-      item_id: string;
-      variation_id?: string;
-      result_id?: string;
-      item_is_convertible?: string;
+      itemName: string;
+      itemId: string;
+      variationId?: string;
+      resultId?: string;
+      itemIsConvertible?: string;
       section?: string;
     },
     userParameters?: TrackerUserParameters,
@@ -94,14 +95,14 @@ declare class Tracker {
   trackConversion(
     term : string | null | undefined,
     parameters: {
-      item_id: string;
+      itemId: string;
       revenue?: number;
-      item_name?: string;
-      variation_id?: string;
+      itemName?: string;
+      variationId?: string;
       type?: string;
-      is_custom_type?: boolean;
-      display_name?: string;
-      result_id?: string;
+      isCustomType?: boolean;
+      displayName?: string;
+      resultId?: string;
       section?: string;
     },
     userParameters?: TrackerUserParameters,
@@ -112,7 +113,7 @@ declare class Tracker {
     parameters: {
       items: object[];
       revenue: number;
-      order_id?: string;
+      orderId?: string;
       section?: string;
     },
     userParameters?: TrackerUserParameters,
@@ -122,12 +123,12 @@ declare class Tracker {
   trackRecommendationView(
     parameters: {
       url: string;
-      pod_id: string;
-      num_results_viewed: number;
+      podId: string;
+      numResultsViewed: number;
       items?: object[];
-      result_count?: number;
-      result_page?: number;
-      result_id?: string;
+      resultCount?: number;
+      resultPage?: number;
+      resultId?: string;
       section?: string;
     },
     userParameters?: TrackerUserParameters,
@@ -136,17 +137,17 @@ declare class Tracker {
 
   trackRecommendationClick(
     parameters: {
-      pod_id: string;
-      strategy_id: string;
-      item_id: string;
-      item_name: string;
-      variation_id?: string;
+      podId: string;
+      strategyId: string;
+      itemId: string;
+      itemName: string;
+      variationId?: string;
       section?: string;
-      result_id?: string;
-      result_count?: number;
-      result_page?: number;
-      result_position_on_page?: number;
-      num_results_per_page?: number;
+      resultId?: string;
+      resultCount?: number;
+      resultPage?: number;
+      resultPositionOnPage?: number;
+      numResultsPerPage?: number;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -155,15 +156,15 @@ declare class Tracker {
   trackBrowseResultsLoaded(
     parameters: {
       url: string;
-      filter_name: string;
-      filter_value: string;
+      filterName: string;
+      filterValue: string;
       section?: string;
-      result_count?: number;
-      result_page?: number;
-      result_id?: string;
-      selected_filters?: object;
-      sort_order?: string;
-      sort_by?: string;
+      resultCount?: number;
+      resultPage?: number;
+      resultId?: string;
+      selectedFilters?: object;
+      sortOrder?: string;
+      sortBy?: string;
       items?: object[];
     },
     userParameters?: TrackerUserParameters,
@@ -172,17 +173,17 @@ declare class Tracker {
 
   trackBrowseResultClick(
     parameters: {
-      filter_name: string;
-      filter_value: string;
-      item_id: string;
+      filterName: string;
+      filterValue: string;
+      itemId: string;
       section?: string;
-      variation_id?: string;
-      result_id?: string;
-      result_count?: number;
-      result_page?: number;
-      result_position_on_page?: number;
-      num_results_per_page?: number;
-      selected_filters?: object;
+      variationId?: string;
+      resultId?: string;
+      resultCount?: number;
+      resultPage?: number;
+      resultPositionOnPage?: number;
+      numResultsPerPage?: number;
+      selectedFilters?: object;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -190,9 +191,9 @@ declare class Tracker {
 
   trackGenericResultClick(
     parameters: {
-      item_id: string;
-      item_name?: string;
-      variation_id?: string;
+      itemId: string;
+      itemName?: string;
+      variationId?: string;
       section?: string;
     },
     userParameters?: TrackerUserParameters,