superposition-sdk 0.88.1__py3-none-any.whl → 0.90.0__py3-none-any.whl

superposition_sdk/models.py

@@ -427,6 +427,10 @@ class AddMembersToGroupOutput:
     """
     Standard response structure for an experiment group.
 
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
     """
 
     id: str
@@ -616,6 +620,13 @@ ShapeID("io.superposition#InternalServerError"): InternalServerError,
 
 @dataclass(kw_only=True)
 class ApplicableVariantsInput:
+    """
+
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
+    """
 
     workspace_id: str | None = None
     org_id: str = "juspay"
@@ -1053,6 +1064,13 @@ class AutocompleteFunctionRequest:
 
 @dataclass(kw_only=True)
 class ContextMove:
+    """
+
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
+    """
 
     context: dict[str, Document]
 
@@ -1122,6 +1140,18 @@ def _deserialize_overrides(deserializer: ShapeDeserializer, schema: Schema) -> d
 
 @dataclass(kw_only=True)
 class ContextPut:
+    """
+
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
+    :param override:
+        **[Required]** - Configuration overrides that replace default values when
+        context conditions are met. Keys represent configuration keys and values are the
+        override data.
+
+    """
 
     context: dict[str, Document]
 
@@ -1187,6 +1217,11 @@ class ContextIdentifierId:
 
 @dataclass
 class ContextIdentifierContext:
+    """
+    Represents conditional criteria used for context matching. Keys define dimension
+    names and values specify the criteria that must be met.
+
+    """
 
     value: dict[str, Document]
 
@@ -1254,6 +1289,14 @@ class _ContextIdentifierDeserializer:
 
 @dataclass(kw_only=True)
 class UpdateContextOverrideRequest:
+    """
+
+    :param override:
+        **[Required]** - Configuration overrides that replace default values when
+        context conditions are met. Keys represent configuration keys and values are the
+        override data.
+
+    """
 
     context: ContextIdentifier
 
@@ -1512,6 +1555,21 @@ class BulkOperationInput:
 
 @dataclass(kw_only=True)
 class ContextResponse:
+    """
+
+    :param value:
+         Represents conditional criteria used for context matching. Keys define dimension
+         names and values specify the criteria that must be met.
+
+    :param override:
+         Configuration overrides that replace default values when context conditions are
+         met. Keys represent configuration keys and values are the override data.
+
+    :param weight:
+         Priority weight used to determine the order of context evaluation. Higher
+         weights take precedence during configuration resolution.
+
+    """
 
     id: str
 
@@ -1908,6 +1966,13 @@ class ExperimentStatusType(StrEnum):
 
 @dataclass(kw_only=True)
 class ConcludeExperimentOutput:
+    """
+
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
+    """
 
     id: str
 
