"""
Organizations
A set of people in Webex. Organizations may manage other organizations or be managed themselves. This organizations
resource can be accessed only by an admin.
Applications can delete an Organization only after they have been authorized by a user with the Full Administrator
Role which may be a user in the customer org or a user in a managing partner organization to which the role has been
granted. The authorizing admin must grant the spark-admin:organizations-write scope.
"""
__all__ = ['Organization', 'OrganizationApi']
import datetime
from typing import Optional
from pydantic import TypeAdapter, Field
from ..api_child import ApiChild
from ..base import ApiModel
[docs]
class Organization(ApiModel):
#: A unique identifier for the organization.
org_id: str = Field(alias='id')
#: Full name of the organization.
display_name: str
#: The date and time the organization was created.
created: datetime.datetime
#: The base path to xsi-actions.
xsi_actions_endpoint: Optional[str] = None
#: The base path to xsi-events.
xsi_events_endpoint: Optional[str] = None
#: The base path to xsi-events-channel.
xsi_events_channel_endpoint: Optional[str] = None
#: api- prepended to the bcBaseDomain value for the organization.
xsi_domain: Optional[str] = None
[docs]
class OrganizationApi(ApiChild, base='organizations'):
[docs]
def list(self, calling_data: bool = None) -> list[Organization]:
"""
List all organizations visible by your account. The results will not be paginated.
:param calling_data: Include XSI endpoint values in the response (if applicable) for the organization.
Default: false
:type calling_data: bool
:return: list of Organizations
"""
params = calling_data and {'callingData': 'true'} or None
data = self.get(url=self.ep(), params=params)
return TypeAdapter(list[Organization]).validate_python(data['items'])
[docs]
def details(self, org_id: str, calling_data: bool = None) -> Organization:
"""
Get Organization Details
Shows details for an organization, by ID.
:param org_id: The unique identifier for the organization.
:type org_id: str
:param calling_data: Include XSI endpoint values in the response (if applicable) for the organization.
Default: false
:type calling_data: bool
:return: org details
:rtype: :class:`Organization`
"""
url = self.ep(org_id)
params = calling_data and {'callingData': 'true'} or None
data = self.get(url=url, params=params)
return Organization.model_validate(data)
[docs]
def delete(self, org_id: str):
"""
Delete Organization
Deletes an organization, by ID. It may take up to 10 minutes for the organization to be deleted after the
response is returned.
:param org_id: The unique identifier for the organization.
:type org_id: str
"""
url = self.ep(org_id)
super().delete(url=url)