Skip to content

Latest commit

 

History

History
249 lines (175 loc) · 17.7 KB

README.md

File metadata and controls

249 lines (175 loc) · 17.7 KB
Raw

Keys

(keys)

Overview

Available Operations

  • create - Create a new API key for a company
  • list - List all active API keys for a client
  • get - Retrieve a single API key

create

Create a new API key for a company.

Example Usage

import { Pushpress } from "pushpress";

const pushpress = new Pushpress({
  apiKey: process.env["PUSHPRESS_API_KEY"] ?? "",
});

async function run() {
  await pushpress.keys.create({
    company: "Nienow Inc",
  });


}

run();

Standalone function

The standalone function version of this method:

import { PushpressCore } from "pushpress/core.js";
import { keysCreate } from "pushpress/funcs/keysCreate.js";

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

async function run() {
  const res = await keysCreate(pushpress, {
    company: "Nienow Inc",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  
}

run();

Parameters

Parameter Type Required Description
request operations.CreateApiKeyRequestBody ✔️ 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.Unauthorized 401, 403, 407, 511 application/json
errors.NotFound 404, 501, 505 application/json
errors.Timeout 408, 504 application/json
errors.BadRequest 413, 414, 415, 422, 431, 510 application/json
errors.RateLimited 429 application/json
errors.InternalServerError 500, 502, 503, 506, 507, 508 application/json
errors.APIError 4XX, 5XX */*

list

List all active API keys for a client.

Example Usage

import { Pushpress } from "pushpress";

const pushpress = new Pushpress({
  apiKey: process.env["PUSHPRESS_API_KEY"] ?? "",
});

async function run() {
  const result = await pushpress.keys.list();

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { PushpressCore } from "pushpress/core.js";
import { keysList } from "pushpress/funcs/keysList.js";

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

async function run() {
  const res = await keysList(pushpress);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter Type Required Description
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.ApiKey>

Errors

Error Type Status Code Content Type
errors.Unauthorized 401, 403, 407, 511 application/json
errors.NotFound 404, 501, 505 application/json
errors.Timeout 408, 504 application/json
errors.BadRequest 413, 414, 415, 422, 431, 510 application/json
errors.RateLimited 429 application/json
errors.InternalServerError 500, 502, 503, 506, 507, 508 application/json
errors.APIError 4XX, 5XX */*

get

Retrieve a single API key.

Example Usage

import { Pushpress } from "pushpress";

const pushpress = new Pushpress({
  apiKey: process.env["PUSHPRESS_API_KEY"] ?? "",
});

async function run() {
  const result = await pushpress.keys.get({
    keyId: "<id>",
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { PushpressCore } from "pushpress/core.js";
import { keysGet } from "pushpress/funcs/keysGet.js";

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

async function run() {
  const res = await keysGet(pushpress, {
    keyId: "<id>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter Type Required Description
request operations.GetApiKeyRequest ✔️ 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.ApiKey>

Errors

Error Type Status Code Content Type
errors.BadRequest 400, 413, 414, 415, 422, 431, 510 application/json
errors.Unauthorized 401, 403, 407, 511 application/json
errors.NotFound 404, 501, 505 application/json
errors.Timeout 408, 504 application/json
errors.RateLimited 429 application/json
errors.InternalServerError 500, 502, 503, 506, 507, 508 application/json
errors.APIError 4XX, 5XX */*