package otoggl

  1. Overview
  2. Docs
Bindings for Toggl API in OCaml

Install

Dune Dependency

Authors

Maintainers

Sources

dev-0.3.2.tbz
sha256=22ee2dc184836891b833d6791bea35f583e24bb2ce87ae4f6e5dcbdb272dc4c9
sha512=89508c18662001029e6d3707dae82edd67a17a7fecc200d7c0da3c4ac8f45b6676e0dec69483234f2170b31451f36735903c89e85cb2a713fe8a4df327964f74

doc/otoggl.lib/Toggl/Auth/module-type-Client/index.html

Module type Auth.ClientSource

type t
val create : ?config:Piaf.Config.t -> Uri.t -> (t, Piaf.Error.t) Lwt_result.t

create ?config uri opens a connection to uri (initially) that can be used to issue multiple requests to the remote endpoint.

A client instance represents a connection to a single remote endpoint, and the remaining functions in this module will issue requests to that endpoint only.

val head : t -> ?headers:(string * string) list -> string -> (Piaf.Response.t, Piaf.Error.t) Lwt_result.t
val get : t -> ?headers:(string * string) list -> string -> (Piaf.Response.t, Piaf.Error.t) Lwt_result.t
val post : t -> ?headers:(string * string) list -> ?body:Piaf.Body.t -> string -> (Piaf.Response.t, Piaf.Error.t) Lwt_result.t
val put : t -> ?headers:(string * string) list -> ?body:Piaf.Body.t -> string -> (Piaf.Response.t, Piaf.Error.t) Lwt_result.t
val patch : t -> ?headers:(string * string) list -> ?body:Piaf.Body.t -> string -> (Piaf.Response.t, Piaf.Error.t) Lwt_result.t
val delete : t -> ?headers:(string * string) list -> ?body:Piaf.Body.t -> string -> (Piaf.Response.t, Piaf.Error.t) Lwt_result.t
val request : t -> ?headers:(string * string) list -> ?body:Piaf.Body.t -> meth:Piaf.Method.t -> string -> (Piaf.Response.t, Piaf.Error.t) Lwt_result.t
val shutdown : t -> unit Lwt.t

shutdown t tears down the connection t and frees up all the resources associated with it.

module Oneshot : sig ... end
OCaml

Innovation. Community. Security.