chore: generated code for commit d3aead8. [skip ci]

Co-authored-by: Ben Greenbank <[email protected]>
Co-authored-by: Clément Vannicatte <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
Co-authored-by: Thomas Raffray <[email protected]>

Author: 5 people

clients/algoliasearch-client-javascript/packages/predict/model/createSegmentParams.ts

@@ -1,13 +1,12 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
+import type { SegmentParentConditions } from './segmentParentConditions';
+
 export type CreateSegmentParams = {
   /**
    * The name or description of the segment.
    */
   name: string;
 
-  /**
-   * The filters that define the segment, defined in the same way as filters for Rules.
-   */
-  conditions: string;
+  conditions: SegmentParentConditions;
 };

clients/algoliasearch-client-javascript/packages/predict/model/createSegmentResponse.ts

@@ -7,7 +7,7 @@ export type CreateSegmentResponse = {
   segmentID: string;
 
   /**
-   * The date and time at which the segment was last updated.
+   * The date and time at which the segment was last updated (RFC3339).
    */
   updatedAt: string;
 };

clients/algoliasearch-client-javascript/packages/predict/model/index.ts

@@ -40,8 +40,26 @@ export * from './predictionsOrderValueSuccess';
 export * from './previousPageTokenParam';
 export * from './properties';
 export * from './segment';
+export * from './segmentAffinityFilter';
+export * from './segmentAffinityFilterValue';
+export * from './segmentChildConditionOperands';
+export * from './segmentChildConditions';
+export * from './segmentConditionOperator';
 export * from './segmentConditionsParam';
+export * from './segmentFilterOperatorBoolean';
+export * from './segmentFilterOperatorNumerical';
+export * from './segmentFilterProbability';
+export * from './segmentFunnelStageFilter';
 export * from './segmentNameParam';
+export * from './segmentOperandAffinity';
+export * from './segmentOperandFunnelStage';
+export * from './segmentOperandOrderValue';
+export * from './segmentOperandProperty';
+export * from './segmentOrderValueFilter';
+export * from './segmentParentConditionOperands';
+export * from './segmentParentConditions';
+export * from './segmentPropertyFilter';
+export * from './segmentPropertyFilterValue';
 export * from './segmentStatus';
 export * from './segmentType';
 export * from './segments';

clients/algoliasearch-client-javascript/packages/predict/model/segment.ts

@@ -1,17 +1,26 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
+import type { SegmentParentConditions } from './segmentParentConditions';
 import type { SegmentStatus } from './segmentStatus';
 import type { SegmentType } from './segmentType';
 
 export type Segment = {
+  /**
+   * The segment syntax version.
+   */
+  version: number;
+
   /**
    * The ID of the segment.
    */
   segmentID: string;
 
+  /**
+   * The name of the segment.
+   */
   name: string;
 
-  conditions: string;
+  conditions: SegmentParentConditions;
 
   segmentStatus: SegmentStatus;
 

clients/algoliasearch-client-javascript/packages/predict/model/segmentAffinityFilter.ts

@@ -0,0 +1,16 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SegmentAffinityFilterValue } from './segmentAffinityFilterValue';
+import type { SegmentFilterOperatorNumerical } from './segmentFilterOperatorNumerical';
+import type { SegmentFilterProbability } from './segmentFilterProbability';
+
+/**
+ * Filter for affinity model predictions.
+ */
+export type SegmentAffinityFilter = {
+  operator?: SegmentFilterOperatorNumerical;
+
+  value: SegmentAffinityFilterValue;
+
+  probability: SegmentFilterProbability;
+};

clients/algoliasearch-client-javascript/packages/predict/model/segmentAffinityFilterValue.ts

@@ -0,0 +1,3 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type SegmentAffinityFilterValue = string[] | boolean | number | string;

clients/algoliasearch-client-javascript/packages/predict/model/segmentChildConditionOperands.ts

