apns

const (
	// ReasonPayloadEmpty represents a reason for error due to a payload empty
	ReasonPayloadEmpty APIReason = "PayloadEmpty"

	// ReasonPayloadTooLarge represents a resason that the payload exceeded the
	// maximum size of 4096 bytes
	ReasonPayloadTooLarge APIReason = "PayloadTooLarge"

	// ReasonBadTopic represents a resason that the topic was either not
	// specified
	ReasonBadTopic APIReason = "BadTopic"

	//ReasonTopicDisallowed represents a reason that the specified topic is not
	//allowed
	ReasonTopicDisallowed APIReason = "TopicDisallowed"

	// ReasonBadMessageID represents a reason that the message id specified is
	// bad
	ReasonBadMessageID APIReason = "BadMessageId"

	// ReasonBadExpirationDate represents a reason that the specified expiration
	// date is not a good one.
	ReasonBadExpirationDate APIReason = "BadExpirationDate"

	// ReasonBadPriority represents a reason that specifies that the priority
	// specified was not valid given the rest of the notification, or just an
	// invalid number
	ReasonBadPriority APIReason = "BadPriority"

	// ReasonMissingDeviceToken represents a reason that specifies that the
	// device token was not specified, and therefore no push could be delivered
	ReasonMissingDeviceToken APIReason = "MissingDeviceToken"

	// ReasonBadDeviceToken represents a reason that specifies that the device
	// Toekn is not a valid one.
	ReasonBadDeviceToken APIReason = "BadDeviceToken"

	// ReasonDeviceTokenNotForTopic represents a reason that specifies that the
	// specified device token hasn't subscribed for push subscriptions for the
	// given topic.
	ReasonDeviceTokenNotForTopic APIReason = "DeviceTokenNotForTopic"

	// ReasonUnregistered represetns a reason that specifies that the device
	// token has unregistered for notifications for the given topic.
	ReasonUnregistered APIReason = "Unregistered"

	// ReasonDuplicateHeaders represents a reason that specifies that one or
	// more headers were repeated.
	ReasonDuplicateHeaders APIReason = "DuplicateHeaders"

	// ReasonBadCertificateEnvironment represents a reason that indicates that
	// the certificate supplied does not match the request environment.
	ReasonBadCertificateEnvironment APIReason = "BadCertificateEnvironment"

	// ReasonBadCertificate represents a reason that the certificate specified
	// is not a valid certificate.
	ReasonBadCertificate APIReason = "BadCertificate"

	// ReasonForbidden represents a reason that specifies that the action
	// requested is not valid.
	ReasonForbidden APIReason = "Forbidden"

	// ReasonBadPath represents a reason that specifies that the path specified
	// is not a good one.
	ReasonBadPath APIReason = "BadPath"

	// ReasonMethodNotAllowed represents a reason that specifies that the
	// request method is not allowed.  The only one allowed, currently is POST.
	ReasonMethodNotAllowed APIReason = "MethodNotAllowed"

	// ReasonTooManyRequests represents a reason that indicates that too many
	// requests have been made to the same device token.
	ReasonTooManyRequests APIReason = "TooManyRequests"

	// ReasonIdleTimeout represents a reason that the given connection has timed
	// out after being idle for too long.
	ReasonIdleTimeout APIReason = "IdleTimeout"

	// ReasonShutdown represents a reason that the APN service is shutting down
	// and the connections are to be terminated.
	ReasonShutdown APIReason = "Shutdown"

	// ReasonInternalServerError represents a reason that indicates that the
	// APN service encountered an internal error while processing your request.
	ReasonInternalServerError APIReason = "InternalServerError"

	// ReasonServiceUnavailable represents a reason that indicates that the
	// APN Service is unavailable.
	ReasonServiceUnavailable APIReason = "ServiceUnavailable"

	// ReasonMissingTopic represents a reason that indicates that the topic is
	// missing from the Notification, and cannot be inferred from the
	// certificate.
	ReasonMissingTopic APIReason = "MissingTopic"
)

const (
	// RespNoError represents a non-error
	RespNoError AppleResponseCode = iota

	// RespProcessingError represents an error in processing the request. This
	// is likely an internal error on Apple's APN service part.
	RespProcessingError

	// RespMissingDeviceToken represents an error that indicates that no device
	// token was specified.
	RespMissingDeviceToken

	// RespMissingTopic represents an error that indicates that no topic was
	// specified within the push request.
	RespMissingTopic

	// RespMissingPayload represents an error that indicates that no payload
	// was contained within the push request.  In general this means there was
	// not anything to be pushed to the device.
	RespMissingPayload

	// RespInvalidTokenSize represents an error that indicates a token had an
	// invalid length
	RespInvalidTokenSize

	// RespInvalidTopicSize represents an error that indicates that a topic had
	// an invalid length
	RespInvalidTopicSize

	// RespInvalidPayloadSize represents an erro that indicates that a palyload
	// had an invalid length
	RespInvalidPayloadSize

	// RespInvalidToken represents an error that indicates that the specified
	// token was no valid for a push subscription.  If encountered, you should
	// remove the push subscription token from use.
	RespInvalidToken

	// RespShutdown represents an error that indicates the Apple's APN service
	// has closed this connection, likely used for maintenance.  This does not
	// neccessarily indicate an error with the push itself.
	RespShutdown AppleResponseCode = 10

	// RespUnknown represents an error that indicates an unknown cause.
	RespUnknown AppleResponseCode = 255
)