Skip to content

feat(client): add webhook secret argument #143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stainless-app merged 1 commit into from
Mar 27, 2024
Merged

feat(client): add webhook secret argument #143

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ export interface ClientOptions {
*/
apiKey?: string | undefined;

/**
* Defaults to process.env['ORB_WEBHOOK_SECRET'].
*/
webhookSecret?: string | null | undefined;

/**
* Override the default base URL for the API, e.g., "https://api.example.com/v2/"
*
Expand Down Expand Up @@ -74,13 +79,15 @@ export interface ClientOptions {
/** API Client for interfacing with the Orb API. */
export class Orb extends Core.APIClient {
apiKey: string;
webhookSecret: string | null;

private _options: ClientOptions;

/**
* API Client for interfacing with the Orb API.
*
* @param {string | undefined} [opts.apiKey=process.env['ORB_API_KEY'] ?? undefined]
* @param {string | null | undefined} [opts.webhookSecret=process.env['ORB_WEBHOOK_SECRET'] ?? null]
* @param {string} [opts.baseURL=process.env['ORB_BASE_URL'] ?? https://api.withorb.com/v1] - Override the default base URL for the API.
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
* @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
Expand All @@ -92,6 +99,7 @@ export class Orb extends Core.APIClient {
constructor({
baseURL = Core.readEnv('ORB_BASE_URL'),
apiKey = Core.readEnv('ORB_API_KEY'),
webhookSecret = Core.readEnv('ORB_WEBHOOK_SECRET') ?? null,
...opts
}: ClientOptions = {}) {
if (apiKey === undefined) {
Expand All @@ -102,6 +110,7 @@ export class Orb extends Core.APIClient {

const options: ClientOptions = {
apiKey,
webhookSecret,
...opts,
baseURL: baseURL || `https://api.withorb.com/v1`,
};
Expand All @@ -117,6 +126,7 @@ export class Orb extends Core.APIClient {
this.idempotencyHeader = 'Idempotency-Key';

this.apiKey = apiKey;
this.webhookSecret = webhookSecret;
}

topLevel: API.TopLevel = new API.TopLevel(this);
Expand Down