diff --git a/src/courier/resources/bulk.py b/src/courier/resources/bulk.py index 464a615..6156454 100644 --- a/src/courier/resources/bulk.py +++ b/src/courier/resources/bulk.py @@ -145,7 +145,8 @@ def list_users( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> BulkListUsersResponse: """ - Get Bulk Job Users + Returns the users ingested into a bulk job with paging, each carrying the status + Courier recorded for it and the id of the message it produced. Args: cursor: A unique identifier that allows for fetching the next set of users added to the @@ -185,7 +186,9 @@ def retrieve_job( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> BulkRetrieveJobResponse: """ - Get a bulk job + Returns a bulk job's message definition, its status — CREATED, PROCESSING, + COMPLETED, or ERROR — and running counts of users received, messages enqueued, + and failures. Poll it to follow a job through to completion. Args: extra_headers: Send extra headers @@ -217,8 +220,11 @@ def run_job( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> None: - """ - Run a bulk job + """Starts processing a bulk job, sending to every user ingested into it. + + Returns + 204 immediately; the job runs asynchronously, so poll the job to watch its + status and counts. Args: extra_headers: Send extra headers @@ -359,7 +365,8 @@ async def list_users( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> BulkListUsersResponse: """ - Get Bulk Job Users + Returns the users ingested into a bulk job with paging, each carrying the status + Courier recorded for it and the id of the message it produced. Args: cursor: A unique identifier that allows for fetching the next set of users added to the @@ -399,7 +406,9 @@ async def retrieve_job( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> BulkRetrieveJobResponse: """ - Get a bulk job + Returns a bulk job's message definition, its status — CREATED, PROCESSING, + COMPLETED, or ERROR — and running counts of users received, messages enqueued, + and failures. Poll it to follow a job through to completion. Args: extra_headers: Send extra headers @@ -431,8 +440,11 @@ async def run_job( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> None: - """ - Run a bulk job + """Starts processing a bulk job, sending to every user ingested into it. + + Returns + 204 immediately; the job runs asynchronously, so poll the job to watch its + status and counts. Args: extra_headers: Send extra headers