@spec appsecret_proof(String.t()) :: String.t() | nil

HMAC-SHA256 of the access token using the app secret.

Source: https://developers.facebook.com/docs/graph-api/guides/secure-requests/

@spec delete_connections(id(), name(), params()) :: success() | error()

Use delete_connections to delete object from connections

Example:

= delete_connections(:me, :feed, %{})

@spec delete_connections(api(), id(), name(), params()) :: api()

Use delete_connections for deleting items from connections using batch api

@spec delete_object(id(), params()) :: success() | error()

Use delete_object to delete object from facebook data.

Example:

= delete_object("item-id", %{})

@spec delete_object(api(), id(), params()) :: api()

Use delete_object for deleting item from facebook data.

@spec get_connections(id(), name(), params()) :: success() | error()

Use get_connections to read feed, home collections.

Example:

} = get_connections(:me, :feed, %{fields: "id, name"})

@spec get_connections(api(), id(), name(), params()) :: api()

Use get_connections for getting collection using batch Facebook API.

@spec get_object(id(), params()) :: success() | error()

Use get_object for getting object related attributes

Example:

} = get_object(:me, %{access_token: "access-token", fields: "id, name"})

@spec get_object(api(), id(), params()) :: api()

Use get_object for getting object related attributes as part of batch API.

@spec get_picture_data(id(), params()) :: success() | error()

Returns hash of image data for passed id.

@spec list_subscriptions(params()) :: success() | error()

Getting list of subscriptions for app, we don't need to use user access token, it requires to have only app_id and secret.

@spec meet_challenge(map(), String.t()) :: {:ok, String.t()} | error()

Handle a Webhooks verification request.

Facebook sends hub.mode, hub.verify_token, and hub.challenge. Return {:ok, challenge} when the request is valid.

Source: https://developers.facebook.com/docs/graph-api/webhooks/getting-started

@spec next_page(success() | error()) :: success() | error()

Pagination next_page is using response from calls of get_connections.

Example:

page0 = get_connections(...)
page1 = page0 |> next_page
page0 = page1 |> prev_page

@spec put_connections(id(), name(), params(), body()) :: success() | error()

Use put_connections for posting messages or other update actions.

Example:

put_connections(:me, :feed, %{access_token: "access-token"}, %{message: "message-example"})

@spec put_connections(api(), id(), name(), params(), body()) :: api()

Use put_connections for posting messages or other update actions.

@spec subscribe(id(), String.t(), String.t(), String.t() | nil) :: success() | error()

Subscribe to real time updates to object.

callback_url - https api endpoint to receive real time updates. verify_token - token to verify post request from facebook with updates. fields - 'friends, feed' as an example.

@spec unsubscribe(id()) :: success() | error()

id - id of object to unsubscribe, in case if developer passed nil unsubscribe would apply for all subscriptions for facebook app.