zonefirewallaccessrulesv1

type CreateZoneAccessRuleOptions struct {
	// The action to apply to a matched request.
	Mode *string `json:"mode,omitempty"`

	// A personal note about the rule. Typically used as a reminder or explanation for the rule.
	Notes *string `json:"notes,omitempty"`

	// Configuration object specifying access rule.
	Configuration *ZoneAccessRuleInputConfiguration `json:"configuration,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type DeleteZoneAccessRuleOptions struct {
	// Identifier of the access rule to be deleted.
	AccessruleIdentifier *string `json:"accessrule_identifier" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type DeleteZoneAccessRuleResp struct {
	// Operation success flag.
	Success *bool `json:"success" validate:"required"`

	// Array of errors encountered.
	Errors [][]string `json:"errors" validate:"required"`

	// Array of messages returned.
	Messages [][]string `json:"messages" validate:"required"`

	// Container for response information.
	Result *DeleteZoneAccessRuleRespResult `json:"result" validate:"required"`
}

type DeleteZoneAccessRuleRespResult struct {
	// ID.
	ID *string `json:"id" validate:"required"`
}

type GetZoneAccessRuleOptions struct {
	// Identifier of firewall access rule for the given zone.
	AccessruleIdentifier *string `json:"accessrule_identifier" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListAllZoneAccessRulesOptions struct {
	// Search access rules by note.(Not case sensitive).
	Notes *string `json:"notes,omitempty"`

	// Search access rules by mode.
	Mode *string `json:"mode,omitempty"`

	// Search access rules by configuration target.
	ConfigurationTarget *string `json:"configuration.target,omitempty"`

	// Search access rules by configuration value which can be IP, IPrange, or country code.
	ConfigurationValue *string `json:"configuration.value,omitempty"`

	// Page number of paginated results.
	Page *int64 `json:"page,omitempty"`

	// Maximum number of access rules per page.
	PerPage *int64 `json:"per_page,omitempty"`

	// Field by which to order list of access rules.
	Order *string `json:"order,omitempty"`

	// Direction in which to order results [ascending/descending order].
	Direction *string `json:"direction,omitempty"`

	// Whether to match all (all) or atleast one search parameter (any).
	Match *string `json:"match,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListZoneAccessRulesResp struct {
	// Operation success flag.
	Success *bool `json:"success" validate:"required"`

	// Array of errors encountered.
	Errors [][]string `json:"errors" validate:"required"`

	// Array of messages returned.
	Messages [][]string `json:"messages" validate:"required"`

	// Container for response information.
	Result []ZoneAccessRuleObject `json:"result" validate:"required"`

	// Statistics of results.
	ResultInfo *ListZoneAccessRulesRespResultInfo `json:"result_info" validate:"required"`
}

type ListZoneAccessRulesRespResultInfo struct {
	// Page number.
	Page *int64 `json:"page" validate:"required"`

	// Number of results per page.
	PerPage *int64 `json:"per_page" validate:"required"`

	// Number of results.
	Count *int64 `json:"count" validate:"required"`

	// Total number of results.
	TotalCount *int64 `json:"total_count" validate:"required"`
}

type UpdateZoneAccessRuleOptions struct {
	// Identifier of firewall access rule.
	AccessruleIdentifier *string `json:"accessrule_identifier" validate:"required,ne="`

	// The action to apply to a matched request.
	Mode *string `json:"mode,omitempty"`

	// A personal note about the rule. Typically used as a reminder or explanation for the rule.
	Notes *string `json:"notes,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ZoneAccessRuleInputConfiguration struct {
	// The request property to target.
	Target *string `json:"target" validate:"required"`

	// The value for the selected target.For ip the value is a valid ip address.For ip_range the value specifies ip range
	// limited to /16 and /24. For asn the value is an AS number. For country the value is a country code for the country.
	Value *string `json:"value" validate:"required"`
}

type ZoneAccessRuleObject struct {
	// Identifier of the firewall access rule.
	ID *string `json:"id" validate:"required"`

	// A personal note about the rule. Typically used as a reminder or explanation for the rule.
	Notes *string `json:"notes" validate:"required"`

	// List of modes that are allowed.
	AllowedModes []string `json:"allowed_modes" validate:"required"`

	// The action to be applied to a request matching the access rule.
	Mode *string `json:"mode" validate:"required"`

	// The scope definition of the access rule.
	Scope *ZoneAccessRuleObjectScope `json:"scope,omitempty"`

	// The creation date-time of the firewall access rule.
	CreatedOn *string `json:"created_on" validate:"required"`

	// The modification date-time of the firewall access rule.
	ModifiedOn *string `json:"modified_on" validate:"required"`

	// configuration.
	Configuration *ZoneAccessRuleObjectConfiguration `json:"configuration" validate:"required"`
}

type ZoneAccessRuleObjectConfiguration struct {
	// target.
	Target *string `json:"target" validate:"required"`

	// Value for the given target. For ip the value is a valid ip address.For ip_range the value specifies ip range limited
	// to /16 and /24. For asn the value is an AS number. For country the value is a country code for the country.
	Value *string `json:"value" validate:"required"`
}

type ZoneAccessRuleObjectScope struct {
	// The scope of the access rule, indicating if its applicable at zone level("zone") or inherited from instance
	// level("account").
	Type *string `json:"type" validate:"required"`
}

type ZoneAccessRuleResp struct {
	// Operation success flag.
	Success *bool `json:"success" validate:"required"`

	// Array of errors encountered.
	Errors [][]string `json:"errors" validate:"required"`

	// Array of messages returned.
	Messages [][]string `json:"messages" validate:"required"`

	// access rule object.
	Result *ZoneAccessRuleObject `json:"result" validate:"required"`
}

type ZoneFirewallAccessRulesV1 struct {
	Service *core.BaseService

	// Full crn of the service instance.
	Crn *string

	// Identifier of zone whose access rule is to be deleted.
	ZoneIdentifier *string
}

type ZoneFirewallAccessRulesV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator

	// Full crn of the service instance.
	Crn *string `validate:"required"`

	// Identifier of zone whose access rule is to be deleted.
	ZoneIdentifier *string `validate:"required"`
}