cloudflare
Version:
The official TypeScript library for the Cloudflare API
57 lines • 2.4 kB
JavaScript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from "../../../core/resource.mjs";
import { path } from "../../../internal/utils/path.mjs";
export var BasePreview = /* @__PURE__ */ (() => {
class BasePreview extends APIResource {
/**
* Generates a preview image for a message that was not flagged as a detection. The
* message is rendered from the copy in the recipient's mailbox, so this requires
* an active integration and only works while the message is still in the
* recipient's inbox. Returns a base64-encoded PNG screenshot of the email body.
* For messages with a detection, use the detection preview endpoint instead.
*
* @example
* ```ts
* const preview =
* await client.emailSecurity.investigate.preview.create({
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* id: '4Njp3P0STMz2c02Q-2024-01-05T10:00:00-12345678',
* });
* ```
*/
create(params, options) {
const { account_id, ...body } = params;
return this._client.post(path `/accounts/${account_id}/email-security/investigate/preview`, {
body,
...options,
})._thenUnwrap((obj) => obj.result);
}
/**
* Returns a preview of the message body as a base64-encoded PNG image for any
* message with a detection. For messages without a detection, use the
* non-detection preview endpoint instead.
*
* @example
* ```ts
* const preview =
* await client.emailSecurity.investigate.preview.get(
* '4Njp3P0STMz2c02Q-2024-01-05T10:00:00-12345678',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
get(investigateID, params, options) {
const { account_id } = params;
return this._client.get(path `/accounts/${account_id}/email-security/investigate/${investigateID}/preview`, options)._thenUnwrap((obj) => obj.result);
}
}
BasePreview._key = Object.freeze([
'emailSecurity',
'investigate',
'preview',
]);
return BasePreview;
})();
export class Preview extends BasePreview {
}
//# sourceMappingURL=preview.mjs.map