Packages
stripity_stripe
3.3.2
3.3.2
3.3.1
3.2.0
3.1.1
3.1.0
3.0.0
2.17.3
2.17.2
2.17.1
2.17.0
2.16.0
2.15.1
2.15.0
2.14.1
2.14.0
2.13.0
2.12.1
2.12.0
2.11.0
2.10.0
2.9.0
2.8.0
2.7.2
2.7.1
2.7.0
2.6.0
2.5.0
2.4.0
2.3.0
2.2.3
2.2.2
2.2.1
2.2.0
2.1.0
2.0.1
2.0.0
2.0.0-alpha.11
2.0.0-alpha.10
2.0.0-alpha.9
2.0.0-alpha.8
2.0.0-alpha.7
2.0.0-alpha.6
2.0.0-alpha.5
2.0.0-alpha.4
2.0.0-alpha.3
2.0.0-alpha.2
2.0.0-alpha.1
1.6.2
1.6.1
1.6.0
1.4.0
1.3.0
1.2.0
1.1.0
0.5.0
0.4.0
0.3.0
0.2.0
A Stripe client for Elixir.
Current section
Files
Jump to
Current section
Files
lib/generated/terminal__onboarding_link.ex
defmodule Stripe.Terminal.OnboardingLink do
use Stripe.Entity
@moduledoc "Returns redirect links used for onboarding onto Tap to Pay on iPhone."
(
defstruct [:link_options, :link_type, :object, :on_behalf_of, :redirect_url]
@typedoc "The `terminal.onboarding_link` type.\n\n * `link_options` \n * `link_type` The type of link being generated.\n * `object` \n * `on_behalf_of` Stripe account ID to generate the link for.\n * `redirect_url` The link passed back to the user for their onboarding.\n"
@type t :: %__MODULE__{
link_options: term,
link_type: binary,
object: binary,
on_behalf_of: binary | nil,
redirect_url: binary
}
)
(
@typedoc "The options associated with the Apple Terms and Conditions link type."
@type apple_terms_and_conditions :: %{
optional(:allow_relinking) => boolean,
optional(:merchant_display_name) => binary
}
)
(
@typedoc "Specific fields needed to generate the desired link type."
@type link_options :: %{optional(:apple_terms_and_conditions) => apple_terms_and_conditions}
)
(
nil
@doc "<p>Creates a new <code>OnboardingLink</code> object that contains a redirect_url used for onboarding onto Tap to Pay on iPhone.</p>\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/terminal/onboarding_links`\n"
(
@spec create(
params :: %{
optional(:expand) => list(binary),
optional(:link_options) => link_options,
optional(:link_type) => :apple_terms_and_conditions,
optional(:on_behalf_of) => binary
},
opts :: Keyword.t()
) ::
{:ok, Stripe.Terminal.OnboardingLink.t()}
| {:error, Stripe.ApiErrors.t()}
| {:error, term()}
def create(params \\ %{}, opts \\ []) do
path = Stripe.OpenApi.Path.replace_path_params("/v1/terminal/onboarding_links", [], [])
Stripe.Request.new_request(opts)
|> Stripe.Request.put_endpoint(path)
|> Stripe.Request.put_params(params)
|> Stripe.Request.put_method(:post)
|> Stripe.Request.make_request()
end
)
)
end