discoursejs/docs/sdks/users/README.md

Users

(users)

Available Operations

• activateUser - Activate a user
• adminGetUser - Get a user by id
• adminListUsers - Get a list of users
• anonymizeUser - Anonymize a user
• changePassword - Change password
• createUser - Creates a user
• deactivateUser - Deactivate a user
• deleteUser - Delete a user
• getUser - Get a single user by username
• getUserEmails - Get email addresses belonging to a user
• getUserExternalId - Get a user by external_id
• getUserIdentiyProviderExternalId - Get a user by identity provider external ID
• listUserActions - Get a list of user actions
• listUserBadges - List badges for a user
• listUsersPublic - Get a public list of users
• logOutUser - Log a user out
• refreshGravatar - Refresh gravatar
• sendPasswordResetEmail - Send password reset email
• silenceUser - Silence a user
• suspendUser - Suspend a user
• updateAvatar - Update avatar
• updateEmail - Update email
• updateUser - Update a user
• updateUsername - Update username

activateUser

Activate a user

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.activateUser(203554);

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

run();

Parameters

Parameter	Type	Required	Description
id	number	✔️	N/A
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<operations.ActivateUserResponseBody>

Errors

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

adminGetUser

Get a user by id

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.adminGetUser(386776);

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

run();

Parameters

Parameter	Type	Required	Description
id	number	✔️	N/A
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<operations.AdminGetUserResponseBody>

Errors

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

adminListUsers

Get a list of users

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.adminListUsers({
    flag: "new",
  });

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

run();

Parameters

Parameter	Type	Required	Description
request	operations.AdminListUsersRequest	✔️	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<operations.AdminListUsersResponseBody[]>

Errors

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

anonymizeUser

Anonymize a user

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.anonymizeUser(418778);

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

run();

Parameters

Parameter	Type	Required	Description
id	number	✔️	N/A
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<operations.AnonymizeUserResponseBody>

Errors

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

changePassword

Change password

Example Usage

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

const sdk = new SDK();

async function run() {
  await sdk.users.changePassword("<value>");

  
}

run();

Parameters

Parameter	Type	Required	Description
token	string	✔️	N/A
requestBody	operations.ChangePasswordRequestBody	➖	N/A
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 Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/

createUser

Creates a user

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.createUser("<value>", "<value>");

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

run();

Parameters

Parameter	Type	Required	Description
apiKey	string	✔️	N/A
apiUsername	string	✔️	N/A
requestBody	operations.CreateUserRequestBody	➖	N/A
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<operations.CreateUserResponseBody>

Errors

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

deactivateUser

Deactivate a user

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.deactivateUser(143950);

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

run();

Parameters

Parameter	Type	Required	Description
id	number	✔️	N/A
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<operations.DeactivateUserResponseBody>

Errors

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

deleteUser

Delete a user

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.deleteUser(251343);

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

run();

Parameters

Parameter	Type	Required	Description
id	number	✔️	N/A
requestBody	operations.DeleteUserRequestBody	➖	N/A
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<operations.DeleteUserResponseBody>

Errors

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

getUser

Get a single user by username

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.getUser("<value>", "<value>", "<value>");

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

run();

Parameters

Parameter	Type	Required	Description
apiKey	string	✔️	N/A
apiUsername	string	✔️	N/A
username	string	✔️	N/A
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<operations.GetUserResponseBody>

Errors

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

getUserEmails

Get email addresses belonging to a user

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.getUserEmails("<value>");

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

run();

Parameters

Parameter	Type	Required	Description
username	string	✔️	N/A
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<operations.GetUserEmailsResponseBody>

Errors

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

getUserExternalId

Get a user by external_id

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.getUserExternalId("<value>", "<value>", "<value>");

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

run();

Parameters

Parameter	Type	Required	Description
apiKey	string	✔️	N/A
apiUsername	string	✔️	N/A
externalId	string	✔️	N/A
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<operations.GetUserExternalIdResponseBody>

Errors

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

getUserIdentiyProviderExternalId

Get a user by identity provider external ID

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.getUserIdentiyProviderExternalId("<value>", "<value>", "<value>", "<value>");

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

