client.shape
Generated methods for the shape namespace.
Sync owner: WarmHubClient.shape. Async owner: AsyncWarmHubClient.shape.
Synchronous methods
Section titled “Synchronous methods”create
Section titled “create”create(org_name: str, repo_name: str, shape_name: str, fields: Mapping[str, JsonValue], *, event_request_id: str, description: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)shape.create — mutate shape.create.
See AsyncGeneratedShapeWriteMixin.create.
get(org_name: str, repo_name: str, shape_name: str, *, include_retracted: bool | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> ShapeGetResultshape.get — query shape.get.
history
Section titled “history”history(org_name: str, repo_name: str, name: str, *, include_retracted: bool | Unset = UNSET, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> HistoryResultshape.history — query shape.history.
history_iter
Section titled “history_iter”history_iter(org_name: str, repo_name: str, name: str, *, include_retracted: bool | Unset = UNSET, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)Every version of one shape, page by page. for v in ....
Add, revise, retract and rename history. The page field is
versions, not items.
list(org_name: str, repo_name: str, *, match: str | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, include_retracted: bool | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> ShapeListResultshape.list — query shape.list.
remove
Section titled “remove”remove(org_name: str, repo_name: str, shape_name: str, *, event_request_id: str, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> ShapeRemoveCompatibilityResult0 | ShapeRemoveCompatibilityResult1shape.remove — mutate shape.remove.
rename
Section titled “rename”rename(org_name: str, repo_name: str, old_name: str, new_name: str, *, event_request_id: str, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> RenameCompatibilityResult0 | RenameCompatibilityResult1shape.rename — mutate shape.rename.
revise
Section titled “revise”revise(org_name: str, repo_name: str, shape_name: str, new_fields: Mapping[str, JsonValue], *, event_request_id: str, description: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)shape.revise — mutate shape.revise.
See AsyncGeneratedShapeWriteMixin.revise.
Asynchronous methods
Section titled “Asynchronous methods”create
Section titled “create”create(org_name: str, repo_name: str, shape_name: str, fields: Mapping[str, JsonValue], *, event_request_id: str, description: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)shape.create — mutate shape.create.
fields maps field names to type specs; the server validates it
against the shape meta-schema. The caller owns event_request_id
across ambiguous retries and can use it for exact receipt lookup.
get(org_name: str, repo_name: str, shape_name: str, *, include_retracted: bool | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> ShapeGetResultshape.get — query shape.get.
history
Section titled “history”history(org_name: str, repo_name: str, name: str, *, include_retracted: bool | Unset = UNSET, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> HistoryResultshape.history — query shape.history.
history_iter
Section titled “history_iter”history_iter(org_name: str, repo_name: str, name: str, *, include_retracted: bool | Unset = UNSET, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)Every version of one shape, page by page. async for v in ....
Add, revise, retract and rename history. A non-async factory
returning an async iterator: an async def would return a coroutine,
and async for iterates the expression rather than awaiting it.
list(org_name: str, repo_name: str, *, match: str | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, include_retracted: bool | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> ShapeListResultshape.list — query shape.list.
remove
Section titled “remove”remove(org_name: str, repo_name: str, shape_name: str, *, event_request_id: str, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> ShapeRemoveCompatibilityResult0 | ShapeRemoveCompatibilityResult1shape.remove — mutate shape.remove.
rename
Section titled “rename”rename(org_name: str, repo_name: str, old_name: str, new_name: str, *, event_request_id: str, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> RenameCompatibilityResult0 | RenameCompatibilityResult1shape.rename — mutate shape.rename.
revise
Section titled “revise”revise(org_name: str, repo_name: str, shape_name: str, new_fields: Mapping[str, JsonValue], *, event_request_id: str, description: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)shape.revise — mutate shape.revise.
new_fields REPLACES the definition; it is not a patch. The caller
owns event_request_id across ambiguous retries.