archastro.platform.v1.resources.solution_categories 

  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: 4a66aa1107aa
  4
  5from __future__ import annotations
  6
  7import builtins
  8
  9from ...runtime.http_client import HttpClient, SyncHttpClient
 10from ...types.common import SolutionCategoryListResponse
 11
 12
 13class AsyncSolutionCategoryResource:
 14    def __init__(self, http: HttpClient):
 15        self._http = http
 16
 17    async def list(
 18        self,
 19        *,
 20        page: int | None = None,
 21        page_size: int | None = None,
 22        keys: builtins.list[str] | None = None,
 23        parent_keys: builtins.list[str] | None = None,
 24        lookup_key: str | None = None,
 25        path_prefix: str | None = None,
 26        owners: builtins.list[str] | None = None,
 27    ) -> SolutionCategoryListResponse:
 28        """
 29        List solution categories
 30        Returns a paginated list of solution category definitions visible to the authenticated caller.
 31        Use filters to narrow results by key, parent key, lookup key, or virtual path prefix.
 32        Results are scoped to categories accessible under the caller's viewer context. Pass `app` to
 33        restrict the listing to categories associated with a specific app scope. Omit `owners` to
 34        return categories from all ownership scopes (`"system"` and `"org"`) that the caller can see.
 35        Pagination is page-based. Use `page` and `page_size` to navigate large result sets. The
 36        response includes `total_entries`, `total_pages`, `has_next`, and `has_prev` to support
 37        pagination controls. `total_entries` reflects the count after key deduplication.
 38
 39        Args:
 40            page: Page number to retrieve, 1-indexed. Defaults to `1`.
 41            page_size: Number of solution categories to return per page. Defaults to `25`.
 42            keys: Return only categories whose key exactly matches one of the provided values.
 43            parent_keys: Return only categories whose parent key matches one of the provided values. Pass an empty array to return root-level categories.
 44            lookup_key: Return only the category whose `lookup_key` exactly matches this value.
 45            path_prefix: Return only categories whose `virtual_path` starts with this prefix.
 46            owners: Restrict results to categories owned by the specified scopes. Accepted values are `"system"` and `"org"`. Omit to include all ownership scopes visible to the caller.
 47
 48        Returns:
 49            Paginated list of solution category summaries matching the applied filters.
 50        """
 51        query: dict[str, object] = {}
 52        if page is not None:
 53            query["page"] = page
 54        if page_size is not None:
 55            query["page_size"] = page_size
 56        if keys is not None:
 57            query["keys"] = keys
 58        if parent_keys is not None:
 59            query["parent_keys"] = parent_keys
 60        if lookup_key is not None:
 61            query["lookup_key"] = lookup_key
 62        if path_prefix is not None:
 63            query["path_prefix"] = path_prefix
 64        if owners is not None:
 65            query["owners"] = owners
 66        return await self._http.request(
 67            "/api/v1/solution_categories",
 68            query=query,
 69            response_type=SolutionCategoryListResponse,
 70        )
 71
 72
 73class SolutionCategoryResource:
 74    def __init__(self, http: SyncHttpClient):
 75        self._http = http
 76
 77    def list(
 78        self,
 79        *,
 80        page: int | None = None,
 81        page_size: int | None = None,
 82        keys: builtins.list[str] | None = None,
 83        parent_keys: builtins.list[str] | None = None,
 84        lookup_key: str | None = None,
 85        path_prefix: str | None = None,
 86        owners: builtins.list[str] | None = None,
 87    ) -> SolutionCategoryListResponse:
 88        """
 89        List solution categories
 90        Returns a paginated list of solution category definitions visible to the authenticated caller.
 91        Use filters to narrow results by key, parent key, lookup key, or virtual path prefix.
 92        Results are scoped to categories accessible under the caller's viewer context. Pass `app` to
 93        restrict the listing to categories associated with a specific app scope. Omit `owners` to
 94        return categories from all ownership scopes (`"system"` and `"org"`) that the caller can see.
 95        Pagination is page-based. Use `page` and `page_size` to navigate large result sets. The
 96        response includes `total_entries`, `total_pages`, `has_next`, and `has_prev` to support
 97        pagination controls. `total_entries` reflects the count after key deduplication.
 98
 99        Args:
100            page: Page number to retrieve, 1-indexed. Defaults to `1`.
101            page_size: Number of solution categories to return per page. Defaults to `25`.
102            keys: Return only categories whose key exactly matches one of the provided values.
103            parent_keys: Return only categories whose parent key matches one of the provided values. Pass an empty array to return root-level categories.
104            lookup_key: Return only the category whose `lookup_key` exactly matches this value.
105            path_prefix: Return only categories whose `virtual_path` starts with this prefix.
106            owners: Restrict results to categories owned by the specified scopes. Accepted values are `"system"` and `"org"`. Omit to include all ownership scopes visible to the caller.
107
108        Returns:
109            Paginated list of solution category summaries matching the applied filters.
110        """
111        query: dict[str, object] = {}
112        if page is not None:
113            query["page"] = page
114        if page_size is not None:
115            query["page_size"] = page_size
116        if keys is not None:
117            query["keys"] = keys
118        if parent_keys is not None:
119            query["parent_keys"] = parent_keys
120        if lookup_key is not None:
121            query["lookup_key"] = lookup_key
122        if path_prefix is not None:
123            query["path_prefix"] = path_prefix
124        if owners is not None:
125            query["owners"] = owners
126        return self._http.request(
127            "/api/v1/solution_categories",
128            query=query,
129            response_type=SolutionCategoryListResponse,
130        )
class AsyncSolutionCategoryResource: 
14class AsyncSolutionCategoryResource:
15    def __init__(self, http: HttpClient):
16        self._http = http
17
18    async def list(
19        self,
20        *,
21        page: int | None = None,
22        page_size: int | None = None,
23        keys: builtins.list[str] | None = None,
24        parent_keys: builtins.list[str] | None = None,
25        lookup_key: str | None = None,
26        path_prefix: str | None = None,
27        owners: builtins.list[str] | None = None,
28    ) -> SolutionCategoryListResponse:
29        """
30        List solution categories
31        Returns a paginated list of solution category definitions visible to the authenticated caller.
32        Use filters to narrow results by key, parent key, lookup key, or virtual path prefix.
33        Results are scoped to categories accessible under the caller's viewer context. Pass `app` to
34        restrict the listing to categories associated with a specific app scope. Omit `owners` to
35        return categories from all ownership scopes (`"system"` and `"org"`) that the caller can see.
36        Pagination is page-based. Use `page` and `page_size` to navigate large result sets. The
37        response includes `total_entries`, `total_pages`, `has_next`, and `has_prev` to support
38        pagination controls. `total_entries` reflects the count after key deduplication.
39
40        Args:
41            page: Page number to retrieve, 1-indexed. Defaults to `1`.
42            page_size: Number of solution categories to return per page. Defaults to `25`.
43            keys: Return only categories whose key exactly matches one of the provided values.
44            parent_keys: Return only categories whose parent key matches one of the provided values. Pass an empty array to return root-level categories.
45            lookup_key: Return only the category whose `lookup_key` exactly matches this value.
46            path_prefix: Return only categories whose `virtual_path` starts with this prefix.
47            owners: Restrict results to categories owned by the specified scopes. Accepted values are `"system"` and `"org"`. Omit to include all ownership scopes visible to the caller.
48
49        Returns:
50            Paginated list of solution category summaries matching the applied filters.
51        """
52        query: dict[str, object] = {}
53        if page is not None:
54            query["page"] = page
55        if page_size is not None:
56            query["page_size"] = page_size
57        if keys is not None:
58            query["keys"] = keys
59        if parent_keys is not None:
60            query["parent_keys"] = parent_keys
61        if lookup_key is not None:
62            query["lookup_key"] = lookup_key
63        if path_prefix is not None:
64            query["path_prefix"] = path_prefix
65        if owners is not None:
66            query["owners"] = owners
67        return await self._http.request(
68            "/api/v1/solution_categories",
69            query=query,
70            response_type=SolutionCategoryListResponse,
71        )
AsyncSolutionCategoryResource(http: archastro.platform.runtime.http_client.HttpClient) 
15    def __init__(self, http: HttpClient):
16        self._http = http
async def list( self, *, page: int | None = None, page_size: int | None = None, keys: list[str] | None = None, parent_keys: list[str] | None = None, lookup_key: str | None = None, path_prefix: str | None = None, owners: list[str] | None = None) -> archastro.platform.types.common.SolutionCategoryListResponse: 
18    async def list(
19        self,
20        *,
21        page: int | None = None,
22        page_size: int | None = None,
23        keys: builtins.list[str] | None = None,
24        parent_keys: builtins.list[str] | None = None,
25        lookup_key: str | None = None,
26        path_prefix: str | None = None,
27        owners: builtins.list[str] | None = None,
28    ) -> SolutionCategoryListResponse:
29        """
30        List solution categories
31        Returns a paginated list of solution category definitions visible to the authenticated caller.
32        Use filters to narrow results by key, parent key, lookup key, or virtual path prefix.
33        Results are scoped to categories accessible under the caller's viewer context. Pass `app` to
34        restrict the listing to categories associated with a specific app scope. Omit `owners` to
35        return categories from all ownership scopes (`"system"` and `"org"`) that the caller can see.
36        Pagination is page-based. Use `page` and `page_size` to navigate large result sets. The
37        response includes `total_entries`, `total_pages`, `has_next`, and `has_prev` to support
38        pagination controls. `total_entries` reflects the count after key deduplication.
39
40        Args:
41            page: Page number to retrieve, 1-indexed. Defaults to `1`.
42            page_size: Number of solution categories to return per page. Defaults to `25`.
43            keys: Return only categories whose key exactly matches one of the provided values.
44            parent_keys: Return only categories whose parent key matches one of the provided values. Pass an empty array to return root-level categories.
45            lookup_key: Return only the category whose `lookup_key` exactly matches this value.
46            path_prefix: Return only categories whose `virtual_path` starts with this prefix.
47            owners: Restrict results to categories owned by the specified scopes. Accepted values are `"system"` and `"org"`. Omit to include all ownership scopes visible to the caller.
48
49        Returns:
50            Paginated list of solution category summaries matching the applied filters.
51        """
52        query: dict[str, object] = {}
53        if page is not None:
54            query["page"] = page
55        if page_size is not None:
56            query["page_size"] = page_size
57        if keys is not None:
58            query["keys"] = keys
59        if parent_keys is not None:
60            query["parent_keys"] = parent_keys
61        if lookup_key is not None:
62            query["lookup_key"] = lookup_key
63        if path_prefix is not None:
64            query["path_prefix"] = path_prefix
65        if owners is not None:
66            query["owners"] = owners
67        return await self._http.request(
68            "/api/v1/solution_categories",
69            query=query,
70            response_type=SolutionCategoryListResponse,
71        )