run();

Parameters

Parameter	Type	Required	Description
apiKey	string	✔️	N/A
apiUsername	string	✔️	N/A
externalId	string	✔️	N/A
provider	string	✔️	Authentication provider name. Can be found in the provider callback URL: /auth/{provider}/callback
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<operations.GetUserIdentiyProviderExternalIdResponseBody>

Errors

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

listUserActions

Get a list of user actions

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.listUserActions("<value>", 620550, "<value>");

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

run();

Parameters

Parameter	Type	Required	Description
filter	string	✔️	N/A
offset	number	✔️	N/A
username	string	✔️	N/A
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<operations.ListUserActionsResponseBody>

Errors

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

listUserBadges

List badges for a user

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.listUserBadges("<value>");

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

run();

Parameters

Parameter	Type	Required	Description
username	string	✔️	N/A
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<operations.ListUserBadgesResponseBody>

Errors

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

listUsersPublic

Get a public list of users

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.listUsersPublic("topic_count", "monthly");

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

run();

Parameters

Parameter	Type	Required	Description
order	operations.Order	✔️	N/A
period	operations.Period	✔️	N/A
asc	operations.Asc	➖	N/A
page	number	➖	N/A
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<operations.ListUsersPublicResponseBody>

Errors

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

logOutUser

Log a user out

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.logOutUser(379568);

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

run();

Parameters

Parameter	Type	Required	Description
id	number	✔️	N/A
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<operations.LogOutUserResponseBody>

Errors

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

refreshGravatar

Refresh gravatar

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.refreshGravatar("<value>");

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

run();

Parameters

Parameter	Type	Required	Description
username	string	✔️	N/A
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<operations.RefreshGravatarResponseBody>

Errors

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

sendPasswordResetEmail

Send password reset email

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.sendPasswordResetEmail();

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

run();

Parameters

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

Errors

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

silenceUser

Silence a user

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.silenceUser(606247, {
    postAction: "delete",
    silencedTill: "2022-06-01T08:00:00.000Z",
  });

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

run();

Parameters

Parameter	Type	Required	Description
id	number	✔️	N/A
requestBody	operations.SilenceUserRequestBody	➖	N/A
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<operations.SilenceUserResponseBody>

Errors

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

suspendUser

Suspend a user

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.suspendUser(970832, {
    postAction: "delete",
    reason: "<value>",
    suspendUntil: "2121-02-22",
  });

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

run();

Parameters

Parameter	Type	Required	Description
id	number	✔️	N/A
requestBody	operations.SuspendUserRequestBody	➖	N/A
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<operations.SuspendUserResponseBody>

Errors

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

updateAvatar

Update avatar

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.updateAvatar("<value>");

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

run();

Parameters

Parameter	Type	Required	Description
username	string	✔️	N/A
requestBody	operations.UpdateAvatarRequestBody	➖	N/A
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<operations.UpdateAvatarResponseBody>

Errors

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

updateEmail

Update email

Example Usage

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

const sdk = new SDK();

async function run() {
  await sdk.users.updateEmail("<value>");

  
}

run();

Parameters

Parameter	Type	Required	Description
username	string	✔️	N/A
requestBody	operations.UpdateEmailRequestBody	➖	N/A
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 Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/

updateUser

Update a user

Example Usage

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

const sdk = new SDK();

async function run() {
  const result = await sdk.users.updateUser("<value>", "<value>", "<value>");

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

run();

Parameters

Parameter	Type	Required	Description
apiKey	string	✔️	N/A
apiUsername	string	✔️	N/A
username	string	✔️	N/A
requestBody	operations.UpdateUserRequestBody	➖	N/A
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<operations.UpdateUserResponseBody>

Errors

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

updateUsername

Update username

Example Usage

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

const sdk = new SDK();

async function run() {
  await sdk.users.updateUsername("<value>");

  
}

run();

Parameters

Parameter	Type	Required	Description
username	string	✔️	N/A
requestBody	operations.UpdateUsernameRequestBody	➖	N/A
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 Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/