CohortsResource

Cohort API methods.

Functions

constructor__init__(client) -> None

Initialize the resource.

paramclientKitaruAPIClient

API client used to send requests.

Returns

None

funccreate(request, idempotency_key=None) -> CohortResponse

Create a cohort.

paramrequestCohortCreateRequest

Cohort create request.

paramidempotency_keystr | None

= None

Idempotency key overriding the transport's random default.

Returns

kitaru.api_models.v1.cohort.CohortResponse

Created cohort.

funcget(cohort_id) -> CohortResponse

Get a cohort by id.

paramcohort_iduuid.UUID

Id of the cohort.

Returns

kitaru.api_models.v1.cohort.CohortResponse

Stored cohort.

funclist(params=None) -> Page[CohortResponse]

List cohorts.

paramparamsCohortListParams | None

= None

Cohort list params.

Returns

kitaru.api_models.v1.base.Page

Page of cohorts.

funciter(params=None) -> AsyncIterator[CohortResponse]

Iterate over all cohorts.

paramparamsCohortListParams | None

= None

Cohort list params.

Returns

collections.abc.AsyncIterator

Async iterator over every cohort.

funcupdate(cohort_id, request) -> CohortResponse

Update a cohort's name and description.

paramcohort_iduuid.UUID

Id of the cohort.

paramrequestCohortUpdateRequest

Cohort update request, unset fields stay unchanged.

Returns

kitaru.api_models.v1.cohort.CohortResponse

Updated cohort.

funcdelete(cohort_id) -> None

Delete a cohort.

paramcohort_iduuid.UUID

Id of the cohort.

Returns

None

funccreate_version(cohort_id, request, idempotency_key=None) -> CohortVersionResponse

Create a new version of a cohort.

paramcohort_iduuid.UUID

Id of the cohort.

paramrequestCohortVersionCreateRequest

Cohort version create request.

paramidempotency_keystr | None

= None

Idempotency key overriding the transport's random default.

Returns

kitaru.api_models.v1.cohort_version.CohortVersionResponse

Created cohort version.

funclist_versions(cohort_id, params=None) -> Page[CohortVersionResponse]

List the versions of a cohort.

paramcohort_iduuid.UUID

Id of the cohort.

paramparamsCohortVersionListParams | None

= None

Cohort version list params.

Returns

kitaru.api_models.v1.base.Page

Page of cohort versions.

funciter_versions(cohort_id, params=None) -> AsyncIterator[CohortVersionResponse]

Iterate over every version of a cohort.

paramcohort_iduuid.UUID

Id of the cohort.

paramparamsCohortVersionListParams | None

= None

Cohort version list params.

Returns

collections.abc.AsyncIterator

Async iterator over every version of the cohort.

FunctionsCopy Anchor Link

On this page

Functions