package otoggl

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package otoggl

otoggl.lib
- Toggl
  - Api
    
    F
    
    Client
    
    Oneshot
    
    Project
    
    TimeEntry
    
    Workspace
  - Auth
    
    Client
    
    Authentication
    
    Oneshot
  - Toggl_j
  - Toggl_t
  - Toggl_v
  - Types
  - Util

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module Authentication : sig ... end

Signature

type t = Piaf.Client.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