cloudflare/src/resources/brand-protection/matches.ts

The official TypeScript library for the Cloudflare API

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

import { APIResource } from '../../resource';
import * as Core from '../../core';

export class Matches extends APIResource {
  /**
   * Return matches as CSV for string queries based on ID
   */
  download(
    params: MatchDownloadParams,
    options?: Core.RequestOptions,
  ): Core.APIPromise<MatchDownloadResponse> {
    const { account_id, ...query } = params;
    return this._client.get(`/accounts/${account_id}/brand-protection/matches/download`, {
      query,
      ...options,
    });
  }

  /**
   * Return matches for string queries based on ID
   */
  get(params: MatchGetParams, options?: Core.RequestOptions): Core.APIPromise<MatchGetResponse> {
    const { account_id, ...query } = params;
    return this._client.get(`/accounts/${account_id}/brand-protection/matches`, { query, ...options });
  }
}

export interface MatchDownloadResponse {
  matches?: Array<{ [key: string]: unknown }>;

  total?: number;
}

export interface MatchGetResponse {
  matches?: Array<{ [key: string]: unknown }>;

  total?: number;
}

export interface MatchDownloadParams {
  /**
   * Path param:
   */
  account_id: string;

  /**
   * Query param:
   */
  id?: string;

  /**
   * Query param:
   */
  include_domain_id?: boolean;

  /**
   * Query param:
   */
  limit?: number;

  /**
   * Query param:
   */
  offset?: number;
}

export interface MatchGetParams {
  /**
   * Path param:
   */
  account_id: string;

  /**
   * Query param:
   */
  id?: string;

  /**
   * Query param:
   */
  include_domain_id?: boolean;

  /**
   * Query param:
   */
  limit?: number;

  /**
   * Query param:
   */
  offset?: number;
}

export declare namespace Matches {
  export {
    type MatchDownloadResponse as MatchDownloadResponse,
    type MatchGetResponse as MatchGetResponse,
    type MatchDownloadParams as MatchDownloadParams,
    type MatchGetParams as MatchGetParams,
  };
}