LukeParke/discoursejs
1
0
Fork 0
mirror of https://github.com/LukeHagar/discoursejs.git synced 2025-12-06 04:19:37 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
54184e1bdebfd5843273eb3a30117a3c57dab575
discoursejs/README.md

16 KiB
Raw Blame History

@lukehagar/discoursejs

SDK Installation

NPM

npm add @lukehagar/discoursejs

Yarn

yarn add @lukehagar/discoursejs

SDK Example Usage

Example

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

async function run() {
    const sdk = new SDK({
        security: {
            key: "<YOUR_API_KEY_HERE>",
            username: "<YOUR_API_KEY_HERE>",
        },
    });

    const res = await sdk.backups.createBackup({
        withUploads: false,
    });

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

run();

Available Resources and Operations

backups

badges

groups

users

admin

categories

invites

topics

notifications

posts

privateMessages

search

site

tags

uploads

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.

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

Example

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

async function run() {
    const sdk = new SDK({
        security: {
            key: "<YOUR_API_KEY_HERE>",
            username: "<YOUR_API_KEY_HERE>",
        },
    });

    let res;
    try {
        res = await sdk.backups.createBackup({
            withUploads: false,
        });
    } catch (err) {
        if (err instanceof errors.SDKError) {
            console.error(err); // handle exception
            throw err;
        }
    }

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

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Variables
0 https://{defaultHost} defaultHost (default is discourse.example.com)

Example

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

async function run() {
    const sdk = new SDK({
        serverIdx: 0,
        security: {
            key: "<YOUR_API_KEY_HERE>",
            username: "<YOUR_API_KEY_HERE>",
        },
    });

    const res = await sdk.backups.createBackup({
        withUploads: false,
    });

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

run();

Variables

Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:

  • defaultHost: string

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: str optional parameter when initializing the SDK client instance. For example:

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

async function run() {
    const sdk = new SDK({
        serverURL: "https://{defaultHost}",
        security: {
            key: "<YOUR_API_KEY_HERE>",
            username: "<YOUR_API_KEY_HERE>",
        },
    });

    const res = await sdk.backups.createBackup({
        withUploads: false,
    });

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

run();

Custom HTTP Client

The Typescript SDK makes API calls using the axios HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom AxiosInstance object.

For example, you could specify a header for every request that your sdk makes as follows:

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

const httpClient = axios.create({
    headers: {'x-custom-header': 'someValue'}
})

const sdk = new SDK({defaultClient: httpClient});

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

Name Type Scheme
key apiKey API key
username apiKey API key

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

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

async function run() {
    const sdk = new SDK({
        security: {
            key: "<YOUR_API_KEY_HERE>",
            username: "<YOUR_API_KEY_HERE>",
        },
    });

    const res = await sdk.backups.createBackup({
        withUploads: false,
    });

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

run();

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy