51 lines
1.5 KiB
TypeScript
51 lines
1.5 KiB
TypeScript
import { APIResource } from "../../resource.js";
|
|
import * as Core from "../../core.js";
|
|
export declare class Previews extends APIResource {
|
|
/**
|
|
* Get the result of a previous preview operation using the provided preview_id.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* const preview = await client.loadBalancers.previews.get(
|
|
* 'p1aba936b94213e5b8dca0c0dbf1f9cc',
|
|
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
|
|
* );
|
|
* ```
|
|
*/
|
|
get(previewId: string, params: PreviewGetParams, options?: Core.RequestOptions): Core.APIPromise<PreviewGetResponse>;
|
|
}
|
|
/**
|
|
* Resulting health data from a preview operation.
|
|
*/
|
|
export type PreviewGetResponse = {
|
|
[key: string]: PreviewGetResponse.item;
|
|
};
|
|
export declare namespace PreviewGetResponse {
|
|
interface item {
|
|
healthy?: boolean;
|
|
origins?: Array<{
|
|
[key: string]: item.load_balancing_origin_health_data;
|
|
}>;
|
|
}
|
|
namespace item {
|
|
/**
|
|
* The origin ipv4/ipv6 address or domain name mapped to it's health data.
|
|
*/
|
|
interface load_balancing_origin_health_data {
|
|
failure_reason?: string;
|
|
healthy?: boolean;
|
|
response_code?: number;
|
|
rtt?: string;
|
|
}
|
|
}
|
|
}
|
|
export interface PreviewGetParams {
|
|
/**
|
|
* Identifier
|
|
*/
|
|
account_id: string;
|
|
}
|
|
export declare namespace Previews {
|
|
export { type PreviewGetResponse as PreviewGetResponse, type PreviewGetParams as PreviewGetParams };
|
|
}
|
|
//# sourceMappingURL=previews.d.ts.map
|