Packages
stripity_stripe
3.3.1
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/tax__settings.ex
defmodule Stripe.Tax.Settings do
use Stripe.Entity
@moduledoc "You can use Tax `Settings` to manage configurations used by Stripe Tax calculations.\n\nRelated guide: [Using the Settings API](https://stripe.com/docs/tax/settings-api)"
(
defstruct [:defaults, :head_office, :livemode, :object, :status, :status_details]
@typedoc "The `tax.settings` type.\n\n * `defaults` \n * `head_office` The place where your business is located.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `status` The status of the Tax `Settings`.\n * `status_details` \n"
@type t :: %__MODULE__{
defaults: term,
head_office: term | nil,
livemode: boolean,
object: binary,
status: binary,
status_details: term
}
)
(
@typedoc "The location of the business for tax purposes."
@type address :: %{
optional(:city) => binary,
optional(:country) => binary,
optional(:line1) => binary,
optional(:line2) => binary,
optional(:postal_code) => binary,
optional(:state) => binary
}
)
(
@typedoc "Default configuration to be used on Stripe Tax calculations."
@type defaults :: %{
optional(:tax_behavior) => :exclusive | :inclusive | :inferred_by_currency,
optional(:tax_code) => binary
}
)
(
@typedoc "The place where your business is located."
@type head_office :: %{optional(:address) => address}
)
(
nil
@doc "<p>Retrieves Tax <code>Settings</code> for a merchant.</p>\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/tax/settings`\n"
(
@spec retrieve(params :: %{optional(:expand) => list(binary)}, opts :: Keyword.t()) ::
{:ok, Stripe.Tax.Settings.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
def retrieve(params \\ %{}, opts \\ []) do
path = Stripe.OpenApi.Path.replace_path_params("/v1/tax/settings", [], [])
Stripe.Request.new_request(opts)
|> Stripe.Request.put_endpoint(path)
|> Stripe.Request.put_params(params)
|> Stripe.Request.put_method(:get)
|> Stripe.Request.make_request()
end
)
)
(
nil
@doc "<p>Updates Tax <code>Settings</code> parameters used in tax calculations. All parameters are editable but none can be removed once set.</p>\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/tax/settings`\n"
(
@spec update(
params :: %{
optional(:defaults) => defaults,
optional(:expand) => list(binary),
optional(:head_office) => head_office
},
opts :: Keyword.t()
) ::
{:ok, Stripe.Tax.Settings.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
def update(params \\ %{}, opts \\ []) do
path = Stripe.OpenApi.Path.replace_path_params("/v1/tax/settings", [], [])
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