@depict-ai/ui 1.0.4 → 1.0.6

package/dist/typescript_schema/BaseSearchRequest.d.ts

@@ -0,0 +1,197 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * An enumeration.
+ */
+export type SortingOrder = "asc" | "desc";
+
+export interface BaseSearchRequest {
+  tenant: string;
+  market: string;
+  /**
+   * List of filters to apply to the results.
+   */
+  filters?: SearchFilter[];
+  /**
+   * Specifies the sorting method. By default, the results are ordered by relevance. To find the possible values for this field, query the endpoint and look at the `sorts` field.
+   */
+  sort?: SortModel;
+  /**
+   * User identifier
+   */
+  user_id?: string;
+  /**
+   * Session identifier
+   */
+  session_id?: string;
+  /**
+   * Populated for integrations performed by Depict.ai only. Depict.ai Session Id
+   */
+  dsid?: string;
+  /**
+   * Metadata that can be used to modify the behaviour of the search.
+   */
+  metadata?: {
+    [k: string]: string;
+  };
+  /**
+   * The search query.
+   */
+  query?: string;
+}
+export interface SearchFilter {
+  /**
+   * The field to filter by.
+   */
+  field: string;
+  /**
+   * The operation used for filtering. The filtering should be read as `field op data`, for example `brand in ["Nike", "Adidas"]`.
+   */
+  op: "eq" | "neq" | "in" | "nin" | "leq" | "geq" | "inrange";
+  /**
+   * Data for the filter.
+   */
+  data?:
+    | ("true" | "false")
+    | number
+    | number
+    | string
+    | [number, number]
+    | [number, number]
+    | [number, number]
+    | [number, number]
+    | (
+        | ("true" | "false")
+        | number
+        | number
+        | string
+        | [number, number]
+        | [number, number]
+        | [number, number]
+        | [number, number]
+      )[]
+    | (("true" | "false") | number | number | string)[][];
+  /**
+   * Metadata about the filter that can be used for rendering. For example, this could contain the possible values to filter by and their counts in the results.
+   */
+  meta?: RangeFilterMeta | ValuesFilterMeta | HierarchicalValuesFilterMeta;
+  /**
+   * ID of the filter. If multiple filters share the same ID, they should be grouped together in the UI.
+   */
+  id?: string;
+}
+export interface RangeFilterMeta {
+  /**
+   * Title of the group, where a group consists of all the filters that share an ID.
+   */
+  group_title?: string;
+  /**
+   * Whether the filter group should be expanded by default or not.
+   */
+  group_expanded?: boolean;
+  type?: "range";
+  /**
+   * The minimum value that can be selected in the range.
+   */
+  min: number;
+  /**
+   * The maximum value that can be selected in the range.
+   */
+  max: number;
+  /**
+   * The unit of the range values.
+   */
+  unit?: string;
+  /**
+   * The currency of the range values.
+   */
+  currency?: string;
+}
+export interface ValuesFilterMeta {
+  /**
+   * Title of the group, where a group consists of all the filters that share an ID.
+   */
+  group_title?: string;
+  /**
+   * Whether the filter group should be expanded by default or not.
+   */
+  group_expanded?: boolean;
+  /**
+   * Type of filter.
+   */
+  type?: "radio" | "checkbox" | "checkbox-grid";
+  /**
+   * Selectable values
+   */
+  values: (
+    | ("true" | "false")
+    | number
+    | number
+    | string
+    | [number, number]
+    | [number, number]
+    | [number, number]
+    | [number, number]
+  )[];
+  /**
+   * Counts for values
+   */
+  counts?: number[];
+  /**
+   * Names for values
+   */
+  names?: string[];
+}
+export interface HierarchicalValuesFilterMeta {
+  /**
+   * Title of the group, where a group consists of all the filters that share an ID.
+   */
+  group_title?: string;
+  /**
+   * Whether the filter group should be expanded by default or not.
+   */
+  group_expanded?: boolean;
+  type?: "checkbox-hierarchical";
+  /**
+   * Selectable hierarchical values
+   */
+  values: (("true" | "false") | number | number | string)[][];
+  /**
+   * Counts for values
+   */
+  counts?: number[];
+  /**
+   * Names for hierarchical values
+   */
+  names?: string[];
+}
+export interface SortModel {
+  /**
+   * The field to sort by.
+   */
+  field: string;
+  /**
+   * The order to sort by.
+   */
+  order: SortingOrder;
+  /**
+   * Metadata about the sort that can be used for rendering.
+   */
+  meta?: SortMeta;
+}
+export interface SortMeta {
+  title: string;
+  /**
+   * Selectable values
+   */
+  values?: SortingOrder[];
+  /**
+   * Names for orders
+   */
+  names?: string[];
+}

