# Topics (*topics*) ## Overview ### Available Operations * [bookmarkTopic](#bookmarktopic) - Bookmark topic * [createTopicPostPM](#createtopicpostpm) - Creates a new topic, a new post, or a private message * [createTopicTimer](#createtopictimer) - Create topic timer * [getTopic](#gettopic) - Get a single topic * [getTopicByExternalId](#gettopicbyexternalid) - Get topic by external_id * [inviteToTopic](#invitetotopic) - Invite to topic * [listLatestTopics](#listlatesttopics) - Get the latest topics * [listTopTopics](#listtoptopics) - Get the top topics filtered by period * [removeTopic](#removetopic) - Remove a topic * [setNotificationLevel](#setnotificationlevel) - Set notification level * [updateTopic](#updatetopic) - Update a topic * [updateTopicStatus](#updatetopicstatus) - Update the status of a topic * [updateTopicTimestamp](#updatetopictimestamp) - Update topic timestamp ## bookmarkTopic Bookmark topic ### Example Usage ```typescript import { SDK } from "@lukehagar/discoursejs"; const sdk = new SDK(); async function run() { await sdk.topics.bookmarkTopic("", "", ""); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { SDKCore } from "@lukehagar/discoursejs/core.js"; import { topicsBookmarkTopic } from "@lukehagar/discoursejs/funcs/topicsBookmarkTopic.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const sdk = new SDKCore(); async function run() { const res = await topicsBookmarkTopic(sdk, "", "", ""); if (!res.ok) { throw res.error; } const { value: result } = res; } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `apiKey` | *string* | :heavy_check_mark: | N/A | | `apiUsername` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## createTopicPostPM Creates a new topic, a new post, or a private message ### Example Usage ```typescript import { SDK } from "@lukehagar/discoursejs"; const sdk = new SDK(); async function run() { const result = await sdk.topics.createTopicPostPM({ archetype: "private_message", raw: "", targetRecipients: "blake,sam", }); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { SDKCore } from "@lukehagar/discoursejs/core.js"; import { topicsCreateTopicPostPM } from "@lukehagar/discoursejs/funcs/topicsCreateTopicPostPM.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const sdk = new SDKCore(); async function run() { const res = await topicsCreateTopicPostPM(sdk, { archetype: "private_message", raw: "", targetRecipients: "blake,sam", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.CreateTopicPostPMRequestBody](../../sdk/models/operations/createtopicpostpmrequestbody.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.CreateTopicPostPMResponseBody](../../sdk/models/operations/createtopicpostpmresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## createTopicTimer Create topic timer ### Example Usage ```typescript import { SDK } from "@lukehagar/discoursejs"; const sdk = new SDK(); async function run() { const result = await sdk.topics.createTopicTimer("", "", "", { time: "", }); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { SDKCore } from "@lukehagar/discoursejs/core.js"; import { topicsCreateTopicTimer } from "@lukehagar/discoursejs/funcs/topicsCreateTopicTimer.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const sdk = new SDKCore(); async function run() { const res = await topicsCreateTopicTimer(sdk, "", "", "", { time: "", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `apiKey` | *string* | :heavy_check_mark: | N/A | | `apiUsername` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `requestBody` | [operations.CreateTopicTimerRequestBody](../../sdk/models/operations/createtopictimerrequestbody.md) | :heavy_minus_sign: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.CreateTopicTimerResponseBody](../../sdk/models/operations/createtopictimerresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## getTopic Get a single topic ### Example Usage ```typescript import { SDK } from "@lukehagar/discoursejs"; const sdk = new SDK(); async function run() { const result = await sdk.topics.getTopic("", "", ""); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { SDKCore } from "@lukehagar/discoursejs/core.js"; import { topicsGetTopic } from "@lukehagar/discoursejs/funcs/topicsGetTopic.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const sdk = new SDKCore(); async function run() { const res = await topicsGetTopic(sdk, "", "", ""); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `apiKey` | *string* | :heavy_check_mark: | N/A | | `apiUsername` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.GetTopicResponseBody](../../sdk/models/operations/gettopicresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## getTopicByExternalId Get topic by external_id ### Example Usage ```typescript import { SDK } from "@lukehagar/discoursejs"; const sdk = new SDK(); async function run() { await sdk.topics.getTopicByExternalId(""); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { SDKCore } from "@lukehagar/discoursejs/core.js"; import { topicsGetTopicByExternalId } from "@lukehagar/discoursejs/funcs/topicsGetTopicByExternalId.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const sdk = new SDKCore(); async function run() { const res = await topicsGetTopicByExternalId(sdk, ""); if (!res.ok) { throw res.error; } const { value: result } = res; } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `externalId` | *string* | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## inviteToTopic Invite to topic ### Example Usage ```typescript import { SDK } from "@lukehagar/discoursejs"; const sdk = new SDK(); async function run() { const result = await sdk.topics.inviteToTopic("", "", ""); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { SDKCore } from "@lukehagar/discoursejs/core.js"; import { topicsInviteToTopic } from "@lukehagar/discoursejs/funcs/topicsInviteToTopic.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const sdk = new SDKCore(); async function run() { const res = await topicsInviteToTopic(sdk, "", "", ""); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `apiKey` | *string* | :heavy_check_mark: | N/A | | `apiUsername` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `requestBody` | [operations.InviteToTopicRequestBody](../../sdk/models/operations/invitetotopicrequestbody.md) | :heavy_minus_sign: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.InviteToTopicResponseBody](../../sdk/models/operations/invitetotopicresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## listLatestTopics Get the latest topics ### Example Usage ```typescript import { SDK } from "@lukehagar/discoursejs"; const sdk = new SDK(); async function run() { const result = await sdk.topics.listLatestTopics("", ""); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { SDKCore } from "@lukehagar/discoursejs/core.js"; import { topicsListLatestTopics } from "@lukehagar/discoursejs/funcs/topicsListLatestTopics.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const sdk = new SDKCore(); async function run() { const res = await topicsListLatestTopics(sdk, "", ""); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `apiKey` | *string* | :heavy_check_mark: | N/A | | `apiUsername` | *string* | :heavy_check_mark: | N/A | | `ascending` | *string* | :heavy_minus_sign: | Defaults to `desc`, add `ascending=true` to sort asc | | `order` | *string* | :heavy_minus_sign: | Enum: `default`, `created`, `activity`, `views`, `posts`, `category`, `likes`, `op_likes`, `posters` | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.ListLatestTopicsResponseBody](../../sdk/models/operations/listlatesttopicsresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## listTopTopics Get the top topics filtered by period ### Example Usage ```typescript import { SDK } from "@lukehagar/discoursejs"; const sdk = new SDK(); async function run() { const result = await sdk.topics.listTopTopics("", ""); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { SDKCore } from "@lukehagar/discoursejs/core.js"; import { topicsListTopTopics } from "@lukehagar/discoursejs/funcs/topicsListTopTopics.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const sdk = new SDKCore(); async function run() { const res = await topicsListTopTopics(sdk, "", ""); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `apiKey` | *string* | :heavy_check_mark: | N/A | | `apiUsername` | *string* | :heavy_check_mark: | N/A | | `period` | *string* | :heavy_minus_sign: | Enum: `all`, `yearly`, `quarterly`, `monthly`, `weekly`, `daily` | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.ListTopTopicsResponseBody](../../sdk/models/operations/listtoptopicsresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## removeTopic Remove a topic ### Example Usage ```typescript import { SDK } from "@lukehagar/discoursejs"; const sdk = new SDK(); async function run() { await sdk.topics.removeTopic("", "", ""); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { SDKCore } from "@lukehagar/discoursejs/core.js"; import { topicsRemoveTopic } from "@lukehagar/discoursejs/funcs/topicsRemoveTopic.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const sdk = new SDKCore(); async function run() { const res = await topicsRemoveTopic(sdk, "", "", ""); if (!res.ok) { throw res.error; } const { value: result } = res; } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `apiKey` | *string* | :heavy_check_mark: | N/A | | `apiUsername` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## setNotificationLevel Set notification level ### Example Usage ```typescript import { SDK } from "@lukehagar/discoursejs"; const sdk = new SDK(); async function run() { const result = await sdk.topics.setNotificationLevel("", "", ""); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { SDKCore } from "@lukehagar/discoursejs/core.js"; import { topicsSetNotificationLevel } from "@lukehagar/discoursejs/funcs/topicsSetNotificationLevel.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const sdk = new SDKCore(); async function run() { const res = await topicsSetNotificationLevel(sdk, "", "", ""); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `apiKey` | *string* | :heavy_check_mark: | N/A | | `apiUsername` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `requestBody` | [operations.SetNotificationLevelRequestBody](../../sdk/models/operations/setnotificationlevelrequestbody.md) | :heavy_minus_sign: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.SetNotificationLevelResponseBody](../../sdk/models/operations/setnotificationlevelresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## updateTopic Update a topic ### Example Usage ```typescript import { SDK } from "@lukehagar/discoursejs"; const sdk = new SDK(); async function run() { const result = await sdk.topics.updateTopic("", "", ""); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { SDKCore } from "@lukehagar/discoursejs/core.js"; import { topicsUpdateTopic } from "@lukehagar/discoursejs/funcs/topicsUpdateTopic.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const sdk = new SDKCore(); async function run() { const res = await topicsUpdateTopic(sdk, "", "", ""); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `apiKey` | *string* | :heavy_check_mark: | N/A | | `apiUsername` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `requestBody` | [operations.UpdateTopicRequestBody](../../sdk/models/operations/updatetopicrequestbody.md) | :heavy_minus_sign: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.UpdateTopicResponseBody](../../sdk/models/operations/updatetopicresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## updateTopicStatus Update the status of a topic ### Example Usage ```typescript import { SDK } from "@lukehagar/discoursejs"; const sdk = new SDK(); async function run() { const result = await sdk.topics.updateTopicStatus("", "", "", { enabled: "false", status: "pinned_globally", until: "2030-12-31", }); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { SDKCore } from "@lukehagar/discoursejs/core.js"; import { topicsUpdateTopicStatus } from "@lukehagar/discoursejs/funcs/topicsUpdateTopicStatus.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const sdk = new SDKCore(); async function run() { const res = await topicsUpdateTopicStatus(sdk, "", "", "", { enabled: "false", status: "pinned_globally", until: "2030-12-31", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `apiKey` | *string* | :heavy_check_mark: | N/A | | `apiUsername` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `requestBody` | [operations.UpdateTopicStatusRequestBody](../../sdk/models/operations/updatetopicstatusrequestbody.md) | :heavy_minus_sign: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.UpdateTopicStatusResponseBody](../../sdk/models/operations/updatetopicstatusresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## updateTopicTimestamp Update topic timestamp ### Example Usage ```typescript import { SDK } from "@lukehagar/discoursejs"; const sdk = new SDK(); async function run() { const result = await sdk.topics.updateTopicTimestamp("", "", "", { timestamp: "1594291380", }); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { SDKCore } from "@lukehagar/discoursejs/core.js"; import { topicsUpdateTopicTimestamp } from "@lukehagar/discoursejs/funcs/topicsUpdateTopicTimestamp.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const sdk = new SDKCore(); async function run() { const res = await topicsUpdateTopicTimestamp(sdk, "", "", "", { timestamp: "1594291380", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `apiKey` | *string* | :heavy_check_mark: | N/A | | `apiUsername` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `requestBody` | [operations.UpdateTopicTimestampRequestBody](../../sdk/models/operations/updatetopictimestamprequestbody.md) | :heavy_minus_sign: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.UpdateTopicTimestampResponseBody](../../sdk/models/operations/updatetopictimestampresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* |