rules

type ASN = shared.ASN

type ASNParam = shared.ASNParam

type AuditLog = shared.AuditLog

type AuditLogAction = shared.AuditLogAction

type AuditLogActor = shared.AuditLogActor

type AuditLogActorType = shared.AuditLogActorType

type AuditLogOwner = shared.AuditLogOwner

type AuditLogResource = shared.AuditLogResource

type CertificateCA = shared.CertificateCA

type CertificateRequestType = shared.CertificateRequestType

type CloudflareTunnel = shared.CloudflareTunnel

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

type Error = apierror.Error

type ErrorData = shared.ErrorData

type ErrorDataSource = shared.ErrorDataSource

type Hostname struct {
	URLHostname string `json:"url_hostname,required"`
	// Only applies to wildcard hostnames (e.g., \*.example.com). When true (default),
	// only subdomains are blocked. When false, both the root domain and subdomains are
	// blocked.
	ExcludeExactHostname bool         `json:"exclude_exact_hostname"`
	JSON                 hostnameJSON `json:"-"`
}

type HostnameParam struct {
	URLHostname param.Field[string] `json:"url_hostname,required"`
	// Only applies to wildcard hostnames (e.g., \*.example.com). When true (default),
	// only subdomains are blocked. When false, both the root domain and subdomains are
	// blocked.
	ExcludeExactHostname param.Field[bool] `json:"exclude_exact_hostname"`
}

type ListBulkOperationGetParams struct {
	// The Account ID for this resource.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ListBulkOperationGetResponse struct {
	// The unique operation ID of the asynchronous action.
	ID string `json:"id,required"`
	// The current status of the asynchronous operation.
	Status ListBulkOperationGetResponseStatus `json:"status,required"`
	// The RFC 3339 timestamp of when the operation was completed.
	Completed string `json:"completed"`
	// A message describing the error when the status is `failed`.
	Error string                           `json:"error"`
	JSON  listBulkOperationGetResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

type ListBulkOperationGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo        `json:"errors,required"`
	Messages []shared.ResponseInfo        `json:"messages,required"`
	Result   ListBulkOperationGetResponse `json:"result,required"`
	// Defines whether the API call was successful.
	Success ListBulkOperationGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    listBulkOperationGetResponseEnvelopeJSON    `json:"-"`
}

type ListBulkOperationGetResponseEnvelopeSuccess bool

type ListBulkOperationGetResponseListsBulkOperationCompleted struct {
	// The unique operation ID of the asynchronous action.
	ID string `json:"id,required"`
	// The RFC 3339 timestamp of when the operation was completed.
	Completed string `json:"completed,required"`
	// The current status of the asynchronous operation.
	Status ListBulkOperationGetResponseListsBulkOperationCompletedStatus `json:"status,required"`
	JSON   listBulkOperationGetResponseListsBulkOperationCompletedJSON   `json:"-"`
}

type ListBulkOperationGetResponseListsBulkOperationCompletedStatus string

type ListBulkOperationGetResponseListsBulkOperationFailed struct {
	// The unique operation ID of the asynchronous action.
	ID string `json:"id,required"`
	// The RFC 3339 timestamp of when the operation was completed.
	Completed string `json:"completed,required"`
	// A message describing the error when the status is `failed`.
	Error string `json:"error,required"`
	// The current status of the asynchronous operation.
	Status ListBulkOperationGetResponseListsBulkOperationFailedStatus `json:"status,required"`
	JSON   listBulkOperationGetResponseListsBulkOperationFailedJSON   `json:"-"`
}

type ListBulkOperationGetResponseListsBulkOperationFailedStatus string

type ListBulkOperationGetResponseListsBulkOperationPendingOrRunning struct {
	// The unique operation ID of the asynchronous action.
	ID string `json:"id,required"`
	// The current status of the asynchronous operation.
	Status ListBulkOperationGetResponseListsBulkOperationPendingOrRunningStatus `json:"status,required"`
	JSON   listBulkOperationGetResponseListsBulkOperationPendingOrRunningJSON   `json:"-"`
}

