mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-06-23 00:00:29 -04:00
Compare commits
430 Commits
master
...
v11.7.0-be
Author | SHA1 | Date | |
---|---|---|---|
|
3e340c4153 | ||
|
0229ed0e95 | ||
|
1e5edb7386 | ||
|
478d6888aa | ||
|
349acd2adf | ||
|
3871745743 | ||
|
59c82e3d4b | ||
|
6a4d2d1570 | ||
|
5669ab4d5c | ||
|
78e3166e20 | ||
|
318bed2067 | ||
|
0c44569639 | ||
|
65c85f45b3 | ||
|
f858c6a959 | ||
|
1fadafb39c | ||
|
4ce9e74bf5 | ||
|
b7d691bafd | ||
|
ee9ea1595a | ||
|
a802c007b2 | ||
|
d8701e8749 | ||
|
c83c27da74 | ||
|
fa02db50ab | ||
|
663d1460ef | ||
|
9716565a2d | ||
|
99c81c7074 | ||
|
16c779cdea | ||
|
f832bff64a | ||
|
d9f19ec10f | ||
|
20ae76545b | ||
|
59863ea3aa | ||
|
a49aa2d18c | ||
|
61aba5d027 | ||
|
3d2ad3d61c | ||
|
ab7d3a61d1 | ||
|
e5ec8c1ebf | ||
|
8558e0ee2e | ||
|
8c3b51769f | ||
|
4c4485185c | ||
|
df7f3fad50 | ||
|
b9597e5eac | ||
|
83463f167e | ||
|
abcc296f24 | ||
|
7eea258347 | ||
|
b66f178666 | ||
|
4ffefec536 | ||
|
7f957926c0 | ||
|
9f5e950493 | ||
|
c4f115226f | ||
|
c9c0acf980 | ||
|
3822030694 | ||
|
287b1fab65 | ||
|
6a0feb8f7d | ||
|
3f60df3581 | ||
|
c2f09bc395 | ||
|
626b576a34 | ||
|
27987ef78e | ||
|
4888991c70 | ||
|
4f0f1ee5f9 | ||
|
f825a94c1c | ||
|
9bfea77b37 | ||
|
929b50a836 | ||
|
e14fff4431 | ||
|
bc3e460aae | ||
|
3ed806c90b | ||
|
c4dd22825e | ||
|
b594bd5c21 | ||
|
7ddec7d6d8 | ||
|
f6a388be06 | ||
|
a8aac472ec | ||
|
0b3c0f3244 | ||
|
cece539ed7 | ||
|
22693301eb | ||
|
c36c240108 | ||
|
ec694bbd05 | ||
|
56039702e9 | ||
|
5edc3708fc | ||
|
0d0cead582 | ||
|
b7a9871e6a | ||
|
e511e2fb8b | ||
|
e37031ef1f | ||
|
d699593ea5 | ||
|
4632b7c9da | ||
|
418d79de1b | ||
|
b1e351f235 | ||
|
2c260289f2 | ||
|
d249b5f78b | ||
|
816f8ad435 | ||
|
02a733676e | ||
|
0e96318130 | ||
|
2e0b17a3dc | ||
|
8c91e40f29 | ||
|
4617b3fbd1 | ||
|
da70f0cfc8 | ||
|
a00f541a93 | ||
|
cbe61d7d38 | ||
|
3fe63202e3 | ||
|
3921d9b812 | ||
|
b39af8a58b | ||
|
6e62bca84a | ||
|
a7d998ab2d | ||
|
479d17b26a | ||
|
1bcb4bc058 | ||
|
b399f87064 | ||
|
a1ce673f62 | ||
|
4ccbe90069 | ||
|
5da74143e8 | ||
|
41ba199775 | ||
|
6897561e00 | ||
|
33e217ba15 | ||
|
dfa7994d04 | ||
|
34ff3ed2ca | ||
|
fe66019c7d | ||
|
f84e1154b1 | ||
|
afa13a53b0 | ||
|
a1deb162d0 | ||
|
499d0605d0 | ||
|
1705995709 | ||
|
452f8ca43d | ||
|
4902b4c49d | ||
|
ad26ff3fca | ||
|
86ac5fd329 | ||
|
ee9b5c7ead | ||
|
083c3a104e | ||
|
354b6a92a3 | ||
|
c48a5e30cf | ||
|
71b8f84574 | ||
|
d353c130bc | ||
|
8bda0900f3 | ||
|
3cecb75d46 | ||
|
18fef16be2 | ||
|
783bcb163f | ||
|
3e5b22eeae | ||
|
452e0c4485 | ||
|
cb256e8e1c | ||
|
90aa83239b | ||
|
ab5266188f | ||
|
e8f3b94a9d | ||
|
52e17ef8ea | ||
|
16227fe1e6 | ||
|
0e8df39594 | ||
|
98fbfb8012 | ||
|
8acad71c3f | ||
|
3b4f6e4bcb | ||
|
e1017fb6ef | ||
|
4933ab3111 | ||
|
b06b78aa85 | ||
|
fb0f82090c | ||
|
7c14c42072 | ||
|
78032b72f5 | ||
|
446f6ec55c | ||
|
7567bd2cb7 | ||
|
002767748d | ||
|
92bad8eeee | ||
|
3d3552e00d | ||
|
5af00f12a2 | ||
|
208ead7817 | ||
|
cca659d7b3 | ||
|
8c0015fb2c | ||
|
5ece384518 | ||
|
d936ddcff1 | ||
|
77d8304c54 | ||
|
6ba63d9a87 | ||
|
0d538ab0f1 | ||
|
6a5b89c99d | ||
|
b036d14d27 | ||
|
eeaa682877 | ||
|
a9611340a4 | ||
|
fee677de9e | ||
|
08400e8df9 | ||
|
b62018ee93 | ||
|
d4e469fa3c | ||
|
cfd9943c83 | ||
|
6d82ac4b56 | ||
|
aeb1b59206 | ||
|
a7f1c57f2c | ||
|
7be7413461 | ||
|
42f0c2c9d4 | ||
|
0055df9a63 | ||
|
4638712b2b | ||
|
86f5a8ac5c | ||
|
5443a95598 | ||
|
bc3cd13405 | ||
|
02c47fd5f0 | ||
|
9a92aa9c72 | ||
|
0030faf88f | ||
|
3285671c8f | ||
|
119802aaf2 | ||
|
d7a09671d1 | ||
|
05ee1f8fd4 | ||
|
72ce4e5f83 | ||
|
7dbfa2b4c4 | ||
|
0d02750915 | ||
|
1e13984787 | ||
|
5a2cf963ec | ||
|
176f13b832 | ||
|
9f77cb9c05 | ||
|
12da6ae2a8 | ||
|
aed8e679c5 | ||
|
a11a923b23 | ||
|
ac980c4216 | ||
|
7852b2faeb | ||
|
0a0374b0a1 | ||
|
2e533be04d | ||
|
e058a85fe7 | ||
|
6bf2eaf832 | ||
|
fb6f536d00 | ||
|
f97b214181 | ||
|
7066d7d3a1 | ||
|
147e25b288 | ||
|
568b3191c4 | ||
|
1ef9ff4b88 | ||
|
3165ed5905 | ||
|
be4388721d | ||
|
6ed6014b89 | ||
|
0ea7c61bcf | ||
|
f94c2cb45c | ||
|
c4bdddbe3c | ||
|
81b5190aed | ||
|
3fd4e48999 | ||
|
44a1547344 | ||
|
65768f9ee1 | ||
|
2ebd8cc795 | ||
|
206c80733f | ||
|
600c5fb883 | ||
|
8dfa6f6eaa | ||
|
c3b05c5e71 | ||
|
fee9143bb1 | ||
|
bd62fe08d6 | ||
|
658a0b786a | ||
|
84bf38a606 | ||
|
882c2a8c36 | ||
|
f7d4abdb5f | ||
|
8977ca553f | ||
|
e8f09f4001 | ||
|
4430246744 | ||
|
e9b70ffd51 | ||
|
b578ab2eb3 | ||
|
79dee2ae96 | ||
|
e0cfc89447 | ||
|
37b1db8140 | ||
|
ce925ab7a4 | ||
|
d604af0247 | ||
|
078adfcc37 | ||
|
e6ff2138c6 | ||
|
5609c6ce72 | ||
|
2227067f71 | ||
|
4981cc844d | ||
|
7e2a036dc5 | ||
|
900ecf2db9 | ||
|
8d5a5ef183 | ||
|
5bf957f53e | ||
|
0e5e7b8647 | ||
|
a334cb5fb4 | ||
|
801b65759e | ||
|
3d772067d1 | ||
|
6db03363ff | ||
|
1af83889bb | ||
|
e6b3043f66 | ||
|
e74bd2e7f7 | ||
|
bc924840dd | ||
|
456f10ab93 | ||
|
96b7453ee9 | ||
|
c0310bc4a7 | ||
|
a2806aca65 | ||
|
2f7ede30d1 | ||
|
4eae12c528 | ||
|
24801210b9 | ||
|
88ef71cf32 | ||
|
50c64e6c06 | ||
|
91015aa41c | ||
|
17619449ed | ||
|
a22bc332ad | ||
|
a5519a6a57 | ||
|
90a2a55687 | ||
|
6e2e8c757d | ||
|
c7a26629e6 | ||
|
62c0f898c3 | ||
|
cd0e601188 | ||
|
43f6318ebd | ||
|
150be92efc | ||
|
99dbffb9c6 | ||
|
a77bbab966 | ||
|
4d5a2aab6e | ||
|
7356579799 | ||
|
23cbd8fc82 | ||
|
adc0ccf8e7 | ||
|
d9118a7dfe | ||
|
f33553bef2 | ||
|
1d1d8a90f0 | ||
|
943dd4b020 | ||
|
6366593ed5 | ||
|
8cdb85cb36 | ||
|
9990e2b8b1 | ||
|
d600f2e9a1 | ||
|
c3cc36ed12 | ||
|
00077b44d8 | ||
|
2c06e9c83e | ||
|
4b74f4c93f | ||
|
e3f0da227f | ||
|
3ac330785f | ||
|
0075550ff8 | ||
|
890cdae767 | ||
|
732a1467b5 | ||
|
d39dcb4a81 | ||
|
fb655489eb | ||
|
4143d3930d | ||
|
23bc1b1f3b | ||
|
fe73975f07 | ||
|
24f8480c71 | ||
|
9d8ca624e3 | ||
|
105506a7fd | ||
|
75b29c3484 | ||
|
a6614ee701 | ||
|
33544c7c25 | ||
|
8f210e251a | ||
|
3b31fb29a6 | ||
|
4519e8fa19 | ||
|
f471a2c6a4 | ||
|
1e3428e87d | ||
|
7233155b42 | ||
|
cbfe81107a | ||
|
0b6cffde22 | ||
|
1be10ae4fc | ||
|
167daeaf62 | ||
|
080fddce5a | ||
|
466824d0af | ||
|
945e691968 | ||
|
f8a9a287ab | ||
|
92083a8615 | ||
|
705078e2cf | ||
|
29d8261b17 | ||
|
3958d6a9df | ||
|
696be38196 | ||
|
ff853fda95 | ||
|
d10398a825 | ||
|
6f70bd8696 | ||
|
1d21c60802 | ||
|
b9c10b9c2f | ||
|
446ffc7a22 | ||
|
58db6d32ef | ||
|
9a4dfdcb2f | ||
|
50bbc0df17 | ||
|
8226f0ad99 | ||
|
43fa8f5af7 | ||
|
0e61789557 | ||
|
cfe69c131e | ||
|
7bf9cace9e | ||
|
d7eac6010d | ||
|
7d91cb83d9 | ||
|
ce4946f5d8 | ||
|
15415fcbf3 | ||
|
f8acdb5f6a | ||
|
fe794f4868 | ||
|
2b841bc109 | ||
|
1835883848 | ||
|
e11400adc8 | ||
|
5ea85d0867 | ||
|
600b1965f6 | ||
|
5fdd180667 | ||
|
97e24e9e57 | ||
|
9531f57236 | ||
|
094574d2fe | ||
|
cff25d0c8b | ||
|
0795c1d3d0 | ||
|
802a1a7aa6 | ||
|
13b0bca995 | ||
|
51d364c844 | ||
|
f4c6f2b304 | ||
|
b64fe42043 | ||
|
586e685e63 | ||
|
3b5c725539 | ||
|
ea91a6f0b9 | ||
|
21f31edff4 | ||
|
a11f1ffd2a | ||
|
4bd92239d5 | ||
|
c261f6bbb6 | ||
|
f45fc7d703 | ||
|
5cd522c007 | ||
|
e6bda8356d | ||
|
2354633a92 | ||
|
549a73544f | ||
|
25833c1408 | ||
|
a59b57c3d1 | ||
|
63d447df77 | ||
|
5cd6f9f9bc | ||
|
ffa3747bdf | ||
|
ddf79610d9 | ||
|
edad946244 | ||
|
e3785d5893 | ||
|
2062e988eb | ||
|
0bdc688516 | ||
|
82ac9f2720 | ||
|
7381eb02a6 | ||
|
6720fc8d3f | ||
|
35a29332c5 | ||
|
519d68ce10 | ||
|
b95ea4ba27 | ||
|
318e244a76 | ||
|
bb1c995e93 | ||
|
0f12721697 | ||
|
671163245a | ||
|
486bee15a8 | ||
|
fdf5be66f5 | ||
|
c732841fd3 | ||
|
22db70b479 | ||
|
2db4fd9d06 | ||
|
6797f906e1 | ||
|
59f2d4d0fe | ||
|
0d1b570bfa | ||
|
d7d3c1b425 | ||
|
7df619de69 | ||
|
f649ed3824 | ||
|
32a95902cc | ||
|
bdcfe6cc33 | ||
|
5e1c4a2302 | ||
|
54a073783f | ||
|
e6a07ae658 | ||
|
588ed3b5e7 | ||
|
de33cde125 | ||
|
d849ec3b14 | ||
|
8b5f78aa6a | ||
|
7f6ba1c35c | ||
|
e55a2559ae | ||
|
0b00266be1 | ||
|
d0cd4fbaa6 | ||
|
979da6f84b | ||
|
d95c518a3c | ||
|
83c773f61e | ||
|
d9f719ba01 | ||
|
73d10e8557 |
@ -38,6 +38,10 @@ Metrics/MethodLength:
|
||||
Metrics/ModuleLength:
|
||||
Enabled: false
|
||||
|
||||
Metrics/ParameterLists:
|
||||
# There's 2 methods in `StripeClient` that have long parameter lists.
|
||||
Max: 8
|
||||
|
||||
Style/AccessModifierDeclarations:
|
||||
EnforcedStyle: inline
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# This configuration was generated by
|
||||
# `rubocop --auto-gen-config`
|
||||
# on 2023-11-28 01:02:03 UTC using RuboCop version 1.57.2.
|
||||
# on 2023-11-29 18:39:02 UTC using RuboCop version 1.57.2.
|
||||
# The point is for the user to remove these configuration records
|
||||
# one by one as the offenses are removed from the code base.
|
||||
# Note that changes in the inspected code, or installation of new
|
||||
@ -11,15 +11,15 @@ Lint/HashCompareByIdentity:
|
||||
Exclude:
|
||||
- 'lib/stripe/stripe_client.rb'
|
||||
|
||||
# Offense count: 26
|
||||
# Offense count: 27
|
||||
# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
|
||||
Metrics/AbcSize:
|
||||
Max: 50
|
||||
Max: 55
|
||||
|
||||
# Offense count: 9
|
||||
# Offense count: 10
|
||||
# Configuration parameters: CountComments, CountAsOne.
|
||||
Metrics/ClassLength:
|
||||
Max: 592
|
||||
Max: 618
|
||||
|
||||
# Offense count: 12
|
||||
# Configuration parameters: AllowedMethods, AllowedPatterns.
|
||||
@ -27,14 +27,9 @@ Metrics/CyclomaticComplexity:
|
||||
Max: 12
|
||||
|
||||
# Offense count: 9
|
||||
# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
|
||||
Metrics/ParameterLists:
|
||||
Max: 7
|
||||
|
||||
# Offense count: 8
|
||||
# Configuration parameters: AllowedMethods, AllowedPatterns.
|
||||
Metrics/PerceivedComplexity:
|
||||
Max: 12
|
||||
Max: 13
|
||||
|
||||
# Offense count: 1
|
||||
# This cop supports unsafe autocorrection (--autocorrect-all).
|
||||
@ -49,7 +44,7 @@ Style/CombinableLoops:
|
||||
Exclude:
|
||||
- 'lib/stripe/stripe_client.rb'
|
||||
|
||||
# Offense count: 39
|
||||
# Offense count: 44
|
||||
# Configuration parameters: AllowedConstants.
|
||||
Style/Documentation:
|
||||
Enabled: false
|
||||
|
1960
CHANGELOG.md
1960
CHANGELOG.md
File diff suppressed because it is too large
Load Diff
@ -1 +1 @@
|
||||
v1011
|
||||
v1055
|
11
README.md
11
README.md
@ -339,6 +339,17 @@ If your beta feature requires a `Stripe-Version` header to be sent, set the `Str
|
||||
Stripe.add_beta_version("feature_beta", "v3")
|
||||
```
|
||||
|
||||
### Custom requests
|
||||
|
||||
If you would like to send a request to an undocumented API (for example you are in a private beta), or if you prefer to bypass the method definitions in the library and specify your request details directly, you can use the `raw_request` method on `Stripe`.
|
||||
|
||||
```ruby
|
||||
resp = Stripe.raw_request(:post, "/v1/beta_endpoint", {param: 123}, {stripe_version: "2022-11-15; feature_beta=v3"})
|
||||
|
||||
# (Optional) resp is a StripeResponse. You can use `Stripe.deserialize` to get a StripeObject.
|
||||
deserialized_resp = Stripe.deserialize(resp.http_body)
|
||||
```
|
||||
|
||||
## Support
|
||||
|
||||
New features and bug fixes are released on the latest major version of the Stripe Ruby library. If you are on an older major version, we recommend that you upgrade to the latest in order to use the new features and bug fixes including those for security vulnerabilities. Older major versions of the package will continue to be available for use, but will not be receiving any updates.
|
||||
|
@ -13,6 +13,7 @@ require "set"
|
||||
require "socket"
|
||||
require "uri"
|
||||
require "forwardable"
|
||||
require "base64"
|
||||
|
||||
# Version
|
||||
require "stripe/api_version"
|
||||
@ -45,6 +46,7 @@ require "stripe/api_resource_test_helpers"
|
||||
require "stripe/singleton_api_resource"
|
||||
require "stripe/webhook"
|
||||
require "stripe/stripe_configuration"
|
||||
require "stripe/request_signing_authenticator"
|
||||
|
||||
# Named API resources
|
||||
require "stripe/resources"
|
||||
@ -71,6 +73,7 @@ module Stripe
|
||||
|
||||
# User configurable options
|
||||
def_delegators :@config, :api_key, :api_key=
|
||||
def_delegators :@config, :authenticator, :authenticator=
|
||||
def_delegators :@config, :api_version, :api_version=
|
||||
def_delegators :@config, :stripe_account, :stripe_account=
|
||||
def_delegators :@config, :api_base, :api_base=
|
||||
@ -117,6 +120,57 @@ module Stripe
|
||||
version: version,
|
||||
}
|
||||
end
|
||||
|
||||
def self.add_beta_version(beta_name, version)
|
||||
if api_version.include?("; #{beta_name}=")
|
||||
raise "Stripe version header #{api_version} already contains entry for beta #{beta_name}"
|
||||
end
|
||||
|
||||
self.api_version = "#{api_version}; #{beta_name}=#{version}"
|
||||
end
|
||||
|
||||
class Preview
|
||||
def self._get_default_opts(opts)
|
||||
{ api_mode: :preview }.merge(opts)
|
||||
end
|
||||
|
||||
def self.get(url, opts = {})
|
||||
Stripe.raw_request(:get, url, {}, _get_default_opts(opts))
|
||||
end
|
||||
|
||||
def self.post(url, params = {}, opts = {})
|
||||
Stripe.raw_request(:post, url, params, _get_default_opts(opts))
|
||||
end
|
||||
|
||||
def self.delete(url, opts = {})
|
||||
Stripe.raw_request(:delete, url, {}, _get_default_opts(opts))
|
||||
end
|
||||
end
|
||||
|
||||
class RawRequest
|
||||
include Stripe::APIOperations::Request
|
||||
|
||||
def initialize
|
||||
@opts = {}
|
||||
end
|
||||
|
||||
def execute(method, url, params = {}, opts = {}, usage = [])
|
||||
resp, = execute_resource_request(method, url, params, opts, usage)
|
||||
|
||||
resp
|
||||
end
|
||||
end
|
||||
|
||||
# Sends a request to Stripe REST API
|
||||
def self.raw_request(method, url, params = {}, opts = {})
|
||||
req = RawRequest.new
|
||||
req.execute(method, url, params, opts, ["raw_request"])
|
||||
end
|
||||
|
||||
def self.deserialize(data)
|
||||
data = JSON.parse(data) if data.is_a?(String)
|
||||
Util.convert_to_stripe_object(data, {})
|
||||
end
|
||||
end
|
||||
|
||||
Stripe.log_level = ENV["STRIPE_LOG"] unless ENV["STRIPE_LOG"].nil?
|
||||
|
@ -48,13 +48,14 @@ module Stripe
|
||||
api_key = headers.delete(:api_key)
|
||||
api_base = headers.delete(:api_base)
|
||||
client = headers.delete(:client)
|
||||
api_mode = headers.delete(:api_mode)
|
||||
# Assume all remaining opts must be headers
|
||||
|
||||
resp, opts[:api_key] = client.send(
|
||||
client_request_method_sym,
|
||||
method, url,
|
||||
api_base: api_base, api_key: api_key,
|
||||
headers: headers, params: params, usage: usage,
|
||||
headers: headers, params: params, usage: usage, api_mode: api_mode,
|
||||
&read_body_chunk_block
|
||||
)
|
||||
|
||||
|
@ -4,5 +4,6 @@
|
||||
module Stripe
|
||||
module ApiVersion
|
||||
CURRENT = "2024-04-10"
|
||||
PREVIEW = "2024-04-11.preview-v2"
|
||||
end
|
||||
end
|
||||
|
@ -15,6 +15,7 @@ module Stripe
|
||||
# object classes: The beginning of the section generated from our OpenAPI spec
|
||||
Account.object_name => Account,
|
||||
AccountLink.object_name => AccountLink,
|
||||
AccountNotice.object_name => AccountNotice,
|
||||
AccountSession.object_name => AccountSession,
|
||||
ApplePayDomain.object_name => ApplePayDomain,
|
||||
ApplicationFee.object_name => ApplicationFee,
|
||||
@ -30,6 +31,9 @@ module Stripe
|
||||
BillingPortal::Configuration.object_name => BillingPortal::Configuration,
|
||||
BillingPortal::Session.object_name => BillingPortal::Session,
|
||||
Capability.object_name => Capability,
|
||||
Capital::FinancingOffer.object_name => Capital::FinancingOffer,
|
||||
Capital::FinancingSummary.object_name => Capital::FinancingSummary,
|
||||
Capital::FinancingTransaction.object_name => Capital::FinancingTransaction,
|
||||
Card.object_name => Card,
|
||||
CashBalance.object_name => CashBalance,
|
||||
Charge.object_name => Charge,
|
||||
@ -56,20 +60,26 @@ module Stripe
|
||||
File.object_name => File,
|
||||
FileLink.object_name => FileLink,
|
||||
FinancialConnections::Account.object_name => FinancialConnections::Account,
|
||||
FinancialConnections::AccountInferredBalance.object_name =>
|
||||
FinancialConnections::AccountInferredBalance,
|
||||
FinancialConnections::AccountOwner.object_name => FinancialConnections::AccountOwner,
|
||||
FinancialConnections::AccountOwnership.object_name => FinancialConnections::AccountOwnership,
|
||||
FinancialConnections::Session.object_name => FinancialConnections::Session,
|
||||
FinancialConnections::Transaction.object_name => FinancialConnections::Transaction,
|
||||
Forwarding::Request.object_name => Forwarding::Request,
|
||||
FundingInstructions.object_name => FundingInstructions,
|
||||
GiftCards::Card.object_name => GiftCards::Card,
|
||||
GiftCards::Transaction.object_name => GiftCards::Transaction,
|
||||
Identity::VerificationReport.object_name => Identity::VerificationReport,
|
||||
Identity::VerificationSession.object_name => Identity::VerificationSession,
|
||||
Invoice.object_name => Invoice,
|
||||
InvoiceItem.object_name => InvoiceItem,
|
||||
InvoiceLineItem.object_name => InvoiceLineItem,
|
||||
InvoicePayment.object_name => InvoicePayment,
|
||||
Issuing::Authorization.object_name => Issuing::Authorization,
|
||||
Issuing::Card.object_name => Issuing::Card,
|
||||
Issuing::Cardholder.object_name => Issuing::Cardholder,
|
||||
Issuing::CreditUnderwritingRecord.object_name => Issuing::CreditUnderwritingRecord,
|
||||
Issuing::Dispute.object_name => Issuing::Dispute,
|
||||
Issuing::PersonalizationDesign.object_name => Issuing::PersonalizationDesign,
|
||||
Issuing::PhysicalBundle.object_name => Issuing::PhysicalBundle,
|
||||
@ -78,6 +88,8 @@ module Stripe
|
||||
LineItem.object_name => LineItem,
|
||||
LoginLink.object_name => LoginLink,
|
||||
Mandate.object_name => Mandate,
|
||||
Margin.object_name => Margin,
|
||||
Order.object_name => Order,
|
||||
PaymentIntent.object_name => PaymentIntent,
|
||||
PaymentLink.object_name => PaymentLink,
|
||||
PaymentMethod.object_name => PaymentMethod,
|
||||
@ -91,6 +103,9 @@ module Stripe
|
||||
ProductFeature.object_name => ProductFeature,
|
||||
PromotionCode.object_name => PromotionCode,
|
||||
Quote.object_name => Quote,
|
||||
QuotePhase.object_name => QuotePhase,
|
||||
QuotePreviewInvoice.object_name => QuotePreviewInvoice,
|
||||
QuotePreviewSubscriptionSchedule.object_name => QuotePreviewSubscriptionSchedule,
|
||||
Radar::EarlyFraudWarning.object_name => Radar::EarlyFraudWarning,
|
||||
Radar::ValueList.object_name => Radar::ValueList,
|
||||
Radar::ValueListItem.object_name => Radar::ValueListItem,
|
||||
@ -110,6 +125,7 @@ module Stripe
|
||||
SubscriptionSchedule.object_name => SubscriptionSchedule,
|
||||
Tax::Calculation.object_name => Tax::Calculation,
|
||||
Tax::CalculationLineItem.object_name => Tax::CalculationLineItem,
|
||||
Tax::Form.object_name => Tax::Form,
|
||||
Tax::Registration.object_name => Tax::Registration,
|
||||
Tax::Settings.object_name => Tax::Settings,
|
||||
Tax::Transaction.object_name => Tax::Transaction,
|
||||
|
79
lib/stripe/request_signing_authenticator.rb
Normal file
79
lib/stripe/request_signing_authenticator.rb
Normal file
@ -0,0 +1,79 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Stripe
|
||||
class RequestSigningAuthenticator
|
||||
AUTHORIZATION_HEADER_NAME = "Authorization"
|
||||
CONTENT_TYPE_HEADER_NAME = "Content-Type"
|
||||
STRIPE_CONTEXT_HEADER_NAME = "Stripe-Context"
|
||||
STRIPE_ACCOUNT_HEADER_NAME = "Stripe-Account"
|
||||
CONTENT_DIGEST_HEADER_NAME = "Content-Digest"
|
||||
SIGNATURE_INPUT_HEADER_NAME = "Signature-Input"
|
||||
SIGNATURE_HEADER_NAME = "Signature"
|
||||
|
||||
attr_reader :auth_token, :sign_lambda
|
||||
|
||||
def initialize(auth_token, sign_lambda)
|
||||
raise ArgumentError, "auth_token must be a string" unless auth_token.is_a?(String)
|
||||
raise ArgumentError, "sign_lambda must be a lambda" unless sign_lambda.is_a?(Proc)
|
||||
|
||||
@auth_token = auth_token
|
||||
@sign_lambda = sign_lambda
|
||||
end
|
||||
|
||||
def authenticate(method, headers, body)
|
||||
covered_headers = [CONTENT_TYPE_HEADER_NAME,
|
||||
CONTENT_DIGEST_HEADER_NAME,
|
||||
STRIPE_CONTEXT_HEADER_NAME,
|
||||
STRIPE_ACCOUNT_HEADER_NAME,
|
||||
AUTHORIZATION_HEADER_NAME,]
|
||||
|
||||
headers[AUTHORIZATION_HEADER_NAME] = "STRIPE-V2-SIG #{auth_token}"
|
||||
|
||||
if method == :get
|
||||
covered_headers -= [CONTENT_TYPE_HEADER_NAME,
|
||||
CONTENT_DIGEST_HEADER_NAME,]
|
||||
else
|
||||
content = body || ""
|
||||
headers[CONTENT_DIGEST_HEADER_NAME] =
|
||||
%(sha-256=:#{content_digest(content)}:)
|
||||
end
|
||||
|
||||
covered_headers_formatted = covered_headers
|
||||
.map { |string| %("#{string.downcase}") }
|
||||
.join(" ")
|
||||
|
||||
signature_input = "(#{covered_headers_formatted});created=#{created_time}"
|
||||
|
||||
inputs = covered_headers
|
||||
.map { |header| %("#{header.downcase}": #{headers[header]}) }
|
||||
.join("\n")
|
||||
|
||||
signature_base = %(#{inputs}\n"@signature-params": #{signature_input})
|
||||
.encode(Encoding::UTF_8)
|
||||
|
||||
headers[SIGNATURE_INPUT_HEADER_NAME] = "sig1=#{signature_input}"
|
||||
|
||||
headers[SIGNATURE_HEADER_NAME] =
|
||||
"sig1=:#{encoded_signature(signature_base)}:"
|
||||
end
|
||||
|
||||
private def sign(signature_base)
|
||||
@sign_lambda.call(signature_base)
|
||||
end
|
||||
|
||||
private def encoded_signature(signature_base)
|
||||
Base64.strict_encode64(sign(signature_base))
|
||||
rescue StandardError
|
||||
raise AuthenticationError, "Encountered '#{e.message} (#{e.class})' " \
|
||||
"when calculating request signature."
|
||||
end
|
||||
|
||||
private def content_digest(content)
|
||||
Base64.strict_encode64(OpenSSL::Digest.new("SHA256").digest(content))
|
||||
end
|
||||
|
||||
private def created_time
|
||||
Time.now.to_i
|
||||
end
|
||||
end
|
||||
end
|
@ -3,6 +3,7 @@
|
||||
|
||||
require "stripe/resources/account"
|
||||
require "stripe/resources/account_link"
|
||||
require "stripe/resources/account_notice"
|
||||
require "stripe/resources/account_session"
|
||||
require "stripe/resources/apple_pay_domain"
|
||||
require "stripe/resources/application_fee"
|
||||
@ -18,6 +19,9 @@ require "stripe/resources/billing/meter_event_summary"
|
||||
require "stripe/resources/billing_portal/configuration"
|
||||
require "stripe/resources/billing_portal/session"
|
||||
require "stripe/resources/capability"
|
||||
require "stripe/resources/capital/financing_offer"
|
||||
require "stripe/resources/capital/financing_summary"
|
||||
require "stripe/resources/capital/financing_transaction"
|
||||
require "stripe/resources/card"
|
||||
require "stripe/resources/cash_balance"
|
||||
require "stripe/resources/charge"
|
||||
@ -44,20 +48,25 @@ require "stripe/resources/exchange_rate"
|
||||
require "stripe/resources/file"
|
||||
require "stripe/resources/file_link"
|
||||
require "stripe/resources/financial_connections/account"
|
||||
require "stripe/resources/financial_connections/account_inferred_balance"
|
||||
require "stripe/resources/financial_connections/account_owner"
|
||||
require "stripe/resources/financial_connections/account_ownership"
|
||||
require "stripe/resources/financial_connections/session"
|
||||
require "stripe/resources/financial_connections/transaction"
|
||||
require "stripe/resources/forwarding/request"
|
||||
require "stripe/resources/funding_instructions"
|
||||
require "stripe/resources/gift_cards/card"
|
||||
require "stripe/resources/gift_cards/transaction"
|
||||
require "stripe/resources/identity/verification_report"
|
||||
require "stripe/resources/identity/verification_session"
|
||||
require "stripe/resources/invoice"
|
||||
require "stripe/resources/invoice_item"
|
||||
require "stripe/resources/invoice_line_item"
|
||||
require "stripe/resources/invoice_payment"
|
||||
require "stripe/resources/issuing/authorization"
|
||||
require "stripe/resources/issuing/card"
|
||||
require "stripe/resources/issuing/cardholder"
|
||||
require "stripe/resources/issuing/credit_underwriting_record"
|
||||
require "stripe/resources/issuing/dispute"
|
||||
require "stripe/resources/issuing/personalization_design"
|
||||
require "stripe/resources/issuing/physical_bundle"
|
||||
@ -66,6 +75,8 @@ require "stripe/resources/issuing/transaction"
|
||||
require "stripe/resources/line_item"
|
||||
require "stripe/resources/login_link"
|
||||
require "stripe/resources/mandate"
|
||||
require "stripe/resources/margin"
|
||||
require "stripe/resources/order"
|
||||
require "stripe/resources/payment_intent"
|
||||
require "stripe/resources/payment_link"
|
||||
require "stripe/resources/payment_method"
|
||||
@ -79,6 +90,9 @@ require "stripe/resources/product"
|
||||
require "stripe/resources/product_feature"
|
||||
require "stripe/resources/promotion_code"
|
||||
require "stripe/resources/quote"
|
||||
require "stripe/resources/quote_phase"
|
||||
require "stripe/resources/quote_preview_invoice"
|
||||
require "stripe/resources/quote_preview_subscription_schedule"
|
||||
require "stripe/resources/radar/early_fraud_warning"
|
||||
require "stripe/resources/radar/value_list"
|
||||
require "stripe/resources/radar/value_list_item"
|
||||
@ -98,6 +112,7 @@ require "stripe/resources/subscription_item"
|
||||
require "stripe/resources/subscription_schedule"
|
||||
require "stripe/resources/tax/calculation"
|
||||
require "stripe/resources/tax/calculation_line_item"
|
||||
require "stripe/resources/tax/form"
|
||||
require "stripe/resources/tax/registration"
|
||||
require "stripe/resources/tax/settings"
|
||||
require "stripe/resources/tax/transaction"
|
||||
|
32
lib/stripe/resources/account_notice.rb
Normal file
32
lib/stripe/resources/account_notice.rb
Normal file
@ -0,0 +1,32 @@
|
||||
# File generated from our OpenAPI spec
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Stripe
|
||||
# A notice to a Connected account. Notice can be sent by Stripe on your behalf or you can opt to send the notices yourself.
|
||||
#
|
||||
# See the [guide to send notices](https://stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) to your connected accounts.
|
||||
class AccountNotice < APIResource
|
||||
extend Stripe::APIOperations::List
|
||||
include Stripe::APIOperations::Save
|
||||
|
||||
OBJECT_NAME = "account_notice"
|
||||
def self.object_name
|
||||
"account_notice"
|
||||
end
|
||||
|
||||
# Retrieves a list of AccountNotice objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
|
||||
def self.list(filters = {}, opts = {})
|
||||
request_stripe_object(method: :get, path: "/v1/account_notices", params: filters, opts: opts)
|
||||
end
|
||||
|
||||
# Updates an AccountNotice object.
|
||||
def self.update(id, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/account_notices/%<id>s", { id: CGI.escape(id) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
end
|
||||
end
|
49
lib/stripe/resources/capital/financing_offer.rb
Normal file
49
lib/stripe/resources/capital/financing_offer.rb
Normal file
@ -0,0 +1,49 @@
|
||||
# File generated from our OpenAPI spec
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Stripe
|
||||
module Capital
|
||||
# This is an object representing an offer of financing from
|
||||
# Stripe Capital to a Connect subaccount.
|
||||
class FinancingOffer < APIResource
|
||||
extend Stripe::APIOperations::List
|
||||
|
||||
OBJECT_NAME = "capital.financing_offer"
|
||||
def self.object_name
|
||||
"capital.financing_offer"
|
||||
end
|
||||
|
||||
# Retrieves the financing offers available for Connected accounts that belong to your platform.
|
||||
def self.list(filters = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :get,
|
||||
path: "/v1/capital/financing_offers",
|
||||
params: filters,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Acknowledges that platform has received and delivered the financing_offer to
|
||||
# the intended merchant recipient.
|
||||
def mark_delivered(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Acknowledges that platform has received and delivered the financing_offer to
|
||||
# the intended merchant recipient.
|
||||
def self.mark_delivered(financing_offer, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(financing_offer) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
15
lib/stripe/resources/capital/financing_summary.rb
Normal file
15
lib/stripe/resources/capital/financing_summary.rb
Normal file
@ -0,0 +1,15 @@
|
||||
# File generated from our OpenAPI spec
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Stripe
|
||||
module Capital
|
||||
# A financing object describes an account's current financing state. Used by Connect
|
||||
# platforms to read the state of Capital offered to their connected accounts.
|
||||
class FinancingSummary < SingletonAPIResource
|
||||
OBJECT_NAME = "capital.financing_summary"
|
||||
def self.object_name
|
||||
"capital.financing_summary"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
27
lib/stripe/resources/capital/financing_transaction.rb
Normal file
27
lib/stripe/resources/capital/financing_transaction.rb
Normal file
@ -0,0 +1,27 @@
|
||||
# File generated from our OpenAPI spec
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Stripe
|
||||
module Capital
|
||||
# This is an object representing the details of a transaction on a Capital financing object.
|
||||
class FinancingTransaction < APIResource
|
||||
extend Stripe::APIOperations::List
|
||||
|
||||
OBJECT_NAME = "capital.financing_transaction"
|
||||
def self.object_name
|
||||
"capital.financing_transaction"
|
||||
end
|
||||
|
||||
# Returns a list of financing transactions. The transactions are returned in sorted order,
|
||||
# with the most recent transactions appearing first.
|
||||
def self.list(filters = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :get,
|
||||
path: "/v1/capital/financing_transactions",
|
||||
params: filters,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
@ -6,12 +6,15 @@ module Stripe
|
||||
# A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.
|
||||
class Account < APIResource
|
||||
extend Stripe::APIOperations::List
|
||||
extend Stripe::APIOperations::NestedResource
|
||||
|
||||
OBJECT_NAME = "financial_connections.account"
|
||||
def self.object_name
|
||||
"financial_connections.account"
|
||||
end
|
||||
|
||||
nested_resource_class_methods :inferred_balance, operations: %i[list]
|
||||
|
||||
# Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
|
||||
def disconnect(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
|
@ -0,0 +1,14 @@
|
||||
# File generated from our OpenAPI spec
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Stripe
|
||||
module FinancialConnections
|
||||
# A historical balance for the account on a particular day. It may be sourced from a balance snapshot provided by a financial institution, or inferred using transactions data.
|
||||
class AccountInferredBalance < APIResource
|
||||
OBJECT_NAME = "financial_connections.account_inferred_balance"
|
||||
def self.object_name
|
||||
"financial_connections.account_inferred_balance"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
59
lib/stripe/resources/gift_cards/card.rb
Normal file
59
lib/stripe/resources/gift_cards/card.rb
Normal file
@ -0,0 +1,59 @@
|
||||
# File generated from our OpenAPI spec
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Stripe
|
||||
module GiftCards
|
||||
# A gift card represents a single gift card owned by a customer, including the
|
||||
# remaining balance, gift card code, and whether or not it is active.
|
||||
class Card < APIResource
|
||||
extend Stripe::APIOperations::Create
|
||||
extend Stripe::APIOperations::List
|
||||
include Stripe::APIOperations::Save
|
||||
|
||||
OBJECT_NAME = "gift_cards.card"
|
||||
def self.object_name
|
||||
"gift_cards.card"
|
||||
end
|
||||
|
||||
# Creates a new gift card object.
|
||||
def self.create(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: "/v1/gift_cards/cards",
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# List gift cards for an account
|
||||
def self.list(filters = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :get,
|
||||
path: "/v1/gift_cards/cards",
|
||||
params: filters,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Update a gift card
|
||||
def self.update(id, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/gift_cards/cards/%<id>s", { id: CGI.escape(id) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Validates a gift card code, returning the matching gift card object if it exists.
|
||||
def self.validate(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: "/v1/gift_cards/cards/validate",
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
93
lib/stripe/resources/gift_cards/transaction.rb
Normal file
93
lib/stripe/resources/gift_cards/transaction.rb
Normal file
@ -0,0 +1,93 @@
|
||||
# File generated from our OpenAPI spec
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Stripe
|
||||
module GiftCards
|
||||
# A gift card transaction represents a single transaction on a referenced gift card.
|
||||
# A transaction is in one of three states, `confirmed`, `held` or `canceled`. A `confirmed`
|
||||
# transaction is one that has added/deducted funds. A `held` transaction has created a
|
||||
# temporary hold on funds, which can then be cancelled or confirmed. A `held` transaction
|
||||
# can be confirmed into a `confirmed` transaction, or canceled into a `canceled` transaction.
|
||||
# A `canceled` transaction has no effect on a gift card's balance.
|
||||
class Transaction < APIResource
|
||||
extend Stripe::APIOperations::Create
|
||||
extend Stripe::APIOperations::List
|
||||
include Stripe::APIOperations::Save
|
||||
|
||||
OBJECT_NAME = "gift_cards.transaction"
|
||||
def self.object_name
|
||||
"gift_cards.transaction"
|
||||
end
|
||||
|
||||
# Cancel a gift card transaction
|
||||
def cancel(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/gift_cards/transactions/%<id>s/cancel", { id: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Cancel a gift card transaction
|
||||
def self.cancel(id, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/gift_cards/transactions/%<id>s/cancel", { id: CGI.escape(id) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Confirm a gift card transaction
|
||||
def confirm(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/gift_cards/transactions/%<id>s/confirm", { id: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Confirm a gift card transaction
|
||||
def self.confirm(id, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/gift_cards/transactions/%<id>s/confirm", { id: CGI.escape(id) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Create a gift card transaction
|
||||
def self.create(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: "/v1/gift_cards/transactions",
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# List gift card transactions for a gift card
|
||||
def self.list(filters = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :get,
|
||||
path: "/v1/gift_cards/transactions",
|
||||
params: filters,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Update a gift card transaction
|
||||
def self.update(id, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/gift_cards/transactions/%<id>s", { id: CGI.escape(id) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
@ -48,6 +48,63 @@ module Stripe
|
||||
end
|
||||
|
||||
nested_resource_class_methods :line, operations: %i[list]
|
||||
nested_resource_class_methods :payment, operations: %i[retrieve list]
|
||||
|
||||
# Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.
|
||||
def add_lines(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/invoices/%<invoice>s/add_lines", { invoice: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.
|
||||
def self.add_lines(invoice, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/invoices/%<invoice>s/add_lines", { invoice: CGI.escape(invoice) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Attaches a PaymentIntent to the invoice, adding it to the list of payments.
|
||||
# When the PaymentIntent's status changes to succeeded, the payment is credited
|
||||
# to the invoice, increasing its amount_paid. When the invoice is fully paid, the
|
||||
# invoice's status becomes paid.
|
||||
#
|
||||
# If the PaymentIntent's status is already succeeded when it is attached, it is
|
||||
# credited to the invoice immediately.
|
||||
#
|
||||
# Related guide: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create)
|
||||
def attach_payment_intent(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/invoices/%<invoice>s/attach_payment_intent", { invoice: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Attaches a PaymentIntent to the invoice, adding it to the list of payments.
|
||||
# When the PaymentIntent's status changes to succeeded, the payment is credited
|
||||
# to the invoice, increasing its amount_paid. When the invoice is fully paid, the
|
||||
# invoice's status becomes paid.
|
||||
#
|
||||
# If the PaymentIntent's status is already succeeded when it is attached, it is
|
||||
# credited to the invoice immediately.
|
||||
#
|
||||
# Related guide: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create)
|
||||
def self.attach_payment_intent(invoice, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/invoices/%<invoice>s/attach_payment_intent", { invoice: CGI.escape(invoice) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or <a href="#send_invoice">send](https://stripe.com/docs/api#finalize_invoice) the invoice to your customers.
|
||||
def self.create(params = {}, opts = {})
|
||||
@ -165,6 +222,26 @@ module Stripe
|
||||
)
|
||||
end
|
||||
|
||||
# Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.
|
||||
def remove_lines(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/invoices/%<invoice>s/remove_lines", { invoice: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.
|
||||
def self.remove_lines(invoice, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/invoices/%<invoice>s/remove_lines", { invoice: CGI.escape(invoice) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
def self.search(params = {}, opts = {})
|
||||
request_stripe_object(method: :get, path: "/v1/invoices/search", params: params, opts: opts)
|
||||
end
|
||||
@ -223,6 +300,26 @@ module Stripe
|
||||
)
|
||||
end
|
||||
|
||||
# Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.
|
||||
def update_lines(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/invoices/%<invoice>s/update_lines", { invoice: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.
|
||||
def self.update_lines(invoice, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/invoices/%<invoice>s/update_lines", { invoice: CGI.escape(invoice) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://stripe.com/docs/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.
|
||||
#
|
||||
# Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or <a href="#create_credit_note">credit note](https://stripe.com/docs/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.
|
||||
|
12
lib/stripe/resources/invoice_payment.rb
Normal file
12
lib/stripe/resources/invoice_payment.rb
Normal file
@ -0,0 +1,12 @@
|
||||
# File generated from our OpenAPI spec
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Stripe
|
||||
# The invoice payment object
|
||||
class InvoicePayment < APIResource
|
||||
OBJECT_NAME = "invoice_payment"
|
||||
def self.object_name
|
||||
"invoice_payment"
|
||||
end
|
||||
end
|
||||
end
|
88
lib/stripe/resources/issuing/credit_underwriting_record.rb
Normal file
88
lib/stripe/resources/issuing/credit_underwriting_record.rb
Normal file
@ -0,0 +1,88 @@
|
||||
# File generated from our OpenAPI spec
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Stripe
|
||||
module Issuing
|
||||
# Every time an applicant submits an application for a Charge Card product your platform offers, or every time your platform takes a proactive credit decision on an existing account, you must record the decision by creating a new `CreditUnderwritingRecord` object on a connected account.
|
||||
#
|
||||
# [Follow the guide](https://stripe.com/docs/issuing/credit/report-credit-decisions-and-manage-aans) to learn about your requirements as a platform.
|
||||
class CreditUnderwritingRecord < APIResource
|
||||
extend Stripe::APIOperations::List
|
||||
|
||||
OBJECT_NAME = "issuing.credit_underwriting_record"
|
||||
def self.object_name
|
||||
"issuing.credit_underwriting_record"
|
||||
end
|
||||
|
||||
# Update a CreditUnderwritingRecord object to correct mistakes.
|
||||
def correct(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/correct", { credit_underwriting_record: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Update a CreditUnderwritingRecord object to correct mistakes.
|
||||
def self.correct(credit_underwriting_record, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/correct", { credit_underwriting_record: CGI.escape(credit_underwriting_record) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Creates a CreditUnderwritingRecord object with information about a credit application submission.
|
||||
def self.create_from_application(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: "/v1/issuing/credit_underwriting_records/create_from_application",
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Creates a CreditUnderwritingRecord object from an underwriting decision coming from a proactive review of an existing accountholder.
|
||||
def self.create_from_proactive_review(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: "/v1/issuing/credit_underwriting_records/create_from_proactive_review",
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Retrieves a list of CreditUnderwritingRecord objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
|
||||
def self.list(filters = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :get,
|
||||
path: "/v1/issuing/credit_underwriting_records",
|
||||
params: filters,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Update a CreditUnderwritingRecord object from a decision made on a credit application.
|
||||
def report_decision(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/report_decision", { credit_underwriting_record: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Update a CreditUnderwritingRecord object from a decision made on a credit application.
|
||||
def self.report_decision(credit_underwriting_record, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/report_decision", { credit_underwriting_record: CGI.escape(credit_underwriting_record) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
37
lib/stripe/resources/margin.rb
Normal file
37
lib/stripe/resources/margin.rb
Normal file
@ -0,0 +1,37 @@
|
||||
# File generated from our OpenAPI spec
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Stripe
|
||||
# A (partner) margin represents a specific discount distributed in partner reseller programs to business partners who
|
||||
# resell products and services and earn a discount (margin) for doing so.
|
||||
class Margin < APIResource
|
||||
extend Stripe::APIOperations::Create
|
||||
extend Stripe::APIOperations::List
|
||||
include Stripe::APIOperations::Save
|
||||
|
||||
OBJECT_NAME = "margin"
|
||||
def self.object_name
|
||||
"margin"
|
||||
end
|
||||
|
||||
# Create a margin object to be used with invoices, invoice items, and invoice line items for a customer to represent a partner discount.A margin has a percent_off which is the percent that will be taken off the subtotal after all items and other discounts and promotions) of any invoices for a customer. Calculation of prorations do not include any partner margins applied on the original invoice item.
|
||||
def self.create(params = {}, opts = {})
|
||||
request_stripe_object(method: :post, path: "/v1/billing/margins", params: params, opts: opts)
|
||||
end
|
||||
|
||||
# Retrieve a list of your margins.
|
||||
def self.list(filters = {}, opts = {})
|
||||
request_stripe_object(method: :get, path: "/v1/billing/margins", params: filters, opts: opts)
|
||||
end
|
||||
|
||||
# Update the specified margin object. Certain fields of the margin object are not editable.
|
||||
def self.update(id, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/billing/margins/%<id>s", { id: CGI.escape(id) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
end
|
||||
end
|
120
lib/stripe/resources/order.rb
Normal file
120
lib/stripe/resources/order.rb
Normal file
@ -0,0 +1,120 @@
|
||||
# File generated from our OpenAPI spec
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Stripe
|
||||
# An Order describes a purchase being made by a customer, including the
|
||||
# products & quantities being purchased, the order status, the payment information,
|
||||
# and the billing/shipping details.
|
||||
#
|
||||
# Related guide: [Orders overview](https://stripe.com/docs/orders)
|
||||
class Order < APIResource
|
||||
extend Stripe::APIOperations::Create
|
||||
extend Stripe::APIOperations::List
|
||||
include Stripe::APIOperations::Save
|
||||
|
||||
OBJECT_NAME = "order"
|
||||
def self.object_name
|
||||
"order"
|
||||
end
|
||||
|
||||
# Cancels the order as well as the payment intent if one is attached.
|
||||
def cancel(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/orders/%<id>s/cancel", { id: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Cancels the order as well as the payment intent if one is attached.
|
||||
def self.cancel(id, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/orders/%<id>s/cancel", { id: CGI.escape(id) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Creates a new open order object.
|
||||
def self.create(params = {}, opts = {})
|
||||
request_stripe_object(method: :post, path: "/v1/orders", params: params, opts: opts)
|
||||
end
|
||||
|
||||
# Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.
|
||||
def self.list(filters = {}, opts = {})
|
||||
request_stripe_object(method: :get, path: "/v1/orders", params: filters, opts: opts)
|
||||
end
|
||||
|
||||
# When retrieving an order, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
|
||||
def list_line_items(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :get,
|
||||
path: format("/v1/orders/%<id>s/line_items", { id: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# When retrieving an order, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
|
||||
def self.list_line_items(id, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :get,
|
||||
path: format("/v1/orders/%<id>s/line_items", { id: CGI.escape(id) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Reopens a submitted order.
|
||||
def reopen(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/orders/%<id>s/reopen", { id: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Reopens a submitted order.
|
||||
def self.reopen(id, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/orders/%<id>s/reopen", { id: CGI.escape(id) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://stripe.com/docs/api#reopen_order) method is called.
|
||||
def submit(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/orders/%<id>s/submit", { id: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://stripe.com/docs/api#reopen_order) method is called.
|
||||
def self.submit(id, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/orders/%<id>s/submit", { id: CGI.escape(id) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
||||
def self.update(id, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/orders/%<id>s", { id: CGI.escape(id) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
end
|
||||
end
|
@ -176,6 +176,56 @@ module Stripe
|
||||
request_stripe_object(method: :post, path: "/v1/payment_intents", params: params, opts: opts)
|
||||
end
|
||||
|
||||
# Perform a decremental authorization on an eligible
|
||||
# [PaymentIntent](https://stripe.com/docs/api/payment_intents/object). To be eligible, the
|
||||
# PaymentIntent's status must be requires_capture and
|
||||
# [decremental_authorization.status](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization)
|
||||
# must be available.
|
||||
#
|
||||
# Decremental authorizations decrease the authorized amount on your customer's card
|
||||
# to the new, lower amount provided. A single PaymentIntent can call this endpoint multiple times to further decrease the authorized amount.
|
||||
#
|
||||
# After decrement, the PaymentIntent object
|
||||
# returns with the updated
|
||||
# [amount](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-amount).
|
||||
# The PaymentIntent will now be capturable up to the new authorized amount.
|
||||
#
|
||||
# Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines.
|
||||
# After it's fully captured, a PaymentIntent can no longer be decremented.
|
||||
def decrement_authorization(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/payment_intents/%<intent>s/decrement_authorization", { intent: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Perform a decremental authorization on an eligible
|
||||
# [PaymentIntent](https://stripe.com/docs/api/payment_intents/object). To be eligible, the
|
||||
# PaymentIntent's status must be requires_capture and
|
||||
# [decremental_authorization.status](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization)
|
||||
# must be available.
|
||||
#
|
||||
# Decremental authorizations decrease the authorized amount on your customer's card
|
||||
# to the new, lower amount provided. A single PaymentIntent can call this endpoint multiple times to further decrease the authorized amount.
|
||||
#
|
||||
# After decrement, the PaymentIntent object
|
||||
# returns with the updated
|
||||
# [amount](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-amount).
|
||||
# The PaymentIntent will now be capturable up to the new authorized amount.
|
||||
#
|
||||
# Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines.
|
||||
# After it's fully captured, a PaymentIntent can no longer be decremented.
|
||||
def self.decrement_authorization(intent, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/payment_intents/%<intent>s/decrement_authorization", { intent: CGI.escape(intent) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Perform an incremental authorization on an eligible
|
||||
# [PaymentIntent](https://stripe.com/docs/api/payment_intents/object). To be eligible, the
|
||||
# PaymentIntent's status must be requires_capture and
|
||||
|
@ -7,6 +7,7 @@ module Stripe
|
||||
class Quote < APIResource
|
||||
extend Stripe::APIOperations::Create
|
||||
extend Stripe::APIOperations::List
|
||||
extend Stripe::APIOperations::NestedResource
|
||||
include Stripe::APIOperations::Save
|
||||
|
||||
OBJECT_NAME = "quote"
|
||||
@ -14,6 +15,9 @@ module Stripe
|
||||
"quote"
|
||||
end
|
||||
|
||||
nested_resource_class_methods :preview_invoice, operations: %i[list]
|
||||
nested_resource_class_methods :preview_subscription_schedule, operations: %i[list]
|
||||
|
||||
# Accepts the specified quote.
|
||||
def accept(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
@ -124,6 +128,86 @@ module Stripe
|
||||
)
|
||||
end
|
||||
|
||||
# Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
|
||||
def list_lines(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :get,
|
||||
path: format("/v1/quotes/%<quote>s/lines", { quote: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
|
||||
def self.list_lines(quote, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :get,
|
||||
path: format("/v1/quotes/%<quote>s/lines", { quote: CGI.escape(quote) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Preview the invoice line items that would be generated by accepting the quote.
|
||||
def list_preview_invoice_lines(preview_invoice, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :get,
|
||||
path: format("/v1/quotes/%<quote>s/preview_invoices/%<preview_invoice>s/lines", { quote: CGI.escape(self["id"]), preview_invoice: CGI.escape(preview_invoice) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Preview the invoice line items that would be generated by accepting the quote.
|
||||
def self.list_preview_invoice_lines(quote, preview_invoice, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :get,
|
||||
path: format("/v1/quotes/%<quote>s/preview_invoices/%<preview_invoice>s/lines", { quote: CGI.escape(quote), preview_invoice: CGI.escape(preview_invoice) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Converts a stale quote to draft.
|
||||
def mark_draft(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/quotes/%<quote>s/mark_draft", { quote: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Converts a stale quote to draft.
|
||||
def self.mark_draft(quote, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/quotes/%<quote>s/mark_draft", { quote: CGI.escape(quote) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Converts a draft or open quote to stale.
|
||||
def mark_stale(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/quotes/%<quote>s/mark_stale", { quote: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Converts a draft or open quote to stale.
|
||||
def self.mark_stale(quote, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/quotes/%<quote>s/mark_stale", { quote: CGI.escape(quote) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.corp.stripe.com/quotes/overview#quote_pdf)
|
||||
def pdf(params = {}, opts = {}, &read_body_chunk_block)
|
||||
config = opts[:client]&.config || Stripe.config
|
||||
@ -150,6 +234,26 @@ module Stripe
|
||||
)
|
||||
end
|
||||
|
||||
# Recompute the upcoming invoice estimate for the quote.
|
||||
def reestimate(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/quotes/%<quote>s/reestimate", { quote: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Recompute the upcoming invoice estimate for the quote.
|
||||
def self.reestimate(quote, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/quotes/%<quote>s/reestimate", { quote: CGI.escape(quote) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# A quote models prices and services for a customer.
|
||||
def self.update(id, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
|
39
lib/stripe/resources/quote_phase.rb
Normal file
39
lib/stripe/resources/quote_phase.rb
Normal file
@ -0,0 +1,39 @@
|
||||
# File generated from our OpenAPI spec
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Stripe
|
||||
# A quote phase describes the line items, coupons, and trialing status of a subscription for a predefined time period.
|
||||
class QuotePhase < APIResource
|
||||
extend Stripe::APIOperations::List
|
||||
|
||||
OBJECT_NAME = "quote_phase"
|
||||
def self.object_name
|
||||
"quote_phase"
|
||||
end
|
||||
|
||||
# Returns a list of quote phases.
|
||||
def self.list(filters = {}, opts = {})
|
||||
request_stripe_object(method: :get, path: "/v1/quote_phases", params: filters, opts: opts)
|
||||
end
|
||||
|
||||
# When retrieving a quote phase, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
|
||||
def list_line_items(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :get,
|
||||
path: format("/v1/quote_phases/%<quote_phase>s/line_items", { quote_phase: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# When retrieving a quote phase, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
|
||||
def self.list_line_items(quote_phase, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :get,
|
||||
path: format("/v1/quote_phases/%<quote_phase>s/line_items", { quote_phase: CGI.escape(quote_phase) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
end
|
||||
end
|
43
lib/stripe/resources/quote_preview_invoice.rb
Normal file
43
lib/stripe/resources/quote_preview_invoice.rb
Normal file
@ -0,0 +1,43 @@
|
||||
# File generated from our OpenAPI spec
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Stripe
|
||||
# Invoices are statements of amounts owed by a customer, and are either
|
||||
# generated one-off, or generated periodically from a subscription.
|
||||
#
|
||||
# They contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments
|
||||
# that may be caused by subscription upgrades/downgrades (if necessary).
|
||||
#
|
||||
# If your invoice is configured to be billed through automatic charges,
|
||||
# Stripe automatically finalizes your invoice and attempts payment. Note
|
||||
# that finalizing the invoice,
|
||||
# [when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does
|
||||
# not happen immediately as the invoice is created. Stripe waits
|
||||
# until one hour after the last webhook was successfully sent (or the last
|
||||
# webhook timed out after failing). If you (and the platforms you may have
|
||||
# connected to) have no webhooks configured, Stripe waits one hour after
|
||||
# creation to finalize the invoice.
|
||||
#
|
||||
# If your invoice is configured to be billed by sending an email, then based on your
|
||||
# [email settings](https://dashboard.stripe.com/account/billing/automatic),
|
||||
# Stripe will email the invoice to your customer and await payment. These
|
||||
# emails can contain a link to a hosted page to pay the invoice.
|
||||
#
|
||||
# Stripe applies any customer credit on the account before determining the
|
||||
# amount due for the invoice (i.e., the amount that will be actually
|
||||
# charged). If the amount due for the invoice is less than Stripe's [minimum allowed charge
|
||||
# per currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts), the
|
||||
# invoice is automatically marked paid, and we add the amount due to the
|
||||
# customer's credit balance which is applied to the next invoice.
|
||||
#
|
||||
# More details on the customer's credit balance are
|
||||
# [here](https://stripe.com/docs/billing/customer/balance).
|
||||
#
|
||||
# Related guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)
|
||||
class QuotePreviewInvoice < APIResource
|
||||
OBJECT_NAME = "quote_preview_invoice"
|
||||
def self.object_name
|
||||
"quote_preview_invoice"
|
||||
end
|
||||
end
|
||||
end
|
11
lib/stripe/resources/quote_preview_subscription_schedule.rb
Normal file
11
lib/stripe/resources/quote_preview_subscription_schedule.rb
Normal file
@ -0,0 +1,11 @@
|
||||
# File generated from our OpenAPI spec
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Stripe
|
||||
class QuotePreviewSubscriptionSchedule < APIResource
|
||||
OBJECT_NAME = "quote_preview_subscription_schedule"
|
||||
def self.object_name
|
||||
"quote_preview_subscription_schedule"
|
||||
end
|
||||
end
|
||||
end
|
@ -15,6 +15,26 @@ module Stripe
|
||||
"subscription_schedule"
|
||||
end
|
||||
|
||||
# Amends an existing subscription schedule.
|
||||
def amend(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/subscription_schedules/%<schedule>s/amend", { schedule: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Amends an existing subscription schedule.
|
||||
def self.amend(schedule, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/subscription_schedules/%<schedule>s/amend", { schedule: CGI.escape(schedule) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
|
||||
def cancel(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
|
49
lib/stripe/resources/tax/form.rb
Normal file
49
lib/stripe/resources/tax/form.rb
Normal file
@ -0,0 +1,49 @@
|
||||
# File generated from our OpenAPI spec
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Stripe
|
||||
module Tax
|
||||
# Tax forms are legal documents which are delivered to one or more tax authorities for information reporting purposes.
|
||||
#
|
||||
# Related guide: [US tax reporting for Connect platforms](https://stripe.com/docs/connect/tax-reporting)
|
||||
class Form < APIResource
|
||||
extend Stripe::APIOperations::List
|
||||
|
||||
OBJECT_NAME = "tax.form"
|
||||
def self.object_name
|
||||
"tax.form"
|
||||
end
|
||||
|
||||
# Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
|
||||
def self.list(filters = {}, opts = {})
|
||||
request_stripe_object(method: :get, path: "/v1/tax/forms", params: filters, opts: opts)
|
||||
end
|
||||
|
||||
# Download the PDF for a tax form.
|
||||
def pdf(params = {}, opts = {}, &read_body_chunk_block)
|
||||
config = opts[:client]&.config || Stripe.config
|
||||
opts = { api_base: config.uploads_base }.merge(opts)
|
||||
request_stream(
|
||||
method: :get,
|
||||
path: format("/v1/tax/forms/%<id>s/pdf", { id: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts,
|
||||
&read_body_chunk_block
|
||||
)
|
||||
end
|
||||
|
||||
# Download the PDF for a tax form.
|
||||
def self.pdf(id, params = {}, opts = {}, &read_body_chunk_block)
|
||||
config = opts[:client]&.config || Stripe.config
|
||||
opts = { api_base: config.uploads_base }.merge(opts)
|
||||
execute_resource_request_stream(
|
||||
:get,
|
||||
format("/v1/tax/forms/%<id>s/pdf", { id: CGI.escape(id) }),
|
||||
params,
|
||||
opts,
|
||||
&read_body_chunk_block
|
||||
)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
@ -37,6 +37,66 @@ module Stripe
|
||||
)
|
||||
end
|
||||
|
||||
# Initiates an input collection flow on a Reader.
|
||||
def collect_inputs(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/terminal/readers/%<reader>s/collect_inputs", { reader: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Initiates an input collection flow on a Reader.
|
||||
def self.collect_inputs(reader, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/terminal/readers/%<reader>s/collect_inputs", { reader: CGI.escape(reader) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
|
||||
def collect_payment_method(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/terminal/readers/%<reader>s/collect_payment_method", { reader: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
|
||||
def self.collect_payment_method(reader, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/terminal/readers/%<reader>s/collect_payment_method", { reader: CGI.escape(reader) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Finalizes a payment on a Reader.
|
||||
def confirm_payment_intent(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/terminal/readers/%<reader>s/confirm_payment_intent", { reader: CGI.escape(self["id"]) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Finalizes a payment on a Reader.
|
||||
def self.confirm_payment_intent(reader, params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
method: :post,
|
||||
path: format("/v1/terminal/readers/%<reader>s/confirm_payment_intent", { reader: CGI.escape(reader) }),
|
||||
params: params,
|
||||
opts: opts
|
||||
)
|
||||
end
|
||||
|
||||
# Creates a new Reader object.
|
||||
def self.create(params = {}, opts = {})
|
||||
request_stripe_object(
|
||||
|
@ -213,9 +213,10 @@ module Stripe
|
||||
end
|
||||
|
||||
def execute_request(method, path,
|
||||
api_base: nil, api_key: nil, headers: {}, params: {}, usage: [])
|
||||
api_base: nil, api_key: nil,
|
||||
headers: {}, params: {}, api_mode: nil, usage: [])
|
||||
http_resp, api_key = execute_request_internal(
|
||||
method, path, api_base, api_key, headers, params, usage
|
||||
method, path, api_base, api_key, headers, params, api_mode, usage
|
||||
)
|
||||
|
||||
begin
|
||||
@ -246,6 +247,7 @@ module Stripe
|
||||
def execute_request_stream(method, path,
|
||||
api_base: nil, api_key: nil, usage: [],
|
||||
headers: {}, params: {},
|
||||
api_mode: nil,
|
||||
&read_body_chunk_block)
|
||||
unless block_given?
|
||||
raise ArgumentError,
|
||||
@ -253,7 +255,8 @@ module Stripe
|
||||
end
|
||||
|
||||
http_resp, api_key = execute_request_internal(
|
||||
method, path, api_base, api_key, headers, params, usage, &read_body_chunk_block
|
||||
method, path, api_base, api_key,
|
||||
headers, params, api_mode, usage, &read_body_chunk_block
|
||||
)
|
||||
|
||||
# When the read_body_chunk_block is given, we no longer have access to the
|
||||
@ -432,8 +435,8 @@ module Stripe
|
||||
end
|
||||
|
||||
private def execute_request_internal(method, path,
|
||||
api_base, api_key, headers, params, usage,
|
||||
&read_body_chunk_block)
|
||||
api_base, api_key, headers, params,
|
||||
api_mode, usage, &read_body_chunk_block)
|
||||
raise ArgumentError, "method should be a symbol" \
|
||||
unless method.is_a?(Symbol)
|
||||
raise ArgumentError, "path should be a string" \
|
||||
@ -441,9 +444,10 @@ module Stripe
|
||||
|
||||
api_base ||= config.api_base
|
||||
api_key ||= config.api_key
|
||||
authenticator ||= config.authenticator
|
||||
params = Util.objects_to_ids(params)
|
||||
|
||||
check_api_key!(api_key)
|
||||
check_keys!(api_key, authenticator)
|
||||
|
||||
body_params = nil
|
||||
query_params = nil
|
||||
@ -456,8 +460,9 @@ module Stripe
|
||||
|
||||
query_params, path = merge_query_params(query_params, path)
|
||||
|
||||
headers = request_headers(api_key, method)
|
||||
headers = request_headers(api_key, method, api_mode)
|
||||
.update(Util.normalize_headers(headers))
|
||||
|
||||
url = api_url(path, api_base)
|
||||
|
||||
# Merge given query parameters with any already encoded in the path.
|
||||
@ -468,13 +473,16 @@ module Stripe
|
||||
# a log-friendly variant of the encoded form. File objects are displayed
|
||||
# as such instead of as their file contents.
|
||||
body, body_log =
|
||||
body_params ? encode_body(body_params, headers) : [nil, nil]
|
||||
body_params ? encode_body(body_params, headers, api_mode) : [nil, nil]
|
||||
|
||||
authenticator.authenticate(method, headers, body) unless api_key
|
||||
|
||||
# stores information on the request we're about to make so that we don't
|
||||
# have to pass as many parameters around for logging.
|
||||
context = RequestLogContext.new
|
||||
context.account = headers["Stripe-Account"]
|
||||
context.api_key = api_key
|
||||
context.authenticator = authenticator
|
||||
context.api_version = headers["Stripe-Version"]
|
||||
context.body = body_log
|
||||
context.idempotency_key = headers["Idempotency-Key"]
|
||||
@ -511,8 +519,16 @@ module Stripe
|
||||
(api_base || config.api_base) + url
|
||||
end
|
||||
|
||||
private def check_api_key!(api_key)
|
||||
unless api_key
|
||||
private def check_keys!(api_key, authenticator)
|
||||
if api_key && authenticator
|
||||
raise AuthenticationError, "Can't specify both API key " \
|
||||
"and authenticator. Either set your API key" \
|
||||
'using "Stripe.api_key = <API-KEY>", or set your authenticator ' \
|
||||
'using "Stripe.authenticator = <AUTHENTICATOR>"' \
|
||||
end
|
||||
|
||||
unless api_key || authenticator
|
||||
# Default to missing API key error message for general users.
|
||||
raise AuthenticationError, "No API key provided. " \
|
||||
'Set your API key using "Stripe.api_key = <API-KEY>". ' \
|
||||
"You can generate API keys from the Stripe web interface. " \
|
||||
@ -531,7 +547,7 @@ module Stripe
|
||||
# Encodes a set of body parameters using multipart if `Content-Type` is set
|
||||
# for that, or standard form-encoding otherwise. Returns the encoded body
|
||||
# and a version of the encoded body that's safe to be logged.
|
||||
private def encode_body(body_params, headers)
|
||||
private def encode_body(body_params, headers, api_mode)
|
||||
body = nil
|
||||
flattened_params = Util.flatten_params(body_params)
|
||||
|
||||
@ -547,15 +563,22 @@ module Stripe
|
||||
flattened_params =
|
||||
flattened_params.map { |k, v| [k, v.is_a?(String) ? v : v.to_s] }.to_h
|
||||
|
||||
elsif api_mode == :preview
|
||||
body = JSON.generate(body_params)
|
||||
headers["Content-Type"] = "application/json"
|
||||
else
|
||||
body = Util.encode_parameters(body_params)
|
||||
end
|
||||
|
||||
# We don't use `Util.encode_parameters` partly as an optimization (to not
|
||||
# redo work we've already done), and partly because the encoded forms of
|
||||
# certain characters introduce a lot of visual noise and it's nice to
|
||||
# have a clearer format for logs.
|
||||
body_log = flattened_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
||||
body_log = if api_mode == :preview
|
||||
body
|
||||
else
|
||||
# We don't use `Util.encode_parameters` partly as an optimization (to
|
||||
# not redo work we've already done), and partly because the encoded
|
||||
# forms of certain characters introduce a lot of visual noise and it's
|
||||
# nice to have a clearer format for logs.
|
||||
flattened_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
||||
end
|
||||
|
||||
[body, body_log]
|
||||
end
|
||||
@ -741,10 +764,11 @@ module Stripe
|
||||
end
|
||||
|
||||
private def specific_api_error(resp, error_data, context)
|
||||
message = error_data[:message]
|
||||
Util.log_error("Stripe API error",
|
||||
status: resp.http_status,
|
||||
error_code: error_data[:code],
|
||||
error_message: error_data[:message],
|
||||
error_message: message,
|
||||
error_param: error_data[:param],
|
||||
error_type: error_data[:type],
|
||||
idempotency_key: context.idempotency_key,
|
||||
@ -765,26 +789,26 @@ module Stripe
|
||||
when 400, 404
|
||||
case error_data[:type]
|
||||
when "idempotency_error"
|
||||
IdempotencyError.new(error_data[:message], **opts)
|
||||
IdempotencyError.new(message, **opts)
|
||||
else
|
||||
InvalidRequestError.new(
|
||||
error_data[:message], error_data[:param],
|
||||
message, error_data[:param],
|
||||
**opts
|
||||
)
|
||||
end
|
||||
when 401
|
||||
AuthenticationError.new(error_data[:message], **opts)
|
||||
AuthenticationError.new(message, **opts)
|
||||
when 402
|
||||
CardError.new(
|
||||
error_data[:message], error_data[:param],
|
||||
message, error_data[:param],
|
||||
**opts
|
||||
)
|
||||
when 403
|
||||
PermissionError.new(error_data[:message], **opts)
|
||||
PermissionError.new(message, **opts)
|
||||
when 429
|
||||
RateLimitError.new(error_data[:message], **opts)
|
||||
RateLimitError.new(message, **opts)
|
||||
else
|
||||
APIError.new(error_data[:message], **opts)
|
||||
APIError.new(message, **opts)
|
||||
end
|
||||
end
|
||||
|
||||
@ -852,16 +876,20 @@ module Stripe
|
||||
message + "\n\n(Network error: #{error.message})"
|
||||
end
|
||||
|
||||
private def request_headers(api_key, method)
|
||||
private def request_headers(api_key, method, api_mode)
|
||||
user_agent = "Stripe/v1 RubyBindings/#{Stripe::VERSION}"
|
||||
user_agent += " " + format_app_info(Stripe.app_info) unless Stripe.app_info.nil?
|
||||
|
||||
headers = {
|
||||
"User-Agent" => user_agent,
|
||||
"Authorization" => "Bearer #{api_key}",
|
||||
"Content-Type" => "application/x-www-form-urlencoded",
|
||||
}
|
||||
|
||||
if api_mode != :preview
|
||||
# TODO: (major) don't set Content-Type if method is not post
|
||||
headers["Content-Type"] = "application/x-www-form-urlencoded"
|
||||
end
|
||||
|
||||
if config.enable_telemetry? && !@last_request_metrics.nil?
|
||||
headers["X-Stripe-Client-Telemetry"] = JSON.generate(
|
||||
last_request_metrics: @last_request_metrics.payload
|
||||
@ -874,7 +902,12 @@ module Stripe
|
||||
headers["Idempotency-Key"] ||= SecureRandom.uuid
|
||||
end
|
||||
|
||||
headers["Stripe-Version"] = config.api_version if config.api_version
|
||||
if api_mode == :preview
|
||||
headers["Stripe-Version"] = ApiVersion::PREVIEW
|
||||
elsif config.api_version
|
||||
headers["Stripe-Version"] = config.api_version
|
||||
end
|
||||
|
||||
headers["Stripe-Account"] = config.stripe_account if config.stripe_account
|
||||
|
||||
user_agent = @system_profiler.user_agent
|
||||
@ -957,7 +990,8 @@ module Stripe
|
||||
# that we can log certain information. It's useful because it means that we
|
||||
# don't have to pass around as many parameters.
|
||||
class RequestLogContext
|
||||
attr_accessor :body, :account, :api_key, :api_version, :idempotency_key, :method, :path, :query, :request_id
|
||||
attr_accessor :body, :account, :api_key, :authenticator, :api_version, :idempotency_key, :method, :path, :query,
|
||||
:request_id
|
||||
|
||||
# The idea with this method is that we might want to update some of
|
||||
# context information because a response that we've received from the API
|
||||
|
@ -25,7 +25,7 @@ module Stripe
|
||||
# If `.logger` is set, the value of `.log_level` is ignored. The decision on
|
||||
# what levels to print is entirely deferred to the logger.
|
||||
class StripeConfiguration
|
||||
attr_accessor :api_key, :api_version, :client_id, :enable_telemetry, :logger, :stripe_account
|
||||
attr_accessor :api_key, :api_version, :authenticator, :client_id, :enable_telemetry, :logger, :stripe_account
|
||||
|
||||
attr_reader :api_base, :uploads_base, :connect_base, :ca_bundle_path, :log_level, :initial_network_retry_delay,
|
||||
# rubocop:todo Layout/LineLength
|
||||
@ -50,6 +50,7 @@ module Stripe
|
||||
|
||||
def initialize
|
||||
@api_version = ApiVersion::CURRENT
|
||||
|
||||
@ca_bundle_path = Stripe::DEFAULT_CA_BUNDLE_PATH
|
||||
@enable_telemetry = true
|
||||
@verify_ssl_certs = true
|
||||
|
@ -7,6 +7,7 @@ module Stripe
|
||||
# Options that a user is allowed to specify.
|
||||
OPTS_USER_SPECIFIED = Set[
|
||||
:api_key,
|
||||
:authenticator,
|
||||
:idempotency_key,
|
||||
:stripe_account,
|
||||
:stripe_version
|
||||
@ -279,7 +280,13 @@ module Stripe
|
||||
when String
|
||||
{ api_key: opts }
|
||||
when Hash
|
||||
check_api_key!(opts.fetch(:api_key)) if opts.key?(:api_key)
|
||||
# If the user is using request signing for authentication,
|
||||
# no need to check the api_key per request.
|
||||
if !(opts.key?(:client) &&
|
||||
opts.fetch(:client).config.authenticator) &&
|
||||
opts.key?(:api_key)
|
||||
check_api_key!(opts.fetch(:api_key))
|
||||
end
|
||||
# Explicitly use dup here instead of clone to avoid preserving freeze
|
||||
# state on input params.
|
||||
opts.dup
|
||||
|
@ -1,5 +1,5 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Stripe
|
||||
VERSION = "11.5.0"
|
||||
VERSION = "11.7.0-beta.1"
|
||||
end
|
||||
|
@ -83,6 +83,19 @@ module Stripe
|
||||
|
||||
should "not specifying api credentials should raise an exception" do
|
||||
Stripe.api_key = nil
|
||||
Stripe.authenticator = nil
|
||||
assert_raises Stripe::AuthenticationError do
|
||||
Stripe::Customer.new("cus_123").refresh
|
||||
end
|
||||
end
|
||||
|
||||
should "specifying both api_key and authenticator should raise an exception" do
|
||||
Stripe.api_key = "sk_123"
|
||||
|
||||
def no_op; end
|
||||
|
||||
Stripe.authenticator = method(:no_op)
|
||||
|
||||
assert_raises Stripe::AuthenticationError do
|
||||
Stripe::Customer.new("cus_123").refresh
|
||||
end
|
||||
|
@ -1295,6 +1295,10 @@ module Stripe
|
||||
Stripe::Quote.update("qt_xxxxxxxxxxxxx", { metadata: { order_id: "6735" } })
|
||||
assert_requested :post, "#{Stripe.api_base}/v1/quotes/qt_xxxxxxxxxxxxx"
|
||||
end
|
||||
should "Test quotes preview invoices lines get" do
|
||||
Stripe::Quote.list_preview_invoice_lines("qt_xyz", "in_xyz")
|
||||
assert_requested :get, "#{Stripe.api_base}/v1/quotes/qt_xyz/preview_invoices/in_xyz/lines"
|
||||
end
|
||||
should "Test radar early fraud warnings get" do
|
||||
Stripe::Radar::EarlyFraudWarning.list({ limit: 3 })
|
||||
assert_requested :get, "#{Stripe.api_base}/v1/radar/early_fraud_warnings?limit=3"
|
||||
@ -1628,6 +1632,11 @@ module Stripe
|
||||
Stripe::TaxCode.retrieve("txcd_xxxxxxxxxxxxx")
|
||||
assert_requested :get, "#{Stripe.api_base}/v1/tax_codes/txcd_xxxxxxxxxxxxx"
|
||||
end
|
||||
should "Test tax forms pdf get" do
|
||||
block_handler = {}
|
||||
Stripe::Tax::Form.pdf("form_xxxxxxxxxxxxx", &block_handler)
|
||||
assert_requested :get, "#{Stripe.api_base}/v1/tax/forms/form_xxxxxxxxxxxxx/pdf"
|
||||
end
|
||||
should "Test tax ids delete" do
|
||||
Stripe::TaxId.delete("taxid_123")
|
||||
assert_requested :delete, "#{Stripe.api_base}/v1/tax_ids/taxid_123"
|
||||
|
84
test/stripe/preview_test.rb
Normal file
84
test/stripe/preview_test.rb
Normal file
@ -0,0 +1,84 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require File.expand_path("../test_helper", __dir__)
|
||||
|
||||
class PreviewTest < Test::Unit::TestCase
|
||||
context "preview raw requests" do
|
||||
should "send preview get request with correct default options" do
|
||||
expected_body = "{\"id\": \"acc_123\"}"
|
||||
req = nil
|
||||
|
||||
stub_request(:get, "#{Stripe.api_base}/v2/accounts/acc_123")
|
||||
.with { |request| req = request }
|
||||
.to_return(body: expected_body)
|
||||
|
||||
resp = Stripe::Preview.get("/v2/accounts/acc_123")
|
||||
|
||||
assert_equal nil, req.headers["Content-Type"]
|
||||
assert_equal Stripe::ApiVersion::PREVIEW, req.headers["Stripe-Version"]
|
||||
assert_equal expected_body, resp.http_body
|
||||
end
|
||||
|
||||
should "send preview post request with correct default options" do
|
||||
expected_body = "{\"id\": \"acc_123\"}"
|
||||
req = nil
|
||||
|
||||
stub_request(:post, "#{Stripe.api_base}/v2/accounts")
|
||||
.with { |request| req = request }
|
||||
.to_return(body: expected_body)
|
||||
|
||||
resp = Stripe::Preview.post("/v2/accounts", { p1: 1, p2: "string" })
|
||||
|
||||
assert_equal "application/json", req.headers["Content-Type"]
|
||||
assert_equal Stripe::ApiVersion::PREVIEW, req.headers["Stripe-Version"]
|
||||
assert_equal "{\"p1\":1,\"p2\":\"string\"}", req.body
|
||||
assert_equal expected_body, resp.http_body
|
||||
end
|
||||
|
||||
should "send preview delete request with correct default options" do
|
||||
expected_body = "{\"id\": \"acc_123\"}"
|
||||
req = nil
|
||||
|
||||
stub_request(:delete, "#{Stripe.api_base}/v2/accounts/acc_123")
|
||||
.with { |request| req = request }
|
||||
.to_return(body: expected_body)
|
||||
|
||||
resp = Stripe::Preview.delete("/v2/accounts/acc_123")
|
||||
|
||||
assert_equal nil, req.headers["Content-Type"]
|
||||
assert_equal Stripe::ApiVersion::PREVIEW, req.headers["Stripe-Version"]
|
||||
assert_equal expected_body, resp.http_body
|
||||
end
|
||||
|
||||
should "allow overriding default options for preview requests" do
|
||||
expected_body = "{\"id\": \"acc_123\"}"
|
||||
stripe_version_override = "2022-11-15"
|
||||
req = nil
|
||||
|
||||
stub_request(:post, "#{Stripe.api_base}/v2/accounts")
|
||||
.with { |request| req = request }
|
||||
.to_return(body: expected_body)
|
||||
|
||||
resp = Stripe::Preview.post("/v2/accounts", {}, { stripe_version: stripe_version_override })
|
||||
|
||||
assert_equal "application/json", req.headers["Content-Type"]
|
||||
assert_equal stripe_version_override, req.headers["Stripe-Version"]
|
||||
assert_equal expected_body, resp.http_body
|
||||
end
|
||||
|
||||
should "allow setting stripe_context for preview requests" do
|
||||
expected_body = "{\"id\": \"acc_123\"}"
|
||||
stripe_context = "acc_123"
|
||||
req = nil
|
||||
|
||||
stub_request(:post, "#{Stripe.api_base}/v2/accounts")
|
||||
.with { |request| req = request }
|
||||
.to_return(body: expected_body)
|
||||
|
||||
Stripe::Preview.post("/v2/accounts", {}, { stripe_context: stripe_context })
|
||||
|
||||
assert_equal "application/json", req.headers["Content-Type"]
|
||||
assert_equal stripe_context, req.headers["Stripe-Context"]
|
||||
end
|
||||
end
|
||||
end
|
128
test/stripe/raw_request_test.rb
Normal file
128
test/stripe/raw_request_test.rb
Normal file
@ -0,0 +1,128 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require File.expand_path("../test_helper", __dir__)
|
||||
|
||||
class RawRequestTest < Test::Unit::TestCase
|
||||
context "raw_request" do
|
||||
should "send get request and return a response" do
|
||||
expected_body = "{\"id\": \"acc_123\"}"
|
||||
req = nil
|
||||
|
||||
stub_request(:get, "#{Stripe.api_base}/v1/accounts/acc_123")
|
||||
.with { |request| req = request }
|
||||
.to_return(body: expected_body)
|
||||
|
||||
resp = Stripe.raw_request(:get, "/v1/accounts/acc_123")
|
||||
|
||||
assert_equal expected_body, resp.http_body
|
||||
assert_equal "application/x-www-form-urlencoded", req.headers["Content-Type"]
|
||||
assert_equal Stripe::ApiVersion::CURRENT, req.headers["Stripe-Version"]
|
||||
end
|
||||
|
||||
should "send post request with body and return a response" do
|
||||
expected_body = "{\"id\": \"acc_123\"}"
|
||||
req = nil
|
||||
|
||||
stub_request(:post, "#{Stripe.api_base}/v1/accounts/acc_123")
|
||||
.with(body: "p1=1&p2=string")
|
||||
.with { |request| req = request }
|
||||
.to_return(body: expected_body)
|
||||
|
||||
resp = Stripe.raw_request(:post, "/v1/accounts/acc_123", { p1: 1, p2: "string" })
|
||||
|
||||
assert_equal expected_body, resp.http_body
|
||||
assert_equal "application/x-www-form-urlencoded", req.headers["Content-Type"]
|
||||
assert_equal Stripe::ApiVersion::CURRENT, req.headers["Stripe-Version"]
|
||||
end
|
||||
|
||||
should "send post request with json body and return a response" do
|
||||
expected_body = "{\"id\": \"acc_123\"}"
|
||||
req = nil
|
||||
|
||||
stub_request(:post, "#{Stripe.api_base}/v1/accounts/acc_123")
|
||||
.with(body: "{\"p1\":1,\"p2\":\"string\"}")
|
||||
.with { |request| req = request }
|
||||
.to_return(body: expected_body)
|
||||
|
||||
resp = Stripe.raw_request(:post, "/v1/accounts/acc_123", { p1: 1, p2: "string" }, { api_mode: :preview })
|
||||
|
||||
assert_equal expected_body, resp.http_body
|
||||
assert_equal "application/json", req.headers["Content-Type"]
|
||||
assert_equal Stripe::ApiVersion::PREVIEW, req.headers["Stripe-Version"]
|
||||
end
|
||||
|
||||
should "send post request with json body and headers and return a response" do
|
||||
expected_body = "{\"id\": \"acc_123\"}"
|
||||
req = nil
|
||||
|
||||
stub_request(:post, "#{Stripe.api_base}/v1/accounts/acc_123")
|
||||
.with(body: "{\"p1\":1,\"p2\":\"string\"}")
|
||||
.with { |request| req = request }
|
||||
.to_return(body: expected_body)
|
||||
|
||||
resp = Stripe.raw_request(:post, "/v1/accounts/acc_123", { p1: 1, p2: "string" }, { api_mode: :preview, "Stripe-Context": "bar" })
|
||||
|
||||
assert_equal expected_body, resp.http_body
|
||||
assert_equal "application/json", req.headers["Content-Type"]
|
||||
assert_equal Stripe::ApiVersion::PREVIEW, req.headers["Stripe-Version"]
|
||||
assert_equal "bar", req.headers["Stripe-Context"]
|
||||
end
|
||||
|
||||
should "send get request with json body and headers and return a response" do
|
||||
expected_body = "{\"id\": \"acc_123\"}"
|
||||
req = nil
|
||||
|
||||
stub_request(:get, "#{Stripe.api_base}/v1/accounts/acc_123")
|
||||
.with { |request| req = request }
|
||||
.to_return(body: expected_body)
|
||||
|
||||
resp = Stripe.raw_request(:get, "/v1/accounts/acc_123", {}, { api_mode: :preview, "Stripe-Account": "bar" })
|
||||
|
||||
assert_not_equal "application/x-www-form-urlencoded", req.headers["Content-Type"]
|
||||
assert_equal expected_body, resp.http_body
|
||||
end
|
||||
|
||||
should "set default preview version when api_mode is preview and stripe_version not specified" do
|
||||
expected_body = "{\"id\": \"acc_123\"}"
|
||||
req = nil
|
||||
|
||||
stub_request(:get, "#{Stripe.api_base}/v1/accounts/acc_123")
|
||||
.with { |request| req = request }
|
||||
.to_return(body: expected_body)
|
||||
|
||||
Stripe.raw_request(:get, "/v1/accounts/acc_123", {}, { api_mode: :preview })
|
||||
|
||||
assert_equal Stripe::ApiVersion::PREVIEW, req.headers["Stripe-Version"]
|
||||
end
|
||||
|
||||
should "allow overriding stripe version when api_mode is preview" do
|
||||
expected_body = "{\"id\": \"acc_123\"}"
|
||||
req = nil
|
||||
|
||||
stub_request(:get, "#{Stripe.api_base}/v1/accounts/acc_123")
|
||||
.with { |request| req = request }
|
||||
.to_return(body: expected_body)
|
||||
|
||||
stripe_version_override = "2023-05-15.preview"
|
||||
Stripe.raw_request(:get, "/v1/accounts/acc_123", {}, { api_mode: :preview, stripe_version: stripe_version_override })
|
||||
|
||||
assert_equal stripe_version_override, req.headers["Stripe-Version"]
|
||||
end
|
||||
should "report usage" do
|
||||
expected_body = "{\"id\": \"acc_123\"}"
|
||||
telemetry_header = nil
|
||||
|
||||
Stripe.enable_telemetry = true
|
||||
|
||||
stub_request(:get, "#{Stripe.api_base}/v1/accounts/acc_124")
|
||||
.with { |request| telemetry_header = request.headers["X-Stripe-Client-Telemetry"] }
|
||||
.to_return(body: expected_body)
|
||||
|
||||
Stripe.raw_request(:get, "/v1/accounts/acc_123", {}, {})
|
||||
Stripe.raw_request(:get, "/v1/accounts/acc_124", {}, {})
|
||||
parsed_telemetry_header = JSON.parse(telemetry_header)
|
||||
|
||||
assert(parsed_telemetry_header["last_request_metrics"]["usage"] == ["raw_request"])
|
||||
end
|
||||
end
|
||||
end
|
112
test/stripe/request_signing_authenticator_test.rb
Normal file
112
test/stripe/request_signing_authenticator_test.rb
Normal file
@ -0,0 +1,112 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require File.expand_path("../test_helper", __dir__)
|
||||
|
||||
module Stripe
|
||||
class RequestSigningAuthenticatorTest < Test::Unit::TestCase
|
||||
TEST_AUTH_TOKEN = "keyid"
|
||||
TEST_SIGN_LAMBDA = -> {}
|
||||
|
||||
context "initialize" do
|
||||
should "raise error if given non-String auth token" do
|
||||
assert_raises ArgumentError do
|
||||
Stripe::RequestSigningAuthenticator.new(123, TEST_SIGN_LAMBDA)
|
||||
end
|
||||
end
|
||||
|
||||
should "raise error if given non-lambda sign function" do
|
||||
assert_raises ArgumentError do
|
||||
Stripe::RequestSigningAuthenticator.new(TEST_AUTH_TOKEN, nil)
|
||||
end
|
||||
end
|
||||
|
||||
should "create a new authenticator with valid arguments" do
|
||||
authenticator = Stripe::RequestSigningAuthenticator.new(TEST_AUTH_TOKEN, TEST_SIGN_LAMBDA)
|
||||
assert_equal(authenticator.auth_token, TEST_AUTH_TOKEN)
|
||||
assert_equal(authenticator.sign_lambda, TEST_SIGN_LAMBDA)
|
||||
end
|
||||
end
|
||||
|
||||
context ".authenticate" do
|
||||
setup do
|
||||
RequestSigningAuthenticator.any_instance.stubs(:created_time).returns(123_456_789)
|
||||
end
|
||||
|
||||
should "applies signature for POST requests" do
|
||||
signature_bases = []
|
||||
sign = lambda { |signature_base|
|
||||
signature_bases.push(signature_base)
|
||||
return [1, 2, 3, 4, 5].pack("C*")
|
||||
}
|
||||
|
||||
authenticator = RequestSigningAuthenticator.new(TEST_AUTH_TOKEN, sign)
|
||||
headers = { "Content-Type" => "application/json" }
|
||||
authenticator.authenticate(:post, headers, '{"string":"String!"}')
|
||||
|
||||
assert_equal("\"content-type\": application/json\n" \
|
||||
"\"content-digest\": sha-256=:HA3i38j+04ac71IzPtG1JK8o4q9sPK0fYPmJHmci5bg=:\n" \
|
||||
"\"stripe-context\": \n" \
|
||||
"\"stripe-account\": \n" \
|
||||
"\"authorization\": STRIPE-V2-SIG keyid\n" \
|
||||
"\"@signature-params\": (\"content-type\" \"content-digest\" \"stripe-context\" \"stripe-account\" \"authorization\");created=123456789",
|
||||
signature_bases[0].force_encoding(Encoding::UTF_8))
|
||||
|
||||
assert_equal('sig1=("content-type" "content-digest" "stripe-context" "stripe-account" "authorization");' \
|
||||
"created=123456789", headers["Signature-Input"])
|
||||
assert_equal("sha-256=:HA3i38j+04ac71IzPtG1JK8o4q9sPK0fYPmJHmci5bg=:", headers["Content-Digest"])
|
||||
assert_equal("sig1=:AQIDBAU=:", headers["Signature"])
|
||||
assert_equal("STRIPE-V2-SIG keyid", headers["Authorization"])
|
||||
end
|
||||
|
||||
should "applies signature for DELETE requests" do
|
||||
signature_bases = []
|
||||
sign = lambda { |signature_base|
|
||||
signature_bases.push(signature_base)
|
||||
return [1, 2, 3, 4, 5].pack("C*")
|
||||
}
|
||||
|
||||
authenticator = RequestSigningAuthenticator.new(TEST_AUTH_TOKEN, sign)
|
||||
headers = { "Content-Type" => "application/json" }
|
||||
authenticator.authenticate(:delete, headers, nil)
|
||||
|
||||
assert_equal("\"content-type\": application/json\n" \
|
||||
"\"content-digest\": sha-256=:47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=:\n" \
|
||||
"\"stripe-context\": \n" \
|
||||
"\"stripe-account\": \n" \
|
||||
"\"authorization\": STRIPE-V2-SIG keyid\n" \
|
||||
"\"@signature-params\": (\"content-type\" \"content-digest\" \"stripe-context\" \"stripe-account\" \"authorization\");created=123456789",
|
||||
signature_bases[0].force_encoding(Encoding::UTF_8))
|
||||
|
||||
assert_equal('sig1=("content-type" "content-digest" "stripe-context" "stripe-account" "authorization");' \
|
||||
"created=123456789", headers["Signature-Input"])
|
||||
assert_equal("sha-256=:47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=:", headers["Content-Digest"])
|
||||
assert_equal("sig1=:AQIDBAU=:", headers["Signature"])
|
||||
assert_equal("STRIPE-V2-SIG keyid", headers["Authorization"])
|
||||
end
|
||||
|
||||
should "applies signature for GET requests" do
|
||||
signature_bases = []
|
||||
sign = lambda { |signature_base|
|
||||
signature_bases.push(signature_base)
|
||||
return [1, 2, 3, 4, 5].pack("C*")
|
||||
}
|
||||
|
||||
authenticator = RequestSigningAuthenticator.new(TEST_AUTH_TOKEN, sign)
|
||||
headers = {}
|
||||
authenticator.authenticate(:get, headers, nil)
|
||||
|
||||
assert_equal("\"stripe-context\": \n" \
|
||||
"\"stripe-account\": \n" \
|
||||
"\"authorization\": STRIPE-V2-SIG keyid\n" \
|
||||
"\"@signature-params\": (\"stripe-context\" \"stripe-account\" \"authorization\");created=123456789",
|
||||
signature_bases[0].force_encoding(Encoding::UTF_8))
|
||||
|
||||
assert_equal('sig1=("stripe-context" "stripe-account" "authorization");' \
|
||||
"created=123456789", headers["Signature-Input"])
|
||||
assert_nil(headers["Content-Digest"])
|
||||
assert_equal("sig1=:AQIDBAU=:", headers["Signature"])
|
||||
assert_equal("STRIPE-V2-SIG keyid", headers["Authorization"])
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
@ -473,6 +473,55 @@ module Stripe
|
||||
end
|
||||
end
|
||||
|
||||
context "signing headers" do
|
||||
setup do
|
||||
RequestSigningAuthenticator.any_instance.stubs(:content_digest).returns("digest")
|
||||
RequestSigningAuthenticator.any_instance.stubs(:created_time).returns(1_234_567_890)
|
||||
RequestSigningAuthenticator.any_instance.stubs(:encoded_signature).returns("signature")
|
||||
|
||||
Stripe.api_key = nil
|
||||
Stripe.authenticator = RequestSigningAuthenticator.new("keyinfo_test_123", -> {})
|
||||
end
|
||||
|
||||
should "apply valid signing headers for get requests" do
|
||||
stub_request(:get, "#{Stripe.api_base}/v1/charges/ch_123")
|
||||
.to_return(body: JSON.generate(object: "charge"))
|
||||
|
||||
client = StripeClient.new
|
||||
client.send(request_method, :get, "/v1/charges/ch_123",
|
||||
&@read_body_chunk_block)
|
||||
assert_requested(
|
||||
:get,
|
||||
"#{Stripe.api_base}/v1/charges/ch_123",
|
||||
headers: {
|
||||
"Authorization" => "STRIPE-V2-SIG keyinfo_test_123",
|
||||
"Signature" => "sig1=:signature:",
|
||||
"Signature-Input" => 'sig1=("stripe-context" "stripe-account" "authorization");created=1234567890',
|
||||
}
|
||||
)
|
||||
end
|
||||
|
||||
should "apply valid signing headers for post requests" do
|
||||
stub_request(:post, "#{Stripe.api_base}/v1/charges")
|
||||
.to_return(body: JSON.generate(object: "charge"))
|
||||
|
||||
client = StripeClient.new
|
||||
client.send(request_method, :post, "/v1/charges",
|
||||
&@read_body_chunk_block)
|
||||
|
||||
assert_requested(
|
||||
:post,
|
||||
"#{Stripe.api_base}/v1/charges",
|
||||
headers: {
|
||||
"Authorization" => "STRIPE-V2-SIG keyinfo_test_123",
|
||||
"Content-Digest" => "sha-256=:digest:",
|
||||
"Signature" => "sig1=:signature:",
|
||||
"Signature-Input" => 'sig1=("content-type" "content-digest" "stripe-context" "stripe-account" "authorization");created=1234567890',
|
||||
}
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
context "logging" do
|
||||
setup do
|
||||
# Freeze time for the purposes of the `elapsed` parameter that we
|
||||
|
@ -119,6 +119,18 @@ class StripeTest < Test::Unit::TestCase
|
||||
assert_equal "2018-02-28", Stripe.api_version
|
||||
end
|
||||
|
||||
should "allow beta versions to be added once only" do
|
||||
Stripe.api_version = "2018-02-28"
|
||||
|
||||
Stripe.add_beta_version("my_beta", "v2")
|
||||
assert_equal "2018-02-28; my_beta=v2", Stripe.api_version
|
||||
|
||||
err = assert_raises do
|
||||
Stripe.add_beta_version("my_beta", "v1")
|
||||
assert_equal(err, "Stripe version header 2018-02-28; my_beta=v2 already contains entry for beta my_beta")
|
||||
end
|
||||
end
|
||||
|
||||
should "allow connect_base to be configured" do
|
||||
Stripe.connect_base = "https://other.stripe.com"
|
||||
assert_equal "https://other.stripe.com", Stripe.connect_base
|
||||
@ -134,4 +146,42 @@ class StripeTest < Test::Unit::TestCase
|
||||
assert_equal "client", Stripe.client_id
|
||||
end
|
||||
end
|
||||
|
||||
context "deserialize" do
|
||||
should "deserializes string into known object" do
|
||||
expected_body = "{\"id\": \"acc_123\", \"object\": \"account\"}"
|
||||
|
||||
obj = Stripe.deserialize(expected_body)
|
||||
|
||||
assert_equal obj.class, Stripe::Account
|
||||
assert_equal obj.id, "acc_123"
|
||||
end
|
||||
|
||||
should "deserializes string into unknown object" do
|
||||
expected_body = "{\"id\": \"acc_123\", \"object\": \"unknown\"}"
|
||||
|
||||
obj = Stripe.deserialize(expected_body)
|
||||
|
||||
assert_equal obj.class, Stripe::StripeObject
|
||||
assert_equal obj.id, "acc_123"
|
||||
end
|
||||
|
||||
should "deserializes hash into known object" do
|
||||
expected_body = { "id" => "acc_123", "object" => "account" }
|
||||
|
||||
obj = Stripe.deserialize(expected_body)
|
||||
|
||||
assert_equal obj.class, Stripe::Account
|
||||
assert_equal obj.id, "acc_123"
|
||||
end
|
||||
|
||||
should "deserializes hash into unknown object" do
|
||||
expected_body = { "id" => "acc_123", "object" => "unknown" }
|
||||
|
||||
obj = Stripe.deserialize(expected_body)
|
||||
|
||||
assert_equal obj.class, Stripe::StripeObject
|
||||
assert_equal obj.id, "acc_123"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
@ -67,6 +67,8 @@ module Test
|
||||
Stripe.api_base = "http://localhost:#{MOCK_PORT}"
|
||||
Stripe.uploads_base = "http://localhost:#{MOCK_PORT}"
|
||||
|
||||
Stripe.authenticator = nil
|
||||
|
||||
stub_connect
|
||||
end
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user