cloudflare
Version:
The official TypeScript library for the Cloudflare API
132 lines • 4.36 kB
text/typescript
import { APIResource } from "../../../core/resource.mjs";
import { APIPromise } from "../../../core/api-promise.mjs";
import { PagePromise, SinglePage } from "../../../core/pagination.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class BaseOwnershipResource extends APIResource {
static readonly _key: readonly ['magicTransit', 'pcaps', 'ownership'];
/**
* Adds an AWS or GCP bucket to use with full packet captures.
*
* @example
* ```ts
* const ownership =
* await client.magicTransit.pcaps.ownership.create({
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* destination_conf: 's3://pcaps-bucket?region=us-east-1',
* });
* ```
*/
create(params: OwnershipCreateParams, options?: RequestOptions): APIPromise<Ownership>;
/**
* Deletes buckets added to the packet captures API.
*
* @example
* ```ts
* await client.magicTransit.pcaps.ownership.delete(
* '023e105f4ecef8ad9ca31a8372d0c353',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
delete(ownershipID: string, params: OwnershipDeleteParams, options?: RequestOptions): APIPromise<void>;
/**
* List all buckets configured for use with PCAPs API.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const ownership of client.magicTransit.pcaps.ownership.get(
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* )) {
* // ...
* }
* ```
*/
get(params: OwnershipGetParams, options?: RequestOptions): PagePromise<OwnershipsSinglePage, Ownership>;
/**
* Validates buckets added to the packet captures API.
*
* @example
* ```ts
* const ownership =
* await client.magicTransit.pcaps.ownership.validate({
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* destination_conf: 's3://pcaps-bucket?region=us-east-1',
* ownership_challenge:
* 'ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt',
* });
* ```
*/
validate(params: OwnershipValidateParams, options?: RequestOptions): APIPromise<Ownership>;
}
export declare class OwnershipResource extends BaseOwnershipResource {
}
export type OwnershipsSinglePage = SinglePage<Ownership>;
export interface Ownership {
/**
* The bucket ID associated with the packet captures API.
*/
id: string;
/**
* The full URI for the bucket. This field only applies to `full` packet captures.
*/
destination_conf: string;
/**
* The ownership challenge filename stored in the bucket.
*/
filename: string;
/**
* The status of the ownership challenge. Can be pending, success or failed.
*/
status: 'pending' | 'success' | 'failed';
/**
* The RFC 3339 timestamp when the bucket was added to packet captures API.
*/
submitted: string;
/**
* The RFC 3339 timestamp when the bucket was validated.
*/
validated?: string;
}
export interface OwnershipCreateParams {
/**
* Path param: Identifier.
*/
account_id: string;
/**
* Body param: The full URI for the bucket. This field only applies to `full`
* packet captures.
*/
destination_conf: string;
}
export interface OwnershipDeleteParams {
/**
* Identifier.
*/
account_id: string;
}
export interface OwnershipGetParams {
/**
* Identifier.
*/
account_id: string;
}
export interface OwnershipValidateParams {
/**
* Path param: Identifier.
*/
account_id: string;
/**
* Body param: The full URI for the bucket. This field only applies to `full`
* packet captures.
*/
destination_conf: string;
/**
* Body param: The ownership challenge filename stored in the bucket.
*/
ownership_challenge: string;
}
export declare namespace OwnershipResource {
export { type Ownership as Ownership, type OwnershipsSinglePage as OwnershipsSinglePage, type OwnershipCreateParams as OwnershipCreateParams, type OwnershipDeleteParams as OwnershipDeleteParams, type OwnershipGetParams as OwnershipGetParams, type OwnershipValidateParams as OwnershipValidateParams, };
}
//# sourceMappingURL=ownership.d.mts.map