cloudflare
Version:
The official TypeScript library for the Cloudflare API
80 lines • 2.78 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 BaseTransformationsC2paResource extends APIResource {
static readonly _key: readonly ['zones', 'transformationsC2pa'];
/**
* C2PA (Coalition for Content Provenance and Authenticity) signing adds
* cryptographic metadata to images processed through Cloudflare Image
* Transformations, enabling verification of image authenticity and provenance.
*
* @example
* ```ts
* const transformationsC2pa =
* await client.zones.transformationsC2pa.edit({
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
* value: 'off',
* });
* ```
*/
edit(params: TransformationsC2paEditParams, options?: RequestOptions): APIPromise<TransformationsC2pa>;
/**
* C2PA (Coalition for Content Provenance and Authenticity) signing adds
* cryptographic metadata to images processed through Cloudflare Image
* Transformations, enabling verification of image authenticity and provenance.
*
* @example
* ```ts
* const transformationsC2pa =
* await client.zones.transformationsC2pa.get({
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
* });
* ```
*/
get(params: TransformationsC2paGetParams, options?: RequestOptions): APIPromise<TransformationsC2pa>;
}
export declare class TransformationsC2paResource extends BaseTransformationsC2paResource {
}
/**
* Controls C2PA signing for images processed through Cloudflare Image
* Transformations.
*/
export interface TransformationsC2pa {
/**
* ID of the zone setting.
*/
id?: 'image_resizing_c2pa';
/**
* Whether or not this setting can be modified for this zone (based on your
* Cloudflare plan level).
*/
editable?: true | false;
/**
* last time this setting was modified.
*/
modified_on?: string | null;
/**
* Current value of the zone setting.
*/
value?: 'on' | 'off';
}
export interface TransformationsC2paEditParams {
/**
* Path param: Identifier.
*/
zone_id: string;
/**
* Body param: Whether C2PA signing is enabled for image transformations.
*/
value: 'off' | 'on';
}
export interface TransformationsC2paGetParams {
/**
* Identifier.
*/
zone_id: string;
}
export declare namespace TransformationsC2paResource {
export { type TransformationsC2pa as TransformationsC2pa, type TransformationsC2paEditParams as TransformationsC2paEditParams, type TransformationsC2paGetParams as TransformationsC2paGetParams, };
}
//# sourceMappingURL=transformations-c2pa.d.mts.map