@depict-ai/ui 1.0.2 → 1.0.4

package/dist/typescript_schema/SearchRequest.d.ts

@@ -1,213 +0,0 @@
-/* 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 SearchRequest {
-  /**
-   * 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;
-  };
-  /**
-   * 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/SearchResponse.d.ts

@@ -1,192 +0,0 @@
-/* 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 SearchResponse {
-  /**
-   * Total number of results for this query. Not necessarily exact.
-   */
-  n_hits: number;
-  /**
-   * Temporary during migration
-   */
-  page?: number;
-  /**
-   * The search results.
-   */
-  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[];
-  search_request_id: string;
-  /**
-   * 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;
-}
-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[];
-}

package/dist/typescript_schema/SearchSuggestionsRequest.d.ts

@@ -1,18 +0,0 @@
-/* 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 SearchSuggestionsRequest {
-  tenant: string;
-  market: string;
-  /**
-   * The search query.
-   */
-  query?: string;
-  user_id?: string;
-  session_id?: string;
-  dsid?: string;
-}

package/dist/typescript_schema/SearchSuggestionsResponse.d.ts

@@ -1,182 +0,0 @@
-/* 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 ECategoryType = "TAG" | "CATEGORY" | "TENANT_CATEGORY" | "TENANT_SECONDARY_CATEGORY" | "CAMPAIGN";
-
-export interface SearchSuggestionsResponse {
-  suggestions_request_id: string;
-  /**
-   * List of suggestions for search queries that should be shown to the user while they are typing.
-   */
-  suggestions: (QuerySuggestion | CategorySuggestion)[];
-}
-export interface QuerySuggestion {
-  type?: "query";
-  /**
-   * Title for suggestion.
-   */
-  title: string;
-  suggestions_result_id: string;
-}
-export interface CategorySuggestion {
-  /**
-   * 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;
-  /**
-   * type
-   */
-  type?: "category";
-  filter: SearchFilter;
-  suggestions_result_id: string;
-  [k: string]: unknown;
-}
-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[];
-}

package/dist/typescript_schema/TrackV2Request.d.ts

@@ -1,115 +0,0 @@
-/* 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 EUnavailabilityType = "out_of_stock" | "missing";
-
-export interface TrackV2Request {
-  /**
-   * Identifier associated with the API integration
-   */
-  tenant: string;
-  /**
-   * Market identifier
-   */
-  market: string;
-  events: (UserTransactionMappingEvent | PurchaseEvent | ProductUnavailableEvent)[];
-}
-export interface UserTransactionMappingEvent {
-  /**
-   * User Id. Persistent between devices, typically on a logged in user.
-   */
-  user_id?: string;
-  /**
-   * Session Id. Unique to a browser/app and stored locally, e.g. cookie or localStorage.
-   */
-  session_id?: string;
-  /**
-   * Populated for integrations performed by Depict.ai only. Depict.ai Session Id.
-   */
-  dsid?: string;
-  /**
-   * Unique identifier for the transaction.
-   */
-  transaction_id: string;
-  /**
-   * The type identifier for this event: transaction_mapping.
-   */
-  event_type?: "transaction_mapping";
-}
-export interface PurchaseEvent {
-  /**
-   * User Id. Persistent between devices, typically on a logged in user.
-   */
-  user_id?: string;
-  /**
-   * Session Id. Unique to a browser/app and stored locally, e.g. cookie or localStorage.
-   */
-  session_id?: string;
-  /**
-   * Populated for integrations performed by Depict.ai only. Depict.ai Session Id.
-   */
-  dsid?: string;
-  /**
-   * Unique identifier for the transaction.
-   */
-  transaction_id: string;
-  /**
-   * The type identifier for this event: purchase.
-   */
-  event_type?: "purchase";
-  /**
-   * Currency the purchase was paid in
-   */
-  currency: string;
-  /**
-   * All the products purchased in this transaction
-   */
-  products: PurchasedProduct[];
-}
-export interface PurchasedProduct {
-  /**
-   * Stock keeping unit, a distinct item for sale. If you are using Google Analytics, it should be the same id used for products there.
-   */
-  sku: string;
-  /**
-   * Price per unit. If there are discounts because of quantity, the unit price should be adjusted accordingly.
-   */
-  price: number;
-  /**
-   * The number of times the product was purchased.
-   */
-  quantity: number;
-}
-export interface ProductUnavailableEvent {
-  /**
-   * User Id. Persistent between devices, typically on a logged in user.
-   */
-  user_id?: string;
-  /**
-   * Session Id. Unique to a browser/app and stored locally, e.g. cookie or localStorage.
-   */
-  session_id?: string;
-  /**
-   * Populated for integrations performed by Depict.ai only. Depict.ai Session Id.
-   */
-  dsid?: string;
-  /**
-   * The type identifier for this event: product_unavailable.
-   */
-  event_type: "product_unavailable";
-  /**
-   * Main product identifier
-   */
-  product_id: string;
-  /**
-   * Reason the product isn't available for purchase
-   */
-  unavailability_type: EUnavailabilityType;
-}