kmx.io/ex_ovh/lib/query/ovh/webstorage/query.ex

• Show log

  Commit

• Hash : 2cbab347
  Author :
  Date : 2016-02-18T22:44:55
  

  change to Webstorage.Request

Download

• lib/query/ovh/webstorage/query.ex

• defmodule ExOvh.Query.Ovh.Webstorage do
    @moduledoc ~S"""
    Helper functions for to building queries to the `/cdn/webstorage` part of the custom ovh api.
  
    The raw query can be passed into a client request.
  
      ## Example
  
        import ExOvh.Query.Ovh.Webstorage
        query = get_all_webstorage()
        ExOvh.ovh_request(query, %{})
    """
    alias ExOvh.Ovh.OvhApi.Cache, as: OvhApiCache
  
  
  
    @doc ~S"""
    GET /v1/​cdn/webstorage​, Get a list of all webstorage cdn services available for the client account
  
    ### Example usage
  
        import ExOvh.Query.Ovh.Webstorage
        ExOvh.ovh_request(get_all_webstorage(), %{})
    """
    @spec get_all_webstorage() :: ExOvh.Client.raw_query_t
    def get_all_webstorage(), do: {:get, "/cdn/webstorage", :nil}
  
  
  
    @doc ~S"""
    GET /v1/​cdn/webstorage​/{serviceName}, Get the domain, server and storage limits for a specific webstorage cdn service
  
    ### Example usage
  
        import ExOvh.Query.Ovh.Webstorage
        service_name = "cdnwebstorage-????"
        {:ok, resp} = ExOvh.ovh_request(get_webstorage_service(service_name), %{})
        %{
          "domain" => domain,
          "storageLimit => storage_limit,
          "server" => server
         } = resp.body
    """
    @spec get_webstorage_service(service_name :: String.t)
                                 :: ExOvh.Client.raw_query_t
    def get_webstorage_service(service_name), do: {:get, "/cdn/webstorage/", service_name}
  
  
  
    @doc ~S"""
    GET /v1/​cdn/webstorage​/{serviceName}/serviceInfos, Get a administrative details for a specific webstorage cdn service
  
    ### Example usage
  
        import ExOvh.Query.Ovh.Webstorage
        service_name = "cdnwebstorage-????"
        {:ok, resp} = ExOvh.ovh_request(get_webstorage_service_info(service_name), %{})
    """
    @spec get_webstorage_service_info(service_name :: String.t)
                                 :: ExOvh.Client.raw_query_t
    def get_webstorage_service_info(service_name), do: {:get, "/cdn/webstorage/#{service_name}/serviceInfos", :nil}
  
  
  
    @doc ~S"""
    GET /v1/​cdn/webstorage​/{serviceName}/statistics, Get statistics for a specific webstorage cdn service
  
      `period can be "month", "week" or "day"`
      `type can be "backend", "quota" or "cdn"`
  
    ### Example usage
  
        import ExOvh.Query.Ovh.Webstorage
        # service_name = "cdnwebstorage-????"
        {:ok, resp} = ExOvh.ovh_request(get_webstorage_service_stats(service_name, "month", "backend"), %{})
    """
    @spec get_webstorage_service_stats(service_name :: String.t, period :: String.t, type :: String.t)
                                 :: ExOvh.Client.raw_query_t
    def get_webstorage_service_stats(service_name, period \\ "month", type \\ "cdn") do
      {:get, "/cdn/webstorage/#{service_name}/statistics", %{"period" => period, "type" => type} }
    end
  
  
  
    @doc ~S"""
    GET /v1/​cdn/webstorage​/{serviceName}/credentials, Get credentials for using the swift compliant api
  
    ### Example usage
  
        import ExOvh.Query.Ovh.Webstorage
        # service_name = "cdnwebstorage-????"
        {:ok, resp} = ExOvh.ovh_request(get_webstorage_credentials(service_name), %{})
    """
    @spec get_webstorage_credentials(service_name :: String.t)
                                 :: ExOvh.Client.raw_query_t
    def get_webstorage_credentials(service_name), do: {:get, "/cdn/webstorage/#{service_name}/credentials", :nil}
  
  
  
  
  end
  
  
  
  
  
  
  
  
  

Download