mixpeek 0.11.2__py3-none-any.whl → 0.13__py3-none-any.whl

mixpeek/searchinteractions.py

@@ -0,0 +1,647 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from .basesdk import BaseSDK
+from mixpeek import models, utils
+from mixpeek._hooks import HookContext
+from mixpeek.types import OptionalNullable, UNSET
+from typing import Any, Mapping, Optional, Union
+
+
+class SearchInteractions(BaseSDK):
+    def create(
+        self,
+        *,
+        feature_id: str,
+        interaction_type: models.InteractionType,
+        x_namespace: OptionalNullable[str] = UNSET,
+        search_request: OptionalNullable[
+            Union[
+                models.SearchRequestFeaturesInput,
+                models.SearchRequestFeaturesInputTypedDict,
+            ]
+        ] = UNSET,
+        position: OptionalNullable[int] = UNSET,
+        metadata: OptionalNullable[
+            Union[models.Metadata, models.MetadataTypedDict]
+        ] = UNSET,
+        session_id: OptionalNullable[str] = UNSET,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.InteractionResponse:
+        r"""Create Interaction
+
+        Record a search interaction (view, click, feedback, etc.)
+
+        :param feature_id: ID of the item that was interacted with
+        :param interaction_type:
+        :param x_namespace: Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.
+        :param search_request: The search request that led to this interaction
+        :param position: Position in search results where interaction occurred
+        :param metadata: Additional context about the interaction
+        :param session_id: Search session identifier
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+
+        request = models.CreateInteractionFeaturesSearchInteractionsPostRequest(
+            x_namespace=x_namespace,
+            search_interaction=models.SearchInteraction(
+                feature_id=feature_id,
+                interaction_type=interaction_type,
+                search_request=utils.get_pydantic_model(
+                    search_request, OptionalNullable[models.SearchRequestFeaturesInput]
+                ),
+                position=position,
+                metadata=utils.get_pydantic_model(
+                    metadata, OptionalNullable[models.Metadata]
+                ),
+                session_id=session_id,
+            ),
+        )
+
+        req = self.build_request(
+            method="POST",
+            path="/features/search/interactions",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            request_has_path_params=False,
+            request_has_query_params=False,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request.search_interaction,
+                False,
+                False,
+                "json",
+                models.SearchInteraction,
+            ),
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                operation_id="create_interaction_features_search_interactions_post",
+                oauth2_scopes=[],
+                security_source=None,
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return utils.unmarshal_json(http_res.text, models.InteractionResponse)
+        if utils.match_response(
+            http_res, ["400", "401", "403", "404", "500"], "application/json"
+        ):
+            data = utils.unmarshal_json(http_res.text, models.ErrorResponseData)
+            raise models.ErrorResponse(data=data)
+        if utils.match_response(http_res, "422", "application/json"):
+            data = utils.unmarshal_json(http_res.text, models.HTTPValidationErrorData)
+            raise models.HTTPValidationError(data=data)
+        if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise models.APIError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+
+        content_type = http_res.headers.get("Content-Type")
+        http_res_text = utils.stream_to_text(http_res)
+        raise models.APIError(
+            f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
+            http_res.status_code,
+            http_res_text,
+            http_res,
+        )
+
+    async def create_async(
+        self,
+        *,
+        feature_id: str,
+        interaction_type: models.InteractionType,
+        x_namespace: OptionalNullable[str] = UNSET,
+        search_request: OptionalNullable[
+            Union[
+                models.SearchRequestFeaturesInput,
+                models.SearchRequestFeaturesInputTypedDict,
+            ]
+        ] = UNSET,
+        position: OptionalNullable[int] = UNSET,
+        metadata: OptionalNullable[
+            Union[models.Metadata, models.MetadataTypedDict]
+        ] = UNSET,
+        session_id: OptionalNullable[str] = UNSET,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.InteractionResponse:
+        r"""Create Interaction
+
+        Record a search interaction (view, click, feedback, etc.)
+
+        :param feature_id: ID of the item that was interacted with
+        :param interaction_type:
+        :param x_namespace: Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.
+        :param search_request: The search request that led to this interaction
+        :param position: Position in search results where interaction occurred
+        :param metadata: Additional context about the interaction
+        :param session_id: Search session identifier
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+
+        request = models.CreateInteractionFeaturesSearchInteractionsPostRequest(
+            x_namespace=x_namespace,
+            search_interaction=models.SearchInteraction(
+                feature_id=feature_id,
+                interaction_type=interaction_type,
+                search_request=utils.get_pydantic_model(
+                    search_request, OptionalNullable[models.SearchRequestFeaturesInput]
+                ),
+                position=position,
+                metadata=utils.get_pydantic_model(
+                    metadata, OptionalNullable[models.Metadata]
+                ),
+                session_id=session_id,
+            ),
+        )
+
+        req = self.build_request_async(
+            method="POST",
+            path="/features/search/interactions",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            request_has_path_params=False,
+            request_has_query_params=False,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request.search_interaction,
+                False,
+                False,
+                "json",
+                models.SearchInteraction,
+            ),
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                operation_id="create_interaction_features_search_interactions_post",
+                oauth2_scopes=[],
+                security_source=None,
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return utils.unmarshal_json(http_res.text, models.InteractionResponse)
+        if utils.match_response(
+            http_res, ["400", "401", "403", "404", "500"], "application/json"
+        ):
+            data = utils.unmarshal_json(http_res.text, models.ErrorResponseData)
+            raise models.ErrorResponse(data=data)
+        if utils.match_response(http_res, "422", "application/json"):
+            data = utils.unmarshal_json(http_res.text, models.HTTPValidationErrorData)
+            raise models.HTTPValidationError(data=data)
+        if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise models.APIError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+
+        content_type = http_res.headers.get("Content-Type")
+        http_res_text = await utils.stream_to_text_async(http_res)
+        raise models.APIError(
+            f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
+            http_res.status_code,
+            http_res_text,
+            http_res,
+        )
+
+    def get_interaction(
+        self,
+        *,
+        interaction_id: str,
+        x_namespace: OptionalNullable[str] = UNSET,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.InteractionResponse:
+        r"""Get Interaction
+
+        Get a specific interaction
+
+        :param interaction_id:
+        :param x_namespace: Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+
+        request = (
+            models.GetInteractionFeaturesSearchInteractionsInteractionIDGetRequest(
+                interaction_id=interaction_id,
+                x_namespace=x_namespace,
+            )
+        )
+
+        req = self.build_request(
+            method="GET",
+            path="/features/search/interactions/{interaction_id}",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=False,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                operation_id="get_interaction_features_search_interactions__interaction_id__get",
+                oauth2_scopes=[],
+                security_source=None,
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return utils.unmarshal_json(http_res.text, models.InteractionResponse)
+        if utils.match_response(
+            http_res, ["400", "401", "403", "404", "500"], "application/json"
+        ):
+            data = utils.unmarshal_json(http_res.text, models.ErrorResponseData)
+            raise models.ErrorResponse(data=data)
+        if utils.match_response(http_res, "422", "application/json"):
+            data = utils.unmarshal_json(http_res.text, models.HTTPValidationErrorData)
+            raise models.HTTPValidationError(data=data)
+        if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise models.APIError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+
+        content_type = http_res.headers.get("Content-Type")
+        http_res_text = utils.stream_to_text(http_res)
+        raise models.APIError(
+            f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
+            http_res.status_code,
+            http_res_text,
+            http_res,
+        )
+
+    async def get_interaction_async(
+        self,
+        *,
+        interaction_id: str,
+        x_namespace: OptionalNullable[str] = UNSET,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.InteractionResponse:
+        r"""Get Interaction
+
+        Get a specific interaction
+
+        :param interaction_id:
+        :param x_namespace: Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+
+        request = (
+            models.GetInteractionFeaturesSearchInteractionsInteractionIDGetRequest(
+                interaction_id=interaction_id,
+                x_namespace=x_namespace,
+            )
+        )
+
+        req = self.build_request_async(
+            method="GET",
+            path="/features/search/interactions/{interaction_id}",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=False,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                operation_id="get_interaction_features_search_interactions__interaction_id__get",
+                oauth2_scopes=[],
+                security_source=None,
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return utils.unmarshal_json(http_res.text, models.InteractionResponse)
+        if utils.match_response(
+            http_res, ["400", "401", "403", "404", "500"], "application/json"
+        ):
+            data = utils.unmarshal_json(http_res.text, models.ErrorResponseData)
+            raise models.ErrorResponse(data=data)
+        if utils.match_response(http_res, "422", "application/json"):
+            data = utils.unmarshal_json(http_res.text, models.HTTPValidationErrorData)
+            raise models.HTTPValidationError(data=data)
+        if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise models.APIError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+
+        content_type = http_res.headers.get("Content-Type")
+        http_res_text = await utils.stream_to_text_async(http_res)
+        raise models.APIError(
+            f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
+            http_res.status_code,
+            http_res_text,
+            http_res,
+        )
+
+    def delete(
+        self,
+        *,
+        interaction_id: str,
+        x_namespace: OptionalNullable[str] = UNSET,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> Any:
+        r"""Delete Interaction
+
+        Delete a specific interaction
+
+        :param interaction_id:
+        :param x_namespace: Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+
+        request = models.DeleteInteractionFeaturesSearchInteractionsInteractionIDDeleteRequest(
+            interaction_id=interaction_id,
+            x_namespace=x_namespace,
+        )
+
+        req = self.build_request(
+            method="DELETE",
+            path="/features/search/interactions/{interaction_id}",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=False,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                operation_id="delete_interaction_features_search_interactions__interaction_id__delete",
+                oauth2_scopes=[],
+                security_source=None,
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return utils.unmarshal_json(http_res.text, Any)
+        if utils.match_response(
+            http_res, ["400", "401", "403", "404", "500"], "application/json"
+        ):
+            data = utils.unmarshal_json(http_res.text, models.ErrorResponseData)
+            raise models.ErrorResponse(data=data)
+        if utils.match_response(http_res, "422", "application/json"):
+            data = utils.unmarshal_json(http_res.text, models.HTTPValidationErrorData)
+            raise models.HTTPValidationError(data=data)
+        if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise models.APIError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+
+        content_type = http_res.headers.get("Content-Type")
+        http_res_text = utils.stream_to_text(http_res)
+        raise models.APIError(
+            f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
+            http_res.status_code,
+            http_res_text,
+            http_res,
+        )
+
+    async def delete_async(
+        self,
+        *,
+        interaction_id: str,
+        x_namespace: OptionalNullable[str] = UNSET,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> Any:
+        r"""Delete Interaction
+
+        Delete a specific interaction
+
+        :param interaction_id:
+        :param x_namespace: Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+
+        request = models.DeleteInteractionFeaturesSearchInteractionsInteractionIDDeleteRequest(
+            interaction_id=interaction_id,
+            x_namespace=x_namespace,
+        )
+
+        req = self.build_request_async(
+            method="DELETE",
+            path="/features/search/interactions/{interaction_id}",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=False,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                operation_id="delete_interaction_features_search_interactions__interaction_id__delete",
+                oauth2_scopes=[],
+                security_source=None,
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return utils.unmarshal_json(http_res.text, Any)
+        if utils.match_response(
+            http_res, ["400", "401", "403", "404", "500"], "application/json"
+        ):
+            data = utils.unmarshal_json(http_res.text, models.ErrorResponseData)
+            raise models.ErrorResponse(data=data)
+        if utils.match_response(http_res, "422", "application/json"):
+            data = utils.unmarshal_json(http_res.text, models.HTTPValidationErrorData)
+            raise models.HTTPValidationError(data=data)
+        if utils.match_response(http_res, ["4XX", "5XX"], "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise models.APIError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+
+        content_type = http_res.headers.get("Content-Type")
+        http_res_text = await utils.stream_to_text_async(http_res)
+        raise models.APIError(
+            f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
+            http_res.status_code,
+            http_res_text,
+            http_res,
+        )