scope-client 1.4.984__tar.gz → 1.4.986__tar.gz

{scope_client-1.4.984 → scope_client-1.4.986}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scope_client
-Version: 1.4.984
+Version: 1.4.986
 Summary: Arthur Python API Client Library
 Author-email: Arthur <info@arthur.ai>
 License: MIT

{scope_client-1.4.984 → scope_client-1.4.986}/scope_client/scope_client/api_bindings/__init__.py

@@ -139,6 +139,7 @@ from scope_client.api_bindings.models.infinite_pagination import InfinitePaginat
 from scope_client.api_bindings.models.infinite_resource_list_alert import InfiniteResourceListAlert
 from scope_client.api_bindings.models.infinite_resource_list_job import InfiniteResourceListJob
 from scope_client.api_bindings.models.internal_server_error import InternalServerError
+from scope_client.api_bindings.models.invite_new_user import InviteNewUser
 from scope_client.api_bindings.models.items import Items
 from scope_client.api_bindings.models.items1 import Items1
 from scope_client.api_bindings.models.job import Job
@@ -220,6 +221,7 @@ from scope_client.api_bindings.models.post_data_retrieval_operation import PostD
 from scope_client.api_bindings.models.post_dataset import PostDataset
 from scope_client.api_bindings.models.post_dataset_join_spec import PostDatasetJoinSpec
 from scope_client.api_bindings.models.post_end_user import PostEndUser
+from scope_client.api_bindings.models.post_global_role_binding import PostGlobalRoleBinding
 from scope_client.api_bindings.models.post_group import PostGroup
 from scope_client.api_bindings.models.post_group_membership import PostGroupMembership
 from scope_client.api_bindings.models.post_job import PostJob

{scope_client-1.4.984 → scope_client-1.4.986}/scope_client/scope_client/api_bindings/api/users_v1_api.py

@@ -19,6 +19,7 @@ from typing_extensions import Annotated
 from pydantic import Field, StrictStr
 from typing import List, Optional
 from typing_extensions import Annotated
+from scope_client.api_bindings.models.invite_new_user import InviteNewUser
 from scope_client.api_bindings.models.patch_service_account_user import PatchServiceAccountUser
 from scope_client.api_bindings.models.patch_user import PatchUser
 from scope_client.api_bindings.models.post_end_user import PostEndUser
@@ -2373,6 +2374,295 @@ class UsersV1Api:
 
 
 
