Site

sitenamespace

Blocos, FAQ, busca e conteúdo do site.

7métodos

sitenamespace

Esta página é gerada automaticamente pelo @luckymaker/sdk-generator. Não edite manualmente.

evaluateBlocksConditions

POST/user/site/blocks/conditions/evaluate

Assinatura:

evaluateBlocksConditions(body?: EvaluateBlocksConditionsBody, settings?: SdkSettings): Promise<EvaluateBlocksConditionsResponse>

Body

Nome	Tipo	Obrigatório
conditions	Array<{ "id": string; "params"?: Record<string, unknown>; }>	sim

Tipos

type EvaluateBlocksConditionsBody = { "conditions": Array<{ "id": string; "params"?: Record<string, unknown>; }>; };
type EvaluateBlocksConditionsResponse = { "results": Array<boolean>; };

Exemplo

const response = await sdk.site.evaluateBlocksConditions({ "conditions": [] });

Testar esta função no playground

getBlock

GET/site/blocks/:id

Assinatura:

getBlock(id: string, settings?: SdkSettings): Promise<GetBlockResponse>

Parâmetros de rota

Nome	Tipo
id	string

Tipos

type GetBlockParams = { "id": string; };
type GetBlockResponse = unknown;

Exemplo

const response = await sdk.site.getBlock("string");

Testar esta função no playground

getFaq

GET/site/faq

Assinatura:

getFaq(settings?: SdkSettings): Promise<GetFaqResponse>

Tipos

type GetFaqResponse = { "articles": Array<{ "title": string; "body": string | { "type": "document" | "doc"; "content": Array<unknown> | Record<string, unknown>; }; }>; };

Exemplo

const response = await sdk.site.getFaq();

Testar esta função no playground

getHomepage

GET/site/views/homepage

Assinatura:

getHomepage(settings?: SdkSettings): Promise<GetHomepageResponse>

Tipos

type GetHomepageResponse = unknown;

Exemplo

const response = await sdk.site.getHomepage();

Testar esta função no playground

getPlugin

GET/site/plugins/:context

Assinatura:

getPlugin(context: "frontend" | "admin" | "reseller", settings?: SdkSettings): Promise<GetPluginResponse>

Parâmetros de rota

Nome	Tipo
context	"frontend" | "admin" | "reseller"

Tipos

type GetPluginParams = { "context": "frontend" | "admin" | "reseller"; };
type GetPluginResponse = Array<{ "id": string; "name": string; "version"?: string; "contexts": Array<string>; "assets": { "frontend"?: string; "admin"?: string; "reseller"?: string; "watchUrl"?: string; }; }>;

Exemplo

const response = await sdk.site.getPlugin("frontend");

Testar esta função no playground

listBlocks

GET/site/blocks

Assinatura:

listBlocks(settings?: SdkSettings): Promise<ListBlocksResponse>

Tipos

type ListBlocksResponse = Array<{ "id": unknown; "title"?: string; "type": string; "slug"?: string; "status"?: string; "publishAt"?: unknown; [key: string]: unknown; }>;

Exemplo

const response = await sdk.site.listBlocks();

Testar esta função no playground

search

GET/site/search

Assinatura:

search(query?: SearchQuery, settings?: SdkSettings): Promise<SearchResponse>

Query

Nome	Tipo	Obrigatório
q	string	não
types	string	não
limit	number	não

Tipos

type SearchQuery = { "q"?: string; "types"?: string; "limit"?: number; };
type SearchResponse = unknown;

Exemplo

const response = await sdk.site.search();

Testar esta função no playground