Skip to content

Latest commit

 

History

History
384 lines (270 loc) · 17.9 KB

README.md

File metadata and controls

384 lines (270 loc) · 17.9 KB
Raw

Groups

(groups)

Available Operations

addGroupMembers

Add group members

Example Usage

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

async function run() {
  const sdk = new SDK();
const id: number = 985975;
const requestBody: AddGroupMembersRequestBody = {
  usernames: "username1,username2",
};

  const res = await sdk.groups.addGroupMembers(id, requestBody);

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

run();

Parameters

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

Response

Promise<operations.AddGroupMembersResponse>

Errors

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

createGroup

Create a group

Example Usage

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

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

  const res = await sdk.groups.createGroup({
    group: {
      mutedCategoryIds: [
        385163,
      ],
      name: "<value>",
      regularCategoryIds: [
        723588,
      ],
      trackingCategoryIds: [
        835377,
      ],
      watchingCategoryIds: [
        370420,
      ],
      watchingFirstPostCategoryIds: [
        831661,
      ],
    },
  });

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

run();

Parameters

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

Response

Promise<operations.CreateGroupResponse>

Errors

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

deleteGroup

Delete a group

Example Usage

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

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

  const res = await sdk.groups.deleteGroup(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.DeleteGroupResponse>

Errors

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

getGroup

Get a group

Example Usage

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

async function run() {
  const sdk = new SDK();
const id: string = "<value>";

  const res = await sdk.groups.getGroup(id);

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

run();

Parameters

Parameter Type Required Description
id string ✔️ Use group name instead of id
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.GetGroupResponse>

Errors

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

listGroupMembers

List group members

Example Usage

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

async function run() {
  const sdk = new SDK();
const id: string = "<value>";

  const res = await sdk.groups.listGroupMembers(id);

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

run();

Parameters

Parameter Type Required Description
id string ✔️ Use group name instead of id
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.ListGroupMembersResponse>

Errors

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

listGroups

List groups

Example Usage

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

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

  const res = await sdk.groups.listGroups();

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

run();

Parameters

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

Response

Promise<operations.ListGroupsResponse>

Errors

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

removeGroupMembers

Remove group members

Example Usage

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

async function run() {
  const sdk = new SDK();
const id: number = 649523;
const requestBody: RemoveGroupMembersRequestBody = {
  usernames: "username1,username2",
};

  const res = await sdk.groups.removeGroupMembers(id, requestBody);

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

run();

Parameters

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

Response

Promise<operations.RemoveGroupMembersResponse>

Errors

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

updateGroup

Update a group

Example Usage

import { SDK } from "@lukehagar/discoursejs";
import { UpdateGroupGroup, UpdateGroupRequest, UpdateGroupRequestBody } from "@lukehagar/discoursejs/dist/sdk/models/operations";

async function run() {
  const sdk = new SDK();
const id: number = 438471;
const requestBody: UpdateGroupRequestBody = {
  group: {
    mutedCategoryIds: [
      244551,
    ],
    name: "<value>",
    regularCategoryIds: [
      750192,
    ],
    trackingCategoryIds: [
      733973,
    ],
    watchingCategoryIds: [
      485153,
    ],
    watchingFirstPostCategoryIds: [
      710652,
    ],
  },
};

  const res = await sdk.groups.updateGroup(id, requestBody);

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

run();

Parameters

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

Response

Promise<operations.UpdateGroupResponse>

Errors

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