Docs
API Referencesdks@platform/sdk-platform

@platform/sdk-platform

Typed TypeScript client for services/platform. The page is generated from the SDK package source plus its generated OpenAPI types.

Installation

npm install @platform/sdk-platform

You’ll also need the shared auth/client helpers:

npm install @platform/hosts @platform/sdk

Quick start

import { LoopClient } from "@platform/sdk";
import { platformHost, SERVICE_NAMES } from "@platform/hosts";
import { createPlatformClient } from "@platform/sdk-platform";
 
const loop = new LoopClient({
  clientId: process.env.LOOP_CLIENT_ID!,
  clientSecret: process.env.LOOP_CLIENT_SECRET!,
  redirectUri: "https://your-app.example.com/auth/loop/callback",
});
 
const platform = createPlatformClient({
  baseUrl: platformHost({ service: SERVICE_NAMES.PLATFORM }),
  accessToken: tokens.access_token,
});

Use the convenience helpers below when the SDK exposes them, or call the typed endpoint methods directly with GET / POST / PATCH / DELETE.

Convenience helpers

This SDK does not add convenience helpers beyond the typed endpoint calls below.

Endpoint calls

GET /readyz

Underlying REST endpoint: GET /readyz

Parameters

None

Return type

Promise<{
  data?: paths["/readyz"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await platform.GET("/readyz");

GET /v1/admin/audit-log

Underlying REST endpoint: GET /v1/admin/audit-log

Parameters

  • query?: paths["/v1/admin/audit-log"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/admin/audit-log"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await platform.GET("/v1/admin/audit-log", {
  params: {
    query: {
      /* paths["/v1/admin/audit-log"]["get"]["parameters"]["query"] */
    },
  },
});

GET /v1/admin/brands

Underlying REST endpoint: GET /v1/admin/brands

Parameters

None

Return type

Promise<{
  data?: paths["/v1/admin/brands"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await platform.GET("/v1/admin/brands");

GET /v1/admin/brands/{id}

Underlying REST endpoint: GET /v1/admin/brands/\{id\}

Parameters

  • path: paths["/v1/admin/brands/{id}"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/admin/brands/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await platform.GET("/v1/admin/brands/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

POST /v1/admin/canary

Underlying REST endpoint: POST /v1/admin/canary

Parameters

None

Return type

Promise<{
  data?: paths["/v1/admin/canary"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await platform.POST("/v1/admin/canary");

GET /v1/partners

Underlying REST endpoint: GET /v1/partners

Parameters

None

Return type

Promise<{
  data?: paths["/v1/partners"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await platform.GET("/v1/partners");

GET /v1/platform/me/brand

Underlying REST endpoint: GET /v1/platform/me/brand

Parameters

None

Return type

Promise<{
  data?: paths["/v1/platform/me/brand"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await platform.GET("/v1/platform/me/brand");

Related

@platform/sdk-payments@platform/sdk-template