List solution categories Returns a paginated list of solution category definitions visible to the authenticated caller. Use filters to narrow results by key, parent key, lookup key, or virtual path prefix. Results are scoped to categories accessible under the caller's viewer context. Pass app to restrict the listing to categories associated with a specific app scope. Omit owners to return categories from all ownership scopes ("system" and "org") that the caller can see. Pagination is page-based. Use page and page_size to navigate large result sets. The response includes total_entries, total_pages, has_next, and has_prev to support pagination controls. total_entries reflects the count after key deduplication.

Arguments:
  • page: Page number to retrieve, 1-indexed. Defaults to 1.
  • page_size: Number of solution categories to return per page. Defaults to 25.
  • keys: Return only categories whose key exactly matches one of the provided values.
  • parent_keys: Return only categories whose parent key matches one of the provided values. Pass an empty array to return root-level categories.
  • lookup_key: Return only the category whose lookup_key exactly matches this value.
  • path_prefix: Return only categories whose virtual_path starts with this prefix.
  • owners: Restrict results to categories owned by the specified scopes. Accepted values are "system" and "org". Omit to include all ownership scopes visible to the caller.
Returns:

Paginated list of solution category summaries matching the applied filters.

class SolutionCategoryResource: 
 74class SolutionCategoryResource:
 75    def __init__(self, http: SyncHttpClient):
 76        self._http = http
 77
 78    def list(
 79        self,
 80        *,
 81        page: int | None = None,
 82        page_size: int | None = None,
 83        keys: builtins.list[str] | None = None,
 84        parent_keys: builtins.list[str] | None = None,
 85        lookup_key: str | None = None,
 86        path_prefix: str | None = None,
 87        owners: builtins.list[str] | None = None,
 88    ) -> SolutionCategoryListResponse:
 89        """
 90        List solution categories
 91        Returns a paginated list of solution category definitions visible to the authenticated caller.
 92        Use filters to narrow results by key, parent key, lookup key, or virtual path prefix.
 93        Results are scoped to categories accessible under the caller's viewer context. Pass `app` to
 94        restrict the listing to categories associated with a specific app scope. Omit `owners` to
 95        return categories from all ownership scopes (`"system"` and `"org"`) that the caller can see.
 96        Pagination is page-based. Use `page` and `page_size` to navigate large result sets. The
 97        response includes `total_entries`, `total_pages`, `has_next`, and `has_prev` to support
 98        pagination controls. `total_entries` reflects the count after key deduplication.
 99
100        Args:
101            page: Page number to retrieve, 1-indexed. Defaults to `1`.
102            page_size: Number of solution categories to return per page. Defaults to `25`.
103            keys: Return only categories whose key exactly matches one of the provided values.
104            parent_keys: Return only categories whose parent key matches one of the provided values. Pass an empty array to return root-level categories.
105            lookup_key: Return only the category whose `lookup_key` exactly matches this value.
106            path_prefix: Return only categories whose `virtual_path` starts with this prefix.
107            owners: Restrict results to categories owned by the specified scopes. Accepted values are `"system"` and `"org"`. Omit to include all ownership scopes visible to the caller.
108
109        Returns:
110            Paginated list of solution category summaries matching the applied filters.
111        """
112        query: dict[str, object] = {}
113        if page is not None:
114            query["page"] = page
115        if page_size is not None:
116            query["page_size"] = page_size
117        if keys is not None:
118            query["keys"] = keys
119        if parent_keys is not None:
120            query["parent_keys"] = parent_keys
121        if lookup_key is not None:
122            query["lookup_key"] = lookup_key
123        if path_prefix is not None:
124            query["path_prefix"] = path_prefix
125        if owners is not None:
126            query["owners"] = owners
127        return self._http.request(
128            "/api/v1/solution_categories",
129            query=query,
130            response_type=SolutionCategoryListResponse,
131        )
SolutionCategoryResource(http: archastro.platform.runtime.http_client.SyncHttpClient) 
75    def __init__(self, http: SyncHttpClient):
76        self._http = http
def list( self, *, page: int | None = None, page_size: int | None = None, keys: list[str] | None = None, parent_keys: list[str] | None = None, lookup_key: str | None = None, path_prefix: str | None = None, owners: list[str] | None = None) -> archastro.platform.types.common.SolutionCategoryListResponse: 
 78    def list(
 79        self,
 80        *,
 81        page: int | None = None,
 82        page_size: int | None = None,
 83        keys: builtins.list[str] | None = None,
 84        parent_keys: builtins.list[str] | None = None,
 85        lookup_key: str | None = None,
 86        path_prefix: str | None = None,
 87        owners: builtins.list[str] | None = None,
 88    ) -> SolutionCategoryListResponse:
 89        """
 90        List solution categories
 91        Returns a paginated list of solution category definitions visible to the authenticated caller.
 92        Use filters to narrow results by key, parent key, lookup key, or virtual path prefix.
 93        Results are scoped to categories accessible under the caller's viewer context. Pass `app` to
 94        restrict the listing to categories associated with a specific app scope. Omit `owners` to
 95        return categories from all ownership scopes (`"system"` and `"org"`) that the caller can see.
 96        Pagination is page-based. Use `page` and `page_size` to navigate large result sets. The
 97        response includes `total_entries`, `total_pages`, `has_next`, and `has_prev` to support
 98        pagination controls. `total_entries` reflects the count after key deduplication.
 99
100        Args:
101            page: Page number to retrieve, 1-indexed. Defaults to `1`.
102            page_size: Number of solution categories to return per page. Defaults to `25`.
103            keys: Return only categories whose key exactly matches one of the provided values.
104            parent_keys: Return only categories whose parent key matches one of the provided values. Pass an empty array to return root-level categories.
105            lookup_key: Return only the category whose `lookup_key` exactly matches this value.
106            path_prefix: Return only categories whose `virtual_path` starts with this prefix.
107            owners: Restrict results to categories owned by the specified scopes. Accepted values are `"system"` and `"org"`. Omit to include all ownership scopes visible to the caller.
108
109        Returns:
110            Paginated list of solution category summaries matching the applied filters.
111        """
112        query: dict[str, object] = {}
113        if page is not None:
114            query["page"] = page
115        if page_size is not None:
116            query["page_size"] = page_size
117        if keys is not None:
118            query["keys"] = keys
119        if parent_keys is not None:
120            query["parent_keys"] = parent_keys
121        if lookup_key is not None:
122            query["lookup_key"] = lookup_key
123        if path_prefix is not None:
124            query["path_prefix"] = path_prefix
125        if owners is not None:
126            query["owners"] = owners
127        return self._http.request(
128            "/api/v1/solution_categories",
129            query=query,
130            response_type=SolutionCategoryListResponse,
131        )

List solution categories Returns a paginated list of solution category definitions visible to the authenticated caller. Use filters to narrow results by key, parent key, lookup key, or virtual path prefix. Results are scoped to categories accessible under the caller's viewer context. Pass app to restrict the listing to categories associated with a specific app scope. Omit owners to return categories from all ownership scopes ("system" and "org") that the caller can see. Pagination is page-based. Use page and page_size to navigate large result sets. The response includes total_entries, total_pages, has_next, and has_prev to support pagination controls. total_entries reflects the count after key deduplication.

Arguments:
  • page: Page number to retrieve, 1-indexed. Defaults to 1.
  • page_size: Number of solution categories to return per page. Defaults to 25.
  • keys: Return only categories whose key exactly matches one of the provided values.
  • parent_keys: Return only categories whose parent key matches one of the provided values. Pass an empty array to return root-level categories.
  • lookup_key: Return only the category whose lookup_key exactly matches this value.
  • path_prefix: Return only categories whose virtual_path starts with this prefix.
  • owners: Restrict results to categories owned by the specified scopes. Accepted values are "system" and "org". Omit to include all ownership scopes visible to the caller.
Returns:

Paginated list of solution category summaries matching the applied filters.