type ListBulkOperationGetResponseListsBulkOperationPendingOrRunningStatus string

type ListBulkOperationGetResponseStatus string

type ListBulkOperationGetResponseUnion interface {
	// contains filtered or unexported methods
}

type ListBulkOperationService struct {
	Options []option.RequestOption
}

type ListCursor struct {
	After  string         `json:"after"`
	Before string         `json:"before"`
	JSON   listCursorJSON `json:"-"`
}

type ListDeleteParams struct {
	// The Account ID for this resource.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ListDeleteResponse struct {
	// The unique ID of the list.
	ID   string                 `json:"id,required"`
	JSON listDeleteResponseJSON `json:"-"`
}

type ListDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   ListDeleteResponse    `json:"result,required"`
	// Defines whether the API call was successful.
	Success ListDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    listDeleteResponseEnvelopeJSON    `json:"-"`
}

type ListDeleteResponseEnvelopeSuccess bool

type ListGetParams struct {
	// The Account ID for this resource.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ListGetResponse struct {
	// The unique ID of the list.
	ID string `json:"id,required"`
	// The RFC 3339 timestamp of when the list was created.
	CreatedOn string `json:"created_on,required"`
	// The type of the list. Each type supports specific list items (IP addresses,
	// ASNs, hostnames or redirects).
	Kind ListGetResponseKind `json:"kind,required"`
	// The RFC 3339 timestamp of when the list was last modified.
	ModifiedOn string `json:"modified_on,required"`
	// An informative name for the list. Use this name in filter and rule expressions.
	Name string `json:"name,required"`
	// The number of items in the list.
	NumItems float64 `json:"num_items,required"`
	// The number of [filters](/api/resources/filters/) referencing the list.
	NumReferencingFilters float64 `json:"num_referencing_filters,required"`
	// An informative summary of the list.
	Description string              `json:"description"`
	JSON        listGetResponseJSON `json:"-"`
}

type ListGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   ListGetResponse       `json:"result,required"`
	// Defines whether the API call was successful.
	Success ListGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    listGetResponseEnvelopeJSON    `json:"-"`
}

type ListGetResponseEnvelopeSuccess bool

type ListGetResponseKind string

type ListItemDeleteParams struct {
	// The Account ID for this resource.
	AccountID param.Field[string]                     `path:"account_id,required"`
	Items     param.Field[[]ListItemDeleteParamsItem] `json:"items"`
}

type ListItemDeleteParamsItem struct {
	// Defines the unique ID of the item in the List.
	ID param.Field[string] `json:"id,required"`
}

type ListItemDeleteResponse struct {
	// The unique operation ID of the asynchronous action.
	OperationID string                     `json:"operation_id,required"`
	JSON        listItemDeleteResponseJSON `json:"-"`
}

type ListItemDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo  `json:"errors,required"`
	Messages []shared.ResponseInfo  `json:"messages,required"`
	Result   ListItemDeleteResponse `json:"result,required"`
	// Defines whether the API call was successful.
	Success ListItemDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    listItemDeleteResponseEnvelopeJSON    `json:"-"`
}

type ListItemDeleteResponseEnvelopeSuccess bool

type ListItemGetParams struct {
	// The Account ID for this resource.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ListItemGetResponse struct {
	// Defines the unique ID of the item in the List.
	ID string `json:"id,required"`
	// The RFC 3339 timestamp of when the list was created.
	CreatedOn string `json:"created_on,required"`
	// The RFC 3339 timestamp of when the list was last modified.
	ModifiedOn string `json:"modified_on,required"`
	// Defines a non-negative 32 bit integer.
	ASN int64 `json:"asn"`
	// Defines an informative summary of the list item.
	Comment string `json:"comment"`
	// Valid characters for hostnames are ASCII(7) letters from a to z, the digits from
	// 0 to 9, wildcards (\*), and the hyphen (-).
	Hostname Hostname `json:"hostname"`
	// An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
	IP string `json:"ip"`
	// The definition of the redirect.
	Redirect Redirect                `json:"redirect"`
	JSON     listItemGetResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

type ListItemGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   ListItemGetResponse   `json:"result,required"`
	// Defines whether the API call was successful.
	Success ListItemGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    listItemGetResponseEnvelopeJSON    `json:"-"`
}

