API
grai_client
endpoints
v1
client

ClientV1 Objects

class ClientV1(BaseClient)

check_authentication

def check_authentication() -> Response

Arguments:

Returns:

workspace

@property
def workspace() -> Optional[str]

Arguments:

Returns:

workspace

@workspace.setter
def workspace(workspace: Optional[Union[str, UUID]])

Arguments:

workspace (Optional[Union[str, UUID]]):

Returns:

authenticate

def authenticate(username: Optional[str] = None,
                 password: Optional[str] = None,
                 api_key: Optional[str] = None) -> None

Arguments:

  • username Optional[str], optional - (Default value = None)
  • password Optional[str], optional - (Default value = None)
  • api_key Optional[str], optional - (Default value = None)

Returns:

client_patch_url

@patch.register
def client_patch_url(
    client: ClientV1,
    url: str,
    payload: Dict,
    options: ClientOptions = ClientOptions()) -> Response

Arguments:

client (BaseClient): url (str): payload (Dict):

  • options ClientOptions, optional - (Default value = ClientOptions())

Returns:

client_post_url

@post.register
def client_post_url(
    client: ClientV1,
    url: str,
    payload: Dict,
    options: ClientOptions = ClientOptions()) -> Response

Arguments:

client (BaseClient): url (str): payload (Dict):

  • options ClientOptions, optional - (Default value = ClientOptions())

Returns:

client_delete_url

@delete.register
def client_delete_url(
    client: ClientV1, url: str,
    options: ClientOptions = ClientOptions()) -> Response

Arguments:

client (BaseClient): url (str):

  • options ClientOptions, optional - (Default value = ClientOptions())

Returns:

client_get_url

@get.register
def client_get_url(
    client: ClientV1, url: str,
    options: ClientOptions = ClientOptions()) -> Response

Arguments:

client (BaseClient): url (str):

  • options ClientOptions, optional - (Default value = ClientOptions())

Returns:

utilitiesdelete