@@ -0,0 +1,12 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SegmentOperandAffinity } from './segmentOperandAffinity';
+import type { SegmentOperandFunnelStage } from './segmentOperandFunnelStage';
+import type { SegmentOperandOrderValue } from './segmentOperandOrderValue';
+import type { SegmentOperandProperty } from './segmentOperandProperty';
+
+export type SegmentChildConditionOperands =
+  | SegmentOperandAffinity
+  | SegmentOperandFunnelStage
+  | SegmentOperandOrderValue
+  | SegmentOperandProperty;

clients/algoliasearch-client-javascript/packages/predict/model/segmentChildConditions.ts

@@ -0,0 +1,13 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SegmentChildConditionOperands } from './segmentChildConditionOperands';
+import type { SegmentConditionOperator } from './segmentConditionOperator';
+
+/**
+ * Nested segment conditions that only contain operands.
+ */
+export type SegmentChildConditions = {
+  operator: SegmentConditionOperator;
+
+  operands: SegmentChildConditionOperands[];
+};

clients/algoliasearch-client-javascript/packages/predict/model/segmentConditionOperator.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Operator used to combine the operands.
+ */
+export type SegmentConditionOperator = 'AND' | 'OR';

clients/algoliasearch-client-javascript/packages/predict/model/segmentConditionsParam.ts

@@ -1,8 +1,7 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
+import type { SegmentParentConditions } from './segmentParentConditions';
+
 export type SegmentConditionsParam = {
-  /**
-   * The filters that define the segment, defined in the same way as filters for Rules.
-   */
-  conditions?: string;
+  conditions?: SegmentParentConditions;
 };

clients/algoliasearch-client-javascript/packages/predict/model/segmentFilterOperatorBoolean.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * The operator used on the boolean filter value.
+ */
+export type SegmentFilterOperatorBoolean = '!=' | '=';

clients/algoliasearch-client-javascript/packages/predict/model/segmentFilterOperatorNumerical.ts

@@ -0,0 +1,12 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * The operator used on the numerical filter value.
+ */
+export type SegmentFilterOperatorNumerical =
+  | '!='
+  | '<'
+  | '<='
+  | '='
+  | '>'
+  | '>=';

clients/algoliasearch-client-javascript/packages/predict/model/segmentFilterProbability.ts

@@ -0,0 +1,14 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Probability of the filter.
+ */
+export type SegmentFilterProbability = {
+  lt?: number;
+
+  lte?: number;
+
+  gt?: number;
+
+  gte?: number;
+};

clients/algoliasearch-client-javascript/packages/predict/model/segmentFunnelStageFilter.ts

@@ -0,0 +1,15 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SegmentFilterOperatorBoolean } from './segmentFilterOperatorBoolean';
+import type { SegmentFilterProbability } from './segmentFilterProbability';
+
+/**
+ * Filter for funnel stage model predictions.
+ */
+export type SegmentFunnelStageFilter = {
+  operator?: SegmentFilterOperatorBoolean;
+
+  value: string;
+
+  probability: SegmentFilterProbability;
+};

clients/algoliasearch-client-javascript/packages/predict/model/segmentOperandAffinity.ts

@@ -0,0 +1,12 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SegmentAffinityFilter } from './segmentAffinityFilter';
+
+/**
+ * Operand for affinity model predictions.
+ */
+export type SegmentOperandAffinity = {
+  name: string;
+
+  filters: SegmentAffinityFilter[];
+};

clients/algoliasearch-client-javascript/packages/predict/model/segmentOperandFunnelStage.ts

@@ -0,0 +1,12 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SegmentFunnelStageFilter } from './segmentFunnelStageFilter';
+
+/**
+ * Operand for funnel stage model predictions.
+ */
+export type SegmentOperandFunnelStage = {
+  name: string;
+
+  filters: SegmentFunnelStageFilter[];
+};

clients/algoliasearch-client-javascript/packages/predict/model/segmentOperandOrderValue.ts