package/dist/typescript_schema/ProductListingQueriesRequest.d.ts

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface ProductListingQueriesRequest {
+  tenant: string;
+  market: string;
+  metadata?: {
+    [k: string]: string;
+  };
+}

package/dist/typescript_schema/ProductListingQueriesResponse.d.ts

@@ -0,0 +1,10 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface ProductListingQueriesResponse {
+  query_ids?: string[];
+}

package/dist/typescript_schema/ProductListingRequest.d.ts

@@ -0,0 +1,221 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * An enumeration.
+ */
+export type SortingOrder = "asc" | "desc";
+
+export interface ProductListingRequest {
+  /**
+   * Deprecated, do not use. Will be removed.
+   */
+  page?: number;
+  /**
+   * Deprecated, do not use. Will be removed.
+   */
+  hits_per_page?: number;
+  /**
+   * Used for cursor-based pagination. Set it to the cursor from the last response. If not set, will return the first results.
+   */
+  cursor?: string;
+  /**
+   * Maximum number of results per response.
+   */
+  limit?: number;
+  tenant: string;
+  market: string;
+  /**
+   * List of filters to apply to the results.
+   */
+  filters?: SearchFilter[];
+  /**
+   * Specifies the sorting method. By default, the results are ordered by relevance. To find the possible values for this field, query the endpoint and look at the `sorts` field.
+   */
+  sort?: SortModel;
+  /**
+   * User identifier
+   */
+  user_id?: string;
+  /**
+   * Session identifier
+   */
+  session_id?: string;
+  /**
+   * Populated for integrations performed by Depict.ai only. Depict.ai Session Id
+   */
+  dsid?: string;
+  /**
+   * Metadata that can be used to modify the behaviour of the search.
+   */
+  metadata?: {
+    [k: string]: string;
+  };
+  /**
+   * ID of the page to get products for. This is typically the slug, for example `hoodies-and-sweaters`.
+   */
+  query_id: string;
+  /**
+   * Disables rules to hide products.
+   */
+  show_hidden_products?: boolean;
+  /**
+   * Whether to return grouping IDs or not.
+   */
+  return_grouping_ids?: boolean;
+}
+export interface SearchFilter {
+  /**
+   * The field to filter by.
+   */
+  field: string;
+  /**
+   * The operation used for filtering. The filtering should be read as `field op data`, for example `brand in ["Nike", "Adidas"]`.
+   */
+  op: "eq" | "neq" | "in" | "nin" | "leq" | "geq" | "inrange";
+  /**
+   * Data for the filter.
+   */
+  data?:
+    | ("true" | "false")
+    | number
+    | number
+    | string
+    | [number, number]
+    | [number, number]
+    | [number, number]
+    | [number, number]
+    | (
+        | ("true" | "false")
+        | number
+        | number
+        | string
+        | [number, number]
+        | [number, number]
+        | [number, number]
+        | [number, number]
+      )[]
+    | (("true" | "false") | number | number | string)[][];
+  /**
+   * Metadata about the filter that can be used for rendering. For example, this could contain the possible values to filter by and their counts in the results.
+   */
+  meta?: RangeFilterMeta | ValuesFilterMeta | HierarchicalValuesFilterMeta;
+  /**
+   * ID of the filter. If multiple filters share the same ID, they should be grouped together in the UI.
+   */
+  id?: string;
+}
+export interface RangeFilterMeta {
+  /**
+   * Title of the group, where a group consists of all the filters that share an ID.
+   */
+  group_title?: string;
+  /**
+   * Whether the filter group should be expanded by default or not.
+   */
+  group_expanded?: boolean;
+  type?: "range";
+  /**
+   * The minimum value that can be selected in the range.
+   */
+  min: number;
+  /**
+   * The maximum value that can be selected in the range.
+   */
+  max: number;
+  /**
+   * The unit of the range values.
+   */
+  unit?: string;
+  /**
+   * The currency of the range values.
+   */
+  currency?: string;
+}
+export interface ValuesFilterMeta {
+  /**
+   * Title of the group, where a group consists of all the filters that share an ID.
+   */
+  group_title?: string;
+  /**
+   * Whether the filter group should be expanded by default or not.
+   */
+  group_expanded?: boolean;
+  /**
+   * Type of filter.
+   */
+  type?: "radio" | "checkbox" | "checkbox-grid";
+  /**
+   * Selectable values
+   */
+  values: (
+    | ("true" | "false")
+    | number
+    | number
+    | string
+    | [number, number]
+    | [number, number]
+    | [number, number]
+    | [number, number]
+  )[];
+  /**
+   * Counts for values
+   */
+  counts?: number[];
+  /**
+   * Names for values
+   */
+  names?: string[];
+}
+export interface HierarchicalValuesFilterMeta {
+  /**
+   * Title of the group, where a group consists of all the filters that share an ID.
+   */
+  group_title?: string;
+  /**
+   * Whether the filter group should be expanded by default or not.
+   */
+  group_expanded?: boolean;
+  type?: "checkbox-hierarchical";
+  /**
+   * Selectable hierarchical values
+   */
+  values: (("true" | "false") | number | number | string)[][];
+  /**
+   * Counts for values
+   */
+  counts?: number[];
+  /**
+   * Names for hierarchical values
+   */
+  names?: string[];
+}
+export interface SortModel {
+  /**
+   * The field to sort by.
+   */
+  field: string;
+  /**
+   * The order to sort by.
+   */
+  order: SortingOrder;
+  /**
+   * Metadata about the sort that can be used for rendering.
+   */
+  meta?: SortMeta;
+}
+export interface SortMeta {
+  title: string;
+  /**
+   * Selectable values
+   */
+  values?: SortingOrder[];
+  /**
+   * Names for orders
+   */
+  names?: string[];
+}

