Benefits

Overview

Available Operations

list - List Benefits
create - Create Benefit
get - Get Benefit
delete - Delete Benefit
update - Update Benefit
grants - List Benefit Grants

list

List benefits.

Scopes: benefits:read benefits:write

Example Usage

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.benefits.list({
    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

Standalone function

The standalone function version of this method:

import { PolarCore } from "@polar-sh/sdk/core.js";
import { benefitsList } from "@polar-sh/sdk/funcs/benefitsList.js";

// Use `PolarCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const polar = new PolarCore({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const res = await benefitsList(polar, {
    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  });
  if (res.ok) {
    const { value: result } = res;
    for await (const page of result) {
    console.log(page);
  }
  } else {
    console.log("benefitsList failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.BenefitsListRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.BenefitsListResponse>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.SDKError	4XX, 5XX	/

create

Create a benefit.

Scopes: benefits:write

Example Usage

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.benefits.create({
    type: "license_keys",
    description: "mature emergent at outside arrogantly gadzooks zealous equatorial notwithstanding",
    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    properties: {},
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { PolarCore } from "@polar-sh/sdk/core.js";
import { benefitsCreate } from "@polar-sh/sdk/funcs/benefitsCreate.js";

// Use `PolarCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const polar = new PolarCore({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const res = await benefitsCreate(polar, {
    type: "license_keys",
    description: "mature emergent at outside arrogantly gadzooks zealous equatorial notwithstanding",
    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    properties: {},
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("benefitsCreate failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	components.BenefitCreate	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.Benefit>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.SDKError	4XX, 5XX	/

get

Get a benefit by ID.

Scopes: benefits:read benefits:write

Example Usage

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.benefits.get({
    id: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { PolarCore } from "@polar-sh/sdk/core.js";
import { benefitsGet } from "@polar-sh/sdk/funcs/benefitsGet.js";

// Use `PolarCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const polar = new PolarCore({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const res = await benefitsGet(polar, {
    id: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("benefitsGet failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.BenefitsGetRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.Benefit>

Errors

Error Type	Status Code	Content Type
errors.ResourceNotFound	404	application/json
errors.HTTPValidationError	422	application/json
errors.SDKError	4XX, 5XX	/

delete

Delete a benefit.

Warning

Every grants associated with the benefit will be revoked. Users will lose access to the benefit.

Scopes: benefits:write

Example Usage

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  await polar.benefits.delete({
    id: "<value>",
  });


}

run();

Standalone function

The standalone function version of this method:

import { PolarCore } from "@polar-sh/sdk/core.js";
import { benefitsDelete } from "@polar-sh/sdk/funcs/benefitsDelete.js";

// Use `PolarCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const polar = new PolarCore({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const res = await benefitsDelete(polar, {
    id: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    
  } else {
    console.log("benefitsDelete failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.BenefitsDeleteRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type	Status Code	Content Type
errors.NotPermitted	403	application/json
errors.ResourceNotFound	404	application/json
errors.HTTPValidationError	422	application/json
errors.SDKError	4XX, 5XX	/

update

Update a benefit.

Scopes: benefits:write

Example Usage

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.benefits.update({
    id: "<value>",
    requestBody: {
      type: "custom",
    },
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { PolarCore } from "@polar-sh/sdk/core.js";
import { benefitsUpdate } from "@polar-sh/sdk/funcs/benefitsUpdate.js";

// Use `PolarCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const polar = new PolarCore({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const res = await benefitsUpdate(polar, {
    id: "<value>",
    requestBody: {
      type: "custom",
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("benefitsUpdate failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.BenefitsUpdateRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.Benefit>

Errors

Error Type	Status Code	Content Type
errors.ResourceNotFound	404	application/json
errors.HTTPValidationError	422	application/json
errors.SDKError	4XX, 5XX	/

grants

List the individual grants for a benefit.

It's especially useful to check if a user has been granted a benefit.

Scopes: benefits:read benefits:write

Example Usage

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.benefits.grants({
    id: "<value>",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

Standalone function

The standalone function version of this method:

import { PolarCore } from "@polar-sh/sdk/core.js";
import { benefitsGrants } from "@polar-sh/sdk/funcs/benefitsGrants.js";

// Use `PolarCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const polar = new PolarCore({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const res = await benefitsGrants(polar, {
    id: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    for await (const page of result) {
    console.log(page);
  }
  } else {
    console.log("benefitsGrants failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.BenefitsGrantsRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.BenefitsGrantsResponse>

Errors

Error Type	Status Code	Content Type
errors.ResourceNotFound	404	application/json
errors.HTTPValidationError	422	application/json
errors.SDKError	4XX, 5XX	/

Uh oh!

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Benefits

Overview

Available Operations

list

Example Usage

Standalone function

Parameters

Response

Errors

create

Example Usage

Standalone function

Parameters

Response

Errors

get

Example Usage

Standalone function

Parameters

Response

Errors

delete

Example Usage

Standalone function

Parameters

Response

Errors

update

Example Usage

Standalone function

Parameters

Response

Errors

grants

Example Usage

Standalone function

Parameters

Response

Errors