+    @validate_call
+    def post_organization_user_invite(
+        self,
+        invite_new_user: InviteNewUser,
+        _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,
+    ) -> User:
+        """Create User Via Email Invite
+
+        Requires organization_invite_user permission. Also requires underlying permissions for managing user permissions: group_create_group_membership, organization_create_role_binding, workspace_create_role_binding, or project_create_role_binding depending on whether the user is being added to a group or granted a role bound to an organization, workspace, or project.
+
+        :param invite_new_user: (required)
+        :type invite_new_user: InviteNewUser
+        :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._post_organization_user_invite_serialize(
+            invite_new_user=invite_new_user,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "User",
+            '500': "InternalServerError",
+            '400': "BadRequestError",
+            '404': "NotFoundError",
+            '201': None,
+            '422': "HTTPValidationError",
+        }
+        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 post_organization_user_invite_with_http_info(
+        self,
+        invite_new_user: InviteNewUser,
+        _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[User]:
+        """Create User Via Email Invite
+
+        Requires organization_invite_user permission. Also requires underlying permissions for managing user permissions: group_create_group_membership, organization_create_role_binding, workspace_create_role_binding, or project_create_role_binding depending on whether the user is being added to a group or granted a role bound to an organization, workspace, or project.
+
+        :param invite_new_user: (required)
+        :type invite_new_user: InviteNewUser
+        :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._post_organization_user_invite_serialize(
+            invite_new_user=invite_new_user,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "User",
+            '500': "InternalServerError",
+            '400': "BadRequestError",
+            '404': "NotFoundError",
+            '201': None,
+            '422': "HTTPValidationError",
+        }
+        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 post_organization_user_invite_without_preload_content(
+        self,
+        invite_new_user: InviteNewUser,
+        _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:
+        """Create User Via Email Invite
+
+        Requires organization_invite_user permission. Also requires underlying permissions for managing user permissions: group_create_group_membership, organization_create_role_binding, workspace_create_role_binding, or project_create_role_binding depending on whether the user is being added to a group or granted a role bound to an organization, workspace, or project.
+
+        :param invite_new_user: (required)
+        :type invite_new_user: InviteNewUser
+        :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._post_organization_user_invite_serialize(
+            invite_new_user=invite_new_user,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "User",
+            '500': "InternalServerError",
+            '400': "BadRequestError",
+            '404': "NotFoundError",
+            '201': None,
+            '422': "HTTPValidationError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _post_organization_user_invite_serialize(
+        self,
+        invite_new_user,
+        _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
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if invite_new_user is not None:
+            _body_params = invite_new_user
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'OAuth2AuthorizationCode'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/api/v1/organization/users/invite-user',
+            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 post_user_creds(
         self,

{scope_client-1.4.984 → scope_client-1.4.986}/scope_client/scope_client/api_bindings/models/__init__.py

@@ -97,6 +97,7 @@ from scope_client.api_bindings.models.infinite_pagination import InfinitePaginat
 from scope_client.api_bindings.models.infinite_resource_list_alert import InfiniteResourceListAlert
 from scope_client.api_bindings.models.infinite_resource_list_job import InfiniteResourceListJob
 from scope_client.api_bindings.models.internal_server_error import InternalServerError
+from scope_client.api_bindings.models.invite_new_user import InviteNewUser
 from scope_client.api_bindings.models.items import Items
 from scope_client.api_bindings.models.items1 import Items1
 from scope_client.api_bindings.models.job import Job
@@ -178,6 +179,7 @@ from scope_client.api_bindings.models.post_data_retrieval_operation import PostD
 from scope_client.api_bindings.models.post_dataset import PostDataset
 from scope_client.api_bindings.models.post_dataset_join_spec import PostDatasetJoinSpec
 from scope_client.api_bindings.models.post_end_user import PostEndUser
+from scope_client.api_bindings.models.post_global_role_binding import PostGlobalRoleBinding
 from scope_client.api_bindings.models.post_group import PostGroup
 from scope_client.api_bindings.models.post_group_membership import PostGroupMembership
 from scope_client.api_bindings.models.post_job import PostJob

scope_client-1.4.986/scope_client/scope_client/api_bindings/models/invite_new_user.py

@@ -0,0 +1,105 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from scope_client.api_bindings.models.post_global_role_binding import PostGlobalRoleBinding
+from typing import Optional, Set
+from typing_extensions import Self
+
+class InviteNewUser(BaseModel):
+    """
+    InviteNewUser
+    """ # noqa: E501
+    email: StrictStr = Field(description="The user's email.")
+    role_binding: Optional[PostGlobalRoleBinding] = None
+    group_ids: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["email", "role_binding", "group_ids"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of InviteNewUser from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of role_binding
+        if self.role_binding:
+            _dict['role_binding'] = self.role_binding.to_dict()
+        # set to None if role_binding (nullable) is None
+        # and model_fields_set contains the field
+        if self.role_binding is None and "role_binding" in self.model_fields_set:
+            _dict['role_binding'] = None
+
+        # set to None if group_ids (nullable) is None
+        # and model_fields_set contains the field
+        if self.group_ids is None and "group_ids" in self.model_fields_set:
+            _dict['group_ids'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of InviteNewUser from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "email": obj.get("email"),
+            "role_binding": PostGlobalRoleBinding.from_dict(obj["role_binding"]) if obj.get("role_binding") is not None else None,
+            "group_ids": obj.get("group_ids")
+        })
+        return _obj
+
+

{scope_client-1.4.984 → scope_client-1.4.986}/scope_client/scope_client/api_bindings/models/permission_name.py

@@ -33,6 +33,7 @@ class PermissionName(str, Enum):
     ORGANIZATION_CREATE_WORKSPACE = 'organization_create_workspace'
     ORGANIZATION_LIST_GROUP_MEMBERSHIPS = 'organization_list_group_memberships'
     ORGANIZATION_CREATE_USER = 'organization_create_user'
+    ORGANIZATION_INVITE_USER = 'organization_invite_user'
     ORGANIZATION_CREATE_SERVICE_ACCOUNT = 'organization_create_service_account'
     DELETE_USER = 'delete_user'
     USER_UPDATE = 'user_update'

scope_client-1.4.986/scope_client/scope_client/api_bindings/models/post_global_role_binding.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from scope_client.api_bindings.models.bound_resource_kind import BoundResourceKind
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PostGlobalRoleBinding(BaseModel):
+    """
+    PostGlobalRoleBinding
+    """ # noqa: E501
+    role_id: StrictStr = Field(description="ID of the bound role.")
+    bound_resource_kind: BoundResourceKind = Field(description="Kind of the bound resource.")
+    resource_id: StrictStr = Field(description="Id of the bound resource.")
+    __properties: ClassVar[List[str]] = ["role_id", "bound_resource_kind", "resource_id"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PostGlobalRoleBinding from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PostGlobalRoleBinding from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "role_id": obj.get("role_id"),
+            "bound_resource_kind": obj.get("bound_resource_kind"),
+            "resource_id": obj.get("resource_id")
+        })
+        return _obj
+
+

{scope_client-1.4.984 → scope_client-1.4.986}/scope_client/scope_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scope_client
-Version: 1.4.984
+Version: 1.4.986
 Summary: Arthur Python API Client Library
 Author-email: Arthur <info@arthur.ai>
 License: MIT

{scope_client-1.4.984 → scope_client-1.4.986}/scope_client/scope_client.egg-info/SOURCES.txt

@@ -124,6 +124,7 @@ scope_client/scope_client/api_bindings/models/infinite_pagination.py
 scope_client/scope_client/api_bindings/models/infinite_resource_list_alert.py
 scope_client/scope_client/api_bindings/models/infinite_resource_list_job.py
 scope_client/scope_client/api_bindings/models/internal_server_error.py
+scope_client/scope_client/api_bindings/models/invite_new_user.py
 scope_client/scope_client/api_bindings/models/items.py
 scope_client/scope_client/api_bindings/models/items1.py
 scope_client/scope_client/api_bindings/models/job.py
@@ -205,6 +206,7 @@ scope_client/scope_client/api_bindings/models/post_data_retrieval_operation.py
 scope_client/scope_client/api_bindings/models/post_dataset.py
 scope_client/scope_client/api_bindings/models/post_dataset_join_spec.py
 scope_client/scope_client/api_bindings/models/post_end_user.py
+scope_client/scope_client/api_bindings/models/post_global_role_binding.py
 scope_client/scope_client/api_bindings/models/post_group.py
 scope_client/scope_client/api_bindings/models/post_group_membership.py
 scope_client/scope_client/api_bindings/models/post_job.py