@@ -2161,6 +2226,13 @@ def _deserialize_override_with_keys(deserializer: ShapeDeserializer, schema: Sch
 
 @dataclass(kw_only=True)
 class ContextPartial:
+    """
+
+    :param condition:
+         Represents conditional criteria used for context matching. Keys define dimension
+         names and values specify the criteria that must be met.
+
+    """
 
     id: str | None = None
     condition: dict[str, Document] | None = None
@@ -2273,6 +2345,13 @@ def _deserialize_overrides_map(deserializer: ShapeDeserializer, schema: Schema)
 
 @dataclass(kw_only=True)
 class GetConfigOutput:
+    """
+
+    :param default_configs:
+         Generic key-value object structure used for flexible data representation
+         throughout the API.
+
+    """
 
     contexts: list[ContextPartial] | None = None
     overrides: dict[str, dict[str, Document]] | None = None
@@ -2735,6 +2814,18 @@ LIST_VERSIONS = APIOperation(
 
 @dataclass(kw_only=True)
 class CreateContextInput:
+    """
+
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
+    :param override:
+        **[Required]** - Configuration overrides that replace default values when
+        context conditions are met. Keys represent configuration keys and values are the
+        override data.
+
+    """
 
     workspace_id: str | None = None
     org_id: str = "juspay"
@@ -2799,6 +2890,21 @@ class CreateContextInput:
 
 @dataclass(kw_only=True)
 class CreateContextOutput:
+    """
+
+    :param value:
+         Represents conditional criteria used for context matching. Keys define dimension
+         names and values specify the criteria that must be met.
+
+    :param override:
+         Configuration overrides that replace default values when context conditions are
+         met. Keys represent configuration keys and values are the override data.
+
+    :param weight:
+         Priority weight used to determine the order of context evaluation. Higher
+         weights take precedence during configuration resolution.
+
+    """
 
     id: str
 
@@ -3034,6 +3140,21 @@ class GetContextInput:
 
 @dataclass(kw_only=True)
 class GetContextOutput:
+    """
+
+    :param value:
+         Represents conditional criteria used for context matching. Keys define dimension
+         names and values specify the criteria that must be met.
+
+    :param override:
+         Configuration overrides that replace default values when context conditions are
+         met. Keys represent configuration keys and values are the override data.
+
+    :param weight:
+         Priority weight used to determine the order of context evaluation. Higher
+         weights take precedence during configuration resolution.
+
+    """
 
     id: str
 
@@ -3187,6 +3308,21 @@ class GetContextFromConditionInput:
 
 @dataclass(kw_only=True)
 class GetContextFromConditionOutput:
+    """
+
+    :param value:
+         Represents conditional criteria used for context matching. Keys define dimension
+         names and values specify the criteria that must be met.
+
+    :param override:
+         Configuration overrides that replace default values when context conditions are
+         met. Keys represent configuration keys and values are the override data.
+
+    :param weight:
+         Priority weight used to determine the order of context evaluation. Higher
+         weights take precedence during configuration resolution.
+
+    """
 
     id: str
 
@@ -3300,9 +3436,37 @@ ShapeID("io.superposition#InternalServerError"): InternalServerError,
         ]
 )
 
+class DimensionMatchStrategy(StrEnum):
+    """
+    Strategy to follow while filter items based on the context
+
+    """
+    EXACT = "exact"
+    """
+    Match the overrides which have the exact context
+
+    """
+    SUBSET = "subset"
+    """
+    Match the overrides which have the given context as subset
+
+    """
+
 class SortBy(StrEnum):
+    """
+    Sort order enumeration for list operations.
+
+    """
     DESC = "desc"
+    """
+    Descending order (Z-A, newest first)
+
+    """
     ASC = "asc"
+    """
+    Ascending order (A-Z, oldest first)
+
+    """
 
 class ContextFilterSortOn(StrEnum):
     LAST_MODIFIED_AT = "last_modified_at"
@@ -3311,17 +3475,28 @@ class ContextFilterSortOn(StrEnum):
 
 @dataclass(kw_only=True)
 class ListContextsInput:
+    """
+
+    :param sort_by:
+         Sort order enumeration for list operations.
+
+    :param dimension_match_strategy:
+         Strategy to follow while filter items based on the context
+
+    """
 
     workspace_id: str | None = None
     org_id: str = "juspay"
     page: int | None = None
     count: int | None = None
+    all: bool | None = None
     prefix: str | None = None
     sort_on: str | None = None
     sort_by: str | None = None
     created_by: str | None = None
     last_modified_by: str | None = None
     plaintext: str | None = None
+    dimension_match_strategy: str | None = None
 
     def serialize(self, serializer: ShapeSerializer):
         serializer.write_struct(_SCHEMA_LIST_CONTEXTS_INPUT, self)
@@ -3352,23 +3527,29 @@ class ListContextsInput:
                     kwargs["count"] = de.read_integer(_SCHEMA_LIST_CONTEXTS_INPUT.members["count"])
 
                 case 4:
-                    kwargs["prefix"] = de.read_string(_SCHEMA_LIST_CONTEXTS_INPUT.members["prefix"])
+                    kwargs["all"] = de.read_boolean(_SCHEMA_LIST_CONTEXTS_INPUT.members["all"])
 
                 case 5:
