SnippetService

class SnippetService

Methods

create	Add or modify a Snippet by key.
delete	Delete the Snippet with the given id.
patch	Modify the Snippet with the given id.
get_all	Get all snippets of the current user.

create(json_body, *, extra_parameters=None)

Add or modify a Snippet by key.

Parameters:

• json_body (Union[dict, list, CreateSnippetData]) – The body of the request. See CreateSnippetData for information about the possible fields. You can provide this data as a CreateSnippetData or as a dictionary.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (SnippetService[AuthenticatedClient]) –

Returns:

A response containing the JSON serialized snippet and return code 201.

Return type:

Snippet

delete(*, snippet_id, extra_parameters=None)

Delete the Snippet with the given id.

Parameters:

• snippet_id (int) – The id of the snippet

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (SnippetService[AuthenticatedClient]) –

Returns:

An empty response with return code 204

Return type:

None

patch(json_body, *, snippet_id, extra_parameters=None)

Modify the Snippet with the given id.

Parameters:

• json_body (Union[dict, list, PatchSnippetData]) – The body of the request. See PatchSnippetData for information about the possible fields. You can provide this data as a PatchSnippetData or as a dictionary.

• snippet_id (int) – The id of the snippet to change.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (SnippetService[AuthenticatedClient]) –

Returns:

An empty response with return code 204.

Return type:

None

get_all(*, extra_parameters=None)

Get all snippets of the current user.

Parameters:

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (SnippetService[AuthenticatedClient]) –

Returns:

An array containing all snippets for the currently logged in user.

Return type:

Sequence[Snippet]