@platform/sdk-affiliates
Typed TypeScript client for services/affiliates. The page is generated from the SDK package source plus its generated OpenAPI types.
Installation
npm install @platform/sdk-affiliatesYou’ll also need the shared auth/client helpers:
npm install @platform/hosts @platform/sdkQuick start
import { LoopClient } from "@platform/sdk";
import { platformHost, SERVICE_NAMES } from "@platform/hosts";
import { createAffiliatesClient } from "@platform/sdk-affiliates";
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 affiliates = createAffiliatesClient({
baseUrl: platformHost({ service: SERVICE_NAMES.AFFILIATES }),
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 affiliates.GET("/readyz");PUT /v1/admin/affiliates/{id}/landing-config
Underlying REST endpoint: PUT /v1/admin/affiliates/\{id\}/landing-config
Parameters
path: paths["/v1/admin/affiliates/{id}/landing-config"]["put"]["parameters"]["path"]body: paths["/v1/admin/affiliates/{id}/landing-config"]["put"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/affiliates/{id}/landing-config"]["put"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.PUT("/v1/admin/affiliates/{id}/landing-config", {
params: {
path: {
id: "<id>",
},
},
body: {
/* paths["/v1/admin/affiliates/{id}/landing-config"]["put"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/admin/affiliates/mark-inactive
Underlying REST endpoint: POST /v1/admin/affiliates/mark-inactive
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/affiliates/mark-inactive"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/admin/affiliates/mark-inactive");POST /v1/admin/affiliates/promote-elite
Underlying REST endpoint: POST /v1/admin/affiliates/promote-elite
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/affiliates/promote-elite"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/admin/affiliates/promote-elite");POST /v1/admin/affiliates/retire-eligible
Underlying REST endpoint: POST /v1/admin/affiliates/retire-eligible
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/affiliates/retire-eligible"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/admin/affiliates/retire-eligible");POST /v1/admin/attributions/scan-expiry
Underlying REST endpoint: POST /v1/admin/attributions/scan-expiry
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/attributions/scan-expiry"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/admin/attributions/scan-expiry");POST /v1/admin/bank-info/drift-check
Underlying REST endpoint: POST /v1/admin/bank-info/drift-check
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/bank-info/drift-check"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/admin/bank-info/drift-check");POST /v1/admin/commissions/reconcile
Underlying REST endpoint: POST /v1/admin/commissions/reconcile
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/commissions/reconcile"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/admin/commissions/reconcile");GET /v1/admin/payouts
Underlying REST endpoint: GET /v1/admin/payouts
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/payouts"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.GET("/v1/admin/payouts");POST /v1/admin/payouts/{id}/approve
Underlying REST endpoint: POST /v1/admin/payouts/\{id\}/approve
Parameters
path: paths["/v1/admin/payouts/{id}/approve"]["post"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/admin/payouts/{id}/approve"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/admin/payouts/{id}/approve", {
params: {
path: {
id: "<id>",
},
},
});POST /v1/admin/payouts/{id}/mark-paid
Underlying REST endpoint: POST /v1/admin/payouts/\{id\}/mark-paid
Parameters
path: paths["/v1/admin/payouts/{id}/mark-paid"]["post"]["parameters"]["path"]body: paths["/v1/admin/payouts/{id}/mark-paid"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/payouts/{id}/mark-paid"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/admin/payouts/{id}/mark-paid", {
params: {
path: {
id: "<id>",
},
},
body: {
/* paths["/v1/admin/payouts/{id}/mark-paid"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/admin/payouts/auto-approve
Underlying REST endpoint: POST /v1/admin/payouts/auto-approve
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/payouts/auto-approve"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/admin/payouts/auto-approve");POST /v1/admin/payouts/draft
Underlying REST endpoint: POST /v1/admin/payouts/draft
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/payouts/draft"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/admin/payouts/draft");POST /v1/admin/payouts/forecast
Underlying REST endpoint: POST /v1/admin/payouts/forecast
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/payouts/forecast"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/admin/payouts/forecast");POST /v1/admin/payouts/monitor-health
Underlying REST endpoint: POST /v1/admin/payouts/monitor-health
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/payouts/monitor-health"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/admin/payouts/monitor-health");POST /v1/admin/payouts/recover-failed
Underlying REST endpoint: POST /v1/admin/payouts/recover-failed
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/payouts/recover-failed"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/admin/payouts/recover-failed");POST /v1/admin/payouts/run-monthly
Underlying REST endpoint: POST /v1/admin/payouts/run-monthly
Parameters
body?: paths["/v1/admin/payouts/run-monthly"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/payouts/run-monthly"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/admin/payouts/run-monthly", {
body: {
/* paths["/v1/admin/payouts/run-monthly"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/admin/payouts/run-nightly
Underlying REST endpoint: POST /v1/admin/payouts/run-nightly
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/payouts/run-nightly"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/admin/payouts/run-nightly");POST /v1/affiliates
Underlying REST endpoint: POST /v1/affiliates
Parameters
body: paths["/v1/affiliates"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/affiliates"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/affiliates", {
body: {
/* paths["/v1/affiliates"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/affiliates/{id}
Underlying REST endpoint: GET /v1/affiliates/\{id\}
Parameters
path: paths["/v1/affiliates/{id}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/affiliates/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.GET("/v1/affiliates/{id}", {
params: {
path: {
id: "<id>",
},
},
});POST /v1/affiliates/{id}/approve
Underlying REST endpoint: POST /v1/affiliates/\{id\}/approve
Parameters
path: paths["/v1/affiliates/{id}/approve"]["post"]["parameters"]["path"]body: paths["/v1/affiliates/{id}/approve"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/affiliates/{id}/approve"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/affiliates/{id}/approve", {
params: {
path: {
id: "<id>",
},
},
body: {
/* paths["/v1/affiliates/{id}/approve"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/affiliates/{id}/commissions
Underlying REST endpoint: GET /v1/affiliates/\{id\}/commissions
Parameters
path: paths["/v1/affiliates/{id}/commissions"]["get"]["parameters"]["path"]query?: paths["/v1/affiliates/{id}/commissions"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/affiliates/{id}/commissions"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.GET("/v1/affiliates/{id}/commissions", {
params: {
path: {
id: "<id>",
},
query: {
/* paths["/v1/affiliates/{id}/commissions"]["get"]["parameters"]["query"] */
},
},
});POST /v1/affiliates/{id}/evaluate-tier
Underlying REST endpoint: POST /v1/affiliates/\{id\}/evaluate-tier
Parameters
path: paths["/v1/affiliates/{id}/evaluate-tier"]["post"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/affiliates/{id}/evaluate-tier"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/affiliates/{id}/evaluate-tier", {
params: {
path: {
id: "<id>",
},
},
});POST /v1/affiliates/{id}/reject
Underlying REST endpoint: POST /v1/affiliates/\{id\}/reject
Parameters
path: paths["/v1/affiliates/{id}/reject"]["post"]["parameters"]["path"]body: paths["/v1/affiliates/{id}/reject"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/affiliates/{id}/reject"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/affiliates/{id}/reject", {
params: {
path: {
id: "<id>",
},
},
body: {
/* paths["/v1/affiliates/{id}/reject"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/affiliates/{id}/verifications
Underlying REST endpoint: GET /v1/affiliates/\{id\}/verifications
Parameters
path: paths["/v1/affiliates/{id}/verifications"]["get"]["parameters"]["path"]query?: paths["/v1/affiliates/{id}/verifications"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/affiliates/{id}/verifications"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.GET("/v1/affiliates/{id}/verifications", {
params: {
path: {
id: "<id>",
},
query: {
/* paths["/v1/affiliates/{id}/verifications"]["get"]["parameters"]["query"] */
},
},
});GET /v1/affiliates/applications/pending
Underlying REST endpoint: GET /v1/affiliates/applications/pending
Parameters
query?: paths["/v1/affiliates/applications/pending"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/affiliates/applications/pending"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.GET("/v1/affiliates/applications/pending", {
params: {
query: {
/* paths["/v1/affiliates/applications/pending"]["get"]["parameters"]["query"] */
},
},
});POST /v1/affiliates/apply
Underlying REST endpoint: POST /v1/affiliates/apply
Parameters
body: paths["/v1/affiliates/apply"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/affiliates/apply"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/affiliates/apply", {
body: {
/* paths["/v1/affiliates/apply"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/affiliates/eligibility/loopbio
Underlying REST endpoint: GET /v1/affiliates/eligibility/loopbio
Parameters
query: paths["/v1/affiliates/eligibility/loopbio"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/affiliates/eligibility/loopbio"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.GET("/v1/affiliates/eligibility/loopbio", {
params: {
query: {
/* paths["/v1/affiliates/eligibility/loopbio"]["get"]["parameters"]["query"] */
},
},
});GET /v1/affiliates/me
Underlying REST endpoint: GET /v1/affiliates/me
Parameters
None
Return type
Promise<{
data?: paths["/v1/affiliates/me"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.GET("/v1/affiliates/me");GET /v1/affiliates/me/payouts
Underlying REST endpoint: GET /v1/affiliates/me/payouts
Parameters
None
Return type
Promise<{
data?: paths["/v1/affiliates/me/payouts"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.GET("/v1/affiliates/me/payouts");POST /v1/attributions/reassign
Underlying REST endpoint: POST /v1/attributions/reassign
Parameters
body: paths["/v1/attributions/reassign"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/attributions/reassign"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/attributions/reassign", {
body: {
/* paths["/v1/attributions/reassign"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/commissions/verify
Underlying REST endpoint: POST /v1/commissions/verify
Parameters
body: paths["/v1/commissions/verify"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/commissions/verify"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/commissions/verify", {
body: {
/* paths["/v1/commissions/verify"]["post"]["requestBody"]["content"]["application/json"] */
},
});PUT /v1/multi-level-config
Underlying REST endpoint: PUT /v1/multi-level-config
Parameters
body: paths["/v1/multi-level-config"]["put"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/multi-level-config"]["put"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.PUT("/v1/multi-level-config", {
body: {
/* paths["/v1/multi-level-config"]["put"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/multi-level-config/{brand_id}
Underlying REST endpoint: GET /v1/multi-level-config/\{brand_id\}
Parameters
path: paths["/v1/multi-level-config/{brand_id}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/multi-level-config/{brand_id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.GET("/v1/multi-level-config/{brand_id}", {
params: {
path: {
brand_id: "<brand_id>",
},
},
});POST /v1/payouts
Underlying REST endpoint: POST /v1/payouts
Parameters
body: paths["/v1/payouts"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/payouts"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/payouts", {
body: {
/* paths["/v1/payouts"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/payouts/{id}
Underlying REST endpoint: GET /v1/payouts/\{id\}
Parameters
path: paths["/v1/payouts/{id}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/payouts/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.GET("/v1/payouts/{id}", {
params: {
path: {
id: "<id>",
},
},
});GET /v1/public/affiliates/{user_id}
Underlying REST endpoint: GET /v1/public/affiliates/\{user_id\}
Parameters
path: paths["/v1/public/affiliates/{user_id}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/public/affiliates/{user_id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.GET("/v1/public/affiliates/{user_id}", {
params: {
path: {
user_id: "<user_id>",
},
},
});GET /v1/public/affiliates/{user_id}/landing-config
Underlying REST endpoint: GET /v1/public/affiliates/\{user_id\}/landing-config
Parameters
path: paths["/v1/public/affiliates/{user_id}/landing-config"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/public/affiliates/{user_id}/landing-config"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.GET("/v1/public/affiliates/{user_id}/landing-config", {
params: {
path: {
user_id: "<user_id>",
},
},
});POST /v1/referrals/enroll
Underlying REST endpoint: POST /v1/referrals/enroll
Parameters
body?: paths["/v1/referrals/enroll"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/referrals/enroll"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/referrals/enroll", {
body: {
/* paths["/v1/referrals/enroll"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/referrals/invites
Underlying REST endpoint: GET /v1/referrals/invites
Parameters
None
Return type
Promise<{
data?: paths["/v1/referrals/invites"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.GET("/v1/referrals/invites");GET /v1/referrals/summary
Underlying REST endpoint: GET /v1/referrals/summary
Parameters
None
Return type
Promise<{
data?: paths["/v1/referrals/summary"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.GET("/v1/referrals/summary");POST /v1/reversals
Underlying REST endpoint: POST /v1/reversals
Parameters
body: paths["/v1/reversals"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/reversals"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.POST("/v1/reversals", {
body: {
/* paths["/v1/reversals"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/tiers/{brand_id}
Underlying REST endpoint: GET /v1/tiers/\{brand_id\}
Parameters
path: paths["/v1/tiers/{brand_id}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/tiers/{brand_id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await affiliates.GET("/v1/tiers/{brand_id}", {
params: {
path: {
brand_id: "<brand_id>",
},
},
});