Improve Stripe.List

lib/stripe/connect/account.ex

@@ -121,7 +121,7 @@ defmodule Stripe.Account do
           details_submitted: boolean,
           display_name: String.t() | nil,
           email: String.t() | nil,
-          external_accounts: Stripe.List.of(Stripe.BankAccount.t() | Stripe.Card.t()),
+          external_accounts: Stripe.List.t(Stripe.BankAccount.t() | Stripe.Card.t()),
           keys: keys | nil,
           legal_entity: legal_entity,
           metadata: Stripe.Types.metadata(),
@@ -312,7 +312,7 @@ defmodule Stripe.Account do
   @doc """
   List all connected accounts.
   """
-  @spec list(params, Stripe.options()) :: {:ok, Stripe.List.of(t)} | {:error, Stripe.Error.t()}
+  @spec list(params, Stripe.options()) :: {:ok, Stripe.List.t(t)} | {:error, Stripe.Error.t()}
         when params: %{
                optional(:ending_before) => t | Stripe.id(),
                optional(:limit) => 1..100,

lib/stripe/connect/application_fee.ex

@@ -21,7 +21,7 @@ defmodule Stripe.ApplicationFee do
           livemode: boolean,
           originating_transaction: Stripe.id() | Stripe.Charge.t(),
           refunded: boolean,
-          refunds: Stripe.List.of(Stripe.FeeRefund.t())
+          refunds: Stripe.List.t(Stripe.FeeRefund.t())
         }
 
   defstruct [

lib/stripe/connect/country_spec.ex

@@ -55,7 +55,7 @@ defmodule Stripe.CountrySpec do
   @doc """
   List all country specs.
   """
-  @spec list(map, Stripe.options()) :: {:ok, Stripe.List.of(t)} | {:error, Stripe.Error.t()}
+  @spec list(map, Stripe.options()) :: {:ok, Stripe.List.t(t)} | {:error, Stripe.Error.t()}
   def list(params \\ %{}, opts \\ []) do
     new_request(opts)
     |> put_endpoint(@plural_endpoint)

lib/stripe/connect/external_account.ex

@@ -93,7 +93,7 @@ defmodule Stripe.ExternalAccount do
 
   Takes either `:bank_account` or `:card` to determine which object to list.
   """
-  @spec list(atom, map, Stripe.options()) :: {:ok, Stripe.List.of(t)} | {:error, Stripe.Error.t()}
+  @spec list(atom, map, Stripe.options()) :: {:ok, Stripe.List.t(t)} | {:error, Stripe.Error.t()}
   def list(atom, params, opts \\ [])
   def list(:bank_account, %{account: _} = params, opts) do
     endpoint = params |> accounts_plural_endpoint()
@@ -106,7 +106,7 @@ defmodule Stripe.ExternalAccount do
     do_list(endpoint, params, opts)
   end
 
-  @spec do_list(String.t, map, Stripe.options()) :: {:ok, Stripe.List.of(t)} | {:error, Stripe.Error.t()}
+  @spec do_list(String.t, map, Stripe.options()) :: {:ok, Stripe.List.t(t)} | {:error, Stripe.Error.t()}
   defp do_list(endpoint, params, opts) do
     new_request(opts)
     |> put_endpoint(endpoint)

lib/stripe/connect/recipient.ex

@@ -29,7 +29,7 @@ defmodule Stripe.Recipient do
               status: String.t()
             }
             | nil,
-          cards: Stripe.List.of(Stripe.Card.t()),
+          cards: Stripe.List.t(Stripe.Card.t()),
           created: Stripe.timestamp(),
           default_card: Stripe.id() | Stripe.Card.t(),
           description: String.t(),

lib/stripe/connect/transfer.ex

@@ -20,7 +20,7 @@ defmodule Stripe.Transfer do
           destination_payment: String.t(),
           livemode: boolean,
           metadata: Stripe.Types.metadata(),
-          reversals: Stripe.List.of(Stripe.Reversal.t()),
+          reversals: Stripe.List.t(Stripe.TransferReversal.t()),
           reversed: boolean,
           source_transaction: Stripe.id() | Stripe.Charge.t(),
           source_type: String.t(),

lib/stripe/core_resources/balance_transaction.ex

@@ -69,7 +69,7 @@ defmodule Stripe.BalanceTransaction do
   See `t:Stripe.BalanceTransaction.All.t/0` or the
   [Stripe docs](https://stripe.com/docs/api#balance_history) for parameter structure.
   """
-  @spec all(params, Stripe.options()) :: {:ok, Stripe.List.of(t)} | {:error, Stripe.Error.t()}
+  @spec all(params, Stripe.options()) :: {:ok, Stripe.List.t(t)} | {:error, Stripe.Error.t()}
         when params: %{
                optional(:available_on) => String.t() | Stripe.date_query(),
                optional(:created) => String.t() | Stripe.date_query(),

lib/stripe/core_resources/charge.ex

@@ -80,7 +80,7 @@ defmodule Stripe.Charge do
           receipt_email: String.t() | nil,
           receipt_number: String.t() | nil,
           refunded: boolean,
-          refunds: Stripe.List.of(Stripe.Refund.t()),
+          refunds: Stripe.List.t(Stripe.Refund.t()),
           review: Stripe.id() | Stripe.Review.t() | nil,
           shipping: Stripe.Types.shipping() | nil,
           source: Stripe.Card.t() | map,
@@ -281,7 +281,7 @@ defmodule Stripe.Charge do
 
   See the [Stripe docs](https://stripe.com/docs/api#list_charges).
   """
-  @spec list(params, Stripe.options()) :: {:ok, Stripe.List.of(t)} | {:error, Stripe.Error.t()}
+  @spec list(params, Stripe.options()) :: {:ok, Stripe.List.t(t)} | {:error, Stripe.Error.t()}
         when params: %{
                optional(:created) => Stripe.date_query(),
                optional(:customer) => Stripe.Customer.t() | Stripe.id(),

lib/stripe/core_resources/customer.ex

@@ -31,8 +31,8 @@ defmodule Stripe.Customer do
           livemode: boolean,
           metadata: Stripe.Types.metadata(),
           shipping: Stripe.Types.shipping() | nil,
-          sources: Stripe.List.of(Stripe.Source.t()),
-          subscriptions: Stripe.List.of(Stripe.Subscription.t())
+          sources: Stripe.List.t(Stripe.Source.t()),
+          subscriptions: Stripe.List.t(Stripe.Subscription.t())
         }
 
   defstruct [
@@ -128,7 +128,7 @@ defmodule Stripe.Customer do
   @doc """
   List all customers.
   """
-  @spec list(params, Stripe.options()) :: {:ok, Stripe.List.of(t)} | {:error, Stripe.Error.t()}
+  @spec list(params, Stripe.options()) :: {:ok, Stripe.List.t(t)} | {:error, Stripe.Error.t()}
         when params: %{
                ending_before: t | Stripe.id() | nil,
                limit: 1..100 | nil,

lib/stripe/core_resources/event.ex

@@ -85,7 +85,7 @@ defmodule Stripe.Event do
   @doc """
   List all events, going back up to 30 days.
   """
-  @spec list(map, Stripe.options()) :: {:ok, Stripe.List.of(t)} | {:error, Stripe.Error.t()}
+  @spec list(map, Stripe.options()) :: {:ok, Stripe.List.t(t)} | {:error, Stripe.Error.t()}
   def list(params \\ %{}, opts \\ []) do
     new_request(opts)
     |> put_endpoint(@plural_endpoint)

lib/stripe/core_resources/file_upload.ex

@@ -64,7 +64,7 @@ defmodule Stripe.FileUpload do
   @doc """
   List all file uploads, going back up to 30 days.
   """
-  @spec list(map, Stripe.options) :: {:ok, Stripe.List.of(t)} | {:error, Stripe.Error.t}
+  @spec list(map, Stripe.options) :: {:ok, Stripe.List.t(t)} | {:error, Stripe.Error.t}
   def list(params \\ %{}, opts \\ []) do
     new_request(opts)
     |> put_endpoint(@plural_endpoint)

lib/stripe/core_resources/payout.ex

@@ -132,7 +132,7 @@ defmodule Stripe.Payout do
 
   See the [Stripe docs](https://stripe.com/docs/api#list_payouts).
   """
-  @spec list(params, Stripe.options()) :: {:ok, Stripe.List.of(t)} | {:error, Stripe.Error.t()}
+  @spec list(params, Stripe.options()) :: {:ok, Stripe.List.t(t)} | {:error, Stripe.Error.t()}
         when params: %{
                arrival_date: Stripe.date_query(),
                created: Stripe.date_query(),

lib/stripe/core_resources/refund.ex

@@ -129,7 +129,7 @@ defmodule Stripe.Refund do
 
   See the [Stripe docs](https://stripe.com/docs/api#list_refunds).
   """
-  @spec list(params, Stripe.options()) :: {:ok, Stripe.List.of(t)} | {:error, Stripe.Error.t()}
+  @spec list(params, Stripe.options()) :: {:ok, Stripe.List.t(t)} | {:error, Stripe.Error.t()}
         when params: %{
                charge: Stripe.id() | Stripe.Charge.t(),
                ending_before: Stripe.id() | t,

lib/stripe/list.ex

@@ -14,7 +14,15 @@ defmodule Stripe.List do
   """
   use Stripe.Entity
 
-  @type t :: %__MODULE__{}
+  @type value :: term
+
+  @type t(value) :: %__MODULE__{
+            object: String.t(),
+            data: [value] | [],
+            has_more: boolean,
+            total_count: integer | nil,
+            url: String.t()
+          }
 
   defstruct [:object, :data, :has_more, :total_count, :url]
 end

lib/stripe/payment_methods/bank_account.ex

@@ -117,7 +117,7 @@ defmodule Stripe.BankAccount do
   @doc """
   List all bank accounts.
   """
-  @spec list(map, Stripe.options()) :: {:ok, Stripe.List.of(t)} | {:error, Stripe.Error.t()}
+  @spec list(map, Stripe.options()) :: {:ok, Stripe.List.t(t)} | {:error, Stripe.Error.t()}
   def list(%{customer: _} = params, opts \\ []) do
     endpoint = params |> plural_endpoint()
     params = params |> Map.put(:object, "card")

lib/stripe/payment_methods/card.ex

@@ -152,7 +152,7 @@ defmodule Stripe.Card do
   @doc """
   List all cards.
   """
-  @spec list(map, Stripe.options()) :: {:ok, Stripe.List.of(t)} | {:error, Stripe.Error.t()}
+  @spec list(map, Stripe.options()) :: {:ok, Stripe.List.t(t)} | {:error, Stripe.Error.t()}
   def list(%{customer: _} = params, opts \\ []) do
     endpoint = params |> plural_endpoint()
     params = params |> Map.put(:object, "card")

lib/stripe/relay/order.ex

@@ -19,10 +19,10 @@ defmodule Stripe.Order do
           customer: Stripe.id() | Stripe.Customer.t(),
           email: String.t(),
           external_coupon_code: String.t(),
-          items: Stripe.List.of(Stripe.OrderItem.t()),
+          items: Stripe.List.t(Stripe.OrderItem.t()),
           livemode: boolean,
           metadata: Stripe.Types.metadata(),
-          returns: Stripe.List.of(Stripe.Return.t()),
+          returns: Stripe.List.t(Stripe.OrderReturn.t()),
           selected_shipping_method: String.t(),
           shipping: %{
             address: %{

lib/stripe/relay/order_return.ex

@@ -14,7 +14,7 @@ defmodule Stripe.OrderReturn do
           amount: pos_integer,
           created: Stripe.timestamp(),
           currency: String.t(),
-          items: Stripe.List.of(Stripe.OrderItem.t()),
+          items: Stripe.List.t(Stripe.OrderItem.t()),
           livemode: boolean,
           order: Stripe.id() | Stripe.Order.t() | nil,
           refund: Stripe.id() | Stripe.Refund.t() | nil
@@ -48,7 +48,7 @@ defmodule Stripe.OrderReturn do
   @doc """
   List all returns.
   """
-  @spec list(Stripe.options()) :: {:ok, Stripe.List.of(t)} | {:error, Stripe.Error.t()}
+  @spec list(Stripe.options()) :: {:ok, Stripe.List.t(t)} | {:error, Stripe.Error.t()}
   def list(opts \\ []) do
     new_request(opts)
     |> put_endpoint(@plural_endpoint)

lib/stripe/relay/product.ex

@@ -31,7 +31,7 @@ defmodule Stripe.Product do
                 width: float
               },
           shippable: boolean,
-          skus: Stripe.List.of(Stripe.SKU.t()),
+          skus: Stripe.List.t(Stripe.SKU.t()),
           updated: Stripe.timestamp(),
           url: String.t()
         }

lib/stripe/subscriptions/coupon.ex

@@ -118,7 +118,7 @@ defmodule Stripe.Coupon do
   @doc """
   List all coupons.
   """
-  @spec list(params, Stripe.options()) :: {:ok, Stripe.List.of(t)} | {:error, Stripe.Error.t()}
+  @spec list(params, Stripe.options()) :: {:ok, Stripe.List.t(t)} | {:error, Stripe.Error.t()}
         when params: %{
                created: Stripe.date_query(),
                ending_before: t | Stripe.id(),

lib/stripe/subscriptions/invoice.ex

@@ -32,7 +32,7 @@ defmodule Stripe.Invoice do
           discount: Stripe.Discount.t() | nil,
           ending_balance: integer | nil,
           forgiven: boolean,
-          lines: Stripe.List.of(Stripe.LineItem.t()),
+          lines: Stripe.List.t(Stripe.LineItem.t()),
           livemode: boolean,
           metadata: Stripe.Types.metadata() | nil,
           next_payment_attempt: Stripe.timestamp() | nil,
@@ -162,7 +162,7 @@ defmodule Stripe.Invoice do
   @doc """
   List all invoices.
   """
-  @spec list(params, Stripe.options()) :: {:ok, Stripe.List.of(t)} | {:error, Stripe.Error.t()}
+  @spec list(params, Stripe.options()) :: {:ok, Stripe.List.t(t)} | {:error, Stripe.Error.t()}
         when params: %{
                customer: Stripe.Customer.t() | Stripe.id(),
                date: Stripe.date_query(),

lib/stripe/subscriptions/line_item.ex

@@ -15,9 +15,7 @@ defmodule Stripe.LineItem do
           description: String.t(),
           discountable: boolean,
           livemode: boolean,
-          metadata: %{
-            optional(String.t()) => String.t()
-          },
+          metadata: Stripe.Types.metadata(),
           period: %{
             start: Stripe.timestamp(),
             end: Stripe.timestamp()

lib/stripe/subscriptions/plan.ex

@@ -135,7 +135,7 @@ defmodule Stripe.Plan do
   @doc """
   List all plans.
   """
-  @spec list(params, Stripe.options()) :: {:ok, Stripe.List.of(t)} | {:error, Stripe.Error.t()}
+  @spec list(params, Stripe.options()) :: {:ok, Stripe.List.t(t)} | {:error, Stripe.Error.t()}
         when params: %{
                created: Stripe.date_query() | nil,
                ending_before: t | Stripe.id() | nil,

lib/stripe/subscriptions/subscription.ex

@@ -27,7 +27,7 @@ defmodule Stripe.Subscription do
           customer: Stripe.id() | Stripe.Customer.t(),
           discount: Stripe.Discount.t() | nil,
           ended_at: Stripe.timestamp() | nil,
-          items: Stripe.List.of(Stripe.SubscriptionItem.t()),
+          items: Stripe.List.t(Stripe.SubscriptionItem.t()),
           livemode: boolean,
           metadata: Stripe.Types.metadata(),
           plan: Stripe.Plan.t() | nil,
@@ -154,7 +154,7 @@ defmodule Stripe.Subscription do
   @doc """
   List all subscriptions.
   """
-  @spec list(params, Stripe.options()) :: {:ok, Stripe.List.of(t)} | {:error, Stripe.Error.t()}
+  @spec list(params, Stripe.options()) :: {:ok, Stripe.List.t(t)} | {:error, Stripe.Error.t()}
         when params: %{
                optional(:created) => Stripe.date_query(),
                optional(:customer) => Stripe.Customer.t() | Stripe.id(),