Docs
API Referencesdks@platform/sdk-intelligence

@platform/sdk-intelligence

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

Installation

npm install @platform/sdk-intelligence

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 { createIntelligenceClient } from "@platform/sdk-intelligence";
 
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 intelligence = createIntelligenceClient({
  baseUrl: platformHost({ service: SERVICE_NAMES.INTELLIGENCE }),
  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 intelligence.GET("/readyz");

POST /v1/contributions

Underlying REST endpoint: POST /v1/contributions

Parameters

  • body: paths["/v1/contributions"]["post"]["requestBody"]["content"]["application/json"]

Return type

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

Example

const result = await intelligence.POST("/v1/contributions", {
  body: {
    /* paths["/v1/contributions"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/decisions

Underlying REST endpoint: POST /v1/decisions

Parameters

  • body: paths["/v1/decisions"]["post"]["requestBody"]["content"]["application/json"]

Return type

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

Example

const result = await intelligence.POST("/v1/decisions", {
  body: {
    /* paths["/v1/decisions"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/decisions/{id}

Underlying REST endpoint: GET /v1/decisions/\{id\}

Parameters

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

Return type

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

Example

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

GET /v1/experiments

Underlying REST endpoint: GET /v1/experiments

Parameters

  • query?: paths["/v1/experiments"]["get"]["parameters"]["query"]

Return type

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

Example

const result = await intelligence.GET("/v1/experiments", {
  params: {
    query: {
      /* paths["/v1/experiments"]["get"]["parameters"]["query"] */
    },
  },
});

POST /v1/experiments

Underlying REST endpoint: POST /v1/experiments

Parameters

  • body: paths["/v1/experiments"]["post"]["requestBody"]["content"]["application/json"]

Return type

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

Example

const result = await intelligence.POST("/v1/experiments", {
  body: {
    /* paths["/v1/experiments"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/experiments/{id}

Underlying REST endpoint: GET /v1/experiments/\{id\}

Parameters

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

Return type

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

Example

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

POST /v1/experiments/{id}/assign

Underlying REST endpoint: POST /v1/experiments/\{id\}/assign

Parameters

  • path: paths["/v1/experiments/{id}/assign"]["post"]["parameters"]["path"]
  • body: paths["/v1/experiments/{id}/assign"]["post"]["requestBody"]["content"]["application/json"]

Return type

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

Example

const result = await intelligence.POST("/v1/experiments/{id}/assign", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/experiments/{id}/assign"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/experiments/{id}/clinicaltrials-export

Underlying REST endpoint: GET /v1/experiments/\{id\}/clinicaltrials-export

Parameters

  • path: paths["/v1/experiments/{id}/clinicaltrials-export"]["get"]["parameters"]["path"]

Return type

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

Example

const result = await intelligence.GET("/v1/experiments/{id}/clinicaltrials-export", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

POST /v1/experiments/{id}/close

Underlying REST endpoint: POST /v1/experiments/\{id\}/close

Parameters

  • path: paths["/v1/experiments/{id}/close"]["post"]["parameters"]["path"]

Return type

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

Example

const result = await intelligence.POST("/v1/experiments/{id}/close", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

POST /v1/experiments/{id}/enroll

Underlying REST endpoint: POST /v1/experiments/\{id\}/enroll

Parameters

  • path: paths["/v1/experiments/{id}/enroll"]["post"]["parameters"]["path"]
  • body: paths["/v1/experiments/{id}/enroll"]["post"]["requestBody"]["content"]["application/json"]

Return type

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

Example

const result = await intelligence.POST("/v1/experiments/{id}/enroll", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/experiments/{id}/enroll"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/experiments/{id}/enrollments/{entity_id}

Underlying REST endpoint: GET /v1/experiments/\{id\}/enrollments/\{entity_id\}

Parameters

  • path: paths["/v1/experiments/{id}/enrollments/{entity_id}"]["get"]["parameters"]["path"]

Return type

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

Example

const result = await intelligence.GET("/v1/experiments/{id}/enrollments/{entity_id}", {
  params: {
    path: {
      id: "<id>",
      entity_id: "<entity_id>",
    },
  },
});

GET /v1/experiments/{id}/exposures

Underlying REST endpoint: GET /v1/experiments/\{id\}/exposures

Parameters

  • path: paths["/v1/experiments/{id}/exposures"]["get"]["parameters"]["path"]
  • query?: paths["/v1/experiments/{id}/exposures"]["get"]["parameters"]["query"]

Return type

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

Example

const result = await intelligence.GET("/v1/experiments/{id}/exposures", {
  params: {
    path: {
      id: "<id>",
    },
    query: {
      /* paths["/v1/experiments/{id}/exposures"]["get"]["parameters"]["query"] */
    },
  },
});

GET /v1/experiments/{id}/nof1-schedule

Underlying REST endpoint: GET /v1/experiments/\{id\}/nof1-schedule

