Status Client API

Generated file warning: this page is generated by packages/schema/scripts/gen-client-reference-docs.ts. Do not edit generated method content by hand.

This page documents 6 schema-registry client methods in the status namespace.

deleteAllStatusInsiders

Delete all statuses

Overview

Prop	Value
Namespace	`status`
Action	`delete`
Functionality	`both`
Positional parameter order	-
Aliases	`deleteAllStatuses`, `status.deleteAll`
Deprecated aliases	-
License	`insiders`
WAPI override	-
Deprecated	No

Routes

Type	Method	Path	Name	Status
Primary	`DELETE`	`/api/status/deleteAll`	`deleteAllStatus`	Active
Alias	`DELETE`	`/api/deleteAllStatus`	`deleteAllStatus`	Active
Alias	`DELETE`	`/api/deleteAllStatuses`	`deleteAllStatuses`	Active

Usage

const result = await client.deleteAllStatus({});

const result = await client.status.deleteAll({});

curl -X DELETE "http://localhost:8080/api/status/deleteAll" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{}'

Parameters

This method does not define input parameters.

Output

Prop	Value
Return type	`unknown`

deleteStatusInsiders

Delete status

Overview

Prop	Value
Namespace	`status`
Action	`delete`
Functionality	`both`
Positional parameter order	`statusesToDelete`
Aliases	`status.delete`
Deprecated aliases	-
License	`insiders`
WAPI override	-
Deprecated	No

Routes

Type	Method	Path	Name	Status
Primary	`DELETE`	`/api/status/delete`	`deleteStatus`	Active
Alias	`DELETE`	`/api/deleteStatus`	`deleteStatus`	Active

Usage

const result = await client.deleteStatus({
  statusesToDelete: [],
});

const result = await client.status.delete({
  statusesToDelete: [],
});

curl -X DELETE "http://localhost:8080/api/status/delete" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "statusesToDelete": []
  }'

Parameters

Prop

Type

Output

Prop	Value
Return type	`unknown`

getStoriesInsiders

Get all stories

Overview

Prop	Value
Namespace	`status`
Action	`read`
Functionality	`both`
Positional parameter order	-
Aliases	`getStatuses`, `status.get`, `status.getAll`, `status.getStories`
Deprecated aliases	-
License	`insiders`
WAPI override	-
Deprecated	No

Routes

Type	Method	Path	Name	Status
Primary	`GET`	`/api/status/getAll`	`getStories`	Active
Alias	`GET`	`/api/getStatuses`	`getStatuses`	Active
Alias	`GET`	`/api/getStories`	`getStories`	Active
Alias	`GET`	`/api/status/get`	`status.get`	Active
Alias	`GET`	`/api/status/getStories`	`status.getStories`	Active

Usage

const result = await client.getStories({});

const result = await client.status.getAll({});

curl -X GET "http://localhost:8080/api/status/getAll" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{}'

Parameters

This method does not define input parameters.

Output

Prop	Value
Return type	`unknown[]`

postImageStatusInsiders

Post image status

Overview

Prop	Value
Namespace	`status`
Action	`send`
Functionality	`both`
Positional parameter order	`image`, `caption`
Aliases	`status.postImage`
Deprecated aliases	-
License	`insiders`
WAPI override	-
Deprecated	No

Routes

Type	Method	Path	Name	Status
Primary	`POST`	`/api/status/postImage`	`postImageStatus`	Active
Alias	`POST`	`/api/postImageStatus`	`postImageStatus`	Active

Usage

const result = await client.postImageStatus({
  image: "image",
  caption: "caption",
});

const result = await client.status.postImage({
  image: "image",
  caption: "caption",
});

curl -X POST "http://localhost:8080/api/status/postImage" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "image": "image",
    "caption": "caption"
  }'

Parameters

Prop

Type

Output

Prop	Value
Return type	`unknown`

postTextStatusInsiders

Post text status

Overview

Prop	Value
Namespace	`status`
Action	`send`
Functionality	`both`
Positional parameter order	`text`, `backgroundColor`, `font`
Aliases	`status.postText`
Deprecated aliases	-
License	`insiders`
WAPI override	-
Deprecated	No

Routes

Type	Method	Path	Name	Status
Primary	`POST`	`/api/status/postText`	`postTextStatus`	Active
Alias	`POST`	`/api/postTextStatus`	`postTextStatus`	Active

Usage

const result = await client.postTextStatus({
  text: "text",
  backgroundColor: "backgroundColor",
  font: 1,
});

const result = await client.status.postText({
  text: "text",
  backgroundColor: "backgroundColor",
  font: 1,
});

curl -X POST "http://localhost:8080/api/status/postText" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "text": "text",
    "backgroundColor": "backgroundColor",
    "font": 1
  }'

Parameters

Prop

Type

Output

Prop	Value
Return type	`unknown`

postVideoStatusInsiders

Post video status

Overview

Prop	Value
Namespace	`status`
Action	`send`
Functionality	`both`
Positional parameter order	`video`, `caption`
Aliases	`status.postVideo`
Deprecated aliases	-
License	`insiders`
WAPI override	-
Deprecated	No

Routes

Type	Method	Path	Name	Status
Primary	`POST`	`/api/status/postVideo`	`postVideoStatus`	Active
Alias	`POST`	`/api/postVideoStatus`	`postVideoStatus`	Active

Usage

const result = await client.postVideoStatus({
  video: "video",
  caption: "caption",
});

const result = await client.status.postVideo({
  video: "video",
  caption: "caption",
});

curl -X POST "http://localhost:8080/api/status/postVideo" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "video": "video",
    "caption": "caption"
  }'

Parameters

Prop

Type

Output

Prop	Value
Return type	`unknown`

Was this helpful?

Wally and his cute companion coffee mug are coding day and night to keep this up-to-date!

Was this helpful?

On this page