Packages

smartsheet

2.3.0
2.5.3 2.5.2 2.5.1 2.5.0 2.4.0 2.3.1 2.3.0 2.2.0 2.1.0 2.0.0 1.1.0 1.0.0 0.1.0

HTTP wrapper around the Smartsheet API

HexDocs

Current section

Files

Jump to
Readme
13 Versions
3 Dependencies
Dependants
Files
Activity
smartsheet lib smartsheet client_behaviour.ex
Raw

lib/smartsheet/client_behaviour.ex 

defmodule Smartsheet.ClientBehaviour do

  @callback get_sheet(String.t(), List) ::

              {:ok, Smartsheet.Response.t(), Smartsheet.Sheet.t()}

              | {:error, Smartsheet.Response.t()}



  @callback create_sheet(map()) ::

              {:ok, Smartsheet.Response.t(), Smartsheet.Sheet.t()}

              | {:error, Smartsheet.Response.t()}

              | {:internal_error, atom()}

  @callback get_columns(String.t(), List) ::

              {:ok, Smartsheet.Response.t(), [Smartsheet.Column]}

              | {:error, Smartsheet.Response.t()}

              | {:internal_error, atom()}



  @callback add_rows(String.t(), any) ::

              {:ok, Smartsheet.Response.t(), [Smartsheet.Row.t()]}

              | {:error, Smartsheet.Response.t()}

              | {:internal_error, atom()}



  @callback update_rows(String.t(), any) ::

              {:ok, Smartsheet.Response.t(), [Smartsheet.Row.t()]}

              | {:error, Smartsheet.Response.t()}

              | {:internal_error, atom()}



  @callback get_row(String.t(), String.t()) ::

              {:ok, Smartsheet.Response.t(), Smartsheet.Row.t()}

              | {:error, Smartsheet.Response.t()}

              | {:internal_error, atom()}



  @callback add_webhook(map()) ::

              {:ok, Smartsheet.Response.t(), Smartsheet.Webhook.t()}

              | {:error, Smartsheet.Response.t()}

              | {:internal_error, atom()}



  @callback update_webhook(String.t(), map()) ::

              {:ok, Smartsheet.Respone.t(), Smartsheet.Webhook.t()}

              | {:error, Smartsheet.Response.t()}

              | {:internal_error, atom()}



  @callback delete_webhook(String.t()) ::

              {:ok, Smartsheet.Respone.t(), map()}

              | {:error, Smartsheet.Response.t()}

              | {:internal_error, atom()}



  @callback list_webhooks() ::

              {:ok, Smartsheet.Response.t(), [Smartsheet.Webhook.t()]}

              | {:error, Smartsheet.Response.t()}

              | {:internal_error, atom()}

end