Skip to main content
REST client

Account Applications

The 2 operations under account-applications, 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 ({ : .. });

POST /v1/account-applications

Open a consumer account application

const  = await ..("post", "/v1/account-applications", {
  : {
    : {},
    : "csm_0000000000000000",
    : [
      "string"
    ]
  }
});
// r.status is one of the documented statuses (200, 403, 422),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
  .(.);
}

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

GET /v1/account-applications/{id}

Read the status of a consumer account application

const  = await ..("get", "/v1/account-applications/{id}", {
  : {
    : "accountapplication_0000000000000000"
  },
  : {
    : "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: GET /v1/account-applications/{id} in the HTTP reference.

Account Applications | CodeSpar