archastro.platform.v1.resources.orgs

  1# Copyright (c) 2026 ArchAstro Inc. All Rights Reserved.
  2# This file is auto-generated by @archastro/sdk-generator. Do not edit.
  3# Content hash: 54f92609d1b5
  4
  5from __future__ import annotations
  6
  7from pydantic import BaseModel, Field
  8
  9from ...runtime.http_client import HttpClient, SyncHttpClient
 10
 11
 12class OrgListResponseDataItem(BaseModel):
 13    domain: str = Field(
 14        ..., description='Primary domain associated with the organization, e.g. `"acme.com"`.'
 15    )
 16    id: str = Field(..., description="Organization ID (`org_...`).")
 17    name: str = Field(..., description="Display name of the organization.")
 18
 19
 20class OrgListResponse(BaseModel):
 21    """
 22    Successful response
 23    """
 24
 25    data: list[OrgListResponseDataItem] = Field(
 26        ..., description="Array of organization objects for the current page."
 27    )
 28    has_next: bool | None = Field(
 29        default=None, description="`true` when a subsequent page exists; `false` on the last page."
 30    )
 31    has_prev: bool | None = Field(
 32        default=None, description="`true` when a previous page exists; `false` on the first page."
 33    )
 34    page: int | None = Field(default=None, description="The current page number returned.")
 35    page_size: int | None = Field(
 36        default=None, description="The number of results per page used for this response."
 37    )
 38    total_entries: int | None = Field(
 39        default=None,
 40        description="Total number of organizations matching the query across all pages.",
 41    )
 42    total_pages: int | None = Field(
 43        default=None, description="Total number of pages for the current query and page size."
 44    )
 45
 46
 47class AsyncOrgResource:
 48    def __init__(self, http: HttpClient):
 49        self._http = http
 50
 51    async def list(
 52        self, *, search: str | None = None, page: int | None = None, page_size: int | None = None
 53    ) -> OrgListResponse:
 54        """
 55        Search organizations
 56        Returns a paginated list of organizations within the authenticated app scope,
 57        optionally filtered by a free-text search term matched against name, slug, and
 58        domain (case-insensitive). Results are ordered by relevance when a search term
 59        is provided, and by creation time descending otherwise.
 60        The response includes only public-facing organization fields: ID, name, domain,
 61        and logo. Use the developer-scoped org endpoints to access full organization
 62        records.
 63        Pagination is offset-based. Pass `page` and `page_size` to navigate through
 64        results. The `has_next` and `has_prev` fields indicate whether adjacent pages
 65        exist.
 66
 67        Args:
 68            search: Free-text search term matched against organization name, slug, and domain (case-insensitive). Omit to return all organizations in the app.
 69            page: Page number to retrieve, starting at `1`. Defaults to `1` when omitted.
 70            page_size: Number of organizations to return per page. Defaults to `25`; maximum is `100`.
 71
 72        Returns:
 73            Successful response
 74        """
 75        query: dict[str, object] = {}
 76        if search is not None:
 77            query["search"] = search
 78        if page is not None:
 79            query["page"] = page
 80        if page_size is not None:
 81            query["page_size"] = page_size
 82        return await self._http.request("/api/v1/orgs", query=query, response_type=OrgListResponse)
 83
 84
 85class OrgResource:
 86    def __init__(self, http: SyncHttpClient):
 87        self._http = http
 88
 89    def list(
 90        self, *, search: str | None = None, page: int | None = None, page_size: int | None = None
 91    ) -> OrgListResponse:
 92        """
 93        Search organizations
 94        Returns a paginated list of organizations within the authenticated app scope,
 95        optionally filtered by a free-text search term matched against name, slug, and
 96        domain (case-insensitive). Results are ordered by relevance when a search term
 97        is provided, and by creation time descending otherwise.
 98        The response includes only public-facing organization fields: ID, name, domain,
 99        and logo. Use the developer-scoped org endpoints to access full organization
100        records.
101        Pagination is offset-based. Pass `page` and `page_size` to navigate through
102        results. The `has_next` and `has_prev` fields indicate whether adjacent pages
103        exist.
104
105        Args:
106            search: Free-text search term matched against organization name, slug, and domain (case-insensitive). Omit to return all organizations in the app.
107            page: Page number to retrieve, starting at `1`. Defaults to `1` when omitted.
108            page_size: Number of organizations to return per page. Defaults to `25`; maximum is `100`.
109
110        Returns:
111            Successful response
112        """
113        query: dict[str, object] = {}
114        if search is not None:
115            query["search"] = search
116        if page is not None:
117            query["page"] = page
118        if page_size is not None:
119            query["page_size"] = page_size
120        return self._http.request("/api/v1/orgs", query=query, response_type=OrgListResponse)