type ListItemGetResponseEnvelopeSuccess bool

type ListItemGetResponseListsListItemASNFull struct {
	// Defines the unique ID of the item in the List.
	ID string `json:"id,required"`
	// Defines a non-negative 32 bit integer.
	ASN int64 `json:"asn,required"`
	// The RFC 3339 timestamp of when the list was created.
	CreatedOn string `json:"created_on,required"`
	// The RFC 3339 timestamp of when the list was last modified.
	ModifiedOn string `json:"modified_on,required"`
	// Defines an informative summary of the list item.
	Comment string                                      `json:"comment"`
	JSON    listItemGetResponseListsListItemASNFullJSON `json:"-"`
}

type ListItemGetResponseListsListItemHostnameFull struct {
	// Defines the unique ID of the item in the List.
	ID string `json:"id,required"`
	// The RFC 3339 timestamp of when the list was created.
	CreatedOn string `json:"created_on,required"`
	// Valid characters for hostnames are ASCII(7) letters from a to z, the digits from
	// 0 to 9, wildcards (\*), and the hyphen (-).
	Hostname Hostname `json:"hostname,required"`
	// The RFC 3339 timestamp of when the list was last modified.
	ModifiedOn string `json:"modified_on,required"`
	// Defines an informative summary of the list item.
	Comment string                                           `json:"comment"`
	JSON    listItemGetResponseListsListItemHostnameFullJSON `json:"-"`
}

type ListItemGetResponseListsListItemIPFull struct {
	// Defines the unique ID of the item in the List.
	ID string `json:"id,required"`
	// The RFC 3339 timestamp of when the list was created.
	CreatedOn string `json:"created_on,required"`
	// An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
	IP string `json:"ip,required"`
	// The RFC 3339 timestamp of when the list was last modified.
	ModifiedOn string `json:"modified_on,required"`
	// Defines an informative summary of the list item.
	Comment string                                     `json:"comment"`
	JSON    listItemGetResponseListsListItemIPFullJSON `json:"-"`
}

type ListItemGetResponseListsListItemRedirectFull struct {
	// Defines the unique ID of the item in the List.
	ID string `json:"id,required"`
	// The RFC 3339 timestamp of when the list was created.
	CreatedOn string `json:"created_on,required"`
	// The RFC 3339 timestamp of when the list was last modified.
	ModifiedOn string `json:"modified_on,required"`
	// The definition of the redirect.
	Redirect Redirect `json:"redirect,required"`
	// Defines an informative summary of the list item.
	Comment string                                           `json:"comment"`
	JSON    listItemGetResponseListsListItemRedirectFullJSON `json:"-"`
}

type ListItemGetResponseUnion interface {
	// contains filtered or unexported methods
}

type ListItemListParams struct {
	// The Account ID for this resource.
	AccountID param.Field[string] `path:"account_id,required"`
	// The pagination cursor. An opaque string token indicating the position from which
	// to continue when requesting the next/previous set of records. Cursor values are
	// provided under `result_info.cursors` in the response. You should make no
	// assumptions about a cursor's content or length.
	Cursor param.Field[string] `query:"cursor"`
	// Amount of results to include in each paginated response. A non-negative 32 bit
	// integer.
	PerPage param.Field[int64] `query:"per_page"`
	// A search query to filter returned items. Its meaning depends on the list type:
	// IP addresses must start with the provided string, hostnames and bulk redirects
	// must contain the string, and ASNs must match the string exactly.
	Search param.Field[string] `query:"search"`
}

