In your app
A function makes the call on the client it is given, so your code passes the real one and a test passes a fake.Add the function
src/attract/get-global-translated-fields.ts
Call it
A script makes the client once and calls the function:A route handler, a job or a queue worker calls it the same way.
scripts/get-global-translated-fields.ts
Terminal
aposLocale set to the language, translate these fields, and patch them back: send only these fields, so no shared setting changes. A link in them (url, headerCtaUrl, cookiePolicyUrl) is the language’s own too: point it at the page in that language.
Parameters
Parameters
None: call it with no arguments.
Returns
Returns
Errors
Errors
Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below; catch only what you want to react to (see Errors and testing).
The API key is missing, malformed, unknown, disabled, expired or archived, or a request its signing mode requires to be signed is not.Retried first: No. Read:
siteMessage, errorName, data.The API key lacks the scope this route needs (the message names it) or is used from outside its allowlist; or, on a route that answers 403 to everyone it refuses, the caller may not use it.Retried first: No. Read:
siteMessage, errorName, data.The key used up its per-minute limit. Still, after the client’s own waits and retries.Retried first: Yes: the client waits
Retry-After (1 s when absent; over 60 s it gives up at once) and retries, up to retries times (2 by default). Read: retryAfter (seconds, or null), siteMessage.The site failed (or something in front of it did). Its logs say why.Retried first: A 502, 503 or 504: yes, after 0.5 s then 1 s. A 500: no. Read:
siteMessage, errorName, data.No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Yes, after 0.5 s then 1 s. Read:
reason, neverConnected.The client refused to send it (e.g. a path segment of
..); the site never saw it.Retried first: No. Read: reason (what to change).Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read:
reason, status.sites.forSite('acme') named a slug your sites (createSiteClients()) don’t have.Retried first: No: nothing was sent. Read: message, slug.Behavior
- Access: an API key with
languages:read, orlanguages:all, oradmin:all, or a signed-in user holding thelanguages:managepermission. Other callers get 403. - Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with
Retry-After. The client waits and retries for you; you seeRateLimitedonly if that runs out. - Retries: a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
- Timeout: 15 s per attempt by default; raise
timeout(milliseconds) on the client for longer.
Test it
It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it withnode --test.
tests/languages-getGlobalTranslatedFields.test.ts
Related
List language lists
site.languages().listSiteLanguages()Get a language list
site.languages().getSiteLanguages()Replace a language list
site.languages().replaceSiteLanguages()Update a language list
site.languages().updateSiteLanguages()GET /site-languages/global-fields
The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.