Parameters

  • path: paths["/v1/experiments/{id}/nof1-schedule"]["get"]["parameters"]["path"]
  • query: paths["/v1/experiments/{id}/nof1-schedule"]["get"]["parameters"]["query"]

Return type

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

Example

const result = await intelligence.GET("/v1/experiments/{id}/nof1-schedule", {
  params: {
    path: {
      id: "<id>",
    },
    query: {
      /* paths["/v1/experiments/{id}/nof1-schedule"]["get"]["parameters"]["query"] */
    },
  },
});

GET /v1/experiments/{id}/precis2

Underlying REST endpoint: GET /v1/experiments/\{id\}/precis2

Parameters

  • path: paths["/v1/experiments/{id}/precis2"]["get"]["parameters"]["path"]

Return type

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

Example

const result = await intelligence.GET("/v1/experiments/{id}/precis2", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

POST /v1/experiments/{id}/precis2

Underlying REST endpoint: POST /v1/experiments/\{id\}/precis2

Parameters

  • path: paths["/v1/experiments/{id}/precis2"]["post"]["parameters"]["path"]
  • body: paths["/v1/experiments/{id}/precis2"]["post"]["requestBody"]["content"]["application/json"]

Return type

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

Example

const result = await intelligence.POST("/v1/experiments/{id}/precis2", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/experiments/{id}/precis2"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/experiments/{id}/preregister

Underlying REST endpoint: POST /v1/experiments/\{id\}/preregister

Parameters

  • path: paths["/v1/experiments/{id}/preregister"]["post"]["parameters"]["path"]

Return type

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

Example

const result = await intelligence.POST("/v1/experiments/{id}/preregister", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

GET /v1/experiments/{id}/preregistration

Underlying REST endpoint: GET /v1/experiments/\{id\}/preregistration

Parameters

  • path: paths["/v1/experiments/{id}/preregistration"]["get"]["parameters"]["path"]

Return type

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

Example

const result = await intelligence.GET("/v1/experiments/{id}/preregistration", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

POST /v1/experiments/{id}/start

Underlying REST endpoint: POST /v1/experiments/\{id\}/start

Parameters

  • path: paths["/v1/experiments/{id}/start"]["post"]["parameters"]["path"]
  • body: paths["/v1/experiments/{id}/start"]["post"]["requestBody"]["content"]["application/json"]

Return type

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

Example

const result = await intelligence.POST("/v1/experiments/{id}/start", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/experiments/{id}/start"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/experiments/{id}/withdraw

Underlying REST endpoint: POST /v1/experiments/\{id\}/withdraw

Parameters

  • path: paths["/v1/experiments/{id}/withdraw"]["post"]["parameters"]["path"]
  • body: paths["/v1/experiments/{id}/withdraw"]["post"]["requestBody"]["content"]["application/json"]

Return type

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

Example

const result = await intelligence.POST("/v1/experiments/{id}/withdraw", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/experiments/{id}/withdraw"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/exposures

Underlying REST endpoint: POST /v1/exposures

Parameters

  • body: paths["/v1/exposures"]["post"]["requestBody"]["content"]["application/json"]

Return type

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

Example

const result = await intelligence.POST("/v1/exposures", {
  body: {
    /* paths["/v1/exposures"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/exposures/{id}

Underlying REST endpoint: GET /v1/exposures/\{id\}

Parameters

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

Return type

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

Example

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

POST /v1/features

Underlying REST endpoint: POST /v1/features

Parameters

  • body: paths["/v1/features"]["post"]["requestBody"]["content"]["application/json"]

Return type

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

Example

const result = await intelligence.POST("/v1/features", {
  body: {
    /* paths["/v1/features"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/features/{entity_id}

Underlying REST endpoint: GET /v1/features/\{entity_id\}

Parameters

  • path: paths["/v1/features/{entity_id}"]["get"]["parameters"]["path"]
  • query: paths["/v1/features/{entity_id}"]["get"]["parameters"]["query"]

Return type

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

Example

const result = await intelligence.GET("/v1/features/{entity_id}", {
  params: {
    path: {
      entity_id: "<entity_id>",
    },
    query: {
      /* paths["/v1/features/{entity_id}"]["get"]["parameters"]["query"] */
    },
  },
});

GET /v1/governance/proposals

Underlying REST endpoint: GET /v1/governance/proposals

Parameters

  • query?: paths["/v1/governance/proposals"]["get"]["parameters"]["query"]

Return type

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

Example

const result = await intelligence.GET("/v1/governance/proposals", {
  params: {
    query: {
      /* paths["/v1/governance/proposals"]["get"]["parameters"]["query"] */
    },
  },
});

GET /v1/governance/proposals/{id}

Underlying REST endpoint: GET /v1/governance/proposals/\{id\}

Parameters

  • path: paths["/v1/governance/proposals/{id}"]["get"]["parameters"]["path"]

Return type

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

Example

const result = await intelligence.GET("/v1/governance/proposals/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

POST /v1/governance/proposals/{id}/apply

Underlying REST endpoint: POST /v1/governance/proposals/\{id\}/apply

Parameters

  • path: paths["/v1/governance/proposals/{id}/apply"]["post"]["parameters"]["path"]
  • body: paths["/v1/governance/proposals/{id}/apply"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/governance/proposals/{id}/apply"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await intelligence.POST("/v1/governance/proposals/{id}/apply", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/governance/proposals/{id}/apply"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/governance/proposals/{id}/approve

Underlying REST endpoint: POST /v1/governance/proposals/\{id\}/approve

Parameters

  • path: paths["/v1/governance/proposals/{id}/approve"]["post"]["parameters"]["path"]
  • body: paths["/v1/governance/proposals/{id}/approve"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/governance/proposals/{id}/approve"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await intelligence.POST("/v1/governance/proposals/{id}/approve", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/governance/proposals/{id}/approve"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/governance/proposals/{id}/reject

Underlying REST endpoint: POST /v1/governance/proposals/\{id\}/reject

Parameters

  • path: paths["/v1/governance/proposals/{id}/reject"]["post"]["parameters"]["path"]
  • body: paths["/v1/governance/proposals/{id}/reject"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/governance/proposals/{id}/reject"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await intelligence.POST("/v1/governance/proposals/{id}/reject", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/governance/proposals/{id}/reject"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/loop/meta-metrics

Underlying REST endpoint: GET /v1/loop/meta-metrics

Parameters

None

Return type

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

Example

const result = await intelligence.GET("/v1/loop/meta-metrics");

GET /v1/loop/proposals

Underlying REST endpoint: GET /v1/loop/proposals

Parameters

  • query?: paths["/v1/loop/proposals"]["get"]["parameters"]["query"]

Return type

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

Example

const result = await intelligence.GET("/v1/loop/proposals", {
  params: {
    query: {
      /* paths["/v1/loop/proposals"]["get"]["parameters"]["query"] */
    },
  },
});

POST /v1/loop/tick

Underlying REST endpoint: POST /v1/loop/tick

Parameters

None

Return type

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

Example

const result = await intelligence.POST("/v1/loop/tick");

POST /v1/recommendations/rank

Underlying REST endpoint: POST /v1/recommendations/rank

Parameters

  • body: paths["/v1/recommendations/rank"]["post"]["requestBody"]["content"]["application/json"]

Return type

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

Example

const result = await intelligence.POST("/v1/recommendations/rank", {
  body: {
    /* paths["/v1/recommendations/rank"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/registry

Underlying REST endpoint: POST /v1/registry

Parameters

  • body: paths["/v1/registry"]["post"]["requestBody"]["content"]["application/json"]

Return type

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

Example

const result = await intelligence.POST("/v1/registry", {
  body: {
    /* paths["/v1/registry"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/registry/{id}

Underlying REST endpoint: GET /v1/registry/\{id\}

Parameters

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

Return type

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

Example

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

POST /v1/registry/{id}/promote

Underlying REST endpoint: POST /v1/registry/\{id\}/promote

Parameters

  • path: paths["/v1/registry/{id}/promote"]["post"]["parameters"]["path"]

Return type

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

Example

const result = await intelligence.POST("/v1/registry/{id}/promote", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

POST /v1/registry/rollback

Underlying REST endpoint: POST /v1/registry/rollback

Parameters

  • body: paths["/v1/registry/rollback"]["post"]["requestBody"]["content"]["application/json"]

Return type

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

Example

const result = await intelligence.POST("/v1/registry/rollback", {
  body: {
    /* paths["/v1/registry/rollback"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/research-consents

Underlying REST endpoint: POST /v1/research-consents

Parameters

  • body: paths["/v1/research-consents"]["post"]["requestBody"]["content"]["application/json"]

Return type

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

Example

const result = await intelligence.POST("/v1/research-consents", {
  body: {
    /* paths["/v1/research-consents"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/research-consents/{entity_id}

Underlying REST endpoint: GET /v1/research-consents/\{entity_id\}

Parameters

  • path: paths["/v1/research-consents/{entity_id}"]["get"]["parameters"]["path"]

Return type

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

Example

const result = await intelligence.GET("/v1/research-consents/{entity_id}", {
  params: {
    path: {
      entity_id: "<entity_id>",
    },
  },
});

POST /v1/research-consents/{entity_id}/revoke

Underlying REST endpoint: POST /v1/research-consents/\{entity_id\}/revoke

Parameters

  • path: paths["/v1/research-consents/{entity_id}/revoke"]["post"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/research-consents/{entity_id}/revoke"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await intelligence.POST("/v1/research-consents/{entity_id}/revoke", {
  params: {
    path: {
      entity_id: "<entity_id>",
    },
  },
});

Related

@platform/sdk-integrations@platform/sdk-jobs