type ListItemListResponse struct {
	// Defines the unique ID of the item in the List.
	ID string `json:"id,required"`
	// The RFC 3339 timestamp of when the list was created.
	CreatedOn string `json:"created_on,required"`
	// The RFC 3339 timestamp of when the list was last modified.
	ModifiedOn string `json:"modified_on,required"`
	// Defines a non-negative 32 bit integer.
	ASN int64 `json:"asn"`
	// Defines an informative summary of the list item.
	Comment string `json:"comment"`
	// Valid characters for hostnames are ASCII(7) letters from a to z, the digits from
	// 0 to 9, wildcards (\*), and the hyphen (-).
	Hostname Hostname `json:"hostname"`
	// An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
	IP string `json:"ip"`
	// The definition of the redirect.
	Redirect Redirect                 `json:"redirect"`
	JSON     listItemListResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

type ListItemListResponseListsListItemASNFull struct {
	// Defines the unique ID of the item in the List.
	ID string `json:"id,required"`
	// Defines a non-negative 32 bit integer.
	ASN int64 `json:"asn,required"`
	// The RFC 3339 timestamp of when the list was created.
	CreatedOn string `json:"created_on,required"`
	// The RFC 3339 timestamp of when the list was last modified.
	ModifiedOn string `json:"modified_on,required"`
	// Defines an informative summary of the list item.
	Comment string                                       `json:"comment"`
	JSON    listItemListResponseListsListItemASNFullJSON `json:"-"`
}

type ListItemListResponseListsListItemHostnameFull struct {
	// Defines the unique ID of the item in the List.
	ID string `json:"id,required"`
	// The RFC 3339 timestamp of when the list was created.
	CreatedOn string `json:"created_on,required"`
	// Valid characters for hostnames are ASCII(7) letters from a to z, the digits from
	// 0 to 9, wildcards (\*), and the hyphen (-).
	Hostname Hostname `json:"hostname,required"`
	// The RFC 3339 timestamp of when the list was last modified.
	ModifiedOn string `json:"modified_on,required"`
	// Defines an informative summary of the list item.
	Comment string                                            `json:"comment"`
	JSON    listItemListResponseListsListItemHostnameFullJSON `json:"-"`
}

type ListItemListResponseListsListItemIPFull struct {
	// Defines the unique ID of the item in the List.
	ID string `json:"id,required"`
	// The RFC 3339 timestamp of when the list was created.
	CreatedOn string `json:"created_on,required"`
	// An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
	IP string `json:"ip,required"`
	// The RFC 3339 timestamp of when the list was last modified.
	ModifiedOn string `json:"modified_on,required"`
	// Defines an informative summary of the list item.
	Comment string                                      `json:"comment"`
	JSON    listItemListResponseListsListItemIPFullJSON `json:"-"`
}

type ListItemListResponseListsListItemRedirectFull struct {
	// Defines the unique ID of the item in the List.
	ID string `json:"id,required"`
	// The RFC 3339 timestamp of when the list was created.
	CreatedOn string `json:"created_on,required"`
	// The RFC 3339 timestamp of when the list was last modified.
	ModifiedOn string `json:"modified_on,required"`
	// The definition of the redirect.
	Redirect Redirect `json:"redirect,required"`
	// Defines an informative summary of the list item.
	Comment string                                            `json:"comment"`
	JSON    listItemListResponseListsListItemRedirectFullJSON `json:"-"`
}

type ListItemListResponseUnion interface {
	// contains filtered or unexported methods
}

type ListItemNewParams struct {
	// The Account ID for this resource.
	AccountID param.Field[string]          `path:"account_id,required"`
	Body      []ListItemNewParamsBodyUnion `json:"body,required"`
}

type ListItemNewParamsBody struct {
	// Defines a non-negative 32 bit integer.
	ASN param.Field[int64] `json:"asn"`
	// Defines an informative summary of the list item.
	Comment param.Field[string] `json:"comment"`
	// Valid characters for hostnames are ASCII(7) letters from a to z, the digits from
	// 0 to 9, wildcards (\*), and the hyphen (-).
	Hostname param.Field[HostnameParam] `json:"hostname"`
	// An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
	IP param.Field[string] `json:"ip"`
	// The definition of the redirect.
	Redirect param.Field[RedirectParam] `json:"redirect"`
}

type ListItemNewParamsBodyListsListItemASNComment struct {
	// Defines a non-negative 32 bit integer.
	ASN param.Field[int64] `json:"asn,required"`
	// Defines an informative summary of the list item.
	Comment param.Field[string] `json:"comment"`
}

type ListItemNewParamsBodyListsListItemHostnameComment struct {
	// Valid characters for hostnames are ASCII(7) letters from a to z, the digits from
	// 0 to 9, wildcards (\*), and the hyphen (-).
	Hostname param.Field[HostnameParam] `json:"hostname,required"`
	// Defines an informative summary of the list item.
	Comment param.Field[string] `json:"comment"`
}

type ListItemNewParamsBodyListsListItemIPComment struct {
	// An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
	IP param.Field[string] `json:"ip,required"`
	// Defines an informative summary of the list item.
	Comment param.Field[string] `json:"comment"`
}

type ListItemNewParamsBodyListsListItemRedirectComment struct {
	// The definition of the redirect.
	Redirect param.Field[RedirectParam] `json:"redirect,required"`
	// Defines an informative summary of the list item.
	Comment param.Field[string] `json:"comment"`
}

type ListItemNewParamsBodyUnion interface {
	// contains filtered or unexported methods
}

type ListItemNewResponse struct {
	// The unique operation ID of the asynchronous action.
	OperationID string                  `json:"operation_id,required"`
	JSON        listItemNewResponseJSON `json:"-"`
}

type ListItemNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   ListItemNewResponse   `json:"result,required"`
	// Defines whether the API call was successful.
	Success ListItemNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    listItemNewResponseEnvelopeJSON    `json:"-"`
}

