Paywalls

Available from @codespar/sdk 0.12.0; the version on npm is 0.12.0. Every example on this page is compiled against the installed package when these docs build: a call that does not type-check fails the build.

Every call below is cs.api reaching one operation of the OpenAPI document this page was generated from; the REST client overview explains request, response, the option bag and the errors. The values are placeholders shaped by the document.

import { CodeSpar } from "@codespar/sdk";

const cs = new CodeSpar({ apiKey: process.env.CODESPAR_API_KEY });

GET /v1/paywalls

List paywalls

const result = await cs.api.get("/v1/paywalls");

Parameters, body and every documented response: GET /v1/paywalls in the HTTP reference.

GET /v1/paywalls/{id}

Read one paywall

const result = await cs.api.get("/v1/paywalls/{id}", {
  path: {
    id: "paywall_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/paywalls/{id} in the HTTP reference.

DELETE /v1/paywalls/{id}

Delete a paywall

const r = await cs.api.response("delete", "/v1/paywalls/{id}", {
  path: {
    id: "paywall_0000000000000000"
  }
});
// r.status is one of the documented statuses (200, 403),
// each with its own body shape in r.data; nothing here throws on 403.
if (r.ok) {
  console.log(r.data);
}

Parameters, body and every documented response: DELETE /v1/paywalls/{id} in the HTTP reference.

GET /v1/paywalls/{id}/stats

Earnings for one paywall

const result = await cs.api.get("/v1/paywalls/{id}/stats", {
  path: {
    id: "paywall_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/paywalls/{id}/stats in the HTTP reference.