package/dist/typescript_schema/ProductListingResponse.d.ts

@@ -0,0 +1,232 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * An enumeration.
+ */
+export type SortingOrder = "asc" | "desc";
+/**
+ * An enumeration.
+ */
+export type ECategoryType = "TAG" | "CATEGORY" | "TENANT_CATEGORY" | "TENANT_SECONDARY_CATEGORY" | "CAMPAIGN";
+
+export interface ProductListingResponse {
+  /**
+   * Total number of results for this query. Not necessarily exact.
+   */
+  n_hits: number;
+  /**
+   * Deprecated, do not use.
+   */
+  page?: number;
+  /**
+   * The products to be shown on the product listing page.
+   */
+  displays: {
+    [k: string]: unknown;
+  }[];
+  /**
+   * Available methods for sorting the response. Any element from this list can be sent as `sort` in subsequent requests.
+   */
+  sorts?: SortModel[];
+  /**
+   * Available filters that can be used for filtering in the subsequent request.
+   */
+  filters?: SearchFilter[];
+  product_listing_request_id: string;
+  /**
+   * Breadcrumb for the current page. Ordered from less to more specific, where the last element is the current page.
+   */
+  breadcrumb?: BaseCategoryDisplay[];
+  /**
+   * List of pages that can be used as quick links. Will return child pages if they exist, otherwise sibling pages.
+   */
+  quick_links?: BaseCategoryDisplay[];
+  /**
+   * Cursor that can be used in the next request to get subsequent results. If this is not set, there are no more results.
+   */
+  cursor?: string;
+  /**
+   * Maps product ID to grouping ID. Only returned if `return_grouping_ids` is True.
+   */
+  grouping_ids?: {
+    [k: string]: string;
+  };
+}
+export interface SortModel {
+  /**
+   * The field to sort by.
+   */
+  field: string;
+  /**
+   * The order to sort by.
+   */
+  order: SortingOrder;
+  /**
+   * Metadata about the sort that can be used for rendering.
+   */
+  meta?: SortMeta;
+}
+export interface SortMeta {
+  title: string;
+  /**
+   * Selectable values
+   */
+  values?: SortingOrder[];
+  /**
+   * Names for orders
+   */
+  names?: string[];
+}
+export interface SearchFilter {
+  /**
+   * The field to filter by.
+   */
+  field: string;
+  /**
+   * The operation used for filtering. The filtering should be read as `field op data`, for example `brand in ["Nike", "Adidas"]`.
+   */
+  op: "eq" | "neq" | "in" | "nin" | "leq" | "geq" | "inrange";
+  /**
+   * Data for the filter.
+   */
+  data?:
+    | ("true" | "false")
+    | number
+    | number
+    | string
+    | [number, number]
+    | [number, number]
+    | [number, number]
+    | [number, number]
+    | (
+        | ("true" | "false")
+        | number
+        | number
+        | string
+        | [number, number]
+        | [number, number]
+        | [number, number]
+        | [number, number]
+      )[]
+    | (("true" | "false") | number | number | string)[][];
+  /**
+   * Metadata about the filter that can be used for rendering. For example, this could contain the possible values to filter by and their counts in the results.
+   */
+  meta?: RangeFilterMeta | ValuesFilterMeta | HierarchicalValuesFilterMeta;
+  /**
+   * ID of the filter. If multiple filters share the same ID, they should be grouped together in the UI.
+   */
+  id?: string;
+}
+export interface RangeFilterMeta {
+  /**
+   * Title of the group, where a group consists of all the filters that share an ID.
+   */
+  group_title?: string;
+  /**
+   * Whether the filter group should be expanded by default or not.
+   */
+  group_expanded?: boolean;
+  type?: "range";
+  /**
+   * The minimum value that can be selected in the range.
+   */
+  min: number;
+  /**
+   * The maximum value that can be selected in the range.
+   */
+  max: number;
+  /**
+   * The unit of the range values.
+   */
+  unit?: string;
+  /**
+   * The currency of the range values.
+   */
+  currency?: string;
+}
+export interface ValuesFilterMeta {
+  /**
+   * Title of the group, where a group consists of all the filters that share an ID.
+   */
+  group_title?: string;
+  /**
+   * Whether the filter group should be expanded by default or not.
+   */
+  group_expanded?: boolean;
+  /**
+   * Type of filter.
+   */
+  type?: "radio" | "checkbox" | "checkbox-grid";
+  /**
+   * Selectable values
+   */
+  values: (
+    | ("true" | "false")
+    | number
+    | number
+    | string
+    | [number, number]
+    | [number, number]
+    | [number, number]
+    | [number, number]
+  )[];
+  /**
+   * Counts for values
+   */
+  counts?: number[];
+  /**
+   * Names for values
+   */
+  names?: string[];
+}
+export interface HierarchicalValuesFilterMeta {
+  /**
+   * Title of the group, where a group consists of all the filters that share an ID.
+   */
+  group_title?: string;
+  /**
+   * Whether the filter group should be expanded by default or not.
+   */
+  group_expanded?: boolean;
+  type?: "checkbox-hierarchical";
+  /**
+   * Selectable hierarchical values
+   */
+  values: (("true" | "false") | number | number | string)[][];
+  /**
+   * Counts for values
+   */
+  counts?: number[];
+  /**
+   * Names for hierarchical values
+   */
+  names?: string[];
+}
+export interface BaseCategoryDisplay {
+  /**
+   * Unique identifier of the category.
+   */
+  category_id: string;
+  /**
+   * The title of the category
+   */
+  title: string;
+  /**
+   * The full URL to the category page
+   */
+  page_url: string;
+  /**
+   * Optionally a unique query ID for the category
+   */
+  query_id?: string;
+  /**
+   * The type of category, for example CAMPAIGN, TAG, or CATEGORY
+   */
+  category_type?: ECategoryType & string;
+}

package/dist/typescript_schema/RecommendResponse.d.ts

@@ -0,0 +1,15 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface RecommendResponse {
+  displays: {
+    [k: string]: unknown;
+  }[];
+  error?: string;
+  variant?: number;
+  experiment_id?: string;
+}