type ListItemNewResponseEnvelopeSuccess bool

type ListItemService struct {
	Options []option.RequestOption
}

type ListItemUpdateParams struct {
	// The Account ID for this resource.
	AccountID param.Field[string]             `path:"account_id,required"`
	Body      []ListItemUpdateParamsBodyUnion `json:"body,required"`
}

type ListItemUpdateParamsBody struct {
	// Defines a non-negative 32 bit integer.
	ASN param.Field[int64] `json:"asn"`
	// Defines an informative summary of the list item.
	Comment param.Field[string] `json:"comment"`
	// Valid characters for hostnames are ASCII(7) letters from a to z, the digits from
	// 0 to 9, wildcards (\*), and the hyphen (-).
	Hostname param.Field[HostnameParam] `json:"hostname"`
	// An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
	IP param.Field[string] `json:"ip"`
	// The definition of the redirect.
	Redirect param.Field[RedirectParam] `json:"redirect"`
}

type ListItemUpdateParamsBodyListsListItemASNComment struct {
	// Defines a non-negative 32 bit integer.
	ASN param.Field[int64] `json:"asn,required"`
	// Defines an informative summary of the list item.
	Comment param.Field[string] `json:"comment"`
}

type ListItemUpdateParamsBodyListsListItemHostnameComment struct {
	// Valid characters for hostnames are ASCII(7) letters from a to z, the digits from
	// 0 to 9, wildcards (\*), and the hyphen (-).
	Hostname param.Field[HostnameParam] `json:"hostname,required"`
	// Defines an informative summary of the list item.
	Comment param.Field[string] `json:"comment"`
}

type ListItemUpdateParamsBodyListsListItemIPComment struct {
	// An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
	IP param.Field[string] `json:"ip,required"`
	// Defines an informative summary of the list item.
	Comment param.Field[string] `json:"comment"`
}

type ListItemUpdateParamsBodyListsListItemRedirectComment struct {
	// The definition of the redirect.
	Redirect param.Field[RedirectParam] `json:"redirect,required"`
	// Defines an informative summary of the list item.
	Comment param.Field[string] `json:"comment"`
}

