# README

Akamai Property Manager API (PAPI)

A golang package which facilitates making requests to the Akamai OPEN Property Manager API.

# Functions

GetAvailableBehaviors retrieves all available behaviors for a property.
GetAvailableCriteria retrieves all available criteria for a property.
GetContracts retrieves all contracts.
GetCpCodes creates a new CpCodes struct and populates it with all CP Codes associated with a contract/group API Docs: https://developer.akamai.com/api/luna/papi/resources.html#listcpcodes.
GetEdgeHostnames retrieves all edge hostnames.
GetGroups retrieves all groups.
GetProducts retrieves all products.
GetProperties retrieves all properties for a given contract/group.
GetVersions retrieves all versions for a given property.
Init sets the PAPI edgegrid Config.
NewActivation creates a new Activation.
NewActivations creates a new Activations.
NewAvailableBehavior creates a new AvailableBehavior.
NewAvailableBehaviors creates a new AvailableBehaviors.
NewAvailableCriteria creates a new AvailableCriteria.
NewBehavior creates a new Behavior.
NewClientSettings creates a new ClientSettings.
NewClonePropertyFrom creates a new ClonePropertyFrom.
NewContract creates a new Contract.
NewContracts creates a new Contracts.
NewCpCode creates a new *CpCode.
NewCpCodes creates a new *CpCodes.
NewCriteria creates a new Criteria.
NewCustomBehavior creates a new *CustomBehavior.
NewCustomBehaviors creates a new *CustomBehaviors.
NewCustomOverride creates a new *CustomOverride.
NewCustomOverrides creates a new *CustomOverrides.
NewEdgeHostname creates a new EdgeHostname.
NewEdgeHostnames creates a new EdgeHostnames.
NewGroup creates a new Group.
NewGroups creates a new Groups.
NewHostname creates a new Hostname.
NewHostnames creates a new Hostnames.
NewProduct creates a new Product.
NewProducts creates a new Products.
NewProperties creates a new Properties.
NewProperty creates a new Property.
NewRule creates a new Rule.
NewRuleErrors creates a new RuleErrors.
NewRuleFormats creates a new RuleFormats.
NewRules creates a new Rules.
NewVariable creates a new Variable.
NewVersion creates a new Version.
NewVersions creates a new Versions.
Search searches for properties API Docs: https://developer.akamai.com/api/luna/papi/resources.html#postfindbyvalue Endpoint: POST /papi/v1/search/find-by-value.

# Constants

ActivationTypeActivate Activation.ActivationType value ACTIVATE.
ActivationTypeDeactivate Activation.ActivationType value DEACTIVATE.
CnameTypeEdgeHostname Hostname.CnameType value EDGE_HOSTNAME.
Error constants.
Error constants.
Error constants.
Error constants.
Error constants.
Error constants.
NetworkProduction Activation.Network value PRODUCTION.
NetworkStaging Activation.Network value STAGING.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
StatusAborted Activation.Status value ABORTED.
StatusActive Activation.Status value ACTIVE.
StatusDeactivated Activation.Status value DEACTIVATED.
StatusFailed Activation.Status value FAILED.
StatusInactive Activation.Status value INACTIVE.
StatusNew Activation.Status value NEW.
StatusPending Activation.Status value PENDING.
StatusPendingDeactivation Activation.Status value PENDING_DEACTIVATION.
StatusZone1 Activation.Status value ZONE_1.
StatusZone2 Activation.Status value ZONE_2.
StatusZone3 Activation.Status value ZONE_3.

# Variables

No description provided by the author
No description provided by the author

# Structs

Activation represents a property activation resource.
No description provided by the author
Activations is a collection of property activations.
AvailableBehavior represents an available behavior resource.
AvailableBehaviors represents a collection of available rule behaviors.
AvailableCriteria represents a collection of available rule criteria.
Behavior represents a rule behavior resource.
ClientSettings represents the PAPI client settings resource.
ClonePropertyFrom represents.
Contract represents a property contract resource.
Contracts represents a collection of property manager contracts.
CpCode represents a single CP Code API Docs: https://developer.akamai.com/api/luna/papi/data.html#cpcode.
CpCodes represents a collection of CP Codes See: CpCodes.GetCpCodes() API Docs: https://developer.akamai.com/api/luna/papi/data.html#cpcode.
Criteria represents a rule criteria resource.
CustomBehavior represents a single Custom Behavior API Docs: https://developer.akamai.com/api/luna/papi/data.html#custombehavior.
CustomBehaviors represents a collection of Custom Behaviors See: CustomBehaviors.GetCustomBehaviors() API Docs: https://developer.akamai.com/api/luna/papi/data.html#custombehavior.
CustomOverride represents a single Custom Override API Docs: https://developer.akamai.com/api/luna/papi/data.html#customoverride.
CustomOverrides represents a collection of Custom Overrides See: CustomerOverrides.GetCustomOverrides() API Docs: https://developer.akamai.com/api/luna/papi/data.html#cpcode.
EdgeHostname represents an Edge Hostname resource.
EdgeHostnames is a collection for PAPI Edge Hostname resources.
Group represents a group resource.
Groups represents a collection of PAPI groups.
Hostname represents a property hostname resource.
Hostnames is a collection of Property Hostnames.
Product represents a product resource.
Products represents a collection of products.
Properties is a collection of PAPI Property resources.
Property represents a PAPI Property.
Rule represents a property rule resource.
RuleErrors represents an validate error returned for a rule.
RuleFormats is a collection of available rule formats.
Rules is a collection of property rules.
No description provided by the author
No description provided by the author
Version represents a Property Version.
Versions contains a collection of Property Versions.

# Type aliases

ActivationValue is used to create an "enum" of possible Activation.ActivationType values.
CnameTypeValue is used to create an "enum" of possible Hostname.CnameType values.
NetworkValue is used to create an "enum" of possible Activation.Network values.
OptionValue represents a generic option value OptionValue is a map with string keys, and any type of value.
No description provided by the author
No description provided by the author
StatusValue is used to create an "enum" of possible Activation.Status values.