Organizations

class Organization(...)

delete()

Delete the resource. Requires the respective permission.

last_request_age_s()

Returns:: time in seconds since the last request
Return type:: float | None

reload(expand=False)

Update the object properties by requesting the current data from the server.

Parameters:: expand – if True the properties will contain additional information.

Note

if EXPANDED_ATTRIBUTES contains '*' expand will always be True

update(**kwargs)

Update the resource properties.

Parameters:: kwargs – values to be updated (depending on the resource)
Returns:: a new instance of the updated resource
Return type:: same as object

view()

returns a mapping view of the objects internal properties as returned by the REST API.

EXPANDED_ATTRIBUTES = ('created_by', 'members', 'updated_by')

active

created_at: datetime

created_by: User

domain: str

domain_assignment: bool

id

members: List[User]

name

note

parent: Organizations

secondary_members: List[User]

shared: bool

updated_at: datetime

updated_by: User

url: the API endpoint URL

property weburl: str: URL of the organization profile in the webclient

class Organizations(...)

create(name, **kwargs)

Create a new organization.

Parameters:

name (str) – organization identifier name
kwargs – additional organization properties

Returns:

the newly created object

Return type:

Organization

iter(*args, **params)

Iterate through all objects.

With params you can also override the pagination defaults set in Client.pagination

The returned iterable can be used in for loops or fill a Python container like list or tuple.

items = tuple(resource.iter(...))

for item in resource.iter(page=5, page_size=20, expand=True):
    print(item)

Parameters:

args – additional endpoint arguments
params – additional pagination options like page, page_size, extend

search(query, *, sort_by=None, order_by=None, **params)

Search for objects with query syntax.

The returned iterable can be used in for loops or fill a Python container like list or tuple.

items = tuple(resource.search(...))

for item in resource.search(...):
    print(item)

Parameters:

query (str) – query string
sort_by (str | None) – sort by a specific property (e.g. ‘name’ or ‘created_at’)
order_by (Literal['asc', 'desc', None]) – sort direction
params – additional pagination options like page, page_size, extend

DEFAULT_CACHE_SIZE = -1

controls the LRU cache behaviour

LRU disabled, cache unbounded (-1)

disable caching (0)

limited LRU caching (>0)

cache: resource LRU cache

property client: Client

endpoint: str

url