type ListItemUpdateParamsBodyUnion interface {
	// contains filtered or unexported methods
}

type ListItemUpdateResponse struct {
	// The unique operation ID of the asynchronous action.
	OperationID string                     `json:"operation_id,required"`
	JSON        listItemUpdateResponseJSON `json:"-"`
}

type ListItemUpdateResponseEnvelope struct {
	Errors   []shared.ResponseInfo  `json:"errors,required"`
	Messages []shared.ResponseInfo  `json:"messages,required"`
	Result   ListItemUpdateResponse `json:"result,required"`
	// Defines whether the API call was successful.
	Success ListItemUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    listItemUpdateResponseEnvelopeJSON    `json:"-"`
}

type ListItemUpdateResponseEnvelopeSuccess bool

type ListListParams struct {
	// The Account ID for this resource.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ListNewParams struct {
	// The Account ID for this resource.
	AccountID param.Field[string] `path:"account_id,required"`
	// The type of the list. Each type supports specific list items (IP addresses,
	// ASNs, hostnames or redirects).
	Kind param.Field[ListNewParamsKind] `json:"kind,required"`
	// An informative name for the list. Use this name in filter and rule expressions.
	Name param.Field[string] `json:"name,required"`
	// An informative summary of the list.
	Description param.Field[string] `json:"description"`
}

type ListNewParamsKind string

type ListNewResponse struct {
	// The unique ID of the list.
	ID string `json:"id,required"`
	// The RFC 3339 timestamp of when the list was created.
	CreatedOn string `json:"created_on,required"`
	// The type of the list. Each type supports specific list items (IP addresses,
	// ASNs, hostnames or redirects).
	Kind ListNewResponseKind `json:"kind,required"`
	// The RFC 3339 timestamp of when the list was last modified.
	ModifiedOn string `json:"modified_on,required"`
	// An informative name for the list. Use this name in filter and rule expressions.
	Name string `json:"name,required"`
	// The number of items in the list.
	NumItems float64 `json:"num_items,required"`
	// The number of [filters](/api/resources/filters/) referencing the list.
	NumReferencingFilters float64 `json:"num_referencing_filters,required"`
	// An informative summary of the list.
	Description string              `json:"description"`
	JSON        listNewResponseJSON `json:"-"`
}

type ListNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   ListNewResponse       `json:"result,required"`
	// Defines whether the API call was successful.
	Success ListNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    listNewResponseEnvelopeJSON    `json:"-"`
}

type ListNewResponseEnvelopeSuccess bool

type ListNewResponseKind string

type ListService struct {
	Options        []option.RequestOption
	BulkOperations *ListBulkOperationService
	Items          *ListItemService
}

type ListUpdateParams struct {
	// The Account ID for this resource.
	AccountID param.Field[string] `path:"account_id,required"`
	// An informative summary of the list.
	Description param.Field[string] `json:"description"`
}

type ListUpdateResponse struct {
	// The unique ID of the list.
	ID string `json:"id,required"`
	// The RFC 3339 timestamp of when the list was created.
	CreatedOn string `json:"created_on,required"`
	// The type of the list. Each type supports specific list items (IP addresses,
	// ASNs, hostnames or redirects).
	Kind ListUpdateResponseKind `json:"kind,required"`
	// The RFC 3339 timestamp of when the list was last modified.
	ModifiedOn string `json:"modified_on,required"`
	// An informative name for the list. Use this name in filter and rule expressions.
	Name string `json:"name,required"`
	// The number of items in the list.
	NumItems float64 `json:"num_items,required"`
	// The number of [filters](/api/resources/filters/) referencing the list.
	NumReferencingFilters float64 `json:"num_referencing_filters,required"`
	// An informative summary of the list.
	Description string                 `json:"description"`
	JSON        listUpdateResponseJSON `json:"-"`
}

type ListUpdateResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   ListUpdateResponse    `json:"result,required"`
	// Defines whether the API call was successful.
	Success ListUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    listUpdateResponseEnvelopeJSON    `json:"-"`
}

type ListUpdateResponseEnvelopeSuccess bool

type ListUpdateResponseKind string

type ListsList struct {
	// The unique ID of the list.
	ID string `json:"id,required"`
	// The RFC 3339 timestamp of when the list was created.
	CreatedOn string `json:"created_on,required"`
	// The type of the list. Each type supports specific list items (IP addresses,
	// ASNs, hostnames or redirects).
	Kind ListsListKind `json:"kind,required"`
	// The RFC 3339 timestamp of when the list was last modified.
	ModifiedOn string `json:"modified_on,required"`
	// An informative name for the list. Use this name in filter and rule expressions.
	Name string `json:"name,required"`
	// The number of items in the list.
	NumItems float64 `json:"num_items,required"`
	// The number of [filters](/api/resources/filters/) referencing the list.
	NumReferencingFilters float64 `json:"num_referencing_filters,required"`
	// An informative summary of the list.
	Description string        `json:"description"`
	JSON        listsListJSON `json:"-"`
}

type ListsListKind string

type Member = shared.Member

type MemberPoliciesAccess = shared.MemberPoliciesAccess

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

type MemberPolicy = shared.MemberPolicy

type MemberStatus = shared.MemberStatus

type MemberUser = shared.MemberUser

type Permission = shared.Permission

type PermissionGrant = shared.PermissionGrant

type PermissionGrantParam = shared.PermissionGrantParam

type RatePlan = shared.RatePlan

type RatePlanID = shared.RatePlanID

type RatePlanParam = shared.RatePlanParam

type Redirect struct {
	SourceURL           string             `json:"source_url,required"`
	TargetURL           string             `json:"target_url,required"`
	IncludeSubdomains   bool               `json:"include_subdomains"`
	PreservePathSuffix  bool               `json:"preserve_path_suffix"`
	PreserveQueryString bool               `json:"preserve_query_string"`
	StatusCode          RedirectStatusCode `json:"status_code"`
	SubpathMatching     bool               `json:"subpath_matching"`
	JSON                redirectJSON       `json:"-"`
}

type RedirectParam struct {
	SourceURL           param.Field[string]             `json:"source_url,required"`
	TargetURL           param.Field[string]             `json:"target_url,required"`
	IncludeSubdomains   param.Field[bool]               `json:"include_subdomains"`
	PreservePathSuffix  param.Field[bool]               `json:"preserve_path_suffix"`
	PreserveQueryString param.Field[bool]               `json:"preserve_query_string"`
	StatusCode          param.Field[RedirectStatusCode] `json:"status_code"`
	SubpathMatching     param.Field[bool]               `json:"subpath_matching"`
}

type RedirectStatusCode int64

type ResponseInfo = shared.ResponseInfo

type ResponseInfoSource = shared.ResponseInfoSource

type Role = shared.Role

type RoleParam = shared.RoleParam

type RolePermissions = shared.RolePermissions

type RolePermissionsParam = shared.RolePermissionsParam

type RuleService struct {
	Options []option.RequestOption
	Lists   *ListService
}

type SortDirection = shared.SortDirection

type Subscription = shared.Subscription

type SubscriptionFrequency = shared.SubscriptionFrequency

type SubscriptionParam = shared.SubscriptionParam

type SubscriptionState = shared.SubscriptionState

type Token = shared.Token

type TokenCondition = shared.TokenCondition

type TokenConditionCIDRList = shared.TokenConditionCIDRList

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

type TokenConditionParam = shared.TokenConditionParam

type TokenConditionRequestIP = shared.TokenConditionRequestIP

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

type TokenParam = shared.TokenParam

type TokenPolicy = shared.TokenPolicy

type TokenPolicyEffect = shared.TokenPolicyEffect

type TokenPolicyParam = shared.TokenPolicyParam

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

type TokenStatus = shared.TokenStatus

type TokenValue = shared.TokenValue