ExKeyCDN.ZoneBehaviour behaviour (exkeycdn v0.0.1)

Zone Behaviour

Link to this section Summary

Callbacks

Add

List

Purge Cache

Returns zone based on id

Link to this section Callbacks

Specs

add(ExKeyCDN.Zone) ::
  [
    limits: [rate_limit_remaining: binary(), rate_limit: binary()],
    zone: ExKeyCDN.Zone
  ]
  | {:error, binary() | ExKeyCDN.ErrorResponse.t()}

Add

Link to this callback

delete(integer)

Specs

delete(integer()) ::
  [
    limits: [rate_limit_remaining: binary(), rate_limit: binary()],
    zone: :deleted
  ]
  | {:error, binary() | ExKeyCDN.ErrorResponse.t()}

Delete

Link to this callback

edit(integer, map)

Specs

edit(integer(), map()) ::
  [
    limits: [rate_limit_remaining: binary(), rate_limit: binary()],
    zone: ExKeyCDN.Zone
  ]
  | {:error, binary() | ExKeyCDN.ErrorResponse.t()}

Edit

Specs

list() ::
  [
    limits: [rate_limit_remaining: binary(), rate_limit: binary()],
    zones: [ExKeyCDN.Zone]
  ]
  | {:error, binary() | ExKeyCDN.ErrorResponse.t()}

List

Link to this callback

purge_cache(integer)

Specs

purge_cache(integer()) ::
  [
    limits: [rate_limit_remaining: binary(), rate_limit: binary()],
    zone: :cache_purged
  ]
  | {:error, binary() | ExKeyCDN.ErrorResponse.t()}

Purge Cache

Link to this callback

purge_url(integer, list)

Specs

purge_url(integer(), list()) ::
  [
    limits: [rate_limit_remaining: binary(), rate_limit: binary()],
    zone: :url_purged
  ]
  | {:error, binary() | ExKeyCDN.ErrorResponse.t()}

Purge URL

Specs

view(integer()) ::
  [
    limits: [rate_limit_remaining: binary(), rate_limit: binary()],
    zone: ExKeyCDN.Zone
  ]
  | {:error, binary() | ExKeyCDN.ErrorResponse.t()}

Returns zone based on id