discoursejs/docs/sdks/badges

Badges

(badges)

Available Operations

• adminListBadges - List badges
• createBadge - Create badge
• deleteBadge - Delete badge
• listUserBadges - List badges for a user
• updateBadge - Update badge

adminListBadges

List badges

Example Usage

import { SDK } from "@lukehagar/discoursejs";

async function run() {
  const sdk = new SDK();

  const res = await sdk.badges.adminListBadges();

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter	Type	Required	Description
config	AxiosRequestConfig	➖	Available config options for making requests.

Response

Promise<operations.AdminListBadgesResponse>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/

createBadge

Create badge

Example Usage

import { SDK } from "@lukehagar/discoursejs";

async function run() {
  const sdk = new SDK();

  const res = await sdk.badges.createBadge({
    badgeTypeId: 190613,
    name: "string",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.CreateBadgeRequestBody	✔️	The request object to use for the request.
config	AxiosRequestConfig	➖	Available config options for making requests.

Response

Promise<operations.CreateBadgeResponse>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/

deleteBadge

Delete badge

Example Usage

import { SDK } from "@lukehagar/discoursejs";
import { DeleteBadgeRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";

async function run() {
  const sdk = new SDK();
const id: number = 32345;

  const res = await sdk.badges.deleteBadge(id);

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter	Type	Required	Description
id	number	✔️	N/A
config	AxiosRequestConfig	➖	Available config options for making requests.

Response

Promise<operations.DeleteBadgeResponse>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/

listUserBadges

List badges for a user

Example Usage

import { SDK } from "@lukehagar/discoursejs";
import { ListUserBadgesRequest } from "@lukehagar/discoursejs/dist/sdk/models/operations";

async function run() {
  const sdk = new SDK();
const username: string = "string";

  const res = await sdk.badges.listUserBadges(username);

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter	Type	Required	Description
username	string	✔️	N/A
config	AxiosRequestConfig	➖	Available config options for making requests.

Response

Promise<operations.ListUserBadgesResponse>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/

updateBadge

Update badge

Example Usage

import { SDK } from "@lukehagar/discoursejs";
import { UpdateBadgeRequest, UpdateBadgeRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";

async function run() {
  const sdk = new SDK();
const id: number = 280628;
const requestBody: UpdateBadgeRequestBody = {
  badgeTypeId: 568845,
  name: "string",
};

  const res = await sdk.badges.updateBadge(id, requestBody);

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter	Type	Required	Description
id	number	✔️	N/A
requestBody	operations.UpdateBadgeRequestBody	➖	N/A
config	AxiosRequestConfig	➖	Available config options for making requests.

Response

Promise<operations.UpdateBadgeResponse>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/