import { IObjectWithId } from '../base';
import { IWebhookCreateParameters } from './WebhookCreateParameters';
import { IWebhookListParameters } from './WebhookListParameters';

/**
 * Each Webhook contains the url which EasyPost will notify whenever an object in our system updates.
 * Several types of objects are processed asynchronously in the EasyPost system, so whenever an object updates, an Event is sent via HTTP POST to each configured webhook URL.
 * The Webhook object provides CRUD operations for all Webhooks.
 *
 * Currently, our recommended best practice for securing Webhooks involves using basic authentication and HTTPS on your endpoint.
 * This will help prevent any altering of any information communicated to you by EasyPost, prevent any third parties from seeing your webhooks in transit, and will prevent any third parties from masquerading as EasyPost and sending fraudulent data.
 * EasyPost performs certificate validation and requires any TLS-enabled (HTTPS) webhook recipients to have a certificate signed by a public trusted certification authority.
 * We do not support sending webhooks to over SSLv2, SSLv3, or any connection using so-called export-grade ciphers.
 * For documentation on how to set up your server with TLS, we recommend Mozilla's guide to Server-Side TLS and Qualys's SSL/TLS deployment best practices guide.
 *
 * In general, a Webhook's endpoint should return a status code of 2XX.
 * A 200 is preferred, but any 2XX status will indicate to our system that the Webhook request was successful.
 * Endpoints that return a large volume and rate of failures over a period of time will get automatically disabled by the system; a disabled Webhook can be re-enabled using the Webhook update endpoint.
 *
 * @see https://docs.easypost.com/docs/webhooks#webhook-object
 */
export declare interface IWebhook extends IObjectWithId<'Webhook'> {
  /**
   * http://example.com
   */
  url: string;

  /**
   * the timestamp at which the webhook was most recently disabled (if any)
   */
  disabled_at: string;

  /**
   * custom headers to add to your webhook
   */
  custom_headers: Array<{ key: string; value: string }>;
}

export declare class Webhook implements IWebhook {
  public constructor(input: IWebhookCreateParameters);

  url: string;
  disabled_at: string;
  id: string;
  mode: 'test' | 'production';
  object: 'Webhook';

  /**
   * To create a Webhook, you simply need to provide a url parameter that you wish to receive notifications to.
   *
   * @see https://docs.easypost.com/docs/webhooks#create-a-webhook
   *
   * @param {Object} params The parameters to create an {@link Webhook} with
   * @returns {Promise<Webhook>} The created and verified {@link Webhook}
   */
  static create(params: Object): Promise<Webhook>;

  /**
   * Enables a Webhook that has been disabled. You can also secure your webhook by adding a webhook_secret.
   *
   * @see https://docs.easypost.com/docs/webhooks#update-a-webhook
   *
   * @param webhookId Unique, starts with "hook_"
   * @param params The parameters to update an {@link Webhook} with
   * @returns {Promise<Webhook>} The created and verified {@link Webhook}
   */
  static update(webhookId: string, params: Object): Promise<Webhook>;

  /**
   * Retrieve an unpaginated list of all Webhooks available to the authenticated account.
   *
   * @see https://docs.easypost.com/docs/webhooks#retrieve-all-webhooks
   *
   * @param {Object} params - The parameters to use for the request.
   * @returns {Object} - An object containing a list of {@link Webhook webhooks} and pagination information.
   */
  static all(params?: IWebhookListParameters): Promise<{ webhooks: Webhook[] }>;

  /**
   * Retrieve a Webhook by id.
   *
   * @param webhookId Unique, starts with "hook_"
   *
   * @see https://docs.easypost.com/docs/webhooks#retrieve-a-webhook
   *
   * @returns {Promise<Webhook>} The created and verified {@link Webhook}
   */
  static retrieve(webhookId: string): Promise<Webhook>;

  /**
   * Delete a Webhook by id.
   *
   * @param webhookId Unique, starts with "hook_"
   *
   * @see https://docs.easypost.com/docs/webhooks#delete-a-webhook
   */
  static delete(webhookId: string): void;
}