NotionElixir (notion_elixir v0.1.2) View Source
API Wrapper for Notion API
Link to this section Summary
Functions
Build a client for re-use over requests
Make a get request against the API
Make a get request against the API using the supplied client
Make a patch request against the API
Make a patch request against the API using the supplied client
Make a post request against the API
Make a post request against the API using the supplied client
Make a post request against the API, and retrieve all paginated results
Make a post request against the API, and retrieve all paginated results
Link to this section Types
Specs
options() :: Keyword.t()
Specs
response() :: {:ok, NotionElixir.Response.t()} | {:ok, NotionElixir.ListResponse.t()} | {:error, any()}
Link to this section Functions
Specs
build_client(opts :: options()) :: Tesla.Client.t()
Build a client for re-use over requests
Options
:api_key
- API key to use with the request.:api_version
- Version of the notion API:base_url
- API base url, defaults to "https://api.notion.com/v1"
Specs
Make a get request against the API
Options
:api_key
- API key to use with the request.:api_version
- Version of the notion API:base_url
- API base url, defaults to "https://api.notion.com/v1"
Specs
get(client :: Tesla.Client.t(), request_path :: String.t(), opts :: options()) :: response()
Make a get request against the API using the supplied client
Specs
Make a patch request against the API
Options
:api_key
- API key to use with the request.:api_version
- Version of the notion API:base_url
- API base url, defaults to "https://api.notion.com/v1"
Specs
patch( client :: Tesla.Client.t(), request_path :: String.t(), data :: map(), opts :: options() ) :: response()
Make a patch request against the API using the supplied client
Options
:api_key
- API key to use with the request.:api_version
- Version of the notion API:base_url
- API base url, defaults to "https://api.notion.com/v1"
Specs
Make a post request against the API
Options
:api_key
- API key to use with the request.:api_version
- Version of the notion API:base_url
- API base url, defaults to "https://api.notion.com/v1"
Specs
post( client :: Tesla.Client.t(), request_path :: String.t(), data :: map(), opts :: options() ) :: response()
Make a post request against the API using the supplied client
Specs
post_all(request_path :: String.t(), data :: map(), opts :: options()) :: response()
post_all(request_path :: String.t(), data :: map(), opts :: options()) :: {:ok, NotionElixir.ListResponse.t()} | {:error, any()}
Make a post request against the API, and retrieve all paginated results
Options
:api_key
- API key to use with the request.:api_version
- Version of the notion API:base_url
- API base url, defaults to "https://api.notion.com/v1"
Make a post request against the API, and retrieve all paginated results