exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.SDK.Reviews (exoapi_stripe v0.1.4)

Link to this section Summary

Types

get_reviews_opts()
get_reviews_review_opts()

Functions

get_reviews(client, opts \\ [])

description: <p>Returns a list of <code>Review</code> objects that have <code>open</code> set to <code>true</code>. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

get_reviews_review(client, review, opts \\ [])

description: <p>Retrieves a <code>Review</code> object.</p>

post_reviews_review_approve(client, body, review)

description: <p>Approves a <code>Review</code> object, closing it and removing it from the list of reviews.</p>

Link to this section Types

Link to this type

get_reviews_opts()

View Source 
@type get_reviews_opts() ::
  {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:created, String.t()}
Link to this type

get_reviews_review_opts()

View Source 
@type get_reviews_review_opts() :: {:expand, String.t()}

Link to this section Functions

Link to this function

get_reviews(client, opts \\ [])

View Source 
@spec get_reviews(client :: ExOAPI.Client.t(), [get_reviews_opts()]) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.Review.t()]
     }
   | map()}
  | {:error, any()}

description: <p>Returns a list of <code>Review</code> objects that have <code>open</code> set to <code>true</code>. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

Link to this function

get_reviews_review(client, review, opts \\ [])

View Source 
@spec get_reviews_review(
  client :: ExOAPI.Client.t(),
  review :: String.t(),
  [get_reviews_review_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.Review.t() | map()}
  | {:error, any()}

description: <p>Retrieves a <code>Review</code> object.</p>

Link to this function

post_reviews_review_approve(client, body, review)

View Source 
@spec post_reviews_review_approve(
  client :: ExOAPI.Client.t(),
  body :: %{expand: [String.t()]} | map(),
  review :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.Review.t() | map()}
  | {:error, any()}

description: <p>Approves a <code>Review</code> object, closing it and removing it from the list of reviews.</p>