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 * as Core from "../../../core";
import { APIResource } from "../../../resource";
import * as AdvertisementsAPI from "./advertisements";

export class Advertisements extends APIResource {
  /**
   * Update advertisement for rule.
   */
  edit(
    ruleId: string,
    params: AdvertisementEditParams,
    options?: Core.RequestOptions,
  ): Core.APIPromise<MagicNetworkMonitoringRuleAdvertisable | null> {
    const { account_id } = params;
    return (
      this._client.patch(
        `/accounts/${account_id}/mnm/rules/${ruleId}/advertisement`,
        options,
      ) as Core.APIPromise<{ result: MagicNetworkMonitoringRuleAdvertisable | null }>
    )._thenUnwrap((obj) => obj.result);
  }
}

export interface MagicNetworkMonitoringRuleAdvertisable {
  /**
   * 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 {
  account_id: string;
}

export namespace Advertisements {
  export import MagicNetworkMonitoringRuleAdvertisable = AdvertisementsAPI.MagicNetworkMonitoringRuleAdvertisable;
  export import AdvertisementEditParams = AdvertisementsAPI.AdvertisementEditParams;
}