-                    kwargs["sort_on"] = de.read_string(_SCHEMA_LIST_CONTEXTS_INPUT.members["sort_on"])
+                    kwargs["prefix"] = de.read_string(_SCHEMA_LIST_CONTEXTS_INPUT.members["prefix"])
 
                 case 6:
-                    kwargs["sort_by"] = de.read_string(_SCHEMA_LIST_CONTEXTS_INPUT.members["sort_by"])
+                    kwargs["sort_on"] = de.read_string(_SCHEMA_LIST_CONTEXTS_INPUT.members["sort_on"])
 
                 case 7:
-                    kwargs["created_by"] = de.read_string(_SCHEMA_LIST_CONTEXTS_INPUT.members["created_by"])
+                    kwargs["sort_by"] = de.read_string(_SCHEMA_LIST_CONTEXTS_INPUT.members["sort_by"])
 
                 case 8:
-                    kwargs["last_modified_by"] = de.read_string(_SCHEMA_LIST_CONTEXTS_INPUT.members["last_modified_by"])
+                    kwargs["created_by"] = de.read_string(_SCHEMA_LIST_CONTEXTS_INPUT.members["created_by"])
 
                 case 9:
+                    kwargs["last_modified_by"] = de.read_string(_SCHEMA_LIST_CONTEXTS_INPUT.members["last_modified_by"])
+
+                case 10:
                     kwargs["plaintext"] = de.read_string(_SCHEMA_LIST_CONTEXTS_INPUT.members["plaintext"])
 
+                case 11:
+                    kwargs["dimension_match_strategy"] = de.read_string(_SCHEMA_LIST_CONTEXTS_INPUT.members["dimension_match_strategy"])
+
                 case _:
                     logger.debug("Unexpected member schema: %s", schema)
 
