cloudflare
Version:
The official TypeScript library for the Cloudflare API
707 lines • 22.8 kB
TypeScript
import { APIResource } from "../../resource.js";
import * as Core from "../../core.js";
import * as RecipientsAPI from "./recipients.js";
import { RecipientCreateParams, RecipientCreateResponse, RecipientDeleteParams, RecipientDeleteResponse, RecipientGetParams, RecipientGetResponse, RecipientListParams, RecipientListResponse, RecipientListResponsesV4PagePaginationArray, Recipients } from "./recipients.js";
import * as ResourcesAPI from "./resources.js";
import { ResourceCreateParams, ResourceCreateResponse, ResourceDeleteParams, ResourceDeleteResponse, ResourceGetParams, ResourceGetResponse, ResourceListParams, ResourceListResponse, ResourceListResponsesV4PagePaginationArray, ResourceUpdateParams, ResourceUpdateResponse, Resources } from "./resources.js";
import { V4PagePaginationArray, type V4PagePaginationArrayParams } from "../../pagination.js";
export declare class ResourceSharing extends APIResource {
recipients: RecipientsAPI.Recipients;
resources: ResourcesAPI.Resources;
/**
* Create a new share
*
* @example
* ```ts
* const resourceSharing = await client.resourceSharing.create(
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* name: 'My Shared WAF Managed Rule',
* recipients: [{}],
* resources: [
* {
* meta: {},
* resource_account_id:
* '023e105f4ecef8ad9ca31a8372d0c353',
* resource_id: '023e105f4ecef8ad9ca31a8372d0c353',
* resource_type: 'custom-ruleset',
* },
* ],
* },
* );
* ```
*/
create(params: ResourceSharingCreateParams, options?: Core.RequestOptions): Core.APIPromise<ResourceSharingCreateResponse>;
/**
* Updating is not immediate, an updated share object with a new status will be
* returned.
*
* @example
* ```ts
* const resourceSharing = await client.resourceSharing.update(
* '3fd85f74b32742f1bff64a85009dda07',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* name: 'My Shared WAF Managed Rule',
* },
* );
* ```
*/
update(shareId: string, params: ResourceSharingUpdateParams, options?: Core.RequestOptions): Core.APIPromise<ResourceSharingUpdateResponse>;
/**
* Lists all account shares.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const resourceSharingListResponse of client.resourceSharing.list(
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* )) {
* // ...
* }
* ```
*/
list(params: ResourceSharingListParams, options?: Core.RequestOptions): Core.PagePromise<ResourceSharingListResponsesV4PagePaginationArray, ResourceSharingListResponse>;
/**
* Deletion is not immediate, an updated share object with a new status will be
* returned.
*
* @example
* ```ts
* const resourceSharing = await client.resourceSharing.delete(
* '3fd85f74b32742f1bff64a85009dda07',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
delete(shareId: string, params: ResourceSharingDeleteParams, options?: Core.RequestOptions): Core.APIPromise<ResourceSharingDeleteResponse>;
/**
* Fetches share by ID.
*
* @example
* ```ts
* const resourceSharing = await client.resourceSharing.get(
* '3fd85f74b32742f1bff64a85009dda07',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
get(shareId: string, params: ResourceSharingGetParams, options?: Core.RequestOptions): Core.APIPromise<ResourceSharingGetResponse>;
}
export declare class ResourceSharingListResponsesV4PagePaginationArray extends V4PagePaginationArray<ResourceSharingListResponse> {
}
export interface ResourceSharingCreateResponse {
/**
* Share identifier tag.
*/
id: string;
/**
* Account identifier.
*/
account_id: string;
/**
* The display name of an account.
*/
account_name: string;
/**
* When the share was created.
*/
created: string;
/**
* When the share was modified.
*/
modified: string;
/**
* The name of the share.
*/
name: string;
/**
* Organization identifier.
*/
organization_id: string;
status: 'active' | 'deleting' | 'deleted';
target_type: 'account' | 'organization';
/**
* The number of recipients in the 'associated' state. This field is only included
* when requested via the 'include_recipient_counts' parameter.
*/
associated_recipient_count?: number;
/**
* The number of recipients in the 'associating' state. This field is only included
* when requested via the 'include_recipient_counts' parameter.
*/
associating_recipient_count?: number;
/**
* The number of recipients in the 'disassociated' state. This field is only
* included when requested via the 'include_recipient_counts' parameter.
*/
disassociated_recipient_count?: number;
/**
* The number of recipients in the 'disassociating' state. This field is only
* included when requested via the 'include_recipient_counts' parameter.
*/
disassociating_recipient_count?: number;
kind?: 'sent' | 'received';
/**
* A list of resources that are part of the share. This field is only included when
* requested via the 'include_resources' parameter.
*/
resources?: Array<ResourceSharingCreateResponse.Resource>;
}
export declare namespace ResourceSharingCreateResponse {
interface Resource {
/**
* Share Resource identifier.
*/
id: string;
/**
* When the share was created.
*/
created: string;
/**
* Resource Metadata.
*/
meta: unknown;
/**
* When the share was modified.
*/
modified: string;
/**
* Account identifier.
*/
resource_account_id: string;
/**
* Share Resource identifier.
*/
resource_id: string;
/**
* Resource Type.
*/
resource_type: 'custom-ruleset' | 'widget' | 'gateway-policy' | 'gateway-destination-ip' | 'gateway-block-page-settings' | 'gateway-extended-email-matching';
/**
* Resource Version.
*/
resource_version: number;
/**
* Resource Status.
*/
status: 'active' | 'deleting' | 'deleted';
}
}
export interface ResourceSharingUpdateResponse {
/**
* Share identifier tag.
*/
id: string;
/**
* Account identifier.
*/
account_id: string;
/**
* The display name of an account.
*/
account_name: string;
/**
* When the share was created.
*/
created: string;
/**
* When the share was modified.
*/
modified: string;
/**
* The name of the share.
*/
name: string;
/**
* Organization identifier.
*/
organization_id: string;
status: 'active' | 'deleting' | 'deleted';
target_type: 'account' | 'organization';
/**
* The number of recipients in the 'associated' state. This field is only included
* when requested via the 'include_recipient_counts' parameter.
*/
associated_recipient_count?: number;
/**
* The number of recipients in the 'associating' state. This field is only included
* when requested via the 'include_recipient_counts' parameter.
*/
associating_recipient_count?: number;
/**
* The number of recipients in the 'disassociated' state. This field is only
* included when requested via the 'include_recipient_counts' parameter.
*/
disassociated_recipient_count?: number;
/**
* The number of recipients in the 'disassociating' state. This field is only
* included when requested via the 'include_recipient_counts' parameter.
*/
disassociating_recipient_count?: number;
kind?: 'sent' | 'received';
/**
* A list of resources that are part of the share. This field is only included when
* requested via the 'include_resources' parameter.
*/
resources?: Array<ResourceSharingUpdateResponse.Resource>;
}
export declare namespace ResourceSharingUpdateResponse {
interface Resource {
/**
* Share Resource identifier.
*/
id: string;
/**
* When the share was created.
*/
created: string;
/**
* Resource Metadata.
*/
meta: unknown;
/**
* When the share was modified.
*/
modified: string;
/**
* Account identifier.
*/
resource_account_id: string;
/**
* Share Resource identifier.
*/
resource_id: string;
/**
* Resource Type.
*/
resource_type: 'custom-ruleset' | 'widget' | 'gateway-policy' | 'gateway-destination-ip' | 'gateway-block-page-settings' | 'gateway-extended-email-matching';
/**
* Resource Version.
*/
resource_version: number;
/**
* Resource Status.
*/
status: 'active' | 'deleting' | 'deleted';
}
}
export interface ResourceSharingListResponse {
/**
* Share identifier tag.
*/
id: string;
/**
* Account identifier.
*/
account_id: string;
/**
* The display name of an account.
*/
account_name: string;
/**
* When the share was created.
*/
created: string;
/**
* When the share was modified.
*/
modified: string;
/**
* The name of the share.
*/
name: string;
/**
* Organization identifier.
*/
organization_id: string;
status: 'active' | 'deleting' | 'deleted';
target_type: 'account' | 'organization';
/**
* The number of recipients in the 'associated' state. This field is only included
* when requested via the 'include_recipient_counts' parameter.
*/
associated_recipient_count?: number;
/**
* The number of recipients in the 'associating' state. This field is only included
* when requested via the 'include_recipient_counts' parameter.
*/
associating_recipient_count?: number;
/**
* The number of recipients in the 'disassociated' state. This field is only
* included when requested via the 'include_recipient_counts' parameter.
*/
disassociated_recipient_count?: number;
/**
* The number of recipients in the 'disassociating' state. This field is only
* included when requested via the 'include_recipient_counts' parameter.
*/
disassociating_recipient_count?: number;
kind?: 'sent' | 'received';
/**
* A list of resources that are part of the share. This field is only included when
* requested via the 'include_resources' parameter.
*/
resources?: Array<ResourceSharingListResponse.Resource>;
}
export declare namespace ResourceSharingListResponse {
interface Resource {
/**
* Share Resource identifier.
*/
id: string;
/**
* When the share was created.
*/
created: string;
/**
* Resource Metadata.
*/
meta: unknown;
/**
* When the share was modified.
*/
modified: string;
/**
* Account identifier.
*/
resource_account_id: string;
/**
* Share Resource identifier.
*/
resource_id: string;
/**
* Resource Type.
*/
resource_type: 'custom-ruleset' | 'widget' | 'gateway-policy' | 'gateway-destination-ip' | 'gateway-block-page-settings' | 'gateway-extended-email-matching';
/**
* Resource Version.
*/
resource_version: number;
/**
* Resource Status.
*/
status: 'active' | 'deleting' | 'deleted';
}
}
export interface ResourceSharingDeleteResponse {
/**
* Share identifier tag.
*/
id: string;
/**
* Account identifier.
*/
account_id: string;
/**
* The display name of an account.
*/
account_name: string;
/**
* When the share was created.
*/
created: string;
/**
* When the share was modified.
*/
modified: string;
/**
* The name of the share.
*/
name: string;
/**
* Organization identifier.
*/
organization_id: string;
status: 'active' | 'deleting' | 'deleted';
target_type: 'account' | 'organization';
/**
* The number of recipients in the 'associated' state. This field is only included
* when requested via the 'include_recipient_counts' parameter.
*/
associated_recipient_count?: number;
/**
* The number of recipients in the 'associating' state. This field is only included
* when requested via the 'include_recipient_counts' parameter.
*/
associating_recipient_count?: number;
/**
* The number of recipients in the 'disassociated' state. This field is only
* included when requested via the 'include_recipient_counts' parameter.
*/
disassociated_recipient_count?: number;
/**
* The number of recipients in the 'disassociating' state. This field is only
* included when requested via the 'include_recipient_counts' parameter.
*/
disassociating_recipient_count?: number;
kind?: 'sent' | 'received';
/**
* A list of resources that are part of the share. This field is only included when
* requested via the 'include_resources' parameter.
*/
resources?: Array<ResourceSharingDeleteResponse.Resource>;
}
export declare namespace ResourceSharingDeleteResponse {
interface Resource {
/**
* Share Resource identifier.
*/
id: string;
/**
* When the share was created.
*/
created: string;
/**
* Resource Metadata.
*/
meta: unknown;
/**
* When the share was modified.
*/
modified: string;
/**
* Account identifier.
*/
resource_account_id: string;
/**
* Share Resource identifier.
*/
resource_id: string;
/**
* Resource Type.
*/
resource_type: 'custom-ruleset' | 'widget' | 'gateway-policy' | 'gateway-destination-ip' | 'gateway-block-page-settings' | 'gateway-extended-email-matching';
/**
* Resource Version.
*/
resource_version: number;
/**
* Resource Status.
*/
status: 'active' | 'deleting' | 'deleted';
}
}
export interface ResourceSharingGetResponse {
/**
* Share identifier tag.
*/
id: string;
/**
* Account identifier.
*/
account_id: string;
/**
* The display name of an account.
*/
account_name: string;
/**
* When the share was created.
*/
created: string;
/**
* When the share was modified.
*/
modified: string;
/**
* The name of the share.
*/
name: string;
/**
* Organization identifier.
*/
organization_id: string;
status: 'active' | 'deleting' | 'deleted';
target_type: 'account' | 'organization';
/**
* The number of recipients in the 'associated' state. This field is only included
* when requested via the 'include_recipient_counts' parameter.
*/
associated_recipient_count?: number;
/**
* The number of recipients in the 'associating' state. This field is only included
* when requested via the 'include_recipient_counts' parameter.
*/
associating_recipient_count?: number;
/**
* The number of recipients in the 'disassociated' state. This field is only
* included when requested via the 'include_recipient_counts' parameter.
*/
disassociated_recipient_count?: number;
/**
* The number of recipients in the 'disassociating' state. This field is only
* included when requested via the 'include_recipient_counts' parameter.
*/
disassociating_recipient_count?: number;
kind?: 'sent' | 'received';
/**
* A list of resources that are part of the share. This field is only included when
* requested via the 'include_resources' parameter.
*/
resources?: Array<ResourceSharingGetResponse.Resource>;
}
export declare namespace ResourceSharingGetResponse {
interface Resource {
/**
* Share Resource identifier.
*/
id: string;
/**
* When the share was created.
*/
created: string;
/**
* Resource Metadata.
*/
meta: unknown;
/**
* When the share was modified.
*/
modified: string;
/**
* Account identifier.
*/
resource_account_id: string;
/**
* Share Resource identifier.
*/
resource_id: string;
/**
* Resource Type.
*/
resource_type: 'custom-ruleset' | 'widget' | 'gateway-policy' | 'gateway-destination-ip' | 'gateway-block-page-settings' | 'gateway-extended-email-matching';
/**
* Resource Version.
*/
resource_version: number;
/**
* Resource Status.
*/
status: 'active' | 'deleting' | 'deleted';
}
}
export interface ResourceSharingCreateParams {
/**
* Path param: Account identifier.
*/
account_id: string;
/**
* Body param: The name of the share.
*/
name: string;
/**
* Body param:
*/
recipients: Array<ResourceSharingCreateParams.Recipient>;
/**
* Body param:
*/
resources: Array<ResourceSharingCreateParams.Resource>;
}
export declare namespace ResourceSharingCreateParams {
/**
* Account or organization ID must be provided.
*/
interface Recipient {
/**
* Account identifier.
*/
account_id?: string;
/**
* Organization identifier.
*/
organization_id?: string;
}
interface Resource {
/**
* Resource Metadata.
*/
meta: unknown;
/**
* Account identifier.
*/
resource_account_id: string;
/**
* Share Resource identifier.
*/
resource_id: string;
/**
* Resource Type.
*/
resource_type: 'custom-ruleset' | 'widget' | 'gateway-policy' | 'gateway-destination-ip' | 'gateway-block-page-settings' | 'gateway-extended-email-matching';
}
}
export interface ResourceSharingUpdateParams {
/**
* Path param: Account identifier.
*/
account_id: string;
/**
* Body param: The name of the share.
*/
name: string;
}
export interface ResourceSharingListParams extends V4PagePaginationArrayParams {
/**
* Path param: Account identifier.
*/
account_id: string;
/**
* Query param: Direction to sort objects.
*/
direction?: 'asc' | 'desc';
/**
* Query param: Include recipient counts in the response.
*/
include_recipient_counts?: boolean;
/**
* Query param: Include resources in the response.
*/
include_resources?: boolean;
/**
* Query param: Filter shares by kind.
*/
kind?: 'sent' | 'received';
/**
* Query param: Order shares by values in the given field.
*/
order?: 'name' | 'created';
/**
* Query param: Filter share resources by resource_types.
*/
resource_types?: Array<'custom-ruleset' | 'widget' | 'gateway-policy' | 'gateway-destination-ip' | 'gateway-block-page-settings' | 'gateway-extended-email-matching'>;
/**
* Query param: Filter shares by status.
*/
status?: 'active' | 'deleting' | 'deleted';
/**
* Query param: Filter shares by target_type.
*/
target_type?: 'account' | 'organization';
}
export interface ResourceSharingDeleteParams {
/**
* Account identifier.
*/
account_id: string;
}
export interface ResourceSharingGetParams {
/**
* Path param: Account identifier.
*/
account_id: string;
/**
* Query param: Include recipient counts in the response.
*/
include_recipient_counts?: boolean;
/**
* Query param: Include resources in the response.
*/
include_resources?: boolean;
}
export declare namespace ResourceSharing {
export { type ResourceSharingCreateResponse as ResourceSharingCreateResponse, type ResourceSharingUpdateResponse as ResourceSharingUpdateResponse, type ResourceSharingListResponse as ResourceSharingListResponse, type ResourceSharingDeleteResponse as ResourceSharingDeleteResponse, type ResourceSharingGetResponse as ResourceSharingGetResponse, ResourceSharingListResponsesV4PagePaginationArray as ResourceSharingListResponsesV4PagePaginationArray, type ResourceSharingCreateParams as ResourceSharingCreateParams, type ResourceSharingUpdateParams as ResourceSharingUpdateParams, type ResourceSharingListParams as ResourceSharingListParams, type ResourceSharingDeleteParams as ResourceSharingDeleteParams, type ResourceSharingGetParams as ResourceSharingGetParams, };
export { Recipients as Recipients, type RecipientCreateResponse as RecipientCreateResponse, type RecipientListResponse as RecipientListResponse, type RecipientDeleteResponse as RecipientDeleteResponse, type RecipientGetResponse as RecipientGetResponse, RecipientListResponsesV4PagePaginationArray as RecipientListResponsesV4PagePaginationArray, type RecipientCreateParams as RecipientCreateParams, type RecipientListParams as RecipientListParams, type RecipientDeleteParams as RecipientDeleteParams, type RecipientGetParams as RecipientGetParams, };
export { Resources as Resources, type ResourceCreateResponse as ResourceCreateResponse, type ResourceUpdateResponse as ResourceUpdateResponse, type ResourceListResponse as ResourceListResponse, type ResourceDeleteResponse as ResourceDeleteResponse, type ResourceGetResponse as ResourceGetResponse, ResourceListResponsesV4PagePaginationArray as ResourceListResponsesV4PagePaginationArray, type ResourceCreateParams as ResourceCreateParams, type ResourceUpdateParams as ResourceUpdateParams, type ResourceListParams as ResourceListParams, type ResourceDeleteParams as ResourceDeleteParams, type ResourceGetParams as ResourceGetParams, };
}
//# sourceMappingURL=resource-sharing.d.ts.map