e-invoice-api/src/resources/webhooks.ts

The official TypeScript library for the e-invoice API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../core/resource';
import { APIPromise } from '../core/api-promise';
import { RequestOptions } from '../internal/request-options';
import { path } from '../internal/utils/path';

export class Webhooks extends APIResource {
  /**
   * Create a new webhook
   */
  create(body: WebhookCreateParams, options?: RequestOptions): APIPromise<WebhookResponse> {
    return this._client.post('/api/webhooks/', { body, ...options });
  }

  /**
   * Get a webhook by ID
   */
  retrieve(webhookID: string, options?: RequestOptions): APIPromise<WebhookResponse> {
    return this._client.get(path`/api/webhooks/${webhookID}`, options);
  }

  /**
   * Update a webhook by ID
   */
  update(
    webhookID: string,
    body: WebhookUpdateParams,
    options?: RequestOptions,
  ): APIPromise<WebhookResponse> {
    return this._client.put(path`/api/webhooks/${webhookID}`, { body, ...options });
  }

  /**
   * Get all webhooks for the current tenant
   */
  list(options?: RequestOptions): APIPromise<WebhookListResponse> {
    return this._client.get('/api/webhooks/', options);
  }

  /**
   * Delete a webhook
   */
  delete(webhookID: string, options?: RequestOptions): APIPromise<WebhookDeleteResponse> {
    return this._client.delete(path`/api/webhooks/${webhookID}`, options);
  }
}

/**
 * Response model for webhook API endpoints.
 */
export interface WebhookResponse {
  id: string;

  events: Array<string>;

  secret: string;

  url: string;

  enabled?: boolean;
}

export type WebhookListResponse = Array<WebhookResponse>;

/**
 * Model for webhook deletion.
 */
export interface WebhookDeleteResponse {
  is_deleted: boolean;
}

export interface WebhookCreateParams {
  events: Array<string>;

  url: string;

  enabled?: boolean;
}

export interface WebhookUpdateParams {
  enabled?: boolean | null;

  events?: Array<string> | null;

  url?: string | null;
}

export declare namespace Webhooks {
  export {
    type WebhookResponse as WebhookResponse,
    type WebhookListResponse as WebhookListResponse,
    type WebhookDeleteResponse as WebhookDeleteResponse,
    type WebhookCreateParams as WebhookCreateParams,
    type WebhookUpdateParams as WebhookUpdateParams,
  };
}