@picked/admin-api-client 0.0.85-next.4 → 0.0.85-next.5

package/README.md

@@ -7,7 +7,14 @@ Typed [gql.tada](https://gql.tada.dev) client for the Picked admin (management)
 ```typescript
 import { createAdminApiClient, graphql } from '@picked/admin-api-client'
 
-const MeQuery = graphql(`query Me { user { id email } }`)
+const MeQuery = graphql(`
+  query Me {
+    user {
+      id
+      email
+    }
+  }
+`)
 
 const client = createAdminApiClient({ apiUrl: 'https://api.picked.app', token: accessToken })
 const data = await client.request(MeQuery, {}) // fully typed from the schema
@@ -16,6 +23,18 @@ const data = await client.request(MeQuery, {}) // fully typed from the schema
 Documents are authored with `graphql`; results and variables are inferred from the API schema. The
 client trusts the API response (no runtime shape validation), matching the dashboard's transport.
 
+Pass `apiKey` to authenticate with an API key; the client sends it as the `X-API-Key` header.
+
+A request is aborted after 30 seconds; `client.request(document, variables, { timeoutMs })`
+sets a different limit for one request. When the API answers with GraphQL errors, `request`
+throws an `AdminApiResponseError` whose `codes` holds each error's `extensions.code`; a
+network failure, timeout, or HTTP error without a GraphQL error list throws a plain `Error`.
+
+The package also exports the documents that move a workspace between projects:
+`WorkspaceExportDocument`, `ProjectLiveVersionDocument`, `WorkspaceImportDocument`,
+`AssetUploadInitDocument`, `AssetCommitDocument`, `AssetDeleteDocument` and
+`WorkspacePublishDocument`.
+
 ## Development
 
 Regenerate the schema types after the API schema changes: