api-sdk-py 1.11.66__py3-none-any.whl

api_sdk_py/api/entitlements_api.py

@@ -0,0 +1,676 @@
+# coding: utf-8
+
+"""
+    Widgetic API Gateway
+
+    API documentation for the Widgetic API Gateway
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictBool, StrictStr
+from typing import Optional
+from typing_extensions import Annotated
+from api_sdk_py.models.get_managed_user_entitlements_response import GetManagedUserEntitlementsResponse
+from api_sdk_py.models.get_partner_entitlements_response import GetPartnerEntitlementsResponse
+
+from api_sdk_py.api_client import ApiClient, RequestSerialized
+from api_sdk_py.api_response import ApiResponse
+from api_sdk_py.rest import RESTResponseType
+
+
+class EntitlementsApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def get_managed_user_entitlements_0(
+        self,
+        managed_user_id: Annotated[StrictStr, Field(description="Managed user ID")],
+        include_expired: Annotated[Optional[StrictBool], Field(description="Include expired entitlements in results")] = None,
+        feature: Annotated[Optional[StrictStr], Field(description="Filter by specific feature")] = None,
+        source: Annotated[Optional[StrictStr], Field(description="Filter by entitlement source")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> GetManagedUserEntitlementsResponse:
+        """Get managed user entitlements
+
+        Retrieves all entitlements for a managed user (admin or partner access).
+
+        :param managed_user_id: Managed user ID (required)
+        :type managed_user_id: str
+        :param include_expired: Include expired entitlements in results
+        :type include_expired: bool
+        :param feature: Filter by specific feature
+        :type feature: str
+        :param source: Filter by entitlement source
+        :type source: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_managed_user_entitlements_0_serialize(
+            managed_user_id=managed_user_id,
+            include_expired=include_expired,
+            feature=feature,
+            source=source,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetManagedUserEntitlementsResponse",
+            '401': "ErrorResponse",
+            '403': "ErrorResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_managed_user_entitlements_0_with_http_info(
+        self,
+        managed_user_id: Annotated[StrictStr, Field(description="Managed user ID")],
+        include_expired: Annotated[Optional[StrictBool], Field(description="Include expired entitlements in results")] = None,
+        feature: Annotated[Optional[StrictStr], Field(description="Filter by specific feature")] = None,
+        source: Annotated[Optional[StrictStr], Field(description="Filter by entitlement source")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[GetManagedUserEntitlementsResponse]:
+        """Get managed user entitlements
+
+        Retrieves all entitlements for a managed user (admin or partner access).
+
+        :param managed_user_id: Managed user ID (required)
+        :type managed_user_id: str
+        :param include_expired: Include expired entitlements in results
+        :type include_expired: bool
+        :param feature: Filter by specific feature
+        :type feature: str
+        :param source: Filter by entitlement source
+        :type source: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_managed_user_entitlements_0_serialize(
+            managed_user_id=managed_user_id,
+            include_expired=include_expired,
+            feature=feature,
+            source=source,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetManagedUserEntitlementsResponse",
+            '401': "ErrorResponse",
+            '403': "ErrorResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_managed_user_entitlements_0_without_preload_content(
+        self,
+        managed_user_id: Annotated[StrictStr, Field(description="Managed user ID")],
+        include_expired: Annotated[Optional[StrictBool], Field(description="Include expired entitlements in results")] = None,
+        feature: Annotated[Optional[StrictStr], Field(description="Filter by specific feature")] = None,
+        source: Annotated[Optional[StrictStr], Field(description="Filter by entitlement source")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get managed user entitlements
+
+        Retrieves all entitlements for a managed user (admin or partner access).
+
+        :param managed_user_id: Managed user ID (required)
+        :type managed_user_id: str
+        :param include_expired: Include expired entitlements in results
+        :type include_expired: bool
+        :param feature: Filter by specific feature
+        :type feature: str
+        :param source: Filter by entitlement source
+        :type source: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_managed_user_entitlements_0_serialize(
+            managed_user_id=managed_user_id,
+            include_expired=include_expired,
+            feature=feature,
+            source=source,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetManagedUserEntitlementsResponse",
+            '401': "ErrorResponse",
+            '403': "ErrorResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_managed_user_entitlements_0_serialize(
+        self,
+        managed_user_id,
+        include_expired,
+        feature,
+        source,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if managed_user_id is not None:
+            _path_params['managedUserId'] = managed_user_id
+        # process the query parameters
+        if include_expired is not None:
+            
+            _query_params.append(('includeExpired', include_expired))
+            
+        if feature is not None:
+            
+            _query_params.append(('feature', feature))
+            
+        if source is not None:
+            
+            _query_params.append(('source', source))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'apiKeyAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/entitlements/managed-users/{managedUserId}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def get_partner_entitlements_0(
+        self,
+        partner_id: Annotated[StrictStr, Field(description="Partner ID")],
+        include_expired: Annotated[Optional[StrictBool], Field(description="Include expired entitlements in results")] = None,
+        feature: Annotated[Optional[StrictStr], Field(description="Filter by specific feature")] = None,
+        source: Annotated[Optional[StrictStr], Field(description="Filter by entitlement source")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> GetPartnerEntitlementsResponse:
+        """Get partner entitlements
+
+        Retrieves all entitlements for a partner (admin or partner access).
+
+        :param partner_id: Partner ID (required)
+        :type partner_id: str
+        :param include_expired: Include expired entitlements in results
+        :type include_expired: bool
+        :param feature: Filter by specific feature
+        :type feature: str
+        :param source: Filter by entitlement source
+        :type source: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_partner_entitlements_0_serialize(
+            partner_id=partner_id,
+            include_expired=include_expired,
+            feature=feature,
+            source=source,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetPartnerEntitlementsResponse",
+            '401': "ErrorResponse",
+            '403': "ErrorResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_partner_entitlements_0_with_http_info(
+        self,
+        partner_id: Annotated[StrictStr, Field(description="Partner ID")],
+        include_expired: Annotated[Optional[StrictBool], Field(description="Include expired entitlements in results")] = None,
+        feature: Annotated[Optional[StrictStr], Field(description="Filter by specific feature")] = None,
+        source: Annotated[Optional[StrictStr], Field(description="Filter by entitlement source")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[GetPartnerEntitlementsResponse]:
+        """Get partner entitlements
+
+        Retrieves all entitlements for a partner (admin or partner access).
+
+        :param partner_id: Partner ID (required)
+        :type partner_id: str
+        :param include_expired: Include expired entitlements in results
+        :type include_expired: bool
+        :param feature: Filter by specific feature
+        :type feature: str
+        :param source: Filter by entitlement source
+        :type source: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_partner_entitlements_0_serialize(
+            partner_id=partner_id,
+            include_expired=include_expired,
+            feature=feature,
+            source=source,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetPartnerEntitlementsResponse",
+            '401': "ErrorResponse",
+            '403': "ErrorResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_partner_entitlements_0_without_preload_content(
+        self,
+        partner_id: Annotated[StrictStr, Field(description="Partner ID")],
+        include_expired: Annotated[Optional[StrictBool], Field(description="Include expired entitlements in results")] = None,
+        feature: Annotated[Optional[StrictStr], Field(description="Filter by specific feature")] = None,
+        source: Annotated[Optional[StrictStr], Field(description="Filter by entitlement source")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get partner entitlements
+
+        Retrieves all entitlements for a partner (admin or partner access).
+
+        :param partner_id: Partner ID (required)
+        :type partner_id: str
+        :param include_expired: Include expired entitlements in results
+        :type include_expired: bool
+        :param feature: Filter by specific feature
+        :type feature: str
+        :param source: Filter by entitlement source
+        :type source: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_partner_entitlements_0_serialize(
+            partner_id=partner_id,
+            include_expired=include_expired,
+            feature=feature,
+            source=source,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetPartnerEntitlementsResponse",
+            '401': "ErrorResponse",
+            '403': "ErrorResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_partner_entitlements_0_serialize(
+        self,
+        partner_id,
+        include_expired,
+        feature,
+        source,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if partner_id is not None:
+            _path_params['partnerId'] = partner_id
+        # process the query parameters
+        if include_expired is not None:
+            
+            _query_params.append(('includeExpired', include_expired))
+            
+        if feature is not None:
+            
+            _query_params.append(('feature', feature))
+            
+        if source is not None:
+            
+            _query_params.append(('source', source))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'apiKeyAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/entitlements/partners/{partnerId}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+