@@ -3453,6 +3634,13 @@ LIST_CONTEXTS = APIOperation(
 
 @dataclass(kw_only=True)
 class MoveContextInput:
+    """
+
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
+    """
 
     workspace_id: str | None = None
     org_id: str = "juspay"
@@ -3510,6 +3698,21 @@ class MoveContextInput:
 
 @dataclass(kw_only=True)
 class MoveContextOutput:
+    """
+
+    :param value:
+         Represents conditional criteria used for context matching. Keys define dimension
+         names and values specify the criteria that must be met.
+
+    :param override:
+         Configuration overrides that replace default values when context conditions are
+         met. Keys represent configuration keys and values are the override data.
+
+    :param weight:
+         Priority weight used to determine the order of context evaluation. Higher
+         weights take precedence during configuration resolution.
+
+    """
 
     id: str
 
@@ -3667,6 +3870,21 @@ class UpdateOverrideInput:
 
 @dataclass(kw_only=True)
 class UpdateOverrideOutput:
+    """
+
+    :param value:
+         Represents conditional criteria used for context matching. Keys define dimension
+         names and values specify the criteria that must be met.
+
+    :param override:
+         Configuration overrides that replace default values when context conditions are
+         met. Keys represent configuration keys and values are the override data.
+
+    :param weight:
+         Priority weight used to determine the order of context evaluation. Higher
+         weights take precedence during configuration resolution.
+
+    """
 
     id: str
 
@@ -3820,6 +4038,21 @@ class WeightRecomputeInput:
 
 @dataclass(kw_only=True)
 class WeightRecomputeResponse:
+    """
+
+    :param condition:
+         Represents conditional criteria used for context matching. Keys define dimension
+         names and values specify the criteria that must be met.
+
+    :param old_weight:
+         Priority weight used to determine the order of context evaluation. Higher
+         weights take precedence during configuration resolution.
+
+    :param new_weight:
+         Priority weight used to determine the order of context evaluation. Higher
+         weights take precedence during configuration resolution.
+
+    """
 
     id: str | None = None
     condition: dict[str, Document] | None = None
@@ -4258,6 +4491,13 @@ def _deserialize_dependents(deserializer: ShapeDeserializer, schema: Schema) ->
 
 @dataclass(kw_only=True)
 class CreateDimensionOutput:
+    """
+
+    :param dependency_graph:
+        **[Required]** - Generic key-value object structure used for flexible data
+        representation throughout the API.
+
+    """
 
     dimension: str
 
@@ -4389,6 +4629,13 @@ CREATE_DIMENSION = APIOperation(
 
 @dataclass(kw_only=True)
 class CreateExperimentInput:
+    """
+
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
+    """
 
     workspace_id: str | None = None
     org_id: str = "juspay"
@@ -4477,6 +4724,13 @@ class CreateExperimentInput:
 
 @dataclass(kw_only=True)
 class CreateExperimentOutput:
+    """
+
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
+    """
 
     id: str
 
@@ -4647,6 +4901,10 @@ class CreateExperimentGroupInput:
     :param change_reason:
         **[Required]** - Reason for creating this experiment group.
 
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
     :param member_experiment_ids:
          List of experiment IDs that are members of this group.
 
@@ -4728,6 +4986,10 @@ class CreateExperimentGroupOutput:
     """
     Standard response structure for an experiment group.
 
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
     """
 
     id: str
@@ -5417,6 +5679,13 @@ class Version(StrEnum):
 
 @dataclass(kw_only=True)
 class CreateWebhookInput:
+    """
+
+    :param custom_headers:
+         Generic key-value object structure used for flexible data representation
+         throughout the API.
+
+    """
 
     workspace_id: str | None = None
     org_id: str = "juspay"
@@ -5512,6 +5781,13 @@ class CreateWebhookInput:
 
 @dataclass(kw_only=True)
 class CreateWebhookOutput:
+    """
+
+    :param custom_headers:
+         Generic key-value object structure used for flexible data representation
+         throughout the API.
+
+    """
 
     name: str
 
@@ -6493,6 +6769,10 @@ class DeleteExperimentGroupOutput:
     """
     Standard response structure for an experiment group.
 
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
     """
 
     id: str
@@ -6921,6 +7201,13 @@ class GetDimensionInput:
 
 @dataclass(kw_only=True)
 class GetDimensionOutput:
+    """
+
+    :param dependency_graph:
+        **[Required]** - Generic key-value object structure used for flexible data
+        representation throughout the API.
+
+    """
 
     dimension: str
 
@@ -7099,6 +7386,13 @@ class ListDimensionsInput:
 
 @dataclass(kw_only=True)
 class DimensionExt:
+    """
+
+    :param dependency_graph:
+        **[Required]** - Generic key-value object structure used for flexible data
+        representation throughout the API.
+
+    """
 
     dimension: str
 
@@ -7377,6 +7671,13 @@ class UpdateDimensionInput:
 
 @dataclass(kw_only=True)
 class UpdateDimensionOutput:
+    """
+
+    :param dependency_graph:
+        **[Required]** - Generic key-value object structure used for flexible data
+        representation throughout the API.
+
+    """
 
     dimension: str
 
@@ -7552,6 +7853,13 @@ class DiscardExperimentInput:
 
 @dataclass(kw_only=True)
 class DiscardExperimentOutput:
+    """
+
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
+    """
 
     id: str
 
@@ -7757,6 +8065,10 @@ class GetExperimentGroupOutput:
     """
     Standard response structure for an experiment group.
 
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
     """
 
     id: str
@@ -7997,6 +8309,10 @@ class ExperimentGroupResponse:
     """
     Standard response structure for an experiment group.
 
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
     """
 
     id: str
@@ -8250,6 +8566,10 @@ class RemoveMembersFromGroupOutput:
     """
     Standard response structure for an experiment group.
 
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
     """
 
     id: str
@@ -8447,6 +8767,10 @@ class UpdateExperimentGroupOutput:
     """
     Standard response structure for an experiment group.
 
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
     """
 
     id: str
@@ -8571,6 +8895,13 @@ ShapeID("io.superposition#InternalServerError"): InternalServerError,
 
 @dataclass(kw_only=True)
 class ExperimentResponse:
+    """
+
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
+    """
 
     id: str
 
@@ -8776,6 +9107,13 @@ class GetExperimentInput:
 
 @dataclass(kw_only=True)
 class GetExperimentOutput:
+    """
+
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
+    """
 
     id: str
 
@@ -8944,6 +9282,15 @@ class ExperimentSortOn(StrEnum):
 
 @dataclass(kw_only=True)
 class ListExperimentInput:
+    """
+
+    :param sort_by:
+         Sort order enumeration for list operations.
+
+    :param dimension_match_strategy:
+         Strategy to follow while filter items based on the context
+
+    """
 
     workspace_id: str | None = None
     org_id: str = "juspay"
@@ -8959,6 +9306,8 @@ class ListExperimentInput:
     created_by: str | None = None
     sort_on: str | None = None
     sort_by: str | None = None
+    global_experiments_only: bool | None = None
+    dimension_match_strategy: str | None = None
 
     def serialize(self, serializer: ShapeSerializer):
         serializer.write_struct(_SCHEMA_LIST_EXPERIMENT_INPUT, self)
@@ -9018,6 +9367,12 @@ class ListExperimentInput:
                 case 13:
                     kwargs["sort_by"] = de.read_string(_SCHEMA_LIST_EXPERIMENT_INPUT.members["sort_by"])
 
+                case 14:
+                    kwargs["global_experiments_only"] = de.read_boolean(_SCHEMA_LIST_EXPERIMENT_INPUT.members["global_experiments_only"])
+
+                case 15:
+                    kwargs["dimension_match_strategy"] = de.read_string(_SCHEMA_LIST_EXPERIMENT_INPUT.members["dimension_match_strategy"])
+
                 case _:
                     logger.debug("Unexpected member schema: %s", schema)
 
@@ -9125,6 +9480,13 @@ class PauseExperimentInput:
 
 @dataclass(kw_only=True)
 class PauseExperimentOutput:
+    """
+
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
+    """
 
     id: str
 
@@ -9339,6 +9701,13 @@ class RampExperimentInput:
 
 @dataclass(kw_only=True)
 class RampExperimentOutput:
+    """
+
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
+    """
 
     id: str
 
@@ -9546,6 +9915,13 @@ class ResumeExperimentInput:
 
 @dataclass(kw_only=True)
 class ResumeExperimentOutput:
+    """
+
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
+    """
 
     id: str
 
@@ -9834,6 +10210,13 @@ class UpdateOverridesExperimentInput:
 
 @dataclass(kw_only=True)
 class UpdateOverridesExperimentOutput:
+    """
+
+    :param context:
+        **[Required]** - Represents conditional criteria used for context matching. Keys
+        define dimension names and values specify the criteria that must be met.
+
+    """
 
     id: str
 
@@ -11398,6 +11781,13 @@ class GetWebhookInput:
 
 @dataclass(kw_only=True)
 class GetWebhookOutput:
+    """
+
+    :param custom_headers:
+         Generic key-value object structure used for flexible data representation
+         throughout the API.
+
+    """
 
     name: str
 
@@ -11790,6 +12180,13 @@ class ListWebhookInput:
 
 @dataclass(kw_only=True)
 class WebhookResponse:
+    """
+
+    :param custom_headers:
+         Generic key-value object structure used for flexible data representation
+         throughout the API.
+
+    """
 
     name: str
 
@@ -12721,6 +13118,13 @@ ShapeID("io.superposition#InternalServerError"): InternalServerError,
 
 @dataclass(kw_only=True)
 class UpdateWebhookInput:
+    """
+
+    :param custom_headers:
+         Generic key-value object structure used for flexible data representation
+         throughout the API.
+
+    """
 
     workspace_id: str | None = None
     org_id: str = "juspay"
@@ -12813,6 +13217,13 @@ class UpdateWebhookInput:
 
 @dataclass(kw_only=True)
 class UpdateWebhookOutput:
+    """
+
+    :param custom_headers:
+         Generic key-value object structure used for flexible data representation
+         throughout the API.
+
+    """
 
     name: str