shields.ts

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

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

export class Shields extends APIResource {
  retrieve(identifier: string, options?: Core.RequestOptions): Core.APIPromise<Shield> {
    return this._client.get(`/v1/shields/${identifier}`, options);
  }

  list(options?: Core.RequestOptions): Core.APIPromise<ShieldListResponse> {
    return (
      this._client.get('/v1/shields', options) as Core.APIPromise<{ data: ShieldListResponse }>
    )._thenUnwrap((obj) => obj.data);
  }

  register(body: ShieldRegisterParams, options?: Core.RequestOptions): Core.APIPromise<Shield> {
    return this._client.post('/v1/shields', { body, ...options });
  }
}

export interface ListShieldsResponse {
  data: ShieldListResponse;
}

/**
 * A safety shield resource that can be used to check content
 */
export interface Shield {
  identifier: string;

  provider_id: string;

  provider_resource_id: string;

  type: 'shield';

  params?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
}

export type ShieldListResponse = Array<Shield>;

export interface ShieldRegisterParams {
  shield_id: string;

  params?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;

  provider_id?: string;

  provider_shield_id?: string;
}

export declare namespace Shields {
  export {
    type ListShieldsResponse as ListShieldsResponse,
    type Shield as Shield,
    type ShieldListResponse as ShieldListResponse,
    type ShieldRegisterParams as ShieldRegisterParams,
  };
}