List an FAQ item’s locales

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const documentLocales = await site.faqItems().getFaqItemLocales({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "results": [
    {}
  ]
}

In your app

import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function getFaqItemLocales(site: SiteClient, id: string) {
  return site.faqItems().getFaqItemLocales({ id });
}

import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { getFaqItemLocales } from '../src/attract/get-faq-item-locales.ts';

const site = createSiteClient();
console.log(await getFaqItemLocales(site, 'clx8m2k4p0000a1b2c3d4e5f6'));

node --env-file=.env scripts/get-faq-item-locales.ts

Find the id

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const row = (await site.faqItems().listFaqItemsPick(['title', 'slug'])).find((each) => each.slug === 'getting-started'); // { id, title, slug }, or undefined

Behavior

• Access: an API key with content:faq-items:read (or a master above it: content:faq-items:all, content:all, admin:all) reads the published documents; drafts (a draft _id) need content:faq-items:write (or a master above it). A signed-in person reads as far as their own permissions allow, and anyone else reads the published documents’ public fields.
• 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 see RateLimited only 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

import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { getFaqItemLocales } from '../src/attract/get-faq-item-locales.ts';

test('faqItems.getFaqItemLocales', async () => {
  const site = fakeSite();
  await getFaqItemLocales(site, 'clx8m2k4p0000a1b2c3d4e5f6');
  site.assertCalled('faqItems.getFaqItemLocales', (args) => args.id === 'clx8m2k4p0000a1b2c3d4e5f6');
});

Related