Skip to main content
REST client

Paywalls

The 6 operations under paywalls, as typed calls on the generated REST client.

1 min read
View MarkdownEdit on GitHub

Available from @codespar/sdk 0.12.0; the version on npm is 0.16.18. When these docs build, the examples on this page are compiled against @codespar/sdk 0.16.18, the version this site installs: a call that does not type-check against it 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 {  } from "@codespar/sdk";

const  = new ({ : .. });

GET /v1/paywalls

List paywalls

const  = await ..("/v1/paywalls");

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

POST /v1/paywalls

Create a paywall

const  = await ..("post", "/v1/paywalls", {
  : {
    : "example",
    : "Example",
    : "https://example.com/hook",
    : "string",
    : "BRL",
    : "csm_0000000000000000",
    : "string",
    : "string",
    : [
      "string"
    ],
    : "string",
    : [
      {
        : 0,
        : "string"
      }
    ],
    : "https://example.com/hook",
    : {
      : "string",
      : "string",
      : 1,
      : 1,
      : "string"
    },
    : {
      : "byo",
      : "string"
    }
  }
});
// 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 (.) {
  .(.);
}

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

GET /v1/paywalls/{id}

Read one paywall

const  = await ..("/v1/paywalls/{id}", {
  : {
    : "paywall_0000000000000000"
  }
});

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

PATCH /v1/paywalls/{id}

Update a paywall

const  = await ..("patch", "/v1/paywalls/{id}", {
  : {
    : "paywall_0000000000000000"
  },
  : {
    : "Example",
    : "https://example.com/hook",
    : "string",
    : true
  }
});
// 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 (.) {
  .(.);
}

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

DELETE /v1/paywalls/{id}

Delete a paywall

const  = await ..("delete", "/v1/paywalls/{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 (.) {
  .(.);
}

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

GET /v1/paywalls/{id}/stats

Earnings for one paywall

const  = await ..("/v1/paywalls/{id}/stats", {
  : {
    : "paywall_0000000000000000"
  }
});

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

Paywalls | CodeSpar