@@ -0,0 +1,12 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SegmentOrderValueFilter } from './segmentOrderValueFilter';
+
+/**
+ * Operand for order value model predictions.
+ */
+export type SegmentOperandOrderValue = {
+  name: string;
+
+  filters: SegmentOrderValueFilter[];
+};

clients/algoliasearch-client-javascript/packages/predict/model/segmentOperandProperty.ts

@@ -0,0 +1,12 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SegmentPropertyFilter } from './segmentPropertyFilter';
+
+/**
+ * Operand for user profile properties.
+ */
+export type SegmentOperandProperty = {
+  name: string;
+
+  filters: SegmentPropertyFilter[];
+};

clients/algoliasearch-client-javascript/packages/predict/model/segmentOrderValueFilter.ts

@@ -0,0 +1,12 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SegmentFilterOperatorNumerical } from './segmentFilterOperatorNumerical';
+
+/**
+ * Filter for order value model predictions.
+ */
+export type SegmentOrderValueFilter = {
+  operator?: SegmentFilterOperatorNumerical;
+
+  value: number;
+};

clients/algoliasearch-client-javascript/packages/predict/model/segmentParentConditionOperands.ts

@@ -0,0 +1,14 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SegmentChildConditions } from './segmentChildConditions';
+import type { SegmentOperandAffinity } from './segmentOperandAffinity';
+import type { SegmentOperandFunnelStage } from './segmentOperandFunnelStage';
+import type { SegmentOperandOrderValue } from './segmentOperandOrderValue';
+import type { SegmentOperandProperty } from './segmentOperandProperty';
+
+export type SegmentParentConditionOperands =
+  | SegmentChildConditions
+  | SegmentOperandAffinity
+  | SegmentOperandFunnelStage
+  | SegmentOperandOrderValue
+  | SegmentOperandProperty;

clients/algoliasearch-client-javascript/packages/predict/model/segmentParentConditions.ts

@@ -0,0 +1,13 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SegmentConditionOperator } from './segmentConditionOperator';
+import type { SegmentParentConditionOperands } from './segmentParentConditionOperands';
+
+/**
+ * The conditions that define which user profiles are included in the segment.  Can contain operands and a maximum of 1 level of nested conditions.
+ */
+export type SegmentParentConditions = {
+  operator: SegmentConditionOperator;
+
+  operands: SegmentParentConditionOperands[];
+};

clients/algoliasearch-client-javascript/packages/predict/model/segmentPropertyFilter.ts

@@ -0,0 +1,13 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SegmentFilterOperatorNumerical } from './segmentFilterOperatorNumerical';
+import type { SegmentPropertyFilterValue } from './segmentPropertyFilterValue';
+
+/**
+ * Filter for user profile properties.
+ */
+export type SegmentPropertyFilter = {
+  operator?: SegmentFilterOperatorNumerical;
+
+  value: SegmentPropertyFilterValue;
+};

clients/algoliasearch-client-javascript/packages/predict/model/segmentPropertyFilterValue.ts

@@ -0,0 +1,5 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SegmentAffinityFilterValue } from './segmentAffinityFilterValue';
+
+export type SegmentPropertyFilterValue = SegmentAffinityFilterValue;

clients/algoliasearch-client-javascript/packages/predict/model/segmentStatus.ts

@@ -1,3 +1,6 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
+/**
+ * The status of the segment.
+ */
 export type SegmentStatus = 'active' | 'failed' | 'pending';

clients/algoliasearch-client-javascript/packages/predict/model/segmentType.ts

@@ -1,3 +1,6 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
+/**
+ * The type of the segment.
+ */
 export type SegmentType = 'computed' | 'custom';

clients/algoliasearch-client-javascript/packages/predict/model/updateSegmentResponse.ts

@@ -7,7 +7,7 @@ export type UpdateSegmentResponse = {
   segmentID: string;
 
   /**
-   * The date and time at which the segment was last updated.
+   * The date and time at which the segment was last updated (RFC3339).
    */
   updatedAt: string;
 };