cloudflare
Version:
The official TypeScript library for the Cloudflare API
46 lines • 1.56 kB
text/typescript
import { APIResource } from "../../../core/resource.mjs";
import { APIPromise } from "../../../core/api-promise.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class BaseAdvertisements extends APIResource {
static readonly _key: readonly ['magicNetworkMonitoring', 'rules', 'advertisements'];
/**
* 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?: RequestOptions): APIPromise<Advertisement | null>;
}
export declare class Advertisements extends BaseAdvertisements {
}
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 };
}
//# sourceMappingURL=advertisements.d.mts.map