cloudflare/src/resources/magic-network-monitoring/rules/advertisements.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 Advertisements extends APIResource {
  /**
   * Update advertisement for rule.
   *
   * @example
   * ```ts
   * const advertisement =
   *   await client.magicNetworkMonitoring.rules.advertisements.edit(
   *     '2890e6fa406311ed9b5a23f70f6fb8cf',
   *     {
   *       account_id: '6f91088a406011ed95aed352566e8d4c',
   *       body: {},
   *     },
   *   );
   * ```
   */
  edit(
    ruleId: string,
    params: AdvertisementEditParams,
    options?: Core.RequestOptions,
  ): Core.APIPromise<Advertisement | null> {
    const { account_id, body } = params;
    return (
      this._client.patch(`/accounts/${account_id}/mnm/rules/${ruleId}/advertisement`, {
        body: body,
        ...options,
      }) as Core.APIPromise<{ result: Advertisement | null }>
    )._thenUnwrap((obj) => obj.result);
  }
}

export interface Advertisement {
  /**
   * Toggle on if you would like Cloudflare to automatically advertise the IP
   * Prefixes within the rule via Magic Transit when the rule is triggered. Only
   * available for users of Magic Transit.
   */
  automatic_advertisement: boolean | null;
}

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

  /**
   * Body param:
   */
  body: unknown;
}

export declare namespace Advertisements {
  export { type Advertisement as Advertisement, type AdvertisementEditParams as AdvertisementEditParams };
}